diff --git a/MIT-license.txt b/MIT-license.txt new file mode 100644 index 000000000..b82a51d7e --- /dev/null +++ b/MIT-license.txt @@ -0,0 +1,21 @@ +The MIT License + +Copyright (C) 2011 by Code Computerlove + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000..efa62b549 --- /dev/null +++ b/README.md @@ -0,0 +1,146 @@ +PhotoSwipe - The ultimate image/photo gallery for your mobile device +====================================================================== + +[www.photoswipe.com](http://www.photoswipe.com) + +Inspired by the iOS photo viewer and Google images for mobile, PhotoSwipe is a HTML/CSS/JavaScript image viewer specifically targeted mobile device use. + +The current version supports mobile handsets running webkit based browsers, i.e. iOS, Android and Blackberry 6. It also works on selected Nokia devices running webkit. At the moment, Windows Phone 7 is not currently supported. + +In addition, PhotoSwipe also runs on the desktop and has been tested on Chrome, Firefox and Internet Explorer 8 and above. + + + +Features +-------- + +- Optimised for mobile devices running a webkit browser. + +- Runs on modern desktop browsers, including Internet Explorer 8 and above. + +- Multiple input options including swipe gestures (both mouse and screen touches), keyboard control and an interactive on screen toolbar. + +- Responsive to device orientation changes. + +- Automatically scales images to maximise screen size and orientation. + +- Works with your markup and semantic structure. Does not enforce any specific markup. + +- Supports image captions. + +- Slideshow feature to automatically play through images in the gallery. + +- Uses hardware acceleration where possible for smoother transitions and effects. + +- Comprehensive customisation options: + + - Presentation controlled via CSS + + - Set whether the gallery loops or not i.e. when you reach the end, is the next image the first image, or does the gallery show a bounce effect to indicate that you have reached the end. + + - Hide or show captions and toolbar + + - Change caption and toolbar positions + + - Set the speeds of all animations used, from sliding in to fading. + + + +Getting Started +--------------- + +The library comes with an example site to help you get started. + +There are two distributions of the library: + +- The default distribution optimised for webkit (mobile and desktop) and Mozilla based browsers. This distribution uses standard DOM querying and manupulation. It also uses CSS3 transformations for animations. + +- The jQuery distribution that uses jQuery as it's engine. + +It is recommended for webit based mobile devices to use the default distribution. This distribution will run faster. It does not require jQuery (so one less library to download to your mobile device). It also uses CSS3 to achieve animation effects. This is extremely noticable when running on an iOS device as animation will use hardware acceleration and will feel more "native" to the device. The default distribution will also work on desktop Webkit browsers (such as Chrome and Safari) as well as Firefox. + +Use the jQuery distibution if you need to support a wider range of browsers such as Internet Explorer etc. By default, this distributionn will not use hardware acceleration for animation on iOS devices so is noticably slower. You can however override the default animation functionality in jQuery by including the excellent [Animate Enhanced](https://github.com/benbarnett/jQuery-Animate-Enhanced) library. + +Both default and jQuery distribution come with a jQuery plugin wrapper to bind elements to the gallery. So for the default distribution, if you really needed to, you can still use jQuery to find your images in your HTML document, hook into the jQuery DOM ready event and use the jQuery PhotoSwipe plugin to display the library. The gallery will still be running on the default optimised engine, but you have the convience of jQuery to set things up should you need to. + + + +Getting Started - Default Distribution +-------------------------------------- + +See "examples/index.html". + +This example assumes no jQuery at all and is heavily optimised for Webkit and Mozilla browsers. + + +Getting Started - Default Distribution (with jQuery plugin) +----------------------------------------------------------- + +See "examples/jquery-plugin.html". + +This example assumes you want to use the convience of jQuery for initiating the gallery, but still the optimised engine for Webkit and Mozilla browsers. + + +Getting Started - Default Distribution (with jQuery engine) +----------------------------------------------------------- + +See "examples/jquery-engine.html". + +This example assumes you want to use jQuery for the gallery's engine as well as initiating the gallery. It is not advised to use this approach if you are targetting mobile webkit based devices. + + +Options +------- + +- **fadeSpeed**: The speed of any fading elements in milliseconds. Default "400" + +- **slideSpeed**: How fast images slide into view in milliseconds. Default "250" + +- **swipeThreshold**: How many pixels your finger has to move across the screen to register a swipe gesture. Default "50" + +- **loop**: Whether the gallery auto-loops back to the beginning when you reach the end. Default "true" + +- **flipCaptionAndToolbar**: Place the caption at the bottom and the toolbar at the top + +- **captionDelay**: How long before the caption is hidden from view in milliseconds. Default "3000" + +- **captionOpacity**: The opacity of the caption. Default "0.8" + +- **hideCaption**: Whether to hide the caption or not. If an image does not have a caption, the caption will be hidden irrespective. Default "false" + +- **showEmptyCaptions**: Shows a blank caption area even if a caption cannot be found for the current image. Default "false" + +- **toolbarDelay**: How long before the toolbar is hidden from view in milliseconds. Default "3000" + +- **toolbarOpacity**: The opacity of the toolbar. Default "0.8" + +- **hideToolbar**: Whether to hide the toolbar or not. Default "false" + +- **slideshowDelay**: The delay between showing the next image when in slideshow mode + +- **imageScaleMethod**: How images will fit onto the screen. Either "fit" or "zoom". "fit" ensures the image always fits the screen. "zoom" the image will always fill the full screen, this may cause the image to be "zoomed" in and cropped. Default "fit" + +- **getImageSource**: Function to specify how the gallery obatins image sources. By default, the gallery assumes you send it a list of images with each image wrapped in an anchor tag. The anchor tag will contain the URL to the full size image. You can change this e.g. if you supply a list of images without an anchor tag, and supply the full size URL on the image's "rel" attribute: + + $('div.gallery a').swipeGallery({ + getImageSource: function(){ + return $j(this).attr('rel'); + } + }); + +- **getImageCaption**: Like "getImageSource", function to specify how the gallery obatins image captions. By default, the gallery looks for an images "alt" tag. + + + +Keyboard controls for desktop browsers +-------------------------------------- + +- **Left cursor**: Previous image + +- **Right cursor**: Next image + +- **Escape**: Close gallery + +- **Space bar**: Show toolbar / caption if they have faded from view. If both are hidden via the configuration, space bar will close the gallery + + diff --git a/artifact/1.0.0/MIT-license.txt b/artifact/1.0.0/MIT-license.txt new file mode 100644 index 000000000..b82a51d7e --- /dev/null +++ b/artifact/1.0.0/MIT-license.txt @@ -0,0 +1,21 @@ +The MIT License + +Copyright (C) 2011 by Code Computerlove + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE \ No newline at end of file diff --git a/artifact/1.0.0/README.md b/artifact/1.0.0/README.md new file mode 100644 index 000000000..efa62b549 --- /dev/null +++ b/artifact/1.0.0/README.md @@ -0,0 +1,146 @@ +PhotoSwipe - The ultimate image/photo gallery for your mobile device +====================================================================== + +[www.photoswipe.com](http://www.photoswipe.com) + +Inspired by the iOS photo viewer and Google images for mobile, PhotoSwipe is a HTML/CSS/JavaScript image viewer specifically targeted mobile device use. + +The current version supports mobile handsets running webkit based browsers, i.e. iOS, Android and Blackberry 6. It also works on selected Nokia devices running webkit. At the moment, Windows Phone 7 is not currently supported. + +In addition, PhotoSwipe also runs on the desktop and has been tested on Chrome, Firefox and Internet Explorer 8 and above. + + + +Features +-------- + +- Optimised for mobile devices running a webkit browser. + +- Runs on modern desktop browsers, including Internet Explorer 8 and above. + +- Multiple input options including swipe gestures (both mouse and screen touches), keyboard control and an interactive on screen toolbar. + +- Responsive to device orientation changes. + +- Automatically scales images to maximise screen size and orientation. + +- Works with your markup and semantic structure. Does not enforce any specific markup. + +- Supports image captions. + +- Slideshow feature to automatically play through images in the gallery. + +- Uses hardware acceleration where possible for smoother transitions and effects. + +- Comprehensive customisation options: + + - Presentation controlled via CSS + + - Set whether the gallery loops or not i.e. when you reach the end, is the next image the first image, or does the gallery show a bounce effect to indicate that you have reached the end. + + - Hide or show captions and toolbar + + - Change caption and toolbar positions + + - Set the speeds of all animations used, from sliding in to fading. + + + +Getting Started +--------------- + +The library comes with an example site to help you get started. + +There are two distributions of the library: + +- The default distribution optimised for webkit (mobile and desktop) and Mozilla based browsers. This distribution uses standard DOM querying and manupulation. It also uses CSS3 transformations for animations. + +- The jQuery distribution that uses jQuery as it's engine. + +It is recommended for webit based mobile devices to use the default distribution. This distribution will run faster. It does not require jQuery (so one less library to download to your mobile device). It also uses CSS3 to achieve animation effects. This is extremely noticable when running on an iOS device as animation will use hardware acceleration and will feel more "native" to the device. The default distribution will also work on desktop Webkit browsers (such as Chrome and Safari) as well as Firefox. + +Use the jQuery distibution if you need to support a wider range of browsers such as Internet Explorer etc. By default, this distributionn will not use hardware acceleration for animation on iOS devices so is noticably slower. You can however override the default animation functionality in jQuery by including the excellent [Animate Enhanced](https://github.com/benbarnett/jQuery-Animate-Enhanced) library. + +Both default and jQuery distribution come with a jQuery plugin wrapper to bind elements to the gallery. So for the default distribution, if you really needed to, you can still use jQuery to find your images in your HTML document, hook into the jQuery DOM ready event and use the jQuery PhotoSwipe plugin to display the library. The gallery will still be running on the default optimised engine, but you have the convience of jQuery to set things up should you need to. + + + +Getting Started - Default Distribution +-------------------------------------- + +See "examples/index.html". + +This example assumes no jQuery at all and is heavily optimised for Webkit and Mozilla browsers. + + +Getting Started - Default Distribution (with jQuery plugin) +----------------------------------------------------------- + +See "examples/jquery-plugin.html". + +This example assumes you want to use the convience of jQuery for initiating the gallery, but still the optimised engine for Webkit and Mozilla browsers. + + +Getting Started - Default Distribution (with jQuery engine) +----------------------------------------------------------- + +See "examples/jquery-engine.html". + +This example assumes you want to use jQuery for the gallery's engine as well as initiating the gallery. It is not advised to use this approach if you are targetting mobile webkit based devices. + + +Options +------- + +- **fadeSpeed**: The speed of any fading elements in milliseconds. Default "400" + +- **slideSpeed**: How fast images slide into view in milliseconds. Default "250" + +- **swipeThreshold**: How many pixels your finger has to move across the screen to register a swipe gesture. Default "50" + +- **loop**: Whether the gallery auto-loops back to the beginning when you reach the end. Default "true" + +- **flipCaptionAndToolbar**: Place the caption at the bottom and the toolbar at the top + +- **captionDelay**: How long before the caption is hidden from view in milliseconds. Default "3000" + +- **captionOpacity**: The opacity of the caption. Default "0.8" + +- **hideCaption**: Whether to hide the caption or not. If an image does not have a caption, the caption will be hidden irrespective. Default "false" + +- **showEmptyCaptions**: Shows a blank caption area even if a caption cannot be found for the current image. Default "false" + +- **toolbarDelay**: How long before the toolbar is hidden from view in milliseconds. Default "3000" + +- **toolbarOpacity**: The opacity of the toolbar. Default "0.8" + +- **hideToolbar**: Whether to hide the toolbar or not. Default "false" + +- **slideshowDelay**: The delay between showing the next image when in slideshow mode + +- **imageScaleMethod**: How images will fit onto the screen. Either "fit" or "zoom". "fit" ensures the image always fits the screen. "zoom" the image will always fill the full screen, this may cause the image to be "zoomed" in and cropped. Default "fit" + +- **getImageSource**: Function to specify how the gallery obatins image sources. By default, the gallery assumes you send it a list of images with each image wrapped in an anchor tag. The anchor tag will contain the URL to the full size image. You can change this e.g. if you supply a list of images without an anchor tag, and supply the full size URL on the image's "rel" attribute: + + $('div.gallery a').swipeGallery({ + getImageSource: function(){ + return $j(this).attr('rel'); + } + }); + +- **getImageCaption**: Like "getImageSource", function to specify how the gallery obatins image captions. By default, the gallery looks for an images "alt" tag. + + + +Keyboard controls for desktop browsers +-------------------------------------- + +- **Left cursor**: Previous image + +- **Right cursor**: Next image + +- **Escape**: Close gallery + +- **Space bar**: Show toolbar / caption if they have faded from view. If both are hidden via the configuration, space bar will close the gallery + + diff --git a/artifact/1.0.0/change-log.html b/artifact/1.0.0/change-log.html new file mode 100644 index 000000000..416b31929 --- /dev/null +++ b/artifact/1.0.0/change-log.html @@ -0,0 +1,15 @@ + + + + Changes + + + + + diff --git a/artifact/1.0.0/code-photoswipe-1.0.0.js b/artifact/1.0.0/code-photoswipe-1.0.0.js new file mode 100644 index 000000000..3dd99d538 --- /dev/null +++ b/artifact/1.0.0/code-photoswipe-1.0.0.js @@ -0,0 +1,3733 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function () { + + // https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function/bind + if (!Function.prototype.bind ) { + + Function.prototype.bind = function( obj ) { + var slice = [].slice, + args = slice.call(arguments, 1), + self = this, + nop = function () {}, + bound = function () { + return self.apply( this instanceof nop ? this : ( obj || {} ), + args.concat( slice.call(arguments) ) ); + }; + + nop.prototype = self.prototype; + + bound.prototype = new nop(); + + return bound; + }; + } + + + if (typeof Code === "undefined") { + Code = {}; + Code.PhotoSwipe = {}; + } + + + + Code.PhotoSwipe.Util = { + + browser: { + version: (navigator.userAgent.match( /.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/ ) || [])[1], + webkit: /webkit/.test(navigator.userAgent), + opera: /opera/.test(navigator.userAgent), // untested + msie: /msie/.test(navigator.userAgent) && !/opera/.test(navigator.userAgent), + mozilla: /mozilla/.test(navigator.userAgent) && !/(compatible|webkit)/.test(navigator.userAgent), + mobileSafari: /Mac OS X.*Mobile.*Safari/.test(navigator.userAgent) + }, + + + /* + * Function: setElementData + */ + setElementData: function(el, key, value){ + + if ( this.isNothing(el.UtilData) ){ + el.UtilData = { }; + } + + el.UtilData[key] = value; + }, + + + /* + * Function: getElementData + */ + getElementData: function(el, key, defaultValue){ + + if (typeof defaultValue === "undefined"){ + defaultValue = null; + } + + if ( this.isNothing(el.UtilData) ){ + return defaultValue; + } + + if ( this.isNothing(el.UtilData[key]) ){ + return defaultValue; + } + + return el.UtilData[key]; + + }, + + + /* + * Function: removeElementData + */ + removeElementData: function(el, key){ + + delete el.UtilData[key]; + + }, + + + /* + * Function: coalesce + * Takes any number of arguments and returns the first non Null / Undefined argument. + */ + coalesce: function () { + var i; + for (i = 0; i < arguments.length; i++) { + if (!this.isNothing(arguments[i])) { + return arguments[i]; + } + } + return null; + }, + + + + /* + * Function: registerNamespace + */ + registerNamespace: function () { + var args = arguments, obj = null, i, j; + for (i = 0; i < args.length; ++i) { + var ns = args[i]; + var nsParts = ns.split("."); + var root = nsParts[0]; + eval('if (typeof ' + root + ' == "undefined"){' + root + ' = {};} obj = ' + root + ';'); + for (j = 1; j < nsParts.length; ++j) { + obj[nsParts[j]] = obj[nsParts[j]] || {}; + obj = obj[nsParts[j]]; + } + } + }, + + + + /* + * Function: extend + */ + extend: function(destination, source, overwriteProperties){ + if (this.isNothing(overwriteProperties)){ + overwriteProperties = true; + } + if (destination && source && this.isObject(source)){ + for(var prop in source){ + if (overwriteProperties){ + destination[prop] = source[prop]; + } + else{ + if(typeof destination[prop] == "undefined"){ + destination[prop] = source[prop]; + } + } + } + } + }, + + + /* + * Function: swapArrayElements + */ + swapArrayElements: function(arr, i, j){ + + var temp = arr[i]; + arr[i] = arr[j]; + arr[j] = temp; + + }, + + + /* + * Function: isObject + */ + isObject: function(obj){ + return typeof obj == "object"; + }, + + + + /* + * Function: isNothing + */ + isNothing: function (obj) { + if (typeof obj === "undefined" || obj === null) { + return true; + } + return false; + }, + + + + /* + * Function: isFunction + */ + isFunction: function(obj){ + return typeof obj == "function"; + }, + + + + /* + * Function: isArray + */ + isArray: function(obj){ + return obj && Code.PhotoSwipe.Util.isFunction(obj.pop); + }, + + + + /* + * Function: isNumber + */ + isNumber: function(obj){ + return typeof obj == "number"; + }, + + + /* + * Function: isString + */ + isString: function(obj){ + return typeof obj == "string"; + }, + + + + /* + * Function: trim + */ + trim: function(val) { + var re = new RegExp(/\s+?/); + return val.replace(re, ''); + } + + }; + + +})();// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + DOM: { + + /* + * Function: resetTranslate + * Required for smoother transition on iOS + */ + resetTranslate: function(el){ + + if (Util.browser.mobileSafari){ + Util.DOM.setStyle(el, '-webkit-transform', 'translate3d(0px,0px,0px)'); + } + + }, + + + /* + * Function: createElement + */ + createElement: function(type, attributes, content){ + + var retval = document.createElement(type); + + for(var attribute in attributes) { + if(attributes.hasOwnProperty(attribute)){ + retval.setAttribute(attribute, attributes[attribute]); + } + } + + retval.innerHTML = content || ''; + + return retval; + + }, + + + /* + * Function: appendChild + */ + appendChild: function(childEl, parentEl){ + + parentEl.appendChild(childEl); + + }, + + + /* + * Function: appendText + */ + appendText: function(text, parentEl){ + + var textNode = document.createTextNode(text); + Util.DOM.appendChild(textNode, parentEl); + + }, + + + /* + * Function: appendToBody + */ + appendToBody: function(childEl){ + + this.appendChild(childEl, document.body); + + }, + + + /* + * Function: removeChild + */ + removeChild: function(childEl, parentEl){ + + parentEl.removeChild(childEl); + + }, + + + + /* + * Function: removeChildren + */ + removeChildren: function(parentEl){ + + if (parentEl.hasChildNodes()){ + + while (parentEl.childNodes.length >= 1){ + parentEl.removeChild(parentEl.childNodes[parentEl.childNodes.length -1]); + } + + } + + }, + + + + /* + * Function: hasAttribute + */ + hasAttribute: function(el, attributeName){ + + return el.getAttribute(attributeName); + + }, + + + /* + * Function: getAttribute + */ + getAttribute: function(el, attributeName){ + + if(!this.hasAttribute(el, attributeName)){ + return ''; + } + + return el.getAttribute(attributeName); + + }, + + + /* + * Function: el, attributeName + */ + setAttribute: function(el, attributeName, value){ + + el.setAttribute(attributeName, value); + + }, + + + /* + * Function: removeAttribute + */ + removeAttribute: function(el, attributeName){ + + if (this.hasAttribute(el, attributeName)){ + + el.removeAttribute(attributeName); + + } + + }, + + + /* + * Function: addClass + */ + addClass: function(el, className){ + + var currentClassValue = Util.DOM.getAttribute(el, 'class'); + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + + if ( ! re.test(currentClassValue) ){ + if (currentClassValue != ''){ + currentClassValue = currentClassValue + ' '; + } + currentClassValue = currentClassValue + className; + Util.DOM.setAttribute(el, 'class', currentClassValue); + } + + }, + + + /* + * Function: removeClass + */ + removeClass: function(el, className){ + + var currentClassValue = Util.DOM.getAttribute(el, 'class'); + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + + if (re.test(currentClassValue)){ + + currentClassValue = currentClassValue.replace(re, ' '); + + Util.DOM.setAttribute(el, 'class', currentClassValue); + Util.DOM.removeClass(el, className); + + } + else{ + currentClassValue = Util.trim(currentClassValue); + if (currentClassValue === ''){ + Util.DOM.removeAttribute(el, 'class'); + } + else{ + Util.DOM.setAttribute(el, 'class', currentClassValue); + } + } + + }, + + + /* + * Function: hasClass + */ + hasClass: function(el, className){ + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + return re.test(Util.DOM.getAttribute(el, 'class')); + + }, + + + /* + * Function: setStyle + */ + setStyle: function(el, style, value){ + + if (Util.isObject(style)) { + for(var propertyName in style) { + if(style.hasOwnProperty(propertyName)){ + el.style[propertyName] = style[propertyName]; + } + } + } + else { + el.style[style] = value; + } + }, + + + /* + * Function: getStyle + */ + getStyle: function(el, styleName){ + + return window.getComputedStyle(el,'').getPropertyValue(styleName); + + }, + + + /* + * Function: hide + */ + hide: function(el){ + + // Store the current display value if we use show + Util.setElementData(el, 'oldDisplayValue', Util.DOM.getStyle(el, 'display')); + Util.DOM.setStyle(el, 'display', 'none'); + + }, + + + /* + * Function: show + */ + show: function(el){ + + if (Util.DOM.getStyle(el, 'display') === 'none'){ + var oldDisplayValue = Util.getElementData(el, 'oldDisplayValue', 'block'); + if (oldDisplayValue === 'none'){ + oldDisplayValue = 'block'; + } + Util.DOM.setStyle(el, 'display', oldDisplayValue); + } + + }, + + + /* + * Function: width + * Content width, excludes padding + */ + width: function(el, value){ + + if (!Util.isNothing(value)){ + if (Util.isNumber(value)){ + value = value + 'px'; + } + el.style.width = value; + } + + return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('width')); + + }, + + + /* + * Function: outerWidth + */ + outerWidth: function(el){ + + return el.offsetWidth; + + }, + + + /* + * Function: height + * Content height, excludes padding + */ + height: function(el, value){ + + if (!Util.isNothing(value)){ + if (Util.isNumber(value)){ + value = value + 'px'; + } + el.style.height = value; + } + + return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('height')); + + }, + + + /* + * Function: outerHeight + */ + outerHeight: function(el){ + + return el.offsetHeight; + + }, + + + /* + * Function: documentWidth + */ + documentWidth: function(){ + + return Util.DOM.width(document.documentElement); + + }, + + + /* + * Function: documentHeight + */ + documentHeight: function(){ + + return Math.round(Util.DOM.height(document.documentElement)); + + }, + + + /* + * Function: bodyWidth + */ + bodyWidth: function(){ + + return Util.DOM.width(document.body); + + }, + + + /* + * Function: bodyHeight + */ + bodyHeight: function(){ + + return Util.DOM.height(document.body); + + }, + + + /* + * Function: windowWidth + */ + windowWidth: function(){ + + return window.innerWidth; + + }, + + + /* + * Function: windowHeight + */ + windowHeight: function(){ + + return window.innerHeight; + + }, + + + /* + * Function: windowScrollLeft + */ + windowScrollLeft: function(){ + + return window.pageXOffset; + + }, + + + /* + * Function: windowScrollTop + */ + windowScrollTop: function(){ + + return window.pageYOffset; + + }, + + + /* + * Function: addEventListener + */ + addEventListener: function(el, type, listener){ + + el.addEventListener(type, listener, false); + + }, + + + /* + * Function: removeEventListener + */ + removeEventListener: function(el, type, listener){ + + el.removeEventListener(type, listener, false); + + }, + + + /* + * Function: getMousePosition + */ + getMousePosition: function(event){ + + var retval = { + x: 0, + y: 0 + } + + if (event.pageX) { + retval.x = event.pageX; + } + else if (event.clientX) { + retval.x = event.clientX + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft); + } + + if (event.pageY) { + retval.y = event.pageY; + } + else if (event.clientY) { + retval.y = event.clientY + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop); + } + + return retval; + }, + + + /* + * Function: getTouchEvent + */ + getTouchEvent: function(event){ + + return event; + + } + + } + + + }); + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + + Animation: { + + _applyTransitionDelay: 100, + + /* + * Function: _setTransition + * Sets animation transitions on the element + */ + _setTransition: function(el, property, duration, timingFunction, delay, callback){ + + var + transitionPrefix = Util.Animation._getTransitionPrefix(), + p = Util.coalesce(property, ''), + d = Util.coalesce(duration, ''), + t, de, c; + + if (Util.isFunction(timingFunction)){ + c = timingFunction; + t = ''; + de = ''; + } + else{ + c = callback; + t = Util.coalesce(timingFunction, ''); + de = Util.coalesce(delay, ''); + } + + Util.DOM.setStyle(el, transitionPrefix + 'Property', p); + Util.DOM.setStyle(el, transitionPrefix + 'Duration', d); + Util.DOM.setStyle(el, transitionPrefix + 'TimingFunction', t); + Util.DOM.setStyle(el, transitionPrefix + 'Delay', de); + + // Wait for the above transitions to get applied + if (Util.isFunction(c)){ + window.setTimeout( + function(){ + c(el); + }, + Util.Animation._applyTransitionDelay + ); + } + + }, + + + /* + * Function: _setTransitionEndEventListener + * Sets an event listener on transition end. This will: + * - Remove the transitionEnd event hander + * - Fire any animation end callback you specified + * + * The function stores a pointer to the event handler functions + * on the element object itself (using Util.setElementData) + * + * This gives us a reference when removing the event listener + */ + _setTransitionEndEventListener: function(el){ + + Util.setElementData(el, 'transitionEndEvent', function(e){ + + var el = e.target; + + Util.DOM.removeEventListener(el, Util.Animation._getTransitionEndEventLabel(), Util.getElementData(el, 'transitionEndEvent')); + Util.removeElementData(el, 'transitionEndEvent'); + + var callback = Util.getElementData(el, 'transitionEndCallback'); + Util.removeElementData(el, 'transitionEndCallback'); + + // Remove the tranistion + Util.Animation._removeTransitions(el); + + if (Util.isFunction(callback)){ + + window.setTimeout( + function(){ + callback(e); + }, + Util.Animation._applyTransitionDelay + ); + + } + + }); + + + Util.DOM.addEventListener(el, Util.Animation._getTransitionEndEventLabel(), Util.getElementData(el, 'transitionEndEvent')); + + }, + + + /* + * Function: _removeTransitions + */ + _removeTransitions: function(el){ + + var transitionPrefix = Util.Animation._getTransitionPrefix(); + + Util.DOM.setStyle(el, transitionPrefix + 'Property', ''); + Util.DOM.setStyle(el, transitionPrefix + 'Duration', ''); + Util.DOM.setStyle(el, transitionPrefix + 'TimingFunction', ''); + Util.DOM.setStyle(el, transitionPrefix + 'Delay', ''); + + }, + + + /* + * Function: _getTransitionEndEventLabel + */ + _getTransitionEndEventLabel: function(){ + + return (document.documentElement.style.WebkitTransition !== undefined) ? "webkitTransitionEnd" : "transitionend"; + + }, + + + _getTransitionPrefix: function(){ + + return (document.documentElement.style.WebkitTransition !== undefined) ? "webkitTransition" : (document.documentElement.style.MozTransition !== undefined) ? "MozTransition" : "transition"; + + }, + + + /* + * Function: stopFade + */ + stopFade: function(el){ + + Util.DOM.removeEventListener( + el, + Util.Animation._getTransitionEndEventLabel(), + Util.getElementData(el, 'transitionEndEvent') + ); + + var transitionPrefix = Util.Animation._getTransitionPrefix(); + var currentOpacity = window.getComputedStyle(el,'').getPropertyValue('opacity'); + + Util.Animation._removeTransitions(el); + + Util.DOM.setStyle(el, 'opacity', currentOpacity); + + }, + + + /* + * Function: fadeIn + * Fades an element in. + * Make sure the element is displayed before calling + */ + fadeIn: function(el, opacity, duration, callback){ + + opacity = Util.coalesce(opacity, 1); + duration = Util.coalesce(duration, 500); + + Util.setElementData(el, 'transitionEndCallback', callback); + + Util.Animation._setTransition(el, 'opacity', duration + 'ms', function(el){ + + Util.Animation._setTransitionEndEventListener(el); + Util.DOM.setStyle(el, 'opacity', opacity); + + }); + + }, + + + /* + * Function: fadeOut + * Fades an element out + * Make sure the element is displayed before calling + * Does not "hide" the element when animation is over + */ + fadeOut: function(el, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + Util.setElementData(el, 'transitionEndCallback', callback); + + Util.Animation._setTransition(el, 'opacity', duration + 'ms', function(el){ + + Util.Animation._setTransitionEndEventListener(el); + Util.DOM.setStyle(el, 'opacity', 0); + + }); + + }, + + + + /* + * Function: slideTo + * Slides an element by an x,y position + */ + slideBy: function(el, xPos, yPos, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + /* Store some values against the element for later use */ + Util.setElementData(el, 'transitionEndCallback', Util.Animation._onSlideByEnd); + Util.setElementData(el, 'slideByCallback', callback); + Util.setElementData(el, 'slideByXPos', xPos); + Util.setElementData(el, 'slideByYPos', yPos); + + //ease-in-out + Util.Animation._setTransition(el, 'all', duration + 'ms', 'ease-in', 0, function(el){ + + Util.Animation._setTransitionEndEventListener(el); + + var + xPos = Util.getElementData(el, 'slideByXPos'), + yPos = Util.getElementData(el, 'slideByYPos'); + + Util.removeElementData(el, 'slideByXPos'); + Util.removeElementData(el, 'slideByYPos'); + + Util.DOM.setStyle(el, { + webkitTransform: (Util.isMobileSafari) ? 'translate3d(' + xPos + 'px, ' + yPos + 'px, 0)' : 'translate(' + xPos + 'px, ' + yPos + 'px)', + MozTransform: 'translate(' + xPos + 'px, ' + yPos + 'px)', + transform: 'translate(' + xPos + 'px, ' + yPos + 'px)' + }); + + }); + + }, + + + + _onSlideByEnd: function(e){ + + // Reset the real css top and left after the transformation + var + el = e.target, + + callback = Util.getElementData(el, 'slideByCallback'), + + transform = Util.coalesce(el.style.webkitTransform, el.style.MozTransform, el.style.transform), + + transformExploded = transform.match( /\((.*?)\)/ )[1].split(', '), + + transformedX = window.parseInt(transformExploded[0]), + + transformedY = window.parseInt(transformExploded[1]), + + domX = window.parseInt(Util.DOM.getStyle(el, 'left')), + + domY = window.parseInt(Util.DOM.getStyle(el, 'top')); + + Util.DOM.setStyle(el, { + webkitTransform: '', + MozTransform: '', + transform: '', + left: (domX + transformedX) + 'px', + top: (domY + transformedY) + 'px' + }); + + + Util.removeElementData(el, 'slideByCallback'); + Util.removeElementData(el, 'slideByXPos'); + Util.removeElementData(el, 'slideByYPos'); + + if (Util.isFunction(callback)){ + window.setTimeout( + function(){ + callback(e); + }, + Util.Animation._applyTransitionDelay + ); + //window.setTimeout(callback, Util.Animation._applyTransitionDelay, e); + } + + } + + + } + + + }); + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function () { + + // Based on http://www.javascriptbank.com/how-build-custom-events-javascript.html + Code.PhotoSwipe.EventClass = Class.extend({ + + _listeners: null, + + init: function(){ + + this._listeners = {}; + + }, + + + addEventListener: function(type, listener){ + + if (typeof this._listeners[type] === 'undefined'){ + this._listeners[type] = []; + } + this._listeners[type].push(listener); + + }, + + + dispatchEvent: function(event){ + if (typeof event == "string"){ + event = { type: event }; + } + if (!event.target){ + event.target = this; + } + + if (!event.type){ + throw new Error("Event object missing 'type' property."); + } + + if (this._listeners[event.type] instanceof Array){ + var listeners = this._listeners[event.type]; + for (var i=0, len=listeners.length; i < len; i++){ + listeners[i].call(this, event); + } + } + }, + + + removeEventListener: function(type, listener){ + if (this._listeners[type] instanceof Array){ + var listeners = this._listeners[type]; + for (var i=0, len=listeners.length; i < len; i++){ + if (listeners[i] === listener){ + listeners.splice(i, 1); + break; + } + } + } + } + + }); + + +})();// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + /* + * Class: Code.PhotoSwipe.ElementClass + * Most PhotoSwipe classes inherit from this class + * Provides hooks for fading in and out + */ + Code.PhotoSwipe.ElementClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + settings: null, + isFading: null, + + fadeInHandler: null, + fadeOutHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this._super(); + + this.settings = { + opacity: 1, + fadeSpeed: 500 + }; + + Util.extend(this.settings, options); + + this.isFading = false; + + this.fadeInHandler = this.postFadeIn.bind(this); + this.fadeOutHandler = this.postFadeOut.bind(this); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + }, + + + + /* + * Function: show + */ + show: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + // Set position + this.resetPosition(); + + // Show + Util.DOM.setStyle(this.el, 'opacity', this.settings.opacity); + Util.DOM.show(this.el); + + this.postShow(); + + }, + + + + /* + * Function: postShow + * Overide this + */ + postShow: function(){ + + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onShow); + + }, + + + + /* + * Function: fadeIn + */ + fadeIn: function(){ + + if (this.el === null){ + return; + } + + Util.DOM.setStyle(this.el, 'opacity', 0); + + this.fadeInFromCurrentOpacity(); + + }, + + + /* + * Function: fadeInFromCurrentOpacity + */ + fadeInFromCurrentOpacity: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + this.isFading = true; + + // Set position + this.resetPosition(); + + // Fade in + Util.DOM.show(this.el); + Util.Animation.fadeIn( + this.el, + this.settings.opacity, + this.settings.fadeSpeed, + this.fadeInHandler + ); + + }, + + + /* + * Function: postFadeIn + */ + postFadeIn: function(e){ + + this.isFading = false; + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeIn); + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + Util.DOM.hide(this.el); + + this.postHide(); + + }, + + + /* + * Function: postHide + * Overide this + */ + postHide: function(){ + + this.removeEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onHide); + + }, + + + /* + * Fuction: fadeOut + */ + fadeOut: function(){ + + this.stopFade(); + + this.isFading = true; + + Util.Animation.fadeOut(this.el, this.settings.fadeSpeed, this.fadeOutHandler); + + }, + + + /* + * Function: preFadeOut + */ + postFadeOut: function(e){ + + this.isFading = false; + + Util.DOM.hide(this.el); + + this.removeEventListeners(); + + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeOut); + + }, + + + /* + * Function: stopFade + */ + stopFade: function(){ + + if (this.el === null){ + return; + } + + Util.Animation.stopFade(this.el); + this.isFading = false; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + } + + + }); + + + + Code.PhotoSwipe.ElementClass.EventTypes = { + onShow: 'onShow', + onHide: 'onHide', + onClick: 'onClick', + onFadeIn: 'onFadeIn', + onFadeOut: 'onFadeOut' + }; + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + + /* + * Class: Code.PhotoSwipe.FullSizeImageClass + */ + Code.PhotoSwipe.FullSizeImageClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + index: null, + + // The naturalWidth and naturalHeight of the image as loaded from the server + // This maybe different from the width and height set on the img element + // We need this to scale the image correctly + naturalWidth: null, + naturalHeight: null, + src: null, + caption: null, + scaleMethod: null, + isLandscape: null, + isLoading: null, + hasLoaded: null, + + loadEventHandler: null, + + + /* + * Function: init + */ + init: function(index, scaleMethod, src, caption){ + + this._super(); + + this.index = index; + this.naturalWidth = 0; + this.naturalHeight = 0; + this.src = src; + this.caption = caption; + this.isLandscape = false; + this.isLoading = false; + this.hasLoaded = false; + this.scaleMethod = scaleMethod; + + this.loadEventHandler = this.onLoad.bind(this); + + }, + + + /* + * Function: load + */ + load: function(){ + + // Load in the image + this.isLoading = true; + + this.el = new Image(); + Util.DOM.addClass(this.el, 'ps-full-size-image'); + this.el.onload = this.loadEventHandler; + this.el.src = this.src; + + }, + + + /* + * Function: onLoad + */ + onLoad: function(){ + + this.naturalWidth = Util.coalesce(this.el.naturalWidth, this.el.width); + this.naturalHeight = Util.coalesce(this.el.naturalHeight, this.el.height); + this.isLandscape = (this.naturalWidth > this.naturalHeight); + this.isLoading = false; + this.hasLoaded = true; + + this.dispatchEvent(Code.PhotoSwipe.FullSizeImageClass.EventTypes.onLoad); + + } + + + }); + + + Code.PhotoSwipe.FullSizeImageClass.EventTypes = { + onLoad: 'onLoad' + }; + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.DocumentOverlayClass + */ + Code.PhotoSwipe.DocumentOverlayClass = Code.PhotoSwipe.ElementClass.extend({ + + /* + * Function: init + */ + init: function(options){ + + this._super(options); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.DocumentOverlayClass.CssClasses.documentOverlay }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.bodyHeight()); + + } + + }); + + + Code.PhotoSwipe.DocumentOverlayClass.CssClasses = { + documentOverlay: 'ps-document-overlay' + }; + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ViewportClass + */ + Code.PhotoSwipe.ViewportClass = Code.PhotoSwipe.ElementClass.extend({ + + touchStartPoint: null, + touchFingerCount: null, + touchCancelsMouseEvents: null, + + touchStartHandler: null, + touchMoveHandler: null, + touchEndHandler: null, + + mouseDownHandler: null, + mouseUpHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + swipeThreshold: 500 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.touchFingerCount = 0; + this.touchStartPoint = { x: 0, y: 0 }; + this.touchCancelsMouseEvents = false; + + this.touchStartHandler = this.onTouchStart.bind(this); + this.touchMoveHandler = this.onTouchMove.bind(this); + this.touchEndHandler = this.onTouchEnd.bind(this); + + this.mouseDownHandler = this.onMouseDown.bind(this); + this.mouseUpHandler = this.onMouseUp.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ViewportClass.CssClasses.viewport }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + left: 0, + overflow: 'hidden' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.setStyle(this.el, { + top: Util.DOM.windowScrollTop() + 'px' + }); + + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.windowHeight()); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + try{ + Util.DOM.addEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.addEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.addEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.addEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.addEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + try{ + Util.DOM.removeEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.removeEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.removeEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.removeEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.removeEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: setCurrentTouchPoint + */ + setCurrentTouchPoint: function(touchPoint, touches){ + + this.touchFingerCount = touches.length; + + if (this.touchFingerCount === 1){ + touchPoint.x = touches[0].pageX; + touchPoint.y = touches[0].pageY; + } + else{ + this.touchFingerCount = 0; + touchPoint.x = 0; + touchPoint.y = 0; + } + + }, + + + + /* + * Function: onTouch + */ + onTouchStart: function(e){ + + e.preventDefault(); + + this.setCurrentTouchPoint(this.touchStartPoint, Util.DOM.getTouchEvent(e).touches); + + }, + + + + /* + * Function: onTouchMove + * For some reason, even though it's not a requirement, + * if we don't listen out for the touchmove event, + * we are unable to detect the swipe on Blackberry6 + */ + onTouchMove: function(e){ + + e.preventDefault(); + + }, + + + + /* + * Function: onTouchEnd + */ + onTouchEnd: function(e){ + + e.preventDefault(); + + var touchEndPoint = { x:0, y:0 }; + + var touchEvent = Util.DOM.getTouchEvent(e); + + if (!Util.isNothing(touchEvent.changedTouches)){ + // http://backtothecode.blogspot.com/2009/10/javascript-touch-and-gesture-events.html + // iOS removed the current touch from e.touches on "touchend" + // Need to look into e.changedTouches + this.setCurrentTouchPoint(touchEndPoint, touchEvent.changedTouches); + } + else{ + this.setCurrentTouchPoint(touchEndPoint, touchEvent.touches); + } + + if (this.touchFingerCount == 1){ + + this.fireTouchEvent(this.touchStartPoint, touchEndPoint); + + } + + }, + + + + /* + * Function: onMouseDown + */ + onMouseDown: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.touchStartPoint = Util.DOM.getMousePosition(e); + + }, + + + + /* + * Function: onMouseUp + */ + onMouseUp: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.fireTouchEvent(this.touchStartPoint, Util.DOM.getMousePosition(e)); + + }, + + + + /* + * Function: fireTouchEvent + */ + fireTouchEvent: function(touchStartPoint, touchEndPoint){ + + var action; + + var distance = touchEndPoint.x - touchStartPoint.x; + + if (Math.abs(distance) >= this.settings.swipeThreshold){ + + if (distance < 0){ + + // Swipe left + action = Code.PhotoSwipe.ViewportClass.Actions.swipeLeft; + + } + else{ + + // Swipe right + action = Code.PhotoSwipe.ViewportClass.Actions.swipeRight; + + } + + } + else{ + + // Click + action = Code.PhotoSwipe.ViewportClass.Actions.click; + + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ViewportClass.EventTypes.onTouch, + target: this, + action: action + }); + + } + + }); + + + Code.PhotoSwipe.ViewportClass.CssClasses = { + viewport: 'ps-viewport' + }; + + + Code.PhotoSwipe.ViewportClass.Actions = { + click: 'click', + swipeLeft: 'swipeLeft', + swipeRight: 'swipeRight' + }; + + Code.PhotoSwipe.ViewportClass.EventTypes = { + onTouch: 'onTouch' + }; + + +})(Code.PhotoSwipe.Util); + +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, FullSizeImageClass){ + + /* + * Class: Code.PhotoSwipe.SliderItemClass + */ + Code.PhotoSwipe.SliderItemClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + imageEl: null, + parentEl: null, + fullSizeImage: null, + + fullSizeImageLoadEventHandler: null, + + /* + * Function: init + */ + init: function(parentEl){ + + this._super(); + + this.parentEl = parentEl; + + this.fullSizeImageLoadEventHandler = this.onFullSizeImageLoad.bind(this); + + // Create element and append to parentEl + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.SliderItemClass.CssClasses.item + ' ' + Code.PhotoSwipe.SliderItemClass.CssClasses.loading }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + top: 0 + }); + Util.DOM.resetTranslate(this.el); + Util.DOM.appendChild(this.el, this.parentEl); + + // Create image element and append to slider item + this.imageEl = new Image(); + Util.DOM.setStyle(this.imageEl, { + display: 'block', + position: 'absolute', + margin: 0, + padding: 0 + }); + Util.DOM.hide(this.imageEl); + Util.DOM.appendChild(this.imageEl, this.el); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(width, height, xPos){ + + Util.DOM.width(this.el, width); + Util.DOM.height(this.el, height); + Util.DOM.setStyle(this.el, 'left', xPos + 'px'); + + this.resetImagePosition(); + + }, + + + + /* + * Function: resetImagePosition + */ + resetImagePosition: function(){ + + if (Util.isNothing(this.fullSizeImage)){ + return; + } + + var src = Util.DOM.getAttribute(this.imageEl, 'src'); + + var + scale, + newWidth, + newHeight, + newTop, + newLeft, + maxWidth = Util.DOM.width(this.el), + maxHeight = Util.DOM.height(this.el); + + if (this.fullSizeImage.isLandscape) { + // Ensure the width fits the screen + scale = maxWidth / this.fullSizeImage.naturalWidth; + } + else { + // Ensure the height fits the screen + scale = maxHeight / this.fullSizeImage.naturalHeight; + } + + newWidth = Math.round(this.fullSizeImage.naturalWidth * scale); + newHeight = Math.round(this.fullSizeImage.naturalHeight * scale); + + if (this.fullSizeImage.scaleMethod === 'fit') { + // Rescale again to ensure full image fits into the viewport + scale = 1; + if (newWidth > maxWidth) { + scale = maxWidth / newWidth; + } + else if (newHeight > maxHeight) { + scale = maxHeight / newHeight; + } + if (scale !== 1) { + newWidth = Math.round(newWidth * scale); + newHeight = Math.round(newHeight * scale); + } + } + + newTop = ((maxHeight - newHeight) / 2) + 'px'; + newLeft = ((maxWidth - newWidth) / 2) + 'px'; + + Util.DOM.width(this.imageEl, newWidth); + Util.DOM.height(this.imageEl, newHeight); + Util.DOM.setStyle(this.imageEl, { + top: newTop, + left: newLeft + }); + + Util.DOM.show(this.imageEl); + + }, + + + + /* + * Function: setFullSizeImage + */ + setFullSizeImage: function(fullSizeImage){ + + this.fullSizeImage = fullSizeImage; + + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + + // Something is wrong! + if (Util.isNothing(this.fullSizeImage)) { + this.fullSizeImage = null; + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + this.hideImage(); + return; + } + + // Still loading + if (!this.fullSizeImage.hasLoaded) { + + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + this.hideImage(); + + if (!this.fullSizeImage.isLoading){ + + // Trigger off the load + this.fullSizeImage.addEventListener( + FullSizeImageClass.EventTypes.onLoad, + this.fullSizeImageLoadEventHandler + ); + + + this.fullSizeImage.load(); + + } + + return; + + } + + // Loaded so show the image + Util.DOM.setAttribute(this.imageEl, 'src', this.fullSizeImage.src); + + this.resetImagePosition(); + + this.dispatchEvent(Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageDisplay); + + }, + + + /* + * Function: onFullSizeImageLoad + */ + onFullSizeImageLoad: function(e){ + + e.target.removeEventListener(FullSizeImageClass.EventTypes.onLoad, this.fullSizeImageLoadEventHandler); + + if (Util.isNothing(this.fullSizeImage) || e.target.index !== this.fullSizeImage.index){ + // Chances are the user has moved the slider + // and the image to display in the item has now changed + // from when the item originally called the fullSizeImage + // to load. If that's the case, rethrow the event, the + // slider will be listening for this and can find a + // relevant slideitem for the loaded image + this.dispatchEvent({ + type: Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageLoadAnomaly, + target: this, + fullSizeImage: e.target + }); + } + else{ + this.setFullSizeImage(e.target); + } + + }, + + + /* + * Function: hideImage + */ + hideImage: function(){ + + Util.DOM.removeAttribute(this.imageEl, 'src'); + Util.DOM.hide(this.imageEl); + + } + + + }); + + + Code.PhotoSwipe.SliderItemClass.CssClasses = { + item: 'ps-slider-item', + loading: 'ps-slider-item-loading', + imageError: 'ps-slider-item-image-error' + }; + + + Code.PhotoSwipe.SliderItemClass.EventTypes = { + onFullSizeImageDisplay: 'onFullSizeImageDisplay', + onFullSizeImageLoadAnomaly: 'onFullSizeImageLoadAnomaly' + }; + + +})(Code.PhotoSwipe.Util, Code.PhotoSwipe.FullSizeImageClass);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, SliderItemClass){ + + /* + * Class: Code.PhotoSwipe.SliderClass + */ + Code.PhotoSwipe.SliderClass = Code.PhotoSwipe.ElementClass.extend({ + + parentEl: null, + parentElWidth: null, + parentElHeight: null, + items: null, + + previousItem: null, + currentItem: null, + nextItem: null, + + hasBounced: null, + lastShowAction: null, + bounceSlideBy: null, + + showNextEndEventHandler: null, + showPreviousEndEventHandler: null, + bounceStepOneEventHandler: null, + bounceStepTwoEventHandler: null, + + sliderFullSizeImageLoadAnomalyEventHandler: null, + + + /* + * Function: init + */ + init: function(options, parentEl){ + + this.settings = { + slideSpeed: 250 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.parentEl = parentEl; + + this.hasBounced = false; + + this.showNextEndEventHandler = this.onShowNextEnd.bind(this); + this.showPreviousEndEventHandler = this.onShowPreviousEnd.bind(this); + this.bounceStepOneEventHandler = this.onBounceStepOne.bind(this); + this.bounceStepTwoEventHandler = this.onBounceStepTwo.bind(this); + + this.sliderFullSizeImageLoadAnomalyEventHandler = this.onSliderFullSizeImageLoadAnomaly.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.SliderClass.CssClasses.slider }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendChild(this.el, parentEl); + + // Create previousItem, currentItem, nextItem + this.items = []; + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + + this.previousItem = this.items[0]; + this.currentItem = this.items[1]; + this.nextItem = this.items[2]; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + for (var i = 0; i 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.captionDelay + ); + + } + + this._super(); + + } + + }); + + + Code.PhotoSwipe.CaptionClass.CssClasses = { + caption: 'ps-caption', + bottom: 'ps-caption-bottom', + content: 'ps-caption-content' + }; + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ToolbarClass + */ + Code.PhotoSwipe.ToolbarClass = Code.PhotoSwipe.ElementClass.extend({ + + closeEl: null, + previousEl: null, + nextEl: null, + playEl: null, + + clickHandler: null, + + fadeOutTimeout: null, + isNextActive: null, + isPreviousActive: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + toolbarDelay: 4000, + position: 'bottom' + }; + + Util.extend(this.settings, options); + + this._super(options); + + this.isNextActive = true; + this.isPreviousActive = true; + + this.clickHandler = this.onClick.bind(this); + + // Create element and append to body + var cssClass = Code.PhotoSwipe.ToolbarClass.CssClasses.caption; + if (this.settings.position === 'top'){ + cssClass = cssClass + ' ' + Code.PhotoSwipe.ToolbarClass.CssClasses.top; + } + + this.el = Util.DOM.createElement('div', { 'class': cssClass }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + overflow: 'hidden', + zIndex: 1001, + display: 'table' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + // Close + this.closeEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.close }, '
'); + Util.DOM.appendChild(this.closeEl, this.el); + + // Play + this.playEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.play }, '
'); + Util.DOM.appendChild(this.playEl, this.el); + + // Previous + this.previousEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.previous }, '
'); + Util.DOM.appendChild(this.previousEl, this.el); + + // Next + this.nextEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.next }, '
'); + Util.DOM.appendChild(this.nextEl, this.el); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + Util.DOM.addEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + Util.DOM.removeEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: onClick + */ + onClick: function(e){ + + var action; + + switch(e.target.parentNode){ + + case this.previousEl: + if (this.isPreviousActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.previous; + } + break; + + case this.nextEl: + if (this.isNextActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.next; + } + break; + + case this.playEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.play; + break; + + case this.closeEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.close; + break; + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ToolbarClass.EventTypes.onClick, + target: this, + action: action + }); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + var top; + + if (this.settings.position === 'bottom') { + top = Util.DOM.windowHeight() - Util.DOM.height(this.el) + Util.DOM.windowScrollTop(); + } + else { + top = Util.DOM.windowScrollTop(); + } + + Util.DOM.setStyle(this.el, 'top', top + 'px'); + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + + }, + + + + /* + * Function: stopFade + */ + stopFade: function(){ + + window.clearTimeout(this.fadeOutTimeout); + this._super(); + + }, + + + + /* + * Function: postShow + */ + postShow: function(){ + + if (this.settings.toolbarDelay > 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.toolbarDelay + ); + + } + + this._super(); + + }, + + + /* + * Function: setNextState + */ + setNextState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = false; + } + else { + Util.DOM.removeClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = true; + } + + }, + + + /* + * Function: setPreviousState + */ + setPreviousState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = false; + } + else { + Util.DOM.removeClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = true; + } + + } + + }); + + + + Code.PhotoSwipe.ToolbarClass.CssClasses = { + caption: 'ps-toolbar', + top: 'ps-toolbar-top', + close: 'ps-toolbar-close', + previous: 'ps-toolbar-previous', + previousDisabled: 'ps-toolbar-previous-disabled', + next: 'ps-toolbar-next', + nextDisabled: 'ps-toolbar-next-disabled', + play: 'ps-toolbar-play', + content: 'ps-toolbar-content' + }; + + + + Code.PhotoSwipe.ToolbarClass.Actions = { + close: 'close', + previous: 'previous', + next: 'next', + play: 'play' + }; + + + Code.PhotoSwipe.ToolbarClass.EventTypes = { + onClick: 'onClick' + }; + +})(Code.PhotoSwipe.Util); + // PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, ElementClass, DocumentOverlayClass, FullSizeImageClass, ViewportClass, SliderClass, CaptionClass, ToolbarClass){ + + var photoSwipe = Code.PhotoSwipe.EventClass.extend({ + + fullSizeImages: null, + + documentOverlay: null, + viewport: null, + slider: null, + caption: null, + toolbar: null, + + settings: null, + slideShowSettingsSaved: null, + currentIndex: null, + isBusy: null, + + slideshowTimeout: null, + + + documentOverlayFadeInEventHandler: null, + windowResizeEventHandler: null, + windowOrientationChangeEventHandler: null, + windowScrollEventHandler: null, + keyDownEventHandler: null, + viewportTouchEventHandler: null, + viewportFadeOutEventHandler: null, + sliderDisplayCurrentFullSizeImageEventHandler: null, + toolbarClickEventHandler: null, + + + /* + * Function: init + */ + init: function(){ + + this._super(); + + this.currentIndex = 0; + this.isBusy = false; + + this.settings = { + getImageSource: Code.PhotoSwipe.GetImageSource, + getImageCaption: Code.PhotoSwipe.GetImageCaption, + fadeSpeed: 400, + slideSpeed: 250, + swipeThreshold: 50, + loop: true, + + flipCaptionAndToolbar: false, + + captionDelay: 3000, + captionOpacity: 0.8, + hideCaption: false, + showEmptyCaptions: true, + + toolbarDelay: 3000, + toolbarOpacity: 0.8, + hideToolbar: false, + + slideshowDelay: 3000, + + imageScaleMethod: 'fit' // Either "fit" or "zoom" + }; + + // Set pointers to event handlers + this.documentOverlayFadeInEventHandler = this.onDocumentOverlayFadeIn.bind(this); + this.windowResizeEventHandler = this.onWindowResize.bind(this); + this.windowOrientationChangeEventHandler = this.onWindowOrientationChange.bind(this); + this.windowScrollEventHandler = this.onWindowScroll.bind(this); + this.keyDownEventHandler = this.onKeyDown.bind(this); + this.viewportTouchEventHandler = this.onViewportTouch.bind(this); + this.viewportFadeOutEventHandler = this.onViewportFadeOut.bind(this); + this.sliderDisplayCurrentFullSizeImageEventHandler = this.onSliderDisplayCurrentFullSizeImage.bind(this); + this.toolbarClickEventHandler = this.onToolbarClick.bind(this); + + }, + + + + /* + * Function: setOptions + */ + setOptions: function(options){ + + Util.extend(this.settings, options); + + }, + + + + /* + * Function: setImages + * Set images from DOM elements. Could be a list of image + * elments or anchors containing image elements etc. + * By default the gallery assumes the latter. If you change + * this, remember to set your own getImageSource and getImageCaption + * methods so the gallery knows what to look for. + */ + setImages: function(thumbEls){ + + if (!Util.isArray){ + throw "thumbEls is not an array"; + } + + this.currentIndex = 0; + + this.fullSizeImages = []; + + for (var i=0; i= this.fullSizeImages.length){ + startingIndex = 0; + } + + this.currentIndex = startingIndex; + + if (Util.isNothing(this.documentOverlay)){ + this.build(); + } + + // Fade in the document overlay, + // then show the viewport, slider and toolbar etc + this.documentOverlay.addEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.documentOverlay.fadeIn(); + + }, + + + + /* + * Function: build + */ + build: function(){ + + // Create the document overlay + this.documentOverlay = new DocumentOverlayClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed + }); + + // Create the viewport + this.viewport = new ViewportClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + swipeThreshold: this.settings.swipeThreshold + }); + + // Create the slider + this.slider = new SliderClass( + { + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + slideSpeed: this.settings.slideSpeed + }, + this.viewport.el + ); + + // Create the caption bar + this.caption = new CaptionClass({ + opacity: this.settings.captionOpacity, + fadeSpeed: this.settings.fadeSpeed, + captionDelay: this.settings.captionDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'bottom' : 'top' + }); + + + // Create the toolbar + this.toolbar = new ToolbarClass({ + opacity: this.settings.toolbarOpacity, + fadeSpeed: this.settings.fadeSpeed, + toolbarDelay: this.settings.toolbarDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'top' : 'bottom' + }); + + }, + + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + // Set window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.addEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + Util.DOM.addEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.addEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Set keydown event handlers for desktop browsers + Util.DOM.addEventListener(document, 'keydown', this.keyDownEventHandler); + + // Set viewport handlers + this.viewport.addEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Set slider handlers + this.slider.addEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Set toolbar handlers + this.toolbar.addEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + // Remove window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.removeEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + + Util.DOM.removeEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.removeEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Remove keydown event handlers for desktop browsers + Util.DOM.removeEventListener(document, 'keydown', this.keyDownEventHandler); + + // Remove viewport handlers + this.viewport.removeEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Remove slider handlers + this.slider.removeEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Remove toolbar handlers + this.toolbar.removeEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: onDocumentOverlayFadeIn + */ + onDocumentOverlayFadeIn: function(e){ + + // Remove the ElementClass.EventTypes.onFadeIn + // event handler + this.documentOverlay.removeEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.viewport.show(); + + this.slider.show(); + + this.toolbar.show(); + + this.addEventListeners(); + + this.slider.setCurrentFullSizeImage(this.fullSizeImages[this.currentIndex]); + + this.isBusy = false; + + }, + + + /* + * Function: setSliderPreviousAndNextFullSizeImages + */ + setSliderPreviousAndNextFullSizeImages: function(){ + + var + lastIndex, + previousFullSizeImage = null, + nextFullSizeImage = null; + + if (this.fullSizeImages.length > 1) { + + lastIndex = this.fullSizeImages.length - 1; + + // Current image is the last + if (this.currentIndex === lastIndex) { + + if (this.settings.loop) { + nextFullSizeImage = this.fullSizeImages[0]; + } + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + // Current image is the first + else if (this.currentIndex === 0) { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + if (this.settings.loop) { + previousFullSizeImage = this.fullSizeImages[lastIndex]; + } + + } + + // Current image is in the middle of the thumbs + else { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + } + + this.slider.setPreviousAndNextFullSizeImages(previousFullSizeImage, nextFullSizeImage); + + }, + + + + /* + * Function: onWindowResize + */ + onWindowResize: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onKeyDown + */ + onKeyDown: function(e){ + + if (e.keyCode === 37) { // Left + e.preventDefault(); + this.showPrevious(); + } + else if (e.keyCode === 39) { // Right + e.preventDefault(); + this.showNext(); + } + else if (e.keyCode === 38 || e.keyCode === 40) { // Up and down + e.preventDefault(); + } + else if (e.keyCode === 27) { // Escape + e.preventDefault(); + //this.pause(); + this.hide(); + } + else if (e.keyCode === 32) { // Spacebar + e.preventDefault(); + } + + }, + + + + /* + * Function: onWindowOrientationChange + */ + onWindowOrientationChange: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onWindowScroll + */ + onWindowScroll: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + if (this.isBusy){ + return; + } + + this.documentOverlay.resetPosition(); + this.viewport.resetPosition(); + this.slider.resetPosition(); + this.caption.resetPosition(); + this.toolbar.resetPosition(); + + }, + + + + /* + * Function: onViewportClick + */ + onViewportTouch: function(e){ + + switch(e.action){ + + case ViewportClass.Actions.swipeLeft: + this.showNext(); + break; + + case ViewportClass.Actions.swipeRight: + this.showPrevious(); + break; + + default: + if (this.isSlideShowActive() || !this.settings.hideToolbar){ + this.showCaptionAndToolbar(); + } + else{ + this.hide(); + } + break; + + } + + }, + + + + /* + * Function: onViewportFadeOut + */ + onViewportFadeOut: function(e){ + + this.viewport.removeEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.isBusy = false; + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.removeEventListeners(); + + this.documentOverlay.hide(); + this.caption.hide(); + this.toolbar.hide(); + this.slider.hide(); + + Util.DOM.removeClass(document.body, Code.PhotoSwipe.CssClasses.activeBody); + + this.viewport.addEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.viewport.fadeOut(); + + }, + + + + /* + * Function: showNext + */ + showNext: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showNext(); + + }, + + + + /* + * Function: showPrevious + */ + showPrevious: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showPrevious(); + + }, + + + + + /* + * Function: onSliderDisplayCurrentFullSizeImage + */ + onSliderDisplayCurrentFullSizeImage: function(e){ + + this.currentIndex = e.fullSizeImage.index; + + // Set the previous and next images for the slider + this.setSliderPreviousAndNextFullSizeImages(); + + this.isBusy = false; + + if (this.isSlideShowActive()){ + if (!this.settings.loop && this.currentIndex === this.fullSizeImages.length-1){ + // Slideshow as reached the end + this.slideshowTimeout = window.setTimeout( + this.showCaptionAndToolbar.bind(this), + this.settings.slideshowDelay + ); + } + else{ + this.fireSlideshowTimeout(); + } + } + else{ + this.showCaptionAndToolbar(); + } + + }, + + + /* + * Function: showCaptionAndToolbar + */ + showCaptionAndToolbar: function(captionValue){ + + this.stopSlideshow(); + + + // Caption + if (this.settings.hideCaption){ + this.caption.hide(); + } + else{ + captionValue = Util.coalesce(captionValue, this.fullSizeImages[this.currentIndex].caption); + + if ( (Util.isNothing(captionValue) || captionValue === '') && !this.settings.showEmptyCaptions ){ + this.caption.hide(); + return; + } + + this.caption.show(captionValue); + } + + + + // Toolbar + if (this.settings.hideToolbar){ + this.toolbar.hide(); + } + else{ + if (this.settings.loop) { + this.toolbar.setNextState(false); + this.toolbar.setPreviousState(false); + } + else{ + if (this.currentIndex >= this.fullSizeImages.length - 1) { + this.toolbar.setNextState(true); + } + else { + this.toolbar.setNextState(false); + } + + if (this.currentIndex < 1) { + this.toolbar.setPreviousState(true); + } + else { + this.toolbar.setPreviousState(false); + } + } + + this.toolbar.show(); + } + + }, + + + + /* + * Function: onToolbarClick + */ + onToolbarClick: function(e){ + + switch (e.action){ + + case ToolbarClass.Actions.previous: + this.showPrevious(); + break; + + case ToolbarClass.Actions.next: + this.showNext(); + break; + + case ToolbarClass.Actions.play: + this.startSlideshow(); + break; + + default: + this.hide(); + break; + + } + + }, + + + + /* + * Function: startSlideshow + */ + startSlideshow: function(){ + + if (this.isBusy){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.slideShowSettingsSaved = { + hideCaption: this.settings.hideCaption, + hideToolbar: this.settings.hideToolbar + }; + + this.settings.hideCaption = true; + this.settings.hideToolbar = true; + + this.caption.fadeOut(); + this.toolbar.fadeOut(); + + this.fireSlideshowTimeout(); + + }, + + + + /* + * Function: stopSlideshow + */ + stopSlideshow: function(){ + + if (!this.isSlideShowActive()){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.settings.hideCaption = this.slideShowSettingsSaved.hideCaption; + this.settings.hideToolbar = this.slideShowSettingsSaved.hideToolbar; + + this.slideShowSettingsSaved = null; + + }, + + + /* + * Function: isSlideShowActive + */ + isSlideShowActive: function(){ + + return (!Util.isNothing(this.slideShowSettingsSaved)); + + }, + + + /* + * Function: fireSlideshowTimeout + */ + fireSlideshowTimeout: function(){ + + this.slideshowTimeout = window.setTimeout( + this.showNext.bind(this), + this.settings.slideshowDelay + ); + + } + + + }); + + + Code.PhotoSwipe.CssClasses = { + activeBody: 'ps-active' + }; + + /* + * Function: Code.PhotoSwipe.GetImageSource + * Default method for returning an image's source + */ + Code.PhotoSwipe.GetImageSource = function(el){ + return el.href; + }; + + + + /* + * Function: Code.PhotoSwipe.GetImageCaption + * Default method for returning an image's caption + * Assumes the el is an anchor and the first child is the + * image. The returned value is the "alt" attribute of the + * image. + */ + Code.PhotoSwipe.GetImageCaption = function(el){ + if (el.nodeName === "IMG"){ + return Util.DOM.getAttribute(el, 'alt'); + } + return Util.DOM.getAttribute(el.firstChild, 'alt'); + }; + + + Code.PhotoSwipe.Current = new photoSwipe(); + + + Code.photoSwipe = function(thumbEls, containerEl, opts){ + + var useEventDelegation = true; + + if (Util.isNothing(thumbEls)){ + return; + } + + /* See if there is a container element, if so we will use event delegation */ + + if (Util.isNothing(containerEl)){ + containerEl = document.documentElement; + useEventDelegation = false; + } + + if (Util.isString(containerEl)){ + containerEl = document.documentElement.querySelector(containerEl); + } + + if (Util.isNothing(containerEl)){ + throw 'Unable to find container element'; + } + + if (Util.isString(thumbEls)){ + thumbEls = containerEl.querySelectorAll(thumbEls); + } + + if (Util.isNothing(thumbEls)){ + return; + } + + + // Set up the options + Code.PhotoSwipe.Current.setOptions(opts); + + + // Tell PhotoSwipe about the photos + Code.PhotoSwipe.Current.setImages(thumbEls); + + + if (useEventDelegation){ + + /* + * Use event delegation rather than setting a click event on each + * thumb element. + */ + containerEl.addEventListener('click', function(e){ + + if (e.target === e.currentTarget){ + return; + } + + e.preventDefault(); + + var findNode = function(clickedEl, targetNodeName, stopAtEl){ + + if (Util.isNothing(clickedEl) || Util.isNothing(targetNodeName) || Util.isNothing(stopAtEl)){ + return null; + } + + if (clickedEl.nodeName === targetNodeName){ + return clickedEl; + } + + if (clickedEl === stopAtEl){ + return null; + } + + return findNode(clickedEl.parentNode, targetNodeName, stopAtEl) + }; + + + var clickedEl = findNode(e.target, thumbEls[0].nodeName, e.currentTarget); + + if (Util.isNothing(clickedEl)){ + return; + } + + showPhotoSwipe(clickedEl); + + }, false); + + } + else{ + + // Add a click event handler on each element + for (var i = 0; i < thumbEls.length; i++){ + + var thumbEl = thumbEls[i]; + thumbEl.addEventListener('click', function(e){ + + e.preventDefault(); + + showPhotoSwipe(e.currentTarget); + + }, false); + + } + + } + + + var showPhotoSwipe = function(clickedEl){ + + var startingIndex = 0; + for (startingIndex; startingIndex < thumbEls.length; startingIndex++){ + if (thumbEls[startingIndex] === clickedEl){ + break; + } + } + + Code.PhotoSwipe.Current.show(startingIndex); + + }; + + }; + + + + /* + * jQuery plugin + */ + if (!Util.isNothing(window.jQuery)){ + + window.jQuery.fn.photoSwipe = function (opts) { + + var thumbEls = this; + Code.PhotoSwipe.Current.setOptions(opts); + Code.PhotoSwipe.Current.setImages(thumbEls); + + $(thumbEls).live('click', function(e){ + + e.preventDefault(); + + var startingIndex = $(thumbEls).index($(e.currentTarget)); + Code.PhotoSwipe.Current.show(startingIndex); + + }); + + }; + + } + + +}) +( + Code.PhotoSwipe.Util, + Code.PhotoSwipe.ElementClass, + Code.PhotoSwipe.DocumentOverlayClass, + Code.PhotoSwipe.FullSizeImageClass, + Code.PhotoSwipe.ViewportClass, + Code.PhotoSwipe.SliderClass, + Code.PhotoSwipe.CaptionClass, + Code.PhotoSwipe.ToolbarClass +); \ No newline at end of file diff --git a/artifact/1.0.0/code-photoswipe-1.0.0.min.js b/artifact/1.0.0/code-photoswipe-1.0.0.min.js new file mode 100644 index 000000000..6e0f5da3d --- /dev/null +++ b/artifact/1.0.0/code-photoswipe-1.0.0.min.js @@ -0,0 +1,147 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license +// version: 1.0.0.111 + +(function(){if(!Function.prototype.bind){Function.prototype.bind=function(obj){var slice=[].slice,args=slice.call(arguments,1),self=this,nop=function(){},bound=function(){return self.apply(this instanceof nop?this:(obj||{}),args.concat(slice.call(arguments)));};nop.prototype=self.prototype;bound.prototype=new nop();return bound;};} +if(typeof Code==="undefined"){Code={};Code.PhotoSwipe={};} +Code.PhotoSwipe.Util={browser:{version:(navigator.userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1],webkit:/webkit/.test(navigator.userAgent),opera:/opera/.test(navigator.userAgent),msie:/msie/.test(navigator.userAgent)&&!/opera/.test(navigator.userAgent),mozilla:/mozilla/.test(navigator.userAgent)&&!/(compatible|webkit)/.test(navigator.userAgent),mobileSafari:/Mac OS X.*Mobile.*Safari/.test(navigator.userAgent)},setElementData:function(el,key,value){if(this.isNothing(el.UtilData)){el.UtilData={};} +el.UtilData[key]=value;},getElementData:function(el,key,defaultValue){if(typeof defaultValue==="undefined"){defaultValue=null;} +if(this.isNothing(el.UtilData)){return defaultValue;} +if(this.isNothing(el.UtilData[key])){return defaultValue;} +return el.UtilData[key];},removeElementData:function(el,key){delete el.UtilData[key];},coalesce:function(){var i;for(i=0;i=1){parentEl.removeChild(parentEl.childNodes[parentEl.childNodes.length-1]);}}},hasAttribute:function(el,attributeName){return el.getAttribute(attributeName);},getAttribute:function(el,attributeName){if(!this.hasAttribute(el,attributeName)){return'';} +return el.getAttribute(attributeName);},setAttribute:function(el,attributeName,value){el.setAttribute(attributeName,value);},removeAttribute:function(el,attributeName){if(this.hasAttribute(el,attributeName)){el.removeAttribute(attributeName);}},addClass:function(el,className){var currentClassValue=Util.DOM.getAttribute(el,'class');var re=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)');if(!re.test(currentClassValue)){if(currentClassValue!=''){currentClassValue=currentClassValue+' ';} +currentClassValue=currentClassValue+className;Util.DOM.setAttribute(el,'class',currentClassValue);}},removeClass:function(el,className){var currentClassValue=Util.DOM.getAttribute(el,'class');var re=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)');if(re.test(currentClassValue)){currentClassValue=currentClassValue.replace(re,' ');Util.DOM.setAttribute(el,'class',currentClassValue);Util.DOM.removeClass(el,className);} +else{currentClassValue=Util.trim(currentClassValue);if(currentClassValue===''){Util.DOM.removeAttribute(el,'class');} +else{Util.DOM.setAttribute(el,'class',currentClassValue);}}},hasClass:function(el,className){var re=new RegExp('(?:^|\\s+)'+className+'(?:\\s+|$)');return re.test(Util.DOM.getAttribute(el,'class'));},setStyle:function(el,style,value){if(Util.isObject(style)){for(var propertyName in style){if(style.hasOwnProperty(propertyName)){el.style[propertyName]=style[propertyName];}}} +else{el.style[style]=value;}},getStyle:function(el,styleName){return window.getComputedStyle(el,'').getPropertyValue(styleName);},hide:function(el){Util.setElementData(el,'oldDisplayValue',Util.DOM.getStyle(el,'display'));Util.DOM.setStyle(el,'display','none');},show:function(el){if(Util.DOM.getStyle(el,'display')==='none'){var oldDisplayValue=Util.getElementData(el,'oldDisplayValue','block');if(oldDisplayValue==='none'){oldDisplayValue='block';} +Util.DOM.setStyle(el,'display',oldDisplayValue);}},width:function(el,value){if(!Util.isNothing(value)){if(Util.isNumber(value)){value=value+'px';} +el.style.width=value;} +return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('width'));},outerWidth:function(el){return el.offsetWidth;},height:function(el,value){if(!Util.isNothing(value)){if(Util.isNumber(value)){value=value+'px';} +el.style.height=value;} +return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('height'));},outerHeight:function(el){return el.offsetHeight;},documentWidth:function(){return Util.DOM.width(document.documentElement);},documentHeight:function(){return Math.round(Util.DOM.height(document.documentElement));},bodyWidth:function(){return Util.DOM.width(document.body);},bodyHeight:function(){return Util.DOM.height(document.body);},windowWidth:function(){return window.innerWidth;},windowHeight:function(){return window.innerHeight;},windowScrollLeft:function(){return window.pageXOffset;},windowScrollTop:function(){return window.pageYOffset;},addEventListener:function(el,type,listener){el.addEventListener(type,listener,false);},removeEventListener:function(el,type,listener){el.removeEventListener(type,listener,false);},getMousePosition:function(event){var retval={x:0,y:0} +if(event.pageX){retval.x=event.pageX;} +else if(event.clientX){retval.x=event.clientX+(document.documentElement.scrollLeft?document.documentElement.scrollLeft:document.body.scrollLeft);} +if(event.pageY){retval.y=event.pageY;} +else if(event.clientY){retval.y=event.clientY+(document.documentElement.scrollTop?document.documentElement.scrollTop:document.body.scrollTop);} +return retval;},getTouchEvent:function(event){return event;}}});})(Code.PhotoSwipe.Util);(function(Util){Util.extend(Util,{Animation:{_applyTransitionDelay:100,_setTransition:function(el,property,duration,timingFunction,delay,callback){var +transitionPrefix=Util.Animation._getTransitionPrefix(),p=Util.coalesce(property,''),d=Util.coalesce(duration,''),t,de,c;if(Util.isFunction(timingFunction)){c=timingFunction;t='';de='';} +else{c=callback;t=Util.coalesce(timingFunction,'');de=Util.coalesce(delay,'');} +Util.DOM.setStyle(el,transitionPrefix+'Property',p);Util.DOM.setStyle(el,transitionPrefix+'Duration',d);Util.DOM.setStyle(el,transitionPrefix+'TimingFunction',t);Util.DOM.setStyle(el,transitionPrefix+'Delay',de);if(Util.isFunction(c)){window.setTimeout(function(){c(el);},Util.Animation._applyTransitionDelay);}},_setTransitionEndEventListener:function(el){Util.setElementData(el,'transitionEndEvent',function(e){var el=e.target;Util.DOM.removeEventListener(el,Util.Animation._getTransitionEndEventLabel(),Util.getElementData(el,'transitionEndEvent'));Util.removeElementData(el,'transitionEndEvent');var callback=Util.getElementData(el,'transitionEndCallback');Util.removeElementData(el,'transitionEndCallback');Util.Animation._removeTransitions(el);if(Util.isFunction(callback)){window.setTimeout(function(){callback(e);},Util.Animation._applyTransitionDelay);}});Util.DOM.addEventListener(el,Util.Animation._getTransitionEndEventLabel(),Util.getElementData(el,'transitionEndEvent'));},_removeTransitions:function(el){var transitionPrefix=Util.Animation._getTransitionPrefix();Util.DOM.setStyle(el,transitionPrefix+'Property','');Util.DOM.setStyle(el,transitionPrefix+'Duration','');Util.DOM.setStyle(el,transitionPrefix+'TimingFunction','');Util.DOM.setStyle(el,transitionPrefix+'Delay','');},_getTransitionEndEventLabel:function(){return(document.documentElement.style.WebkitTransition!==undefined)?"webkitTransitionEnd":"transitionend";},_getTransitionPrefix:function(){return(document.documentElement.style.WebkitTransition!==undefined)?"webkitTransition":(document.documentElement.style.MozTransition!==undefined)?"MozTransition":"transition";},stopFade:function(el){Util.DOM.removeEventListener(el,Util.Animation._getTransitionEndEventLabel(),Util.getElementData(el,'transitionEndEvent'));var transitionPrefix=Util.Animation._getTransitionPrefix();var currentOpacity=window.getComputedStyle(el,'').getPropertyValue('opacity');Util.Animation._removeTransitions(el);Util.DOM.setStyle(el,'opacity',currentOpacity);},fadeIn:function(el,opacity,duration,callback){opacity=Util.coalesce(opacity,1);duration=Util.coalesce(duration,500);Util.setElementData(el,'transitionEndCallback',callback);Util.Animation._setTransition(el,'opacity',duration+'ms',function(el){Util.Animation._setTransitionEndEventListener(el);Util.DOM.setStyle(el,'opacity',opacity);});},fadeOut:function(el,duration,callback){if(Util.isNothing(duration)){duration=500;} +Util.setElementData(el,'transitionEndCallback',callback);Util.Animation._setTransition(el,'opacity',duration+'ms',function(el){Util.Animation._setTransitionEndEventListener(el);Util.DOM.setStyle(el,'opacity',0);});},slideBy:function(el,xPos,yPos,duration,callback){if(Util.isNothing(duration)){duration=500;} +Util.setElementData(el,'transitionEndCallback',Util.Animation._onSlideByEnd);Util.setElementData(el,'slideByCallback',callback);Util.setElementData(el,'slideByXPos',xPos);Util.setElementData(el,'slideByYPos',yPos);Util.Animation._setTransition(el,'all',duration+'ms','ease-in',0,function(el){Util.Animation._setTransitionEndEventListener(el);var +xPos=Util.getElementData(el,'slideByXPos'),yPos=Util.getElementData(el,'slideByYPos');Util.removeElementData(el,'slideByXPos');Util.removeElementData(el,'slideByYPos');Util.DOM.setStyle(el,{webkitTransform:(Util.isMobileSafari)?'translate3d('+xPos+'px, '+yPos+'px, 0)':'translate('+xPos+'px, '+yPos+'px)',MozTransform:'translate('+xPos+'px, '+yPos+'px)',transform:'translate('+xPos+'px, '+yPos+'px)'});});},_onSlideByEnd:function(e){var +el=e.target,callback=Util.getElementData(el,'slideByCallback'),transform=Util.coalesce(el.style.webkitTransform,el.style.MozTransform,el.style.transform),transformExploded=transform.match(/\((.*?)\)/)[1].split(', '),transformedX=window.parseInt(transformExploded[0]),transformedY=window.parseInt(transformExploded[1]),domX=window.parseInt(Util.DOM.getStyle(el,'left')),domY=window.parseInt(Util.DOM.getStyle(el,'top'));Util.DOM.setStyle(el,{webkitTransform:'',MozTransform:'',transform:'',left:(domX+transformedX)+'px',top:(domY+transformedY)+'px'});Util.removeElementData(el,'slideByCallback');Util.removeElementData(el,'slideByXPos');Util.removeElementData(el,'slideByYPos');if(Util.isFunction(callback)){window.setTimeout(function(){callback(e);},Util.Animation._applyTransitionDelay);}}}});})(Code.PhotoSwipe.Util);(function(){Code.PhotoSwipe.EventClass=Class.extend({_listeners:null,init:function(){this._listeners={};},addEventListener:function(type,listener){if(typeof this._listeners[type]==='undefined'){this._listeners[type]=[];} +this._listeners[type].push(listener);},dispatchEvent:function(event){if(typeof event=="string"){event={type:event};} +if(!event.target){event.target=this;} +if(!event.type){throw new Error("Event object missing 'type' property.");} +if(this._listeners[event.type]instanceof Array){var listeners=this._listeners[event.type];for(var i=0,len=listeners.length;ithis.naturalHeight);this.isLoading=false;this.hasLoaded=true;this.dispatchEvent(Code.PhotoSwipe.FullSizeImageClass.EventTypes.onLoad);}});Code.PhotoSwipe.FullSizeImageClass.EventTypes={onLoad:'onLoad'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.DocumentOverlayClass=Code.PhotoSwipe.ElementClass.extend({init:function(options){this._super(options);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.DocumentOverlayClass.CssClasses.documentOverlay},'');Util.DOM.setStyle(this.el,{left:0,position:'absolute',top:0});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);},resetPosition:function(){Util.DOM.width(this.el,Util.DOM.bodyWidth());Util.DOM.height(this.el,Util.DOM.bodyHeight());}});Code.PhotoSwipe.DocumentOverlayClass.CssClasses={documentOverlay:'ps-document-overlay'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.ViewportClass=Code.PhotoSwipe.ElementClass.extend({touchStartPoint:null,touchFingerCount:null,touchCancelsMouseEvents:null,touchStartHandler:null,touchMoveHandler:null,touchEndHandler:null,mouseDownHandler:null,mouseUpHandler:null,init:function(options){this.settings={swipeThreshold:500};Util.extend(this.settings,options);this._super(this.settings);this.touchFingerCount=0;this.touchStartPoint={x:0,y:0};this.touchCancelsMouseEvents=false;this.touchStartHandler=this.onTouchStart.bind(this);this.touchMoveHandler=this.onTouchMove.bind(this);this.touchEndHandler=this.onTouchEnd.bind(this);this.mouseDownHandler=this.onMouseDown.bind(this);this.mouseUpHandler=this.onMouseUp.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ViewportClass.CssClasses.viewport},'');Util.DOM.setStyle(this.el,{position:'absolute',left:0,overflow:'hidden'});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);},resetPosition:function(){Util.DOM.setStyle(this.el,{top:Util.DOM.windowScrollTop()+'px'});Util.DOM.width(this.el,Util.DOM.bodyWidth());Util.DOM.height(this.el,Util.DOM.windowHeight());},addEventListeners:function(){try{Util.DOM.addEventListener(this.el,'touchstart',this.touchStartHandler);Util.DOM.addEventListener(this.el,'touchmove',this.touchMoveHandler);Util.DOM.addEventListener(this.el,'touchend',this.touchEndHandler);} +catch(err){} +Util.DOM.addEventListener(this.el,'mousedown',this.mouseDownHandler);Util.DOM.addEventListener(this.el,'mouseup',this.mouseUpHandler);},removeEventListeners:function(){try{Util.DOM.removeEventListener(this.el,'touchstart',this.touchStartHandler);Util.DOM.removeEventListener(this.el,'touchmove',this.touchMoveHandler);Util.DOM.removeEventListener(this.el,'touchend',this.touchEndHandler);} +catch(err){} +Util.DOM.removeEventListener(this.el,'mousedown',this.mouseDownHandler);Util.DOM.removeEventListener(this.el,'mouseup',this.mouseUpHandler);},setCurrentTouchPoint:function(touchPoint,touches){this.touchFingerCount=touches.length;if(this.touchFingerCount===1){touchPoint.x=touches[0].pageX;touchPoint.y=touches[0].pageY;} +else{this.touchFingerCount=0;touchPoint.x=0;touchPoint.y=0;}},onTouchStart:function(e){e.preventDefault();this.setCurrentTouchPoint(this.touchStartPoint,Util.DOM.getTouchEvent(e).touches);},onTouchMove:function(e){e.preventDefault();},onTouchEnd:function(e){e.preventDefault();var touchEndPoint={x:0,y:0};var touchEvent=Util.DOM.getTouchEvent(e);if(!Util.isNothing(touchEvent.changedTouches)){this.setCurrentTouchPoint(touchEndPoint,touchEvent.changedTouches);} +else{this.setCurrentTouchPoint(touchEndPoint,touchEvent.touches);} +if(this.touchFingerCount==1){this.fireTouchEvent(this.touchStartPoint,touchEndPoint);}},onMouseDown:function(e){e.preventDefault();if(this.touchCancelsMouseEvents){return;} +this.touchStartPoint=Util.DOM.getMousePosition(e);},onMouseUp:function(e){e.preventDefault();if(this.touchCancelsMouseEvents){return;} +this.fireTouchEvent(this.touchStartPoint,Util.DOM.getMousePosition(e));},fireTouchEvent:function(touchStartPoint,touchEndPoint){var action;var distance=touchEndPoint.x-touchStartPoint.x;if(Math.abs(distance)>=this.settings.swipeThreshold){if(distance<0){action=Code.PhotoSwipe.ViewportClass.Actions.swipeLeft;} +else{action=Code.PhotoSwipe.ViewportClass.Actions.swipeRight;}} +else{action=Code.PhotoSwipe.ViewportClass.Actions.click;} +if(Util.isNothing(action)){return;} +this.dispatchEvent({type:Code.PhotoSwipe.ViewportClass.EventTypes.onTouch,target:this,action:action});}});Code.PhotoSwipe.ViewportClass.CssClasses={viewport:'ps-viewport'};Code.PhotoSwipe.ViewportClass.Actions={click:'click',swipeLeft:'swipeLeft',swipeRight:'swipeRight'};Code.PhotoSwipe.ViewportClass.EventTypes={onTouch:'onTouch'};})(Code.PhotoSwipe.Util);(function(Util,FullSizeImageClass){Code.PhotoSwipe.SliderItemClass=Code.PhotoSwipe.EventClass.extend({el:null,imageEl:null,parentEl:null,fullSizeImage:null,fullSizeImageLoadEventHandler:null,init:function(parentEl){this._super();this.parentEl=parentEl;this.fullSizeImageLoadEventHandler=this.onFullSizeImageLoad.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.SliderItemClass.CssClasses.item+' '+Code.PhotoSwipe.SliderItemClass.CssClasses.loading},'');Util.DOM.setStyle(this.el,{position:'absolute',top:0});Util.DOM.resetTranslate(this.el);Util.DOM.appendChild(this.el,this.parentEl);this.imageEl=new Image();Util.DOM.setStyle(this.imageEl,{display:'block',position:'absolute',margin:0,padding:0});Util.DOM.hide(this.imageEl);Util.DOM.appendChild(this.imageEl,this.el);},resetPosition:function(width,height,xPos){Util.DOM.width(this.el,width);Util.DOM.height(this.el,height);Util.DOM.setStyle(this.el,'left',xPos+'px');this.resetImagePosition();},resetImagePosition:function(){if(Util.isNothing(this.fullSizeImage)){return;} +var src=Util.DOM.getAttribute(this.imageEl,'src');var +scale,newWidth,newHeight,newTop,newLeft,maxWidth=Util.DOM.width(this.el),maxHeight=Util.DOM.height(this.el);if(this.fullSizeImage.isLandscape){scale=maxWidth/this.fullSizeImage.naturalWidth;} +else{scale=maxHeight/this.fullSizeImage.naturalHeight;} +newWidth=Math.round(this.fullSizeImage.naturalWidth*scale);newHeight=Math.round(this.fullSizeImage.naturalHeight*scale);if(this.fullSizeImage.scaleMethod==='fit'){scale=1;if(newWidth>maxWidth){scale=maxWidth/newWidth;} +else if(newHeight>maxHeight){scale=maxHeight/newHeight;} +if(scale!==1){newWidth=Math.round(newWidth*scale);newHeight=Math.round(newHeight*scale);}} +newTop=((maxHeight-newHeight)/2)+'px';newLeft=((maxWidth-newWidth)/2)+'px';Util.DOM.width(this.imageEl,newWidth);Util.DOM.height(this.imageEl,newHeight);Util.DOM.setStyle(this.imageEl,{top:newTop,left:newLeft});Util.DOM.show(this.imageEl);},setFullSizeImage:function(fullSizeImage){this.fullSizeImage=fullSizeImage;Util.DOM.removeClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.loading);Util.DOM.removeClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.imageError);if(Util.isNothing(this.fullSizeImage)){this.fullSizeImage=null;Util.DOM.addClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.imageError);this.hideImage();return;} +if(!this.fullSizeImage.hasLoaded){Util.DOM.addClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.loading);this.hideImage();if(!this.fullSizeImage.isLoading){this.fullSizeImage.addEventListener(FullSizeImageClass.EventTypes.onLoad,this.fullSizeImageLoadEventHandler);this.fullSizeImage.load();} +return;} +Util.DOM.setAttribute(this.imageEl,'src',this.fullSizeImage.src);this.resetImagePosition();this.dispatchEvent(Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageDisplay);},onFullSizeImageLoad:function(e){e.target.removeEventListener(FullSizeImageClass.EventTypes.onLoad,this.fullSizeImageLoadEventHandler);if(Util.isNothing(this.fullSizeImage)||e.target.index!==this.fullSizeImage.index){this.dispatchEvent({type:Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageLoadAnomaly,target:this,fullSizeImage:e.target});} +else{this.setFullSizeImage(e.target);}},hideImage:function(){Util.DOM.removeAttribute(this.imageEl,'src');Util.DOM.hide(this.imageEl);}});Code.PhotoSwipe.SliderItemClass.CssClasses={item:'ps-slider-item',loading:'ps-slider-item-loading',imageError:'ps-slider-item-image-error'};Code.PhotoSwipe.SliderItemClass.EventTypes={onFullSizeImageDisplay:'onFullSizeImageDisplay',onFullSizeImageLoadAnomaly:'onFullSizeImageLoadAnomaly'};})(Code.PhotoSwipe.Util,Code.PhotoSwipe.FullSizeImageClass);(function(Util,SliderItemClass){Code.PhotoSwipe.SliderClass=Code.PhotoSwipe.ElementClass.extend({parentEl:null,parentElWidth:null,parentElHeight:null,items:null,previousItem:null,currentItem:null,nextItem:null,hasBounced:null,lastShowAction:null,bounceSlideBy:null,showNextEndEventHandler:null,showPreviousEndEventHandler:null,bounceStepOneEventHandler:null,bounceStepTwoEventHandler:null,sliderFullSizeImageLoadAnomalyEventHandler:null,init:function(options,parentEl){this.settings={slideSpeed:250};Util.extend(this.settings,options);this._super(this.settings);this.parentEl=parentEl;this.hasBounced=false;this.showNextEndEventHandler=this.onShowNextEnd.bind(this);this.showPreviousEndEventHandler=this.onShowPreviousEnd.bind(this);this.bounceStepOneEventHandler=this.onBounceStepOne.bind(this);this.bounceStepTwoEventHandler=this.onBounceStepTwo.bind(this);this.sliderFullSizeImageLoadAnomalyEventHandler=this.onSliderFullSizeImageLoadAnomaly.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.SliderClass.CssClasses.slider},'');Util.DOM.setStyle(this.el,{position:'absolute',top:0});Util.DOM.hide(this.el);Util.DOM.appendChild(this.el,parentEl);this.items=[];this.items.push(new SliderItemClass(this.el));this.items.push(new SliderItemClass(this.el));this.items.push(new SliderItemClass(this.el));this.previousItem=this.items[0];this.currentItem=this.items[1];this.nextItem=this.items[2];},addEventListeners:function(){for(var i=0;i0){this.fadeOutTimeout=window.setTimeout(this.fadeOut.bind(this),this.settings.captionDelay);} +this._super();}});Code.PhotoSwipe.CaptionClass.CssClasses={caption:'ps-caption',bottom:'ps-caption-bottom',content:'ps-caption-content'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.ToolbarClass=Code.PhotoSwipe.ElementClass.extend({closeEl:null,previousEl:null,nextEl:null,playEl:null,clickHandler:null,fadeOutTimeout:null,isNextActive:null,isPreviousActive:null,init:function(options){this.settings={toolbarDelay:4000,position:'bottom'};Util.extend(this.settings,options);this._super(options);this.isNextActive=true;this.isPreviousActive=true;this.clickHandler=this.onClick.bind(this);var cssClass=Code.PhotoSwipe.ToolbarClass.CssClasses.caption;if(this.settings.position==='top'){cssClass=cssClass+' '+Code.PhotoSwipe.ToolbarClass.CssClasses.top;} +this.el=Util.DOM.createElement('div',{'class':cssClass},'');Util.DOM.setStyle(this.el,{left:0,position:'absolute',overflow:'hidden',zIndex:1001,display:'table'});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);this.closeEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.close},'
');Util.DOM.appendChild(this.closeEl,this.el);this.playEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.play},'
');Util.DOM.appendChild(this.playEl,this.el);this.previousEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.previous},'
');Util.DOM.appendChild(this.previousEl,this.el);this.nextEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.next},'
');Util.DOM.appendChild(this.nextEl,this.el);},addEventListeners:function(){Util.DOM.addEventListener(this.el,'click',this.clickHandler);},removeEventListeners:function(){Util.DOM.removeEventListener(this.el,'click',this.clickHandler);},onClick:function(e){var action;switch(e.target.parentNode){case this.previousEl:if(this.isPreviousActive){action=Code.PhotoSwipe.ToolbarClass.Actions.previous;} +break;case this.nextEl:if(this.isNextActive){action=Code.PhotoSwipe.ToolbarClass.Actions.next;} +break;case this.playEl:action=Code.PhotoSwipe.ToolbarClass.Actions.play;break;case this.closeEl:action=Code.PhotoSwipe.ToolbarClass.Actions.close;break;} +if(Util.isNothing(action)){return;} +this.dispatchEvent({type:Code.PhotoSwipe.ToolbarClass.EventTypes.onClick,target:this,action:action});},resetPosition:function(){var top;if(this.settings.position==='bottom'){top=Util.DOM.windowHeight()-Util.DOM.height(this.el)+Util.DOM.windowScrollTop();} +else{top=Util.DOM.windowScrollTop();} +Util.DOM.setStyle(this.el,'top',top+'px');Util.DOM.width(this.el,Util.DOM.bodyWidth());},stopFade:function(){window.clearTimeout(this.fadeOutTimeout);this._super();},postShow:function(){if(this.settings.toolbarDelay>0){this.fadeOutTimeout=window.setTimeout(this.fadeOut.bind(this),this.settings.toolbarDelay);} +this._super();},setNextState:function(disable){if(disable){Util.DOM.addClass(this.nextEl,Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled);this.isNextActive=false;} +else{Util.DOM.removeClass(this.nextEl,Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled);this.isNextActive=true;}},setPreviousState:function(disable){if(disable){Util.DOM.addClass(this.previousEl,Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled);this.isPreviousActive=false;} +else{Util.DOM.removeClass(this.previousEl,Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled);this.isPreviousActive=true;}}});Code.PhotoSwipe.ToolbarClass.CssClasses={caption:'ps-toolbar',top:'ps-toolbar-top',close:'ps-toolbar-close',previous:'ps-toolbar-previous',previousDisabled:'ps-toolbar-previous-disabled',next:'ps-toolbar-next',nextDisabled:'ps-toolbar-next-disabled',play:'ps-toolbar-play',content:'ps-toolbar-content'};Code.PhotoSwipe.ToolbarClass.Actions={close:'close',previous:'previous',next:'next',play:'play'};Code.PhotoSwipe.ToolbarClass.EventTypes={onClick:'onClick'};})(Code.PhotoSwipe.Util);(function(Util,ElementClass,DocumentOverlayClass,FullSizeImageClass,ViewportClass,SliderClass,CaptionClass,ToolbarClass){var photoSwipe=Code.PhotoSwipe.EventClass.extend({fullSizeImages:null,documentOverlay:null,viewport:null,slider:null,caption:null,toolbar:null,settings:null,slideShowSettingsSaved:null,currentIndex:null,isBusy:null,slideshowTimeout:null,documentOverlayFadeInEventHandler:null,windowResizeEventHandler:null,windowOrientationChangeEventHandler:null,windowScrollEventHandler:null,keyDownEventHandler:null,viewportTouchEventHandler:null,viewportFadeOutEventHandler:null,sliderDisplayCurrentFullSizeImageEventHandler:null,toolbarClickEventHandler:null,init:function(){this._super();this.currentIndex=0;this.isBusy=false;this.settings={getImageSource:Code.PhotoSwipe.GetImageSource,getImageCaption:Code.PhotoSwipe.GetImageCaption,fadeSpeed:400,slideSpeed:250,swipeThreshold:50,loop:true,flipCaptionAndToolbar:false,captionDelay:3000,captionOpacity:0.8,hideCaption:false,showEmptyCaptions:true,toolbarDelay:3000,toolbarOpacity:0.8,hideToolbar:false,slideshowDelay:3000,imageScaleMethod:'fit'};this.documentOverlayFadeInEventHandler=this.onDocumentOverlayFadeIn.bind(this);this.windowResizeEventHandler=this.onWindowResize.bind(this);this.windowOrientationChangeEventHandler=this.onWindowOrientationChange.bind(this);this.windowScrollEventHandler=this.onWindowScroll.bind(this);this.keyDownEventHandler=this.onKeyDown.bind(this);this.viewportTouchEventHandler=this.onViewportTouch.bind(this);this.viewportFadeOutEventHandler=this.onViewportFadeOut.bind(this);this.sliderDisplayCurrentFullSizeImageEventHandler=this.onSliderDisplayCurrentFullSizeImage.bind(this);this.toolbarClickEventHandler=this.onToolbarClick.bind(this);},setOptions:function(options){Util.extend(this.settings,options);},setImages:function(thumbEls){if(!Util.isArray){throw"thumbEls is not an array";} +this.currentIndex=0;this.fullSizeImages=[];for(var i=0;i=this.fullSizeImages.length){startingIndex=0;} +this.currentIndex=startingIndex;if(Util.isNothing(this.documentOverlay)){this.build();} +this.documentOverlay.addEventListener(ElementClass.EventTypes.onFadeIn,this.documentOverlayFadeInEventHandler);this.documentOverlay.fadeIn();},build:function(){this.documentOverlay=new DocumentOverlayClass({opacity:1,fadeSpeed:this.settings.fadeSpeed});this.viewport=new ViewportClass({opacity:1,fadeSpeed:this.settings.fadeSpeed,swipeThreshold:this.settings.swipeThreshold});this.slider=new SliderClass({opacity:1,fadeSpeed:this.settings.fadeSpeed,slideSpeed:this.settings.slideSpeed},this.viewport.el);this.caption=new CaptionClass({opacity:this.settings.captionOpacity,fadeSpeed:this.settings.fadeSpeed,captionDelay:this.settings.captionDelay,position:(this.settings.flipCaptionAndToolbar)?'bottom':'top'});this.toolbar=new ToolbarClass({opacity:this.settings.toolbarOpacity,fadeSpeed:this.settings.fadeSpeed,toolbarDelay:this.settings.toolbarDelay,position:(this.settings.flipCaptionAndToolbar)?'top':'bottom'});},addEventListeners:function(){if(!Util.isNothing(window.orientation)){Util.DOM.addEventListener(window,'orientationchange',this.windowOrientationChangeEventHandler);} +Util.DOM.addEventListener(window,'resize',this.windowResizeEventHandler);Util.DOM.addEventListener(window,'scroll',this.windowScrollEventHandler);Util.DOM.addEventListener(document,'keydown',this.keyDownEventHandler);this.viewport.addEventListener(ViewportClass.EventTypes.onTouch,this.viewportTouchEventHandler);this.slider.addEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage,this.sliderDisplayCurrentFullSizeImageEventHandler);this.toolbar.addEventListener(ToolbarClass.EventTypes.onClick,this.toolbarClickEventHandler);},removeEventListeners:function(){if(!Util.isNothing(window.orientation)){Util.DOM.removeEventListener(window,'orientationchange',this.windowOrientationChangeEventHandler);} +Util.DOM.removeEventListener(window,'resize',this.windowResizeEventHandler);Util.DOM.removeEventListener(window,'scroll',this.windowScrollEventHandler);Util.DOM.removeEventListener(document,'keydown',this.keyDownEventHandler);this.viewport.removeEventListener(ViewportClass.EventTypes.onTouch,this.viewportTouchEventHandler);this.slider.removeEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage,this.sliderDisplayCurrentFullSizeImageEventHandler);this.toolbar.removeEventListener(ToolbarClass.EventTypes.onClick,this.toolbarClickEventHandler);},onDocumentOverlayFadeIn:function(e){this.documentOverlay.removeEventListener(ElementClass.EventTypes.onFadeIn,this.documentOverlayFadeInEventHandler);this.viewport.show();this.slider.show();this.toolbar.show();this.addEventListeners();this.slider.setCurrentFullSizeImage(this.fullSizeImages[this.currentIndex]);this.isBusy=false;},setSliderPreviousAndNextFullSizeImages:function(){var +lastIndex,previousFullSizeImage=null,nextFullSizeImage=null;if(this.fullSizeImages.length>1){lastIndex=this.fullSizeImages.length-1;if(this.currentIndex===lastIndex){if(this.settings.loop){nextFullSizeImage=this.fullSizeImages[0];} +previousFullSizeImage=this.fullSizeImages[this.currentIndex-1];} +else if(this.currentIndex===0){nextFullSizeImage=this.fullSizeImages[this.currentIndex+1];if(this.settings.loop){previousFullSizeImage=this.fullSizeImages[lastIndex];}} +else{nextFullSizeImage=this.fullSizeImages[this.currentIndex+1];previousFullSizeImage=this.fullSizeImages[this.currentIndex-1];}} +this.slider.setPreviousAndNextFullSizeImages(previousFullSizeImage,nextFullSizeImage);},onWindowResize:function(e){this.resetPosition();},onKeyDown:function(e){if(e.keyCode===37){e.preventDefault();this.showPrevious();} +else if(e.keyCode===39){e.preventDefault();this.showNext();} +else if(e.keyCode===38||e.keyCode===40){e.preventDefault();} +else if(e.keyCode===27){e.preventDefault();this.hide();} +else if(e.keyCode===32){e.preventDefault();}},onWindowOrientationChange:function(e){this.resetPosition();},onWindowScroll:function(e){this.resetPosition();},resetPosition:function(){if(this.isBusy){return;} +this.documentOverlay.resetPosition();this.viewport.resetPosition();this.slider.resetPosition();this.caption.resetPosition();this.toolbar.resetPosition();},onViewportTouch:function(e){switch(e.action){case ViewportClass.Actions.swipeLeft:this.showNext();break;case ViewportClass.Actions.swipeRight:this.showPrevious();break;default:if(this.isSlideShowActive()||!this.settings.hideToolbar){this.showCaptionAndToolbar();} +else{this.hide();} +break;}},onViewportFadeOut:function(e){this.viewport.removeEventListener(ElementClass.EventTypes.onFadeOut,this.viewportFadeOutEventHandler);this.isBusy=false;},hide:function(){if(this.isBusy){return;} +this.isBusy=true;this.removeEventListeners();this.documentOverlay.hide();this.caption.hide();this.toolbar.hide();this.slider.hide();Util.DOM.removeClass(document.body,Code.PhotoSwipe.CssClasses.activeBody);this.viewport.addEventListener(ElementClass.EventTypes.onFadeOut,this.viewportFadeOutEventHandler);this.viewport.fadeOut();},showNext:function(){if(this.isBusy){return;} +this.isBusy=true;this.caption.setEmptyCaption();this.slider.showNext();},showPrevious:function(){if(this.isBusy){return;} +this.isBusy=true;this.caption.setEmptyCaption();this.slider.showPrevious();},onSliderDisplayCurrentFullSizeImage:function(e){this.currentIndex=e.fullSizeImage.index;this.setSliderPreviousAndNextFullSizeImages();this.isBusy=false;if(this.isSlideShowActive()){if(!this.settings.loop&&this.currentIndex===this.fullSizeImages.length-1){this.slideshowTimeout=window.setTimeout(this.showCaptionAndToolbar.bind(this),this.settings.slideshowDelay);} +else{this.fireSlideshowTimeout();}} +else{this.showCaptionAndToolbar();}},showCaptionAndToolbar:function(captionValue){this.stopSlideshow();if(this.settings.hideCaption){this.caption.hide();} +else{captionValue=Util.coalesce(captionValue,this.fullSizeImages[this.currentIndex].caption);if((Util.isNothing(captionValue)||captionValue==='')&&!this.settings.showEmptyCaptions){this.caption.hide();return;} +this.caption.show(captionValue);} +if(this.settings.hideToolbar){this.toolbar.hide();} +else{if(this.settings.loop){this.toolbar.setNextState(false);this.toolbar.setPreviousState(false);} +else{if(this.currentIndex>=this.fullSizeImages.length-1){this.toolbar.setNextState(true);} +else{this.toolbar.setNextState(false);} +if(this.currentIndex<1){this.toolbar.setPreviousState(true);} +else{this.toolbar.setPreviousState(false);}} +this.toolbar.show();}},onToolbarClick:function(e){switch(e.action){case ToolbarClass.Actions.previous:this.showPrevious();break;case ToolbarClass.Actions.next:this.showNext();break;case ToolbarClass.Actions.play:this.startSlideshow();break;default:this.hide();break;}},startSlideshow:function(){if(this.isBusy){return;} +window.clearTimeout(this.slideshowTimeout);this.slideShowSettingsSaved={hideCaption:this.settings.hideCaption,hideToolbar:this.settings.hideToolbar};this.settings.hideCaption=true;this.settings.hideToolbar=true;this.caption.fadeOut();this.toolbar.fadeOut();this.fireSlideshowTimeout();},stopSlideshow:function(){if(!this.isSlideShowActive()){return;} +window.clearTimeout(this.slideshowTimeout);this.settings.hideCaption=this.slideShowSettingsSaved.hideCaption;this.settings.hideToolbar=this.slideShowSettingsSaved.hideToolbar;this.slideShowSettingsSaved=null;},isSlideShowActive:function(){return(!Util.isNothing(this.slideShowSettingsSaved));},fireSlideshowTimeout:function(){this.slideshowTimeout=window.setTimeout(this.showNext.bind(this),this.settings.slideshowDelay);}});Code.PhotoSwipe.CssClasses={activeBody:'ps-active'};Code.PhotoSwipe.GetImageSource=function(el){return el.href;};Code.PhotoSwipe.GetImageCaption=function(el){if(el.nodeName==="IMG"){return Util.DOM.getAttribute(el,'alt');} +return Util.DOM.getAttribute(el.firstChild,'alt');};Code.PhotoSwipe.Current=new photoSwipe();Code.photoSwipe=function(thumbEls,containerEl,opts){var useEventDelegation=true;if(Util.isNothing(thumbEls)){return;} +if(Util.isNothing(containerEl)){containerEl=document.documentElement;useEventDelegation=false;} +if(Util.isString(containerEl)){containerEl=document.documentElement.querySelector(containerEl);} +if(Util.isNothing(containerEl)){throw'Unable to find container element';} +if(Util.isString(thumbEls)){thumbEls=containerEl.querySelectorAll(thumbEls);} +if(Util.isNothing(thumbEls)){return;} +Code.PhotoSwipe.Current.setOptions(opts);Code.PhotoSwipe.Current.setImages(thumbEls);if(useEventDelegation){containerEl.addEventListener('click',function(e){if(e.target===e.currentTarget){return;} +e.preventDefault();var findNode=function(clickedEl,targetNodeName,stopAtEl){if(Util.isNothing(clickedEl)||Util.isNothing(targetNodeName)||Util.isNothing(stopAtEl)){return null;} +if(clickedEl.nodeName===targetNodeName){return clickedEl;} +if(clickedEl===stopAtEl){return null;} +return findNode(clickedEl.parentNode,targetNodeName,stopAtEl)};var clickedEl=findNode(e.target,thumbEls[0].nodeName,e.currentTarget);if(Util.isNothing(clickedEl)){return;} +showPhotoSwipe(clickedEl);},false);} +else{for(var i=0;i'); + retval.attr(attributes); + retval.append(content); + + return retval[0]; + + }, + + + /* + * Function: appendChild + */ + appendChild: function(childEl, parentEl){ + + $(parentEl).append(childEl); + + }, + + + /* + * Function: appendText + */ + appendText: function(text, parentEl){ + + $(parentEl).text(text); + + }, + + + /* + * Function: appendToBody + */ + appendToBody: function(childEl){ + + $('body').append(childEl); + + }, + + + /* + * Function: removeChild + */ + removeChild: function(childEl, parentEl){ + + $(parentEl).remove(childEl); + + }, + + + + /* + * Function: removeChildren + */ + removeChildren: function(parentEl){ + + $(parentEl).empty(); + + }, + + + + /* + * Function: hasAttribute + */ + hasAttribute: function(el, attributeName){ + + return Util.isNothing( $(el).attr(attributeName) ); + + }, + + + /* + * Function: getAttribute + */ + getAttribute: function(el, attributeName){ + + return $(el).attr(attributeName); + + }, + + + /* + * Function: el, attributeName + */ + setAttribute: function(el, attributeName, value){ + + $(el).attr(attributeName, value); + + }, + + + /* + * Function: removeAttribute + */ + removeAttribute: function(el, attributeName){ + + $(el).removeAttr(attributeName); + + }, + + + /* + * Function: addClass + */ + addClass: function(el, className){ + + $(el).addClass(className); + + }, + + + /* + * Function: removeClass + */ + removeClass: function(el, className){ + + $(el).removeClass(className); + + }, + + + /* + * Function: hasClass + */ + hasClass: function(el, className){ + + $(el).hasClass(className); + + }, + + + /* + * Function: setStyle + */ + setStyle: function(el, style, value){ + + if (Util.isObject(style)) { + $(el).css(style); + } + else { + $(el).css(style, value); + } + + }, + + + /* + * Function: getStyle + */ + getStyle: function(el, styleName){ + + return $(el).css(styleName); + + }, + + + /* + * Function: hide + */ + hide: function(el){ + + $(el).hide(); + + }, + + + /* + * Function: show + */ + show: function(el){ + + $(el).show(); + + }, + + + /* + * Function: width + * Content width, exludes padding + */ + width: function(el, value){ + + if (!Util.isNothing(value)){ + $(el).width(value); + } + + return $(el).width(); + + }, + + + /* + * Function: outerWidth + */ + outerWidth: function(el){ + + return $(el).outerWidth(); + + }, + + + /* + * Function: height + * Content height, excludes padding + */ + height: function(el, value){ + + if (!Util.isNothing(value)){ + $(el).height(value); + } + + return $(el).height(); + + }, + + + /* + * Function: outerHeight + */ + outerHeight: function(el){ + + return $(el).outerHeight(); + + }, + + + /* + * Function: documentWidth + */ + documentWidth: function(){ + + return $(document.documentElement).width(); + + }, + + + /* + * Function: documentHeight + */ + documentHeight: function(){ + + return $(document.documentElement).height(); + + }, + + + /* + * Function: bodyWidth + */ + bodyWidth: function(){ + + return $(document.body).width(); + + }, + + + /* + * Function: bodyHeight + */ + bodyHeight: function(){ + + return $(document.body).height(); + + }, + + + /* + * Function: windowWidth + */ + windowWidth: function(){ + + return $(window).width(); + + }, + + + /* + * Function: windowHeight + */ + windowHeight: function(){ + + return $(window).height(); + + }, + + + /* + * Function: windowScrollLeft + */ + windowScrollLeft: function(){ + + return $(window).scrollLeft(); + + }, + + + /* + * Function: windowScrollTop + */ + windowScrollTop: function(){ + + return $(window).scrollTop(); + + }, + + + /* + * Function: addEventListener + */ + addEventListener: function(el, type, listener){ + + $(el).bind( type, listener ); + + }, + + + /* + * Function: removeEventListener + */ + removeEventListener: function(el, type, listener){ + + $(el).unbind( type, listener ); + + }, + + + /* + * Function: getMousePosition + */ + getMousePosition: function(event){ + + var retval = { + x: event.pageX, + y: event.pageY + } + + return retval; + }, + + + /* + * Function: getTouchEvent + */ + getTouchEvent: function(event){ + + return event.originalEvent; + + } + + } + + + }); + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + + Animation: { + + + /* + * Function: stopFade + */ + stopFade: function(el){ + + $(el).stop(true, true); + + }, + + + /* + * Function: fadeIn + * Fades an element in. + * Make sure the element is displayed before calling + */ + fadeIn: function(el, opacity, duration, callback){ + + opacity = Util.coalesce(opacity, 1); + duration = Util.coalesce(duration, 500); + + $(el).fadeTo(duration, opacity, callback); + + }, + + + /* + * Function: fadeOut + * Fades an element out + * Make sure the element is displayed before calling + * Does not "hide" the element when animation is over + */ + fadeOut: function(el, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + $(el).fadeTo(duration, 0, callback); + + }, + + + + /* + * Function: slideTo + * Slides an element by an x,y position + */ + slideBy: function(el, xPos, yPos, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + + $(el).animate( + { + left: '+=' + xPos + 'px', + top: '+=' + yPos + 'px' + }, + duration, + callback + ); + + } + + } + + }); + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function () { + + // Based on http://www.javascriptbank.com/how-build-custom-events-javascript.html + Code.PhotoSwipe.EventClass = Class.extend({ + + _listeners: null, + + init: function(){ + + this._listeners = {}; + + }, + + + addEventListener: function(type, listener){ + + if (typeof this._listeners[type] === 'undefined'){ + this._listeners[type] = []; + } + this._listeners[type].push(listener); + + }, + + + dispatchEvent: function(event){ + if (typeof event == "string"){ + event = { type: event }; + } + if (!event.target){ + event.target = this; + } + + if (!event.type){ + throw new Error("Event object missing 'type' property."); + } + + if (this._listeners[event.type] instanceof Array){ + var listeners = this._listeners[event.type]; + for (var i=0, len=listeners.length; i < len; i++){ + listeners[i].call(this, event); + } + } + }, + + + removeEventListener: function(type, listener){ + if (this._listeners[type] instanceof Array){ + var listeners = this._listeners[type]; + for (var i=0, len=listeners.length; i < len; i++){ + if (listeners[i] === listener){ + listeners.splice(i, 1); + break; + } + } + } + } + + }); + + +})();// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + /* + * Class: Code.PhotoSwipe.ElementClass + * Most PhotoSwipe classes inherit from this class + * Provides hooks for fading in and out + */ + Code.PhotoSwipe.ElementClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + settings: null, + isFading: null, + + fadeInHandler: null, + fadeOutHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this._super(); + + this.settings = { + opacity: 1, + fadeSpeed: 500 + }; + + Util.extend(this.settings, options); + + this.isFading = false; + + this.fadeInHandler = this.postFadeIn.bind(this); + this.fadeOutHandler = this.postFadeOut.bind(this); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + }, + + + + /* + * Function: show + */ + show: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + // Set position + this.resetPosition(); + + // Show + Util.DOM.setStyle(this.el, 'opacity', this.settings.opacity); + Util.DOM.show(this.el); + + this.postShow(); + + }, + + + + /* + * Function: postShow + * Overide this + */ + postShow: function(){ + + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onShow); + + }, + + + + /* + * Function: fadeIn + */ + fadeIn: function(){ + + if (this.el === null){ + return; + } + + Util.DOM.setStyle(this.el, 'opacity', 0); + + this.fadeInFromCurrentOpacity(); + + }, + + + /* + * Function: fadeInFromCurrentOpacity + */ + fadeInFromCurrentOpacity: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + this.isFading = true; + + // Set position + this.resetPosition(); + + // Fade in + Util.DOM.show(this.el); + Util.Animation.fadeIn( + this.el, + this.settings.opacity, + this.settings.fadeSpeed, + this.fadeInHandler + ); + + }, + + + /* + * Function: postFadeIn + */ + postFadeIn: function(e){ + + this.isFading = false; + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeIn); + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + Util.DOM.hide(this.el); + + this.postHide(); + + }, + + + /* + * Function: postHide + * Overide this + */ + postHide: function(){ + + this.removeEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onHide); + + }, + + + /* + * Fuction: fadeOut + */ + fadeOut: function(){ + + this.stopFade(); + + this.isFading = true; + + Util.Animation.fadeOut(this.el, this.settings.fadeSpeed, this.fadeOutHandler); + + }, + + + /* + * Function: preFadeOut + */ + postFadeOut: function(e){ + + this.isFading = false; + + Util.DOM.hide(this.el); + + this.removeEventListeners(); + + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeOut); + + }, + + + /* + * Function: stopFade + */ + stopFade: function(){ + + if (this.el === null){ + return; + } + + Util.Animation.stopFade(this.el); + this.isFading = false; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + } + + + }); + + + + Code.PhotoSwipe.ElementClass.EventTypes = { + onShow: 'onShow', + onHide: 'onHide', + onClick: 'onClick', + onFadeIn: 'onFadeIn', + onFadeOut: 'onFadeOut' + }; + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + + /* + * Class: Code.PhotoSwipe.FullSizeImageClass + */ + Code.PhotoSwipe.FullSizeImageClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + index: null, + + // The naturalWidth and naturalHeight of the image as loaded from the server + // This maybe different from the width and height set on the img element + // We need this to scale the image correctly + naturalWidth: null, + naturalHeight: null, + src: null, + caption: null, + scaleMethod: null, + isLandscape: null, + isLoading: null, + hasLoaded: null, + + loadEventHandler: null, + + + /* + * Function: init + */ + init: function(index, scaleMethod, src, caption){ + + this._super(); + + this.index = index; + this.naturalWidth = 0; + this.naturalHeight = 0; + this.src = src; + this.caption = caption; + this.isLandscape = false; + this.isLoading = false; + this.hasLoaded = false; + this.scaleMethod = scaleMethod; + + this.loadEventHandler = this.onLoad.bind(this); + + }, + + + /* + * Function: load + */ + load: function(){ + + // Load in the image + this.isLoading = true; + + this.el = new Image(); + Util.DOM.addClass(this.el, 'ps-full-size-image'); + this.el.onload = this.loadEventHandler; + this.el.src = this.src; + + }, + + + /* + * Function: onLoad + */ + onLoad: function(){ + + this.naturalWidth = Util.coalesce(this.el.naturalWidth, this.el.width); + this.naturalHeight = Util.coalesce(this.el.naturalHeight, this.el.height); + this.isLandscape = (this.naturalWidth > this.naturalHeight); + this.isLoading = false; + this.hasLoaded = true; + + this.dispatchEvent(Code.PhotoSwipe.FullSizeImageClass.EventTypes.onLoad); + + } + + + }); + + + Code.PhotoSwipe.FullSizeImageClass.EventTypes = { + onLoad: 'onLoad' + }; + + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.DocumentOverlayClass + */ + Code.PhotoSwipe.DocumentOverlayClass = Code.PhotoSwipe.ElementClass.extend({ + + /* + * Function: init + */ + init: function(options){ + + this._super(options); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.DocumentOverlayClass.CssClasses.documentOverlay }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.bodyHeight()); + + } + + }); + + + Code.PhotoSwipe.DocumentOverlayClass.CssClasses = { + documentOverlay: 'ps-document-overlay' + }; + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ViewportClass + */ + Code.PhotoSwipe.ViewportClass = Code.PhotoSwipe.ElementClass.extend({ + + touchStartPoint: null, + touchFingerCount: null, + touchCancelsMouseEvents: null, + + touchStartHandler: null, + touchMoveHandler: null, + touchEndHandler: null, + + mouseDownHandler: null, + mouseUpHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + swipeThreshold: 500 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.touchFingerCount = 0; + this.touchStartPoint = { x: 0, y: 0 }; + this.touchCancelsMouseEvents = false; + + this.touchStartHandler = this.onTouchStart.bind(this); + this.touchMoveHandler = this.onTouchMove.bind(this); + this.touchEndHandler = this.onTouchEnd.bind(this); + + this.mouseDownHandler = this.onMouseDown.bind(this); + this.mouseUpHandler = this.onMouseUp.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ViewportClass.CssClasses.viewport }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + left: 0, + overflow: 'hidden' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.setStyle(this.el, { + top: Util.DOM.windowScrollTop() + 'px' + }); + + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.windowHeight()); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + try{ + Util.DOM.addEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.addEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.addEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.addEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.addEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + try{ + Util.DOM.removeEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.removeEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.removeEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.removeEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.removeEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: setCurrentTouchPoint + */ + setCurrentTouchPoint: function(touchPoint, touches){ + + this.touchFingerCount = touches.length; + + if (this.touchFingerCount === 1){ + touchPoint.x = touches[0].pageX; + touchPoint.y = touches[0].pageY; + } + else{ + this.touchFingerCount = 0; + touchPoint.x = 0; + touchPoint.y = 0; + } + + }, + + + + /* + * Function: onTouch + */ + onTouchStart: function(e){ + + e.preventDefault(); + + this.setCurrentTouchPoint(this.touchStartPoint, Util.DOM.getTouchEvent(e).touches); + + }, + + + + /* + * Function: onTouchMove + * For some reason, even though it's not a requirement, + * if we don't listen out for the touchmove event, + * we are unable to detect the swipe on Blackberry6 + */ + onTouchMove: function(e){ + + e.preventDefault(); + + }, + + + + /* + * Function: onTouchEnd + */ + onTouchEnd: function(e){ + + e.preventDefault(); + + var touchEndPoint = { x:0, y:0 }; + + var touchEvent = Util.DOM.getTouchEvent(e); + + if (!Util.isNothing(touchEvent.changedTouches)){ + // http://backtothecode.blogspot.com/2009/10/javascript-touch-and-gesture-events.html + // iOS removed the current touch from e.touches on "touchend" + // Need to look into e.changedTouches + this.setCurrentTouchPoint(touchEndPoint, touchEvent.changedTouches); + } + else{ + this.setCurrentTouchPoint(touchEndPoint, touchEvent.touches); + } + + if (this.touchFingerCount == 1){ + + this.fireTouchEvent(this.touchStartPoint, touchEndPoint); + + } + + }, + + + + /* + * Function: onMouseDown + */ + onMouseDown: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.touchStartPoint = Util.DOM.getMousePosition(e); + + }, + + + + /* + * Function: onMouseUp + */ + onMouseUp: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.fireTouchEvent(this.touchStartPoint, Util.DOM.getMousePosition(e)); + + }, + + + + /* + * Function: fireTouchEvent + */ + fireTouchEvent: function(touchStartPoint, touchEndPoint){ + + var action; + + var distance = touchEndPoint.x - touchStartPoint.x; + + if (Math.abs(distance) >= this.settings.swipeThreshold){ + + if (distance < 0){ + + // Swipe left + action = Code.PhotoSwipe.ViewportClass.Actions.swipeLeft; + + } + else{ + + // Swipe right + action = Code.PhotoSwipe.ViewportClass.Actions.swipeRight; + + } + + } + else{ + + // Click + action = Code.PhotoSwipe.ViewportClass.Actions.click; + + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ViewportClass.EventTypes.onTouch, + target: this, + action: action + }); + + } + + }); + + + Code.PhotoSwipe.ViewportClass.CssClasses = { + viewport: 'ps-viewport' + }; + + + Code.PhotoSwipe.ViewportClass.Actions = { + click: 'click', + swipeLeft: 'swipeLeft', + swipeRight: 'swipeRight' + }; + + Code.PhotoSwipe.ViewportClass.EventTypes = { + onTouch: 'onTouch' + }; + + +})(Code.PhotoSwipe.Util); + +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, FullSizeImageClass){ + + /* + * Class: Code.PhotoSwipe.SliderItemClass + */ + Code.PhotoSwipe.SliderItemClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + imageEl: null, + parentEl: null, + fullSizeImage: null, + + fullSizeImageLoadEventHandler: null, + + /* + * Function: init + */ + init: function(parentEl){ + + this._super(); + + this.parentEl = parentEl; + + this.fullSizeImageLoadEventHandler = this.onFullSizeImageLoad.bind(this); + + // Create element and append to parentEl + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.SliderItemClass.CssClasses.item + ' ' + Code.PhotoSwipe.SliderItemClass.CssClasses.loading }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + top: 0 + }); + Util.DOM.resetTranslate(this.el); + Util.DOM.appendChild(this.el, this.parentEl); + + // Create image element and append to slider item + this.imageEl = new Image(); + Util.DOM.setStyle(this.imageEl, { + display: 'block', + position: 'absolute', + margin: 0, + padding: 0 + }); + Util.DOM.hide(this.imageEl); + Util.DOM.appendChild(this.imageEl, this.el); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(width, height, xPos){ + + Util.DOM.width(this.el, width); + Util.DOM.height(this.el, height); + Util.DOM.setStyle(this.el, 'left', xPos + 'px'); + + this.resetImagePosition(); + + }, + + + + /* + * Function: resetImagePosition + */ + resetImagePosition: function(){ + + if (Util.isNothing(this.fullSizeImage)){ + return; + } + + var src = Util.DOM.getAttribute(this.imageEl, 'src'); + + var + scale, + newWidth, + newHeight, + newTop, + newLeft, + maxWidth = Util.DOM.width(this.el), + maxHeight = Util.DOM.height(this.el); + + if (this.fullSizeImage.isLandscape) { + // Ensure the width fits the screen + scale = maxWidth / this.fullSizeImage.naturalWidth; + } + else { + // Ensure the height fits the screen + scale = maxHeight / this.fullSizeImage.naturalHeight; + } + + newWidth = Math.round(this.fullSizeImage.naturalWidth * scale); + newHeight = Math.round(this.fullSizeImage.naturalHeight * scale); + + if (this.fullSizeImage.scaleMethod === 'fit') { + // Rescale again to ensure full image fits into the viewport + scale = 1; + if (newWidth > maxWidth) { + scale = maxWidth / newWidth; + } + else if (newHeight > maxHeight) { + scale = maxHeight / newHeight; + } + if (scale !== 1) { + newWidth = Math.round(newWidth * scale); + newHeight = Math.round(newHeight * scale); + } + } + + newTop = ((maxHeight - newHeight) / 2) + 'px'; + newLeft = ((maxWidth - newWidth) / 2) + 'px'; + + Util.DOM.width(this.imageEl, newWidth); + Util.DOM.height(this.imageEl, newHeight); + Util.DOM.setStyle(this.imageEl, { + top: newTop, + left: newLeft + }); + + Util.DOM.show(this.imageEl); + + }, + + + + /* + * Function: setFullSizeImage + */ + setFullSizeImage: function(fullSizeImage){ + + this.fullSizeImage = fullSizeImage; + + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + + // Something is wrong! + if (Util.isNothing(this.fullSizeImage)) { + this.fullSizeImage = null; + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + this.hideImage(); + return; + } + + // Still loading + if (!this.fullSizeImage.hasLoaded) { + + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + this.hideImage(); + + if (!this.fullSizeImage.isLoading){ + + // Trigger off the load + this.fullSizeImage.addEventListener( + FullSizeImageClass.EventTypes.onLoad, + this.fullSizeImageLoadEventHandler + ); + + + this.fullSizeImage.load(); + + } + + return; + + } + + // Loaded so show the image + Util.DOM.setAttribute(this.imageEl, 'src', this.fullSizeImage.src); + + this.resetImagePosition(); + + this.dispatchEvent(Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageDisplay); + + }, + + + /* + * Function: onFullSizeImageLoad + */ + onFullSizeImageLoad: function(e){ + + e.target.removeEventListener(FullSizeImageClass.EventTypes.onLoad, this.fullSizeImageLoadEventHandler); + + if (Util.isNothing(this.fullSizeImage) || e.target.index !== this.fullSizeImage.index){ + // Chances are the user has moved the slider + // and the image to display in the item has now changed + // from when the item originally called the fullSizeImage + // to load. If that's the case, rethrow the event, the + // slider will be listening for this and can find a + // relevant slideitem for the loaded image + this.dispatchEvent({ + type: Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageLoadAnomaly, + target: this, + fullSizeImage: e.target + }); + } + else{ + this.setFullSizeImage(e.target); + } + + }, + + + /* + * Function: hideImage + */ + hideImage: function(){ + + Util.DOM.removeAttribute(this.imageEl, 'src'); + Util.DOM.hide(this.imageEl); + + } + + + }); + + + Code.PhotoSwipe.SliderItemClass.CssClasses = { + item: 'ps-slider-item', + loading: 'ps-slider-item-loading', + imageError: 'ps-slider-item-image-error' + }; + + + Code.PhotoSwipe.SliderItemClass.EventTypes = { + onFullSizeImageDisplay: 'onFullSizeImageDisplay', + onFullSizeImageLoadAnomaly: 'onFullSizeImageLoadAnomaly' + }; + + +})(Code.PhotoSwipe.Util, Code.PhotoSwipe.FullSizeImageClass);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, SliderItemClass){ + + /* + * Class: Code.PhotoSwipe.SliderClass + */ + Code.PhotoSwipe.SliderClass = Code.PhotoSwipe.ElementClass.extend({ + + parentEl: null, + parentElWidth: null, + parentElHeight: null, + items: null, + + previousItem: null, + currentItem: null, + nextItem: null, + + hasBounced: null, + lastShowAction: null, + bounceSlideBy: null, + + showNextEndEventHandler: null, + showPreviousEndEventHandler: null, + bounceStepOneEventHandler: null, + bounceStepTwoEventHandler: null, + + sliderFullSizeImageLoadAnomalyEventHandler: null, + + + /* + * Function: init + */ + init: function(options, parentEl){ + + this.settings = { + slideSpeed: 250 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.parentEl = parentEl; + + this.hasBounced = false; + + this.showNextEndEventHandler = this.onShowNextEnd.bind(this); + this.showPreviousEndEventHandler = this.onShowPreviousEnd.bind(this); + this.bounceStepOneEventHandler = this.onBounceStepOne.bind(this); + this.bounceStepTwoEventHandler = this.onBounceStepTwo.bind(this); + + this.sliderFullSizeImageLoadAnomalyEventHandler = this.onSliderFullSizeImageLoadAnomaly.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.SliderClass.CssClasses.slider }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendChild(this.el, parentEl); + + // Create previousItem, currentItem, nextItem + this.items = []; + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + + this.previousItem = this.items[0]; + this.currentItem = this.items[1]; + this.nextItem = this.items[2]; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + for (var i = 0; i 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.captionDelay + ); + + } + + this._super(); + + } + + }); + + + Code.PhotoSwipe.CaptionClass.CssClasses = { + caption: 'ps-caption', + bottom: 'ps-caption-bottom', + content: 'ps-caption-content' + }; + +})(Code.PhotoSwipe.Util);// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ToolbarClass + */ + Code.PhotoSwipe.ToolbarClass = Code.PhotoSwipe.ElementClass.extend({ + + closeEl: null, + previousEl: null, + nextEl: null, + playEl: null, + + clickHandler: null, + + fadeOutTimeout: null, + isNextActive: null, + isPreviousActive: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + toolbarDelay: 4000, + position: 'bottom' + }; + + Util.extend(this.settings, options); + + this._super(options); + + this.isNextActive = true; + this.isPreviousActive = true; + + this.clickHandler = this.onClick.bind(this); + + // Create element and append to body + var cssClass = Code.PhotoSwipe.ToolbarClass.CssClasses.caption; + if (this.settings.position === 'top'){ + cssClass = cssClass + ' ' + Code.PhotoSwipe.ToolbarClass.CssClasses.top; + } + + this.el = Util.DOM.createElement('div', { 'class': cssClass }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + overflow: 'hidden', + zIndex: 1001, + display: 'table' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + // Close + this.closeEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.close }, '
'); + Util.DOM.appendChild(this.closeEl, this.el); + + // Play + this.playEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.play }, '
'); + Util.DOM.appendChild(this.playEl, this.el); + + // Previous + this.previousEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.previous }, '
'); + Util.DOM.appendChild(this.previousEl, this.el); + + // Next + this.nextEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.next }, '
'); + Util.DOM.appendChild(this.nextEl, this.el); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + Util.DOM.addEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + Util.DOM.removeEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: onClick + */ + onClick: function(e){ + + var action; + + switch(e.target.parentNode){ + + case this.previousEl: + if (this.isPreviousActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.previous; + } + break; + + case this.nextEl: + if (this.isNextActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.next; + } + break; + + case this.playEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.play; + break; + + case this.closeEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.close; + break; + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ToolbarClass.EventTypes.onClick, + target: this, + action: action + }); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + var top; + + if (this.settings.position === 'bottom') { + top = Util.DOM.windowHeight() - Util.DOM.height(this.el) + Util.DOM.windowScrollTop(); + } + else { + top = Util.DOM.windowScrollTop(); + } + + Util.DOM.setStyle(this.el, 'top', top + 'px'); + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + + }, + + + + /* + * Function: stopFade + */ + stopFade: function(){ + + window.clearTimeout(this.fadeOutTimeout); + this._super(); + + }, + + + + /* + * Function: postShow + */ + postShow: function(){ + + if (this.settings.toolbarDelay > 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.toolbarDelay + ); + + } + + this._super(); + + }, + + + /* + * Function: setNextState + */ + setNextState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = false; + } + else { + Util.DOM.removeClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = true; + } + + }, + + + /* + * Function: setPreviousState + */ + setPreviousState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = false; + } + else { + Util.DOM.removeClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = true; + } + + } + + }); + + + + Code.PhotoSwipe.ToolbarClass.CssClasses = { + caption: 'ps-toolbar', + top: 'ps-toolbar-top', + close: 'ps-toolbar-close', + previous: 'ps-toolbar-previous', + previousDisabled: 'ps-toolbar-previous-disabled', + next: 'ps-toolbar-next', + nextDisabled: 'ps-toolbar-next-disabled', + play: 'ps-toolbar-play', + content: 'ps-toolbar-content' + }; + + + + Code.PhotoSwipe.ToolbarClass.Actions = { + close: 'close', + previous: 'previous', + next: 'next', + play: 'play' + }; + + + Code.PhotoSwipe.ToolbarClass.EventTypes = { + onClick: 'onClick' + }; + +})(Code.PhotoSwipe.Util); + // PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, ElementClass, DocumentOverlayClass, FullSizeImageClass, ViewportClass, SliderClass, CaptionClass, ToolbarClass){ + + var photoSwipe = Code.PhotoSwipe.EventClass.extend({ + + fullSizeImages: null, + + documentOverlay: null, + viewport: null, + slider: null, + caption: null, + toolbar: null, + + settings: null, + slideShowSettingsSaved: null, + currentIndex: null, + isBusy: null, + + slideshowTimeout: null, + + + documentOverlayFadeInEventHandler: null, + windowResizeEventHandler: null, + windowOrientationChangeEventHandler: null, + windowScrollEventHandler: null, + keyDownEventHandler: null, + viewportTouchEventHandler: null, + viewportFadeOutEventHandler: null, + sliderDisplayCurrentFullSizeImageEventHandler: null, + toolbarClickEventHandler: null, + + + /* + * Function: init + */ + init: function(){ + + this._super(); + + this.currentIndex = 0; + this.isBusy = false; + + this.settings = { + getImageSource: Code.PhotoSwipe.GetImageSource, + getImageCaption: Code.PhotoSwipe.GetImageCaption, + fadeSpeed: 400, + slideSpeed: 250, + swipeThreshold: 50, + loop: true, + + flipCaptionAndToolbar: false, + + captionDelay: 3000, + captionOpacity: 0.8, + hideCaption: false, + showEmptyCaptions: true, + + toolbarDelay: 3000, + toolbarOpacity: 0.8, + hideToolbar: false, + + slideshowDelay: 3000, + + imageScaleMethod: 'fit' // Either "fit" or "zoom" + }; + + // Set pointers to event handlers + this.documentOverlayFadeInEventHandler = this.onDocumentOverlayFadeIn.bind(this); + this.windowResizeEventHandler = this.onWindowResize.bind(this); + this.windowOrientationChangeEventHandler = this.onWindowOrientationChange.bind(this); + this.windowScrollEventHandler = this.onWindowScroll.bind(this); + this.keyDownEventHandler = this.onKeyDown.bind(this); + this.viewportTouchEventHandler = this.onViewportTouch.bind(this); + this.viewportFadeOutEventHandler = this.onViewportFadeOut.bind(this); + this.sliderDisplayCurrentFullSizeImageEventHandler = this.onSliderDisplayCurrentFullSizeImage.bind(this); + this.toolbarClickEventHandler = this.onToolbarClick.bind(this); + + }, + + + + /* + * Function: setOptions + */ + setOptions: function(options){ + + Util.extend(this.settings, options); + + }, + + + + /* + * Function: setImages + * Set images from DOM elements. Could be a list of image + * elments or anchors containing image elements etc. + * By default the gallery assumes the latter. If you change + * this, remember to set your own getImageSource and getImageCaption + * methods so the gallery knows what to look for. + */ + setImages: function(thumbEls){ + + if (!Util.isArray){ + throw "thumbEls is not an array"; + } + + this.currentIndex = 0; + + this.fullSizeImages = []; + + for (var i=0; i= this.fullSizeImages.length){ + startingIndex = 0; + } + + this.currentIndex = startingIndex; + + if (Util.isNothing(this.documentOverlay)){ + this.build(); + } + + // Fade in the document overlay, + // then show the viewport, slider and toolbar etc + this.documentOverlay.addEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.documentOverlay.fadeIn(); + + }, + + + + /* + * Function: build + */ + build: function(){ + + // Create the document overlay + this.documentOverlay = new DocumentOverlayClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed + }); + + // Create the viewport + this.viewport = new ViewportClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + swipeThreshold: this.settings.swipeThreshold + }); + + // Create the slider + this.slider = new SliderClass( + { + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + slideSpeed: this.settings.slideSpeed + }, + this.viewport.el + ); + + // Create the caption bar + this.caption = new CaptionClass({ + opacity: this.settings.captionOpacity, + fadeSpeed: this.settings.fadeSpeed, + captionDelay: this.settings.captionDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'bottom' : 'top' + }); + + + // Create the toolbar + this.toolbar = new ToolbarClass({ + opacity: this.settings.toolbarOpacity, + fadeSpeed: this.settings.fadeSpeed, + toolbarDelay: this.settings.toolbarDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'top' : 'bottom' + }); + + }, + + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + // Set window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.addEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + Util.DOM.addEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.addEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Set keydown event handlers for desktop browsers + Util.DOM.addEventListener(document, 'keydown', this.keyDownEventHandler); + + // Set viewport handlers + this.viewport.addEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Set slider handlers + this.slider.addEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Set toolbar handlers + this.toolbar.addEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + // Remove window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.removeEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + + Util.DOM.removeEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.removeEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Remove keydown event handlers for desktop browsers + Util.DOM.removeEventListener(document, 'keydown', this.keyDownEventHandler); + + // Remove viewport handlers + this.viewport.removeEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Remove slider handlers + this.slider.removeEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Remove toolbar handlers + this.toolbar.removeEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: onDocumentOverlayFadeIn + */ + onDocumentOverlayFadeIn: function(e){ + + // Remove the ElementClass.EventTypes.onFadeIn + // event handler + this.documentOverlay.removeEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.viewport.show(); + + this.slider.show(); + + this.toolbar.show(); + + this.addEventListeners(); + + this.slider.setCurrentFullSizeImage(this.fullSizeImages[this.currentIndex]); + + this.isBusy = false; + + }, + + + /* + * Function: setSliderPreviousAndNextFullSizeImages + */ + setSliderPreviousAndNextFullSizeImages: function(){ + + var + lastIndex, + previousFullSizeImage = null, + nextFullSizeImage = null; + + if (this.fullSizeImages.length > 1) { + + lastIndex = this.fullSizeImages.length - 1; + + // Current image is the last + if (this.currentIndex === lastIndex) { + + if (this.settings.loop) { + nextFullSizeImage = this.fullSizeImages[0]; + } + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + // Current image is the first + else if (this.currentIndex === 0) { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + if (this.settings.loop) { + previousFullSizeImage = this.fullSizeImages[lastIndex]; + } + + } + + // Current image is in the middle of the thumbs + else { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + } + + this.slider.setPreviousAndNextFullSizeImages(previousFullSizeImage, nextFullSizeImage); + + }, + + + + /* + * Function: onWindowResize + */ + onWindowResize: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onKeyDown + */ + onKeyDown: function(e){ + + if (e.keyCode === 37) { // Left + e.preventDefault(); + this.showPrevious(); + } + else if (e.keyCode === 39) { // Right + e.preventDefault(); + this.showNext(); + } + else if (e.keyCode === 38 || e.keyCode === 40) { // Up and down + e.preventDefault(); + } + else if (e.keyCode === 27) { // Escape + e.preventDefault(); + //this.pause(); + this.hide(); + } + else if (e.keyCode === 32) { // Spacebar + e.preventDefault(); + } + + }, + + + + /* + * Function: onWindowOrientationChange + */ + onWindowOrientationChange: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onWindowScroll + */ + onWindowScroll: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + if (this.isBusy){ + return; + } + + this.documentOverlay.resetPosition(); + this.viewport.resetPosition(); + this.slider.resetPosition(); + this.caption.resetPosition(); + this.toolbar.resetPosition(); + + }, + + + + /* + * Function: onViewportClick + */ + onViewportTouch: function(e){ + + switch(e.action){ + + case ViewportClass.Actions.swipeLeft: + this.showNext(); + break; + + case ViewportClass.Actions.swipeRight: + this.showPrevious(); + break; + + default: + if (this.isSlideShowActive() || !this.settings.hideToolbar){ + this.showCaptionAndToolbar(); + } + else{ + this.hide(); + } + break; + + } + + }, + + + + /* + * Function: onViewportFadeOut + */ + onViewportFadeOut: function(e){ + + this.viewport.removeEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.isBusy = false; + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.removeEventListeners(); + + this.documentOverlay.hide(); + this.caption.hide(); + this.toolbar.hide(); + this.slider.hide(); + + Util.DOM.removeClass(document.body, Code.PhotoSwipe.CssClasses.activeBody); + + this.viewport.addEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.viewport.fadeOut(); + + }, + + + + /* + * Function: showNext + */ + showNext: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showNext(); + + }, + + + + /* + * Function: showPrevious + */ + showPrevious: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showPrevious(); + + }, + + + + + /* + * Function: onSliderDisplayCurrentFullSizeImage + */ + onSliderDisplayCurrentFullSizeImage: function(e){ + + this.currentIndex = e.fullSizeImage.index; + + // Set the previous and next images for the slider + this.setSliderPreviousAndNextFullSizeImages(); + + this.isBusy = false; + + if (this.isSlideShowActive()){ + if (!this.settings.loop && this.currentIndex === this.fullSizeImages.length-1){ + // Slideshow as reached the end + this.slideshowTimeout = window.setTimeout( + this.showCaptionAndToolbar.bind(this), + this.settings.slideshowDelay + ); + } + else{ + this.fireSlideshowTimeout(); + } + } + else{ + this.showCaptionAndToolbar(); + } + + }, + + + /* + * Function: showCaptionAndToolbar + */ + showCaptionAndToolbar: function(captionValue){ + + this.stopSlideshow(); + + + // Caption + if (this.settings.hideCaption){ + this.caption.hide(); + } + else{ + captionValue = Util.coalesce(captionValue, this.fullSizeImages[this.currentIndex].caption); + + if ( (Util.isNothing(captionValue) || captionValue === '') && !this.settings.showEmptyCaptions ){ + this.caption.hide(); + return; + } + + this.caption.show(captionValue); + } + + + + // Toolbar + if (this.settings.hideToolbar){ + this.toolbar.hide(); + } + else{ + if (this.settings.loop) { + this.toolbar.setNextState(false); + this.toolbar.setPreviousState(false); + } + else{ + if (this.currentIndex >= this.fullSizeImages.length - 1) { + this.toolbar.setNextState(true); + } + else { + this.toolbar.setNextState(false); + } + + if (this.currentIndex < 1) { + this.toolbar.setPreviousState(true); + } + else { + this.toolbar.setPreviousState(false); + } + } + + this.toolbar.show(); + } + + }, + + + + /* + * Function: onToolbarClick + */ + onToolbarClick: function(e){ + + switch (e.action){ + + case ToolbarClass.Actions.previous: + this.showPrevious(); + break; + + case ToolbarClass.Actions.next: + this.showNext(); + break; + + case ToolbarClass.Actions.play: + this.startSlideshow(); + break; + + default: + this.hide(); + break; + + } + + }, + + + + /* + * Function: startSlideshow + */ + startSlideshow: function(){ + + if (this.isBusy){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.slideShowSettingsSaved = { + hideCaption: this.settings.hideCaption, + hideToolbar: this.settings.hideToolbar + }; + + this.settings.hideCaption = true; + this.settings.hideToolbar = true; + + this.caption.fadeOut(); + this.toolbar.fadeOut(); + + this.fireSlideshowTimeout(); + + }, + + + + /* + * Function: stopSlideshow + */ + stopSlideshow: function(){ + + if (!this.isSlideShowActive()){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.settings.hideCaption = this.slideShowSettingsSaved.hideCaption; + this.settings.hideToolbar = this.slideShowSettingsSaved.hideToolbar; + + this.slideShowSettingsSaved = null; + + }, + + + /* + * Function: isSlideShowActive + */ + isSlideShowActive: function(){ + + return (!Util.isNothing(this.slideShowSettingsSaved)); + + }, + + + /* + * Function: fireSlideshowTimeout + */ + fireSlideshowTimeout: function(){ + + this.slideshowTimeout = window.setTimeout( + this.showNext.bind(this), + this.settings.slideshowDelay + ); + + } + + + }); + + + Code.PhotoSwipe.CssClasses = { + activeBody: 'ps-active' + }; + + /* + * Function: Code.PhotoSwipe.GetImageSource + * Default method for returning an image's source + */ + Code.PhotoSwipe.GetImageSource = function(el){ + return el.href; + }; + + + + /* + * Function: Code.PhotoSwipe.GetImageCaption + * Default method for returning an image's caption + * Assumes the el is an anchor and the first child is the + * image. The returned value is the "alt" attribute of the + * image. + */ + Code.PhotoSwipe.GetImageCaption = function(el){ + if (el.nodeName === "IMG"){ + return Util.DOM.getAttribute(el, 'alt'); + } + return Util.DOM.getAttribute(el.firstChild, 'alt'); + }; + + + Code.PhotoSwipe.Current = new photoSwipe(); + + + Code.photoSwipe = function(thumbEls, containerEl, opts){ + + var useEventDelegation = true; + + if (Util.isNothing(thumbEls)){ + return; + } + + /* See if there is a container element, if so we will use event delegation */ + + if (Util.isNothing(containerEl)){ + containerEl = document.documentElement; + useEventDelegation = false; + } + + if (Util.isString(containerEl)){ + containerEl = document.documentElement.querySelector(containerEl); + } + + if (Util.isNothing(containerEl)){ + throw 'Unable to find container element'; + } + + if (Util.isString(thumbEls)){ + thumbEls = containerEl.querySelectorAll(thumbEls); + } + + if (Util.isNothing(thumbEls)){ + return; + } + + + // Set up the options + Code.PhotoSwipe.Current.setOptions(opts); + + + // Tell PhotoSwipe about the photos + Code.PhotoSwipe.Current.setImages(thumbEls); + + + if (useEventDelegation){ + + /* + * Use event delegation rather than setting a click event on each + * thumb element. + */ + containerEl.addEventListener('click', function(e){ + + if (e.target === e.currentTarget){ + return; + } + + e.preventDefault(); + + var findNode = function(clickedEl, targetNodeName, stopAtEl){ + + if (Util.isNothing(clickedEl) || Util.isNothing(targetNodeName) || Util.isNothing(stopAtEl)){ + return null; + } + + if (clickedEl.nodeName === targetNodeName){ + return clickedEl; + } + + if (clickedEl === stopAtEl){ + return null; + } + + return findNode(clickedEl.parentNode, targetNodeName, stopAtEl) + }; + + + var clickedEl = findNode(e.target, thumbEls[0].nodeName, e.currentTarget); + + if (Util.isNothing(clickedEl)){ + return; + } + + showPhotoSwipe(clickedEl); + + }, false); + + } + else{ + + // Add a click event handler on each element + for (var i = 0; i < thumbEls.length; i++){ + + var thumbEl = thumbEls[i]; + thumbEl.addEventListener('click', function(e){ + + e.preventDefault(); + + showPhotoSwipe(e.currentTarget); + + }, false); + + } + + } + + + var showPhotoSwipe = function(clickedEl){ + + var startingIndex = 0; + for (startingIndex; startingIndex < thumbEls.length; startingIndex++){ + if (thumbEls[startingIndex] === clickedEl){ + break; + } + } + + Code.PhotoSwipe.Current.show(startingIndex); + + }; + + }; + + + + /* + * jQuery plugin + */ + if (!Util.isNothing(window.jQuery)){ + + window.jQuery.fn.photoSwipe = function (opts) { + + var thumbEls = this; + Code.PhotoSwipe.Current.setOptions(opts); + Code.PhotoSwipe.Current.setImages(thumbEls); + + $(thumbEls).live('click', function(e){ + + e.preventDefault(); + + var startingIndex = $(thumbEls).index($(e.currentTarget)); + Code.PhotoSwipe.Current.show(startingIndex); + + }); + + }; + + } + + +}) +( + Code.PhotoSwipe.Util, + Code.PhotoSwipe.ElementClass, + Code.PhotoSwipe.DocumentOverlayClass, + Code.PhotoSwipe.FullSizeImageClass, + Code.PhotoSwipe.ViewportClass, + Code.PhotoSwipe.SliderClass, + Code.PhotoSwipe.CaptionClass, + Code.PhotoSwipe.ToolbarClass +); \ No newline at end of file diff --git a/artifact/1.0.0/code-photoswipe-jQuery-1.0.0.min.js b/artifact/1.0.0/code-photoswipe-jQuery-1.0.0.min.js new file mode 100644 index 000000000..689c713fa --- /dev/null +++ b/artifact/1.0.0/code-photoswipe-jQuery-1.0.0.min.js @@ -0,0 +1,130 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license +// version: 1.0.0.111 + +(function(){if(!Function.prototype.bind){Function.prototype.bind=function(obj){var slice=[].slice,args=slice.call(arguments,1),self=this,nop=function(){},bound=function(){return self.apply(this instanceof nop?this:(obj||{}),args.concat(slice.call(arguments)));};nop.prototype=self.prototype;bound.prototype=new nop();return bound;};} +if(typeof Code==="undefined"){Code={};Code.PhotoSwipe={};} +Code.PhotoSwipe.Util={browser:{version:(navigator.userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/)||[])[1],webkit:/webkit/.test(navigator.userAgent),opera:/opera/.test(navigator.userAgent),msie:/msie/.test(navigator.userAgent)&&!/opera/.test(navigator.userAgent),mozilla:/mozilla/.test(navigator.userAgent)&&!/(compatible|webkit)/.test(navigator.userAgent),mobileSafari:/Mac OS X.*Mobile.*Safari/.test(navigator.userAgent)},setElementData:function(el,key,value){if(this.isNothing(el.UtilData)){el.UtilData={};} +el.UtilData[key]=value;},getElementData:function(el,key,defaultValue){if(typeof defaultValue==="undefined"){defaultValue=null;} +if(this.isNothing(el.UtilData)){return defaultValue;} +if(this.isNothing(el.UtilData[key])){return defaultValue;} +return el.UtilData[key];},removeElementData:function(el,key){delete el.UtilData[key];},coalesce:function(){var i;for(i=0;i');retval.attr(attributes);retval.append(content);return retval[0];},appendChild:function(childEl,parentEl){$(parentEl).append(childEl);},appendText:function(text,parentEl){$(parentEl).text(text);},appendToBody:function(childEl){$('body').append(childEl);},removeChild:function(childEl,parentEl){$(parentEl).remove(childEl);},removeChildren:function(parentEl){$(parentEl).empty();},hasAttribute:function(el,attributeName){return Util.isNothing($(el).attr(attributeName));},getAttribute:function(el,attributeName){return $(el).attr(attributeName);},setAttribute:function(el,attributeName,value){$(el).attr(attributeName,value);},removeAttribute:function(el,attributeName){$(el).removeAttr(attributeName);},addClass:function(el,className){$(el).addClass(className);},removeClass:function(el,className){$(el).removeClass(className);},hasClass:function(el,className){$(el).hasClass(className);},setStyle:function(el,style,value){if(Util.isObject(style)){$(el).css(style);} +else{$(el).css(style,value);}},getStyle:function(el,styleName){return $(el).css(styleName);},hide:function(el){$(el).hide();},show:function(el){$(el).show();},width:function(el,value){if(!Util.isNothing(value)){$(el).width(value);} +return $(el).width();},outerWidth:function(el){return $(el).outerWidth();},height:function(el,value){if(!Util.isNothing(value)){$(el).height(value);} +return $(el).height();},outerHeight:function(el){return $(el).outerHeight();},documentWidth:function(){return $(document.documentElement).width();},documentHeight:function(){return $(document.documentElement).height();},bodyWidth:function(){return $(document.body).width();},bodyHeight:function(){return $(document.body).height();},windowWidth:function(){return $(window).width();},windowHeight:function(){return $(window).height();},windowScrollLeft:function(){return $(window).scrollLeft();},windowScrollTop:function(){return $(window).scrollTop();},addEventListener:function(el,type,listener){$(el).bind(type,listener);},removeEventListener:function(el,type,listener){$(el).unbind(type,listener);},getMousePosition:function(event){var retval={x:event.pageX,y:event.pageY} +return retval;},getTouchEvent:function(event){return event.originalEvent;}}});})(Code.PhotoSwipe.Util);(function(Util){Util.extend(Util,{Animation:{stopFade:function(el){$(el).stop(true,true);},fadeIn:function(el,opacity,duration,callback){opacity=Util.coalesce(opacity,1);duration=Util.coalesce(duration,500);$(el).fadeTo(duration,opacity,callback);},fadeOut:function(el,duration,callback){if(Util.isNothing(duration)){duration=500;} +$(el).fadeTo(duration,0,callback);},slideBy:function(el,xPos,yPos,duration,callback){if(Util.isNothing(duration)){duration=500;} +$(el).animate({left:'+='+xPos+'px',top:'+='+yPos+'px'},duration,callback);}}});})(Code.PhotoSwipe.Util);(function(){Code.PhotoSwipe.EventClass=Class.extend({_listeners:null,init:function(){this._listeners={};},addEventListener:function(type,listener){if(typeof this._listeners[type]==='undefined'){this._listeners[type]=[];} +this._listeners[type].push(listener);},dispatchEvent:function(event){if(typeof event=="string"){event={type:event};} +if(!event.target){event.target=this;} +if(!event.type){throw new Error("Event object missing 'type' property.");} +if(this._listeners[event.type]instanceof Array){var listeners=this._listeners[event.type];for(var i=0,len=listeners.length;ithis.naturalHeight);this.isLoading=false;this.hasLoaded=true;this.dispatchEvent(Code.PhotoSwipe.FullSizeImageClass.EventTypes.onLoad);}});Code.PhotoSwipe.FullSizeImageClass.EventTypes={onLoad:'onLoad'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.DocumentOverlayClass=Code.PhotoSwipe.ElementClass.extend({init:function(options){this._super(options);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.DocumentOverlayClass.CssClasses.documentOverlay},'');Util.DOM.setStyle(this.el,{left:0,position:'absolute',top:0});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);},resetPosition:function(){Util.DOM.width(this.el,Util.DOM.bodyWidth());Util.DOM.height(this.el,Util.DOM.bodyHeight());}});Code.PhotoSwipe.DocumentOverlayClass.CssClasses={documentOverlay:'ps-document-overlay'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.ViewportClass=Code.PhotoSwipe.ElementClass.extend({touchStartPoint:null,touchFingerCount:null,touchCancelsMouseEvents:null,touchStartHandler:null,touchMoveHandler:null,touchEndHandler:null,mouseDownHandler:null,mouseUpHandler:null,init:function(options){this.settings={swipeThreshold:500};Util.extend(this.settings,options);this._super(this.settings);this.touchFingerCount=0;this.touchStartPoint={x:0,y:0};this.touchCancelsMouseEvents=false;this.touchStartHandler=this.onTouchStart.bind(this);this.touchMoveHandler=this.onTouchMove.bind(this);this.touchEndHandler=this.onTouchEnd.bind(this);this.mouseDownHandler=this.onMouseDown.bind(this);this.mouseUpHandler=this.onMouseUp.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ViewportClass.CssClasses.viewport},'');Util.DOM.setStyle(this.el,{position:'absolute',left:0,overflow:'hidden'});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);},resetPosition:function(){Util.DOM.setStyle(this.el,{top:Util.DOM.windowScrollTop()+'px'});Util.DOM.width(this.el,Util.DOM.bodyWidth());Util.DOM.height(this.el,Util.DOM.windowHeight());},addEventListeners:function(){try{Util.DOM.addEventListener(this.el,'touchstart',this.touchStartHandler);Util.DOM.addEventListener(this.el,'touchmove',this.touchMoveHandler);Util.DOM.addEventListener(this.el,'touchend',this.touchEndHandler);} +catch(err){} +Util.DOM.addEventListener(this.el,'mousedown',this.mouseDownHandler);Util.DOM.addEventListener(this.el,'mouseup',this.mouseUpHandler);},removeEventListeners:function(){try{Util.DOM.removeEventListener(this.el,'touchstart',this.touchStartHandler);Util.DOM.removeEventListener(this.el,'touchmove',this.touchMoveHandler);Util.DOM.removeEventListener(this.el,'touchend',this.touchEndHandler);} +catch(err){} +Util.DOM.removeEventListener(this.el,'mousedown',this.mouseDownHandler);Util.DOM.removeEventListener(this.el,'mouseup',this.mouseUpHandler);},setCurrentTouchPoint:function(touchPoint,touches){this.touchFingerCount=touches.length;if(this.touchFingerCount===1){touchPoint.x=touches[0].pageX;touchPoint.y=touches[0].pageY;} +else{this.touchFingerCount=0;touchPoint.x=0;touchPoint.y=0;}},onTouchStart:function(e){e.preventDefault();this.setCurrentTouchPoint(this.touchStartPoint,Util.DOM.getTouchEvent(e).touches);},onTouchMove:function(e){e.preventDefault();},onTouchEnd:function(e){e.preventDefault();var touchEndPoint={x:0,y:0};var touchEvent=Util.DOM.getTouchEvent(e);if(!Util.isNothing(touchEvent.changedTouches)){this.setCurrentTouchPoint(touchEndPoint,touchEvent.changedTouches);} +else{this.setCurrentTouchPoint(touchEndPoint,touchEvent.touches);} +if(this.touchFingerCount==1){this.fireTouchEvent(this.touchStartPoint,touchEndPoint);}},onMouseDown:function(e){e.preventDefault();if(this.touchCancelsMouseEvents){return;} +this.touchStartPoint=Util.DOM.getMousePosition(e);},onMouseUp:function(e){e.preventDefault();if(this.touchCancelsMouseEvents){return;} +this.fireTouchEvent(this.touchStartPoint,Util.DOM.getMousePosition(e));},fireTouchEvent:function(touchStartPoint,touchEndPoint){var action;var distance=touchEndPoint.x-touchStartPoint.x;if(Math.abs(distance)>=this.settings.swipeThreshold){if(distance<0){action=Code.PhotoSwipe.ViewportClass.Actions.swipeLeft;} +else{action=Code.PhotoSwipe.ViewportClass.Actions.swipeRight;}} +else{action=Code.PhotoSwipe.ViewportClass.Actions.click;} +if(Util.isNothing(action)){return;} +this.dispatchEvent({type:Code.PhotoSwipe.ViewportClass.EventTypes.onTouch,target:this,action:action});}});Code.PhotoSwipe.ViewportClass.CssClasses={viewport:'ps-viewport'};Code.PhotoSwipe.ViewportClass.Actions={click:'click',swipeLeft:'swipeLeft',swipeRight:'swipeRight'};Code.PhotoSwipe.ViewportClass.EventTypes={onTouch:'onTouch'};})(Code.PhotoSwipe.Util);(function(Util,FullSizeImageClass){Code.PhotoSwipe.SliderItemClass=Code.PhotoSwipe.EventClass.extend({el:null,imageEl:null,parentEl:null,fullSizeImage:null,fullSizeImageLoadEventHandler:null,init:function(parentEl){this._super();this.parentEl=parentEl;this.fullSizeImageLoadEventHandler=this.onFullSizeImageLoad.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.SliderItemClass.CssClasses.item+' '+Code.PhotoSwipe.SliderItemClass.CssClasses.loading},'');Util.DOM.setStyle(this.el,{position:'absolute',top:0});Util.DOM.resetTranslate(this.el);Util.DOM.appendChild(this.el,this.parentEl);this.imageEl=new Image();Util.DOM.setStyle(this.imageEl,{display:'block',position:'absolute',margin:0,padding:0});Util.DOM.hide(this.imageEl);Util.DOM.appendChild(this.imageEl,this.el);},resetPosition:function(width,height,xPos){Util.DOM.width(this.el,width);Util.DOM.height(this.el,height);Util.DOM.setStyle(this.el,'left',xPos+'px');this.resetImagePosition();},resetImagePosition:function(){if(Util.isNothing(this.fullSizeImage)){return;} +var src=Util.DOM.getAttribute(this.imageEl,'src');var +scale,newWidth,newHeight,newTop,newLeft,maxWidth=Util.DOM.width(this.el),maxHeight=Util.DOM.height(this.el);if(this.fullSizeImage.isLandscape){scale=maxWidth/this.fullSizeImage.naturalWidth;} +else{scale=maxHeight/this.fullSizeImage.naturalHeight;} +newWidth=Math.round(this.fullSizeImage.naturalWidth*scale);newHeight=Math.round(this.fullSizeImage.naturalHeight*scale);if(this.fullSizeImage.scaleMethod==='fit'){scale=1;if(newWidth>maxWidth){scale=maxWidth/newWidth;} +else if(newHeight>maxHeight){scale=maxHeight/newHeight;} +if(scale!==1){newWidth=Math.round(newWidth*scale);newHeight=Math.round(newHeight*scale);}} +newTop=((maxHeight-newHeight)/2)+'px';newLeft=((maxWidth-newWidth)/2)+'px';Util.DOM.width(this.imageEl,newWidth);Util.DOM.height(this.imageEl,newHeight);Util.DOM.setStyle(this.imageEl,{top:newTop,left:newLeft});Util.DOM.show(this.imageEl);},setFullSizeImage:function(fullSizeImage){this.fullSizeImage=fullSizeImage;Util.DOM.removeClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.loading);Util.DOM.removeClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.imageError);if(Util.isNothing(this.fullSizeImage)){this.fullSizeImage=null;Util.DOM.addClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.imageError);this.hideImage();return;} +if(!this.fullSizeImage.hasLoaded){Util.DOM.addClass(this.el,Code.PhotoSwipe.SliderItemClass.CssClasses.loading);this.hideImage();if(!this.fullSizeImage.isLoading){this.fullSizeImage.addEventListener(FullSizeImageClass.EventTypes.onLoad,this.fullSizeImageLoadEventHandler);this.fullSizeImage.load();} +return;} +Util.DOM.setAttribute(this.imageEl,'src',this.fullSizeImage.src);this.resetImagePosition();this.dispatchEvent(Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageDisplay);},onFullSizeImageLoad:function(e){e.target.removeEventListener(FullSizeImageClass.EventTypes.onLoad,this.fullSizeImageLoadEventHandler);if(Util.isNothing(this.fullSizeImage)||e.target.index!==this.fullSizeImage.index){this.dispatchEvent({type:Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageLoadAnomaly,target:this,fullSizeImage:e.target});} +else{this.setFullSizeImage(e.target);}},hideImage:function(){Util.DOM.removeAttribute(this.imageEl,'src');Util.DOM.hide(this.imageEl);}});Code.PhotoSwipe.SliderItemClass.CssClasses={item:'ps-slider-item',loading:'ps-slider-item-loading',imageError:'ps-slider-item-image-error'};Code.PhotoSwipe.SliderItemClass.EventTypes={onFullSizeImageDisplay:'onFullSizeImageDisplay',onFullSizeImageLoadAnomaly:'onFullSizeImageLoadAnomaly'};})(Code.PhotoSwipe.Util,Code.PhotoSwipe.FullSizeImageClass);(function(Util,SliderItemClass){Code.PhotoSwipe.SliderClass=Code.PhotoSwipe.ElementClass.extend({parentEl:null,parentElWidth:null,parentElHeight:null,items:null,previousItem:null,currentItem:null,nextItem:null,hasBounced:null,lastShowAction:null,bounceSlideBy:null,showNextEndEventHandler:null,showPreviousEndEventHandler:null,bounceStepOneEventHandler:null,bounceStepTwoEventHandler:null,sliderFullSizeImageLoadAnomalyEventHandler:null,init:function(options,parentEl){this.settings={slideSpeed:250};Util.extend(this.settings,options);this._super(this.settings);this.parentEl=parentEl;this.hasBounced=false;this.showNextEndEventHandler=this.onShowNextEnd.bind(this);this.showPreviousEndEventHandler=this.onShowPreviousEnd.bind(this);this.bounceStepOneEventHandler=this.onBounceStepOne.bind(this);this.bounceStepTwoEventHandler=this.onBounceStepTwo.bind(this);this.sliderFullSizeImageLoadAnomalyEventHandler=this.onSliderFullSizeImageLoadAnomaly.bind(this);this.el=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.SliderClass.CssClasses.slider},'');Util.DOM.setStyle(this.el,{position:'absolute',top:0});Util.DOM.hide(this.el);Util.DOM.appendChild(this.el,parentEl);this.items=[];this.items.push(new SliderItemClass(this.el));this.items.push(new SliderItemClass(this.el));this.items.push(new SliderItemClass(this.el));this.previousItem=this.items[0];this.currentItem=this.items[1];this.nextItem=this.items[2];},addEventListeners:function(){for(var i=0;i0){this.fadeOutTimeout=window.setTimeout(this.fadeOut.bind(this),this.settings.captionDelay);} +this._super();}});Code.PhotoSwipe.CaptionClass.CssClasses={caption:'ps-caption',bottom:'ps-caption-bottom',content:'ps-caption-content'};})(Code.PhotoSwipe.Util);(function(Util){Code.PhotoSwipe.ToolbarClass=Code.PhotoSwipe.ElementClass.extend({closeEl:null,previousEl:null,nextEl:null,playEl:null,clickHandler:null,fadeOutTimeout:null,isNextActive:null,isPreviousActive:null,init:function(options){this.settings={toolbarDelay:4000,position:'bottom'};Util.extend(this.settings,options);this._super(options);this.isNextActive=true;this.isPreviousActive=true;this.clickHandler=this.onClick.bind(this);var cssClass=Code.PhotoSwipe.ToolbarClass.CssClasses.caption;if(this.settings.position==='top'){cssClass=cssClass+' '+Code.PhotoSwipe.ToolbarClass.CssClasses.top;} +this.el=Util.DOM.createElement('div',{'class':cssClass},'');Util.DOM.setStyle(this.el,{left:0,position:'absolute',overflow:'hidden',zIndex:1001,display:'table'});Util.DOM.hide(this.el);Util.DOM.appendToBody(this.el);this.closeEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.close},'
');Util.DOM.appendChild(this.closeEl,this.el);this.playEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.play},'
');Util.DOM.appendChild(this.playEl,this.el);this.previousEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.previous},'
');Util.DOM.appendChild(this.previousEl,this.el);this.nextEl=Util.DOM.createElement('div',{'class':Code.PhotoSwipe.ToolbarClass.CssClasses.next},'
');Util.DOM.appendChild(this.nextEl,this.el);},addEventListeners:function(){Util.DOM.addEventListener(this.el,'click',this.clickHandler);},removeEventListeners:function(){Util.DOM.removeEventListener(this.el,'click',this.clickHandler);},onClick:function(e){var action;switch(e.target.parentNode){case this.previousEl:if(this.isPreviousActive){action=Code.PhotoSwipe.ToolbarClass.Actions.previous;} +break;case this.nextEl:if(this.isNextActive){action=Code.PhotoSwipe.ToolbarClass.Actions.next;} +break;case this.playEl:action=Code.PhotoSwipe.ToolbarClass.Actions.play;break;case this.closeEl:action=Code.PhotoSwipe.ToolbarClass.Actions.close;break;} +if(Util.isNothing(action)){return;} +this.dispatchEvent({type:Code.PhotoSwipe.ToolbarClass.EventTypes.onClick,target:this,action:action});},resetPosition:function(){var top;if(this.settings.position==='bottom'){top=Util.DOM.windowHeight()-Util.DOM.height(this.el)+Util.DOM.windowScrollTop();} +else{top=Util.DOM.windowScrollTop();} +Util.DOM.setStyle(this.el,'top',top+'px');Util.DOM.width(this.el,Util.DOM.bodyWidth());},stopFade:function(){window.clearTimeout(this.fadeOutTimeout);this._super();},postShow:function(){if(this.settings.toolbarDelay>0){this.fadeOutTimeout=window.setTimeout(this.fadeOut.bind(this),this.settings.toolbarDelay);} +this._super();},setNextState:function(disable){if(disable){Util.DOM.addClass(this.nextEl,Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled);this.isNextActive=false;} +else{Util.DOM.removeClass(this.nextEl,Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled);this.isNextActive=true;}},setPreviousState:function(disable){if(disable){Util.DOM.addClass(this.previousEl,Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled);this.isPreviousActive=false;} +else{Util.DOM.removeClass(this.previousEl,Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled);this.isPreviousActive=true;}}});Code.PhotoSwipe.ToolbarClass.CssClasses={caption:'ps-toolbar',top:'ps-toolbar-top',close:'ps-toolbar-close',previous:'ps-toolbar-previous',previousDisabled:'ps-toolbar-previous-disabled',next:'ps-toolbar-next',nextDisabled:'ps-toolbar-next-disabled',play:'ps-toolbar-play',content:'ps-toolbar-content'};Code.PhotoSwipe.ToolbarClass.Actions={close:'close',previous:'previous',next:'next',play:'play'};Code.PhotoSwipe.ToolbarClass.EventTypes={onClick:'onClick'};})(Code.PhotoSwipe.Util);(function(Util,ElementClass,DocumentOverlayClass,FullSizeImageClass,ViewportClass,SliderClass,CaptionClass,ToolbarClass){var photoSwipe=Code.PhotoSwipe.EventClass.extend({fullSizeImages:null,documentOverlay:null,viewport:null,slider:null,caption:null,toolbar:null,settings:null,slideShowSettingsSaved:null,currentIndex:null,isBusy:null,slideshowTimeout:null,documentOverlayFadeInEventHandler:null,windowResizeEventHandler:null,windowOrientationChangeEventHandler:null,windowScrollEventHandler:null,keyDownEventHandler:null,viewportTouchEventHandler:null,viewportFadeOutEventHandler:null,sliderDisplayCurrentFullSizeImageEventHandler:null,toolbarClickEventHandler:null,init:function(){this._super();this.currentIndex=0;this.isBusy=false;this.settings={getImageSource:Code.PhotoSwipe.GetImageSource,getImageCaption:Code.PhotoSwipe.GetImageCaption,fadeSpeed:400,slideSpeed:250,swipeThreshold:50,loop:true,flipCaptionAndToolbar:false,captionDelay:3000,captionOpacity:0.8,hideCaption:false,showEmptyCaptions:true,toolbarDelay:3000,toolbarOpacity:0.8,hideToolbar:false,slideshowDelay:3000,imageScaleMethod:'fit'};this.documentOverlayFadeInEventHandler=this.onDocumentOverlayFadeIn.bind(this);this.windowResizeEventHandler=this.onWindowResize.bind(this);this.windowOrientationChangeEventHandler=this.onWindowOrientationChange.bind(this);this.windowScrollEventHandler=this.onWindowScroll.bind(this);this.keyDownEventHandler=this.onKeyDown.bind(this);this.viewportTouchEventHandler=this.onViewportTouch.bind(this);this.viewportFadeOutEventHandler=this.onViewportFadeOut.bind(this);this.sliderDisplayCurrentFullSizeImageEventHandler=this.onSliderDisplayCurrentFullSizeImage.bind(this);this.toolbarClickEventHandler=this.onToolbarClick.bind(this);},setOptions:function(options){Util.extend(this.settings,options);},setImages:function(thumbEls){if(!Util.isArray){throw"thumbEls is not an array";} +this.currentIndex=0;this.fullSizeImages=[];for(var i=0;i=this.fullSizeImages.length){startingIndex=0;} +this.currentIndex=startingIndex;if(Util.isNothing(this.documentOverlay)){this.build();} +this.documentOverlay.addEventListener(ElementClass.EventTypes.onFadeIn,this.documentOverlayFadeInEventHandler);this.documentOverlay.fadeIn();},build:function(){this.documentOverlay=new DocumentOverlayClass({opacity:1,fadeSpeed:this.settings.fadeSpeed});this.viewport=new ViewportClass({opacity:1,fadeSpeed:this.settings.fadeSpeed,swipeThreshold:this.settings.swipeThreshold});this.slider=new SliderClass({opacity:1,fadeSpeed:this.settings.fadeSpeed,slideSpeed:this.settings.slideSpeed},this.viewport.el);this.caption=new CaptionClass({opacity:this.settings.captionOpacity,fadeSpeed:this.settings.fadeSpeed,captionDelay:this.settings.captionDelay,position:(this.settings.flipCaptionAndToolbar)?'bottom':'top'});this.toolbar=new ToolbarClass({opacity:this.settings.toolbarOpacity,fadeSpeed:this.settings.fadeSpeed,toolbarDelay:this.settings.toolbarDelay,position:(this.settings.flipCaptionAndToolbar)?'top':'bottom'});},addEventListeners:function(){if(!Util.isNothing(window.orientation)){Util.DOM.addEventListener(window,'orientationchange',this.windowOrientationChangeEventHandler);} +Util.DOM.addEventListener(window,'resize',this.windowResizeEventHandler);Util.DOM.addEventListener(window,'scroll',this.windowScrollEventHandler);Util.DOM.addEventListener(document,'keydown',this.keyDownEventHandler);this.viewport.addEventListener(ViewportClass.EventTypes.onTouch,this.viewportTouchEventHandler);this.slider.addEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage,this.sliderDisplayCurrentFullSizeImageEventHandler);this.toolbar.addEventListener(ToolbarClass.EventTypes.onClick,this.toolbarClickEventHandler);},removeEventListeners:function(){if(!Util.isNothing(window.orientation)){Util.DOM.removeEventListener(window,'orientationchange',this.windowOrientationChangeEventHandler);} +Util.DOM.removeEventListener(window,'resize',this.windowResizeEventHandler);Util.DOM.removeEventListener(window,'scroll',this.windowScrollEventHandler);Util.DOM.removeEventListener(document,'keydown',this.keyDownEventHandler);this.viewport.removeEventListener(ViewportClass.EventTypes.onTouch,this.viewportTouchEventHandler);this.slider.removeEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage,this.sliderDisplayCurrentFullSizeImageEventHandler);this.toolbar.removeEventListener(ToolbarClass.EventTypes.onClick,this.toolbarClickEventHandler);},onDocumentOverlayFadeIn:function(e){this.documentOverlay.removeEventListener(ElementClass.EventTypes.onFadeIn,this.documentOverlayFadeInEventHandler);this.viewport.show();this.slider.show();this.toolbar.show();this.addEventListeners();this.slider.setCurrentFullSizeImage(this.fullSizeImages[this.currentIndex]);this.isBusy=false;},setSliderPreviousAndNextFullSizeImages:function(){var +lastIndex,previousFullSizeImage=null,nextFullSizeImage=null;if(this.fullSizeImages.length>1){lastIndex=this.fullSizeImages.length-1;if(this.currentIndex===lastIndex){if(this.settings.loop){nextFullSizeImage=this.fullSizeImages[0];} +previousFullSizeImage=this.fullSizeImages[this.currentIndex-1];} +else if(this.currentIndex===0){nextFullSizeImage=this.fullSizeImages[this.currentIndex+1];if(this.settings.loop){previousFullSizeImage=this.fullSizeImages[lastIndex];}} +else{nextFullSizeImage=this.fullSizeImages[this.currentIndex+1];previousFullSizeImage=this.fullSizeImages[this.currentIndex-1];}} +this.slider.setPreviousAndNextFullSizeImages(previousFullSizeImage,nextFullSizeImage);},onWindowResize:function(e){this.resetPosition();},onKeyDown:function(e){if(e.keyCode===37){e.preventDefault();this.showPrevious();} +else if(e.keyCode===39){e.preventDefault();this.showNext();} +else if(e.keyCode===38||e.keyCode===40){e.preventDefault();} +else if(e.keyCode===27){e.preventDefault();this.hide();} +else if(e.keyCode===32){e.preventDefault();}},onWindowOrientationChange:function(e){this.resetPosition();},onWindowScroll:function(e){this.resetPosition();},resetPosition:function(){if(this.isBusy){return;} +this.documentOverlay.resetPosition();this.viewport.resetPosition();this.slider.resetPosition();this.caption.resetPosition();this.toolbar.resetPosition();},onViewportTouch:function(e){switch(e.action){case ViewportClass.Actions.swipeLeft:this.showNext();break;case ViewportClass.Actions.swipeRight:this.showPrevious();break;default:if(this.isSlideShowActive()||!this.settings.hideToolbar){this.showCaptionAndToolbar();} +else{this.hide();} +break;}},onViewportFadeOut:function(e){this.viewport.removeEventListener(ElementClass.EventTypes.onFadeOut,this.viewportFadeOutEventHandler);this.isBusy=false;},hide:function(){if(this.isBusy){return;} +this.isBusy=true;this.removeEventListeners();this.documentOverlay.hide();this.caption.hide();this.toolbar.hide();this.slider.hide();Util.DOM.removeClass(document.body,Code.PhotoSwipe.CssClasses.activeBody);this.viewport.addEventListener(ElementClass.EventTypes.onFadeOut,this.viewportFadeOutEventHandler);this.viewport.fadeOut();},showNext:function(){if(this.isBusy){return;} +this.isBusy=true;this.caption.setEmptyCaption();this.slider.showNext();},showPrevious:function(){if(this.isBusy){return;} +this.isBusy=true;this.caption.setEmptyCaption();this.slider.showPrevious();},onSliderDisplayCurrentFullSizeImage:function(e){this.currentIndex=e.fullSizeImage.index;this.setSliderPreviousAndNextFullSizeImages();this.isBusy=false;if(this.isSlideShowActive()){if(!this.settings.loop&&this.currentIndex===this.fullSizeImages.length-1){this.slideshowTimeout=window.setTimeout(this.showCaptionAndToolbar.bind(this),this.settings.slideshowDelay);} +else{this.fireSlideshowTimeout();}} +else{this.showCaptionAndToolbar();}},showCaptionAndToolbar:function(captionValue){this.stopSlideshow();if(this.settings.hideCaption){this.caption.hide();} +else{captionValue=Util.coalesce(captionValue,this.fullSizeImages[this.currentIndex].caption);if((Util.isNothing(captionValue)||captionValue==='')&&!this.settings.showEmptyCaptions){this.caption.hide();return;} +this.caption.show(captionValue);} +if(this.settings.hideToolbar){this.toolbar.hide();} +else{if(this.settings.loop){this.toolbar.setNextState(false);this.toolbar.setPreviousState(false);} +else{if(this.currentIndex>=this.fullSizeImages.length-1){this.toolbar.setNextState(true);} +else{this.toolbar.setNextState(false);} +if(this.currentIndex<1){this.toolbar.setPreviousState(true);} +else{this.toolbar.setPreviousState(false);}} +this.toolbar.show();}},onToolbarClick:function(e){switch(e.action){case ToolbarClass.Actions.previous:this.showPrevious();break;case ToolbarClass.Actions.next:this.showNext();break;case ToolbarClass.Actions.play:this.startSlideshow();break;default:this.hide();break;}},startSlideshow:function(){if(this.isBusy){return;} +window.clearTimeout(this.slideshowTimeout);this.slideShowSettingsSaved={hideCaption:this.settings.hideCaption,hideToolbar:this.settings.hideToolbar};this.settings.hideCaption=true;this.settings.hideToolbar=true;this.caption.fadeOut();this.toolbar.fadeOut();this.fireSlideshowTimeout();},stopSlideshow:function(){if(!this.isSlideShowActive()){return;} +window.clearTimeout(this.slideshowTimeout);this.settings.hideCaption=this.slideShowSettingsSaved.hideCaption;this.settings.hideToolbar=this.slideShowSettingsSaved.hideToolbar;this.slideShowSettingsSaved=null;},isSlideShowActive:function(){return(!Util.isNothing(this.slideShowSettingsSaved));},fireSlideshowTimeout:function(){this.slideshowTimeout=window.setTimeout(this.showNext.bind(this),this.settings.slideshowDelay);}});Code.PhotoSwipe.CssClasses={activeBody:'ps-active'};Code.PhotoSwipe.GetImageSource=function(el){return el.href;};Code.PhotoSwipe.GetImageCaption=function(el){if(el.nodeName==="IMG"){return Util.DOM.getAttribute(el,'alt');} +return Util.DOM.getAttribute(el.firstChild,'alt');};Code.PhotoSwipe.Current=new photoSwipe();Code.photoSwipe=function(thumbEls,containerEl,opts){var useEventDelegation=true;if(Util.isNothing(thumbEls)){return;} +if(Util.isNothing(containerEl)){containerEl=document.documentElement;useEventDelegation=false;} +if(Util.isString(containerEl)){containerEl=document.documentElement.querySelector(containerEl);} +if(Util.isNothing(containerEl)){throw'Unable to find container element';} +if(Util.isString(thumbEls)){thumbEls=containerEl.querySelectorAll(thumbEls);} +if(Util.isNothing(thumbEls)){return;} +Code.PhotoSwipe.Current.setOptions(opts);Code.PhotoSwipe.Current.setImages(thumbEls);if(useEventDelegation){containerEl.addEventListener('click',function(e){if(e.target===e.currentTarget){return;} +e.preventDefault();var findNode=function(clickedEl,targetNodeName,stopAtEl){if(Util.isNothing(clickedEl)||Util.isNothing(targetNodeName)||Util.isNothing(stopAtEl)){return null;} +if(clickedEl.nodeName===targetNodeName){return clickedEl;} +if(clickedEl===stopAtEl){return null;} +return findNode(clickedEl.parentNode,targetNodeName,stopAtEl)};var clickedEl=findNode(e.target,thumbEls[0].nodeName,e.currentTarget);if(Util.isNothing(clickedEl)){return;} +showPhotoSwipe(clickedEl);},false);} +else{for(var i=0;i + + PhotoSwipe + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/artifact/1.0.0/examples/images/blogicon.png b/artifact/1.0.0/examples/images/blogicon.png new file mode 100644 index 000000000..7cb472c3d Binary files /dev/null and b/artifact/1.0.0/examples/images/blogicon.png differ diff --git a/artifact/1.0.0/examples/images/codecomputerlovelogo.gif b/artifact/1.0.0/examples/images/codecomputerlovelogo.gif new file mode 100644 index 000000000..f5a905407 Binary files /dev/null and b/artifact/1.0.0/examples/images/codecomputerlovelogo.gif differ diff --git a/artifact/1.0.0/examples/images/facebookicon.png b/artifact/1.0.0/examples/images/facebookicon.png new file mode 100644 index 000000000..e6de15d06 Binary files /dev/null and b/artifact/1.0.0/examples/images/facebookicon.png differ diff --git a/artifact/1.0.0/examples/images/flickricon.png b/artifact/1.0.0/examples/images/flickricon.png new file mode 100644 index 000000000..a7474c9f6 Binary files /dev/null and b/artifact/1.0.0/examples/images/flickricon.png differ diff --git a/artifact/1.0.0/examples/images/full/001.jpg b/artifact/1.0.0/examples/images/full/001.jpg new file mode 100644 index 000000000..2ab880c20 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/001.jpg differ diff --git a/artifact/1.0.0/examples/images/full/002.jpg b/artifact/1.0.0/examples/images/full/002.jpg new file mode 100644 index 000000000..80e9da4c8 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/002.jpg differ diff --git a/artifact/1.0.0/examples/images/full/003.jpg b/artifact/1.0.0/examples/images/full/003.jpg new file mode 100644 index 000000000..cf61c3f21 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/003.jpg differ diff --git a/artifact/1.0.0/examples/images/full/004.jpg b/artifact/1.0.0/examples/images/full/004.jpg new file mode 100644 index 000000000..fc0c1b790 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/004.jpg differ diff --git a/artifact/1.0.0/examples/images/full/005.jpg b/artifact/1.0.0/examples/images/full/005.jpg new file mode 100644 index 000000000..50cc9c304 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/005.jpg differ diff --git a/artifact/1.0.0/examples/images/full/006.jpg b/artifact/1.0.0/examples/images/full/006.jpg new file mode 100644 index 000000000..330790e86 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/006.jpg differ diff --git a/artifact/1.0.0/examples/images/full/007.jpg b/artifact/1.0.0/examples/images/full/007.jpg new file mode 100644 index 000000000..6244f9dc8 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/007.jpg differ diff --git a/artifact/1.0.0/examples/images/full/008.jpg b/artifact/1.0.0/examples/images/full/008.jpg new file mode 100644 index 000000000..fc52e87a3 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/008.jpg differ diff --git a/artifact/1.0.0/examples/images/full/009.jpg b/artifact/1.0.0/examples/images/full/009.jpg new file mode 100644 index 000000000..ec81b067c Binary files /dev/null and b/artifact/1.0.0/examples/images/full/009.jpg differ diff --git a/artifact/1.0.0/examples/images/full/010.jpg b/artifact/1.0.0/examples/images/full/010.jpg new file mode 100644 index 000000000..f705ddc9f Binary files /dev/null and b/artifact/1.0.0/examples/images/full/010.jpg differ diff --git a/artifact/1.0.0/examples/images/full/011.jpg b/artifact/1.0.0/examples/images/full/011.jpg new file mode 100644 index 000000000..e41c7ff41 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/011.jpg differ diff --git a/artifact/1.0.0/examples/images/full/012.jpg b/artifact/1.0.0/examples/images/full/012.jpg new file mode 100644 index 000000000..4f2de4bd7 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/012.jpg differ diff --git a/artifact/1.0.0/examples/images/full/013.jpg b/artifact/1.0.0/examples/images/full/013.jpg new file mode 100644 index 000000000..571a9e487 Binary files /dev/null and b/artifact/1.0.0/examples/images/full/013.jpg differ diff --git a/artifact/1.0.0/examples/images/full/014.jpg b/artifact/1.0.0/examples/images/full/014.jpg new file mode 100644 index 000000000..a7b233f2e Binary files /dev/null and b/artifact/1.0.0/examples/images/full/014.jpg differ diff --git a/artifact/1.0.0/examples/images/full/015.jpg b/artifact/1.0.0/examples/images/full/015.jpg new file mode 100644 index 000000000..cd04cbfbd Binary files /dev/null and b/artifact/1.0.0/examples/images/full/015.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/001.jpg b/artifact/1.0.0/examples/images/thumb/001.jpg new file mode 100644 index 000000000..4ba1b8112 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/001.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/002.jpg b/artifact/1.0.0/examples/images/thumb/002.jpg new file mode 100644 index 000000000..09538dfe6 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/002.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/003.jpg b/artifact/1.0.0/examples/images/thumb/003.jpg new file mode 100644 index 000000000..e95bc3784 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/003.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/004.jpg b/artifact/1.0.0/examples/images/thumb/004.jpg new file mode 100644 index 000000000..86ace941a Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/004.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/005.jpg b/artifact/1.0.0/examples/images/thumb/005.jpg new file mode 100644 index 000000000..e9b17f0a0 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/005.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/006.jpg b/artifact/1.0.0/examples/images/thumb/006.jpg new file mode 100644 index 000000000..d0757d85d Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/006.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/007.jpg b/artifact/1.0.0/examples/images/thumb/007.jpg new file mode 100644 index 000000000..a6a02657e Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/007.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/008.jpg b/artifact/1.0.0/examples/images/thumb/008.jpg new file mode 100644 index 000000000..185bce127 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/008.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/009.jpg b/artifact/1.0.0/examples/images/thumb/009.jpg new file mode 100644 index 000000000..aac07132e Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/009.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/010.jpg b/artifact/1.0.0/examples/images/thumb/010.jpg new file mode 100644 index 000000000..cdae77865 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/010.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/011.jpg b/artifact/1.0.0/examples/images/thumb/011.jpg new file mode 100644 index 000000000..a71f66d34 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/011.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/012.jpg b/artifact/1.0.0/examples/images/thumb/012.jpg new file mode 100644 index 000000000..27a732e02 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/012.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/013.jpg b/artifact/1.0.0/examples/images/thumb/013.jpg new file mode 100644 index 000000000..ae52fe90b Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/013.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/014.jpg b/artifact/1.0.0/examples/images/thumb/014.jpg new file mode 100644 index 000000000..919980be8 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/014.jpg differ diff --git a/artifact/1.0.0/examples/images/thumb/015.jpg b/artifact/1.0.0/examples/images/thumb/015.jpg new file mode 100644 index 000000000..f587b00c2 Binary files /dev/null and b/artifact/1.0.0/examples/images/thumb/015.jpg differ diff --git a/artifact/1.0.0/examples/images/twittericon.png b/artifact/1.0.0/examples/images/twittericon.png new file mode 100644 index 000000000..7a588c1e8 Binary files /dev/null and b/artifact/1.0.0/examples/images/twittericon.png differ diff --git a/artifact/1.0.0/examples/index-jquery-plugin.html b/artifact/1.0.0/examples/index-jquery-plugin.html new file mode 100644 index 000000000..e62047930 --- /dev/null +++ b/artifact/1.0.0/examples/index-jquery-plugin.html @@ -0,0 +1,123 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/artifact/1.0.0/examples/index.html b/artifact/1.0.0/examples/index.html new file mode 100644 index 000000000..28d3b4c69 --- /dev/null +++ b/artifact/1.0.0/examples/index.html @@ -0,0 +1,139 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/artifact/1.0.0/examples/jquery-engine.html b/artifact/1.0.0/examples/jquery-engine.html new file mode 100644 index 000000000..a42624606 --- /dev/null +++ b/artifact/1.0.0/examples/jquery-engine.html @@ -0,0 +1,127 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/artifact/1.0.0/examples/styles.css b/artifact/1.0.0/examples/styles.css new file mode 100644 index 000000000..38acccd76 --- /dev/null +++ b/artifact/1.0.0/examples/styles.css @@ -0,0 +1,20 @@ +body { padding: 0; margin: 0; background: #DFDCD1; font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; color: #444340; } +h1 { font-size: 1.3em; padding: 15px 10px; margin: 0; } +img { border: none; } +a { color: #444340; } + +#Header { background: #EEBF02; height: 61px; padding: 0; border-bottom: 1px solid #3c3c3c; } +#Header img { display: block; margin: 0 auto 0; } + +#MainContent { background: #ffffff; padding-bottom: 30px; } + +#Footer { padding: 10px; border-top: none; } + +#SocialLinks { padding: 10px 0 0 0; } +#SocialLinks:after { clear: both; content: "."; display: block; height: 0; visibility: hidden; } +#SocialLinks a { display: block; float: left; padding-right: 15px; } + +div.gallery-row:after { clear: both; content: "."; display: block; height: 0; visibility: hidden; } +div.gallery-item { float: left; width: 33.33333333%; } +div.gallery-item a { display: block; margin: 5px; border: 1px solid #3c3c3c; } +div.gallery-item img { display: block; width: 100%; height: auto; } \ No newline at end of file diff --git a/artifact/1.0.0/lib/jquery-1.5.1.min.js b/artifact/1.0.0/lib/jquery-1.5.1.min.js new file mode 100644 index 000000000..6437874c6 --- /dev/null +++ b/artifact/1.0.0/lib/jquery-1.5.1.min.js @@ -0,0 +1,16 @@ +/*! + * jQuery JavaScript Library v1.5.1 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Wed Feb 23 13:55:29 2011 -0500 + */ +(function(a,b){function cg(a){return d.isWindow(a)?a:a.nodeType===9?a.defaultView||a.parentWindow:!1}function cd(a){if(!bZ[a]){var b=d("<"+a+">").appendTo("body"),c=b.css("display");b.remove();if(c==="none"||c==="")c="block";bZ[a]=c}return bZ[a]}function cc(a,b){var c={};d.each(cb.concat.apply([],cb.slice(0,b)),function(){c[this]=a});return c}function bY(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}function bX(){try{return new a.XMLHttpRequest}catch(b){}}function bW(){d(a).unload(function(){for(var a in bU)bU[a](0,1)})}function bQ(a,c){a.dataFilter&&(c=a.dataFilter(c,a.dataType));var e=a.dataTypes,f={},g,h,i=e.length,j,k=e[0],l,m,n,o,p;for(g=1;g=0===c})}function N(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function F(a,b){return(a&&a!=="*"?a+".":"")+b.replace(r,"`").replace(s,"&")}function E(a){var b,c,e,f,g,h,i,j,k,l,m,n,o,q=[],r=[],s=d._data(this,"events");if(a.liveFired!==this&&s&&s.live&&!a.target.disabled&&(!a.button||a.type!=="click")){a.namespace&&(n=new RegExp("(^|\\.)"+a.namespace.split(".").join("\\.(?:.*\\.)?")+"(\\.|$)")),a.liveFired=this;var t=s.live.slice(0);for(i=0;ic)break;a.currentTarget=f.elem,a.data=f.handleObj.data,a.handleObj=f.handleObj,o=f.handleObj.origHandler.apply(f.elem,arguments);if(o===!1||a.isPropagationStopped()){c=f.level,o===!1&&(b=!1);if(a.isImmediatePropagationStopped())break}}return b}}function C(a,c,e){var f=d.extend({},e[0]);f.type=a,f.originalEvent={},f.liveFired=b,d.event.handle.call(c,f),f.isDefaultPrevented()&&e[0].preventDefault()}function w(){return!0}function v(){return!1}function g(a){for(var b in a)if(b!=="toJSON")return!1;return!0}function f(a,c,f){if(f===b&&a.nodeType===1){f=a.getAttribute("data-"+c);if(typeof f==="string"){try{f=f==="true"?!0:f==="false"?!1:f==="null"?null:d.isNaN(f)?e.test(f)?d.parseJSON(f):f:parseFloat(f)}catch(g){}d.data(a,c,f)}else f=b}return f}var c=a.document,d=function(){function I(){if(!d.isReady){try{c.documentElement.doScroll("left")}catch(a){setTimeout(I,1);return}d.ready()}}var d=function(a,b){return new d.fn.init(a,b,g)},e=a.jQuery,f=a.$,g,h=/^(?:[^<]*(<[\w\W]+>)[^>]*$|#([\w\-]+)$)/,i=/\S/,j=/^\s+/,k=/\s+$/,l=/\d/,m=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,n=/^[\],:{}\s]*$/,o=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,p=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,q=/(?:^|:|,)(?:\s*\[)+/g,r=/(webkit)[ \/]([\w.]+)/,s=/(opera)(?:.*version)?[ \/]([\w.]+)/,t=/(msie) ([\w.]+)/,u=/(mozilla)(?:.*? rv:([\w.]+))?/,v=navigator.userAgent,w,x=!1,y,z="then done fail isResolved isRejected promise".split(" "),A,B=Object.prototype.toString,C=Object.prototype.hasOwnProperty,D=Array.prototype.push,E=Array.prototype.slice,F=String.prototype.trim,G=Array.prototype.indexOf,H={};d.fn=d.prototype={constructor:d,init:function(a,e,f){var g,i,j,k;if(!a)return this;if(a.nodeType){this.context=this[0]=a,this.length=1;return this}if(a==="body"&&!e&&c.body){this.context=c,this[0]=c.body,this.selector="body",this.length=1;return this}if(typeof a==="string"){g=h.exec(a);if(!g||!g[1]&&e)return!e||e.jquery?(e||f).find(a):this.constructor(e).find(a);if(g[1]){e=e instanceof d?e[0]:e,k=e?e.ownerDocument||e:c,j=m.exec(a),j?d.isPlainObject(e)?(a=[c.createElement(j[1])],d.fn.attr.call(a,e,!0)):a=[k.createElement(j[1])]:(j=d.buildFragment([g[1]],[k]),a=(j.cacheable?d.clone(j.fragment):j.fragment).childNodes);return d.merge(this,a)}i=c.getElementById(g[2]);if(i&&i.parentNode){if(i.id!==g[2])return f.find(a);this.length=1,this[0]=i}this.context=c,this.selector=a;return this}if(d.isFunction(a))return f.ready(a);a.selector!==b&&(this.selector=a.selector,this.context=a.context);return d.makeArray(a,this)},selector:"",jquery:"1.5.1",length:0,size:function(){return this.length},toArray:function(){return E.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this[this.length+a]:this[a]},pushStack:function(a,b,c){var e=this.constructor();d.isArray(a)?D.apply(e,a):d.merge(e,a),e.prevObject=this,e.context=this.context,b==="find"?e.selector=this.selector+(this.selector?" ":"")+c:b&&(e.selector=this.selector+"."+b+"("+c+")");return e},each:function(a,b){return d.each(this,a,b)},ready:function(a){d.bindReady(),y.done(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(E.apply(this,arguments),"slice",E.call(arguments).join(","))},map:function(a){return this.pushStack(d.map(this,function(b,c){return a.call(b,c,b)}))},end:function(){return this.prevObject||this.constructor(null)},push:D,sort:[].sort,splice:[].splice},d.fn.init.prototype=d.fn,d.extend=d.fn.extend=function(){var a,c,e,f,g,h,i=arguments[0]||{},j=1,k=arguments.length,l=!1;typeof i==="boolean"&&(l=i,i=arguments[1]||{},j=2),typeof i!=="object"&&!d.isFunction(i)&&(i={}),k===j&&(i=this,--j);for(;j0)return;y.resolveWith(c,[d]),d.fn.trigger&&d(c).trigger("ready").unbind("ready")}},bindReady:function(){if(!x){x=!0;if(c.readyState==="complete")return setTimeout(d.ready,1);if(c.addEventListener)c.addEventListener("DOMContentLoaded",A,!1),a.addEventListener("load",d.ready,!1);else if(c.attachEvent){c.attachEvent("onreadystatechange",A),a.attachEvent("onload",d.ready);var b=!1;try{b=a.frameElement==null}catch(e){}c.documentElement.doScroll&&b&&I()}}},isFunction:function(a){return d.type(a)==="function"},isArray:Array.isArray||function(a){return d.type(a)==="array"},isWindow:function(a){return a&&typeof a==="object"&&"setInterval"in a},isNaN:function(a){return a==null||!l.test(a)||isNaN(a)},type:function(a){return a==null?String(a):H[B.call(a)]||"object"},isPlainObject:function(a){if(!a||d.type(a)!=="object"||a.nodeType||d.isWindow(a))return!1;if(a.constructor&&!C.call(a,"constructor")&&!C.call(a.constructor.prototype,"isPrototypeOf"))return!1;var c;for(c in a){}return c===b||C.call(a,c)},isEmptyObject:function(a){for(var b in a)return!1;return!0},error:function(a){throw a},parseJSON:function(b){if(typeof b!=="string"||!b)return null;b=d.trim(b);if(n.test(b.replace(o,"@").replace(p,"]").replace(q,"")))return a.JSON&&a.JSON.parse?a.JSON.parse(b):(new Function("return "+b))();d.error("Invalid JSON: "+b)},parseXML:function(b,c,e){a.DOMParser?(e=new DOMParser,c=e.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b)),e=c.documentElement,(!e||!e.nodeName||e.nodeName==="parsererror")&&d.error("Invalid XML: "+b);return c},noop:function(){},globalEval:function(a){if(a&&i.test(a)){var b=c.head||c.getElementsByTagName("head")[0]||c.documentElement,e=c.createElement("script");d.support.scriptEval()?e.appendChild(c.createTextNode(a)):e.text=a,b.insertBefore(e,b.firstChild),b.removeChild(e)}},nodeName:function(a,b){return a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,c,e){var f,g=0,h=a.length,i=h===b||d.isFunction(a);if(e){if(i){for(f in a)if(c.apply(a[f],e)===!1)break}else for(;g1){var f=E.call(arguments,0),g=b,h=function(a){return function(b){f[a]=arguments.length>1?E.call(arguments,0):b,--g||c.resolveWith(e,f)}};while(b--)a=f[b],a&&d.isFunction(a.promise)?a.promise().then(h(b),c.reject):--g;g||c.resolveWith(e,f)}else c!==a&&c.resolve(a);return e},uaMatch:function(a){a=a.toLowerCase();var b=r.exec(a)||s.exec(a)||t.exec(a)||a.indexOf("compatible")<0&&u.exec(a)||[];return{browser:b[1]||"",version:b[2]||"0"}},sub:function(){function a(b,c){return new a.fn.init(b,c)}d.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.subclass=this.subclass,a.fn.init=function b(b,c){c&&c instanceof d&&!(c instanceof a)&&(c=a(c));return d.fn.init.call(this,b,c,e)},a.fn.init.prototype=a.fn;var e=a(c);return a},browser:{}}),y=d._Deferred(),d.each("Boolean Number String Function Array Date RegExp Object".split(" "),function(a,b){H["[object "+b+"]"]=b.toLowerCase()}),w=d.uaMatch(v),w.browser&&(d.browser[w.browser]=!0,d.browser.version=w.version),d.browser.webkit&&(d.browser.safari=!0),G&&(d.inArray=function(a,b){return G.call(b,a)}),i.test(" ")&&(j=/^[\s\xA0]+/,k=/[\s\xA0]+$/),g=d(c),c.addEventListener?A=function(){c.removeEventListener("DOMContentLoaded",A,!1),d.ready()}:c.attachEvent&&(A=function(){c.readyState==="complete"&&(c.detachEvent("onreadystatechange",A),d.ready())});return d}();(function(){d.support={};var b=c.createElement("div");b.style.display="none",b.innerHTML="
a";var e=b.getElementsByTagName("*"),f=b.getElementsByTagName("a")[0],g=c.createElement("select"),h=g.appendChild(c.createElement("option")),i=b.getElementsByTagName("input")[0];if(e&&e.length&&f){d.support={leadingWhitespace:b.firstChild.nodeType===3,tbody:!b.getElementsByTagName("tbody").length,htmlSerialize:!!b.getElementsByTagName("link").length,style:/red/.test(f.getAttribute("style")),hrefNormalized:f.getAttribute("href")==="/a",opacity:/^0.55$/.test(f.style.opacity),cssFloat:!!f.style.cssFloat,checkOn:i.value==="on",optSelected:h.selected,deleteExpando:!0,optDisabled:!1,checkClone:!1,noCloneEvent:!0,noCloneChecked:!0,boxModel:null,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableHiddenOffsets:!0},i.checked=!0,d.support.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,d.support.optDisabled=!h.disabled;var j=null;d.support.scriptEval=function(){if(j===null){var b=c.documentElement,e=c.createElement("script"),f="script"+d.now();try{e.appendChild(c.createTextNode("window."+f+"=1;"))}catch(g){}b.insertBefore(e,b.firstChild),a[f]?(j=!0,delete a[f]):j=!1,b.removeChild(e),b=e=f=null}return j};try{delete b.test}catch(k){d.support.deleteExpando=!1}!b.addEventListener&&b.attachEvent&&b.fireEvent&&(b.attachEvent("onclick",function l(){d.support.noCloneEvent=!1,b.detachEvent("onclick",l)}),b.cloneNode(!0).fireEvent("onclick")),b=c.createElement("div"),b.innerHTML="";var m=c.createDocumentFragment();m.appendChild(b.firstChild),d.support.checkClone=m.cloneNode(!0).cloneNode(!0).lastChild.checked,d(function(){var a=c.createElement("div"),b=c.getElementsByTagName("body")[0];if(b){a.style.width=a.style.paddingLeft="1px",b.appendChild(a),d.boxModel=d.support.boxModel=a.offsetWidth===2,"zoom"in a.style&&(a.style.display="inline",a.style.zoom=1,d.support.inlineBlockNeedsLayout=a.offsetWidth===2,a.style.display="",a.innerHTML="
",d.support.shrinkWrapBlocks=a.offsetWidth!==2),a.innerHTML="
t
";var e=a.getElementsByTagName("td");d.support.reliableHiddenOffsets=e[0].offsetHeight===0,e[0].style.display="",e[1].style.display="none",d.support.reliableHiddenOffsets=d.support.reliableHiddenOffsets&&e[0].offsetHeight===0,a.innerHTML="",b.removeChild(a).style.display="none",a=e=null}});var n=function(a){var b=c.createElement("div");a="on"+a;if(!b.attachEvent)return!0;var d=a in b;d||(b.setAttribute(a,"return;"),d=typeof b[a]==="function"),b=null;return d};d.support.submitBubbles=n("submit"),d.support.changeBubbles=n("change"),b=e=f=null}})();var e=/^(?:\{.*\}|\[.*\])$/;d.extend({cache:{},uuid:0,expando:"jQuery"+(d.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){a=a.nodeType?d.cache[a[d.expando]]:a[d.expando];return!!a&&!g(a)},data:function(a,c,e,f){if(d.acceptData(a)){var g=d.expando,h=typeof c==="string",i,j=a.nodeType,k=j?d.cache:a,l=j?a[d.expando]:a[d.expando]&&d.expando;if((!l||f&&l&&!k[l][g])&&h&&e===b)return;l||(j?a[d.expando]=l=++d.uuid:l=d.expando),k[l]||(k[l]={},j||(k[l].toJSON=d.noop));if(typeof c==="object"||typeof c==="function")f?k[l][g]=d.extend(k[l][g],c):k[l]=d.extend(k[l],c);i=k[l],f&&(i[g]||(i[g]={}),i=i[g]),e!==b&&(i[c]=e);if(c==="events"&&!i[c])return i[g]&&i[g].events;return h?i[c]:i}},removeData:function(b,c,e){if(d.acceptData(b)){var f=d.expando,h=b.nodeType,i=h?d.cache:b,j=h?b[d.expando]:d.expando;if(!i[j])return;if(c){var k=e?i[j][f]:i[j];if(k){delete k[c];if(!g(k))return}}if(e){delete i[j][f];if(!g(i[j]))return}var l=i[j][f];d.support.deleteExpando||i!=a?delete i[j]:i[j]=null,l?(i[j]={},h||(i[j].toJSON=d.noop),i[j][f]=l):h&&(d.support.deleteExpando?delete b[d.expando]:b.removeAttribute?b.removeAttribute(d.expando):b[d.expando]=null)}},_data:function(a,b,c){return d.data(a,b,c,!0)},acceptData:function(a){if(a.nodeName){var b=d.noData[a.nodeName.toLowerCase()];if(b)return b!==!0&&a.getAttribute("classid")===b}return!0}}),d.fn.extend({data:function(a,c){var e=null;if(typeof a==="undefined"){if(this.length){e=d.data(this[0]);if(this[0].nodeType===1){var g=this[0].attributes,h;for(var i=0,j=g.length;i-1)return!0;return!1},val:function(a){if(!arguments.length){var c=this[0];if(c){if(d.nodeName(c,"option")){var e=c.attributes.value;return!e||e.specified?c.value:c.text}if(d.nodeName(c,"select")){var f=c.selectedIndex,g=[],h=c.options,i=c.type==="select-one";if(f<0)return null;for(var k=i?f:0,l=i?f+1:h.length;k=0;else if(d.nodeName(this,"select")){var f=d.makeArray(e);d("option",this).each(function(){this.selected=d.inArray(d(this).val(),f)>=0}),f.length||(this.selectedIndex=-1)}else this.value=e}})}}),d.extend({attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attr:function(a,c,e,f){if(!a||a.nodeType===3||a.nodeType===8||a.nodeType===2)return b;if(f&&c in d.attrFn)return d(a)[c](e);var g=a.nodeType!==1||!d.isXMLDoc(a),h=e!==b;c=g&&d.props[c]||c;if(a.nodeType===1){var i=k.test(c);if(c==="selected"&&!d.support.optSelected){var j=a.parentNode;j&&(j.selectedIndex,j.parentNode&&j.parentNode.selectedIndex)}if((c in a||a[c]!==b)&&g&&!i){h&&(c==="type"&&l.test(a.nodeName)&&a.parentNode&&d.error("type property can't be changed"),e===null?a.nodeType===1&&a.removeAttribute(c):a[c]=e);if(d.nodeName(a,"form")&&a.getAttributeNode(c))return a.getAttributeNode(c).nodeValue;if(c==="tabIndex"){var o=a.getAttributeNode("tabIndex");return o&&o.specified?o.value:m.test(a.nodeName)||n.test(a.nodeName)&&a.href?0:b}return a[c]}if(!d.support.style&&g&&c==="style"){h&&(a.style.cssText=""+e);return a.style.cssText}h&&a.setAttribute(c,""+e);if(!a.attributes[c]&&(a.hasAttribute&&!a.hasAttribute(c)))return b;var p=!d.support.hrefNormalized&&g&&i?a.getAttribute(c,2):a.getAttribute(c);return p===null?b:p}h&&(a[c]=e);return a[c]}});var p=/\.(.*)$/,q=/^(?:textarea|input|select)$/i,r=/\./g,s=/ /g,t=/[^\w\s.|`]/g,u=function(a){return a.replace(t,"\\$&")};d.event={add:function(c,e,f,g){if(c.nodeType!==3&&c.nodeType!==8){try{d.isWindow(c)&&(c!==a&&!c.frameElement)&&(c=a)}catch(h){}if(f===!1)f=v;else if(!f)return;var i,j;f.handler&&(i=f,f=i.handler),f.guid||(f.guid=d.guid++);var k=d._data(c);if(!k)return;var l=k.events,m=k.handle;l||(k.events=l={}),m||(k.handle=m=function(){return typeof d!=="undefined"&&!d.event.triggered?d.event.handle.apply(m.elem,arguments):b}),m.elem=c,e=e.split(" ");var n,o=0,p;while(n=e[o++]){j=i?d.extend({},i):{handler:f,data:g},n.indexOf(".")>-1?(p=n.split("."),n=p.shift(),j.namespace=p.slice(0).sort().join(".")):(p=[],j.namespace=""),j.type=n,j.guid||(j.guid=f.guid);var q=l[n],r=d.event.special[n]||{};if(!q){q=l[n]=[];if(!r.setup||r.setup.call(c,g,p,m)===!1)c.addEventListener?c.addEventListener(n,m,!1):c.attachEvent&&c.attachEvent("on"+n,m)}r.add&&(r.add.call(c,j),j.handler.guid||(j.handler.guid=f.guid)),q.push(j),d.event.global[n]=!0}c=null}},global:{},remove:function(a,c,e,f){if(a.nodeType!==3&&a.nodeType!==8){e===!1&&(e=v);var g,h,i,j,k=0,l,m,n,o,p,q,r,s=d.hasData(a)&&d._data(a),t=s&&s.events;if(!s||!t)return;c&&c.type&&(e=c.handler,c=c.type);if(!c||typeof c==="string"&&c.charAt(0)==="."){c=c||"";for(h in t)d.event.remove(a,h+c);return}c=c.split(" ");while(h=c[k++]){r=h,q=null,l=h.indexOf(".")<0,m=[],l||(m=h.split("."),h=m.shift(),n=new RegExp("(^|\\.)"+d.map(m.slice(0).sort(),u).join("\\.(?:.*\\.)?")+"(\\.|$)")),p=t[h];if(!p)continue;if(!e){for(j=0;j=0&&(a.type=f=f.slice(0,-1),a.exclusive=!0),e||(a.stopPropagation(),d.event.global[f]&&d.each(d.cache,function(){var b=d.expando,e=this[b];e&&e.events&&e.events[f]&&d.event.trigger(a,c,e.handle.elem)}));if(!e||e.nodeType===3||e.nodeType===8)return b;a.result=b,a.target=e,c=d.makeArray(c),c.unshift(a)}a.currentTarget=e;var h=d._data(e,"handle");h&&h.apply(e,c);var i=e.parentNode||e.ownerDocument;try{e&&e.nodeName&&d.noData[e.nodeName.toLowerCase()]||e["on"+f]&&e["on"+f].apply(e,c)===!1&&(a.result=!1,a.preventDefault())}catch(j){}if(!a.isPropagationStopped()&&i)d.event.trigger(a,c,i,!0);else if(!a.isDefaultPrevented()){var k,l=a.target,m=f.replace(p,""),n=d.nodeName(l,"a")&&m==="click",o=d.event.special[m]||{};if((!o._default||o._default.call(e,a)===!1)&&!n&&!(l&&l.nodeName&&d.noData[l.nodeName.toLowerCase()])){try{l[m]&&(k=l["on"+m],k&&(l["on"+m]=null),d.event.triggered=!0,l[m]())}catch(q){}k&&(l["on"+m]=k),d.event.triggered=!1}}},handle:function(c){var e,f,g,h,i,j=[],k=d.makeArray(arguments);c=k[0]=d.event.fix(c||a.event),c.currentTarget=this,e=c.type.indexOf(".")<0&&!c.exclusive,e||(g=c.type.split("."),c.type=g.shift(),j=g.slice(0).sort(),h=new RegExp("(^|\\.)"+j.join("\\.(?:.*\\.)?")+"(\\.|$)")),c.namespace=c.namespace||j.join("."),i=d._data(this,"events"),f=(i||{})[c.type];if(i&&f){f=f.slice(0);for(var l=0,m=f.length;l-1?d.map(a.options,function(a){return a.selected}).join("-"):"":a.nodeName.toLowerCase()==="select"&&(c=a.selectedIndex);return c},B=function B(a){var c=a.target,e,f;if(q.test(c.nodeName)&&!c.readOnly){e=d._data(c,"_change_data"),f=A(c),(a.type!=="focusout"||c.type!=="radio")&&d._data(c,"_change_data",f);if(e===b||f===e)return;if(e!=null||f)a.type="change",a.liveFired=b,d.event.trigger(a,arguments[1],c)}};d.event.special.change={filters:{focusout:B,beforedeactivate:B,click:function(a){var b=a.target,c=b.type;(c==="radio"||c==="checkbox"||b.nodeName.toLowerCase()==="select")&&B.call(this,a)},keydown:function(a){var b=a.target,c=b.type;(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(c==="checkbox"||c==="radio")||c==="select-multiple")&&B.call(this,a)},beforeactivate:function(a){var b=a.target;d._data(b,"_change_data",A(b))}},setup:function(a,b){if(this.type==="file")return!1;for(var c in z)d.event.add(this,c+".specialChange",z[c]);return q.test(this.nodeName)},teardown:function(a){d.event.remove(this,".specialChange");return q.test(this.nodeName)}},z=d.event.special.change.filters,z.focus=z.beforeactivate}c.addEventListener&&d.each({focus:"focusin",blur:"focusout"},function(a,b){function c(a){a=d.event.fix(a),a.type=b;return d.event.handle.call(this,a)}d.event.special[b]={setup:function(){this.addEventListener(a,c,!0)},teardown:function(){this.removeEventListener(a,c,!0)}}}),d.each(["bind","one"],function(a,c){d.fn[c]=function(a,e,f){if(typeof a==="object"){for(var g in a)this[c](g,e,a[g],f);return this}if(d.isFunction(e)||e===!1)f=e,e=b;var h=c==="one"?d.proxy(f,function(a){d(this).unbind(a,h);return f.apply(this,arguments)}):f;if(a==="unload"&&c!=="one")this.one(a,e,f);else for(var i=0,j=this.length;i0?this.bind(b,a,c):this.trigger(b)},d.attrFn&&(d.attrFn[b]=!0)}),function(){function u(a,b,c,d,e,f){for(var g=0,h=d.length;g0){j=i;break}}i=i[a]}d[g]=j}}}function t(a,b,c,d,e,f){for(var g=0,h=d.length;g+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,e=0,f=Object.prototype.toString,g=!1,h=!0,i=/\\/g,j=/\W/;[0,0].sort(function(){h=!1;return 0});var k=function(b,d,e,g){e=e||[],d=d||c;var h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof b!=="string")return e;var i,j,n,o,q,r,s,t,u=!0,w=k.isXML(d),x=[],y=b;do{a.exec(""),i=a.exec(y);if(i){y=i[3],x.push(i[1]);if(i[2]){o=i[3];break}}}while(i);if(x.length>1&&m.exec(b))if(x.length===2&&l.relative[x[0]])j=v(x[0]+x[1],d);else{j=l.relative[x[0]]?[d]:k(x.shift(),d);while(x.length)b=x.shift(),l.relative[b]&&(b+=x.shift()),j=v(b,j)}else{!g&&x.length>1&&d.nodeType===9&&!w&&l.match.ID.test(x[0])&&!l.match.ID.test(x[x.length-1])&&(q=k.find(x.shift(),d,w),d=q.expr?k.filter(q.expr,q.set)[0]:q.set[0]);if(d){q=g?{expr:x.pop(),set:p(g)}:k.find(x.pop(),x.length===1&&(x[0]==="~"||x[0]==="+")&&d.parentNode?d.parentNode:d,w),j=q.expr?k.filter(q.expr,q.set):q.set,x.length>0?n=p(j):u=!1;while(x.length)r=x.pop(),s=r,l.relative[r]?s=x.pop():r="",s==null&&(s=d),l.relative[r](n,s,w)}else n=x=[]}n||(n=j),n||k.error(r||b);if(f.call(n)==="[object Array]")if(u)if(d&&d.nodeType===1)for(t=0;n[t]!=null;t++)n[t]&&(n[t]===!0||n[t].nodeType===1&&k.contains(d,n[t]))&&e.push(j[t]);else for(t=0;n[t]!=null;t++)n[t]&&n[t].nodeType===1&&e.push(j[t]);else e.push.apply(e,n);else p(n,e);o&&(k(o,h,e,g),k.uniqueSort(e));return e};k.uniqueSort=function(a){if(r){g=h,a.sort(r);if(g)for(var b=1;b0},k.find=function(a,b,c){var d;if(!a)return[];for(var e=0,f=l.order.length;e":function(a,b){var c,d=typeof b==="string",e=0,f=a.length;if(d&&!j.test(b)){b=b.toLowerCase();for(;e=0)?c||d.push(h):c&&(b[g]=!1));return!1},ID:function(a){return a[1].replace(i,"")},TAG:function(a,b){return a[1].replace(i,"").toLowerCase()},CHILD:function(a){if(a[1]==="nth"){a[2]||k.error(a[0]),a[2]=a[2].replace(/^\+|\s*/g,"");var b=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(a[2]==="even"&&"2n"||a[2]==="odd"&&"2n+1"||!/\D/.test(a[2])&&"0n+"+a[2]||a[2]);a[2]=b[1]+(b[2]||1)-0,a[3]=b[3]-0}else a[2]&&k.error(a[0]);a[0]=e++;return a},ATTR:function(a,b,c,d,e,f){var g=a[1]=a[1].replace(i,"");!f&&l.attrMap[g]&&(a[1]=l.attrMap[g]),a[4]=(a[4]||a[5]||"").replace(i,""),a[2]==="~="&&(a[4]=" "+a[4]+" ");return a},PSEUDO:function(b,c,d,e,f){if(b[1]==="not")if((a.exec(b[3])||"").length>1||/^\w/.test(b[3]))b[3]=k(b[3],null,null,c);else{var g=k.filter(b[3],c,d,!0^f);d||e.push.apply(e,g);return!1}else if(l.match.POS.test(b[0])||l.match.CHILD.test(b[0]))return!0;return b},POS:function(a){a.unshift(!0);return a}},filters:{enabled:function(a){return a.disabled===!1&&a.type!=="hidden"},disabled:function(a){return a.disabled===!0},checked:function(a){return a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!k(c[3],a).length},header:function(a){return/h\d/i.test(a.nodeName)},text:function(a){return"text"===a.getAttribute("type")},radio:function(a){return"radio"===a.type},checkbox:function(a){return"checkbox"===a.type},file:function(a){return"file"===a.type},password:function(a){return"password"===a.type},submit:function(a){return"submit"===a.type},image:function(a){return"image"===a.type},reset:function(a){return"reset"===a.type},button:function(a){return"button"===a.type||a.nodeName.toLowerCase()==="button"},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)}},setFilters:{first:function(a,b){return b===0},last:function(a,b,c,d){return b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return b%2===1},lt:function(a,b,c){return bc[3]-0},nth:function(a,b,c){return c[3]-0===b},eq:function(a,b,c){return c[3]-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b[1],f=l.filters[e];if(f)return f(a,c,b,d);if(e==="contains")return(a.textContent||a.innerText||k.getText([a])||"").indexOf(b[3])>=0;if(e==="not"){var g=b[3];for(var h=0,i=g.length;h=0}},ID:function(a,b){return a.nodeType===1&&a.getAttribute("id")===b},TAG:function(a,b){return b==="*"&&a.nodeType===1||a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(" "+(a.className||a.getAttribute("class"))+" ").indexOf(b)>-1},ATTR:function(a,b){var c=b[1],d=l.attrHandle[c]?l.attrHandle[c](a):a[c]!=null?a[c]:a.getAttribute(c),e=d+"",f=b[2],g=b[4];return d==null?f==="!=":f==="="?e===g:f==="*="?e.indexOf(g)>=0:f==="~="?(" "+e+" ").indexOf(g)>=0:g?f==="!="?e!==g:f==="^="?e.indexOf(g)===0:f==="$="?e.substr(e.length-g.length)===g:f==="|="?e===g||e.substr(0,g.length+1)===g+"-":!1:e&&d!==!1},POS:function(a,b,c,d){var e=b[2],f=l.setFilters[e];if(f)return f(a,c,b,d)}}},m=l.match.POS,n=function(a,b){return"\\"+(b-0+1)};for(var o in l.match)l.match[o]=new RegExp(l.match[o].source+/(?![^\[]*\])(?![^\(]*\))/.source),l.leftMatch[o]=new RegExp(/(^(?:.|\r|\n)*?)/.source+l.match[o].source.replace(/\\(\d+)/g,n));var p=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0)[0].nodeType}catch(q){p=function(a,b){var c=0,d=b||[];if(f.call(a)==="[object Array]")Array.prototype.push.apply(d,a);else if(typeof a.length==="number")for(var e=a.length;c",e.insertBefore(a,e.firstChild),c.getElementById(d)&&(l.find.ID=function(a,c,d){if(typeof c.getElementById!=="undefined"&&!d){var e=c.getElementById(a[1]);return e?e.id===a[1]||typeof e.getAttributeNode!=="undefined"&&e.getAttributeNode("id").nodeValue===a[1]?[e]:b:[]}},l.filter.ID=function(a,b){var c=typeof a.getAttributeNode!=="undefined"&&a.getAttributeNode("id");return a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var a=c.createElement("div");a.appendChild(c.createComment("")),a.getElementsByTagName("*").length>0&&(l.find.TAG=function(a,b){var c=b.getElementsByTagName(a[1]);if(a[1]==="*"){var d=[];for(var e=0;c[e];e++)c[e].nodeType===1&&d.push(c[e]);c=d}return c}),a.innerHTML="",a.firstChild&&typeof a.firstChild.getAttribute!=="undefined"&&a.firstChild.getAttribute("href")!=="#"&&(l.attrHandle.href=function(a){return a.getAttribute("href",2)}),a=null}(),c.querySelectorAll&&function(){var a=k,b=c.createElement("div"),d="__sizzle__";b.innerHTML="

";if(!b.querySelectorAll||b.querySelectorAll(".TEST").length!==0){k=function(b,e,f,g){e=e||c;if(!g&&!k.isXML(e)){var h=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h[1])return p(e.getElementsByTagName(b),f);if(h[2]&&l.find.CLASS&&e.getElementsByClassName)return p(e.getElementsByClassName(h[2]),f)}if(e.nodeType===9){if(b==="body"&&e.body)return p([e.body],f);if(h&&h[3]){var i=e.getElementById(h[3]);if(!i||!i.parentNode)return p([],f);if(i.id===h[3])return p([i],f)}try{return p(e.querySelectorAll(b),f)}catch(j){}}else if(e.nodeType===1&&e.nodeName.toLowerCase()!=="object"){var m=e,n=e.getAttribute("id"),o=n||d,q=e.parentNode,r=/^\s*[+~]/.test(b);n?o=o.replace(/'/g,"\\$&"):e.setAttribute("id",o),r&&q&&(e=e.parentNode);try{if(!r||q)return p(e.querySelectorAll("[id='"+o+"'] "+b),f)}catch(s){}finally{n||m.removeAttribute("id")}}}return a(b,e,f,g)};for(var e in a)k[e]=a[e];b=null}}(),function(){var a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector,d=!1;try{b.call(c.documentElement,"[test!='']:sizzle")}catch(e){d=!0}b&&(k.matchesSelector=function(a,c){c=c.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!k.isXML(a))try{if(d||!l.match.PSEUDO.test(c)&&!/!=/.test(c))return b.call(a,c)}catch(e){}return k(c,null,null,[a]).length>0})}(),function(){var a=c.createElement("div");a.innerHTML="
";if(a.getElementsByClassName&&a.getElementsByClassName("e").length!==0){a.lastChild.className="e";if(a.getElementsByClassName("e").length===1)return;l.order.splice(1,0,"CLASS"),l.find.CLASS=function(a,b,c){if(typeof b.getElementsByClassName!=="undefined"&&!c)return b.getElementsByClassName(a[1])},a=null}}(),c.documentElement.contains?k.contains=function(a,b){return a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?k.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:k.contains=function(){return!1},k.isXML=function(a){var b=(a?a.ownerDocument||a:0).documentElement;return b?b.nodeName!=="HTML":!1};var v=function(a,b){var c,d=[],e="",f=b.nodeType?[b]:b;while(c=l.match.PSEUDO.exec(a))e+=c[0],a=a.replace(l.match.PSEUDO,"");a=l.relative[a]?a+"*":a;for(var g=0,h=f.length;g0)for(var g=c;g0},closest:function(a,b){var c=[],e,f,g=this[0];if(d.isArray(a)){var h,i,j={},k=1;if(g&&a.length){for(e=0,f=a.length;e-1:d(g).is(h))&&c.push({selector:i,elem:g,level:k});g=g.parentNode,k++}}return c}var l=L.test(a)?d(a,b||this.context):null;for(e=0,f=this.length;e-1:d.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b)break}}c=c.length>1?d.unique(c):c;return this.pushStack(c,"closest",a)},index:function(a){if(!a||typeof a==="string")return d.inArray(this[0],a?d(a):this.parent().children());return d.inArray(a.jquery?a[0]:a,this)},add:function(a,b){var c=typeof a==="string"?d(a,b):d.makeArray(a),e=d.merge(this.get(),c);return this.pushStack(N(c[0])||N(e[0])?e:d.unique(e))},andSelf:function(){return this.add(this.prevObject)}}),d.each({parent:function(a){var b=a.parentNode;return b&&b.nodeType!==11?b:null},parents:function(a){return d.dir(a,"parentNode")},parentsUntil:function(a,b,c){return d.dir(a,"parentNode",c)},next:function(a){return d.nth(a,2,"nextSibling")},prev:function(a){return d.nth(a,2,"previousSibling")},nextAll:function(a){return d.dir(a,"nextSibling")},prevAll:function(a){return d.dir(a,"previousSibling")},nextUntil:function(a,b,c){return d.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return d.dir(a,"previousSibling",c)},siblings:function(a){return d.sibling(a.parentNode.firstChild,a)},children:function(a){return d.sibling(a.firstChild)},contents:function(a){return d.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:d.makeArray(a.childNodes)}},function(a,b){d.fn[a]=function(c,e){var f=d.map(this,b,c),g=K.call(arguments);G.test(a)||(e=c),e&&typeof e==="string"&&(f=d.filter(e,f)),f=this.length>1&&!M[a]?d.unique(f):f,(this.length>1||I.test(e))&&H.test(a)&&(f=f.reverse());return this.pushStack(f,a,g.join(","))}}),d.extend({filter:function(a,b,c){c&&(a=":not("+a+")");return b.length===1?d.find.matchesSelector(b[0],a)?[b[0]]:[]:d.find.matches(a,b)},dir:function(a,c,e){var f=[],g=a[c];while(g&&g.nodeType!==9&&(e===b||g.nodeType!==1||!d(g).is(e)))g.nodeType===1&&f.push(g),g=g[c];return f},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a[c])if(a.nodeType===1&&++e===b)break;return a},sibling:function(a,b){var c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return c}});var P=/ jQuery\d+="(?:\d+|null)"/g,Q=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,S=/<([\w:]+)/,T=/",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};X.optgroup=X.option,X.tbody=X.tfoot=X.colgroup=X.caption=X.thead,X.th=X.td,d.support.htmlSerialize||(X._default=[1,"div
","
"]),d.fn.extend({text:function(a){if(d.isFunction(a))return this.each(function(b){var c=d(this);c.text(a.call(this,b,c.text()))});if(typeof a!=="object"&&a!==b)return this.empty().append((this[0]&&this[0].ownerDocument||c).createTextNode(a));return d.text(this)},wrapAll:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapAll(a.call(this,b))});if(this[0]){var b=d(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapInner(a.call(this,b))});return this.each(function(){var b=d(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){d(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){d.nodeName(this,"body")||d(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=d(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,d(arguments[0]).toArray());return a}},remove:function(a,b){for(var c=0,e;(e=this[c])!=null;c++)if(!a||d.filter(a,[e]).length)!b&&e.nodeType===1&&(d.cleanData(e.getElementsByTagName("*")),d.cleanData([e])),e.parentNode&&e.parentNode.removeChild(e);return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++){b.nodeType===1&&d.cleanData(b.getElementsByTagName("*"));while(b.firstChild)b.removeChild(b.firstChild)}return this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return this.map(function(){return d.clone(this,a,b)})},html:function(a){if(a===b)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(P,""):null;if(typeof a!=="string"||V.test(a)||!d.support.leadingWhitespace&&Q.test(a)||X[(S.exec(a)||["",""])[1].toLowerCase()])d.isFunction(a)?this.each(function(b){var c=d(this);c.html(a.call(this,b,c.html()))}):this.empty().append(a);else{a=a.replace(R,"<$1>");try{for(var c=0,e=this.length;c1&&l0?this.clone(!0):this).get();d(f[h])[b](j),e=e.concat(j)}return this.pushStack(e,a,f.selector)}}),d.extend({clone:function(a,b,c){var e=a.cloneNode(!0),f,g,h;if((!d.support.noCloneEvent||!d.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!d.isXMLDoc(a)){$(a,e),f=_(a),g=_(e);for(h=0;f[h];++h)$(f[h],g[h])}if(b){Z(a,e);if(c){f=_(a),g=_(e);for(h=0;f[h];++h)Z(f[h],g[h])}}return e},clean:function(a,b,e,f){b=b||c,typeof b.createElement==="undefined"&&(b=b.ownerDocument||b[0]&&b[0].ownerDocument||c);var g=[];for(var h=0,i;(i=a[h])!=null;h++){typeof i==="number"&&(i+="");if(!i)continue;if(typeof i!=="string"||U.test(i)){if(typeof i==="string"){i=i.replace(R,"<$1>");var j=(S.exec(i)||["",""])[1].toLowerCase(),k=X[j]||X._default,l=k[0],m=b.createElement("div");m.innerHTML=k[1]+i+k[2];while(l--)m=m.lastChild;if(!d.support.tbody){var n=T.test(i),o=j==="table"&&!n?m.firstChild&&m.firstChild.childNodes:k[1]===""&&!n?m.childNodes:[];for(var p=o.length-1;p>=0;--p)d.nodeName(o[p],"tbody")&&!o[p].childNodes.length&&o[p].parentNode.removeChild(o[p])}!d.support.leadingWhitespace&&Q.test(i)&&m.insertBefore(b.createTextNode(Q.exec(i)[0]),m.firstChild),i=m.childNodes}}else i=b.createTextNode(i);i.nodeType?g.push(i):g=d.merge(g,i)}if(e)for(h=0;g[h];h++)!f||!d.nodeName(g[h],"script")||g[h].type&&g[h].type.toLowerCase()!=="text/javascript"?(g[h].nodeType===1&&g.splice.apply(g,[h+1,0].concat(d.makeArray(g[h].getElementsByTagName("script")))),e.appendChild(g[h])):f.push(g[h].parentNode?g[h].parentNode.removeChild(g[h]):g[h]);return g},cleanData:function(a){var b,c,e=d.cache,f=d.expando,g=d.event.special,h=d.support.deleteExpando;for(var i=0,j;(j=a[i])!=null;i++){if(j.nodeName&&d.noData[j.nodeName.toLowerCase()])continue;c=j[d.expando];if(c){b=e[c]&&e[c][f];if(b&&b.events){for(var k in b.events)g[k]?d.event.remove(j,k):d.removeEvent(j,k,b.handle);b.handle&&(b.handle.elem=null)}h?delete j[d.expando]:j.removeAttribute&&j.removeAttribute(d.expando),delete e[c]}}}});var bb=/alpha\([^)]*\)/i,bc=/opacity=([^)]*)/,bd=/-([a-z])/ig,be=/([A-Z])/g,bf=/^-?\d+(?:px)?$/i,bg=/^-?\d/,bh={position:"absolute",visibility:"hidden",display:"block"},bi=["Left","Right"],bj=["Top","Bottom"],bk,bl,bm,bn=function(a,b){return b.toUpperCase()};d.fn.css=function(a,c){if(arguments.length===2&&c===b)return this;return d.access(this,a,c,!0,function(a,c,e){return e!==b?d.style(a,c,e):d.css(a,c)})},d.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=bk(a,"opacity","opacity");return c===""?"1":c}return a.style.opacity}}},cssNumber:{zIndex:!0,fontWeight:!0,opacity:!0,zoom:!0,lineHeight:!0},cssProps:{"float":d.support.cssFloat?"cssFloat":"styleFloat"},style:function(a,c,e,f){if(a&&a.nodeType!==3&&a.nodeType!==8&&a.style){var g,h=d.camelCase(c),i=a.style,j=d.cssHooks[h];c=d.cssProps[h]||h;if(e===b){if(j&&"get"in j&&(g=j.get(a,!1,f))!==b)return g;return i[c]}if(typeof e==="number"&&isNaN(e)||e==null)return;typeof e==="number"&&!d.cssNumber[h]&&(e+="px");if(!j||!("set"in j)||(e=j.set(a,e))!==b)try{i[c]=e}catch(k){}}},css:function(a,c,e){var f,g=d.camelCase(c),h=d.cssHooks[g];c=d.cssProps[g]||g;if(h&&"get"in h&&(f=h.get(a,!0,e))!==b)return f;if(bk)return bk(a,c,g)},swap:function(a,b,c){var d={};for(var e in b)d[e]=a.style[e],a.style[e]=b[e];c.call(a);for(e in b)a.style[e]=d[e]},camelCase:function(a){return a.replace(bd,bn)}}),d.curCSS=d.css,d.each(["height","width"],function(a,b){d.cssHooks[b]={get:function(a,c,e){var f;if(c){a.offsetWidth!==0?f=bo(a,b,e):d.swap(a,bh,function(){f=bo(a,b,e)});if(f<=0){f=bk(a,b,b),f==="0px"&&bm&&(f=bm(a,b,b));if(f!=null)return f===""||f==="auto"?"0px":f}if(f<0||f==null){f=a.style[b];return f===""||f==="auto"?"0px":f}return typeof f==="string"?f:f+"px"}},set:function(a,b){if(!bf.test(b))return b;b=parseFloat(b);if(b>=0)return b+"px"}}}),d.support.opacity||(d.cssHooks.opacity={get:function(a,b){return bc.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?parseFloat(RegExp.$1)/100+"":b?"1":""},set:function(a,b){var c=a.style;c.zoom=1;var e=d.isNaN(b)?"":"alpha(opacity="+b*100+")",f=c.filter||"";c.filter=bb.test(f)?f.replace(bb,e):c.filter+" "+e}}),c.defaultView&&c.defaultView.getComputedStyle&&(bl=function(a,c,e){var f,g,h;e=e.replace(be,"-$1").toLowerCase();if(!(g=a.ownerDocument.defaultView))return b;if(h=g.getComputedStyle(a,null))f=h.getPropertyValue(e),f===""&&!d.contains(a.ownerDocument.documentElement,a)&&(f=d.style(a,e));return f}),c.documentElement.currentStyle&&(bm=function(a,b){var c,d=a.currentStyle&&a.currentStyle[b],e=a.runtimeStyle&&a.runtimeStyle[b],f=a.style;!bf.test(d)&&bg.test(d)&&(c=f.left,e&&(a.runtimeStyle.left=a.currentStyle.left),f.left=b==="fontSize"?"1em":d||0,d=f.pixelLeft+"px",f.left=c,e&&(a.runtimeStyle.left=e));return d===""?"auto":d}),bk=bl||bm,d.expr&&d.expr.filters&&(d.expr.filters.hidden=function(a){var b=a.offsetWidth,c=a.offsetHeight;return b===0&&c===0||!d.support.reliableHiddenOffsets&&(a.style.display||d.css(a,"display"))==="none"},d.expr.filters.visible=function(a){return!d.expr.filters.hidden(a)});var bp=/%20/g,bq=/\[\]$/,br=/\r?\n/g,bs=/#.*$/,bt=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,bu=/^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bv=/(?:^file|^widget|\-extension):$/,bw=/^(?:GET|HEAD)$/,bx=/^\/\//,by=/\?/,bz=/)<[^<]*)*<\/script>/gi,bA=/^(?:select|textarea)/i,bB=/\s+/,bC=/([?&])_=[^&]*/,bD=/(^|\-)([a-z])/g,bE=function(a,b,c){return b+c.toUpperCase()},bF=/^([\w\+\.\-]+:)\/\/([^\/?#:]*)(?::(\d+))?/,bG=d.fn.load,bH={},bI={},bJ,bK;try{bJ=c.location.href}catch(bL){bJ=c.createElement("a"),bJ.href="",bJ=bJ.href}bK=bF.exec(bJ.toLowerCase()),d.fn.extend({load:function(a,c,e){if(typeof a!=="string"&&bG)return bG.apply(this,arguments);if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var g=a.slice(f,a.length);a=a.slice(0,f)}var h="GET";c&&(d.isFunction(c)?(e=c,c=b):typeof c==="object"&&(c=d.param(c,d.ajaxSettings.traditional),h="POST"));var i=this;d.ajax({url:a,type:h,dataType:"html",data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?d("
").append(c.replace(bz,"")).find(g):c)),e&&i.each(e,[c,b,a])}});return this},serialize:function(){return d.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?d.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||bA.test(this.nodeName)||bu.test(this.type))}).map(function(a,b){var c=d(this).val();return c==null?null:d.isArray(c)?d.map(c,function(a,c){return{name:b.name,value:a.replace(br,"\r\n")}}):{name:b.name,value:c.replace(br,"\r\n")}}).get()}}),d.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){d.fn[b]=function(a){return this.bind(b,a)}}),d.each(["get","post"],function(a,c){d[c]=function(a,e,f,g){d.isFunction(e)&&(g=g||f,f=e,e=b);return d.ajax({type:c,url:a,data:e,success:f,dataType:g})}}),d.extend({getScript:function(a,c){return d.get(a,b,c,"script")},getJSON:function(a,b,c){return d.get(a,b,c,"json")},ajaxSetup:function(a,b){b?d.extend(!0,a,d.ajaxSettings,b):(b=a,a=d.extend(!0,d.ajaxSettings,b));for(var c in {context:1,url:1})c in b?a[c]=b[c]:c in d.ajaxSettings&&(a[c]=d.ajaxSettings[c]);return a},ajaxSettings:{url:bJ,isLocal:bv.test(bK[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":"*/*"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":d.parseJSON,"text xml":d.parseXML}},ajaxPrefilter:bM(bH),ajaxTransport:bM(bI),ajax:function(a,c){function v(a,c,l,n){if(r!==2){r=2,p&&clearTimeout(p),o=b,m=n||"",u.readyState=a?4:0;var q,t,v,w=l?bP(e,u,l):b,x,y;if(a>=200&&a<300||a===304){if(e.ifModified){if(x=u.getResponseHeader("Last-Modified"))d.lastModified[k]=x;if(y=u.getResponseHeader("Etag"))d.etag[k]=y}if(a===304)c="notmodified",q=!0;else try{t=bQ(e,w),c="success",q=!0}catch(z){c="parsererror",v=z}}else{v=c;if(!c||a)c="error",a<0&&(a=0)}u.status=a,u.statusText=c,q?h.resolveWith(f,[t,c,u]):h.rejectWith(f,[u,c,v]),u.statusCode(j),j=b,s&&g.trigger("ajax"+(q?"Success":"Error"),[u,e,q?t:v]),i.resolveWith(f,[u,c]),s&&(g.trigger("ajaxComplete",[u,e]),--d.active||d.event.trigger("ajaxStop"))}}typeof a==="object"&&(c=a,a=b),c=c||{};var e=d.ajaxSetup({},c),f=e.context||e,g=f!==e&&(f.nodeType||f instanceof d)?d(f):d.event,h=d.Deferred(),i=d._Deferred(),j=e.statusCode||{},k,l={},m,n,o,p,q,r=0,s,t,u={readyState:0,setRequestHeader:function(a,b){r||(l[a.toLowerCase().replace(bD,bE)]=b);return this},getAllResponseHeaders:function(){return r===2?m:null},getResponseHeader:function(a){var c;if(r===2){if(!n){n={};while(c=bt.exec(m))n[c[1].toLowerCase()]=c[2]}c=n[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){r||(e.mimeType=a);return this},abort:function(a){a=a||"abort",o&&o.abort(a),v(0,a);return this}};h.promise(u),u.success=u.done,u.error=u.fail,u.complete=i.done,u.statusCode=function(a){if(a){var b;if(r<2)for(b in a)j[b]=[j[b],a[b]];else b=a[u.status],u.then(b,b)}return this},e.url=((a||e.url)+"").replace(bs,"").replace(bx,bK[1]+"//"),e.dataTypes=d.trim(e.dataType||"*").toLowerCase().split(bB),e.crossDomain||(q=bF.exec(e.url.toLowerCase()),e.crossDomain=q&&(q[1]!=bK[1]||q[2]!=bK[2]||(q[3]||(q[1]==="http:"?80:443))!=(bK[3]||(bK[1]==="http:"?80:443)))),e.data&&e.processData&&typeof e.data!=="string"&&(e.data=d.param(e.data,e.traditional)),bN(bH,e,c,u);if(r===2)return!1;s=e.global,e.type=e.type.toUpperCase(),e.hasContent=!bw.test(e.type),s&&d.active++===0&&d.event.trigger("ajaxStart");if(!e.hasContent){e.data&&(e.url+=(by.test(e.url)?"&":"?")+e.data),k=e.url;if(e.cache===!1){var w=d.now(),x=e.url.replace(bC,"$1_="+w);e.url=x+(x===e.url?(by.test(e.url)?"&":"?")+"_="+w:"")}}if(e.data&&e.hasContent&&e.contentType!==!1||c.contentType)l["Content-Type"]=e.contentType;e.ifModified&&(k=k||e.url,d.lastModified[k]&&(l["If-Modified-Since"]=d.lastModified[k]),d.etag[k]&&(l["If-None-Match"]=d.etag[k])),l.Accept=e.dataTypes[0]&&e.accepts[e.dataTypes[0]]?e.accepts[e.dataTypes[0]]+(e.dataTypes[0]!=="*"?", */*; q=0.01":""):e.accepts["*"];for(t in e.headers)u.setRequestHeader(t,e.headers[t]);if(e.beforeSend&&(e.beforeSend.call(f,u,e)===!1||r===2)){u.abort();return!1}for(t in {success:1,error:1,complete:1})u[t](e[t]);o=bN(bI,e,c,u);if(o){u.readyState=1,s&&g.trigger("ajaxSend",[u,e]),e.async&&e.timeout>0&&(p=setTimeout(function(){u.abort("timeout")},e.timeout));try{r=1,o.send(l,v)}catch(y){status<2?v(-1,y):d.error(y)}}else v(-1,"No Transport");return u},param:function(a,c){var e=[],f=function(a,b){b=d.isFunction(b)?b():b,e[e.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=d.ajaxSettings.traditional);if(d.isArray(a)||a.jquery&&!d.isPlainObject(a))d.each(a,function(){f(this.name,this.value)});else for(var g in a)bO(g,a[g],c,f);return e.join("&").replace(bp,"+")}}),d.extend({active:0,lastModified:{},etag:{}});var bR=d.now(),bS=/(\=)\?(&|$)|()\?\?()/i;d.ajaxSetup({jsonp:"callback",jsonpCallback:function(){return d.expando+"_"+bR++}}),d.ajaxPrefilter("json jsonp",function(b,c,e){var f=typeof b.data==="string";if(b.dataTypes[0]==="jsonp"||c.jsonpCallback||c.jsonp!=null||b.jsonp!==!1&&(bS.test(b.url)||f&&bS.test(b.data))){var g,h=b.jsonpCallback=d.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a[h],j=b.url,k=b.data,l="$1"+h+"$2",m=function(){a[h]=i,g&&d.isFunction(i)&&a[h](g[0])};b.jsonp!==!1&&(j=j.replace(bS,l),b.url===j&&(f&&(k=k.replace(bS,l)),b.data===k&&(j+=(/\?/.test(j)?"&":"?")+b.jsonp+"="+h))),b.url=j,b.data=k,a[h]=function(a){g=[a]},e.then(m,m),b.converters["script json"]=function(){g||d.error(h+" was not called");return g[0]},b.dataTypes[0]="json";return"script"}}),d.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){d.globalEval(a);return a}}}),d.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),d.ajaxTransport("script",function(a){if(a.crossDomain){var d,e=c.head||c.getElementsByTagName("head")[0]||c.documentElement;return{send:function(f,g){d=c.createElement("script"),d.async="async",a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,"success")},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var bT=d.now(),bU,bV;d.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&bX()||bY()}:bX,bV=d.ajaxSettings.xhr(),d.support.ajax=!!bV,d.support.cors=bV&&"withCredentials"in bV,bV=b,d.support.ajax&&d.ajaxTransport(function(a){if(!a.crossDomain||d.support.cors){var c;return{send:function(e,f){var g=a.xhr(),h,i;a.username?g.open(a.type,a.url,a.async,a.username,a.password):g.open(a.type,a.url,a.async);if(a.xhrFields)for(i in a.xhrFields)g[i]=a.xhrFields[i];a.mimeType&&g.overrideMimeType&&g.overrideMimeType(a.mimeType),(!a.crossDomain||a.hasContent)&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(i in e)g.setRequestHeader(i,e[i])}catch(j){}g.send(a.hasContent&&a.data||null),c=function(e,i){var j,k,l,m,n;try{if(c&&(i||g.readyState===4)){c=b,h&&(g.onreadystatechange=d.noop,delete bU[h]);if(i)g.readyState!==4&&g.abort();else{j=g.status,l=g.getAllResponseHeaders(),m={},n=g.responseXML,n&&n.documentElement&&(m.xml=n),m.text=g.responseText;try{k=g.statusText}catch(o){k=""}j||!a.isLocal||a.crossDomain?j===1223&&(j=204):j=m.text?200:404}}}catch(p){i||f(-1,p)}m&&f(j,k,m,l)},a.async&&g.readyState!==4?(bU||(bU={},bW()),h=bT++,g.onreadystatechange=bU[h]=c):c()},abort:function(){c&&c(0,1)}}}});var bZ={},b$=/^(?:toggle|show|hide)$/,b_=/^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,ca,cb=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];d.fn.extend({show:function(a,b,c){var e,f;if(a||a===0)return this.animate(cc("show",3),a,b,c);for(var g=0,h=this.length;g=0;a--)c[a].elem===this&&(b&&c[a](!0),c.splice(a,1))}),b||this.dequeue();return this}}),d.each({slideDown:cc("show",1),slideUp:cc("hide",1),slideToggle:cc("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){d.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),d.extend({speed:function(a,b,c){var e=a&&typeof a==="object"?d.extend({},a):{complete:c||!c&&b||d.isFunction(a)&&a,duration:a,easing:c&&b||b&&!d.isFunction(b)&&b};e.duration=d.fx.off?0:typeof e.duration==="number"?e.duration:e.duration in d.fx.speeds?d.fx.speeds[e.duration]:d.fx.speeds._default,e.old=e.complete,e.complete=function(){e.queue!==!1&&d(this).dequeue(),d.isFunction(e.old)&&e.old.call(this)};return e},easing:{linear:function(a,b,c,d){return c+d*a},swing:function(a,b,c,d){return(-Math.cos(a*Math.PI)/2+.5)*d+c}},timers:[],fx:function(a,b,c){this.options=b,this.elem=a,this.prop=c,b.orig||(b.orig={})}}),d.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this),(d.fx.step[this.prop]||d.fx.step._default)(this)},cur:function(){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];var a,b=d.css(this.elem,this.prop);return isNaN(a=parseFloat(b))?!b||b==="auto"?0:b:a},custom:function(a,b,c){function g(a){return e.step(a)}var e=this,f=d.fx;this.startTime=d.now(),this.start=a,this.end=b,this.unit=c||this.unit||(d.cssNumber[this.prop]?"":"px"),this.now=this.start,this.pos=this.state=0,g.elem=this.elem,g()&&d.timers.push(g)&&!ca&&(ca=setInterval(f.tick,f.interval))},show:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.show=!0,this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur()),d(this.elem).show()},hide:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.hide=!0,this.custom(this.cur(),0)},step:function(a){var b=d.now(),c=!0;if(a||b>=this.options.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),this.options.curAnim[this.prop]=!0;for(var e in this.options.curAnim)this.options.curAnim[e]!==!0&&(c=!1);if(c){if(this.options.overflow!=null&&!d.support.shrinkWrapBlocks){var f=this.elem,g=this.options;d.each(["","X","Y"],function(a,b){f.style["overflow"+b]=g.overflow[a]})}this.options.hide&&d(this.elem).hide();if(this.options.hide||this.options.show)for(var h in this.options.curAnim)d.style(this.elem,h,this.options.orig[h]);this.options.complete.call(this.elem)}return!1}var i=b-this.startTime;this.state=i/this.options.duration;var j=this.options.specialEasing&&this.options.specialEasing[this.prop],k=this.options.easing||(d.easing.swing?"swing":"linear");this.pos=d.easing[j||k](this.state,i,0,1,this.options.duration),this.now=this.start+(this.end-this.start)*this.pos,this.update();return!0}},d.extend(d.fx,{tick:function(){var a=d.timers;for(var b=0;b
";d.extend(b.style,{position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"}),b.innerHTML=j,a.insertBefore(b,a.firstChild),e=b.firstChild,f=e.firstChild,h=e.nextSibling.firstChild.firstChild,this.doesNotAddBorder=f.offsetTop!==5,this.doesAddBorderForTableAndCells=h.offsetTop===5,f.style.position="fixed",f.style.top="20px",this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15,f.style.position=f.style.top="",e.style.overflow="hidden",e.style.position="relative",this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5,this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==i,a.removeChild(b),a=b=e=f=g=h=null,d.offset.initialize=d.noop},bodyOffset:function(a){var b=a.offsetTop,c=a.offsetLeft;d.offset.initialize(),d.offset.doesNotIncludeMarginInBodyOffset&&(b+=parseFloat(d.css(a,"marginTop"))||0,c+=parseFloat(d.css(a,"marginLeft"))||0);return{top:b,left:c}},setOffset:function(a,b,c){var e=d.css(a,"position");e==="static"&&(a.style.position="relative");var f=d(a),g=f.offset(),h=d.css(a,"top"),i=d.css(a,"left"),j=e==="absolute"&&d.inArray("auto",[h,i])>-1,k={},l={},m,n;j&&(l=f.position()),m=j?l.top:parseInt(h,10)||0,n=j?l.left:parseInt(i,10)||0,d.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):f.css(k)}},d.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),e=cf.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(d.css(a,"marginTop"))||0,c.left-=parseFloat(d.css(a,"marginLeft"))||0,e.top+=parseFloat(d.css(b[0],"borderTopWidth"))||0,e.left+=parseFloat(d.css(b[0],"borderLeftWidth"))||0;return{top:c.top-e.top,left:c.left-e.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&(!cf.test(a.nodeName)&&d.css(a,"position")==="static"))a=a.offsetParent;return a})}}),d.each(["Left","Top"],function(a,c){var e="scroll"+c;d.fn[e]=function(c){var f=this[0],g;if(!f)return null;if(c!==b)return this.each(function(){g=cg(this),g?g.scrollTo(a?d(g).scrollLeft():c,a?c:d(g).scrollTop()):this[e]=c});g=cg(f);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:d.support.boxModel&&g.document.documentElement[e]||g.document.body[e]:f[e]}}),d.each(["Height","Width"],function(a,c){var e=c.toLowerCase();d.fn["inner"+c]=function(){return this[0]?parseFloat(d.css(this[0],e,"padding")):null},d.fn["outer"+c]=function(a){return this[0]?parseFloat(d.css(this[0],e,a?"margin":"border")):null},d.fn[e]=function(a){var f=this[0];if(!f)return a==null?null:this;if(d.isFunction(a))return this.each(function(b){var c=d(this);c[e](a.call(this,b,c[e]()))});if(d.isWindow(f)){var g=f.document.documentElement["client"+c];return f.document.compatMode==="CSS1Compat"&&g||f.document.body["client"+c]||g}if(f.nodeType===9)return Math.max(f.documentElement["client"+c],f.body["scroll"+c],f.documentElement["scroll"+c],f.body["offset"+c],f.documentElement["offset"+c]);if(a===b){var h=d.css(f,e),i=parseFloat(h);return d.isNaN(i)?h:i}return this.css(e,typeof a==="string"?a:a+"px")}}),a.jQuery=a.$=d})(window); \ No newline at end of file diff --git a/artifact/1.0.0/lib/simple-inheritance.min.js b/artifact/1.0.0/lib/simple-inheritance.min.js new file mode 100644 index 000000000..2481fd0a1 --- /dev/null +++ b/artifact/1.0.0/lib/simple-inheritance.min.js @@ -0,0 +1,8 @@ +/* Simple JavaScript Inheritance + * By John Resig http://ejohn.org/ + * MIT Licensed. + */ +(function(){var initializing=false,fnTest=/xyz/.test(function(){xyz;})?/\b_super\b/:/.*/;this.Class=function(){};Class.extend=function(prop){var _super=this.prototype;initializing=true;var prototype=new this();initializing=false;for(var name in prop){prototype[name]=typeof prop[name]=="function"&&typeof _super[name]=="function"&&fnTest.test(prop[name])?(function(name,fn){return function(){var tmp=this._super;this._super=_super[name];var ret=fn.apply(this,arguments);this._super=tmp;return ret;};})(name,prop[name]):prop[name];} +function Class(){if(!initializing&&this.init) +this.init.apply(this,arguments);} +Class.prototype=prototype;Class.constructor=Class;Class.extend=arguments.callee;return Class;};})(); \ No newline at end of file diff --git a/artifact/1.0.0/photoswipe-icons.png b/artifact/1.0.0/photoswipe-icons.png new file mode 100644 index 000000000..687cd74bc Binary files /dev/null and b/artifact/1.0.0/photoswipe-icons.png differ diff --git a/artifact/1.0.0/photoswipe-loader.gif b/artifact/1.0.0/photoswipe-loader.gif new file mode 100644 index 000000000..c95d05a05 Binary files /dev/null and b/artifact/1.0.0/photoswipe-loader.gif differ diff --git a/artifact/1.0.0/photoswipe.css b/artifact/1.0.0/photoswipe.css new file mode 100644 index 000000000..0e3f012ae --- /dev/null +++ b/artifact/1.0.0/photoswipe.css @@ -0,0 +1,138 @@ +/* + * PhotoSwipe - http://www.photoswipe.com/ + * Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) + * Licensed under the MIT license + * + * Default styles for SwipeGallery + * Avoid any position or dimension based styles + * where possible, unless specified already here. + * The gallery automatically works out gallery item + * positions etc. + */ + +body.ps-active +{ + -webkit-text-size-adjust: none; +} +body.ps-active * +{ + -webkit-tap-highlight-color: rgba(255, 255, 255, 0); +} +body.ps-active *:focus +{ + outline: 0; +} + + +/* Document overlay */ +div.ps-document-overlay +{ + background: #000; +} + + +/* Viewport */ +div.ps-viewport +{ + background: #000; + cursor: pointer; +} + + +/* Slider */ +div.ps-slider-item-loading +{ + background: url(photoswipe-loader.gif) no-repeat center center; +} + + +/* Caption */ +div.ps-caption +{ + background: #000000; + background: -moz-linear-gradient(top, #303130 0%, #000101 100%); + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#303130), color-stop(100%,#000101)); + border-bottom: 1px solid #42403f; + color: #ffffff; + font-size: 13px; + font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; + text-align: center; +} + +div.ps-caption-bottom +{ + border-top: 1px solid #42403f; + border-bottom: none; +} + +div.ps-caption-content +{ + padding: 13px; +} + + +/* Toolbar */ +div.ps-toolbar +{ + background: #000000; + background: -moz-linear-gradient(top, #303130 0%, #000101 100%); + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#303130), color-stop(100%,#000101)); + border-top: 1px solid #42403f; + color: #ffffff; + font-size: 13px; + font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; + text-align: center; + height: 44px; + border-collapse: collapse; + display: table; + table-layout: fixed; +} + +div.ps-toolbar-top +{ + border-bottom: 1px solid #42403f; + border-top: none; +} + +div.ps-toolbar-close, div.ps-toolbar-previous, div.ps-toolbar-next, div.ps-toolbar-play +{ + cursor: pointer; + display: table-cell; +} + +div.ps-toolbar div div.ps-toolbar-content +{ + width: 44px; + height: 44px; + margin: 0 auto 0; +} + +div.ps-toolbar-close div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -44px 0; +} + +div.ps-toolbar-previous div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -132px 0; +} + +div.ps-toolbar-previous-disabled div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -132px -44px; +} + +div.ps-toolbar-next div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -176px 0; +} + +div.ps-toolbar-next-disabled div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -176px -44px; +} + +div.ps-toolbar-play div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -88px 0; +} diff --git a/build.cmd b/build.cmd new file mode 100644 index 000000000..c9bbcaf68 --- /dev/null +++ b/build.cmd @@ -0,0 +1,2 @@ +call tools\apache-ant-1.8.2\bin\ant +IF NOT %ERRORLEVEL% == 0 pause diff --git a/build.number b/build.number new file mode 100644 index 000000000..bc352633b --- /dev/null +++ b/build.number @@ -0,0 +1,3 @@ +#Build Number for ANT. Do not edit! +#Thu Apr 07 14:38:26 BST 2011 +build.number=112 diff --git a/build.properties b/build.properties new file mode 100644 index 000000000..7009d9567 --- /dev/null +++ b/build.properties @@ -0,0 +1,11 @@ +# +# Ant Property file +# + +project.description = PhotoSwipe +project.src.dir = src + +project.build.version = 1.0.0 + +project.build.workdir = work +project.build.artifactdir = artifact diff --git a/build.sh b/build.sh new file mode 100644 index 000000000..fae0beee8 --- /dev/null +++ b/build.sh @@ -0,0 +1,2 @@ +#!/bin/bash +tools/apache-ant-1.8.2/bin/ant diff --git a/build.xml b/build.xml new file mode 100644 index 000000000..45a012025 --- /dev/null +++ b/build.xml @@ -0,0 +1,127 @@ + + + + + + + + + + + + Building = ${project.build.version} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/src/caption-class.js b/src/caption-class.js new file mode 100644 index 000000000..9265c5e8d --- /dev/null +++ b/src/caption-class.js @@ -0,0 +1,196 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.CaptionClass + */ + Code.PhotoSwipe.CaptionClass = Code.PhotoSwipe.ElementClass.extend({ + + contentEl: null, + + fadeOutTimeout: null, + + touchStartHandler: null, + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + captionDelay: 4000, + position: 'bottom' + }; + + Util.extend(this.settings, options); + + this._super(options); + + this.touchStartHandler = this.onTouchStart.bind(this); + + // Create element and append to body + var cssClass = Code.PhotoSwipe.CaptionClass.CssClasses.caption; + if (this.settings.position === 'bottom'){ + cssClass = cssClass + ' ' + Code.PhotoSwipe.CaptionClass.CssClasses.bottom; + } + + this.el = Util.DOM.createElement('div', { 'class': cssClass }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + overflow: 'hidden', + zIndex: 1000 + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + this.contentEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.CaptionClass.CssClasses.content }, ''); + Util.DOM.appendChild(this.contentEl, this.el); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + try{ + Util.DOM.addEventListener(this.el, 'touchstart', this.touchStartHandler); + } + catch (err){ } + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + try{ + Util.DOM.removeEventListener(this.el, 'touchstart', this.touchStartHandler); + } + catch (err){ } + + }, + + + /* + * Function: onTouch + */ + onTouchStart: function(e){ + + e.preventDefault(); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + var top; + + if (this.settings.position === 'bottom') { + top = Util.DOM.windowHeight() - Util.DOM.height(this.el) + Util.DOM.windowScrollTop(); + } + else { + top = Util.DOM.windowScrollTop(); + } + + Util.DOM.setStyle(this.el, 'top', top + 'px'); + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + + }, + + + + /* + * Function: captionToShow + */ + show: function(captionValue){ + + this.stopFade(); + + Util.DOM.removeChildren(this.contentEl); + + captionValue = Util.coalesce(captionValue, '\u00A0'); + + if (Util.isObject(captionValue)){ + Util.DOM.appendChild(captionValue, this.contentEl); + } + else{ + if (captionValue === ''){ + captionValue = '\u00A0'; + } + Util.DOM.appendText(captionValue, this.contentEl); + } + + Util.DOM.setStyle(this.el, 'opacity', this.settings.opacity); + Util.DOM.show(this.el); + + // Set position + this.resetPosition(); + + this.postShow(); + + }, + + + + /* + * Function: setEmptyCaption + */ + setEmptyCaption: function(){ + + Util.DOM.removeChildren(this.contentEl); + Util.DOM.appendText('\u00A0', this.contentEl); + + }, + + + + /* + * Function: stopFade + */ + stopFade: function(){ + + window.clearTimeout(this.fadeOutTimeout); + this._super(); + + }, + + + /* + * Function: postShow + */ + postShow: function(){ + + if (this.settings.captionDelay > 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.captionDelay + ); + + } + + this._super(); + + } + + }); + + + Code.PhotoSwipe.CaptionClass.CssClasses = { + caption: 'ps-caption', + bottom: 'ps-caption-bottom', + content: 'ps-caption-content' + }; + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/change-log.html b/src/change-log.html new file mode 100644 index 000000000..416b31929 --- /dev/null +++ b/src/change-log.html @@ -0,0 +1,15 @@ + + + + Changes + + +
    +
  • + 1.0.0 07.04.11 +
    + Initial release by Ste Brennan +
    • +
+ + diff --git a/src/document-overlay-class.js b/src/document-overlay-class.js new file mode 100644 index 000000000..f3decc8ee --- /dev/null +++ b/src/document-overlay-class.js @@ -0,0 +1,50 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.DocumentOverlayClass + */ + Code.PhotoSwipe.DocumentOverlayClass = Code.PhotoSwipe.ElementClass.extend({ + + /* + * Function: init + */ + init: function(options){ + + this._super(options); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.DocumentOverlayClass.CssClasses.documentOverlay }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.bodyHeight()); + + } + + }); + + + Code.PhotoSwipe.DocumentOverlayClass.CssClasses = { + documentOverlay: 'ps-document-overlay' + }; + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/element-class.js b/src/element-class.js new file mode 100644 index 000000000..f5e3b806b --- /dev/null +++ b/src/element-class.js @@ -0,0 +1,251 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + /* + * Class: Code.PhotoSwipe.ElementClass + * Most PhotoSwipe classes inherit from this class + * Provides hooks for fading in and out + */ + Code.PhotoSwipe.ElementClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + settings: null, + isFading: null, + + fadeInHandler: null, + fadeOutHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this._super(); + + this.settings = { + opacity: 1, + fadeSpeed: 500 + }; + + Util.extend(this.settings, options); + + this.isFading = false; + + this.fadeInHandler = this.postFadeIn.bind(this); + this.fadeOutHandler = this.postFadeOut.bind(this); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + }, + + + + /* + * Function: show + */ + show: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + // Set position + this.resetPosition(); + + // Show + Util.DOM.setStyle(this.el, 'opacity', this.settings.opacity); + Util.DOM.show(this.el); + + this.postShow(); + + }, + + + + /* + * Function: postShow + * Overide this + */ + postShow: function(){ + + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onShow); + + }, + + + + /* + * Function: fadeIn + */ + fadeIn: function(){ + + if (this.el === null){ + return; + } + + Util.DOM.setStyle(this.el, 'opacity', 0); + + this.fadeInFromCurrentOpacity(); + + }, + + + /* + * Function: fadeInFromCurrentOpacity + */ + fadeInFromCurrentOpacity: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + this.isFading = true; + + // Set position + this.resetPosition(); + + // Fade in + Util.DOM.show(this.el); + Util.Animation.fadeIn( + this.el, + this.settings.opacity, + this.settings.fadeSpeed, + this.fadeInHandler + ); + + }, + + + /* + * Function: postFadeIn + */ + postFadeIn: function(e){ + + this.isFading = false; + this.addEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeIn); + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.el === null){ + return; + } + + this.stopFade(); + + Util.DOM.hide(this.el); + + this.postHide(); + + }, + + + /* + * Function: postHide + * Overide this + */ + postHide: function(){ + + this.removeEventListeners(); + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onHide); + + }, + + + /* + * Fuction: fadeOut + */ + fadeOut: function(){ + + this.stopFade(); + + this.isFading = true; + + Util.Animation.fadeOut(this.el, this.settings.fadeSpeed, this.fadeOutHandler); + + }, + + + /* + * Function: preFadeOut + */ + postFadeOut: function(e){ + + this.isFading = false; + + Util.DOM.hide(this.el); + + this.removeEventListeners(); + + this.dispatchEvent(Code.PhotoSwipe.ElementClass.EventTypes.onFadeOut); + + }, + + + /* + * Function: stopFade + */ + stopFade: function(){ + + if (this.el === null){ + return; + } + + Util.Animation.stopFade(this.el); + this.isFading = false; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + } + + + }); + + + + Code.PhotoSwipe.ElementClass.EventTypes = { + onShow: 'onShow', + onHide: 'onHide', + onClick: 'onClick', + onFadeIn: 'onFadeIn', + onFadeOut: 'onFadeOut' + }; + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/event-class.js b/src/event-class.js new file mode 100644 index 000000000..54504e99d --- /dev/null +++ b/src/event-class.js @@ -0,0 +1,65 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function () { + + // Based on http://www.javascriptbank.com/how-build-custom-events-javascript.html + Code.PhotoSwipe.EventClass = Class.extend({ + + _listeners: null, + + init: function(){ + + this._listeners = {}; + + }, + + + addEventListener: function(type, listener){ + + if (typeof this._listeners[type] === 'undefined'){ + this._listeners[type] = []; + } + this._listeners[type].push(listener); + + }, + + + dispatchEvent: function(event){ + if (typeof event == "string"){ + event = { type: event }; + } + if (!event.target){ + event.target = this; + } + + if (!event.type){ + throw new Error("Event object missing 'type' property."); + } + + if (this._listeners[event.type] instanceof Array){ + var listeners = this._listeners[event.type]; + for (var i=0, len=listeners.length; i < len; i++){ + listeners[i].call(this, event); + } + } + }, + + + removeEventListener: function(type, listener){ + if (this._listeners[type] instanceof Array){ + var listeners = this._listeners[type]; + for (var i=0, len=listeners.length; i < len; i++){ + if (listeners[i] === listener){ + listeners.splice(i, 1); + break; + } + } + } + } + + }); + + +})(); \ No newline at end of file diff --git a/src/examples/advanced-setup.html b/src/examples/advanced-setup.html new file mode 100644 index 000000000..a9bbead6d --- /dev/null +++ b/src/examples/advanced-setup.html @@ -0,0 +1,173 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/src/examples/images/blogicon.png b/src/examples/images/blogicon.png new file mode 100644 index 000000000..7cb472c3d Binary files /dev/null and b/src/examples/images/blogicon.png differ diff --git a/src/examples/images/codecomputerlovelogo.gif b/src/examples/images/codecomputerlovelogo.gif new file mode 100644 index 000000000..f5a905407 Binary files /dev/null and b/src/examples/images/codecomputerlovelogo.gif differ diff --git a/src/examples/images/facebookicon.png b/src/examples/images/facebookicon.png new file mode 100644 index 000000000..e6de15d06 Binary files /dev/null and b/src/examples/images/facebookicon.png differ diff --git a/src/examples/images/flickricon.png b/src/examples/images/flickricon.png new file mode 100644 index 000000000..a7474c9f6 Binary files /dev/null and b/src/examples/images/flickricon.png differ diff --git a/src/examples/images/full/001.jpg b/src/examples/images/full/001.jpg new file mode 100644 index 000000000..2ab880c20 Binary files /dev/null and b/src/examples/images/full/001.jpg differ diff --git a/src/examples/images/full/002.jpg b/src/examples/images/full/002.jpg new file mode 100644 index 000000000..80e9da4c8 Binary files /dev/null and b/src/examples/images/full/002.jpg differ diff --git a/src/examples/images/full/003.jpg b/src/examples/images/full/003.jpg new file mode 100644 index 000000000..cf61c3f21 Binary files /dev/null and b/src/examples/images/full/003.jpg differ diff --git a/src/examples/images/full/004.jpg b/src/examples/images/full/004.jpg new file mode 100644 index 000000000..fc0c1b790 Binary files /dev/null and b/src/examples/images/full/004.jpg differ diff --git a/src/examples/images/full/005.jpg b/src/examples/images/full/005.jpg new file mode 100644 index 000000000..50cc9c304 Binary files /dev/null and b/src/examples/images/full/005.jpg differ diff --git a/src/examples/images/full/006.jpg b/src/examples/images/full/006.jpg new file mode 100644 index 000000000..330790e86 Binary files /dev/null and b/src/examples/images/full/006.jpg differ diff --git a/src/examples/images/full/007.jpg b/src/examples/images/full/007.jpg new file mode 100644 index 000000000..6244f9dc8 Binary files /dev/null and b/src/examples/images/full/007.jpg differ diff --git a/src/examples/images/full/008.jpg b/src/examples/images/full/008.jpg new file mode 100644 index 000000000..fc52e87a3 Binary files /dev/null and b/src/examples/images/full/008.jpg differ diff --git a/src/examples/images/full/009.jpg b/src/examples/images/full/009.jpg new file mode 100644 index 000000000..ec81b067c Binary files /dev/null and b/src/examples/images/full/009.jpg differ diff --git a/src/examples/images/full/010.jpg b/src/examples/images/full/010.jpg new file mode 100644 index 000000000..f705ddc9f Binary files /dev/null and b/src/examples/images/full/010.jpg differ diff --git a/src/examples/images/full/011.jpg b/src/examples/images/full/011.jpg new file mode 100644 index 000000000..e41c7ff41 Binary files /dev/null and b/src/examples/images/full/011.jpg differ diff --git a/src/examples/images/full/012.jpg b/src/examples/images/full/012.jpg new file mode 100644 index 000000000..4f2de4bd7 Binary files /dev/null and b/src/examples/images/full/012.jpg differ diff --git a/src/examples/images/full/013.jpg b/src/examples/images/full/013.jpg new file mode 100644 index 000000000..571a9e487 Binary files /dev/null and b/src/examples/images/full/013.jpg differ diff --git a/src/examples/images/full/014.jpg b/src/examples/images/full/014.jpg new file mode 100644 index 000000000..a7b233f2e Binary files /dev/null and b/src/examples/images/full/014.jpg differ diff --git a/src/examples/images/full/015.jpg b/src/examples/images/full/015.jpg new file mode 100644 index 000000000..cd04cbfbd Binary files /dev/null and b/src/examples/images/full/015.jpg differ diff --git a/src/examples/images/thumb/001.jpg b/src/examples/images/thumb/001.jpg new file mode 100644 index 000000000..4ba1b8112 Binary files /dev/null and b/src/examples/images/thumb/001.jpg differ diff --git a/src/examples/images/thumb/002.jpg b/src/examples/images/thumb/002.jpg new file mode 100644 index 000000000..09538dfe6 Binary files /dev/null and b/src/examples/images/thumb/002.jpg differ diff --git a/src/examples/images/thumb/003.jpg b/src/examples/images/thumb/003.jpg new file mode 100644 index 000000000..e95bc3784 Binary files /dev/null and b/src/examples/images/thumb/003.jpg differ diff --git a/src/examples/images/thumb/004.jpg b/src/examples/images/thumb/004.jpg new file mode 100644 index 000000000..86ace941a Binary files /dev/null and b/src/examples/images/thumb/004.jpg differ diff --git a/src/examples/images/thumb/005.jpg b/src/examples/images/thumb/005.jpg new file mode 100644 index 000000000..e9b17f0a0 Binary files /dev/null and b/src/examples/images/thumb/005.jpg differ diff --git a/src/examples/images/thumb/006.jpg b/src/examples/images/thumb/006.jpg new file mode 100644 index 000000000..d0757d85d Binary files /dev/null and b/src/examples/images/thumb/006.jpg differ diff --git a/src/examples/images/thumb/007.jpg b/src/examples/images/thumb/007.jpg new file mode 100644 index 000000000..a6a02657e Binary files /dev/null and b/src/examples/images/thumb/007.jpg differ diff --git a/src/examples/images/thumb/008.jpg b/src/examples/images/thumb/008.jpg new file mode 100644 index 000000000..185bce127 Binary files /dev/null and b/src/examples/images/thumb/008.jpg differ diff --git a/src/examples/images/thumb/009.jpg b/src/examples/images/thumb/009.jpg new file mode 100644 index 000000000..aac07132e Binary files /dev/null and b/src/examples/images/thumb/009.jpg differ diff --git a/src/examples/images/thumb/010.jpg b/src/examples/images/thumb/010.jpg new file mode 100644 index 000000000..cdae77865 Binary files /dev/null and b/src/examples/images/thumb/010.jpg differ diff --git a/src/examples/images/thumb/011.jpg b/src/examples/images/thumb/011.jpg new file mode 100644 index 000000000..a71f66d34 Binary files /dev/null and b/src/examples/images/thumb/011.jpg differ diff --git a/src/examples/images/thumb/012.jpg b/src/examples/images/thumb/012.jpg new file mode 100644 index 000000000..27a732e02 Binary files /dev/null and b/src/examples/images/thumb/012.jpg differ diff --git a/src/examples/images/thumb/013.jpg b/src/examples/images/thumb/013.jpg new file mode 100644 index 000000000..ae52fe90b Binary files /dev/null and b/src/examples/images/thumb/013.jpg differ diff --git a/src/examples/images/thumb/014.jpg b/src/examples/images/thumb/014.jpg new file mode 100644 index 000000000..919980be8 Binary files /dev/null and b/src/examples/images/thumb/014.jpg differ diff --git a/src/examples/images/thumb/015.jpg b/src/examples/images/thumb/015.jpg new file mode 100644 index 000000000..f587b00c2 Binary files /dev/null and b/src/examples/images/thumb/015.jpg differ diff --git a/src/examples/images/twittericon.png b/src/examples/images/twittericon.png new file mode 100644 index 000000000..7a588c1e8 Binary files /dev/null and b/src/examples/images/twittericon.png differ diff --git a/src/examples/index-jquery-plugin.html b/src/examples/index-jquery-plugin.html new file mode 100644 index 000000000..e62047930 --- /dev/null +++ b/src/examples/index-jquery-plugin.html @@ -0,0 +1,123 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/src/examples/index.html b/src/examples/index.html new file mode 100644 index 000000000..28d3b4c69 --- /dev/null +++ b/src/examples/index.html @@ -0,0 +1,139 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/src/examples/jquery-engine.html b/src/examples/jquery-engine.html new file mode 100644 index 000000000..a42624606 --- /dev/null +++ b/src/examples/jquery-engine.html @@ -0,0 +1,127 @@ + + + PhotoSwipe + + + + + + + + + + + + + + + + + + + + +
+ +
+

PhotoSwipe

+
+ + + + + +
+ + + + + + \ No newline at end of file diff --git a/src/examples/styles.css b/src/examples/styles.css new file mode 100644 index 000000000..38acccd76 --- /dev/null +++ b/src/examples/styles.css @@ -0,0 +1,20 @@ +body { padding: 0; margin: 0; background: #DFDCD1; font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; color: #444340; } +h1 { font-size: 1.3em; padding: 15px 10px; margin: 0; } +img { border: none; } +a { color: #444340; } + +#Header { background: #EEBF02; height: 61px; padding: 0; border-bottom: 1px solid #3c3c3c; } +#Header img { display: block; margin: 0 auto 0; } + +#MainContent { background: #ffffff; padding-bottom: 30px; } + +#Footer { padding: 10px; border-top: none; } + +#SocialLinks { padding: 10px 0 0 0; } +#SocialLinks:after { clear: both; content: "."; display: block; height: 0; visibility: hidden; } +#SocialLinks a { display: block; float: left; padding-right: 15px; } + +div.gallery-row:after { clear: both; content: "."; display: block; height: 0; visibility: hidden; } +div.gallery-item { float: left; width: 33.33333333%; } +div.gallery-item a { display: block; margin: 5px; border: 1px solid #3c3c3c; } +div.gallery-item img { display: block; width: 100%; height: auto; } \ No newline at end of file diff --git a/src/full-size-image-class.js b/src/full-size-image-class.js new file mode 100644 index 000000000..ab7e1611d --- /dev/null +++ b/src/full-size-image-class.js @@ -0,0 +1,93 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + + /* + * Class: Code.PhotoSwipe.FullSizeImageClass + */ + Code.PhotoSwipe.FullSizeImageClass = Code.PhotoSwipe.EventClass.extend({ + + el: null, + index: null, + + // The naturalWidth and naturalHeight of the image as loaded from the server + // This maybe different from the width and height set on the img element + // We need this to scale the image correctly + naturalWidth: null, + naturalHeight: null, + src: null, + caption: null, + scaleMethod: null, + isLandscape: null, + isLoading: null, + hasLoaded: null, + + loadEventHandler: null, + + + /* + * Function: init + */ + init: function(index, scaleMethod, src, caption){ + + this._super(); + + this.index = index; + this.naturalWidth = 0; + this.naturalHeight = 0; + this.src = src; + this.caption = caption; + this.isLandscape = false; + this.isLoading = false; + this.hasLoaded = false; + this.scaleMethod = scaleMethod; + + this.loadEventHandler = this.onLoad.bind(this); + + }, + + + /* + * Function: load + */ + load: function(){ + + // Load in the image + this.isLoading = true; + + this.el = new Image(); + Util.DOM.addClass(this.el, 'ps-full-size-image'); + this.el.onload = this.loadEventHandler; + this.el.src = this.src; + + }, + + + /* + * Function: onLoad + */ + onLoad: function(){ + + this.naturalWidth = Util.coalesce(this.el.naturalWidth, this.el.width); + this.naturalHeight = Util.coalesce(this.el.naturalHeight, this.el.height); + this.isLandscape = (this.naturalWidth > this.naturalHeight); + this.isLoading = false; + this.hasLoaded = true; + + this.dispatchEvent(Code.PhotoSwipe.FullSizeImageClass.EventTypes.onLoad); + + } + + + }); + + + Code.PhotoSwipe.FullSizeImageClass.EventTypes = { + onLoad: 'onLoad' + }; + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/lib/jquery-1.5.1.min.js b/src/lib/jquery-1.5.1.min.js new file mode 100644 index 000000000..6437874c6 --- /dev/null +++ b/src/lib/jquery-1.5.1.min.js @@ -0,0 +1,16 @@ +/*! + * jQuery JavaScript Library v1.5.1 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Wed Feb 23 13:55:29 2011 -0500 + */ +(function(a,b){function cg(a){return d.isWindow(a)?a:a.nodeType===9?a.defaultView||a.parentWindow:!1}function cd(a){if(!bZ[a]){var b=d("<"+a+">").appendTo("body"),c=b.css("display");b.remove();if(c==="none"||c==="")c="block";bZ[a]=c}return bZ[a]}function cc(a,b){var c={};d.each(cb.concat.apply([],cb.slice(0,b)),function(){c[this]=a});return c}function bY(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}function bX(){try{return new a.XMLHttpRequest}catch(b){}}function bW(){d(a).unload(function(){for(var a in bU)bU[a](0,1)})}function bQ(a,c){a.dataFilter&&(c=a.dataFilter(c,a.dataType));var e=a.dataTypes,f={},g,h,i=e.length,j,k=e[0],l,m,n,o,p;for(g=1;g=0===c})}function N(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function F(a,b){return(a&&a!=="*"?a+".":"")+b.replace(r,"`").replace(s,"&")}function E(a){var b,c,e,f,g,h,i,j,k,l,m,n,o,q=[],r=[],s=d._data(this,"events");if(a.liveFired!==this&&s&&s.live&&!a.target.disabled&&(!a.button||a.type!=="click")){a.namespace&&(n=new RegExp("(^|\\.)"+a.namespace.split(".").join("\\.(?:.*\\.)?")+"(\\.|$)")),a.liveFired=this;var t=s.live.slice(0);for(i=0;ic)break;a.currentTarget=f.elem,a.data=f.handleObj.data,a.handleObj=f.handleObj,o=f.handleObj.origHandler.apply(f.elem,arguments);if(o===!1||a.isPropagationStopped()){c=f.level,o===!1&&(b=!1);if(a.isImmediatePropagationStopped())break}}return b}}function C(a,c,e){var f=d.extend({},e[0]);f.type=a,f.originalEvent={},f.liveFired=b,d.event.handle.call(c,f),f.isDefaultPrevented()&&e[0].preventDefault()}function w(){return!0}function v(){return!1}function g(a){for(var b in a)if(b!=="toJSON")return!1;return!0}function f(a,c,f){if(f===b&&a.nodeType===1){f=a.getAttribute("data-"+c);if(typeof f==="string"){try{f=f==="true"?!0:f==="false"?!1:f==="null"?null:d.isNaN(f)?e.test(f)?d.parseJSON(f):f:parseFloat(f)}catch(g){}d.data(a,c,f)}else f=b}return f}var c=a.document,d=function(){function I(){if(!d.isReady){try{c.documentElement.doScroll("left")}catch(a){setTimeout(I,1);return}d.ready()}}var d=function(a,b){return new d.fn.init(a,b,g)},e=a.jQuery,f=a.$,g,h=/^(?:[^<]*(<[\w\W]+>)[^>]*$|#([\w\-]+)$)/,i=/\S/,j=/^\s+/,k=/\s+$/,l=/\d/,m=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,n=/^[\],:{}\s]*$/,o=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,p=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,q=/(?:^|:|,)(?:\s*\[)+/g,r=/(webkit)[ \/]([\w.]+)/,s=/(opera)(?:.*version)?[ \/]([\w.]+)/,t=/(msie) ([\w.]+)/,u=/(mozilla)(?:.*? rv:([\w.]+))?/,v=navigator.userAgent,w,x=!1,y,z="then done fail isResolved isRejected promise".split(" "),A,B=Object.prototype.toString,C=Object.prototype.hasOwnProperty,D=Array.prototype.push,E=Array.prototype.slice,F=String.prototype.trim,G=Array.prototype.indexOf,H={};d.fn=d.prototype={constructor:d,init:function(a,e,f){var g,i,j,k;if(!a)return this;if(a.nodeType){this.context=this[0]=a,this.length=1;return this}if(a==="body"&&!e&&c.body){this.context=c,this[0]=c.body,this.selector="body",this.length=1;return this}if(typeof a==="string"){g=h.exec(a);if(!g||!g[1]&&e)return!e||e.jquery?(e||f).find(a):this.constructor(e).find(a);if(g[1]){e=e instanceof d?e[0]:e,k=e?e.ownerDocument||e:c,j=m.exec(a),j?d.isPlainObject(e)?(a=[c.createElement(j[1])],d.fn.attr.call(a,e,!0)):a=[k.createElement(j[1])]:(j=d.buildFragment([g[1]],[k]),a=(j.cacheable?d.clone(j.fragment):j.fragment).childNodes);return d.merge(this,a)}i=c.getElementById(g[2]);if(i&&i.parentNode){if(i.id!==g[2])return f.find(a);this.length=1,this[0]=i}this.context=c,this.selector=a;return this}if(d.isFunction(a))return f.ready(a);a.selector!==b&&(this.selector=a.selector,this.context=a.context);return d.makeArray(a,this)},selector:"",jquery:"1.5.1",length:0,size:function(){return this.length},toArray:function(){return E.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this[this.length+a]:this[a]},pushStack:function(a,b,c){var e=this.constructor();d.isArray(a)?D.apply(e,a):d.merge(e,a),e.prevObject=this,e.context=this.context,b==="find"?e.selector=this.selector+(this.selector?" ":"")+c:b&&(e.selector=this.selector+"."+b+"("+c+")");return e},each:function(a,b){return d.each(this,a,b)},ready:function(a){d.bindReady(),y.done(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(E.apply(this,arguments),"slice",E.call(arguments).join(","))},map:function(a){return this.pushStack(d.map(this,function(b,c){return a.call(b,c,b)}))},end:function(){return this.prevObject||this.constructor(null)},push:D,sort:[].sort,splice:[].splice},d.fn.init.prototype=d.fn,d.extend=d.fn.extend=function(){var a,c,e,f,g,h,i=arguments[0]||{},j=1,k=arguments.length,l=!1;typeof i==="boolean"&&(l=i,i=arguments[1]||{},j=2),typeof i!=="object"&&!d.isFunction(i)&&(i={}),k===j&&(i=this,--j);for(;j0)return;y.resolveWith(c,[d]),d.fn.trigger&&d(c).trigger("ready").unbind("ready")}},bindReady:function(){if(!x){x=!0;if(c.readyState==="complete")return setTimeout(d.ready,1);if(c.addEventListener)c.addEventListener("DOMContentLoaded",A,!1),a.addEventListener("load",d.ready,!1);else if(c.attachEvent){c.attachEvent("onreadystatechange",A),a.attachEvent("onload",d.ready);var b=!1;try{b=a.frameElement==null}catch(e){}c.documentElement.doScroll&&b&&I()}}},isFunction:function(a){return d.type(a)==="function"},isArray:Array.isArray||function(a){return d.type(a)==="array"},isWindow:function(a){return a&&typeof a==="object"&&"setInterval"in a},isNaN:function(a){return a==null||!l.test(a)||isNaN(a)},type:function(a){return a==null?String(a):H[B.call(a)]||"object"},isPlainObject:function(a){if(!a||d.type(a)!=="object"||a.nodeType||d.isWindow(a))return!1;if(a.constructor&&!C.call(a,"constructor")&&!C.call(a.constructor.prototype,"isPrototypeOf"))return!1;var c;for(c in a){}return c===b||C.call(a,c)},isEmptyObject:function(a){for(var b in a)return!1;return!0},error:function(a){throw a},parseJSON:function(b){if(typeof b!=="string"||!b)return null;b=d.trim(b);if(n.test(b.replace(o,"@").replace(p,"]").replace(q,"")))return a.JSON&&a.JSON.parse?a.JSON.parse(b):(new Function("return "+b))();d.error("Invalid JSON: "+b)},parseXML:function(b,c,e){a.DOMParser?(e=new DOMParser,c=e.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b)),e=c.documentElement,(!e||!e.nodeName||e.nodeName==="parsererror")&&d.error("Invalid XML: "+b);return c},noop:function(){},globalEval:function(a){if(a&&i.test(a)){var b=c.head||c.getElementsByTagName("head")[0]||c.documentElement,e=c.createElement("script");d.support.scriptEval()?e.appendChild(c.createTextNode(a)):e.text=a,b.insertBefore(e,b.firstChild),b.removeChild(e)}},nodeName:function(a,b){return a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,c,e){var f,g=0,h=a.length,i=h===b||d.isFunction(a);if(e){if(i){for(f in a)if(c.apply(a[f],e)===!1)break}else for(;g1){var f=E.call(arguments,0),g=b,h=function(a){return function(b){f[a]=arguments.length>1?E.call(arguments,0):b,--g||c.resolveWith(e,f)}};while(b--)a=f[b],a&&d.isFunction(a.promise)?a.promise().then(h(b),c.reject):--g;g||c.resolveWith(e,f)}else c!==a&&c.resolve(a);return e},uaMatch:function(a){a=a.toLowerCase();var b=r.exec(a)||s.exec(a)||t.exec(a)||a.indexOf("compatible")<0&&u.exec(a)||[];return{browser:b[1]||"",version:b[2]||"0"}},sub:function(){function a(b,c){return new a.fn.init(b,c)}d.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.subclass=this.subclass,a.fn.init=function b(b,c){c&&c instanceof d&&!(c instanceof a)&&(c=a(c));return d.fn.init.call(this,b,c,e)},a.fn.init.prototype=a.fn;var e=a(c);return a},browser:{}}),y=d._Deferred(),d.each("Boolean Number String Function Array Date RegExp Object".split(" "),function(a,b){H["[object "+b+"]"]=b.toLowerCase()}),w=d.uaMatch(v),w.browser&&(d.browser[w.browser]=!0,d.browser.version=w.version),d.browser.webkit&&(d.browser.safari=!0),G&&(d.inArray=function(a,b){return G.call(b,a)}),i.test(" ")&&(j=/^[\s\xA0]+/,k=/[\s\xA0]+$/),g=d(c),c.addEventListener?A=function(){c.removeEventListener("DOMContentLoaded",A,!1),d.ready()}:c.attachEvent&&(A=function(){c.readyState==="complete"&&(c.detachEvent("onreadystatechange",A),d.ready())});return d}();(function(){d.support={};var b=c.createElement("div");b.style.display="none",b.innerHTML="
a";var e=b.getElementsByTagName("*"),f=b.getElementsByTagName("a")[0],g=c.createElement("select"),h=g.appendChild(c.createElement("option")),i=b.getElementsByTagName("input")[0];if(e&&e.length&&f){d.support={leadingWhitespace:b.firstChild.nodeType===3,tbody:!b.getElementsByTagName("tbody").length,htmlSerialize:!!b.getElementsByTagName("link").length,style:/red/.test(f.getAttribute("style")),hrefNormalized:f.getAttribute("href")==="/a",opacity:/^0.55$/.test(f.style.opacity),cssFloat:!!f.style.cssFloat,checkOn:i.value==="on",optSelected:h.selected,deleteExpando:!0,optDisabled:!1,checkClone:!1,noCloneEvent:!0,noCloneChecked:!0,boxModel:null,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableHiddenOffsets:!0},i.checked=!0,d.support.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,d.support.optDisabled=!h.disabled;var j=null;d.support.scriptEval=function(){if(j===null){var b=c.documentElement,e=c.createElement("script"),f="script"+d.now();try{e.appendChild(c.createTextNode("window."+f+"=1;"))}catch(g){}b.insertBefore(e,b.firstChild),a[f]?(j=!0,delete a[f]):j=!1,b.removeChild(e),b=e=f=null}return j};try{delete b.test}catch(k){d.support.deleteExpando=!1}!b.addEventListener&&b.attachEvent&&b.fireEvent&&(b.attachEvent("onclick",function l(){d.support.noCloneEvent=!1,b.detachEvent("onclick",l)}),b.cloneNode(!0).fireEvent("onclick")),b=c.createElement("div"),b.innerHTML="";var m=c.createDocumentFragment();m.appendChild(b.firstChild),d.support.checkClone=m.cloneNode(!0).cloneNode(!0).lastChild.checked,d(function(){var a=c.createElement("div"),b=c.getElementsByTagName("body")[0];if(b){a.style.width=a.style.paddingLeft="1px",b.appendChild(a),d.boxModel=d.support.boxModel=a.offsetWidth===2,"zoom"in a.style&&(a.style.display="inline",a.style.zoom=1,d.support.inlineBlockNeedsLayout=a.offsetWidth===2,a.style.display="",a.innerHTML="
",d.support.shrinkWrapBlocks=a.offsetWidth!==2),a.innerHTML="
t
";var e=a.getElementsByTagName("td");d.support.reliableHiddenOffsets=e[0].offsetHeight===0,e[0].style.display="",e[1].style.display="none",d.support.reliableHiddenOffsets=d.support.reliableHiddenOffsets&&e[0].offsetHeight===0,a.innerHTML="",b.removeChild(a).style.display="none",a=e=null}});var n=function(a){var b=c.createElement("div");a="on"+a;if(!b.attachEvent)return!0;var d=a in b;d||(b.setAttribute(a,"return;"),d=typeof b[a]==="function"),b=null;return d};d.support.submitBubbles=n("submit"),d.support.changeBubbles=n("change"),b=e=f=null}})();var e=/^(?:\{.*\}|\[.*\])$/;d.extend({cache:{},uuid:0,expando:"jQuery"+(d.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){a=a.nodeType?d.cache[a[d.expando]]:a[d.expando];return!!a&&!g(a)},data:function(a,c,e,f){if(d.acceptData(a)){var g=d.expando,h=typeof c==="string",i,j=a.nodeType,k=j?d.cache:a,l=j?a[d.expando]:a[d.expando]&&d.expando;if((!l||f&&l&&!k[l][g])&&h&&e===b)return;l||(j?a[d.expando]=l=++d.uuid:l=d.expando),k[l]||(k[l]={},j||(k[l].toJSON=d.noop));if(typeof c==="object"||typeof c==="function")f?k[l][g]=d.extend(k[l][g],c):k[l]=d.extend(k[l],c);i=k[l],f&&(i[g]||(i[g]={}),i=i[g]),e!==b&&(i[c]=e);if(c==="events"&&!i[c])return i[g]&&i[g].events;return h?i[c]:i}},removeData:function(b,c,e){if(d.acceptData(b)){var f=d.expando,h=b.nodeType,i=h?d.cache:b,j=h?b[d.expando]:d.expando;if(!i[j])return;if(c){var k=e?i[j][f]:i[j];if(k){delete k[c];if(!g(k))return}}if(e){delete i[j][f];if(!g(i[j]))return}var l=i[j][f];d.support.deleteExpando||i!=a?delete i[j]:i[j]=null,l?(i[j]={},h||(i[j].toJSON=d.noop),i[j][f]=l):h&&(d.support.deleteExpando?delete b[d.expando]:b.removeAttribute?b.removeAttribute(d.expando):b[d.expando]=null)}},_data:function(a,b,c){return d.data(a,b,c,!0)},acceptData:function(a){if(a.nodeName){var b=d.noData[a.nodeName.toLowerCase()];if(b)return b!==!0&&a.getAttribute("classid")===b}return!0}}),d.fn.extend({data:function(a,c){var e=null;if(typeof a==="undefined"){if(this.length){e=d.data(this[0]);if(this[0].nodeType===1){var g=this[0].attributes,h;for(var i=0,j=g.length;i-1)return!0;return!1},val:function(a){if(!arguments.length){var c=this[0];if(c){if(d.nodeName(c,"option")){var e=c.attributes.value;return!e||e.specified?c.value:c.text}if(d.nodeName(c,"select")){var f=c.selectedIndex,g=[],h=c.options,i=c.type==="select-one";if(f<0)return null;for(var k=i?f:0,l=i?f+1:h.length;k=0;else if(d.nodeName(this,"select")){var f=d.makeArray(e);d("option",this).each(function(){this.selected=d.inArray(d(this).val(),f)>=0}),f.length||(this.selectedIndex=-1)}else this.value=e}})}}),d.extend({attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attr:function(a,c,e,f){if(!a||a.nodeType===3||a.nodeType===8||a.nodeType===2)return b;if(f&&c in d.attrFn)return d(a)[c](e);var g=a.nodeType!==1||!d.isXMLDoc(a),h=e!==b;c=g&&d.props[c]||c;if(a.nodeType===1){var i=k.test(c);if(c==="selected"&&!d.support.optSelected){var j=a.parentNode;j&&(j.selectedIndex,j.parentNode&&j.parentNode.selectedIndex)}if((c in a||a[c]!==b)&&g&&!i){h&&(c==="type"&&l.test(a.nodeName)&&a.parentNode&&d.error("type property can't be changed"),e===null?a.nodeType===1&&a.removeAttribute(c):a[c]=e);if(d.nodeName(a,"form")&&a.getAttributeNode(c))return a.getAttributeNode(c).nodeValue;if(c==="tabIndex"){var o=a.getAttributeNode("tabIndex");return o&&o.specified?o.value:m.test(a.nodeName)||n.test(a.nodeName)&&a.href?0:b}return a[c]}if(!d.support.style&&g&&c==="style"){h&&(a.style.cssText=""+e);return a.style.cssText}h&&a.setAttribute(c,""+e);if(!a.attributes[c]&&(a.hasAttribute&&!a.hasAttribute(c)))return b;var p=!d.support.hrefNormalized&&g&&i?a.getAttribute(c,2):a.getAttribute(c);return p===null?b:p}h&&(a[c]=e);return a[c]}});var p=/\.(.*)$/,q=/^(?:textarea|input|select)$/i,r=/\./g,s=/ /g,t=/[^\w\s.|`]/g,u=function(a){return a.replace(t,"\\$&")};d.event={add:function(c,e,f,g){if(c.nodeType!==3&&c.nodeType!==8){try{d.isWindow(c)&&(c!==a&&!c.frameElement)&&(c=a)}catch(h){}if(f===!1)f=v;else if(!f)return;var i,j;f.handler&&(i=f,f=i.handler),f.guid||(f.guid=d.guid++);var k=d._data(c);if(!k)return;var l=k.events,m=k.handle;l||(k.events=l={}),m||(k.handle=m=function(){return typeof d!=="undefined"&&!d.event.triggered?d.event.handle.apply(m.elem,arguments):b}),m.elem=c,e=e.split(" ");var n,o=0,p;while(n=e[o++]){j=i?d.extend({},i):{handler:f,data:g},n.indexOf(".")>-1?(p=n.split("."),n=p.shift(),j.namespace=p.slice(0).sort().join(".")):(p=[],j.namespace=""),j.type=n,j.guid||(j.guid=f.guid);var q=l[n],r=d.event.special[n]||{};if(!q){q=l[n]=[];if(!r.setup||r.setup.call(c,g,p,m)===!1)c.addEventListener?c.addEventListener(n,m,!1):c.attachEvent&&c.attachEvent("on"+n,m)}r.add&&(r.add.call(c,j),j.handler.guid||(j.handler.guid=f.guid)),q.push(j),d.event.global[n]=!0}c=null}},global:{},remove:function(a,c,e,f){if(a.nodeType!==3&&a.nodeType!==8){e===!1&&(e=v);var g,h,i,j,k=0,l,m,n,o,p,q,r,s=d.hasData(a)&&d._data(a),t=s&&s.events;if(!s||!t)return;c&&c.type&&(e=c.handler,c=c.type);if(!c||typeof c==="string"&&c.charAt(0)==="."){c=c||"";for(h in t)d.event.remove(a,h+c);return}c=c.split(" ");while(h=c[k++]){r=h,q=null,l=h.indexOf(".")<0,m=[],l||(m=h.split("."),h=m.shift(),n=new RegExp("(^|\\.)"+d.map(m.slice(0).sort(),u).join("\\.(?:.*\\.)?")+"(\\.|$)")),p=t[h];if(!p)continue;if(!e){for(j=0;j=0&&(a.type=f=f.slice(0,-1),a.exclusive=!0),e||(a.stopPropagation(),d.event.global[f]&&d.each(d.cache,function(){var b=d.expando,e=this[b];e&&e.events&&e.events[f]&&d.event.trigger(a,c,e.handle.elem)}));if(!e||e.nodeType===3||e.nodeType===8)return b;a.result=b,a.target=e,c=d.makeArray(c),c.unshift(a)}a.currentTarget=e;var h=d._data(e,"handle");h&&h.apply(e,c);var i=e.parentNode||e.ownerDocument;try{e&&e.nodeName&&d.noData[e.nodeName.toLowerCase()]||e["on"+f]&&e["on"+f].apply(e,c)===!1&&(a.result=!1,a.preventDefault())}catch(j){}if(!a.isPropagationStopped()&&i)d.event.trigger(a,c,i,!0);else if(!a.isDefaultPrevented()){var k,l=a.target,m=f.replace(p,""),n=d.nodeName(l,"a")&&m==="click",o=d.event.special[m]||{};if((!o._default||o._default.call(e,a)===!1)&&!n&&!(l&&l.nodeName&&d.noData[l.nodeName.toLowerCase()])){try{l[m]&&(k=l["on"+m],k&&(l["on"+m]=null),d.event.triggered=!0,l[m]())}catch(q){}k&&(l["on"+m]=k),d.event.triggered=!1}}},handle:function(c){var e,f,g,h,i,j=[],k=d.makeArray(arguments);c=k[0]=d.event.fix(c||a.event),c.currentTarget=this,e=c.type.indexOf(".")<0&&!c.exclusive,e||(g=c.type.split("."),c.type=g.shift(),j=g.slice(0).sort(),h=new RegExp("(^|\\.)"+j.join("\\.(?:.*\\.)?")+"(\\.|$)")),c.namespace=c.namespace||j.join("."),i=d._data(this,"events"),f=(i||{})[c.type];if(i&&f){f=f.slice(0);for(var l=0,m=f.length;l-1?d.map(a.options,function(a){return a.selected}).join("-"):"":a.nodeName.toLowerCase()==="select"&&(c=a.selectedIndex);return c},B=function B(a){var c=a.target,e,f;if(q.test(c.nodeName)&&!c.readOnly){e=d._data(c,"_change_data"),f=A(c),(a.type!=="focusout"||c.type!=="radio")&&d._data(c,"_change_data",f);if(e===b||f===e)return;if(e!=null||f)a.type="change",a.liveFired=b,d.event.trigger(a,arguments[1],c)}};d.event.special.change={filters:{focusout:B,beforedeactivate:B,click:function(a){var b=a.target,c=b.type;(c==="radio"||c==="checkbox"||b.nodeName.toLowerCase()==="select")&&B.call(this,a)},keydown:function(a){var b=a.target,c=b.type;(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(c==="checkbox"||c==="radio")||c==="select-multiple")&&B.call(this,a)},beforeactivate:function(a){var b=a.target;d._data(b,"_change_data",A(b))}},setup:function(a,b){if(this.type==="file")return!1;for(var c in z)d.event.add(this,c+".specialChange",z[c]);return q.test(this.nodeName)},teardown:function(a){d.event.remove(this,".specialChange");return q.test(this.nodeName)}},z=d.event.special.change.filters,z.focus=z.beforeactivate}c.addEventListener&&d.each({focus:"focusin",blur:"focusout"},function(a,b){function c(a){a=d.event.fix(a),a.type=b;return d.event.handle.call(this,a)}d.event.special[b]={setup:function(){this.addEventListener(a,c,!0)},teardown:function(){this.removeEventListener(a,c,!0)}}}),d.each(["bind","one"],function(a,c){d.fn[c]=function(a,e,f){if(typeof a==="object"){for(var g in a)this[c](g,e,a[g],f);return this}if(d.isFunction(e)||e===!1)f=e,e=b;var h=c==="one"?d.proxy(f,function(a){d(this).unbind(a,h);return f.apply(this,arguments)}):f;if(a==="unload"&&c!=="one")this.one(a,e,f);else for(var i=0,j=this.length;i0?this.bind(b,a,c):this.trigger(b)},d.attrFn&&(d.attrFn[b]=!0)}),function(){function u(a,b,c,d,e,f){for(var g=0,h=d.length;g0){j=i;break}}i=i[a]}d[g]=j}}}function t(a,b,c,d,e,f){for(var g=0,h=d.length;g+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,e=0,f=Object.prototype.toString,g=!1,h=!0,i=/\\/g,j=/\W/;[0,0].sort(function(){h=!1;return 0});var k=function(b,d,e,g){e=e||[],d=d||c;var h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof b!=="string")return e;var i,j,n,o,q,r,s,t,u=!0,w=k.isXML(d),x=[],y=b;do{a.exec(""),i=a.exec(y);if(i){y=i[3],x.push(i[1]);if(i[2]){o=i[3];break}}}while(i);if(x.length>1&&m.exec(b))if(x.length===2&&l.relative[x[0]])j=v(x[0]+x[1],d);else{j=l.relative[x[0]]?[d]:k(x.shift(),d);while(x.length)b=x.shift(),l.relative[b]&&(b+=x.shift()),j=v(b,j)}else{!g&&x.length>1&&d.nodeType===9&&!w&&l.match.ID.test(x[0])&&!l.match.ID.test(x[x.length-1])&&(q=k.find(x.shift(),d,w),d=q.expr?k.filter(q.expr,q.set)[0]:q.set[0]);if(d){q=g?{expr:x.pop(),set:p(g)}:k.find(x.pop(),x.length===1&&(x[0]==="~"||x[0]==="+")&&d.parentNode?d.parentNode:d,w),j=q.expr?k.filter(q.expr,q.set):q.set,x.length>0?n=p(j):u=!1;while(x.length)r=x.pop(),s=r,l.relative[r]?s=x.pop():r="",s==null&&(s=d),l.relative[r](n,s,w)}else n=x=[]}n||(n=j),n||k.error(r||b);if(f.call(n)==="[object Array]")if(u)if(d&&d.nodeType===1)for(t=0;n[t]!=null;t++)n[t]&&(n[t]===!0||n[t].nodeType===1&&k.contains(d,n[t]))&&e.push(j[t]);else for(t=0;n[t]!=null;t++)n[t]&&n[t].nodeType===1&&e.push(j[t]);else e.push.apply(e,n);else p(n,e);o&&(k(o,h,e,g),k.uniqueSort(e));return e};k.uniqueSort=function(a){if(r){g=h,a.sort(r);if(g)for(var b=1;b0},k.find=function(a,b,c){var d;if(!a)return[];for(var e=0,f=l.order.length;e":function(a,b){var c,d=typeof b==="string",e=0,f=a.length;if(d&&!j.test(b)){b=b.toLowerCase();for(;e=0)?c||d.push(h):c&&(b[g]=!1));return!1},ID:function(a){return a[1].replace(i,"")},TAG:function(a,b){return a[1].replace(i,"").toLowerCase()},CHILD:function(a){if(a[1]==="nth"){a[2]||k.error(a[0]),a[2]=a[2].replace(/^\+|\s*/g,"");var b=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(a[2]==="even"&&"2n"||a[2]==="odd"&&"2n+1"||!/\D/.test(a[2])&&"0n+"+a[2]||a[2]);a[2]=b[1]+(b[2]||1)-0,a[3]=b[3]-0}else a[2]&&k.error(a[0]);a[0]=e++;return a},ATTR:function(a,b,c,d,e,f){var g=a[1]=a[1].replace(i,"");!f&&l.attrMap[g]&&(a[1]=l.attrMap[g]),a[4]=(a[4]||a[5]||"").replace(i,""),a[2]==="~="&&(a[4]=" "+a[4]+" ");return a},PSEUDO:function(b,c,d,e,f){if(b[1]==="not")if((a.exec(b[3])||"").length>1||/^\w/.test(b[3]))b[3]=k(b[3],null,null,c);else{var g=k.filter(b[3],c,d,!0^f);d||e.push.apply(e,g);return!1}else if(l.match.POS.test(b[0])||l.match.CHILD.test(b[0]))return!0;return b},POS:function(a){a.unshift(!0);return a}},filters:{enabled:function(a){return a.disabled===!1&&a.type!=="hidden"},disabled:function(a){return a.disabled===!0},checked:function(a){return a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!k(c[3],a).length},header:function(a){return/h\d/i.test(a.nodeName)},text:function(a){return"text"===a.getAttribute("type")},radio:function(a){return"radio"===a.type},checkbox:function(a){return"checkbox"===a.type},file:function(a){return"file"===a.type},password:function(a){return"password"===a.type},submit:function(a){return"submit"===a.type},image:function(a){return"image"===a.type},reset:function(a){return"reset"===a.type},button:function(a){return"button"===a.type||a.nodeName.toLowerCase()==="button"},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)}},setFilters:{first:function(a,b){return b===0},last:function(a,b,c,d){return b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return b%2===1},lt:function(a,b,c){return bc[3]-0},nth:function(a,b,c){return c[3]-0===b},eq:function(a,b,c){return c[3]-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b[1],f=l.filters[e];if(f)return f(a,c,b,d);if(e==="contains")return(a.textContent||a.innerText||k.getText([a])||"").indexOf(b[3])>=0;if(e==="not"){var g=b[3];for(var h=0,i=g.length;h=0}},ID:function(a,b){return a.nodeType===1&&a.getAttribute("id")===b},TAG:function(a,b){return b==="*"&&a.nodeType===1||a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(" "+(a.className||a.getAttribute("class"))+" ").indexOf(b)>-1},ATTR:function(a,b){var c=b[1],d=l.attrHandle[c]?l.attrHandle[c](a):a[c]!=null?a[c]:a.getAttribute(c),e=d+"",f=b[2],g=b[4];return d==null?f==="!=":f==="="?e===g:f==="*="?e.indexOf(g)>=0:f==="~="?(" "+e+" ").indexOf(g)>=0:g?f==="!="?e!==g:f==="^="?e.indexOf(g)===0:f==="$="?e.substr(e.length-g.length)===g:f==="|="?e===g||e.substr(0,g.length+1)===g+"-":!1:e&&d!==!1},POS:function(a,b,c,d){var e=b[2],f=l.setFilters[e];if(f)return f(a,c,b,d)}}},m=l.match.POS,n=function(a,b){return"\\"+(b-0+1)};for(var o in l.match)l.match[o]=new RegExp(l.match[o].source+/(?![^\[]*\])(?![^\(]*\))/.source),l.leftMatch[o]=new RegExp(/(^(?:.|\r|\n)*?)/.source+l.match[o].source.replace(/\\(\d+)/g,n));var p=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0)[0].nodeType}catch(q){p=function(a,b){var c=0,d=b||[];if(f.call(a)==="[object Array]")Array.prototype.push.apply(d,a);else if(typeof a.length==="number")for(var e=a.length;c",e.insertBefore(a,e.firstChild),c.getElementById(d)&&(l.find.ID=function(a,c,d){if(typeof c.getElementById!=="undefined"&&!d){var e=c.getElementById(a[1]);return e?e.id===a[1]||typeof e.getAttributeNode!=="undefined"&&e.getAttributeNode("id").nodeValue===a[1]?[e]:b:[]}},l.filter.ID=function(a,b){var c=typeof a.getAttributeNode!=="undefined"&&a.getAttributeNode("id");return a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var a=c.createElement("div");a.appendChild(c.createComment("")),a.getElementsByTagName("*").length>0&&(l.find.TAG=function(a,b){var c=b.getElementsByTagName(a[1]);if(a[1]==="*"){var d=[];for(var e=0;c[e];e++)c[e].nodeType===1&&d.push(c[e]);c=d}return c}),a.innerHTML="",a.firstChild&&typeof a.firstChild.getAttribute!=="undefined"&&a.firstChild.getAttribute("href")!=="#"&&(l.attrHandle.href=function(a){return a.getAttribute("href",2)}),a=null}(),c.querySelectorAll&&function(){var a=k,b=c.createElement("div"),d="__sizzle__";b.innerHTML="

";if(!b.querySelectorAll||b.querySelectorAll(".TEST").length!==0){k=function(b,e,f,g){e=e||c;if(!g&&!k.isXML(e)){var h=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h[1])return p(e.getElementsByTagName(b),f);if(h[2]&&l.find.CLASS&&e.getElementsByClassName)return p(e.getElementsByClassName(h[2]),f)}if(e.nodeType===9){if(b==="body"&&e.body)return p([e.body],f);if(h&&h[3]){var i=e.getElementById(h[3]);if(!i||!i.parentNode)return p([],f);if(i.id===h[3])return p([i],f)}try{return p(e.querySelectorAll(b),f)}catch(j){}}else if(e.nodeType===1&&e.nodeName.toLowerCase()!=="object"){var m=e,n=e.getAttribute("id"),o=n||d,q=e.parentNode,r=/^\s*[+~]/.test(b);n?o=o.replace(/'/g,"\\$&"):e.setAttribute("id",o),r&&q&&(e=e.parentNode);try{if(!r||q)return p(e.querySelectorAll("[id='"+o+"'] "+b),f)}catch(s){}finally{n||m.removeAttribute("id")}}}return a(b,e,f,g)};for(var e in a)k[e]=a[e];b=null}}(),function(){var a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector,d=!1;try{b.call(c.documentElement,"[test!='']:sizzle")}catch(e){d=!0}b&&(k.matchesSelector=function(a,c){c=c.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!k.isXML(a))try{if(d||!l.match.PSEUDO.test(c)&&!/!=/.test(c))return b.call(a,c)}catch(e){}return k(c,null,null,[a]).length>0})}(),function(){var a=c.createElement("div");a.innerHTML="
";if(a.getElementsByClassName&&a.getElementsByClassName("e").length!==0){a.lastChild.className="e";if(a.getElementsByClassName("e").length===1)return;l.order.splice(1,0,"CLASS"),l.find.CLASS=function(a,b,c){if(typeof b.getElementsByClassName!=="undefined"&&!c)return b.getElementsByClassName(a[1])},a=null}}(),c.documentElement.contains?k.contains=function(a,b){return a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?k.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:k.contains=function(){return!1},k.isXML=function(a){var b=(a?a.ownerDocument||a:0).documentElement;return b?b.nodeName!=="HTML":!1};var v=function(a,b){var c,d=[],e="",f=b.nodeType?[b]:b;while(c=l.match.PSEUDO.exec(a))e+=c[0],a=a.replace(l.match.PSEUDO,"");a=l.relative[a]?a+"*":a;for(var g=0,h=f.length;g0)for(var g=c;g0},closest:function(a,b){var c=[],e,f,g=this[0];if(d.isArray(a)){var h,i,j={},k=1;if(g&&a.length){for(e=0,f=a.length;e-1:d(g).is(h))&&c.push({selector:i,elem:g,level:k});g=g.parentNode,k++}}return c}var l=L.test(a)?d(a,b||this.context):null;for(e=0,f=this.length;e-1:d.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b)break}}c=c.length>1?d.unique(c):c;return this.pushStack(c,"closest",a)},index:function(a){if(!a||typeof a==="string")return d.inArray(this[0],a?d(a):this.parent().children());return d.inArray(a.jquery?a[0]:a,this)},add:function(a,b){var c=typeof a==="string"?d(a,b):d.makeArray(a),e=d.merge(this.get(),c);return this.pushStack(N(c[0])||N(e[0])?e:d.unique(e))},andSelf:function(){return this.add(this.prevObject)}}),d.each({parent:function(a){var b=a.parentNode;return b&&b.nodeType!==11?b:null},parents:function(a){return d.dir(a,"parentNode")},parentsUntil:function(a,b,c){return d.dir(a,"parentNode",c)},next:function(a){return d.nth(a,2,"nextSibling")},prev:function(a){return d.nth(a,2,"previousSibling")},nextAll:function(a){return d.dir(a,"nextSibling")},prevAll:function(a){return d.dir(a,"previousSibling")},nextUntil:function(a,b,c){return d.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return d.dir(a,"previousSibling",c)},siblings:function(a){return d.sibling(a.parentNode.firstChild,a)},children:function(a){return d.sibling(a.firstChild)},contents:function(a){return d.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:d.makeArray(a.childNodes)}},function(a,b){d.fn[a]=function(c,e){var f=d.map(this,b,c),g=K.call(arguments);G.test(a)||(e=c),e&&typeof e==="string"&&(f=d.filter(e,f)),f=this.length>1&&!M[a]?d.unique(f):f,(this.length>1||I.test(e))&&H.test(a)&&(f=f.reverse());return this.pushStack(f,a,g.join(","))}}),d.extend({filter:function(a,b,c){c&&(a=":not("+a+")");return b.length===1?d.find.matchesSelector(b[0],a)?[b[0]]:[]:d.find.matches(a,b)},dir:function(a,c,e){var f=[],g=a[c];while(g&&g.nodeType!==9&&(e===b||g.nodeType!==1||!d(g).is(e)))g.nodeType===1&&f.push(g),g=g[c];return f},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a[c])if(a.nodeType===1&&++e===b)break;return a},sibling:function(a,b){var c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return c}});var P=/ jQuery\d+="(?:\d+|null)"/g,Q=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,S=/<([\w:]+)/,T=/",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};X.optgroup=X.option,X.tbody=X.tfoot=X.colgroup=X.caption=X.thead,X.th=X.td,d.support.htmlSerialize||(X._default=[1,"div
","
"]),d.fn.extend({text:function(a){if(d.isFunction(a))return this.each(function(b){var c=d(this);c.text(a.call(this,b,c.text()))});if(typeof a!=="object"&&a!==b)return this.empty().append((this[0]&&this[0].ownerDocument||c).createTextNode(a));return d.text(this)},wrapAll:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapAll(a.call(this,b))});if(this[0]){var b=d(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapInner(a.call(this,b))});return this.each(function(){var b=d(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){d(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){d.nodeName(this,"body")||d(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=d(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,d(arguments[0]).toArray());return a}},remove:function(a,b){for(var c=0,e;(e=this[c])!=null;c++)if(!a||d.filter(a,[e]).length)!b&&e.nodeType===1&&(d.cleanData(e.getElementsByTagName("*")),d.cleanData([e])),e.parentNode&&e.parentNode.removeChild(e);return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++){b.nodeType===1&&d.cleanData(b.getElementsByTagName("*"));while(b.firstChild)b.removeChild(b.firstChild)}return this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return this.map(function(){return d.clone(this,a,b)})},html:function(a){if(a===b)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(P,""):null;if(typeof a!=="string"||V.test(a)||!d.support.leadingWhitespace&&Q.test(a)||X[(S.exec(a)||["",""])[1].toLowerCase()])d.isFunction(a)?this.each(function(b){var c=d(this);c.html(a.call(this,b,c.html()))}):this.empty().append(a);else{a=a.replace(R,"<$1>");try{for(var c=0,e=this.length;c1&&l0?this.clone(!0):this).get();d(f[h])[b](j),e=e.concat(j)}return this.pushStack(e,a,f.selector)}}),d.extend({clone:function(a,b,c){var e=a.cloneNode(!0),f,g,h;if((!d.support.noCloneEvent||!d.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!d.isXMLDoc(a)){$(a,e),f=_(a),g=_(e);for(h=0;f[h];++h)$(f[h],g[h])}if(b){Z(a,e);if(c){f=_(a),g=_(e);for(h=0;f[h];++h)Z(f[h],g[h])}}return e},clean:function(a,b,e,f){b=b||c,typeof b.createElement==="undefined"&&(b=b.ownerDocument||b[0]&&b[0].ownerDocument||c);var g=[];for(var h=0,i;(i=a[h])!=null;h++){typeof i==="number"&&(i+="");if(!i)continue;if(typeof i!=="string"||U.test(i)){if(typeof i==="string"){i=i.replace(R,"<$1>");var j=(S.exec(i)||["",""])[1].toLowerCase(),k=X[j]||X._default,l=k[0],m=b.createElement("div");m.innerHTML=k[1]+i+k[2];while(l--)m=m.lastChild;if(!d.support.tbody){var n=T.test(i),o=j==="table"&&!n?m.firstChild&&m.firstChild.childNodes:k[1]===""&&!n?m.childNodes:[];for(var p=o.length-1;p>=0;--p)d.nodeName(o[p],"tbody")&&!o[p].childNodes.length&&o[p].parentNode.removeChild(o[p])}!d.support.leadingWhitespace&&Q.test(i)&&m.insertBefore(b.createTextNode(Q.exec(i)[0]),m.firstChild),i=m.childNodes}}else i=b.createTextNode(i);i.nodeType?g.push(i):g=d.merge(g,i)}if(e)for(h=0;g[h];h++)!f||!d.nodeName(g[h],"script")||g[h].type&&g[h].type.toLowerCase()!=="text/javascript"?(g[h].nodeType===1&&g.splice.apply(g,[h+1,0].concat(d.makeArray(g[h].getElementsByTagName("script")))),e.appendChild(g[h])):f.push(g[h].parentNode?g[h].parentNode.removeChild(g[h]):g[h]);return g},cleanData:function(a){var b,c,e=d.cache,f=d.expando,g=d.event.special,h=d.support.deleteExpando;for(var i=0,j;(j=a[i])!=null;i++){if(j.nodeName&&d.noData[j.nodeName.toLowerCase()])continue;c=j[d.expando];if(c){b=e[c]&&e[c][f];if(b&&b.events){for(var k in b.events)g[k]?d.event.remove(j,k):d.removeEvent(j,k,b.handle);b.handle&&(b.handle.elem=null)}h?delete j[d.expando]:j.removeAttribute&&j.removeAttribute(d.expando),delete e[c]}}}});var bb=/alpha\([^)]*\)/i,bc=/opacity=([^)]*)/,bd=/-([a-z])/ig,be=/([A-Z])/g,bf=/^-?\d+(?:px)?$/i,bg=/^-?\d/,bh={position:"absolute",visibility:"hidden",display:"block"},bi=["Left","Right"],bj=["Top","Bottom"],bk,bl,bm,bn=function(a,b){return b.toUpperCase()};d.fn.css=function(a,c){if(arguments.length===2&&c===b)return this;return d.access(this,a,c,!0,function(a,c,e){return e!==b?d.style(a,c,e):d.css(a,c)})},d.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=bk(a,"opacity","opacity");return c===""?"1":c}return a.style.opacity}}},cssNumber:{zIndex:!0,fontWeight:!0,opacity:!0,zoom:!0,lineHeight:!0},cssProps:{"float":d.support.cssFloat?"cssFloat":"styleFloat"},style:function(a,c,e,f){if(a&&a.nodeType!==3&&a.nodeType!==8&&a.style){var g,h=d.camelCase(c),i=a.style,j=d.cssHooks[h];c=d.cssProps[h]||h;if(e===b){if(j&&"get"in j&&(g=j.get(a,!1,f))!==b)return g;return i[c]}if(typeof e==="number"&&isNaN(e)||e==null)return;typeof e==="number"&&!d.cssNumber[h]&&(e+="px");if(!j||!("set"in j)||(e=j.set(a,e))!==b)try{i[c]=e}catch(k){}}},css:function(a,c,e){var f,g=d.camelCase(c),h=d.cssHooks[g];c=d.cssProps[g]||g;if(h&&"get"in h&&(f=h.get(a,!0,e))!==b)return f;if(bk)return bk(a,c,g)},swap:function(a,b,c){var d={};for(var e in b)d[e]=a.style[e],a.style[e]=b[e];c.call(a);for(e in b)a.style[e]=d[e]},camelCase:function(a){return a.replace(bd,bn)}}),d.curCSS=d.css,d.each(["height","width"],function(a,b){d.cssHooks[b]={get:function(a,c,e){var f;if(c){a.offsetWidth!==0?f=bo(a,b,e):d.swap(a,bh,function(){f=bo(a,b,e)});if(f<=0){f=bk(a,b,b),f==="0px"&&bm&&(f=bm(a,b,b));if(f!=null)return f===""||f==="auto"?"0px":f}if(f<0||f==null){f=a.style[b];return f===""||f==="auto"?"0px":f}return typeof f==="string"?f:f+"px"}},set:function(a,b){if(!bf.test(b))return b;b=parseFloat(b);if(b>=0)return b+"px"}}}),d.support.opacity||(d.cssHooks.opacity={get:function(a,b){return bc.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?parseFloat(RegExp.$1)/100+"":b?"1":""},set:function(a,b){var c=a.style;c.zoom=1;var e=d.isNaN(b)?"":"alpha(opacity="+b*100+")",f=c.filter||"";c.filter=bb.test(f)?f.replace(bb,e):c.filter+" "+e}}),c.defaultView&&c.defaultView.getComputedStyle&&(bl=function(a,c,e){var f,g,h;e=e.replace(be,"-$1").toLowerCase();if(!(g=a.ownerDocument.defaultView))return b;if(h=g.getComputedStyle(a,null))f=h.getPropertyValue(e),f===""&&!d.contains(a.ownerDocument.documentElement,a)&&(f=d.style(a,e));return f}),c.documentElement.currentStyle&&(bm=function(a,b){var c,d=a.currentStyle&&a.currentStyle[b],e=a.runtimeStyle&&a.runtimeStyle[b],f=a.style;!bf.test(d)&&bg.test(d)&&(c=f.left,e&&(a.runtimeStyle.left=a.currentStyle.left),f.left=b==="fontSize"?"1em":d||0,d=f.pixelLeft+"px",f.left=c,e&&(a.runtimeStyle.left=e));return d===""?"auto":d}),bk=bl||bm,d.expr&&d.expr.filters&&(d.expr.filters.hidden=function(a){var b=a.offsetWidth,c=a.offsetHeight;return b===0&&c===0||!d.support.reliableHiddenOffsets&&(a.style.display||d.css(a,"display"))==="none"},d.expr.filters.visible=function(a){return!d.expr.filters.hidden(a)});var bp=/%20/g,bq=/\[\]$/,br=/\r?\n/g,bs=/#.*$/,bt=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,bu=/^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bv=/(?:^file|^widget|\-extension):$/,bw=/^(?:GET|HEAD)$/,bx=/^\/\//,by=/\?/,bz=/)<[^<]*)*<\/script>/gi,bA=/^(?:select|textarea)/i,bB=/\s+/,bC=/([?&])_=[^&]*/,bD=/(^|\-)([a-z])/g,bE=function(a,b,c){return b+c.toUpperCase()},bF=/^([\w\+\.\-]+:)\/\/([^\/?#:]*)(?::(\d+))?/,bG=d.fn.load,bH={},bI={},bJ,bK;try{bJ=c.location.href}catch(bL){bJ=c.createElement("a"),bJ.href="",bJ=bJ.href}bK=bF.exec(bJ.toLowerCase()),d.fn.extend({load:function(a,c,e){if(typeof a!=="string"&&bG)return bG.apply(this,arguments);if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var g=a.slice(f,a.length);a=a.slice(0,f)}var h="GET";c&&(d.isFunction(c)?(e=c,c=b):typeof c==="object"&&(c=d.param(c,d.ajaxSettings.traditional),h="POST"));var i=this;d.ajax({url:a,type:h,dataType:"html",data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?d("
").append(c.replace(bz,"")).find(g):c)),e&&i.each(e,[c,b,a])}});return this},serialize:function(){return d.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?d.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||bA.test(this.nodeName)||bu.test(this.type))}).map(function(a,b){var c=d(this).val();return c==null?null:d.isArray(c)?d.map(c,function(a,c){return{name:b.name,value:a.replace(br,"\r\n")}}):{name:b.name,value:c.replace(br,"\r\n")}}).get()}}),d.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){d.fn[b]=function(a){return this.bind(b,a)}}),d.each(["get","post"],function(a,c){d[c]=function(a,e,f,g){d.isFunction(e)&&(g=g||f,f=e,e=b);return d.ajax({type:c,url:a,data:e,success:f,dataType:g})}}),d.extend({getScript:function(a,c){return d.get(a,b,c,"script")},getJSON:function(a,b,c){return d.get(a,b,c,"json")},ajaxSetup:function(a,b){b?d.extend(!0,a,d.ajaxSettings,b):(b=a,a=d.extend(!0,d.ajaxSettings,b));for(var c in {context:1,url:1})c in b?a[c]=b[c]:c in d.ajaxSettings&&(a[c]=d.ajaxSettings[c]);return a},ajaxSettings:{url:bJ,isLocal:bv.test(bK[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":"*/*"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":d.parseJSON,"text xml":d.parseXML}},ajaxPrefilter:bM(bH),ajaxTransport:bM(bI),ajax:function(a,c){function v(a,c,l,n){if(r!==2){r=2,p&&clearTimeout(p),o=b,m=n||"",u.readyState=a?4:0;var q,t,v,w=l?bP(e,u,l):b,x,y;if(a>=200&&a<300||a===304){if(e.ifModified){if(x=u.getResponseHeader("Last-Modified"))d.lastModified[k]=x;if(y=u.getResponseHeader("Etag"))d.etag[k]=y}if(a===304)c="notmodified",q=!0;else try{t=bQ(e,w),c="success",q=!0}catch(z){c="parsererror",v=z}}else{v=c;if(!c||a)c="error",a<0&&(a=0)}u.status=a,u.statusText=c,q?h.resolveWith(f,[t,c,u]):h.rejectWith(f,[u,c,v]),u.statusCode(j),j=b,s&&g.trigger("ajax"+(q?"Success":"Error"),[u,e,q?t:v]),i.resolveWith(f,[u,c]),s&&(g.trigger("ajaxComplete",[u,e]),--d.active||d.event.trigger("ajaxStop"))}}typeof a==="object"&&(c=a,a=b),c=c||{};var e=d.ajaxSetup({},c),f=e.context||e,g=f!==e&&(f.nodeType||f instanceof d)?d(f):d.event,h=d.Deferred(),i=d._Deferred(),j=e.statusCode||{},k,l={},m,n,o,p,q,r=0,s,t,u={readyState:0,setRequestHeader:function(a,b){r||(l[a.toLowerCase().replace(bD,bE)]=b);return this},getAllResponseHeaders:function(){return r===2?m:null},getResponseHeader:function(a){var c;if(r===2){if(!n){n={};while(c=bt.exec(m))n[c[1].toLowerCase()]=c[2]}c=n[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){r||(e.mimeType=a);return this},abort:function(a){a=a||"abort",o&&o.abort(a),v(0,a);return this}};h.promise(u),u.success=u.done,u.error=u.fail,u.complete=i.done,u.statusCode=function(a){if(a){var b;if(r<2)for(b in a)j[b]=[j[b],a[b]];else b=a[u.status],u.then(b,b)}return this},e.url=((a||e.url)+"").replace(bs,"").replace(bx,bK[1]+"//"),e.dataTypes=d.trim(e.dataType||"*").toLowerCase().split(bB),e.crossDomain||(q=bF.exec(e.url.toLowerCase()),e.crossDomain=q&&(q[1]!=bK[1]||q[2]!=bK[2]||(q[3]||(q[1]==="http:"?80:443))!=(bK[3]||(bK[1]==="http:"?80:443)))),e.data&&e.processData&&typeof e.data!=="string"&&(e.data=d.param(e.data,e.traditional)),bN(bH,e,c,u);if(r===2)return!1;s=e.global,e.type=e.type.toUpperCase(),e.hasContent=!bw.test(e.type),s&&d.active++===0&&d.event.trigger("ajaxStart");if(!e.hasContent){e.data&&(e.url+=(by.test(e.url)?"&":"?")+e.data),k=e.url;if(e.cache===!1){var w=d.now(),x=e.url.replace(bC,"$1_="+w);e.url=x+(x===e.url?(by.test(e.url)?"&":"?")+"_="+w:"")}}if(e.data&&e.hasContent&&e.contentType!==!1||c.contentType)l["Content-Type"]=e.contentType;e.ifModified&&(k=k||e.url,d.lastModified[k]&&(l["If-Modified-Since"]=d.lastModified[k]),d.etag[k]&&(l["If-None-Match"]=d.etag[k])),l.Accept=e.dataTypes[0]&&e.accepts[e.dataTypes[0]]?e.accepts[e.dataTypes[0]]+(e.dataTypes[0]!=="*"?", */*; q=0.01":""):e.accepts["*"];for(t in e.headers)u.setRequestHeader(t,e.headers[t]);if(e.beforeSend&&(e.beforeSend.call(f,u,e)===!1||r===2)){u.abort();return!1}for(t in {success:1,error:1,complete:1})u[t](e[t]);o=bN(bI,e,c,u);if(o){u.readyState=1,s&&g.trigger("ajaxSend",[u,e]),e.async&&e.timeout>0&&(p=setTimeout(function(){u.abort("timeout")},e.timeout));try{r=1,o.send(l,v)}catch(y){status<2?v(-1,y):d.error(y)}}else v(-1,"No Transport");return u},param:function(a,c){var e=[],f=function(a,b){b=d.isFunction(b)?b():b,e[e.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=d.ajaxSettings.traditional);if(d.isArray(a)||a.jquery&&!d.isPlainObject(a))d.each(a,function(){f(this.name,this.value)});else for(var g in a)bO(g,a[g],c,f);return e.join("&").replace(bp,"+")}}),d.extend({active:0,lastModified:{},etag:{}});var bR=d.now(),bS=/(\=)\?(&|$)|()\?\?()/i;d.ajaxSetup({jsonp:"callback",jsonpCallback:function(){return d.expando+"_"+bR++}}),d.ajaxPrefilter("json jsonp",function(b,c,e){var f=typeof b.data==="string";if(b.dataTypes[0]==="jsonp"||c.jsonpCallback||c.jsonp!=null||b.jsonp!==!1&&(bS.test(b.url)||f&&bS.test(b.data))){var g,h=b.jsonpCallback=d.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a[h],j=b.url,k=b.data,l="$1"+h+"$2",m=function(){a[h]=i,g&&d.isFunction(i)&&a[h](g[0])};b.jsonp!==!1&&(j=j.replace(bS,l),b.url===j&&(f&&(k=k.replace(bS,l)),b.data===k&&(j+=(/\?/.test(j)?"&":"?")+b.jsonp+"="+h))),b.url=j,b.data=k,a[h]=function(a){g=[a]},e.then(m,m),b.converters["script json"]=function(){g||d.error(h+" was not called");return g[0]},b.dataTypes[0]="json";return"script"}}),d.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){d.globalEval(a);return a}}}),d.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),d.ajaxTransport("script",function(a){if(a.crossDomain){var d,e=c.head||c.getElementsByTagName("head")[0]||c.documentElement;return{send:function(f,g){d=c.createElement("script"),d.async="async",a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,"success")},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var bT=d.now(),bU,bV;d.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&bX()||bY()}:bX,bV=d.ajaxSettings.xhr(),d.support.ajax=!!bV,d.support.cors=bV&&"withCredentials"in bV,bV=b,d.support.ajax&&d.ajaxTransport(function(a){if(!a.crossDomain||d.support.cors){var c;return{send:function(e,f){var g=a.xhr(),h,i;a.username?g.open(a.type,a.url,a.async,a.username,a.password):g.open(a.type,a.url,a.async);if(a.xhrFields)for(i in a.xhrFields)g[i]=a.xhrFields[i];a.mimeType&&g.overrideMimeType&&g.overrideMimeType(a.mimeType),(!a.crossDomain||a.hasContent)&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(i in e)g.setRequestHeader(i,e[i])}catch(j){}g.send(a.hasContent&&a.data||null),c=function(e,i){var j,k,l,m,n;try{if(c&&(i||g.readyState===4)){c=b,h&&(g.onreadystatechange=d.noop,delete bU[h]);if(i)g.readyState!==4&&g.abort();else{j=g.status,l=g.getAllResponseHeaders(),m={},n=g.responseXML,n&&n.documentElement&&(m.xml=n),m.text=g.responseText;try{k=g.statusText}catch(o){k=""}j||!a.isLocal||a.crossDomain?j===1223&&(j=204):j=m.text?200:404}}}catch(p){i||f(-1,p)}m&&f(j,k,m,l)},a.async&&g.readyState!==4?(bU||(bU={},bW()),h=bT++,g.onreadystatechange=bU[h]=c):c()},abort:function(){c&&c(0,1)}}}});var bZ={},b$=/^(?:toggle|show|hide)$/,b_=/^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,ca,cb=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];d.fn.extend({show:function(a,b,c){var e,f;if(a||a===0)return this.animate(cc("show",3),a,b,c);for(var g=0,h=this.length;g=0;a--)c[a].elem===this&&(b&&c[a](!0),c.splice(a,1))}),b||this.dequeue();return this}}),d.each({slideDown:cc("show",1),slideUp:cc("hide",1),slideToggle:cc("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){d.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),d.extend({speed:function(a,b,c){var e=a&&typeof a==="object"?d.extend({},a):{complete:c||!c&&b||d.isFunction(a)&&a,duration:a,easing:c&&b||b&&!d.isFunction(b)&&b};e.duration=d.fx.off?0:typeof e.duration==="number"?e.duration:e.duration in d.fx.speeds?d.fx.speeds[e.duration]:d.fx.speeds._default,e.old=e.complete,e.complete=function(){e.queue!==!1&&d(this).dequeue(),d.isFunction(e.old)&&e.old.call(this)};return e},easing:{linear:function(a,b,c,d){return c+d*a},swing:function(a,b,c,d){return(-Math.cos(a*Math.PI)/2+.5)*d+c}},timers:[],fx:function(a,b,c){this.options=b,this.elem=a,this.prop=c,b.orig||(b.orig={})}}),d.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this),(d.fx.step[this.prop]||d.fx.step._default)(this)},cur:function(){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];var a,b=d.css(this.elem,this.prop);return isNaN(a=parseFloat(b))?!b||b==="auto"?0:b:a},custom:function(a,b,c){function g(a){return e.step(a)}var e=this,f=d.fx;this.startTime=d.now(),this.start=a,this.end=b,this.unit=c||this.unit||(d.cssNumber[this.prop]?"":"px"),this.now=this.start,this.pos=this.state=0,g.elem=this.elem,g()&&d.timers.push(g)&&!ca&&(ca=setInterval(f.tick,f.interval))},show:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.show=!0,this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur()),d(this.elem).show()},hide:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.hide=!0,this.custom(this.cur(),0)},step:function(a){var b=d.now(),c=!0;if(a||b>=this.options.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),this.options.curAnim[this.prop]=!0;for(var e in this.options.curAnim)this.options.curAnim[e]!==!0&&(c=!1);if(c){if(this.options.overflow!=null&&!d.support.shrinkWrapBlocks){var f=this.elem,g=this.options;d.each(["","X","Y"],function(a,b){f.style["overflow"+b]=g.overflow[a]})}this.options.hide&&d(this.elem).hide();if(this.options.hide||this.options.show)for(var h in this.options.curAnim)d.style(this.elem,h,this.options.orig[h]);this.options.complete.call(this.elem)}return!1}var i=b-this.startTime;this.state=i/this.options.duration;var j=this.options.specialEasing&&this.options.specialEasing[this.prop],k=this.options.easing||(d.easing.swing?"swing":"linear");this.pos=d.easing[j||k](this.state,i,0,1,this.options.duration),this.now=this.start+(this.end-this.start)*this.pos,this.update();return!0}},d.extend(d.fx,{tick:function(){var a=d.timers;for(var b=0;b
";d.extend(b.style,{position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"}),b.innerHTML=j,a.insertBefore(b,a.firstChild),e=b.firstChild,f=e.firstChild,h=e.nextSibling.firstChild.firstChild,this.doesNotAddBorder=f.offsetTop!==5,this.doesAddBorderForTableAndCells=h.offsetTop===5,f.style.position="fixed",f.style.top="20px",this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15,f.style.position=f.style.top="",e.style.overflow="hidden",e.style.position="relative",this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5,this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==i,a.removeChild(b),a=b=e=f=g=h=null,d.offset.initialize=d.noop},bodyOffset:function(a){var b=a.offsetTop,c=a.offsetLeft;d.offset.initialize(),d.offset.doesNotIncludeMarginInBodyOffset&&(b+=parseFloat(d.css(a,"marginTop"))||0,c+=parseFloat(d.css(a,"marginLeft"))||0);return{top:b,left:c}},setOffset:function(a,b,c){var e=d.css(a,"position");e==="static"&&(a.style.position="relative");var f=d(a),g=f.offset(),h=d.css(a,"top"),i=d.css(a,"left"),j=e==="absolute"&&d.inArray("auto",[h,i])>-1,k={},l={},m,n;j&&(l=f.position()),m=j?l.top:parseInt(h,10)||0,n=j?l.left:parseInt(i,10)||0,d.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):f.css(k)}},d.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),e=cf.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(d.css(a,"marginTop"))||0,c.left-=parseFloat(d.css(a,"marginLeft"))||0,e.top+=parseFloat(d.css(b[0],"borderTopWidth"))||0,e.left+=parseFloat(d.css(b[0],"borderLeftWidth"))||0;return{top:c.top-e.top,left:c.left-e.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&(!cf.test(a.nodeName)&&d.css(a,"position")==="static"))a=a.offsetParent;return a})}}),d.each(["Left","Top"],function(a,c){var e="scroll"+c;d.fn[e]=function(c){var f=this[0],g;if(!f)return null;if(c!==b)return this.each(function(){g=cg(this),g?g.scrollTo(a?d(g).scrollLeft():c,a?c:d(g).scrollTop()):this[e]=c});g=cg(f);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:d.support.boxModel&&g.document.documentElement[e]||g.document.body[e]:f[e]}}),d.each(["Height","Width"],function(a,c){var e=c.toLowerCase();d.fn["inner"+c]=function(){return this[0]?parseFloat(d.css(this[0],e,"padding")):null},d.fn["outer"+c]=function(a){return this[0]?parseFloat(d.css(this[0],e,a?"margin":"border")):null},d.fn[e]=function(a){var f=this[0];if(!f)return a==null?null:this;if(d.isFunction(a))return this.each(function(b){var c=d(this);c[e](a.call(this,b,c[e]()))});if(d.isWindow(f)){var g=f.document.documentElement["client"+c];return f.document.compatMode==="CSS1Compat"&&g||f.document.body["client"+c]||g}if(f.nodeType===9)return Math.max(f.documentElement["client"+c],f.body["scroll"+c],f.documentElement["scroll"+c],f.body["offset"+c],f.documentElement["offset"+c]);if(a===b){var h=d.css(f,e),i=parseFloat(h);return d.isNaN(i)?h:i}return this.css(e,typeof a==="string"?a:a+"px")}}),a.jQuery=a.$=d})(window); \ No newline at end of file diff --git a/src/lib/simple-inheritance.js b/src/lib/simple-inheritance.js new file mode 100644 index 000000000..d62bd0bc5 --- /dev/null +++ b/src/lib/simple-inheritance.js @@ -0,0 +1,64 @@ +/* Simple JavaScript Inheritance +* By John Resig http://ejohn.org/ +* MIT Licensed. +*/ +// Inspired by base2 and Prototype +(function () { + var initializing = false, fnTest = /xyz/.test(function () { xyz; }) ? /\b_super\b/ : /.*/; + + // The base Class implementation (does nothing) + this.Class = function () { }; + + // Create a new Class that inherits from this class + Class.extend = function (prop) { + var _super = this.prototype; + + // Instantiate a base class (but only create the instance, + // don't run the init constructor) + initializing = true; + var prototype = new this(); + initializing = false; + + // Copy the properties over onto the new prototype + for (var name in prop) { + // Check if we're overwriting an existing function + prototype[name] = typeof prop[name] == "function" && + typeof _super[name] == "function" && fnTest.test(prop[name]) ? + (function (name, fn) { + return function () { + var tmp = this._super; + + // Add a new ._super() method that is the same method + // but on the super-class + this._super = _super[name]; + + // The method only need to be bound temporarily, so we + // remove it when we're done executing + var ret = fn.apply(this, arguments); + this._super = tmp; + + return ret; + }; + })(name, prop[name]) : + prop[name]; + } + + // The dummy class constructor + function Class() { + // All construction is actually done in the init method + if (!initializing && this.init) + this.init.apply(this, arguments); + } + + // Populate our constructed prototype object + Class.prototype = prototype; + + // Enforce the constructor to be what we expect + Class.constructor = Class; + + // And make this class extendable + Class.extend = arguments.callee; + + return Class; + }; +})(); \ No newline at end of file diff --git a/src/lib/simple-inheritance.txt b/src/lib/simple-inheritance.txt new file mode 100644 index 000000000..7bae15d97 --- /dev/null +++ b/src/lib/simple-inheritance.txt @@ -0,0 +1,4 @@ +/* Simple JavaScript Inheritance + * By John Resig http://ejohn.org/ + * MIT Licensed. + */ \ No newline at end of file diff --git a/src/photoswipe-icons.png b/src/photoswipe-icons.png new file mode 100644 index 000000000..687cd74bc Binary files /dev/null and b/src/photoswipe-icons.png differ diff --git a/src/photoswipe-loader.gif b/src/photoswipe-loader.gif new file mode 100644 index 000000000..c95d05a05 Binary files /dev/null and b/src/photoswipe-loader.gif differ diff --git a/src/photoswipe.css b/src/photoswipe.css new file mode 100644 index 000000000..0e3f012ae --- /dev/null +++ b/src/photoswipe.css @@ -0,0 +1,138 @@ +/* + * PhotoSwipe - http://www.photoswipe.com/ + * Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) + * Licensed under the MIT license + * + * Default styles for SwipeGallery + * Avoid any position or dimension based styles + * where possible, unless specified already here. + * The gallery automatically works out gallery item + * positions etc. + */ + +body.ps-active +{ + -webkit-text-size-adjust: none; +} +body.ps-active * +{ + -webkit-tap-highlight-color: rgba(255, 255, 255, 0); +} +body.ps-active *:focus +{ + outline: 0; +} + + +/* Document overlay */ +div.ps-document-overlay +{ + background: #000; +} + + +/* Viewport */ +div.ps-viewport +{ + background: #000; + cursor: pointer; +} + + +/* Slider */ +div.ps-slider-item-loading +{ + background: url(photoswipe-loader.gif) no-repeat center center; +} + + +/* Caption */ +div.ps-caption +{ + background: #000000; + background: -moz-linear-gradient(top, #303130 0%, #000101 100%); + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#303130), color-stop(100%,#000101)); + border-bottom: 1px solid #42403f; + color: #ffffff; + font-size: 13px; + font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; + text-align: center; +} + +div.ps-caption-bottom +{ + border-top: 1px solid #42403f; + border-bottom: none; +} + +div.ps-caption-content +{ + padding: 13px; +} + + +/* Toolbar */ +div.ps-toolbar +{ + background: #000000; + background: -moz-linear-gradient(top, #303130 0%, #000101 100%); + background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#303130), color-stop(100%,#000101)); + border-top: 1px solid #42403f; + color: #ffffff; + font-size: 13px; + font-family: "Lucida Grande", Helvetica, Arial,Verdana, sans-serif; + text-align: center; + height: 44px; + border-collapse: collapse; + display: table; + table-layout: fixed; +} + +div.ps-toolbar-top +{ + border-bottom: 1px solid #42403f; + border-top: none; +} + +div.ps-toolbar-close, div.ps-toolbar-previous, div.ps-toolbar-next, div.ps-toolbar-play +{ + cursor: pointer; + display: table-cell; +} + +div.ps-toolbar div div.ps-toolbar-content +{ + width: 44px; + height: 44px; + margin: 0 auto 0; +} + +div.ps-toolbar-close div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -44px 0; +} + +div.ps-toolbar-previous div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -132px 0; +} + +div.ps-toolbar-previous-disabled div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -132px -44px; +} + +div.ps-toolbar-next div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -176px 0; +} + +div.ps-toolbar-next-disabled div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -176px -44px; +} + +div.ps-toolbar-play div.ps-toolbar-content +{ + background: url(photoswipe-icons.png) no-repeat -88px 0; +} diff --git a/src/photoswipe.js b/src/photoswipe.js new file mode 100644 index 000000000..7e060466d --- /dev/null +++ b/src/photoswipe.js @@ -0,0 +1,935 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, ElementClass, DocumentOverlayClass, FullSizeImageClass, ViewportClass, SliderClass, CaptionClass, ToolbarClass){ + + var photoSwipe = Code.PhotoSwipe.EventClass.extend({ + + fullSizeImages: null, + + documentOverlay: null, + viewport: null, + slider: null, + caption: null, + toolbar: null, + + settings: null, + slideShowSettingsSaved: null, + currentIndex: null, + isBusy: null, + + slideshowTimeout: null, + + + documentOverlayFadeInEventHandler: null, + windowResizeEventHandler: null, + windowOrientationChangeEventHandler: null, + windowScrollEventHandler: null, + keyDownEventHandler: null, + viewportTouchEventHandler: null, + viewportFadeOutEventHandler: null, + sliderDisplayCurrentFullSizeImageEventHandler: null, + toolbarClickEventHandler: null, + + + /* + * Function: init + */ + init: function(){ + + this._super(); + + this.currentIndex = 0; + this.isBusy = false; + + this.settings = { + getImageSource: Code.PhotoSwipe.GetImageSource, + getImageCaption: Code.PhotoSwipe.GetImageCaption, + fadeSpeed: 400, + slideSpeed: 250, + swipeThreshold: 50, + loop: true, + + flipCaptionAndToolbar: false, + + captionDelay: 3000, + captionOpacity: 0.8, + hideCaption: false, + showEmptyCaptions: true, + + toolbarDelay: 3000, + toolbarOpacity: 0.8, + hideToolbar: false, + + slideshowDelay: 3000, + + imageScaleMethod: 'fit' // Either "fit" or "zoom" + }; + + // Set pointers to event handlers + this.documentOverlayFadeInEventHandler = this.onDocumentOverlayFadeIn.bind(this); + this.windowResizeEventHandler = this.onWindowResize.bind(this); + this.windowOrientationChangeEventHandler = this.onWindowOrientationChange.bind(this); + this.windowScrollEventHandler = this.onWindowScroll.bind(this); + this.keyDownEventHandler = this.onKeyDown.bind(this); + this.viewportTouchEventHandler = this.onViewportTouch.bind(this); + this.viewportFadeOutEventHandler = this.onViewportFadeOut.bind(this); + this.sliderDisplayCurrentFullSizeImageEventHandler = this.onSliderDisplayCurrentFullSizeImage.bind(this); + this.toolbarClickEventHandler = this.onToolbarClick.bind(this); + + }, + + + + /* + * Function: setOptions + */ + setOptions: function(options){ + + Util.extend(this.settings, options); + + }, + + + + /* + * Function: setImages + * Set images from DOM elements. Could be a list of image + * elments or anchors containing image elements etc. + * By default the gallery assumes the latter. If you change + * this, remember to set your own getImageSource and getImageCaption + * methods so the gallery knows what to look for. + */ + setImages: function(thumbEls){ + + if (!Util.isArray){ + throw "thumbEls is not an array"; + } + + this.currentIndex = 0; + + this.fullSizeImages = []; + + for (var i=0; i= this.fullSizeImages.length){ + startingIndex = 0; + } + + this.currentIndex = startingIndex; + + if (Util.isNothing(this.documentOverlay)){ + this.build(); + } + + // Fade in the document overlay, + // then show the viewport, slider and toolbar etc + this.documentOverlay.addEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.documentOverlay.fadeIn(); + + }, + + + + /* + * Function: build + */ + build: function(){ + + // Create the document overlay + this.documentOverlay = new DocumentOverlayClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed + }); + + // Create the viewport + this.viewport = new ViewportClass({ + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + swipeThreshold: this.settings.swipeThreshold + }); + + // Create the slider + this.slider = new SliderClass( + { + opacity: 1, + fadeSpeed: this.settings.fadeSpeed, + slideSpeed: this.settings.slideSpeed + }, + this.viewport.el + ); + + // Create the caption bar + this.caption = new CaptionClass({ + opacity: this.settings.captionOpacity, + fadeSpeed: this.settings.fadeSpeed, + captionDelay: this.settings.captionDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'bottom' : 'top' + }); + + + // Create the toolbar + this.toolbar = new ToolbarClass({ + opacity: this.settings.toolbarOpacity, + fadeSpeed: this.settings.fadeSpeed, + toolbarDelay: this.settings.toolbarDelay, + position: (this.settings.flipCaptionAndToolbar) ? 'top' : 'bottom' + }); + + }, + + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + // Set window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.addEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + Util.DOM.addEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.addEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Set keydown event handlers for desktop browsers + Util.DOM.addEventListener(document, 'keydown', this.keyDownEventHandler); + + // Set viewport handlers + this.viewport.addEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Set slider handlers + this.slider.addEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Set toolbar handlers + this.toolbar.addEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + // Remove window size handlers + if (!Util.isNothing(window.orientation)){ + Util.DOM.removeEventListener(window, 'orientationchange', this.windowOrientationChangeEventHandler); + } + + Util.DOM.removeEventListener(window, 'resize', this.windowResizeEventHandler); + + Util.DOM.removeEventListener(window, 'scroll', this.windowScrollEventHandler); + + // Remove keydown event handlers for desktop browsers + Util.DOM.removeEventListener(document, 'keydown', this.keyDownEventHandler); + + // Remove viewport handlers + this.viewport.removeEventListener(ViewportClass.EventTypes.onTouch, this.viewportTouchEventHandler); + + // Remove slider handlers + this.slider.removeEventListener(SliderClass.EventTypes.onDisplayCurrentFullSizeImage, this.sliderDisplayCurrentFullSizeImageEventHandler); + + // Remove toolbar handlers + this.toolbar.removeEventListener(ToolbarClass.EventTypes.onClick, this.toolbarClickEventHandler); + + }, + + + + /* + * Function: onDocumentOverlayFadeIn + */ + onDocumentOverlayFadeIn: function(e){ + + // Remove the ElementClass.EventTypes.onFadeIn + // event handler + this.documentOverlay.removeEventListener( + ElementClass.EventTypes.onFadeIn, + this.documentOverlayFadeInEventHandler + ); + + this.viewport.show(); + + this.slider.show(); + + this.toolbar.show(); + + this.addEventListeners(); + + this.slider.setCurrentFullSizeImage(this.fullSizeImages[this.currentIndex]); + + this.isBusy = false; + + }, + + + /* + * Function: setSliderPreviousAndNextFullSizeImages + */ + setSliderPreviousAndNextFullSizeImages: function(){ + + var + lastIndex, + previousFullSizeImage = null, + nextFullSizeImage = null; + + if (this.fullSizeImages.length > 1) { + + lastIndex = this.fullSizeImages.length - 1; + + // Current image is the last + if (this.currentIndex === lastIndex) { + + if (this.settings.loop) { + nextFullSizeImage = this.fullSizeImages[0]; + } + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + // Current image is the first + else if (this.currentIndex === 0) { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + if (this.settings.loop) { + previousFullSizeImage = this.fullSizeImages[lastIndex]; + } + + } + + // Current image is in the middle of the thumbs + else { + + nextFullSizeImage = this.fullSizeImages[this.currentIndex + 1]; + previousFullSizeImage = this.fullSizeImages[this.currentIndex - 1]; + + } + + } + + this.slider.setPreviousAndNextFullSizeImages(previousFullSizeImage, nextFullSizeImage); + + }, + + + + /* + * Function: onWindowResize + */ + onWindowResize: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onKeyDown + */ + onKeyDown: function(e){ + + if (e.keyCode === 37) { // Left + e.preventDefault(); + this.showPrevious(); + } + else if (e.keyCode === 39) { // Right + e.preventDefault(); + this.showNext(); + } + else if (e.keyCode === 38 || e.keyCode === 40) { // Up and down + e.preventDefault(); + } + else if (e.keyCode === 27) { // Escape + e.preventDefault(); + //this.pause(); + this.hide(); + } + else if (e.keyCode === 32) { // Spacebar + e.preventDefault(); + } + + }, + + + + /* + * Function: onWindowOrientationChange + */ + onWindowOrientationChange: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: onWindowScroll + */ + onWindowScroll: function(e){ + + this.resetPosition(); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + if (this.isBusy){ + return; + } + + this.documentOverlay.resetPosition(); + this.viewport.resetPosition(); + this.slider.resetPosition(); + this.caption.resetPosition(); + this.toolbar.resetPosition(); + + }, + + + + /* + * Function: onViewportClick + */ + onViewportTouch: function(e){ + + switch(e.action){ + + case ViewportClass.Actions.swipeLeft: + this.showNext(); + break; + + case ViewportClass.Actions.swipeRight: + this.showPrevious(); + break; + + default: + if (this.isSlideShowActive() || !this.settings.hideToolbar){ + this.showCaptionAndToolbar(); + } + else{ + this.hide(); + } + break; + + } + + }, + + + + /* + * Function: onViewportFadeOut + */ + onViewportFadeOut: function(e){ + + this.viewport.removeEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.isBusy = false; + + }, + + + + /* + * Function: hide + */ + hide: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.removeEventListeners(); + + this.documentOverlay.hide(); + this.caption.hide(); + this.toolbar.hide(); + this.slider.hide(); + + Util.DOM.removeClass(document.body, Code.PhotoSwipe.CssClasses.activeBody); + + this.viewport.addEventListener(ElementClass.EventTypes.onFadeOut, this.viewportFadeOutEventHandler); + + this.viewport.fadeOut(); + + }, + + + + /* + * Function: showNext + */ + showNext: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showNext(); + + }, + + + + /* + * Function: showPrevious + */ + showPrevious: function(){ + + if (this.isBusy){ + return; + } + + this.isBusy = true; + + this.caption.setEmptyCaption(); + + this.slider.showPrevious(); + + }, + + + + + /* + * Function: onSliderDisplayCurrentFullSizeImage + */ + onSliderDisplayCurrentFullSizeImage: function(e){ + + this.currentIndex = e.fullSizeImage.index; + + // Set the previous and next images for the slider + this.setSliderPreviousAndNextFullSizeImages(); + + this.isBusy = false; + + if (this.isSlideShowActive()){ + if (!this.settings.loop && this.currentIndex === this.fullSizeImages.length-1){ + // Slideshow as reached the end + this.slideshowTimeout = window.setTimeout( + this.showCaptionAndToolbar.bind(this), + this.settings.slideshowDelay + ); + } + else{ + this.fireSlideshowTimeout(); + } + } + else{ + this.showCaptionAndToolbar(); + } + + }, + + + /* + * Function: showCaptionAndToolbar + */ + showCaptionAndToolbar: function(captionValue){ + + this.stopSlideshow(); + + + // Caption + if (this.settings.hideCaption){ + this.caption.hide(); + } + else{ + captionValue = Util.coalesce(captionValue, this.fullSizeImages[this.currentIndex].caption); + + if ( (Util.isNothing(captionValue) || captionValue === '') && !this.settings.showEmptyCaptions ){ + this.caption.hide(); + return; + } + + this.caption.show(captionValue); + } + + + + // Toolbar + if (this.settings.hideToolbar){ + this.toolbar.hide(); + } + else{ + if (this.settings.loop) { + this.toolbar.setNextState(false); + this.toolbar.setPreviousState(false); + } + else{ + if (this.currentIndex >= this.fullSizeImages.length - 1) { + this.toolbar.setNextState(true); + } + else { + this.toolbar.setNextState(false); + } + + if (this.currentIndex < 1) { + this.toolbar.setPreviousState(true); + } + else { + this.toolbar.setPreviousState(false); + } + } + + this.toolbar.show(); + } + + }, + + + + /* + * Function: onToolbarClick + */ + onToolbarClick: function(e){ + + switch (e.action){ + + case ToolbarClass.Actions.previous: + this.showPrevious(); + break; + + case ToolbarClass.Actions.next: + this.showNext(); + break; + + case ToolbarClass.Actions.play: + this.startSlideshow(); + break; + + default: + this.hide(); + break; + + } + + }, + + + + /* + * Function: startSlideshow + */ + startSlideshow: function(){ + + if (this.isBusy){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.slideShowSettingsSaved = { + hideCaption: this.settings.hideCaption, + hideToolbar: this.settings.hideToolbar + }; + + this.settings.hideCaption = true; + this.settings.hideToolbar = true; + + this.caption.fadeOut(); + this.toolbar.fadeOut(); + + this.fireSlideshowTimeout(); + + }, + + + + /* + * Function: stopSlideshow + */ + stopSlideshow: function(){ + + if (!this.isSlideShowActive()){ + return; + } + + window.clearTimeout(this.slideshowTimeout); + + this.settings.hideCaption = this.slideShowSettingsSaved.hideCaption; + this.settings.hideToolbar = this.slideShowSettingsSaved.hideToolbar; + + this.slideShowSettingsSaved = null; + + }, + + + /* + * Function: isSlideShowActive + */ + isSlideShowActive: function(){ + + return (!Util.isNothing(this.slideShowSettingsSaved)); + + }, + + + /* + * Function: fireSlideshowTimeout + */ + fireSlideshowTimeout: function(){ + + this.slideshowTimeout = window.setTimeout( + this.showNext.bind(this), + this.settings.slideshowDelay + ); + + } + + + }); + + + Code.PhotoSwipe.CssClasses = { + activeBody: 'ps-active' + }; + + /* + * Function: Code.PhotoSwipe.GetImageSource + * Default method for returning an image's source + */ + Code.PhotoSwipe.GetImageSource = function(el){ + return el.href; + }; + + + + /* + * Function: Code.PhotoSwipe.GetImageCaption + * Default method for returning an image's caption + * Assumes the el is an anchor and the first child is the + * image. The returned value is the "alt" attribute of the + * image. + */ + Code.PhotoSwipe.GetImageCaption = function(el){ + if (el.nodeName === "IMG"){ + return Util.DOM.getAttribute(el, 'alt'); + } + return Util.DOM.getAttribute(el.firstChild, 'alt'); + }; + + + Code.PhotoSwipe.Current = new photoSwipe(); + + + Code.photoSwipe = function(thumbEls, containerEl, opts){ + + var useEventDelegation = true; + + if (Util.isNothing(thumbEls)){ + return; + } + + /* See if there is a container element, if so we will use event delegation */ + + if (Util.isNothing(containerEl)){ + containerEl = document.documentElement; + useEventDelegation = false; + } + + if (Util.isString(containerEl)){ + containerEl = document.documentElement.querySelector(containerEl); + } + + if (Util.isNothing(containerEl)){ + throw 'Unable to find container element'; + } + + if (Util.isString(thumbEls)){ + thumbEls = containerEl.querySelectorAll(thumbEls); + } + + if (Util.isNothing(thumbEls)){ + return; + } + + + // Set up the options + Code.PhotoSwipe.Current.setOptions(opts); + + + // Tell PhotoSwipe about the photos + Code.PhotoSwipe.Current.setImages(thumbEls); + + + if (useEventDelegation){ + + /* + * Use event delegation rather than setting a click event on each + * thumb element. + */ + containerEl.addEventListener('click', function(e){ + + if (e.target === e.currentTarget){ + return; + } + + e.preventDefault(); + + var findNode = function(clickedEl, targetNodeName, stopAtEl){ + + if (Util.isNothing(clickedEl) || Util.isNothing(targetNodeName) || Util.isNothing(stopAtEl)){ + return null; + } + + if (clickedEl.nodeName === targetNodeName){ + return clickedEl; + } + + if (clickedEl === stopAtEl){ + return null; + } + + return findNode(clickedEl.parentNode, targetNodeName, stopAtEl) + }; + + + var clickedEl = findNode(e.target, thumbEls[0].nodeName, e.currentTarget); + + if (Util.isNothing(clickedEl)){ + return; + } + + showPhotoSwipe(clickedEl); + + }, false); + + } + else{ + + // Add a click event handler on each element + for (var i = 0; i < thumbEls.length; i++){ + + var thumbEl = thumbEls[i]; + thumbEl.addEventListener('click', function(e){ + + e.preventDefault(); + + showPhotoSwipe(e.currentTarget); + + }, false); + + } + + } + + + var showPhotoSwipe = function(clickedEl){ + + var startingIndex = 0; + for (startingIndex; startingIndex < thumbEls.length; startingIndex++){ + if (thumbEls[startingIndex] === clickedEl){ + break; + } + } + + Code.PhotoSwipe.Current.show(startingIndex); + + }; + + }; + + + + /* + * jQuery plugin + */ + if (!Util.isNothing(window.jQuery)){ + + window.jQuery.fn.photoSwipe = function (opts) { + + var thumbEls = this; + Code.PhotoSwipe.Current.setOptions(opts); + Code.PhotoSwipe.Current.setImages(thumbEls); + + $(thumbEls).live('click', function(e){ + + e.preventDefault(); + + var startingIndex = $(thumbEls).index($(e.currentTarget)); + Code.PhotoSwipe.Current.show(startingIndex); + + }); + + }; + + } + + +}) +( + Code.PhotoSwipe.Util, + Code.PhotoSwipe.ElementClass, + Code.PhotoSwipe.DocumentOverlayClass, + Code.PhotoSwipe.FullSizeImageClass, + Code.PhotoSwipe.ViewportClass, + Code.PhotoSwipe.SliderClass, + Code.PhotoSwipe.CaptionClass, + Code.PhotoSwipe.ToolbarClass +); \ No newline at end of file diff --git a/src/slider-class.js b/src/slider-class.js new file mode 100644 index 000000000..c2212d4b3 --- /dev/null +++ b/src/slider-class.js @@ -0,0 +1,380 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util, SliderItemClass){ + + /* + * Class: Code.PhotoSwipe.SliderClass + */ + Code.PhotoSwipe.SliderClass = Code.PhotoSwipe.ElementClass.extend({ + + parentEl: null, + parentElWidth: null, + parentElHeight: null, + items: null, + + previousItem: null, + currentItem: null, + nextItem: null, + + hasBounced: null, + lastShowAction: null, + bounceSlideBy: null, + + showNextEndEventHandler: null, + showPreviousEndEventHandler: null, + bounceStepOneEventHandler: null, + bounceStepTwoEventHandler: null, + + sliderFullSizeImageLoadAnomalyEventHandler: null, + + + /* + * Function: init + */ + init: function(options, parentEl){ + + this.settings = { + slideSpeed: 250 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.parentEl = parentEl; + + this.hasBounced = false; + + this.showNextEndEventHandler = this.onShowNextEnd.bind(this); + this.showPreviousEndEventHandler = this.onShowPreviousEnd.bind(this); + this.bounceStepOneEventHandler = this.onBounceStepOne.bind(this); + this.bounceStepTwoEventHandler = this.onBounceStepTwo.bind(this); + + this.sliderFullSizeImageLoadAnomalyEventHandler = this.onSliderFullSizeImageLoadAnomaly.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.SliderClass.CssClasses.slider }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + top: 0 + }); + Util.DOM.hide(this.el); + Util.DOM.appendChild(this.el, parentEl); + + // Create previousItem, currentItem, nextItem + this.items = []; + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + this.items.push(new SliderItemClass(this.el)); + + this.previousItem = this.items[0]; + this.currentItem = this.items[1]; + this.nextItem = this.items[2]; + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + for (var i = 0; i maxWidth) { + scale = maxWidth / newWidth; + } + else if (newHeight > maxHeight) { + scale = maxHeight / newHeight; + } + if (scale !== 1) { + newWidth = Math.round(newWidth * scale); + newHeight = Math.round(newHeight * scale); + } + } + + newTop = ((maxHeight - newHeight) / 2) + 'px'; + newLeft = ((maxWidth - newWidth) / 2) + 'px'; + + Util.DOM.width(this.imageEl, newWidth); + Util.DOM.height(this.imageEl, newHeight); + Util.DOM.setStyle(this.imageEl, { + top: newTop, + left: newLeft + }); + + Util.DOM.show(this.imageEl); + + }, + + + + /* + * Function: setFullSizeImage + */ + setFullSizeImage: function(fullSizeImage){ + + this.fullSizeImage = fullSizeImage; + + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + Util.DOM.removeClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + + // Something is wrong! + if (Util.isNothing(this.fullSizeImage)) { + this.fullSizeImage = null; + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.imageError); + this.hideImage(); + return; + } + + // Still loading + if (!this.fullSizeImage.hasLoaded) { + + Util.DOM.addClass(this.el, Code.PhotoSwipe.SliderItemClass.CssClasses.loading); + this.hideImage(); + + if (!this.fullSizeImage.isLoading){ + + // Trigger off the load + this.fullSizeImage.addEventListener( + FullSizeImageClass.EventTypes.onLoad, + this.fullSizeImageLoadEventHandler + ); + + + this.fullSizeImage.load(); + + } + + return; + + } + + // Loaded so show the image + Util.DOM.setAttribute(this.imageEl, 'src', this.fullSizeImage.src); + + this.resetImagePosition(); + + this.dispatchEvent(Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageDisplay); + + }, + + + /* + * Function: onFullSizeImageLoad + */ + onFullSizeImageLoad: function(e){ + + e.target.removeEventListener(FullSizeImageClass.EventTypes.onLoad, this.fullSizeImageLoadEventHandler); + + if (Util.isNothing(this.fullSizeImage) || e.target.index !== this.fullSizeImage.index){ + // Chances are the user has moved the slider + // and the image to display in the item has now changed + // from when the item originally called the fullSizeImage + // to load. If that's the case, rethrow the event, the + // slider will be listening for this and can find a + // relevant slideitem for the loaded image + this.dispatchEvent({ + type: Code.PhotoSwipe.SliderItemClass.EventTypes.onFullSizeImageLoadAnomaly, + target: this, + fullSizeImage: e.target + }); + } + else{ + this.setFullSizeImage(e.target); + } + + }, + + + /* + * Function: hideImage + */ + hideImage: function(){ + + Util.DOM.removeAttribute(this.imageEl, 'src'); + Util.DOM.hide(this.imageEl); + + } + + + }); + + + Code.PhotoSwipe.SliderItemClass.CssClasses = { + item: 'ps-slider-item', + loading: 'ps-slider-item-loading', + imageError: 'ps-slider-item-image-error' + }; + + + Code.PhotoSwipe.SliderItemClass.EventTypes = { + onFullSizeImageDisplay: 'onFullSizeImageDisplay', + onFullSizeImageLoadAnomaly: 'onFullSizeImageLoadAnomaly' + }; + + +})(Code.PhotoSwipe.Util, Code.PhotoSwipe.FullSizeImageClass); \ No newline at end of file diff --git a/src/toolbar-class.js b/src/toolbar-class.js new file mode 100644 index 000000000..10f7b7f7f --- /dev/null +++ b/src/toolbar-class.js @@ -0,0 +1,259 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ToolbarClass + */ + Code.PhotoSwipe.ToolbarClass = Code.PhotoSwipe.ElementClass.extend({ + + closeEl: null, + previousEl: null, + nextEl: null, + playEl: null, + + clickHandler: null, + + fadeOutTimeout: null, + isNextActive: null, + isPreviousActive: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + toolbarDelay: 4000, + position: 'bottom' + }; + + Util.extend(this.settings, options); + + this._super(options); + + this.isNextActive = true; + this.isPreviousActive = true; + + this.clickHandler = this.onClick.bind(this); + + // Create element and append to body + var cssClass = Code.PhotoSwipe.ToolbarClass.CssClasses.caption; + if (this.settings.position === 'top'){ + cssClass = cssClass + ' ' + Code.PhotoSwipe.ToolbarClass.CssClasses.top; + } + + this.el = Util.DOM.createElement('div', { 'class': cssClass }, ''); + Util.DOM.setStyle(this.el, { + left: 0, + position: 'absolute', + overflow: 'hidden', + zIndex: 1001, + display: 'table' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + // Close + this.closeEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.close }, '
'); + Util.DOM.appendChild(this.closeEl, this.el); + + // Play + this.playEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.play }, '
'); + Util.DOM.appendChild(this.playEl, this.el); + + // Previous + this.previousEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.previous }, '
'); + Util.DOM.appendChild(this.previousEl, this.el); + + // Next + this.nextEl = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ToolbarClass.CssClasses.next }, '
'); + Util.DOM.appendChild(this.nextEl, this.el); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + Util.DOM.addEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + Util.DOM.removeEventListener(this.el, 'click', this.clickHandler); + + }, + + + /* + * Function: onClick + */ + onClick: function(e){ + + var action; + + switch(e.target.parentNode){ + + case this.previousEl: + if (this.isPreviousActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.previous; + } + break; + + case this.nextEl: + if (this.isNextActive){ + action = Code.PhotoSwipe.ToolbarClass.Actions.next; + } + break; + + case this.playEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.play; + break; + + case this.closeEl: + action = Code.PhotoSwipe.ToolbarClass.Actions.close; + break; + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ToolbarClass.EventTypes.onClick, + target: this, + action: action + }); + + }, + + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + var top; + + if (this.settings.position === 'bottom') { + top = Util.DOM.windowHeight() - Util.DOM.height(this.el) + Util.DOM.windowScrollTop(); + } + else { + top = Util.DOM.windowScrollTop(); + } + + Util.DOM.setStyle(this.el, 'top', top + 'px'); + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + + }, + + + + /* + * Function: stopFade + */ + stopFade: function(){ + + window.clearTimeout(this.fadeOutTimeout); + this._super(); + + }, + + + + /* + * Function: postShow + */ + postShow: function(){ + + if (this.settings.toolbarDelay > 0){ + + this.fadeOutTimeout = window.setTimeout( + this.fadeOut.bind(this), + this.settings.toolbarDelay + ); + + } + + this._super(); + + }, + + + /* + * Function: setNextState + */ + setNextState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = false; + } + else { + Util.DOM.removeClass(this.nextEl, Code.PhotoSwipe.ToolbarClass.CssClasses.nextDisabled); + this.isNextActive = true; + } + + }, + + + /* + * Function: setPreviousState + */ + setPreviousState: function (disable) { + + if (disable) { + Util.DOM.addClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = false; + } + else { + Util.DOM.removeClass(this.previousEl, Code.PhotoSwipe.ToolbarClass.CssClasses.previousDisabled); + this.isPreviousActive = true; + } + + } + + }); + + + + Code.PhotoSwipe.ToolbarClass.CssClasses = { + caption: 'ps-toolbar', + top: 'ps-toolbar-top', + close: 'ps-toolbar-close', + previous: 'ps-toolbar-previous', + previousDisabled: 'ps-toolbar-previous-disabled', + next: 'ps-toolbar-next', + nextDisabled: 'ps-toolbar-next-disabled', + play: 'ps-toolbar-play', + content: 'ps-toolbar-content' + }; + + + + Code.PhotoSwipe.ToolbarClass.Actions = { + close: 'close', + previous: 'previous', + next: 'next', + play: 'play' + }; + + + Code.PhotoSwipe.ToolbarClass.EventTypes = { + onClick: 'onClick' + }; + +})(Code.PhotoSwipe.Util); + \ No newline at end of file diff --git a/src/util-animation-jQuery.js b/src/util-animation-jQuery.js new file mode 100644 index 000000000..d2d5901de --- /dev/null +++ b/src/util-animation-jQuery.js @@ -0,0 +1,83 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + + Animation: { + + + /* + * Function: stopFade + */ + stopFade: function(el){ + + $(el).stop(true, true); + + }, + + + /* + * Function: fadeIn + * Fades an element in. + * Make sure the element is displayed before calling + */ + fadeIn: function(el, opacity, duration, callback){ + + opacity = Util.coalesce(opacity, 1); + duration = Util.coalesce(duration, 500); + + $(el).fadeTo(duration, opacity, callback); + + }, + + + /* + * Function: fadeOut + * Fades an element out + * Make sure the element is displayed before calling + * Does not "hide" the element when animation is over + */ + fadeOut: function(el, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + $(el).fadeTo(duration, 0, callback); + + }, + + + + /* + * Function: slideTo + * Slides an element by an x,y position + */ + slideBy: function(el, xPos, yPos, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + + $(el).animate( + { + left: '+=' + xPos + 'px', + top: '+=' + yPos + 'px' + }, + duration, + callback + ); + + } + + } + + }); + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/util-animation.js b/src/util-animation.js new file mode 100644 index 000000000..a869931ca --- /dev/null +++ b/src/util-animation.js @@ -0,0 +1,292 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + + Animation: { + + _applyTransitionDelay: 100, + + /* + * Function: _setTransition + * Sets animation transitions on the element + */ + _setTransition: function(el, property, duration, timingFunction, delay, callback){ + + var + transitionPrefix = Util.Animation._getTransitionPrefix(), + p = Util.coalesce(property, ''), + d = Util.coalesce(duration, ''), + t, de, c; + + if (Util.isFunction(timingFunction)){ + c = timingFunction; + t = ''; + de = ''; + } + else{ + c = callback; + t = Util.coalesce(timingFunction, ''); + de = Util.coalesce(delay, ''); + } + + Util.DOM.setStyle(el, transitionPrefix + 'Property', p); + Util.DOM.setStyle(el, transitionPrefix + 'Duration', d); + Util.DOM.setStyle(el, transitionPrefix + 'TimingFunction', t); + Util.DOM.setStyle(el, transitionPrefix + 'Delay', de); + + // Wait for the above transitions to get applied + if (Util.isFunction(c)){ + window.setTimeout( + function(){ + c(el); + }, + Util.Animation._applyTransitionDelay + ); + } + + }, + + + /* + * Function: _setTransitionEndEventListener + * Sets an event listener on transition end. This will: + * - Remove the transitionEnd event hander + * - Fire any animation end callback you specified + * + * The function stores a pointer to the event handler functions + * on the element object itself (using Util.setElementData) + * + * This gives us a reference when removing the event listener + */ + _setTransitionEndEventListener: function(el){ + + Util.setElementData(el, 'transitionEndEvent', function(e){ + + var el = e.target; + + Util.DOM.removeEventListener(el, Util.Animation._getTransitionEndEventLabel(), Util.getElementData(el, 'transitionEndEvent')); + Util.removeElementData(el, 'transitionEndEvent'); + + var callback = Util.getElementData(el, 'transitionEndCallback'); + Util.removeElementData(el, 'transitionEndCallback'); + + // Remove the tranistion + Util.Animation._removeTransitions(el); + + if (Util.isFunction(callback)){ + + window.setTimeout( + function(){ + callback(e); + }, + Util.Animation._applyTransitionDelay + ); + + } + + }); + + + Util.DOM.addEventListener(el, Util.Animation._getTransitionEndEventLabel(), Util.getElementData(el, 'transitionEndEvent')); + + }, + + + /* + * Function: _removeTransitions + */ + _removeTransitions: function(el){ + + var transitionPrefix = Util.Animation._getTransitionPrefix(); + + Util.DOM.setStyle(el, transitionPrefix + 'Property', ''); + Util.DOM.setStyle(el, transitionPrefix + 'Duration', ''); + Util.DOM.setStyle(el, transitionPrefix + 'TimingFunction', ''); + Util.DOM.setStyle(el, transitionPrefix + 'Delay', ''); + + }, + + + /* + * Function: _getTransitionEndEventLabel + */ + _getTransitionEndEventLabel: function(){ + + return (document.documentElement.style.WebkitTransition !== undefined) ? "webkitTransitionEnd" : "transitionend"; + + }, + + + _getTransitionPrefix: function(){ + + return (document.documentElement.style.WebkitTransition !== undefined) ? "webkitTransition" : (document.documentElement.style.MozTransition !== undefined) ? "MozTransition" : "transition"; + + }, + + + /* + * Function: stopFade + */ + stopFade: function(el){ + + Util.DOM.removeEventListener( + el, + Util.Animation._getTransitionEndEventLabel(), + Util.getElementData(el, 'transitionEndEvent') + ); + + var transitionPrefix = Util.Animation._getTransitionPrefix(); + var currentOpacity = window.getComputedStyle(el,'').getPropertyValue('opacity'); + + Util.Animation._removeTransitions(el); + + Util.DOM.setStyle(el, 'opacity', currentOpacity); + + }, + + + /* + * Function: fadeIn + * Fades an element in. + * Make sure the element is displayed before calling + */ + fadeIn: function(el, opacity, duration, callback){ + + opacity = Util.coalesce(opacity, 1); + duration = Util.coalesce(duration, 500); + + Util.setElementData(el, 'transitionEndCallback', callback); + + Util.Animation._setTransition(el, 'opacity', duration + 'ms', function(el){ + + Util.Animation._setTransitionEndEventListener(el); + Util.DOM.setStyle(el, 'opacity', opacity); + + }); + + }, + + + /* + * Function: fadeOut + * Fades an element out + * Make sure the element is displayed before calling + * Does not "hide" the element when animation is over + */ + fadeOut: function(el, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + Util.setElementData(el, 'transitionEndCallback', callback); + + Util.Animation._setTransition(el, 'opacity', duration + 'ms', function(el){ + + Util.Animation._setTransitionEndEventListener(el); + Util.DOM.setStyle(el, 'opacity', 0); + + }); + + }, + + + + /* + * Function: slideTo + * Slides an element by an x,y position + */ + slideBy: function(el, xPos, yPos, duration, callback){ + + if (Util.isNothing(duration)){ + duration = 500; + } + + /* Store some values against the element for later use */ + Util.setElementData(el, 'transitionEndCallback', Util.Animation._onSlideByEnd); + Util.setElementData(el, 'slideByCallback', callback); + Util.setElementData(el, 'slideByXPos', xPos); + Util.setElementData(el, 'slideByYPos', yPos); + + //ease-in-out + Util.Animation._setTransition(el, 'all', duration + 'ms', 'ease-in', 0, function(el){ + + Util.Animation._setTransitionEndEventListener(el); + + var + xPos = Util.getElementData(el, 'slideByXPos'), + yPos = Util.getElementData(el, 'slideByYPos'); + + Util.removeElementData(el, 'slideByXPos'); + Util.removeElementData(el, 'slideByYPos'); + + Util.DOM.setStyle(el, { + webkitTransform: (Util.isMobileSafari) ? 'translate3d(' + xPos + 'px, ' + yPos + 'px, 0)' : 'translate(' + xPos + 'px, ' + yPos + 'px)', + MozTransform: 'translate(' + xPos + 'px, ' + yPos + 'px)', + transform: 'translate(' + xPos + 'px, ' + yPos + 'px)' + }); + + }); + + }, + + + + _onSlideByEnd: function(e){ + + // Reset the real css top and left after the transformation + var + el = e.target, + + callback = Util.getElementData(el, 'slideByCallback'), + + transform = Util.coalesce(el.style.webkitTransform, el.style.MozTransform, el.style.transform), + + transformExploded = transform.match( /\((.*?)\)/ )[1].split(', '), + + transformedX = window.parseInt(transformExploded[0]), + + transformedY = window.parseInt(transformExploded[1]), + + domX = window.parseInt(Util.DOM.getStyle(el, 'left')), + + domY = window.parseInt(Util.DOM.getStyle(el, 'top')); + + Util.DOM.setStyle(el, { + webkitTransform: '', + MozTransform: '', + transform: '', + left: (domX + transformedX) + 'px', + top: (domY + transformedY) + 'px' + }); + + + Util.removeElementData(el, 'slideByCallback'); + Util.removeElementData(el, 'slideByXPos'); + Util.removeElementData(el, 'slideByYPos'); + + if (Util.isFunction(callback)){ + window.setTimeout( + function(){ + callback(e); + }, + Util.Animation._applyTransitionDelay + ); + //window.setTimeout(callback, Util.Animation._applyTransitionDelay, e); + } + + } + + + } + + + }); + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/util-dom-jQuery.js b/src/util-dom-jQuery.js new file mode 100644 index 000000000..802b53457 --- /dev/null +++ b/src/util-dom-jQuery.js @@ -0,0 +1,384 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + DOM: { + + /* + * Function: resetTranslate + * Required for smoother transition on iOS + */ + resetTranslate: function(el){ + + if (Util.browser.mobileSafari){ + $(el).css('-webkit-transform', 'translate3d(0px,0px,0px)'); + } + + }, + + + /* + * Function: createElement + */ + createElement: function(type, attributes, content){ + + var retval = $('<' + type +'>'); + retval.attr(attributes); + retval.append(content); + + return retval[0]; + + }, + + + /* + * Function: appendChild + */ + appendChild: function(childEl, parentEl){ + + $(parentEl).append(childEl); + + }, + + + /* + * Function: appendText + */ + appendText: function(text, parentEl){ + + $(parentEl).text(text); + + }, + + + /* + * Function: appendToBody + */ + appendToBody: function(childEl){ + + $('body').append(childEl); + + }, + + + /* + * Function: removeChild + */ + removeChild: function(childEl, parentEl){ + + $(parentEl).remove(childEl); + + }, + + + + /* + * Function: removeChildren + */ + removeChildren: function(parentEl){ + + $(parentEl).empty(); + + }, + + + + /* + * Function: hasAttribute + */ + hasAttribute: function(el, attributeName){ + + return Util.isNothing( $(el).attr(attributeName) ); + + }, + + + /* + * Function: getAttribute + */ + getAttribute: function(el, attributeName){ + + return $(el).attr(attributeName); + + }, + + + /* + * Function: el, attributeName + */ + setAttribute: function(el, attributeName, value){ + + $(el).attr(attributeName, value); + + }, + + + /* + * Function: removeAttribute + */ + removeAttribute: function(el, attributeName){ + + $(el).removeAttr(attributeName); + + }, + + + /* + * Function: addClass + */ + addClass: function(el, className){ + + $(el).addClass(className); + + }, + + + /* + * Function: removeClass + */ + removeClass: function(el, className){ + + $(el).removeClass(className); + + }, + + + /* + * Function: hasClass + */ + hasClass: function(el, className){ + + $(el).hasClass(className); + + }, + + + /* + * Function: setStyle + */ + setStyle: function(el, style, value){ + + if (Util.isObject(style)) { + $(el).css(style); + } + else { + $(el).css(style, value); + } + + }, + + + /* + * Function: getStyle + */ + getStyle: function(el, styleName){ + + return $(el).css(styleName); + + }, + + + /* + * Function: hide + */ + hide: function(el){ + + $(el).hide(); + + }, + + + /* + * Function: show + */ + show: function(el){ + + $(el).show(); + + }, + + + /* + * Function: width + * Content width, exludes padding + */ + width: function(el, value){ + + if (!Util.isNothing(value)){ + $(el).width(value); + } + + return $(el).width(); + + }, + + + /* + * Function: outerWidth + */ + outerWidth: function(el){ + + return $(el).outerWidth(); + + }, + + + /* + * Function: height + * Content height, excludes padding + */ + height: function(el, value){ + + if (!Util.isNothing(value)){ + $(el).height(value); + } + + return $(el).height(); + + }, + + + /* + * Function: outerHeight + */ + outerHeight: function(el){ + + return $(el).outerHeight(); + + }, + + + /* + * Function: documentWidth + */ + documentWidth: function(){ + + return $(document.documentElement).width(); + + }, + + + /* + * Function: documentHeight + */ + documentHeight: function(){ + + return $(document.documentElement).height(); + + }, + + + /* + * Function: bodyWidth + */ + bodyWidth: function(){ + + return $(document.body).width(); + + }, + + + /* + * Function: bodyHeight + */ + bodyHeight: function(){ + + return $(document.body).height(); + + }, + + + /* + * Function: windowWidth + */ + windowWidth: function(){ + + return $(window).width(); + + }, + + + /* + * Function: windowHeight + */ + windowHeight: function(){ + + return $(window).height(); + + }, + + + /* + * Function: windowScrollLeft + */ + windowScrollLeft: function(){ + + return $(window).scrollLeft(); + + }, + + + /* + * Function: windowScrollTop + */ + windowScrollTop: function(){ + + return $(window).scrollTop(); + + }, + + + /* + * Function: addEventListener + */ + addEventListener: function(el, type, listener){ + + $(el).bind( type, listener ); + + }, + + + /* + * Function: removeEventListener + */ + removeEventListener: function(el, type, listener){ + + $(el).unbind( type, listener ); + + }, + + + /* + * Function: getMousePosition + */ + getMousePosition: function(event){ + + var retval = { + x: event.pageX, + y: event.pageY + } + + return retval; + }, + + + /* + * Function: getTouchEvent + */ + getTouchEvent: function(event){ + + return event.originalEvent; + + } + + } + + + }); + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/util-dom.js b/src/util-dom.js new file mode 100644 index 000000000..43f937493 --- /dev/null +++ b/src/util-dom.js @@ -0,0 +1,467 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function (Util) { + + Util.extend(Util, { + + DOM: { + + /* + * Function: resetTranslate + * Required for smoother transition on iOS + */ + resetTranslate: function(el){ + + if (Util.browser.mobileSafari){ + Util.DOM.setStyle(el, '-webkit-transform', 'translate3d(0px,0px,0px)'); + } + + }, + + + /* + * Function: createElement + */ + createElement: function(type, attributes, content){ + + var retval = document.createElement(type); + + for(var attribute in attributes) { + if(attributes.hasOwnProperty(attribute)){ + retval.setAttribute(attribute, attributes[attribute]); + } + } + + retval.innerHTML = content || ''; + + return retval; + + }, + + + /* + * Function: appendChild + */ + appendChild: function(childEl, parentEl){ + + parentEl.appendChild(childEl); + + }, + + + /* + * Function: appendText + */ + appendText: function(text, parentEl){ + + var textNode = document.createTextNode(text); + Util.DOM.appendChild(textNode, parentEl); + + }, + + + /* + * Function: appendToBody + */ + appendToBody: function(childEl){ + + this.appendChild(childEl, document.body); + + }, + + + /* + * Function: removeChild + */ + removeChild: function(childEl, parentEl){ + + parentEl.removeChild(childEl); + + }, + + + + /* + * Function: removeChildren + */ + removeChildren: function(parentEl){ + + if (parentEl.hasChildNodes()){ + + while (parentEl.childNodes.length >= 1){ + parentEl.removeChild(parentEl.childNodes[parentEl.childNodes.length -1]); + } + + } + + }, + + + + /* + * Function: hasAttribute + */ + hasAttribute: function(el, attributeName){ + + return el.getAttribute(attributeName); + + }, + + + /* + * Function: getAttribute + */ + getAttribute: function(el, attributeName){ + + if(!this.hasAttribute(el, attributeName)){ + return ''; + } + + return el.getAttribute(attributeName); + + }, + + + /* + * Function: el, attributeName + */ + setAttribute: function(el, attributeName, value){ + + el.setAttribute(attributeName, value); + + }, + + + /* + * Function: removeAttribute + */ + removeAttribute: function(el, attributeName){ + + if (this.hasAttribute(el, attributeName)){ + + el.removeAttribute(attributeName); + + } + + }, + + + /* + * Function: addClass + */ + addClass: function(el, className){ + + var currentClassValue = Util.DOM.getAttribute(el, 'class'); + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + + if ( ! re.test(currentClassValue) ){ + if (currentClassValue != ''){ + currentClassValue = currentClassValue + ' '; + } + currentClassValue = currentClassValue + className; + Util.DOM.setAttribute(el, 'class', currentClassValue); + } + + }, + + + /* + * Function: removeClass + */ + removeClass: function(el, className){ + + var currentClassValue = Util.DOM.getAttribute(el, 'class'); + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + + if (re.test(currentClassValue)){ + + currentClassValue = currentClassValue.replace(re, ' '); + + Util.DOM.setAttribute(el, 'class', currentClassValue); + Util.DOM.removeClass(el, className); + + } + else{ + currentClassValue = Util.trim(currentClassValue); + if (currentClassValue === ''){ + Util.DOM.removeAttribute(el, 'class'); + } + else{ + Util.DOM.setAttribute(el, 'class', currentClassValue); + } + } + + }, + + + /* + * Function: hasClass + */ + hasClass: function(el, className){ + + var re = new RegExp('(?:^|\\s+)' + className + '(?:\\s+|$)'); + return re.test(Util.DOM.getAttribute(el, 'class')); + + }, + + + /* + * Function: setStyle + */ + setStyle: function(el, style, value){ + + if (Util.isObject(style)) { + for(var propertyName in style) { + if(style.hasOwnProperty(propertyName)){ + el.style[propertyName] = style[propertyName]; + } + } + } + else { + el.style[style] = value; + } + }, + + + /* + * Function: getStyle + */ + getStyle: function(el, styleName){ + + return window.getComputedStyle(el,'').getPropertyValue(styleName); + + }, + + + /* + * Function: hide + */ + hide: function(el){ + + // Store the current display value if we use show + Util.setElementData(el, 'oldDisplayValue', Util.DOM.getStyle(el, 'display')); + Util.DOM.setStyle(el, 'display', 'none'); + + }, + + + /* + * Function: show + */ + show: function(el){ + + if (Util.DOM.getStyle(el, 'display') === 'none'){ + var oldDisplayValue = Util.getElementData(el, 'oldDisplayValue', 'block'); + if (oldDisplayValue === 'none'){ + oldDisplayValue = 'block'; + } + Util.DOM.setStyle(el, 'display', oldDisplayValue); + } + + }, + + + /* + * Function: width + * Content width, excludes padding + */ + width: function(el, value){ + + if (!Util.isNothing(value)){ + if (Util.isNumber(value)){ + value = value + 'px'; + } + el.style.width = value; + } + + return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('width')); + + }, + + + /* + * Function: outerWidth + */ + outerWidth: function(el){ + + return el.offsetWidth; + + }, + + + /* + * Function: height + * Content height, excludes padding + */ + height: function(el, value){ + + if (!Util.isNothing(value)){ + if (Util.isNumber(value)){ + value = value + 'px'; + } + el.style.height = value; + } + + return window.parseInt(window.getComputedStyle(el,'').getPropertyValue('height')); + + }, + + + /* + * Function: outerHeight + */ + outerHeight: function(el){ + + return el.offsetHeight; + + }, + + + /* + * Function: documentWidth + */ + documentWidth: function(){ + + return Util.DOM.width(document.documentElement); + + }, + + + /* + * Function: documentHeight + */ + documentHeight: function(){ + + return Math.round(Util.DOM.height(document.documentElement)); + + }, + + + /* + * Function: bodyWidth + */ + bodyWidth: function(){ + + return Util.DOM.width(document.body); + + }, + + + /* + * Function: bodyHeight + */ + bodyHeight: function(){ + + return Util.DOM.height(document.body); + + }, + + + /* + * Function: windowWidth + */ + windowWidth: function(){ + + return window.innerWidth; + + }, + + + /* + * Function: windowHeight + */ + windowHeight: function(){ + + return window.innerHeight; + + }, + + + /* + * Function: windowScrollLeft + */ + windowScrollLeft: function(){ + + return window.pageXOffset; + + }, + + + /* + * Function: windowScrollTop + */ + windowScrollTop: function(){ + + return window.pageYOffset; + + }, + + + /* + * Function: addEventListener + */ + addEventListener: function(el, type, listener){ + + el.addEventListener(type, listener, false); + + }, + + + /* + * Function: removeEventListener + */ + removeEventListener: function(el, type, listener){ + + el.removeEventListener(type, listener, false); + + }, + + + /* + * Function: getMousePosition + */ + getMousePosition: function(event){ + + var retval = { + x: 0, + y: 0 + } + + if (event.pageX) { + retval.x = event.pageX; + } + else if (event.clientX) { + retval.x = event.clientX + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft); + } + + if (event.pageY) { + retval.y = event.pageY; + } + else if (event.clientY) { + retval.y = event.clientY + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop); + } + + return retval; + }, + + + /* + * Function: getTouchEvent + */ + getTouchEvent: function(event){ + + return event; + + } + + } + + + }); + + +})(Code.PhotoSwipe.Util); \ No newline at end of file diff --git a/src/util.js b/src/util.js new file mode 100644 index 000000000..b8d5277ad --- /dev/null +++ b/src/util.js @@ -0,0 +1,229 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function () { + + // https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function/bind + if (!Function.prototype.bind ) { + + Function.prototype.bind = function( obj ) { + var slice = [].slice, + args = slice.call(arguments, 1), + self = this, + nop = function () {}, + bound = function () { + return self.apply( this instanceof nop ? this : ( obj || {} ), + args.concat( slice.call(arguments) ) ); + }; + + nop.prototype = self.prototype; + + bound.prototype = new nop(); + + return bound; + }; + } + + + if (typeof Code === "undefined") { + Code = {}; + Code.PhotoSwipe = {}; + } + + + + Code.PhotoSwipe.Util = { + + browser: { + version: (navigator.userAgent.match( /.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/ ) || [])[1], + webkit: /webkit/.test(navigator.userAgent), + opera: /opera/.test(navigator.userAgent), // untested + msie: /msie/.test(navigator.userAgent) && !/opera/.test(navigator.userAgent), + mozilla: /mozilla/.test(navigator.userAgent) && !/(compatible|webkit)/.test(navigator.userAgent), + mobileSafari: /Mac OS X.*Mobile.*Safari/.test(navigator.userAgent) + }, + + + /* + * Function: setElementData + */ + setElementData: function(el, key, value){ + + if ( this.isNothing(el.UtilData) ){ + el.UtilData = { }; + } + + el.UtilData[key] = value; + }, + + + /* + * Function: getElementData + */ + getElementData: function(el, key, defaultValue){ + + if (typeof defaultValue === "undefined"){ + defaultValue = null; + } + + if ( this.isNothing(el.UtilData) ){ + return defaultValue; + } + + if ( this.isNothing(el.UtilData[key]) ){ + return defaultValue; + } + + return el.UtilData[key]; + + }, + + + /* + * Function: removeElementData + */ + removeElementData: function(el, key){ + + delete el.UtilData[key]; + + }, + + + /* + * Function: coalesce + * Takes any number of arguments and returns the first non Null / Undefined argument. + */ + coalesce: function () { + var i; + for (i = 0; i < arguments.length; i++) { + if (!this.isNothing(arguments[i])) { + return arguments[i]; + } + } + return null; + }, + + + + /* + * Function: registerNamespace + */ + registerNamespace: function () { + var args = arguments, obj = null, i, j; + for (i = 0; i < args.length; ++i) { + var ns = args[i]; + var nsParts = ns.split("."); + var root = nsParts[0]; + eval('if (typeof ' + root + ' == "undefined"){' + root + ' = {};} obj = ' + root + ';'); + for (j = 1; j < nsParts.length; ++j) { + obj[nsParts[j]] = obj[nsParts[j]] || {}; + obj = obj[nsParts[j]]; + } + } + }, + + + + /* + * Function: extend + */ + extend: function(destination, source, overwriteProperties){ + if (this.isNothing(overwriteProperties)){ + overwriteProperties = true; + } + if (destination && source && this.isObject(source)){ + for(var prop in source){ + if (overwriteProperties){ + destination[prop] = source[prop]; + } + else{ + if(typeof destination[prop] == "undefined"){ + destination[prop] = source[prop]; + } + } + } + } + }, + + + /* + * Function: swapArrayElements + */ + swapArrayElements: function(arr, i, j){ + + var temp = arr[i]; + arr[i] = arr[j]; + arr[j] = temp; + + }, + + + /* + * Function: isObject + */ + isObject: function(obj){ + return typeof obj == "object"; + }, + + + + /* + * Function: isNothing + */ + isNothing: function (obj) { + if (typeof obj === "undefined" || obj === null) { + return true; + } + return false; + }, + + + + /* + * Function: isFunction + */ + isFunction: function(obj){ + return typeof obj == "function"; + }, + + + + /* + * Function: isArray + */ + isArray: function(obj){ + return obj && Code.PhotoSwipe.Util.isFunction(obj.pop); + }, + + + + /* + * Function: isNumber + */ + isNumber: function(obj){ + return typeof obj == "number"; + }, + + + /* + * Function: isString + */ + isString: function(obj){ + return typeof obj == "string"; + }, + + + + /* + * Function: trim + */ + trim: function(val) { + var re = new RegExp(/\s+?/); + return val.replace(re, ''); + } + + }; + + +})(); \ No newline at end of file diff --git a/src/version-header.txt b/src/version-header.txt new file mode 100644 index 000000000..f49952e47 --- /dev/null +++ b/src/version-header.txt @@ -0,0 +1,4 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license +// version: %%version%% diff --git a/src/viewport-class.js b/src/viewport-class.js new file mode 100644 index 000000000..ed37095ce --- /dev/null +++ b/src/viewport-class.js @@ -0,0 +1,290 @@ +// PhotoSwipe - http://www.photoswipe.com/ +// Copyright (c) 2011 by Code Computerlove (http://www.codecomputerlove.com) +// Licensed under the MIT license + +(function(Util){ + + /* + * Class: Code.PhotoSwipe.ViewportClass + */ + Code.PhotoSwipe.ViewportClass = Code.PhotoSwipe.ElementClass.extend({ + + touchStartPoint: null, + touchFingerCount: null, + touchCancelsMouseEvents: null, + + touchStartHandler: null, + touchMoveHandler: null, + touchEndHandler: null, + + mouseDownHandler: null, + mouseUpHandler: null, + + + /* + * Function: init + */ + init: function(options){ + + this.settings = { + swipeThreshold: 500 + }; + + Util.extend(this.settings, options); + + this._super(this.settings); + + this.touchFingerCount = 0; + this.touchStartPoint = { x: 0, y: 0 }; + this.touchCancelsMouseEvents = false; + + this.touchStartHandler = this.onTouchStart.bind(this); + this.touchMoveHandler = this.onTouchMove.bind(this); + this.touchEndHandler = this.onTouchEnd.bind(this); + + this.mouseDownHandler = this.onMouseDown.bind(this); + this.mouseUpHandler = this.onMouseUp.bind(this); + + // Create element and append to body + this.el = Util.DOM.createElement('div', { 'class': Code.PhotoSwipe.ViewportClass.CssClasses.viewport }, ''); + Util.DOM.setStyle(this.el, { + position: 'absolute', + left: 0, + overflow: 'hidden' + }); + Util.DOM.hide(this.el); + Util.DOM.appendToBody(this.el); + + }, + + + /* + * Function: resetPosition + */ + resetPosition: function(){ + + // Set the height and width to fill the document + Util.DOM.setStyle(this.el, { + top: Util.DOM.windowScrollTop() + 'px' + }); + + Util.DOM.width(this.el, Util.DOM.bodyWidth()); + Util.DOM.height(this.el, Util.DOM.windowHeight()); + + }, + + + /* + * Function: addEventListeners + */ + addEventListeners: function(){ + + try{ + Util.DOM.addEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.addEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.addEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.addEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.addEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: removeEventListeners + */ + removeEventListeners: function(){ + + try{ + Util.DOM.removeEventListener(this.el, 'touchstart', this.touchStartHandler); + Util.DOM.removeEventListener(this.el, 'touchmove', this.touchMoveHandler); + Util.DOM.removeEventListener(this.el, 'touchend', this.touchEndHandler); + } + catch (err){ } + + Util.DOM.removeEventListener(this.el, 'mousedown', this.mouseDownHandler); + Util.DOM.removeEventListener(this.el, 'mouseup', this.mouseUpHandler); + + }, + + + + /* + * Function: setCurrentTouchPoint + */ + setCurrentTouchPoint: function(touchPoint, touches){ + + this.touchFingerCount = touches.length; + + if (this.touchFingerCount === 1){ + touchPoint.x = touches[0].pageX; + touchPoint.y = touches[0].pageY; + } + else{ + this.touchFingerCount = 0; + touchPoint.x = 0; + touchPoint.y = 0; + } + + }, + + + + /* + * Function: onTouch + */ + onTouchStart: function(e){ + + e.preventDefault(); + + this.setCurrentTouchPoint(this.touchStartPoint, Util.DOM.getTouchEvent(e).touches); + + }, + + + + /* + * Function: onTouchMove + * For some reason, even though it's not a requirement, + * if we don't listen out for the touchmove event, + * we are unable to detect the swipe on Blackberry6 + */ + onTouchMove: function(e){ + + e.preventDefault(); + + }, + + + + /* + * Function: onTouchEnd + */ + onTouchEnd: function(e){ + + e.preventDefault(); + + var touchEndPoint = { x:0, y:0 }; + + var touchEvent = Util.DOM.getTouchEvent(e); + + if (!Util.isNothing(touchEvent.changedTouches)){ + // http://backtothecode.blogspot.com/2009/10/javascript-touch-and-gesture-events.html + // iOS removed the current touch from e.touches on "touchend" + // Need to look into e.changedTouches + this.setCurrentTouchPoint(touchEndPoint, touchEvent.changedTouches); + } + else{ + this.setCurrentTouchPoint(touchEndPoint, touchEvent.touches); + } + + if (this.touchFingerCount == 1){ + + this.fireTouchEvent(this.touchStartPoint, touchEndPoint); + + } + + }, + + + + /* + * Function: onMouseDown + */ + onMouseDown: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.touchStartPoint = Util.DOM.getMousePosition(e); + + }, + + + + /* + * Function: onMouseUp + */ + onMouseUp: function(e){ + + e.preventDefault(); + if (this.touchCancelsMouseEvents){ + return; + } + + this.fireTouchEvent(this.touchStartPoint, Util.DOM.getMousePosition(e)); + + }, + + + + /* + * Function: fireTouchEvent + */ + fireTouchEvent: function(touchStartPoint, touchEndPoint){ + + var action; + + var distance = touchEndPoint.x - touchStartPoint.x; + + if (Math.abs(distance) >= this.settings.swipeThreshold){ + + if (distance < 0){ + + // Swipe left + action = Code.PhotoSwipe.ViewportClass.Actions.swipeLeft; + + } + else{ + + // Swipe right + action = Code.PhotoSwipe.ViewportClass.Actions.swipeRight; + + } + + } + else{ + + // Click + action = Code.PhotoSwipe.ViewportClass.Actions.click; + + } + + if (Util.isNothing(action)){ + return; + } + + this.dispatchEvent({ + type: Code.PhotoSwipe.ViewportClass.EventTypes.onTouch, + target: this, + action: action + }); + + } + + }); + + + Code.PhotoSwipe.ViewportClass.CssClasses = { + viewport: 'ps-viewport' + }; + + + Code.PhotoSwipe.ViewportClass.Actions = { + click: 'click', + swipeLeft: 'swipeLeft', + swipeRight: 'swipeRight' + }; + + Code.PhotoSwipe.ViewportClass.EventTypes = { + onTouch: 'onTouch' + }; + + +})(Code.PhotoSwipe.Util); + diff --git a/tools/apache-ant-1.8.2/INSTALL b/tools/apache-ant-1.8.2/INSTALL new file mode 100644 index 000000000..83c11675a --- /dev/null +++ b/tools/apache-ant-1.8.2/INSTALL @@ -0,0 +1,2 @@ +For installation instructions see the manual in the docs subdirectory +or online at . diff --git a/tools/apache-ant-1.8.2/KEYS b/tools/apache-ant-1.8.2/KEYS new file mode 100644 index 000000000..26260e0f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/KEYS @@ -0,0 +1,1398 @@ +This file contains the PGP keys of various developers. + +Users: pgp < KEYS + gpg --import KEYS +Developers: + pgp -kxa and append it to this file. + (pgpk -ll && pgpk -xa ) >> this file. + (gpg --list-sigs + && gpg --armor --export ) >> this file. + +Type Bits/KeyID Date User ID +pub 1024/FEECAAED 1998/11/11 Stefan Bodewig + Stefan Bodewig + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: 2.6.3i + +mQCNAzZJoiMAAAEEAMzhUxTOC20Nprp6K4nLTiARt+EXii/dovNWWcfzZcYXi/lX +r3zpUTTZxlKQpd4RaHjFmGgoOraZE4jCRFARVcFJgYmGUKpcWJZO7YKL36WUizTM ++dyB2ycOtzlty1W5VmRL3FGqo67pKA9F/QHg3NSu9hY1W9xPPK7Kq3f+7KrtAAUR +tCBTdGVmYW4gQm9kZXdpZyA8Ym9kZXdpZ0Bib3N0LmRlPokAlQIFEDZSrGXHcgyK +jiW9zQEBshEEAMlG4qVjKp4/agdJG56M6izx9oaKecFLXHQJrFUy3w2PvZHFYtXc +osXKorX6bPrE8uB57MxbY2WapKeVRodlG0+j39vAf501duK8q2rktfWt9Cl4JjJ4 +DbWhSWfV1ci62u2gCxwYQe22F9Wh+vhOR5NK9RTbSKhupdlFsnrk/i7xiQCVAwUQ +NkmiI67Kq3f+7KrtAQGdxQQAlcFOzSv7G6M4uGbgvw7IGgrhx7rawtIyv9hLXgVC +7ua9xaZV8G0Fl9gh8RnbdcZ4R/aT+KIiAFaslfZ3t6hlC4MTbnAJqvdS/NO98ZkJ +YvnzZSKHflAbd5gyE7IVxBC9/xRlF/Wls5sYNwb6RjoRCaOjxN/y3WCLa3Va101v +zNy0I1N0ZWZhbiBCb2Rld2lnIDxib2Rld2lnQGFwYWNoZS5vcmc+iQCVAwUQOxIo +BK7Kq3f+7KrtAQGn6gP/SBACdHakA4H//otpyESSrk4PmyOaYF0Kyok43Gee2mT+ +m9+jZ3jLcC0oav6iH+otL/lhk9t/JDM8LjD2kAkdWWoIvvuPyCx97gOzojIo0Ve2 +1wuxJTF/VIjwyOtE8FzE7p4tkc6EubVpeZkV9Pq9HFRBCUcyKJDLnF4tbstScLU= +=OBLe +-----END PGP PUBLIC KEY BLOCK----- + + +pub 1024D/51898504 2001-05-29 Conor MacNeill +sig 3 51898504 2001-05-29 Conor MacNeill +sig 5F6B8B72 2002-01-11 Stefan Bodewig +uid Conor MacNeill +sig 3 51898504 2001-05-29 Conor MacNeill +sig 5F6B8B72 2002-01-11 Stefan Bodewig +sub 1024g/D1ECBA5D 2001-05-29 +sig 51898504 2001-05-29 Conor MacNeill + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.0 (GNU/Linux) + +mQGiBDsTqygRBACiZckNdclTlQFonLaIKBFGhMy0KKByw0x8XA4iwdbCXuF6xNIc +HIFHajJ74AHchQ4d8xtomBy6b8yvFgWVeaZensvn69BlLeqGdyeJRzfPt6TgRnzZ +2eWhb0HXdG3JwxL/2BabDhHfs4YJOrgB/vhRFQku6oCMRiBPtJj2werD6wCg0/zp +jacYTw6+CR+sVvneCNyySFED/R3j10c4RnR8djgv1jKT8CKPuHYraupI9INEe+I6 +7qWjtJ02GzvMO6TElAtUsf4aysu45GgwkwEBnuG6mYb3Pq0V2c5tJc2A3Tj3DrdR +i3HUNwurbus76I0sPyyENPu12QPeC6mvWLEsxVJ9o0hRKFayGvYUmrwWK9UFLjvp +p9cXBACDHgLn7MAVLqUdYhRrUj/M+GOUpvBikEgoJJrEUmb5X4+++dffMh5HBIO4 +5LA11qEKuM2xnKqOilP7NLYXz1Fe0ocqv0jsHB4SprFTTai7ma31uwuRQvCQXVv1 +yJ5CLqYda64h/UA2kmmR2dfopmvDogYEMz/HU5voozxe7BEI7bQhQ29ub3IgTWFj +TmVpbGwgPGNvbm9yQGFwYWNoZS5vcmc+iFcEExECABcFAjsTqygFCwcKAwQDFQMC +AxYCAQIXgAAKCRCBBGRPUYmFBDgIAKCZztXqKhK6kXOnoGy7opCNmWU0lwCgsPDa +4m+ruW3ch0rfbqtR75S52R+IRgQQEQIABgUCPD6eTgAKCRCiEVrhX2uLcqCcAKCr +1Wylqju9YjBi5Twej9ze69JFBQCeOaMgo6yjnkcV3PnVInLlaMwPr5q0LUNvbm9y +IE1hY05laWxsIDxjb25vckBjb3J0ZXhlYnVzaW5lc3MuY29tLmF1PohXBBMRAgAX +BQI7E6xMBQsHCgMEAxUDAgMWAgECF4AACgkQgQRkT1GJhQTY0ACgmZmKheHzjPJs +5hybpyvnvEiPYqYAn2+ryxdtz8XyOMExGRmHNlhG7svsiEYEEBECAAYFAjw+nlUA +CgkQohFa4V9ri3JYYACg1WN+NCptfKVP1mbrIa+0ajztsiIAnAn+m70iwRRFZCxr +jcULoY5SjyTLuQENBDsTqy0QBACfsCxJ6iCtgX8zjlVtMsMfDqu72x5sYatWKn8c +u+4Oj5mi0x6azZIhwCa+K3ihLVOyG1mCRnzztGTIxWYRhq3TESIVOfgm+NgLGrmA +XUTFyCT+21TExLCpuVZKmUHsWXLxDtfQ1diPeQpiQ8+Fvb/4jLGFjFIrQ2VjtFQn +kumkSwADBgP9H0bF4hdMuVEcSJ9imxSoJshcOOA3Vd2+YiCTZhBygWM49wY5jNos +/DArIjNCE53IlOu/UtHB2jqkSqjF0soGYsUjeCWouiTP9hLuMKPjnqj9ryJPTDKz +nTCZ4TuB5CtzrKTlWLmPCPpFsGqe4KjMeKg/mqGqjPKl97xgStK9N9GIRgQYEQIA +BgUCOxOrLQAKCRCBBGRPUYmFBMM6AJsF3FFyZGEmbt9aGG1W/u0oI9mcLgCfQyJ+ +aalbspazea4J9zgi59SSwOM= +=cBdR +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024R/697ECEDD 2000-04-06 Henri Gomez +sig 697ECEDD 2000-04-06 Henri Gomez + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.0 (GNU/Linux) + +mQCNAzjsydwAAAEEAMpwFU/ci3/wR3ryCGp9Exr+Rx/hTQ7hWAJcVw8ejlBXlT4T +yITlRUs0HGfRWxME2J55PuXXsIEPZzjfozNtvOyq8WlLlJ7iaiyWxVRoPJ25sSEj +C9etm6wjj4E66ZgzuElZkm1m69uEsCHPPNuz1oQ/g1O+SmIVxIYirlxpfs7dAAUR +tBxIZW5yaSBHb21leiA8aGdvbWV6QHNsaWIuZnI+iQCVAwUQOOzJ3IYirlxpfs7d +AQFQyQQAj0D9G0hEL7SQGaSCkkoXwvamQw42N8+tNm+jfWHWdE4HAiVlhJmI2GyD +sdcXVAcR8R7ILIRB5AY7a3bF+qMk0r+vO6oR878RKKn9AvtaAIOnrh6tr0tiPwf5 +XDUMySxIWJEF3SmJAy9Lq3bAl5GMzZCFHiS0NW2gtWgmr/u1RuM= +=6l+I +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024R/397DCAD5 2002-07-03 Henri Gomez +sig 397DCAD5 2002-07-03 Henri Gomez + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.0 (GNU/Linux) + +mQCNAz0i0UUAAAEEALXePN6IHne0W96YRMnR+4EXB6402QY5f8ZLcnSUZUH55Fb1 +qcZGBc3WRKlPiUvwBD+eVYgCpNSXF/H+oV1mawxNJN5XwqBEpfYmY8MRIPcqa61h +bJc3LBSm1qNf05G5Cwxeed+OgVm0r1HBy6DAgDHAqNlkC8DZ/BVgqMA5fcrVAAUR +tCpIZW5yaSBHb21leiA8aGdvbWV6QHVzZXJzLnNvdXJjZWZvcmdlLm5ldD6JAJUD +BRA9ItFFFWCowDl9ytUBASNyA/458T84LUVhqq6Y9fPBAfcFMWY2kehuDWsQEXkO +46XoK+AnFZCkKuyDLqPHchVUO5pK/gZYsDK/xJkfh3u4FTDTsecb9wFmIeyayVIN +SI8o6l8EZzDX/PGwqEwzxHrbQkIgIktNn5ApIoazvdBpbkQfNj1vr2wWoMYPLAWM +8xzecA== +=UmZ8 +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/307A10A5 2002-07-18 Henri Gomez +sig 3 307A10A5 2002-07-18 Henri Gomez +sub 2048g/862B8F70 2002-07-18 +sig 307A10A5 2002-07-18 Henri Gomez + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.0 (GNU/Linux) + +mQGiBD02vbERBAC1v8fR6gjERpaz4UMfdy0hRVWCPSbOdF+Swm/IenjVzErco6zb +MTa13umUNrDPBy/tTWiCCZrOnqi7fgDzWqPEqrXJjKAFVLEWE6MmKylPPEPG1/bm +idkNGERSAZduvhKv777PzvEJJ/8eGe3wy/O8NbgIjCPtr4UklwCZS8cFuwCg8oMO +UdT8qZRtzdxdAyu1m5fUb+MD/3IKJYWXsdtb6iBphCU4f/BoyjVC9EZJ1ywLuiVM +siKbuaDUaXU9nWcbNKv+fx8uZ1NaadpfLokqqhnWcpnSiqw8HNR7SwsF1D33rkXK +O4FSuVss/tIoqGdWFcJyPkP4yP5shxqR335narVw2vDa0+BiWkALbA2qVsSIdZDB +LeFZA/47AMBS0U2BRk2rQT8LmMuFl7mR+wNBM4n7FUGdxsGn3TcYd4pXTNrEQPrV +YNdooKlikgGk4hgFnIFX09Spmimqgq0goFue81rttVdZZ4uep8dTghY6gwmvcOxX +jATbhWStBhdu9B35kzfHc+1QihD5Z94u4uyWIVBIzikcdiY8LbQqSGVucmkgR29t +ZXogPGhnb21lekB1c2Vycy5zb3VyY2Vmb3JnZS5uZXQ+iFcEExECABcFAj02vbEF +CwcKAwQDFQMCAxYCAQIXgAAKCRAZMdaEMHoQpYijAKCCP68ndU/kTXR9XAKLvibC +3S8+1QCfUFQYte3Jo+MHKaWjsu9JGptRzo+5Ag0EPTa93RAIAKlsRJ5gOGTFsmaR +W9k6MIh4c/MCy7J7HUxT5xTdHROa+3zUh+FAE/JaOx9ZtZtH863DFHA8cP4L+tpi +PjBT6g2E94dwGcuH/OiSSCT4JSBukbGbOuLLdmFXqUl8+4gsL90Xal67FtNLwyLG +1n7geLir0byD+OT7VLA5w+6G0NOpJEveV/FIa2qLgdRZ8vz73ybgMh18hBUrUmro +jncp0rln2VU7VCH1C2aClKm7kK4mGAjIFIzKbguK+kM3b8NDHmXKpT6syyCtIM3h +prkV1TUCAFqLI32aSdlTN79lpeA2zDga9k4/4X/RDHsFpRN2neRFGTNUtuUgYpQQ +E5zWBmMAAwUH/RiGxyeBsad923IwE1+GAjxFl2tqF9xWk0J6yTnSK4nfhYAE9evV +jwDEok9jRl4ILCcXx6YN/d/lWNuSbARKHz/3hLiTouPpwd3SSJ8is2x9PgpJz5JX +cD0y1SkbPLvs3jH3ZmdcxZpuAmJeI/typqFKK5pWP44oXIH+XH/8nWDtmLEBkgKQ +/ATQWenMTmZ6MIJ6aWKWGkO9QS6iYRz3PPPGQ1O8W02CeprM2wBtlb8J1Z3RxNhM +rZcg/1Qi3V3D1HI4zw6tAFmDeBb8J4PaBQzqlhzx2EBTbfwNPhV8AlPvpxHEeGGn +v+O1yhZr33SnyZdINNoNDn+owVMdmkobe9GIRgQYEQIABgUCPTa93QAKCRAZMdaE +MHoQpRsTAJ4qst3MhLm48fBAEnzuzi/BIKr+AgCfYaCB/AvPoncQbHc8BcNGRimR +P9A= +=hQhz +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/EDF62C35 2002-04-10 Magesh Umasankar +sig 3 EDF62C35 2002-04-10 Magesh Umasankar +sig 3 5F6B8B72 2003-03-07 Stefan Bodewig +sub 1024g/B5FFC53F 2002-04-10 +sig EDF62C35 2002-04-10 Magesh Umasankar + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.0 (GNU/Linux) + +mQGiBDy0ebgRBADuKIKD8PuJ4wKEV1h2AprwJjxCRx8vn48XNwfLZuvhw8cpArtK +rZwhoGPPUPEEXgtTNerlKq4VwpAwcnvRz7oC/7aWkUbcR2sAyhfe2scohwPgw7Xv ++isWC0NDPdrxvXG/PUOG/cnELunr51ymybBqBxUd2gMhYIxPo67D+YPYLwCgwcZp +yc/6kJa116ESWHrti342GD8D/1srpnRs9CiS1DQF1uZ1wW4vzj4VD61tKsjdWD8D +V573R22iMDLSj4oMB536WxUH7snz8XsAKm/peqJ6G9m0smtmWA1ago5yzQj70WqF +xzWBhHn2I/YfAQ8pb2s9q1lClj8elnCxT65L27ydBAZteejb2VqjtQ6iGy86PUT2 +wRUvBADZmoV1eIZJEM5NnxBv1EtvRYZtIQEzZ8dO2A1LOS7qlVr8IypljNPLGhzX +VHNvVsjC9QMUSWeBsDedvQHQ3hJpIMnTI32XE1V4gX06gfVTZdhf2fLTtwnsHZp0 +oumqshGDVRhNJJdDYLikxWOxOfkNveKEqJFvtuBR+ZqqluQKebQlTWFnZXNoIFVt +YXNhbmthciA8dW1hZ2VzaEBhcGFjaGUub3JnPohXBBMRAgAXBQI8tHm4BQsHCgME +AxUDAgMWAgECF4AACgkQ76Pnee32LDWSRwCfeASWXvpdt7bSFPMtszU/7uPEktsA +n23mYUN5WKJA1ZreW+0CcZ2ESnOviEYEExECAAYFAj5ogYgACgkQohFa4V9ri3IW +YACgsxGig0PL0M86rJsA/IpXjBdg3ysAoJzsoUZ/7s2BxDfzF/FRTVIzS+TMuQEN +BDy0eb8QBACBVb9YDJRp9Irzmq71Jf9FIPw+4g/cWpF3t/Eb7eSzMcOvTAXyNIWz +aaOjHre7lFctHfq8ls/6gR7uqajiAnfQcfTcu7pp+F5KsU0Embt83SFzZ3aoJwET +mB/LqUyrrGDiue3lU+flJO7UmcsRvtk0+BDkyCeB9HgfdpXbBLCyuwADBQP+PNxX +4e1tg3ZJo/xNEnD2Re3HjmQRrr0RYJLUGjgQrAEONSgowx3IW8/JssmNJVjnYm0q +jSKsb8rergCFJhPNZ8Dd/k00pKcrq+IN6j7WTYLqPce87zrGAZUtmDwDSp5mxy5E +xWJJxsgBPk4YBQLzJt21A3BgK/i24Sze2VLbaZuIRgQYEQIABgUCPLR5vwAKCRDv +o+d57fYsNa8xAJ4mLfonZbd64+YY9rfvhIh3Vsl3AACeLPPKtma2K6XCfhTBEDnj +hzSr4vo= +=lBfF +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/5F6B8B72 2001-05-28 +uid Stefan Bodewig +sig 3 5F6B8B72 2001-05-28 Stefan Bodewig +sig 51898504 2002-01-11 Conor MacNeill +sig 3 F88341D9 2003-03-17 Lars Eilebrecht +sig 3 2261D073 2003-03-17 Astrid Kessler (Kess) +sig 21D0A71B 2003-03-17 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 75A67692 2003-03-18 Erik Abele +sig B3B2A12C 2003-05-20 ct magazine CERTIFICATE +sig 3 8103A37E 2003-04-04 Andre Malo +sig 3 5F6B8B72 2001-05-28 Stefan Bodewig +sig D6298F01 2003-04-27 Paulo Henrique Gaspar Jorge +sig 0CAA68B4 2004-11-11 Patrick Rentsch +sig 2FE28BCF 2005-07-01 Harald Wilhelm (HAWI) +sig 5793498F 2005-07-21 Tim Ellison +sig E4136392 2005-07-21 Noel J. Bergman +sig 8408F755 2005-07-21 Christian Geisert +sig 2 FC243F3C 2005-07-20 Henk P. Penning +sig 3 EC140B81 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 EE65E321 2005-07-20 Martin Kraemer +sig 3 A99F75DD 2005-07-21 Rodent of Unusual Size +sig 3 3642CB4B 2005-07-20 Martin Kraemer +sig 3 302DA568 2005-07-21 Rodent of Unusual Size (DSA) +sig 3 2C312D2F 2005-07-21 Rodent of Unusual Size +sig 3 CC78C893 2005-07-22 Rich Bowen +sig 3 E2D774DF 2005-07-22 Sylvain Wallez +sig 3 E04F9A89 2005-07-22 Roy T. Fielding +sig 3 015AFC8A 2005-07-22 Bertrand Delacretaz +sig 3 87315C31 2005-07-23 Raphaël Luta +sig 3 E41EDC7E 2005-07-24 Carsten Ziegeler +sig 3 F39B3750 2005-07-24 Colm MacCarthaigh +sig 1CD4861F 2005-07-25 Eran Chinthaka +sig EA1BA38D 2005-07-25 Ajith Harshana Ranabahu (Made at Apachecon 2005) +sig 333E4E84 2005-07-26 Chathura Kamalanath Herath (Apachecon Europe 2005) +sig 152924AF 2005-07-29 Sander Temme +sig 3 9C85222B 2005-07-24 Henning Schmiedehausen +sig 3 9978AF86 2005-07-25 [User ID not found] +sig 3 2A623F72 2005-07-25 [User ID not found] +sig 3 F8EA2967 2005-07-26 [User ID not found] +sig 3 C152431A 2005-07-27 Steve Loughran +sig DE885DD3 2005-11-25 Sander Striker +sig CE419C8F 2007-01-05 Upayavira +sig E222DE4F 2007-05-02 Mathias Herberts +sig 911203E4 2007-05-02 [User ID not found] +sig F12F6072 2007-05-05 [User ID not found] +sig 3 990ED4AA 2007-05-02 Knut Anders Hatlen +sig 3 311A3DE5 2007-05-05 Ruediger Pluem +sig 3 88817402 2007-05-06 Thomas Vandahl +sig 5F298824 2007-05-06 Simon Pepping +sig 4CEED75F 2007-05-06 Nick Burch +sig 4358C584 2007-05-06 Vincent Hennebert +sig 0B7E6CFA 2007-05-06 Sami Siren +sig 3 01530235 2007-05-02 Luc Maisonobe (SpaceRoots) +sig 40581837 2007-05-08 Nick Kew +uid Stefan Bodewig +sig 3 5F6B8B72 2003-03-07 Stefan Bodewig +sig 3 F88341D9 2003-03-17 Lars Eilebrecht +sig 3 2261D073 2003-03-17 Astrid Kessler (Kess) +sig 21D0A71B 2003-03-17 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 75A67692 2003-03-18 Erik Abele +sig B3B2A12C 2003-05-20 ct magazine CERTIFICATE +sig 3 8103A37E 2003-04-04 Andre Malo +sig 51898504 2005-06-21 Conor MacNeill +sig 0CAA68B4 2004-11-11 Patrick Rentsch +sig 2FE28BCF 2005-07-01 Harald Wilhelm (HAWI) +sig 5793498F 2005-07-21 Tim Ellison +sig 8408F755 2005-07-21 Christian Geisert +sig 3 EC140B81 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 EE65E321 2005-07-20 Martin Kraemer +sig 3 A99F75DD 2005-07-21 Rodent of Unusual Size +sig 3 3642CB4B 2005-07-20 Martin Kraemer +sig 3 302DA568 2005-07-21 Rodent of Unusual Size (DSA) +sig 3 2C312D2F 2005-07-21 Rodent of Unusual Size +sig 3 CC78C893 2005-07-22 Rich Bowen +sig 3 E2D774DF 2005-07-22 Sylvain Wallez +sig 3 E04F9A89 2005-07-22 Roy T. Fielding +sig 3 87315C31 2005-07-23 Raphaël Luta +sig 3 E41EDC7E 2005-07-24 Carsten Ziegeler +sig 3 F39B3750 2005-07-24 Colm MacCarthaigh +sig 1CD4861F 2005-07-25 Eran Chinthaka +sig EA1BA38D 2005-07-25 Ajith Harshana Ranabahu (Made at Apachecon 2005) +sig 333E4E84 2005-07-26 Chathura Kamalanath Herath (Apachecon Europe 2005) +sig 152924AF 2005-07-29 Sander Temme +sig 3 9C85222B 2005-07-24 Henning Schmiedehausen +sig 3 9978AF86 2005-07-25 [User ID not found] +sig 3 2A623F72 2005-07-25 [User ID not found] +sig 3 F8EA2967 2005-07-26 [User ID not found] +sig 3 C152431A 2005-07-27 Steve Loughran +sig DE885DD3 2005-11-25 Sander Striker +sig E222DE4F 2007-05-02 Mathias Herberts +sig 911203E4 2007-05-02 [User ID not found] +sig F12F6072 2007-05-05 [User ID not found] +sig 3 990ED4AA 2007-05-02 Knut Anders Hatlen +sig 3 311A3DE5 2007-05-05 Ruediger Pluem +sig 3 88817402 2007-05-06 Thomas Vandahl +sig 4CEED75F 2007-05-06 Nick Burch +sig 4358C584 2007-05-06 Vincent Hennebert +sig 0B7E6CFA 2007-05-06 Sami Siren +sig 3 DE8884A0 2007-05-07 Xavier Hanin +sig 3 01530235 2007-05-02 Luc Maisonobe (SpaceRoots) +sig 40581837 2007-05-08 Nick Kew +uid Stefan Bodewig +sig 3 5F6B8B72 2005-05-31 Stefan Bodewig +sig 51898504 2005-06-21 Conor MacNeill +sig 2FE28BCF 2005-07-01 Harald Wilhelm (HAWI) +sig 5793498F 2005-07-21 Tim Ellison +sig 3 EC140B81 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 EE65E321 2005-07-20 Martin Kraemer +sig 3 A99F75DD 2005-07-21 Rodent of Unusual Size +sig 3 21D0A71B 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 3642CB4B 2005-07-20 Martin Kraemer +sig 3 302DA568 2005-07-21 Rodent of Unusual Size (DSA) +sig 3 2C312D2F 2005-07-21 Rodent of Unusual Size +sig 3 CC78C893 2005-07-22 Rich Bowen +sig 3 E2D774DF 2005-07-22 Sylvain Wallez +sig 3 E04F9A89 2005-07-22 Roy T. Fielding +sig 3 87315C31 2005-07-23 Raphaël Luta +sig 3 E41EDC7E 2005-07-24 Carsten Ziegeler +sig 3 F39B3750 2005-07-24 Colm MacCarthaigh +sig 1CD4861F 2005-07-25 Eran Chinthaka +sig EA1BA38D 2005-07-25 Ajith Harshana Ranabahu (Made at Apachecon 2005) +sig 333E4E84 2005-07-26 Chathura Kamalanath Herath (Apachecon Europe 2005) +sig 152924AF 2005-07-29 Sander Temme +sig 3 9C85222B 2005-07-24 Henning Schmiedehausen +sig 3 9978AF86 2005-07-25 [User ID not found] +sig 3 2A623F72 2005-07-25 [User ID not found] +sig 3 F8EA2967 2005-07-26 [User ID not found] +sig 3 C152431A 2005-07-27 Steve Loughran +sig DE885DD3 2005-11-25 Sander Striker +sig E222DE4F 2007-05-02 Mathias Herberts +sig 911203E4 2007-05-02 [User ID not found] +sig F12F6072 2007-05-05 [User ID not found] +sig 3 990ED4AA 2007-05-02 Knut Anders Hatlen +sig 3 311A3DE5 2007-05-05 Ruediger Pluem +sig 3 88817402 2007-05-06 Thomas Vandahl +sig 4CEED75F 2007-05-06 Nick Burch +sig 4358C584 2007-05-06 Vincent Hennebert +sig 0B7E6CFA 2007-05-06 Sami Siren +sig 3 01530235 2007-05-02 Luc Maisonobe (SpaceRoots) +sig 40581837 2007-05-08 Nick Kew +sub 1024g/24774157 2001-05-28 +sig 5F6B8B72 2001-05-28 Stefan Bodewig + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.2 (GNU/Linux) + +mQGiBDsSIk4RBADSCj6rUjV64tYCGT1DYKYR7GthyWpNdGHSYLbETBcDatAe1dzQ +5NsCgfrlybfyeY+y1lxr3T9bqf6zJWDw/718wff96qmmv1qzexSYtmIrj+h53V82 +EXwWOFuYMJisuxdT940iQzosm3GOv4MJdEg3oI2SgfEyRQQ6vO4Ob5rHDwCg5taZ +nrHOrXx2dIGHxpxRZ0SUl30D/jmtttFjYOQ3LBMriikz5mh2sK3ZnoSRF4o5O0zW +Ve6e2SFXOEjVjImKsH6KCbdQNelrAdgiyOoXClyQKsQ27pncbdWo6bO0E3POJZVm +XaeW7iudHVr63rU5PViXObIQrdQl0D59j5brKj4vdlTyUw8kaHPvbKPDEOwvZq4Y +LJQ5BACA1YilTeXRJqwFsNlpcxCHwlULD4QUVP496prQWf1B7Z6g0KvLGrQsO0Vn +Jcn+fEqukysTJixSXCPebosltd4RalJIupVYkp4w6MJ7biaDAlLuNhDcI/AiXTmV +dXUedVXIaM8I3Ne23gucwbAyc0Hvb+3cSAKRhl/azFQhuHBvlrQjU3RlZmFuIEJv +ZGV3aWcgPGJvZGV3aWdAYXBhY2hlLm9yZz6IaAQTEQIAIAIXgAIZAQUCSgkegwUL +CQgHAwQVCgkIBRYCAwEAAh4BABIHZUdQRwABAQkQohFa4V9ri3IWMwCghs0wCe4g +GMPBq6jtBXK46e4aHKIAoNn+9NX6NlhF04qaHyDBhXK2HMmuiEYEEBECAAYFAjw+ +1Y8ACgkQgQRkT1GJhQSdkgCeM6RDHUF/E334TtiLPgw7GpmNJSkAoNCLQCW/9VHr +V+ZHsodnXUnaD4dIiJkEEwECAAYFAj513wwACgkQPo+38viDQdknZAPlHNiMnR+L +Uavo2yOYiJT+W9+8+qNs2grYDZ+WSYujaWT2NJrUCYXQRM6gKDyFlkcJvHI9lF2y +YMkVetllZVN1TJkeEdtbHncNHcdq+ZUQR0NkFKTF9d1K7UI2rfWxt1y6a13TcUjp +JXzbtw/OXX9EZSI6QQt4rSFlvci9J3mIRgQTEQIABgUCPnXawQAKCRDu0eo5ImHQ +c0W4AJ9vuq4wlkc6TmmmZPF/gZVLluHcTgCeItrnvzyS11xkIETk6v4b7K4gaiiI +PwMFED51qhr9b4jGIdCnGxECRAUAoOaVZW5CdZ9oYr3PwI/i8RJN+JfJAKCmd/XI +lYOCpa9Qc4C855pM8NFw6YhGBBARAgAGBQI+d6QQAAoJEBU/oM11pnaSL+sAn1DT +HmbhITeEw0ZSgyBLQw2ZhcM5AJ0ZrRBbZ9lbgHXBKOJQiLpWBj4XsYhGBBARAgAG +BQI+yi6WAAoJENvSRfyzsqEsF/AAoNXq7Cp/0AwEmWvhoTjmtY6eVYB5AKCMFhBU +dYWNXVyalPTq8ThswNUnr4hGBBMRAgAGBQI+jc4sAAoJEMppOXSBA6N+kUoAn1Nj +6YqarQg0sL2KrFsQROM3A6fSAKCyl40SpfVJSO33fYuPci9dHp+QCIhXBBMRAgAX +BQI7EiJOBQsHCgMEAxUDAgMWAgECF4AACgkQohFa4V9ri3IsngCfbIpJDWj6UgXY +7rBH8To12BgB+RIAn3jw72WJzplAtShVTmuMlRFS+FUNiEYEEBECAAYFAj6sazwA +CgkQqywx6dYpjwFkeQCeOkJrnO5r2hWDhX4ACPPLObZvXLIAnR0VHAgkEH1W/t7B +4zdDYdBBZrd5iEYEEBECAAYFAkGS8mMACgkQ5BNhMwyqaLQs9ACgio5zJcieYLpp +igvSYLBfubUVrXUAnRKZJ6MACpH6fpoz2vkc2dh69tbSiEYEEBECAAYFAkLFMoEA +CgkQm/IjRS/ii88aCQCfd1cIawDqpkYU86f3JEjcN85ntFcAni0m8WR6s+bkh3fd ++EIrSRsru3uQiEYEEBECAAYFAkLfRQIACgkQQeoJoFeTSY8XxQCdFd+XEWqyDkCx +37gaIQAG4dHpwiUAoOZ/K5OHyTJCNFaBUDtpCh7hL8TPiEYEEBECAAYFAkLfkncA +CgkQAQVmvOQTY5L3SgCgiEi5/1vYvJrKoAdl0hRWU57ieUIAn2n08BQfMZJQ439a +NW/CnIK8jPBPiEYEEBECAAYFAkLgNdAACgkQc84u+4QI91XdNQCgoBB1ebohIfli +nAPlvI37pFHuu0MAoJ4yMtbKZMaq0xIBnxV9c5uu99tGiEYEEhECAAYFAkLerWMA +CgkQi5YpQ/wkPzxD7ACgqKnyeb/fjVS8vov4FePxeLju4msAn1SCGaiF9gEf+qIa +ZUnjcT7JDJ96iJwEEwECAAYFAkLerG8ACgkQMaY9luwUC4Ea9gP/WON+0xIWOvWP +7mKkg/+X0ukW+mbjE426qKtG/B0vNrTKpElmz8ttR+oajqbg20LazoEUuA9ZXjLP +fsdWA+vFkxgV6qIdtxYPMamPm7ytEBOmgMowYXUftGteqM5fxLlceHiwdUlynG2f +mtMqvPnd2OCezSFRx3W6nvAiIjoLZpCInAQTAQIABgUCQt7H0wAKCRA34/Rf7mXj +IcAUA/4nDlQbnToSSDOZkFj1CoGL8TjsVgzrO3r3S3x38uQQTFAE/AGBY4mtHgNc +YmiJaC2hN1Y+mlEGu/80Rjv185ZfJsFEerU6Y/9tRJJ1So9AAe5AmvGpD9ysXae5 +geB+k+epIMSuf9WMeTRUCbQs9ufGZLV5a8jqstv+btcrzNaY9oicBBMBAgAGBQJC +32x4AAoJEJrNPMCpn3XdRBkD/iNi0Y6A3afDG9ZL/K4JrOPgHUFWC/DgAEBme4AY +62agUsT0uXlz+Mu1Ps2E0t26ejScuVMMvqpXg7iJ2+3yKzsnX0ySEXW6/696XEpe +3TFn1iVOmMElPKxakn3t/jr6SDepo9jqD5P5CJR4GsDsG3iKIisWdDf81ZXpf86y +7A5eiEYEExECAAYFAkLeuuUACgkQMsnkzjZCy0vmSQCdHGC6jOEVo96yyospTq7b +L+EEeioAoNMKIZy5qFLXXZbSNvsj7mDRg2c8iEYEExECAAYFAkLfbHoACgkQUI6u +xTAtpWhYhQCaAvqVBsTX5s4c+sTOo06BNMdzHIUAoIwpThAKq936Szy/3Gfv8K3g +s5NOiEYEExECAAYFAkLfbHwACgkQ3bpkuiwxLS9z8ACfYeocOK4J204xwbXgEdUJ +QyvHK2UAoKz2AF1I2b8Ebu7vTUZLNFV1QMtwiEYEExECAAYFAkLgyTgACgkQXP03 ++sx4yJNbEgCfRcj6QKHVHQtYVXdCYKUbrj97wAoAnimqV15cvz1siDjUK9K/aTsk +GwajiEYEExECAAYFAkLg7MsACgkQybWm7OLXdN8UoQCdFfqef8My1xhn6mLd9WTL +LaIewTQAnRXGh/Af4hVG0KwtZcJEA464nCoJiEYEExECAAYFAkLg7TwACgkQW5aA +EOBPmol+JwCeLxZjKNisjgP4AxV5BCKR+5SU9NoAoIwPF/7B2NmGNR0t3EZze8wp +NhQ0iEYEExECAAYFAkLg7V8ACgkQN/aP9QFa/IqerACfafKJi4s8LYV2JxNfQKHg +mRXzeIIAoNBHOzukDCdxIvmYJfamItnCP45giEYEExECAAYFAkLiYm8ACgkQbZiN +F4cxXDH8HwCgq8P29CwMX7PKhRmY3T32APsOaMEAnjdd/WvzVBFtTcJFWkH6iF4L +8EQpiEYEExECAAYFAkLjVb4ACgkQEy5J1OQe3H56DACcDPfWLO5cDkeKFCvIP8mc +4p4KkfkAoJITROldIRxXqUiML1oTJxieuHJfiEYEExECAAYFAkLjZNoACgkQdcqi +o/ObN1CItACgsJhqBxeZTaSrRVNk3aj6ciAJrgEAoIxPXYTvIpnWBr4/WMbN0jpV +0TGEiEYEEBECAAYFAkLkbxIACgkQjON2uBzUhh/gZQCbBpIqkCEuIbd6tqChz3Pz +cIGiZbgAnjluBFHl4l1/NHtP9fEYCgl8nbCviEYEEBECAAYFAkLkkr4ACgkQBJE0 +Quobo42f+QCgjtO6EOdDRiruCi6gKvwM1a2eRwcAn0XUELm5AZezL5E0rEfIM2FB +iMi5iEYEEBECAAYFAkLlwh0ACgkQYRlqLjM+ToS9pwCfUEgO834XY/clWzkw/VLB +fe7MLZQAmwdz0nleOHYWFBrnYgEz53d4MxUPiEYEEBECAAYFAkLqY/QACgkQsr68 +QBUpJK/oMQCfc7M9KpApCWW7eE22PlLoN1sPK+4AoJdwE8TsDM2Pmehk9K+uHIx6 +FoRviEYEExECAAYFAkLj7WcACgkQMoZOQZyFIitClACfWpH0+V/N6vuucWZ7bsMm +2BcmM3oAn3fF5qqovlog4/PcgvKCToNEF8uWiEYEExECAAYFAkLlELcACgkQUnkv +r5l4r4YUZwCgg7vJpDpUXnuNvgc5RHgG7UYhRQYAoIEKHsrswh6XzVn5yQRkfjdB +/A0OiEYEExECAAYFAkLlEaQACgkQa3OhBipiP3JA4QCffb8NgQssOQXaVR0dSwPC +eU2nQPUAn15EAjykVZsUi2tZWqEM08SNOKI9iEYEExECAAYFAkLmmWIACgkQaOuM +dvjqKWd7AQCbBpwyitQ77kd9KIT6y95Im1vmWt8AnAnkNTBctVtMfwddYTG+xLka +OllOiEYEExECAAYFAkLnYVAACgkQbpR1lMFSQxqIRACffQqUXTgOa4hyHYQBUwrl +GEqmWt4AnRMXVGhd47loS27MmiEiWwDlkNjJiEYEEBECAAYFAkOHn54ACgkQZjW2 +wN6IXdOr9gCgh2fn26W0DSL5WZATvvQkwZeJNiMAnR6+0AlUK8uFSFIVhl+RZMnY ++XFwiEYEEBECAAYFAkWdnk0ACgkQIYJJVs5BnI/0SgCeKCw39INy9ISFunlAojYg +SInHfokAn2vU8q4JNjg13qNeclZN9kmN9mbWiEYEEBECAAYFAkY44sMACgkQFUWz +/uIi3k+qvACffppBpoY82MEvDV7c4/6cjw544CQAoJAPCdZA/LRqICJm0iFbDrwh +sSb6iEYEEBECAAYFAkY4558ACgkQY9CtrpESA+QrAACglRB/VdEmovbyWdMDmsTd +yw4kha4An0uKwZeKHfBR3cC2s7MvqqmMoz9jiEUEEBECAAYFAkY8kyoACgkQmHDv +8/EvYHIkCgCYgXQZTJ8VmHwSX3pXOxnMhp7mbACeIPXwcPvmfP709nfgQ8/GpT2z +9ISIRgQTEQIABgUCRjkasQAKCRDh4fKwmQ7UqhZKAJ9iraDBstzeXPMtst3x+ZXd +LQm7cgCfWDDgaQOa8CoM5/+7WCtkyasP6BiIRgQTEQIABgUCRjxQRwAKCRBMBCgY +MRo95eP4AKCuEQU6fjPy/cPEiqhGH23J2YEr7gCfS8vBTEU4sRbOomTEuINPxb96 +OZmIRgQTEQIABgUCRj2gkgAKCRAuuUaCiIF0AgOBAJ0bJmFzA9WkG5FmfaP4ieG9 ++SCbXACgw+2wcOA/B94LKRtjhJT6j6zSiDmIRgQQEQIABgUCRj4VvwAKCRA+Km/C +XymIJIvcAJ9QSE4mCQldVnpbYwLTCk+xHDqhcQCggT9P3/rHIzIvv1tJ+A1ZJPvX +OcqIRgQQEQIABgUCRj3WeAAKCRD1wmAWTO7XXwpbAJ4mr2IxFtx0ppkefxx0l0TJ +6cFkrQCdEFbc+aMxRKhK9SCAWi3mq1UqEWiIRgQQEQIABgUCRj31AAAKCRCgctTQ +Q1jFhByKAJ9SIielTuD3StxPQpBkAkYP6Ld88ACgg1oPX9ryJA7YuhMD7byXQsET +zD+IRgQQEQIABgUCRj4FxQAKCRACpaYFC35s+k/GAJ9/VDyw2vNzk1xjcu/QZCa3 +gGI2zgCfeG8klJ78bAGknzxBlK3XtmoNqASISgQQEQIACgUCRjj3hAMFAzwACgkQ +c92MFgFTAjVJogCeL+3FTTVR5snJx9qbGQsgv23ZaT0An2Hy1CcXVklcYBF7Lbnb +Agbe1HpfiEYEEBECAAYFAkZAtkMACgkQbQvHOkBYGDePegCbBe6rmz9/kYDV7w5p +vwnugVsvbiEAniTfLW7NW8z1SRBWf6lMH3clGAs8iEYEEBECAAYFAkZMRFMACgkQ +HyEjw2vYcqB22gCg1np1JYFYPqCB3ekZts3K+pn7RkwAnRWd6HmtjRolZdrZfkqQ +DJKmd5zviEYEEBECAAYFAkZMfQEACgkQD0UKJmIQv8DJYgCfW0C9rDAToLU+0BKL +YCiWwtFJ98MAn2HvQ3CDhv8WTm+av36lETLqhjnfiEYEEBECAAYFAkZSb1kACgkQ +MsHW7w8UO8GGZwCg0l2T1O/OpOECXs/vYE2649wNTaYAoLrUpLKYev8uHAfc53lZ +6LE0h1T0iEYEEBECAAYFAkZSb2AACgkQy66+OaRsTKHZbwCdFSloWJh3uuTLk87a +St4uYeZrKToAoIrN7epZxeu9n9e6hqVOLz85zc3TiEYEEBECAAYFAkZe1aoACgkQ +mobXzNGq6mD+cwCg3k4BRrRi6pjrY/UggHjhiHWSD1YAniDQn1MVB620Ik2cVL7h +R1V0ZL6biEYEEBECAAYFAkalTCwACgkQOb5RoQhMkROqQwCdHhIdklVR341azVFB +O6aGArSOP2QAn0WtSIiqaLTEQ57+ir62FxRYBQdWiEYEEBECAAYFAkatzFQACgkQ +M81nM69exFIdRgCfSGft6KIZ+CTEPIGr8lp8oOpNaHMAn1NCXZTJOW+r0G5ply4h +lu8UXC4AiQEcBBABAgAGBQJHwH2YAAoJEBllhVDDEQYRZ4cH/3XnLW6UAdDd4k0x +l2lUAj9gB7ITUbejCwvnFqUyKAE9P38boBHNfc6cliQUOz4ITWDPhiinbjNnJHgl +p9vK0o4R/tFFyGImIvbmu1C8lyO2BJPgF2yMNrBgZhx0+IkAG3R4iy9JFIDGgddj +LQSP4TX3uRUFUXEAhHzGA//XP4tnC3CisvOsuoc6ZjyZGSt/HUzZoKf+wsdJlfab +iK3QpD8lSOw8KEZF54JUC8uaYGuBGs7ih4FcO+Aqb52UAx4/+13eEdAognVF2Hba +iI+G2jEekyAwD0bP3DWyg+9fGBtnwtDMj0OrHklvA8qoHxAMvXHIGhxjqZBOFehh +8DNEB6SIRgQQEQIABgUCScqH2QAKCRDJx5JOUQR9Zj6WAJwOtRlhq45DedrYNH54 +QIJSFw3XJQCfQI9fZl6zmKWSm1nJqXRC+awKmwyIRgQQEQIABgUCSc/UtQAKCRAk +waN4agF7F75XAJ0TyTdCMGIZGCooM/xr3w+qvyZLgACg0W8O9WOf0qwSVgynmh2v +QggUiyKIRgQQEQIABgUCSdI2jwAKCRCusBoVO3x1sZHiAKClsXinnJfHMQYewFPq +y16zr//f4ACgulnu+ObADHMquuGCw4BLwrvqMIK0IFN0ZWZhbiBCb2Rld2lnIDxi +b2Rld2lnQGJvc3QuZGU+iF8EExECABcFAjsSOYEFCwcKAwQDFQMCAxYCAQIXgAAS +CRCiEVrhX2uLcgdlR1BHAAEByboAoNoD/9Jgm/alxfAYELz05LMa/HLeAKDWTHqq +7rMkppZoTUv2gWpVzrk5RIhGBBARAgAGBQI8PtWVAAoJEIEEZE9RiYUE0LMAn22/ +u01Lo3Bo5lDxxHSkayUkYq25AKCm20yaGFGtTDJW4Rdz50pfut1AwoiZBBMBAgAG +BQI+dd8PAAoJED6Pt/L4g0HZWboD4gPGJi0y93+Zp37uFGgpe8PkB10HVLCe9B0l +7R7BK0UFhnFl004td2RWeALAAnOI8ZlxCahwQdUys34zF77c5fQ8Rn7co46wBSL5 +9Oi/bG9/wRYqBf13SWL2ITK1UDgzRznZrds9MLQqSL8oBjebyg28CZPBYH10FKig +UUMwiEYEExECAAYFAj512scACgkQ7tHqOSJh0HOu5gCcDO9Ou8NA2+gChoNAn6j/ +J2owDxkAnA0Q5AMezP7rKdsw+hCYqZSp8QhIiD8DBRA+daoh/W+IxiHQpxsRAiSn +AJ4id/ijcLliSH/EGh1UiaunYK9zLwCgyfeZ7mnhKXauba2NXFMlm3axSvuIRgQQ +EQIABgUCPnekGgAKCRAVP6DNdaZ2kikaAKCJMBE/oJ/4ko7FRpUWvQv0MLmhRwCg +jEXsPmY5Ur8AVynVzE2TcEu12reIRgQQEQIABgUCPsouMgAKCRDb0kX8s7KhLABs +AKCU2ntXY/DhTnvki6igzrvttl/ynACfZTZNwePs9imtT6phGTInelrsXLKIRgQT +EQIABgUCPo3ONQAKCRDKaTl0gQOjflg/AJ4khT+aic33qc/iMmMC5+URcxt6ZQCg +leruhUJi44Kpav9PdVbQMzdb52eIRgQQEQIABgUCQZLz6wAKCRDkE2EzDKpotDZH +AJ4xwN/htv44yNFQnACTYsc322HjZACfTd9WoxRkRWY6tVd9YgumNc0swMiIRgQQ +EQIABgUCQsUyhgAKCRCb8iNFL+KLz+ClAJ99ddEJ5l/VW/mKHvTITZleDSv+uwCg +lgqx3HQrlqp+gTPKIEKPkjjom+GIagQwEQIAKgUCQuE4ECMdIFRoaXMgd2FzIGEg +am9iIGFkZHJlc3MgYW5kIEkgcXVpdAAKCRCiEVrhX2uLcvEYAKCJD7CVpr2Iw657 +kO6G3Is8xKa6IgCgiStyJgU5/dUEEPQctZ8ZVZSrHNGIRgQQEQIABgUCQt9FDAAK +CRBB6gmgV5NJj+d2AJ9QRCXhFzmee7cbhlfejg7LBsXsMQCfce2/Wz+if56L7WaZ +Lpn893CAzu+InAQTAQIABgUCQt6scQAKCRAxpj2W7BQLgXUkA/96klgNlfh+VTSx +rwCUW1JE5j87qDeJWrnN5ibVYPd7TE45hNeWQie2RgWGpsHNlDekVh9aZuHMJb9N +zRGKAAJ2augQQuvDKt8sge+ydRMXsLkAvpK4VBmobqqgyO0cV3ooMyizawMRndVc +MbVu5b6Gkdj2tZEko/Nv9KBJ61MJ64icBBMBAgAGBQJC3sfZAAoJEDfj9F/uZeMh +rGYEAKJgLDFku3GdpF/BI4GQBKqadLygF3Igq9Np310sTcLOI2ARb4B18Tvq9CyR +4PEvdlVC5uEpaJozgHthTadjGTgg1WmiTWqG31s3U+zL5NLdK+k8qqrxGLzFzhk8 +PB1wJwImJcvLmJHm3HeIGycdEzn4swgmD4uI6p39mcGyCCONiJwEEwECAAYFAkLf +bHkACgkQms08wKmfdd2sxAP/e8W2cqyypPqYHs05nTxNzD5wLl72ABWvljfdf5mA +97sEl3q48234j3sUN1Uk6c21NlK+eRBn8Lv1ihyLTJkACgdiXNFvi1eC4vLhQMGO +PcGW8+wI4olmsqftvG+2hNt4eCMead6IjAK7LNKgDWEBjGI+WIOvC5UJBO50cNXG +OXWIRgQTEQIABgUCQt667QAKCRAyyeTONkLLSxJgAJ9faCKziDmN6nQeMoAECTfV +vIdTRACgjnb3h8sc54gcosIh28qb7uBUuf6IRgQTEQIABgUCQt9sewAKCRBQjq7F +MC2laDoHAJ9VC11NFs0+BAYWoZBJSUEnjn3F9gCgsqGPrxhTBkHlWAh4iiumq31t +ZHaIRgQTEQIABgUCQt9sfQAKCRDdumS6LDEtL3hJAKCEHj7lHAZHRk7LLbFQDh7o +iY7plACgiORbBhF3VWn1JCglbk51Kq5hJy2IRgQTEQIABgUCQuDJOwAKCRBc/Tf6 +zHjIk6wAAJ4qjf2FNE1VXK+PnL2iFP1h7f8L4wCfbtoQqsaDE1vCrnSobEUT6nfq +Pt+IRgQTEQIABgUCQuDszAAKCRDJtabs4td03yLQAKCz5pbjUWdyEHQr85R0He3Q +uDiLkgCgz6XQ/LFLdcmwDAj4lsKbRpHdUDyIRgQTEQIABgUCQuDtQAAKCRBbloAQ +4E+aiRuoAJwLeKfpT6aqNLBvrusHnNNjROFi5wCgjhXup7RcdMNTDBY6BGj83NHu +TU6IRgQTEQIABgUCQuJibwAKCRBtmI0XhzFcMZwOAKCLkKunJnUNy7QgowvTkV+/ +DyU+FgCfScvQFzMSj1Gk1ViDbK0n5i2MpQWIRgQTEQIABgUCQuNVwAAKCRATLknU +5B7cfur2AJ9XnFPKjlIPsbrZVJRuNh96py7FfACgoC5yGwyRq9hYK3SMGGAu5MmQ +WpSIRgQTEQIABgUCQuNk2wAKCRB1yqKj85s3UB1kAKClSCLmqecNSlVeFOwlSijh +TjzmxgCg5eYxuHJo4wf2D2d1gWbloc8xt/2IRgQQEQIABgUCQuRvFAAKCRCM43a4 +HNSGH1JzAKCoUQuAh01aTLbbUS4WCMrOAQblagCfdwFlsT48wWEBnJSFAiXaEcRt +UkiIRgQQEQIABgUCQuSSxwAKCRAEkTRC6hujjcShAJ9EK1u8wehMaZLt2ZnexHIC +PhbtagCgkN+i7LXBnm1IwlP5cGbmgW3BJRKIRgQQEQIABgUCQuXCIAAKCRBhGWou +Mz5OhEAfAJsHEwc1jK9tiYBvWRMS3zJ0XrrShgCffOyuZlrBNeuO9s8T9WkL7/vC +nOmIRgQQEQIABgUCQupj+AAKCRCyvrxAFSkkrxWDAJ9oJHjkm3MWfPS/iMK6iipo +UaAfzQCfYFygT+mws9MQIZEMoTi/sk0AOcKIRgQTEQIABgUCQuPtagAKCRAyhk5B +nIUiKxsGAJ4mMBcsZ/PlqEN2CjOoNits7PFYbwCeLuEXDDEcUAh7jb46wvrHB5EP +jp+IRgQTEQIABgUCQuUQtwAKCRBSeS+vmXivhlvNAJ4wGMXMO8EgWYrlU0i+9wrd +6N0M/ACgvODXK0oKDcDQ55t8xf2evmJA7HCIRgQTEQIABgUCQuURpQAKCRBrc6EG +KmI/cl6+AJ4kaPB7Ois5KuLwhbEwmpO3e07OQQCgw1kJOjcCZwogIWG1222By45k +1YCIRgQTEQIABgUCQuaZYgAKCRBo64x2+OopZ+DxAJ91h0aGRvukGqAWEafe4nnT +6xj9CACfU91kJ9G1WB2T8lW/fkXt8mnlrUKIRgQTEQIABgUCQudhVwAKCRBulHWU +wVJDGgmCAJ9DsO7lkpvuigmPoIX6d7vufFW5iACeMsXW1nX0DWf6E9pPgDaeZ+db +a1GIRgQQEQIABgUCQ4efngAKCRBmNbbA3ohd09++AJ9GFjNIUutctozuFNreIeS2 +xATWJQCfTUwt6nd4R13f5U0+iOsTwWVX6h2IRgQQEQIABgUCQ4efngAKCRBmNbbA +3ohd06v2AKCHZ+fbpbQNIvlZkBO+9CTBl4k2IwCdHr7QCVQry4VIUhWGX5Fkydj5 +cXCJARwEEAECAAYFAkfAfZgACgkQGWWFUMMRBhFLagf6AqFi2y+DPg+duogX5hHs +lLpeRVXbqEqX9bB2BzzinUhTmmRpEpiVnCkTd69scXh/ZVTECfA2zBYV67gp3eit +UB7CDSeLZwqQCIz42uF5ADq9oj+j6uf8pPmsk9qO4VZcr7mUwJ4tDy6znG7Qg5H7 +y4HRRQ8cwodDIa2jpLdQ+v9+fms4Nq5j/IJRmHjT7Ha6n78arpl8DlBtjjG0dpmK +fBB9n68MbiFLX19yIxO98X/nEoDCk6DuLX79Ratt4jEr08YCyJ4PfAqJKUy+F5jr +Knp3G/qj6H2N72vHZLzoZRfZjBzbpN3V9rPossxQauoRqmU5M9wFDnBoqyszMMU+ +KokBHAQQAQIABgUCR8B9mAAKCRAZZYVQwxEGEWeHB/915y1ulAHQ3eJNMZdpVAI/ +YAeyE1G3owsL5xalMigBPT9/G6ARzX3OnJYkFDs+CE1gz4Yop24zZyR4JafbytKO +Ef7RRchiJiL25rtQvJcjtgST4BdsjDawYGYcdPiJABt0eIsvSRSAxoHXYy0Ej+E1 +97kVBVFxAIR8xgP/1z+LZwtworLzrLqHOmY8mRkrfx1M2aCn/sLHSZX2m4it0KQ/ +JUjsPChGReeCVAvLmmBrgRrO4oeBXDvgKm+dlAMeP/td3hHQKIJ1Rdh22oiPhtox +HpMgMA9Gz9w1soPvXxgbZ8LQzI9Dqx5JbwPKqB8QDL1xyBocY6mQThXoYfAzRAek +tCpTdGVmYW4gQm9kZXdpZyA8c3RlZmFuLmJvZGV3aWdAZnJlZW5ldC5kZT6IYAQT +EQIAIAIbAwIeAQIXgAUCSgkeigULCQgHAwQVCgkIBRYCAwEAAAoJEKIRWuFfa4ty +6SoAn2X4c0dOTQp0dk+ofvPDMtNWBbIXAKDdrSAnSP/iaXIouTg9ncAERnXFgoiZ +BBMBAgAGBQI+dd8PAAoJED6Pt/L4g0HZhpID51GCXx5Q60No2CVrjw73vZ+KVfTr +8iJZSsi3X1C47C1l8OCZvnzECYFq9hhKL9WWCMktvqxg2aW8/78WgVW4KjPEz3Yl +88cFPABauJPhJuHyl0efAci0iY7yy82utbKTRyXp5xFBad7U6RLK+GzbrmqEWIbY +is06jbqAvtMfiEYEExECAAYFAj512scACgkQ7tHqOSJh0HOZXACfRTqAC+LhzLqh +1668bBFTybxCdvwAoIGjkethM4lKnKqXZv9Wctz+E9toiD8DBRA+dao4/W+IxiHQ +pxsRAlrLAKCp5Eet21hghQweWCbX2Sfp0Kt0wACg9W8xv5CE0KSB7E9rwmNcgZpV +mwWIRgQQEQIABgUCPnekGgAKCRAVP6DNdaZ2kvvSAJ9JBZVwMzoYbuK+X4JTFbsO +W0wHdACgrWEV9hElP/rbBPL7l1rbDAhniOWIRgQQEQIABgUCPsouuwAKCRDb0kX8 +s7KhLEnHAKCqht/V9susaEGuep74heYgo/6ExQCcCysfRsihFG0jPX/yEOwLGT4R +0+eIRgQTEQIABgUCPo3ONQAKCRDKaTl0gQOjfsWIAJ9R2xmpnF0w2EhY591OYpNr +0GvJ7gCgv7lDNNYLHZ/u9RIgJJq45R+h/TCIRgQQEQIABgUCQrgKqwAKCRCBBGRP +UYmFBNDFAJ93FhVVtNwg7jLgO00lKk3/3lgEVgCgvxo0Jz2dPoOzWw8OvGUmN5PF +rrqIRgQQEQIABgUCQZLz+QAKCRDkE2EzDKpotBiEAJ9ZqXR8/8Ffvq0lNkJ+0d9r +JXzXaQCgyT6qZ5nDeDFJpPdMmRHhwHSZq4SIRgQQEQIABgUCQsUyhgAKCRCb8iNF +L+KLz92FAJ9c/C9RJy3SGLbVq09c7NBPPS8+AQCeLBc3EqtjTtzmbBEH4fRegq1H +t1KIRgQQEQIABgUCQt9FDAAKCRBB6gmgV5NJjyFIAKDhfzgs3KPp/97Biee5tPmq +hizsIwCfWwvOgdoUb5GmZRpv53t08woBRp6IRgQQEQIABgUCQuA10wAKCRBzzi77 +hAj3VbBKAJ9oavMNCVLXyabt0pjFJBWSwRZt/gCePKcZox146ASRqaJF8OIvQn2+ +egaImwQTAQIABgUCQt6scQAKCRAxpj2W7BQLgRg1A/d5x83A1kegLg8Q72g6dcUf +KCWR6I3mfbFkkUH34jSShdO773Yxm8oKolm0JrUzPagZwMRIgaUqSXpgYbxkyorz +5G/R/PCkHto6qMAztyCaKyFTE/nlBQfuKZ+XPpBSw/yIRu6IWdqwSHOOy+thRbg9 +fXrMbzHFXpawRauu2VeCiJwEEwECAAYFAkLex9kACgkQN+P0X+5l4yGPbwQA6q4L +s5TTiRZFrxJIHVVwgh9kz9zlLj2fSULWyX25INZ59YQpzCE2qTSZRBN8sowe5BKQ +ZJlLcir91UsDg7KX4rP6bOsyUSJ3v9kecarU9/B3/7GLnKDGVHHoqRQKAi2DqpCi +SsE6WDNONNXVKbsadcvC6uTdEg7U1vXyjDbPY4qInAQTAQIABgUCQt9seQAKCRCa +zTzAqZ913XpNBADS498IdhQrpMnbH0s6oIxQ6ZFY4gcW07QnqfOn5WizKxdx9InX +JBgozFH/yaLLQbI8AqS9lZQrb4cJeWYCM5vJbnHh7qatoguYb1DdCIyriFzC22T+ +wxPi33L8PNpyrfCTT6Y6LF4jIcrEGZrNl37jT+n/xMvCeY2gdmdiQmFiQYhGBBMR +AgAGBQJC3rrtAAoJEDLJ5M42QstLwa4AoJXwrbSMRRqlUy06v54T50RTB1/WAKDO +GdOaE7jxcRlkuEc8Qswm976bAIhGBBMRAgAGBQJC32x7AAoJEFCOrsUwLaVoIqQA +n0wc28m+1XNI69hWQ4lyRVEgQqBGAJ0fsklpnnZHCVhEkrakbLQ/E+9pjohGBBMR +AgAGBQJC32x9AAoJEN26ZLosMS0v+UQAoJvPJaWA8ctG2Bff7mxW76gsOovWAJ46 +0KDi0QbUOEJiD0fk//R0XjnknIhGBBMRAgAGBQJC4Mk8AAoJEFz9N/rMeMiTV8UA +n36HHFAVjudWCBDNJm7KqZyh7WsKAJ9sU4g4KN047W0SbJAA7sPkJwE0C4hGBBMR +AgAGBQJC4OzMAAoJEMm1puzi13TfGz8An3irX0FipvIvirhSUyKDE7wDeuUEAJ9g +PRtcLRDeFc4Oh35077YLrN9q0YhGBBMRAgAGBQJC4O1AAAoJEFuWgBDgT5qJwJMA +n3hd5dZRNloo0BdAZjzH6r5MgNlHAJ0UM7nOz1sj9J8nRqCb3xFBwclbO4hGBBMR +AgAGBQJC4mJvAAoJEG2YjReHMVwxAuoAoKiAof3Y87dYurmnSQDs7WXP88ZdAJ40 +dTmjNicUfsKit5aEkxCl9bjqQYhGBBMRAgAGBQJC41XAAAoJEBMuSdTkHtx+60cA +niVi5i8j86YN56+uY+wMahkSXg31AJ0U9jmvOXQDNNsIHWJY9xXoz7jRc4hGBBMR +AgAGBQJC42TbAAoJEHXKoqPzmzdQwPoAnjmnjGqxCQz22Y2jd8vz3+Twfwr9AKDB +j4z0kxrf4hydmgK38ndDBP0edohGBBARAgAGBQJC5G8UAAoJEIzjdrgc1IYfpZ0A +n1WzxheVFpcxW8SvsSpmNg2yl2+cAJ46aAMX30kTtT2ZUFB4FpUvjWngs4hGBBAR +AgAGBQJC5JLHAAoJEASRNELqG6ONH2wAoKPWAiV7uR6aHP0lad6xwmJk7hDGAKCL +dquqzy/yW25IpG0amrrBJxbLc4hGBBARAgAGBQJC5cIgAAoJEGEZai4zPk6ET/MA +njlQCKWhvqvRu7iYFQsg2dCW443yAKCYIPjawX4TXjgbruZktT0hg87UPohGBBAR +AgAGBQJC6mP4AAoJELK+vEAVKSSvB38An1oDZWDSwVpp/53o5cdJujbLU9grAJ0X +YbLrL+kW3CjaFVLncRhuF5t5xohGBBMRAgAGBQJC4+1qAAoJEDKGTkGchSIr+o0A +njIqK/E4OJrK0XPhX134+VJZ9N3eAJ90U2hylPkr+EoBHnF5VtEWJVWunohGBBMR +AgAGBQJC5RC3AAoJEFJ5L6+ZeK+GQvYAmweV9Ky/w7aRqbYjTtdg3U0Ks7DDAKDl +qSRYN1u8wK+2pVY6pcdLdb0uCohGBBMRAgAGBQJC5RGlAAoJEGtzoQYqYj9y2GsA +oIrkKoVWsuxRPHtOWWuvbHkMBeAmAJwMQVTcr17v9WngLkot4gurcsLxaIhGBBMR +AgAGBQJC5pliAAoJEGjrjHb46iln3W0AnR3w53mDPp1l0/6GDqqIWpi75PIkAJ9S +yyYZC4gjDmvf24hduMyrfjI2h4hGBBMRAgAGBQJC52FXAAoJEG6UdZTBUkMaINAA +oKf5u3fzXTT9MOtOVcqyVgnaIHhvAJ9hPhaRQUIMryWg+pJcw0TTWC3O9YhGBBAR +AgAGBQJDh5+eAAoJEGY1tsDeiF3TYA4An1FTBiWVfw9UBHZ8K05EZjG9+ykeAJ0S +w1jLCrauKil0I2G5rizXR2tREIhGBBARAgAGBQJGOOLIAAoJEBVFs/7iIt5PB/wA +oJihHU6IgWsNcADF1yo4/vD01PPNAJ401g1Y1dn2Z4/Il2jiuzE8dNYDEYhGBBAR +AgAGBQJGOOeiAAoJEGPQra6REgPkF3AAnAhbVLxHJk0+XswLDLFj20SQKrcKAJ4x +XaigKAQ5D6/Of1SPPRoX7bTEXYhGBBARAgAGBQJGPJMqAAoJEJhw7/PxL2By3XsA +oKONmq8YyhYqvpafW9dX7k6r4pg5AJ9Sjki0Wqrm1AYXxAYGc8fZIesIf4hGBBMR +AgAGBQJGORq5AAoJEOHh8rCZDtSqiDoAnR8FA/yGXEAd6gP0AoioyMHj6e0KAKCA +dnxXUB/eSwN98EkeVwSPpiBLG4hGBBMRAgAGBQJGPFBHAAoJEEwEKBgxGj3l+XYA +n2Okz5W6SabKyirUGjF30lr9BP8VAKCBqsPWR50O8vcG0lDLkp1tuW+63YhGBBMR +AgAGBQJGPaCSAAoJEC65RoKIgXQCTFkAoIq89nYh6AmxcqwQFeYiloD+FGv0AJ41 +la0vkis1JUIDM3FNO8xw5VbNZIhGBBARAgAGBQJGPdZ4AAoJEPXCYBZM7tdfcxkA +nAsMAnhrvQNVPQJs/P5ysQTKHXZ7AKCGrxUFi5FQ93oEuWBGqw/xHcMfVIhGBBAR +AgAGBQJGPfUFAAoJEKBy1NBDWMWESn4AnjHzaapJEaIYFhc/39hIRm5n0dl9AJ9l +AXqmz+YQSqJKQ/cchdKbLdhSGYhGBBARAgAGBQJGPgXFAAoJEAKlpgULfmz6xg8A +n1EFGiCeI1C+7BUDqI5xlPps6WB5AJ9cUoE8g1ipE/QtCVYcOUhD53yxY4hGBBMR +AgAGBQJGPwYxAAoJEAP2jL3eiISgjbsAoLzdvLd5d8mADMZDFLi9ywPLk4pBAKCt +23xxWAwNSj5W+uPGLL6R0IEb6IhKBBARAgAKBQJGOPeHAwUDPAAKCRBz3YwWAVMC +NT3pAJ0d+kpqF2GHoIhFEisRwox0J52J2wCfc5nQgpaGmgyMqodqq+cdoybHIx2I +RgQQEQIABgUCRkC2TAAKCRBtC8c6QFgYN2F+AJ9l6y2ms478IKVMFRI/SghwKvRW +AQCeJIR6hCR46QY0IqKhkHy9mfzaiPaIRgQQEQIABgUCRkxEUwAKCRAfISPDa9hy +oOhdAJ45vxMRMgaHj1548DkUttPv0cdYHQCdGlc//bHVnJwwlUFz/1O4sXwDttaI +RgQQEQIABgUCRkx9AQAKCRAPRQomYhC/wO8fAJ44L3d9QLaMvMvcI78aMBJH2y2d +SgCfe9xYYMuYvf9qElihil/7a/9p68CIRgQQEQIABgUCRlJvWQAKCRAywdbvDxQ7 +wRIDAJ9xo4egUgVo6h/N7A5nMBuT3dZ6jACgy2Oc2uFYYhGvBAgQpHqESZf4suOI +RgQQEQIABgUCRlJvYAAKCRDLrr45pGxMoYJUAKC/iURBlu5JKxZJqUJ6D2kzYuo4 +tQCgxTpvpDWKqrGIM8OeA/PbdUJqTkCIRgQQEQIABgUCRl7VqgAKCRCahtfM0arq +YMd8AKDHCkES+rZ5lM7aewuV+/ouOknGQACfePMsXa5L4OKjA3szncnZkcc6Wl6I +RgQQEQIABgUCRqVMLgAKCRA5vlGhCEyREz3aAKCFX/1eYbphSmP2KYfgHkhg6Hf1 +UwCgtjZrJUNnuhsPGRK+Fooeds3MatGIRgQQEQIABgUCRq3MVwAKCRAzzWczr17E +UvI9AKC1QzfFpES4rgb6+6lqzYYO2JW9SwCgtZkhqsaH5evRZiIglzjHmfgPJjeJ +ARwEEAECAAYFAkfAfZgACgkQGWWFUMMRBhEjoAgA4cFAPqtCYVpEf0Nc7eciqxpU +LGLaUCOuDfMZiz1kSkXi4FiDAKbSfrcGAPmLh+8AiQbID+1PKItsfWs5ZjuBzJw2 +toF7OKSWxNKUSJoT+SapGGrs3qbywZWRi82dcwqSxPyZmsQfLXONJRePwgWy4+RB +Nvo38j1hKZclf8xMI4w1wJMUs34Xae9BGMoLhpuJ+jOCoG4JE3cUdf7hvhyJKtMh +xrAiYVYmVlurShtNF3Czhq5tm80Jb9m1wlZRFgvUE6m/2XWwPjjS0lnZnoBFVZ0H +lMd47b0YOu8ieS1wNgkqtpRwBqBBH2XOM4kR5p/uT7rJN9yav6z1fEEgmV5TG4hG +BBARAgAGBQJJyofZAAoJEMnHkk5RBH1mxrcAnj6+e5JOVqw2yHEYGIL5d+z9iURf +AKCR6Y89jMFzzv2rEPbArCxOeGmurrQkU3RlZmFuIEJvZGV3aWcgPHN0ZWZhbkBz +YW1hZmxvc3QuZGU+iGAEExECACACGwMCHgECF4AFAkoJHooFCwkIBwMEFQoJCAUW +AgMBAAAKCRCiEVrhX2uLcoYCAKC4KNTcBwjOEIfMOgFsF3uTQTvL5QCfQ2960jGi +s9Jye9Ly/fI1CBMVQxiIRgQQEQIABgUCQrgKqwAKCRCBBGRPUYmFBP0VAKCPH0b7 +S+TylV1uBuYcYnWIb/RJzwCeJvRTMPnWNjVz+CVOvVzJTH4ol5mIRgQQEQIABgUC +QsUyhgAKCRCb8iNFL+KLz3iqAKCXRZWdGjBVbj3IBFl3kvh3xF2gsgCcD3H79mbV +DRNMxpGArFQ1hqQFzleIRgQQEQIABgUCQt9FDAAKCRBB6gmgV5NJjzHQAJ9IfkjK +kiEuFxUhznsghAQ8bsBWnACgoT0kWSB3iUepLIDoWhhGtDIS5FSInAQTAQIABgUC +Qt6scQAKCRAxpj2W7BQLgebOBACAFFpEKETO3ZHbjMnPogACNr6EZCQxzGTIXrXS +yWQs68VcH54wUOA4yk3cGpfH2pgAxYjaHejTJRvDKvGrPGlKHgCZFy4+wHzo17pW +9J1aKk2sUWlT67snDVdMun/i8WxD9yz299cXR6iCxPfP2HIMEqbsxWJaXITo7drW +SjO35YicBBMBAgAGBQJC3sfZAAoJEDfj9F/uZeMhRawEAM9wfn9sBIsFzQRQbAO+ +ll83f8ki++A4Anj6DXQ4xRmClUxqahL1BjxxeQhE+Qomq1IebDJr0Se34XB0g3J7 +bzr/i9QmEwEqnDJfWVobv1Ugjy+1jzErlZBhm8hnCI+zPnrWKLk0n78vzJ5RrnVa +TTV+OW5r4rdVZ86yKYHtpVSoiJwEEwECAAYFAkLfbHkACgkQms08wKmfdd0HDQP8 +DDD+1FQU8PPPe+Kuf2bJOO7Ycrej4JF1I/Gbs2HH3xXgOZsRv6WJ41M/ovxJLYrp +VqQA2YF/Gxwguwrf4lPk+4spFdabguiJK0d2/KZAtnLsjIzdYcoY01IKGT3xkPwI +DErNFSmxX6bKCUePcFNHYZ6dDBHFFcYVTsdo/wbAe6aIRgQTEQIABgUCQt6wsgAK +CRD9b4jGIdCnG30UAKDCxsPZksKIcvj7tbHQEwm+PV5+DwCg7PorUCgIvTIWnID8 +zRWDBG4ACXaIRgQTEQIABgUCQt667QAKCRAyyeTONkLLS/d2AJwM7BQIQgqLA0qA +75R2EjHFXQKZWACgo7iaANHxIRc/Nw19j8CxNbWJRJ6IRgQTEQIABgUCQt9sewAK +CRBQjq7FMC2laIx3AJsF0Hjrm4N21EwdrmhS9PHKQL2KdgCgjlus2GyuCzafgb9J +HVhBDrhelkmIRgQTEQIABgUCQt9sfQAKCRDdumS6LDEtL7MWAKC6rQU6ZjSS6gVn +wswutaqBwfwtvwCgv2mMGJf2hnYVaNNqV5WIFAuycmOIRgQTEQIABgUCQuDJOwAK +CRBc/Tf6zHjIk9TlAJ9dbM2HowI5oD6hGSnADhI2dKfBrQCg4O9WtFiRzLqC1TgC +Asbigqy+JDiIRgQTEQIABgUCQuDszAAKCRDJtabs4td0311pAJ9L3yUe7GUeDqMz +d3WLWatclf7ruQCeOenA9nhyKgHASeEK/ZXQXDDBW0uIRgQTEQIABgUCQuDtQAAK +CRBbloAQ4E+aibNVAJ4wnAfcA/rtUs3+Hu9nNn8ar/2Q5wCfe6W+k9yHjd7hZWnY +HdnCkAZkOMeIRgQTEQIABgUCQuJibwAKCRBtmI0XhzFcMezQAKCnk+So0Anm4kLD +wl+srHvIB7b6jACgqROBN5MeEGXQm+Gan2VSt+nvTZ+IRgQTEQIABgUCQuNVwAAK +CRATLknU5B7cflR0AKCTAlfhPFwHPXnBo+5IROopwNQnsQCgh2vHS9VRZRt5I9is +NDaNf1biCQmIRgQTEQIABgUCQuNk2wAKCRB1yqKj85s3UK9XAKCELi7ymxtLxdwY +fdfV3dxd63mV2wCgjgaUlQqFXjx5mXnRsgy4S6cS9yuIRgQQEQIABgUCQuRvFAAK +CRCM43a4HNSGH5/sAJ9JVHMVwBwHD8PN3DQq8hHEumn8twCfVQSXooNY2P744K+8 +k6lLO8nOH6GIRgQQEQIABgUCQuSSxwAKCRAEkTRC6hujjb+qAJ0Z+AoGDYe122wR +AOYAKayl9f9e0QCeKetoll6NZ+Rm/NKbFJGP6fYywIuIRgQQEQIABgUCQuXCIAAK +CRBhGWouMz5OhDd7AJ40l37cLZcSxfPt3M7/aOPgVGpa5wCfciaEynzuHDfIQD/v +tXrZb2m0+NeIRgQQEQIABgUCQupj+AAKCRCyvrxAFSkkrwQsAJwM8IqtXQk/TBiQ +i6Fyq/HHm5/zvACg5atZV8F+r7jVRhT1SJ+FaVsaQDiIRgQTEQIABgUCQuPtagAK +CRAyhk5BnIUiKwuyAJwOljL2++fVQ0BSKRvFSvS+fSu3KACeJxsOhbyCd3o3rqwa +VeY5FFi+Fm+IRgQTEQIABgUCQuUQtwAKCRBSeS+vmXivhv0OAJ0Sg/UEnB/IAoqj +HzKoBivCMYDtrQCfVY3IDKRHbbLNfWBSDERWCTpHXtiIRgQTEQIABgUCQuURpQAK +CRBrc6EGKmI/cqGBAKDEgTewzt6TjmCkI9RrYjF46a9H4wCeJPh4bmTymcfwRGn6 +0h0a9Mz1mKaIRgQTEQIABgUCQuaZYgAKCRBo64x2+OopZ3lEAJ9w4EWAgRUMxf0U +d1zoygYDQedAgQCeJPHSbk62Ej11NljNGN1zdwzRHuSIRgQTEQIABgUCQudhVwAK +CRBulHWUwVJDGkOfAKCgQM+50dTktJDaDd8gVOGBKRiSIgCgkT9gdtDac0m9s2IH +Aqktk0mc0U+IRgQQEQIABgUCQ4efngAKCRBmNbbA3ohd05uvAKCjMnn4GpnZhjWF +S7iN0LIXgxm5PwCfYodjKF5zSbIROx79dJ41Gg0/VxWIRgQQEQIABgUCRjjiyAAK +CRAVRbP+4iLeTznPAKCaIUKdiySarhu//zEVn67y9q/szACcDUob1L2ac1R1FHB9 +XE4fTf/PV1KIRgQQEQIABgUCRjjnogAKCRBj0K2ukRID5FlVAJoDhc0dijUvPmOK +ILkX6fG5g73DugCePsOrjW+YIc5+T9qeVMzHyfm2opuIRgQQEQIABgUCRjyTKgAK +CRCYcO/z8S9gctnJAKCc7DZ7JzXgaB4ImiwB2dyGMFUC8QCgitOFKEw1y4+V1dNN +3kZYL4P/M/uIRgQTEQIABgUCRjkauQAKCRDh4fKwmQ7UqvVYAJ9BjHLDyGmR56xK +lKF3qVq1+jAmgwCfQR+0qbVWaSIaVS1DCg8yUr2txOeIRgQTEQIABgUCRjxQRwAK +CRBMBCgYMRo95VO1AKCewEwAscfj9VfTxswF6BL6zNj8rACfW/3kG7zPI2dSjWJz +GYPQYPAa0smIRgQTEQIABgUCRj2gkgAKCRAuuUaCiIF0AjxRAKCu9kiQfvVmSrVZ +b9HK8Mazhut+hwCfY5guSOz96KH5dJ2585cm5wPyT5mIRgQQEQIABgUCRj3WeAAK +CRD1wmAWTO7XX04yAJ4/ZvOfsexCgIQRuoREg1/D9bniKgCfTcKh9dLFkPjlD3yI +w/NCc1L0/ruIRgQQEQIABgUCRj31BQAKCRCgctTQQ1jFhJmBAJ0TPZlIksq1EnAY +tTTSb/tHpXxNUACfd/m3jaTHdJljRXGI7UBsVHnL0nWIRgQQEQIABgUCRj4FxQAK +CRACpaYFC35s+iQnAJ0eGzB7NIQtXLEgyuphyW0nBppVrQCcDj6tm1MCKXA7f4zV +1R0u30jrUeCISgQQEQIACgUCRjj3hwMFAzwACgkQc92MFgFTAjV92QCeI+02yLkS +qmdJlMBVfVE9joT/pBAAnjJlywot38PS8FtodliCfNvqn6VIiEYEEBECAAYFAkZA +tkwACgkQbQvHOkBYGDcfVwCfbS6bS20V1ElnuQBAofsmi0yjbzoAn3eztrDQIrh+ +/BkXIJo7IF0Ny+gViEYEEBECAAYFAkZMRFMACgkQHyEjw2vYcqBPqACg1jy6peeP +fEuvYJEKfJBNG7FVwPwAn3y5/eBtZdRefj90FeIiS3dr3D3siEYEEBECAAYFAkZM +fQEACgkQD0UKJmIQv8AfLQCfeHzJB6tJdA4bjPEcJKi0sMFceCwAnAovkjdUhF2a +JrpK2cr4bZhm5RbhiEYEEBECAAYFAkZSb1kACgkQMsHW7w8UO8FdFACfSFzmzz3l +ZmB+qclUq7q+YVgd3hYAnRyNi3iYLUVrk746XsvzWcv8UonRiEYEEBECAAYFAkZS +b2AACgkQy66+OaRsTKE0LgCfYZfXtB9Er7iKXoDfhNuuDIdKmqQAniGNC3piLBCg +gMPpJ5vQp2KsptvJiEYEEBECAAYFAkZe1aoACgkQmobXzNGq6mC8pQCfeV2ib+Ym +o/KQ+jYsr1BxYVFCOmsAoO312vLgv8Q46hucGIq9aN2isEnEiEYEEBECAAYFAkal +TC4ACgkQOb5RoQhMkRPl4wCfebfolpLZYdGk48JuUwd2shtkicwAoMGAdNOSoXyn +I/6/b9jsxQl8qmwZiEYEEBECAAYFAkatzFcACgkQM81nM69exFIBlgCg0CUQ1h61 +lCLBjE9+/Kvskrh1QAgAn0gXeq1NKEuepDB6hQo7fVZrSpF8iQEcBBABAgAGBQJH +wH2YAAoJEBllhVDDEQYR8ZEIALAYFxipk7FfpDbEnUrTI237QugKjpvrX9n7CdHx +JLnwOBr1g2/e/RMgoJHH8yqP8iQPGMfZXCVLM6ME/EoUQAVT0M0I1QsBVxTIXyPq +QIzCv6zibLYyEXDlQDNVB4hqdhozzxyjGruqbn75zfb8mlTMoj9lElNhVIdcUOVL +2xHkBy6g/YpmuZb/pt4HXBOUyWkmFK8zBMxhXw5bOuOP2zSJk9rZt7wdKNj3iC+/ ++936yXZzqWFuUOq0RX61RtW8e3SJfowGFBd728snsiD0IFLTXor62aBfBJ5yiGKF +UBM8LQ27FcJasfo7a8SiBbJOO/OsyQ1lRvLS85kM+XZDXZaIRgQQEQIABgUCScqH +2QAKCRDJx5JOUQR9Zlt8AKCAMAc8652qgKVPdH0XJbzoq6ykNwCgkTboPY7d+GFy +EwNCHk+0PAmkPru0KFN0ZWZhbiBCb2Rld2lnIDxzdGVmYW4uYm9kZXdpZ0BlcG9z +dC5kZT6IdwQwEQIANwUCQsVK6jAdIEkgbm8gbG9uZ2VyIGhhdmUgYWNjZXNzIHRv +IHRoYXQgZW1haWwgYWRkcmVzcy4ACgkQohFa4V9ri3LW7wCdEc6hdCr094a8LG+c +hTd+OzGxfFUAnR3FvtuG8sv367Knk0ybMnpOM/4hiEYEEBECAAYFAj53pBoACgkQ +FT+gzXWmdpL1ewCeOSe7lOufhc3mfTXs7eSvqECt89oAn0VM+YgQHbfdVp32YE7H +t6N6GPf0iJkEEwECAAYFAj513w8ACgkQPo+38viDQdkP7QPmPZXPi7m6wRiLofsT +lHCbBrR+ehWoSSqCmHQjN1DGRtamGE6X8QbMIttD+NLp+uTx8j/E0sGUdPnWkky6 +fwt1f3AYeoAgCXNvPoewsC6mZn3FMdEo6vJc43FmhsUfumOtunvGNBnXdM8GSCJ+ +RBS/ASMjRrECF12/14xwgyyIVwQTEQIAFwUCPD7aNgULBwoDBAMVAwIDFgIBAheA +AAoJEKIRWuFfa4tys/4AoND5QhEdyVIypBvCUHv5SCaAKcd/AKDFthtZTrjF+eEY +lktPLRtI9zjeE4hGBBMRAgAGBQI+jc41AAoJEMppOXSBA6N+jAIAoIcAeCIKt2QB +PnAthnUk4DhlmM7FAKCA0Iz9ZutXGb2l+p8s7hhF3+Y9L4hGBBMRAgAGBQI+ddrH +AAoJEO7R6jkiYdBzi84AnRddvByuDodl5KaCSdpe6k9aYkLqAJoC/ud28X0M478K +lmacVVjb+PqzBIg/AwUQPnWqLv1viMYh0KcbEQJ6DwCff918LRigFUyEvYj04C12 +so87JNUAn0RNFw+P1/SR9Mr/JQmOzJVhlwdriEYEEBECAAYFAkLFMoYACgkQm/Ij +RS/ii8+wZwCfRvfW6NyBoAp7oS9ILRHNYh2GbhsAnRYGs1hSaGK4rGxm/fmqxj+D +vqI2iQEcBBABAgAGBQJHwH2YAAoJEBllhVDDEQYRqFAH/28B/f92MsQX9ZRJG1v9 +EDGVx1U+pcE16a7iplCP4QuUR6uA2EUe9fptzZfX2iT2nr2XgCB3x2NHf0rzNpTA +M3OtqKQhXdvS3EWzWqR8UaDf6dxKN57B4QONRIhuImf3m9DWFNwIr3oOtO25Q+tG +7YcZen/zbwU5O23CEakNsysxGEHn/3BPjRyA1FE7NVLrAmxFu8LXBUD9y3HNNetM +4WlucnObqw5cBFsZMtnGcVLs3suTAsxwrnBo7jq/DbZVvzUZtEkGdV7LpSWkivSr +q0+h9Gzug8EcYTjrdR6LFA5xGan6R9zrSe4mxe7vja10fmGEdIOQIapgO/iOWDR8 +3MG5AQ0EOxIiVBAEAM1SlkvEK5MrMnW0ybtv9eMCG89gqIvd2gBnpcAsF0sX+dCa +WHWNy5HL3dBak/G3BJ8+NzAksfL5Srm0LVKcfVjBiG+IsbUoSyeJQGuhSZXYcnIc +/3Z8Ujcs+TfFurG8uHU1cWnNK5aMYwDrqxmp4Ru0zLYHw4tHBBKF0cgFaCsjAAMF +A/49aSZuDaatppSaBOzCt7wIYCsGBxX5ZibrJqr0gLUbhXU9eaWzCawOWwCvpQN0 +lTjoYVkwiLZaYUkdqsSQgHAU3jjKlIuaIRXApEkTb8Jg7R/vNAdwXoZRLBCjZPGd +5qGtnIezsZ2+lxFx+bRieUL8fUInemXwWl8e23PMisgm+IhOBBgRAgAGBQI7EiJU +ABIJEKIRWuFfa4tyB2VHUEcAAQENMgCgnc22kj8TfjktU6u4SUUqud25ZZcAn0B2 +b0zPjKjGuiwdKSnkFbNcFS3g +=UxMc +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/C152431A 2005-07-18 [expires: 2010-07-17] +uid Steve Loughran +sig 3 C152431A 2005-07-18 Steve Loughran +sig 2 FC243F3C 2005-07-20 Henk P. Penning +sig 3 302DA568 2005-07-21 Rodent of Unusual Size (DSA) +sig 3 2C312D2F 2005-07-21 Rodent of Unusual Size +sig 3 E04F9A89 2005-07-22 Roy T. Fielding +sig 8103A37E 2005-07-20 Andre Malo +sig 5793498F 2005-07-21 Tim Ellison +sig E4136392 2005-07-21 Noel J. Bergman +sig 1CD4861F 2005-07-25 Eran Chinthaka +sig EA1BA38D 2005-07-25 Ajith Harshana Ranabahu (Made at Apachecon 2005) +sig 3 21D0A71B 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 3642CB4B 2005-07-20 Martin Kraemer +sig 3 2261D073 2005-07-20 Astrid Kessler (Kess) +sig 3 E2D774DF 2005-07-22 Sylvain Wallez +sig 3 015AFC8A 2005-07-22 Bertrand Delacretaz +sig 3 E41EDC7E 2005-07-24 Carsten Ziegeler +sig 3 F39B3750 2005-07-24 Colm MacCarthaigh +sig 3 9C85222B 2005-07-24 Henning Schmiedehausen +sig 3 9978AF86 2005-07-25 Christoph Probst +sig 3 2A623F72 2005-07-25 Christoph Probst +sig 3 F8EA2967 2005-07-26 Brian McCallister +sig 3 A99F75DD 2005-07-21 Rodent of Unusual Size +sig 3 EC140B81 2005-07-20 Dirk-Willem van Gulik (http://www.anywi.com/ - Senior partner) +sig 3 EE65E321 2005-07-20 Martin Kraemer +sig 152924AF 2005-07-29 Sander Temme +sig 3 87315C31 2005-07-23 Raphaël Luta +sub 2048g/59066D7B 2005-07-18 [expires: 2010-07-17] +sig C152431A 2005-07-18 Steve Loughran + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.2 (GNU/Linux) + +mQGiBELb2+oRBADhgEV29jhAMg4dFJN9fjeIjN7+J0Lj3rcLBWc5RTlM33DTOCFM +BCIE9B/RXJuVhGgi7fUuB+WsHz7XMgZRn+5nqIKGecIxwEUtZCfwsaV6Id3abt30 +wccyYDTSV95gQie+bbwWF44ao7n/CaR1WUU/Nx5b26nY2EzOrQcgP1qYEwCgynnc +NU1N3zd1cIYr5hQVqvdazKsEAMbYAm5WsjBlLBrolxs/smx4vxZYJaA3gUqTz9WY +D08rDsotVIMoosYF0b4b3WxcePJ68N1pkF3U+zo8bIZJThT91nAfMh29ZAcSyRqg +Mkd25OcrrjykeF7OavuFSwhvYoDdlwsvkuijHY3weXyhpjvzi+GzvZoONo3zSl4g +aWncA/4vu6k7XZUZ6B9DbJLJ4Xqq8uhD7uT4417uCQdozIWgKE4ThM2WffhV2IgY +W6IXg+o6AqY1qiMLSYYdeRsVkQ/GVss+sR++cbsO5ijDGfvlWPfGxIcA+P+alAwf +KY9M45IB8E92DUDru6ImrDHMeOrlDNPRusxRyZ4SiSJYNcgBtLQiU3RldmUgTG91 +Z2hyYW4gPHN0ZXZlbEBhcGFjaGUub3JnPohhBBMRAgAhBQJC29vqBQkJZgGABgsJ +CAcDAgMVAgMDFgIBAh4BAheAAAoJEG6UdZTBUkMaZugAnjJVyMa1FYEm/9811Whm +K06kGzXbAJ4rgRTBOcuyVbmbOAeYCgqloOxky4hGBBIRAgAGBQJC3rlGAAoJEIuW +KUP8JD88RewAn3LmpnmnLlYnlQW7+byITmKLO9gwAKCi0GGQz0QUq9tFG4YeF7Rp +UCl8ZIhGBBMRAgAGBQJC32y8AAoJEFCOrsUwLaVof1cAoLX3ROO9ufH+QXYlBuy6 +HA5SgofAAJ9aON/jC3WmrxT9Lz/DlIBKVI9TZohGBBMRAgAGBQJC32zBAAoJEN26 +ZLosMS0vCycAnjFhGc63FoWHwzpfVoocrBm8yQTHAJ47Kle1Tr+fBnlkYsAg0xY6 +12VZ9YhGBBMRAgAGBQJC4PEqAAoJEFuWgBDgT5qJY6IAnj2jxdReXh3eBRr+easP +bboH9Lu0AKCSoT0Gt+pM+G7XM8vQbZjsyjDhrohMBBARAgAMBQJC3t+3BYMJYv2z +AAoJEMppOXSBA6N+4VAAnRfGDGvU4qDop0EdApmHCExFDHFDAJ9/3xZDnJjEeSGr +l2JyOPJfbv/k0YhMBBARAgAMBQJC30/tBYMJYo19AAoJEEHqCaBXk0mPRKwAoI0M +FDyhr2PON57N4614Po16a9ZNAJ0SGKJtMOIxgoDHSf6SYuFy+8sBLYhMBBARAgAM +BQJC35MFBYMJYkplAAoJEAEFZrzkE2OSgcsAnjKv4POPmFUYhDGH+GCcxSyM9LPo +AJ0TPnoLf74lUroWD5+rlhTPD9eMHYhMBBARAgAMBQJC5HvtBYMJXWF9AAoJEIzj +drgc1IYfdCAAoIKybYLGd4yGE8NcrvnGaPSXx6NXAJ4zrIPA9tQu23tOHarZxSqg +7AWGh4hMBBARAgAMBQJC5JCBBYMJXUzpAAoJEASRNELqG6ONWZsAniJvvMiDR61N +rV5Y7xx/3/id/ekWAJ9MNUUQAXTES1dkywQVHVp6C8QFvohMBBMRAgAMBQJC3rR1 +BYMJYyj1AAoJEP1viMYh0Kcb26oAn2JuF355Lq6PIEvnhEr+SA3noxS8AJ9msBXz +nHsORsz8mB4WZ4DMAYEH0YhMBBMRAgAMBQJC3rvoBYMJYyGCAAoJEDLJ5M42QstL +Cu0An2vCOimm9iyRJekvlh7IcsrXVDksAJ9S1iVXBgyRuWBkbcuRk9OLs/TnwohM +BBMRAgAMBQJC3twlBYMJYwFFAAoJEO7R6jkiYdBz3gkAn3b48pHpjPG5DCbfp0oT +/WN9IqYlAJ47CLk2xg7e8N53WTmYfL+F/c/ZrohMBBMRAgAMBQJC4O0jBYMJYPBH +AAoJEMm1puzi13Tf+KgAnjviBj4kvC9ABiWR70t4BU3y8kgJAJ9qmj71qWjrek/L +Cb3+fAmlASx82IhMBBMRAgAMBQJC4O20BYMJYO+2AAoJEDf2j/UBWvyKJywAnjSC +smaB18utPgHthVW0qDQ+DDmNAJ9a64uKqcDI7u1cDEbi3nL5ELztCohMBBMRAgAM +BQJC41snBYMJXoJDAAoJEBMuSdTkHtx+SyUAn19MjVdnPdxKdiXjpMRWwOs5fhTL +AJ9AGh+TvyOt877cfLVaywPK+GhN0ohMBBMRAgAMBQJC42UQBYMJXnhaAAoJEHXK +oqPzmzdQe9gAoL7BugDd1NniX/ZNqs0aD7Y1uUfhAJ0b4p34ZYPWFg1CyUduwYlx +MAOqo4hMBBMRAgAMBQJC4+3gBYMJXe+KAAoJEDKGTkGchSIrHl8An0ERlWCCDHYy +0jlbsVcQ4FOS9qe6AJ4sLF02AltG01bK1kpvnKXxHFVYoIhMBBMRAgAMBQJC5RDw +BYMJXMx6AAoJEFJ5L6+ZeK+GWEkAoIl+GM1cgJosSMsMG0NqXog9yqeKAJ9aJ0Xr +j7JP5abRyjROroIUCUcc4ohMBBMRAgAMBQJC5RHdBYMJXMuNAAoJEGtzoQYqYj9y +IawAn3TzgRnJPfl4gg2kwIlJtD/a4ql5AJ43+Bbg3EWh2RVaLB7QpA1pAsRFB4hM +BBMRAgAMBQJC5pnVBYMJW0OVAAoJEGjrjHb46ilnWz8An1WpumoYARq3Le1VG0vu +SkQcdg8SAJ488MHNQRq2fyQFk9uIstWriQfa7YicBBMBAgAGBQJC32y2AAoJEJrN +PMCpn3Xdsl0D/j7J+/vobH/4+pmWCWv3okqBbbd9PH/NJTC3B7KU+p8bFdIIZWYh +n9SPXRdLoUlbKnqYw6+x0Ktn/9oWqwTM2b1bOHoMEUy/hPDM1ZK2gGDU11BFbfC4 +zkXowbq2xCHLyaQXqj5Wju01PT/wj8bw5A0E2rzv2iUA2ilXJE1vQdx+iKIEEwEC +AAwFAkLerQ0FgwljMF0ACgkQMaY9luwUC4H6jAP+L3lvntIdecj0QlnD4gTkdLn+ +nbOPT0G9MPSjA3ML9Bqeoh/uD2TeHS0dqb67DpIzhKV/zu6vrOhsXHXNiCjR4lxR +YHBg0PoxLJkggpjdAduk5vcM2ZgRJZQojsQ9CunxnmA/YCRCEEUPFeKj/5p1aFGm +uPsl2zwggHxbdOBY1maIogQTAQIADAUCQt7IywWDCWMUnwAKCRA34/Rf7mXjITNS +A/9YB8srHD2WbpZy5P/cN6WjPshYgx0lVFOifFdXgD4AUzgJ3VmtH1NI0Rkgadcw +8PdJYAynH/Hdz4PJ8wIEkmMFEe6TKB3BCjCGY8+Ti6R/VrlkizIGL0HzAUzNc+g2 +D1NI8725Idx+XNSOSBcOBZ3mwPVo1k67X1rF8BoYAeo8TohMBBARAgAMBQJC6mYn +BYMJV3dDAAoJELK+vEAVKSSv8BwAniQzr7l/ihVvAhvNUnpJzFWfr6tfAJ93Mama +D+Fz4kgEVjnO5j8MrM6JtIhMBBMRAgAMBQJC4mNBBYMJX3opAAoJEG2YjReHMVwx +Pr4AmQGWlApW3C1VbkuRgVs8pj6/ejXqAKC1z3D5mMpj83yyejnBjxDjXTLsUbkC +DQRC29vxEAgA05PNdXcVOSTsYuizTCbdBU9i3qUBkAyqPmDE6hkWI+7fnr8KAUUo +UghWwhxqBngpv48o3mE+bC+l/cTH+DuHIOsszpSK5ydufyitXi7piYk4RS+UNbyl +b4BU5qGodwWwXC9wKBIjXL5rK2KjKh4Ovh0WogtZ1fwc5NzQkjcfbner9WsAmjtd +nmVV2vZhJdDlxf3BBM9ai2R2IRvfhF61QFZcr2ehqAdsiDix8p0ugpC/oQS8h8pg +GQebz7aNeSjh/Vb3dsdo8CaLvHp1nM5aVCDRqoCfoeKUbRfwwwKxtc1cyYzOHD1f +KG9BuvtL4y4JQ/gDCsQVKdAAoiktu8Ks9wADBQf/fGkVYIh7w0+8xSIvez1DKirX +rl1J3XNvOYIa1qlBk65hllXnFXeXqoOLQpvygcwNRfil3AGcpwzwlNloem3ozjnt +IFvYJYzB6q4SMl1/a5uLrcc2frq8tbG0RhU+ZEhWR6sIEOBQhkKZ9LZbJ1tK9buJ +M0meaIt5gVLAVbI5vf+2Lvmlv0+E/a4Zn2exl1RcBYATNZT1gC55m0z5PMzG6Bc4 +tOAhPEo3WpfNjIrFeXcB0ksk4mfDIWKlA0mc8A+faKSSMdiDpeU4H4uZy5pE/hVv +2VyE3Ej5PoA3DajRzgQ69YlojTYnfnPyJErCBZhtZXTtRY7aDm9/xBT7FZ06RIhM +BBgRAgAMBQJC29vxBQkJZgGAAAoJEG6UdZTBUkMakjEAoINKV6yLAdbBhXhvMsqK +0N6XOghJAJ4mSgdwgv+sIOaPKQqCm+PL2M0lPw== +=4TlI +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/AA0077B0 2006-06-13 +uid Kev Jackson (apache key) +sig 3 AA0077B0 2006-06-13 Kev Jackson (apache key) +sub 2048g/8A6DD738 2006-06-13 +sig AA0077B0 2006-06-13 Kev Jackson (apache key) + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.1 (Darwin) + +mQGiBESOfuoRBADiCLjvY8EG8cDrfNvPaVJr1/8d8GDoLjBCeJWl50M7j1IQDB+r +rzBPXOzhoqiNRbZMkpjv8ofa5hVOQitVS4B69FA07RbuiQNTKg142h8ogtJeAI1g +eXuTZtmGE47TOpj7FMG8bHOmoJdQMkzUsdOhEAyqRu4noknuuIKgsE1kYwCgnhaH +9KBlpKaRG7Bb2BH6da+wmKUEAIaBeZ1aSQodUzDqnGjCd4hZbpzjyWg7O5BylNhK +ogMY95BvwFRD8WFdSvhvH9VKBtSuNqg/6gIkqAljRRESVxL4QrzlYSqF513kK1ds +lUTmqU9Dvaf7dkH+MYnkPVTP5tMZVCT7HEt4F6HcqlaZKlz5jsu3R53KBx6XZATc +SEGbA/wOournJ64We8sXTJGHFupvSLBy3nh68mPLaplzTnH2al1DLBnoF2giC32v +ZGG+e12kWE+fyyQ3pdAIRHgVjZ/ckPmcmxnVcYrhzbgV99fo2+JRh2SVrLrmvw+G +CKiUtNHn0HS1klBKSj+3ML1AQQlbyfrcVSf0Fefug51BqoqU+rQqS2V2IEphY2tz +b24gKGFwYWNoZSBrZXkpIDxrZXZqQGFwYWNoZS5vcmc+iF4EExECAB4FAkSOfuoC +GwMGCwkIBwMCAxUCAwMWAgECHgECF4AACgkQoL/5PaoAd7BnTACff9f8Y2RFB7O7 +Wjncyb1XbEwJB/gAninrR0isW9jGx49GmSnQCjtO9k34uQINBESOfzMQCACP+GP2 +x2nE2JxjUUjj16ftOxUivbL8L9ksplx41n7yeRvu+RzOXcjlonuld0LYxprNsHGv +mbAoZj93QozHQIMfC2kfnia+hxCcBPMbev9RPCqgogpb90BtV0f9HGyWXs2QTgWG +R2hyjq/RpwtA3obSXw3pb1CnXW4stV65WAdd72KDc66wRR1gmjxKQx6b1dGcC+E4 +HyOgu2CDtr1ULPeI5U4BA4y8FLgDfYwkxp6vj5ViegGP7GlMa3bSgNRGsYX7VwgZ +pmI8WY4B5k3/Pyv2Toe6/5zTmKH8WlyZd00ede/tbFTqQLg+EylAcWJ8c3asood+ +SjCwTuD8l8a0wpO3AAMHB/9GXkbBUE8cbMTaS4yj7UL5iWRVhSPo9IzMSrzaXmZN +8ykX96ud35BCEfmYgty3USMk90Rs/PbwB4Mh3h1ZTXqRWcfOXzJ8kMabm2RANyf2 +H2DvGKoFPtpX/9I13vo9qRLRHVRENNg+3JCa1ii8cq7h8bWvTT0VxX/rOG0cl8nO +XkHTUARR19cGPf6XkHEcl+u1pAxIJGqY/gVowjyFGZs+RXFl/q/Vrgu+lvvxmryd +yEdeGdsBvQ9M0KKr98w1RiJnDUkSqI711xwlVk14Uu6Xke0oB3bbpe4UxD52avAC +yEzYY7vbpe6XS2+dOcZxWE3eur6SfsucAkj4Ib72mchhiEkEGBECAAkFAkSOfzMC +GwwACgkQoL/5PaoAd7BQAwCeJFb9yZvOWfdf73A7t2MvPXn1y6kAnRquMmA5eVdh +HbAUXWyYuT2OHOSD +=F2q3 +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/DE8884A0 2007-04-27 Xavier Hanin +sig 3 DE8884A0 2007-04-27 Xavier Hanin +sig 5F298824 2007-05-06 Simon Pepping +sig A99F75DD 2007-05-03 Rodent of Unusual Size +sig E222DE4F 2007-05-02 Mathias Herberts +sig 911203E4 2007-05-02 [User id not found] +sig 302DA568 2007-05-03 Rodent of Unusual Size (DSA) +sig 2C312D2F 2007-05-03 Rodent of Unusual Size +sig F12F6072 2007-05-05 Fred Vos +sig 3 311A3DE5 2007-05-05 Ruediger Pluem +sig 3 88817402 2007-05-06 Thomas Vandahl +sig 01530235 2007-05-02 Luc Maisonobe (SpaceRoots) +sig 5F6B8B72 2007-05-12 Stefan Bodewig +sig 9C85222B 2007-05-14 Henning Schmiedehausen +sig 4358C584 2007-05-06 Vincent Hennebert +sig 0B7E6CFA 2007-05-06 Sami Siren +sig 4CEED75F 2007-05-07 Nick Burch +sig 40581837 2007-05-08 Nick Kew +sig 6BD872A0 2007-05-17 Michael Busch (Lucene Committer) +sig 6210BFC0 2007-05-17 Jean-Frederic Clere +sig 3 990ED4AA 2007-05-06 Knut Anders Hatlen +sig 0F143BC1 2007-05-22 Matt Hogstrom +sig A46C4CA1 2007-05-22 Matt Hogstrom +sig 152924AF 2007-05-23 Sander Temme +sub 1024g/A5EB8D3D 2007-04-27 +sig DE8884A0 2007-04-27 Xavier Hanin + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.2.3 (MingW32) + +mQGiBEYxng4RBACQpDi0ebPGdHVAdV14aK47MzFkFJEbCisBgcZ2OT/pyPjVTN+9 +Q3NtIusVuY/yEeO4+tb+YTbBiwNsx5p91Rder0prBBVPr9TGN8bV81hnSHfVCR+O +oqrLj2Onv1qsMslOuZR2m1d/i6cFIKV0CV9EWOcEJZ6UEP9CXP29ZzjdRwCg5NgW +YfergzvpVtON0E5UvjFnGmUD/AoWhJ0CRxw8xj/EAGS4xXO83Ydf6ucu2PwqUOSZ +N2mMWyBpr12sQH+iMjWJW25GNobwJBKzfvrojujvlU4uyNIyD40sPeH0UrTwLbL/ +Kek9zp9NxZ9wawjzZvdp8sdrOZ54o59/7flAjL3iqJRtLQSeyQsfZaOSNRxsAUiI +obn3A/9SEtJdF6HM6C7V57WdKIHv6uVocdZNN3zig2T9uP2Uq1VMIEYtllRNX/4V +9Vq+2KdV72DnlMuZIA++o1n57d/LgUmbDd72AAZGNJaFq39CV9YElXziO7BVOjAg +MH9kNxCywcjcw8EFa3NCFcOKMESBn5sHu1nw/Iu1Z9TtagnJwrQlWGF2aWVyIEhh +bmluIDx4YXZpZXIuaGFuaW5AZ21haWwuY29tPoheBBMRAgAeBQJGMZ4OAhsDBgsJ +CAcDAgMVAgMDFgIBAh4BAheAAAoJEAP2jL3eiISgw0gAoKcAgjjfQWlqnQNRJQ+8 +A7H5ioIZAJ9qApxb1iH8ulGHjiBOjiSgQq0SNohGBBARAgAGBQJGPhhDAAoJED4q +b8JfKYgkB8AAn28euVJz8OQZvoSw89voHvcVzewGAJ4lm2R0FCSIRfmHCl+5aSYw +TazeNYicBBABAgAGBQJGOgiqAAoJEJrNPMCpn3Xd8Z8D/1Z/ml/qcIf1yDiYQTu8 +O+/so0ZlfTYlEF6XrW6WjZDIhNVAAT+Rk1E3q+FvZfMq1BV1mubsCXRtcwt1Br3z +MWIuJ7lBZl+T1Nu2sxH9H7FAvY7Bk8p5WecIaVdNyFxC98vGYAFs0aRRGSeCFbEu +oW5XXxUAkkWpIT/aG2y3t4G3iEYEEBECAAYFAkY45CgACgkQFUWz/uIi3k/mCwCf +WUNeKG4a3hgDhMOyZ1FGFpDnle0AnR1yXWaEazJD5wyTtnnSE/Ajk4L3iEYEEBEC +AAYFAkY46MoACgkQY9CtrpESA+SOtgCeMIh7BKJeSezB+h1JQmUyg6EuNWMAn3pN +aMYYEj1LL8R/2ZxBNbU9njNXiEYEEBECAAYFAkY6CKoACgkQUI6uxTAtpWhrvwCf +c2uhmeog5475d9hTQg94MqEo8cEAoJOp95BdZ7xd9ayJwL4LmBVYaIMAiEYEEBEC +AAYFAkY6CKoACgkQ3bpkuiwxLS9rvwCffwzrqfIJghWUoXhJsa/m/PSLiogAoM3j +x2xt5sG1sQQbzM+U4VHhRmWAiEYEEBECAAYFAkY8xoUACgkQmHDv8/EvYHKBZgCe +PkYoQsESFkBkVyiSVueICUvg4G0An3rqc8/Beip9a2YF+7UYsKKJ1e5OiEYEExEC +AAYFAkY8UYgACgkQTAQoGDEaPeVNwQCdE4UB1RW+mjtYEbgxkZSjdaV3IKgAn1Sy +hoOrn3S20OhaZht5Y0EksVVEiEYEExECAAYFAkY9o64ACgkQLrlGgoiBdAKz3ACf +RkJXrvpQVQlk9//+O0W4BvggGxMAoPyvjRXm+Ie+nPAII74kL7croRWsiEYEEBEC +AAYFAkY4+5AACgkQc92MFgFTAjXIMgCfXfRlxPUwlzLWotr0BGQVK39JXyEAnRht +cgH/yscqbkvi2JvaVWkV/T9JiEYEEBECAAYFAkZGEjgACgkQohFa4V9ri3KpJwCg +4v63DT9Ll4+mqnAC1/HWIgSfQ8sAoN+EQ15zUuI0nuSyG6UCw/UUZX82iHEEEBEC +ADEFAkZIxWEqHEhlbm5pbmcgU2NobWllZGVoYXVzZW4gPGhwc0BpbnRlcm1ldGEu +ZGU+AAoJEDKGTkGchSIrkUgAnjI6jBaidqIjKhusVm6ihmG6LEIdAJwJnc6YRNyY +88MWtd0XRghD6ST174hGBBARAgAGBQJGPfdgAAoJEKBy1NBDWMWEYEYAn0RS69vJ +1EVod7WxAecb0F4tyJcBAJsEnTiTRMoNmJmRe6w3WqhqdLQUeYhGBBARAgAGBQJG +PhN/AAoJEAKlpgULfmz6aJIAmwcQI5XDWrLDzSFRJFuW3F1zl7P0AJ9GQYDvu4mI +c9ZCcaLdukbY2e6FGIhGBBARAgAGBQJGPyoEAAoJEPXCYBZM7tdfbQ8AoJVSPa3g +Cmc5ghLz1X12r/QBHPPKAJsH6g/0hcAou2ZUfVhOE7VJhpeGkohGBBARAgAGBQJG +QLz1AAoJEG0LxzpAWBg3cXAAoI2rKauHeIDRwh05S8iNGKTtEaPMAKCMHrqbLsbl +0P7XxTpZ4EKSvOkQ6IhGBBARAgAGBQJGTEaDAAoJEB8hI8Nr2HKgtRoAnReqmHxs +MbATTtCEF+WbTqREe1+JAJ9pM5VmM/Apfh1hPM8i55Q96BP1h4hGBBARAgAGBQJG +TIFwAAoJEA9FCiZiEL/A4j0AnAsAjAu6nDTd73TM3S80JtbuatX8AJ0WBRJk5ZZI +TmnMyz2yp6k57tyeRohGBBMRAgAGBQJGPbLbAAoJEOHh8rCZDtSqCOQAn0SVan9j +r55MJrDGk8D3M5pQvTd8AJ9uU45i0OQUP+zY5LSacNtOzSy6MIhGBBARAgAGBQJG +Una1AAoJEDLB1u8PFDvBK+EAoMjrujpsE1XQs3YxDwz5HHSWv9E7AKCJLU0W2MbF +OIgs9Smxz2LbuYH7lIhGBBARAgAGBQJGUnbGAAoJEMuuvjmkbEyh9uMAoJ2fBgZo +2kl+jOzhQnXHHDHzyLyAAKCR8Z6tloKXkhPRIV/N/OjwIW0i54ipBBARAgBpBQJG +U8qkIBxTYW5kZXIgVGVtbWUgPHNhbmRlckB0ZW1tZS5uZXQ+IhxTYW5kZXIgVGVt +bWUgPHNjdGVtbWVAYXBhY2hlLm9yZz4eHFNhbmRlciBUZW1tZSA8c2FuZGVyQG1h +Yy5jb20+AAoJELK+vEAVKSSveJAAniq8wB4b/DdGTK9Ygmu5Y76tqsw/AJsHGkn3 +5JyiHbXCvVujWmPtY1/OZbkBDQRGMZ4PEAQA+T0YRtd2aeXU+AOJnrhChy0dptVt +CE6PW9LrwZGqeV4THNWhdYuWRWlyzgU4HSfuk1Svu3WKMbnwp+Fv8fU6MmidOvEJ +p9IV1l4DidIXyhAacwpCN11hXvj5cHdF4KhJr/NG9oedin6nQoQFRQ7EfkUjAXOf +MCZnSps9XBJdy3cAAwUEAIGrITayVmWfUgjPvQg8L+4R2i31XQ70HIELQtYDs0Ln +iWrwZuO+aLI6Jw1RbZii6DM2QsVdZj+v36S2KJTvXeJVyb51d0uXYFxre1uCZrb2 +I1Lle8v3GVQvlrTpmZIPhOTotskKFWUCh2jqgLaEvJPpRWgIRXPF4g12nBXcLLXE +iEkEGBECAAkFAkYxng8CGwwACgkQA/aMvd6IhKDVtQCeKdUGQS0lD0nAJsGiSbKg +gLwEM0sAn0dUIIsbxE0fTHQVIQK4bII82UhZ +=jwNf +-----END PGP PUBLIC KEY BLOCK----- +pub 1024D/B80602AE 2008-10-22 +uid Maarten Coene (CODE SIGNING KEY) +sig 3 B80602AE 2008-10-22 Maarten Coene (CODE SIGNING KEY) +sig 5F6B8B72 2009-02-02 Stefan Bodewig +sub 2048g/9C7184FE 2008-10-22 +sig B80602AE 2008-10-22 Maarten Coene (CODE SIGNING KEY) + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.9 (Cygwin) + +mQGiBEj/pNYRBADN+YqWzDBLrOgiUCul5TWVLgUReY2VMaWh3Z732AMPJb1dlbtW +B8sRqyvtQxKIPIItl6oaom5yzuqc8leXQCJBVRnnBkv8cMomhOD/AuzaA82egttI +C+CHt/akaUPhgrzhry7TZ7lVtJZ04FJ9WaE+LKAZcnlhCWOSF330pRB8bwCg8E5k +4TF9z2cmwfRmMwJxruRpN1cEAJ0yo22TkjSksXFmQf0eKVEPaHmrsEjNzIECcz8m +JrggYDfXIgC2s758D7uhUTlJM7u1L2KTZmiZgiFp6WOw6DnPlBf4PRD03038fAQn +rGtfC/B7DcgMLS4tCPlGEyeh9H8RphaVSXVCN5IgRV4x0vIhyx7kVz1ZWbAlLEQx +KHp8BAC3/K9yVkRDa6m+HAZvRP60zxWAwIdiX1R/9CCRtI4uSaLz1Iiw0jni1YkE +tFe+z5PNa89Dy1bgFWJKxtG1jQVfHIt6nEz2C4z3Xk02+PxmJH/Dj84EOiLfxzvp +Hm2hA57GrNjJuvG7C7GVFy+bQh8DCkzJfGAaplSgzqyVmP/l5bQ2TWFhcnRlbiBD +b2VuZSAoQ09ERSBTSUdOSU5HIEtFWSkgPG1hYXJ0ZW5jQGFwYWNoZS5vcmc+iGAE +ExECACAFAkj/pNYCGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRBb4LqMuAYC +rpMmAKCNSdXDiaOex6L8UmKiGbkEah3llgCgotsI/YjRzQNSvmGfqrgkch6f0tqI +RgQQEQIABgUCSYbTIwAKCRCiEVrhX2uLckjKAJ9f0JEsAJIJDn80SMIHaEXhJj9N +tgCeL29JGbUoYjTq8LpoMrl3ZhDaqEy5Ag0ESP+k1hAIALRxgmE+fbedOgRhLl4w +pZyt3A/EXiZBY/9UDRAWpviCp4S3cQ5cjhv3glj8IAHw2ntuEJ2ksjG5r/swQ38z +quTdDY4YT/Qd5NDlSX+KOGL69mda6kFFiNeJerDcM0FPjiV3MWcNp4IwJTs45EX2 +ep17a0oUG2AhDjL8c/32elHzXtkzoMPQzBWqHdTO4gkp/2iLw/bTpfEJLtWKsWJS +lgnLobisAnWjFBo/NgtjxaxGjwIjTn4OZNQaBi3P46PP9FEj4Hp791i1YvkBYrIg +BaQY96Fexd/7FKyvBefUmlxZPyY7I/OI11KWifJoSj1qPxZb+90UQN2r9zySDdpQ +h0MAAwYH/jkSE2KTx5R/vU+bnz11Kx3NRq6kxCQBGUclPGgUxk7iSWfHggQ/0U3m +1TI8GL687dwb8AO+f2b4nov4g4umdoddu9gPlHvpBcQ1BGx8JqcWJJ+F7lWUeVw+ +bqp5Qcttm9ldw1HEbUF0l81VFpLNDV6p5z3zrXGE84fk2BEMzD23IhMwNnWDsDVu +2S46h6BuK8sdTzgP5GTXw/7c7xG2zgfMHVUBWtuz5P6D8vl9gHu6unuLIcKspOgI +Vl2ygZ2VsxGUscyR9soLrem7hZaaQJfJqH757X3K8SuGZY36mH69Ziwzs1gQlof6 +bgumh74P8Xu+StvFwdZn1+aFsqcoDwuISQQYEQIACQUCSP+k1gIbDAAKCRBb4LqM +uAYCrpuxAJ9NYy3kPGHYAZuFSeygBt3aV1acGACeP9bIj81YOQn45Dvgmb7zqYBU +g7o= +=jpcP +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/3B7C75B1 2007-05-29 +uid Gilles Scokart (at apache) +sig 3 3B7C75B1 2007-05-29 Gilles Scokart (at apache) +sig 51047D66 2009-03-25 Tony Stevenson +sig 01530235 2009-03-26 Luc Maisonobe (general purpose) +sig 6A017B17 2009-03-29 H.-Dirk Schmitt +sig 5F6B8B72 2009-03-30 Stefan Bodewig +sig B1313DE2 2009-03-30 Robert Burrell Donkin (CODE SIGNING KEY) +sig 40581837 2009-03-31 Nick Kew +sub 2048g/82AE20EE 2007-05-29 +sig 3B7C75B1 2007-05-29 Gilles Scokart (at apache) + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.9 (Cygwin) + +mQGiBEZcIBkRBAD5fm+1xVyIldiodrRlBF+LIcyKhX/tXyn7BL82cf/8UwxHdcqm +9/cihYQH1ywj3fiVEKdnoHWTtZyvNtA2c2JUUJfqlD81SZKi+pnRzDpnBLmliaYN +CZNo4jlk5/Ft3fWjHe3pYISDrJkMsbfdN59CHtgor88UVaTRANIrc044RwCgv2p4 +kZjazZhUnALYfUGBKTiMnhsEALk8pYW3uVtk7Qlor7KNx5YfSmaIxi/LQnk9i8LQ +r+N0ZA/vMPMxwA7l1hsuQA/LgElTzS5E9caqVP+n+RL0wMNDfova5tar8LgGa8Wl +GC1A4aEF3DUTLuKwdW20ZV3ai7ROaoDwGcMzxQxJwffMVlsto0DgX+cw17g6ld2u +/jpABADf6DfQn170yeCwA7v/iQcSau3vDquMIDGCfE7USUEWop91pi9hs7lEkoDG +V/uDC+XpT2jFD6z4p2bhdD6CL3xXk1PbR/4W9Z/hzQQs7IeKtxb2ZPUkmTGkHa1b +1AXBjk0COaYbFMDHC/1M7tSJVitOjJgn6SzvvpebPzZCPPJhu7QwR2lsbGVzIFNj +b2thcnQgKGF0IGFwYWNoZSkgPGdzY29rYXJ0QGFwYWNoZS5vcmc+iGAEExECACAF +AkZcIBkCGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRCusBoVO3x1sSe3AJ42 +g9VSRlSotQF09SOUOSy+OT09HgCgjdxpDK9DePZJQqNvFiFlVHosOFiIRgQQEQIA +BgUCScqJzQAKCRDJx5JOUQR9ZnA3AJ95e/9F+PbyG644fqHRbNRaoPK7IwCgklmM +i91C3XHtkJIFlkIcrSDYmauIRgQQEQIABgUCScvpOwAKCRBz3YwWAVMCNefhAKCe +NXk2pgPR+IQ5DTynLD9I3zpt5wCfSslyVN1eFyOB98cAvcQ6ZSvQ41CIRgQQEQIA +BgUCSc/ynAAKCRAkwaN4agF7F//ZAKDlEUat3dBPe35MUAd+nLumAx0IwQCg4wsJ +5gf8UUWQGRn9kQqoCpENhXuIRgQQEQIABgUCSdDLeQAKCRCiEVrhX2uLcs3xAJ9f +MNVQ2cvirIAWAWBOWNVxRuBVgQCgmxIdCpUQxXCB4wJkNjjTqY5X+KGIRgQQEQIA +BgUCSdDjEgAKCRDVM051sTE94urLAKCc1IeUJf+Mjssykz1bz9qCoN9KCQCfZ5+q +4QJxgiOzLSjvNBSBSKrSdUmIRgQQEQIABgUCSdJ1/wAKCRBtC8c6QFgYNxLjAJsH +jscYS54FPhD6UQrm40U4hRKD8wCeODdDmprYA+G6BBF3CM7uXK4H2Mi5Ag0ERlwg +HxAIAJXnRz/mS9LlEoHKCvvoY58OAPIjaSqfdNLWGBSjXOsPKSRIb44PmakBGp8r +xCZdgwIRv/qHzkBVjiYD0k4XkftCwrz2yGkzcIgXl6kW3kCkwkrNckFoDmTCGshP +BuTKJctwIDWQW38ORfObOs5dRCzmvfI6S75JYUAi/EEHDtXuo3UjLPEWVEA9xoOn +kUo4MehCRgOh40J3GDyeOaC9/2aXOBLOdNJpciyX/035/rxxIE+FgwYVssfnmph7 +rguczh1VXWtP9URTUHJYis71wCjil1AYxHwTHg791pwde3JifieyNYLCUK4jS0XH +RybeIzrq68pHQGVakrV8alIf86MAAwUH/1PtIDR2YthX7Mwo08H0DLaDpU5sioAg +rU6NytREJR6VHDgRlwFn4FT1skx0yZw4TjoOoHfs5u59pnalRjPitpWPaNRK2Se7 +HsWv83nCZVqXxgi0Zr5xsNdeohOMcKlFhJfu7Q4UgCX9RjMDFVBWdPeeU2vNDdMd +B5XgmQIls7bq6skeX2nZCa+R1M2QK5ckd+qOYGj1Qu2eJbfq0Tgo21s3tgX5Y1nD +wD3VnBV8oqfUNanAnp/km4XlWwI8dk6f5GliWJ7/aKFOkg5IoAjJ3CPfLBrPC+ns +TEuMtaOLk0Bb1rIisXn7Pz4b3EpzetD/lJdVahLy5Ko2lE+OQW3sFJCISQQYEQIA +CQUCRlwgHwIbDAAKCRCusBoVO3x1sd/FAJ9xjqbygtW21vUNcztbWJroKaL/DACe +PEZ4/iF5mYiEb2kEZmS6aRhVxuA= +=w8bP +-----END PGP PUBLIC KEY BLOCK----- + +pub 1024D/7BF8BE8E 2008-06-18 +uid Nicolas Lalevée +sig 3 7BF8BE8E 2010-01-21 Nicolas Lalevée +sig 3 7BF8BE8E 2008-06-18 Nicolas Lalevée +sub 2048g/64443553 2008-06-18 +sig 7BF8BE8E 2008-06-18 Nicolas Lalevée + +pub 4096R/971731FB 2010-01-29 +uid Nicolas Lalevée +sig 3 971731FB 2010-01-29 Nicolas Lalevée +sig 7BF8BE8E 2010-01-29 Nicolas Lalevée +sig 0642FA40 2010-01-31 Lionel Porcheron +sub 4096R/9A54153C 2010-01-29 +sig 971731FB 2010-01-29 Nicolas Lalevée + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.10 (Darwin) + +mQGiBEhY+uIRBACUmSXD8kBukXrvlRHNVCvo1mMNyaGhHbkf2oF1Sr8o/g10wRLF +1zh2Ohgux/Z0gbjumhT4WG/kADsk0r8vSeuiquwyhHIg9ZXBgs4/JFtSbVrahxkG +gWIhr1cLKYSAeFe20w/Bn3zBUtfKVN3VaDyDFJkgOsu/0mXPU+3JbcV/CwCg9M14 +Pk3MtDg2xgfoVlm3CiT1byED+wS8Rmm9+spz8oMA8vKxKtIb5vvlnnIdaSs69XtT +1Iv2aDpCIlYh820G2mghll2f9rfTn7aiiL8ohyQ55N5tSwVdMrUKbsW2o8IreXuJ +XvGxuSAxpWgKluuH42uHXitO06Ir55mkhHG6M06cMn3hEXU4gJRegCUQW41vrCgn +zorKA/0ZOdFGhN0NCACB3o/bjQFINs5MpDpkPZOYkb0PSgtqto75jZQEMqk4vvlp +Z0430MSzA66WSU9rPv9b2Ck7+/bqxFx972tSygUg3w2mSvqab2z//HVB6XQm+R1b +3XGaEMM19nG3K8XJMKolhcrvwbT8OS1ZajEJlvEt0jpfk7rYpLQtTmljb2xhcyBM +YWxldsOpZSA8bmljb2xhcy5sYWxldmVlQGhpYm5ldC5vcmc+iGEEExECACECGwMC +HgECF4AFAktYr7EFCwkIBwMFFQoJCAsFFgIDAQAACgkQSDwjxnv4vo7YZQCeNnaq +c5+4/3NSQjyPNnRBse17FS8AoL8BQSWRvCzlti3VBA7UOamcNM+eiGAEExECACAF +AkhY+uICGwMGCwkIBwMCBBUCCAMEFgIDAQIeAQIXgAAKCRBIPCPGe/i+jhSdAJ4y +bjviXLP22CAsOZh7hn3rkL49MQCfUnJIv8ErY+I1EH+sWMNnj91aY5K5AgwESFj6 +5hAIAKO3XJPcBZBLwpYtOcRZqyUSOQ9uHe5iRtqEFP3fqibVvIEMq7jeMa3q+Y+0 +i6wSbDEnKS3VfTv5JXyIXyK5k9bN8+BclzXGuyzFrz05b3XmkaNZuHHtyfPzj1bt +FO0K1Bh8utejday12ZK8gfEaTZaG14027BdYtoR2YzrilXXzxc740nDOlgAU9pwk +DqWR8gMOUf4l0mLGwG0F66CZJsIY8x580afbCUOTaXXyp9wHMK4ko9zm6+dFT/4c +D41eovaqP+GSxyBow6A9pSD8nFI/YrcrfxvPb2DMLhkBYG5VzYYOisRY/nFot04i +lc0v2HNV7RWrylXzlVRIo9SqC2sAAwUH+Jr/O+GDP3kOmmE7iCCg16KfP67wG/oN +1+pYtSDTSgn4f/Ec+HO6vbkc5A+nfetMdgGnbVnFIdZl9BcNb3xqCQMkGcmEFvmJ +YilxGfqngnu+8kPXJMEfHHTcEXGUme0YaPrJeQHiu2C75n9uuvUMtPO+kCfxfEY1 +TMPnHpDKwTGWuOLdI0hzoLSOPBuKpha7Im4SqQq5vHQ0xJmGSwYR5+l2Weob3nU0 +miyCAT4+3FMTQrQ5N6nX8tb8wqRT85sgwMXyXszz9TQ0g+Q5RLmE4jHP3sPEUhbt +k5LBxPZyxwwzFHgDHmleHP1lzKCHi2K4ed3j/IqOVrhpMSSW8kI9/IhJBBgRAgAJ +BQJIWPrmAhsMAAoJEEg8I8Z7+L6ODs4AnRqXRAlzNAepkDiRwtJS++ecE0sPAKDA +OVV69v0Yz7/QqRrLRB66xTj2kZkCDQRLYwO/ARAApAAIbR+GIZgckHwL4vlPeMM4 +eG9gAina2Lkk1h8YuwkeryEKXwE6ggQOjqvv+MiqV7EhFL2EIDDL68YG8Hmih6Ml +gzlrDwiQILvx9KGKAVRQGiknDz3thgK7rZ0FINdkB0OP04NB7vGX3i+dZfSknN5m +WWucQDxxtN/b6QsLOnsepxdYPU6fcMLvrgXBMwhbFkWjcsv4rkwWRWcx8KUTADOJ +vbndMnbMp24DMv5VNYISri+VJ4PKEZyFBeG4NT4KhL7/tJ104D9zERWu8mWA2bNP +hl1hy3woX4ueBmAUdvKuzFgAEnV98ZTzIGdEPrWVz/T6RccRjwpfxKB7kNVzaPC9 +lNoOPRqK5ir3wVhPYAdE+cNJ0IZ0X37PSJlp+ZHEraR9iGI2AIG7bBwvvtcDqMLk +r78aY8RrAY3+fXScE+yBMynTKWxQXoRJJAZhEJbwA7WVMw5ms+ooPmqYCNwEoOe+ +0KeNC3fxkbFsU9Nt7kqVKmqMAUsOonNAB161JURhzAoYbeiYStq7ln9nEQ+yuZsb +eLs+j6vyAqw0QmuIphaFevz0oeXXPDIoSRMpDiVmrfn/T+283ilZOlYEt08YhSqJ +68CtGhVes3vdx/m4t5Lr2GK8Y8ogOuwdM7v+JJNbhlgYu6CSp+rHsdnh6Zi8zhFG +OMKAzPnorBE7MbzgrxcAEQEAAbQtTmljb2xhcyBMYWxldsOpZSA8bmljb2xhcy5s +YWxldmVlQGhpYm5ldC5vcmc+iQI3BBMBCgAhBQJLYwO/AhsDBQsJCAcDBRUKCQgL +BRYCAwEAAh4BAheAAAoJEDeg4GKXFzH73nEQAJZD8Ol1LfaD4AoA5gR7eo1VuIjT +SkwdufYyo9PPuimMZEt8hZk0bq56Q5g6uxkJqegeBbDTarreBVx5liy4NovqWknd +UqSMANmB5tRtlUmcTTjcz/1BJ4ynb/Ty/YqRljrFf0+yWII9Il3H/gCwHnv2cXun +Iu+x7y1wKuJg2Dg976jIBh1949Jddqz+Hs0NzTuxs56I5yf/mMsVz3QtplgsIPXB +0xBVK5W/HY6Jx9j4qpjWLklZ2TDftzoYdO+mj/RK4n0xxeA2HdK3+XFvJ4fn9xY/ +9l/fk2ElM/4zUAKFDeyYyAw/x34nJJF1KDcp46GaXPM3CkvTweYEsJ5rruuBTYLb +IZxBCHSBsCZwHHCai8+aj3tQywoq7tyLtWfWdiNE03xJumv3O0Zk7XXmAAo9fhgo +91fI4r1hkyy8GGZasXeMz6xyRFzEJyNP9O6a9iAt7w4zlf/J6WrG6n3RchAp8wPi +tvTW6hgZdgr2pP4a7i29lzUBmLbGhOYN9sgbZxgRUiHGee/F++KNV48FG72VgNTj +LYPnxvL7fx8YZkMiWLfEqlMyt7Dy8kyF4SnWH563kOVzfAxKdxLgNWfll4bBA99m +Yvx7b0H/UTAvo474PvJyAPYR51P0Ekq3OSIcSreH39I4as0WNjRNOoWpO4IQP+3y +tIaD+8bMnmhR6l/NiEYEEBEKAAYFAktjBtsACgkQSDwjxnv4vo5v2gCgyeuyy3UJ +dJjdR7NGhGSCHIn27QkAoMQ99L7qjlYOsvkmSPdPSWwpV03qiQEcBBABAgAGBQJL +ZXYVAAoJEGrA8Y4GQvpA8egH/A9b3bfHKLCLGtpn859V1IoLRqioze33dr3I2AaC +CEaxQQbDQZeJWB7eKtnB8O1YuqPTFHH3H9xfyj5DtA2SzhaE1hSHPlYNgGTkfTaB +0NncbD708yAisyilKbDilBnmcxwLbACadO7BCHE47FAbMT97qm0Y270SgN7bwh2+ +14SCjsivVAoRUtYshJxpEQAFYBNi76yi1w5ZEptPCvobI4dcabwYb3rZXVKBb+20 +OU0oeVS1wpf33A8xH1TQc3KtcXgEAwNz4opEZAgWc79km+2BCLTxidHSJylqkrPC +QWo12Du7hPwZzeBKl5wCwOq2qzbFBfB9yVIePrE7CUrNHEq5Ag0ES2MDvwEQAMFy +Z3VaTm01L6Lv3BSvBNydsRvnK3jeBKlWsiysI7uJrzYBIIcWcyE6lDjobmEegu3Z +7lef3/5NmzR2QRhxro/oWXhzZqTfmnLIvUiqRLGD+e7tGrabIabWqjies55lCZaE +vJOFLoEoIgzCPhRcPidfnHfbctq0KIkkP3jbdWmqcY8Y5na2t210jXiDRdGGwPKY +G+2Q+4UUsfFvHS8Q9nZJdmm87hWWa0XUMYOmbE0ffewad2LF3PpT2NK/qX/7jqdX +N/nnSoMQrAuJBmJAQBtdDfgN6Wddm5cedoc2fDcsm3rLamS9dgW7mrNfcIvt3ECw +nlV1rReASPU3CTsuwFxB89VPHOemQ1o52IpW+zO/g/11q5ycmzjteBbL6uL4vZRB +G7VUCi2fKpWa16FhSeZ2+8FMUW3YiS/LL5r1mtovZZdhY543nzuHUYCigqUVvzUj +Dhn3wXgjNNmZbDLPExSacMgvbafeDAGSLtXd6Q4RkFbtxtmwwDmg8e17QW6OKQQ5 +jd5devg2UM053Bji8+SnRq3LgqgvaG90fT85JqtlnbeGjV3CiTizeHbz8ucQ+HtV +uJewGj9HMuRM1Mgw1UHZ+k+5PVkMxmMN5M3O92a1DtYtFxXAK6bbiHb4QA8kSScN +HljHA+lJYfYrQY1vVgbHuCkoE1aTJv0W9B28CwolABEBAAGJAh8EGAEKAAkFAktj +A78CGwwACgkQN6DgYpcXMfvZ4w//QphYIrHnVmlEj3GUXX+DU1vhrHbpFMcqWkSA +xHTDWgbrJdOyf9iMperYo0/3u+DnGR/vcb1LvpIeOtNgAd6SYeSmerE3CZlV/0kD +LyA6OfyinX8vxaXxgcObxrpcB7rpvom7xVE0tUB6vJtGF9dfKQ/VVFtQ2812Xv22 +cFcAZ1jIqYsIZ/TK9aqRl2DqMTCpLWWaoR61hlTc/TeAud67hCDxHZfuQpXrQ0RW +5dIlg5dKSlluT3dq9XZ36LctgKpy6lX3OzJts+W3YN7fkKKxHtCBqltUiUAQDZVs +SJTbV9mheymgLJPqcK7ZUi2HDoi2w993KRUa2GSmQpU0qBaWPJQapY3CueAsSCV5 +rMb6BIfHGr96bDogi0h7vgxieG8TrZrW4J6SDvvzmiIAZhKM78kBBzQ1m8i4xqeW +a+0ddwNcvOEM7G3uH1P3rThHdkIkcPixAGaRXjsOBRVawdNCouf/YcRZakxBIhHA +wfDfgVHPFr/UMZC4iMEt9OdF1uWMe/9Eu9LxF6BzN8VkAmJ5F2f5izl0P6nnmQ4/ +BSG8P9yd+0IMyBAXSeMkYSJVZF2EII1qa/zpWYMx9emOkdL7m666NgwdXrcVf/bw +9EG82hI9O6HI2jQAPMH9WPoungOiOh+TT90IKX5eI+cW0TaR8JeG5A2oYB9Yxr/q +wepeqtU= +=gSlB +-----END PGP PUBLIC KEY BLOCK----- + +pub 4096R/9711DBFC 2010-03-11 +uid Jon Schneider +sig 3 9711DBFC 2010-03-11 Jon Schneider +sub 4096R/3DAD980A 2010-03-11 +sig 9711DBFC 2010-03-11 Jon Schneider + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG v1.4.10 (MingW32) + +mQINBEuY8zUBEACcQbEoZkXl296KesX/bjX1aCatSIEGIZGiWWTfABqzx55tmfsI +BBx1HuuVcBlwMZfeTIb5Oe0IQaZ5h7wEl/ezzwQxOezHTwvAbwnZ4oZOrbs7p7D4 +5I90vsw7rn3bPMBV8xuCgV8t2YFmLH0pzX6+gwmSoVfk+RuxRWfqhHJaVzqNYk6q +iit6NLm2O4PUEeqHWl30RaYPlKabwhoBoFfAzEGIoE3BgukSukO7JmhXGhcS6fLG +V3/2qvzQmb62PwtuHarIHtaPq4lE0DME0+cXZtLEgMq2nMtPxSssYHk71PhaP4+0 +iu7AwgMfAUbNDFJoAc5M0gq2TAoJk3YZrtisTUhSjMIiKrLB8MvnZZ+MWK1/E+Aq +XXocerbgK5fFpk7yeEiqvU1/h+S7WSqIDDOqZWeiKCrrIQZAJvz2f5Ak4A8eyYhv +KXDOwty+q4FL3V76VwWsA7fS8ib9PZqahowaG34DNCflUO3Xj5F9Gk71eBbb894E +Jboq+n7K7Ayo1jRKu8i+HF6KHiPgWcRvpIbJuQxpjxW4c8Kxqf5iGTXyP7dwRWyQ +k+DZ2RKzzNBLXCKyQ5TJtgiHXUEwAW21nCaPijOiqjII00GdoA9oZgliX3O3jKsq +S3llZqwldE97ycfxWenOLn5g47yiCUFqK7/UtJizwYKJC6J3pliC7Kz9UQARAQAB +tCVKb24gU2NobmVpZGVyIDxqc2NobmVpZGVyQGFwYWNoZS5vcmc+iQI3BBMBAgAi +BQJLmPM1AhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRCNbQrQlxHb/BpI +D/iB+WagSbCHgwy+vt0ImiPMggmoxemyf8f1Uv1fz0C9gSH6mY6/ovLrXF0YIBGq +SP8OlTtcz7eKMJPsvJ2n3GrwXyCYLNbL3QUOoHZjnTpmO/vqTtP3jNceoVzW7vle +PwMTgp6Nme0/DQ8Hqdgjinwd/E8BY8AFpNdr2ZaWwVHT9fjKpxdGTQG0iZIesluB +XppnqkltNwBkSdxyVpRXaLhMSjlQyx3S2sGZDJPO7ydiR0EnxzkWP8WqNyEkI80R +n0neYL4HCnwufsCE+sDBiz4p1v6ekUil0Gv0seK+24U+LsEoc6zZatgXzwJ6XEGC +0L6eNZ6al6TzxhKxq6byzb7XQxASV0CiZKQTTY0yh400+cgFwa3p02hFnvl7skB3 +f6u20tmnQi4xb2f7W++z215qPpbsLHTggmAIguX0oF2aTYBjNDLyu0LCMnm2uhzF +Lf/kl77V7AUAWHKdRTDhblTsFL2G/O5i8aDGMbyG82ZieOe2LFqZ1EcqD6ODrLP5 +hhyEYmnlEcb6VSQyQwFwF0E6X4MiZbo0ieLwYEI1P6nSfjKr6Ejuk2EwvQe5TTnM +OwB0a/4jv/U4A3NE26wJKca3LSml3eYPEsOqE7+X7225z6+YeGPGEYCUCu6HI/Wu +0VDsZ0SjoHYlMyx6q+bvbLhwBBUJLP6aKiGeptDUHYCmuQINBEuY8zUBEADd1HYa +7X6JLzEyPZOaddJqR6RZoBKBxmfqxcNv+jO4BehqVEEh7f+Fj/P80JwlyjLiL+1N +tlf/ejfMXrhjqK5uNbVyKRtwwlgztWook+8zJ0xMeYth6UXdFdhrUTs41R4QSUai +c8X+kEQex1TgjCXeDBiBJgUEpnMIc2OOIZgEHpverdOE3X0WYXqHppC0FCzYBTix +x8gw6bsgn/Z2mGMTmzHtm1OtIp9mWJQtY+tLa6+3sWiedClrQcWtUIxPqDh68Ckh +Lwc05TRGryqZ40zU8mF68DQ9GQB7+FUADkViT5l/cGZa1XCEyPI72IjdH4WY2Qxl +ivXoItQgUPgVBo1aeeoVYFr43iCFMVPKp3qOJTeJGg/qezc3X1TZXNQ3E6vY5XO5 +9d4CpduJ1uOjk4NSSnfpUG+Y/LrCrx8yqO2Uhh23S6KhO5Bx7ar65YBBFhFhc2aP +sqRfqUSACaDKmO7VvxarYcjvbqb1zzwCzXzGhb3LqIuik8ydkoBB91BDouNM5J3u +O2KHVhRrnPncyDtL9FQ7Ru7T7NnFdtxZ17BSM6Z7DUHs+PJe+EYBzMN7UDkV7eJ8 +/2HC59QaY+NoNYPyNHOwkTNQyn5kMIwoTVBndqBlSdp5vR+8n/nJ7RNOF+pPeEfd +hs1rzfZy/+1wP4PWWh1Cj34ZrQjpfDKBKYiXoQARAQABiQIfBBgBAgAJBQJLmPM1 +AhsMAAoJEI1tCtCXEdv8XNwQAI9dF7lvrIz/7D5t0+u43k6dSGVH76tMQXv6yo4u +tyuKoRieR315SjjgCGZ817bHM3frxyIXLk+PMT7Brbi2DKoftVVLpmVDbSsv2Pi+ +mqez8XjJFoRZNgwbWESjtcNJY10ukwQ9VT5+73kVNIQdbizK51hK13+Etd9UGr6p +2MZOe+nV5bbKnEdCxrRricbGTOju5x5i5DEZzWGa8W2JZKHsEF/l3qrfYbmn0AMg +vXw5Robo38ZxxuH3l6O3GEed4aUNLJSmu3gIl32uANLE5kg/OYbupmAuvwBCn7/D +xAB7LY38Tg4zIrWfhQCzP5IAyxYOZSFgsggpJ6foilOLCgJul8Vq19HV98FsWf/M +sE5azSIfJI/Z5EWpbaM0xu56nbJ2O18mN0Y3ojz5/ewZo9+ODRm+buCI+Muz5Gs2 +iNoi9D8jtudc46l1OASP7n9e+WQDCd/IwwsUXHqT4+EkM/ZIj31W1+mBZtzIPBCU +37ibGfpt4W8GC9DtsDk+r0A0+4RurzVYTR0P8iTb4uq0i/ffBPBLVTS1E9D/WcGP +2DX7YW9e6LhY1kIbjrLR/rDHi95sx8QOCBMridpy8RlXdwWKU/kZ9s5gCYBVKBhj +/w98LUqT07uWFU98kDugW15Ng8OCogpaueDYi6hA4A6c66EhjdKH9JzigxfxjSkD +udvp +=oSat +-----END PGP PUBLIC KEY BLOCK----- +pub 1024D/265B4C63 2003-08-18 +uid Antoine Levy-Lambert (Apache Ant Committer) +sig 3 265B4C63 2003-12-06 Antoine Levy-Lambert (Apache Ant Committer) +sig 3 5F6B8B72 2003-12-12 Stefan Bodewig +uid Antoine Levy-Lambert (Apache Ant Committer) +sig 3 265B4C63 2003-08-18 Antoine Levy-Lambert (Apache Ant Committer) +sig 3 5F6B8B72 2003-12-12 Stefan Bodewig +sub 1024g/A3060393 2003-08-18 +sig 265B4C63 2003-08-18 Antoine Levy-Lambert (Apache Ant Committer) + +pub 4096R/710038F5 2010-11-02 +uid Antoine Levy-Lambert (CODE SIGNING KEY) +sig 3 710038F5 2010-11-02 Antoine Levy-Lambert (CODE SIGNING KEY) +sub 4096R/84F32FDC 2010-11-02 +sig 710038F5 2010-11-02 Antoine Levy-Lambert (CODE SIGNING KEY) + +pub 4096R/82A7FBCD 2010-11-02 +uid Antoine Levy-Lambert (CODE SIGNING KEY) +sig 3 82A7FBCD 2010-11-02 Antoine Levy-Lambert (CODE SIGNING KEY) +sig 62B2963F 2010-11-04 Dan Poirier +sig 7C408737 2010-11-04 Joseph Edward Bergmark (CODE SIGNING KEY) +sig 02E9F65B 2010-11-04 Luc Maisonobe +sig EFB55DF1 2010-11-05 Luciano Resende (Code Signing Key) +sub 4096R/70EC4C9A 2010-11-02 +sig 82A7FBCD 2010-11-02 Antoine Levy-Lambert (CODE SIGNING KEY) + +-----BEGIN PGP PUBLIC KEY BLOCK----- +Version: GnuPG/MacGPG2 v2.0.16 (Darwin) + +mQGiBD9AzmcRBACMqgb7IFvC/nLxw7mUAgHENeZXY3JOQJ8wVBevIbbMEeFvzHE2 +diFydqUXocPexduYr0ahkf033WvWdAiNqDLfVW/HFOsc1TpjbHkqPUHtJ62Ya5tg +nH4UGN9BYZfMbfVDOSz41lYwmfK5HYgpZN/sBQBSKf2qgoFB+LxYaae8YwCgrWlu +fYhf7fkKbbdSf3BGS67ggNkD/0VvkXkw1SEnPaqrkKGkPKomCTb2auGxcYYI3/rP +1m+SGRf0gE1NtocmIEitiR6WvfKUjoMAXSCp5KdnUXmO9rwzkM002KCA7K5CY+e/ +2bLDuiQ3rNiD4mFfG6M+UnmZ+GMFba1p9Cp4PqLNLsCHz67t7hEsscTZQ8mZ9xKM ++GCsA/9P+XFM7JDn9MLhYab9qo1CkceBkthUP6jWGjuAZ00elmBCkpkzNv5aIzss +xih2GpaU/tmcMjw8FGp0dTwzqdpmbZBLjunRnuBTir4m4l5G9rwl4JbfK1PVqk4a +VKkh9W7/yqBcEfNcsfJO9cqaQ+PzcnCoDiD9UHEBYzUhrCKwhLRCQW50b2luZSBM +ZXZ5LUxhbWJlcnQgKEFwYWNoZSBBbnQgQ29tbWl0dGVyKSA8YW50b2luZUBhbnRi +dWlsZC5jb20+iFsEExECABsFAj9AzmcGCwkIBwMCAxUCAwMWAgECHgECF4AACgkQ +hhTWqyZbTGMnOgCeJV2gI+1CIxMR7dcIhXjPkiusreIAn2SGOsPS0o89l0EIVuc9 +J2F03aB+iEYEExECAAYFAj/ZwioACgkQohFa4V9ri3J8CACgiGlh+td0BAnJPq19 +ovEQR2DJ02MAoLP203EF+BLPpykeTcGp8UEWmeGQtEBBbnRvaW5lIExldnktTGFt +YmVydCAoQXBhY2hlIEFudCBDb21taXR0ZXIpIDxhbnRvaW5lQGFwYWNoZS5vcmc+ +iF4EExECAB4FAj/SSwYCGwMGCwkIBwMCAxUCAwMWAgECHgECF4AACgkQhhTWqyZb +TGOh/QCfbrSoipMlizyGT6c8BOPEd9zzfi0AnRRTqTDzXzsGk4CG/BJME9CCm7Ts +iEYEExECAAYFAj/ZwiMACgkQohFa4V9ri3IOVACgh2QHS1+cVjvM4eLjls1bJwWi +o5IAoLtAszHrwHS5qrhvr2rtnlyyyV2guQENBD9AzmkQBACNpBfqi2PweozCtxoX +PqzKdRDKqCw7TOrDR6lbP3z/ov/1SN5Vc0XqNzBSGqwBcmGWtneABkX7n4uzJrC5 +wvX/TZ/DkMvypPyeNVMu+/ZMlzdbx06OUDKr6Fy/NtaI7cN1rw+Igyv22Q8ilhhg +s/5Rdj84EtJkWQjVRml6wXSAZwADBwP/TqyhOC4sA5YrePYGH8i46h0SU9dXjfEF +JijC8vXZ+BNQHQVK3fjEXedZL8Zvvp1bsMu7Muz9SMnqygM1unp2NGxLRd/9315p +Qh0VStYKn0xq13ybOKr0Gsyx5yyl3Nzlu/1qAR0es/zN4jV7/IQi3R2GOvezcpHX +mkbsYiZAhu2IRgQYEQIABgUCP0DOaQAKCRCGFNarJltMYxcsAKCSJJUABlXYnLBj +b+WtmAzu0JjZNACdFJ4KIATJDK/5ajFq5+irOpodoHeZAg0ETM+HJwEQAMkzgJCo +lSOgkvzsTcjy/4ySwS56VgyFdYpZis8QqbEGCe8xKT+d9FYi5sBTw/jGpIy4weig +NKRRW4NLYgriWJANksBaaPOKvczGAOLWzh2aPfifaGF/puIVT8yCubH6ecxr0Wy/ +lN54Rpi7cmpp+CEbhUTR+7xNGCMt3f9brtOlC6qYN3tJ7PPcfNBjJr0Ts+fPt8lT +RZlBhVa9iEUVYoqMnZQEBmYkg+FxSrFlLw7/WLMKaKGHAV7QbpIxhaDvQ7bMM6qW +c4plt10+wtZtJV3MB6TIRSYaEF87hXCif7mJY8KkCN8XkAxFlQhqEY/gJTOs73DS +Z5+LJKUOF+0+66B31tN5gQq5yNBGd55OEA9iOM87hhQb4e0IuZGvq2vxxK1OL6Q5 +apr141c0ZxHLKaG2YCqM0B42mW84V2mO/Xu25HUjmXGrkpEd61KaodffS5g7SWj3 +jb0X1w/+QGQXnWdTPWuWu/SrpnJb9kBpk/awrBbh6/gz9Uug6WVw3jBaYvfm2gEf +eKVYXa8AtBDSDuytXSXCSNRKY6Hd27ohUKMRBLEtz6Z+WgTKS11u9ip6ewG9irtk +cJQmloGjgaQTLmTXJaZ9UkaEh8uH/LinhIDHk+ilht7z2+CN7S3kOX094v1AnvlA +OchoDd7Wn1KqSoiM6WO5pccPdnU/j4LSoeVDABEBAAG0PEFudG9pbmUgTGV2eS1M +YW1iZXJ0IChDT0RFIFNJR05JTkcgS0VZKSA8YW50b2luZUBhcGFjaGUub3JnPokC +OAQTAQIAIgUCTM+HJwIbAwYLCQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQDmn4 +CXEAOPVsEQ//Vv4CTUrXTvuaPTNR1x08nntcF5RY+2GGNlT5Cs6EzRbiB3GmKFKu +Qxp0Ucgr+Yg1NTa7jOP2TbMwo8/FCD6i/Q5pWTISs7CdahnqKx37a33F1Hz1bNqV +0Jhi5oJS/sVniYG0d4ZcUl5FkD/gDXgNbUDaB1Vi3I9bU+agwrsLoXrFWDpDPxrg +PGDV3grvqfEp7K2HvPl2B6mUQHYHbIZ9FgjRLRIjOzjMr33RkVtg2QrLaUiOlJ3r +i0xpWf2kMKDMej6M3vFP7PTacRHwqZMxZMWZ2WaviuC943pK0gWwUyJgkkYSrfql +LkzIq3DwKPUneuuInNS4bab8YjwuGYSd/Fnj11P8emTEHwkIIKFyH0LxO2JKw8tV +BosgExmS39P99tGjAOp4Qg1E00exl2mxtIiKI359DS3DYhjEhb5EDH1gVAh5GL2s +Y/NiI4VANomiuzkzCybVYaMwjRpaIkCKemXN0BXb8r7e3CLXn4BA3KHIpuZH4Yz7 +I6RpVuyTOrayM62czy9mxF64Pnwp0gRUJhWC3a2BTYXV5vAtW89BrFB7ArENUKGd +q81lUXVocAk/1LnMxy5fveS5yuUMxPM0fRBwzgARfyv+0HdsjzVmKZZKfjKPOjB5 +YWtOFtdFSdCzYnpIGyoPuUU34v8LuzRwMdBDrODb5LfvX3lMw7YvIkq5Ag0ETM+H +JwEQANOvLBAACFpbL82gr5fP0xfL/fG+oSrAqumUsXmxnCcxHOzDoEvExxebVnL+ +102IXIMV3eQqEaZuqcUYGBjkMt216u5btuSoSsVDrwRI8T3/9fXsB/jdvlCzsq7b +pImEFh7VDQc/jC21pP7r1G81Tt7zWB8oWYBbGXJMGsacaNg6449Z/0Ctp+gi+T5L +jIq1b9apD/+ucg9kGdlKFlLJ8zMwc77hG3LWkoli1cbLgYKk4RKahboFmoEVnM9S +ypdFfDZuSCB+7PvitjfqEao+fOCYOG0b3ykdcYXSVitFSnHe9T1DLjvKBy9qMtbA +GkdD61xEl0MtifQxKkya/n2Fg438HUeU7ltcFLlKd4XAzmsh9PXy2Gpj/lbNYpsD +DDMZafyfFfkLYYZasN4/+Ak+f5T1OuUqByIlesAPGReFtnUI+yXM9qEImProy+R5 +gNkBPN1AnNWvy2pi+ZUUI+35NW49uee35p5LNzMiP3hd2W+rDHWhE9y3oVFkpzbL +lXwF7AMQGtMNE6i82XfahDyiMRo9BzssTSdYc1+5OO+5buXWuZUibYmGc5yDQ6qv +0Yhlry4uoBMLJQcVCMkFh/os0gB4hgzI/MkhuEIYIBZcjGTzIzeGnB+0hB3ODiqt +LmrR2IiK56EkJ+UGfQ6Niankx+1M+OtSFXc9oWP4RacT8yaZABEBAAGJAh8EGAEC +AAkFAkzPhycCGwwACgkQDmn4CXEAOPW/3w//Wd3DfhQTXa1LoenNuuALnF9zIJQr +scLXc9HRO41x+0oCxi+ePDhCSiTWKWA4t74PsgLurdwXnQlcFU8rdSeWSalnO0gr +f0Rs+OHl4ICK3AWAgzZjFDh4J5Pyr7fVteGlUlKRgCCy/rGMwwSnCGLQYa9W1/ZE +KYZzLvFk0S/AoSv2iw6BxWUYVZVO7EzRzLoauLXQX6HyFyTpaH2soYbs1Xnp8t/u +w47PDnWXpYAaM0P1pD0T6krYp3M8YdNySGiXaZTkHBP2bj0PllGQHB/RjOyUrv95 +USYZj60O430OyvjlIBDq+BBL/ZLEbMdUIFJJ6WO1F1nIr8MowpTNqeEBpEaqOY6A +lV0j9fZWX2qJKIxQayq5OjfWL6Y7juJUuDBBZUzPtKSmcwGtg3HsCL0SWoz8JT4p +hPOXy4Zk1NMn4F4oIwRrGrcB2lmBaQmoBWBP63g5rObADL0wsyabfYuVRTE7PoSg +iCEN7wONrFjXrpB+WWG36d8nrETyMKALr96YL+1T4VNs0sllYbrkowRe2ioMKj9r +t61UPOGhPekw0HA7pDS1n+nGMMU+efLKKCvcKFKq/TDdjK2jPg1JQ1Xq8O4fDwRf +ibUXyvYwswAqOqQ0nHH5QSj9pov3tsXhJWWDVIWKMFhk+U1Sans9txHEQKJl8L5k +KiqgPxg3Tk50+6aZAg0ETM+LbwEQAN5ZRgD4sZJ6ClxoWjlmMM1c9632/isnzXJM +unkZeCA3gjx++uhZexCdSD36aQZ7dAFSwvrJLHRrjsszl/uc1H7FaBmkZ7E8sjNI +/oulUtMhcLe0TYy6MRSdl8aBqll4slZNfcl7iYk4PCmk2eR4sdMPMEsQC2kcglDW +HDeJfG0RozFgJ46QVRCktRWTrrACQcvuHLizl0+4nMZ76yexNre7Rrgo6kE5Mapl +0UXog6qM9ngV5cVxh2/wDex5fmXvB9uNTusEQIFo8qaZPBtapAAeoIShyUWispqi +kos5t410OzlGfBHsDb0cq4SU44bAXJmkZv/95JECEy8mZjsbywU4MCDjAf1lC4d9 +K7lcwHQS9rE2Xw1suXfD/VjQy9obpLLROk1DGLJC0aige0BbhMOa+mXgKVzSKcKv +PdmcUHcdm0dIy/LYZhC9Ja0uv37Sc9Ri55k3DU6DgdBu2dZgy7q9bBzLpqPIyTPs +XxUlczjhT6KxZYDeyghbwJYQ+miasY2VHeY9aZHYXXhDHIo2eEaut1y/9a7i4auA +aYnaADj/gmryBm6rb+r/MIMbfZ5htB4l6aoI/8BJygzq38LrWwUvzQ3p/N5+jA5N +uJWexAbG9hEc7nbbwINwp1b0P35eqSxhtr5wGdSNor5zScHazaPjPxHKP7WiATj8 +a1p0MlEHABEBAAG0PEFudG9pbmUgTGV2eS1MYW1iZXJ0IChDT0RFIFNJR05JTkcg +S0VZKSA8YW50b2luZUBhcGFjaGUub3JnPokCKwQTAQIAFQIbAwIeAQIXgAUCTM+M +LAUVCgkIAgAKCRBe+tn+gqf7zcwkEAC3VkVY4TGXoj3CDnjCL9nwkxAyK+JagXSw +7g8FMjqWW7YAIU8TprZxtOJUcnSXioVtT8dhKBfaasu34EpMrUYEIPNp5BNzhxIf +f9hXVrcuOZ1k0nJRlSc4IKSsrognoCDm340ma8AOMARVkrz7tXdqdlDPWVjMvqn/ +5/KReaIHQUNRqjypIIdM5mgaE41F1+uAyqLqcxvf4YQtu0NNGMizGZd37bH+5wMF +BT7S6CesAVPogcfnMdoMN1wO2yOzWKlg49U91DLUY3XHGOQnqVnTnVQ/xzLEj/vf +0PlLoY+3Yn9WEaonkMgco9un71xZ9s4DnR4WE+7QJYU2cgSPFB5DbAZ925qcNK/x +wOpKfRyBPN4zdjWE8Vjd25EcjZLsxgPiSlPpbyIJD6Ot61uoqekinNlAo44sleg8 +rNAAYnajlD/1La+Q/grQnHcujOt/w/ya3LG/cTpz7wkUhxhnmMwmxrVlEFaM24Qk +PwbQE/Wuwdvm/hYX5o4F1b7DQ9WepNZ4ahb/ztbsIg2my7JLN4RPDWZ++EMt5K6w +G+34vn8RfuSu4GHT8TAoexDsAEWzFo67F+dAosrvfw+HBBm3hNEz4tRkKP4SPqmo +dE8IXUffF+VFeFH0NLsvIwfpdW90XNxnSlnrc8aVpdvuE3qXqjQICo10LEJuxZRa +hNggNMtUNIkCfQQQAQIAZwUCTNK+FSEcRGFuIFBvaXJpZXIgPHBvaXJpZXJAYXBh +Y2hlLm9yZz4gHERhbiBQb2lyaWVyIDxwb2lyaWVyQHBvYm94LmNvbT4dHERhbiBQ +b2lyaWVyIDxkYW5AcG9pcmllci51cz4ACgkQnPorAWKylj8WUxAAmxx/NESLJp0r +A+fW8dQ08jGZ1Xf1laNCEd1eb6FXr/Z2xsKPFq6okBiiw6cm2wiwp7DBBHxQatyb +AJNLAGVg8wpHUPgUguFOY1LyLRZ9i2SKKmWG0jzQ7svWELxssHFUnMW8dwtk3qAb +o8pKvOKf4ol3qoKfN3Xq8ZBXAGkQaTIOJzGSfau+dH5NbhMcqZEoKGOAcOsLiIHZ +Cnos9KqFMxqBlTMyJWO9YP8dY3mGHUWV0gsYfE32bHM3auaA2Ynzxtor/jMBATeq +hTWjRAD1H92/HZ9vRBKwpHHpjsF+21aL9TZv5D2OmFYeN7/G1tyRcLYLrhDa7tnx +r5S/ePdypMZ2IUaC0umMKrc8ZrAtK/2N4ZmnHKoScCJHjup66cLCVVFGXHb2hEM9 +2fPFog2//s78Cw1DAxaNE4jjmR4QWXmQZUqA8AymIfgsi+nI9rWMWnpTCC6DGG9+ +j7GbIpPdRscqoyAiPl2lBpZerLirTa1GMuDqqGuNiv6YmEvxNVleOlPYCCQr1vY5 +ltJz34zckBNJAH/7woggqoyGiLa456ruDzU77qxUCy5ulFTOWsVtltojnlxgKBML +8f0uThQZN+0HydPb4uP3k5aLNL1ktiSo/XlIP2/AO69Bi4YZzERYsETm2zFLWx1P +MN+R0l/BAjRskTCX+H92fG5OkGjkmR+JAlwEEAECAEcFAkzS16tAHEpvc2VwaCBF +ZHdhcmQgQmVyZ21hcmsgKENPREUgU0lHTklORyBLRVkpIDxiZXJnbWFya0BhcGFj +aGUub3JnPgAKCRCw2ZG0fECHN8OVD/Y8+R4R9aNkuZJ76SCHOIhxjKtMhk44muAZ +FQwB+CG7HY4b/869+JdAOrwsOYr75h3vkz1vkU8FOr2LAu6PdiXDKpEs9wkPDGFx +Rg9yePaX2DbAh0Ch1ucR1FZvr3QqO+L0ri1lfUUl76n/QfZtHXfuoPgsYIjsbv6g +90mxHFJxxmowgX5gWKYaVm6OFN7xYiAC18Ia8LfReNIZO0XyaOq2/NoLuIVyguyi +C3RuVnvAk92/6YCPgZNiH1lN1kLmkoNvGpY6CFkCI9LKZ9xRCbs7Dbkoz7I+EYla +zfRf5mLjsrI+nVmFHvicvuw3ZtCCAImMdZ+Z53CHwd2N2v81lqnxUyCDPJf4Mxcw +Jq7Hf9hYZUBS9Ehj3nfCmJwOVUMrXYXurKinDAcyoYmlA2iqdzUdM3d9xFGjexsl +cUhZusggmOvBc3bK5BLZXUm009B5LYz4BGUAVsmN8vXekRgevszz5GcZBKElgRds +9DQaO4sbgrskq2TXHzBI7e9GiEcUyErZ8fdsbea5zrPoW2/x74Kq93VtQCuWPDOJ +Nq95l0J6bmiaVZuUTO5YIHFts7jphvA4gMf/4Lnzhzkcwftgi9OwyDBbpTyfdno+ +hsYBrBFQP4L7DLaGewHt46Iggil7Y9oMO0Yo7JtCsRnDtZYxc4rveg8vRg2xIl4y +NJlDNzNciQIcBBABCgAGBQJM0p5uAAoJEJrilv0C6fZbqooQAOpWpMdzXdmDG2fe +BffHiY2sabhX7B+tBRw+SIvmGw+ZvWvy3Tp2xFy7+PgCJhs/wbjyI3tCyx+DPb5C +ybZpDjferuhbKA/PVgnJozUhYtwLFQ7bRyvlLq3ZSZZawVn2bbIHn1knjohz+0hB +90zVX6vXhjPNZwL8vzPa3jMMNPDbd4E7w0VB63sWTKXq/pTy5SFGfscunxOsDMbj +KcW1VtSszH68aywefZV9DbmjSDEgNRiqwtj+WxD3rp3fARBO+4o5yIsjWu1wGL+n +59atHZJp34dAJFgOTJ2Jtykyuh3G76k4XKLemgUsu4aWFAlNIWt/f41cT5WmQe4z +YG4yWLE/KWpIc5Jn2p3wlQpKqwl/+F3pkOpqPZmZkYjn4ORCMg1Q0eOzfiaheofv +T78N0j8020z1lf5ojmEtGHoOzwz076Z3TGP256a4F37ZzibM7KFBn4iwjVrgqfFa +62Q5WG+q2rdmpQ5B2eXAYNxg66DiMcfR3zHJeMz3UpOZcygIUZ63N6VK7+WgNPtO +swBmXUxa5L35+a616/vvPtCEBlvJtDQz22BIvp/RpYaJ1k5K58uy0hj0oXZlD3q7 +BJSgPhgYOOqO79ZOwbgqGB9is5yegDXtXctV4FGuj601C+qtUHbRLmGio3XSMnmy +FCOJpZW41tJYo9uQz7dRHIzGsBpSiIAEEBECAEAFAkzTeLE5HEx1Y2lhbm8gUmVz +ZW5kZSAoQ29kZSBTaWduaW5nIEtleSkgPGxyZXNlbmRlQGFwYWNoZS5vcmc+AAoJ +EPOfGH3vtV3xs08AniczpMS0xOouROjBIHLC+RlBdMwAAJ0ZiOfPrr5+C9Glo317 +omxwZ0obvbkCDQRMz4tvARAAoqAcqn4cTgkAEACgeJQJoPKYAAyZwISGNTgqnnSr +BtN91af3XoVybrnXvlzFc6CkyWQ5T44yMaSfM/ZCYMpFCLtzssTlk3R8ASd7aIQR +/ydoB5vaPZ424NjSfsNLiF1NR868R8iFPHphegw3P2UeFT8rw/arcdJ5lXQ/J66p +63t9BlggU4piIMl/JPrtVawVLelYMYy3zw/RdnmrvU1qrZBGno5QkRhRlOXqQBTv +FlWVZT0GtC+lNha/MqEqW5YkACVPYqpmYk2aoNH5+Gj/yBpWap1o8GsVZKZQUMx6 +CPAT9GcTrOlFqFbFG1kL0iOQgOlggQ0Kba5LN1VXUl7ESsu7NYEXDqDdbjduVDMR +UsFrhTPUOf/kRNPjMPmGih0RP1s0woe3M4dsLaZEcAu88HHMCcaiOfBPAFU84upM +fEgh0BIcmTVwAaSftD5gzmZKY3YXfaS0cD6RaZBWuzecHNDLLEgzuhNbUtmtylx1 +X57tep9Mh2tKDFrqBxlhg3M73+mGdE6zgsWhgOeAMATII8mzM90zLh4bg9RBxdp+ +PnoJEbuZVdIX2bNJPt/u4LdAV/czozPjkZtZ60VSkEYyUnZ2dNKUOv5tujkY4dm1 +V+R9uR25C4fLopnE/AN26+GYePrbBaghEUh7ugg7HlTEXPz2JsfvpjPIaao0V1+A +bEUAEQEAAYkCHwQYAQIACQUCTM+LbwIbDAAKCRBe+tn+gqf7zYEvEACoszB5B68Z +QrcOBSWvk4l0xWLNfZQIl0M5WoNEoNj6Vt1CzIXadRFxHu1m0gnDLW3brquRuxTe +acho1iqinNw0pP7yODNW5p5ftKdvFlB7NNemVxzNZn1Q4cSkbI7GdYFiU9WQf7lB +TQpzFhjJSbJEMHtQrYOqw1wGNPZThEfNXwFLwe+0RF25gEQwuTkRdnpKarBeZiax +8zkuOmTLWmrI5Dq0dsYi6YotuHaSa3cFjGo+gp2cj+mBljaW8BXAIjzNunjMKqkV +XNA+Eh3w8FIx7NYZfrbDz4II3naYLb3x3IEwb6g7sTnCexFyTcS2RMJOqPBG2Zh6 +UI73B3AGkWDMsUyDMPVCVOEWUsT94tPBDZCrvdOpVu99OeMqESuaIuPELEbSIrsU +aDCyJDnIWVExk69szQl/4HOM+u9WBtSmG94WOCT7T+ypPcfFBPpUvxx6VriWKRQX +yKUlVCJVET4UpDHIwVUpIsmFmjxZfTlhe7pny8/a03/EnvGImuLYoxhfzP3VRapr +86fwCseMxAPW3gnl6zvGZrIM6ZS09tdyTIOiHUHMcXvWpyxdw+7EXHuncpEB5m0U +Ci8LBeDYqitVqqakgdKGAl8pfwaIJ9DsE5Sv/IHKFmieLa9PEh/2S/4hCD31atIK +3PimOFurhebU3wOU0wEkNb/3IYLk+MFQOA== +=1STU +-----END PGP PUBLIC KEY BLOCK----- diff --git a/tools/apache-ant-1.8.2/LICENSE b/tools/apache-ant-1.8.2/LICENSE new file mode 100644 index 000000000..cdf6ff8b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/LICENSE @@ -0,0 +1,272 @@ +/* + * Apache License + * Version 2.0, January 2004 + * http://www.apache.org/licenses/ + * + * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + * + * 1. Definitions. + * + * "License" shall mean the terms and conditions for use, reproduction, + * and distribution as defined by Sections 1 through 9 of this document. + * + * "Licensor" shall mean the copyright owner or entity authorized by + * the copyright owner that is granting the License. + * + * "Legal Entity" shall mean the union of the acting entity and all + * other entities that control, are controlled by, or are under common + * control with that entity. For the purposes of this definition, + * "control" means (i) the power, direct or indirect, to cause the + * direction or management of such entity, whether by contract or + * otherwise, or (ii) ownership of fifty percent (50%) or more of the + * outstanding shares, or (iii) beneficial ownership of such entity. + * + * "You" (or "Your") shall mean an individual or Legal Entity + * exercising permissions granted by this License. + * + * "Source" form shall mean the preferred form for making modifications, + * including but not limited to software source code, documentation + * source, and configuration files. + * + * "Object" form shall mean any form resulting from mechanical + * transformation or translation of a Source form, including but + * not limited to compiled object code, generated documentation, + * and conversions to other media types. + * + * "Work" shall mean the work of authorship, whether in Source or + * Object form, made available under the License, as indicated by a + * copyright notice that is included in or attached to the work + * (an example is provided in the Appendix below). + * + * "Derivative Works" shall mean any work, whether in Source or Object + * form, that is based on (or derived from) the Work and for which the + * editorial revisions, annotations, elaborations, or other modifications + * represent, as a whole, an original work of authorship. For the purposes + * of this License, Derivative Works shall not include works that remain + * separable from, or merely link (or bind by name) to the interfaces of, + * the Work and Derivative Works thereof. + * + * "Contribution" shall mean any work of authorship, including + * the original version of the Work and any modifications or additions + * to that Work or Derivative Works thereof, that is intentionally + * submitted to Licensor for inclusion in the Work by the copyright owner + * or by an individual or Legal Entity authorized to submit on behalf of + * the copyright owner. For the purposes of this definition, "submitted" + * means any form of electronic, verbal, or written communication sent + * to the Licensor or its representatives, including but not limited to + * communication on electronic mailing lists, source code control systems, + * and issue tracking systems that are managed by, or on behalf of, the + * Licensor for the purpose of discussing and improving the Work, but + * excluding communication that is conspicuously marked or otherwise + * designated in writing by the copyright owner as "Not a Contribution." + * + * "Contributor" shall mean Licensor and any individual or Legal Entity + * on behalf of whom a Contribution has been received by Licensor and + * subsequently incorporated within the Work. + * + * 2. Grant of Copyright License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * copyright license to reproduce, prepare Derivative Works of, + * publicly display, publicly perform, sublicense, and distribute the + * Work and such Derivative Works in Source or Object form. + * + * 3. Grant of Patent License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * (except as stated in this section) patent license to make, have made, + * use, offer to sell, sell, import, and otherwise transfer the Work, + * where such license applies only to those patent claims licensable + * by such Contributor that are necessarily infringed by their + * Contribution(s) alone or by combination of their Contribution(s) + * with the Work to which such Contribution(s) was submitted. If You + * institute patent litigation against any entity (including a + * cross-claim or counterclaim in a lawsuit) alleging that the Work + * or a Contribution incorporated within the Work constitutes direct + * or contributory patent infringement, then any patent licenses + * granted to You under this License for that Work shall terminate + * as of the date such litigation is filed. + * + * 4. Redistribution. You may reproduce and distribute copies of the + * Work or Derivative Works thereof in any medium, with or without + * modifications, and in Source or Object form, provided that You + * meet the following conditions: + * + * (a) You must give any other recipients of the Work or + * Derivative Works a copy of this License; and + * + * (b) You must cause any modified files to carry prominent notices + * stating that You changed the files; and + * + * (c) You must retain, in the Source form of any Derivative Works + * that You distribute, all copyright, patent, trademark, and + * attribution notices from the Source form of the Work, + * excluding those notices that do not pertain to any part of + * the Derivative Works; and + * + * (d) If the Work includes a "NOTICE" text file as part of its + * distribution, then any Derivative Works that You distribute must + * include a readable copy of the attribution notices contained + * within such NOTICE file, excluding those notices that do not + * pertain to any part of the Derivative Works, in at least one + * of the following places: within a NOTICE text file distributed + * as part of the Derivative Works; within the Source form or + * documentation, if provided along with the Derivative Works; or, + * within a display generated by the Derivative Works, if and + * wherever such third-party notices normally appear. The contents + * of the NOTICE file are for informational purposes only and + * do not modify the License. You may add Your own attribution + * notices within Derivative Works that You distribute, alongside + * or as an addendum to the NOTICE text from the Work, provided + * that such additional attribution notices cannot be construed + * as modifying the License. + * + * You may add Your own copyright statement to Your modifications and + * may provide additional or different license terms and conditions + * for use, reproduction, or distribution of Your modifications, or + * for any such Derivative Works as a whole, provided Your use, + * reproduction, and distribution of the Work otherwise complies with + * the conditions stated in this License. + * + * 5. Submission of Contributions. Unless You explicitly state otherwise, + * any Contribution intentionally submitted for inclusion in the Work + * by You to the Licensor shall be under the terms and conditions of + * this License, without any additional terms or conditions. + * Notwithstanding the above, nothing herein shall supersede or modify + * the terms of any separate license agreement you may have executed + * with Licensor regarding such Contributions. + * + * 6. Trademarks. This License does not grant permission to use the trade + * names, trademarks, service marks, or product names of the Licensor, + * except as required for reasonable and customary use in describing the + * origin of the Work and reproducing the content of the NOTICE file. + * + * 7. Disclaimer of Warranty. Unless required by applicable law or + * agreed to in writing, Licensor provides the Work (and each + * Contributor provides its Contributions) on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied, including, without limitation, any warranties or conditions + * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + * PARTICULAR PURPOSE. You are solely responsible for determining the + * appropriateness of using or redistributing the Work and assume any + * risks associated with Your exercise of permissions under this License. + * + * 8. Limitation of Liability. In no event and under no legal theory, + * whether in tort (including negligence), contract, or otherwise, + * unless required by applicable law (such as deliberate and grossly + * negligent acts) or agreed to in writing, shall any Contributor be + * liable to You for damages, including any direct, indirect, special, + * incidental, or consequential damages of any character arising as a + * result of this License or out of the use or inability to use the + * Work (including but not limited to damages for loss of goodwill, + * work stoppage, computer failure or malfunction, or any and all + * other commercial damages or losses), even if such Contributor + * has been advised of the possibility of such damages. + * + * 9. Accepting Warranty or Additional Liability. While redistributing + * the Work or Derivative Works thereof, You may choose to offer, + * and charge a fee for, acceptance of support, warranty, indemnity, + * or other liability obligations and/or rights consistent with this + * License. However, in accepting such obligations, You may act only + * on Your own behalf and on Your sole responsibility, not on behalf + * of any other Contributor, and only if You agree to indemnify, + * defend, and hold each Contributor harmless for any liability + * incurred by, or claims asserted against, such Contributor by reason + * of your accepting any such warranty or additional liability. + * + * END OF TERMS AND CONDITIONS + * + * APPENDIX: How to apply the Apache License to your work. + * + * To apply the Apache License to your work, attach the following + * boilerplate notice, with the fields enclosed by brackets "[]" + * replaced with your own identifying information. (Don't include + * the brackets!) The text should be enclosed in the appropriate + * comment syntax for the file format. We also recommend that a + * file or class name and description of purpose be included on the + * same "printed page" as the copyright notice for easier + * identification within third-party archives. + * + * Copyright [yyyy] [name of copyright owner] + * + * Licensed 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. + */ + +W3C® SOFTWARE NOTICE AND LICENSE +http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231 + +This work (and included software, documentation such as READMEs, or other +related items) is being provided by the copyright holders under the following +license. By obtaining, using and/or copying this work, you (the licensee) agree +that you have read, understood, and will comply with the following terms and +conditions. + +Permission to copy, modify, and distribute this software and its documentation, +with or without modification, for any purpose and without fee or royalty is +hereby granted, provided that you include the following on ALL copies of the +software and documentation or portions thereof, including modifications: + + 1. The full text of this NOTICE in a location viewable to users of the + redistributed or derivative work. + 2. Any pre-existing intellectual property disclaimers, notices, or terms + and conditions. If none exist, the W3C Software Short Notice should be + included (hypertext is preferred, text is permitted) within the body + of any redistributed or derivative code. + 3. Notice of any changes or modifications to the files, including the date + changes were made. (We recommend you provide URIs to the location from + which the code is derived.) + +THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE +NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT +THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY +PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. + +COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION. + +The name and trademarks of copyright holders may NOT be used in advertising or +publicity pertaining to the software without specific, written prior permission. +Title to copyright in this software and any associated documentation will at +all times remain with copyright holders. + +____________________________________ + +This formulation of W3C's notice and license became active on December 31 2002. +This version removes the copyright ownership notice such that this license can +be used with materials other than those owned by the W3C, reflects that ERCIM +is now a host of the W3C, includes references to this specific dated version of +the license, and removes the ambiguous grant of "use". Otherwise, this version +is the same as the previous version and is written so as to preserve the Free +Software Foundation's assessment of GPL compatibility and OSI's certification +under the Open Source Definition. Please see our Copyright FAQ for common +questions about using materials from our site, including specific terms and +conditions for packages like libwww, Amaya, and Jigsaw. Other questions about +this notice can be directed to site-policy@w3.org. + +Joseph Reagle + +This license came from: http://www.megginson.com/SAX/copying.html + However please note future versions of SAX may be covered + under http://saxproject.org/?selected=pd + +SAX2 is Free! + +I hereby abandon any property rights to SAX 2.0 (the Simple API for +XML), and release all of the SAX 2.0 source code, compiled code, and +documentation contained in this distribution into the Public Domain. +SAX comes with NO WARRANTY or guarantee of fitness for any +purpose. + +David Megginson, david@megginson.com +2000-05-05 diff --git a/tools/apache-ant-1.8.2/NOTICE b/tools/apache-ant-1.8.2/NOTICE new file mode 100644 index 000000000..713e04ae4 --- /dev/null +++ b/tools/apache-ant-1.8.2/NOTICE @@ -0,0 +1,6 @@ + Apache Ant + Copyright 1999-2010 The Apache Software Foundation + + The task is based on code Copyright (c) 2002, Landmark + Graphics Corp that has been kindly donated to the Apache Software + Foundation. diff --git a/tools/apache-ant-1.8.2/README b/tools/apache-ant-1.8.2/README new file mode 100644 index 000000000..951094109 --- /dev/null +++ b/tools/apache-ant-1.8.2/README @@ -0,0 +1,97 @@ + + A N T + + + What is it? + ----------- + + Ant is a Java based build tool. In theory it is kind of like "make" + without makes wrinkles and with the full portability of pure java code. + + + Why? + ---- + + Why another build tool when there is already make, gnumake, nmake, jam, + and others? Because all of those tools have limitations that its original + author couldn't live with when developing software across multiple platforms. + + Make-like tools are inherently shell based. They evaluate a set of + dependencies and then execute commands not unlike what you would issue on a + shell. This means that you can easily extend these tools by using or writing + any program for the OS that you are working on. However, this also means that + you limit yourself to the OS, or at least the OS type such as Unix, that you + are working on. + + Makefiles are inherently evil as well. Anybody who has worked on them for any + time has run into the dreaded tab problem. "Is my command not executing + because I have a space in front of my tab!!!" said the original author of Ant + way too many times. Tools like Jam took care of this to a great degree, but + still use yet another format to use and remember. + + Ant is different. Instead a model where it is extended with shell based + commands, it is extended using Java classes. Instead of writing shell + commands, the configuration files are XML based calling out a target tree + where various tasks get executed. Each task is run by an object which + implements a particular Task interface. + + Granted, this removes some of the expressive power that is inherent by being + able to construct a shell command such as `find . -name foo -exec rm {}` but + it gives you the ability to be cross platform. To work anywhere and + everywhere. And hey, if you really need to execute a shell command, Ant has + an exec rule that allows different commands to be executed based on the OS + that it is executing on. + + The Latest Version + ------------------ + + Details of the latest version can be found on the Apache Ant + Project web site . + + + Documentation + ------------- + + Documentation is available in HTML format, in the docs/ directory. + For information about building and installing Ant, see + docs/manual/index.html + + + Licensing + --------- + + This software is licensed under the terms you may find in the file + named "LICENSE" in this directory. + + This distribution includes cryptographic software. The country in + which you currently reside may have restrictions on the import, + possession, use, and/or re-export to another country, of + encryption software. BEFORE using any encryption software, please + check your country's laws, regulations and policies concerning the + import, possession, or use, and re-export of encryption software, to + see if this is permitted. See for more + information. + + The U.S. Government Department of Commerce, Bureau of Industry and + Security (BIS), has classified this software as Export Commodity + Control Number (ECCN) 5D002.C.1, which includes information security + software using or performing cryptographic functions with asymmetric + algorithms. The form and manner of this Apache Software Foundation + distribution makes it eligible for export under the License Exception + ENC Technology Software Unrestricted (TSU) exception (see the BIS + Export Administration Regulations, Section 740.13) for both object + code and source code. + + The following provides more details on the included cryptographic + software: + + For the SSH family of tasks ( and ) Ant requires the + JSch library as well as the + Java Cryptography extensions + . Ant does not + include these libraries itself, but is designed to use them. + + Thanks for using Ant. + + The Apache Ant Project + diff --git a/tools/apache-ant-1.8.2/WHATSNEW b/tools/apache-ant-1.8.2/WHATSNEW new file mode 100644 index 000000000..0b6b9e5b4 --- /dev/null +++ b/tools/apache-ant-1.8.2/WHATSNEW @@ -0,0 +1,5467 @@ +Changes from Ant 1.8.1 TO Ant 1.8.2 +=================================== + +Changes that could break older environments: +------------------------------------------- + + * Prior to Ant 1.8.0 the task and several other tasks would + overwrite read-only destination files. Starting with 1.8.0 they + would only do so under special circumstances. Ant 1.8.2 now + consistently won't replace a read-only file by default. The same is + true for a number of other tasks. + The , and tasks now have a new force attribute + and has a new forceReadonly attribute that can be used to + make the task overwrite read-only destinations. + Bugzilla Report 49261. + + * Removed ant-nodeps.jar; it is now merged into ant.jar. + + * DOMElementWriter#encode used to employ special code before encoding + ampersands so that { remained { rather than being turned + into &#123;. This is no longer the case, ampersands will now + be encoded unconditionally. + Also DOMElementWriter#encodeData will treat CDATA sections containing a + literal "]]>" sequence different now - it will split the CDATA + section between the second "]" and ">" and create two sections. + This affects task as well as the XML logger or JUnit + formatter where ampersands will now always get encoded. + In addition DOMElementWriter will now replace the characters \t, \r + and \n in attribute values by entity references. + Bugzilla Report 49404. + + * The list elements returned by ProjectHelper#getExtensionStack are + now String arrays of length 3 rather than 2 in order to support the + onMissingExtensionPoint attribute. + Bugzilla Report 49473. + + * When using properties defined + inside the same file will only get used in expansions if the ${} + reference uses the same prefix. This is different from Ant 1.8.1 + but is the same behavior Ant 1.8.0 and earlier exhibited. + A new attribute prefixValues can be used to re-enable the behavior + of Ant 1.8.1. + Bugzilla Report 49373. + + * The files and directories used by Git, Mercurial and Bazaar to + store their information are now excluded by the defaultexcludes. + Bugzilla Report 49624. + + * The task no longer generates TestListener events - which + have been introduced in ant 1.7.0 - by default. The task has a new + attribute enableTestListenerEvents and a new "magic" property + ant.junit.enabletestlistenerevents has been added that can be used + to reinstate the old behavior. + +Fixed bugs: +----------- + + * hostinfo now prefers addresses with a hostname over addresses without + a hostname, provided the addresses have the same scope. + For local lookup, no IP address will be put in NAME / DOMAIN anymore. + For remote lookup, if a host name was provided and only an IP address is + found, the IP address will no longer overwrite the host name provided to the + task. + Bugzilla Report 49513 + + * mmap-based file copy problems under JDK 1.4 on Linux. + Bugzilla Report 49430. + + * The Sun JVM tries to mmap the entire file during a copy. + For large files this is not feasible. + We now explicitly request to copy at most 16 MiB per request. + Bugzilla Report 49326. + + * DemuxInputStream.read() should return unsigned values + Bugzilla Report 49279. + + * The MIME mailer ignored the port parameter when using SSL. + Bugzilla Report 49267. + + * ignored the classpath when using the default TraX processor. + Bugzilla Report 49271. + + * 's totalproperty only worked reliably if the same file + name didn't occur inside more than one directory. + Bugzilla Report 36748. + + * could fail to download files from remote subdirectories under + certain circumstances. + Bugzilla Report 49296. + + * will now produce better diagnostics when it fails to delete + a temporary file. + Bugzilla Report 49419. + + * Ant would often scan directories even though there were known to + only hold excluded files when evaluating filesets. This never + resulted in wrong results but degraded performance of the scan + itself. + Bugzilla Report 49420. + + * failed for long command lines on OS/2. + Bugzilla Report 49425. + + * did not handle encodings well for stdout/stderr. + Bugzilla Report 49418. + + * could issue a warning about multiple versions of Ant on the + CLASSPATH if two CLASSPATH entries differed in case on a + case-insensitive file system. + Bugzilla Report 49041. + + * The resource collection was checking every resource even if + we actually just want the first one, like in the example of use of + resourcelist in the documentation (getting the first available resource + from a mirror list). + + * A race condition could lead to build failures if multiple + tasks were trying to create the same directory. + Bugzilla Report 49572. + + * the toString() method of the Resources class - and thus any + ${toString:} expansion of a reference to a element - + didn't iterate over its nested elements if it hadn't done so prior + to the toString invocation already. + Bugzilla Report 49588. + + * in parallel mode didn't work together with a nested + if maxparallel was <= 0 (the default) or no source + files matched. + Bugzilla Report 49594. + + * didn't work for manifests added via + s that used the prefix or fullpath attributes. + Bugzilla Report 49605. + + * would cause an error unless the prefix + attribute has been specified. + Bugzilla Report 49755. + + * If forked, after finished was still reading the input stream + for a bunch of characters, then stealing them from a following . + Bugzilla Report 49119. + + * Ant could be leaking threads for each forked process (started by + , , or similar tasks) that didn't receive input + from a resource or string explicitly. + Bugzilla Report 49587. + + * Project#setDefault threw an exception when null was passed in as + argument, even though the Javadoc says null is a valid value. + Bugzilla Report 49803. + + * runant.py would swallow the first argument if CLASSPATH wasn't set. + Bugzilla Report 49963. + + * failed to load resources from jar files contained in a + directory that has a "!" in its name. + Bugzilla Report 50007. + + * ant.bat exit strategy improvements and issues + make the exit codes work in environments where 4NT or MKS are installed + Bugzilla Report 41039. + + * would fail if used via its Java API and the File passed + into the setJar method was not "normalized" (i.e. contained ".." + segments). + Bugzilla Report 50081. + + * ignored 's errorOnMissingDir attribute + Bugzilla Report 50124. + + * failed to close files when reading a list of symbolic + links from a properties file. + Bugzilla Report 50136. + + * could allow tasks to start executing even if a task + scheduled to run before them timed out. + Bugzilla Report 49527. + + * If a batch with multiple tests times out Ant logs a message + about a test named Batch-With-Multiple-Tests since 1.8.0 but the + logic that determined the Java package of this pseudo-test has been + wrong. + Bugzilla Report 45227. + + * didn't preserve the original linefeed style when + updating a file. + Bugzilla Report 50049. + + * 's whenEmpty behavior never consulted the non-fileset + resources so the task could fail even though resources have been + provided using non-fileset resource collections. + Bugzilla Issue 50115. + +* ftp chmod could throw a NPE. + Bugzilla report 50217. + +* The project help (-p option in the command line) will now print + the dependencies of the targets in debug mode (-d on the command + line) + +Other changes: +-------------- + + * 's force attribute has been deprecated in favor of a new + overwrite attribute that is consistent with 's attribute + names. + + * You can now specify a list of methods to run in a JUnit test case. + Bugzilla Report 34748. + + * properties in files read because of the -propertyfile command line + option will now get resolved against other properties that are + defined before the project starts executing (those from the same or + earlier -propertfiles or defined via the -D option). + Bugzilla Report 18732. + + * s can now contain wildcards in order to use wildcard + CLASSPATH entries introduced with Java6. + The wildcards are not expanded or even evaluated by Ant and will be + used literally. The resulting path may be unusable as a CLASSPATH + for Java versions prior to Java6 and likely doesn't mean anything + when used in any other way than a CLASSPATH for a forked Java VM. + Bugzilla Report 46842. + + * A new attribute allows targets to deal with nonexistent extension + points, i.e. they can extend an extension-point if it has been + defined or silently work as plain targets if it hasn't. This is + useful for targets that get included/imported in different + scenarios where a given extension-point may or may not exist. + Bugzilla Report 49473. + + * Ant now logs a warning message if it fails to change the file + modification time in for example when using or preserving + timestamps in various tasks. + Bugzilla Report 49485. + + * ProjectHelpers can now be installed dynamically via the + Ant task. + + * is now able to switch to the proper ProjectHelper to parse + the imported resource. This means that several kinds of different build + files can import each other. + + * now also works for non-filesystem resources. + Bugzilla Report 49756. + + * The filter now supports a casesensitive + attribute. + + * The selector now supports casesensitive, multiline + and singleline attributes. + Bugzilla Report 49764. + + * A new can be used like wget's --cut-dirs option to + strip leading directories from file names. + + * now supports the GNU project's gcjh compiler. + Bugzilla Report 50149. + + * supports additional views of a file's path as elements + for a custom pattern. + Bugzilla Report 50114. + + * JUnit XMLResultAggregator logs the stack trace of caught IO exceptions + in verbose runs. + Bugzilla Report 48836. + + * StringUtils.parseHumanSizes() should turn parse failures into + BuildExceptions. + Bugzilla Report 48835. + + * New task to make a list of targets bound to some + specified extension point. + + * Initial support for OpenJDK7 has been added. + + * Ant now uses java.net.CookieStore rather than + java.util.ServiceLocator to detect whether the environment is a + Java 1.6 system. This means releases of gcj/gij at the time of + this release of Ant are detected as Java 1.5 and not 1.6. + Bugzilla Report 50256. + + * It is now possible to write a compiler adapter for that + compiles sources with extensions other than .java (but that still + compile to .class files). + Bugzilla Report 48829. + + * The performance of VectorSet#add(Object) has been improved which + should also benefit any operation that scans directories in Ant. + Bugzilla Report 50200. + +Changes from Ant 1.8.0 TO Ant 1.8.1 +=================================== + +Changes that could break older environments: +------------------------------------------- + + * ant-trax.jar is no longer produced since TrAX is included in JDK 1.4+. + + * Ant no longer ships with Apache Xerces-J or the XML APIs but relies + on the Java runtime to provide a parser and matching API versions. + + * The stylebook ant task and the ant-stylebook.jar are removed. + +Fixed bugs: +----------- + + * Tasks that iterate over task or type definitions, references or + targets now iterate over copies instead of the live maps to avoid + ConcurrentModificationExceptions if another thread changes the + maps. + Bugzilla Report 48310. + + * The filesmatch condition threw a NullPointerException when + comparing text files and the second file contained fewer lines than + the first one. + Bugzilla Report 48715. + + * Regression: The task would allow multiple + META-INF/application.xml files to be added. + Bugzilla Report 6836. + + * VectorSet#remove(Object) would fail if the size of the vector + equaled its capacity. + + * Regression : ant -diagnostics was returning with exit code 1 + Bugzilla Report 48782 + + * Fix for exec task sometimes inserts extraneous newlines + Bugzilla Report 48746 + + * SymlinkTest#testSymbolicLinkUtilsMethods failing on MacOS + Bugzilla Report 48785. + + * If 's first resourcecollection child is a , + any subsequently added child resourcecollection joins the first. + Bugzilla Report 48816. + + * with an invalid URL could trigger an NPE in some JVMs. + Bugzilla Report 48833 + + * Broken Pipe issue under Ubuntu Linux + Bugzilla Report 48789 + + * Properties wrongly read from file or not update during read + Bugzilla Report 48768 + + * AntClassLoader in Ant 1.8.0 has been considerably slower than in + 1.7.1 + Bugzilla Report 48853 + + * ANT_CMD_LINE_ARGS are rippling through lower level Ant usage + Bugzilla Report 48876 + + * email : IO error sending mail with plain mimetype + Bugzilla Report 48932 + + * the complete-ant-cmd.pl script failed to create a proper cache of + target if "ant -p" failed. + Bugzilla Report 48980 + + * 's sourcebase attribute was broken. + Bugzilla Report 48970 + + * 's failonerror didn't work as expected when copying a single + element resource collection to a file. + Bugzilla Report 49070 + + * no longer followed redirects if the redirect URL was relative + and not an absolute URL. + Bugzilla Report 48972 + + * fixed a performance degradation in the code that expands property + references. + Bugzilla Reports 48961 and 49079 + + * was broken on Windows. + Bugzilla Report 49090 + + * delete failed if the link attribute was a relative path + to a link inside the current directory without a leading ".". + Bugzilla Report 49137 + + * and failed to find the expected strings when + waiting for responses and thus always failed. + Bugzilla Report 49173 + +Other changes: +-------------- + + * Project provides new get methods that return copies instead of the + live maps of task and type definitions, references and targets. + + * Ant is now more lenient with ZIP extra fields and will be able to + read archives that it failed to read in earlier versions. + Bugzilla Report 48781. + + * The family of tasks has been sped up for bigger archives. + Bugzilla Report 48755. + + * Add removeKeepExtension option to NetRexxC task. + Bugzilla Report 48788. + + * Add prefix attribute to loadproperties task. + + * Add resource attribute to length task. + + * PropertyResource will effectively proxy another Resource if ${name} + evaluates to a Resource object. + + * Added forcestring attribute to equals condition to force evaluation + of Object args as strings; previously only API-level usage of the + equals condition allowed Object args, but Ant 1.8.x+ property + evaluation may yield values of any type. + + * BuildFileTest.assertPropertyUnset() fails with a slightly more + meaningful error message + Bugzilla Report 48834 + + * will now throw an exception if a test name is empty. This + used to manifest itself in unrelated errors like + Bugzilla Report 43586. + + * A change that made more reliable on Windows (Bugzilla Report + 5003) strongly impacts the performance for commands that execute + quickly, like attrib. Basically no single execution of a command + could take less than a second on Windows. + A few timeouts have been tweaked to allow these commands to finish + more quickly but still they will take longer than they did with Ant + 1.7.1. + Bugzilla Report 48734. + + * Added SimpleBigProjectLogger, intermediate between NoBannerLogger and + BigProjectLogger. + + * supports new attributes enablemultiplemappings + and cache. + + * Added the augment task to manipulate existing references via Ant's basic + introspection mechanisms. + +Changes from Ant 1.8.0RC1 TO Ant 1.8.0 +====================================== + +Changes that could break older environments: +------------------------------------------- + + * the appendtolines filter has been renamed to suffixlines. + +Fixed bugs: +----------- + + * stack traces were not reported at all by + when filtertrace="on", which is the default. + + * ant.bat can now also process the -noclasspath switch when it is + the first switch on a command line. + Bugzilla Report 48186. + + * now tries to delete the created temporary files earlier. + Bugzilla Report 48506. + + * the implementation of had been changed in a way that broke + the jarjar links task and protentially other third-party subclasses + as well. + Bugzilla Report 48541. + + * task didn't report build file location when a remote operation failed + Bugzilla Report 48578. + + * would add the same comment and a date line each time + it updated an existing property file. + Bugzilla Report 48558. + + * didn't work properly in recent Java VMs. + Bugzilla Report 48637. + +Other changes: +-------------- + +Changes from Ant 1.7.1 TO Ant 1.8.0RC1 +====================================== + +Changes that could break older environments: +------------------------------------------- + + * if and unless attributes (on as well as various tasks and other + elements) have long permitted ${property} interpolation. Now, if the result + evaluates to "true" or "false" (or "yes", "no", "on", "off"), that boolean + value will be used; otherwise the traditional behavior of treating the value + as a property name (defined ~ true, undefined ~ false) is used. Existing + scripts could be broken if they perversely defined a property named "false" + and expected if="false" to be true, or used if="true" expecting this to be + triggered only if a property named "true" were defined. + + * Ant now requires Java 1.4 or later. + + * Improved handling of InterruptException (lets suppose someone/thing + is trying to kill the thread when we receive an + InterruptException), when an InterruptException is received, we do + not wait anymore in a while loop till the end time has been + reached. + Bugzilla Report 42924. + + * Refactor PropertyHelper and introspection APIs to make extension + more granular and support setting task/type attribute values to + objects decoded by custom PropertyEvaluator delegates. Also add + task for registering delegates and/or replacing + the registered PropertyHelper instance. + Bugzilla Report 42736. + + * Added a restricted form of typedef called . This + allows definition of elements that can only be within tasks or + types. This method is now used to define conditions, selectors, + comparators and filterreaders. This means that tasks may now have + nested conditions just by implementing the Condition interface, + rather than extending ConditionBase. It also means that the use of + namespaces for some of the selectors introduced in Ant 1.7.0 is no + longer necessary. Implementing this means that the DynamicElement + work-around introduced in Ant 1.7.0 has been removed. + Bugzilla Report 40511. + + * In the task when a is used, the millis and + datetime attributes now override the time of the source resource if + provisioned. + Bugzilla Report 43235. + + * Remove fall-back mechanism for references that are not resolved + during normal runtime execution. + + * FileUtils.createTempFile now actually creates the file. + The TempFile task still does not create the file by default, can be + instructed to do so however using a new parameter. + Bugzilla Report 33969. + + * A lock in Project ensured that a BuildListener's messageLogged + method was only ever executed by a single thread at a time, while + all other methods could be invoked by multiple threads + simultaniously (while within , for example). This lock + is no longer in place, messageLogged should be made thread-safe + now. + + * 's onError="stop" no longer fails the build if an error + occurs, this is the main difference between stop and error and + matches what the documentation implied. + Bugzilla Report 24668. + + * Ant's configuration introspection mechanisms have been modified to prefer + Resource and FileProvider attributes to plain java.io.File attributes; + however the configuration-from-String behavior remains equivalent, rendering + a FileResource. + + * CBZip2InputStream will now throw an IOException if + passed in a null or empty InputStream to read from. + Bugzilla Reports 32200. + + * will now fail when trying to extract certain broken + archives that would have been silently ignored in earlier version. + Bugzilla Report 35000. + + * Ant's family of tasks tries to preserve the existing Unix + permissions when updating archives or copying entries from one + archive to another. + Since not all archiving tools support storing Unix permissions in + the same way that is used by Ant, sometimes the permissions read by + Ant seem to be 0, which means nobody is allowed to do anything to + the file or directory. + If Ant now encounters a permission set of 0 it will assume that + this is not the intended value and instead apply its own default + values. Ant used to create entries with 0 permissions itself. + The family of tasks has a new attribute preserve0permissions + that can be set to restore the old behavior. + Bugzilla Report 42122. + + * If a batch containing multiple JUnit tests running inside a forked + Java VM caused the VM to crash (or caused a timeout), the + formatters would receive an error message for the last test in the + batch. + Ant will now pass in a test with the name "Batch-With-Multiple-Tests" + instead - this is supposed to show more clearly that the last test + may not have started at all. + Bugzilla Report 45227. + + * If the number of minutes a build takes is bigger then 1000 Ant will + no longer print a thousands separator in the "elapsed time" + message. It used to be the thousands separator of the current + locale. + Bugzilla Report 44659. + + * used to fail if the link was broken (i.e. + pointing to a file or directory that no longer existed). It will now + silently try to remove the link. + Bugzilla Report 41285. + + * used to log a warning and not delete broken + symbolic links. didn't even log a warning. + The task will now try to delete them in both cases. + Bugzilla Report 41285. + + * if the dir attribute of a points to a symbolic link and + followsymlinks is set to false, the fileset will no longer be + scanned and always seem empty. + Bugzilla Report 45741. + + * the .NET tasks that have been deprecated since Ant 1.7.0 have been + removed, please use the stand-alone Antlib you can find at + http://ant.apache.org/antlibs/dotnet/index.html + instead. + + * the logic of closing streams connected to forked processes (read + the input and output of and friends) has been changed to + deal with cases where child processes of the forked processes live + longer than their parents and keep Ant from exiting. + It is unlikely but possible that the changed logic breaks stream + handling on certain Java VMs. + Bugzilla issue 5003. + + * 's totalproperty was platform dependent because it relied + on java.io.File#compareTo. It has now been made platform + independent, which means that totalPropery values obtained on + Windows (and other systems where the sort order of File is not case + sensitive) can be different from the values obtained with earlier + versions of Ant. + Bugzilla Report 36748. + + * globmapper didn't work properly if the "to" or "from" patterns + didn't contain a "*". In particular it implicitly added a * to the + end of the pattern(s). This is no longer the case. If you relied + on this behavior you will now need to explicitly specify the + trailing "*". + Bugzilla Report 46506. + + * silently ignored missing resources even with + failOnError="true". If your build tries to copy non-existant + resources and you relied on this behavior you must now explicitly + set failOnError to false. + Bugzilla Report 47362. + + * Ant now prefers the java.runtime.version system property over + java.vm.version for the Created-By Manifest attribute. + Bugzilla Report 47632. + + * The task now supports a nested mapper. In order to + implement this, the Java API of the task had to change so any + custom subclass overriding the processFile method will need to + adapt (by overriding the new two-arg processFile method). + Bugzilla Report 23243. + + * A new property syntax can be used to set attributes from + references: ${ant.ref:some-reference} + + In most cases this will yield the exact same result as + ${toString:some-reference} - only when an attribute setter method + accepts an object type other than string and the project's + reference is an Object of matching type the new syntax will pass in + that object. + + If your build file already contains properties whose name starts + with "ant.ref:" there is a potential for collision. If your + property has been set, normal property expansion will take + precedence over the new syntax. If the property has not been set + and a reference with the postfix of your property name exists + (i.e. in a very unlikely event) then the new syntax would yield a + different result (an expanded property) than Ant 1.7.1 did. + + * A ProjectHelper implementation can now provide the default build file + name it is expecting, and can specify if they can support a specific build + file. So Ant is now capable of supporting several ProjectHelper + implementations, deciding on which to use depending of the input build file. + + * Mapper-aware selectors (depends, different, present) now accept typedef'd + FileNameMappers. + +Fixed bugs: +----------- + + * The default logger was failing to print complete stack traces for + exceptions other than BuildException when inside or + , thus omitting often important diagnostic + information. + Bugzilla 43398 (continued). + + * Better handling of package-info.class. + Bugzilla Report 43114. + + * RPM task needed an inserted space between the define and the value. + Bugzilla Report 46659. + + * Got rid of deadlock between in, out and err in the Redirector. + Bugzilla Report 44544. + + * Caused by AssertionError no longer filtered. + Bugzilla Report 45631. + + * would sometimes recreate JARs unnecessarily. + Bugzilla Report 45902. + + * task couldn't overwrite existing symlinks that pointed to + nonexistent files + Bugzilla Report 38199. + + * task couldn't overwrite files that were in the way of the symlink. + Bugzilla Report 43426. + + * task failonerror="false" does not stop build from failing + when 'ln' command returns non-zero. + Bugzilla Report 43624 + + * task couldn't differentiate between "no resources + specified" and "no resources matched." + Bugzilla Report 43799. + + * ManifestClassPath failed when a relative path would traverse the + file system root. + Bugzilla Report 44499. + + * had an indexoutofbounds when the prefix and postfix + overlapped. + Bugzilla Report 44731. + + * and failed to accept file names with # + characters in them. + Bugzilla Report 45190 + + * A deadlock could occur if a BuildListener tried to access an Ant property + within messageLogged while a different thread also accessed one. + Bugzilla Report 45194 + + * Handle null result of system getProperty() in CommandlineJava. + Similar to Bugzilla Report 42334. + + * Length task did not process nonexistent Resources even though these might + conceivably still carry file length information. + Bugzilla Report 45271. + + * 's includeJavaRuntime="false" should work for gcj now. Note + that you may need to set includeAntRuntime to false in order to + have full control. + Bugzilla Report 34638. + + * would fail if the executed statment didn't return a result + set with some JDBC driver that dissalow Statement.getResultSet to + be called in such a situation. + Bugzilla Report 36265 + + * if the executed statement in returned a result set and an + update count, the count would be lost. + + * if an executed statement in mixes update count and result set + parts, some result sets wouldn't get printed. + Bugzilla Report 32168. + + * XmlLogger could lose messages if is used. + Bugzilla Report 25734. + + * creates remoteToDir if it doesn't exist. + Bugzilla Report 42781 + + * CBZip2OutputStream threw an exception if it was closed prior to + writing anything. + Bugzilla Reports 32200, 45836 + + * The IPlanetDeploymentTool didn't use the configured DTD locations. + Bugzilla Report 31876. + + * The ant shell script printed a warning under Cygwin if JAVA_HOME + was not set. + Bugzilla Report 45245. + + * sometimes incorrectly flagged infinite recursions of + filter tokens + Bugzilla Report 44226. + + * failures were treated as errors in forked JUnit tests when JUnit 4 + was used. + Bugzilla Report 43892. + + * and disallowed manifest attributes whose name + contained the character '8'. + Bugzilla Report 45675. + + * BigProjectLogger would set the project's basedir to the current + working directory. + Bugzilla Report 45607. + + * only s that logged to a file were notified if forked VM + crashed or a timeout occured in . + Bugzilla Report 37312. + + * ant -v -version would print the version information twice. + Bugzilla Report 45695. + + * when nested into builds that have been invoked by tasks + might set the wrong basedir on the called projects. + Bugzilla Report 30569. + + * If the message of the failed assertion of a forked JUnit test + contained line feeds some excess output ended up in Ant's log. + Bugzilla Report 45411. + + * failed to delete a link that pointed to + a parent directory. + Bugzilla Report 45743. + + * failed if ant lacked permission to rename + the link's target. + Bugzilla Report 41525. + + * when checking whether a jar is signed, ignored the + sigfile attribute. + Bugzilla Report 44805. + + * When using JavaMail all tasks used the same mail host + regardless of their configuration. + Bugzilla Report 37970. + + * and didn't handle aliases with characters other + than numbers, letters, hyphen or underscore properly. + Bugzilla Report 45820. + + * could miss multi-character begin tokens in some cases. + Bugzilla Report 45094. + + * didn't close JARs that were part of the classpath. + Bugzilla Report 45955. + + * in some cases would delete class files even if it didn't + find the corresponding source files. + Bugzilla Report 45916. + + * failed if the nested or contained line + breaks. + Bugzilla Report 43342. + + * encoding="auto" has been broken in since Ant 1.7.0 and only + worked if JavaMail was available. + Bugzilla Report 42389. + + * MailLogger could cause a NullPointerException. + Bugzilla Report 44009. + + * didn't recognize failed assertions as failures if they + caused subclasses of AssertionError to be thrown (like + org.junit.ComparisonFailure that is thrown when assertEquals + fails). + Bugzilla Report 45028. + + * the Unix "ant" wrapper script failed to protect wildcards in + command line arguments in some cases. + Bugzilla Report 31601. + + * crippled file names and could miss some entries if + multiple modules have been specified. + Bugzilla Report 35301. + + * Tasks with a "public void add(SomeType)" method failed to work as + TaskContainers at the same time. + Bugzilla Report 41647. + + * Tasks that implementes DynamicElemen or DynamicElementNS failed to + work as TaskContainers at the same time. + Bugzilla Report 41647. + + * combining SSL and authentication in and MailLogger failed in + some setups. + Bugzilla Report 46063. + + * if an error occurs while logging the buildFinished event, the + original error is now logged to System.err. + Bugzilla Report 25086. + + * failed with a NullPointerException when copying a resource + without a name. It will now fail with a meaningful error message. + Bugzilla Report 39960. + + * now uses the configured classpath to load the factory (when + using TraX) before falling back to Ant's own classpath. + Bugzilla Report 46172. + + * complained about files being modified in the future if + they had been just very recently (within Ant's assumed granularity + of the file system). + Bugzilla Report 43665. + + * didn't store the ouput in outputproperty if the remote + command failed. + Bugzilla Report 46340. + + * DirectoryScanner's slow-scanning algorithm that is used when you + ask for excluded or not-included files and/or directories could + miss some files and directories in the presence of recursive + exclude patterns. + + * resource collection kept only one of entries deemed equal by + the chosen Comparator. + Bugzilla Report 46527. + + * the ZipFile class used by and others could leave the + archive open (making it undeletable on Windows as long as the java + VM was running) for files with an unexpected internal structure. + Bugzilla Report 46559. + + * The zip package now supports the extra fields invented by InfoZIP + in order to store Unicode file names and comments. + + * The zip package detects the encoding bit set by more modern + archivers when they write UTF-8 filenames and optionally sets it + when writing zips or jars. + Bugzilla Report 45548 + + * could run into a NullPointerException when faced with broken + symbolic links. + Bugzilla Report 46747. + + * The ant shell script should now support MSYS/MinGW as well. + Bugzilla Report 46936. + + * has a new force attribute that allows re-signing of jars + that are already signed. + Bugzilla Report 46891. + + * now again honors failonerror in the face of connection + errors. + Bugzilla Report 46829. + + * The filter threw an exception if the stream to + filter ended with a begin token. + Bugzilla Report 47306. + + * , and didn't support + the setbeans attribute. + Bugzilla Report 47336. + + * ' encoding attribute didn't work. + Bugzilla Report 47382. + + * Ant created tar archives could contain random bytes at the end + which confused some untar implementations. + Bugzilla Report 47421. + + * various places where unchecked PrintWriters could hide exceptions + have been revisited to now check the error status or not use a + PrintWriter at all. + Bugzilla Report 43537. + + * filesetmanifest="mergewithoutmain" in didn't treat inline + manifests as expected. + Bugzilla Report 29731. + + * didn't work properly with nested builds. + Bugzilla Report 41368. + + * with filesetmanifest different from skip didn't work if the + update attribute has been set to true. + Bugzilla Report 30751. + + * The default stylesheets for failed to properly escape + XML content in exception stack traces. + Bugzilla Report 39492. + + * AntClassLoader didn't set the proper CodeSource for loaded classes. + Bugzilla Report 20174. + + * AntClassLoader.getResourceAsStream would return streams to + resources it didn't return with getResource and to classes it + failed to load. + Bugzilla Report 44103. + + * Logging exceptions without a message would cause a + NullPointerException. + Bugzilla Report 47623. + + * WeblogicDeploymentTool could fail on platforms with a file + separator other than "/". + Bugzilla Report 35649. + + * The update attribute of the modified selector was ignored. + Bugzilla Report 32597. + + * and can now merge Class-Path attributes from + multiple sources and optionally flatten them into a single + attribute. + The default behaviour still is to keep multiple Class-Path + attributes if they have been specified and to only include the + attributes of the last merged manifest. + Bugzilla Report 39655. + + * didn't work correctly with a selector because + it was scanning the same filesets more than once. + Bugzilla Report 43574. + + * when using custom filterreaders with the + syntax Ant could leak memory. + The problem didn't occur when using or to + define the filterreader which is the recommended approach. + Bugzilla Report 45439. + + * Ant didn't set the proper "magic" value for tar entries containing + long file names in GNU longfile mode. + Bugzilla Report 47653. + + * The tar task failed to recognize that the archive had to be + (re-)created in some cases where the sources are filesystem based + resources but not filesets. + Bugzilla Report 48035. + + * 's outputproperty was prefixed by the executed command + when the command attribute has been used, breaking backwards + compatibility to Ant 1.7.0. + Bugzilla Report 48040. + + * different task instances of the same ed tasks could + overwrite each others attributes/nested elements. + Bugzilla Report 41602. + + * The Hashvalue algortihm implementation of the modified task could + fail to read the file(s) completely. + Bugzilla Report 48313. + +Other changes: +-------------- + + * The get task now also follows redirects from http to https + Bugzilla Report 47433 + + * A HostInfo task was added performing information on hosts, including info on + the host ant is running on. + Bugzilla Reports 45861 and 31164. + + * There is now a FileProvider interface for resources that act as a source + of filenames. This should be used by tasks that require resources + to provide filenames, rather than require that all resources + are instances or subclasses of FileResource. + Bugzilla Report 43348 + + * There is now a URLProvider interface for resources that act as a + source of URLs. This should be used by tasks that require resources + to provide URLs, rather than require that all resources are + instances or subclasses of URLResource. + + * Fixcrlf now gives better error messages on bad directory attributes. + Bugzilla Report 43936 + + * a new property ant.project.default-target holds the value of the + current 's default attribute. + + * a new property ant.project.invoked-targets holds a comma separated + list of the targets that have been specified on the command line + (the IDE, an task ...) when invoking the current project. + + * The resource selector has had an "any" type added for better + configurability. + + * Ant should detect the OS as both a Mac and a Unix system when + running on OpenJDK. + Bugzilla Report 44889. + + * new protected getConnection and getStatement methods allow + subclasses of SQLExec more control - or access to the cached + instances when overriding other methods like runStatements. + Bugzilla Report 27178. + + * has a new failOnConnectionError attribute that can be used to + keep a build going even if the task failed to connect to the + database. + Bugzilla Report 36712. + + * A new attribute strictDelimiterMatching can be used to ignore case + or whitespace differences when searches for delimiters. + This is useful if you execute a SQL script that has contains "GO" + and "go" as delimiters. + Bugzilla Report 26459. + + * A new showWarnings attribute of allows warnings to be logged. + Bugzilla Report 41836. + + * A new treatWarningsAsErrors attribute of can be used to fail + a build if a warning occurs. + Bugzilla Report 41836. + + * Ant now supports scoped properties (see Local task). + Bugzilla Report 23942. + + * 's CSV output can be controlled via the new attributes + csvColumnSeparator and csvQuoteCharacter. + Bugzilla Report 35627. + + * 's logging has been improved. + Bugzilla Reports 30932, 31743. + + * It is now possible to disable 's remote verification. + Bugzilla Report 35471. + + * now supports input in a way similar to + Bugzilla Report 39197. + + * can now preserve the file modification time when downloading + files. + Bugzilla Report 33939. + + * the new task sshsession can run multiple tasks in the presence of + an SSH session providing (local and remote) tunnels. + Bugzilla Report 43083. + + * ZipOutputStream has been sped up for certain usage scenarios that + are not used by Ant's family of zip tasks. + Bugzilla Report 45396. + + * supports an "output" Resource attribute as an alternative to "file". + + * "output" attribute now supports any Resource in addition to a file. + + * no longer requires a passphrase when using key based + authentication. + Bugzilla Report 33718. + + * a new failOnEmptyArchive attribute on and can now + make the task fail the build if it tries to extract an empty + archive. + + * and have a new attribute stripAbsolutePathSpec. + When set to true, Ant will remove any leading path separator from + the archived entry's name before extracting it (making the name a + relative file name). + Bugzilla Report 28911. + + * will now detect that it was asked to extract a file that is + not an archive earlier if the file is big. + Bugzilla Report 45463. + + * New file and resource selectors and have + been added that select file which the current process can read or + write. + Bugzilla Report 45081. + + * The filename file selector has a new attribute regex that allows + files to be selected by matching their names against a regular + expression. + Bugzilla Report 45284 + + * The name resource selector has a new attribute regex that allows + resources to be selected by matching their names against a regular + expression. + Bugzilla Report 45284 + + * Enhanced performance of Project.fireMessageLoggedEvent and DirectoryScanner + Bugzilla Reports 45651 and 45665 + + * The package list location for offline links can now be specified as + an URL. + Bugzilla Report 28881 + + * now supports XML namespaces. + Bugzilla Report 36804. + + * A new listener for has been added that tries to invoke the + tearDown method of a TestCase if that TestCase was run in a forked + VM and the VM crashed or a timeout occured. See the task's + manual page for details. + Bugzilla Report 37241. + + * The Jar task now supports the addition of a jar index file in update mode. + Previously the absence of the index was not enough to trigger the rebuild; + some other update was necessary. + Bugzilla report 45098. + + * has a new attribute "useNativeBasedir" that makes the child + build use the same basedir it would have used if invoked from the + command line. No matter what other attributes/properties have been + set. + Bugzilla Report 45711. + + * has a new optional failOnError attribute. + Bugzilla Report 44772. + + * Antlib descriptors will now be parsed by the configured + ProjectHelper if the implementation overrides the new + canParseAntlibDescriptor and parseAntlibDescriptor methods. If the + configured helper doesn't override the methods, a new instance of + ProjectHelper2 will be used just like in Ant 1.7.1. + Bugzilla Report 42208. + + * It is now possible to explicitly set the executable used by + . + Bugzilla Report 39189. + + * 's order of results is now predictable. + Bugzilla Report 44873 + + * a new has been added, which works similar to + but only returns the results of the first nested + mapper that matches. + Bugzilla Report 44873 + + * has a new maxtime attribute that terminates downloads that + are taking too long. + Bugzilla Report 45181. + + * now supports selectors for remote directories as well. + Bugzilla Report 44726. + + * In some cases Ant fails to rename files if the source or target + file has just recently been closed on Windows. It will now try to + delete the offending file once again after giving the Java VM time + to really close the file. + Bugzilla Report 45960. + + * two new properties can be used to set the MIME-Type and charset + used by MailLogger. + Bugzilla Report 27211. + + * a new attribute of allows the task to succeed if it can + reach at least one given recipient. + Bugzilla Report 36446. + + * two new properties allow MailLogger to send a fixed text instead of + the log file. + Bugzilla Report 38029. + + * is supposed to support CVSNT now. + Bugzilla Report 31409. + + * ' port attribute should now work for all clients that use the + environment variable CVS_PSERVER_PORT instead of the "official" + CVS_CLIENT_PORT. + Bugzilla Report 30124. + + * now works for local repositories as well. + + * has an option to ignore removed files now. + Bugzilla Report 26257. + + * and friends now support modules with spaces in their names + via nested elements. + + * A new attribute "ignoreEmpty" controls how deals when + there are no resources to concatenate. If it is set to false, the + destination file will be created regardless, which reinstates the + behavior of Ant 1.7.0. + Bugzilla Report 46010. + + * If the new remote attribute is set to true, can now + work against a remote repository without any working copy. + Bugzilla Report 27419. + + * start and end tags can now be used instead of dates in + . + Bugzilla Report 27419. + + * MailLogger and can now optionally enable support for + STARTTLS. + Bugzilla Report 46063. + + * has new attributes "as" and "prefixSeparator" that can be + used to control the prefix prepended to the imported targets' + names. + + * a new task provides an alternative to that + should be preferred when you don't want to override any targets. + + * delete has a new attribute removeNotFollowedSymlink. If set to + true, symbolic links not followed (because followSymlinks was false + or the number of symlinks was too big) will be removed. + Bugzilla Report 36658. + + * the os and osfamily attributes of , , and + can now be used to run the commands on operating systems + other than their "native" environment, i.e. non-Unix or non-Windows + operating systems respectively. + Bugzilla Report 7624. + + * a new resource collection generalizes the prefix + and fullpath attributes of to arbitrary mappers that + can be applied to arbitrary resource collections. + Bugzilla Report 4240. + + * and have a new attribute + errorOnMissingArchive that allows "optional" filesets that don't + break the build if the archive doesn't exist. + Bugzilla Report 46091. + + * has new attributes that correspond to the + -docfilessubdirs and -excludedocfilessubdir command line arguments. + Bugzilla Report 34455. + + * now fails early if a specified stylesheet doesn't exist. + Bugzilla Report 34525. + + * now has an option to supress transformer warnings. This + option only has an effect for processors that support this feature; + the "trax" processor included with Ant does support it. + Bugzilla Report 18897. + + * has two new attributes failOnError and + failOnTransformationError that can be used to not make the build + process proceed if an error occurs. + Bugzilla Report 36260. + + * has a new attribute failOnNoResources that can be used to + make the build fail/continue if the collection of resources to + transform is empty. + Bugzilla Report 46274. + + * It is now possible to define system properties that should be set + during xslt's transformation. This can be used to enable XInclude + processing in Xerces, for example. + Bugzilla Report 36653. + + * a new resource collection can be used to specify + collections of ZIP and TAR archives as sources. It extracts them on + the fly. This is a generalization of the found + as nested element of and friends. + Bugzilla Report 46257. + + * has a new verbose attribute that makes the task list + all deleted targets and give a hint as to why it deleted them. + Bugzilla Report 13681. + + * now supports arbitrary filesystem based resource + collections. + Bugzilla Report 46341. + + * now supports arbitrary filesystem based resource + collections. + Bugzilla Report 24062. + + * token and value of 's nested can now also + be specified as nested elements to allow multiline content more + easily. + Bugzilla Report 39568. + + * and can now optionally preserve the file + timestamp even if the file is modified. + Bugzilla Report 39002. + + * The child-elements and have + a new attribute that controls whether properties in nested text get + expanded. + Bugzilla Report 11585. + + * has a new attribute failOnNoReplacements that makes the + build fail if the task didn't do anything. + Bugzilla Report 21064. + + * 's has a new attribute that controls + whether empty directories should be kept. + Bugzilla Report 43159. + + * ant -diagnostics now checks that it can read as much from the + temporary directory as it has written. This may help detecting a + full filesystem. + Bugzilla Report 32676. + + * has a new preserveduplicates attribute--historically + these were eliminated in the interest of behaving in the manner + of a "path." + + * 's source and target attributes are no longer ignored when + using gcj. + Bugzilla Issue 46617. + + * ant -diagnostics now outputs information about the default XSLT + processor. + Bugzilla Issue 46612. + + * the ZIP library will now ignore ZIP extra fields that don't specify + a size. + Bugzilla Report 42940. + + * CBZip2OutputStream now has a finish method separate from close. + Bugzilla Report 42713. + + * the and family of tasks has new options to deal with + file name and comment encoding. Please see the zip tasks' + documentation for details. + + * now uses previously + undocumented SecureInputHandler shipped with Ant 1.7.1. + + * Command line arguments for and similar tasks can now have + optional prefix and suffix attributes. + Bugzilla Report 47365 + + * 's srcfile and targetfile child elements can now have + optional prefix and suffix attributes. + Bugzilla Report 45625 + + * has a new attribute to enable indexing of META-INF + directories which is disabled for backwards compatibility reasons. + Bugzilla Report 47457 + + * 's executable attribute can be used to specify a different + executable. + Bugzilla Report 46230. + + * 's new executable attribute can be used to specify a + different executable. + Bugzilla Report 42132. + + * , , and now provide a nested + element to specify a classpath that will be used when loading the + task's (compiler) adapter class. + Bugzilla Report 11143. + + * , , and now provide a nested + element to specify the task's (compiler) adapter as an instance of + a class that has been defined via typedef/componentdef. This + allows more control over the classpath and allows adapters to be + defined in Antlibs easily. + + * A new subclass org.apache.tools.ant.loader.AntClassLoader5 of + AntClassLoader has been added which overrides getResources + which became non-final in ClassLoader with Java5+ so + this method now behaves as expected. + The new subclass will be used by Ant internally if it is available + and Ant is running on Java5 or more recent. + Bugzilla Report 46752. + + * a new attributes can chose a different request method than GET for + the http condition. + Bugzilla Report 30244 + + * now supports a configurable display text and a regular + expression based way to determine progress based on logged messages. + Bugzilla Report 39957. + + * the number of retries on error in is now configurable. + can be told to not download files that already exist locally. + Bugzilla Report 40058. + + * Ant now builds against commons-net 2.0 as well. + Bugzilla Report 47669. + + * A new nested element connectionProperty of allows setting of + arbitrary JDBC connection properties. + Bugzilla Report 33452. + + * A new islastmodified condition can check the last modified date of + resources. + + * has a new destDir attribute that allows generated files to + be written to a different location than the original classes. + Bugzilla Report 20699. + + * has a new listfiles attribute similar to the existing one of + . + Bugzilla Report 24359. + + * It is now possible to suppress the "FAILED" lines sent to Ant's + logging system via 's new logFailedTests attribute. + Bugzilla Report 35073. + + * now can delete entries. + + * The resource collection can now optionally cache its + contents. + + * A new condition can check whether resources exists. + + * has two new attributes errorproperty and warningproperty that + can be set if an error/warning occurs. + Bugzilla Report 38807. + + * has a new attribute rowcountproperty that can be used to set + a property to the number of rows affected by a task execution. + Bugzilla Report 40923. + + * when Ant copies files without filtering, it will now use NIO + channels. + Bugzilla Report 30094. + + * has a new attribute that can be used to disable caching on + HTTP connections at the HttpUrlConnection level. + Bugzilla Report 41891. + + * and (and tasks derived from ) will now create the + parent directory of the destination archive if it doesn't exist. + Bugzilla Report 45377. + + * A new filterreader that sorts input lines has been + added. + Bugzilla Report 40504. + + * A new token filter that suppresses tokens that match + their ancestor token has been added. + + * s nested into s can now use a dir + attribute different from the . + Bugzilla Report 37763. + + * can now optionally cache its contents. + + * can now specify values as nested text. + Bugzilla Report 32917. + + * a new parentFirst attribute on allows resources to + be loaded from the specified classpath rather than the system + classloader. + Bugzilla Report 41369. + + * can now + calculate relative paths. + + * The selector supports a new handleDirSep attribute that + makes it ignore differences between / and \ separators. + Bugzilla Report 47858. + + * now supports resource collections (as long as the resources + contained provide URLs) and can get multiple resources in a single + task. + + * can now import non-File resources if they provide an URL + - as the and resources do. + Bugzilla Report 29251 + + * can now import multiple resources specified as resource + collections. + Bugzilla Report 22269. + + * a new type is similar to but can read the + list of resources from non-file resources and may return resources + that are not files. + + * a new filterreader appendtolines complements prefixlines. + + * a new top level element extension-point allows build files to be + extended with custom targets more easily. + +Changes from Ant 1.7.0 TO Ant 1.7.1 +============================================= + +Changes that could break older environments: +------------------------------------------- + +* String resources only have properties single expanded. If you relied on + resources being expanded more than once, it no longer happens. + Bugzilla report 42277. + +* A String resource's encoding attribute was only taken into account when + set from the resource's OutputStream; the InputStream provided the String's + binary content according to the platform's default encoding. Behavior has + been modified to encode outgoing (InputStream) content as well as encoding + incoming (OutputStream) content. + +* with fork now returns gives -1 instead of 0 as result when failonerror + is false and some exception (including timeout) occurs. Br 42377. + +* ant-type attribute has been marked as deprecated and a warning has been + issued if it is encountered in the build file. + +Fixed bugs: +----------- + +* The default logger was failing to print complete stack traces for exceptions + other than BuildException, thus omitting often important diagnostic + information. Bugzilla 43398. + +* Error in FTP task + Bugzilla report 41724 + +* Regression: Locator fails with URI encoding problem when spaces in path + Bugzilla report 42222 + +* Regression in Locator: running Ant off a network share does not work: + message "URI has authority component" appears + Bugzilla report 42275 + +* Improvements in AntClassLoader Speed. + Bugzilla report 42259 + +* Error in handling of some permissions, most notably the AllPermission on + jdk 1.5 + Bugzilla report 41776 + +* Replace task summary output incorrect. + Bugzilla report 41544 + +* Dependset crashes ant when timestamp on files change during Dependset + execution. + Bugzilla report 41284 + +* Bug in org.apache.tools.ant.types.resources.comparators.Date + Bugzilla report 41411 + +* in Ant 1.7.0 could throw NPE if no was defined. + Bugzilla report 41422. + +* In Ant 1.7.0, in does not by default include only + **/*.java as the documentation claims and earlier revisions did. + Bugzilla report 41264. + +* SPI support in jar was broken. + Bugzilla report 41201. + +* jsch-0.1.30 causes SCP task to hang + Bugzilla report 41090. + +* Target from imported file listed twice in projecthelp. + Bugzilla report 41226. + +* task double-expands properties if expandproperties is true, + and expands properties if expandproperties is false. + Bugzilla report 41204. + +* Rolling back Bugzilla 32927 (set a default description for a javadoc tag + if not set) as it caused a BC problem. + Bugzilla report 41268. + +* forks properly and so memory settings are picked up. + Bug report 41280. + +* Regression: NPE was thrown when using against a + (third-party instantiated) fileset with null Project reference. + +* Strip out all -J arguments to non forking rmic adapters, specifically + the Sun and Weblogic compilers. + Bug report 41349 + +* Synchonization issues in PropertyHelper. Bugzilla 41353. + +* did not append. Bugzilla 41399. + +* -autoproxy turns Java1.5+ automatic proxy support on. Bugzilla 41904 + +* Handle null result of system getProperty(). Bugzilla 42334. + +* Regression: concat fixlastline="true" should not have applied to + nested text, but did in Ant 1.7.0. Bugzilla 42369. + +* Regression: ant.version was not passed down in , . + This worked in Ant 1.6.5, but not in 1.7.0. + ant.core.lib (added in 1.7.0) was also not being propagated. + Bugzilla bug 42263 + +* Regression: bzip2 task created corrupted output files for some inputs. + Bugzilla bug 41596. + +* Regression: with did not work. + Bugzilla 42735. + +* ant script, cd may output to stdout. + Bugzilla 42739. + +* Modified selector doesn't update the cache if only one file has changed. + Bugzilla 42802. + +* Regression: Path subclasses that overrode list() stopped working in + resourceCollection contexts in Ant 1.7.0. Bugzilla 42967. + +* supports loading from xml based property definition. + Bugzilla 42946 + +* supports collecting and rerunning failed test cases + (textXXX methods). Bugzilla 42984. + +* War task failed with "No WEB-INF/web.xml file was added" when called + a second time. Bugzilla 43121. + +* FilterMapper could throw an NPE. + Bugzilla 43292. + +* Regession nested macrodefs with elements could cause StackOverFlow. + Bugzilla 43324. + +* Some changes to broke third party tasks that extend it (like + Apache Cactus' Ant task). The changes have been modified so that + subclases should now work again - without any changes to the + subclass. + +Other changes: +-------------- + +* Various small optimizations speed up common tasks such as on large + filesets, reducing both I/O and CPU usage. + +* Profiling logger has been added with basic profiling capabilities. + +* +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache AntUnit

+

+ + Apache AntUnit™ +

+

Apache AntUnit is an Antlib that provides a test framework + for Apache Ant tasks and types.

+

+ + Apache AntUnit 1.1 +

+

September 26, 2008 - Apache AntUnit 1.1 Released

+

Apache AntUnit 1.1 is now available for download as binary + or source + release.

+

In addition to a few bugfixes and some new assertions AntUnit + 1.1 allows test listeners to receive the log output of the + project under test. Both plainlistener and xmllistener have + an option that makes them echo the project's output into their + respective logs.

+

+ + AntUnit 1.1 Beta 1 +

+

September 3, 2008 - Apache AntUnit 1.1 Beta 1 Available

+

+ + AntUnit 1.0 +

+

January 8, 2007 - Apache AntUnit 1.0 Available

+

Apache AntUnit 1.0 is now available for download as binary + or source + release.

+

+ + Idea +

+

Initially all tests for Apache Ant tasks were written as individual + JUnit test cases. Pretty + soon it was clear that most tests needed to perform common tasks + like reading a build file, initializing a project instance with + it and executing a target. At this point BuildFileTest + was invented, a base class for almost all task test cases.

+

BuildFileTest works fine and in fact has been picked up by the Ant-Contrib Project + and others as well.

+

Over time a new pattern evolved, more and more tests only + executed a target and didn't check any effects. Instead that + target contained the assertions as a <fail> + task. This is an example taken from the build file for the + ANTLR task (using Ant 1.7 features):

+ 
+  <target name="test3" depends="setup">
+    <antlr target="antlr.g" outputdirectory="${tmp.dir}"/>
+    <fail>
+      <condition>
+        <!-- to prove each of these files exists;
+             ANTLR >= 2.7.6 leaves behind new (.smap) files as well. -->
+        <resourcecount when="ne" count="5">
+          <fileset dir="${tmp.dir}">
+            <include name="CalcParserTokenTypes.txt" />
+            <include name="CalcParserTokenTypes.java" />
+            <include name="CalcLexer.java" />
+            <include name="CalcParser.java" />
+            <include name="CalcTreeWalker.java" />
+          </fileset>
+        </resourcecount>
+      </condition>
+    </fail>
+  </target>
+
+

where the corresponding JUnit testcase has been reduced + to

+ 
+...
+public class ANTLRTest extends BuildFileTest {
+
+    private final static String TASKDEFS_DIR = "src/etc/testcases/taskdefs/optional/antlr/";
+
+    public ANTLRTest(String name) {
+        super(name);
+    }
+
+    public void setUp() {
+        configureProject(TASKDEFS_DIR + "antlr.xml");
+    }
+
+    public void tearDown() {
+        executeTarget("cleanup");
+    }
+
+    public void test3() {
+        executeTarget("test3");
+    }
+...
+}
+
+

This approach has a couple of advantages, one of them is that + it is very easy to translate an example build file from a bug + report into a test case. If you ask a user for a testcase for a + given bug in Ant, he now doesn't need to understand JUnit or how + to fit a test into Ant's existing tests any more.

+

AntUnit takes this approach to testing even further, it + removes JUnit completely and it comes with a set of predefined + <assert> tasks in order to reuse common kind + of checks.

+

It turns out that AntUnit lends itself as a solution to other + problems as well. The assertions are an easy way to validate a + setup before even starting the build process, for example. + AntUnit could also be used for functional and integration tests + outside of the scope of Ant tasks (assert contents of databases + after running an application, assert contents of HTTP responses + ...). This is an area that will need more research.

+

+ + Concepts +

+

+ + antunit Task +

+

The <antunit> task drives the tests much like + <junit> does for JUnit tests.

+

When called on a build file, the task will start a new Ant + project for that build file and scan for targets with names + that start with "test". For each such target it then will

+
    +
  1. Execute the target named setUp, if there is one.
    2. +
  2. Execute the target itself - if this target depends on + other targets the normal Ant rules apply and the dependent + targets are executed first.
    3. +
  3. Execute the target names tearDown, if there is one.
    4. +
+

+ + Assertions +

+

The base task is <assertTrue>. It + accepts a single nested condition and throws a subclass of + BuildException named AssertionFailedException if that + condition evaluates to false.

+

This task could have been implemented using + <macrodef> and <fail>, + but in fact it is a "real" task so that it is possible to + throw a subclass of BuildException. The + <antunit> task catches this exception and + marks the target as failed, any other type of Exception + (including other BuildException) are test errors.

+

Together with <assertTrue> there are + many predefined assertions for common conditions, most of + these are only macros.

+

+ + Other Tasks +

+

The <logcapturer> captures all messages + that pass Ant's logging system and provides them via a + reference inside of the project. If you want to assert + certain log messages, you need to start this task (prior to + your target under test) and use the + <assertLogContains> assertion.

+

<expectFailure> is a task container that + catches any BuildException thrown by tasks nested into it. If + no exception has been thrown it will cause a test failure (by + throwing an AssertionFailedException).

+

+ + AntUnitListener +

+

Part of the library is the AntUnitListener + interface that can be used to record test results. The + <antunit> task accepts arbitrary many listeners and + relays test results to them.

+

Currently two implementations - + <plainlistener> and xmllistener + modelled after the "plain" and "xml" + JUnit listeners - are bundled with the library.

+

+ + Examples +

+

This is a way to test that <touch> + actually creates a file if it doesn't exist:

+ 
+<project xmlns:au="antlib:org.apache.ant.antunit">
+  <!-- is called prior to the test -->
+  <target name="setUp">
+    <property name="foo" value="foo"/>
+  </target>
+
+  <!-- is called after the test, even if that caused an error -->
+  <target name="tearDown">
+    <delete file="${foo}" quiet="true"/>
+  </target>
+
+  <!-- the actual test case -->
+  <target name="testTouchCreatesFile">
+    <au:assertFileDoesntExist file="${foo}"/>
+    <touch file="${foo}"/>
+    <au:assertFileExists file="${foo}"/>
+  </target>
+</project>
+
+

When running a task like

+ 
+    <au:antunit>
+      <fileset dir="." includes="touch.xml"/>
+      <au:plainlistener/>
+    </au:antunit>
+
+

from a buildfile of its own you'll get a result that looks like

+ 
+[au:antunit] Build File: /tmp/touch.xml
+[au:antunit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.249 sec
+[au:antunit] Target: testTouchCreatesFile took 0.183 sec
+
+BUILD SUCCESSFUL
+Total time: 1 second
+
+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/bindownload.cgi b/tools/apache-ant-1.8.2/docs/antlibs/bindownload.cgi new file mode 100644 index 000000000..4324f769f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/bindownload.cgi @@ -0,0 +1,22 @@ +#!/bin/sh + +# 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. + +# Wrapper script around mirrors.cgi script +# (we must change to that directory in order for python to pick up the +# python includes correctly) +cd /www/www.apache.org/dyn/mirrors +/www/www.apache.org/dyn/mirrors/mirrors.cgi $* diff --git a/tools/apache-ant-1.8.2/docs/antlibs/bindownload.html b/tools/apache-ant-1.8.2/docs/antlibs/bindownload.html new file mode 100644 index 000000000..bf54b2943 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/bindownload.html @@ -0,0 +1,361 @@ + + + + + + + + + Apache Ant - Binary Distributions + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Binary Distributions

+

+ + Downloading Apache Antlibs +

+

Use the links below to download a binary distribution of Apache Antlibs from +one of our mirrors. It is good practice to +verify the integrity +of the distribution files, especially if you are using one of our +mirror sites. In order to do this you must use the signatures from +our main distribution +directory.

+

Antlibs are distributed as zip, tar.gz and +tar.bz2 archives - the contents are the same. Please +note that the tar.* archives contain file names longer +than 100 characters and have been created using GNU tar extensions. +Thus they must be untarred with a GNU compatible version of +tar.

+

If you do not see the file you need in the links below, please see +the master distribution +directory or, preferably, its mirror.

+

+ + Mirror +

+

You are currently using [preferred]. If you encounter a +problem with this mirror, please select another mirror. If all +mirrors are failing, there are backup mirrors (at the end of +the mirrors list) that should be available.

+
+Other mirrors: + +
+

+ + Current Antlib Releases +

+
+
Note
+
Very recent releases may not be available on all +mirrors for a few days.
+
+
+
+
Tar files may require gnu tar to extract
+
Tar files in the distribution contain long file names, and may + require gnu tar to do the extraction.
+
+ +

+ + Old Antlib Releases +

+

Older releases of Ant Libraries can be found here. +We highly recommend to not use those releases but upgrade to the latest releases.

+

+ + Verify Releases +

+

It is essential that you verify the integrity of the downloaded +files using the PGP signature or the SHA1 or MD5 checksums. The +checksums are not as strong indicators as the PGP signature.

+

The PGP signatures can be verified using PGP or GPG. First +download the KEYS +as well as the asc signature file for the particular +distribution. Make sure you get these files from the main distribution +directory, rather than from a mirror. Then verify the signatures +using

+

+% pgpk -a KEYS
+% pgpv apache-ant-dotnet-1.0-bin.tar.gz.asc
+ +or
+ +% pgp -ka KEYS
+% pgp apache-ant-dotnet-1.0-bin.tar.gz.asc
+ +or
+ +% gpg --import KEYS
+% gpg --verify apache-ant-dotnet-1.0-bin.tar.gz.asc +

+

Alternatively, you can verify the checksums on the files. Unix +programs called md5/sha1 or +md5sum/sha1sum are included in many unix +distributions. *sum is also available as part of GNU +Textutils. Windows users can get binary md5 programs from here, here. fsum supports MD5 and +SHA1.

+

We highly recommend to verify the PGP signature, though.

+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/charter.html b/tools/apache-ant-1.8.2/docs/antlibs/charter.html new file mode 100644 index 000000000..1b3397c62 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/charter.html @@ -0,0 +1,365 @@ + + + + + + + + + Apache Ant - Apache Ant Libraries - Charter + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Ant Libraries - Charter

+

+ + Charter +

+

Below is the text of the proposal that has been accepted by + the Apache Ant PMC. Further amendments are expected.

+ 
+Proposal to Create a Ant-Libraries Sub-Project in Apache Ant
+============================================================
+
+(0) rationale
+
+Ant itself has accumulated lots and lots of tasks over time. So many,
+that Ant developers have become reluctant to adding new
+task. Furthermore any new task in Ant would be tied to Ant's release
+schedule which is too slow for a thriving, fresh piece of code.
+
+The proposal allows Ant tasks and types to be developed under the Ant
+umbrella by Ant developers but have much shorter release cycles than
+Ant itself. In addition it would new committers who would have commit
+access to a single Ant library instead of the whole of Ant.
+
+(1) scope of the subproject
+
+The subproject shall create and maintain libraries of Ant tasks and
+types. Each library will be managed in the same manner as the Ant
+project itself, the PMC is ultimately responsible for it.
+
+Common Java libraries that only happen to provide Ant tasks as well
+are out of scope of the subproject. Providing the tasks or types has
+to be the primary goal of the library.
+
+To further this goal, the subproject shall also host a workplace for
+Ant committers.
+
+(1.5) interaction with other subprojects
+
+(1.5.1) the sandbox
+
+The subproject will host a SVN repository available to all Ant
+committers as a workplace for new Ant libraries.
+
+Before a library can have a public release it has to get promoted to
+the "proper" Ant libraries subproject. This also means it has to match
+the requirements of an Ant library as defined in section (4) under
+Guidelines below.
+
+The status of any library developed in the sandbox shall be reviewed
+after six months and the library gets either promoted or removed - or
+it has to be re-evaluated after another six months.
+
+(2) identify the initial source from which the subproject is to be populated
+
+Some Ant committers have developed tasks or libraries inside of the
+Ant CVS module under the proposal/sandbox directory. Committers are
+free to move them over to the new sandbox subproject or remove them
+completely.
+
+Libraries expected to move to the sandbox subproject initially are
+
+* the .NET tasks under proposal/sandbox/dotnet
+
+* the Subversion support tasks under proposal/sandbox/svn
+
+(3) identify the initial Apache resources to be created
+
+(3.1) mailing list(s)
+
+None. At least at the beginning we don't expect too much traffic and
+the existing mailing lists of the Ant projects will be used.
+
+(3.2) SVN repositories
+
+Create <http://svn.apache.org/repos/asf/ant/>
+
+Expected are sub-directories
+
+antlibs/
+   |
+   -----> proper/
+   |        |
+   |        -----> library1
+   |        |        |
+   |        |        -----------> trunk
+   |        |        -----------> tags
+   |        |        -----------> branches
+   |        -----> library2
+   |                 |
+   |                 -----------> trunk
+   |                 -----------> tags
+   |                 -----------> branches
+   |
+   -----> sandbox/
+            |
+            -----> library1
+            |        |
+            |        -----------> trunk
+            |        -----------> tags
+            |        -----------> branches
+            -----> library2
+                     |
+                     -----------> trunk
+                     -----------> tags
+                     -----------> branches
+
+And potentially collections of all-trunks using svn:external as shown
+by the current Jakarta Commons structure.
+
+(3.3) Bugzilla
+
+New components under product "Ant" for each new library.
+
+(4) identify the initial set of committers
+
+All current Ant PMC members plus the active Ant committers who are not
+PMC members yet.
+
+Guidelines
+----------
+
+Note:
+
+* is, has, will, shall, must - required.
+
+* may, should, are encouraged - optional but recommended.
+
+(1) The primary unit of reuse and release is the Ant library.
+
+(2) The library is not a framework or a general library but a
+    collection of Ant tasks and types.
+
+(3) Each library must have a clearly defined purpose, scope, and API.
+
+(4) Each library is treated as a product in its own right.
+
+(4.1) Each library has its own status file, release schedule, version
+      number, QA tests, documentation, bug category, and individual
+      JAR.
+
+(4.2) Each library must clearly specify any external dependencies,
+      including any other libraries, and the earliest JDK version
+      required.
+
+(4.3) Each library must maintain a list of its active committers in
+      its status file.
+
+(4.4) The libraries should use a standard scheme for versioning, QA
+      tests, and directory layouts, and a common format for
+      documentation and Ant build files.
+
+(4.4) Each library will be hosted on its own page on the subproject
+      Web site, and will also be indexed in a master directory.
+
+(4.5) Volunteers become committers to this subproject in the same way
+      they are entered to any Apache subproject.
+
+      Once the required infrastructure is in place, volunteers may
+      become committers for a single Ant library only.
+
+(4.6) New libraries may be proposed to the Ant dev mailing list. To be
+      accepted, a library proposal must receive majority approval of
+      the Ant PMC. Proposals are to identify the rationale for the
+      library, its scope, the initial source from which the library is
+      to be created, and the initial set of committers.
+
+(4.7) As stated in the Ant guidelines, an action requiring majority
+      approval must receive at least 3 binding +1 votes and more +1
+      votes than -1 votes.
+
+(4.8) Each Ant library needs at least three committers, at least one
+      of them has to be an Ant PMC member.
+
+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/compress/index.html b/tools/apache-ant-1.8.2/docs/antlibs/compress/index.html new file mode 100644 index 000000000..e3761f6ba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/compress/index.html @@ -0,0 +1,238 @@ + + + + + + + + + Apache Ant - Apache Compress Antlib + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Compress Antlib

+

+ + Apache Compress Antlib™ +

+

This Antlib contains tasks and resources that provide + compression/uncompression and archival/unarchival capabilities + based on Apache + Commons Compress. Using Apache Commons Compress 1.1 + this.

+

+ + Compress Ant Library 1.0 +

+

August 30, 2010 - Apache Compress Ant Library 1.0 + Available

+

Apache Compress Ant Library 1.0 is now available for + download as binary + or source + release.

+

+ + Introduction +

+

Using Apache Commons Compress this Antlib supports gzip and + bzip2 compression and ar, cpio, tar and zip archives.

+

The current code base is based on the 1.1 release of Commons + Compress but it is expected that this Antlib follows Commons + Compress' development and will add new compression or + archiving formats as they are provided by the underlying + library.

+

The gzip and bzip2 tasks and resources are similar to the + corresponding tasks and types in Ant's core and mainly just + use a different code base for the implementation of the + formats.

+

The same is mostly true for the zip and tar resources as well + as the unzip/tar task with the major difference being that + unzip and zipfileset can work with non-File resources.

+

The zip and tar tasks are completely new implementations and + offer a superset of the functionality of the core tasks.

+

Tasks and resources for the ar and cpio formats mirror those + available for tar and zip.

+

All tasks and types can be mixed with the core tasks and + types; it is possible to use the core zip task to create an + archive based on an cpiofileset for example.

+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/dotnet/index.html b/tools/apache-ant-1.8.2/docs/antlibs/dotnet/index.html new file mode 100644 index 000000000..f52868f6a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/dotnet/index.html @@ -0,0 +1,336 @@ + + + + + + + + + Apache Ant - Apache .NET Ant Library + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache .NET Ant Library

+

+ + Apache .NET Ant Library™ +

+

The Apache .NET Antlib provides tasks that support + development of .NET software with Apache Ant.

+

+ + Apache .NET Ant Library 1.0 +

+

November 6, 2006 - Apache .NET Ant Library 1.0 + Available

+

Apache .NET Ant Library 1.0 is now available for + download as binary + or source + release.

+

+ + Idea +

+

This library doesn't strive to replace NAnt or MSBuild, its + main purpose is to help those of us who work on projects + crossing platform boundaries. With this library you can use Ant + to build and test the Java as well as the .NET parts of your + project.

+

This library provides a special version of the + <exec> task tailored to run .NET executables. + On Windows it will assume the Microsoft framework is around and + run the executable directly, while it will invoke Mono on any + other platform. Of course you can override these + assumptions.

+

Based on this a few tasks to run well known .NET utilities + from within Ant are provided, namely tasks to run NUnit, NAnt, MSBuild + and the Wix toolkit.

+

The initial .NET tasks of Ant (compiler tasks for C#, J# and VB.NET + for example) have also been moved to this Antlib and will see further + development here.

+

+ + Tasks +

+

+ + dotnetexec +

+

Runs a .NET executable.

+

+ + nunit +

+

Runs NUnit tests.

+

+ + nant +

+

Invokes NAnt, either on an external file or a build file + snippet contained inside your Ant build file.

+

+ + msbuild +

+

Invokes MSBuild, either on an external file or a build file + snippet contained inside your Ant build file.

+

+ + wix +

+

Invokes the candle and light executables of the WiX toolkit + in order to create MSI installers from within Ant.

+

+ + Examples +

+

+ + nant +

+ 
+<project xmlns:dn="antlib:org.apache.ant.dotnet">
+  <dn:nant>
+    <build>
+      <echo message="Hello world"/>
+    </build>
+  </dn:nant>
+</project>
+
+

runs NAnt on the embedded <echo> + task, output looks like

+ 
+Buildfile: test.xml
+[dn:nant] NAnt 0.85 (Build 0.85.1932.0; rc3; 16.04.2005)
+[dn:nant] Copyright (C) 2001-2005 Gerry Shaw
+[dn:nant] http://nant.sourceforge.net
+[dn:nant] 
+[dn:nant] Buildfile: file:///c:/DOKUME~1/STEFAN~1.BOD/LOKALE~1/Temp/build1058451555.xml
+[dn:nant] Target framework: Microsoft .NET Framework 1.1
+[dn:nant] 
+[dn:nant]      [echo] Hello world
+[dn:nant] 
+[dn:nant] BUILD SUCCEEDED
+[dn:nant] 
+[dn:nant] Total time: 0.2 seconds.
+
+BUILD SUCCESSFUL
+Total time: 2 seconds
+

+ + msbuild +

+ 
+<project xmlns:dn="antlib:org.apache.ant.dotnet">
+  <dn:msbuild>
+    <build>
+      <Message Text="Hello world"
+        xmlns="http://schemas.microsoft.com/developer/msbuild/2003"/>
+    </build>
+  </dn:msbuild>
+</project>
+

runs MSBuild on the embedded <Message> + task, output looks like

+ 
+Buildfile: test.xml
+[dn:msbuild] Microsoft (R) Build Engine Version 2.0.50727.42
+[dn:msbuild] [Microsoft .NET Framework, Version 2.0.50727.42]
+[dn:msbuild] Copyright (C) Microsoft Corporation 2005. All rights reserved.
+
+[dn:msbuild] Build started 15.12.2005 20:21:56.
+[dn:msbuild] __________________________________________________
+[dn:msbuild] Project "c:\Dokumente und Einstellungen\stefan.bodewig\Lokale Einstellungen\Temp\build1543310185.xml" (default targets):
+
+[dn:msbuild] Target generated-by-ant:
+[dn:msbuild]     Hello world
+
+[dn:msbuild] Build succeeded.
+[dn:msbuild]     0 Warning(s)
+[dn:msbuild]     0 Error(s)
+
+[dn:msbuild] Time Elapsed 00:00:00.10
+
+BUILD SUCCESSFUL
+Total time: 0 seconds
+
+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/index.html b/tools/apache-ant-1.8.2/docs/antlibs/index.html new file mode 100644 index 000000000..54839cf22 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/index.html @@ -0,0 +1,209 @@ + + + + + + + + + Apache Ant - The Apache Ant™ Libraries Subproject + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

The Apache Ant™ Libraries Subproject

+

+ + The Apache Ant Libraries Subproject +

+

Apache Ant Libraries - or Antlibs for short

+

With Apache Ant 1.6.0 and the ant libraries concept creating + libraries of Ant tasks that are easy to get dropped into an + existing Ant installation has become far easier.

+

The Ant Libraries subproject was started as a place to + develop small libraries of tasks that can get released + independent of Ant's release schedule - which is necessary for + nascent Ant tasks since Ant's own release schedule has become + rather slow over time.

+

The subproject also offers a sandbox as playground for Ant + committers to try new ideas for tasks.

+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/proper.html b/tools/apache-ant-1.8.2/docs/antlibs/proper.html new file mode 100644 index 000000000..18a17fb7c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/proper.html @@ -0,0 +1,592 @@ + + + + + + + + + Apache Ant - Apache Ant™ Libraries + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Ant™ Libraries

+

+ + Apache Ant Libraries +

+ +

+ + Apache AntUnit™ - Unit Test Framework for Ant Tasks +

+

Apache AntUnit borrows ideas from JUnit 3.x and the <junit> + task. It provides a task that runs build files as unit tests + as well as a number of assertion tasks to support the + idea.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Homepage: + + http://ant.apache.org/antlibs/antunit/ +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/antlibs/antunit/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/antlibs/antunit/trunk/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2005-04-15 +
+ Promoted from sandbox: + + 2005-11-22 +
+ Latest Release: + + 1.1 released on September 26, 2008 +
+ +

+ + Apache Compress Antlib™ +

+

The Apache Compress Antlib offers tasks and types for additional + archive formats like CPIO and AR supported + by Apache + Commons Compress.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Homepage: + + http://ant.apache.org/antlibs/compress/ +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/antlibs/compress/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/ +
+ Ant compatibility: + + Ant 1.8.x +
+ Added to sandbox: + + 2009-07-31 +
+ Promoted from sandbox: + + 2009-10-16 +
+ Latest Release: + + 1.0 released on August 30, 2010 +
+ +

+ + DotNet - Improved Support for .NET projects +

+

Provides a simple infrastructure to execute .NET + applications from within Ant for different VMs so that the + user doesn't have to change the build file when she wants to + run Mono on Linux and Microsoft's VM on Windows.

+

Also contains <nant>, <nunit> and + <msbuild> tasks and an untested <wix> tasks.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Homepage: + + http://ant.apache.org/antlibs/dotnet/ +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/antlibs/dotnet/trunk/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2005-04-15 +
+ Promoted from sandbox: + + 2005-11-22 +
+ Latest Release: + + 1.0 released on November 6, 2006 +
+ +

+ + Props - additional Property Resolver +

+

This is a library of supplementary handlers for Ant + properties resolution.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Homepage: + + http://ant.apache.org/antlibs/props/ +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/antlibs/props/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/antlibs/props/trunk/ +
+ Ant compatibility: + + Ant 1.8.x +
+ Added to sandbox: + + 2007-07-25 +
+ Promoted from sandbox: + + 2009-10-06 +
+ Latest Release: + + None +
+ +

+ + VSS - Microsoft Visual SourceSafe Tasks +

+

This antlib provides an interface to the Microsoft Visual SourceSafe SCM. The original tasks + (org.apache.tools.ant.taskdefs.optional.vss) have been expanded upon in this antlib. + Some fixes to issues in the original tasks have also been incorporated.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + http://svn.apache.org/repos/asf/ant/antlibs/vss/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/antlibs/vss/trunk/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2006-04-26 +
+ Promoted from sandbox: + + 2010-09-02 +
+ Latest Release: + + None +
+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/props/index.html b/tools/apache-ant-1.8.2/docs/antlibs/props/index.html new file mode 100644 index 000000000..dd751801d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/props/index.html @@ -0,0 +1,281 @@ + + + + + + + + + Apache Ant - Apache Props Antlib + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Props Antlib

+

+ + Apache Props Antlib™ +

+

This is a library of supplementary handlers for Apache Ant + properties resolution.

+

The types provided are instances of + org.apache.tools.ant.PropertyHelper.Delegate and + can be invoked using the <propertyhelper> + task provided in Ant 1.8.0.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Delegate + + Delegate Type + + Description +
+ nested + + PropertyExpander + + Implements nested property expansion; + e.g. ${${double-expand-me}}. +
+ stringops + + PropertyEvaluator + + Implements *nix shell-inspired string operations. +
+ refs + + PropertyEvaluator + + Given ref:refid, + resolves reference refid. +
+ types + + PropertyEvaluator + + Given type(arg), attempts + to invoke + type constructor (project, arg), + then (arg). +
+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/sandbox.html b/tools/apache-ant-1.8.2/docs/antlibs/sandbox.html new file mode 100644 index 000000000..d1faf88af --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/sandbox.html @@ -0,0 +1,735 @@ + + + + + + + + + Apache Ant - Apache Ant™ Libraries - The Sandbox + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Ant™ Libraries - The Sandbox

+

+ + Apache Ant Libraries - The Sandbox +

+

The sandbox is the place where new Apache Ant Libraries start their + life, it is a playground for Ant committers and other + contributors who find committers to sponsor their ideas.

+

The sandbox is no dumping ground. If a Sandbox Ant Library + fails to attract interest within a reasonable amount of time, it + gets removed from the sandbox.

+

+ + Current Sandbox Ant Libraries +

+

+ + DBPatch +

+

DBPatch library is intended to maintain versioning of a + database schema and data during iterative development.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/dbpatch/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/dbpatch/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2008-04-22 +
+ Sponsoring Committers + + Stefan Bodewig +
+

+ + Debian - Debian related tasks +

+

Debian provides tasks for generating Debian packages.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/debian/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/debian/trunk/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2007-05-18 +
+ Sponsoring Committers + + Kevin Jackson +
+

+ + FSCache - Filesystem Resource cache +

+

This is a library of tasks and types to cache arbitrary Ant resources + to the filesystem for processing with file-based tools.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/fscache/trunk/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/fscache/trunk/ +
+ Ant compatibility: + + Ant 1.8.x +
+ Added to sandbox: + + 2008-06-30 +
+ Sponsoring Committers + + Matt Benson +
+

+ + GenDoc - Generate the manual for Ant Tasks from their sources +

+

Most of the information needed for writing the manual is inside the sources: attributes, nested elements (especially + inherited one). GenDoc collects these information and generates the manual as xml page. Following steps transform this + xml into the final format (HTML in the first step, PDF may follow).

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + http://svn.apache.org/repos/asf/ant/sandbox/antlibs/gendoc/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/gendoc/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2005-04-15 +
+ Sponsoring Committers + + +
+

+ + HTTP - tasks for handling HTTP requests +

+

This antlib contains tasks to make the basic HTTP requests: get, post, head, put, with Basicauthentication.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + http://svn.apache.org/repos/asf/ant/sandbox/antlibs/http/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/http/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2006-06-27 +
+ Sponsoring Committers + + +
+

+ + Manual4Eclipse - Generate an Eclipse Help PlugIn from Ant's manual +

+

This AntLib provides tasks for generating an Eclipse Help PlugIn from Ant's manual.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + http://svn.apache.org/repos/asf/ant/sandbox/antlibs/manual4eclipse/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/manual4eclipse/trunk/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Java compatibility: + + Java 1.5+ +
+ Added to sandbox: + + 2007-03-01 +
+ Sponsoring Committers + + +
+

+ + Minify +

+

Minify library offers tasks for minimizing JavaScript scripts.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/minify/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/minify/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2009-01-01 +
+ Sponsoring Committers + + Kevin Jackson +
+

+ + StarTeam +

+

This antlib provides tasks for working with the StarTeam SCM.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/starteam/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/starteam/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2007-08-27 +
+ Sponsoring Committers + + Peter Reilly +
+

+ + WebLogic +

+

This antlib provides tasks for working with the WebLogic app server.

+ + + + + + + + + + + + + + + + + + + + + +
+ SVN URL: + + https://svn.apache.org/repos/asf/ant/sandbox/antlibs/weblogic/ +
+ ViewSVN: + + http://svn.apache.org/viewvc/ant/sandbox/antlibs/weblogic/ +
+ Ant compatibility: + + Ant 1.7.x +
+ Added to sandbox: + + 2007-08-20 +
+ Sponsoring Committers + + Peter Reilly, Stefan Bodewig +
+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.cgi b/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.cgi new file mode 100644 index 000000000..4324f769f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.cgi @@ -0,0 +1,22 @@ +#!/bin/sh + +# 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. + +# Wrapper script around mirrors.cgi script +# (we must change to that directory in order for python to pick up the +# python includes correctly) +cd /www/www.apache.org/dyn/mirrors +/www/www.apache.org/dyn/mirrors/mirrors.cgi $* diff --git a/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.html b/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.html new file mode 100644 index 000000000..bf316fc2d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/srcdownload.html @@ -0,0 +1,360 @@ + + + + + + + + + Apache Ant - Source Distributions + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Source Distributions

+

+ + Downloading Apache Antlibs +

+

Use the links below to download a source distribution of Apache Antlibs from +one of our mirrors. It is good practice to +verify the integrity +of the distribution files, especially if you are using one of our +mirror sites. In order to do this you must use the signatures from +our main distribution +directory.

+

Antlibs are distributed as zip, tar.gz and +tar.bz2 archives - the contents are the same. Please +note that the tar.* archives contain file names longer +than 100 characters and have been created using GNU tar extensions. +Thus they must be untarred with a GNU compatible version of +tar.

+

If you do not see the file you need in the links below, please see +the master distribution +directory or, preferably, its mirror.

+

+ + Mirror +

+

You are currently using [preferred]. If you encounter a +problem with this mirror, please select another mirror. If all +mirrors are failing, there are backup mirrors (at the end of +the mirrors list) that should be available.

+
+Other mirrors: + +
+

+ + Current Antlib Releases +

+
+
Note
+
Very recent releases may not be available on all +mirrors for a few days.
+
+
+
+
Tar files may require gnu tar to extract
+
Tar files in the distribution contain long file names, and may + require gnu tar to do the extraction.
+
+ +

+ + Old Antlib Releases +

+

Older releases of Ant Libraries can be found here. +We highly recommend to not use those releases but upgrade to the latest releases.

+

+ + Verify Releases +

+

It is essential that you verify the integrity of the downloaded +files using the PGP signature or the SHA1 or MD5 checksums. The +checksums are not as strong indicators as the PGP signature.

+

The PGP signatures can be verified using PGP or GPG. First +download the KEYS +as well as the asc signature file for the particular +distribution. Make sure you get these files from the main distribution +directory, rather than from a mirror. Then verify the signatures +using

+

+% pgpk -a KEYS
+% pgpv apache-ant-dotnet-1.0-bin.tar.gz.asc
+ +or
+ +% pgp -ka KEYS
+% pgp apache-ant-dotnet-1.0-bin.tar.gz.asc
+ +or
+ +% gpg --import KEYS
+% gpg --verify apache-ant-dotnet-1.0-bin.tar.gz.asc +

+

Alternatively, you can verify the checksums on the files. Unix +programs called md5/sha1 or +md5sum/sha1sum are included in many unix +distributions. *sum is also available as part of GNU +Textutils. Windows users can get binary md5 programs from here, here. fsum supports MD5 and +SHA1.

+

We highly recommend to verify the PGP signature, though.

+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antlibs/svn/index.html b/tools/apache-ant-1.8.2/docs/antlibs/svn/index.html new file mode 100644 index 000000000..d35014011 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antlibs/svn/index.html @@ -0,0 +1,235 @@ + + + + + + + + + Apache Ant - Apache Subversion Ant Library + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Subversion Ant Library

+

+ + Idea +

+

The main purpose of this Apache Ant library is to provide the same + level of support that Ant provides for CVS. This means the + tasks are wrappers on top of the command line client (read: you + still need to install an svn client) and there is not much more + than running the executable and creating some reports.

+

If you are looking for projects that aim at more, there are + better alternatives, for example Subclipse's Ant + task or JavaSVN.

+

+ + Tasks +

+

+ + svn +

+

A very thin layer on top of the command line executable, + comparable to the CVS + task.

+

+ + changelog +

+

Creates a log of change comments between two revisions, + comparable to CvsChangeLog.

+

+ + *diff +

+

<tagdiff> creates a differences report + for the changes between two tags or branches.

+

<revisiondiff> creates a differences report + for the changes between two revisions.

+

Together comparable to CvsTagDiff.

+

+ + Examples +

+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/antnews.html b/tools/apache-ant-1.8.2/docs/antnews.html new file mode 100644 index 000000000..2a4371756 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/antnews.html @@ -0,0 +1,763 @@ + + + + + + + + + Apache Ant - Apache Ant™ Project News + + + + + + + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Apache Ant™ Project News

+

+ + Apache Ant 1.8.2 +

+

December 27th, 2010 - Apache Ant 1.8.2 Released

+

Apache Ant 1.8.2 is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/bindownload.cgi.

+

Key features of the 1.8.2 release are

+
    +
  • performance improvements in directory scanning
    • +
  • XSLT task honors classpath again (bugrep 49271)
    • +
  • distinction between core tasks and optional tasks is abolished
    • +
  • numerous bug fixes and improvements as documented in Bugzilla + and in WHATSNEW
    • +
+

+ + Apache Ivy 2.2.0 +

+

September 30, 2010 - Apache Ivy 2.2.0 Released

+

Apache Ivy 2.2.0 is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/ivy/download.cgi.

+

Key features of the 2.2.0 release are

+
    +
  • enhanced Maven2 compatibility, with several bug fixes and + more pom features covered
    • +
  • new parent mechanism for Ivy files
    • +
  • improved pom generation from an ivy.xml file
    • +
  • automated PGP signature generation when uploading artifacts
    • +
  • numerous bug fixes and improvements as documented in Jira + and in the release notes
    • +
+

For more information see + the Ivy home page.

+

+ + Apache Ant 1.8.1 +

+

May 7th, 2010 - Apache Ant 1.8.1 Released

+

Apache Ant 1.8.1 is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/bindownload.cgi.

+

Key features of the 1.8.1 release are

+
    +
  • new task augment allows to add attributes or nested elements to previously defined references
    • +
  • numerous bug fixes and improvements as documented in Bugzilla + and in WHATSNEW
    • +
+

+ + Apache Ant 1.8.0 +

+

Februrary 8th, 2010 - Apache Ant 1.8.0 Released

+

Key features of the 1.8.0 release are

+
    +
  • Lexically scoped local properties, i.e. properties that are only defined inside a target, + sequential block or similar environment. This is very useful inside + of <macrodef>s where a macro can now define a temporary property + that will disappear once the task has finished.
    • +
  • <import> can now import from any file- or URL-providing resource - + this includes <javaresource>. + This means <import> can read build file snippets from JARs or fixed server URLs. + There are several other improvements in the area of import.
    • +
  • Various improvements to the directory scanning code that help with symbolic link + cycles (as can be found on MacOS X Java installations for example) and improve + scanning performance. For big directory trees the improvement is + dramatic.
    • +
  • The way developers can extend Ant's property expansion algorithm has been rewritten + (breaking the older API) to be easier to use and be more powerful. + The whole local properties mechanism is implemented using that API and could be + implemented in a separate library without changes in Ant's core. + Things like the yet-to-be-released props Antlib can now provide often required + "scripty" fuctions without touching Ant itself. + At the same time the if and unless attributes have been rewritten to do the expected + thing if applied to a property expansion (i.e. if="${foo}" will mean "yes, do it" + if ${foo} expands to true, in Ant 1.7.1 it would mean "no" unless a property named + "true" existed). This adds "testing conditions" as a new use-case to property + expansion.
    • +
  • A new top-level element <extension-point> assists in writing re-usable + build files that are meant to be imported. <extension-point> has a name + and a dependency-list like <target> and can be used like a <target> + from the command line or a dependency-list but the importing build file can add + targets to the <extension-point>'s depends list.
    • +
  • Ant now requires Java 1.4 or later
    • +
  • new task include provides an alternative to <import> that + should be preferred when you don't want to override any targets
    • +
  • numerous bug fixes and improvements as documented in Bugzilla + and in WHATSNEW
    • +
+

+ + Apache Ivy 2.1.0 +

+

October 8, 2009 - Apache Ivy 2.1.0 Released

+

Key features of the 2.1.0 release are

+
    +
  • enhanced Maven2 compatibility, with several bug fixes and + more pom features covered
    • +
  • new options for the Ivy Ant tasks and commandline
    • +
  • configuration intersections and configuration groups
    • +
  • numerous bug fixes and improvements as documented in Jira + and in the release notes
    • +
+

For more information see + the Ivy home page.

+

+ + Apache IvyDE 2.0.0 +

+

July 13, 2009 - Apache IvyDE 2.0.0 Released

+

Apache IvyDE 2.0.0 is now available for download from + http://ant.apache.org/ivy/ivyde/download.cgi + or directly from the updatesite + http://www.apache.org/dist/ant/ivyde/updatesite +

+

This is the first release considered as stable since the project as been hosted + by the Apache Software Foundation.

+

Major changes in this release:

+
    +
  • the "resolve in workspace" feature (make IvyDE search for Ivy dependencies +directly into the Eclipse projects) has been introduced in the last release +but was quite experimental. It has been refactored to be more reliable and +have been reported to be working like a charm by some of the IvyDE early users.
    • +
  • the user documentation of IvyDE is now available directly into the Eclipse help center.
    • +
  • IvyDE can now load property files along with the Ivy settings.
    • +
+

For more information see + the IvyDE home page.

+

+ + Apache Ivy 2.0.0 +

+

January 20, 2009 - Apache Ivy 2.0.0 Released

+

Apache Ivy 2.0.0 (final) is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/ivy/download.cgi.

+

This is the first non-beta release of Ivy under Apache and includes some major new features + like: enhanced Maven2 compatibility, improved cache management, improved concurrency support + and numerous bug fixes and other improvements.

+

For more information see the Ivy home page.

+

+ + Apache AntUnit 1.1 +

+

September 26, 2008 - Apache AntUnit 1.1 Released

+

Apache AntUnit 1.1 is now available for download as binary + or source + release.

+

In addition to a few bugfixes and some new assertions AntUnit + 1.1 allows test listeners to receive the log output of the + project under test. Both plainlistener and xmllistener have + an option that makes them echo the project's output into their + respective logs.

+

For more information see the Antlib's + home page

+

+ + Apache AntUnit 1.1 Beta 1 +

+

September 3, 2008 - Apache AntUnit 1.1 Beta 1 Available

+

+ + Apache Ant 1.7.1 +

+

June 27, 2008 - Apache Ant 1.7.1 Available

+

Apache Ant 1.7.1 is now available for download.

+

Ant 1.7.1 is mainly a bugfix release.

+

Ant 1.7.1 has extended support for Java6 features.

+

Ant 1.7.1 <script> now has support for JavaFX.

+

+ + Apache Ivy is an Ant Sub-Project Now! +

+

October 11, 2007 - Apache Ivy is an Ant Sub-Project Now!

+

Apache Ivy, "A Java based tool for tracking, resolving and + managing project dependencies.", just finished Incubation and has joined + the Ant project. More information will be available from the Ant + site soon.

+

Until we've finished the migration, you can learn more about + Ivy from its Incubator + website.

+

+ + Apache AntUnit 1.0 +

+

January 8, 2007 - Apache AntUnit 1.0 Available

+

Apache AntUnit 1.0 is now available for download.

+

This Ant Library contains tasks to test Ant tasks using Ant + instead of JUnit. For more information see the AntUnit home page.

+

+ + Apache Ant 1.7.0 +

+

December 19, 2006 - Apache Ant 1.7.0 Available

+

Apache Ant 1.7.0 is now available for download.

+

Ant 1.7 introduces a resource framework. Some of the core ant + tasks such as <copy/> are now able to process not only file + system resources but also zip entries, tar entries, paths, ... + Resource collections group resources, and can be further + combined with operators such as union and intersection. This + can be extended by custom resources and custom tasks using resources.

+

+ Ant 1.7 starts outsourcing of optional tasks to Antlibs. + The .NET antlib in preparation will replace the .NET optional tasks which ship in Ant. + Support for the version control system Subversion will be only provided as an antlib to + be released shortly. +

+

Ant 1.7 fixes also a large number of bugs.

+

Ant 1.7 has some initial support for Java6 features.

+

+ + Apache .NET Ant Library 1.0Beta1 +

+

November 6, 2006 - Apache .NET Ant Library 1.0 Available

+

Apache .NET Ant Library 1.0 is now available for download.

+

This Ant Library contains support for tools like NUnit as well + as the "old" .NET tasks of Ant's core. It has been tested + Microsoft's frameworks as well as Mono.

+

For more information see the Antlib's + home page

+

+ + Apache AntUnit 1.0Beta2 +

+

October 29, 2006 - Apache AntUnit 1.0Beta2 Available

+

Apache AntUnit 1.0Beta1 is now available for download.

+

This Ant Library contains tasks to test Ant tasks using Ant + instead of JUnit. For more information see the AntUnit home page.

+

+ + Apache AntUnit 1.0Beta1 +

+

September 22, 2006 - Apache AntUnit 1.0Beta1 Available

+

Apache AntUnit 1.0Beta1 is now available for download.

+

This Ant Library contains tasks to test Ant tasks using Ant + instead of JUnit. For more information see the AntUnit home page.

+

+ + Apache .NET Ant Library 1.0Beta1 +

+

September 13, 2006 - Apache .NET Ant Library 1.0Beta1 Available

+

Apache .NET Ant Library 1.0Beta1 is now available for download.

+

This Ant Library contains support for tools like NUnit as well + as the "old" .NET tasks of Ant's core. It has been tested + Microsoft's frameworks as well as Mono.

+

For more information see the Antlib's + home page

+

+ + Apache Ant 1.6.5 +

+

June 2, 2005 - Apache Ant 1.6.5 Available

+

Apache Ant 1.6.5 is now available for download.

+

This is a bug fix release.

+

+ + Apache Ant 1.6.4 +

+

May 19, 2005 - Apache Ant 1.6.4 Available

+

Apache Ant 1.6.4 is now available for download.

+

This is a bug fix release.

+

+ + Apache Ant 1.6.3 +

+

April 28, 2005 - Apache Ant 1.6.3 Available

+

Apache Ant 1.6.3 is now available for download.

+

There is a large list of fixed bugs and enhancements.

+

Some of the bugs affecting the embedded use of Ant are fixed.

+

+ + Apache Antidote Retired +

+

April 4th, 2005 - The Apache Ant Project Retires Apache Antidote, the + Ant GUI

+

The Antidote subproject was once started to provide a GUI for + Ant at a time where IDE support for Ant was far from usable. + Unfortunately it never attracted a developer community of its + own.

+

At the same time IDE support for Ant has become ubiquitous by + now and there is little reason to have a GUI just for Ant. This + makes it even less likely that volunteers will start to spend time + working on it.

+

Antidote's development has been stalled for years now, despite + some efforts to rejuvenate it by single developers. Therefore the + Ant developers have chosen to retire Antidote.

+

Antidote will no longer be developed by the Ant project; its + CVS module will be shut down.

+

If you are interested in Antidote's sources to learn from or + build on it, you can find snapshots at http://archive.apache.org/ant/antidote/.

+

+ + Apache Ant 1.6.2 +

+

July 16, 2004 - Apache Ant 1.6.2 Available

+

Apache Ant 1.6.2 available for download.

+

Nested elements for namespaced tasks and types may belong to the +Ant default namespace as well as the task's or type's namespace.

+

All exceptions thrown by tasks are now wrapped in a +buildexception giving the location in the buildfile of the task.

+

Ant 1.6.2 fixes a large number of bugs and adds a number of +features which were asked for by users on Bugzilla.

+

+ + Wiki Migration +

+

February 29, 2004

+

The Apache Ant Wiki pages have been migrated to their + new home on the Apache + Wiki farm. +

+

+ + Apache Ant 1.6.1 +

+

February 12, 2004 - Apache Ant 1.6.1 Available

+

Apache Ant 1.6.1 is still available for + download. +

+

The ASF Board has approved the new Apache License 2.0. + For a copy of that license, please see + + http://www.apache.org/licenses/.

+

The Ant 1.6.1 release is delivered with the + Apache License 2.0.

+

Ant 1.6.1 fixes several bugs, most notably the handling + of the default namespace for nested elements.

+

Ant 1.6.1 also introduces initial support for compiling with + Java 1.5.

+

+ + Apache Ant 1.6.0 +

+

December 18, 2003 - Apache Ant 1.6.0 Available

+

Apache Ant 1.6.0 is still available for + download. +

+

As + we've already said in the announcements of Ant 1.5.4, this release + requires JDK 1.2 or later to run.

+

Ant 1.6.0 adds a lot of new features, most prominently support + for XML namespaces as well as a new concept of Ant libraries that + makes use of namespaces to avoid name clashes of custom tasks. + For a longer list of fixed bugs and new features see the release + notes.

+

If you find anything that hasn't been covered in the manual (I bet you +did) or could be explained better, feel free to help us out in the +Wiki.

+

+ + Apache Ant 1.5.4 +

+

August 12, 2003 - Apache Ant 1.5.4 Available

+

Apache Ant 1.5.4 is still available for + download. +

+

This is a minor bugfix release that fixes a problem with the + javah task on JDK 1.4.2 and a couple of bugs in the + Visual Age for Java intergration tasks. If you don't use javah or + VAJ, there is no reason to upgrade.

+
+
Note
+
Ant 1.5.4 is the last release that supports + JDK 1.1. Ant 1.6.0 requires JDK 1.2 or + later. +
+
+

+ + Java Pro 2003 Readers Choice Award +

+ + +

June 11th, 2003: Apache Ant wins a Java Pro readers' choice award

+

+ Ant has won the Java Pro 2003 Readers' Choice Award for +

+

+ Most Valuable Java Deployment Technology. +

+

+ Thanks to Java Pro and all its readers. You can read about + these + awards + at the Java Pro website. +

+

+ + JDJ Editors Choice Award +

+ +

June 2003: Apache Ant wins JDJ Editors' Choice Award

+

+"Ant is the hammer of the Java world: without it, civilization might have progressed, but much more slowly than it has. Ant is one of the most useful build tools I have ever had the pleasure to use." - Joe Ottinger +

+

+ + Apache Ant keeps on winning! +

+ +

June 9th, 2003: Apache Ant wins the JavaWorld Editors' Choice Award

+

+ Ant has won the JavaWorld Editors' Choice Award for +

+

+ Most Useful Java Community-Developed Technology +

+

+ for the second time in a row! Read the + full article -- or jump directly to the bit about + our award :)

+

+ + Apache Ant 1.5.3 +

+

April 9, 2003 - Apache Ant 1.5.3 Available

+

Apache Ant 1.5.3 is still available for + download. +

+

+ + Apache Ant 1.5.2 +

+

March 3, 2003 - Apache Ant 1.5.2 Available!

+

The final version of Ant 1.5.2 is available for + download. + If you have any feedback on this release, feel free to join the + discussion on the dev and user mailing lists. +

+

+ + Apache Ant Top Level Project +

+

November 18, 2002

+

The Apache board created + the Apache Ant top level project. Ant has now migrated from the Jakarta + project into an Apache project of its own. This is primarily an + organizational change and will not affect the technical aspects of + the project. Ant retains a strong association with the Apache + Jakarta project. One effect of this change is that the Ant webpage + is now located at http://ant.apache.org/ +

+

+ + Apache Ant 1.5.1 +

+

October 3, 2002 - Apache Ant 1.5.1 Available !

+

The final version of Ant 1.5.1 is still available for + + download. If you have any feedback on this release, feel free to join the + discussion on the ant-dev and ant-user mailing lists. +

+

+ + Apache Ant 1.5 +

+

July 15, 2002 - Fix for Cygwin problem in wrapper script available

+

The wrapper script of Apache Ant 1.5 needs to be replaced with a new + version for Cygwin users. See the FAQ for details.

+

July 10, 2002 - Apache Ant 1.5 Released!

+

The final version of Ant 1.5 is now available for + + download. If you have any feedback on this release, feel free to join the + discussion on the ant-dev and ant-user mailing lists. +

+

+ + Apache Ant wins again! +

+ +

Apr 29, 2002: Apache Ant wins Software Development magazine's + 2002 Productivity Award.

+

+ Ant has been awarded a 2002 Productivity Award by + Software Development + magazine. Read the + + press release for more information and the full list of winners. +

+

+ + Apache Ant has won! +

+ +

Mar 26, 2002: Apache Ant wins the JavaWorld Editors' Choice + Award

+

+ Ant has won the JavaWorld Editors' Choice Award for + Most Useful Java Community-Developed Technology. + Read the + full article -- or jump directly to the bit about + our award :)

+

+ + Java 1.4 Support +

+

Feb 15, 2002: Java 1.4 Support

+

+ Java 1.4 has now been released by Sun. The latest Apache Ant source supports + the new assert statement in the compiler task via the source + attribute. It also contains a compatibility fix needed for some ant tasks + on Java 1.4 over Windows XP. If you have problems running Ant 1.4.1 on WinXP/Java 1.4, + please use a recent build or compile your own version from the source tree. +

+

+ + See our new logo! +

+

Have a look at our new cool logo!

+

+ + Apache Ant 1.4.1 +

+

11 October 2001 Apache Ant 1.4.1 released !

+

Please visit the + + download area. +

+

+ + Best-Practices Profile of Apache Ant at Sun's Dot-Com Builder +

+

Sun has released an introductory article on Apache Ant on their + Dot-Com Builder site on May 30 2001. See http://dcb.sun.com/practices/profiles/ant.jsp

+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/appendix_e.pdf b/tools/apache-ant-1.8.2/docs/appendix_e.pdf new file mode 100644 index 000000000..81e5aa853 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/appendix_e.pdf differ diff --git a/tools/apache-ant-1.8.2/docs/breadcrumbs.js b/tools/apache-ant-1.8.2/docs/breadcrumbs.js new file mode 100644 index 000000000..8e172c897 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/breadcrumbs.js @@ -0,0 +1,235 @@ +/* + * 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. + * + */ + +/** + * This script, when included in a html file, builds a neat breadcrumb trail + * based on its url. That is, if it doesn't contains bugs (I'm relatively + * sure it does). + * + * Typical usage: + * + * + *@author Leo Simons (main author) + *@author Nicola Ken Barozzi (integration in skin) + *@created July 12, 2002 + *@version 1.0 + */ + +/** + * IE 5 on Mac doesn't know Array.push. + * + * Implement it - courtesy to fritz. + */ +var abc = new Array(); +if (!abc.push) { + Array.prototype.push = function(what){this[this.length]=what} +} + +/* ======================================================================== + CONSTANTS + ======================================================================== */ + +/** + * Two-dimensional array containing extra crumbs to place at the front of + * the trail. Specify first the name of the crumb, then the URI that belongs + * to it. You'll need to modify this for every domain or subdomain where + * you use this script (you can leave it as an empty array if you wish) + */ +var PREPREND_CRUMBS = new Array(); + if(!("apache"=="")){ + PREPREND_CRUMBS.push( new Array( "apache", "http://www.apache.org/" ) ); + } + if(!("xml.apache"=="")){ + PREPREND_CRUMBS.push( new Array( "ant.apache", "http://ant.apache.org/" ) ); + } + if(!(""=="")){ + PREPREND_CRUMBS.push( new Array( "", "" ) ); + } + +/** + * String to include between crumbs: + */ +var DISPLAY_SEPARATOR = " > "; +/** + * String to include at the beginning of the trail + */ +var DISPLAY_PREPREND = ""; +/** + * String to include at the end of the trail + */ +var DISPLAY_POSTPREND = ""; + +/** + * CSS Class to use for a single crumb: + */ +var CSS_CLASS_CRUMB = "breadcrumb"; + +/** + * CSS Class to use for the complete trail: + */ +var CSS_CLASS_TRAIL = "breadcrumbTrail"; + +/** + * CSS Class to use for crumb separator: + */ +var CSS_CLASS_SEPARATOR = "crumbSeparator"; + +/** + * Array of strings containing common file extensions. We use this to + * determine what part of the url to ignore (if it contains one of the + * string specified here, we ignore it). + */ +var FILE_EXTENSIONS = new Array( ".html", ".htm", ".jsp", ".php", ".php3", ".php4" ); + +/** + * String that separates parts of the breadcrumb trail from each other. + * When this is no longer a slash, I'm sure I'll be old and grey. + */ +var PATH_SEPARATOR = "/"; + +/* ======================================================================== + UTILITY FUNCTIONS + ======================================================================== */ +/** + * Capitalize first letter of the provided string and return the modified + * string. + */ +function sentenceCase( string ) +{ + var lower = string.toLowerCase(); + return lower.substr(0,1).toUpperCase() + lower.substr(1); +} + +/** + * Returns an array containing the names of all the directories in the + * current document URL + */ +function getDirectoriesInURL() +{ + var trail = document.location.pathname.split( PATH_SEPARATOR ); + + // check whether last section is a file or a directory + var lastcrumb = trail[trail.length-1]; + for( var i = 0; i < FILE_EXTENSIONS.length; i++ ) + { + if( lastcrumb.indexOf( FILE_EXTENSIONS[i] ) ) + { + // it is, remove it and send results + return trail.slice( 1, trail.length-1 ); + } + } + + // it's not; send the trail unmodified + return trail.slice( 1, trail.length ); +} + +/* ======================================================================== + BREADCRUMB FUNCTIONALITY + ======================================================================== */ +/** + * Return a two-dimensional array describing the breadcrumbs based on the + * array of directories passed in. + */ +function getBreadcrumbs( dirs ) +{ + var prefix = "/"; + var postfix = "/"; + + // the array we will return + var crumbs = new Array(); + + if( dirs != null ) + { + for( var i = 0; i < dirs.length; i++ ) + { + prefix += dirs[i] + postfix; + crumbs.push( new Array( dirs[i], prefix ) ); + } + } + + // preprend the PREPREND_CRUMBS + if(PREPREND_CRUMBS.length > 0 ) + { + return PREPREND_CRUMBS.concat( crumbs ); + } + + return crumbs; +} + +/** + * Return a string containing a simple text breadcrumb trail based on the + * two-dimensional array passed in. + */ +function getCrumbTrail( crumbs ) +{ + var xhtml = DISPLAY_PREPREND; + + for( var i = 0; i < crumbs.length; i++ ) + { + xhtml += ''; + xhtml += sentenceCase( crumbs[i][0] ) + ''; + if( i != (crumbs.length-1) ) + { + xhtml += DISPLAY_SEPARATOR; + } + } + + xhtml += DISPLAY_POSTPREND; + + return xhtml; +} + +/** + * Return a string containing an XHTML breadcrumb trail based on the + * two-dimensional array passed in. + */ +function getCrumbTrailXHTML( crumbs ) +{ + var xhtml = ''; + xhtml += DISPLAY_PREPREND; + + for( var i = 0; i < crumbs.length; i++ ) + { + xhtml += ''; + xhtml += sentenceCase( crumbs[i][0] ) + ''; + if( i != (crumbs.length-1) ) + { + xhtml += '' + DISPLAY_SEPARATOR + ''; + } + } + + xhtml += DISPLAY_POSTPREND; + xhtml += ''; + + return xhtml; +} + +/* ======================================================================== + PRINT BREADCRUMB TRAIL + ======================================================================== */ + +// check if we're local; if so, only print the PREPREND_CRUMBS +if( document.location.href.toLowerCase().indexOf( "http://" ) == -1 ) +{ + document.write( getCrumbTrail( getBreadcrumbs() ) ); +} +else +{ + document.write( getCrumbTrail( getBreadcrumbs( getDirectoriesInURL() ) ) ); +} + diff --git a/tools/apache-ant-1.8.2/docs/bugs.html b/tools/apache-ant-1.8.2/docs/bugs.html new file mode 100644 index 000000000..3e3d6c3f1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/bugs.html @@ -0,0 +1,379 @@ + + + + + + + + + Apache Ant - Bug database + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Bug database

+

+ + Bug Database +

+

+ This page gives you some bookmarks to use the Bugzilla + Apache Bug Database. +

+

+ This link issues.apache.org connects you + to the complete list of Apache Bug Database systems. +

+

+ + Has It Been Reported? +

+

+ If the current nightly build doesn't resolve your problem, it is + possible that someone else has reported the issue. It is time to + look at the bug database. This system is easy to use, and it will + let you search the + currently open and resolved bugs to see if your problem has + already been reported. If your problem has been reported, you can + see whether any of the developers have commented, suggesting + workarounds, or the reason for the bug, etc. Or you may have + information to add (see about creating and modifying bug reports + below), in which case, go right ahead and add the information. + If you don't have any additional information, you may just want + to vote for this bug, and perhaps + add yourself to the CC list to follow the progress + of this bug. +

+

Open Apache Ant bugs by order of priority.

+

Open Apache Ant bugs by number of votes.

+

+ + Filing a Bug Report +

+

+ Please read our document about problems + before deciding that there is an unreported + bug in Apache Ant. +

+

+ You have a few choices at this point. You can send + an email to the user mailing list + to see if + others have encountered your issue and find out how they may + have worked around it. If after some discussion, you feel it + is time to create + a bug report, this is a simple operation in the bug database. + Please try to provide as much information as possible in order + to assist the developers in resolving the bug. Please try to enter + correct values for the various inputs when creating the bug, such + as which version of Ant you are running, and on which platform, + etc. Once the bug is created, you can also add attachments to + the bug report. +

+

+ What information should you include in your bug report? The + easiest bugs to fix are those that are most easily reproducible, + so it is really helpful if you can produce a small test case that + exhibits the problem. In this case, you would attach the build file + and any other files necessary to reproduce the problem, probably + packed together in an archive. If you can't produce a test case, + you should try to include a snippet from your build file and the + relevant sections from the verbose or debug output from Ant. Try + to include the header information where Ant states the version, + the OS and VM information, etc. As debug output is likely to be + very large, it's best to remove any output that is not + relevant. Once the bug is entered into the bug database, you + will be kept informed by email about progress on the bug. If + you receive email asking for further information, please try to + respond, as it will aid in the resolution of your bug. +

+

+ To create the bug report hit this + + link. +

+

+ + Asking for an Enhancement +

+

+ Sometimes, you may find that Ant just doesn't do what you need it + to. It isn't a bug, as such, since Ant is working the way it is + supposed to work. Perhaps it is some additional functionality for + a task that hasn't been thought of yet, or maybe a completely new + task. For these situations, you will + want to raise an enhancement request. Enhancement requests + are managed using the same Apache Bug Database described above. + These are just a different type of bug report. If you look in the + bug database, you will see that one of the severity settings for + a bug is "Enhancement". Just fill the bug report in, + set the severity of the bug to "Enhancement", and + state in the description how you would like to have Ant enhanced. + Again, you should first check whether there are any existing + enhancment requests that cover your needs. If so, just add your + vote to these. +

+

+ + Create an enhancement report + +

+

+ + Fixing the Bug +

+

+ If you aren't satisfied with just filing a bug report, you can + try to find the cause of the problem and provide a fix yourself. + The best way to do that is by working with the latest code from Subversion. + Alternatively, you can work with the source code available from the + + source distributions. If you + are going to tackle the problem at this level, you may want to + discuss some details first on the dev + mailing list. Once you have a fix for the problem, you may submit + the fix as a patch to either the + dev mailing + list, or enter the bug database as described above and attach the + patch to the bug report. Using the bug database has the advantage + of being able to track the progress of your patch. +

+

+ If you have a patch to submit and are sending it to the + dev mailing list, + prefix "[PATCH]" + to your message subject (this is also a good idea for + a subject line in the bug database). + Please include any relevant bug numbers. + Patch files should be created with the -u + option of the + diff or svn diff command. For + example:

+ + diff -u Javac.java.orig Javac.java > javac.diffs

+ + or, if you have source from Subversion:

+ + svn diff Javac.java > javac.diffs

+ + + Note: You should give your patch files meaningful names. + This makes it easier for developers who need to apply a number + of different patch files. +

+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/bylaws.html b/tools/apache-ant-1.8.2/docs/bylaws.html new file mode 100644 index 000000000..3ef36a230 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/bylaws.html @@ -0,0 +1,831 @@ + + + + + + + + + Apache Ant - Project Bylaws + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Project Bylaws

+

+ + Apache Ant™ Project Bylaws +

+

+ This document defines the bylaws under which the Apache Ant project + operates. It defines the roles and responsibilities of the + project, who may vote, how voting works, how conflicts are resolved, + etc. +

+

+ Ant is a project of the + Apache Software + Foundation. The foundation holds the copyright on Apache + code including the code in the Ant codebase. The + foundation FAQ + explains the operation and background of the foundation. +

+

+ Ant is typical of Apache projects in that it operates under a set of + principles, known collectively as the "Apache Way". If you are + new to Apache development, please refer to the + Incubator project + for more information on how Apache projects operate. Note: the + incubator project has only been recently set up and does not yet explain + the Apache Way in great detail. +

+ +

+ + Roles and Responsibilities +

+

+ Apache projects define a set of roles with associated rights and + responsibilities. These roles govern what tasks an individual may perform + within the project. The roles are defined in the following sections +

+ +

+ + Users +

+

+ The most important participants in the project are people who use our + software. The majority of our developers start out as users and guide + their development efforts from the user's perspective. +

+

+ Users contribute to the Apache projects by providing feedback to + developers in the form of bug reports and feature suggestions. As + well, users participate in the Apache community by helping other users + on mailing lists and user support forums. +

+

+ + Developers +

+

+ All of the volunteers who are contributing time, code, documentation, + or resources to the Ant Project. A developer that makes sustained, + welcome contributions to the project may be invited to become a + Committer, though the exact timing of such invitations depends on many + factors. +

+

+ + Committers +

+

+ The project's Committers are responsible for the project's technical + management. All committers have write access to the project's source + repositories. Committers may cast binding votes on any technical + discussion regarding the project. +

+

+ Committer access is by invitation only and must be approved by lazy + consensus of the active PMC members. A Committer is considered emeritus + by their own declaration or by not contributing in any form to the + project for over six months. An emeritus committer may request + reinstatement of commit access from the PMC. Such reinstatement is + subject to lazy consensus of active PMC members. +

+

+ Commit access can be revoked by a unanimous vote of all the active + PMC members (except the committer in question if they are also a PMC member). +

+

+ All Apache committers are required to have a signed Contributor License + Agreement (CLA) on file with the Apache Software Foundation. There is a + Committer FAQ + which provides more details on the requirements for Committers +

+

+ A committer who makes a sustained contribution to the project may be + invited to become a member of the PMC. The form of contribution is + not limited to code. It can also include code review, helping out + users on the mailing lists, documentation, etc. +

+

+ + Project Management Committee +

+

+ The Project Management Committee (PMC) for Apache Ant was created by a + resolution of the board of the Apache + Software Foundation on 18th November 2002. The PMC is + responsible to the board and the ASF for the management and oversight + of the Apache Ant codebase. The responsibilities of the PMC include +

+
    +
  • Deciding what is distributed as products of the Apache Ant project. + In particular all releases must be approved by the PMC +
    • +
  • Maintaining the project's shared resources, including the codebase + repository, mailing lists, websites. +
    • +
  • Speaking on behalf of the project. +
    • +
  • Resolving license disputes regarding products of the project +
    • +
  • Nominating new PMC members and committers +
    • +
  • Maintaining these bylaws and other guidelines of the project +
    • +
+

+ Membership of the PMC is by invitation only and must be approved by a + lazy consensus of active PMC members. A PMC member is considered + "emeritus" by their own declaration or by not contributing in + any form to the project for over six months. An emeritus member may + request reinstatement to the PMC. Such reinstatement is subject to lazy + consensus of the active PMC members. Membership of the PMC can be + revoked by an unanimous vote of all the active PMC members other than + the member in question. +

+

+ The chair of the PMC is appointed by the ASF board. The chair is an + office holder of the Apache Software Foundation (Vice President, + Apache Ant) and has primary responsibility to the board for the + management of the projects within the scope of the Ant PMC. The chair + reports to the board quarterly on developments within the Ant project. + The PMC may consider the position of PMC chair annually and if + supported by 2/3 Majority may recommend a new chair to the board. + Ultimately, however, it is the board's responsibility who it chooses + to appoint as the PMC chair. +

+

+ + Decision Making +

+

+ Within the Ant project, different types of decisions require different + forms of approval. For example, the + previous section describes + several decisions which require "lazy consensus" approval. This + section defines how voting is performed, the types of approvals, and which + types of decision require which type of approval. +

+

+ + Voting +

+

+ Decisions regarding the project are made by votes on the primary project + development mailing list (dev@ant.apache.org). Where necessary, + PMC voting may take place on the private Ant PMC mailing list. + Votes are clearly indicated by subject line starting with [VOTE] or + [PMC-VOTE]. Votes may contain multiple items for approval and these + should be clearly separated. Voting is carried out by replying to the + vote mail. Voting may take four flavours +

+ + + + + + + + + + + + + + + + + +
+ +1 + + + "Yes," "Agree," or "the action should be + performed." In general, this vote also indicates a willingness + on the behalf of the voter in "making it happen" + +
+ +0 + + + This vote indicates a willingness for the action under + consideration to go ahead. The voter, however will not be able + to help. + +
+ -0 + + + This vote indicates that the voter does not, in general, agree with + the proposed action but is not concerned enough to prevent the + action going ahead. + +
+ -1 + + + This is a negative vote. On issues where consensus is required, + this vote counts as a veto. All vetoes must + contain an explanation of why the veto is appropriate. Vetoes with + no explanation are void. It may also be appropriate for a -1 vote + to include an alternative course of action. + +
+

+ All participants in the Ant project are encouraged to show their + agreement with or against a particular action by voting. For technical + decisions, only the votes of active committers are binding. Non binding + votes are still useful for those with binding votes to understand the + perception of an action in the wider Ant community. For PMC decisions, + only the votes of PMC members are binding. +

+

+ Voting can also be applied to changes made to the Ant codebase. These + typically take the form of a veto (-1) in reply to the commit message + sent when the commit is made. +

+

+ + Approvals +

+

+ These are the types of approvals that can be sought. Different actions + require different types of approvals +

+ + + + + + + + + + + + + + + + + + + + + +
+ Consensus + + + For this to pass, all voters with binding votes must vote and there + can be no binding vetoes (-1). Consensus votes are rarely required + due to the impracticality of getting all eligible voters to cast a + vote. + +
+ Lazy Consensus + + + Lazy consensus requires 3 binding +1 votes and no binding vetoes. + +
+ Lazy Majority + + + A lazy majority vote requires 3 binding +1 votes and more binding +1 + votes that -1 votes. + +
+ Lazy Approval + + + An action with lazy approval is implicitly allowed unless a -1 vote + is received, at which time, depending on the type of action, either + lazy majority or lazy consensus approval must be obtained. + +
+ 2/3 Majority + + + Some actions require a 2/3 majority of active committers or PMC + members to pass. Such actions typically affect the foundation + of the project (e.g. adopting a new codebase to replace an existing + product). The higher threshold is designed to ensure such changes + are strongly supported. To pass this vote requires at least 2/3 of + binding vote holders to vote +1 + +
+

+ + Vetoes +

+

+ A valid, binding veto cannot be overruled. If a veto is cast, it must be + accompanied by a valid reason explaining the reasons for the veto. The + validity of a veto, if challenged, can be confirmed by anyone who has + a binding vote. This does not necessarily signify agreement with the + veto - merely that the veto is valid. +

+

+ If you disagree with a valid veto, you must lobby the person casting + the veto to withdraw their veto. If a veto is not withdrawn, the action + that has been vetoed must be reversed in a timely manner. +

+

+ + Actions +

+

+ This section describes the various actions which are undertaken within + the project, the corresponding approval required for that action and + those who have binding votes over the action. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Action + + Description + + Approval + + Binding Votes +
+ Code Change + + + A change made to a codebase of the project and committed + by a committer. This includes source code, documentation, website + content, etc. + + + + Lazy approval and then lazy consensus. + + + + Active committers. + +
+ Release Plan + + + Defines the timetable and actions for a release. The plan also + nominates a Release Manager. + + + + Lazy majority + + + + Active committers + +
+ Product Release + + + When a release of one of the project's products is ready, a vote is + required to accept the release as an official release of the + project. + + + + Lazy Majority + + + + Active PMC members + +
+ Adoption of New Codebase + + +

+ When the codebase for an existing, released product is to be + replaced with an alternative codebase. If such a vote fails to + gain approval, the existing code base will continue. +

+ +

+ This also covers the creation of new sub-projects + within the project +

+ + 		+ + 2/3 majority + + + + Active committers + +
+ New Committer + + + When a new committer is proposed for the project + + + + Lazy consensus + + + + Active PMC members + +
+ New PMC Member + + + When a committer is proposed for the PMC + + + + Lazy consensus + + + + Active PMC members + +
+ Committer Removal + + +

When removal of commit privileges is sought.

+

Note: Such actions will also be referred to the ASF + board by the PMC chair

+ + 		+ + Consensus + + + + Active PMC members (excluding the committer in question if a + member of the PMC). + +
+ PMC Member Removal + + +

When removal of a PMC member is sought.

+

Note: Such actions will also be referred to the + ASF board by the PMC chair

+ + 		+ + Consensus + + + + Active PMC members (excluding the member in question). + +
+

+ + Voting Timeframes +

+

+ Votes are open for a period of 1 week to allow all active voters + time to consider the vote. Votes relating to code changes are not + subject to a strict timetable but should be made as timely as possible. +

+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/contributors.html b/tools/apache-ant-1.8.2/docs/contributors.html new file mode 100644 index 000000000..b10e6aaa9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/contributors.html @@ -0,0 +1,553 @@ + + + + + + + + + Apache Ant - Contributors + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Contributors

+

+ + Project Management Committee +

+

+ + Active Members +

+

+ Bruce Atherton (bruce at callenish.com - http://www.callenish.com/~bruce) +
+Currently a Systems Architect with Avue Technologies, Bruce has been +working with Java since version 1.0a2. He also claims to be one of the first +people to mark up a FAQ with HTML, for a web browser of the distant past +called Cello. +

+

+ Stephane Bailliez
+

+

+ Matt Benson
+

+

+ Stefan Bodewig (stefan.bodewig at freenet.de - + http://stefan.samaflost.de/) +
+

+

+ Dominique Devienne (ddevienne at apache.org) +
+Dominique has been involved non-stop with the Ant user community since +the 1.4 days, trying without success to answer posts as well or as often +as Diane Holt after she left the user list. He is opinionated, always +striving for the best possible design. While at Landmark Graphics, he +designed and implemented large Ant/CppTasks builds for mixed Java/C++ projects. +

+

+ Erik Hatcher (ehatcher at apache.org) +
+Erik is the co-author of +Java Development with Ant and speaks on Ant and other topics at +No Fluff, Just Stuff +symposiums as well as other venues. Erik is the President of +eHatcher Solutions, Inc. +

+

+ Martijn (J.M.) Kruithof (ant at kruithof xs4all nl) +
+Martijn Kruithof is a system engineer working with and on Java products +in a telecommunication network setting. +

+

+ Antoine Levy-Lambert (antoine at apache.org) +
+Antoine is working as a software engineer for +Ariel Partners. +He is specialized in builds and automation of deployment processes. + +

+

+ Steve Loughran
+

+

+ Conor MacNeill (conor at cortexebusiness.com.au) +
+Conor is a senior developer at Cortex eBusiness, where he develops +J2EE based systems. In his spare time he helps with the development of +the Ant build tool. He is also serving as the Chairman of this PMC. +

+

+ Jan Matèrne (jhm at apache.org) +
+Jan is consultant for OOA/D in the computer centre of the government +of Northrhine Westfalia / Germany. +

+

+ Peter Reilly
+

+

+ + Sam Ruby + + (rubys at us.ibm.com) +
+Sam takes a perverse pleasure in integrating disparate things. He is +a member of the PHP group, Apache +XML PMC, Apache +sponsor for the xml-soap subproject +and convener of ECMA TC39 TG3. +

+

+ Magesh Umasankar (umagesh at apache.org) +
+Magesh, President of Metamach Solutions, +an Atlanta-based technology-management consultancy, has recently launched +WinedIn.com for wine-lovers to pair food and wine. +

+

+ Christoph Wilhelms (christoph.wilhelms at t-online.de) +
+Christoph works as software engineer at the world's biggest travel company +TUI. His passion are all UI related things so +at the Ant-Project he takes care of Antidote - the Ant GUI. +

+

+ Kevin Jackson (foamdino at gmail.com)
+

+

+ + Emeritus Members +

+

+ James Duncan Davidson (duncan at x180.net - http://x180.net/) +
+ +By day, Duncan works in the Open Source Program Office at Sun +Microsystems where he helps various Open Source efforts within Sun +"do the right thing". Previously at Sun he was responsible +for the Servlet API Specifications 2.1 and 2.2 as well as the Java API +for XML Parsing 1.0 and was the original author of Tomcat and Ant. He +was one of the rabble-rousers within Sun that helped make the Jakarta +Project a reality and served as the first Chairman of the Jakarta PMC. +

+

+ Diane Holt
+

+

+ Donald Leslie
+

+

+ Costin Monolache
+

+

+ Jon Skeet
+

+

+ + Committers +

+

+ + Active Committers +

+

+ Steve Cohen +

+

+ Jose Alberto Fernandez +

+

+ Jesse Glick (jesse dot glick at sun dot com) +
+Jesse has been using Java since 1998 and joined Sun Microsystems as +part of the company that produced the NetBeans IDE. After discovering +Ant in the 1.2 days, he wrote most of NetBeans' Ant integration. +Recently he has worked on the NetBeans 4.0 project system, based heavily +on Ant as a build tool. +

+

+ Jon Schneider +

+

+ Alexey Solofnenko (trelony at gmail.com)
+

+

+ + Emeritus Committers +

+

+ Preston Bannister
+

+

+ Nick Davis
+

+

+ Darrell DeBoer
+

+

+ Peter Donald (peter at apache.org) +
+ +Peter is an avid java developer who is active in the +Avalon and +Ant projects. +In his spare time he develops a distributed virtual environment +(ie military simulator or 3D game) using java technologies. +

+

+ Danno Ferrin (shemnon at yahoo.com) +
+Danno has been programming in Java since Summer 96. Danno wrote a JSP +engine on his own and released it the very same day Jakarta was +announced at JavaOne. Since then, he decided to join the Jakarta +project in a spirit of co-operation over competition. +

+

+ Simeon H.K. Fitch (simeon.fitch at mseedsoft.com) +
+Simeon is owner of Mustard Seed Software, which specializes in developing +distributed applications and user interfaces for the science, engineering, +and research oriented clients. He is the lead architect and developer for +Antidote, the GUI for Ant. +

+

+ Thomas Haas (tha at whitestein.com) +
+Tom is interested in distributed systems, Java middleware and worked on an +implementation of the JMS specification. At Whitestein Technologies he is +working on bringing software agent technology and J2EE together. +

+

+ + Jason Hunter (jh at servlets.com) +
+Jason is author of "Java Servlet Programming" (O'Reilly) and publisher +of http://www.servlets.com/. +He works at CollabNet. +

+

+ Justyna Horwat (horwat at apache.org) +
+

+

+ Arun Jamwal +
+

+

+ Arnout J. Kuiper (ajkuiper at planet.nl) +
+ +Arnout J. Kuiper is a Java Architect with the Sun Java Center at Sun +Microsystems. His main focus is web-related technologies on the Java +platform (J2EE, XML, ...). +

+

+ Stefano Mazzocchi (stefano at apache.org) +
+Stefano is addicted to software design, Java programming and +open development. In the last 4 years, he has contributed way too much +time to Apache, expecially on JServ, JMeter, Avalon, JAMES, Ant, Cocoon +and helping to bring more projects into Apache-land, such as FOP, Batik, +POI and Xindice. The problem is that he's too picky to be satisfied :-) +

+

+ Glenn McAllister (glenn at somanetworks.com) +
+Glenn McAllister is a software developer at SOMA Networks, was formerly +the same at IBM (plus tech writer plus build guy), and does some writing +on the side for the VADD Technical Journal. +

+

+ Craig McClanahan (Craig.McClanahan at eng.sun.com) +
+Craig was involved in the Apache JServ project, focused on implementing +a next generation architecture and feature set for the core servlet +engine. He has recently joined Sun as technical lead for the servlet +and JSP reference implementation. +

+

+ Adam Murdoch +
+

+

+ Harish Prabhandham (harishp at onebox.com) +
+Harish is an engineer with the J2EE team at Sun, primarily responsible +for implementing security in the J2EE Reference Implementation +(RI). He integrated various technologies including servlet/JSP +implementations from Tomcat into the J2EE RI. These days, he hacks PHP +code during the day. +

+

+ Nico Seessle
+

+

+ Gal Shachor (shachor at il.ibm.com) +
+Gal Shachor is a research staff member at IBM. He wrote his first +Servlet container (ServletExpress) at the beginning of 1997. Later on +ServletExpress (and Gal) merged into WebSphere, and Gal participated +in the development of WebSphere 1, 2 and 3. +

+

+ Jon S. Stevens (jon at collab.net) +
+ +Jon is a Co-Founder of Clear Ink +Corp and recently left to work on Scarab a next generation Open +Source Java Servlet based Issue/Bug tracking system for CollabNet. He is an active developer +of the Apache JServ Servlet +Engine for the Apache Web Server and Co-Author of the Element Construction Set as +well as the web application framework, Turbine. +

+

+ Jesse Stockall
+

+

+ James Todd (jwtodd at pacbell.net) +
+James has developed real time customer oriented apps for roughly 10 +years the last 5 of which have predominately been fully integrated, +front and back, extraNet implementations which have been based on +Apache, Java and Tcl. +

+

+ Anil Vijendran (akv at eng.sun.com) +
+Anil Vijendran is the principal developer of the JSP engine in +Tomcat. He's done some pretty scary things in his past life -- +implementing the CORBA IDL to C++ 2.0 mapping, skydiving, IDL to Java +compilers, Object Databases (SIGSEV, you da man!) for C++, Java ORB +and EJB runtime environments -- in that order. +

+

+ + Logo +

+

Ant's logo is the result of a logo contest, it has been + designed by

+

+ Nick King +
+

+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/external.html b/tools/apache-ant-1.8.2/docs/external.html new file mode 100644 index 000000000..81db13bbb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/external.html @@ -0,0 +1,7561 @@ + + + + + + + + + Apache Ant - External Tools and Tasks + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

External Tools and Tasks

+

+ + External Tools and Tasks +

+

This page lists external resources for Apache Ant: Tasks, Compiler Implementations, + IDE integration + tools, Source Control + Systems, Loggers, you name it. If you've written + something that should be included, please post all relevant + information to one of the mailing lists. For details, see the + FAQ.

+

Nothing listed here is directly supported by the Ant + developers (therefore 'external tools and tasks'), + if you encounter any problems with them, please use + the contact information.

+

+ + Tasks +

+

+ + AJC +

+

AspectJ is an + aspect-oriented extension to Java. This task compiles a + source tree using the AspectJ compiler -- AJC.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 +
+ URL: + + http://www.eclipse.org/aspectj/ +
+ Contact: + + project mailing lists +
+ License: + + Eclipse Public License +
+

+ + Anakia +

+

Actually, Anakia is more than just an Ant task, it is a an + XML transformation tool based on JDOM, Velocity and Ant.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 and later +
+ URL: + + http://velocity.apache.org/anakia/devel/ +
+ Contact: + + Velocity mailing lists +
+ License: + + Apache License 2.0 +
+

+ + Andariel +

+

Andariel is a set of tasks designed to help the generation of HTML + (and other markup languages) pages from Ant. Includes a XPath processor, + an image information retriever, and others.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.4 and newer +
+ URL: + + http://andariel.uworks.net/ +
+ Contact: + + josep DOT rio AT uworks DOT net +
+ License: + + Apache Software License 1.1 +
+

+ + ant4eclipse +

+

ant4eclipse provides a set of Ant tasks to make several + configurations from the Eclipse IDE available in Ant + buildscripts. The tasks are aimed to avoid redundancy between + Eclipse and Ant configurations in order to build small but + powerful build systems for the continuous integration + process

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.1 and higher +
+ URL: + + http://ant4eclipse.sf.net +
+ Contact: + + + ant4eclipse user mailing list + +
+ License: + + Sun Public License +
+

+ + Antcount +

+

Antcount is a set of filters that can be used to gather statistics + from files or resources. It is mainly used for log files analysis. + It allows to:

    +
  • count inputs (lines, strings)
    • +
  • count occurrences of each input
    • +
  • calculate average, max and min values of floats in input
    • +
+ Antcount also includes some useful filters to:
    +
  • stop filtering: read everything but write nothing
    • +
  • echo input to the console or to a file. This allows users to create + several files at once
    • +
  • split the stream in two for parallel processing
    • +
+

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.2 and higher +
+ URL: + + http://antcount.sourceforge.net/ +
+ Contact: + + Patrick Martin +
+ License: + + LGPL +
+

+ + AntDoc +

+

AntDoc is a tool that generates HTML documentation from Ant + buildfiles; the generated HTML is inspired from what javadoc + yields. AntDocGUI offers a simple Ant target launcher named + AntDoc GUI. Ant targets may be launched from the generated + AntDoc HTML pages. Integration to various IDEs is in + progress.

+

AntDoc can be run via an Ant task, AntDoc GUI can be run + via an Ant task, or via a JVM launch.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 and higher +
+ URL: + + http://antdoc.free.fr/ +
+ Contact: + + Edouard Mercier +
+ License: + + Apache Software License 1.1 +
+

+ + AntDoclet +

+

AntDoclet is a tool to automatically generate documentation out of + your Ant Tasks' source code.

+

It is implemented as a Javadoc doclet, and generates reference + documentation and other deliverables from the source code of your + custom Ant Tasks/Types.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6+ (not tested on earlier versions) +
+ URL: + + http://antdoclet.neuroning.com/ +
+ Contact: + + Fernando Dobladez +
+ License: + + GPL +
+

+ + Anteater +

+

Anteater is a set of Ant tasks for the functional testing of websites + and web services (functional testing being; hit a URL and ensure the + response meets certain criteria). Can test HTTP params, response + codes, XPath, regexp and Relax NG expressions. Includes HTML reporting + (based on junitreport) and a hierarchical grouping system for quickly + configuring large test scripts. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://aft.sourceforge.net/ +
+ Contact: + + developer + mailing list +
+ License: + + Apache Software License 1.1 +
+

+ + AntForm +

+

Provides a java/swing form-based input scheme for + configuring ant properties and launching ant targets.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.2. +
+ URL: + + http://antforms.sourceforge.net/ +
+ Contact: + + René Ghosh +
+ License: + + GNU General Public License +
+

+ + Antmerge +

+

Provides simple inheritance between ant files

+

As noted on the website, this project is deprected.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.5. Should work with all versions. +
+ URL: + + http://www.russet.org.uk/antmerge.html +
+ Contact: + + Phillip Lord +
+ License: + + GNU Lesser General Public License +
+

+ + Antomology +

+

Antomology is an analysis tool suite for Ant. It includes:

    +
  • StatisticsListener - an Ant BuildListener which can be used to gather + statistics while an Ant build is executed. Statistics on the targets + and tasks executed are written to the console after the build completes.
    • +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + unknown +
+ URL: + + http://antomology.codehaus.org +
+ Contact: + + contact page +
+ License: + + Apache License V2.0 +
+

+ + AntPrettyBuild +

+

+ Ant Pretty Build is a tool to easily show and run Ant buildfiles directly from + within a browser window. It consists of a single XSL file that will generate, + on the fly, in the browser, from the .xml buildfile, a pretty interface showing + project name, description, properties and targets, etc. sorted or unsorted, + allowing to load/modify/add properties, run the whole project, or run selected + set of targets in a specific order, with the ability to modify logger/logfile, + mode and add more libs or command line arguments. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + All Ant versions +
+ URL: + + Ant Pretty Build Homepage +
+ Contact: + + Charbel BITAR +
+ License: + + Apache License V2.0 +
+

+ + AntRunner +

+

AntRunner is an easy to use and free GUI application for running + Ant build files. It's written for .NET so it should run on any Windows + Platform.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 and newer +
+ URL: + + http://visualdrugs.net/antrunner/ +
+ Contact: + + Andre Fiedler +
+ License: + + GPL +
+

+ + AntSpaces +

+

AntSpaces provides Ant integration with JavaSpaces. This + allows you to coordinate Ant tasks via JavaSpaces, pull out + work units from a JavaSpace for distributed Ant tasks to work + on, and so forth.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + + http://www.oopsconsultancy.com/software/antspaces/ + +
+ Contact: + + antspaces at oopsconsultancy.com +
+ License: + + Apache Software License 1.1 +
+

+ + AntTimerTask +

+

Timer + is task for measuring the time elapsed to complete other + tasks

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 +
+ URL: + + + http://www.jeckle.de/freeStuff/AntTimerTask/index.html + +
+ Contact: + + mario@jeckle.de +
+ License: + + Lesser GNU Public License +
+

+ + Ant Web Start Task +

+

Ant Web Start Task is an Ant task allowing developers to + package a desktop application as a WAR (Web Application + Archive) to be distributed over the net via Java Web Start

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and above +
+ URL: + + http://ant-jnlp-war.sourceforge.net/ +
+ License: + + Apache License 2.0 +
+

+ + AntXtras +

+

A collection of powerful Ant extensions components + organized into five categories: fixture-control, + execution-rules, flow-control, feedback, and helpers.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 +
+ URL: + + AntXtras Home +
+ Contact: + + SSMC +
+ License: + + GNU Lesser General Public License (LGPL 2.1) +
+

+ + Build Number +

+

Build Number is a tool to track software artifacts such as files and automatically assign + proper version/build numbers to them. It ensures that two different artifacts will have different + version/build numbers, but identical artifacts/builds will be assigned the same number. It doesn't + take version management away from you and doesn't replace your build process, but rather plugs + into the process and introduces version/build number governance by defining who is in charge of + which part of version number. With Build Number you are still in charge of the head of the version + number. E.g. you may decide to have 4 numbers in your version (major, minor, interface, implementation) + and you want to manage the two first numbers (major and minor). Build Number will take care of the + tedium of managing the last two numbers (interface and implementation).

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with Ant 1.5.4 and 1.6.5 +
+ URL: + + http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/build-number/ +
+ Contact: + + Project Contact Page +
+ License: + + Commercial +
+

+ + Checkstyle +

+

Checkstyle is a development tool to help programmers write + Java code that adheres to a coding standard. Its purpose is to + automate the process of checking Java code, and to spare + humans of this boring (but important) task.

+

Checkstyle can be run via an Ant task or a command line + utility.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 and later +
+ URL: + + http://checkstyle.sourceforge.net/ +
+ Contact: + + Oliver Burn +
+ License: + + Starting with release 2.0 the license is the GNU + Lesser General Public License. Prior releases were under + the GNU General Public License. +
+

+ + ChownTask +

+

ChownTask is an Ant task to change ownership of files on Unix.

+

Note: As the Sourceforge project site + shows, the last update was on Feb 16 2003. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 and up +
+ URL: + + + http://sourceforge.net/projects/chowntask/ + +
+ Contact: + + Wilfred Springer + +
+ License: + + GNU General Public License +
+

+ + CleanImports +

+

Removes unneeded imports. Formats your import + sections. Flags ambiguous imports.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 and up +
+ URL: + + http://www.cleanimports.tombrus.nl +
+ Contact: + + Tom Brus +
+ License: + + Apache Software License 1.1 +
+

+ + Clover +

+

Clover is an Ant-based Code Coverage tool. It can be used + seamlessly with Ant-based projects. It provides method, + statement, and branch coverage analysis, and has rich + reporting in XML, HTML or via a Swing GUI.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 or greater +
+ URL: + + http://www.cenqua.com/clover/ +
+ Contact: + + clover-support@cenqua.com +
+ License: + + Commercial, free licenses available for open source + projects. +
+

+ + CMSDeploy +

+

CMSDeploy is + an Apache Ant Task to submit files and templates to Vignette + CMS.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 and later +
+ URL: + + http://cmsdeploy.sourceforge.net +
+ Contact: + + masogato@users.sourceforge.net +
+ License: + + GNU Lesser General Public License +
+

+ + Cocoon Task +

+

This task allows the generation of static web pages and + sites using Apache Cocoon in off-line mode.

+

It allows the configuration information for Cocoon to be + included within the Ant build file, and is thus + able to take advantage of Ant properties.

+

The task shares its code with the Cocoon Command Line, which + means that this task will instantly take + advantage of any new functionality added there.

+ + + + + + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.3 and above +
+ URL: + + http://cocoon.apache.org +
+ Documentation: + + http://cocoon.apache.org/2.1/userdocs/offline/ant.html +
+ Contact: + + users at cocoon.apache.org +
+ License: + + Apache License 2.0 +
+

+ + Commons Configuration Ant Task +

+

A set of Ant task that help convert Apache Commons + Configuration property files into build properties, java Enum's + (that are populated at runtime), and any exportable property / + env file desired (e.g., csh, bash, bat, etc.).

+

This project provides the following tasks: +

    +
  • CreateEnumTask: Creates a Java enum based on + commons configuration property files.
    • +
  • ExportPropertiesTask: Exports commons + configuration properties to a external file in a using a + specified format.
    • +
  • LoadPropertiesTask: Loads commons configuration + properties into pre-generated Java enum.
    • +
+

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 and above +
+ URL: + + http://code.google.com/p/commonsconfiganttask/ +
+ Contact: + + ndunn at me.com +
+ License: + + Apache License 2.0 +
+

+ + Configure +

+

Recursive build support (call ant on every package level, + and only build files in that package or in that package and + everything below) with seperation of source and output.

+

The task generates build files in any subdirectory (except + for CVS-directories) for you. Only place one build.xml file in + the top and call target 'setup' or + 'rescan'.

+

As of 2009-03-06 this site was offline due database problems. So we do not know + if this still longer exist. But you could also try Ants own <subant> task.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 and 1.3 +
+ URL: + + http://www.dsdelft.nl/~lemval/ant/ +
+ Contact: + + M.J.P. van Leeuwen +
+ License: + + License derived from Apache Software License 1.1 +
+

+ + CVSGrab +

+

A little CVS client that can be useful when people are + behind corporate firewall that blocks any cvs + communications. It uses the ViewCVS web interface to access + the CVS repository via standard http, and downloads all the + files present in it.

+

It works from the command line or as an Ant task.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 or higher +
+ URL: + + http://cvsgrab.sourceforge.net/ +
+ Contact: + + CVSGrab + user mailing list +
+ License: + + LGPL +
+

+ + Dependencies +

+

The dependencies task manages a set of external dependencies which + may be downloaded from a remote repository, + such as ibiblio.org. Uses a local cache to avoid repeated + downloads.

+

Note: While the HttpUnit site is still active, the referenced URL is not available. + You could also try Ivy.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.5.1, should work with 1.4+. +
+ URL: + + http://www.httpunit.org/doc/dependencies.html +
+ Contact: + + Russell Gold +
+ License: + + MIT License +
+

+ + Dependency Finder +

+

Dependency Finder extracts dependencies and OO metrics from + Java class files produced by most Java compilers. It can compute + API differences between versions; no sources needed. It includes + Ant tasks, web, Swing, and command-line interfaces, with XSL + stylesheets for formatting output.

+

You can use it to extract dependencies between packages, classes, + or even methods, or any combination thereof. You can use Perl + regular expressions to filter the information and pinpoint only + what you need. There is even a Web Application version (WAR file) + so a whole group of developers can share a common view.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.5.3, should work with 1.4+. +
+ URL: + + http://depfind.sourceforge.net/ +
+ Contact: + + Jean Tessier +
+ License: + + BSD-like License +
+

+ + Doxygen task +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://ant-doxygen.blogspot.com +
+ Contact: + + Karthik A Kumar +
+ License: + + Apache License 2.0 +
+

+ + DTDDoc +

+

DTDDoc is here to help you to document your DTD's efficiently. It is a + straightforward extension of the javadoc concept to the DTD file format.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + http://dtddoc.sourceforge.net/ +
+ Contact: + + Project Mailing List +
+ License: + + X11 (Open Source) +
+

+ + EnvGen +

+

+ EnvGen is an Ant task for generating + different versions of the same file parameterized for different environments (i.e. + development, test, and production). File generation is done using + FreeMarker, a template engine with a full-featured + templating language. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 or higher (not tested on earlier versions) +
+ URL: + + http://www.basilv.com/software +
+ Contact: + + EnvGen Feedback Page +
+ License: + + GPL +
+

+ + EMMA +

+

EMMA is an open-source toolkit for measuring and reporting + Java code coverage. EMMA distinguishes itself from other tools + by going after a unique feature combination: support large-scale + enterprise software development while keeping individual developers + work fast and iterative at the same time.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + http://emma.sourceforge.net/ +
+ Contact: + + Mailinglist +
+ License: + + Common Public License 1.0 +
+

+ + EPP Task +

+

EPP Task is an easy preprocessor ant task. + The next directives are supported: #ifdef, #ifndef, #else, + #endif and #include.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and higher +
+ URL: + + + http://sourceforge.net/projects/epptask/ +
+ Contact: + + Dmitriy Rykov +
+ License: + + Apache License 2.0 +
+

+ + FMPP +

+

FMPP is a general-purpose text file preprocessor tool that + uses FreeMarker templates. It is particularly designed for + HTML preprocessor, for the generation of complete (static) + homepages: directory structure that contains HTML-s, image + files, etc. But of course it can be used to generate source + code or whatever text files. FMPP is extendable with Java + classes to pull data from any data sources (XML file, + database, etc.) and embed the data into the generated + files.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 +
+ URL: + + http://fmpp.sourceforge.net/ +
+ License: + + BSD License +
+

+ + GenJar +

+

Builds a JAR file based on class dependencies rather than simply the contents of a directory

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 alpha (built after 2001/08/04) and later +
+ URL: + + http://genjar.sourceforge.net/ +
+ Contact: + + Jesse Stockall +
+ License: + + Apache Software License 1.1 +
+

+ + Grand +

+

Grand is a set of tools to create a visual representation of Ant target + dependencies. It works by taking an Ant build file and creating a "dot" file. It + differs from the existing tools by relying on the Ant API rather than XML parsing to + get the dependencies. It includes many advanced features such as filtering or + rendering depending on the target's nature. Also features a SWT based GUI.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 and later +
+ URL: + + http://www.ggtools.net/grand/ +
+ Contact: + + Christophe Labouisse +
+ License: + + BSD License +
+

+ + Greebo +

+

Greebo is an Ant-task for downloading dependency files + (currently only jars) from a network to a specified directory, + much like Maven. It supports multiple local and remote + repositories with either flat or maven-like structures. It can + read the dependency list from a Maven project file, a + maven-like dependency file, or directly from the build.xml + file.

+

Note: As the Sourceforge project site + shows, the last update was on Mar 12 2003 . + You could also try Ivy. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://greebo.sourceforge.net/ +
+ Contact: + + project mailing lists +
+ License: + + Apache Software License 1.1 +
+

+ + GroboUtils CodeCoverage +

+

The CodeCoverage sub-project of GroboUtils provides a 100% + pure Java code coverage tool. It uses pre-execution class file + recompilation, and generates XML files containing the coverage + statistics. It does not require any advanced VM setup to generate + coverage numbers. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 +
+ URL: + + http://groboutils.sourceforge.net/codecoverage/ +
+ Contact: + + project mailing lists +
+ License: + + MIT License +
+

+ + Hammurapi +

+

Java code review tool. Performs automated code + review. Contains 111 inspectors which check different aspects + of code quality including coding standards, EJB, threading, + ...

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with Ant 1.5.x and 1.6.5 +
+ URL: + + http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/hammurapi/index.html +
+ Contact: + + Support adress +
+ License: + +   +
+

+ + HelpStudioAnt +

+

This task allows for HelpStudio projects to be created via Ant.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.0 and later +
+ URL: + + http://helpstudioant.sourceforge.net +
+ License: + + GNU General Public License +
+

+ + IDLDepend +

+

idldepend is a task that (re)generates Java sources to be + created from CORBA/IDL files.

+

It parses the IDL file and determines the Java files that + must be generated, taking in account the modifications that + can happen due to command line parameters. If any of the Java + files are missing or older than the source IDL specification, + it launches the specified compiler. The compilers of Orbacus, + Jacorb, OpenORB, Orbix2k and Sun'JDK distributions are + supported.

+

To speed up the process and avoid unnecesary re-parsing, it + keeps the dependencies in intermediate files. This task does + not launch the javac compiler as well, that is, its output are + Java files and not the final bytecode.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 or later +
+ URL: + + http://www.coderazzi.net/idldepend/ +
+ Contact: + + lu@coderazzi.net +
+ License: + + free source, no license restrictions +
+

+ + Image +

+

Image task generates and transforms images. It exposes the + imaging capability available in Java2D, Java Advanced Imaging, + ImageIO, etc., as set of nested elements.

+

Image transformations such as "resize" + (scale),"overlay" (one image on another), + "border" (add a border), "text" (text on + image), "crop" (a sub-image of a bigger image), + "rotate", "grayscale" (change a color + image to shades of gray).
+ Now it supports transparency (making images translucent), a + bestfit option for Resize, simple support for images within + a security-constraint, a preliminary support (if pjatools.jar + is available) for saving files as GIF and some other fixes.

+

IMPORTANT: You will need the PMIW (Poor Man's Imaging Wrapper) jar + for all the operations and the pjatools jar for GIF encoding/ saving + support.

+

Note: The website encourage the use of Ants internal image tasks. While the development + of these image tasks is stopped the development of the underlying PMIW should occur.

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://www.mullassery.com/software/ANT/ +
+ pmiw jar + + http://www.mullassery.com/software/PMIW/ + (Poor Man's Imaging Wrapper) +
+ pjatools jar + + http://www.eteks.com/pja/en/ + (pjatools for GIF encoding support) +
+ Contact: + + Abey Mullassery +
+ License: + + Apache Software License 1.1 +
+

+ + Importscrubber +

+

Removes unnecessary import statements from a Java source code file.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 +
+ URL: + + http://importscrubber.sourceforge.net/ +
+ Contact: + + Tom Copeland +
+ License: + + LGPL +
+

+ + ImTask +

+

ImTask is a task to allow one to send an Instant + Message. Currently supports yahoo!, AIM, and Jabber

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 or higher +
+ URL: + + http://imtask.sourceforge.net +
+ Contact: + + Jon Madison +
+ License: + + GNU LGPL +
+

+ + Incanto +

+

Ant tasks to provide support for Oracle database tools + (such as SQL*Plus, Import, Export)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 +
+ URL: + + http://incanto.sourceforge.net/ +
+ Contact: + + Alexander Karnstedt +
+ License: + + Apache License, Version 2.0 +
+

+ + IsDirValidator +

+

Checks whether a given directory structure conforms to + certain rules that are defined via nested elements of the + task.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://isvalidator.sourceforge.net/en/isDirValidator.htm +
+ Contact: + + Iñigo Serrano +
+ License: + + GNU General Public License +
+

+ + Ivy +

+

Ivy is a simple yet powerful dependency manager featuring + continuous integration, dependencies of dependencies + management, multiple repositories including ibiblio and high + performance (use of a local cache).

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + 1.5.1 (1.6.5 or 1.7.1 recommended) +
+ URL: + + http://ant.apache.org/ivy/ +
+ Contact: + + ivy-user (at) ant (dot) apache (dot) org [User Mailinglist] +
+ License: + + Apache License 2.0 +
+

+ + J2ME Ant Tasks +

+

There are different sets of tasks to help build Java 2 Platform, Micro + Edition (J2ME) applications.

+
+ + *** Antenna *** +
+

Antenna provides a set of Ant tasks suitable for developing + wireless Java applications targeted at the Mobile Information + Device Profile (MIDP). With Antenna, you can compile, + preverify, package, obfuscate, and run your MIDP applications + (aka MIDlets), manipulate Java Application Descriptor (JAD) + files, as well as convert JAR files to PRC files designed to + run on MIDP for Palm OS. Deployment is supported via a + deployment task and a corresponding HTTP servlet for + Over-the-Air (OTA) provisioning. A small preprocessor allows + to generate different variants of a MIDlet from a single + source.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 or later +
+ URL: + + http://antenna.sourceforge.net/ +
+ Contact: + + Jörg Pleumann +
+ License: + + GNU Lesser General Public License +
+
+ + *** Antic *** +
+

Antic is a freely available task for packaging J2ME + applications. It produces both the Jar and Jad files in a + single step. This allows *all* entries to be correclty set in + the jad file, including the size of the jar file that is + produced. This task has been used and tested extensively with + Sun's Wireless Toolkit and also the Nokia SDK and + emulators.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://www.smartkey.co.uk/tools/antic/antic.html + +
+ Contact: + + smartkey.co.uk +
+ License: + + GNU General Public License +
+
+ + *** Dave's J2ME Tasks *** +
+

This set supports CLDC and the K Virtual Machine (KVM):

+

Note: As the website shows the 'most recent news' is from 18 Apr 2001

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 +
+ URL: + + http://www.dribin.org/dave/j2me_ant/ +
+ Contact: + + Dave Dribin +
+ License: + + Apache Software License 1.1 +
+
+ + *** J2ME Polish *** +
+

J2ME Polish is an Ant-based tool for the creation of + MIDP applications. It covers the whole circle of preprocessing, compiling, + obfuscation, preverifying, packaging and JAD-creation. J2ME Polish is + ideal for creating device optimized applications with its powerful + preprocessing capabilities and the integrated device database. + With J2ME Polish no hardcoded values are needed and the portability of an + application is not sacrificed, even though highly optimized applications are + created from a single source. +
+ It contains a logging framework and an optional MIDP-compatible GUI + which can be designed using the web-standard CSS. With the J2ME Polish GUI + you can even use MIDP/2.0 features on MIDP/1.0 phones. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 or later +
+ URL: + + http://www.j2mepolish.org/ +
+ Contact: + + Enough Software +
+ License: + + GNU General Public License; commercial licenses available +
+
+ + *** Stampysoft's J2ME Tasks *** +
+

And this set works with the J2ME Wireless Toolkit and MIDP + for PalmOS.

+

Note: as the website shows, the 'current release' is from 11/5/2001

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 +
+ URL: + + http://www.jeckels.com/ant/ +
+ Contact: + + Josh Eckels +
+ License: + + MIT License +
+

+ + Jacson +

+

Jacson is a configurable and plugable tool (much like Ant + itself) to create filters for text (line based) files without + programming.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Jacson has been used and tested with 1.5.1, should + work with 1.4+ +
+ URL: + + http://jacson.sourceforge.net/ +
+ Contact: + + jacson-user@lists.sourceforge.de +
+ License: + + GNU Library or Lesser General Public License +
+

+ + Jalopy +

+

An Ant Plug-in for the Java Source Code Formatter + Jalopy.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 (or higher) +
+ URL: + + http://jalopy.sourceforge.net/ +
+ Contact: + + http://jalopy.sf.net/contact.html +
+ License: + + Starting with release 1.0 Beta 6 the license is the + BSD License. Prior releases were under the GNU General + Public License. +
+

+ + JarBundler +

+

JarBundler is a task that generates Mac OS X native Java + Application Bundles. It is fully configurable and can be used + to generate Mac OS X application bundles from any supported + Java platform, making it ideal for targeting multiple + platforms with one build.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + http://www.loomcom.com/jarbundler/ +
+ Contact: + + Seth Morabito +
+ License: + + GNU General Public License +
+

+ + JarPatch +

+

JarPatch is a task that generates a zip file resulting of + the diff between the content of 2 jar files.

+

The resulting diff file can be use as a patch for a + previous installation (just ensure that the generated + patch.zip file is located on the CLASSPATH before the patched + oldJar jar file).

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://norb.dnsalias.org/ant/ +
+ Contact: + + Norbert Barbosa +
+ License: + + LGPL License +
+

+ + Java+ Precompile Task +

+

Java+ is an open source Java preprocessor that adds these + features to any Java compiler:

+
    +
  • Multi-line strings with executable inclusions like Perl + and Ruby. It eliminates the need for JSP or ASP and their + need for Java compilers on deployment servers (a security + concern) while adding no overhead in either space or + time.
    • + +
  • Optionally supports localization by segregating Java+ + strings into ResourceBundle files with invarient keys based + on the hash code of the strings's value. This is handled + automatically and transparently; no intervention is + required.
    • + +
  • Fast. Negligible impact on build times. By default, + skips inputs whose outputs are up to date to avoid + triggering recompilations.
    • + +
  • Pure Java code, portable to any platform, with + graphical, shell and ant interfaces.
    • + +
  • Simple, general, recursive, digraph-driven string + syntax. Digraph characters are user-selectable.
    • +
+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 +
+ URL: + + http://virtualschool.edu/java+/ +
+ Contact: + + Brad Cox +
+ License: + + BSD-like License +
+

+ + Java2Html +

+

There are two different tools both named Java2HTML that + process Java source code and generate syntax highlighted + documentation from it. Both include Ant tasks to run + them.

+

Java2Html library for converting java source files + or snipplets to syntax highlighted html, rtf, tex and + others.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://www.java2html.de/ +
+ Contact: + + java2html@jave.de +
+ License: + + GNU General Public License +
+

Java2HTML is a simple-to-use tool which converts a bunch of + Java Source Code into a colourized and browsable HTML + representation.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + 1.5.1 onwards +
+ URL: + + http://www.java2html.com/java2html_ant_task.html +
+ Contact: + + support@java2html.com +
+ License: + + FreeWare +
+

+ + Javamake +

+

A task to compile Java sources and manage class file + dependencies. Functionality is equivalent to that of standard + Javac and Depend tasks combined, with improved dependency + checking.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 +
+ URL: + + http://www.experimentalstuff.com/Technologies/JavaMake/index.html +
+ Contact: + + Mikhail Dmitriev +
+ License: + + BSD-like License +
+

+ + javarec +

+

Ant tasks that generate record classes for VisualAge for + Java from Cobol copy books.

+

Note: the website shows that the latest version 1.1 is from December 2, 2001

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://glezen.org/javarec/ +
+ Contact: + + Paul Glezen +
+ License: + + Apache Software License 1.1 +
+

+ + JCSC +

+

JCSC is a Java Coding Standard Checker which also features + the generation of some code metrics. It is a command line tool + with an Ant task to scan whole package trees. The result can + viewed in an JavaDoc style web page.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant >= 1.5 +
+ URL: + + http://jcsc.sourceforge.net/ +
+ Contact: + + Ralph Jocham +
+ License: + + GNU General Public License +
+

+ + JDeb +

+

JDeb provides an Ant task and a Maven plugin to create + Debian packages from Java builds in a truly cross platform + manner. Build your Debian packages on any platform that has + Java support. Windows, Linux - it does not require + additional native tools installed.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.7 (not tested on earlier versions) +
+ URL: + + http://vafer.org/projects/jdeb/ +
+ Contact: + + Torsten Curdt +
+ License: + + Apache License 2.0 +
+

+ + Jdiff +

+

A task that generates an HTML report of all the packages, classes, + constructors, methods, and fields which have been removed, added or + changed in any way, including their documentation, when two APIs are + compared.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 +
+ URL: + + + + http://javadiff.sourceforge.net/ +
+ Task Documentation: + + + + (in CVS) +
+ License: + + LGPL +
+

+ + JFlex +

+

JFlex is a lexical analyzer generator (also known as + scanner generator) for Java, written in Java.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://jflex.de/ +
+ Contact: + + jflex-users mailing list +
+ License: + + GNU General Public License (GPL) +
+

+ + JindentTask +

+

JindentTask is a very straightforward wrapping of the + Jindent tool, a vendor code beautifier. It enables to use + Jindent natively from Ant.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 and higher +
+ URL: + + http://the.edouard.mercier.free.fr/Jindent_content.php +
+ Contact: + + Edouard Mercier +
+

+ + Jing Task +

+

Validates XML files against the RELAX NG alternative to XML Schema. + The Jing task for Ant allows you to efficiently validate + multiple files against multiple RELAX NG patterns and integrate + RELAX NG validation with other XML processing.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + + http://www.thaiopensource.com/relaxng/jing-ant.html +
+ License: + + BSD-like +
+

+ + jMetra +

+

jMetra is a tool for collecting code metrics across a + project lifecycle and compiling the results into + JavaDoc-styled documentation to analyze project metrics over + time. jMetra is best utilized by integrating it with your + project's scheduled build process.

+

It works from the command line or using several provided + Ant tasks.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and higher +
+ URL: + + + http://www.jmetra.com/ + +
+ Contact: + + + R Todd Newton + + +
+ License: + + Commercial, free licenses for open source projects and + evaluations. +
+

+ + JMX4Ant +

+

JMX4Ant provides tasks for integration with JMX (Java Management + Extensions). It provides tasks for getting and setting attributes + of MBeans, invoking their methods and much more.

+

Note: As the Sourceforge project site + shows, the last update was on May 28 2003. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and higher +
+ URL: + + + http://jmx4ant.sourceforge.net/ + +
+ Contact: + + + Brian Dueck + +
+ License: + + Apache Software License 1.1 +
+

+ + JNI +

+

+ + JNI is a free toolkit that makes easy work of + integrating Java and C through the Java Native + Interface (JNI). It includes a code generator that + generates both Java "proxy" classes to access C + "peer" classes, and C "proxy" classes to access + Java "peer" classes or interfaces. It also + includes a core library with a simplified JVM + interface as well as "helper" classes to ease + working with the JNI data types. The code + generation is driven by an XML project file that + can be created with the assistance of the GUI + Project Manager. The code generation can be + invoked either from Ant or from the + GUI. Includes a comprehensive printable PDF User + Guide and plenty of examples.

+

Note: As the Sourceforge project site + shows, the last update was on Jan 29 2002. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://jnipp.sf.net/ +
+ Contact: + + Phillip E. Trewhella +
+ License: + + GNU LGPL +
+

+ + JPP +

+

+ JPP is a preprocessor for Ant supporting + many different file types that allows you to include / exclude contents based on + build-time parameters. It is completely invisible to other tools and takes the hassle + out of maintaining customised code or content. It is free, is provided as an Ant task, + and very simple to use. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 +
+ URL: + + http://www.javapreprocessor.com +
+ Contact: + + info@javapreprocessor.com +
+ License: + + Freeware +
+

+ + JReleaseInfo +

+

Sometimes you are interested at runtime to have information + from build time. This may be the build date, a build number or + the version. The JReleaseInfo Ant Task generates a java + source file with getter methods for any desired and provided + properties. Furthermore, it can automatically generate a + viewer (which can e.g. be used as main-class in a library jar + file) that shows the included release information.

+

Note: As the Sourceforge project site + shows, the last update was on Aug 07 2005. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 and later +
+ URL: + + HomePage on SourceForge +
+ Contact: + + Forums/Tracker on SourceForge +
+ License: + + Apache License 2.0 +
+

+ + JRun Ant Tasks +

+

JRun 4 SP1 ships with lib/jrun-ant-tasks.jar, which defines + three Ant tasks: jrun, jrunapp, and jrunjmx. Documentation + for the tasks can be found in JRun under + docs/ant/jrun.html.

+

Note that the service pack must be installed on top of an + existing JRun 4 installation.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 or higher +
+ URL: + + http://www.adobe.com/products/jrun/ +
+ License: + + Commercial +
+

+ + JsDoc Toolkit Ant Task +

+

JsDoc Toolkit is an application, written in JavaScript, for + automatically generating template-formatted, multi-page HTML + (or XML, JSON, or any other text-based) documentation from + commented JavaScript source code.

+

This project is a simple wrapper around the JsDoc Toolkit + documentation program. It gives the user all the command + line options, with the flexibility of using in within an Ant + build file.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.7.0 or higher +
+ URL: + + http://code.google.com/p/jsdoc-toolkit-ant-task/ +
+ Contact: + + Darren Hurley +
+ License: + + Apache License 2.0 +
+

+ + JSMin Ant Task +

+

The JSMin Ant task can be used for the automated minification of javascript files + in your build and deploy processes.

+

JSMin is a filter which removes comments and unnecessary whitespace from javascript + files. It typically reduces filesize by half, resulting in faster downloads.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 or higher +
+ URL: + + http://code.google.com/p/jsmin-ant-task/ +
+ Contact: + + M. Haynes +
+ License: + + Apache License 2.0 +
+

+ + JudoScript Ant Task +

+

The <judoscript> task is an easy way to embed JudoScript + code in the Ant build script. The tag format is quite simple. You can + either embed code directly, or can specify an external JudoScript program + file as the src attribute value. Parameters can be specified + as the params attribute; this is applicable to both embedded + code and external files. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 or higher +
+ URL: + + http://www.judoscript.org/books/judoscript-0.9/chapters/ant.html +
+ Contact: + + James Jianbo Huang +
+ License: + + Lesser GNU Public License +
+

+ + Just4log Ant Task +

+

Just4log is a ant task to optimize JVM bytecode with regards + for Logs ( be it, Log4j, Apache Commons or JDK 1.4 ) + It depends on apache BCEL for Bytecode engineering.

+

Note: As the Sourceforge project site + shows, the last update was on Oct 19 2003. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.2 or higher +
+ URL: + + http://just4log.sourceforge.net +
+ Contact: + + Lucas Bruand +
+ License: + + Apache License 1.1. +
+

+ + Kanaputs +

+

Kanaputs is a parser for java based scripting. It is an + interpreter for Java. With Kanaputs you can use Java as an + interpreted language: no more compilation, each instruction is + executed when you write it. It is a small programmation + language to make script files above Java.

+

Kanaputs Ant Task provides a way to add any kind of + programmatic features in your Ant script. The code you insert + stays OS independent (because Kanaputs uses Java) and is + completely integrated with Ant as you can give Ant properties + to the Kanaputs code and get back the results in other + properties.

+

Moreover, as you can invoke any kind of Java code with + Kanaputs, you can popup windows from your Ant file to ask the + user to do a choice.

+

Note: the website + shows that the latest version 1.4 is from Nov 26, 2004. The mailing archive from + the last few months contains only spam...

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 and above +
+ URL: + + + https://kanaputs.dev.java.net//
+ https://kanaputs.dev.java.net/ant.pdf + +
+ Contact: + + + kfra@dev.java.net + +
+ License: + + Freeware +
+

+ + LaTeX Task +

+

Simple Task to use (PDF)LaTeX, BibTeX, Makeindex and GlossTeX to + create your documentation.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.2 and above +
+ URL: + + + http://www.dokutransdata.de/
+ http://www.dokutransdata.de/ant_latex/ + +
+ Contact: + + + jaloma@dokutransdata.de + +
+ License: + + Freeware +
+

+ + Macker +

+

A build-time architectural testing tool, designed + to maintain clean layering / tiering / modularity. + Macker works against compiled class files, checking + dependencies between classes against a set of + pattern-based access rules you specify for your + project in an XML rules file. Macker doesn't presume + anything about your architecture -- you write the + rules, and Macker keeps you honest about them.

+

Note: As the Sourceforge project site + shows, the last update was on Nov 02 2003. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and higher (1.4 untested but may work) +
+ URL: + + http://innig.net/macker/ +
+ Contact: + + Paul Cantrell +
+ License: + + GNU GPL 2.0 +
+

+ + MakeRunScript +

+

MakeRunScript creates a run script for your application. Even if you are developing on windows, + you can make a run script for *nix and vice versa. If you've used the built-in java task before, you + already know how to use 90% of MakeRunScript.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.7 and higher +
+ URL: + + http://sourceforge.net/projects/makerunscript/ +
+ Contact: + + MakeRunScript forums +
+ License: + + Apache 2.0 +
+

+ + mtxslt +

+

The mtxslt (Multi-XSLT) extends the standard Ant "xslt/style" task + to make it easy to use multiple XSLT engines during the same build. + This is useful for regression testing of XSLT scripts against several + engines.

+

Note: As the Sourceforge project site + shows, the last update was on Oct 16 2002. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://mtxslt.sourceforge.net/ +
+ Contact: + + Anthony B. Coates +
+ License: + + Apache Software License 1.1 +
+

+ + nsd2LaTeX Task +

+

Simple Task to use nsd2ltx to build your Nassi-Shneiderman diagrams.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.2 and above +
+ URL: + + + http://www.dokutransdata.de/
+ http://www.dokutransdata.de/ant_nsd2ltx/ + +
+ Contact: + + + jaloma@dokutransdata.de + +
+ License: + + Freeware +
+

+ + Nurflugel AntScript Visualizer +

+

The Nurflugel AntScript Visualizer takes your build file, + finds any imported build files, and shows all relationships + between targets, taskdefs, macrodefs, Ant and Antcalls; output + options include PDF, SVG, and PNG. Many options including + grouping by build file, inclusion/exclusion of targets, + taskdefs, imports, etc. Installation is via Java WebStart, so + you'll always have the freshest version available.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.1 and later +
+ URL: + + http://www.nurflugel.com/webstart/AntScriptVisualizer/ +
+ Contact: + + dbullard <at> nurflugel <dot> com (email + will receive a challenge to weed out spam) +
+ License: + + GNU General Public License +
+

+ + Orangevolt Ant Tasks +

+

Orangevolt ANT Tasks is a collection of Tasks for Apache + Ant.

+

The Orangevolt Ant Tasks collections provides a bunch of + Appplication Deployment related Tasks from windows specific + tasks (registry access, executable generation), *nix specific + tasks (kde/gnome shortcut generation) to many useful utility + tasks like jnlp generation.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 or above +
+ URL: + + http://sourceforge.net/projects/ovanttasks +
+ Contact: + + info@roxes.com +
+ License: + + GNU General Public License (GPL) +
+

+ + pack +

+

pack is a task to build the smallest possible JAR to link + and run one or more classes.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://sadun-util.sourceforge.net/pack.html +
+ Contact: + + Cristiano Sadun +
+ License: + + GNU Lesser General Public License +
+

+ + PCT +

+

PCT is a task to compile Progress code, and in a more general + way, to deal with Progress procedures and databases.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://pct.sourceforge.net +
+ Contact: + + Gilles QUERRET +
+ Licence: + + Apache License 2.0 +
+

+ + PesterCat Ant Toolkit +

+

PesterCat is a web testing tool that was designed to + perform functional testing for web applications. The PesterCat + Ant Toolkit contains tasks to playback test scripts and create + HTML reports. +

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 and later +
+ URL: + + http://www.pestercat.com/ +
+ License: + + Commercial +
+

+ + PMD +

+

PMD checks Java source code for unused variables, + unnecessary object creation, etc

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and higher +
+ URL: + + http://pmd.sf.net/ +
+ Contact: + + Tom Copeland +
+ License: + + BSD style license +
+

+ + PRes +

+

PRes is short for Property Resources and will generate a Java source + file from name=value pair .property files which can be compiled like any + other class.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later (may work with earlier) +
+ URL: + + http://mseries.sourceforge.net +
+ Contact: + + MSeries +
+ License: + + LGPL +
+

+ + ProGuard +

+

ProGuard is + a free Java class file shrinker and obfuscator. It can detect + and remove unused classes, fields, methods, and attributes. It + can then rename the remaining classes, fields, and methods + using short meaningless names.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.5. Should work with all versions. +
+ URL: + + + http://proguard.sourceforge.net/ + +
+ Contact: + + + Feedback Page + +
+ License: + + GNU General Public License +
+

+ + properties2java +

+

Properties2Java is an Ant task for automatic conversion of + java ".properties" files to ".java" files extending the + java.util.ListResourceBundle.

+

Note: As the Sourceforge project site + shows, the last update was on Jun 04 2005. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 or above +
+ URL: + + http://properties2java.jayefem.de/ +
+ Contact: + + Jan-Friedrich Mutter +
+ License: + + Apache License 2.0 +
+

+ + Purge +

+

Purge deletes all but the most recent few files from a fileset. + For example: if you have generated files (logs, .ear, .war, .jar + etc) accumulating in a directory, the purge task will allow you + to delete the older files, keeping just the most recent ones.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 or above +
+ URL: + + http://www.dallaway.com/ant/ +
+ Contact: + + Richard Dallaway +
+ License: + + LGPL +
+

+ + RefactorIT +

+

RefactorIT includes an Ant task for metrics and audits. + RefactorIT is a Java refactoring, audit and metrics tool. + It plugs into major Java IDEs, also runs stand-alone with + a GUI and a command line interface.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://www.refactorit.com/ +
+ Contact: + + support@refactorit.com +
+ License: + + Commercial. (Free for accredited open source products, see + http://www.refactorit.com/osc.) +
+

+ + Reflectant Task +

+

This is a task for reflection invocation from within ant build file.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 or above +
+ URL: + + http://sourceforge.net/projects/reflectant/ +
+ Contact: + + sv_ant@mail.bg +
+ License: + + Apache License 2.0 +
+

+ + rundoc +

+

A task designed to help with the single-sourcing of program + documentation. Rundoc replaces special commands + (in the format @@rundoc:command param1 param2...@@) embedded + within text files with their output in a + specified format. Currently, only Docbook format is supported.

+

Rundoc was written to keep sample code output in program + documentation synchronized with the actual output + of the current code, by running the referenced code when the + documentation is built.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.6 Should work with all versions. +
+ URL: + + http://www.martiansoftware.com/lab/index.html#rundoc +
+ Contact: + + Marty Lamb +
+ License: + + Revised BSD +
+

+ + SerialVer +

+

SerialVer adds the Java serialver functionality to Apache + Ant. This project adds Tasks and FilterReaders to get, to + insert and to modify the serialVersionUID in the source code + of a serializable class.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 and later +
+ URL: + + http://serialver.sourceforge.net/ +
+ Contact: + + developer mailing list +
+ License: + + Apache Software License 1.1 +
+

+ + Simian +

+

Simian (Similarity Analyser) identifies duplication in Java, + C#, C, CPP, COBOL, JSP, HTML source code and even plain text files.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 and later +
+ URL: + + + http://www.redhillconsulting.com.au/products/simian/ +
+ Contact: + + + simian-user-subscribe@redhillconsulting.com.au (User Mailinglist) + +
+ License: + + Commercial, Free Licenses available for Non-Commercial Projects +
+

+ + SmartAnalyzer +

+

Powerful analysis of dependencies between Java classes. + Only affected classes will be recompiled and it can be used + with any bytecode compiler.

+

Note: As the Sourceforge project site + shows, the last update was on Feb 21 2003. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Apache Ant version 1.5.1 +
+ URL: + + http://smartanalyzer.sourceforge.net/ +
+ Contact: + + support at sourceforge project page +
+ License: + + GNU General Public Licence (GPL) +
+

+ + snip +

+

A task designed to help with the single-sourcing of program documentation. + Snip extracts snippets of text from files, placing them into properties in the Ant project. + These properties can then be used by any other Ant task, and are particularly useful when + referenced by <filter>s within the <copy> task.

+

Snip was originally written to keep snippets of sample code in API documentation synchronized + with the actual sample classes.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with 1.5.1. Should work with all versions. +
+ URL: + + http://www.martiansoftware.com/lab/index.html#snip +
+ Contact: + + Marty Lamb +
+ License: + + Revised BSD +
+

+ + spell +

+

Website is gone and nothing found.

+

+ + SQL Compiler (SQLC) +

+

SQL Compiler (SQLC) compiles database metadata and SQL statements into data access and data transfer classes.

+

Note: It seems that the product is renamed to jIncarnate.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with Ant 1.5.4 and 1.6.5 +
+ URL: + + http://www.hammurapi.biz/products/sqlc +
+ Contact: + + Project Contact Page +
+ License: + + LGPL +
+

+ + SQLUnit +

+

SQLUnit is a regression and unit testing harness for testing + database stored procedures. The test suite is written as an XML file. + The SQLUnit harness itself is written in Java and uses the JUnit unit + testing framework to convert the XML test specifications to JDBC calls + and compare the results generated from the calls with the specified + results. It also provides the <sqlunit> task to run the tests + from a build script.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with Ant 1.6 +
+ URL: + + http://sqlunit.sourceforge.net +
+ Contact: + + Project forums +
+ License: + + GNU General Public License (GPL) +
+

+ + Styler +

+

The styler task makes useful combinations of XSLT transformations + easy to specify in an Ant build file. Like the built-in Ant task + style, styler can apply a single transformation to a set of XML files. + But it can also:

+
    +
  • handle multiple transformations, in parallel or pipelined.
    • +
  • enable transformations that split or merge files
    • +
  • process non-XML files, especially HTML (based on JTidy)
    • +
  • apply non-XSLT transformation, especially "regular + fragmentations"
    • +
  • use any custom XMLReader or XMLFilter class to handle new file + formats and transformation techniques.
    • +
+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://www.langdale.com.au/styler/ +
+ Contact: + + Arnold deVos +
+ License: + + LGPL +
+

+ + Syntax +

+

Transforms source files into HTML documents with syntax + highlighting. It can handle a variety of source files + including Java, HTML, C/C++, SQL, and Java properties. Colors + for elements are specified using cascading style sheets. The + output can be templated for easy integration with a site's + look and feel.

+

A very short look into the scm + shows that the last modifications where in 2003.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 +
+ URL: + + http://ostermiller.org/syntax/ant.html +
+ Contact: + + Stephen Ostermiller +
+ License: + + GNU General Public License (GPL) +
+

+ + TestSetGenerator +

+

The TestSetGenerator is an ant task for generating property files with + testsets based on the results of SQL queries and validation plug-ins. Very + usefull when building unit tests that make use of changing datasets. This + task is an extension of the Ant SQL task. Hsqldb is used for both the + examples and the unittests.

+

Note: As the Sourceforge project site + shows, the last update was on Jan 04 2004. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + ANT 1.4 (or later) +
+ URL: + + http://anttestsetgen.sourceforge.net/ +
+ Contact: + + m.c.jansen@planet.nl +
+ License: + + GPL +
+

+ + TiniAnt +

+

TiniAnt is an Ant task to support building applications for + the TINI.

+

Note: As the Sourceforge project site + shows, the last update was on Mar 05 2002. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 to 1.4.1 +
+ URL: + + http://tiniant.sourceforge.net/ +
+ Contact: + + Sean Kelly +
+ License: + + BSD-like license +
+

+ + Transformica +

+

Transformica is a versatile and extensible code generator. + Supports multiple source models including database metadata, Java source files, grammar + files and custom models. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Tested with Ant 1.5.x and 1.6.5 +
+ URL: + + http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/transformica/ +
+ Contact: + + email support +
+ License: + +   +
+

+ + Version_Tool +

+

A versioning tool for Ant.

+

Note: As the Sourceforge project site + shows, the last update was on Feb 19 2004. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 +
+ URL: + + http://ant.ryangrier.com/ +
+ Contact: + + version_tool@ryangrier.com +
+ License: + + BSD license +
+

+ + VPP +

+

VPP provides general file preprocessing support based on + the Velocity Template Engine. The core functionality is + provided as a filter for use with tasks that supports filter + chains. Also included are replacement tasks for <copy> and + <javac> that integrate support for preprocessing.

+

Note: As the Sourceforge project site + shows, the last update was on May 06 2004. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + 1.5.1 and above +
+ URL: + + http://vpp.sourceforge.net/ +
+ Contact: + + vpp-user@lists.sourceforge.net +
+ License: + + BSD license +
+

+ + WOProject +

+

WOProject provides a set of tools to work with + WebObjects 5.1 + independent from platform and IDE. It significantly + improves developer productivity + and makes complex project structures more flexible compared to + traditional Makefile-based approach. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://objectstyle.org/woproject/ +
+ Contact: + + Andrus Adamchik +
+ License: + + Apache license +
+

+ + WSDLValidate +

+

WSDLValidate is, as it sounds, a tool to validate WSDL files.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 or later +
+ URL: + + http://www.eclipse.org/webtools/ +
+ Contact: + + Project newsgroup and mailing list +
+ License: + + Common Public + License (CPL) +
+

+ + Xcluder +

+

xcluder is an XML Inclusions (XInclude) task for Apache Ant. + Offers the choice of using Xerces or Elliotte Rusty Harold's XOM API. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 or later. XInclude compliance depends on the + underlying Xerces or XOM used. Xerces 2.5.0 and above works fine, + but please note that 2.6.1 and 2.6.2 processed the + http://www.w3.org/2003/XInclude, now obsolete by + http://www.w3.org/2001/XInclude used by the latest + Candidate Recommendation (13 April 2004). + +
+ URL: + + http://sourceforge.net/projects/xcluder +
+ Contact: + + mbatsis@users.sf.net +
+ License: + + GNU General Public License (GPL), GNU Library or Lesser + General Public License (LGPL) + +
+

+ + XDoclet +

+

XDoclet is an extended Javadoc Doclet engine for use in Ant. + It lets you create custom Javadoc @tags and based on those tags + generates source code or other files (such as xml-ish deployment + descriptors). Templates and matching tasks are provided to generate + EJB and web application deployment descriptors. +

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 +
+ URL: + + http://sourceforge.net/projects/xdoclet/ +
+ License: + + BSD license +
+

+ + XInclude +

+

XInclude is + a W3C standardized vocabulary for including arbitrary text or XML + documents in other XML documents. This task performes the inclusion + using an existing XInclude implementation

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.2 +
+ URL: + + + http://www.jeckle.de/freeStuff/xia/index.html + +
+ Contact: + + mario@jeckle.de +
+ License: + + Lesser GNU Public License +
+

+ + XML Directory Listing Ant Task +

+

The XML Directory Listing task can recurse through a directory structure and produce an + XML representation. The resulting file can then be transformed further with Ant.

+

The XML output is configurable through various options. The SAX parsing is fast and has a + low memory footprint.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 or higher +
+ URL: + + http://code.google.com/p/xml-dir-listing/ +
+ Contact: + + M. Haynes +
+ License: + + Apache License 2.0 +
+

+ + XMLReleaseNotes (XRN) +

+

This framework is a release notes framework that enables to + generate textual release notes from an XML file. This is an + open framework that enables to integrate the information + coming from VSC and bug tracking solutions, for instance.

+

Note: As the Sourceforge project site + shows, the last update was on Sep 04 2005. (jhm)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://xmlreleasenotes.free.fr/ +
+ Contact: + + Edouard Mercier +
+ License: + + Apache Software License 1.1 +
+

+ + XmlTask +

+

XmlTask provides a simple means to modify XML documents + without having to learn XSLT. A simple path reference to an + XML node specifies the node you want to change, and how you + want to allow XML insertion and removal, or attribute + changes. The emphasis is on providing the simplest means to + perform common XML replacements

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + http://www.oopsconsultancy.com/software/xmltask/ +
+ Contact: + + xmltask-users at lists.sourceforge.net +
+ License: + + Apache Software License 1.1 +
+

+ + yGuard +

+

yGuard is a free Java(TM) Bytecode Obfuscator Task that + needs no external script or project files. It can completely + be configured and run through the Ant build script. The task + supports multiple Jar files at once and makes use of + patternsets and regular expressions to specify elements, which + should be left unobfuscated. Additionally it can be used to + produce patches for obfuscated applications that have already + been deployed.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://www.yworks.com/en/products_yguard_about.htm +
+ Contact: + + yGuard@yWorks.com +
+ License: + + Library: LGPL, Task: Commercial +
+

+ + Zelix KlassMaster +

+

The task ZKMTask allows the Zelix KlassMaster Java obfuscator to be integrated into an Ant build.

+ + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4.1 and later +
+ URL: + + http://www.zelix.com/klassmaster/docs/buildToolApi.html +
+ License: + + Commercial +
+

+ + Build Listeners +

+

+ + AntUtility +

+

+ Wondering why your Ant build is slow? Is your continuous integration server taking too + long to produce your project builds? This project may help. This project includes a small + number of classes for use with Ant that can help you to analyze your build in a + non-intrusive manner. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6 +
+ URL: + + https://antutility.dev.java.net/ +
+ Contact: + + David Green +
+ License: + + Apache + License 2.0 +
+

+ + Compiler Implementations +

+

+ + Generics (JSR14) Early-Access Compiler Adapter +

+

This is an Ant compiler-adapter that allows you to use the + normal <javac> task plus Sun's early-access + compiler to compile Generics-enabled Java code. (This is only + necessary until JDK1.5 is released.)

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + http://www.madbean.com/blog/3/ +
+ Contact: + + Matt Quail <spud[at]madbean[dot]com> +
+ License: + + Public Domain +
+

+ + miniRMI <rmic> implementation +

+

miniRMI is a freeware opensource library that serves as a + lightweight replacement for the original java.rmi packages and + is suitable especially for applets. Ant 1.4+ + <rmic> adapter included.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and later +
+ URL: + + http://dione.zcu.cz/~toman40/miniRMI/ +
+ Contact: + + Petr Toman +
+ License: + + Gnu Lesser Public License +
+

+ + IDE and Editor Integration +

+

+ + AntFarm +

+

A plugin that integrates Ant into the jEdit editor.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + bundles Ant 1.5 +
+ URL: + + http://plugins.jedit.org/plugins/?AntFarm +
+ Contact: + + jEdit developers mailinglist +
+ License: + + GNU General Public License +
+

+ + AntRunner +

+

An OpenTool that integrates Ant into the JBuilder IDE + (version 5 and later).

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 and later +
+ URL: + + http://antrunner.sourceforge.net/ +
+ Contact: + + Dirk Schnelle +
+ License: + + GNU General Public License +
+

+ + CAPlex +

+

CA Plex is an architected RAD tool that combines the techniques of + model-driven development, code generation and patterns to create + business applications for multiple platforms, including Java, .NET and + IBM System i. In its 6.0 release, CA Plex includes integrated support + for building generated Java code with Ant.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.5 +
+ URL: + + http://wiki.plexinfo.net/index.php?title=Customizing_Plex_6.0_ANT_builds +
+ Contact: + + http://www.ca.com/us/products/product.aspx?ID=258 +
+ License: + + Commercial +
+

+ + Eclipse +

+

Eclipse is a universal tool platform with Ant integration.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + + Ant 1.3 and higher
+ Bundles Ant 1.6.2 as of Eclipse 3.0.1 (tested with Ant 1.5.4 - 1.6.2)
+ Eclipse 3.2 bundles Ant 1.6.5
+ Eclipse 3.3 bundles Ant 1.7.0 + +
+ URL: + + + http://www.eclipse.org/ + or + + http://dev.eclipse.org/viewcvs/index.cgi/~checkout~/platform-ant-home/index.html + + +
+ Contact: + + news://news.eclipse.org/eclipse.platform +
+ License: + + Common Public License Version 1.0 +
+

+ + Gel +

+

Java IDE with support for Ant. Gel is a native Microsoft Windows software.

+

Note: The website recommends using another IDE because GEL is not longer maintained.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.4 and above +
+ URL: + + http://www.gexperts.com/products/gel/gel.asp +
+ Contact: + + Project Mailing List +
+ License: + + Freeware +
+

+ + IntelliJ IDEA +

+

Java IDE with refactoring support and Ant integration. + The IDE has special editing and navigation support for Ant. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + bundles Ant 1.6.5 +
+ URL: + + http://www.intellij.com/idea/ +
+ Contact: + + support@intellij.com +
+ License: + + Commercial; Academic and OpenSource licenses available. +
+

+ + JBuilder +

+

Embarcadero JBuilder comes (as Eclipse based product) with built-in Ant support.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Bundles Ant 1.6 +
+ URL: + + http://www.codegear.com/en/products/jbuilder +
+ Contact: + + http://support.codegear.com/en +
+ License: + + Commercial; Turbo JBuilder 2007 is free. +
+

+ + JDEE +

+

The Java Development Environment for Emacs (JDEE) supports + Apache Ant as one of three built-in ways to build your + applications.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.2 and later +
+ URL: + + http://jdee.sourceforge.net/ +
+ Contact: + + JDEE Mailing list. +
+ License: + + GNU General Public License +
+

+ + NetBeans +

+

NetBeans IDE includes integrated Ant support. + This IDE uses Ant as its primary means of building applications, + with custom tasks and an Ant-aware editor.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + bundles 1.8.0 starting with NetBeans 6.9; 1.8.1 for 6.9.1 +
+ URL: + + http://www.netbeans.org/ +
+ Contact: + + nbdev@netbeans.org +
+ License: + + Common Development and Distribution License / GNU General Public License +
+

+ + Optistic IDX Java IDE +

+

Java IDE with deep Ant integration. IDX is a native Microsoft Windows program.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + bundles Ant 1.6 +
+ URL: + + + http://optistic.com/idx + +
+ Contact: + + + support@optistic.com + +
+ License: + + Commercial; Academic and OpenSource licenses available. +
+

+ + Oracle JDeveloper 10i +

+

Java IDE with support for Ant.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5.1 +
+ URL: + + http://www.oracle.com/technology/products/jdev/index.html +
+ Contact: + + JDeveloper Forum +
+ License: + + Commercial +
+

+ + Virtual Ant +

+

+ Instead of manually creating build scripts in XML, Virtual Ant provides a fully virtual file system + where you can run your tasks in real time and see the results. Everything that you do is recorded and + turned into an Ant build script. +

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + + Ant 1.6.5 onwards + +
+ URL: + + + http://www.placidsystems.com/virtualant/ + +
+ Contact: + + + support@placidsystems.com + +
+ License: + + Commercial; OpenSource licenses available too. +
+

+ + WebSphere Studio Application Developer +

+

WSAD features Ant integrate by virtue of being built on the Eclipse tools platform.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + bundles Ant 1.4.1 +
+ URL: + + + http://www.ibm.com/developerworks/websphere/ + +
+ Article: + + Using Ant with WebSphere Studio Application Developer +
+ License: + + Commercial +
+

+ + Source Control Systems +

+

There are several integration with SCM systems. Some are + built in. But some are available as + external libraries. Here a list of task libraries we are aware of:

+

+ + ANT4HG +

+

These are tasks that allow users to access Mercurial + functionality from within Ant build scripts.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.7 and later +
+ URL: + + http://ant4hg.free.fr +
+ Contact: + + ant4hg@free.fr +
+ License: + + GNU Lesser General Public License +
+

+ + clearAntLib +

+

This library is a collection of "value-add" Ant tasks for integrating + IBM Rational ClearCase with Apache Ant. The integration makes full use + of the power and capabilities of Ant, with support for nested elements + (such as filesets) and also supports conditions. There are a number of + tasks for creating XML reports on both ClearCase baselines and labels as + well as a task for "staging" ClearCase objects.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.6.1 and later +
+ URL: + + + http://clearantlib.sourceforge.net/ +
+ Contact: + + Forum +
+ License: + + Apache License 2.0 +
+

+ + Surround SCM +

+

These are tasks that allow users to access Surround SCM + functionality from within Ant build scripts.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.5 and later +
+ URL: + + + Surround SCM Resource Center +
+ Contact: + + Seapine Support +
+ License: + + GNU Lesser General Public License +
+

+ + SvnAnt +

+

SvnAnt is an ant task that provides an interface to Subversion revision control system + that is a compelling replacement for CVS in the open source community.

+ + + + + + + + + + + + + +
+ URL: + + + Subclipse .: :. SvnAnt .: :. SvnClientAdapter +
+ Contact: + + subclipse: Issues and Help +
+ License: + + Eclipse Public License (EPL) 1.0 +
+

+ + Svn4Ant +

+

JWare/AntXtras Svn4Ant (Svn4Ant) is a complete set of native Ant tasks for managing Subversion working copies, + exported directories, and repositories from a build, test, or deployment environment. + Immodestly, Svn4Ant?s goal is to be the best provider of Subversion Ant components.

+ + + + + + + + + + + + + +
+ URL: + + + Svn4Ant +
+ Contact: + + Support - JWare Free Software +
+ License: + + LGPL 2.1 +
+

+ + Loggers +

+

+ + AntStatistics +

+

AntStatistics logs execution times for + all build targets and displays them at the end of the build. Furthermore execution times of + past builds are collected and graphed in a chart.

+ + + + + + + + + + + + + + + + + +
+ Compatibility: + + Ant 1.3 +
+ URL: + + http://code.google.com/p/antstatistics/ +
+ Contact: + + issue tracker +
+ License: + + Apache License 2.0 +
+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/faq.html b/tools/apache-ant-1.8.2/docs/faq.html new file mode 100644 index 000000000..0ef115dba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/faq.html @@ -0,0 +1,2284 @@ + + + + + + + + + Apache Ant - Frequently Asked Questions + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Frequently Asked Questions

+ +

Questions

+

About this FAQ

+ +

General

+ +

Installation

+ +

How do I ...

+ +

It doesn't work (as expected)

+ +

Apache Ant and IDEs/Editors

+ +

Advanced Issues

+ +

Known Problems

+ + +

Answers

+

+ + Where do I find the latest version of this + document? +

+

The latest version can always be found at Apache Ant's homepage + http://ant.apache.org/faq.html.

+

+ + How can I contribute to this FAQ? +

+

The page you are looking it is generated from + this + document. If you want to add a new question, please submit + a patch against this document to one of Ant's mailing lists; + hopefully, the structure is self-explanatory.

+

If you don't know how to create a patch, see the patches + section of this + page.

+

+ + How do you create the HTML version of this + FAQ? +

+

We use + Anakia + to render the HTML version from the original XML file.

+

The Velocity stylesheets used to process the XML files can + be found in the xdocs/stylesheets subdirectory of + Ant's SVN repository - the build file + docs.xml at the top level of the ant SVN + module (trunk) is used to drive Anakia.

+

To transform the xml into html, one needs velocity 1.4. + The command to run is :

+

+ ant -Dvelocity.dir=[installation path of velocity] -f docs.xml +

+

+ + What is Apache Ant? +

+

Ant is a Java-based build tool. In theory, it is kind of + like Make, without Make's wrinkles and with the full + portability of pure Java code.

+

+ + Why do you call it Ant? +

+

According to Ant's original author, James Duncan + Davidson, the name is an acronym for "Another Neat + Tool".

+

Later explanations go along the lines of "ants + do an extremely good job at building things", or + "ants are very small and can carry a weight dozens of times + their own" - describing what Ant is intended to + be.

+

+ + Tell us a little bit about Ant's history. +

+

Initially, Ant was part of the Tomcat code base, when it was + donated to the Apache Software Foundation. It was + created by James Duncan Davidson, who is also the original + author of Tomcat. Ant was there to build Tomcat, nothing + else.

+

Soon thereafter, several open source Java projects realized + that Ant could solve the problems they had with Makefiles. + Starting with the projects hosted at Jakarta and the old Java + Apache project, Ant spread like a virus and is now the build + tool of choice for a lot of projects.

+

In January 2000, Ant was moved to a separate CVS module and + was promoted to a project of its own, independent of + Tomcat, and became Apache Ant.

+

The first version of Ant that was exposed to a larger audience + was the one that shipped with Tomcat's 3.1 release on 19 April + 2000. This version has later been referred to as Ant + 0.3.1.

+

The first official release of Ant as a stand-alone product was + Ant 1.1, released on 19 July 2000. The complete release + history:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Ant Version + + Release Date +
+ 1.1 + + 19 July 2000 +
+ 1.2 + + 24 October 2000 +
+ 1.3 + + 3 March 2001 +
+ 1.4 + + 3 September 2001 +
+ 1.4.1 + + 11 October 2001 +
+ 1.5 + + 10 July 2002 +
+ 1.5.1 + + 3 October 2002 +
+ 1.5.2 + + 3 March 2003 +
+ 1.5.3 + + 9 April 2003 +
+ 1.5.4 + + 12 August 2003 +
+ 1.6.0 + + 18 December 2003 +
+ 1.6.1 + + 12 February 2004 +
+ 1.6.2 + + 16 July 2004 +
+ 1.6.3 + + 28 April 2005 +
+ 1.6.4 + + 19 May 2005 +
+ 1.6.5 + + 2 June 2005 +
+ 1.7.0 + + 19 December 2006 +
+ 1.7.1 + + 27 June 2008 +
+ 1.8.0 + + 8 February 2010 +
+ 1.8.1 + + 7 May 2010 +
+ 1.8.2 + + 27 December 2010 +
+

+ + Which version of Java is required to run + Apache Ant? +

+

You will need Java installed on your system, version 1.4 or + later required, 1.5 or later strongly recommended. The later + the version of Java, the more Ant tasks you get.

+

If only the JRE is present but not a full JDK then many + tasks will not work.

+

The following table lists the minimum Java versions + required to compile and run Ant. Note that most committers + work with more recent versions of the JDK and that Ant doesn't + get tested much for older versions.

+ + + + + + + + + + + + + + + + + + + + + +
+ Ant Version + + Minimum Java Version +
+ 1.1 up to 1.5.4 + + 1.1 +
+ 1.6.0 up to 1.6.5 + + 1.2 +
+ 1.7.0 up to 1.7.1 + + 1.3 +
+ 1.8.0 up to current svn trunk + + 1.4 +
+

+ + I get checksum errors when I try to extract the + tar.gz distribution file. Why? +

+

Ant's distribution contains file names that are longer + than 100 characters, which is not supported by the standard + tar file format. Several different implementations of tar use + different and incompatible ways to work around this + restriction.

+

Ant's <tar> task can create tar archives that use + the GNU tar extension, and this has been used when putting + together the distribution. If you are using a different + version of tar (for example, the one shipping with Solaris), + you cannot use it to extract the archive.

+

The solution is to either install GNU tar, which can be + found here, + or use the zip archive instead (you can extract it using + jar xf).

+

+ + How do you get ant-1.6.x (or any version later than + 1.5.2) to work on on RedHat ES 3? +

+

Redhat ES 3.0 comes installed with ant 1.5.2. Even if you + have your PATH and ANT_HOME variables set correctly to a later + version of ant, you will always be forced to use the + preinstalled version.

+

To use a later version of ant on this OS you could do the + following:

+ 
+$ ant -version
+Apache Ant version 1.5.2-23 compiled on November 12 2003
+$ su -
+# rpm -e ant ant-libs
+# exit
+$ hash -r
+$ ant -version
+Apache Ant version 1.6.2 compiled on July 16 2004
+
+

+ + How to I precompile Java Server Pages (JSPs)? +

+

Apache Ant has a built in optional task <jspc> + which was intended for that. But this task is deprecated. + Here the alternative suggested by the manual:

+

Instead of relying on container specific JSP-compilers we suggest deploying + the raw files (*.jsp) and use the container build-in functions: after deploying + run a test suite (e.g. with + Cactus or + HttpUnit) against the deployed web + application. So you'll get then test result and the compiled JSPs.

+

+ + How do I realize os--specific configurations? +

+

The core idea is using property files which name accords to the + os-name. Then simply use the build-in property os.name.

+

For better use you should also provide a file with default values. + But be careful with the correct os-names. For test simply <echo> + the ${os.name} on all machines and you can be sure to use the right + file names.

+ 
+          <property file="${os.name}.properties"/>
+          <property file="default.properties"/>
+
+

+ + How do I add an external task that I've written to the + page "External Tools and Tasks"? +

+

Join and post a message to the dev or user mailing + list (one list is enough), including the following + information:

+
    +
  • the name of the task/tool
    • +
  • a short description of the task/tool
    • +
  • a Compatibility: entry stating with which version(s) of + Ant the tool/task is compatible to
    • +
  • a URL: entry linking to the main page of the tool/task
    • +
  • a Contact: entry containing the email address or the URL + of a webpage for the person or list to contact for issues + related to the tool/task. Note that we'll add a + link on the page, so any email address added there is not + obfuscated and can (and probably will) be abused by robots + harvesting websites for addresses to spam.
    • +
  • a License: entry containing the type of license for the + tool/task
    • +
+

The preferred format for this information is a patch to this + document.

+

If you have written something bigger than a 'simple plugin' to Ant it + may be better to add the link to projects.html. + The procedure to add it is the same. The file to patch is this + document. The syntax of that file is the same.

+

+ + How do I create new tasks? +

+

Apart from a lot of information on using Ant, the + Manual also contains information + on how to extend Ant with new tasks. This information + can be found under "Developing with Ant".

+

Chances are that someone else already created the task you + want to create, it may be wise to see + External Tools and Tasks and + Related Projects first.

+

+ + How do I pass parameters from the command line to my + build file? +

+

Use properties. Using ant + -Dname=value lets you define values for + properties on the Ant command line. These properties can then be + used within your build file as + any normal property: ${name} will put in + value.

+

+ + How can I use Jikes-specific command-line + switches? +

+

A couple of switches are supported via "magic" + properties:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ switch + + property + + default +
+ +E + + build.compiler.emacs + + false == not set +
+ +P + + build.compiler.pedantic + + false == not set +
+ +F + + build.compiler.fulldepend + + false == not set +
+ (Only for Ant < 1.4; replaced by the + nowarn + attribute of the <javac> + task after that.)
-nowarn + 		+ build.compiler.warnings + + true == not set +
+

With Ant >= 1.5, you can also use nested + <compilerarg> elements with the + <javac> task.

+

+ + How do I include a < character in my command-line arguments? +

+

The short answer is "Use: &lt;".

+

The long answer is that this probably won't do what you + want anyway (see the next + section).

+

+ + How do I redirect standard input or standard output + in the <exec> task? +

+

Say you want to redirect the standard output stream of the + m4 command to write to a file, something + like:

+ 
+shell-prompt> m4 foo.m4 > foo
+
+

and try to translate it into

+ 
+<exec executable="m4">
+  <arg value="foo.m4"/>
+  <arg value="&gt;"/>
+  <arg value="foo"/>
+</exec>
+
+

This will not do what you expect. The output redirection is + performed by your shell, not the command itself, so this + should read:

+ 
+<exec executable="/bin/sh">
+  <arg value="-c" />
+  <arg value="m4 foo.m4 &gt; foo" />
+</exec>
+
+

Note that you must use the value attribute of + <arg> in the last element, in order to have + the command passed as a single, quoted argument. Alternatively, + you can use:

+ 
+<exec executable="/bin/sh">
+  <arg line='-c "m4 foo.m4 &gt; foo"'/>
+</exec>
+
+

Note the double-quotes nested inside the single-quotes.

+

+ + How do I execute a batch file or shell script from Ant? +

+

On native Unix systems, you should be able to run shell scripts + directly. On systems running a Unix-type shell (for example, Cygwin + on Windows) execute the (command) shell instead - cmd + for batch files, sh for shell scripts - then pass the + batch file or shell script (plus any arguments to the script) + as a single command, using the /c or + -c switch, respectively. See + the above section + for example <exec> tasks + executing sh. For batch files, use something like:

+ 
+<exec dir="." executable="cmd" os="Windows NT">
+  <arg line="/c test.bat"/>
+</exec>
+
+

+ + I want to execute a particular target only if + multiple conditions are true. +

+

There are actually several answers to this question.

+

If you have only one set and one unset property to test, + you can specify both an if and an unless + attribute for the target, and they will act as if they + are "anded" together.

+

If you are using a version of Ant 1.3 or earlier, the + way to work with all other cases is to chain targets together + to determine the specific state you want to test for.

+

To see how this works, assume you have three properties: + prop1, prop2, and prop3. + You want to test that prop1 and prop2 + are set, and that prop3 is not. If the condition + holds true you want to echo "yes".

+

Here is the implementation in Ant 1.3 and earlier:

+ 
+<target name="cond" depends="cond-if"/>
+
+<target name="cond-if" if="prop1">
+  <antcall target="cond-if-2"/>
+</target>
+
+<target name="cond-if-2" if="prop2">
+  <antcall target="cond-if-3"/>
+</target>
+
+<target name="cond-if-3" unless="prop3">
+  <echo message="yes"/>
+</target>
+
+

Note: <antcall> tasks do not pass + property changes back up to the environment they were called + from, so you wouldn't be able to, for example, set a + result property in the cond-if-3 target, + then do + <echo message="result is ${result}"/> + in the cond target.

+

Starting with Ant 1.4, you can use the + <condition> task.

+ 
+<target name="cond" depends="cond-if,cond-else"/>
+
+<target name="check-cond">
+  <condition property="cond-is-true">
+    <and>
+      <not>
+        <equals arg1="${prop1}" arg2="$${prop1}" />
+      </not>
+      <not>
+        <equals arg1="${prop2}" arg2="$${prop2}" />
+      </not>
+      <equals arg1="${prop3}" arg2="$${prop3}" />
+    </and>
+  </condition>
+</target>
+
+<target name="cond-if" depends="check-cond" if="cond-is-true">
+  <echo message="yes"/>
+</target>
+
+<target name="cond-else" depends="check-cond" unless="cond-is-true">
+  <echo message="no"/>
+</target>
+
+

This version takes advantage of two things:

+
    +
  • If a property a has not been set, + ${a} will evaluate to ${a}.
    • + +
  • To get a literal $ in Ant, you have to + escape it with another $ - this will also break + the special treatment of the ${ sequence.
    • +
+

Because testing for a literal ${property} string + isn't all that readable or easy to understand, + post-1.4.1 Ant introduces the <isset> element + to the <condition> task.

+

Here is the previous example done using + <isset>:

+ 
+<target name="check-cond">
+  <condition property="cond-is-true">
+    <and>
+      <isset property="prop1"/>
+      <isset property="prop2"/>
+      <not>
+        <isset property="prop3"/>
+      </not>
+    </and>
+  </condition>
+</target>
+
+

The last option is to use a scripting language to set the + properties. This can be particularly handy when you need much + finer control than the simple conditions shown here but, of + course, comes with the overhead of adding JAR files to support + the language, to say nothing of the added maintenance in requiring + two languages to implement a single system. See the + + <script> task documentation for more + details.

+

+ + How can I include national characters like German + umlauts in my build file? +

+

You need to tell the XML parser which character encoding + your build file uses, this is done inside the XML + declaration.

+

By default the parser assumes you are using the UTF-8 + encoding instead of your platform's default. For most Western + European countries you should set the encoding to + ISO-8859-1. To do so, make the very first line + of you build file read like

+ 
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+
+

+ + How do I use jar's M switch? + I don't want a MANIFEST. +

+

A JAR archive is a ZIP file, so if you don't want a + MANIFEST you can simply use <zip>.

+

If your file names contain national characters you should + know that Sun's jar utility like Ant's + <jar> uses UTF-8 to encode their names while + <zip> uses your platforms default encoding. + Use the encoding attribute of <zip> if + necessary.

+

+ + How can I do something like <property name="prop" + value="${${anotherprop}}"/> (double expanding the property)? +

+

Without any external help you can not.

+

With <script/>, which needs external libraries, you can do

+ 
+<script language="javascript">
+    propname = project.getProperty("anotherprop");
+    project.setNewProperty("prop", propname);
+</script>
+
+

With AntContrib (external task library) you can do + <propertycopy name="prop" from="${anotherprop}"/>.

+

With Ant 1.6 you can simulate the AntContribs <propertycopy> + and avoid the need of an external library:

+ 
+<macrodef name="propertycopy">
+  <attribute name="name"/>
+  <attribute name="from"/>
+  <sequential>
+    <property name="@{name}" value="${@{from}}"/>
+  </sequential>
+</macrodef>
+
+

With the 'props' antlib (external, but also from Ant) you could + do the dereferencing with ${${anotherprop} - not just + in the property task - instead everywhere in your buildfile (after + registering the required property helper).

+ 
+<propertyhelper>
+  <props:nested />
+</propertyhelper>
+<property name="foo" value="foo.value" />
+<property name="var" value="foo" />
+<echo> ${${var}} = foo.value </echo>
+

+ + How can I delete everything beneath a particular directory, + preserving the directory itself? +

+

Most users who go down this path have no problem figuring out that + <delete includeemptydirs="true" /> will help them. The + seemingly tricky part is preserving the base directory itself, + which Ant includes in the directory scan. Fortunately the answer is simple: +

+ 
+<delete includeemptydirs="true">
+  <fileset dir="dirtokeep" includes="**/*" />
+</delete>
+
+

+ + How can I delete a particular directory, + if and only if it is empty? +

+

Most users who go down this path have no problem figuring + out that + <delete includeemptydirs="true" /> will + help them. The seemingly tricky part is preserving the + non-empty directories, which Ant includes in the directory + scan. Fortunately the answer is simple:

+ 
+<delete includeemptydirs="true">
+  <fileset dir="dirtokeepifnotempty" excludes="**/*" />
+</delete>
+
+

+ + General Advice +

+

There are many reasons why Apache Ant doesn't behave as + expected, not all of them are due to Ant bugs. See our Having Problems? page for hints that + may help pinning down the reasons for your problem.

+

+ + Why does Ant always recompile all my Java files? +

+

In order to find out which files should be compiled, Ant + compares the timestamps of the source files to those of the + resulting .class files. Opening all source files + to find out which package they belong to would be very + inefficient. Instead, Ant expects you to place your + source files in a directory hierarchy that mirrors your + package hierarchy and to point Ant to the root of this + directory tree with the srcdir attribute.

+

Say you have <javac srcdir="src" + destdir="dest"/>. If Ant finds a file + src/a/b/C.java, it expects it to be in package + a.b so that the resulting .class + file is going to be dest/a/b/C.class.

+

If your source-tree directory structure does not match your + package structure, Ant's heuristic won't work, and + it will recompile classes that are up-to-date. Ant is not the + only tool that expects a source-tree layout like this.

+

If you have Java source files that aren't declared to + be part of any package, you can still use the <javac> + task to compile these files correctly - just set the + srcdir and destdir attributes to + the actual directory the source + files live in and the directory the class files should go into, + respectively.

+

+ + I've used a <delete> task to + delete unwanted SourceSafe control files (CVS files, editor + backup files, etc.), but it doesn't seem to work; the files + never get deleted. What's wrong? +

+

This is probably happening because, by default, Ant excludes + SourceSafe control files (vssver.scc) and certain other + files from FileSets.

+

Here's what you probably did:

+ 
+<delete>
+  <fileset dir="${build.src}" includes="**/vssver.scc"/>
+</delete>
+
+

You need to switch off the default exclusions, + and it will work:

+ 
+<delete>
+  <fileset dir="${build.src}" includes="**/vssver.scc"
+           defaultexcludes="no"/>
+</delete>
+
+

For a complete listing of the patterns that are excluded + by default, see the user + manual.

+

+ + I have a target I want to skip if a property is set, + so I have unless="property" as an attribute + of the target, but all the targets this target + depends on are still executed. Why? +

+

The list of dependencies is generated by Ant before any of the + targets are run. This allows dependent targets, such as an + init target, to set properties that can control the + execution of the targets higher in the dependency graph. This + is a good thing.

+

However, when your dependencies break down the + higher-level task + into several smaller steps, this behaviour becomes + counter-intuitive. There are a couple of solutions available: +

+
    +
  1. Put the same condition on each of the dependent targets.
    2. + +
  2. Execute the steps using <antcall>, + instead of specifying them inside the depends + attribute.
    3. +
+

+ + In my <fileset>, I've put in an + <exclude> of all files followed by an + <include> of just the files I want, but it + isn't giving me any files at all. What's wrong? + +

+

The order of the <include> and + <exclude> tags within a <fileset> + is ignored when the FileSet is created. Instead, all of the + <include> elements are processed together, + followed by all of the <exclude> + elements. This means that the <exclude> + elements only apply to the file list produced by the + <include> elements.

+

To get the files you want, focus on just the + <include> patterns that would be necessary + to get them. If you find you need to trim the list that the + <include> elements produce, then use + <exclude> elements.

+

+ + ant failed to build my program via javac + even when I put the needed jars in an external + build.properties file and reference them by + pathelement or classpath refid. +

+

When ant loads properties from an external + file it doesn't touch the value of properties, trailing blanks + will not be trimmed for example.

+

If the value represents a file path, like a jar needed to + compile, the task which requires the value, javac for example + would fail to compile since it can't find the file due to + trailing spaces.

+

+ + Ant creates WAR files with a lower-case + web-inf or JAR files with a lower-case + meta-inf directory. +

+

No it doesn't.

+

You may have seen these lower-case directory names in + WinZIP, but WinZIP is trying to be helpful (and fails). If + WinZIP encounters a filename that is all upper-case, it + assumes it has come from an old DOS box and changes the case to + all lower-case for you.

+

If you extract (or just check) the archive with jar, you + will see that the names have the correct case.

+

With WinZIP (version 8.1 at least), this can be corrected in the + configuration. In the Options/Configuration menu, in the View tab, General + section, check the "Allow all upper case files names" box. The META-INF and + WEB-INF will look correct.

+

+ + I installed Ant 1.6.x and now get + Exception in thread "main" java.lang.NoClassDefFoundError: + + +

+

+ The cause of this is that there is an old version of ant somewhere in the + class path or configuration. +

+

+ A version of this problem happens with jars that are in the classpath + that include an embedded copy of ant classes. + An example of this is some copies of weblogic.jar. +

+

+ One can check if this is the case by doing (on unix/sh): + 

+        unset CLASSPATH
+        ant -version
+
+ +

+

+ + I installed Ant 1.6.x and now get + java.lang.InstantiationException: org.apache.tools.ant.Main + +

+

+ The cause of this is that there is an old version of ant somewhere in the + class path or configuration. +

+

+ A version of this problem may be seen on some linux systems. + Some linux systems (Fedora Core 2 for example), comes with a version + of ant pre-installed. There is a configuration file called + /etc/ant.conf which if present, the ant shell + script will 'dot' include. On Fedora Core 2, the /etc/ant.conf + file resets the ANT_HOME environment variable to + /usr/share/ant. This causes the problem that + an old version of ant (1.5.x in this cause) will be used + with a new version of the ant script file. +

+

+ One can check if this is the case by doing + ant --noconfig -version. +

+

+ + + Whenever I use the Ant jar or manifest related tasks, long lines in + my manifest are wrapped at 70 characters and the resulting jar does + not work in my application server. Why does Ant do this? + +

+

+ Ant implements the Java + Jar + file specification. Please refer to the notes section where it + discusses the maximum allowable length of a line and the concept of + continuation characters. +

+

+ If a jar file produced by Ant does not work in your appserver, and + that failure is due to the wrapped manifest, then you need + to consult your appserver provider, as it is a bug in their + appserver. Far more likely, however, is a problem in your + specification of your classpath. It is not Ant's wrapping of your + classpath that is the problem. +

+

+ Do not raise a bug about this issue until you have checked to ensure + that the problem is not due to your classpath specification. +

+

+ + <exec> fails with "Cannot run + program "...":CreateProcess error=2" on + Windows. +

+

A common problem is not having the executable on the + PATH. In case you get an error message Cannot run + program "...":CreateProcess error=2. The system cannot find + the path specified. have a look at your PATH + variable.

+

Just type the command directly on the command line and if + Windows finds it, Ant should do it too. (Otherwise ask on + the user mailinglist for help.) If Windows can not execute + the program add the directory of the programm to the PATH + (set PATH=%PATH%;dirOfProgram) or specify the + absolute path in the executable attribute in + your buildfile.

+

+ + Is Apache Ant supported by my IDE/Editor? +

+

See the section + on IDE integration on our External Tools and Tasks page.

+

+ + Why doesn't (X)Emacs/vi/MacOS X's project builder + correctly parse the error messages generated by Ant? +

+

Ant adds a "banner" with the name of the current + task in front of all logging messages - and there are no built-in + regular expressions in your editor that would account for + this.

+

You can disable this banner by invoking Ant with the + -emacs switch. To make Ant autodetect + Emacs' compile mode, put this into your + .antrc (contributed by Ville Skyttä).

+ 
+# Detect (X)Emacs compile mode
+if [ "$EMACS" = "t" ] ; then
+  ANT_ARGS="$ANT_ARGS -emacs"
+  ANT_OPTS="$ANT_OPTS -Dbuild.compiler.emacs=true"
+fi
+
+

Alternatively, you can add the following snippet to your + .emacs to make Emacs understand Ant's + output.

+ 
+(require 'compile)
+(setq compilation-error-regexp-alist
+  (append (list
+     ;; works for jikes
+     '("^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):\\([0-9]+\\):[0-9]+:[0-9]+:" 1 2 3)
+     ;; works for javac
+     '("^\\s-*\\[[^]]*\\]\\s-*\\(.+\\):\\([0-9]+\\):" 1 2))
+  compilation-error-regexp-alist))
+
+

Yet another alternative that preserves most of Ant's + formatting is to pipe Ant's output through the following Perl + script by Dirk-Willem van Gulik:

+ 
+#!/usr/bin/perl
+#
+# May 2001 dirkx@apache.org - remove any
+# [foo] lines from the output; keeping
+# spacing more or less there.
+#
+$|=1;
+while(<STDIN>) {
+        if (s/^(\s+)\[(\w+)\]//) {
+                if ($2 ne $last) {
+                        print "$1\[$2\]";
+                        $s = ' ' x length($2);
+                } else {
+                        print "$1 $s ";
+                };
+                $last = $2;
+        };
+        print;
+};
+
+

+ + Is there a DTD that I can use to validate my build + files? +

+

An incomplete DTD can be created by the + <antstructure> task - but this one + has a few problems:

+
    +
  • It doesn't know about required attributes. Only + manual tweaking of this file can help here.
    • + +
  • It is not complete - if you add new tasks via + <taskdef> it won't know about it. See + this + page by Michel Casabianca for a solution to this + problem. Note that the DTD you can download at this page + is based on Apache Ant 0.3.1.
    • + +
  • It may even be an invalid DTD. As Ant allows tasks + writers to define arbitrary elements, name collisions will + happen quite frequently - if your version of Ant contains + the optional <test> and + <junit> tasks, there are two XML + elements named test (the task and the nested child + element of <junit>) with different attribute + lists. This problem cannot be solved; DTDs don't give a + syntax rich enough to support this.
    • +
+

+ + How do I include an XML snippet in my build file? +

+

You can use XML's way of including external files and let + the parser do the job for Ant:

+ 
+<?xml version="1.0"?>
+
+<!DOCTYPE project [
+       <!ENTITY common SYSTEM "common.xml">
+]>
+
+<project name="test" default="test" basedir=".">
+
+  <target name="setup">
+    ...
+  </target>
+
+  &common;
+
+  ...
+
+</project>
+
+

will literally include the contents of common.xml where + you've placed the &common; entity.

+

(The filename common.xml in this example is resolved + relative to the containing XML file by the XML parser. You may also use + an absolute file: protocol URI.)

+

In combination with a DTD, this would look like this:

+ 
+<!DOCTYPE project PUBLIC "-//ANT//DTD project//EN" "ant.dtd" [
+   <!ENTITY include SYSTEM "header.xml">
+]>
+
+

Starting with Ant 1.6, there is a new + <import> task that can (also) be used to + include build file fragments. Unlike the snippets used with + entity includes, the referenced files have to be complete Ant + build files, though.

+

The example above would become:

+ 
+<?xml version="1.0"?>
+<project name="test" default="test" basedir=".">
+
+  <target name="setup">
+    ...
+  </target>
+
+  <import file="./common.xml"/>
+
+  ...
+
+</project>
+
+

Unlike entity includes, <import> will + let you use Ant properties in the file name.

+

+ + How do I send an email with the result of my build + process? +

+

If you are using a nightly build of Ant 1.5 after + 2001-12-14, you can use the built-in MailLogger:

+ 
+         ant -logger org.apache.tools.ant.listener.MailLogger
+
+

See the Listeners + & Loggers documentation for details on the properties + required.

+

For older versions of Ant, you can use a custom + BuildListener that sends out an email + in the buildFinished() method. Will Glozer + <will.glozer@jda.com> has written such a listener based + on JavaMail. + The source is:

+ 
+import java.io.*;
+import java.util.*;
+import javax.mail.*;
+import javax.mail.internet.*;
+import org.apache.tools.ant.*;
+
+/**
+ * A simple listener that waits for a build to finish and sends an email
+ * of the results.  The settings are stored in "monitor.properties" and
+ * are fairly self explanatory.
+ *
+ * @author      Will Glozer
+ * @version     1.05a 09/06/2000
+ */
+public class BuildMonitor implements BuildListener {
+    protected Properties props;
+
+    /**
+     * Create a new BuildMonitor.
+     */
+    public BuildMonitor() throws Exception {
+        props = new Properties();
+        InputStream is = getClass().getResourceAsStream("monitor.properties");
+        props.load(is);
+        is.close();
+    }
+
+    public void buildStarted(BuildEvent e) {
+    }
+
+    /**
+     * Determine the status of the build and the actions to follow, now that
+     * the build has completed.
+     *
+     * @param       e       Event describing the build status.
+     */
+    public void buildFinished(BuildEvent e) {
+        Throwable th = e.getException();
+        String status = (th != null) ? "failed" : "succeeded";
+
+        try {
+            String key = "build." + status;
+            if (props.getProperty(key + ".notify").equalsIgnoreCase("false")) {
+                    return;
+            }
+
+            Session session = Session.getDefaultInstance(props, null);
+
+            MimeMessage message = new MimeMessage(session);
+            message.addRecipients(Message.RecipientType.TO, parseAddresses(
+                props.getProperty(key + ".email.to")));
+            message.setSubject(props.getProperty(key + ".email.subject"));
+
+            BufferedReader br = new BufferedReader(new FileReader(
+                props.getProperty("build.log")));
+            StringWriter sw = new StringWriter();
+
+            String line = br.readLine();
+            while (line != null) {
+                sw.write(line);
+                sw.write("\n");
+                line = br.readLine();
+            }
+            br.close();
+
+            message.setText(sw.toString(), "UTF-8");
+            sw.close();
+
+            Transport transport = session.getTransport();
+            transport.connect();
+            transport.send(message);
+            transport.close();
+        } catch (Exception ex) {
+            System.out.println("BuildMonitor failed to send email!");
+            ex.printStackTrace();
+        }
+    }
+
+    /**
+     * Parse a comma separated list of internet email addresses.
+     *
+     * @param       s       The list of addresses.
+     * @return      Array of Addresses.
+     */
+    protected Address[] parseAddresses(String s) throws Exception {
+        StringTokenizer st = new StringTokenizer(s, ",");
+        Address[] addrs = new Address[st.countTokens()];
+
+        for (int i = 0; i < addrs.length; i++) {
+            addrs[i] = new InternetAddress(st.nextToken());
+        }
+        return addrs;
+    }
+
+    public void messageLogged(BuildEvent e) {
+    }
+
+    public void targetStarted(BuildEvent e) {
+    }
+
+    public void targetFinished(BuildEvent e) {
+    }
+
+    public void taskStarted(BuildEvent e) {
+    }
+
+    public void taskFinished(BuildEvent e) {
+    }
+}
+
+

With a monitor.properties like this:

+ 
+# configuration for build monitor
+
+mail.transport.protocol=smtp
+mail.smtp.host=<host>
+mail.from=Will Glozer <will.glozer@jda.com>
+
+build.log=build.log
+
+build.failed.notify=true
+build.failed.email.to=will.glozer@jda.com
+build.failed.email.subject=Nightly build failed!
+
+build.succeeded.notify=true
+build.succeeded.email.to=will.glozer@jda.com
+build.succeeded.email.subject=Nightly build succeeded!
+
+

monitor.properties should be placed right next + to your compiled BuildMonitor.class. To use it, + invoke Ant like:

+ 
+ant -listener BuildMonitor -logfile build.log
+
+

Make sure that mail.jar from JavaMail and + activation.jar from the + Java + Beans Activation Framework are in your CLASSPATH.

+

+ + How do I get at the properties that Ant was running + with from inside BuildListener? +

+

You can get at a hashtable with all the properties that Ant + has been using through the BuildEvent parameter. For + example:

+ 
+public void buildFinished(BuildEvent e) {
+    Hashtable table = e.getProject().getProperties();
+    String buildpath = (String)table.get("build.path");
+    ...
+}
+
+

This is more accurate than just reading the same property + files that your project does, since it will give the correct + results for properties that were specified on the Ant command line.

+

+ + <exec> causes other tasks to hang + or leads to strange behaviour of <input> + tasks. +

+

When Apache Ant forks a new process for example by using the + <exec>, <apply> + or <java> tasks, it will also start a + new thread reading from standard input and sending + everything that it has read to that process.

+

Unfortunately Ant has no way to know whether the forked + process is ever going to read any input, so it will start such + a thread even if the process doesn't need one.

+

This behaviour leads to strange side effects like the Ant + process + being suspended + when a build forking new process is run as a background + process on Unix-like systems or + <input> + tasks requiring + additional inputs if they come after + an <exec> task.

+

Fortunately there is a workaround for this, always specify + inputstring="" for + any <exec> task (or one of its sibblings) + if you know the forked process doesn't consume any + input.

+

+ + <javac> causes a + StackOverflowError +

+

For some Java source files it is possible + that causes + a StackOverlowError is thrown inside Sun's javac + compiler. As far as we can tell this is not triggered by a + bug in Ant.

+

It is possible to work around this problem by setting + <javac>'s fork attribute to true.

+

+ + Ant 1.7.0 doesn't build from sources without + JUnit +

+

When building Ant 1.7.0 from the source release without + junit.jar the build fails with the message "We cannot build + the test jar unless JUnit is present".

+

With Ant 1.7.0 we've started to add ant-testutil.jar as + part of the distribution and this causes a hard dependency on + JUnit - at least in version 1.7.0. Unfortunately the + installation docs don't say so.

+

There are two workarounds:

+
    + +
  1. Add junit.jar to your CLASSPATH when building Ant.
    2. + +
  2. Change Ant's buildfile and remove test-jar from the + depends list of the dist-lite target.
    3. + +
+

+ + <chmod> or <exec> doesn't work in Ant + 1.3 on Unix +

+

The antRun script in ANT_HOME/bin + has DOS instead of Unix line endings; you must remove the + carriage-return characters from this file. This can be done by + using Ant's <fixcrlf> task + or something like:

+ 
+tr -d '\r' < $ANT_HOME/bin/antRun > /tmp/foo
+mv /tmp/foo $ANT_HOME/bin/antRun
+
+

+ + <style> or <junit> ignores my + <classpath> +

+

Starting with Ant 1.7.0, <junit> will honor your + nested <classpath>.

+

These tasks don't ignore your classpath setting, you + are facing a common problem with delegating classloaders.

+

This question collects a common type of problem: A task + needs an external library and it has a nested classpath + element so that you can point it to this external library, but + that doesn't work unless you put the external library + into the CLASSPATH or place it in + ANT_HOME/lib.

+

Some background is necessary before we can discuss + solutions for Ant + 1.5.x and Ant + 1.6.x.

+

When you specify a nested <classpath> in + Ant, Ant creates a new class loader that uses the path you + have specified. It then tries to load additional classes from + this classloader.

+

In most cases - for example using <style> or + <junit> - Ant doesn't load the external library + directly, it is the loaded class that does so.

+

In the case of <junit> it is the task + implementation itself and in the case of + <style> it is the implementation of the + org.apache.tools.ant.taskdefs.XSLTLiaison + class.

+

As of Ant 1.7 <junit> no longer + requires you to have junit.jar in Ant's startup + classpath even if ant-junit.jar is present there.

+

Ant's class loader implementation uses Java's + delegation model, see http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html + the paragraph

+
The ClassLoader class uses a + delegation model to search for classes and resources. Each + instance of ClassLoader has an associated parent + class loader. When called upon to find a class or resource, a + ClassLoader instance will delegate the search for + the class or resource to its parent class loader before + attempting to find the class or resource itself. The virtual + machine's built-in class loader, called the bootstrap + class loader, does not itself have a parent but may serve as + the parent of a ClassLoader + instance.
+

The possible solutions depend on the version of Ant you + use, see the next sections.

+

+ + <style> or <junit> ignores my + <classpath> - Ant 1.5.x version +

+

Please read the previous + entry before you go ahead.

+

First of all let's state that Ant's wrapper script + (ant or ant.bat) adds all + .jar files from ANT_HOME/lib to + CLASSPATH, therefore "in + CLASSPATH" shall mean "either in your + CLASSPATH environment variable or + ANT_HOME/lib" for the rest of this + answer.

+

The root of the problem is that the class that needs the + external library is on the CLASSPATH.

+

Let's see what happens when you load the <junit> + task. Ant's class loader will consult the + bootstrap class loader first, which tries to load classes from + CLASSPATH. The bootstrap class loader + doesn't know anything about Ant's class loader or + even the path you have specified.

+

If the bootstrap class loader can load the class Ant has + asked it to load (which it can if optional.jar is + part of CLASSPATH), this class will try to load + the external library from CLASSPATH as well - it + doesn't know anything else - and will not find it unless + the library is in CLASSPATH as well.

+

To solve this, you have two major options:

+
    +
  1. put all external libraries you need in + CLASSPATH as well this is not what you want, + otherwise you wouldn't have found this FAQ entry.
    2. + +
  2. remove the class that loads the external library from + the CLASSPATH.
    3. +
+

The easiest way to do this is to remove + optional.jar from ANT_HOME/lib. If + you do so, you will have to <taskdef> all + optional tasks and use nested <classpath> + elements in the <taskdef> tasks that point + to the new location of optional.jar. Also, + don't forget to add the new location of + optional.jar to the + <classpath> of your + <style> or <junit> + task.

+

If you want to avoid to <taskdef> all + optional tasks you need, the only other option is to remove + the classes that should not be loaded via the bootstrap class + loader from optional.jar and put them into a + separate archive. Add this separate archive to the + <classpath> of your + <style> or <junit> task + - and make sure the separate archive is not in + CLASSPATH.

+

In the case of <junit> you'd have + to remove all classes that are in the + org/apache/tools/ant/taskdefs/optional/junit + directory, in the <style> case it is one of + the *Liaison classes in + org/apache/tools/ant/taskdefs/optional.

+

If you use the option to break up optional.jar + for <junit> or remove + ant-junit.jar, you still have to use a + <taskdef> with a nested + <classpath> to define the junit task.

+

+ + <style> or <junit> ignores my + <classpath> - Ant 1.6.x version +

+

Please read the general + entry before you go ahead.

+

The wrapper script of Ant 1.6.x no longer adds the contents + of ANT_HOME/lib to CLASSPATH, + instead Ant will create a classloader on top of the bootstrap + classloader - let's call it the coreloader for the rest of + this answer - which holds the contents of + ANT_HOME/lib. Ant's core and its tasks will be + loaded through this classloader and not the bootstrap + classloader.

+

This causes some small but notable differences between Ant + 1.5.x and 1.6.x. Most importantly, a third-party task that is + part of CLASSPATH will no longer work in Ant + 1.6.x since the task now can't find Ant's classes. In a sense + this is the same problem this entry is about, only + ant.jar has become the external library in + question now.

+

This coreloader also holds the contents of + ~/.ant/lib and any file or directory that has + been specified using Ant's -lib command line + argument.

+

Let's see what happens when you load the <junit> + task. Ant's class loader will consult the bootstrap + class loader first, which tries to load classes from + CLASSPATH. The bootstrap class loader + doesn't know anything about Ant's class loader or + even the path you have specified. If it fails to find the + class using the bootstrap classloader it will try the + coreloader next. Again, the coreloader doesn't know anything + about your path.

+

If the coreloader can load the class Ant has asked it to + load (which it can if ant-junit.jar is in + ANT_HOME/lib), this class will try to load the + external library from coreloader as well - it doesn't + know anything else - and will not find it unless the library + is in CLASSPATH or the coreloader as well.

+

To solve this, you have the following major options:

+
    +
  1. put all external libraries you need in + CLASSPATH as well this is not what you want, + otherwise you wouldn't have found this FAQ entry.
    2. + +
  2. put all external libraries you need in + ANT_HOME/lib or .ant/lib. This + probably still isn't what you want, but you might reconsider + the .ant/lib option.
    3. + +
  3. Always start Ant with the -lib command line + switch and point to your external libraries (or the + directories holding them).
    4. + +
  4. remove the class that loads the external library from + the coreloader.
    5. +
+

In Ant 1.6 optional.jar has been split into + multiple jars, each one containing classes with the same + dependencies on external libraries. You can move the + "offending" jar out of ANT_HOME/lib. For the + <junit> task it would be + ant-junit.jar.

+

If you do so, you will have to <taskdef> + all optional tasks that need the external library and use + nested <classpath> elements in the + <taskdef> tasks that point to the new + location of ant-*.jar. Also, don't forget + to add the new location of ant-*.jar to the + <classpath> of your + <style> or <junit> + task.

+

For example

+ 
+    <taskdef name="junit"
+            class="org.apache.tools.ant.taskdefs.optional.junit.JUnitTask">
+      <classpath>
+        <pathelement location="HOME-OF/junit.jar"/>
+        <pathelement location="NEW-HOME-OF/ant-junit.jar"/>
+      </classpath>
+    </taskdef>
+
+

+ + + Why do my custom task containers see Unknown Elements in Ant 1.6 + - they worked in Ant 1.5? + +

+

+ The objects added in TaskContainer.addTask(Task task) + have changed from Tasks to UnknownElements. +

+

+ There was a number of valid reasons for this change. But the backward + compatibility problems were not noticed until after Ant 1.6.0 was + released. +

+

+ Your container class will need to be modified to check if the Task + is an UnknownElement and call perform on it to + convert it to a Task and to execute it. + (see apache.tools.ant.taskdefs.Sequential) +

+

+ If you want to do more processing on the task, + you need to use the techniques in apache.tools.ant.taskdefs.Antlib#execute() + This does make use of one 1.6 method call (UE#getRealObject()), + you need to use UE#getTask() instead - this will + return null for non tasks (types like fileset id=x). +

+

+ So.. iterate over the tasks, if they are UEs, convert them to + tasks, using UE#maybeConfigure and UE#getTask() +

+ 
+        for (Iterator i = tasks.iterator(); i.hasNext();) {
+           Task t = (Task) i.next();
+           if (t instanceof UnknownElement) {
+              ((UnknownElement) t).maybeConfigure();
+              t = ((UnknownElement) t).getTask();
+              if (t == null) {
+                  continue;
+              }
+           }
+           // .... original Custom code
+        }
+
+

+ This approach should work for ant1.5 and ant1.6. +

+

+ + + Ant runs into an infinite loop/throws an OutOfMemoryError + when I compile my project under Mac OS X. + +

+

Apple's Java VMs reside + in /System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z + and JAVA_HOME will usually be something + like /System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z/Home.

+

Inside this home directory there is a symbolic link + named shared_bundle that links three levels up, + i.e. to /System/Library/Frameworks/JavaVM.framework.

+

If your build file contains a fileset like

+ 
+<fileset dir="${java.home}" includes="**/*.jar"/>
+
+

Ant is going to follow the shared_bundle + symlink and ends up recursing into all your installed VMs. + Even worse, it will + enter /System/Library/Frameworks/JavaVM.framework/Versions/X.Y.Z/Home + and will once again follow the same symlink.

+

Ant versions after Ant 1.7.1 will detect the infinite loop + they are in, but the resulting fileset may still be too big to + deal with, in particular if you have many different VM + versions installed. The problem is amplified by the fact that + each installed version has a shared_bundle + symlink in it.

+

One solution is to not allow the fileset to follow symbolic + links at all, like in

+ 
+<fileset dir="${java.home}" includes="**/*.jar" followsymlinks="false"/>
+
+

another one excludes the shared_bundle + directories:

+ 
+<fileset dir="${java.home}" includes="**/*.jar" excludes="**/shared_bundle/**"/>
+
+

For Ant 1.7.1 and earlier + excluding shared_bundle may not be enough since + there is another symlink bundle that points to + the Home directory and will cause infite + recursions as well.

+

+ + extension-point doesn't work + with import like the documentation + states. +

+

Yes, there is + a bug + in Ant 1.8.0.

+

When using two build files like

+ 
+importing.xml:
+<project>
+   ...
+   <import file="imported.xml"/>
+   <target name="bar" extensionOf="foo"/>
+</project>
+imported.xml:
+<project>
+   <extension-point name="foo"/>
+</project>
+
+

Ant 1.8.0 will fail, claiming there was no extension point + named "foo".

+

This bug has been fixed for Ant 1.8.1. For Ant 1.8.0 there + is + a work-around: + add an additional layer of importing like in

+ 
+importing.xml:
+<project>
+   <target name="bar" extensionOf="foo"/>
+</project>
+imported.xml:
+<project>
+   <extension-point name="foo"/>
+</project>
+build.xml:
+<project>
+   <import file="imported.xml"/>
+   <import file="importing.xml"/>
+</project>
+
+
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/favicon.ico b/tools/apache-ant-1.8.2/docs/favicon.ico new file mode 100644 index 000000000..161bcf784 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/favicon.ico differ diff --git a/tools/apache-ant-1.8.2/docs/images/JDJEditorsChoiceAward.jpg b/tools/apache-ant-1.8.2/docs/images/JDJEditorsChoiceAward.jpg new file mode 100644 index 000000000..5dcb99815 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/JDJEditorsChoiceAward.jpg differ diff --git a/tools/apache-ant-1.8.2/docs/images/ant_logo.ico b/tools/apache-ant-1.8.2/docs/images/ant_logo.ico new file mode 100644 index 000000000..9dbc258f2 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/ant_logo.ico differ diff --git a/tools/apache-ant-1.8.2/docs/images/ant_logo_large.gif b/tools/apache-ant-1.8.2/docs/images/ant_logo_large.gif new file mode 100644 index 000000000..e99363b9f Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/ant_logo_large.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/ant_logo_medium.gif b/tools/apache-ant-1.8.2/docs/images/ant_logo_medium.gif new file mode 100644 index 000000000..44bc07fa2 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/ant_logo_medium.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/ant_logo_small.gif b/tools/apache-ant-1.8.2/docs/images/ant_logo_small.gif new file mode 100644 index 000000000..34080c978 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/ant_logo_small.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/beta.png b/tools/apache-ant-1.8.2/docs/images/beta.png new file mode 100644 index 000000000..924a75d40 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/beta.png differ diff --git a/tools/apache-ant-1.8.2/docs/images/current.gif b/tools/apache-ant-1.8.2/docs/images/current.gif new file mode 100644 index 000000000..af0f64fb2 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/current.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/group-logo.gif b/tools/apache-ant-1.8.2/docs/images/group-logo.gif new file mode 100644 index 000000000..de57d342c Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/group-logo.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/jp_rcwinner_2003.gif b/tools/apache-ant-1.8.2/docs/images/jp_rcwinner_2003.gif new file mode 100644 index 000000000..63d831341 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/jp_rcwinner_2003.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2002.gif b/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2002.gif new file mode 100644 index 000000000..334b1146b Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2002.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2003.gif b/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2003.gif new file mode 100644 index 000000000..dbbb422d8 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/jw_ec_logo_winner2003.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/label.gif b/tools/apache-ant-1.8.2/docs/images/label.gif new file mode 100644 index 000000000..bc4cb5897 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/label.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/menu-left.gif b/tools/apache-ant-1.8.2/docs/images/menu-left.gif new file mode 100644 index 000000000..0ca90471e Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/menu-left.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/menu-right.gif b/tools/apache-ant-1.8.2/docs/images/menu-right.gif new file mode 100644 index 000000000..879c02806 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/menu-right.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/page.gif b/tools/apache-ant-1.8.2/docs/images/page.gif new file mode 100644 index 000000000..b0b394491 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/page.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/printer.gif b/tools/apache-ant-1.8.2/docs/images/printer.gif new file mode 100644 index 000000000..5021187b0 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/printer.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/project-logo.gif b/tools/apache-ant-1.8.2/docs/images/project-logo.gif new file mode 100644 index 000000000..5d9cd7f3a Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/project-logo.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/sdm_productivity_award.gif b/tools/apache-ant-1.8.2/docs/images/sdm_productivity_award.gif new file mode 100644 index 000000000..6d76aa08e Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/sdm_productivity_award.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/search-left.gif b/tools/apache-ant-1.8.2/docs/images/search-left.gif new file mode 100644 index 000000000..cb204461f Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/search-left.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/search-right.gif b/tools/apache-ant-1.8.2/docs/images/search-right.gif new file mode 100644 index 000000000..100557317 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/search-right.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/spacer.gif b/tools/apache-ant-1.8.2/docs/images/spacer.gif new file mode 100644 index 000000000..35d42e808 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/spacer.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/tab-left.gif b/tools/apache-ant-1.8.2/docs/images/tab-left.gif new file mode 100644 index 000000000..1bfd75440 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/tab-left.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/tab-right.gif b/tools/apache-ant-1.8.2/docs/images/tab-right.gif new file mode 100644 index 000000000..6803a8561 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/tab-right.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/tabSel-left.gif b/tools/apache-ant-1.8.2/docs/images/tabSel-left.gif new file mode 100644 index 000000000..46abc4dd4 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/tabSel-left.gif differ diff --git a/tools/apache-ant-1.8.2/docs/images/tabSel-right.gif b/tools/apache-ant-1.8.2/docs/images/tabSel-right.gif new file mode 100644 index 000000000..881f74c1d Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/images/tabSel-right.gif differ diff --git a/tools/apache-ant-1.8.2/docs/index.html b/tools/apache-ant-1.8.2/docs/index.html new file mode 100644 index 000000000..ff6b6bbad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/index.html @@ -0,0 +1,338 @@ + + + + + + + + + Apache Ant - Welcome + + + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Welcome

+

+ + Apache Ant™ +

+

Apache Ant is a Java library and command-line tool who's + mission is to drive processes described in build files as targets + and extension points dependent upon each other. + The main known usage of Ant is the build of Java applications. + Ant supplies a number of built-in tasks allowing to compile, assemble, + test and run Java applications. + Ant can also be used effectively to build non Java applications, for + instance C or C++ applications. More generally, Ant can be used to + pilot any type of process which can be described in terms of targets + and tasks. +

+

+ Ant is written in Java. Users of Ant can develop their own + "antlibs" containing Ant tasks and types, and are offered + a large number of ready-made commercial or open-source "antlibs". +

+

+ Ant is extremely flexible and does not impose coding conventions or + directory layouts to the Java projects which adopt it as a build tool. +

+

+ Software development projects looking for a solution combining build tool and + dependency management can use Ant in combination with Apache Ivy. +

+

The Apache Ant project is part of + the Apache Software + Foundation.

+

+ + Apache Ant1.8.2 +

+

December 27th, 2010 - Apache Ant 1.8.2 Released

+

Apache Ant 1.8.2 is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/bindownload.cgi.

+

Key features of the 1.8.2 release are

+
    +
  • performance improvements in directory scanning
    • +
  • XSLT task honors classpath again (bugrep 49271)
    • +
  • distinction between core tasks and optional tasks is abolished
    • +
  • numerous bug fixes and improvements as documented in Bugzilla + and in WHATSNEW
    • +
+

+ + Apache Ivy 2.2.0 +

+

September 30, 2010 - Apache Ivy 2.2.0 Released

+

Apache Ivy 2.2.0 is now available for download as source or binary (with and without + dependencies) from + http://ant.apache.org/ivy/download.cgi.

+

Key features of the 2.2.0 release are

+
    +
  • enhanced Maven2 compatibility, with several bug fixes and + more pom features covered
    • +
  • new parent mechanism for Ivy files
    • +
  • improved pom generation from an ivy.xml file
    • +
  • automated PGP signature generation when uploading artifacts
    • +
  • numerous bug fixes and improvements as documented in Jira + and in the release notes
    • +
+

For more information see + the Ivy home page.

+

+ + Apache AntUnit 1.1 +

+

September 26, 2008 - Apache AntUnit 1.1 Released

+

Apache AntUnit 1.1 is now available for download as binary + or source + release.

+

In addition to a few bugfixes and some new assertions AntUnit + 1.1 allows test listeners to receive the log output of the + project under test. Both plainlistener and xmllistener have + an option that makes them echo the project's output into their + respective logs.

+

For more information see the Antlib's + home page

+

+ + Documentation +

+

+You can view the documentation for the current release (Apache Ant 1.8.1) +online +

+

+Comprehensive documentation is included in the source and binary distributions. +

+

+ + Get Involved +

+ + +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/legal.html b/tools/apache-ant-1.8.2/docs/legal.html new file mode 100644 index 000000000..86004a4b1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/legal.html @@ -0,0 +1,249 @@ + + + + + + + + + Apache Ant - Legal + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Legal

+

+ + Legal Stuff They Make Us Say +

+

All material on this website is Copyright © 1999-2010, + The Apache Software Foundation.

+

Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather + logo, and the Apache Ant project logos are trademarks of The + Apache Software Foundation.

+

Sun, Sun Microsystems, Solaris, Java, JavaServer Web + Development Kit, and JavaServer Pages are trademarks or + registered trademarks of Oracle Corporation. UNIX is a + registered trademark in the United States and other countries, + exclusively licensed through X/Open Company, Ltd. Windows, + WindowsNT, and Win32 are registered trademarks of Microsoft + Corp. All other product names mentioned herein and throughout + the entire web site are trademarks of their respective + owners.

+ +
+
+ +

+ Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/license.html b/tools/apache-ant-1.8.2/docs/license.html new file mode 100644 index 000000000..2e303e041 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/license.html @@ -0,0 +1,519 @@ + + + + + + + + + Apache Ant - License + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

License

+

+ + The Apache License Version 2.0 +

+

The Apache License Version 2.0 applies + to all releases of Apache Ant starting with Ant 1.6.1

+ 
/*
+ *                                 Apache License
+ *                           Version 2.0, January 2004
+ *                        http://www.apache.org/licenses/
+ *
+ *   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+ *
+ *   1. Definitions.
+ *
+ *      "License" shall mean the terms and conditions for use, reproduction,
+ *      and distribution as defined by Sections 1 through 9 of this document.
+ *
+ *      "Licensor" shall mean the copyright owner or entity authorized by
+ *      the copyright owner that is granting the License.
+ *
+ *      "Legal Entity" shall mean the union of the acting entity and all
+ *      other entities that control, are controlled by, or are under common
+ *      control with that entity. For the purposes of this definition,
+ *      "control" means (i) the power, direct or indirect, to cause the
+ *      direction or management of such entity, whether by contract or
+ *      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ *      outstanding shares, or (iii) beneficial ownership of such entity.
+ *
+ *      "You" (or "Your") shall mean an individual or Legal Entity
+ *      exercising permissions granted by this License.
+ *
+ *      "Source" form shall mean the preferred form for making modifications,
+ *      including but not limited to software source code, documentation
+ *      source, and configuration files.
+ *
+ *      "Object" form shall mean any form resulting from mechanical
+ *      transformation or translation of a Source form, including but
+ *      not limited to compiled object code, generated documentation,
+ *      and conversions to other media types.
+ *
+ *      "Work" shall mean the work of authorship, whether in Source or
+ *      Object form, made available under the License, as indicated by a
+ *      copyright notice that is included in or attached to the work
+ *      (an example is provided in the Appendix below).
+ *
+ *      "Derivative Works" shall mean any work, whether in Source or Object
+ *      form, that is based on (or derived from) the Work and for which the
+ *      editorial revisions, annotations, elaborations, or other modifications
+ *      represent, as a whole, an original work of authorship. For the purposes
+ *      of this License, Derivative Works shall not include works that remain
+ *      separable from, or merely link (or bind by name) to the interfaces of,
+ *      the Work and Derivative Works thereof.
+ *
+ *      "Contribution" shall mean any work of authorship, including
+ *      the original version of the Work and any modifications or additions
+ *      to that Work or Derivative Works thereof, that is intentionally
+ *      submitted to Licensor for inclusion in the Work by the copyright owner
+ *      or by an individual or Legal Entity authorized to submit on behalf of
+ *      the copyright owner. For the purposes of this definition, "submitted"
+ *      means any form of electronic, verbal, or written communication sent
+ *      to the Licensor or its representatives, including but not limited to
+ *      communication on electronic mailing lists, source code control systems,
+ *      and issue tracking systems that are managed by, or on behalf of, the
+ *      Licensor for the purpose of discussing and improving the Work, but
+ *      excluding communication that is conspicuously marked or otherwise
+ *      designated in writing by the copyright owner as "Not a Contribution."
+ *
+ *      "Contributor" shall mean Licensor and any individual or Legal Entity
+ *      on behalf of whom a Contribution has been received by Licensor and
+ *      subsequently incorporated within the Work.
+ *
+ *   2. Grant of Copyright License. Subject to the terms and conditions of
+ *      this License, each Contributor hereby grants to You a perpetual,
+ *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *      copyright license to reproduce, prepare Derivative Works of,
+ *      publicly display, publicly perform, sublicense, and distribute the
+ *      Work and such Derivative Works in Source or Object form.
+ *
+ *   3. Grant of Patent License. Subject to the terms and conditions of
+ *      this License, each Contributor hereby grants to You a perpetual,
+ *      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ *      (except as stated in this section) patent license to make, have made,
+ *      use, offer to sell, sell, import, and otherwise transfer the Work,
+ *      where such license applies only to those patent claims licensable
+ *      by such Contributor that are necessarily infringed by their
+ *      Contribution(s) alone or by combination of their Contribution(s)
+ *      with the Work to which such Contribution(s) was submitted. If You
+ *      institute patent litigation against any entity (including a
+ *      cross-claim or counterclaim in a lawsuit) alleging that the Work
+ *      or a Contribution incorporated within the Work constitutes direct
+ *      or contributory patent infringement, then any patent licenses
+ *      granted to You under this License for that Work shall terminate
+ *      as of the date such litigation is filed.
+ *
+ *   4. Redistribution. You may reproduce and distribute copies of the
+ *      Work or Derivative Works thereof in any medium, with or without
+ *      modifications, and in Source or Object form, provided that You
+ *      meet the following conditions:
+ *
+ *      (a) You must give any other recipients of the Work or
+ *          Derivative Works a copy of this License; and
+ *
+ *      (b) You must cause any modified files to carry prominent notices
+ *          stating that You changed the files; and
+ *
+ *      (c) You must retain, in the Source form of any Derivative Works
+ *          that You distribute, all copyright, patent, trademark, and
+ *          attribution notices from the Source form of the Work,
+ *          excluding those notices that do not pertain to any part of
+ *          the Derivative Works; and
+ *
+ *      (d) If the Work includes a "NOTICE" text file as part of its
+ *          distribution, then any Derivative Works that You distribute must
+ *          include a readable copy of the attribution notices contained
+ *          within such NOTICE file, excluding those notices that do not
+ *          pertain to any part of the Derivative Works, in at least one
+ *          of the following places: within a NOTICE text file distributed
+ *          as part of the Derivative Works; within the Source form or
+ *          documentation, if provided along with the Derivative Works; or,
+ *          within a display generated by the Derivative Works, if and
+ *          wherever such third-party notices normally appear. The contents
+ *          of the NOTICE file are for informational purposes only and
+ *          do not modify the License. You may add Your own attribution
+ *          notices within Derivative Works that You distribute, alongside
+ *          or as an addendum to the NOTICE text from the Work, provided
+ *          that such additional attribution notices cannot be construed
+ *          as modifying the License.
+ *
+ *      You may add Your own copyright statement to Your modifications and
+ *      may provide additional or different license terms and conditions
+ *      for use, reproduction, or distribution of Your modifications, or
+ *      for any such Derivative Works as a whole, provided Your use,
+ *      reproduction, and distribution of the Work otherwise complies with
+ *      the conditions stated in this License.
+ *
+ *   5. Submission of Contributions. Unless You explicitly state otherwise,
+ *      any Contribution intentionally submitted for inclusion in the Work
+ *      by You to the Licensor shall be under the terms and conditions of
+ *      this License, without any additional terms or conditions.
+ *      Notwithstanding the above, nothing herein shall supersede or modify
+ *      the terms of any separate license agreement you may have executed
+ *      with Licensor regarding such Contributions.
+ *
+ *   6. Trademarks. This License does not grant permission to use the trade
+ *      names, trademarks, service marks, or product names of the Licensor,
+ *      except as required for reasonable and customary use in describing the
+ *      origin of the Work and reproducing the content of the NOTICE file.
+ *
+ *   7. Disclaimer of Warranty. Unless required by applicable law or
+ *      agreed to in writing, Licensor provides the Work (and each
+ *      Contributor provides its Contributions) on an "AS IS" BASIS,
+ *      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ *      implied, including, without limitation, any warranties or conditions
+ *      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ *      PARTICULAR PURPOSE. You are solely responsible for determining the
+ *      appropriateness of using or redistributing the Work and assume any
+ *      risks associated with Your exercise of permissions under this License.
+ *
+ *   8. Limitation of Liability. In no event and under no legal theory,
+ *      whether in tort (including negligence), contract, or otherwise,
+ *      unless required by applicable law (such as deliberate and grossly
+ *      negligent acts) or agreed to in writing, shall any Contributor be
+ *      liable to You for damages, including any direct, indirect, special,
+ *      incidental, or consequential damages of any character arising as a
+ *      result of this License or out of the use or inability to use the
+ *      Work (including but not limited to damages for loss of goodwill,
+ *      work stoppage, computer failure or malfunction, or any and all
+ *      other commercial damages or losses), even if such Contributor
+ *      has been advised of the possibility of such damages.
+ *
+ *   9. Accepting Warranty or Additional Liability. While redistributing
+ *      the Work or Derivative Works thereof, You may choose to offer,
+ *      and charge a fee for, acceptance of support, warranty, indemnity,
+ *      or other liability obligations and/or rights consistent with this
+ *      License. However, in accepting such obligations, You may act only
+ *      on Your own behalf and on Your sole responsibility, not on behalf
+ *      of any other Contributor, and only if You agree to indemnify,
+ *      defend, and hold each Contributor harmless for any liability
+ *      incurred by, or claims asserted against, such Contributor by reason
+ *      of your accepting any such warranty or additional liability.
+ *
+ *   END OF TERMS AND CONDITIONS
+ *
+ *   APPENDIX: How to apply the Apache License to your work.
+ *
+ *      To apply the Apache License to your work, attach the following
+ *      boilerplate notice, with the fields enclosed by brackets "[]"
+ *      replaced with your own identifying information. (Don't include
+ *      the brackets!)  The text should be enclosed in the appropriate
+ *      comment syntax for the file format. We also recommend that a
+ *      file or class name and description of purpose be included on the
+ *      same "printed page" as the copyright notice for easier
+ *      identification within third-party archives.
+ *
+ *   Copyright [yyyy] Apache Software Foundation
+ *
+ *   Licensed 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.
+ */
+
+

You can download the original license file here.

+

The License is accompanied by a NOTICE

+ 
+   =========================================================================
+   ==  NOTICE file corresponding to the section 4 d of                    ==
+   ==  the Apache License, Version 2.0,                                   ==
+   ==  in this case for the Apache Ant distribution.                      ==
+   =========================================================================
+
+   This product includes software developed by
+   The Apache Software Foundation (http://www.apache.org/).
+
+   This product includes also software developed by :
+     - the W3C consortium (http://www.w3c.org) ,
+     - the SAX project (http://www.saxproject.org)
+
+   Please read the different LICENSE files present in the root directory of
+   this distribution.
+
+   The names "Ant" and  "Apache Software Foundation"  must not be used to
+   endorse  or promote  products derived  from this  software without prior
+   written permission. For written permission, please contact
+   apache@apache.org.
+
+

+ + The Apache Software License, Version 1.1 +

+

The Apache Software License, Version 1.1, applies to all versions of up to Apache Ant 1.6.0 included.

+ 
/*
+ * ============================================================================
+ *                   The Apache Software License, Version 1.1
+ * ============================================================================
+ * 
+ *    Copyright (C) 2000-2003 The Apache Software Foundation. All
+ *    rights reserved.
+ * 
+ * Redistribution and use in source and binary forms, with or without modifica-
+ * tion, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of  source code must  retain the above copyright  notice,
+ *    this list of conditions and the following disclaimer.
+ * 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * 3. The end-user documentation included with the redistribution, if any, must
+ *    include  the following  acknowledgment:  "This product includes  software
+ *    developed  by the  Apache Software Foundation  (http://www.apache.org/)."
+ *    Alternately, this  acknowledgment may  appear in the software itself,  if
+ *    and wherever such third-party acknowledgments normally appear.
+ * 
+ * 4. The names "Ant" and  "Apache Software Foundation"  must not be used to
+ *    endorse  or promote  products derived  from this  software without  prior
+ *    written permission. For written permission, please contact
+ *    apache@apache.org.
+ * 
+ * 5. Products  derived from this software may not  be called "Apache", nor may
+ *    "Apache" appear  in their name,  without prior written permission  of the
+ *    Apache Software Foundation.
+ * 
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS  FOR A PARTICULAR  PURPOSE ARE  DISCLAIMED.  IN NO  EVENT SHALL  THE
+ * APACHE SOFTWARE  FOUNDATION  OR ITS CONTRIBUTORS  BE LIABLE FOR  ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL,  EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLU-
+ * DING, BUT NOT LIMITED TO, PROCUREMENT  OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR  PROFITS; OR BUSINESS  INTERRUPTION)  HOWEVER CAUSED AND ON
+ * ANY  THEORY OF LIABILITY,  WHETHER  IN CONTRACT,  STRICT LIABILITY,  OR TORT
+ * (INCLUDING  NEGLIGENCE OR  OTHERWISE) ARISING IN  ANY WAY OUT OF THE  USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * This software  consists of voluntary contributions made  by many individuals
+ * on behalf of the  Apache Software Foundation.  For more  information  on the 
+ * Apache Software Foundation, please see <http://www.apache.org/>.
+ *
+ */
+
+ +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/mail.html b/tools/apache-ant-1.8.2/docs/mail.html new file mode 100644 index 000000000..e1893b772 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/mail.html @@ -0,0 +1,338 @@ + + + + + + + + + Apache Ant - Mailing Lists + + + + + + +

+ +

+ +
+ + + + + + +
Apache Ant siteApache Ant logo +
+ + + + + + + + + + + + + + +
+ + + + +
+ the Apache Ant site +
+
+
+
+ +
+ + + + + +
+ + + + +
Home
+ 		+ + + + +
Projects
+
+
+ +
+ +
+
+ +
+
+ ApacheCon - logo +
+ + +
+
 
+
+
+

Mailing Lists

+

+ + Mailing Lists +

+

Please read the guidelines of + the Jakarta Project before subscribing and posting to any of + the lists below. They apply to Apache Ant's lists as well.

+

The user and dev list are subscriber only lists, this means + you have to subscribe before you can post to the list. Please + note that any HTML parts sent to the lists will be removed by our + mailing list software - you shouldn't be sending HTML mails + anyway.

+

To subscribe to a mailinglist use the links below. In your first email you will get some + information about working with the list manager EZMLM.

+

+ + User List: user@ant.apache.org +

+

+ Medium Traffic + Subscribe + Unsubscribe + ASF Archive + Third Party Archive +

+

This list is for developers that are using Ant in their own + projects to ask questions, share knowledge, and discuss issues + related to using Apache Ant as a build tool.

+

+ + Ivy User List: ivy-user@ant.apache.org +

+

+ Medium Traffic + Subscribe + Unsubscribe + ASF Archive +

+

This list is for developers that are using Ivy or IvyDE in + their own projects to ask questions, share knowledge, and + discuss issues related to using Apache Ivy with or without Apache Ant.

+

+ + Developer List: dev@ant.apache.org +

+

+ Medium Traffic + Subscribe + Unsubscribe + ASF Archive + Third Party Archive +

+

This is the list where participating developers of the Apache Ant + build tool, Apache Ivy or the Ant libraries developed by the Ant team + meet and discuss issues, code changes/additions, etc.

+

+ + Notifications List: notifications@ant.apache.org +

+

+ Medium Traffic + Subscribe + Unsubscribe + ASF Archive +

+

Subscribers to this list get notices of each and every + code change, build results, testing notices, etc.

+

+ + How to unsubscribe your old email address +

+

+ First, find out the particular email adress to which ezmlm is sending. + The email headers are visible in Microsoft Outlook via the messages menu + "View | Options". + 

+        Microsoft Mail Internet Headers Version 2.0
+        ...
+        List-Unsubscribe: <mailto:user-unsubscribe@ant.apache.org>
+        List-Help: <mailto:user-help@ant.apache.org>
+        List-Post: <mailto:user@ant.apache.org>
+        List-Id: "Ant Users List" <user.ant.apache.org>
+        Reply-To: "Ant Users List" <user@ant.apache.org>
+        Delivered-To: mailing list user@ant.apache.org
+        ...
+        Return-Path: user-return-12345-john=host.domain@ant.apache.org
+        ...
+
+ The Return-Path header contains the email address which is subscribed. +

+

To stop subscription for the address john@host.domain , send an email to 

dev-unsubscribe-john=host.domain@ant.apache.org
+ or to 
user-unsubscribe-john=host.domain@ant.apache.org
. +

+

+ + Archives +

+

These lists are archived at

+ + +
+
+ +

+ +

+ + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Integration/anttool1.gif b/tools/apache-ant-1.8.2/docs/manual/Integration/anttool1.gif new file mode 100644 index 000000000..ad450ba67 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/Integration/anttool1.gif differ diff --git a/tools/apache-ant-1.8.2/docs/manual/Integration/jext-plugin.html b/tools/apache-ant-1.8.2/docs/manual/Integration/jext-plugin.html new file mode 100644 index 000000000..84e88c087 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Integration/jext-plugin.html @@ -0,0 +1,56 @@ + + + + + + + +Apache AntWork Plugin for the Jext Java Text Editor + + + +

AntWork Plugin for the Jext Java Text Editor

+ by +
+ +

You can download the plugin at: ftp://jext.sourceforge.net/pub/jext/plugins/AntWork.zip

+ +

Installation instructions from the Readme.txt:

+ +

You have to enable the Jext Console to see the Apache Ant output (menu: +Edit->Options... - General Panel), because the Ant messages are +redirected to the Jext console.

+ +

You can configure the Ant call in the Jext menu: Edit->Options... - +Plugin Options - Antwork Plugin Panel; here you can set the ant home +directory and the path to your build file.

+ +

You can start AntWork in the menu: Plugins->Ant->Work Now! In the +appearing dialog box you can enter the target which you want to +compile.

+ +

If a javac error occurs in the ant run an error-list opens within +Jext. With a double-click on the error-message you jump to the error +in the specified java text file.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Integration/remacc.gif b/tools/apache-ant-1.8.2/docs/manual/Integration/remacc.gif new file mode 100644 index 000000000..e02e04887 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/Integration/remacc.gif differ diff --git a/tools/apache-ant-1.8.2/docs/manual/Integration/toolmenu.gif b/tools/apache-ant-1.8.2/docs/manual/Integration/toolmenu.gif new file mode 100644 index 000000000..164db44d8 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/Integration/toolmenu.gif differ diff --git a/tools/apache-ant-1.8.2/docs/manual/LICENSE b/tools/apache-ant-1.8.2/docs/manual/LICENSE new file mode 100644 index 000000000..f820d4bd3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/LICENSE @@ -0,0 +1,203 @@ +/* + * Apache License + * Version 2.0, January 2004 + * http://www.apache.org/licenses/ + * + * TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + * + * 1. Definitions. + * + * "License" shall mean the terms and conditions for use, reproduction, + * and distribution as defined by Sections 1 through 9 of this document. + * + * "Licensor" shall mean the copyright owner or entity authorized by + * the copyright owner that is granting the License. + * + * "Legal Entity" shall mean the union of the acting entity and all + * other entities that control, are controlled by, or are under common + * control with that entity. For the purposes of this definition, + * "control" means (i) the power, direct or indirect, to cause the + * direction or management of such entity, whether by contract or + * otherwise, or (ii) ownership of fifty percent (50%) or more of the + * outstanding shares, or (iii) beneficial ownership of such entity. + * + * "You" (or "Your") shall mean an individual or Legal Entity + * exercising permissions granted by this License. + * + * "Source" form shall mean the preferred form for making modifications, + * including but not limited to software source code, documentation + * source, and configuration files. + * + * "Object" form shall mean any form resulting from mechanical + * transformation or translation of a Source form, including but + * not limited to compiled object code, generated documentation, + * and conversions to other media types. + * + * "Work" shall mean the work of authorship, whether in Source or + * Object form, made available under the License, as indicated by a + * copyright notice that is included in or attached to the work + * (an example is provided in the Appendix below). + * + * "Derivative Works" shall mean any work, whether in Source or Object + * form, that is based on (or derived from) the Work and for which the + * editorial revisions, annotations, elaborations, or other modifications + * represent, as a whole, an original work of authorship. For the purposes + * of this License, Derivative Works shall not include works that remain + * separable from, or merely link (or bind by name) to the interfaces of, + * the Work and Derivative Works thereof. + * + * "Contribution" shall mean any work of authorship, including + * the original version of the Work and any modifications or additions + * to that Work or Derivative Works thereof, that is intentionally + * submitted to Licensor for inclusion in the Work by the copyright owner + * or by an individual or Legal Entity authorized to submit on behalf of + * the copyright owner. For the purposes of this definition, "submitted" + * means any form of electronic, verbal, or written communication sent + * to the Licensor or its representatives, including but not limited to + * communication on electronic mailing lists, source code control systems, + * and issue tracking systems that are managed by, or on behalf of, the + * Licensor for the purpose of discussing and improving the Work, but + * excluding communication that is conspicuously marked or otherwise + * designated in writing by the copyright owner as "Not a Contribution." + * + * "Contributor" shall mean Licensor and any individual or Legal Entity + * on behalf of whom a Contribution has been received by Licensor and + * subsequently incorporated within the Work. + * + * 2. Grant of Copyright License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * copyright license to reproduce, prepare Derivative Works of, + * publicly display, publicly perform, sublicense, and distribute the + * Work and such Derivative Works in Source or Object form. + * + * 3. Grant of Patent License. Subject to the terms and conditions of + * this License, each Contributor hereby grants to You a perpetual, + * worldwide, non-exclusive, no-charge, royalty-free, irrevocable + * (except as stated in this section) patent license to make, have made, + * use, offer to sell, sell, import, and otherwise transfer the Work, + * where such license applies only to those patent claims licensable + * by such Contributor that are necessarily infringed by their + * Contribution(s) alone or by combination of their Contribution(s) + * with the Work to which such Contribution(s) was submitted. If You + * institute patent litigation against any entity (including a + * cross-claim or counterclaim in a lawsuit) alleging that the Work + * or a Contribution incorporated within the Work constitutes direct + * or contributory patent infringement, then any patent licenses + * granted to You under this License for that Work shall terminate + * as of the date such litigation is filed. + * + * 4. Redistribution. You may reproduce and distribute copies of the + * Work or Derivative Works thereof in any medium, with or without + * modifications, and in Source or Object form, provided that You + * meet the following conditions: + * + * (a) You must give any other recipients of the Work or + * Derivative Works a copy of this License; and + * + * (b) You must cause any modified files to carry prominent notices + * stating that You changed the files; and + * + * (c) You must retain, in the Source form of any Derivative Works + * that You distribute, all copyright, patent, trademark, and + * attribution notices from the Source form of the Work, + * excluding those notices that do not pertain to any part of + * the Derivative Works; and + * + * (d) If the Work includes a "NOTICE" text file as part of its + * distribution, then any Derivative Works that You distribute must + * include a readable copy of the attribution notices contained + * within such NOTICE file, excluding those notices that do not + * pertain to any part of the Derivative Works, in at least one + * of the following places: within a NOTICE text file distributed + * as part of the Derivative Works; within the Source form or + * documentation, if provided along with the Derivative Works; or, + * within a display generated by the Derivative Works, if and + * wherever such third-party notices normally appear. The contents + * of the NOTICE file are for informational purposes only and + * do not modify the License. You may add Your own attribution + * notices within Derivative Works that You distribute, alongside + * or as an addendum to the NOTICE text from the Work, provided + * that such additional attribution notices cannot be construed + * as modifying the License. + * + * You may add Your own copyright statement to Your modifications and + * may provide additional or different license terms and conditions + * for use, reproduction, or distribution of Your modifications, or + * for any such Derivative Works as a whole, provided Your use, + * reproduction, and distribution of the Work otherwise complies with + * the conditions stated in this License. + * + * 5. Submission of Contributions. Unless You explicitly state otherwise, + * any Contribution intentionally submitted for inclusion in the Work + * by You to the Licensor shall be under the terms and conditions of + * this License, without any additional terms or conditions. + * Notwithstanding the above, nothing herein shall supersede or modify + * the terms of any separate license agreement you may have executed + * with Licensor regarding such Contributions. + * + * 6. Trademarks. This License does not grant permission to use the trade + * names, trademarks, service marks, or product names of the Licensor, + * except as required for reasonable and customary use in describing the + * origin of the Work and reproducing the content of the NOTICE file. + * + * 7. Disclaimer of Warranty. Unless required by applicable law or + * agreed to in writing, Licensor provides the Work (and each + * Contributor provides its Contributions) on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + * implied, including, without limitation, any warranties or conditions + * of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + * PARTICULAR PURPOSE. You are solely responsible for determining the + * appropriateness of using or redistributing the Work and assume any + * risks associated with Your exercise of permissions under this License. + * + * 8. Limitation of Liability. In no event and under no legal theory, + * whether in tort (including negligence), contract, or otherwise, + * unless required by applicable law (such as deliberate and grossly + * negligent acts) or agreed to in writing, shall any Contributor be + * liable to You for damages, including any direct, indirect, special, + * incidental, or consequential damages of any character arising as a + * result of this License or out of the use or inability to use the + * Work (including but not limited to damages for loss of goodwill, + * work stoppage, computer failure or malfunction, or any and all + * other commercial damages or losses), even if such Contributor + * has been advised of the possibility of such damages. + * + * 9. Accepting Warranty or Additional Liability. While redistributing + * the Work or Derivative Works thereof, You may choose to offer, + * and charge a fee for, acceptance of support, warranty, indemnity, + * or other liability obligations and/or rights consistent with this + * License. However, in accepting such obligations, You may act only + * on Your own behalf and on Your sole responsibility, not on behalf + * of any other Contributor, and only if You agree to indemnify, + * defend, and hold each Contributor harmless for any liability + * incurred by, or claims asserted against, such Contributor by reason + * of your accepting any such warranty or additional liability. + * + * END OF TERMS AND CONDITIONS + * + * APPENDIX: How to apply the Apache License to your work. + * + * To apply the Apache License to your work, attach the following + * boilerplate notice, with the fields enclosed by brackets "[]" + * replaced with your own identifying information. (Don't include + * the brackets!) The text should be enclosed in the appropriate + * comment syntax for the file format. We also recommend that a + * file or class name and description of purpose be included on the + * same "printed page" as the copyright notice for easier + * identification within third-party archives. + * + * Copyright [yyyy] [name of copyright owner] + * + * Licensed 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. + */ diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandEJBTasks.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandEJBTasks.html new file mode 100644 index 000000000..126fe5c57 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandEJBTasks.html @@ -0,0 +1,143 @@ + + + + + + +Borland EJB Tasks + + + + +

BorlandDeployTool

+

by Benoit Moussaud (benoit.moussaud@criltelecom.com)

+ + +

Description

+

The BorlandDeployTool is a vendor specific nested element for the Ejbjar optional task.

+

BorlandDeploymentTool is dedicated to the Borland Application Server 4.5.x and Borland + Enterprise Server 5.x. It generates and compiles the stubs and skeletons for all ejb described into the + Deployment Descriptor, builds the jar file including the support files and + verify whether the produced jar is valid or not.

+ +

Benoit Moussaud maintains a separate FAQ for this task at +his homepage.

+ +

Borland element

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated borland + ready jar files are depositedyes
debugIf true, turn on the debug mode for each borland + tools (java2iiop, iastool ...) default = falseno
verifyIf true, turn on the verification at the end + of the jar production (default = false)no
verifyargsextra parameter for verify commandno
suffixString value appended to the basename of the + deployment descriptor to create the filename of the Borland EJB jar file.No, defaults to '-ejb.jar'.
basdtdDeprecated. Defines the location of the + DTD which covers the Borland specific deployment descriptors. + This should not be necessary if you have borland in your classpath. If you + do not, you should use a nested + <dtd> element, described + in the ejbjar task documentation.no
ejbdtdDeprecated. Defines the location of the + ejb-jar DTD in the class hierarchy. This should not be necessary + if you have borland in your classpath. If you do not, you should use a + nested <dtd> element, + described in the ejbjar task + documentation. no
generateclient If true, turn on the generation of the corresponding + ejbjar (default = false)no
versionset the Borland Application Version. +
    +
  • 4 means B.A.S (Borland Application Server) 4.x, target will add ejb-inprise.xml file
    • +
  • 5 means B.E.S (Borland Application Server) 5.x, target will add ejb-borland.xml file
    • +
+ 		No, defaults to 4
java2iiopParams If filled, the params are added to the java2iiop command (ex: -no_warn_missing_define)no
+ +

Examples

+

The following build.xml snippet is an example of how to use Borland element + into the ejbjar task

+
    <ejbjar srcdir="${build.classes}" basejarname="vsmp" descriptordir="${rsc.dir}/hrmanager">
+        <borland destdir="lib" verify="on" generateclient="on" version="5">
+          <classpath refid="classpath"/>
+        </borland>
+        <include name="**\ejb-jar.xml"/>
+        <support dir="${build.classes}">
+          <include name="demo\*.class"/>
+          <include name="demo\helper\*.class"/>
+         </support>
+     </ejbjar>
+
The borland element will generate into the lib dir an ejb jar file using the deployment descriptor placed into the ${rsc.dir}/hrmanager directory.
+The verify phase is turned on and the generate client phase as well.
+
+ +

 

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandGenerateClient.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandGenerateClient.html new file mode 100644 index 000000000..01956b25f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/BorlandGenerateClient.html @@ -0,0 +1,90 @@ + + + + + + +BorlandGenerateClient Task + + + + +

BorlandGenerateClient

+

by Benoit Moussaud (benoit.moussaud@criltelecom.com)

+

Description

+

The BorlandGenerateClient is a task dedicated to Borland Application Server + v 4.5. It offers to generate the client jar file corresponding to an ejb jar + file.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
ejbjarejb jar fileyes
debugIf true, turn on the debug mode for each borland + tools (java2iiop, iastool ...) default = falseno
clientjarclient jar file name. If missing the client jar + file name is build using the ejbjar file name: ejbjar = hellobean-ejb.jar + => hellobean-ejbclient.jarno
modechoose the command launching mode. Two values: + java or fork. default = fork. java is not supported for version=5.Possibility to specify a classpath.no
versionset the Borland Application Version. +
    +
  • 4 means B.A.S (Borland Application Server 4.x)
    • +
  • 5 means B.E.S (Borland Application Server 5.x)
    • +
+ 		No, defaults to 4
+ +

Examples

+

The following build.xml snippet is an example of how to use Borland element + into the ejbjar task using the java mode.

+
+<blgenclient ejbjar="lib/secutest-ejb.jar" clientjar="lib/client.jar" debug="true" mode="fork"> version="5">
+    <classpath>
+        <pathelement location="mymodule.jar"/>
+    </classpath>
+</blgenclient>
+
+
 
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/ant.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/ant.html new file mode 100644 index 000000000..87b78bb26 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/ant.html @@ -0,0 +1,413 @@ + + + + + + +Ant Task + + + + +

Ant

+

Description

+ +

Runs Apache Ant on a supplied buildfile. This can be used to build +subprojects. This task must not be used outside of a +target if it invokes the same build file it is part +of.

+ +

When the antfile attribute is omitted, the file "build.xml" +in the supplied directory (dir attribute) is used.

+

If no target attribute is supplied, the default target of the new project is +used.

+

By default, all of the properties of the current project will be +available in the new project. Alternatively, you can set the +inheritAll attribute to false and only +"user" properties (i.e., those passed on the command-line) +will be passed to the new project. In either case, the set of +properties passed to the new project will override the properties that +are set in the new project (See also the property task).

+ +

You can also set properties in the new project from the old project +by using nested property tags. These properties are always passed +to the new project and any project created in that project +regardless of the setting of inheritAll. This allows you to +parameterize your subprojects.

+ +

When more than one nested <property> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <property> tasks in build + files behave.

+ +

Properties defined on the command line cannot be overridden by + nested <property> elements. Since Ant + 1.8.0. the same is true for nested structures + of <ant> tasks: if a build file A + invokes B via an <ant> task setting a + property with a nested <property> element + and B contains an <ant> tasks + invoking C, C will see the value set + in A, even if B used a + nested <property> element as well.

+ +

References to data types can also be passed to the new project, but +by default they are not. If you set the inheritrefs attribute to +true, all references will be copied, but they will not override +references defined in the new project.

+ +

Nested <reference> elements +can also be used to copy references from the calling project to the +new project, optionally under a different id. References taken from +nested elements will override existing references that have been +defined outside of targets in the new project - but not those defined +inside of targets.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
antfilethe buildfile to use. Defaults to + "build.xml". This file is expected to be a filename + relative to the dir attribute given.No
dirthe directory to use as a basedir for the new Ant + project (unless useNativeBasedir is set to true). + Defaults to the current project's basedir, unless + inheritall has been set to false, in which case it doesn't + have a default value. This will override the basedir + setting of the called project.
+ Also serves as the directory to resolve the antfile and output + attribute's values (if any). + 		No
targetthe target of the new Ant project that should be executed. + Defaults to the new project's default target.No
outputFilename to write the ant output to. This is + relative to the value of the dir attribute if it has been set or + to the base directory of the current project otherwise. + No
inheritAllIf true, pass all properties to the + new Ant project. Defaults to true.No
inheritRefsIf true, pass all references to the + new Ant project. Defaults to false.No
useNativeBasedirIf set to true, the child build will use the same + basedir as it would have used when run from the command line + (i.e. the basedir one would expect when looking at the child + build's buildfile). Defaults to false. since + Ant 1.8.0No
+ +

Parameters specified as nested elements

+ +

property

+

See the description of the property +task.
+These properties become equivalent to properties you define on +the command line. These are special properties and they will always get passed +down, even through additional <*ant*> tasks with inheritall set to +false (see above).
+Note that the refid attribute points to a +reference in the calling project, not in the new one.

+ +

reference

+

Used to choose references that shall be copied into the new project, +optionally changing their id.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
refidThe id of the reference in the calling project.Yes
torefidThe id of the reference in the new project.No, defaults to the value of refid.
+ +

propertyset

+ +

You can specify a set of properties to be copied into the new +project with propertysets.

+ +

since Ant 1.6.

+ +

target

+ +

You can specify multiple targets using nested <target> elements +instead of using the target attribute. These will be executed as if +Ant had been invoked with a single target whose dependencies are the +targets so specified, in the order specified.

+ + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the called target.Yes
+

since Ant 1.6.3.

+ +

Basedir of the new project

+ +

If you set useNativeBasedir to true, the basedir of + the new project will be whatever the basedir attribute of + the <project> element of the new project says (or + the new project's directory if the there is no basedir attribute) - + no matter what any other attribute of this task says and no matter + how deeply nested into levels of + <ant> invocations this task lives.

+ +

If you haven't set useNativeBasedir or set it to + false, the following rules apply:

+ +

The basedir value of the new project is affected by the two + attributes dir and inheritall as well as + the <ant> task's history. The current behaviour + is known to be confusing but cannot be changed without breaking + backwards compatibility in subtle ways.

+ +

If the <ant> task is in a "top level" build + file, i.e. the project containing the <ant> task + has not itself been invoked as part of a + different <ant> (or <antcall>) + task "higher up", the following table shows the details:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
dir attributeinheritAll attributenew project's basedir
value providedtruevalue of dir attribute
value providedfalsevalue of dir attribute
omittedtruebasedir of calling project (the one whose build + file contains the <ant> task).
omittedfalsebasedir attribute of the <project> element + of the new project
+ +

If on the other hand the <ant> task is already + nested into another invocation, the parent invocation's settings + affect the outcome of the basedir value. The current task's dir + attribute will always win, but if the dir attribute has been omitted + an even more complex situation arises:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
parent dir attributeparent inheritAll attributecurrent inheritAll attributenew project's basedir
value providedanyanyvalue of parent's dir attribute
omittedtruetruebasedir of parent project (the one whose build + file called the build file that contains + the current <ant> task).
omittedtruefalsebasedir of parent project (the one whose build + file called the build file that contains + the current <ant> task).
omittedfalsetruebasedir of calling project (the one whose build + file contains the current <ant> task).
omittedfalsefalsebasedir attribute of the <project> element + of the new project
+ +

If you add even deeper levels of nesting, things get even more + complicated and you need to apply the above table recursively.

+ +

If the basedir of the outer most build has been specified as a + property on the command line (i.e. -Dbasedir=some-value + or a -propertyfile argument) the value provided will + get an even higher priority. For any <ant> task + that doesn't specify a dir attribute, the new project's basedir will + be the value specified on the command line - no matter how deeply + nested into layers of build files the task may be.

+ +

The same happens if the basedir is specified as a + nested <property> of an <ant> + task. The basedir of build files started at deeper levels will be + set to the specified value of the property element unless the + corresponding Ant tasks set the dir attribute explicitly.

+ +

Examples

+
+<ant antfile="subproject/subbuild.xml" target="compile"/>
+
+<ant dir="subproject"/>
+
+<ant antfile="subproject/property_based_subbuild.xml">
+  <property name="param1" value="version 1.x"/>
+  <property file="config/subproject/default.properties"/>
+</ant>
+
+<ant inheritAll="false" antfile="subproject/subbuild.xml">
+  <property name="output.type" value="html"/>
+</ant>
+
+ +

These lines invoke the same build file:

+
+<ant antfile="sub1/sub2/build.xml" />
+<ant antfile="sub2/build.xml" dir="sub1" />
+<ant antfile="build.xml" dir="sub1/sub2" />
+
+ +

The build file of the calling project defines some +<path> elements like this:

+ +
+<path id="path1">
+    ...
+</path>
+<path id="path2">
+    ...
+</path>
+
+ +

and the called build file (subbuild.xml) also defines +a <path> with the id path1, but +path2 is not defined:

+ +
+<ant antfile="subbuild.xml" inheritrefs="true"/>
+
+ +

will not override subbuild's definition of +path1, but make the parent's definition of +path2 available in the subbuild.

+ +
+<ant antfile="subbuild.xml"/>
+
+ +

as well as

+ +
+<ant antfile="subbuild.xml" inheritrefs="false"/>
+
+ +

will neither override path1 nor copy +path2.

+ +
+<ant antfile="subbuild.xml" inheritrefs="false">
+  <reference refid="path1"/>
+</ant>
+
+ +

will override subbuild's definition of +path1.

+ +
+<ant antfile="subbuild.xml" inheritrefs="false">
+  <reference refid="path1" torefid="path2"/>
+</ant>
+
+ +

will copy the parent's definition of path1 into the +new project using the id path2.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/antcall.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/antcall.html new file mode 100644 index 000000000..00cf61551 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/antcall.html @@ -0,0 +1,201 @@ + + + + + + +AntCall Task + + + + +

AntCall

+

Description

+ +

Call another target within the same buildfile optionally +specifying some properties (params in this context). This +task must not be used outside of a target.

+ +

By default, all of the properties of the current project will be +available in the new project. Alternatively, you can +set the inheritAll attribute to false and only +"user" properties (i.e., those passed on the command-line) +will be passed to the new project. In either case, the set of +properties passed to the new project will override the properties that +are set in the new project (See also the property task).

+

You can also set properties in the new project from the old project +by using nested param tags. These properties are always passed +to the new project and any project created in that project +regardless of the setting of inheritAll. This allows you to +parameterize your subprojects. Properties defined on the command line +can not be overridden by nested <param> elements.

+ +

When more than one nested <param> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <property> tasks in build + files behave.

+ +

Nested <reference>; elements can +be used to copy references from the calling project to the new +project, optionally under a different id. References taken from +nested elements will override existing references that have been +defined outside of targets in the new project - but not those defined +inside of targets.

+ +

+When a target is invoked by antcall, all of its dependent targets will +also be called within the context of any new parameters. For example. if +the target "doSomethingElse" depended on the target "init", then the +antcall of "doSomethingElse" will call "init" during the call. +Of course, any properties defined in the antcall task or inherited from the calling target +will be fixed and not overridable in the init task--or indeed in the "doSomethingElse" task. +

+ +

The called target(s) are run in a new project; be aware that this +means properties, references, etc. set by called targets will not +persist back to the calling project.

+ +

If the build file changes after you've started the build, the +behavior of this task is undefined.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetThe target to execute.Yes
inheritAllIf true, pass all properties to the new Apache Ant + project. Defaults to true. + No
inheritRefsIf true, pass all references to the + new Ant project. Defaults to false.No
+ +

Note on inheritRefs

+ +

<antcall> will not override existing references, +even if you set inheritRefs to true. As the called build +files is the same build file as the calling one, this means it will +not override any reference set via an id attribute at +all. The only references that can be inherited by the child project +are those defined by nested <reference> elements or +references defined by tasks directly (not using the id +attribute).

+ +

Parameters specified as nested elements

+

param

+

Specifies the properties to set before running the specified target. See property for usage guidelines.
+These properties become equivalent to properties you define on +the command line. These are special properties and they will always get passed +down, even through additional <*ant*> tasks with inheritall set to +false (see above). +

+ +

reference

+

Used to choose references that shall be copied into the new project, +optionally changing their id.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
refidThe id of the reference in the calling project.Yes
torefidThe id of the reference in the new project.No, defaults to the value of refid.
+ +

propertyset

+ +

You can specify a set of properties to be copied into the new +project with propertysets.

+ +

since Ant 1.6.

+ +

target

+ +

You can specify multiple targets using nested <target> elements +instead of using the target attribute. These will be executed as if +Ant had been invoked with a single target whose dependencies are the +targets so specified, in the order specified.

+ + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the called target.Yes
+

since Ant 1.6.3.

+ +

Examples

+
+<target name="default">
+  <antcall target="doSomethingElse">
+    <param name="param1" value="value"/>
+  </antcall>
+</target>
+
+<target name="doSomethingElse">
+  <echo message="param1=${param1}"/>
+</target>
+
+

Will run the target 'doSomethingElse' and echo 'param1=value'.

+ +
+<antcall ... >
+  <reference refid="path1" torefid="path2"/>
+</antcall>
+
+ +

will copy the parent's definition of path1 into the +new project using the id path2.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/antlr.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/antlr.html new file mode 100644 index 000000000..e7d4fdbac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/antlr.html @@ -0,0 +1,200 @@ + + + + + + +ANTLR Task + + + + +

ANTLR

+

Description

+

+ Invokes the ANTLR Translator generator + on a grammar file. +

+

+ To use the ANTLR task, set the target attribute to the name of the + grammar file to process. Optionally, you can also set the + outputdirectory to write the generated file to a specific directory. + Otherwise ANTLR writes the generated files to the directory containing + the grammar file. +

+

+ This task only invokes ANTLR if the grammar file (or the + supergrammar specified by the glib attribute) is newer than the + generated files. +

+

Antlr 2.7.1 Note: + + To successfully run ANTLR, your best option is probably to build the whole + jar with the provided script mkalljar and drop the resulting jar (about 300KB) + into ${ant.home}/lib. Dropping the default jar (70KB) is probably not enough + for most needs and your only option will be to add ANTLR home directory + to your classpath as described in ANTLR install.html document. + +

+

Antlr 2.7.2 Note: + + Instead of the above, you will need antlrall.jar that can be created + by the antlr-all.jar target of the Makefile provided with the + download. + +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetThe grammar file to process.Yes
outputdirectory + The directory to write the generated files to. If not set, the files + are written to the directory containing the grammar file. + No
glib + An optional super grammar file that the target grammar overrides. This + feature is only needed for advanced vocabularies. + No
debug + When set to "yes", this flag adds code to the generated parser that will + launch the ParseView debugger upon invocation. The default is "no". +
+ Note: ParseView is a separate component that needs to be installed or your + grammar will have compilation errors. + 		No
html + Emit an html version of the grammar with hyperlinked actions. + No
diagnostic + Generates a text file with debugging information based on the target grammar. + No
trace + Forces all rules to call traceIn/traceOut if set to "yes". + The default is "no". + No
traceParser + Only forces parser rules to call traceIn/traceOut if set to "yes". + The default is "no". + No
traceLexer + Only forces lexer rules to call traceIn/traceOut if set to "yes". + The default is "no". + No
traceTreeWalker + Only forces tree walker rules to call traceIn/traceOut if set to + "yes". The default is "no". + No
dirThe directory to invoke the VM in. No
+ +

Nested Elements

+ +

ANTLR supports a nested <classpath> +element, that represents a PATH like +structure. It is given as a convenience if you have to specify +the original ANTLR directory. In most cases, dropping the appropriate +ANTLR jar in the normal Ant lib repository will be enough.

+ +

jvmarg

+ +

Additional parameters may be passed to the new +VM via nested <jvmarg> attributes, for example:

+ +
+<antlr target="...">
+  <jvmarg value="-Djava.compiler=NONE"/>
+  ...
+</antlr>
+
+ +

would run ANTLR in a VM without JIT.

+ +

<jvmarg> allows all attributes described in Command line arguments.

+ +

Example

+
+<antlr
+    target="etc/java.g"
+    outputdirectory="build/src"
+/>
+
+

+ This invokes ANTLR on grammar file etc/java.g, writing the generated + files to build/src. +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/antstructure.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/antstructure.html new file mode 100644 index 000000000..ab7acc1a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/antstructure.html @@ -0,0 +1,100 @@ + + + + + + +AntStructure Task + + + + +

AntStructure

+

Description

+ +

Generates an DTD for Apache Ant buildfiles which contains information +about all tasks currently known to Ant.

+ +

Actually the DTD will not be a real DTD for buildfiles since Ant's +usage of XML cannot be captured with a DTD. Several elements in Ant +can have different attribute lists depending on the element that +contains them. "fail" for example can be the task or the nested child element of the sound task. Don't consider the +generated DTD something to rely upon.

+ +

Also note that the DTD generated by this task is incomplete, you can +always add XML entities using <taskdef> or <typedef>. See here for a way to get around this problem.

+

This task doesn't know about required attributes, all will be +listed as #IMPLIED.

+ +

Since Ant 1.7 custom structure printers can be used +instead of the one that emits a DTD. In order to plug in your own +structure, you have to implement the interface +org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter +and <typedef> your class and use the new type as a nested +element of this task - see the example below. + +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
outputfile to write the DTD to.Yes
+

Examples

+
+<antstructure output="project.dtd" />
+
+ +

Emitting your own structure instead of a DTD

+ +

First you need to implement the interface

+ +
+package org.example;
+import org.apache.tools.ant.taskdefs.AntStructure;
+public class MyPrinter implements AntStructure.StructurePrinter {
+    ...
+}
+
+ +

and then use it via typedef

+ +
+  <typedef name="myprinter" classname="org.example.MyPrinter" />
+  <antstructure output="project.my">
+    <myprinter />
+  </antstructure>
+
+ +

Your own StructurePrinter can accept attributes and nested elements +just like any other Ant type or task.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/antversion.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/antversion.html new file mode 100644 index 000000000..cd9f838af --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/antversion.html @@ -0,0 +1,95 @@ + + + + + + +Antversion Task + + + + +

Antversion

+

Description

+

+Stores the Apache Ant version (when used as task) or checks for a specific Ant version +(when used as condition). +Since Ant 1.7.0 +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired (Task)Required (Condition)
atleastThe version that this at least. + The format is major.minor.point.NoOne of these.
exactlyThe version that this ant is exactly. + The format is major.minor.point.No
propertyThe name of the property to set.YesNo (ignored)
+ + +

Examples

+ +
+<antversion property="antversion"/>
+
+

Stores the current Ant version in the property antversion.

+ +
+<antversion property="antversion" atleast="1.6"/>
+
+

Stores the Ant version in the property antversion if the current Ant version is 1.6.0 +or higher. Otherwise the property remains unset.

+ +
+<antversion property="ant-is-exact-7" exactly="1.7.0"/>
+
+

Sets the property ant-is-exact-7 if Ant 1.7.0 is running. Neither 1.6.5 nor 1.7.0 +would match.

+ +
+<condition property="Ant17isOnline">
+  <and>
+    <antversion exactly="1.7.0"/>
+    <http url="http://ant.apache.org"/>
+  </and>
+</condition>
+
+

Sets Ant17isOnline if Ant 1.7.0 is running and can get a non-error-response from +the Ant homepage.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/apply.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/apply.html new file mode 100644 index 000000000..6cf948fa7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/apply.html @@ -0,0 +1,499 @@ + + + + + + + Apply Task + + + + +

Apply/ExecOn

+

The name execon is deprecated and only kept for backwards +compatibility.

+

Description

+

Executes a system command. When the os attribute is specified, then +the command is only executed when Apache Ant is run on one of the specified operating +systems.

+ +

The files and/or directories of a number of Resource Collections +– including but not restricted to + FileSets, + DirSets + (since Ant 1.6) or + FileLists + (since Ant 1.6) +– + are passed as arguments to the system command.

+

If you specify a nested mapper, +the timestamp of each source file is compared to the timestamp of a +target file which is defined by the nested mapper element and searched +for in the given dest, if specified.

+

At least one fileset or filelist is required, +and you must not specify more than one mapper.

+ +

Note that you cannot interact with the forked program, the only way +to send input to it is via the input and inputstring attributes.

+ +

Running Ant as a background process on + Unix(-like) systems

+ +

If you run Ant as a background process (like ant &) + and use the <apply> task with spawn + set to false, you must provide explicit input to the + forked process or Ant will be suspended because it tries to read + from the standard input.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
executablethe command to execute without any command line + arguments.Yes
destthe directory where the command is expected to place + target files when it is executed. This attribute is valid only when used + in conjunction with a nested mapper; if omitted, the target filenames + returned by the mapper will be interpreted as absolute paths.No
spawnwhether or not you want the commands to be spawned.
+ If you spawn a command, its output will not be logged by ant.
+ The input, output, error, and result property settings are not active when spawning a process.
+ since Ant 1.6 + 		No, default is false
dirthe directory in which the command should be executed.No
relativewhether the filenames should be passed on the + command line as relative pathnames (relative to the base directory + of the corresponding fileset/list for source files or the + dest attribute for target files).No, default is false
forwardslashwhether the file names should be passed + with forward slashes even if the operating system requires other + file separator. The option is ignored if the system file separator + is a forward slash.No, default is false
oslist of Operating Systems on which the command may be + executed.No
osfamilyOS family as used in the <os> condition. + since Ant 1.7No
outputthe file to which the output of the command + should be redirected. If the error stream is not also redirected + to a file or property, it will appear in this output.No
errorThe file to which the standard error of the + command should be redirected. since Ant 1.6No
logErrorThis attribute is used when you wish to see error + output in Ant's log and you are redirecting output to a + file/property. The error output will not be included in the output + file/property. If you redirect error with the "error" or + "errorProperty" attributes, this will have no effect. + since Ant 1.6No
appendwhether output should be appended to or overwrite + an existing file. If you set parallel to false, you will probably + want to set this one to true.No, default is false
outputpropertythe name of a property in which the output of the + command should be stored. Unless the error stream is redirected + to a separate file or stream, this property will include the error + output.No
errorpropertyThe name of a property in which the standard error of the + command should be stored. since Ant 1.6No
inputA file from which the executed command's standard + input is taken. This attribute is mutually exclusive with the + inputstring attribute. since Ant 1.6No
inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute. since Ant 1.6No
resultpropertythe name of a property in which the return code + of the command should be stored. Only of interest if + failonerror=false. If you set parallel to false, only the result + of the first execution will be stored.No
timeoutStop the command if it doesn't finish within the + specified time (given in milliseconds).No
failonerrorStop the buildprocess if the command exits with a + returncode other than 0.No
failifexecutionfailsStop the build if we can't start the program. + Defaults to true. No
skipemptyfilesetsDon't run the command, if no source files have + been found or are newer than their corresponding target + files. Despite its name, this attribute applies to filelists as + well.No, default is false
parallelRun the command only once, appending all files as + arguments. If false, command will be executed once for every file.No, default is false
typeOne of file, dir or + both. If set to file, only the names of plain + files will be sent to the command. If set to dir, only + the names of directories are considered.
+ Note: The type attribute does not apply to + nested dirsets - dirsets always implicitly + assume type to be dir.		No, default is file
newenvironmentDo not propagate old environment when new environment + variables are specified.No, default is false
vmlauncherRun command using the Java VM's execution facilities + where available. If set to false the underlying OS's shell, + either directly or through the antRun scripts, will be used. + Under some operating systems, this gives access to facilities + not normally available through the VM including, under Windows, + being able to execute scripts, rather than their associated + interpreter. If you want to specify the name of the + executable as a relative path to the directory given by the + dir attribute, it may become necessary to set vmlauncher to + false as well.No, default is true
resolveExecutableWhen this attribute is true, the name of the + executable if resolved firstly against the project basedir and if + that does not exist, against the execution directory if + specified. On Unix systems, if you only want to allow execution of + commands in the user's path, set this to false. + since Ant 1.6No, default is false
maxparallelLimit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Since Ant 1.6.No, unlimited by default
addsourcefileWhether source file names should be added to the + command automatically. Since Ant 1.6.No, default is true
verboseWhether to print a summary after execution or not. + Since Ant 1.6.No, default false
ignoremissingWhether to ignore nonexistent files specified + via filelists. Since Ant 1.6.2.No, default is true
forceWhether to bypass timestamp comparisons + for target files. Since Ant 1.6.3.No, default is false
+

Parameters specified as nested elements

+

fileset

+

You can use any number of nested <fileset> +elements to define the files for this task and refer to +<fileset>s defined elsewhere.

+

filelist

+

Since Ant 1.6

+

You can use any number of nested <filelist> +elements to define the files for this task and refer to +<filelist>s defined elsewhere.

+

dirset

+

Since Ant 1.6

+

You can use any number of nested <dirset> +elements to define the directories for this task and refer to +<dirset>s defined elsewhere.

+ +

Any other Resource +Collection

+

since Ant 1.7

+

You can use any number of nested resource collections.

+ +

mapper

+

A single <mapper> specifies the target files relative +to the dest attribute for dependency checking. If the +dest attribute is specified it will be used as a base directory +for resolving relative pathnames returned by the mapper. At least one +<fileset> or <filelist> is required.

+

arg

+

Command line arguments should be specified as nested +<arg> elements. See Command line arguments.

+

srcfile

+

By default the file names of the source files will be added to the +end of the command line (unless you set addsourcefile to +false). If you need to place it somewhere different, +use a nested <srcfile> element between your +<arg> elements to mark the insertion point.

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
prefixa prefix to place in front of the file name when + building the command line argument. Since Ant 1.8.0No.
suffixa suffix to append to the file name when + building the command line argument. Since Ant 1.8.0No.
+

targetfile

+

<targetfile> is similar to +<srcfile> and marks the position of the target +filename on the command line. If omitted, the target filenames will +not be added to the command line at all. This element can only be +specified if you also define a nested mapper.

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
prefixa prefix to place in front of the file name when + building the command line argument. Since Ant 1.8.0No.
suffixa suffix to append to the file name when + building the command line argument. Since Ant 1.8.0No.
+

env

+

It is possible to specify environment variables to pass to the +system command via nested <env> elements. See the +description in the section about exec

+

redirector

+Since Ant 1.6.2 +

A nested I/O Redirector +can be specified. <apply>'s behavior is like that of +exec with regard to +redirectors, with the exception that, in non-parallel mode, +file mapping will take place with each iteration. This grants the +user the capacity to receive input from, and send output to, different +files for each sourcefile. +

+

In parallel-mode the redirector will be reset for each batch + of executions (with maxparallel > 0) and null will be used + a source file just like it is in the case of exec.

+

Examples

+
+<apply executable="ls">
+  <arg value="-l"/>
+  <fileset dir="/tmp">
+    <patternset>
+      <exclude name="**/*.txt"/>
+    </patternset>
+  </fileset>
+  <fileset refid="other.files"/>
+</apply>
+
+

invokes ls -l, adding the absolute filenames of all +files below /tmp not ending in .txt and all +files of the FileSet with id other.files to +the command line.

+
+<apply executable="somecommand" parallel="false">
+  <arg value="arg1"/>
+  <srcfile/>
+  <arg value="arg2"/>
+  <fileset dir="/tmp"/>
+</apply>
+
+

invokes somecommand arg1 SOURCEFILENAME arg2 for each +file in /tmp replacing SOURCEFILENAME with the absolute +filename of each file in turn. If parallel had been set +to true, SOURCEFILENAME would be replaced with the absolute filenames +of all files separated by spaces.

+
+<apply executable="cc" dest="src/C" parallel="false">
+  <arg value="-c"/>
+  <arg value="-o"/>
+  <targetfile/>
+  <srcfile/>
+  <fileset dir="src/C" includes="*.c"/>
+  <mapper type="glob" from="*.c" to="*.o"/>
+</apply>
+
+

invokes cc -c -o TARGETFILE SOURCEFILE for each +.c file that is newer than the corresponding +.o, replacing TARGETFILE with the absolute filename of +the .o and SOURCEFILE with the absolute name of the +.c file.

+
+<mapper id="out" type="glob"
+           from="src${file.separator}*.file"
+           to="dest${file.separator}*.out"/>
+
+<apply executable="processfile" dest="dest">
+  <fileset dir="src" includes="*.file"/>
+  <mapper refid="out"/>
+  <redirector>
+    <outputmapper refid="out"/>
+  </redirector>
+</apply>
+
+Applies the fictitious "processfile" executable to all +files matching *.file in the src directory. +The out <mapper> has been set up to map +*.file to *.out, then this <mapper> +is used to specify targetfiles for this <apply> +task. A reference to out is then used as an +<outputmapper> nested in a <redirector>, which in turn is +nested beneath this <apply> instance. This allows us to perform +dependency checking against output files--the target files in this case. +
+<apply executable="ls" parallel="true"
+       force="true" dest="${basedir}" append="true" type="both">
+  <path>
+    <pathelement path="${env.PATH}"/>
+  </path>
+  <identitymapper/>
+</apply>
+
+Applies the "ls" executable to all directories in the PATH, effectively +listing all executables that are available on the PATH. + +
+<apply executable="jsmin" addsourcefile="false">
+    <!-- Collect the JS-files -->
+    <fileset dir="src" includes="*.js"/>
+    <redirector>
+        <!-- redirect STDIN; fileset collects relative to its dir, but we need -->
+        <!-- relative to basedir -->
+        <inputmapper type="glob" from="*" to="src/*"/>
+        <!-- redirect STDOUT to file in dest-dir -->
+        <outputmapper id="out" type="glob" from="*.js" to="dest/*.js"/>
+    </redirector>
+</apply>
+
+Conversion of the command jsmin < src/a.js > dest/a.js but for +all files in the src-directory. Because the filename itself should not be passed +to the jsmin program, the addsourcefile is set to +false. + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/apt.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/apt.html new file mode 100644 index 000000000..6298cfa7d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/apt.html @@ -0,0 +1,183 @@ + + + +Apt Task + + + +

Apt

+

Description

+

Runs the annotation processor tool (apt), and then optionally compiles + the original code, and any generated source code. This task requires Java 1.5. + It may work on later versions, but this cannot be confirmed until those + versions ship. Be advised that the Apt tool does appear to be an unstable + part of the JDK framework, so may change radically in future versions. + In particular it is likely to be obsolete in JDK 6, which can run annotation + processors as part of javac. + If the <apt> task does break when upgrading JVM, please + check to see if there is a more recent version of Apache Ant that tracks + any changes.

+ + +

This task inherits from the Javac Task, and thus + supports nearly all of the same attributes, and subelements. + There is one special case, the fork attribute, which is present + but which can only be set to true. That is, apt only works as + a forked process. +

+

+ In addition, it supports + the following addition items:

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
compileAfter running the Apt, should the code be compiled. (see the + -nocompile flag on the Apt executable)No, defaults to false.
factoryThe fully qualified classname of the AnnotationProcessFactory to be used + to construct annotation processors. This represents the -factory + command line flag of the Apt executable.No
factorypathrefThe reference id of the path used to find the classes needed by the + AnnotationProcessorFactory (and the location of the factory itself). + This represents the -factorypath flag on the Apt executable.No
preprocessdirThe directory used for preprocessing. This is the directory where the + generated source code will be place. This represents the -s flag on + the Apt executable.No
+ +

Parameters specified as nested elements

+ + +

factorypath

+ +

You can specify the path used to find the classes needed by the AnnotationProcessorFactory + at runtime, using this element. It is represents as a generic path like structure. This + represents the -factorypath flag on the Apt executable.

+ + +

option

+ +

Used to represent a generic option to pass to Apt. This represents the -A flag on the + Apt executable. You can specify zero or more <option> elements.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the optionYes.
valueThe value to set the option toYes.
+ +

Examples

+
+<apt srcdir="${src}"
+     destdir="${build}"
+     classpath="xyz.jar"
+     debug="on"
+     compile="true"
+     factory="com.mycom.MyAnnotationProcessorFactory"
+     factorypathref="my.factorypath.id"
+     preprocessdir="${preprocess.dir}">
+</apt>
+
+

compiles all .java files under the ${src} +directory, and stores +the .class files in the ${build} directory. +The classpath used includes xyz.jar, and compiling with +debug information is on. It also forces the generated source code to +be compiled. The generated source code will be placed in +${preprocess.dir} directory, using the class +com.mycom.MyAnnotationProcessorFactory to supply +AnnotationProcessor instances.

+ + +

Notes

+ +

+The inherited "fork" attribute is set to true by default; please do not change it. +

+ +

+The inherited "compiler" attribute is ignored, as it is forced to use the Apt compiler +

+ +

Using the Apt compiler with the "compile" option set to "true" + forces you to use Sun's Apt compiler, which will use the JDK's Javac compiler. + If you wish to use another compiler, you will first need run the Apt processor + with the "compile" flag set to "false", and then use a + <javac> task to compile first your original source code, and then the + generated source code:

+ +
+<apt srcdir="${src}"
+     destdir="${build}"
+     classpath="xyz.jar"
+     debug="true"
+     compile="false"
+     factory="com.mycom.MyAnnotationProcessorFactory"
+     factorypathref="my.factorypath.id"
+     preprocessdir="${preprocess.dir}">
+</apt>
+
+<javac srcdir="${src}"
+       destdir="${build}"
+       classpath="xyz.jar"
+       debug="on"/>
+
+<javac srcdir="${preprocess.dir}"
+       destdir="${build}"
+       classpath="xyz.jar"
+       debug="true"/>
+
+ +This may involve more build file coding, but the speedup gained from switching +to jikes may justify the effort. +

+

+ + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/attrib.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/attrib.html new file mode 100644 index 000000000..a26f0c555 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/attrib.html @@ -0,0 +1,167 @@ + + + + + + +Apache Ant User Manual + + + + +

Attrib

+

Since Apache Ant 1.6.

+

Description

+ +

Changes the attributes of a file or all files inside specified +directories. Right now it has effect only under Windows. Each of the +4 possible permissions has its own attribute, matching the arguments +for the attrib command.

+ +

FileSets, +DirSets or FileLists can be specified using +nested <fileset>, <dirset> and +<filelist> elements.

+ +

Starting with Ant 1.7, this task supports arbitrary Resource Collections +as nested elements.

+ + + +

By default this task won't do anything unless it detects it is + running on a Windows system. If you know for sure that you have a + "attrib" executable on your PATH that is command line compatible with + the Windows command, you can use the task's os attribute and set its + value to your current os.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe file or directory of which the permissions must be + changed.Yes or nested + <fileset/list> elements.
readonlythe readonly permission.at least one of the four.
archivethe archive permission.
systemthe system permission.
hiddenthe hidden permission.
typeOne of file, dir or both. If set to + file, only the permissions of plain files are going to be changed. + If set to dir, only the directories are considered.
+ Note: The type attribute does not apply to + nested dirsets - dirsets always implicitly + assume type to be dir.		No, default is file
verboseWhether to print a summary after execution or not. + Defaults to false.No
oslist of Operating Systems on which the command may be + executed.No
osfamilyOS family as used in + the <os> + condition.No - defaults to "windows"
+ +

Examples

+
+
<attrib file="${dist}/run.bat" readonly="true" hidden="true"/>
+
+

makes the "run.bat" file read-only and hidden.

+ +
+ 
<attrib readonly="false">
+  <fileset dir="${meta.inf}" includes="**/*.xml"/>
+</attrib>
+
+
+

makes all ".xml" files below ${meta.inf} readable.

+ +
+ 
+<attrib readonly="true" archive="true">
+  <fileset dir="shared/sources1">
+    <exclude name="**/trial/**"/>
+  </fileset>
+  <fileset refid="other.shared.sources"/>
+</attrib>
+
+
+

makes all files below shared/sources1 (except those below any + directory named trial) read-only and archived. In addition all files belonging + to a FileSet with id other.shared.sources get the + same attributes.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/augment.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/augment.html new file mode 100644 index 000000000..305e39a83 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/augment.html @@ -0,0 +1,83 @@ + + + + + + +Augment Task + + + + +

Augment

+ +

Description

+

Modify an existing reference by adding nested elements or (re-)assigning properties +mapped as XML attributes. This is an unusual task that makes use of Ant's internal +processing mechanisms to reload a previously declared reference by means of the 'id' +attribute, then treats the declared augment element as though it were the +original element. +Since Apache Ant 1.8.1

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
idThe id of the reference to augment. If no such reference has + been declared a BuildException is generated.Yes
+

+Additional permissible attributes are dependent on the reference to be modified. +

+ +

Parameters specified as nested elements

+ +

+Permissible nested elements are dependent on the reference to be modified. +

+ +

Examples

+ +Given +
+  <fileset id="input-fs" dir="${basedir}" />
+
+ +
+  <augment id="input-fs" excludes="foo" />
+
+ +

Modifies the excludes attribute of input-fs.

+ +
+  <augment id="input-fs">
+    <filename name="bar" />
+  </augment>
+
+ +

Adds a filename selector to input-fs.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/available.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/available.html new file mode 100644 index 000000000..6e4a17185 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/available.html @@ -0,0 +1,160 @@ + + + + + + +Available Task + + + + +

Available

+

Description

+

Sets a property if a resource is available at runtime. This resource can be a +file, a directory, a class in the classpath, or a JVM system resource.

+

If the resource is present, the property value is set to true by +default; otherwise, the property is not set. You can set the value to +something other than the default by specifying the value attribute.

+

Normally, this task is used to set properties that are useful to avoid target +execution depending on system parameters.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe name of the property to set.Yes
valueThe value to set the property to. Defaults to "true".No
classnameThe class to look for in the classpath.Yes
fileThe file to look for.
resourceThe resource to look for in the JVM.
classpathThe classpath to use when looking up classname or resource.No
filepathThe path to use when looking up file.No
classpathrefThe classpath to use, given as a reference to a path defined elsewhere.No
typeThe type of file to look for, either a directory (type="dir") or a file + (type="file"). If not set, the property will be set if the name specified in the file + attribute exists as either a file or a directory.No
ignoresystemclassesIgnore Ant's runtime classes, using only the specified + classpath. Only affects the "classname" attribute. Defaults to "false"No
searchparentsThis contains the behaviour of the "file" type. + If true, the available task will, when + searching for a file, search not only the directories specified but + will also search the parent directories of those + specified. + If false, only the directories specified will be searched. + Defaults to "false". + Since Ant 1.7 + No
+

Parameters specified as nested elements

+

classpath

+

Available's classpath attribute is a path-like structure and can also be set via a nested +<classpath> element.

+

filepath

+

Available's filepath attribute is a path-like structure and can also be set via a nested +<filepath> element.

+

Examples

+
+<available classname="org.whatever.Myclass" property="Myclass.present"/>
+
+

sets the Myclass.present property to the value "true" +if the class org.whatever.Myclass is found in Ant's classpath.

+
+<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
+<available file="${jaxp.jar}" property="jaxp.jar.present"/>
+
+

sets the jaxp.jar.present property to the value "true" +if the file ./lib/jaxp11/jaxp.jar is found.

+
+<available file="/usr/local/lib" type="dir"
+           property="local.lib.present"/>
+
+

sets the local.lib.present property to the value "true" +if the directory /usr/local/lib is found.

+
+...in project ...
+<property name="jaxp.jar" value="./lib/jaxp11/jaxp.jar"/>
+<path id="jaxp" location="${jaxp.jar}"/>
+...in target ...
+<available classname="javax.xml.transform.Transformer"
+           classpathref="jaxp" property="jaxp11.present"/>
+
+

sets the jaxp11.present property to the value "true" +if the class javax.xml.transform.Transformer is found in the classpath referenced by jaxp (in this case, ./lib/jaxp11/jaxp.jar). +

+
+<available property="have.extras" resource="extratasks.properties">
+  <classpath>
+    <pathelement location="/usr/local/ant/extra.jar" />
+  </classpath>
+</available>
+
+

sets the have.extras property to the value "true" +if the resource-file extratasks.properties is found. +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/basename.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/basename.html new file mode 100644 index 000000000..0822d8f9e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/basename.html @@ -0,0 +1,92 @@ + + + + + + +Basename Task + + + + +

Basename

+

Description

+

+Task to determine the basename of a specified file, optionally minus a +specified suffix. +

+

+When this task executes, it will set the specified property to the +value of the last path element of the specified file. If file is a +directory, the basename will be the last directory element. If +file is a full-path, relative-path, or simple filename, +the basename will be the simple file name, without any directory elements. +

+

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe path to take the basename of.Yes
propertyThe name of the property to set.Yes
suffixThe suffix to remove from the resulting basename + (specified either with or without the ".").No
+ +

Examples

+
+<basename property="jar.filename" file="${lib.jarfile}"/>
+
+will set jar.filename to +myjar.jar, if lib.jarfile is defined as either a +full-path filename (eg., /usr/local/lib/myjar.jar), +a relative-path filename (eg., lib/myjar.jar), +or a simple filename (eg., myjar.jar). +
+<basename property="cmdname" file="D:/usr/local/foo.exe"
+          suffix=".exe"/>
+
+will set cmdname to foo. +
+<property environment="env"/>
+<basename property="temp.dirname" file="${env.TEMP}"/>
+
+ +will set temp.dirname to the last directory element of +the path defined for the TEMP environment variable.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/bindtargets.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/bindtargets.html new file mode 100644 index 000000000..d8374a49c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/bindtargets.html @@ -0,0 +1,92 @@ + + + + + + +Bindtargets Task + + + + +

Bindtargets

+

Description

+ +

Make some target the extension of some defined +extension point. It will make the +list of targets dependencies of the extension point.

+ +

This target is useful when you want to have a target participate to another +build workflow, build workflow which explicitly expose an extension point for +that kind of insertion. But the target to bind and the extension point to +bind to are both declared in some imported build files. Modifying directly the +target dependency graph of these external build files may have a side effect +on some other project which import them. This task helps then to modify the +target dependencies but only in your context. +

+ +

Note: this task is quite equivalent to the definition of an intermediate +target which will be the bridge between the target to bind and the extension +point. For instance: +

+
<bindtargets targets="jar,javadoc" extensionPoint="dist" />
+is quite equivalent to: +
<target name="bind-to-dist" depends="jar,javadoc" extensionOf="dist" />
+

+This task basically avoid the creation of a target. +

+ +

The bindtargets task may only be used as a top-level task. This means that +it may not be used in a target. This is making the target dependency graph static +and predictable as soon as every build file is loaded.

+ +

Since Apache Ant 1.8.2

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetsa comma separated list of target names to bind.Yes
extensionPointthe name of the extension point to bind the targets to.Yes
onMissingExtensionPointWhat to do if this target tries to extend a missing + extension-point. ("fail", + "warn", "ignore").No. Defaults to fail
+ +

Examples

+
+<bindtargets targets="build-jar,build-src-jar" extensionPoint="dist" />
+
+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/buildnumber.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/buildnumber.html new file mode 100644 index 000000000..aaaa14cd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/buildnumber.html @@ -0,0 +1,74 @@ + + + + + + +BuildNumber Task + + + + +

BuildNumber

+

Description

+

This is a basic task that can be used to track build numbers.

+

It will first attempt to read a build number from a file (by default, +build.number in the current directory), then +set the property build.number to the value that was read in +(or to 0, if no such value). It will then increment the +number by one and write it back out to the file. +(See the +PropertyFile task +if you need finer control over things such as the property name or +the number format.) +

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to read and write the build number from/to.No; defaults to "build.number"
+ +

Examples

+
+<buildnumber/>
+
+ +

Read, increment, and write a build number to the default file, +build.number.

+ +
+<buildnumber file="mybuild.number"/>
+
+ +

Read, increment, and write a build number to the file +mybuild.number.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/cab.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/cab.html new file mode 100644 index 000000000..e981827a5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/cab.html @@ -0,0 +1,167 @@ + + + + + + +Cab Task + + + + +

Cab

+

Description

+

The cab task creates Microsoft cab archive files. It is invoked +similar to the jar or zip tasks. +This task will work on Windows using the external cabarc tool (provided by Microsoft) +which must be located in your executable path.

+

To use this task on other platforms you need to download and compile libcabinet from + +http://trill.cis.fordham.edu/~barbacha/cabinet_library/.

+

See the section on directory based +tasks, on how the inclusion/exclusion of files works, and how to +write patterns.

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes basedir) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
cabfilethe name of the cab file to create.Yes
basedirthe directory to start archiving files from.No
verboseset to "yes" if you want to see the output from + the cabarc tool. defaults to "no".No
compressset to "no" to store files without compressing. + defaults to "yes".No
optionsuse to set additional command-line options for + the cabarc tool. should not normally be necessary.No
includescomma- or space-separated list of patterns of files that + must be included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that + must be excluded. No files (except default excludes) are excluded + when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used + or not ("yes"/"no"). Default excludes are used when omitted.No
+

Parameters specified as nested elements

+

fileset

+ +

The cab task supports one nested <fileset> +element to specify the files to be included in the archive. + If this is specified, the "basedir" attribute cannot be used. +

+ +

Examples

+
+<cab cabfile="${dist}/manual.cab"
+     basedir="htdocs/manual"
+  />
+
+

cabs all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory.

+
+<cab cabfile="${dist}/manual.cab"
+     basedir="htdocs/manual"
+     excludes="mydocs/**, **/todo.html"
+  />
+
+

cabs all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory. Files in the directory mydocs, +or files with the name todo.html are excluded.

+
+<cab cabfile="${dist}/manual.cab"
+     basedir="htdocs/manual"
+     includes="api/**/*.html"
+     excludes="**/todo.html"
+     verbose="yes"
+  />
+
+

Cab all files in the htdocs/manual directory into a file called +manual.cab in the ${dist} directory. Only html files under the +directory api are archived, and files with the name todo.html are +excluded. Output from the cabarc tool is displayed in the build +output.

+ +
+<cab cabfile="${dist}/manual.cab"
+     verbose="yes">
+  <fileset
+       dir="htdocs/manual"
+       includes="api/**/*.html"
+       excludes="**/todo.html"
+  />
+</cab>
+
+

is equivalent to the example above.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/ccm.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/ccm.html new file mode 100644 index 000000000..714a4eeb5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/ccm.html @@ -0,0 +1,273 @@ + + + + + + +Continuus Tasks + + + + +

Continuus Support

+ + +

These Apache Ant tasks are wrappers around Continuus Source Manager. They have been tested + against versions 5.1/6.2 on Windows 2000, but should work on other platforms with ccm installed.

+

author: Benoit Mousaud (benoit.moussaud@criltelecom.com)

+
+

CCMCheckin

+

Description

+Task to checkin a file +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
filePath to the file that the command will operate onYes
commentSpecify a comment. Default is "Checkin" plus the dateNo
taskSpecify the task number used to check in the file (may use 'default')No
ccmdirpath to the ccm executable file, required if it is not on the PATHNo
+

Examples

+
+ 
<ccmcheckin file="c:/wa/com/foo/MyFile.java"
+        comment="mycomment"/>
+
+
+

Checks in the file c:/wa/com/foo/MyFile.java. + Comment attribute mycomment is added as a task comment. The task + used is the one set as the default.

+
+

CCMCheckout

+

Description

+Task to perform a Checkout command to Continuus +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
filePath to the file that the command will operate onYes (file|fileset)
filesetfileset containing the file to be checked out
commentSpecify a comment.No
taskSpecify the task number used to checkin the file (may use + 'default')No
ccmdirpath to the ccm executable file, required if it is not on the PATHNo
+

Examples

+
+ 
<ccmcheckout file="c:/wa/com/foo/MyFile.java"
+        comment="mycomment"/>
+
+
+

Check out the file c:/wa/com/foo/MyFile.java. + Comment attribute mycomment is added as a task comment + The used task is the one set as the default.

+
+ 
<ccmcheckout  comment="mycomment">
+  <fileset dir="lib" >
+    <include name="**/*.jar"/>
+  </fileset>
+</ccmcheckout >
+
+
+ +

Check out all the files in the lib directory having the .jar extension. + Comment attribute mycomment is added as a task comment + The used task is the one set as the default.

+ + + +
+

CCMCheckinTask

+

Description

+Task to perform a check in default task command to Continuus +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
commentSpecify a comment.No
taskSpecify the task number used to check in the file (may use 'default')No
ccmdirpath to the ccm executable file, required if it is not on the PATHNo
+

Examples

+
+ 
<ccmcheckintask comment="blahblah/>
+
+
+

Does a Checkin default task on all the checked out files in the current task.

+
+

CCMReconfigure

+

Description

+Task to perform an reconfigure command to Continuus. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
recurserecurse on subproject (default false)No
verbosedo a verbose reconfigure operation (default false)No
ccmprojectSpecifies the ccm project on which the operation is applied.Yes
ccmdirpath to the ccm executable file, required if it is not on the PATHNo
+

Examples

+
+ 
<ccmreconfigure ccmproject="ANTCCM_TEST#BMO_1"
+         verbose="true"/>
+
+
+

Does a Continuus reconfigure on the project ANTCCM_TEST#BMO_1. +

+
+

CCMCreateTask

+

Description

+Create a Continuus task. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
commentSpecify a comment.No
platformSpecify the target platformNo
ccmdirpath to the ccm executable file, required if it is not on the PATHNo
resolverSpecify the resolverNo
releaseSpecify the CCM releaseNo
subsystemSpecify the subsystemNo
taskSpecify the task number used to checkin the file (may use 'default')No
+

Examples

+
+ 
<ccmcreatetask resolver="${user.name}"
+            release="ANTCCM_TEST" comment="blahblah"/>
+
+
+

Creates a task for the release ANTCCM_TEST with the + current user as the resolver for this task.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/changelog.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/changelog.html new file mode 100644 index 000000000..ecd9faff4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/changelog.html @@ -0,0 +1,294 @@ + + + + + + +ChangeLog Task + + + + +

CvsChangeLog

+

Description

+

Generates an XML-formatted report file of the change logs recorded in a +CVS repository.

+

Important: This task needs "cvs" on the path. If it isn't, you will get +an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs exceutable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + included in the report. + Since Ant 1.8.0 + + +
AttributeDescriptionRequired
Attributes from parent Cvs task which are meaningful here
+ Since Apache Ant 1.6.1
cvsRootthe CVSROOT variable.No
cvsRshthe CVS_RSH variable.No
packagethe package/module to check out. Note: + multiple attributes can be split using spaces. Use a nested + <module> element if you want to specify a module with + spaces in its name.No
portPort used by CVS to communicate with the server.No, default port 2401.
passfilePassword file to read passwords from.No, default file ~/.cvspass.
failonerrorStop the build process if the command exits with a + return code other than 0. Defaults to falseNo
tagquery the changelog for a specific branch.No
Specific attributes
dirThe directory from which to run the CVS log + command.No; defaults to ${basedir}.
destfileThe file in which to write the change log report.Yes
usersfileProperty file that contains name-value pairs mapping + user IDs and names that should be used in the report in place of + the user ID.No
daysinpastSets the number of days into the past for which the + change log information should be retrieved.No
startThe earliest date from which change logs are to be + included in the report.No
endThe latest date to which change logs are to be + included in the report.No
remoteIf set to true, works against the repository + (using rlog) without a working copy. Default is + false. Since Ant 1.8.0No
startTagThe start of a tag range. If endTag is also + specified, they must both be on the same branch. If endTag is not + specified, the end of the range will be the latest on the same + branch on which startTag lives. Since Ant 1.8.0No
endTagThe end of a tag range. If startTag is also + specified, they must both be on the same branch. If startTag is + not specified, the start of the range will be the top of the + branch on which endTag lives.No
+ +

Parameters specified as nested elements

+

user

+

The nested <user> element allows you to specify a +mapping between a user ID as it appears on the CVS server and a name to +include in the formatted report. +Anytime the specified user ID has made a change in the repository, the +<author> tag in the report file will include +the name specified in displayname rather than the user ID. +

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
displaynameThe name to be used in the CVS change log report.Yes
useridThe userid of the person as it exists on the CVS server. + Yes
+ +

module

+ +

Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.

+ + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe module's/package's name.Yes.
+ +

Examples

+
  <cvschangelog dir="dve/network"
+                destfile="changelog.xml"
+  />
+ +

Generates a change log report for all the changes that have been made +under the dve/network directory. +It writes these changes into the file changelog.xml.

+ +
  <cvschangelog dir="dve/network"
+                destfile="changelog.xml"
+                daysinpast="10"
+  />
+ +

Generates a change log report for any changes that were made +under the dve/network directory in the past 10 days. +It writes these changes into the file changelog.xml.

+ +
  <cvschangelog dir="dve/network"
+                destfile="changelog.xml"
+                start="20 Feb 2002"
+                end="20 Mar 2002"
+  />
+ +

Generates a change log report for any changes that were made +between February 20, 2002 and March 20, 2002 +under the dve/network directory. +It writes these changes into the file changelog.xml.

+ +
  <cvschangelog dir="dve/network"
+                destfile="changelog.xml"
+                start="20 Feb 2002"
+  />
+ +

Generates a change log report for any changes that were made +after February 20, 2002 under the dve/network directory. +It writes these changes into the file changelog.xml.

+ +
  <cvschangelog dir="dve/network"
+                destfile="changelog.xml">
+       <user displayname="Peter Donald" userid="donaldp"/>
+  </cvschangelog>
+ +

Generates a change log report for all the changes that were made +under the dve/network directory, substituting the name +"Peter Donald" in the <author> tags +anytime it encounters a change made by the user ID "donaldp". +It writes these changes into the file changelog.xml.

+ +

Generates a change log report on the ANT_16_BRANCH.

+
+ <cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
+                destfile="changelogant.xml" tag="ANT_16_BRANCH"/>
+
+

Generate Report

+

Ant includes a basic XSLT stylesheet that you can use to generate +a HTML report based on the xml output. The following example illustrates +how to generate a HTML report from the XML report.

+ +
+        <style in="changelog.xml" 
+               out="changelog.html" 
+               style="${ant.home}/etc/changelog.xsl">
+          <param name="title" expression="Ant ChangeLog"/>
+          <param name="module" expression="ant"/>
+          <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
+        </style>
+
+ +

Sample Output

+
+<changelog>
+  <entry>
+    <date>2002-03-06</date>
+    <time>12:00</time>
+    <author>Peter Donald</author>
+    <file>
+      <name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
+      <revision>1.3</revision>
+      <prevrevision>1.2</prevrevision>
+    </file>
+    <msg><![CDATA[Use URLs directly rather than go via a File.
+
+This allows templates to be stored inside jar]]></msg>
+  </entry>
+</changelog>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/checksum.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/checksum.html new file mode 100644 index 000000000..1754af7f6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/checksum.html @@ -0,0 +1,268 @@ + + + + + + +Checksum Task + + + + +

Checksum

+

Description

+

+Generates checksum for files. This task can also be used to +perform checksum verifications. +

+ +

Note that many popular message digest functions - including MD5 and +SHA-1 - have been broken recently. If you are going to use the task +to create checksums used in an environment where security is +important, please take some time to investigate the algorithms offered +by your JCE provider. Note also that some JCE providers like the one +by The Legion of the Bouncy +Castle, the GNU +project or the +Technical University Graz offer more digest algorithms than those +built-in into your JDK.

+ +

+Warning: the case of the extension is that of the algorithm used. +If you ask for "SHA1", you get a .SHA1 extension; if you ask for "sha1", you +get a file ending in .sha1. The Java Crypto Engines are case-insensitive +in matching algorithms, so choose a name to match your desired output extension, +or set the fileext attribute. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to generate checksum for.One of either file or + at least one nested (filesystem-only) resource collection.
todirThe root directory where checksums should be written.No. If not specified, checksum files + will be written to the same directory as the files themselves. + since Apache Ant 1.6 +
algorithmSpecifies the algorithm to be used to + compute the checksum. Defaults to "MD5". + Other popular algorithms like "SHA" or "SHA-512" may be used + as well. + No
providerSpecifies the provider of the algorithm.No
fileextThe generated checksum file's name will be the + original filename with the fileext added to it. + Defaults to a "." and the algorithm name being used. + No
propertyThis attribute can mean two different things, it + depends on the presence of the verifyproperty attribute.
+ If you don't set the verifyproperty attribute, property + specifies the name of the property to be set with the generated + checksum value.
+ If you set the verifyproperty attribute, property specifies + the checksum you expect to be generated (the checksum itself, not + a name of a property containing the checksum).
+ This cannot be specified when fileext is being used or when the + number of files for which checksums is to be generated is greater + than 1. + 		No
patternSpecifies the pattern to use as a pattern + suitable + for MessageFormat + where {0} is replaced with the checksum and + {1} with the file name. Since Ant + 1.7.0
+ starting with Ant 1.8.2 {2} is replaced by + the path of the file relative to the checksum file being + written, {3} with tha path of the file relative to + the project's basedir and {4} with the absolute + path of the file.		No - default is "{0}".
formatSpecifies the pattern to use as one of a + well-known format. Supported values are + + + + + + + + + + + + + + + + + + + + + +
namepatterndescription
CHECKSUM {0}only the checksum itself
MD5SUM {0} *{1}the format of GNU textutils md5sum
SVF MD5 ({1}) = {0}the format of BSDs md5 command
+ Since Ant 1.7.0 + 		No - default is "CHECKSUM".
totalpropertyIf specified, this attribute specifies the name of + the property that will hold a checksum of all the checksums and + file paths. The individual checksums and the relative paths to the files + within the resource collections in which they are defined will be used to + compute this checksum. (The file separators in the paths will be + converted to '/' before computation to ensure platform portability). + since Ant 1.6 + No
forceoverwriteOverwrite existing files even if the destination + files are newer. Defaults to "no".No
verifypropertySpecifies the name of the property to be set + with "true" or "false" depending upon whether + the generated checksum matches the existing checksum. When + this is set, the generated checksum is not written to a file or + property, but rather, the content of the file or property is used to + check against the generated checksum. + No
readbuffersizeThe size of the buffer (in bytes) to use when + reading a file. Defaults to "8192" - you may get a + better performance on big files if you increase this value.No
+

Parameters specified as nested elements

+ +

resource collection

+

+ Resource collections are + used to select files for which checksums should be generated. +

+ +

Examples

+

Example 1

+
<checksum file="foo.bar"/>
+Generates a MD5 checksum for foo.bar and stores the checksum in the destination file +foo.bar.MD5. foo.bar.MD5 is overwritten only if foo.bar is newer than itself. + +

Example 2

+
<checksum file="foo.bar" forceOverwrite="yes"/>
+Generates a MD5 checksum for foo.bar and stores the checksum in foo.bar.MD5. +If foo.bar.MD5 already exists, it is overwritten. + +

Example 3

+
<checksum file="foo.bar" property="foobarMD5"/>
+Generates a MD5 checksum for foo.bar and stores it in the Project Property foobarMD5. + +

Example 4

+
<checksum file="foo.bar" verifyProperty="isMD5ok"/>
+Generates a MD5 checksum for foo.bar, compares it against foo.bar.MD5 and sets +isMD5ok to either true or false, depending upon the result. + +

Example 5

+
<checksum file="foo.bar" algorithm="SHA-512" fileext="asc"/>
+Generates a SHA-512 checksum for foo.bar and stores the checksum in the destination file +foo.bar.asc. foo.bar.asc is overwritten only if foo.bar is newer than itself. + +

Example 6

+
+<checksum file="foo.bar" property="${md5}" verifyProperty="isEqual"/>
+
+Generates a MD5 checksum for foo.bar, compares it against the value of the property +md5, and sets isEqual to either true or false, depending upon the result. + +

Example 7

+
+<checksum>
+  <fileset dir=".">
+    <include name="foo*"/>
+  </fileset>
+</checksum>
+
+Works just like Example 1, but generates a .MD5 file for every file that begins with the name foo. + +

Example 8

+
+<condition property="isChecksumEqual">
+  <checksum>
+    <fileset dir=".">
+      <include name="foo.bar"/>
+    </fileset>
+  </checksum>
+</condition>
+
+Works like Example 4, but only sets isChecksumEqual to true, if the +checksum matches - it will never be set to false. This example +demonstrates use with the Condition task. + + +

Note:

+When working with more than one file, if condition and/or verifyproperty is used, +the result will be true only if the checksums matched correctly for all files being +considered. + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/chgrp.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/chgrp.html new file mode 100644 index 000000000..2126fb741 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/chgrp.html @@ -0,0 +1,185 @@ + + + + + + +Chgrp Task + + + + +

Chgrp

+

Since Apache Ant 1.6.

+

Description

+ +

Changes the group of a file or all files inside specified +directories. Right now it has effect only under Unix. The group +attribute is equivalent to the corresponding argument for the chgrp +command.

+ +

FileSets, +DirSets or FileLists can be specified using +nested <fileset>, <dirset> and +<filelist> elements.

+ +

Starting with Ant 1.7, this task supports arbitrary Resource Collections +as nested elements.

+ +

By default this task will use a single invocation of the underlying +chgrp command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.

+ +

By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chgrp" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe file or directory of which the group must be + changed.Yes, unless nested + <fileset|filelist|dirset> + elements are specified
groupthe new group.Yes
parallelprocess all specified files using a single + chgrp command. Defaults to true.No
typeOne of file, dir or + both. If set to file, only the group of + plain files are going to be changed. If set to dir, only + the directories are considered.
+ Note: The type attribute does not apply to + nested dirsets - dirsets always implicitly + assume type to be dir.		No, default is file
maxparallelLimit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited.No
verboseWhether to print a summary after execution or not. + Defaults to false.No
oslist of Operating Systems on which the command may be + executed.No
osfamilyOS family as used in + the <os> + condition.No - defaults to "unix"
+

Examples

+ 
+<chgrp file="${dist}/start.sh" group="coders"/>
+
+
+

makes the "start.sh" file belong to the coders group on a +UNIX system.

+
+
+<chgrp group="coders">
+  <fileset dir="${dist}/bin" includes="**/*.sh"/>
+</chgrp>
+
+
+

makes all ".sh" files below ${dist}/bin +belong to the coders group on a UNIX system.

+
+
+<chgrp group="coders">
+  <fileset dir="shared/sources1">
+    <exclude name="**/trial/**"/>
+  </fileset>
+  <fileset refid="other.shared.sources"/>
+</chgrp>
+
+
+

makes all files below shared/sources1 (except those +below any directory named trial) belong to the coders group on a UNIX +system. In addition all files belonging to a FileSet +with id other.shared.sources get the same +group.

+ +
+
+<chgrp group="webdev" type="file">
+  <fileset dir="/web">
+    <include name="**/*.test.jsp"/>
+    <include name="**/*.new"/>
+  </fileset>
+  <dirset dir="/web">
+    <include name="**/test_*"/>
+  </dirset>
+</chmod>
+
+
+ +

makes all .test.jsp, and .new files belong to +group webdev. Directories beginning with test_ also will belong +to webdev, but if there is a directory that ends in .new or a file +that begins with test_ it will be unaffected.

+ + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/chmod.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/chmod.html new file mode 100644 index 000000000..74e71d0a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/chmod.html @@ -0,0 +1,225 @@ + + + + + + +Chmod Task + + + + +

Chmod

+

Description

+

Changes the permissions of a file or all files inside specified +directories. Right now it has effect only under Unix or NonStop Kernel (Tandem). +The permissions are also UNIX style, like the argument for the chmod command.

+

See the section on directory based +tasks, on how the inclusion/exclusion of files works, and how to +write patterns.

+ +

This task holds an implicit FileSet and supports all of +FileSet's attributes and nested elements directly. More sets can be +specified using nested <fileset> or +<dirset> (since Apache Ant 1.6) elements.

+ +

Starting with Ant 1.6, this task also supports nested filelists.

+ +

Starting with Ant 1.7, this task supports arbitrary Resource Collections +as nested elements.

+ +

By default this task will use a single invocation of the underlying +chmod command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.

+ +

By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chmod" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe file or single directory of which the permissions + must be changed.exactly one of the two or nested <fileset/list> elements.
dirthe directory which holds the files whose permissions + must be changed.
+ Note: for backwards compatibility + reasons <chmod dir="some-dir"/> will + only change the permissions on "some-dir" but not recurse into + it, unless you also specify any patterns.
permthe new permissions.Yes
includescomma- or space-separated list of patterns of files that must be + included.No
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
parallelprocess all specified files using a single + chmod command. Defaults to true.No
typeOne of file, dir or + both. If set to file, only the permissions of + plain files are going to be changed. If set to dir, only + the directories are considered.
+ Note: The type attribute does not apply to + nested dirsets - dirsets always implicitly + assume type to be dir.		No, default is file
maxparallelLimit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited. Since Ant 1.6.No
verboseWhether to print a summary after execution or not. + Defaults to false. Since Ant 1.6.No
oslist of Operating Systems on which the command may be + executed.No
osfamilyOS family as used in + the <os> condition.No - defaults to "unix"
+

Examples

+ 
+<chmod file="${dist}/start.sh" perm="ugo+rx"/>
+
+

makes the "start.sh" file readable and executable for anyone on a +UNIX system.

+
+<chmod file="${dist}/start.sh" perm="700"/>
+
+

makes the "start.sh" file readable, writable and executable only for the owner on a +UNIX system.

+
+
+<chmod dir="${dist}/bin" perm="ugo+rx" 
+       includes="**/*.sh"/>
+
+
+

makes all ".sh" files below ${dist}/bin +readable and executable for anyone on a UNIX system.

+
+
+<chmod perm="g+w">
+  <fileset dir="shared/sources1">
+    <exclude name="**/trial/**"/>
+  </fileset>
+  <fileset refid="other.shared.sources"/>
+</chmod>
+
+
+

makes all files below shared/sources1 (except those +below any directory named trial) writable for members of the same +group on a UNIX system. In addition all files belonging to a FileSet +with id other.shared.sources get the same +permissions.

+ +
+
+<chmod perm="go-rwx" type="file">
+  <fileset dir="/web">
+    <include name="**/*.cgi"/>
+    <include name="**/*.old"/>
+  </fileset>
+  <dirset dir="/web">
+    <include name="**/private_*"/>
+  </dirset>
+</chmod>
+
+
+ +

keeps non-owners from touching cgi scripts, files with a .old +extension or directories beginning with private_. A directory +ending in .old or a file beginning with private_ would remain +unaffected.

+ + +

Note on maxparallel attribute

+

+ Some shells have a limit of the number of characters that + a command line may contain. + This maximum limit varies from shell to shell and from operating + system to operating system. + If one has a large number of files to change mode on, consider + using the maxparallel attribute. For example + when using AIX and the limit is reached, the system responds + with a warning: "Warning: + UNIXProcess.forkAndExec native error: The parameter or environment lists + are too long". A value of about 300 seems to result in a + command line that is acceptable. +

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/chown.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/chown.html new file mode 100644 index 000000000..33a9f446a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/chown.html @@ -0,0 +1,183 @@ + + + + + + +Chown Task + + + + +

Chown

+

Since Apache Ant 1.6.

+

Description

+ +

Changes the owner of a file or all files inside specified +directories. Right now it has effect only under Unix. The owner +attribute is equivalent to the corresponding argument for the chown +command.

+ +

FileSets, +DirSets or FileLists can be specified using +nested <fileset>, <dirset> and +<filelist> elements.

+ +

Starting with Ant 1.7, this task supports arbitrary Resource Collections +as nested elements.

+ +

By default this task will use a single invocation of the underlying +chown command. If you are working on a large number of files this may +result in a command line that is too long for your operating system. +If you encounter such problems, you should set the maxparallel +attribute of this task to a non-zero value. The number to use highly +depends on the length of your file names (the depth of your directory +tree) and your operating system, so you'll have to experiment a +little. POSIX recommends command line length limits of at least 4096 +characters, this may give you an approximation for the number you +could use as initial value for these experiments.

+ +

By default this task won't do anything unless it detects it is + running on a Unix system. If you know for sure that you have a + "chown" executable on your PATH that is command line compatible with + the Unix command, you can use the task's os attribute and set its + value to your current os.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe file or directory of which the owner must be + changed.Yes or nested + <fileset/list> elements.
ownerthe new owner.Yes
parallelprocess all specified files using a single + chown command. Defaults to true.No
typeOne of file, dir or + both. If set to file, only the owner of + plain files are going to be changed. If set to dir, only + the directories are considered.
+ Note: The type attribute does not apply to + nested dirsets - dirsets always implicitly + assume type to be dir.		No, default is file
maxparallelLimit the amount of parallelism by passing at + most this many sourcefiles at once. Set it to <= 0 for + unlimited. Defaults to unlimited.No
verboseWhether to print a summary after execution or not. + Defaults to false.No
oslist of Operating Systems on which the command may be + executed.No
osfamilyOS family as used in + the <os> + condition.No - defaults to "unix"
+

Examples

+
+<chown file="${dist}/start.sh" owner="coderjoe"/>
+
+
+

makes the "start.sh" file belong to coderjoe on a +UNIX system.

+
+
+    <chown owner="coderjoe">
+      <fileset dir="${dist}/bin" includes="**/*.sh"/>
+    </chown>
+
+
+

makes all ".sh" files below ${dist}/bin +belong to coderjoe on a UNIX system.

+
+
+<chown owner="coderjoe">
+  <fileset dir="shared/sources1">
+    <exclude name="**/trial/**"/>
+  </fileset>
+  <fileset refid="other.shared.sources"/>
+</chown>
+
+
+

makes all files below shared/sources1 (except those +below any directory named trial) belong to coderjoe on a UNIX +system. In addition all files belonging to a FileSet +with id other.shared.sources get the same +owner.

+ +
+
+<chown owner="webadmin" type="file">
+  <fileset dir="/web">
+    <include name="**/*.cgi"/>
+    <include name="**/*.old"/>
+  </fileset>
+  <dirset dir="/web">
+    <include name="**/private_*"/>
+  </dirset>
+</chmod>
+
+
+ +

makes cgi scripts, files with a .old extension or +directories beginning with private_ belong to the user named +webadmin. A directory ending in .old or a file beginning with +private_ would remain unaffected.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/clearcase.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/clearcase.html new file mode 100644 index 000000000..e59a75a81 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/clearcase.html @@ -0,0 +1,958 @@ + + + + + + + Clearcase Tasks + + + +

Apache Ant ClearCase Tasks

+

by:
+Curtis White (cwhite at aracnet dot com),
+Sean P. Kane (spkane at genomatica dot com),
+Rob Anderson (Anderson.Rob at vectorscm dot com), and
+Sean Egan (sean at cm-logic dot com)

+ +

Version 1.6 - 02/25/2003

+ +

ClearCase Support

+

Table of Contents

+ + +
+

Introduction

+

Apache Ant provides several optional tasks for working with ClearCase. These tasks correspond to various +ClearCase commands using the Cleartool program. The current tasks available for Ant correspond to only +a few of the significant ClearCase commands.

+ +

More tasks can be easily added by deriving from the ClearCase class and then adding +functionality that is specific to that ClearCase command.

+

+ Important: these tasks all require cleartool on the command line. + If a task fails with an IOException, especially error code 2 on Windows, + this is your problem. +

+ + +
+

CCCheckin

+

Description

+Task to perform a "cleartool checkin" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command + will operate onNo
commentSpecify a comment. Only one of comment or commentfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or commentfile + may be used.No
nowarnSuppress warning messagesNo
preservetimePreserve the modification timeNo
keepcopyKeeps a copy of the file with a .keep extensionNo
identicalAllows the file to be checked in even if it is identical + to the originalNo
failonerrThrow an exception if the command fails. Default is trueNo
+

Examples

+
+
+<cccheckin viewpath="c:/views/viewdir/afile"
+        commentfile="acomment.txt"
+        nowarn="true"
+        identical="true"/>
+
+
+

Does a ClearCase checkin on the file c:/views/viewdir/afile. +Comment text from the file acomment.txt is added to ClearCase as a comment. +All warning messages are suppressed. The file is checked in even if it is +identical to the original.

+
+

CCCheckout

+

Description

+Task to perform a "cleartool checkout" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command + will operate onNo
reservedSpecifies whether to check out the file as reserved or notYes
outCreates a writable file under a different filenameNo
nodataChecks out the file but does not create an editable file + containing its dataNo
branchSpecify a branch to check out the file toNo
versionAllows checkout of a version other than main latestNo
nowarnSuppress warning messagesNo
commentSpecify a comment. Only one of comment or commentfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or + commentfile may be used.No
notcoFail if it's already checked out to the current view. Set to false to ignore it.
+ Since ant 1.6.1		No
failonerrThrow an exception if the command fails. Default is true.
+ Since ant 1.6.1		No
+

Examples

+
+
+<cccheckout viewpath="c:/views/viewdir/afile"
+        reserved="true"
+        branch="abranch"
+        nowarn="true"
+        comment="Some comment text"/>
+
+
+

Does a ClearCase checkout on the file c:/views/viewdir/afile. +It is checked out as reserved on branch called abranch. All +warning messages are suppressed. A Some comment text is added to +ClearCase as a comment.

+
+

CCUnCheckout

+

Description

+Task to perform a UnCheckout command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command + will operate onNo
keepcopySpecifies whether to keep a copy of the file with a .keep + extension or notNo
failonerrThrow an exception if the command fails. Default is true
+ Since ant 1.6.1		No
+

Examples

+
+
+<ccuncheckout viewpath="c:/views/viewdir/afile"
+        keepcopy="true"/>
+
+
+

Does a ClearCase uncheckout on the file c:/views/viewdir/afile. +A copy of the file called c:/views/viewdir/afile.keep is kept.

+
+

CCUpdate

+

Description

+Task to perform an "cleartool update" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase snapshot view file or directory that the command + will operate onNo
graphicalDisplays a graphical dialog during the updateNo
logSpecifies a log file for ClearCase to write toNo
overwriteSpecifies whether to overwrite hijacked files or notNo
renameSpecifies that hijacked files should be renamed with a .keep extensionNo
currenttimeSpecifies that modification time should be written as the + current time. Either currenttime or preservetime can be + specified.No
preservetimeSpecifies that modification time should preserved from the + VOB time. Either currenttime or preservetime can be + specified.No
failonerrThrow an exception if the command fails. Default is true.
+ Since ant 1.6.1		No
+

Examples

+
+
+<ccupdate viewpath="c:/views/viewdir"
+        graphical="false"
+        log="log.log"
+        overwrite="true"
+        currenttime="true"
+        rename="false"/>
+
+
+

Does a ClearCase update on the snapshot view directory c:/views/viewdir. +A graphical dialog will be displayed. The output will be logged to +log.log and it will overwrite any hijacked files. The modified +time will be set to the current time.

+ + + +
+

CCMklbtype

+

Description

+Task to perform a "mklbtype" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
typenameName of the label type to createYes
vobName of the VOBNo
replaceReplace an existing label definition of the same typeNo
globalEither global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOBNo
ordinaryEither global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. DefaultNo
pbranchAllows the label type to be used once per branch in a given element's version treeNo
sharedSets the way mastership is checked by ClearCase. See ClearCase documentation for detailsNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is true
+ Since ant 1.6.1		No
+ +

Examples

+
+
+<ccmklbtype typename="VERSION_1"
+        ordinary="true"
+        comment="Development version 1"/>
+
+
+

Does a ClearCase mklbtype to create a label type named VERSION_1. +It is created as ordinary so it is available only to the current VOB. +The text Development version 1 is added as a comment.

+ + +
+

CCMklabel

+

Description

+Task to perform a "mklabel" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
typenameName of the label typeYes
viewpathPath to the ClearCase view file or directory that the command will operate onNo
replaceReplace a label of the same type on the same branchNo
recurseProcess each subdirectory under viewpathNo
versionIdentify a specific version to attach the label toNo
vobName of the VOBNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is true
+ Since ant 1.6.1		No
+ +

Examples

+
+
+<ccmklabel viewpath="c:/views/viewdir/afile"
+        comment="Some comment text"
+        recurse="true"
+        version="\main\2"
+        typename="VERSION_1"/>
+
+
+

Does a ClearCase mklabel on the file c:/views/viewdir/afile under +the main branch for version 2 (\main\2). Text Some comment text is added +as a comment. It will recurse all subdirectories. + + +

+

CCRmtype

+

Description

+Task to perform a "rmtype" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
typekindThe kind of type to create. Valid types are: + + + + + + + +
attype
+ brtype
+ eltype
+ hltype
+ lbtype
+ trtype + 		-
+ -
+ -
+ -
+ -
+ - + 		attribute type
+ branch type
+ element type
+ hyperlink type
+ label type
+ trigger type +
+ 		Yes
typenameThe name of the type to removeYes
ignoreUsed with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removalNo
rmallRemoves all instances of a type and the type object itselfNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is true + Since ant 1.6.1No
+ +

Examples

+
+
+<ccrmtype typekind="lbtype"
+        typename="VERSION_1"
+        commentfile="acomment.txt"
+        rmall="true"/>
+
+
+

Does a ClearCase rmtype to remove a label type (lbtype) named VERSION_1. +Comment text from the file acomment.txt is added as a comment. All instances of the type +are removed, including the type object itself.

+
+ +

CCLock

+

Description

+Task to perform a "cleartool lock" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
replaceSpecifies replacing an existing lockNo
nusersSpecifies user(s) who can still modify the objectNo
obsoleteSpecifies that the object should be marked obsoleteNo
commentSpecifies how to populate comments fieldsNo
pnameSpecifies the object pathname to be locked.No
objselectThis variable is obsolete. Should use objsel instead.No
objselSpecifies the object(s) to be locked.
+ Since ant 1.6.1		No
failonerrThrow an exception if the command fails. Default is true.
+ Since ant 1.6.1		No
+

Examples

+
+
+<cclock
+    objsel="stream:Application_Integration@\MyProject_PVOB"
+    />
+
+
+

Does a ClearCase lock on the object stream:Application_Integration@\MyProject_PVOB.

+
+ +

CCUnlock

+

Description

+Task to perform a "cleartool unlock" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
commentSpecifies how to populate comments fieldsNo
pnameSpecifies the object pathname to be unlocked.No
objselectThis variable is obsolete. Should use objsel instead.No
objselSpecifies the object(s) to be unlocked.
+ Since ant 1.6.1		No
failonerrThrow an exception if the command fails. Default is true.
+ Since ant 1.6.1		No
+

Examples

+
+
+<ccunlock
+    objsel="stream:Application_Integration@\MyProject_PVOB"
+    />
+
+
+

Does a ClearCase unlock on the object stream:Application_Integration@\MyProject_PVOB.

+
+ +

CCMkbl

+

Description

+Task to perform a "cleartool mkbl" command to ClearCase. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
commentSpecify a comment. Only one of comment or cfile may be +used.No
commentfileSpecify a file containing a comment. Only one of comment or +cfile may be used.No
baselinerootnameSpecify the name to be associated with the baseline.Yes
nowarnSuppress warning messagesNo
identicalAllows the baseline to be created even if it is identical to the +previous baseline.No
fullCreates a full baseline.No
nlabelAllows the baseline to be created without a label.No
failonerrThrow an exception if the command fails. Default is true.
+ Since ant 1.6.1		No
+

Examples

+
+
+<ccmkbl
+    baselinerootname="Application_Baseline_AUTO"
+    identical="yes"
+    full="no"
+    viewpath="v:\ApplicationCC"
+    />
+
+
+

Does a ClearCase mkbl on the Integration view at v:\ApplicationCC +even if it is identical to a previous baseline. The new baseline with be +incremental and named "Application_Baseline_AUTO".

+
+ +

CCMkattr

+

Description

+Task to perform a "cleartool mkattr" command to ClearCase.
+Since ant 1.6.1 +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command will operate onYes
replaceReplace the value of the attribute if it already existsNo
recurseProcess each subdirectory under viewpathNo
versionIdentify a specific version to attach the attribute toNo
typenameName of the attribute typeYes
typevalueValue to attach to the attribute typeYes
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
failonerrThrow an exception if the command fails. Default is trueNo
+

Examples

+
+
+<ccmkattr viewpath="c:/views/viewdir/afile"
+    typename="BugFix"
+    typevalue="34445"
+    />
+
+
+

Does a ClearCase mkattr on the file c:/views/viewdir/afile and +attaches the attribute BugFix with a value of 34445 to it.

+
+ +

CCMkdir

+

Description

+Task to perform a "cleartool mkdir" command to ClearCase.
+Since ant 1.6.1 +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view directory that the command will operate onYes
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
nocheckoutDo not checkout after element creationNo
failonerrThrow an exception if the command fails. Default is trueNo
+

Examples

+
+
+<ccmkdir viewpath="c:/views/viewdir/adir"
+        nochcekout="true"
+        comment="Some comment text"/>
+
+
+

Does a ClearCase mkdir on the dir c:/views/viewdir/adir and +does not automatically check it out.

+
+ +

CCMkelem

+

Description

+Task to perform a "cleartool mkelem" command to ClearCase.
+Since ant 1.6.1 +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command will operate onYes
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
nowarnSuppress warning messagesNo
nocheckoutDo not checkout after element creationNo
checkinCheckin element after creationNo
preservetimePreserve the modification time (for checkin)No
masterAssign mastership of the main branch to the current siteNo
eltypeElement type to use during element creationNo
failonerrThrow an exception if the command fails. Default is trueNo
+

Examples

+
+
+<ccmkelem viewpath="c:/views/viewdir/afile"
+        eltype="text_file"
+        checkin="true"
+        comment="Some comment text"/>
+
+
+

Does a ClearCase mkelem on the file c:/views/viewdir/afile with +element type text_file. It also checks in the file after creation.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/common.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/common.html new file mode 100644 index 000000000..6fa3418e5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/common.html @@ -0,0 +1,59 @@ + + + + + + +Common + + + + +

Common Attributes of all Tasks

+

All tasks share the following attributes:

+ + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
idUnique identifier for this task instance, can be + used to reference this task in scripts.No
tasknameA different name for this task instance - will + show up in the logging output.No
descriptionRoom for your commentsNo
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/componentdef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/componentdef.html new file mode 100644 index 000000000..173c5bd0c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/componentdef.html @@ -0,0 +1,62 @@ + + + + + + +Componentdef Task + + + + +

componentdef

+

Description

+

+ Adds a component definition to the current project. + A compenent definition is the same as a + typedef except: +

+
    +
  1. + that it can only be used in other types or tasks that + accept components (by having an add() method). +
    2. +
  2. + multiple components may have the same name, provided they + implement different interfaces. +
    3. +
+

+ The purpose of this is to allow internal Apache Ant definitions to be + made for tags like "and" or "or". +

+ +

Examples

+ +
 <componentdef name="or" onerror="ignore"
+    classname="com.apache.tools.ant.taskdefs.conditions.Or"/>
+  <componentdef name="or" onerror="ignore"
+    classname="com.apache.tools.ant.types.resources.selectors.Or"/>
+

+ defines two components with the same name "or"; one is a condition + (see conditions) and one is + a selector (see selectors). +

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/concat.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/concat.html new file mode 100644 index 000000000..922bfdb54 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/concat.html @@ -0,0 +1,328 @@ + + + + + + +Concat + + + + +

Concat

+ +

Description

+ +

+ Concatenates one or more + resources + to a single file or to the console. The destination + file will be created if it does not exist unless the resource + list is empty and ignoreempty is true. +

+ +

Since Apache Ant 1.7.1, this task can be used as a + Resource Collection + that will return exactly one + resource. +

+ +

+ +Resource Collections are used to + select which resources are to be concatenated. There is no + singular attribute to specify a single resource to cat. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destfile + The destination file for the concatenated stream. + If not specified the console will be used instead. + + No +
append + Specifies whether or not the file specified by 'destfile' + should be appended. Defaults to "no". + No
force + Specifies whether or not the file specified by 'destfile' + should be written to even if it is newer than all source files. + deprecated, use the overwrite attribute instead + Defaults to "yes". + No
overwrite + Specifies whether or not the file specified by 'destfile' + should be written to even if it is newer than all source files. + since Ant 1.8.2. + Defaults to "yes". + No
forceReadOnlyOverwrite read-only destination + files. since Ant 1.8.2No; defaults to false.
encoding + Specifies the encoding for the input files. Please see + http://download.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html + for a list of possible values. Defaults to the platform's + default character encoding. + No
outputencoding + The encoding to use when writing the output file + since Ant 1.6. + Defaults to the value of the encoding attribute + if given or the default JVM encoding otherwise. + No
fixlastline + Specifies whether or not to check if + each file concatenated is terminated by + a new line. If this attribute is "yes" + a new line will be appended to the stream if + the file did not end in a new line. + since Ant 1.6. + Defaults to "no". + This attribute does not apply to embedded text. + No
eol + Specifies what the end of line character are + for use by the fixlastline attribute. + since Ant 1.6 + Valid values for this property are: +
    +
  • cr: a single CR
    • +
  • lf: a single LF
    • +
  • crlf: the pair CRLF
    • +
  • mac: a single CR
    • +
  • unix: a single LF
    • +
  • dos: the pair CRLF
    • +
+ The default is platform dependent. + For Unix platforms, the default is "lf". + For DOS based systems (including Windows), + the default is "crlf". + For Mac OS, the default is "cr". + 		No
binary + since Ant 1.6.2 + If this attribute is set to true, the task concatenates the files + in a byte by byte fashion. If this attribute is false, concat will + not normally work for binary files due to character encoding + issues. + If this option is set to true, the destfile attribute must be + set, and the task cannot used nested text. + Also the attributes encoding, outputencoding, filelastline + cannot be used. + The default is "false". + No
ignoreempty + Since Ant 1.8.0 + Specifies whether or not the file specified by 'destfile' + should be created if the source resource list is + empty. Defaults to "true". + No
+ +

Parameters specified as nested elements

+

Resource Collection

+

since Ant 1.7.

+ +

+ Any of the various + Resource Collection types can specify the resources to be + concatenated. +

+ +

filterchain

+

since Ant 1.6.

+

The concat task supports nested + FilterChains.

+ +

header, footer

+

since Ant 1.6.

+

Used to prepend or postpend text into the concatenated stream.

+

The text may be in-line or be in a file.

+ + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filtering + Whether to filter the text provided by this sub element, + default is "yes". + No
fileA file to place at the head or tail of the + concatenated text. + No
trimWhether to trim the value, default is "no"No
trimleading + Whether to trim leading white space on each line, default is "no" + No
+ +

Examples

+ +

Concatenate a string to a file:

+ + 
+  <concat destfile="README">Hello, World!</concat>
+
+ +

Concatenate a series of files to the console:

+ + 
+  <concat>
+    <fileset dir="messages" includes="*important*"/>
+  </concat>
+
+ +

Concatenate a single file, appending if the destination file exists:

+ + 
+  <concat destfile="NOTES" append="true">
+    <filelist dir="notes" files="note.txt"/>
+  </concat>
+
+ +

Concatenate a series of files, update the destination + file only if is older that all the source files:

+ + 
+  <concat destfile="${docbook.dir}/all-sections.xml"
+          force="no">
+    <filelist dir="${docbook.dir}/sections"
+         files="introduction.xml,overview.xml"/>
+    <fileset dir="${docbook.dir}"
+         includes="sections/*.xml"
+         excludes="introduction.xml,overview.xml"/>
+  </concat>
+
+ +

Concatenate a series of files, expanding ant properties

+ 
+   <concat destfile="${build.dir}/subs">
+      <path>
+        <fileset dir="${src.dir}" includes="*.xml"/>
+        <pathelement location="build.xml"/>
+      </path>
+      <filterchain>
+        <expandproperties/>
+      </filterchain>
+   </concat>
+
+ +

Filter the lines containing project from build.xml and output + them to report.output, prepending with a header

+ 
+   <concat destfile="${build.dir}/report.output">
+      <header filtering="no" trimleading="yes">
+          Lines that contain project
+          ==========================
+      </header>
+      <path path="build.xml"/>
+      <filterchain>
+         <linecontains>
+           <contains value="project"/>
+         </linecontains>
+      </filterchain>
+   </concat>
+
+ +

Concatenate a number of binary files.

+ 
+   <concat destfile="${build.dir}/dist.bin" binary="yes">
+     <fileset file="${src.dir}/scripts/dist.sh" />
+     <fileset file="${build.dir}/dist.tar.bz2" />
+   </concat>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/condition.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/condition.html new file mode 100644 index 000000000..405f95e7a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/condition.html @@ -0,0 +1,110 @@ + + + + + + +Condition Task + + + + +

Condition

+

Description

+

Sets a property if a certain condition holds true - this is a +generalization of Available and Uptodate.

+

If the condition holds true, the property value is set to true by +default; otherwise, the property is not set. You can set the value to +something other than the default by specifying the value +attribute.

+

Conditions are specified as nested elements, +you must specify exactly one condition.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe name of the property to set.Yes
valueThe value to set the property to. Defaults to + "true".No
elseThe value to set the property to if the condition + evaluates to false. By default the property will remain unset. + Since Apache Ant 1.6.3 + No
+

Parameters specified as nested elements

+

All conditions to test are specified as nested elements, for a +complete list see here.

+ +

Examples

+
+  <condition property="javamail.complete">
+    <and>
+      <available classname="javax.activation.DataHandler"/>
+      <available classname="javax.mail.Transport"/>
+    </and>
+  </condition>
+
+

sets the property javamail.complete if both the +JavaBeans Activation Framework and JavaMail are available in the +classpath.

+ +
+  <condition property="isMacOsButNotMacOsX">
+    <and>
+      <os family="mac"/>
+
+      <not>
+        <os family="unix"/>
+
+      </not>
+    </and>
+  </condition>
+
+

sets the property isMacOsButNotMacOsX if the current +operating system is MacOS, but not MacOS X - which Ant considers to be +in the Unix family as well.

+ +
+  <condition property="isSunOSonSparc">
+    <os name="SunOS" arch="sparc"/>
+
+  </condition>
+
+

sets the property isSunOSonSparc if the current +operating system is SunOS and if it is running on a sparc architecture.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/conditions.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/conditions.html new file mode 100644 index 000000000..8d6b2a9c8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/conditions.html @@ -0,0 +1,1083 @@ + + + + + + +Conditions Task + + + + +

Conditions

+

Conditions are nested elements of the +<condition> and +<waitfor> tasks. + There are core conditions and custom conditions. Custom + conditions are described in + + Custom Conditions. + Core Conditions are described below. +

+

Core Conditions

+ +

These are the nested elements that can be used as conditions in the +<condition> and +<waitfor> tasks.

+ +

not

+

The <not> element expects exactly one other +condition to be nested into this element, negating the result of the +condition. It doesn't have any attributes and accepts all nested +elements of the condition task as nested elements as well.

+ +

and

+The <and> element doesn't have any attributes and +accepts an arbitrary number of conditions as nested elements - all +nested elements of the condition task are supported. This condition +is true if all of its contained conditions are, conditions will be +evaluated in the order they have been specified in the build file.

+

The <and> condition has the same shortcut +semantics as the Java && operator, as soon as one of the +nested conditions is false, no other condition will be evaluated.

+ +

or

+The <or> element doesn't have any attributes and +accepts an arbitrary number of conditions as nested elements - all +nested elements of the condition task are supported. This condition +is true if at least one of its contained conditions is, conditions +will be evaluated in the order they have been specified in the build +file.

The <or> condition has the same +shortcut semantics as the Java || operator, as soon as one of the +nested conditions is true, no other condition will be evaluated.

+ +

xor

+

The <xor> element performs an exclusive +or on all nested elements, similar to the ^ operator +in Java. It only evaluates to true if an odd number of nested conditions +are true. There is no shortcutting of evaluation, unlike the <and> +and <or> tests. +It doesn't have any attributes and accepts all nested +elements of the condition task as nested elements as well.

+ +

available

+

This condition is identical to the Available task, all attributes and nested +elements of that task are supported, the property and value attributes +are redundant and will be ignored.

+ +

uptodate

+

This condition is identical to the Uptodate task, all attributes and nested +elements of that task are supported, the property and value attributes +are redundant and will be ignored.

+ +

os

 +

Test whether the current operating system is of a given type. Each +defined attribute is tested and the result is true only if all +the tests succeed. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
familyThe name of the operating system family to expect.No
nameThe name of the operating system to expect.No
archThe architecture of the operating system to expect.No
versionThe version of the operating system to expect.No
+

Supported values for the family attribute are: +

    +
  • windows (for all versions of Microsoft Windows)
    • +
  • dos (for all Microsoft DOS based operating systems including + Microsoft Windows and OS/2)
    • +
  • mac (for all Apple Macintosh systems)
    • +
  • unix (for all Unix and Unix-like operating systems)
    • +
  • netware (for Novell NetWare)
    • +
  • os/2 (for OS/2)
    • +
  • tandem (for HP's NonStop Kernel - formerly Tandem)
    • +
  • win9x for Microsoft Windows 95 and 98, ME and CE
    • +
  • winnt for Microsoft Windows NT-based systems, including Windows 2000, XP and + successors
    • +
  • z/os for z/OS and OS/390
    • +
  • os/400 for OS/400
    • +
  • openvms for OpenVMS
    • +
+ +

equals

+

Tests whether the two given values are equal.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
arg1First value to test.Yes
arg2Second value to test.Yes
casesensitivePerform a case sensitive comparision. Default is + true.No
trimTrim whitespace from arguments before comparing + them. Default is false.No
forcestringForce string comparison of arg1/arg2. + Default is false. Since Apache Ant 1.8.1 + No
+ +

isset

+

Test whether a given property has been set in this project.

+ + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe name of the property to test.Yes
+ +

checksum

+

This condition is identical to the Checksum +task, all attributes and nested elements of that task are supported, +the property and overwrite attributes are redundant and will be +ignored.

+ +

http

+

The http condition checks for a valid response from a +web server of the specified url. By default, HTTP responses errors +of 400 or greater are viewed as invalid.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
urlThe full URL of the page to request. The web server must + return a status code below the value of errorsBeginAtYes.
errorsBeginAtThe lowest HTTP response code that signals an error; + by default '400'; server errors, not-authorized, not-found and the like + are detectedNo
requestMethodThe HTTP method to be used when issuing the request. + Any of GET, POST, HEAD, OPTIONS, PUT, DELETEm and TRACE + are valid, subject to protocol restrictions. The default if not + specified is "GET".
+ since Ant 1.8.0		No
+ +

socket

+

The socket condition checks for the existence of a +TCP/IP listener at the specified host and port.

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
serverThe DNS name or IP address of the server.Yes.
portThe port number to connect to.Yes.
+ +

filesmatch

+

Test two files for matching. Nonexistence of one file results in "false", +although if neither exists they are considered equal in terms of content. +This test does a byte for byte comparision, so test time scales with +byte size. NB: if the files are different sizes, one of them is missing +or the filenames match the answer is so obvious the detailed test is omitted. + +

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
file1First file to testYes
file2Second file to testYes
textfileWhether to ignore line endings + when comparing files; defaults to false, while + true triggers a binary comparison. Since Ant 1.7 + No
+ +

contains

+

Tests whether a string contains another one.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
stringThe string to search in.Yes
substringThe string to search for.Yes
casesensitivePerform a case sensitive comparision. Default is + true.No
+ +

istrue

+

Tests whether a string equals any of the ant definitions of true, +that is "true","yes", or "on"

+ + + + + + + + + + + +
AttributeDescriptionRequired
valuevalue to testYes
+
+<istrue value="${someproperty}"/>
+<istrue value="false"/>
+
+ +

isfalse

+

Tests whether a string is not true, the negation of <istrue> +

+ + + + + + + + + + + +
AttributeDescriptionRequired
valuevalue to testYes
+
+<isfalse value="${someproperty}"/>
+<isfalse value="false"/>
+
+ +

isreference

+ +

Test whether a given reference has been defined in this project and +- optionally - is of an expected type.

+ +

This condition has been added in Apache Ant 1.6.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
refidThe id of the reference to test.Yes
typeName of the data type or task this reference is + expected to be.No
+

issigned

+

+ Test whether a jarfile is signed. + If the name of the + signature is passed, the file is checked for presence of that + particular signature; otherwise the file is checked for the + existence of any signature. It does not perform rigorous + signature validation; it only looks for the presence of a signature. +

+

+ This condition was added in Apache Ant 1.7. +

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
file + The jarfile that is to be tested for the presence + of a signature. + Yes
name The signature name to check for.No
+

isfileselected

+

+ Test whether a file passes an embedded + selector. +

+

+ This condition was added in Apache Ant 1.6.3. +

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
file + The file to check if is passes the embedded selector. + Yes
basedirThe base directory to use for name based selectors. It this is not set, + the project's basedirectory will be used.No
+

+ Example usage: +

+
+<isfileselected file="a.xml">
+  <date datetime="06/28/2000 2:02 pm" when="equal"/>
+</isfileselected>
+
+

typefound

+ +

Test whether a given type is defined, and that +its implementation class can be loaded. Types include +tasks, datatypes, scriptdefs, macrodefs and presetdefs.

+ +

This condition was added in Apache Ant 1.7.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namename of the typeYes
uri + The uri that this type lives in. + No
+ +

+ Example usages: +

+
+<typefound name="junit"/>
+<typefound uri="antlib:org.apache.maven.artifact.ant" name="artifact"/>
+
+ +

scriptcondition

+ +

Evaluate a condition based on a script in any +Apache BSF + or + JSR 223 +supported language. +

+

+See the Script task for +an explanation of scripts and dependencies. +

+ +

This condition was added in Apache Ant 1.7.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
languagescript languageYes
manager + The script engine manager to use. + See the script task + for using this attribute. + No - default is "auto"
valuedefault boolean valueNo -default is "false"
srcfilename of script sourceNo
setbeanswhether to have all properties, references and targets as + global variables in the script. since Ant 1.8.0No, default is "true".
classpath + The classpath to pass into the script. + No
classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + No
+
Parameters specified as nested elements
+
classpath
+

+ See the script task + for using this nested element. +

+
Description
+

+The script supports script language inline, this script has access to the +same beans as the <script> task, and to the self bean, +which refers back to the condition itself. If the script evaluates to a boolean result, +this is the result of the condition's evaluation (since Ant 1.7.1). +Alternatively, self.value can be used to set the evaluation result. +

+

+Example: +

+
+<scriptcondition language="javascript"
+        value="true">
+    self.setValue(false);
+</scriptcondition>
+
+ +Sets the default value of the condition to true, then in the script, +sets the value to false. This condition always evaluates to "false" + +

parsersupports

+ +

Tests whether Ant's XML parser supports a given +feature or property, as per the SAX/JAXP specifications, by +attempting to set the appropriate property/feature/

+ +

This condition was added in Apache Ant 1.7.

+ + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyproperty to setone of property or feature
featurefeature to setone of property or feature
valuestring (property) or boolean (feature)For property tests, but not for feature tests
+ +
+<parsersupports feature="http://xml.org/sax/features/namespaces"/>
+
+Check for namespace support. All SAX2 parsers should have this. +
+<or>
+  <parsersupports
+    feature="http://apache.org/xml/features/validation/schema"/>
+  <parsersupports
+    feature="http://java.sun.com/xml/jaxp/properties/schemaSource"/>
+</or>
+
+ +Check for XML Schema support. + +
+<parsersupports
+  property="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
+  value="document.xsd"/>
+
+ +Check for Xerces-specific definition of the location of the no namespace schema. + +

isreachable

+ +

Uses Java1.5+ networking APIs to probe for a (remote) system being +reachable. Exactly what probe mechanisms are used is an implementation +feature of the JVM. They may include ICMP "ping" packets, UDP or TCP connections +to port 7 "echo service" or other means. On Java1.4 and earlier, being able +to resolve the hostname is considered success. This means that if DNS is not +working or a URL/hostname is bad, the test will fail, but otherwise succeed +even if the remote host is actually absent. + +

+

+This condition turns unknown host exceptions into false conditions. This is +because on a laptop, DNS is one of the first services when the network goes; you +are implicitly offline. +

+

+ If a URL is supplied instead of a host, the hostname is extracted + and used in the test - all other parts of the URL are discarded. +

+

+The test may not work through firewalls, that is, something may be reachable +using a protocol such as HTTP, while the lower level ICMP packets get dropped +on the floor. Similarly, a host may detected as reachable with ICMP, but +not reachable on other ports (i.e. port 80), because of firewalls. +

+

+ +This condition was added in Apache Ant 1.7.

+ + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
hosthost to check forone of url or host
urlURL containing hostnameone of url or host
timeouttimeout in secondsno, default is 30s
+ +
+<condition property="offline">
+  <isreachable url="http://ibiblio.org/maven/" />
+</condition>
+
+ +

+Probe for the maven repository being reachable. +

+ +
+<condition property="offline">
+  <isreachable host="ibiblio.org" timeout="10" />
+</condition>
+
+ +

+Probe for the maven repository being reachable using the hostname, ten second timeout.. +

+ +

length

+

This condition is a facet of the Length task. + It is used to test the length of a string or one or more files. + Since Ant 1.6.3 +

+ +
+<length string=" foo " trim="true" length="3" />
+
+

Verify a string is of a certain length.

+ +
+<length file="foo" when="greater" length="0" />
+
+

Verify that file foo is not empty.

+ +

isfailure

+ +

Test the return code of an executable (see the +Exec task) for failure. Since Ant 1.7

+ + + + + + + + + + + + +
AttributeDescriptionRequired
codeThe return code to test.Yes
+ +

resourcecount

+

This condition is a facet of the + ResourceCount task. + It is used to test the size of a + resource collection. + Since Ant 1.7 +

+ +
+<resourcecount refid="myresourcecollection" when="greater" count="0" />
+
+

Verify that a resource collection is not empty.

+ +

resourcesmatch

+

Test resources for matching. Nonexistence of one or more resources results in +"false", although if none exists they are considered equal in terms of content. +By default this test does a byte for byte comparision, so test time scales with +byte size. NB: if the files are different sizes, one of them is missing +or the filenames match the answer is so obvious the detailed test is omitted. +The resources to check are specified as nested +resource collections, +meaning that more than two resources can be checked; in this case all resources +must match. Since Ant 1.7 +

+ + + + + + + + + + + +
AttributeDescriptionRequired
astextWhether to ignore line endings + when comparing resource content; defaults to false, + while true triggers a binary comparison. + No
+ +

resourcecontains

+

Tests whether a resource contains a given (sub)string.

+

The resources to check are specified via references or - in the + case of file resources via the resource attribute. Since Ant 1.7.1 +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
resourceName of a file that is the resource to test. + One of the two
refidReference to a resource defined inside the project.
substringThe string to search for.Yes
casesensitivePerform a case sensitive comparision. Default is + true.No
+ +

hasmethod

+ +

Tests for a class having a method or field. If the class is not found + or fails to load, the build fails. + + Since Ant 1.7 +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
classnamename of the class to loadyes
fieldname of a field to look forone of field or method
methodname of a method to look forone of field or method
ignoreSystemClassesshould system classes be ignored?No -default is false
classpatha class pathNo
classpathrefreference to a class pathNo
+ +

+ There is also a nested <classpath> element, which can be used to specify + a classpath. +

+
+<hasmethod classname="java.util.ArrayList" method="trimToSize"  />
+
+ +

Looks for the method trimToSize in the ArrayList class.

+ +

matches

+ +

+ Test if the specified string matches the specified regular + expression pattern. + Since Ant 1.7

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
stringThe string to test.Yes
patternThe regular expression pattern used to test.Yes, unless there is a nested + <regexp> element.
casesensitivePerform a case sensitive match. Default is + true.No
multiline + Perform a multi line match. + Default is false.No
singleline + This allows '.' to match new lines. + SingleLine is not to be confused with multiline, SingleLine is a perl + regex term, it corresponds to dotall in java regex. + Default is false.No
+ +

+ There is also an optional <regexp> element, which can be used to specify + a regular expression instead of the "pattern" attribute. + See Regexp Type for the description + of the nested element regexp and of + the choice of regular expression implementation. +

+

+ An example: +

+
+<condition property="legal-password">
+  <matches pattern="[1-9]" string="${user-input}"/>
+</condition>
+<fail message="Your password should at least contain one number"
+      unless="legal-password"/>
+
+

+ The following example sets the property "ok" if + the property "input" is three characters long, starting + with 'a' and ending with 'b'. +

+
+<condition property="ok">
+  <matches string="${input}" pattern="^a.b$"/>
+</condition>
+
+

+ The following defines a reference regular expression for + matching dates and then uses antunit to check if the + property "today" is in the correct format: +

+
+<regexp id="date.pattern" pattern="^[0123]\d-[01]\d-[12]\d\d\d$"/>
+
+<au:assertTrue xmlns:au="antlib:org.apache.ant.antunit">
+  <matches string="${today}">
+    <regexp refid="date.pattern"/>
+  </matches>
+</au:assertTrue>
+
+

+ The following example shows the use of the singleline and the casesensitive + flags. +

+
+<au:assertTrue>
+  <matches string="AB${line.separator}C" pattern="^ab.*C$"
+           casesensitive="false"
+           singleline="true"/>
+</au:assertTrue>
+<au:assertFalse>
+  <matches string="AB${line.separator}C" pattern="^ab.*C$"
+           casesensitive="false"
+           singleline="false"/>
+</au:assertFalse>
+
+

antversion

+

This condition is identical to the Antversion task, all attributes are supported, the property attribute +is redundant and will be ignored.

+ + +

hasfreespace

+ +

+ Tests a partition to see if there is enough space. + Since Ant 1.7.0

+

Needed attribute can be specified using standard computing terms:
+

    +
  • K : Kilobytes (1024 bytes)
    • +
  • M : Megabytes (1024 K)
    • +
  • G : Gigabytes (1024 M)
    • +
  • T : Terabytes (1024 G)
    • +
  • P : Petabytes (1024 T)
    • +
+

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
partitionThe partition or filesystem to check for freespaceYes
neededThe amount of freespace needed.Yes
+

+ An example: +

+
+<hasfreespace partition="c:" needed="100M"/>
+
+ +

islastmodified

+ +

Tests the last modified date of a resource. Since Ant +1.8.0

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
millisSpecifies the expected modification time of the resource + in milliseconds since midnight Jan 1 1970.Exactly one of the + two.
datetimeSpecifies the expected modification time of the + resource. The special value "now" indicates the + current time.
patternSimpleDateFormat-compatible pattern string. + Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM. + No
modeHow to compare the timestamp. Accepted values + are "equals", "before", "not-before", "after" and "not-after". + No, defaults to "equals".
+ +

The actual resource to test is specified as a nested element.

+ +

+ An example: +

+
+<islastmodified dateTime="08/18/2009 04:41:19 AM" mode="not-before">
+  <file file="${file}"/>
+</islastmodified>
+
+ +

resourceexists

+ +

Tests a resource for existance. since Ant 1.8.0

+ +

The actual resource to test is specified as a nested element.

+ +

+ An example: +

+
+<resourceexists>
+  <file file="${file}"/>
+</resourceexists>
+
+ + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/copy.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/copy.html new file mode 100644 index 000000000..7e95c1d85 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/copy.html @@ -0,0 +1,367 @@ + + + + + + +Copy Task + + + + +

Copy

+

Description

+

Copies a file or resource collection to a new file or directory. By default, files are +only copied if the source file is newer than the destination file, +or when the destination file does not exist. However, you can explicitly +overwrite files with the overwrite attribute.

+ +

Resource +Collections are used to select a group of files to copy. To use a +resource collection, the todir attribute must be set. +Note that some resources (for example +the file resource) +return absolute paths as names and the result of using them without +using a nested mapper (or the flatten attribute) may not be what you +expect.

+ +

+Note: If you employ filters in your copy operation, +you should limit the copy to text files. Binary files will be corrupted +by the copy operation. +This applies whether the filters are implicitly defined by the +filter task or explicitly provided to the copy +operation as filtersets. + See encoding note. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to copy.Yes, unless a nested + resource collection element is used.
preservelastmodifiedGive the copied files the same last modified + time as the original source files.No; defaults to false.
tofileThe file to copy to.With the file + attribute, either tofile or todir can be used.
+ + With nested resource collection elements, if the number of + included resources + is greater than 1, or if only the dir attribute is + specified in the <fileset>, or if the + file attribute is also specified, then only + todir is allowed.
+ Prior to Apache Ant 1.8.2 the tofile attribute + only supported filesystem resources top copy from.
todirThe directory to copy to.
overwriteOverwrite existing files even if the destination + files are newer.No; defaults to false.
forceOverwrite read-only destination + files. since Ant 1.8.2No; defaults to false.
filteringIndicates whether token filtering using the global + build-file filters should take place during the copy. + Note: Nested <filterset> elements will + always be used, even if this attribute is not specified, or its value is + false (no, or off).No; defaults to false.
flattenIgnore the directory structure of the source files, + and copy all files into the directory specified by the todir + attribute. Note that you can achieve the same effect by using a + flatten mapper.No; defaults to false.
includeEmptyDirsCopy any empty directories included in the FileSet(s). + No; defaults to true.
failonerrorIf false, log a warning message, but do not stop the + build, when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while copying. + No; defaults to true.
verboseLog the files that are being copied.No; defaults to false.
encodingThe encoding to assume when filter-copying the + files. since Ant 1.5.No - defaults to default JVM encoding
outputencodingThe encoding to use when writing the files. + since Ant 1.6.No - defaults to the value of the encoding + attribute if given or the default JVM encoding otherwise.
enablemultiplemappings + If true the task will process to all the mappings for a + given source path. If false the task will only process + the first file or directory. This attribute is only relevant + if there is a mapper subelement. + since Ant 1.6.No - defaults to false.
granularityThe number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 1 second, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. since Ant + 1.6.2.No
+

Parameters specified as nested elements

+ +

fileset or any other resource collection

+

Resource +Collections are used to select groups of files to copy. To use a +resource collection, the todir attribute must be set.

+

Prior to Ant 1.7 only <fileset> has been +supported as a nested element.

+ +

mapper

+

You can define filename transformations by using a nested mapper element. The default mapper used by + <copy> is the identity mapper.

+

+ Since Ant 1.6.3, + one can use a filenamemapper type in place of the mapper element. +

+ +

Note that the source name handed to the mapper depends on the +resource collection you use. If you use <fileset> +or any other collection that provides a base directory, the name +passed to the mapper will be a relative filename, relative to the base +directory. In any other case the absolute filename of the source will +be used.

+ +

filterset

+

FilterSets are used to replace +tokens in files that are copied. + To use a FilterSet, use the nested <filterset> element.

+ +

It is possible to use more than one filterset.

+ +

filterchain

+

The Copy task supports nested +FilterChains.

+ +

+If <filterset> and <filterchain> elements are used inside the +same <copy> task, all <filterchain> elements are processed first +followed by <filterset> elements. +

+ +

Examples

+

Copy a single file

+
+  <copy file="myfile.txt" tofile="mycopy.txt"/>
+
+

Copy a single file to a directory

+
+  <copy file="myfile.txt" todir="../some/other/dir"/>
+
+

Copy a directory to another directory

+
+  <copy todir="../new/dir">
+    <fileset dir="src_dir"/>
+  </copy>
+
+

Copy a set of files to a directory

+
+  <copy todir="../dest/dir">
+    <fileset dir="src_dir">
+      <exclude name="**/*.java"/>
+    </fileset>
+  </copy>
+
+  <copy todir="../dest/dir">
+    <fileset dir="src_dir" excludes="**/*.java"/>
+  </copy>
+
+

Copy a set of files to a directory, appending +.bak to the file name on the fly

+
+  <copy todir="../backup/dir">
+    <fileset dir="src_dir"/>
+    <globmapper from="*" to="*.bak"/>
+  </copy>
+
+ +

Copy a set of files to a directory, replacing @TITLE@ with Foo Bar +in all files.

+
+  <copy todir="../backup/dir">
+    <fileset dir="src_dir"/>
+    <filterset>
+      <filter token="TITLE" value="Foo Bar"/>
+    </filterset>
+  </copy>
+
+ +

Collect all items from the current CLASSPATH setting into a +destination directory, flattening the directory structure.

+
+  <copy todir="dest" flatten="true">
+    <path>
+      <pathelement path="${java.class.path}"/>
+    </path>
+  </copy>
+
+ +

Copies some resources to a given directory.

+
+  <copy todir="dest" flatten="true">
+    <resources>
+      <file file="src_dir/file1.txt"/>
+      <url url="http://ant.apache.org/index.html"/>
+    </resources>
+  </copy>
+
+ +

If the example above didn't use the flatten attribute, + the <file> resource would have returned its full + path as source and target name and would not have been copied at + all. In general it is a good practice to use an explicit mapper + together with resources that use an absolute path as their + names.

+ +

Copies the two newest resources into a destination directory.

+
+  <copy todir="dest" flatten="true">
+    <first count="2">
+      <sort>
+        <date xmlns="antlib:org.apache.tools.ant.types.resources.comparators"/>
+        <resources>
+          <file file="src_dir/file1.txt"/>
+          <file file="src_dir/file2.txt"/>
+          <file file="src_dir/file3.txt"/>
+          <url url="http://ant.apache.org/index.html"/>
+        </resources>
+      </sort>
+    </first>
+  </copy>
+
+ +

The paragraph following the previous example applies to this + example as well.

+ +

Unix Note: File permissions are not retained when files +are copied; they end up with the default UMASK permissions +instead. This +is caused by the lack of any means to query or set file permissions in the +current Java runtimes. If you need a permission-preserving copy function, +use <exec executable="cp" ... > instead. +

+ +

Windows Note: If you copy a file to a directory +where that file already exists, but with different casing, +the copied file takes on the case of the original. The workaround is to +delete +the file in the destination directory before you copy it. +

+

+ Important Encoding Note: + The reason that binary files when filtered get corrupted is that + filtering involves reading in the file using a Reader class. This + has an encoding specifing how files are encoded. There are a number + of different types of encoding - UTF-8, UTF-16, Cp1252, ISO-8859-1, + US-ASCII and (lots) others. On Windows the default character encoding + is Cp1252, on Unix it is usually UTF-8. For both of these encoding + there are illegal byte sequences (more in UTF-8 than for Cp1252). +

+

+ How the Reader class deals with these illegal sequences is up to the + implementation + of the character decoder. The current Sun Java implemenation is to + map them to legal characters. Previous Sun Java (1.3 and lower) threw + a MalformedInputException. IBM Java 1.4 also thows this exception. + It is the mapping of the characters that cause the corruption. +

+

+ On Unix, where the default is normally UTF-8, this is a big + problem, as it is easy to edit a file to contain non US Ascii characters + from ISO-8859-1, for example the Danish oe character. When this is + copied (with filtering) by Ant, the character get converted to a + question mark (or some such thing). +

+

+ There is not much that Ant can do. It cannot figure out which + files are binary - a UTF-8 version of Korean will have lots of + bytes with the top bit set. It is not informed about illegal + character sequences by current Sun Java implementions. +

+

+ One trick for filtering containing only US-ASCII is to + use the ISO-8859-1 encoding. This does not seem to contain + illegal character sequences, and the lower 7 bits are US-ASCII. + Another trick is to change the LANG environment variable from + something like "us.utf8" to "us". +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/copydir.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/copydir.html new file mode 100644 index 000000000..9e9e60e1c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/copydir.html @@ -0,0 +1,136 @@ + + + + + + +Copydir Task + + + + +

Copydir

+

Deprecated

+

This task has been deprecated. Use the Copy task instead.

+

Description

+

Copies a directory tree from the source to the destination.

+

It is possible to refine the set of files that are being copied. This can be +done with the includes, includesfile, excludes, excludesfile and defaultexcludes +attributes. With the includes or includesfile attribute you specify the files you want to +have included by using patterns. The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes src) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcthe directory to copy.Yes
destthe directory to copy to.Yes
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
filteringindicates whether token filtering should take place during + the copyNo
flattenignore directory structure of source directory, + copy all files into a single directory, specified by the dest + attribute (default is false).No
forceoverwriteoverwrite existing files even if the destination + files are newer (default is false).No
+

Examples

+
  <copydir src="${src}/resources"
+           dest="${dist}"
+  />
+

copies the directory ${src}/resources to ${dist}.

+
  <copydir src="${src}/resources"
+           dest="${dist}"
+           includes="**/*.java"
+           excludes="**/Test.java"
+  />
+

copies the directory ${src}/resources to ${dist} +recursively. All java files are copied, except for files with the name Test.java.

+
  <copydir src="${src}/resources"
+           dest="${dist}"
+           includes="**/*.java"
+           excludes="mypackage/test/**"/>
+

copies the directory ${src}/resources to ${dist} +recursively. All java files are copied, except for the files under the mypackage/test +directory.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/copyfile.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/copyfile.html new file mode 100644 index 000000000..e204a7e67 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/copyfile.html @@ -0,0 +1,73 @@ + + + + + + +Copyfile Task + + + + +

Copyfile

+

Deprecated

+

This task has been deprecated. Use the Copy task instead.

+

Description

+

Copies a file from the source to the destination. The file is only copied if +the source file is newer than the destination file, or when the destination file +does not exist.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcthe filename of the file to copy.Yes
destthe filename of the file where to copy to.Yes
filteringindicates whether token filtering should take place during + the copyNo
forceoverwriteoverwrite existing files even if the destination + files are newer (default is false).No
+

Examples

+
+

<copyfile src="test.java" dest="subdir/test.java"/>

+

<copyfile src="${src}/index.html" dest="${dist}/help/index.html"/>

+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/cvs.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvs.html new file mode 100644 index 000000000..deac33d8e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvs.html @@ -0,0 +1,230 @@ + + + + + + + CVS Task + + + + +

Cvs

+

Description

+

Handles packages/modules retrieved from a +CVS repository.

+

Important: This task needs "cvs" on the path. If it isn't, you will get +an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs exceutable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +

+ +

CVSNT Note: CVSNT prefers users to store the passwords +inside the registry. If the cvspass task +and the passfile attribute don't seem to work for you, the most likely +reason is that CVSNT ignores your .cvspass file completely. See bugzilla +report 21657 for recommended workarounds.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
commandthe CVS command to execute.No, default "checkout".
compressiontrue or false - if set + to true, this is the same as compressionlevel="3"No. Defaults to false.
compressionlevelA number between 1 and 9 (corresponding to + possible values for CVS' -z# argument). Any + other value is treated as compression="false"No. Defaults to no compression.
cvsRootthe CVSROOT variable.No
cvsRshthe CVS_RSH variable.No
destthe directory where the checked out files should + be placed. Note that this is different from CVS's -d command line + switch as Apache Ant will never shorten pathnames to avoid empty + directories.No, default is project's basedir.
packagethe package/module to check out. Note: + multiple attributes can be split using spaces. Use a nested + <module> element if you want to specify a module with + spaces in its name.No
tagthe tag of the package/module to check out.No
dateUse the most recent revision no later than the given dateNo
quietsuppress informational messages. This is the same as -q on the command line.No, default "false"
reallyquietsuppress all messages. This is the same as + -Q on the command line. since Ant 1.6.No, default "false"
noexecreport only, don't change any files.No, default to "false"
outputthe file to direct standard output from the command.No, default output to ANT Log as MSG_INFO.
errorthe file to direct standard error from the command.No, default error to ANT Log as MSG_WARN.
appendwhether to append output/error when redirecting to a file.No, default to "false".
portPort used by CVS to communicate with the server.No, default port 2401.
passfilePassword file to read passwords from.No, default file ~/.cvspass.
failonerrorStop the build process if the command exits with a + return code other than 0. Defaults to "false"No
+ +

Parameters specified as nested elements

+ +

module

+ +

Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.

+ + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe module's/package's name.Yes.
+ +

Examples

+
  <cvs cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
+       package="ant"
+       dest="${ws.dir}"
+  />
+

checks out the package/module "ant" from the CVS +repository pointed to by the cvsRoot attribute, and stores the files in "${ws.dir}".

+
  <cvs dest="${ws.dir}" command="update"/>
+

updates the package/module that has previously been checked out into +"${ws.dir}".

+ +
  <cvs command="-q diff -u -N" output="patch.txt"/>
+ +

silently (-q) creates a file called patch.txt which contains a unified (-u) diff which includes new files added via "cvs add" (-N) and can be used as input to patch. +The equivalent, using <commandline> elements, is: +

+
+<cvs output="patch">
+    <commandline>
+        <argument value="-q"/>
+        <argument value="diff"/>
+        <argument value="-u"/>
+        <argument value="-N"/>
+    </commandline>
+</cvs>
+
+or: +
+<cvs output="patch">
+    <commandline>
+        <argument line="-q diff -u -N"/>
+    </commandline>
+</cvs>
+
+

+You may include as many <commandline> elements as you like. +Each will inherit the failonerror, compression, and other "global" parameters +from the <cvs> element. +

+ + +
  <cvs command="update -A -d"/>
+

Updates from the head of repository ignoring sticky bits (-A) and creating any new directories as necessary (-d).

+

Note: the text of the command is passed to cvs "as-is" so any cvs options should appear +before the command, and any command options should appear after the command as in the diff example +above. See the cvs manual for details, +specifically the Guide to CVS commands

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/cvspass.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvspass.html new file mode 100644 index 000000000..185dde794 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvspass.html @@ -0,0 +1,70 @@ + + + + + + +CVSPass Task + + + + +

cvspass

+

Description

+

Adds entries to a .cvspass file. Adding entries to this file has the same affect as a cvs login command.

+ +

CVSNT Note: CVSNT prefers users to store the passwords +inside the registry. If the task doesn't seem to work for you, the +most likely reason is that CVSNT ignores your .cvspass file +completely. See bug +zilla report 21657 for recommended workarounds.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
cvsrootthe CVS repository to add an entry for.Yes
passwordPassword to be added to the password file.Yes
passfilePassword file to add the entry to.No, default is ~/.cvspass.
+

Examples

+
  <cvspass cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
+       password="anoncvs"
+  />
+

Adds an entry into the ~/.cvspass password file.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/cvstagdiff.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvstagdiff.html new file mode 100644 index 000000000..e2dd3d3a2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvstagdiff.html @@ -0,0 +1,241 @@ + + + + + +CvsTagDiff Task + + +

CvsTagDiff

+

Description

+

Generates an XML-formatted report file of the changes between two tags or dates recorded in a +CVS repository.

+

Important: This task needs "cvs" on the path. If it isn't, you will get +an error (such as error 2 on windows). If <cvs> doesn't work, try to execute cvs.exe +from the command line in the target directory in which you are working. +Also note that this task assumes that the cvs exceutable is compatible +with the Unix version from cvshome.org, this is not completely true +for certain other cvs clients - like CVSNT for example - and some +operation may fail when using such an incompatible client. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
startTagThe earliest tag from which diffs are to be + included in the report.exactly one of the two.
startDateThe earliest date from which diffs are to be + included in the report.
+ accepts all formats accepted by the cvs command for -D date_spec arguments
endTagThe latest tag from which diffs are to be + included in the report.exactly one of the two.
endDateThe latest date from which diffs are to be + included in the report.
+ accepts all formats accepted by the cvs command for -D date_spec arguments
destfileThe file in which to write the diff report.Yes
ignoreRemovedWhen set to true, the report will not include any + removed files. Since Apache Ant 1.8.0No, defaults to false.
+ +

Parameters inherited from the cvs task

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
compressiontrue, false, or the number 1-9 (corresponding to possible values for CVS -z# argument). Any other value is treated as falseNo. Defaults to no compression. if passed true, level 3 compression is assumed.
cvsRootthe CVSROOT variable.No
cvsRshthe CVS_RSH variable.No
packagethe package/module to analyze.
+ Since Ant 1.6 + multiple packages separated by spaces are possible. + aliases corresponding to different modules are also possible + Use a nested <module> element if you want to specify a module with + spaces in its name.		No
Yes
quietsuppress informational messages.No, default "false"
portPort used by CVS to communicate with the server.No, default port 2401.
passfilePassword file to read passwords from.No, default file ~/.cvspass.
failonerrorStop the buildprocess if the command exits with a + returncode other than 0. Defaults to falseNo
+ +

Parameters specified as nested elements

+ +

module

+ +

Specifies a package/module to work on, unlike the package attribute + modules specified using this attribute can contain spaces in their + name.

+ + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe module's/package's name.Yes.
+ +

Examples

+
  <cvstagdiff cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
+                destfile="tagdiff.xml"
+                package="ant"
+                startTag="ANT_14"
+                endTag="ANT_141"
+  />
+ +

Generates a tagdiff report for all the changes that have been made +in the ant module between the tags ANT_14 and ANT_141. +It writes these changes into the file tagdiff.xml.

+ +
  <cvstagdiff
+                destfile="tagdiff.xml"
+                package="ant"
+                startDate="2002-01-01"
+                endDate="2002-31-01"
+  />
+ +

Generates a tagdiff report for all the changes that have been made +in the ant module in january 2002. In this example cvsRoot +has not been set. The current cvsRoot will be used (assuming the build is started +from a folder stored in cvs. +It writes these changes into the file tagdiff.xml.

+ +
  <cvstagdiff
+                destfile="tagdiff.xml"
+                package="ant jakarta-gump"
+                startDate="2003-01-01"
+                endDate="2003-31-01"
+  />
+ +

Generates a tagdiff report for all the changes that have been made +in the ant and jakarta-gump modules in january 2003. +In this example cvsRoot +has not been set. The current cvsRoot will be used (assuming the build is started +from a folder stored in cvs. +It writes these changes into the file tagdiff.xml.

+ +

Generate Report

+

Ant includes a basic XSLT stylesheet that you can use to generate +a HTML report based on the xml output. The following example illustrates +how to generate a HTML report from the XML report.

+ +
+        <style in="tagdiff.xml" 
+               out="tagdiff.html" 
+               style="${ant.home}/etc/tagdiff.xsl">
+          <param name="title" expression="Ant Diff"/>
+          <param name="module" expression="ant"/>
+          <param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
+        </style>
+
+ +

Output

+

+The cvsroot and package attributes of the tagdiff element are new in ant 1.6.
+Notes on entry attributes : + + + + + +
AttributeComment
namewhen reporting on one package, the package name is removed from the output
revisionsupplied for files which exist at the end of the reporting period
prevrevisionsupplied for files which exist at the beginning of the reporting period.
+Old CVS servers do not supply it for deleted files. CVS 1.12.2 supplies it.
+

+
+<?xml version="1.0" encoding="UTF-8"?>
+<tagdiff startTag="ANT_14" endTag="ANT_141" 
+cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" package="ant">
+  <entry>
+    <file>
+      <name>src/main/org/apache/tools/ant/DirectoryScanner.java</name>
+      <revision>1.15.2.1</revision>
+      <prevrevision>1.15</prevrevision>
+    </file>
+  </entry>
+</tagdiff>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/cvsversion.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvsversion.html new file mode 100644 index 000000000..09e7cee13 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/cvsversion.html @@ -0,0 +1,108 @@ + + + + + + + CVSVersion Task + + + + +

CvsVersion

+

Description

+

+This task allows to retrieve a CVS client and server version. + Since Apache Ant 1.6.1. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
Attributes from parent Cvs task which are meaningful here
cvsRootthe CVSROOT variable.No
cvsRshthe CVS_RSH variable.No
destdirectory containing the checked out version of the projectNo, default is project's basedir.
packagethe package/module to check out.No
portPort used by CVS to communicate with the server.No, default port 2401.
passfilePassword file to read passwords from.No, default file ~/.cvspass.
failonerrorStop the build process if the command exits with a + return code other than 0. Defaults to falseNo
Specific attributes
clientversionpropertyName of a property where the cvsclient version + should be storedNo
serverversionpropertyName of a property where the cvs server version + should be storedNo
+

Examples

+
  <cvsversion cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
+       passfile="/home/myself/.cvspass"
+       serverversionproperty="apachecvsversion"
+       clientversionproperty="localcvsversion"
+  />
+

finds out the cvs client and server versions and stores the versions in the +properties called apachecvsversion and localcvsversion

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/defaultexcludes.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/defaultexcludes.html new file mode 100644 index 000000000..7f25a9d81 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/defaultexcludes.html @@ -0,0 +1,107 @@ + + + + + + +DefaultExcludes Task + + + + +

DefaultExcludes

+ +

since Apache Ant 1.6

+ +

Description

+

Alters the default excludes for all subsequent processing in the +build, and prints out the current default excludes if desired. + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
echowhether or not to print out the default excludes.(defaults to false)attribute "true" required if no + other attribute specified
defaultgo back to hard wired default excludesattribute "true" required if no + if no other attribute is specified
addthe pattern to add to the default excludesif no other attribute is specified
removeremove the specified pattern from the default excludesif no other attribute is specified
+ +

Examples

+ +

Print out the default excludes

+ +
  <defaultexcludes echo="true"/>
+ +

Print out the default excludes and exclude all *.bak files in +all further processing

+ +
  <defaultexcludes echo="true" add="**/*.bak"/>
+ +

Silently allow several fileset based tasks to operate on emacs +backup files and then restore normal behavior

+ +
+  <defaultexcludes remove="**/*~"/>
+
+  (do several fileset based tasks here)
+
+  <defaultexcludes default="true"/>
+
+ +

Notes

+By default the pattern **/.svn and **/.svn/** are set as default +excludes. With version 1.3 Subversion supports the +"_svn hack". +That means, that the svn-libraries evaluate environment variables and use .svn +or _svn directory regarding to that value. We had chosen not to evaluate environment variables to +get a more reliable build. Instead you have to change the settings by yourself by changing +the exclude patterns: +
+  <defaultexcludes remove="**/.svn"/>
+  <defaultexcludes remove="**/.svn/**"/>
+  <defaultexcludes add="**/_svn"/>
+  <defaultexcludes add="**/_svn/**"/>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/delete.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/delete.html new file mode 100644 index 000000000..5f1eab4b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/delete.html @@ -0,0 +1,215 @@ + + + + + + +Delete Task + + + + +

Delete

+

Description

+

Deletes a single file, a specified directory and all its files and +subdirectories, or a set of files specified by one or more +resource collections. +The literal implication of <fileset> is that +directories are not included; however the removal of empty directories can +be triggered when using nested filesets by setting the +includeEmptyDirs attribute to true. Note that this +attribute is meaningless in the context of any of the various resource +collection types that do include directories, but that no attempt +will be made to delete non-empty directories in any case. Whether a +directory is empty or not is decided by looking into the filesystem - +include or exclude patterns don't apply here.

+

+If you use this task to delete temporary files created by editors +and it doesn't seem to work, read up on the +default exclusion set +in Directory-based Tasks, and see the +defaultexcludes attribute below. + +

For historical reasons <delete dir="x"/> is + different from <delete><fileset + dir="x"/></delete>, it will try to remove everything + inside "x" including "x" itself, not taking default excludes into + account, blindly following all symbolic links. If you need more + control, use a nested <fileset>.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to delete, specified as either the simple + filename (if the file exists in the current base directory), a + relative-path filename, or a full-path filename.At least one of the two, + unless nested resource collections are specified +
dirThe directory to delete, including all its files and + subdirectories.
+ Note: dir is not used + to specify a directory name for file; file + and dir are independent of each other.
+ WARNING: Do not set dir to + ".", "${basedir}", + or the full-pathname equivalent unless you truly intend to + recursively remove the entire contents of the current base directory + (and the base directory itself, if different from the current working + directory).
verboseWhether to show the name of each deleted file.No, default "false"
quietIf the specified file or directory does not exist, + do not display a diagnostic message (unless Apache Ant + has been invoked with the -verbose or + -debug switches) or modify the exit status to + reflect an error. + When set to "true", if a file or directory cannot be deleted, + no error is reported. This setting emulates the + -f option to the Unix rm command. + Setting this to "true" implies setting + failonerror to "false". + No, default "false"
failonerrorControls whether an error (such as a failure to + delete a file) stops the build or is merely reported to the screen. + Only relevant if quiet is "false".No, default "true"
includeemptydirsWhether to delete empty directories + when using filesets.No, default "false"
includesDeprecated. Use resource collections. + Comma- or space-separated list of patterns of + files that must be deleted. All files are relative to the directory + specified in dir.No
includesfileDeprecated. Use resource collections. + The name of a file. Each line of + this file is taken to be an include pattern.No
excludesDeprecated. Use resource collections. + Comma- or space-separated list of patterns of + files that must be excluded from the deletion list. + All files are relative to the directory specified in dir. + No files (except default excludes) are excluded when omitted.No
excludesfileDeprecated. Use resource collections. + The name of a file. Each line of + this file is taken to be an exclude patternNo
defaultexcludesDeprecated. Use resource collections. + Whether to use + default excludes.No, default "true"
deleteonexit + Indicates whether to use File#deleteOnExit() if there is a + failure to delete a file, this causes the jvm to attempt + to delete the file when the jvm process is terminating. + Since Ant 1.6.2No, default "false"
removeNotFollowedSymlinks + Whether symbolic links (not the files/directories they link to) + should be removed if they haven't been followed because + followSymlinks was false or the maximum number of symbolic links + was too big. + Since Ant 1.8.0No, default "false"
+ +

Examples

+
  <delete file="/lib/ant.jar"/>
+

deletes the file /lib/ant.jar.

+
  <delete dir="lib"/>
+

deletes the lib directory, including all files +and subdirectories of lib.

+ +
  <delete>
+    <fileset dir="." includes="**/*.bak"/>
+  </delete>
+
+

deletes all files with the extension .bak from the current directory +and any subdirectories.

+ +
  <delete includeEmptyDirs="true">
+    <fileset dir="build"/>
+  </delete>
+
+

deletes all files and subdirectories of build, including +build itself.

+ +
  <delete includeemptydirs="true">
+    <fileset dir="build" includes="**/*"/>
+  </delete>
+
+

deletes all files and subdirectories of build, without +build itself.

+ +
  <delete includeemptydirs="true">
+    <fileset dir="src" includes="**/.svn" defaultexcludes="false"/>
+  </delete>
+
+

deletes the subversion metadata directories under src. Because .svn +is on of the default excludes you have to use the +defaultexcludes flag, otherwise Ant wont delete these directories and the files in it.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/deltree.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/deltree.html new file mode 100644 index 000000000..98adf4f55 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/deltree.html @@ -0,0 +1,56 @@ + + + + + + +Deltree Task + + + + +

Deltree

+

Deprecated

+

This task has been deprecated. Use the Delete task instead.

+

Description

+

Deletes a directory with all its files and subdirectories.

+

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
dirthe directory to delete.Yes
+

Examples

+
  <deltree dir="dist"/>
+

deletes the directory dist, including its files and +subdirectories.

+
  <deltree dir="${dist}"/>
+

deletes the directory ${dist}, including its files and +subdirectories.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/depend.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/depend.html new file mode 100644 index 000000000..55017becf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/depend.html @@ -0,0 +1,216 @@ + + + + + + +Depend Task + + + + +

Depend

+ +A task to manage Java class file dependencies. + +

Description

+ +

+The depend task works by determining which classes are out of date with +respect to their source and then removing the class files of any other +classes which depend on the out-of-date classes. +

+ +

To determine the class dependencies, the depend task analyses the class +files of all class files passed to it. Depend does not parse your source code in +any way but relies upon the class references encoded into the class files by the +compiler. This is generally faster than parsing the Java source.

+ +

+To learn more about how this information is obtained from the class files, +please refer to the Java +Virtual Machine Specification +

+ +

Since a class' dependencies only change when the class itself changes, the +depend task is able to cache dependency information. Only those class files +which have changed will have their dependency information re-analysed. Note that +if you change a class' dependencies by changing the source, it will be +recompiled anyway. You can examine the dependency files created to understand +the dependencies of your classes. Please do not rely, however, on the format of +the information, as it may change in a later release.

+ +

Once depend discovers all of the class dependencies, it "inverts" +this relation to determine, for each class, which other classes are dependent +upon it. This "affects" list is used to discover which classes are +invalidated by the out of date class. The class files of the invalidated +classes are removed, triggering the compilation of the affected classes.

+ +

The depend task supports an attribute, "closure" which controls +whether depend will only consider direct class-class relationships or whether it +will also consider transitive, indirect relationships. For example, say there +are three classes, A, which depends on B, which in-turn depend on C. Now say +that class C is out of date. Without closure, only class B would be removed by +depend. With closure set, class A would also be removed. Normally direct +relationships are sufficient - it is unusual for a class to depend on another +without having a direct relationship. With closure set, you will notice that +depend typically removes far more class files.

+ +

The classpath attribute for <depend> is optional. If it is present, +depend will check class dependencies against classes and jars on this classpath. +Any classes which depend on an element from this classpath and which are older +than that element will be deleted. A typical example where you would use this +facility would be where you are building a utility jar and want to make sure +classes which are out of date with respect to this jar are rebuilt. You should +not include jars in this classpath which you do not expect to change, +such as the JDK runtime jar or third party jars, since doing so will just slow +down the dependency check. This means that if you do use a classpath for the +depend task it may be different from the classpath necessary to actually +compile your code.

+ +

Performance

+ +

The performance of the depend task is dependent on a +number of factors such as class relationship complexity and how many class files +are out of date. The decision about whether it is cheaper to just recompile all +classes or to use the depend task will depend on the size of your project and +how interrelated your classes are.

+ + +

Limitations

+ +

There are some source dependencies which depend will not detect.

+ +
    +
  • If the Java compiler optimizes away a class relationship, + there can be a source dependency without a class dependency.
    • + +
  • Non public classes cause two problems. Firstly depend cannot relate + the class file to a source file. In the future this may be addressed + using the source file attribute in the classfile. Secondly, neither + depend nor the compiler tasks can detect when a non public class is + missing. Inner classes are handled by the depend task.
    • +
+ +The most obvious example of these limitations is that the task can't tell +which classes to recompile when a constant primitive data type exported +by other classes is changed. For example, a change in the definition of +something like +
+public final class Constants {
+  public final static boolean DEBUG=false;
+}
+
will not be picked up by other classes. + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcDirThis is the directory where the source exists. depend +will examine this to determine which classes are out of date. If you use multiple +source directories you can pass this attribute a path of source directories.Yes
destDirThis is the root directory of the class files which +will be analysed. If this is not present, the srcdir is used.No
cacheThis is a directory in which depend can store and +retrieve dependency information. If this is not present, depend will not +use a cache No
closureThis attribute controls whether depend only removes +classes which directly depend on out of date classes. If this is set to true, +depend will traverse the class dependency graph deleting all affected +classes. Defaults to falseNo
dumpIf true the dependency information will be written to the debug level log + No
classpathThe classpath containing jars and classes for which <depend> should also + check dependenciesNo
warnOnRmiStubsFlag to disable warnings about files that look like rmic generated stub/skeleton + classes, and which have no .java source. Useful when doing rmi development. No, default=true
+ +

Parameters specified as nested elements

+

The depend task's classpath attribute is a +PATH-like structure and can also be set +via a nested <classpath> element.

+ +

Additionally, +this task forms an implicit +FileSet +and supports most attributes of +<fileset> (dir becomes srcdir), +as well as the nested <include>, +<exclude>, and <patternset> elements. + +

Examples

+
<depend srcdir="${java.dir}"
+        destdir="${build.classes}"
+        cache="depcache"
+        closure="yes"/>
+ +

removes any classes in the ${build.classes} directory +that depend on out-of-date classes. Classes are considered out-of-date with +respect to the source in the ${java.dir} directory, using the same +mechanism as the <javac> task. In this example, the +<depend> task caches its dependency +information in the depcache directory.

+ +
+<depend srcdir="${java.dir}" destdir="${build.classes}"
+        cache="depcache" closure="yes">
+  <include name="**/*.java"/>
+  <excludesfile name="${java.dir}/build_excludes"/>
+</depend>
+
+

does the same as the previous example, but explicitly includes all +.java files, except those that match the list given +in ${java.dir}/build_excludes.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/dependset.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/dependset.html new file mode 100644 index 000000000..34ec238b1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/dependset.html @@ -0,0 +1,171 @@ + + + + + + +DependSet Task + + + + +

DependSet

+ +A task to manage arbitrary dependencies between resources. + +

Description

+ +

+The dependset task compares a set of sources with a set of target +files. If any of the sources has been modified more recently than +any of the target files, all of the target files are removed. +

+

+Sources and target files are specified via nested +Resource Collections; +sources can be resources of any type, while targets are restricted to files +only. At least one set of sources and one set of targets is required. +

+

+Use a FileSet when you want to use wildcard include or exclude +patterns and don't care about missing files. Use a FileList when you +want to consider the non-existence of a file as if it were out of +date. If there are any non-existing files in any source or target +FileList, all target files will be removed. +

+

+DependSet is useful to capture dependencies that are not or cannot be +determined algorithmically. For example, the <style> task only +compares the source XML file and XSLT stylesheet against the target +file to determined whether to restyle the source. Using dependset you +can extend this dependency checking to include a DTD or XSD file as +well as other stylesheets imported by the main stylesheet. +

+ +

Parameters

+ + + + + + + + + + + + +
AttributeDescriptionRequired
verboseMakes the task list all deleted targets files + and the reason why they get deleted.No
+ +

Parameters Specified as Nested Elements

+ +

sources

+ +

The <sources> element is a +Union into which +arbitrary resource collections can be nested. Since Apache Ant 1.7 +

+ +

srcfileset

+ +

+The nested <srcfileset> element specifies a FileSet. All files included in +this fileset will be compared against all files included in all of the +<targetfileset> filesets and <targetfilelist> +filelists. Multiple <srcfileset> filesets may be specified. +

+ +

srcfilelist

+ +

+The nested <srcfilelist> element specifies a FileList. All files included in +this filelist will be compared against all files included in all of the +<targetfileset> filesets and <targetfilelist> +filelists. Multiple <srcfilelist> filelists may be specified. +

+ +

targets

+ +

The <targets> element is a +Path and thus can +include any filesystem-based resource. Since Ant 1.7 +

+ +

targetfileset

+ +

+The nested <targetfileset> element specifies a FileSet. All files included in +this fileset will be compared against all files included in all of the +<srcfileset> filesets and <sourcefilelist> +filelists, and if any are older, they are all deleted. +Multiple <targetfileset> filesets may be specified. +

+ +

targetfilelist

+ +

+The nested <targetfilelist> element specifies a FileList. All files included in +this filelist will be compared against all files included in all of the +<srcfileset> filesets and <sourcefilelist> +filelists, and if any are older, they are all deleted. +Multiple <targetfilelist> filelists may be specified. +

+ +

Examples

+
+    <dependset>
+       <srcfilelist
+           dir   = "${dtd.dir}"
+           files = "paper.dtd,common.dtd"/>
+       <srcfilelist
+           dir   = "${xsl.dir}"
+           files = "common.xsl"/>
+       <srcfilelist
+           dir   = "${basedir}"
+           files = "build.xml"/>
+       <targetfileset
+           dir      = "${output.dir}"
+           includes = "**/*.html"/>
+    </dependset>
+
+ +

+In this example derived HTML files in the ${output.dir} directory +will be removed if any are out-of-date with respect to:

+
    +
  1. the DTD of their source XML files
    2. +
  2. a common DTD (imported by the main DTD)
    3. +
  3. a subordinate XSLT stylesheet (imported by the main stylesheet), or
    4. +
  4. the buildfile
    5. +
+ +

+If any of the sources in the above example does not exist, all +target files will also be removed. To ignore missing sources instead, +use filesets instead of filelists for the sources. +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/diagnostics.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/diagnostics.html new file mode 100644 index 000000000..cdb16930d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/diagnostics.html @@ -0,0 +1,49 @@ + + + + + + +Diagnostics Task + + + + +

Diagnostics

+

Diagnostics

+

+Runs Apache Ant's -diagnostics code inside Ant itself. This is good for +debugging Ant's configuration under an IDE. +Since Ant 1.7.0 +

+ + +

Examples

+ +
+    <target name="diagnostics" description="diagnostics">
+        <diagnostics/>
+    </target>
+
+

+ Prints out the current diagnostics dump. +

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/dirname.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/dirname.html new file mode 100644 index 000000000..03227b462 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/dirname.html @@ -0,0 +1,74 @@ + + + + + + +Dirname Task + + + + +

Dirname

+

Description

+

+Task to determine the directory path of a specified file. +

+

+When this task executes, it will set the specified property to the +value of the specified file (or directory) up to, but not including, +the last path element. If the specified file is a path that ends in a +filename, the filename will be dropped. If the specified file is just +a filename, the directory will be the current directory. +

+

+ Note: This is not the same as the UNIX dirname command, which is + defined as "strip non-directory suffix from filename". <dirname> + determines the full directory path of the specified file. +

+

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe path to take the dirname of.Yes
propertyThe name of the property to set.Yes
+ +

Examples

+
  <dirname property="antfile.dir" file="${ant.file}"/>
+will set antfile.dir to the directory path for +${ant.file}. +
  <dirname property="foo.dirname" file="foo.txt"/>
+will set foo.dirname to the project's basedir.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/ear.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/ear.html new file mode 100644 index 000000000..4479f1766 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/ear.html @@ -0,0 +1,292 @@ + + + + + + +EAR Task + + + + +

Ear

+

Description

+

An extension of the Jar task with special +treatment for files that should end up in an Enterprise Application archive.

+

(The Ear task is a shortcut for specifying the particular layout of a EAR file. +The same thing can be accomplished by using the prefix and fullpath +attributes of zipfilesets in a Zip or Jar task.)

+

The extended zipfileset element from the zip task (with attributes prefix, fullpath, and src) is available in the Ear task.

+ +

Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the duplicate attribute +to a value other than its default, "add".

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destfilethe EAR file to create.Yes
appxmlThe deployment descriptor to use (META-INF/application.xml).Yes, unless update is set to true
basedirthe directory from which to jar the files.No
compressNot only store data but also compress them, + defaults to true. Unless you set the keepcompression + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.No
keepcompressionFor entries coming from existing archives (like + nested zipfilesets or while updating the archive), keep + the compression as it has been originally instead of using the + compress attribute. Defaults false. Since Apache Ant + 1.6No
encodingThe character encoding to use for filenames + inside the archive. Defaults to UTF8. It is not + recommended to change this value as the created archive will most + likely be unreadable for Java otherwise. +
See also the discussion in the + zip task page		No
filesonlyStore only file entries, defaults to falseNo
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
manifestthe manifest file to use.No
filesetmanifestbehavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + No
whenmanifestonlybehavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".No
manifestencodingThe encoding used to read the JAR manifest, when a manifest file is specified.No, defaults to the platform encoding.
indexwhether to create an index + list to speed up classloading. This is a JDK 1.3+ specific + feature. Unless you specify additional jars with nested indexjars elements, only the + contents of this jar will be included in the index. Defaults to + false.No
indexMetaInfwhether to include META-INF and its children in + the index. Doesn't have any effect if index is + false.
+ Sun's jar implementation used to skip the META-INF directory and + Ant followed that example. The behavior has been changed with + Java + 5. In order to avoid problems with Ant generated jars on + Java 1.4 or earlier Ant will not include META-INF unless + explicitly asked to.
+ Ant 1.8.0 - Defaults to false.		No
updateindicates whether to update or overwrite + the destination file if it already exists. Default is "false".No
duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
roundupWhether the file modification times will be + rounded up to the next even number of seconds.
+ Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.
+ Defaults to true. Since Ant 1.6.2		No
levelNon-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). Since Ant 1.7No
preserve0permissionswhen updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.
+ Set this attribute to true if you really want to preserve the + original permission field.since Ant 1.8.0 + 		No, default is false
useLanguageEncodingFlagWhether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is true
createUnicodeExtraFieldsWhether to create unicode extra fields to store + the file names a second time inside the entry's metadata. +
Possible values are "never", "always" and "not-encodable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is "never"
fallbacktoUTF8Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is false
mergeClassPathAttributesWhether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + Since Ant 1.8.0. +
unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.		No, default is false
flattenAttributesWhether to merge attributes occuring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + Since Ant 1.8.0.No, default is false
+ +

Nested elements

+ +

metainf

+

The nested metainf element specifies a FileSet. All files included in this fileset will +end up in the META-INF directory of the ear file. If this +fileset includes a file named MANIFEST.MF, the file is +ignored and you will get a warning.

+ +

manifest, indexjars, service

+These are inherited from <jar> + +

Example

+
+    <ear destfile="${build.dir}/myapp.ear" appxml="${src.dir}/metadata/application.xml">
+      <fileset dir="${build.dir}" includes="*.jar,*.war"/>
+    </ear>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/echo.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/echo.html new file mode 100644 index 000000000..e9c9176f5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/echo.html @@ -0,0 +1,193 @@ + + + + + + +Echo Task + + + + +

Echo

+

Description

+

Echoes a message to the current loggers and listeners which +means System.out unless overridden. A level +can be specified, which controls at what logging level the message is +filtered at. +

+The task can also echo to a file, in which case the option to append rather +than overwrite the file is available, and the level option is +ignored

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
messagethe message to echo.No. Text may also be included in a + character section within this element. If neither is included a + blank line will be emitted in the output.
filethe file to write the message to.Optionally one of these may be specified.
outputthe Resource + to write the message to (see note). + Since Apache Ant 1.8
appendAppend to an existing file (or + + open a new file / overwrite an existing file)? Default false. + No; ignored unless output indicates a + filesystem destination.
levelControl the level at which this message is reported. + One of "error", "warning", "info", "verbose", "debug" (decreasing order)No - default is "warning".
encodingencoding to use, default is ""; the local system encoding. since Ant 1.7No
forceOverwrite read-only destination + files. since Ant 1.8.2No; defaults to false.
+ +

Examples

+
+<echo message="Hello, world"/>
+
+
+<echo message="Embed a line break:${line.separator}"/>
+
+
+<echo>Embed another:${line.separator}</echo>
+
+
+<echo>This is a longer message stretching over
+two lines.
+</echo>
+
+
+<echo>
+This is a longer message stretching over
+three lines; the first line is a blank
+</echo>
+
+The newline immediately following the <echo> tag will be part of the output.
+Newlines in character data within the content of an element are not discarded by XML parsers.
+See +W3C Recommendation 04 February 2004 / End of Line handling + for more details. + +
<echo message="Deleting drive C:" level="debug"/>
+A message which only appears in -debug mode. +
<echo level="error">
+Imminent failure in the antimatter containment facility.
+Please withdraw to safe location at least 50km away.
+</echo>
+
+A message which appears even in -quiet mode. + +
<echo file="runner.csh" append="false">#\!/bin/tcsh
+java-1.3.1 -mx1024m ${project.entrypoint} $$*
+</echo>
+Generate a shell script by echoing to a file. +Note the use of a double $ symbol to stop Ant +filtering out the single $ during variable expansion + +

Depending on the loglevel Ant runs, messages are print out or silently +ignored: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Ant-Statement-quiet, -qno statement-verbose, -v-debug, -d
<echo message="This is error message." level="error" />
okokokok
<echo message="This is warning message." />
okokokok
<echo message="This is warning message." level="warning" />
okokokok
<echo message="This is info message." level="info" />
not loggedokokok
<echo message="This is verbose message." level="verbose" />
not loggednot loggedokok
<echo message="This is debug message." level="debug" />
not loggednot loggednot loggedok
+ + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/echoproperties.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/echoproperties.html new file mode 100644 index 000000000..9511a2f9d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/echoproperties.html @@ -0,0 +1,146 @@ + + + + + + +Echoproperties Task + + + + +

echoproperties

+

Description

+ +

Displays all the current properties (or a subset of them specified +by a nested <propertyset>) in the project. The +output can be sent to a file if desired. This task can be used as a +somewhat contrived means of returning data from an +<ant> invocation, but is really for debugging build +files.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destfileIf specified, the value indicates the name of the + file to send the output of the statement to. The generated output file + is compatible for loading by any Java application as a property file. + If not specified, then the output will go to the Apache Ant log.No
prefix + a prefix which is used to filter the properties + only those properties starting with this prefix will be echoed. +

+

No
regex + a regular expression which is used to filter the + properties + only those properties whose names match it will be echoed. + No
failonerrorBy default, the "failonerror" attribute is enabled. + If an error occurs while writing the properties to a file, and this + attribute is enabled, then a BuildException will be thrown, causing the + build to fail. If disabled, then IO errors will be reported as a log + statement, and the build will continue without failure from this task.No
formatOne of text or xml. + Determines the output format. Defaults to text.No
+ +

Parameters specified as nested elements

+ +

propertyset

+ +

You can specify subsets of properties to be echoed with propertysets. Using +propertysets gives more control on which properties will be +picked up. The attributes prefix and regex are just +shorcuts that use propertysets internally. +

+ +

since Ant 1.6.

+ +

Examples

+
+  <echoproperties/>
+
+

Report the current properties to the log.

+
+  <echoproperties destfile="my.properties"/>
+
+

Report the current properties to the file "my.properties", and will +fail the build if the file could not be created or written to.

+
+  <echoproperties destfile="my.properties" failonerror="false"/>
+
+

Report the current properties to the file "my.properties", and will +log a message if the file could not be created or written to, but will still +allow the build to continue.

+
+  <echoproperties prefix="java."/>
+
+

List all properties beginning with "java."

+
+  <echoproperties>
+    <propertyset>
+      <propertyref prefix="java."/>
+    </propertyset>
+  </echoproperties>
+
+

This again lists all properties beginning with "java." using a nested +</propertyset> which is an equivalent but longer way.

+
+  <echoproperties regex=".*ant.*"/>
+
+

Lists all properties that contain "ant" in their names. +The equivalent snippet with </propertyset> is:

+
+  <echoproperties>
+    <propertyset>
+      <propertyref regex=".*ant.*"/>
+    </propertyset>
+  </echoproperties>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/echoxml.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/echoxml.html new file mode 100644 index 000000000..9c0188e15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/echoxml.html @@ -0,0 +1,73 @@ + + + + + + +EchoXML Task + + + + +

EchoXML

+

Description

+

Echo nested XML to the console or a file. Since Apache Ant 1.7

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to receive the XML. If omitted nested + XML will be echoed to the log.No
appendWhether to append file, if specified.No
namespacePolicySets the namespace policy as defined + by org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy. Valid + values are "ignore," "elementsOnly," or "all." Default is + "ignore".No
+

Parameters specified as nested elements

+Nested XML content is required. + +

Examples

+
<echoxml file="subbuild.xml">
+  <project default="foo">
+    <target name="foo">
+      <echo>foo</echo>
+    </target>
+  </project>
+</echoxml>
+
+

Creates an Ant buildfile, subbuild.xml.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/ejb.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/ejb.html new file mode 100644 index 000000000..6e03a3358 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/ejb.html @@ -0,0 +1,1781 @@ + + + + + + +EJB Tasks + + + + + +

Apache Ant EJB Tasks User Manual

+

by

+ + + +
+

Table of Contents

+ + +
+

Introduction

+

Ant provides a number of optional tasks for developing 1.x and 2.x +Enterprise Java Beans (EJBs). +In general these tasks are specific to the particular vendor's EJB Server.

+ +

The tasks support:
+ +

+ Vendors such as BEA and IBM now provide custom Ant tasks to work with their + particular products. More importantly, EJB3.0 renders this whole process obsolete. + Accordingly, developement of these tasks is effectively frozen. Bug reports + and especially patches are welcome, but there is no pressing need to add + support for new application servers. Nobody should be writing new EJB2.x applications + and definitely not new EJB2.x servers. +

+ +
+

EJB Tasks

+ + + + + + + + + + + + + + + + +
TaskApplication Servers
blgenclientBorland Application Server 4.5 and 5.x
ddcreatorWeblogic 4.5.1
ejbcWeblogic 4.5.1
iplanet-ejbciPlanet Application Server 6.0
ejbjarNested Elements
borlandBorland Application Server 4.5 and 5.x
iPlanetiPlanet Application Server 6.0
jbossJBoss
jonasJOnAS 2.4.x and 2.5
weblogicWeblogic 5.1 to 7.0
websphereIBM WebSphere 4.0
wlrunWeblogic 4.5.1 to 7.0
wlstopWeblogic 4.5.1 to 7.0
+ +
+

ddcreator

+

Description:

+

ddcreator will compile a set of Weblogic text-based deployment descriptors into a serialized +EJB deployment descriptor. The selection of which of the text-based descriptors are to be compiled +is based on the standard Ant include and exclude selection mechanisms. +

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
descriptorsThis is the base directory from which descriptors are selected.Yes
destThe directory where the serialized deployment descriptors will be writtenYes
classpathThis is the classpath to use to run the underlying weblogic ddcreator tool. + This must include the weblogic.ejb.utils.DDCreator classNo
+

Examples

+
+<ddcreator descriptors="${dd.dir}"
+           dest="${gen.classes}"
+           classpath="${descriptorbuild.classpath}">
+  <include name="*.txt"/>
+</ddcreator>
+
+ +
+

ejbc

+

Description:

+

The ejbc task will run Weblogic's ejbc tool. This tool will take a serialized deployment descriptor, +examine the various EJB interfaces and bean classes and then generate the required support classes +necessary to deploy the bean in a Weblogic EJB container. This will include the RMI stubs and skeletons +as well as the classes which implement the bean's home and remote interfaces.

+

+The ant task which runs this tool is able to compile several beans in a single operation. The beans to be +compiled are selected by including their serialized deployment descriptors. The standard ant +include and exclude constructs can be used to select the deployment descriptors +to be included.

+

+Each descriptor is examined to determine whether the generated classes are out of date and need to be +regenerated. The deployment descriptor is de-serialized to discover the home, remote and +implementation classes. The corresponding source files are determined and checked to see their +modification times. These times and the modification time of the serialized descriptor itself are +compared with the modification time of the generated classes. If the generated classes are not present +or are out of date, the ejbc tool is run to generate new versions.

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
descriptorsThis is the base directory from which the serialized deployment descriptors are selected.Yes
destThe base directory where the generated classes, RIM stubs and RMI skeletons are writtenYes
manifestThe name of a manifest file to be written. This manifest will contain an entry for each EJB processedYes
srcThe base directory of the source tree containing the source files of the home interface, + remote interface and bean implementation classes.Yes
classpathThis classpath must include both the weblogic.ejbc class and the + class files of the bean, home interface, remote interface, etc of the bean being + processed.No
keepgeneratedControls whether ejbc will keep the + intermediate Java files used to build the class files. This can be + useful when debugging.No, defaults to false.
+

Examples

+
+<ejbc descriptors="${gen.classes}"
+           src="${src.dir}"
+           dest="${gen.classes}"
+           manifest="${build.manifest}"
+           classpath="${descriptorbuild.classpath}">
+  <include name="*.ser"/>
+</ejbc>
+
+ +
+

+iplanet-ejbc

+ +

+Description:

+Task to compile EJB stubs and skeletons for the iPlanet Application Server +6.0. Given a standard EJB 1.1 XML descriptor as well as an iAS-specific +EJB descriptor, this task will generate the stubs and skeletons required +to deploy the EJB to iAS. Since the XML descriptors can include multiple +EJBs, this is a convenient way of specifying many EJBs in a single Ant +task. +

For each EJB specified, the task will locate the three classes that +comprise the EJB in the destination directory. If these class files +cannot be located in the destination directory, the task will fail. The +task will also attempt to locate the EJB stubs and skeletons in this directory. +If found, the timestamps on the stubs and skeletons will be checked to +ensure they are up to date. Only if these files cannot be found or if they +are out of date will the iAS ejbc utility be called to generate new stubs +and skeletons.

+

+Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
ejbdescriptorStandard EJB 1.1 XML descriptor (typically titled "ejb-jar.xml").Yes
iasdescriptoriAS-specific EJB XML descriptor (typically titled "ias-ejb-jar.xml").Yes
destThe is the base directory where the RMI stubs and skeletons +are written. In addition, the class files for each bean (home interface, +remote interface, and EJB implementation) must be found in this directory.Yes
classpathThe classpath used when generating EJB stubs and skeletons. +If omitted, the classpath specified when Ant was started will be used. +Nested "classpath" elements may also be used.No
keepgeneratedIndicates whether or not the Java source files which are +generated by ejbc will be saved or automatically deleted. If "yes", the +source files will be retained. If omitted, it defaults to "no". No
debugIndicates whether or not the ejbc utility should log additional debugging +statements to the standard output. If "yes", the additional debugging statements +will be generated. If omitted, it defaults to "no". +
No
+
iashomeMay be used to specify the "home" directory for this iAS installation. +This is used to find the ejbc utility if it isn't included in the user's +system path. If specified, it should refer to the "[install-location]/iplanet/ias6/ias" +directory. If omitted, the ejbc utility must be on the user's system path. No
+ +

+Examples

+ +
+<iplanet-ejbc ejbdescriptor="ejb-jar.xml"
+              iasdescriptor="ias-ejb-jar.xml"
+              dest="${build.classesdir}"
+              classpath="${ias.ejbc.cpath}"/>
+
+
+<iplanet-ejbc ejbdescriptor="ejb-jar.xml"
+              iasdescriptor="ias-ejb-jar.xml"
+              dest="${build.classesdir}"
+              keepgenerated="yes"
+              debug="yes"
+              iashome="${ias.home}">
+              <classpath>
+                  <pathelement path="."/>
+                  <pathelement path="${build.classpath}"/>
+              </classpath>
+</iplanet-ejbc>
+
+
+
+ +
+

wlrun

+

Description:

+ +

The wlrun task is used to start a weblogic server. The task runs +a weblogic instance in a separate Java Virtual Machine. A number of parameters +are used to control the operation of the weblogic instance. Note that the task, +and hence ant, will not complete until the weblogic instance is stopped.

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired for 4.5.1 and 5.1Required for 6.0
BEA HomeThe location of the BEA Home where the server's config is defined. + If this attribute is present, wlrun assumes that the server will + be running under Weblogic 6.0N/AYes
homeThe location of the weblogic home that is to be used. This is the location + where weblogic is installed.YesYes. Note this is the absolute location, not relative to + BEA home.
DomainThe domain to which the server belongs.N/AYes
classpathThe classpath to be used with the Java Virtual Machine that runs the Weblogic + Server. Prior to Weblogic 6.0, this is typically set to the Weblogic + boot classpath. Under Weblogic 6.0 this should include all the + weblogic jarsYesYes
wlclasspathThe weblogic classpath used by the Weblogic Server.NoN/A
propertiesThe name of the server's properties file within the weblogic home directory + used to control the weblogic instance.YesN/A
nameThe name of the weblogic server within the weblogic home which is to be run. + This defaults to "myserver"NoNo
policyThe name of the security policy file within the weblogic home directory that + is to be used. If not specified, the default policy file weblogic.policy + is used.NoNo
usernameThe management username used to manage the serverN/ANo
passwordThe server's management passwordN/AYes
pkPasswordThe private key password so the server can decrypt the SSL + private key fileN/ANo
jvmargsAdditional argument string passed to the Java Virtual Machine used to run the + Weblogic instance.NoNo
weblogicMainClassname of the main class for weblogicNoNo
+ +

Nested Elements

+ +

The wlrun task supports nested <classpath> and <wlclasspath> +elements to set the respective classpaths.

+ +

Examples

+ +

This example shows the use of wlrun to run a server under Weblogic 5.1

+ +
+    <wlrun taskname="myserver"
+           classpath="${weblogic.boot.classpath}"
+           wlclasspath="${weblogic.classes}:${code.jars}"
+           name="myserver"
+           home="${weblogic.home}"
+           properties="myserver/myserver.properties"/>
+
+ +

This example shows wlrun being used to run the petstore server under +Weblogic 6.0

+ +
+    <wlrun taskname="petstore"
+           classpath="${weblogic.classes}"
+           name="petstoreServer"
+           domain="petstore"
+           home="${weblogic.home}"
+           password="petstorePassword"
+           beahome="${bea.home}"/>
+
+ +
+

wlstop

+

Description:

+ +

The wlstop task is used to stop a weblogic instance which is +currently running. To shut down an instance you must supply both a username and +a password. These will be stored in the clear in the build script used to stop +the instance. For security reasons, this task is therefore only appropriate in a +development environment.

+ +

This task works for most version of Weblogic, including 6.0. You need to +specify the BEA Home to have this task work correctly under 6.0

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
BEAHomeThis attribute selects Weblogic 6.0 shutdown.No
classpathThe classpath to be used with the Java Virtual Machine that runs the Weblogic + Shutdown command.Yes
userThe username of the account which will be used to shutdown the serverYes
passwordThe password for the account specified in the user parameter.Yes
urlThe URL which describes the port to which the server is listening for T3 connections. + For example, t3://localhost:7001Yes
delayThe delay in seconds after which the server will stop. This defaults to an + immediate shutdown.No
+ +

Nested Element

+ +

The classpath of the wlstop task can be set by a <classpath> nested element.

+ +

Examples

+ +

This example show the shutdown for a Weblogic 6.0 server

+ +
+    <wlstop classpath="${weblogic.classes}"
+            user="system"
+            url="t3://localhost:7001"
+            password="foobar"
+            beahome="${bea.home}"/>
+
+ +
+ +

ejbjar

+

Description:

+ +

This task is designed to support building of EJB jar files (EJB 1.1 & 2.0). +Support is currently provided for 'vanilla' EJB jar files - i.e. those containing only +the user generated class files and the standard deployment descriptor. Nested +elements provide support for vendor specific deployment tools. These currently +include:

+
    +
  • Borland Application Server 4.5
    • +
  • iPlanet Application Server 6.0
    • +
  • JBoss 2.1 and above
    • +
  • Weblogic 5.1/6.0 session/entity beans using the weblogic.ejbc tool
    • +
  • IBM WebSphere 4.0
    • +
  • TOPLink for WebLogic 2.5.1-enabled entity beans
    • +
  • JOnAS 2.4.x and 2.5 Open Source EJB server
    • +
+ + +

The task works as a directory scanning task, and performs an action for each +deployment descriptor found. As such the includes and excludes should be set +to ensure that all desired EJB descriptors are found, but no application +server descriptors are found. For each descriptor found, ejbjar will parse the +deployment descriptor to determine the necessary class files which implement the +bean. These files are assembled along with the deployment descriptors into a +well formed EJB jar file. Any support files which need to be included in the +generated jar can be added with the <support> nested element. For each +class included in the jar, ejbjar will scan for any super classes or super +interfaces. These will be added to the generated jar.

+ +

If no nested vendor-specific deployment elements are present, the task will +simply generate a generic EJB jar. Such jars are typically used as the input to +vendor-specific deployment tools. For each nested deployment element, a vendor +specific deployment tool is run to generate a jar file ready for deployment in +that vendor's EJB container.

+ +

The jar files are only built if they are out of date. Each deployment tool +element will examine its target jar file and determine if it is out of date with +respect to the class files and deployment descriptors that make up the bean. If +any of these files are newer than the jar file the jar will be rebuilt otherwise +a message is logged that the jar file is up to date.

+ +

The task uses the + jakarta-BCEL framework +to extract all dependent classes. This +means that, in addition to the classes that are mentioned in the +deployment descriptor, any classes that these depend on are also +automatically included in the jar file.

+ + +

Naming Convention

+ +Ejbjar handles the processing of multiple beans, and it uses a set of naming +conventions to determine the name of the generated EJB jars. The naming convention +that is used is controlled by the "naming" attribute. It supports the +following values +
    + +
  • descriptor
    • +

    This is the default naming scheme. The name of the generated bean is derived from the +name of the deployment descriptor. For an Account bean, for example, the deployment +descriptor would be named Account-ejb-jar.xml. Vendor specific descriptors are +located using the same naming convention. The weblogic bean, for example, would be named +Account-weblogic-ejb-jar.xml. Under this arrangement, the deployment descriptors +can be separated from the code implementing the beans, which can be useful when the same bean code +is deployed in separate beans. +

    + +

    This scheme is useful when you are using one bean per EJB jar and where you may be +deploying the same bean classes in different beans, with different deployment characteristics. + +

  • ejb-name
    • +

    This naming scheme uses the <ejb-name> element from the deployment descriptor to +determine the bean name. In this situation, the descriptors normally use the generic +descriptor names, such as ejb-jar.xml along with any associated vendor specific descriptor +names. For example, If the value of the <ejb-name> were to be given in the deployment descriptor +as follows: +

    +<ejb-jar>
+    <enterprise-beans>
+        <entity>
+            <ejb-name>Sample</ejb-name>
+            <home>org.apache.ant.ejbsample.SampleHome</home>
+
    + +then the name of the generated bean would be Sample.jar +

    +

    This scheme is useful where you want to use the standard deployment descriptor names, which may be more +compatible with other EJB tools. This scheme must have one bean per jar. +

    +
  • directory
    • +

    +In this mode, the name of the generated bean jar is derived from the directory +containing the deployment descriptors. Again the deployment descriptors typically use +the standard filenames. For example, if the path to the deployment descriptor is +/home/user/dev/appserver/dd/sample, then the generated +bean will be named sample.jar +

    +

    +This scheme is also useful when you want to use standard style descriptor names. It is often +most useful when the descriptors are located in the same directory as the bean source code, +although that is not mandatory. This scheme can handle multiple beans per jar. +

    + +
  • basejarname
    • +

    +The final scheme supported by the <ejbjar> task is used when you want to specify the generated +bean jar name directly. In this case the name of the generated jar is specified by the +"basejarname" attribute. Since all generated beans will have the same name, this task should +be only used when each descriptor is in its own directory. +

    + +

    +This scheme is most appropriate when you are using multiple beans per jar and only process a single +deployment descriptor. You typically want to specify the name of the jar and not derive it from the +beans in the jar. +

    + +
+ +

Dependencies

 +

In addition to the bean classes, ejbjar is able to ad additional classes to the generated +ejbjar. These classes are typically the support classes which are used by the bean's classes or as +parameters to the bean's methods.

+ +

In versions of Ant prior to 1.5, ejbjar used reflection and attempted to add the super +classes and super interfaces of the bean classes. For this technique to work the bean +classes had to be loaded into Ant's JVM. This was not always possible due to class dependencies. +

+ +

The ejbjar task in Ant releases 1.5 and later uses the + jakarta-BCEL library +to analyze the bean's class +files directly, rather than loading them into the JVM. This also allows ejbjar to add all +of the required support classes for a bean and not just super classes. +

+ +

In Ant 1.5, a new attribute, dependency has been introduced to allow the +buildfile to control what additional classes are added to the generated jar. It takes three +possible values

+
    +
  • none - only the bean classes and interfaces described in the bean's +descriptor are added to the jar.
    • +
  • super - this is the default value and replicates the original ejbjar +behaviour where super classes and super interfaces are added to the jar
    • +
  • full - In this mode all classes used by the bean's classes and interfaces +are added to the jar
    • +
+

The super and full values require the + jakarta-BCEL library +to be available. If it is not, ejbjar will drop back to the behaviour corresponding to +the value none.

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
descriptordirThe base directory under which to scan for EJB + deployment descriptors. If this attribute is not + specified, then the deployment descriptors must be + located in the directory specified by the 'srcdir' + attribute.No
srcdirThe base directory containing the .class files that + make up the bean. Included are the home- remote- pk- + and implementation- classes and all classes, that these + depend on. Note that this can be the same as the + descriptordir if all files are in the same directory + tree.Yes
destdirThe base directory into which generated jar files are + deposited. Jar files are deposited in directories + corresponding to their location within the descriptordir + namespace. Note that this attribute is only used if the + task is generating generic jars (i.e. no vendor-specific + deployment elements have been specified).Yes, unless vendor-specific deployment elements + have been specified.
cmpversionEither 1.0 or 2.0.
+ Default is 1.0.
+ A CMP 2.0 implementation exists currently only for JBoss.		No
namingControls the naming convention used to name generated + EJB jars. Please refer to the description above.No
basejarnameThe base name that is used for the generated jar files. + If this attribute is specified, the generic jar file name + will use this value as the prefix (followed by the value + specified in the 'genericjarsuffix' attribute) and the + resultant ejb jar file (followed by any suffix specified + in the nested element).No
basenameterminatorString value used to substring out a string from the name + of each deployment descriptor found, which is then used to + locate related deployment descriptors (e.g. the WebLogic + descriptors). For example, a basename of '.' and a + deployment descriptor called 'FooBean.ejb-jar.xml' would + result in a basename of 'FooBean' which would then be used + to find FooBean.weblogic-ejb-jar.xml and + FooBean.weblogic-cmp-rdbms-jar.xml, as well as to create + the filenames of the jar files as FooBean-generic.jar and + FooBean-wl.jar. This attribute is not used if the + 'basejarname' attribute is specified.No, defaults to '-'.
genericjarsuffixString value appended to the basename of the deployment + descriptor to create the filename of the generic EJB jar + file.No, defaults to '-generic.jar'.
classpathThis classpath is used when resolving classes which + are to be added to the jar. Typically nested deployment + tool elements will also support a classpath which + will be combined with this classpath when resolving + classesNo.
flatdestdirSet this attribute to true if you want all generated jars + to be placed in the root of the destdir, rather than + according to the location of the deployment descriptor + within the descriptor dir hierarchy.No.
dependencyThis attribute controls which additional classes and interfaces + are added to the jar. Please refer to the description + aboveNo.
manifestthe manifest file to use, if any.No
+ +

Nested Elements

+ +

In addition to the vendor specific nested elements, the ejbjar task provides +three nested elements.

+ +

Classpath

+ +

The <classpath> nested element allows the classpath +to be set. It is useful when setting the classpath from a reference path. In all +other respects the behaviour is the same as the classpath attribute.

+ +

dtd

 + +

The <dtd> element is used to specify the local location of DTDs to be +used when parsing the EJB deployment descriptor. Using a local DTD is much +faster than loading the DTD across the net. If you are running ejbjar behind a +firewall you may not even be able to access the remote DTD. The supported +vendor-specific nested elements know the location of the required DTDs within +the vendor class hierarchy and, in general, this means <dtd> elements are +not required. It does mean, however, that the vendor's class hierarchy must be +available in the classpath when Ant is started. If your want to run Ant without +requiring the vendor classes in the classpath, you would need to use a +<dtd> element.

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
publicIdThe public Id of the DTD for which the location is being providedYes
locationThe location of the local copy of the DTD. This can either be a + file or a resource loadable from the classpath.Yes
+ +

support

+ +

The <support> nested element is used to supply additional classes +(files) to be included in the generated jars. The <support> element is a +FileSet, so it can either reference a fileset declared elsewhere or it can be +defined in-place with the appropriate <include> and <exclude> nested +elements. The files in the support fileset are added into the generated EJB jar +in the same relative location as their location within the support fileset. Note +that when ejbjar generates more than one jar file, the support files are added +to each one.

+ +

Vendor-specific deployment elements

+ +Each vendor-specific nested element controls the generation of a deployable jar +specific to that vendor's EJB container. The parameters for each supported +deployment element are detailed here. + + +

Jboss element

+ +

The jboss element searches for the JBoss specific deployment descriptors and adds them +to the final ejb jar file. JBoss has two deployment descriptors: +

  • jboss.xml
    • +
  • for container manager persistence:
    + + + + +
    CMP versionFile name
    CMP 1.0jaws.xml
    CMP 2.0jbosscmp-jdbc.xml
    +
    • +
+
+. The JBoss server uses hot deployment and does +not require compilation of additional stubs and skeletons.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. Yes
genericjarsuffixA generic jar is generated as an intermediate step in + build the weblogic deployment jar. The suffix used to + generate the generic jar file is not particularly + important unless it is desired to keep the generic + jar file. It should not, however, be the same + as the suffix setting.No, defaults to '-generic.jar'.
suffixString value appended to the basename of the deployment + descriptor to create the filename of the JBoss EJB + jar file.No, defaults to '.jar'.
keepgenericThis controls whether the generic file used as input to + ejbc is retained.No, defaults to false
+ + +

Weblogic element

+ +

The weblogic element is used to control the weblogic.ejbc compiler for +generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP +descriptors was to use the ejbjar naming convention. So if your ejb-jar was +called, Customer-ejb-jar.xml, your weblogic descriptor was called Customer- +weblogic-ejb-jar.xml and your CMP descriptor had to be Customer-weblogic-cmp- +rdbms-jar.xml. In addition, the <type-storage> element in the weblogic +descriptor had to be set to the standard name META-INF/weblogic-cmp-rdbms- +jar.xml, as that is where the CMP descriptor was mapped to in the generated +jar.

+ +

There are a few problems with this scheme. It does not allow for more than +one CMP descriptor to be defined in a jar and it is not compatible with the +deployment descriptors generated by some tools.

+ +

In Ant 1.3, ejbjar parses the weblogic deployment descriptor to discover the +CMP descriptors, which are then included automatically. This behaviour is +controlled by the newCMP attribute. Note that if you move to the new method of +determining CMP descriptors, you will need to update your weblogic deployment +descriptor's <type-storage> element. In the above example, you would +define this as META-INF/Customer-weblogic-cmp-rdbms-jar.xml.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. Yes
genericjarsuffixA generic jar is generated as an intermediate step in + build the weblogic deployment jar. The suffix used to + generate the generic jar file is not particularly + important unless it is desired to keep the generic + jar file. It should not, however, be the same + as the suffix setting.No, defaults to '-generic.jar'.
suffixString value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file.No, defaults to '.jar'.
classpathThe classpath to be used when running the weblogic ejbc + tool. Note that this tool typically requires the classes + that make up the bean to be available on the classpath. + Currently, however, this will cause the ejbc tool to be + run in a separate VMNo
wlclasspathWeblogic 6.0 will give a warning if the home and remote interfaces + of a bean are on the system classpath used to run weblogic.ejbc. + In that case, the standard weblogic classes should be set with + this attribute (or equivalent nested element) and the + home and remote interfaces located with the standard classpath + attributeNo
keepgenericThis controls whether the generic file used as input to + ejbc is retained.No, defaults to false
compilerThis allows for the selection of a different compiler + to be used for the compilation of the generated Java + files. This could be set, for example, to Jikes to + compile with the Jikes compiler. If this is not set + and the build.compiler property is set + to jikes, the Jikes compiler will be used. If this + is not desired, the value "default" + may be given to use the default compilerNo
rebuildThis flag controls whether weblogic.ejbc is always + invoked to build the jar file. In certain circumstances, + such as when only a bean class has been changed, the jar + can be generated by merely replacing the changed classes + and not rerunning ejbc. Setting this to false will reduce + the time to run ejbjar. + No, defaults to true.
keepgeneratedControls whether weblogic will keep the generated Java + files used to build the class files added to the + jar. This can be useful when debugging + No, defaults to false.
argsAny additional arguments to be passed to the weblogic.ejbc + tool. + No.
weblogicdtdDeprecated. Defines the location of the ejb-jar DTD in + the weblogic class hierarchy. This should not be necessary if you + have weblogic in your classpath. If you do not, you should use a + nested <dtd> element, described above. If you do choose + to use an attribute, you should use a + nested <dtd> element. + No.
wldtdDeprecated. Defines the location of the weblogic-ejb-jar + DTD which covers the Weblogic specific deployment descriptors. + This should not be necessary if you have weblogic in your + classpath. If you do not, you should use a nested <dtd> + element, described above. + No.
ejbdtdDeprecated. Defines the location of the ejb-jar DTD in + the weblogic class hierarchy. This should not be necessary if you + have weblogic in your classpath. If you do not, you should use a + nested <dtd> element, described above. + No.
newCMPIf this is set to true, the new method for locating + CMP descriptors will be used.No. Defaults to false
oldCMPDeprecated This is an antonym for newCMP which should be used instead.No.
noEJBCIf this attribute is set to true, Weblogic's ejbc will not be run on the EJB jar. + Use this if you prefer to run ejbc at deployment time.No.
ejbcclassSpecifies the classname of the ejbc compiler. Normally ejbjar determines + the appropriate class based on the DTD used for the EJB. The EJB 2.0 compiler + featured in weblogic 6 has, however, been deprecated in version 7. When + using with version 7 this attribute should be set to + "weblogic.ejbc" to avoid the deprecation warning.No.
jvmargsAny additional arguments to be passed to the Virtual Machine + running weblogic.ejbc tool. For example to set the memory size, + this could be jvmargs="-Xmx128m" + No.
jvmdebuglevelSets the weblogic.StdoutSeverityLevel to use when running + the Virtual Machine that executes ejbc. Set to 16 to avoid + the warnings about EJB Home and Remotes being in the classpath + No.
outputdirIf set ejbc will be given this directory as the output + destination rather than a jar file. This allows for the + generation of "exploded" jars. + No.
+ +

The weblogic nested element supports three nested elements. The +first two, <classpath> and <wlclasspath>, are used to set the +respective classpaths. These nested elements are useful when setting up +class paths using reference Ids. The last, <sysproperty>, allows +Java system properties to be set during the compiler run. This turns out +to be necessary for supporting CMP EJB compilation in all environments. +

+ +

TOPLink for Weblogic element

+ +

Deprecated

+ +

The toplink element is no longer required. Toplink beans can now be built with the standard +weblogic element, as long as the newCMP attribute is set to "true" +

+ +

The TopLink element is used to handle beans which use Toplink for the CMP operations. It +is derived from the standard weblogic element so it supports the same set of attributes plus these +additional attributes

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
toplinkdescriptorThis specifies the name of the TOPLink deployment descriptor file contained in the + 'descriptordir' directory.Yes
toplinkdtdThis specifies the location of the TOPLink DTD file. This can be a file path or + a file URL. This attribute is not required, but using a local DTD is recommended.No, defaults to dtd file at www.objectpeople.com.
+ + +

Examples

+ +

This example shows ejbjar being used to generate deployment jars using a +Weblogic EJB container. This example requires the naming standard to be used for +the deployment descriptors. Using this format will create a ejb jar file for +each variation of '*-ejb-jar.xml' that is found in the deployment descriptor +directory.

+ +
+    <ejbjar srcdir="${build.classes}"
+            descriptordir="${descriptor.dir}">
+      <weblogic destdir="${deploymentjars.dir}"
+                classpath="${descriptorbuild.classpath}"/>
+      <include name="**/*-ejb-jar.xml"/>
+      <exclude name="**/*weblogic*.xml"/>
+    </ejbjar>
+
+ +

If weblogic is not in the Ant classpath, the following example +shows how to specify the location of the weblogic DTDs. This +example also show the use of a nested classpath element.

+ +
+    <ejbjar descriptordir="${src.dir}" srcdir="${build.classes}">
+       <weblogic destdir="${deployment.webshop.dir}"
+                 keepgeneric="true"
+                 args="-g -keepgenerated ${ejbc.compiler}"
+                 suffix=".jar"
+                 oldCMP="false">
+         <classpath>
+           <pathelement path="${descriptorbuild.classpath}"/>
+         </classpath>
+       </weblogic>
+       <include name="**/*-ejb-jar.xml"/>
+       <exclude name="**/*-weblogic-ejb-jar.xml"/>
+       <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
+            location="${weblogic.home}/classes/weblogic/ejb/deployment/xml/ejb-jar.dtd"/>
+       <dtd publicId="-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN"
+            location="${weblogic.home}/classes/weblogic/ejb/deployment/xml/weblogic-ejb-jar.dtd"/>
+    </ejbjar>
+
+ + +

This example shows ejbjar being used to generate a single deployment jar +using a Weblogic EJB container. This example does not require the deployment +descriptors to use the naming standard. This will create only one ejb jar file - +'TheEJBJar.jar'.

+ + +
+    <ejbjar srcdir="${build.classes}"
+            descriptordir="${descriptor.dir}"
+            basejarname="TheEJBJar">
+      <weblogic destdir="${deploymentjars.dir}"
+                classpath="${descriptorbuild.classpath}"/>
+      <include name="**/ejb-jar.xml"/>
+      <exclude name="**/weblogic*.xml"/>
+    </ejbjar>
+
+ +

This example shows ejbjar being used to generate deployment jars for a TOPLink-enabled entity bean using a +Weblogic EJB container. This example does not require the deployment descriptors to use the naming standard. +This will create only one TOPLink-enabled ejb jar file - 'Address.jar'.

+ +
+    <ejbjar srcdir="${build.dir}"
+            destdir="${solant.ejb.dir}"
+            descriptordir="${descriptor.dir}"
+            basejarname="Address">
+            <weblogictoplink destdir="${solant.ejb.dir}"
+                    classpath="${java.class.path}"
+                    keepgeneric="false"
+                    toplinkdescriptor="Address.xml"
+                    toplinkdtd="file:///dtdfiles/toplink-cmp_2_5_1.dtd"
+                    suffix=".jar"/>
+            <include name="**/ejb-jar.xml"/>
+            <exclude name="**/weblogic-ejb-jar.xml"/>
+    </ejbjar>
+
+ +

This final example shows how you would set-up ejbjar under Weblogic 6.0. It also shows the use of the +<support> element to add support files

+ +
+    <ejbjar descriptordir="${dd.dir}" srcdir="${build.classes.server}">
+       <include name="**/*-ejb-jar.xml"/>
+       <exclude name="**/*-weblogic-ejb-jar.xml"/>
+       <support dir="${build.classes.server}">
+            <include name="**/*.class"/>
+       </support>
+       <weblogic destdir="${deployment.dir}"
+                 keepgeneric="true"
+                 suffix=".jar"
+                 rebuild="false">
+         <classpath>
+            <pathelement path="${build.classes.server}"/>
+         </classpath>
+         <wlclasspath>
+            <pathelement path="${weblogic.classes}"/>
+         </wlclasspath>
+       </weblogic>
+    </ejbjar>
+
+ + +

WebSphere element

+ +

The websphere element searches for the websphere specific deployment descriptors and +adds them to the final ejb jar file. Websphere has two specific descriptors for session +beans: +

    +
  • ibm-ejb-jar-bnd.xmi
    • +
  • ibm-ejb-jar-ext.xmi
    • +
+and another two for container managed entity beans: +
    +
  • Map.mapxmi
    • +
  • Schema.dbxmi
    • +
+In terms of WebSphere, the generation of container code and stubs is called deployment. +This step can be performed by the websphere element as part of the jar generation process. If the +switch ejbdeploy is on, the ejbdeploy tool from the websphere toolset is called for +every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic +(called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with +sun jdk. +

+ +

+For the websphere element to work, you have to provide a complete classpath, that contains all +classes, that are required to reflect the bean classes. For ejbdeploy to work, you must also provide +the classpath of the ejbdeploy tool and set the websphere.home property (look at the examples below). +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated weblogic ready + jar files are deposited. Jar files are deposited in + directories corresponding to their location within the + descriptordir namespace. Yes
ejbdeployDecides whether ejbdeploy is called. When you set this to true, + be sure, to run ant with the ibm jdk.No, defaults to true
suffixString value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file.No, defaults to '.jar'.
keepgenericThis controls whether the generic file used as input to + ejbdeploy is retained.No, defaults to false
rebuildThis controls whether ejbdeploy is called although no changes + have occurred.No, defaults to false
tempdirA directory, where ejbdeploy will write temporary filesNo, defaults to '_ejbdeploy_temp'.
dbName
dbSchema		These options are passed to ejbdeploy.No
dbVendorThis option is passed to ejbdeploy. +

+ Valid options can be obtained by running the following command: + + <WAS_HOME>/bin/EJBDeploy.[sh/bat] -help + +

+ This is also used to determine the name of the Map.mapxmi and + Schema.dbxmi files, for example Account-DB2UDBWIN_V71-Map.mapxmi + and Account-DB2UDBWIN_V71-Schema.dbxmi. + 		No
codegen
quiet
novalidate
noinform
trace
+ use35MappingRules		These options are all passed to ejbdeploy. All options + except 'quiet' default to false.No
rmicOptionsThis option is passed to ejbdeploy and will be passed + on to rmic.No
+ +

This example shows ejbjar being used to generate deployment jars for all deployment descriptors +in the descriptor dir:

+ +
+    <property name="webpshere.home" value="${was4.home}"/>
+    <ejbjar srcdir="${build.class}" descriptordir="etc/ejb">
+      <include name="*-ejb-jar.xml"/>
+      <websphere dbvendor="DB2UDBOS390_V6"
+                 ejbdeploy="true"
+                 oldCMP="false"
+                 tempdir="/tmp"
+                 destdir="${dist.server}">
+        <wasclasspath>
+          <pathelement location="${was4.home}/deploytool/itp/plugins/org.eclipse.core.boot/boot.jar"/>
+          <pathelement location="${was4.home}/deploytool/itp/plugins/com.ibm.etools.ejbdeploy/runtime/batch.jar"/>
+          <pathelement location="${was4.home}/lib/xerces.jar"/>
+          <pathelement location="${was4.home}/lib/ivjejb35.jar"/>
+          <pathelement location="${was4.home}/lib/j2ee.jar"/>
+          <pathelement location="${was4.home}/lib/vaprt.jar"/>
+        </wasclasspath>
+        <classpath>
+          <path refid="build.classpath"/>
+        </classpath>
+      </websphere>
+      <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
+           location="${lib}/dtd/ejb-jar_1_1.dtd"/>
+    </ejbjar>
+
+ +

iPlanet Application Server (iAS) element

+ +The <iplanet< nested element is used to build iAS-specific stubs and + +skeletons and construct a JAR file which may be deployed to the iPlanet +Application Server 6.0. The build process will always determine if +the EJB stubs/skeletons and the EJB-JAR file are up to date, and it will +do the minimum amount of work required. +

Like the WebLogic element, a naming convention for the EJB descriptors +is most commonly used to specify the name for the completed JAR file. +For example, if the EJB descriptor ejb/Account-ejb-jar.xml is found in +the descriptor directory, the iplanet element will search for an iAS-specific +EJB descriptor file named ejb/Account-ias-ejb-jar.xml (if it isn't found, +the task will fail) and a JAR file named ejb/Account.jar will be written +in the destination directory. Note that when the EJB descriptors +are added to the JAR file, they are automatically renamed META-INF/ejb-jar.xml +and META-INF/ias-ejb-jar.xml.

+

Of course, this naming behaviour can be modified by specifying attributes +in the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir) +as well as the iplanet element (for example, suffix). Refer to the +appropriate documentation for more details.

+

+Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated JAR files will +be written. Each JAR file is written in directories which correspond to +their location within the "descriptordir" namespace.Yes
classpathThe classpath used when generating EJB stubs and skeletons. +If omitted, the classpath specified in the "ejbjar" parent task will be +used. If specified, the classpath elements will be prepended to the +classpath specified in the parent "ejbjar" task. Note that nested "classpath" +elements may also be used.No
keepgeneratedIndicates whether or not the Java source files which are +generated by ejbc will be saved or automatically deleted. If "yes", the +source files will be retained. If omitted, it defaults to "no". No
debugIndicates whether or not the ejbc utility should log additional debugging +statements to the standard output. If "yes", the additional debugging statements +will be generated. If omitted, it defaults to "no". No
iashomeMay be used to specify the "home" directory for this iAS installation. +This is used to find the ejbc utility if it isn't included in the user's +system path. If specified, it should refer to the [install-location]/iplanet/ias6/ias +directory. If omitted, the ejbc utility must be on the user's system +path. No
suffixString value appended to the JAR filename when creating each JAR. +If omitted, it defaults to ".jar". No
+ +

As noted above, the iplanet element supports additional <classpath> +nested elements.

+

+Examples

+This example demonstrates the typical use of the <iplanet> nested element. +It will name each EJB-JAR using the "basename" prepended to each standard +EJB descriptor. For example, if the descriptor named "Account-ejb-jar.xml" +is processed, the EJB-JAR will be named "Account.jar" +
+    <ejbjar srcdir="${build.classesdir}"
+            descriptordir="${src}">
+
+            <iplanet destdir="${assemble.ejbjar}"
+                     classpath="${ias.ejbc.cpath}"/>
+            <include name="**/*-ejb-jar.xml"/>
+            <exclude name="**/*ias-*.xml"/>
+    </ejbjar>
+ +This example demonstrates the use of a nested classpath element as well +as some of the other optional attributes. +
+    <ejbjar srcdir="${build.classesdir}"
+            descriptordir="${src}">
+
+            <iplanet destdir="${assemble.ejbjar}"
+                     iashome="${ias.home}"
+                     debug="yes"
+                     keepgenerated="yes">
+                     <classpath>
+                         <pathelement path="."/>
+                         <pathelement path="${build.classpath}"/>
+                     </classpath>
+            </iplanet>
+            <include name="**/*-ejb-jar.xml"/>
+            <exclude name="**/*ias-*.xml"/>
+    </ejbjar>
+ +This example demonstrates the use of basejarname attribute. In this +case, the completed EJB-JAR will be named "HelloWorld.jar" If multiple +EJB descriptors might be found, care must be taken to ensure that the completed +JAR files don't overwrite each other. +
+    <ejbjar srcdir="${build.classesdir}"
+            descriptordir="${src}"
+            basejarname="HelloWorld">
+
+            <iplanet destdir="${assemble.ejbjar}"
+                     classpath="${ias.ejbc.cpath}"/>
+            <include name="**/*-ejb-jar.xml"/>
+            <exclude name="**/*ias-*.xml"/>
+    </ejbjar>
+This example demonstrates the use of the dtd nested element. If the local +copies of the DTDs are included in the classpath, they will be automatically +referenced without the nested elements. In iAS 6.0 SP2, these local DTDs are +found in the [iAS-install-directory]/APPS directory. In iAS 6.0 SP3, these +local DTDs are found in the [iAS-install-directory]/dtd directory. +
+    <ejbjar srcdir="${build.classesdir}"
+            descriptordir="${src}">
+            <iplanet destdir="${assemble.ejbjar}">
+                     classpath="${ias.ejbc.cpath}"/>
+            <include name="**/*-ejb-jar.xml"/>
+            <exclude name="**/*ias-*.xml"/>
+
+            <dtd publicId="-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
+                 location="${ias.home}/APPS/ejb-jar_1_1.dtd"/>
+            <dtd publicId="-//Sun Microsystems, Inc.//DTD iAS Enterprise JavaBeans 1.0//EN"
+                 location="${ias.home}/APPS/IASEjb_jar_1_0.dtd"/>
+    </ejbjar>
+ +

JOnAS (Java Open Application Server) element

+ +

The <jonas> nested element is used to build JOnAS-specific stubs and +skeletons thanks to the GenIC specific tool, and construct a JAR +file which may be deployed to the JOnAS Application Server. The build process +will always determine if the EJB stubs/skeletons and the EJB-JAR file are up to +date, and it will do the minimum amount of work required.

+ +

Like the WebLogic element, a naming convention for the EJB descriptors is +most commonly used to specify the name for the completed JAR file. For example, +if the EJB descriptor ejb/Account-ejb-jar.xml is found in the +descriptor directory, the <jonas> element will search for a JOnAS-specific +EJB descriptor file named ejb/Account-jonas-ejb-jar.xml and a JAR +file named ejb/Account.jar will be written in the destination +directory. But the <jonas> element can also use the JOnAS naming +convention. With the same example as below, the EJB descriptor can also be named +ejb/Account.xml (no base name terminator here) in the descriptor +directory. Then the <jonas> element will search for a JOnAS-specific EJB +descriptor file called ejb/jonas-Account.xml. This convention do +not follow strictly the ejb-jar naming convention recommendation but is +supported for backward compatibility with previous version of JOnAS.

+ +

Note that when the EJB descriptors are added to the JAR file, they are +automatically renamed META-INF/ejb-jar.xml and +META-INF/jonas-ejb-jar.xml.

+ +

Of course, this naming behavior can be modified by specifying attributes in +the ejbjar task (for example, basejarname, basenameterminator, and flatdestdir) +as well as the iplanet element (for example, suffix). Refer to the appropriate +documentation for more details.

+ +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirThe base directory into which the generated JAR files + will be written. Each JAR file is written in directories which correspond + to their location within the "descriptordir" namespace.Yes
jonasrootThe root directory for JOnAS.Yes
classpathThe classpath used when generating EJB stubs and + skeletons. If omitted, the classpath specified in the "ejbjar" parent + task will be used. If specified, the classpath elements will be prepended + to the classpath specified in the parent "ejbjar" task (see also the ORB + attribute documentation below). Note that nested "classpath" elements may + also be used.No
keepgeneratedtrue if the intermediate Java + source files generated by GenIC must be deleted or not. If + omitted, it defaults to false.No
nocompiltrue if the generated source files + must not be compiled via the java and rmi compilers. If omitted, + it defaults to false.No
novalidationtrue if the XML deployment descriptors must + be parsed without validation. If omitted, it defaults to false.No
javacJava compiler to use. If omitted, it defaults + to the value of build.compiler property.No
javacoptsOptions to pass to the java compiler.No
rmicoptsOptions to pass to the rmi compiler.No
secpropagtrue if the RMI Skel. and + Stub. must be modified to implement the implicit propagation of + the security context (the transactional context is always + provided). If omitted, it defaults to false.No
verboseIndicates whether or not to use -verbose switch. If + omitted, it defaults to false.No
additionalargsAdd additional args to GenIC.No
keepgenerictrue if the generic JAR file used as input + to GenIC must be retained. If omitted, it defaults to false.No
jarsuffixString value appended to the JAR filename when creating each JAR. If + omitted, it defaults to ".jar". No
orbChoose your ORB : RMI, JEREMIE, DAVID. If omitted, it defaults to the + one present in classpath. If specified, the corresponding JOnAS JAR is + automatically added to the classpath.No
nogenicIf this attribute is set to true, + JOnAS's GenIC will not be run on the EJB JAR. Use this if you + prefer to run GenIC at deployment time. If omitted, it defaults + to false.No
+ +

As noted above, the jonas element supports additional <classpath> +nested elements.

+ +

Examples

+ +

This example shows ejbjar being used to generate deployment jars using a +JOnAS EJB container. This example requires the naming standard to be used for +the deployment descriptors. Using this format will create a EJB JAR file for +each variation of  '*-jar.xml' that is found in the deployment descriptor +directory. 

+ +
+      <ejbjar srcdir="${build.classes}"
+              descriptordir="${descriptor.dir}">
+        <jonas destdir="${deploymentjars.dir}"
+             jonasroot="${jonas.root}"
+             orb="RMI"/>
+        <include name="**/*.xml"/>
+        <exclude name="**/jonas-*.xml"/>
+        <support dir="${build.classes}">
+             <include name="**/*.class"/>
+        </support>
+      </ejbjar>
+
+ +

This example shows ejbjar being used to generate a single deployment jar +using a JOnAS EJB container. This example does require the deployment +descriptors to use the naming standard. This will create only one ejb jar file - +'TheEJBJar.jar'.

+ +
+      <ejbjar srcdir="${build.classes}"
+              descriptordir="${descriptor.dir}"
+              basejarname="TheEJBJar">
+        <jonas destdir="${deploymentjars.dir}"
+                  jonasroot="${jonas.root}"
+                  suffix=".jar"
+                  classpath="${descriptorbuild.classpath}"/>
+        <include name="**/ejb-jar.xml"/>
+        <exclude name="**/jonas-ejb-jar.xml"/>
+      </ejbjar>
+
+ + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/exec.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/exec.html new file mode 100644 index 000000000..c25334a18 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/exec.html @@ -0,0 +1,460 @@ + + + + + + + Exec Task + + + + +

Exec

+

Description

+

Executes a system command. When the os attribute is specified, then +the command is only executed when Apache Ant is run on one of the specified operating +systems.

+ +

Note that you cannot interact with the forked program, the only way +to send input to it is via the input and inputstring attributes. Also note that +since Ant 1.6, any attempt to read input in the forked program will receive an +EOF (-1). This is a change from Ant 1.5, where such an attempt would block.

+ +

If you want to execute an executable using a path relative to the + project's basedir, you may need to + use vmlauncher="false" on some operating systems - but + even this may fail (Solaris 8/9 has been reported as problematic). + The resolveexecutable attribute should be more + reliable, as would be something like +

+  <property name="executable-full-path"
+            location="../relative/path/to/executable"/>
+  <exec executable="${executable-full-path}" ...
+
+

+ +

Windows Users

+

The <exec> task delegates to Runtime.exec which in turn +apparently calls +::CreateProcess. It is the latter Win32 function that defines +the exact semantics of the call. In particular, if you do not put a file extension +on the executable, only ".EXE" files are looked for, not ".COM", ".CMD" or other file +types listed in the environment variable PATHEXT. That is only used by the shell. +

+

+ Note that .bat files cannot in general by executed directly. + One normally needs to execute the command shell executable cmd + using the /c switch. +

+
+
+<target name="help">
+  <exec executable="cmd">
+    <arg value="/c"/>
+    <arg value="ant.bat"/>
+    <arg value="-p"/>
+  </exec>
+</target>
+
+ +

A common problem is not having the executable on the PATH. In case you get an error +message Cannot run program "...":CreateProcess error=2. The system cannot find +the path specified. have a look at your PATH variable. Just type the command directly on +the command line and if Windows finds it, Ant should do it too. (Otherwise ask on the user mailinglist for help.) If Windows can not execute the program add the directory of the programm +to the PATH (set PATH=%PATH%;dirOfProgram) or specify the absolute path in the +executable attribute in your buildfile. +

+ + +

Cygwin Users

+

The <exec> task will not understand paths such as /bin/sh +for the executable parameter. This is because the Java VM in which Ant is +running is a standard Windows executable and is not aware of the Cygwin +environment (i.e., doesn't load cygwin1.dll). The only +work-around for this is to compile a JVM under Cygwin (at your own risk). +See for instance + +sun jdk 6 build instructions for cygwin. +

+ +

OpenVMS Users

+

The command specified using executable and +<arg> elements is executed exactly as specified +inside a temporary DCL script. This has some implications: +

    +
  • paths have to be written in VMS style
    • +
  • if your executable points to a DCL script remember to +prefix it with an @-sign +(e.g. executable="@[FOO]BAR.COM"), just as you would in a +DCL script
    • +
+For <exec> to work in an environment with a Java VM +older than version 1.4.1-2 it is also required that the logical +JAVA$FORK_SUPPORT_CHDIR is set to TRUE in +the job table (see the JDK Release Notes).

+ +

Please note that the Java VM provided by HP doesn't follow OpenVMS' +conventions of exit codes. If you run a Java VM with this task, the +task may falsely claim that an error occurred (or silently ignore an +error). Don't use this task to run JAVA.EXE, use a +<java> task with the fork attribute +set to true instead as this task will follow the VM's +interpretation of exit codes.

+ +

RedHat S/390 Users

+ +

It has been reported +on the VMESA-LISTSERV that shell scripts invoked via the Ant Exec +task must have their interpreter specified, i.e., the scripts must +start with something like: + +

+
+#!/bin/bash
+
+
+ +or the task will fail as follows: + +
+
+[exec] Warning: UNIXProcess.forkAndExec native error: Exec format error
+[exec] Result: 255
+
+
+

+ +

Running Ant as a background process on + Unix(-like) systems

+ +

If you run Ant as a background process (like ant &) + and use the <exec> task with spawn + set to false, you must provide explicit input to the + forked process or Ant will be suspended because it tries to read + from the standard input.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
commandthe command to execute with all command line + arguments. deprecated, use executable and nested + <arg> elements instead.Exactly one of the two.
executablethe command to execute without any command line + arguments.
dirthe directory in which the command should be executed.No
oslist of Operating Systems on which the command may be + executed. If the current OS's name is contained in this list, the command will + be executed. The OS's name is determined by the Java Virtual machine and is set + in the "os.name" system property. + No
osfamilyOS family as used in the <os> condition. + since Ant 1.7No
spawnwhether or not you want the command to be spawned
+ Default is false.
+ If you spawn a command, its output will not be logged by ant.
+ The input, output, error, and result property settings are not active when spawning a process.
+ since Ant 1.6 + 		No
outputName of a file to which to write the output. If the error stream + is not also redirected to a file or property, it will appear in this output.No
errorThe file to which the standard error of the + command should be redirected. since Ant 1.6No
logErrorThis attribute is used when you wish to see error output in Ant's + log and you are redirecting output to a file/property. The error + output will not be included in the output file/property. If you + redirect error with the "error" or "errorProperty" + attributes, this will have no effect. since Ant 1.6No
appendWhether output and error files should be appended to or overwritten. + Defaults to false.No
outputpropertyThe name of a property in which the output of the + command should be stored. Unless the error stream is redirected to a separate + file or stream, this property will include the error output.No
errorpropertyThe name of a property in which the standard error of the + command should be stored. since Ant 1.6No
inputA file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attribute. since Ant 1.6No
inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute. since Ant 1.6No
resultpropertythe name of a property in which the return code of the + command should be stored. Only of interest if failonerror=false.No
timeoutStop the command if it doesn't finish within the + specified time (given in milliseconds).No
failonerrorStop the buildprocess if the command exits with a + return code signaling failure. Defaults to false.No
failifexecutionfailsStop the build if we can't start the program. + Defaults to true. No
newenvironmentDo not propagate old environment when new environment + variables are specified.No, default is false
vmlauncherRun command using the Java VM's execution facilities + where available. If set to false the underlying OS's shell, + either directly or through the antRun scripts, will be used. + Under some operating systems, this gives access to facilities + not normally available through the VM including, under Windows, + being able to execute scripts, rather than their associated + interpreter. If you want to specify the name of the + executable as a relative path to the directory given by the + dir attribute, it may become necessary to set vmlauncher to + false as well.No, default is true
resolveexecutableWhen this attribute is true, the name of the executable + is resolved firstly against the project basedir and + if that does not exist, against the execution + directory if specified. On Unix systems, if you only + want to allow execution of commands in the user's path, + set this to false. since Ant 1.6No, default is false
searchpathWhen this attribute is true, then + system path environment variables will + be searched when resolving the location + of the executable. since Ant 1.6.3No, default is false
+

Examples

+
+
+<exec dir="${src}" executable="cmd.exe" os="Windows 2000" output="dir.txt">
+  <arg line="/c dir"/>
+</exec>
+
+

Parameters specified as nested elements

+

arg

+

Command line arguments should be specified as nested +<arg> elements. See Command line arguments.

+

env

+

It is possible to specify environment variables to pass to the +system command via nested <env> elements.

+ + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
key + The name of the environment variable. +
+ Note: (Since Ant 1.7) + For windows, the name is case-insensitive. + 		Yes
valueThe literal value for the environment variable.Exactly one of these.
pathThe value for a PATH like environment + variable. You can use ; or : as path separators and Ant will + convert it to the platform's local conventions.
fileThe value for the environment variable. Will be + replaced by the absolute filename of the file by Ant.
+

redirector

 +Since Ant 1.6.2 +

A nested I/O Redirector +can be specified. In general, the attributes of the redirector behave +as the corresponding attributes available at the task level. The most +notable peculiarity stems from the retention of the <exec> +attributes for backwards compatibility. Any file mapping is done +using a null sourcefile; therefore not all +Mapper types will return +results. When no results are returned, redirection specifications +will fall back to the task level attributes. In practice this means that +defaults can be specified for input, output, and error output files. +

+

Errors and return codes

+By default the return code of a <exec> is ignored; when you set +failonerror="true" then any return code signaling failure +(OS specific) causes the build to fail. Alternatively, you can set +resultproperty to the name of a property and have it assigned to +the result code (barring immutability, of course). +

+If the attempt to start the program fails with an OS dependent error code, +then <exec> halts the build unless failifexecutionfails +is set to false. You can use that to run a program if it exists, but +otherwise do nothing. +

+What do those error codes mean? Well, they are OS dependent. On Windows +boxes you have to look at + +the documentation; error code 2 means 'no such program', which usually means +it is not on the path. Any time you see such an error from any Ant task, it is +usually not an Ant bug, but some configuration problem on your machine. + +

Examples

+
+<exec executable="emacs">
+  <env key="DISPLAY" value=":1.0"/>
+</exec>
+
+

starts emacs on display 1 of the X Window System.

+ +
+<property environment="env"/>
+<exec ... >
+  <env key="PATH" path="${env.PATH}:${basedir}/bin"/>
+</exec>
+
+

adds ${basedir}/bin to the PATH of the +system command.

+ +
+<property name="browser" location="C:/Program Files/Internet Explorer/iexplore.exe"/>
+<property name="file" location="ant/docs/manual/index.html"/>
+
+<exec executable="${browser}" spawn="true">
+    <arg value="${file}"/>
+</exec>
+
+

Starts the ${browser} with the specified ${file} and end the +Ant process. The browser will remain.

+ +
+<exec executable="cat">
+    <redirector outputproperty="redirector.out"
+                errorproperty="redirector.err"
+                inputstring="blah before blah">
+        <inputfilterchain>
+            <replacestring from="before" to="after"/>
+        </inputfilterchain>
+        <outputmapper type="merge" to="redirector.out"/>
+        <errormapper type="merge" to="redirector.err"/>
+    </redirector>
+</exec>
+
+ +Sends the string "blah before blah" to the "cat" executable, +using an <inputfilterchain> +to replace "before" with "after" on the way in. +Output is sent to the file "redirector.out" and stored +in a property of the same name. Similarly, error output is sent to +a file and a property, both named "redirector.err". + + +

Note: do not try to specify arguments using +a simple arg-element and separate them by spaces. This results in +only a single argument containing the entire string.

+

+Timeouts: If a timeout is specified, when it is reached the +sub process is killed and a message printed to the log. The return +value of the execution will be "-1", which will halt the build if +failonerror=true, but be ignored otherwise. + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/fail.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/fail.html new file mode 100644 index 000000000..eabe30b86 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/fail.html @@ -0,0 +1,143 @@ + + + + + + +Fail Task + + + + +

Fail

+

Description

+

Exits the current build (just throwing a BuildException), optionally printing additional information.

+

The message of the Exception can be set via the message attribute +or character data nested into the element.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
messageA message giving further information on why the build exitedNo
ifOnly fail if a property of the given name exists + in the current projectNo
unlessOnly fail if a property of the given name doesn't + exist in the current projectNo
statusExit using the specified status code; + assuming the generated Exception is not caught, the + JVM will exit with this status. Since Apache Ant 1.6.2No
+ +

Parameters specified as nested elements

+ +

As an alternative to the if/unless attributes, + conditional failure can be achieved using a single nested + <condition> element, which should contain exactly one + core or custom condition. For information about conditions, see + here.
Since Ant 1.6.2 +

+ +

Examples

+ +
  <fail/>
+

will exit the current build with no further information given.

+
+BUILD FAILED
+
+build.xml:4: No message
+
+ +
  <fail message="Something wrong here."/>
+

will exit the current build and print something + like the following to wherever your output goes: +

+
+BUILD FAILED
+
+build.xml:4: Something wrong here.
+
+ +
  <fail>Something wrong here.</fail>
+

will give the same result as above.

+ +
  <fail unless="thisdoesnotexist"/>
+

will exit the current build and print something + like the following to wherever your output goes: +

+
+BUILD FAILED
+
+build.xml:2: unless=thisdoesnotexist
+
+ +Using a condition to achieve the same effect: + +
+  <fail>
+     <condition>
+       <not>
+         <isset property="thisdoesnotexist"/>
+       </not>
+     </condition>
+   </fail>
+
+ +

Output:

+
+BUILD FAILED
+
+build.xml:2: condition satisfied
+
+ +
+<fail message="Files are missing.">
+    <condition>
+        <not>
+            <resourcecount count="2">
+                <fileset id="fs" dir="." includes="one.txt,two.txt"/>
+            </resourcecount>
+        </not>
+    </condition>
+</fail>
+
+

Will check that both files one.txt and two.txt are present otherwise the build +will fail.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/filter.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/filter.html new file mode 100644 index 000000000..16ba88c61 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/filter.html @@ -0,0 +1,79 @@ + + + + + + +Filter Task + + + + +

Filter

+

Description

+

Sets a token filter for this project or read multiple token filter from +an input file and sets these as filters. +Token filters are used by all tasks that perform file copying operations +through the Project commodity methods. See the warning +here before using.

+

Note 1: the token string must not contain the separators chars (@).
+Note 2: Either token and value attributes must be provided, or only the +filtersfile attribute.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
tokenthe token string without @Yes*
valuethe string that should be put to replace the token when the + file is copiedYes*
filtersfileThe file from which the filters must be read. This file must be a formatted as a property file. Yes*
+

* see notes 1 and 2 above parameters table.

+

Examples

+
  <filter token="year" value="2000"/>
+  <copy todir="${dest.dir}" filtering="true">
+    <fileset dir="${src.dir}"/>
+  </copy>
+

will copy recursively all the files from the src.dir directory into +the dest.dir directory replacing all the occurrences of the string @year@ +with 2000.

+
  <filter filtersfile="deploy_env.properties"/>
+will read all property entries from the deploy_env.properties file +and set these as filters. + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/fixcrlf.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/fixcrlf.html new file mode 100644 index 000000000..462e7fc4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/fixcrlf.html @@ -0,0 +1,327 @@ + + + + + + +FixCRLF Task + + + + +

FixCRLF

+

Description

+

+ Adjusts a text file to local conventions. +

+ +

+ The set of files to be adjusted can be refined with the + includes, includesfile, excludes, + excludesfile and defaultexcludes + attributes. Patterns provided through the includes or + includesfile attributes specify files to be + included. Patterns provided through the exclude or + excludesfile attribute specify files to be + excluded. Additionally, default exclusions can be specified with + the defaultexcludes attribute. See the section on directory-based + tasks, for details of file inclusion/exclusion patterns + and their usage. +

+ +

+ This task forms an implicit + FileSet and + supports most attributes of <fileset> + (dir becomes srcdir) as well as the nested + <include>, <exclude> and + <patternset> elements. +

+ +

+ The output file is only written if it is a new file, or if it + differs from the existing file. This prevents spurious + rebuilds based on unchanged files which have been regenerated + by this task. +

+ +

+ Since Apache Ant 1.7, this task can be used in a + filterchain. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
As TaskAs Filter
srcDirWhere to find the files to be fixed up.One of these 
fileName of a single file to fix. Since Ant 1.7 
destDirWhere to place the corrected files. Defaults to + srcDir (replacing the original file).No 
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No 
includesfilethe name of a file. Each line of this file is + taken to be an include pattern.No 
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No 
excludesfilethe name of a file. Each line of this file is + taken to be an exclude pattern.No 
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted. + No 
encodingThe encoding of the files.No; defaults to default JVM encoding. 
outputencodingThe encoding to use when writing the files. + Since Ant 1.7No; defaults to the value of the encoding attribute. 
preservelastmodifiedWhether to preserve the last modified + date of source files. Since Ant 1.6.3No; default is false 
eol + Specifies how end-of-line (EOL) characters are to be + handled. The EOL characters are CR, LF and the pair CRLF. + Valid values for this property are: +
    +
  • asis: leave EOL characters alone
    • +
  • cr: convert all EOLs to a single CR
    • +
  • lf: convert all EOLs to a single LF
    • +
  • crlf: convert all EOLs to the pair CRLF
    • +
  • mac: convert all EOLs to a single CR
    • +
  • unix: convert all EOLs to a single LF
    • +
  • dos: convert all EOLs to the pair CRLF
    • +
+ Default is based on the platform on which you are running this task. + For Unix platforms (including Mac OS X), the default is "lf". + For DOS-based systems (including Windows), the default is + "crlf". + For Mac environments other than OS X, the default is "cr". +

+ This is the preferred method for specifying EOL. The + "cr" attribute (see below) is + now deprecated. +

+

+ N.B.: One special case is recognized. The three + characters CR-CR-LF are regarded as a single EOL. + Unless this property is specified as "asis", + this sequence will be converted into the specified EOL + type. +

+ 		No
cr + Deprecated. Specifies how CR characters are + to be handled at end-of-line (EOL). Valid values for this + property are: +
    +
  • asis: leave EOL characters alone.
    • +
  • + add: add a CR before any single LF characters. The + intent is to convert all EOLs to the pair CRLF. +
    • +
  • + remove: remove all CRs from the file. The intent is + to convert all EOLs to a single LF. +
    • +
+ Default is based on the platform on which you are running + this task. For Unix platforms, the default is "remove". + For DOS based systems (including Windows), the default is + "add". +

+ N.B.: One special case is recognized. The three + characters CR-CR-LF are regarded as a single EOL. + Unless this property is specified as "asis", + this sequence will be converted into the specified EOL + type. +

+ 		No
javafiles + Used only in association with the + "tab" attribute (see below), this + boolean attribute indicates whether the fileset is a set + of java source files + ("yes"/"no"). Defaults to + "no". See notes in section on "tab". + No
tabSpecifies how tab characters are to be handled. Valid + values for this property are: +
    +
  • add: convert sequences of spaces which span a tab stop to tabs
    • +
  • asis: leave tab and space characters alone
    • +
  • remove: convert tabs to spaces
    • +
+ Default for this parameter is "asis". +

+ N.B.: When the attribute + "javafiles" (see above) is + "true", literal TAB characters occurring + within Java string or character constants are never + modified. This functionality also requires the + recognition of Java-style comments. +

+

+ N.B.: There is an incompatibility between this + and the previous version in the handling of white + space at the end of lines. This version does + not remove trailing whitespace on lines. +

+ 		No
tablengthTAB character interval. Valid values are between + 2 and 80 inclusive. The default for this parameter is 8.No
eofSpecifies how DOS end of file (control-Z) characters are + to be handled. Valid values for this property are: +
    +
  • add: ensure that there is an EOF character at the end of the file
    • +
  • asis: leave EOF characters alone
    • +
  • remove: remove any EOF character found at the end
    • +
+ Default is based on the platform on which you are running this task. + For Unix platforms, the default is remove. For DOS based systems + (including Windows), the default is asis. + 		No
fixlastWhether to add a missing EOL to the last line + of a processed file. Since Ant 1.6.1No; default is true
+

Examples

+
<fixcrlf srcdir="${src}" includes="**/*.sh"
+         eol="lf" eof="remove" />
+

Replaces EOLs with LF characters and removes eof characters from + the shell scripts. Tabs and spaces are left as is.

+
<fixcrlf srcdir="${src}"
+         includes="**/*.bat" eol="crlf" />
+

Replaces all EOLs with cr-lf pairs in the batch files. + Tabs and spaces are left as is. + EOF characters are left alone if run on + DOS systems, and are removed if run on Unix systems.

+
<fixcrlf srcdir="${src}"
+         includes="**/Makefile" tab="add" />
+

Sets EOLs according to local OS conventions, and + converts sequences of spaces and tabs to the minimal set of spaces and + tabs which will maintain spacing within the line. Tabs are + set at 8 character intervals. EOF characters are left alone if + run on DOS systems, and are removed if run on Unix systems. + Many versions of make require tabs prior to commands.

+ 
<fixcrlf srcdir="${src}" includes="**/*.java"
+         tab="remove" tablength="3"
+         eol="lf" javafiles="yes" />
+

+ Converts all EOLs in the included java source files to a + single LF. Replace all TAB characters except those in string + or character constants with spaces, assuming a tab width of 3. + If run on a unix system, any CTRL-Z EOF characters at the end + of the file are removed. On DOS/Windows, any such EOF + characters will be left untouched. +

+
<fixcrlf srcdir="${src}"
+         includes="**/README*" tab="remove" />
+

Sets EOLs according to local OS conventions, and + converts all tabs to spaces, assuming a tab width of 8. + EOF characters are left alone if run on + DOS systems, and are removed if run on Unix systems. + You never know what editor a user will use to browse READMEs.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/ftp.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/ftp.html new file mode 100644 index 000000000..b8e089c49 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/ftp.html @@ -0,0 +1,724 @@ + + + + + + +FTP Task + + + + +

FTP

+

Description

+

The ftp task implements a basic FTP client that can send, receive, +list, delete files, and create directories. See below for descriptions and examples of how +to perform each task.

+

Note: This task depends on external libraries not included in the Apache Ant distribution. +See Library Dependencies for more information. +Get the latest version of this library, for the best support in Ant + +

+

The ftp task attempts to determine what file system is in place on the FTP server. +Supported server types are Unix, NT, OS2, VMS, and OS400. In addition, NT and OS400 servers +which have been configured to display the directory in Unix style are also supported correctly. +Otherwise, the system will default to Unix standards. +remotedir must be specified in the exact syntax required by the ftp +server. If the usual Unix conventions are not supported by the server, +separator can be used to set the file separator that should be used +instead.

+

See the section on directory based +tasks, on how the inclusion/exclusion of files works, and how to +write patterns.

+

+This task does not currently use the proxy information set by the +<setproxy> task, and cannot go through +a firewall via socks. +

+Warning: there have been problems reported concerning the ftp get with the newer attribute. +Problems might be due to format of ls -l differing from what is expected by commons-net, +for instance due to specificities of language used by the ftp server in the directory listing. +If you encounter such a problem, please send an email including a sample directory listing +coming from your ftp server (ls -l on the ftp prompt). +

+

+If you can connect but not upload or download, try setting the passive +attribute to true to use the existing (open) channel, instead of having the server +try to set up a new connection.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
serverthe address of the remote ftp server.Yes
portthe port number of the remote ftp server. + Defaults to port 21.No
useridthe login id to use on the ftp server.Yes
passwordthe login password to use on the ftp server.Yes
accountthe account to use on the ftp server. + since Ant 1.7. + No
remotedirremote directory on the + ftp server + see table below for detailed usage + No
actionthe ftp action to perform, defaulting to "send". + Currently supports "put", "get", + "del", "list", "chmod", + "mkdir", "rmdir", and "site".No
binaryselects binary-mode ("yes") or text-mode + ("no") transfers. + Defaults to "yes"No
passiveselects passive-mode ("yes") transfers, for + better through-firewall connectivity, at the price + of performance. + Defaults to "no"No
verbosedisplays information on each file transferred if set + to "yes". Defaults to "no".No
dependstransfers only new or changed files if set to + "yes". Defaults to "no".No
newera synonym for depends. + see timediffauto and timediffmillisNo
timediffautoset to "true" + to make ant calculate the time difference between client and server.
+ requires write access in the remote directory
+ Since ant 1.6		No
timestampGranularitySpecify either MINUTE, NONE, + (or you may specify "" which is equivalent to not specifying a value, + useful for property-file driven scripts). Allows override of the typical situation + in PUT and GET where local filesystem timestamps are HH:mm:ss + and the typical FTP server's timestamps are HH:mm. This can throw + off uptodate calculations. However, the default values should suffice for most + applications.
+ Since ant 1.7 + 		No. Only applies in "puts" and "gets" where the + default values are MINUTE for PUT and NONE for GET. + (It is not as necessary in GET because we have the preservelastmodified option.)
timediffmillisDeprecated. Number of milliseconds to add to the time on + the remote machine to get the time on the local machine. The timestampGranularity + attribute (for which the default values should suffice in most situations), and the + serverTimeZoneConfig option, should make this unnecessary. + serverTimeZoneConfig does the math for you and also knows about + Daylight Savings Time.
+ Since ant 1.6 + 		No
separatorsets the file separator used on the ftp server. + Defaults to "/".No
umasksets the default file permissions for new files, + unix only.No
chmodsets or changes file permissions for new or existing files, + unix only. If used with a put action, chmod will be issued for each file.No
listingthe file to write results of the "list" action. + Required for the "list" action, ignored otherwise.No
ignoreNoncriticalErrorsflag which permits the task to ignore some non-fatal error + codes sent by some servers during directory creation: wu-ftp in particular. + Default: falseNo
skipFailedTransfersflag which enables unsuccessful file put, delete + and get operations to be skipped with a warning and the + remainder of the files still transferred. Default: falseNo
preservelastmodifiedGive the copied files the same last modified + time as the original source files (applies to getting files only). + (Note: Ignored on Java 1.1)No; defaults to false.
retriesAllowedSet the number of retries allowed on an file-transfer operation. + If a number > 0 specified, each file transfer can fail up to that + many times before the operation is failed. If -1 or "forever" specified, the + operation will keep trying until it succeeds.No; defaults to 0
siteCommandSet the server-specific SITE command to execute if + the action attribute has been specified as "site". + No
initialSiteCommandSet a server-specific SITE command to execute immediately + after login.No
enableRemoteVerificationWhether data connection sshould be verified to + connect to the same host as the control connection. This is a + security measure that is enabled by default, but it may be useful + to disable it in certain firewall scenarios. + since Ant 1.8.0No, default is true
+

The following attributes require + jakarta-commons-net-1.4.0 or greater.

+

+ Use these options when the standard options don't work, because +

  • the server is in a different timezone and you need timestamp + dependency checking
    • +
  • the default timestamp formatting doesn't match the server display and + list parsing therefore fails
+

+ If none of these is specified, the default mechanism of letting the system + auto-detect the server OS type based on the FTP SYST command and assuming + standard formatting for that OS type will be used. +

+ To aid in property-file-based development where a build script is configured + with property files, for any of these attributes, a value of "" + is equivalent to not specifying it. +

+ Please understand that these options are incompatible with the autodetection + scheme. If any of these options is specified, (other than with a value of + "" ) a system type must be chosen and if systemTypeKey is not + specified, UNIX will be assumed. The philosophy behind this is that these + options are for setting non-standard formats, and a build-script author who + knows what system he is dealing with will know what options to need to be + set. Otherwise, these options should be left alone and the default + autodetection scheme can be used and will work in the majority of cases. +

systemTypeKeySpecifies the type of system in use on the server. + Supported values are "UNIX", "VMS", "WINDOWS", "OS/2", "OS/400", + "MVS". If not specified, (or specified as "") and if + no other xxxConfig attributes are specified, the autodectection mechanism + based on the FTP SYST command will be used.
+ Since ant 1.7 + 		No, but if any of the following xxxConfig + attributes is specified, UNIX will be assumed, even if "" + is specified here. +
serverTimeZoneConfigSpecify as a Java + + TimeZone identifier, (e.g. GMT, America/Chicago or + Asia/Jakarta) the timezone used by the server for timestamps. This + enables timestamp dependency checking even when the server is in a different + time zone from the client. Time Zones know, also, about daylight savings time, + and do not require you to calculate milliseconds of difference. If not specified, + (or specified as ""), the time zone of the client is assumed.
+ Since ant 1.7 + 		No
defaultDateFormatConfigSpecify in Java + + SimpleDateFormat notation, (e.g. + yyyy-MM-dd), the date format generally used by the FTP server + to parse dates. In some cases this will be the only date format used. + In others, (unix for example) this will be used for dates + older than a year old. (See recentDateFormatConfig). If not specified, + (or specified as ""), the default date format for the system + type indicated by the systemTypeKey attribute will be used.
+ Since ant 1.7 + 		+ No. +
recentDateFormatConfigSpecify in Java + + SimpleDateFormat notation, + (e.g. MMM dd hh:mm) the date format used by the FTP server + to parse dates less than a year old. If not specified (or specified as + ""), and if the system type indicated by the system key uses + a recent date format, its standard format will be used.
+ Since ant 1.7 + 		No
serverLanguageCodeConfiga + two-letter ISO-639 language code used to specify the + language used by the server to format month names. This only needs to be + specified when the server uses non-numeric abbreviations for months in its + date listings in a language other than English. This appears to be + becoming rarer and rarer, as commonly distributed ftp servers seem + increasingly to use English or all-numeric formats. + Languages supported are: +
    +
  • en - English
    • +
  • fr - French
    • +
  • de - German
    • +
  • it - Italian
    • +
  • es - Spanish
    • +
  • pt - Portuguese
    • +
  • da - Danish
    • +
  • sv - Swedish
    • +
  • no - Norwegian
    • +
  • nl - Dutch
    • +
  • ro - Romanian
    • +
  • sq - Albanian
    • +
  • sh - Serbo-croatian
    • +
  • sk - Slovak
    • +
  • sl - Slovenian
    • +
+ If you require a language other than the above, see also the + shortMonthNamesConfig attribute.
+ Since ant 1.7 + 		No
shortMonthNamesConfigspecify the month abbreviations used on the server in file + timestamp dates as a pipe-delimited string for each month. For example, + a set of month names used by a hypothetical + Icelandic FTP server might conceivably be specified as + "jan|feb|mar|apr|maí|jún|júl|ágú|sep|okt|nóv|des". + This attribute exists primarily to support languages not supported by + the serverLanguageCode attribute.
+ Since ant 1.7 + 		No
+

Note about remotedir attribute

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Action
+ 		meaning of remotedir
+ 		use of nested fileset +(s)
+
send/put
+ 		base directory to +which the files are sent
+ 		they are used normally and +evaluated on the local machine
+
recv/get
+ 		base directory from +which the files are retrieved
+ 		the remote files located under +the remotedir matching the include/exclude patterns of +the fileset 
del/delete
+ 		base directory from +which files get deleted
+ 		the remote files located under +the remotedir matching the include/exclude patterns of +the fileset
+
list
+ 		base directory from +which files are listed
+ 		the remote files located under +the remotedir matching the include/exclude patterns of +the fileset
+
mkdirdirectory to create
+ 		not used
+
chmodbase directory from +which the mode of files get changed
+ 		the remote files located under +the remotedir matching the include/exclude patterns of +the fileset
+
rmdir
+ 		base directory from +which directories get removed
+ 		the remote directories located +under the remotedir matching the include/exclude +patterns of the fileset
+

Parameters specified as nested elements

+

fileset

+

The ftp task supports any number of nested <fileset> elements to specify +the files to be retrieved, or deleted, or listed, or whose mode you want to change.

+

+The attribute followsymlinks of fileset is supported on +local (put) as well as remote (get, chmod, delete) filesets. +Before ant 1.6 there was no support of symbolic links in remote filesets. +In order to exclude symbolic links (preserve the behavior of ant 1.5.x and older), +you need to explicitly set followsymlinks to false. +On remote filesets hidden files are not checked for being symbolic links. Hidden +files are currently assumed to not be symbolic links. +

+ +

Sending Files

+

The easiest way to describe how to send files is with a couple of examples:

+
+  <ftp server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com">
+    <fileset dir="htdocs/manual"/>
+  </ftp>
+
+

Logs in to ftp.apache.org as anonymous and +uploads all files in the htdocs/manual directory +to the default directory for that user.

+
  <ftp server="ftp.apache.org"
+       remotedir="incoming"
+       userid="anonymous"
+       password="me@myorg.com"
+       depends="yes">
+    <fileset dir="htdocs/manual"/>
+  </ftp>
+

Logs in to ftp.apache.org as anonymous and +uploads all new or changed files in the htdocs/manual directory +to the incoming directory relative to the default directory +for anonymous.

+
  <ftp server="ftp.apache.org"
+       port="2121"
+       remotedir="/pub/incoming"
+       userid="coder"
+       password="java1"
+       passive="yes"
+       depends="yes"
+       binary="no">
+    <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>
+

Logs in to ftp.apache.org at port 2121 as +coder with password java1 and uploads all new or +changed HTML files in the htdocs/manual directory to the +/pub/incoming directory. The files are transferred in text mode. +Passive mode has been switched on to send files from behind a firewall.

+
  <ftp server="ftp.hypothetical.india.org"
+       port="2121"
+       remotedir="/pub/incoming"
+       userid="coder"
+       password="java1"
+       depends="yes"
+       binary="no"
+       systemTypeKey="Windows"
+       serverTimeZoneConfig="India/Calcutta">
+    <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>
+

Logs in to a Windows server at ftp.hypothetical.india.org +at port 2121 as coder with password java1 +and uploads all new or changed (accounting for timezone differences) +HTML files in the htdocs/manual +directory to the /pub/incoming directory. The files are transferred +in text mode.

+
  <ftp server="ftp.nt.org"
+       remotedir="c:\uploads"
+       userid="coder"
+       password="java1"
+       separator="\"
+       verbose="yes">
+    <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>

Logs in to the Windows-based ftp.nt.org as +coder with password java1 and uploads all +HTML files in the htdocs/manual directory to the +c:\uploads directory. Progress messages are displayed as each +file is uploaded.

+

Getting Files

+

Getting files from an FTP server works pretty much the same way as +sending them does. The only difference is that the nested filesets +use the remotedir attribute as the base directory for the files on the +FTP server, and the dir attribute as the local directory to put the files +into. The file structure from the FTP site is preserved on the local machine.

+
+  <ftp action="get"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com">
+    <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>
+
+

Logs in to ftp.apache.org as anonymous and +recursively downloads all .html files from default directory for that user +into the htdocs/manual directory on the local machine.

+
+  <ftp action="get"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com"
+       systemTypeKey="UNIX"
+       defaultDateFormatConfig="yyyy-MM-dd HH:mm">
+    <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>
+
+

If apache.org ever switches to a unix FTP server that uses the new all-numeric +format for timestamps, this version would become necessary. It would accomplish +the same functionality as the previous example but would successfully handle the +numeric timestamps. +The systemTypeKey is not necessary here but helps clarify what is +going on.

+
+  <ftp action="get"
+       server="ftp.hypthetical.fr"
+       userid="anonymous"
+       password="me@myorg.com"
+       defaultDateFormatConfig="d MMM yyyy"
+       recentDateFormatConfig="d MMM HH:mm"
+       serverLanguageCodeConfig="fr">
+     <fileset dir="htdocs/manual">
+      <include name="**/*.html"/>
+    </fileset>
+  </ftp>
+
+

Logs into a UNIX FTP server at ftp.hypothetical.fr which displays +dates with French names in Standard European format, as anonymous, and +recursively downloads all .html files from default directory for that user +into the htdocs/manual directory on the local machine.

+ +

Deleting Files

+As you've probably guessed by now, you use nested fileset elements to +select the files to delete from the remote FTP server. Again, the +filesets are relative to the remote directory, not a local directory. In +fact, the dir attribute of the fileset is ignored completely. + +
+  <ftp action="del"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com">
+    <fileset>
+      <include name="**/*.tmp"/>
+    </fileset>
+  </ftp>
+
+

Logs in to ftp.apache.org as anonymous and +tries to delete all *.tmp files from the default directory for that user. +If you don't have permission to delete a file, a BuildException is thrown.

+

Listing Files

+
+  <ftp action="list"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com"
+       listing="data/ftp.listing">
+    <fileset>
+      <include name="**"/>
+    </fileset>
+  </ftp>
+
+

This provides a file listing in data/ftp.listing of all the files on +the FTP server relative to the default directory of the anonymous +user. The listing is in whatever format the FTP server normally lists files.

+ +

Creating Directories

+

Note that with the mkdir action, the directory to create is specified using the +remotedir attribute.

+
+  <ftp action="mkdir"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com"
+       remotedir="some/remote/dir"/>
+
+

This creates the directory some/remote/dir beneath the default root +directory. As with all other actions, the directory separator character must be correct +according to the desires of the FTP server.

+

Removing Directories

+This action uses nested fileset elements to +select the directories to remove from the remote FTP server. The +filesets are relative to the remote directory, not a local directory. +The dir attribute of the fileset is ignored completely. +The directories to be removed must be empty, or contain only +other directories that have been also selected to be removed by the filesets +patterns, otherwise a BuildException will be thrown. +Also, if you don't have permission to remove a directory, a BuildException is +thrown. + +
+  <ftp action="rmdir"
+       server="ftp.apache.org"
+       userid="anonymous"
+       password="me@myorg.com"
+       remotedir="/somedir" >
+    <fileset>
+      <include name="dira"/>
+      <include name="dirb/**"/>
+    </fileset>
+  </ftp>
+
+

Logs in to ftp.apache.org as anonymous and +tries to remove /somedir/dira directory and +all the directories tree starting at, and including, /somedir/dirb. +When removing the /somedir/dirb tree, +it will start at the leaves moving up to the root, so that when +it tries to remove a directory it is sure all the directories under it are +already removed. +Obviously all the files in the tree must have been already deleted. +

+

As an example suppose you want to delete everything contained into +/somedir, so invoke first the <ftp> task with +action="delete", then with +action="rmdir" specifying in both cases +remotedir="/somedir" and + +

+    <fileset>
+        <include name="**"/>
+    </fileset>
+
+ +The directory specified in the remotedir parameter is never +selected for remove, so if you need to remove it, specify its parent in +remotedir parameter and include it in the +<fileset> pattern, like "somedir/**". +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/genkey.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/genkey.html new file mode 100644 index 000000000..96959c2ff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/genkey.html @@ -0,0 +1,125 @@ + + + + + + +GenKey Task + + + + +

GenKey

+

Description

+

Generates a key in a keystore.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
aliasthe alias to add underYes.
storepasspassword for keystore integrity. Must + be at least 6 characters longYes.
keystorekeystore locationNo
storetypekeystore typeNo
keypasspassword for private key (if different)No
sigalgthe algorithm to use in signingNo
keyalgthe method to use when generating name-value pairNo
verbose(true | false) verbose output when signingNo
dnameThe distinguished name for entityYes if dname element unspecified
validity(integer) indicates how many days certificate is validNo
keysize(integer) indicates the size of key generatedNo
+ +

Alternatively you can specify the distinguished name by creating a +sub-element named dname and populating it with param elements that +have a name and a value. When using the subelement it is automatically +encoded properly and commas (",") are replaced +with "\,".

+ +

The following two examples are identical:

+ +

Examples

+
+<genkey alias="apache-group" storepass="secret" 
+  dname="CN=Ant Group, OU=Jakarta Division, O=Apache.org, C=US"/>
+
+ +
+ 
+<genkey alias="apache-group" storepass="secret" >
+  <dname>
+    <param name="CN" value="Ant Group"/>
+    <param name="OU" value="Jakarta Division"/>
+    <param name="O"  value="Apache.Org"/>
+    <param name="C"  value="US"/>
+  </dname>
+</genkey>
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/get.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/get.html new file mode 100644 index 000000000..831fa2f48 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/get.html @@ -0,0 +1,217 @@ + + + + + + +Get Task + + + + +

Get

+

Description

+

Gets files from URLs. When the verbose option is "on", this task +displays a '.' for every 100 Kb retrieved. Any URL schema supported by +the runtime is valid here, including http:, ftp: and jar:; +

+The usetimestamp option enables you to control downloads so that the remote file is +only fetched if newer than the local copy. If there is no local copy, the download always takes +place. When a file is downloaded, the timestamp of the downloaded file is set to the remote timestamp. +NB: This timestamp facility only works on downloads using the HTTP protocol. +

+A username and password can be specified, in which case basic 'slightly encoded +plain text' authentication is used. This is only secure over an HTTPS link. +

+ +

Proxies. Since Apache Ant 1.7.0, Ant running on Java1.5 or later can + use the proxy settings of the operating + system if enabled with the + -autoproxy option. There is also the + <setproxy> task + for earlier Java versions. With proxies turned + on, <get> requests against localhost may not work + as expected, if the request is relayed to the proxy.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcthe URL from which to retrieve a file.Yes or a nested resource collection
destthe file or directory where to store the + retrieved file(s).Yes
verboseshow verbose progress information ("on"/"off").No; default "false"
ignoreerrorsLog errors but don't treat as fatal.No; default "false"
usetimestampconditionally download a file based on the timestamp of the + local copy. HTTP onlyNo; default "false"
usernameusername for 'BASIC' http authenticationif password is set
passwordpassword: required if username is set
maxtimeMaximum time in seconds a single download may take, + otherwise it will be interrupted and treated like a download + error. Since Ant 1.8.0No: default 0 which means no + maximum time
retriesthe per download number of retries on error
+ since Ant 1.8.0		No; default "3"
skipexistingskip files that already exist on the local filesystem
+ since Ant 1.8.0		No; default "false"
httpusecachesHTTP only - if true, allow caching at the + HttpUrlConnection level. if false, turn caching off.
+ Note this is only a hint to the underlying UrlConnection + class, implementations and proxies are free to ignore the + setting.		No; default "true"
+

Parameters specified as nested elements

+

any resource collection

+ +

Resource + Collections are used to select groups of URLs to download. If + the collection contains more than one resource, the dest attribute + must point to a directory if it exists or a directory will be + created if it doesn't exist. The destination file name use the + last part of the path of the source URL unless you also specify a + mapper.

+ +

mapper

+ +

You can define name transformations by using a + nested mapper element. You + can also use any filenamemapper type in place of the mapper + element.

+ +

The mapper will receive the resource's name as argument. Any + resource for which the mapper returns no or more than one mapped + name will be skipped. If the returned name is a relative path, it + will be considered relative to the dest attribute.

+ +

Examples

+
  <get src="http://ant.apache.org/" dest="help/index.html"/>
+

Gets the index page of http://ant.apache.org/, and stores it in the file help/index.html.

+ +
  <get src="http://www.apache.org/dist/ant/KEYS" 
+    dest="KEYS" 
+    verbose="true"
+    usetimestamp="true"/>
+

+Gets the PGP keys of Ant's (current and past) release managers, if the local copy +is missing or out of date. Uses the verbose option +for progress information. +

+ +
  <get src="https://insecure-bank.org/statement/user=1214" 
+    dest="statement.html" 
+    username="1214";
+    password="secret"/>
+

+Fetches some file from a server with access control. Because https is being used the +fact that basic auth sends passwords in plaintext is moot if you +ignore the fact that it is part of your build file which may be +readable by third parties. If you need more security, consider using +the input task to query for a password.

+ +

Using a macro like the following

+ +
+  <macrodef name="get-and-checksum">
+    <attribute name="url"/>
+    <attribute name="dest"/>
+    <sequential>
+      <local name="destdir"/>
+      <dirname property="destdir" file="@{dest}"/>
+      <get dest="${destdir}">
+        <url url="@{url}"/>
+        <url url="@{url}.sha1"/>
+        <firstmatchmapper>
+          <globmapper from="@{url}.sha1" to="@{dest}.sha"/>
+          <globmapper from="@{url}" to="@{dest}"/>
+        </firstmatchmapper>
+      </get>
+      <local name="checksum.matches"/>
+      <local name="checksum.matches.fail"/>
+      <checksum file="@{dest}" algorithm="sha" fileext=".sha"
+                verifyproperty="checksum.matches"/>
+      <condition property="checksum.matches.fail">
+        <equals arg1="${checksum.matches}" arg2="false"/>
+      </condition>
+      <fail if="checksum.matches.fail">Checksum error</fail>
+    </sequential>
+  </macrodef>
+
+ +

it is possible to download an artifacts together with its SHA1 + checksum (assuming a certain naming convention for the checksum + file, of course) and validate the checksum on the fly.

+ +
+<get dest="downloads">
+  <url url="http://ant.apache.org/index.html"/> 
+  <url url="http://ant.apache.org/faq.html"/>
+</get>
+
+

Gets the index and FAQ pages of http://ant.apache.org/, and stores + them in the directory downloads which will be created if + necessary.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/gunzip.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/gunzip.html new file mode 100644 index 000000000..32e2cf216 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/gunzip.html @@ -0,0 +1,29 @@ + + + + + + +GUnZip Task + + + +This document's new home is here + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/gzip.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/gzip.html new file mode 100644 index 000000000..6054d319c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/gzip.html @@ -0,0 +1,29 @@ + + + + + + +GZip Task + + + +This document's new home is here + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/hostinfo.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/hostinfo.html new file mode 100644 index 000000000..851b40360 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/hostinfo.html @@ -0,0 +1,98 @@ + + + + + + +HostInfo Task + + + + +

HostInfo

+ +

Description

+

Sets the NAME, DOMAIN, ADDR4, and ADDR6 +properties in the current project.

+

+The NAME contains the host part of the canonical name of the host.
+If the host is not found, the host will contain the name as provided to the task, +or localhost if no host was provided, and no name for the local +host was found.
+The DOMAIN contains the domain part of the canonical name of the host.
+ If the host is not found, the domain will contain the domain as provided to the task, + or localdomain if no host / domain was provided.
+The ADDR4 contains the IPv4 address of the host with the widest meaning.
+If no IPv4 address is found and a host has been provided the address 0.0.0.0 +is returned, when no host was provided the address 127.0.0.1 is returned.
+The ADDR6 contains the IPv6 address of the host with the widest meaning.
+If no IPv6 address is found and a host has been provided the address :: +is returned, when no host was provided the address ::1 is returned.
+

+ +

These properties can be used in the build-file, for instance, to create +host-stamped filenames, or used to replace placeholder tags inside documents +to indicate, for example, the host where the build was performed on. +The best place for this task is probably in an initialization target.

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
prefixPrefix used for all properties set. The default is no prefix.No
host + The host to retrieve the information for, default is to retrieve + information for the host the task is running on. + No
+ +

Examples

+ +
+  <hostinfo/>
+
+ +

+Sets the NAME, DOMAIN, ADDR4, and +ADDR6 for the local host, using the most "global" address +available.

+
+  <hostinfo prefix="remotehost" host="www.apache.org"/>
+
+

+Sets the properties remotehost.NAME to eos, +remotehost.DOMAIN to apache.org, +remotehost.ADDR4 to 140.211.11.130 and +remotehost.ADDR6 to :: +for the host with the name www.apache.org (provided the canonical name and ip +addresses do not change). +

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/image-classdiagram.gif b/tools/apache-ant-1.8.2/docs/manual/Tasks/image-classdiagram.gif new file mode 100644 index 000000000..fa4b81e8d Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/Tasks/image-classdiagram.gif differ diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/image.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/image.html new file mode 100644 index 000000000..ed7ed7ef4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/image.html @@ -0,0 +1,261 @@ + + + + + + +Image Task + + + + +

Image

+

Description

+

Applies a chain of image operations on a set of files.

+

Requires Java Advanced Image API from Sun.

+ +
Overview of used datatypes
+Class-Diagram + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
failonerror Boolean value. If false, note errors to the output but keep going. no (defaults to true)
srcdir Directory containing the images. yes, unless nested fileset is used
encoding Image encoding type.
+ Valid (caseinsensitive) are: jpg, jpeg, tif, tiff + 		no (defaults to JPEG)
overwrite Boolean value. Sets whether or not to overwrite + a file if there is naming conflict. + no (defaults to false)
gc Boolean value. Enables garbage collection after + each image processed. + no (defaults to false)
destdir Directory where the result images are stored. no (defaults to value of srcdir)
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
caseSensitive Boolean value. Sets case sensitivity of the file system. no (defaults to false)
followSymlinks Boolean value. Sets whether or not symbolic links should be followed. no (defaults to true)
+ +

Parameters specified as nested elements

+

This task forms an implicit FileSet and +supports most attributes of <fileset> as well as the +nested <include>, <exclude> and +<patternset> elements.

+ + +

ImageOperation

+

Adds an ImageOperation to chain.

+
Nested Elements
+ImageOperation can handle nested Rotate, Draw, Rectangle, Text and Scale objects. + +

Rotate

+

Adds a Rotate ImageOperation to chain.

+
Parameters
+ + + + + + + + + + + +
AttributeDescriptionRequired
angle Float value. Sets the angle of rotation in degrees. no (defaults to 0.0F)
+ +

Scale

+

Adds a Scale ImageOperation to chain.

+
Parameters
+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
proportions Sets which dimension to control proportions from. Valid values are:
    +
  • "ignore" - treat the dimensions independently.
    • +
  • "height" - keep proportions based on the width.
    • +
  • "width" - keep proportions based on the height.
    • +
  • "cover" - keep proportions and fit in the supplied dimensions.
    • +
  • "fit" - keep proportions and cover the supplied dimensions.
    • +
no (defaults to ignore)
width Sets the width of the image, either as an integer or a %. no (defaults to 100%)
height Sets the height of the image, either as an integer or a %. no (defaults to 100%)
+ +

Draw

+

Adds a Draw ImageOperation to chain. DrawOperation DataType objects can be +nested inside the Draw object.

+
Parameters
+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
xloc X-Position where to draw nested image elements. no (defaults to 0)
yloc Y-Position where to draw nested image elements. no (defaults to 0)
+ +

mapper

+

Since Apache Ant 1.8.0

+ +

You can define filename transformations by using a + nested mapper element. The + default mapper used by + <image> is + the identity + mapper.

+ +

You can also use a filenamemapper type in place of the mapper + element.

+ +

Examples

+ +
+ <image destdir="samples/low" overwrite="yes">
+     <fileset dir="samples/full">
+         <include name="**/*.jpg"/>
+     </fileset>
+     <scale width="160" height="160" proportions="fit"/>
+ </image>
+
+

Create thumbnails of my images and make sure they all fit within the 160x160 size whether the +image is portrait or landscape.

+ +
+<image srcdir="src" includes="*.png">
+    <scale proportions="width" width="40"/>
+</image>
+
+

Creates a thumbnail for all PNG-files in src in the size of 40 pixel keeping the proportions +and stores the src.

+ +
+<image srcdir="src" destdir="dest" includes="*.png">
+    <scale proportions="width" width="40"/>
+</image>
+
+

Same as above but stores the result in dest.

+ +
+<image srcdir="src" destdir="dest" includes="*.png">
+    <scale proportions="width" width="40"/>
+    <globmapper from="*" to="scaled-*"/>
+</image>
+
+

Same as above but stores the resulting file names will be prefixed + by "scaled-".

+ +
+
+ + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/import.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/import.html new file mode 100644 index 000000000..8cc52655f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/import.html @@ -0,0 +1,349 @@ + + + + + + + Import Task + + +

Import

+

Description

+

+ Imports another build file into the current project. +

+ +

+ On execution it will select the proper ProjectHelper to parse the imported + file, using the same algorithm as the one executed at + startup. The selected ProjectHelper + instance will then be responsible to actually parse the imported file. +

+ +

+ Note as seen above, this task heavily relies on the ProjectHelper + implementation and doesn't really perform any work of its own. If + you have configured Apache Ant to use a ProjectHelper other than Ant's + default, this task may or may not work. +

+ +

+ In the common use case where only Ant's default project helper is + used, it basically works like the + Entity + Includes as explained in the Ant FAQ, as if the imported file was + contained in the importing file, minus the top <project> + tag. +

+ +

+ The import task may only be used as a top-level task. This means that + it may not be used in a target. +

+

+There are two further functional aspects that pertain to this task and +that are not possible with entity includes: +

    +
  • target overriding
    • +
  • special properties
    • +
+

+

Target overriding

+ +

If a target in the main file is also present in at least one of the +imported files, the one from the main file takes precedence.

+ +

So if I import for example a docsbuild.xml file named builddocs, +that contains a "docs" target, I can redefine it in my main +buildfile and that is the one that will be called. This makes it easy to +keep the same target name, so that the overriding target is still called +by any other targets--in either the main or imported buildfile(s)--for which +it is a dependency, with a different implementation. The target from docsbuild.xml is +made available by the name "builddocs.docs". +This enables the new implementation to call the old target, thus +enhancing it with tasks called before or after it.

+ +

If you use the as attribute of the task, its value will be + used to prefix the overriden target's name instead of the name + attribute of the project tag.

+ +

Special Properties

+ +

Imported files are treated as they are present in the main +buildfile. This makes it easy to understand, but it makes it impossible +for them to reference files and resources relative to their path. +Because of this, for every imported file, Ant adds a property that +contains the path to the imported buildfile. With this path, the +imported buildfile can keep resources and be able to reference them +relative to its position.

+ +

So if I import for example a docsbuild.xml file named builddocs, +I can get its path as ant.file.builddocs, similarly to the ant.file +property of the main buildfile.

+ +

Note that "builddocs" is not the filename, but the name attribute +present in the imported project tag.

+

+ If the imported file does not have a name attribute, the ant.file.projectname + property will not be set. +

+ +

Since Ant 1.8.0 the task can also import resources from URLs or + classpath resources (which are URLs, really). If you need to know + whether the current build file's source has been a file or an URL + you can consult the + property ant.file.type.projectname (using the same + example as above ant.file.type.builddocs) which either have + the value "file" or "url".

+ +

Resolving files against the imported file

+ +

Suppose your main build file called importing.xml +imports a build file imported.xml, located anywhere on +the file system, and imported.xml reads a set of +properties from imported.properties:

+ +
<!-- importing.xml -->
+<project name="importing" basedir="." default="...">
+  <import file="${path_to_imported}/imported.xml"/>
+</project>
+
+<!-- imported.xml -->
+<project name="imported" basedir="." default="...">
+  <property file="imported.properties"/>
+</project>
+
+ +

This snippet however will resolve imported.properties +against the basedir of importing.xml, because the basedir +of imported.xml is ignored by Ant. The right way to use +imported.properties is:

+ +
+<!-- imported.xml -->
+<project name="imported" basedir="." default="...">
+  <dirname property="imported.basedir" file="${ant.file.imported}"/>
+  <property file="${imported.basedir}/imported.properties"/>
+</project>
+
+ +

As explained above ${ant.file.imported} stores the +path of the build script, that defines the project called +imported, (in short it stores the path to +imported.xml) and <dirname> takes its +directory. This technique also allows imported.xml to be +used as a standalone file (without being imported in other +project).

+ +

The above description only works for imported files that actually + are imported from files and not from URLs. For files imported from + URLs using resources relative to the imported file requires you to + use tasks that can work on non-file resources in the first place. + To create a relative resource you'd use something like:

+ +
+  <loadproperties>
+    <url baseUrl="${ant.file.imported}"
+         relativePath="imported.properties"/>
+  </loadproperties>
+
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
+ file + + The file to import. If this is a relative file name, the file name will be resolved + relative to the importing file. Note, this is unlike most other + ant file attributes, where relative files are resolved relative to ${basedir}. + Yes or a nested resource collection
+ optional + + If true, do not stop the build if the file does not exist, + default is false. + No
+ as + + Specifies the prefix prepended to the target names. If + ommitted, the name attribute of the project tag of the + imported file will be used. + No
+ prefixSeparator + + Specifies the separator to be used between the prefix and the + target name. Defaults to ".". + No
+ +

Parameters specified as nested elements

+ +

any resource or resource +collection

+ +

The specified resources will be imported. Since Ant + 1.8.0

+ +

Examples

+
  <import file="../common-targets.xml"/>
+
+ +

Imports targets from the common-targets.xml file that is in a parent +directory.

+ +
  <import file="${deploy-platform}.xml"/>
+
+ +

Imports the project defined by the property deploy-platform

+ +
+  <import>
+    <javaresource name="common/targets.xml">
+      <classpath location="common.jar"/>
+    </javaresource>
+  </import>
+
+ +

Imports targets from the targets.xml file that is inside the + directory common inside the jar file common.jar.

+ +

How is <import> different + from <include>?

+ +

The short version: Use import if you intend to override a target, + otherwise use include.

+ +

When using import the imported targets are available by up to two + names. Their "normal" name without any prefix and potentially with + a prefixed name (the value of the as attribute or the imported + project's name attribute, if any).

+ +

When using include the included targets are only available in the + prefixed form.

+ +

When using import, the imported target's depends attribute + remains unchanged, i.e. it uses "normal" names and allows you to + override targets in the dependency list.

+ +

When using include, the included targets cannot be overridden and + their depends attributes are rewritten so that prefixed names are + used. This allows writers of the included file to control which + target is invoked as part of the dependencies.

+ +

It is possible to include the same file more than once by using + different prefixes, it is not possible to import the same file more + than once.

+ +

Examples

+ +

nested.xml shall be:

+ +
+<project>
+  <target name="setUp">
+    <property name="prop" value="in nested"/>
+  </target>
+
+  <target name="echo" depends="setUp">
+    <echo>prop has the value ${prop}</echo>
+  </target>
+</project>
+
+ +

When using import like in

+ +
+<project default="test">
+  <target name="setUp">
+    <property name="prop" value="in importing"/>
+  </target>
+
+  <import file="nested.xml" as="nested"/>
+
+  <target name="test" depends="nested.echo"/>
+</project>
+
+ +

Running the build file will emit: + +

+setUp:
+
+nested.echo:
+     [echo] prop has the value in importing
+
+test:
+
+
+ +

When using include like in

+ +
+<project default="test">
+  <target name="setUp">
+    <property name="prop" value="in importing"/>
+  </target>
+
+  <include file="nested.xml" as="nested"/>
+
+  <target name="test" depends="nested.echo"/>
+</project>
+
+ +

Running the target build file will emit: + +

+nested.setUp:
+
+nested.echo:
+     [echo] prop has the value in nested
+
+test:
+
+
+ +

and there won't be any target named "echo" on the including build file.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/include.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/include.html new file mode 100644 index 000000000..8778ae64a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/include.html @@ -0,0 +1,344 @@ + + + + + + + Include Task + + +

Include

+

Description

+

+ Include another build file into the current project. +

+ +

since Apache Ant 1.8.0

+ +

+ Note this task heavily relies on the ProjectHelper + implementation and doesn't really perform any work of its own. If + you have configured Ant to use a ProjectHelper other than Ant's + default, this task may or may not work. +

+ +

+ On execution it will read another Ant file into the same Project + rewriting the included target names and depends lists. This is + different + from Entity + Includes as explained in the Ant FAQ insofar as the target + names get prefixed by the included project's name or the as + attribute and do not appear as if the file was contained in the + including file. +

+

+ The include task may only be used as a top-level task. This means that + it may not be used in a target. +

+

+There are two further functional aspects that pertain to this task and +that are not possible with entity includes: +

    +
  • target rewriting
    • +
  • special properties
    • +
+

+

Target rewriting

+ +

Any target in the included file will be renamed + to prefix.name where name is the original target's + name and prefix is either the value of the as + attribute or the name attribute of the project tag of + the included file.

+ +

The depends attribute of all included targets is rewritten so that + all target names are prefixed as well. This makes the included file + self-contained.

+ +

Note that prefixes nest, so if a build file includes a file with + prefix "a" and the included file includes another file with prefix + "b", then the targets of that last build file will be prefixed by + "a.b.".

+ +

<import> contribute to the prefix as well, but + only if their as attribute has been specified. + +

Special Properties

+ +

Included files are treated as they are present in the main +buildfile. This makes it easy to understand, but it makes it impossible +for them to reference files and resources relative to their path. +Because of this, for every included file, Ant adds a property that +contains the path to the included buildfile. With this path, the +included buildfile can keep resources and be able to reference them +relative to its position.

+ +

So if I include for example a docsbuild.xml file named builddocs, +I can get its path as ant.file.builddocs, similarly to the ant.file +property of the main buildfile.

+ +

Note that "builddocs" is not the filename, but the name attribute +present in the included project tag.

+

+ If the included file does not have a name attribute, the ant.file.projectname + property will not be set. +

+ +

If you need to know whether the current build file's source has + been a file or an URL you can consult the + property ant.file.type.projectname (using the same + example as above ant.file.type.builddocs) which either have + the value "file" or "url".

+ +

Resolving files against the included file

+ +

Suppose your main build file called including.xml +includes a build file included.xml, located anywhere on +the file system, and included.xml reads a set of +properties from included.properties:

+ +
<!-- including.xml -->
+<project name="including" basedir="." default="...">
+  <include file="${path_to_included}/included.xml"/>
+</project>
+
+<!-- included.xml -->
+<project name="included" basedir="." default="...">
+  <property file="included.properties"/>
+</project>
+
+ +

This snippet however will resolve included.properties +against the basedir of including.xml, because the basedir +of included.xml is ignored by Ant. The right way to use +included.properties is:

+ +
+<!-- included.xml -->
+<project name="included" basedir="." default="...">
+  <dirname property="included.basedir" file="${ant.file.included}"/>
+  <property file="${included.basedir}/included.properties"/>
+</project>
+
+ +

As explained above ${ant.file.included} stores the +path of the build script, that defines the project called +included, (in short it stores the path to +included.xml) and <dirname> takes its +directory. This technique also allows included.xml to be +used as a standalone file (without being included in other +project).

+ +

The above description only works for included files that actually + are included from files and not from URLs. For files included from + URLs using resources relative to the included file requires you to + use tasks that can work on non-file resources in the first place. + To create a relative resource you'd use something like:

+ +
+  <loadproperties>
+    <url baseUrl="${ant.file.included}"
+         relativePath="included.properties"/>
+  </loadproperties>
+
+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
+ file + + The file to include. If this is a relative file name, the file name will be resolved + relative to the including file. Note, this is unlike most other + ant file attributes, where relative files are resolved relative to ${basedir}. + Yes or a nested resource collection
+ optional + + If true, do not stop the build if the file does not exist, + default is false. + No
+ as + + Specifies the prefix prepended to the target names. If + ommitted, the name attribute of the project tag of the + included file will be used. + Yes, if the included file's + project tag doesn't specify a name attribute.
+ prefixSeparator + + Specifies the separator to be used between the prefix and the + target name. Defaults to ".". + No
+ +

Parameters specified as nested elements

+ +

any resource or resource +collection

+ +

The specified resources will be included.

+ +

Examples

+
  <include file="../common-targets.xml"/>
+
+ +

Includes targets from the common-targets.xml file that is in a parent +directory.

+ +
  <include file="${deploy-platform}.xml"/>
+
+ +

Includes the project defined by the property deploy-platform

+ +
+  <include>
+    <javaresource name="common/targets.xml">
+      <classpath location="common.jar"/>
+    </javaresource>
+  </include>
+
+ +

Includes targets from the targets.xml file that is inside the + directory common inside the jar file common.jar.

+ +

How is <import> different + from <include>?

+ +

The short version: Use import if you intend to override a target, + otherwise use include.

+ +

When using import the imported targets are available by up to two + names. Their "normal" name without any prefix and potentially with + a prefixed name (the value of the as attribute or the imported + project's name attribute, if any).

+ +

When using include the included targets are only available in the + prefixed form.

+ +

When using import, the imported target's depends attribute + remains unchanged, i.e. it uses "normal" names and allows you to + override targets in the dependency list.

+ +

When using include, the included targets cannot be overridden and + their depends attributes are rewritten so that prefixed names are + used. This allows writers of the included file to control which + target is invoked as part of the dependencies.

+ +

It is possible to include the same file more than once by using + different prefixes, it is not possible to import the same file more + than once.

+ +

Examples

+ +

nested.xml shall be:

+ +
+<project>
+  <target name="setUp">
+    <property name="prop" value="in nested"/>
+  </target>
+
+  <target name="echo" depends="setUp">
+    <echo>prop has the value ${prop}</echo>
+  </target>
+</project>
+
+ +

When using import like in

+ +
+<project default="test">
+  <target name="setUp">
+    <property name="prop" value="in importing"/>
+  </target>
+
+  <import file="nested.xml" as="nested"/>
+
+  <target name="test" depends="nested.echo"/>
+</project>
+
+ +

Running the build file will emit: + +

+setUp:
+
+nested.echo:
+     [echo] prop has the value in importing
+
+test:
+
+
+ +

When using include like in

+ +
+<project default="test">
+  <target name="setUp">
+    <property name="prop" value="in importing"/>
+  </target>
+
+  <include file="nested.xml" as="nested"/>
+
+  <target name="test" depends="nested.echo"/>
+</project>
+
+ +

Running the target build file will emit: + +

+nested.setUp:
+
+nested.echo:
+     [echo] prop has the value in nested
+
+test:
+
+
+ +

and there won't be any target named "echo" on the including build file.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/input.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/input.html new file mode 100644 index 000000000..0e4629c71 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/input.html @@ -0,0 +1,198 @@ + + + + + + +Input Task + + + + +

Input

+

Description

+ +

Allows user interaction during the build process by prompting for +input. To do so, it uses the configured +InputHandler.

+ +

The prompt can be set via the message attribute or as character +data nested into the element.

+ +

Optionally a set of valid input arguments can be defined via the +validargs attribute. Input task will not accept a value that doesn't match +one of the predefined.

+ +

Optionally a property can be created from the value entered by the +user. This property can then be used during the following build +run. Input behaves according to property +task which means that existing properties cannot be overriden. +Since Apache Ant 1.6, <input> will not prompt for input if +a property should be set by the task that has already been set in the +project (and the task wouldn't have any effect).

+ +

Historically, a regular complaint about this task has been that it echoes +characters to the console, this is a critical security defect, we must fix it +immediately, etc, etc. This problem was due to the lack in early versions of +Java of a (fully functional) facility for handling secure console input. +In Java 1.6 that shortcoming in Java's API was addressed and Ant versions 1.7.1 +and 1.8 have added support for Java 1.6's secure console input feature +(see handler type).

+ +

+IDE behaviour depends upon the IDE: some hang waiting for input, some let you +type it in. For this situation, place the password in a (secured) property +file and load in before the input task.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
messagethe Message which gets displayed to the user + during the build run.No
validargscomma separated String containing valid input + arguments. If set, input task will reject any input not defined + here. Validargs are compared case sensitive. If you want 'a' and + 'A' to be accepted you will need to define both arguments within + validargs.No
addpropertythe name of a property to be created from + input. Behaviour is equal to property + task which means that existing properties cannot be + overridden.No
defaultvalueDefines the default value of the property to be + created from input. Property value will be set to default if no + input is received.No
+

Parameters Specified as Nested Elements

+

Handler

+

Since Ant 1.7, a nested <handler> element can be used to +specify an InputHandler, so that different InputHandlers may be used +among different Input tasks. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
typeone of "default","propertyfile", "greedy", or "secure" (since Ant 1.8). + One of these
refidReference to an InputHandler + defined elsewhere in the project. +
classnameThe name of an InputHandler subclass.
classpathThe classpath to use with classname.No
classpathrefThe refid of a classpath to use with classname.No
loaderrefThe refid of a classloader to use with classname. + No
+
+The classpath can also be specified by means of one or more nested +<classpath> elements.

+ +

Examples

+
  <input/>
+

Will pause the build run until return key is pressed when using the +default +InputHandler, the concrete behavior is defined by the InputHandler +implementation you use.

+
  <input>Press Return key to continue...</input>
+

Will display the message "Press Return key to +continue..." and pause the build run until return key is pressed +(again, the concrete behavior is implementation dependent).

+
  <input
+    message="Press Return key to continue..."
+  />
+

Will display the message "Press Return key to +continue..." and pause the build run until return key is pressed +(see above).

+
+  <input
+    message="All data is going to be deleted from DB continue (y/n)?"
+    validargs="y,n"
+    addproperty="do.delete"
+  />
+  <condition property="do.abort">
+    <equals arg1="n" arg2="${do.delete}"/>
+  </condition>
+  <fail if="do.abort">Build aborted by user.</fail>
+
+

Will display the message "All data is going to be deleted from +DB continue (y/n)?" and require 'y' to continue build or 'n' to +exit build with following message "Build aborted by +user.".

+
  <input
+    message="Please enter db-username:"
+    addproperty="db.user"
+  />
+

Will display the message "Please enter db-username:" and set the +property db.user to the value entered by the user.

+ +
  <input
+    message="Please enter db-username:"
+    addproperty="db.user"
+    defaultvalue="Scott-Tiger"
+  />
+

Same as above, but will set db.user to the value +Scott- Tiger if the user enters no value (simply types +<return>).

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jar.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jar.html new file mode 100644 index 000000000..3a9de693b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jar.html @@ -0,0 +1,570 @@ + + + + + + +Jar Task + + + + +

Jar

+

Description

+

Jars a set of files.

+

The basedir attribute is the reference directory from where to jar.

+

Note that file permissions will not be stored in the resulting jarfile.

+

It is possible to refine the set of files that are being jarred. This can be +done with the includes, includesfile, excludes, excludesfile and defaultexcludes +attributes. With the includes or includesfile attribute you specify the files you want to +have included by using patterns. The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes basedir) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

You can also use nested file sets for more flexibility, and specify +multiple ones to merge together different trees of files into one JAR. +The extended fileset and groupfileset child elements from the zip task are +also available in the jar task. +See the Zip task for more details and examples.

+

If the manifest is omitted, a simple one will be supplied by Apache Ant.

+ +

The update parameter controls what happens if the JAR +file already exists. When set to yes, the JAR file is +updated with the files specified. When set to no (the +default) the JAR file is overwritten. An example use of this is +provided in the Zip task documentation. Please +note that ZIP files store file modification times with a granularity +of two seconds. If a file is less than two seconds newer than the +entry in the archive, Ant will not consider it newer.

+ +

The whenmanifestonly parameter controls what happens when no +files, apart from the manifest file, or nested services, match. +If skip, the JAR is not created and a warning is issued. +If fail, the JAR is not created and the build is halted with an error. +If create, (default) an empty JAR file (only containing a manifest and services) +is created.

+ +

(The Jar task is a shortcut for specifying the manifest file of a JAR file. +The same thing can be accomplished by using the fullpath +attribute of a zipfileset in a Zip task. The one difference is that if the +manifest attribute is not specified, the Jar task will +include an empty one for you.)

+ +

Manifests are processed by the Jar task according to the +Jar file specification. +Note in particular that this may result in manifest lines greater than 72 bytes +being wrapped and continued on the next line.

+ +

The Jar task checks whether you specified package information according to the + +versioning specification.

+ +

Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the duplicate attribute +to a value other than its default, "add".

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destfilethe JAR file to create.Yes
basedirthe directory from which to jar the files.No
compressNot only store data but also compress them, + defaults to true. Unless you set the keepcompression + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.No
keepcompressionFor entries coming from existing archives (like + nested zipfilesets or while updating the archive), keep + the compression as it has been originally instead of using the + compress attribute. Defaults false. Since Ant + 1.6No
encodingThe character encoding to use for filenames + inside the archive. Defaults to UTF8. It is not + recommended to change this value as the created archive will + most likely be unreadable for Java otherwise. +
See also the discussion in the + zip task page		No
filesonlyStore only file entries, defaults to falseNo
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
manifestthe manifest file to use. This can be either the location of a manifest, or the name of a jar added through a fileset. If its the name of an added jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MFNo
filesetmanifestbehavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + No
updateindicates whether to update or overwrite + the destination file if it already exists. Default is "false".No
whenmanifestonlybehavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".No
duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
indexwhether to create an index + list to speed up classloading. This is a JDK 1.3+ specific + feature. Unless you specify additional jars with nested indexjars elements, only the + contents of this jar will be included in the index. Defaults to + false.No
indexMetaInfwhether to include META-INF and its children in + the index. Doesn't have any effect if index is + false.
+ Sun's jar implementation used to skip the META-INF directory and + Ant followed that example. The behavior has been changed with + Java + 5. In order to avoid problems with Ant generated jars on + Java 1.4 or earlier Ant will not include META-INF unless + explicitly asked to.
+ Ant 1.8.0 - Defaults to false.		No
manifestencodingThe encoding used to read the JAR manifest, when + a manifest file is specified. The task will always use UTF-8 + when writing the manifest.No, defaults to the platform encoding.
roundupWhether the file modification times will be + rounded up to the next even number of seconds.
+ Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.
+ Defaults to true. Since Ant 1.6.2		No
levelNon-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). Since Ant 1.7No
strictConfigures how to handle breaks of the packaging version + specification:
    +
  • fail = throws a BuildException
    • +
  • warn = logs a message on warn level
    • +
  • ignore = logs a message on verbose level (default)
    • +
+ Since Ant 1.7.1		No, defaults to ignore.
preserve0permissionswhen updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.
+ Set this attribute to true if you really want to preserve the + original permission field.since Ant 1.8.0 + 		No, default is false
useLanguageEncodingFlagWhether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is true
createUnicodeExtraFieldsWhether to create unicode extra fields to store + the file names a second time inside the entry's metadata. +
Possible values are "never", "always" and "not-encodable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is "never"
fallbacktoUTF8Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + Since Ant 1.8.0. +
See also the discussion in the + zip task page		No, default is false
mergeClassPathAttributesWhether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + Since Ant 1.8.0. +
unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.		No, default is false
flattenAttributesWhether to merge attributes occuring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + Since Ant 1.8.0.No, default is false
+ +

Nested elements

+

metainf

+

The nested metainf element specifies a FileSet. All files included in this fileset will +end up in the META-INF directory of the jar file. If this +fileset includes a file named MANIFEST.MF, the file is +ignored and you will get a warning.

+ +

manifest

+

The manifest nested element allows the manifest for the Jar file to +be provided inline in the build file rather than in an external +file. This element is identical to the +manifest task, but the file and mode +attributes must be omitted.

+

+If both an inline manifest and an external file are both specified, the +manifests are merged. +

+ +

When using inline manifests, the Jar task will check whether the manifest +contents have changed (i.e. the manifest as specified is different in any way +from the manifest that exists in the Jar, if it exists. +If the manifest values have changed the jar will be updated or rebuilt, as +appropriate. +

+ +

indexjars

 + +

since ant 1.6.2

+ +

The nested indexjars element specifies a PATH like structure. Its content is +completely ignored unless you set the index attribute of the task to +true.

+ +

The index created by this task will contain indices for the +archives contained in this path, the names used for the archives +depend on your manifest:

+
    +
  • If the generated jar's manifest contains no Class-Path + attribute, the file name without any leading directory path will be + used and all parts of the path will get indexed.
    • +
  • If the manifest contains a Class-Path attribute, this task will + try to guess which part of the Class-Path belongs to a given + archive. If it cannot guess a name, the archive will be skipped, + otherwise the name listed inside the Class-Path attribute will be + used.
    • +
+ +

This task will not create any index entries for archives that are + empty or only contain files inside the META-INF directory unless + the indexmetainf attribute has been set + to true.

+ +

service

 + +

since ant 1.7.0

+ +

+ The nested service element specifies a service. + Services are described by + http://download.oracle.com/javase/1.5.0/docs/guide/jar/jar.html#Service%20Provider. + The approach is to have providers JARs include files named by the service + provided, for example, + META-INF/services/javax.script.ScriptEngineFactory + which can include implementation class names, one per line (usually just one per JAR). + + The name of the + service is set by the "type" attribute. The classname implementing + the service is the the "provider" attribute, or it one wants to + specify a number of classes that implement the service, by + "provider" nested elements. +

+

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
typeThe name of the service.Yes
provider + The classname of the class implemening the service. + Yes, unless there is a nested + <provider> element.
+

+ The provider classname is specified either by the "provider" attribute, or + by a nested <provider> element, which has a single "classname" attribute. + If a JAR file has more that one implementation of the service, a number of + nested <provider> elements may be used. +

+ + +

Examples

+ +

Simple

+
  <jar destfile="${dist}/lib/app.jar" basedir="${build}/classes"/>
+

jars all files in the ${build}/classes directory into a file +called app.jar in the ${dist}/lib directory.

+ + +

With filters

+ +
  <jar destfile="${dist}/lib/app.jar"
+       basedir="${build}/classes"
+       excludes="**/Test.class"
+  />
+

jars all files in the ${build}/classes directory into a file +called app.jar in the ${dist}/lib directory. Files +with the name Test.class are excluded.

+ +
  <jar destfile="${dist}/lib/app.jar"
+       basedir="${build}/classes"
+       includes="mypackage/test/**"
+       excludes="**/Test.class"
+  />
+

jars all files in the ${build}/classes directory into a file +called app.jar in the ${dist}/lib directory. Only +files under the directory mypackage/test are used, and files with +the name Test.class are excluded.

+ +

Multiple filesets

+
  <jar destfile="${dist}/lib/app.jar">
+    <fileset dir="${build}/classes"
+             excludes="**/Test.class"
+    />
+    <fileset dir="${src}/resources"/>
+  </jar>
+

jars all files in the ${build}/classes directory and also +in the ${src}/resources directory together into a file +called app.jar in the ${dist}/lib directory. +Files with the name Test.class are excluded. +If there are files such as ${build}/classes/mypackage/MyClass.class +and ${src}/resources/mypackage/image.gif, they will appear +in the same directory in the JAR (and thus be considered in the same package +by Java).

+ +

Merging archives

+ +
 <jar destfile="build/main/checksites.jar">
+    <fileset dir="build/main/classes"/>
+    <zipfileset includes="**/*.class" src="lib/main/some.jar"/>
+    <manifest>
+      <attribute name="Main-Class"
+            value="com.acme.checksites.Main"/>
+    </manifest>
+  </jar>
+

+ Creates an executable jar file with a main class "com.acme.checksites.Main", and + embeds all the classes from the jar lib/main/some.jar. +

+ +
 <jar destfile="build/main/checksites.jar">
+    <fileset dir="build/main/classes"/>
+    <restrict>
+     <name name="**/*.class"/>
+     <archives>
+       <zips>
+         <fileset dir="lib/main" includes="**/*.jar"/>
+       </zips>
+     </archives>
+    </restrict>
+    <manifest>
+      <attribute name="Main-Class"
+            value="com.acme.checksites.Main"/>
+    </manifest>
+  </jar>
+

+ Creates an executable jar file with a main class "com.acme.checksites.Main", and + embeds all the classes from all the jars in lib/main. +

+ +

Inline manifest

+
  <jar destfile="test.jar" basedir=".">
+    <include name="build"/>
+    <manifest>
+      <!-- Who is building this jar? -->
+      <attribute name="Built-By" value="${user.name}"/>
+      <!-- Information about the program itself -->
+      <attribute name="Implementation-Vendor" value="ACME inc."/>
+      <attribute name="Implementation-Title" value="GreatProduct"/>
+      <attribute name="Implementation-Version" value="1.0.0beta2"/>
+      <!-- details -->
+      <section name="common/MyClass.class">
+        <attribute name="Sealed" value="false"/>
+      </section>
+    </manifest>
+  </jar>
+

+This is an example of an inline manifest specification including the version of the build +program (Implementation-Version). Note that the Built-By attribute will take the value of the Ant +property ${user.name}. The manifest produced by the above would look like this: +

+ +
Manifest-Version: 1.0
+Built-By: conor
+Implementation-Vendor: ACME inc.
+Implementation-Title: GreatProduct
+Implementation-Version: 1.0.0beta2
+Created-By: Apache Ant 1.7.0
+
+Name: common/MyClass.class
+Sealed: false
+ +

Service Provider

+ +

+ The following shows how to create a jar file specifing a service + with an implementation of the JDK6 scripting interface: +

+
<jar jarfile="pinky.jar">
+  <fileset dir="build/classes"/>
+  <service type="javax.script.ScriptEngineFactory"
+           provider="org.acme.PinkyLanguage"/>
+</jar>
+
+ + + +

+ The following shows how to create a jar file specifing a service + with two implementations of the JDK6 scripting interface: +

+
+<jar jarfile="pinkyandbrain.jar">
+  <fileset dir="classes"/>
+  <service type="javax.script.ScriptEngineFactory">
+    <provider classname="org.acme.PinkyLanguage"/>
+    <provider classname="org.acme.BrainLanguage"/>
+  </service>
+</jar>
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-available.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-available.html new file mode 100644 index 000000000..9e237edd0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-available.html @@ -0,0 +1,135 @@ + + + + + + +jarlib-available Task + + + + +

jarlib-available

+

Description

+

Check whether an extension is present in a fileset or an extensionSet. +If the extension is present then a property is set.

+ +

Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html +

See the Extension and ExtensionSet documentation for further details

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe name of property to set if extensions is available.Yes
fileThe file to check for extensionNo, one of file, nested + ExtensionSet or nested fileset must be present.
+

Parameters specified as nested elements

+ +

extension

+

Extension the extension + to search for.

+ +

fileset

+

FileSets are used to select +sets of files to check for extension.

+ +

extensionSet

+

ExtensionSets is the set + of extensions to search for extension in.

+ +

Examples

+

Search for extension in single file

+
+  <jarlib-available property="myext.present" file="myfile.jar">
+    <extension
+      extensionName="org.apache.tools.ant"
+      specificationVersion="1.4.9"
+      specificationVendor="Apache Software Foundation"/>
+  </jarlib-available>
+
+ +

Search for extension in single file referencing external Extension

+
+  <extension id="myext"
+    extensionName="org.apache.tools.ant"
+    specificationVersion="1.4.9"
+    specificationVendor="Apache Software Foundation"/>
+
+  <jarlib-available property="myext.present" file="myfile.jar">
+    <extension refid="myext"/>
+  </jarlib-available>
+
+

Search for extension in fileset

+
+  <extension id="myext"
+    extensionName="org.apache.tools.ant"
+    specificationVersion="1.4.9"
+    specificationVendor="Apache Software Foundation"/>
+
+  <jarlib-available property="myext.present">
+    <extension refid="myext"/>
+    <fileset dir="lib">
+      <include name="*.jar"/>
+    </fileset>
+  </jarlib-available>
+
+

Search for extension in extensionSet

+
+  <extension id="myext"
+    extensionName="org.apache.tools.ant"
+    specificationVersion="1.4.9"
+    specificationVendor="Apache Software Foundation"/>
+
+  <jarlib-available property="myext.present">
+    <extension refid="myext"/>
+    <extensionSet id="exts3">
+      <libfileset
+        includeUrl="false"
+        includeImpl="true"
+        dir="lib">
+        <include name="*.jar"/>
+      </libfileset>
+    </extensionSet>
+  </jarlib-available>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-display.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-display.html new file mode 100644 index 000000000..6eb8eb303 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-display.html @@ -0,0 +1,81 @@ + + + + + + +jarlib-display Task + + + + +

jarlib-display

+

Description

+

Display the "Optional Package" and "Package Specification" information + contained within the specified jars.

+ +

Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html +

See the Extension and ExtensionSet documentation for further details

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
fileThe file to display extension information about.No, but one of file or fileset must be + present.
+

Parameters specified as nested elements

+ +

fileset

+

FileSets contain list of files to + display Extension information about.

+ +

Examples

+

Display Extension info for a single file

+
+  <jarlib-display file="myfile.jar">
+
+ +

Display Extension info for a fileset

+
+  <jarlib-display>
+    <fileset dir="lib">
+      <include name="*.jar"/>
+    </fileset>
+  </jarlib-display>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-manifest.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-manifest.html new file mode 100644 index 000000000..70e133d10 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-manifest.html @@ -0,0 +1,124 @@ + + + + + + +jarlib-manifest Task + + + + +

jarlib-manifest

+

Description

+

Task to generate a manifest that declares all the dependencies + in manifest. The dependencies are determined by looking in the + specified path and searching for Extension / "Optional Package" + specifications in the manifests of the jars.

+ +

Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html +

See the Extension and ExtensionSet documentation for further details

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
destfileThe file to generate Manifest intoYes.
+

Parameters specified as nested elements

+ +

extension

+

Extension the extension + that this library implements.

+ +

depends

+

ExtensionSets containing + all dependencies for jar.

+ +

options

+

ExtensionSets containing + all optional dependencies for jar. (Optional dependencies will be used if + present else they will be ignored)

+ +

Examples

+

Basic Manifest generated for single Extension

+
+<extension id="e1"
+    extensionName="MyExtensions"
+    specificationVersion="1.0"
+    specificationVendor="Peter Donald"
+    implementationVendorID="vv"
+    implementationVendor="Apache"
+    implementationVersion="2.0"
+    implementationURL="http://somewhere.com"/>
+
+<jarlib-manifest destfile="myManifest.txt">
+    <extension refid="e1"/>
+</jarlib-manifest>
+
+ +

Search for extension in fileset

+

A large example with required and optional dependencies

+
+<extension id="e1"
+    extensionName="MyExtensions"
+    specificationVersion="1.0"
+    specificationVendor="Peter Donald"
+    implementationVendorID="vv"
+    implementationVendor="Apache"
+    implementationVersion="2.0"
+    implementationURL="http://somewhere.com"/>
+
+<extensionSet id="option.ext">
+    <libfileset dir="lib/option">
+        <include name="**/*.jar"/>
+    </libfileset>
+</extensionSet>
+
+<extensionSet id="depends.ext">
+    <libfileset dir="lib/required">
+        <include name="*.jar"/>
+    </libfileset>
+</extensionSet>
+
+<jarlib-manifest destfile="myManifest.txt">
+    <extension refid="e1"/>
+    <depends refid="depends.ext"/>
+    <options refid="option.ext"/>
+</jarlib-manifest>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-resolve.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-resolve.html new file mode 100644 index 000000000..d168d8121 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jarlib-resolve.html @@ -0,0 +1,212 @@ + + + + + + +jarlib-resolve Task + + + + +

jarlib-resolve

+

Description

+

Try to locate a jar to satisfy an extension and place + location of jar into property. The task allows you to + add a number of resolvers that are capable of locating a + library for a specific extension. Each resolver will be attempted + in specified order until library is found or no resolvers are left. + If no resolvers are left and failOnError is true then a BuildException + will be thrown.

+ +

Note that this task +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html +

See the Extension and ExtensionSet documentation for further details

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe name of property to set to library location.Yes
failOnErrorTrue if failure to locate library should result in build exception.No, defaults to true.
checkExtensionTrue if libraries returned by nested resolvers should be checked to see if + they supply extension.No, defaults to true.
+

Parameters specified as nested elements

+ +

extension

+

Extension the extension + to resolve. Must be present

+ +

location

+

The location sub element allows you to look for a library in a + location relative to project directory.

+ + + + + + + + + + + +
AttributeDescriptionRequired
locationThe pathname of library.Yes
+ +

url

+

The url resolver allows you to download a library from a URL to a + local file.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
urlThe URL to download.Yes
destfileThe file to download URL into.No, But one of destfile or + destdir must be present
destdirThe directory in which to place downloaded file.No, But one of destfile or + destdir must be present
+ +

ant

+

The ant resolver allows you to run an Apache Ant build file to generate a library.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
antfileThe build file.Yes
destfileThe file that the ant build creates.Yes
targetThe target to run in build file.No
+ +

Examples

+

Resolve Extension to file. If file does not exist or file + does not implement extension then throw an exception.

+
+  <extension id="dve.ext"
+    extensionName="org.realityforge.dve"
+    specificationVersion="1.2"
+    specificationVendor="Peter Donald"/>
+
+  <jarlib-resolve property="dve.library">
+    <extension refid="dve.ext"/>
+    <location location="/opt/jars/dve.jar"/>
+  </jarlib-resolve>
+
+ +

Resolve Extension to url. If url does not exist or can not write + to destfile or files does not implement extension then throw an exception.

+
+  <extension id="dve.ext"
+    extensionName="org.realityforge.dve"
+    specificationVersion="1.2"
+    specificationVendor="Peter Donald"/>
+
+  <jarlib-resolve property="dve.library">
+    <extension refid="dve.ext"/>
+    <url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/>
+  </jarlib-resolve>
+
+ +

Resolve Extension to file produce by ant build. If file does not get produced + or ant file is missing or build fails then throw an exception (Note does not check + that library implements extension).

+
+  <extension id="dve.ext"
+    extensionName="org.realityforge.dve"
+    specificationVersion="1.2"
+    specificationVendor="Peter Donald"/>
+
+  <jarlib-resolve property="dve.library" checkExtension="false">
+    <extension refid="dve.ext"/>
+    <ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/>
+  </jarlib-resolve>
+
+ +

Resolve Extension via multiple methods. First check local file to see if it implements + extension. If it does not then try to build it from source in parallel directory. If that + fails then finally try to download it from a website. If all steps fail then throw a build + exception.

+
+  <extension id="dve.ext"
+    extensionName="org.realityforge.dve"
+    specificationVersion="1.2"
+    specificationVendor="Peter Donald"/>
+
+  <jarlib-resolve property="dve.library">
+    <extension refid="dve.ext"/>
+    <location location="/opt/jars/dve.jar"/>
+    <ant antfile="../dve/build.xml" target="main" destfile="lib/dve.jar"/>
+    <url url="http://www.realityforge.net/jars/dve.jar" destfile="lib/dve.jar"/>
+  </jarlib-resolve>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/java.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/java.html new file mode 100644 index 000000000..a237039c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/java.html @@ -0,0 +1,405 @@ + + + + + + +Java Task + + + + +

Java

+

Description

+

Executes a Java class within the running (Apache Ant) VM or forks another VM if +specified.

+

+If odd things go wrong when you run this task, set fork="true" to use a new +JVM. + +

As of Ant 1.6.3, you can interact with a forked VM, as well as +sending input to it via the input and inputstring +attributes.

+ +

Running Ant as a background process on + Unix(-like) systems

+ +

If you run Ant as a background process (like ant &) + and use the <java> task with spawn + set to false and fork + to true, you must provide explicit input to the forked + process or Ant will be suspended because it tries to read from the + standard input.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
classnamethe Java class to execute.Either jar or classname
jarthe location of the jar file to execute (must have a + Main-Class entry in the manifest). Fork must be set to true if this option is selected. + See notes below for more details. + Either jar or classname
argsthe arguments for the class that is + executed. deprecated, use nested <arg> + elements instead.No
classpaththe classpath to use.No
classpathrefthe classpath to use, given as reference to a PATH defined elsewhere.No
forkif enabled triggers the class execution in another VM + (disabled by default)No
spawnif enabled allows to start a process which will outlive ant.
+ Requires fork=true, and not compatible + with timeout, input, output, error, result attributes.
+ (disabled by default)		No
jvmthe command used to invoke the Java Virtual Machine, + default is 'java'. The command is resolved by java.lang.Runtime.exec(). + Ignored if fork is disabled. + No
jvmargsthe arguments to pass to the forked VM (ignored + if fork is disabled). deprecated, use nested + <jvmarg> elements instead.No
maxmemoryMax amount of memory to allocate to the forked VM + (ignored if fork is disabled)No
failonerrorStop the buildprocess if the command exits with a + returncode other than 0. Default is "false" (see note)No
resultpropertyThe name of a property in which the return code of the + command should be stored. Only of interest if failonerror=false + and if fork=true.No
dirThe directory to invoke the VM in. (ignored if + fork is disabled)No
outputName of a file to which to write the output. If the error stream + is not also redirected to a file or property, it will appear in this output.No
errorThe file to which the standard error of the command should be + redirected. No
logErrorThis attribute is used when you wish to see error output in Ant's + log and you are redirecting output to a file/property. The error + output will not be included in the output file/property. If you + redirect error with the "error" or "errorProperty" + attributes, this will have no effect.No
appendWhether output and error files should be appended to or overwritten. + Defaults to false.No
outputpropertyThe name of a property in which the output of the + command should be stored. Unless the error stream is redirected to a separate + file or stream, this property will include the error output.No
errorpropertyThe name of a property in which the standard error of the + command should be stored.No
inputA file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attributeNo; default is to take standard input from console + (unless spawn="true")
inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute.No; default is to take standard input from console + (unless spawn="true")
newenvironmentDo not propagate old environment when new + environment variables are specified. Default is "false" + (ignored if fork is disabled).No
timeoutStop the command if it doesn't finish within the + specified time (given in milliseconds). It is highly + recommended to use this feature only if fork is enabled.No
clonevmIf set to true, then all system properties + and the bootclasspath of the forked Java Virtual Machine will be + the same as those of the Java VM running Ant. Default is + "false" (ignored if fork is disabled). + since Ant 1.7No
+

Parameters specified as nested elements

+

arg and jvmarg

+

Use nested <arg> and <jvmarg> +elements to specify arguments for the Java class and the forked VM respectively. +See Command line arguments.

+

sysproperty

+

Use nested <sysproperty> +elements to specify system properties required by the class. +These properties will be made available to the VM during the execution +of the class (either ANT's VM or the forked VM). The attributes +for this element are the same as for environment +variables.

+ +

syspropertyset

+ +

You can specify a set of properties to be used as system properties +with syspropertysets.

+ +

since Ant 1.6.

+ +

classpath

+

Java's classpath attribute is a PATH like structure and can also be set via a nested +classpath element.

+ +

bootclasspath

+ +

The location of bootstrap class files can be specified using this +PATH like structure - will be ignored +if fork is not true or the target VM doesn't +support it (i.e. Java 1.1).

+ +

since Ant 1.6.

+ +

env

+

It is possible to specify environment variables to pass to the +forked VM via nested env elements. See the description in the +section about exec

+

Settings will be ignored if fork is disabled.

+ +

permissions

+

Security permissions can be revoked and granted during the execution of the +class via a nested permissions element. For more information please +see permissions

+

When the permission RuntimePermission exitVM has not been granted (or has +been revoked) the System.exit() call will be intercepted +and treated like indicated in failonerror.

+

Note:
+If you do not specify permissions, +a set of default permissions will be added to your Java invocation to make +sure that the ant run will continue or terminated as indicated by +failonerror. All permissions not granted per default will be +checked by whatever security manager was already in place. exitVM will be +disallowed. +

+

Settings will be ignored if fork is enabled.

+ +

since Ant 1.6.

+ +

assertions

+ +

You can control enablement of Java 1.4 assertions with an +<assertions> +subelement.

+ +

Assertion statements are currently ignored in non-forked mode.

+ +

since Ant 1.6.

+ +

redirector

 +Since Ant 1.6.2 +

A nested I/O Redirector +can be specified. In general, the attributes of the redirector behave +as the corresponding attributes available at the task level. The most +notable peculiarity stems from the retention of the <java> +attributes for backwards compatibility. Any file mapping is done +using a null sourcefile; therefore not all +Mapper types will return +results. When no results are returned, redirection specifications +will fall back to the task level attributes. In practice this means that +defaults can be specified for input, output, and error output files. +

+

Errors and return codes

 +By default the return code of a <java> is ignored. +Alternatively, you can set resultproperty to the name +of a property and have it assigned to the result code (barring immutability, +of course). +When you set failonerror="true", the only possible value for +resultproperty is 0. Any non-zero response is treated as an +error and would mean the build exits. +

Similarly, if failonerror="false" and fork="false" +, then <java> must return 0 otherwise the build will +exit, as the class was run by the build JVM.

+ +

JAR file execution

+ +

The parameter of the jar attribute is of type File; +that is, the parameter is resolved to an absolute file relative to the +base directory of the project, not the directory in which the Java +task is run. If you need to locate a JAR file relative to the directory +the task will be run in, you need to explicitly create the full path +to the JAR file.

+

When using the jar attribute, all classpath settings are +ignored according to Sun's +specification. + + +

Examples

+
+       <java classname="test.Main">
+         <arg value="-h"/>
+         <classpath>
+           <pathelement location="dist/test.jar"/>
+           <pathelement path="${java.class.path}"/>
+         </classpath>
+       </java>
+
+Run a class in this JVM with a new jar on the classpath + +
+       <java jar="dist/test.jar"
+           fork="true"
+           failonerror="true"
+           maxmemory="128m"
+           >
+         <arg value="-h"/>
+         <classpath>
+           <pathelement location="dist/test.jar"/>
+           <pathelement path="${java.class.path}"/>
+         </classpath>
+       </java>
+
+Run the JAR test.jar in this project's dist/lib directory. +using the manifest supplied entry point, forking (as required), +and with a maximum memory of 128MB. Any non zero return code breaks the build. + +
+       <java
+           dir="${exec.dir}"
+           jar="${exec.dir}/dist/test.jar"
+           fork="true"
+           failonerror="true"
+           maxmemory="128m"
+           >
+         <arg value="-h"/>
+         <classpath>
+           <pathelement location="dist/test.jar"/>
+           <pathelement path="${java.class.path}"/>
+         </classpath>
+       </java>
+
+Run the JAR dist/test.jar relative to the directory +${exec.dir}, this being the same directory into which the JVM +is to start up. + +
  <java classname="test.Main"/>
+Runs a given class with the current classpath. + +
+  <java classname="test.Main"
+        fork="yes" >
+    <sysproperty key="DEBUG" value="true"/>
+    <arg value="-h"/>
+    <jvmarg value="-Xrunhprof:cpu=samples,file=log.txt,depth=3"/>
+  </java>
+
+Add system properties and JVM-properties to the JVM as in +java ="-Xrunhprof:cpu=samples,file=log.txt,depth=3 -DDEBUG=true test.Main + +
  <java classname="ShowJavaVersion" classpath="."
+        jvm="path-to-java14-home/bin/java" fork="true"
+        taskname="java1.4" >
+
+Use a given Java implementation (another the one Ant is currently using) to run the class. +For documentation in the log taskname is used to change the [java] +log-prefix to [java1.4]. + + +

Note: you can not specify the (highly deprecated) MSJVM, "jview.exe" as the +JVM, as it takes different parameters for other JVMs, +That JVM can be started from <exec> if required.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/javac.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/javac.html new file mode 100644 index 000000000..168f6b9cb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/javac.html @@ -0,0 +1,842 @@ + + + + + + +Javac Task + + + + +

Javac

+

Description

+

Compiles a Java source tree.

+

The source and destination directory will be recursively scanned for Java +source files to compile. Only Java files that have no corresponding +.class file +or where the class file is older than the +.java file will be compiled.

+

Note: Apache Ant uses only the names of the source and class files to find +the classes that need a rebuild. It will not scan the source and therefore +will have no knowledge about nested classes, classes that are named different +from the source file, and so on. See the +<depend> task +for dependency checking based on other than just +existence/modification times.

+

When the source files are part of a package, the directory structure of +the source tree should follow the package +hierarchy.

+

It is possible to refine the set of files that are being compiled. +This can be done with the includes, includesfile, +excludes, and excludesfile +attributes. With the includes or +includesfile attribute, you specify the files you want to +have included. +The exclude or excludesfile attribute is used +to specify +the files you want to have excluded. In both cases, the list of files +can be specified by either the filename, relative to the directory(s) specified +in the srcdir attribute or nested <src> +element(s), or by using wildcard patterns. See the section on +directory-based tasks, +for information on how the +inclusion/exclusion of files works, and how to write wildcard patterns.

+

It is possible to use different compilers. This can be specified by +either setting the global build.compiler property, which will +affect all <javac> tasks throughout the build, by +setting the compiler attribute, specific to the current +<javac> task or by using a nested element of any +typedeffed or +componentdeffed type that implements +org.apache.tools.ant.taskdefs.compilers.CompilerAdapter. +Valid values for either the +build.compiler property or the compiler +attribute are:

+
    +
  • classic (the standard compiler of JDK 1.1/1.2) – + javac1.1 and + javac1.2 can be used as aliases.
    • +
  • modern (the standard compiler of JDK 1.3/1.4/1.5/1.6/1.7) – + javac1.3 and + javac1.4 and + javac1.5 and + javac1.6 and + javac1.7 (since Ant 1.8.2) can be used as aliases.
    • +
  • jikes (the Jikes + compiler).
    • +
  • jvc (the Command-Line Compiler from Microsoft's SDK + for Java / Visual J++) – microsoft can be used + as an alias.
    • +
  • kjc (the kopi + compiler).
    • +
  • gcj (the gcj compiler from gcc).
    • +
  • sj (Symantec java compiler) – + symantec can be used as an alias.
    • +
  • extJavac (run either modern or classic in a JVM of + its own).
    • +
+

The default is javac1.x with x depending +on the JDK version you use while you are running Ant. +If you wish to use a different compiler interface than those +supplied, you can write a class that implements the CompilerAdapter interface +(package org.apache.tools.ant.taskdefs.compilers). Supply the full +classname in the build.compiler property or the +compiler attribute. +

+

The fork attribute overrides the build.compiler property +or compiler attribute setting and +expects a JDK1.1 or higher to be set in JAVA_HOME. +

+

You can also use the compiler attribute to tell Ant +which JDK version it shall assume when it puts together the command +line switches - even if you set fork="true". +This is useful if you want to run the compiler of JDK 1.1 while you +current JDK is 1.2+. If you use +compiler="javac1.1" and (for example) +depend="true" Ant will use the command line +switch -depend instead of -Xdepend.

+

This task will drop all entries that point to non-existent +files/directories from the classpath it passes to the compiler.

+

The working directory for a forked executable (if any) is the + project's base directory.

+

Windows Note:When the modern compiler is used +in unforked mode on Windows, it locks up the files present in the +classpath of the <javac> task, and does not release them. +The side effect of this is that you will not be able to delete or move +those files later on in the build. The workaround is to fork when +invoking the compiler.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcdirLocation of the java files. (See the + note below.)Yes, unless nested <src> elements are present.
destdirLocation to store the class files.No
includesComma- or space-separated list of files (may be specified using + wildcard patterns) that must be + included; all .java files are included when omitted.No
includesfileThe name of a file that contains a list of files to + include (may be specified using wildcard patterns).No
excludesComma- or space-separated list of files (may be specified using + wildcard patterns) that must be excluded; no files (except default + excludes) are excluded when omitted.No
excludesfileThe name of a file that contains a list of files to + exclude (may be specified using wildcard patterns).No
classpathThe classpath to use.No
sourcepathThe sourcepath to use; defaults to the value of the srcdir attribute (or nested <src> elements). + To suppress the sourcepath switch, use sourcepath="".No
bootclasspath + Location of bootstrap class files. (See below + for using the -X and -J-X parameters for specifing + the bootstrap classpath). + No
classpathrefThe classpath to use, given as a + reference to a path defined elsewhere.No
sourcepathrefThe sourcepath to use, given as a + reference to a path defined elsewhere.No
bootclasspathrefLocation of bootstrap class files, given as a + reference to a path defined elsewhere.No
extdirsLocation of installed extensions.No
encodingEncoding of source files. (Note: gcj doesn't support + this option yet.)No
nowarnIndicates whether the -nowarn switch + should be passed to the compiler; defaults to off.No
debugIndicates whether source should be compiled with + debug information; defaults to off. If set to + off, -g:none will be passed on the + command line for compilers that support it (for other compilers, no + command line argument will be used). If set to true, + the value of the debuglevel attribute determines the + command line argument.No
debuglevelKeyword list to be appended to the -g + command-line switch. This will be ignored by all implementations except + modern, classic(ver >= 1.2) and jikes. + Legal values are none or a comma-separated list of the + following keywords: + lines, vars, and source. + If debuglevel is not specified, by default, + nothing will be + appended to -g. If debug is not turned on, + this attribute will be ignored. + No
optimize + Indicates whether source should be compiled with + optimization; defaults to off. Note + that this flag is just ignored by Sun's javac starting + with JDK 1.3 (since compile-time optimization is unnecessary). + No
deprecationIndicates whether source should be compiled with + deprecation information; defaults to off.No
targetGenerate class files for specific VM version + (e.g., 1.1 or 1.2). Note that the + default value depends on the JVM that is running Ant. In + particular, if you use JDK 1.4+ the generated classes will not be + usable for a 1.1 Java VM unless you explicitly set this attribute + to the value 1.1 (which is the default value for JDK 1.1 to + 1.3). We highly recommend to always specify this + attribute.
+ A default value for this attribute can be provided using the magic + ant.build.javac.target + property.		No
verboseAsks the compiler for verbose output; defaults to + no.No
depend Enables dependency-tracking + for compilers that support this (jikes and + classic).No
includeAntRuntimeWhether to include the Ant run-time libraries in the + classpath; defaults to yes, unless + build.sysclasspath is set. + It is usually best to set this to false so the script's behavior is not + sensitive to the environment in which it is run.No
includeJavaRuntimeWhether to include the default run-time + libraries from the executing VM in the classpath; + defaults to no.
+ Note: In some setups the run-time libraries may be part + of the "Ant run-time libraries" so you may need to explicitly + set includeAntRuntime to false to ensure that the Java + run-time libraries are not included.		No
forkWhether to execute javac using the + JDK compiler externally; defaults to no.No
executableComplete path to the javac + executable to use in case of fork="yes". + Defaults to the compiler of the Java version that is currently + running Ant. Ignored if fork="no".
+ Since Ant 1.6 this attribute can also be used to specify the + path to the executable when using jikes, jvc, gcj or sj.		No
memoryInitialSizeThe initial size of the memory for the underlying VM, + if javac is run externally; ignored otherwise. Defaults + to the standard VM memory setting. + (Examples: 83886080, 81920k, or + 80m)No
memoryMaximumSizeThe maximum size of the memory for the underlying VM, + if javac is run externally; ignored otherwise. Defaults + to the standard VM memory setting. + (Examples: 83886080, 81920k, or + 80m)No
failonerrorIndicates whether compilation errors + will fail the build; defaults to true.No
errorProperty + The property to set (to the value "true") if compilation fails. + Since Ant 1.7.1. + No
sourceValue of the -source command-line + switch; will be ignored by all implementations prior to + javac1.4 (or modern when Ant is not + running in a 1.3 VM), gcj and jikes.
+ If you use this attribute together with gcj + or jikes, you must make sure that your version + supports the -source (or -fsource for + gcj) + switch. By default, no -source argument will be used + at all.
+ Note that the default value depends on the JVM that is running + Ant. We highly recommend to always specify this + attribute.
+ A default value for this attribute can be provided using the magic + ant.build.javac.source + property.		No
compilerThe compiler implementation to use. + If this attribute is not set, the value of the + build.compiler property, if set, will be used. + Otherwise, the default compiler for the current VM will be used. + (See the above list of valid + compilers.)No
listfilesIndicates whether the source files to be compiled will + be listed; defaults to no.No
tempdirWhere Ant should place temporary files. + This is only used if the task is forked and the + command line args length exceeds 4k. + Since Ant 1.6. + No; default is java.io.tmpdir. +
updatedProperty + The property to set (to the value "true") + if compilation has taken place + and has been successful. + Since Ant 1.7.1. + No
includeDestClasses + This attribute controls whether to include the + destination classes directory in the classpath + given to the compiler. + The default value of this is "true" and this + means that previously compiled classes are on + the classpath for the compiler. This means that "greedy" compilers + will not recompile dependant classes that are already compiled. + In general this is a good thing as it stops the compiler + for doing unnecessary work. However, for some edge cases, + involving generics, the javac compiler + needs to compile the dependant classes to get the generics + information. One example is documented in the bug report: + + Bug 40776 - a problem compiling a Java 5 project with generics. + Setting the attribute to "false" will cause the compiler + to recompile dependent classes. + Since Ant 1.7.1. + No - default is "true"
+ +

Parameters specified as nested elements

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes srcdir) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

srcdir, classpath, sourcepath, +bootclasspath and extdirs

+

<javac>'s srcdir, classpath, +sourcepath, bootclasspath, and +extdirs attributes are +path-like structures +and can also be set via nested +<src> (note the different name!), +<classpath>, +<sourcepath>, +<bootclasspath> and +<extdirs> elements, respectively.

+ +

compilerarg

+ +

You can specify additional command line arguments for the compiler +with nested <compilerarg> elements. These elements +are specified like Command-line +Arguments but have an additional attribute that can be used to +enable arguments only if a given compiler implementation will be +used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
valueSee + Command-line Arguments.Exactly one of these.
line
file
path
prefixSee + Command-line Arguments. + Since Ant 1.8.No
suffixNo
compilerOnly pass the specified argument if the chosen + compiler implementation matches the value of this attribute. + Legal values are the + same as those in the above list of valid + compilers.)No
+ +

compilerclasspath since Ant 1.8.0

+ +

A PATH like structure holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.

+ +

Any nested element of a type that implements CompilerAdapter + since Ant 1.8.0

+ +

If a defined type implements the CompilerAdapter + interface a nested element of that type can be used as an + alternative to the compiler attribute.

+ +

Examples

+
  <javac srcdir="${src}"
+         destdir="${build}"
+         classpath="xyz.jar"
+         debug="on"
+         source="1.4"
+  />
+

compiles all .java files under the ${src} +directory, and stores +the .class files in the ${build} directory. +The classpath used includes xyz.jar, and compiling with +debug information is on. The source level is 1.4, +so you can use assert statements.

+ +
  <javac srcdir="${src}"
+         destdir="${build}"
+         fork="true"
+         source="1.2"
+         target="1.2"
+  />
+

compiles all .java files under the ${src} +directory, and stores the .class files in the +${build} directory. This will fork off the javac +compiler using the default javac executable. +The source level is 1.2 (similar to 1.1 or 1.3) and +the class files should be runnable under JDK 1.2+ as well.

+ +
  <javac srcdir="${src}"
+         destdir="${build}"
+         fork="java$$javac.exe"
+         source="1.5"
+  />
+

compiles all .java files under the ${src} +directory, and stores the .class files in the +${build} directory. This will fork off the javac +compiler, using the executable named java$javac.exe. Note +that the $ sign needs to be escaped by a second one. +The source level is 1.5, so you can use generics.

+ +
  <javac srcdir="${src}"
+         destdir="${build}"
+         includes="mypackage/p1/**,mypackage/p2/**"
+         excludes="mypackage/p1/testpackage/**"
+         classpath="xyz.jar"
+         debug="on"
+  />
+

compiles .java files under the ${src} +directory, and stores the +.class files in the ${build} directory. +The classpath used includes xyz.jar, and debug information is on. +Only files under mypackage/p1 and mypackage/p2 are +used. All files in and below the mypackage/p1/testpackage +directory are excluded from compilation. +You didn't specify a source or target level, +so the actual values used will depend on which JDK you ran Ant with.

+ +
  <javac srcdir="${src}:${src2}"
+         destdir="${build}"
+         includes="mypackage/p1/**,mypackage/p2/**"
+         excludes="mypackage/p1/testpackage/**"
+         classpath="xyz.jar"
+         debug="on"
+  />
+ +

is the same as the previous example, with the addition of a second +source path, defined by +the property src2. This can also be represented using nested +<src> elements as follows:

+ +
  <javac destdir="${build}"
+         classpath="xyz.jar"
+         debug="on">
+    <src path="${src}"/>
+    <src path="${src2}"/>
+    <include name="mypackage/p1/**"/>
+    <include name="mypackage/p2/**"/>
+    <exclude name="mypackage/p1/testpackage/**"/>
+  </javac>
+ +

If you want to run the javac compiler of a different JDK, you +should tell Ant, where to find the compiler and which version of JDK +you will be using so it can choose the correct command line switches. +The following example executes a JDK 1.1 javac in a new process and +uses the correct command line switches even when Ant is running in a +Java VM of a different version:

+ +
  <javac srcdir="${src}"
+         destdir="${build}"
+         fork="yes"
+         executable="/opt/java/jdk1.1/bin/javac"
+         compiler="javac1.1"
+  />
+ +

Note: +If you wish to compile only source files located in certain packages below a +common root, use the include/exclude attributes +or <include>/<exclude> nested elements +to filter for these packages. Do not include part of your package structure +in the srcdir attribute +(or nested <src> elements), or Ant will recompile your +source files every time you run your compile target. See the +Ant FAQ +for additional information.

+ +

+If you wish to compile only files explicitly specified and disable +javac's default searching mechanism then you can unset the sourcepath +attribute: +

  <javac sourcepath="" srcdir="${src}"
+         destdir="${build}" >
+    <include name="**/*.java"/>
+    <exclude name="**/Example.java"/>
+  </javac>
+That way the javac will compile all java source files under "${src}" +directory but skip the examples. The compiler will even produce errors if some of +the non-example files refers to them. +

+ +

+If you wish to compile with a special JDK (another than the one Ant is currently using), +set the executable and fork attribute. Using taskname +could show in the log, that these settings are fix. +

  <javac srcdir="" 
+         destdir=""
+         executable="path-to-java14-home/bin/javac" 
+         fork="true"
+         taskname="javac1.4" />
+

+ + +

Note: If you are using Ant on Windows and a new DOS window pops up +for every use of an external compiler, this may be a problem of the JDK you are +using. This problem may occur with all JDKs < 1.2.

+ + +

+If you want to activate other compiler options like lint you could use +the <compilerarg> element: +

  <javac srcdir="${src.dir}"
+         destdir="${classes.dir}"
+         classpathref="libraries">
+    <compilerarg value="-Xlint"/>
+  </javac>
+

+ +

If you want to use a custom + CompilerAdapter org.example.MyAdapter you can either + use the compiler attribute:

+
+<javac srcdir="${src.dir}"
+       destdir="${classes.dir}"
+       compiler="org.example.MyAdapter"/>
+
+

or a define a type and nest this into the task like in:

+
+<componentdef classname="org.example.MyAdapter"
+              name="myadapter"/>
+<javac srcdir="${src.dir}"
+       destdir="${classes.dir}">
+  <myadapter/>
+</javac>
+
+

in which case your compiler adapter can support attributes and + nested elements of its own.

+ +

Jikes Notes

+ +

You need Jikes 1.15 or later.

+ +

Jikes supports some extra options, which can be set be defining +the properties shown below prior to invoking the task. The setting +for each property will be in affect for all <javac> +tasks throughout the build. +The Ant developers are aware that +this is ugly and inflexible – expect a better solution in the future. +All the options are boolean, and must be set to true or +yes to be +interpreted as anything other than false. By default, +build.compiler.warnings is true, +while all others are false.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescriptionDefault
+ build.compiler.emacs + + Enable emacs-compatible error messages. + + false +
+ build.compiler.fulldepend + + Enable full dependency checking; see
+ the +F switch in the Jikes manual. + 		+ false +
+ build.compiler.pedantic + + Enable pedantic warnings. + + false +
+ build.compiler.warnings
+ Deprecated. Use + <javac>'s nowarn + attribute instead. + 		+ Don't disable warning messages. + + true +
+ +

Jvc Notes

+ +

Jvc will enable Microsoft extensions unless you set the property +build.compiler.jvc.extensions to false before invoking +<javac>.

+ +

Bootstrap Options

+

+ The Sun javac compiler has a bootclasspath command + line option - this corresponds to the "bootclasspath" attribute/element + of the <javac> task. The Sun compiler also allows more + control over the boot classpath using the -X and -J-X attributes. + One can set these by using the <compilerarg>. Since Ant 1.6.0, + there is a shortcut to convert path references to strings that + can by used in an OS independent fashion (see + pathshortcut). For example: +

+
+  <path id="lib.path.ref">
+    <fileset dir="lib" includes="*.jar"/>
+  </path>
+  <javac srcdir="src" destdir="classes">
+    <compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/>
+  </javac>
+
+ + +

+ +

OpenJDK Notes

+

+ The openjdk + project has provided the javac + compiler + as an opensource project. The output of this project is a + javac.jar which contains the javac compiler. + This compiler may be used with the <javac> task with + the use of a -Xbootclasspath/p java argument. The argument needs + to be given to the runtime system of the javac executable, so it needs + to be prepended with a "-J". For example: + +

+  <property name="patched.javac.jar"
+            location="${my.patched.compiler}/dist/lib/javac.jar"/>
+
+  <presetdef name="patched.javac">
+    <javac fork="yes">
+      <compilerarg value="-J-Xbootclasspath/p:${patched.javac.jar}"/>
+    </javac>
+  </presetdef>
+
+
+  <patched.javac srcdir="src/java" destdir="build/classes"
+                 debug="yes"/>
+
+ +

Note on package-info.java

+

+ package-info.java files were introduced in Java5 to + allow package level annotations. On compilation, if the java file + does not contain runtime annotations, there will be no .class file + for the java file. Up to Ant 1.7.1, when the <javac> + task is run again, the + task will try to compile the package-info java files again. +

+

With Ant 1.7.1 a different kind of logic was introduced that + involved the timestamp of the directory that would normally + contain the .class file. This logic turned out to lead to Ant not + recompiling package-info.java in certain setup.

+

Starting with Ant 1.8.0 Ant will create + "empty" package-info.class files if it compiles + a package-info.java and + no package-info.class file has been created by the + compiler itself.

+ + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/javacc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/javacc.html new file mode 100644 index 000000000..26f9de8e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/javacc.html @@ -0,0 +1,204 @@ + + + + + + +JavaCC Task + + + + +

JavaCC

+

Description

+

+ Invokes the JavaCC compiler + compiler on a grammar file. +

+

+ To use the javacc task, set the target attribute to the name of the + grammar file to process. You also need to specify the directory containing + the JavaCC installation using the javacchome attribute, so that Apache Ant + can find the JavaCC classes. Optionally, you can also set the + outputdirectory to write the generated file to a specific directory. + Otherwise javacc writes the generated files to the directory containing + the grammar file. +

+

+ This task only invokes JavaCC if the grammar file is newer than the generated + Java files. javacc assumes that the Java class name of the generated parser + is the same as the name of the grammar file, ignoring the .jj. + If this is not the case, the javacc task will still work, but it will always + generate the output files. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetThe grammar file to process.Yes
javacchomeThe directory containing the JavaCC distribution.Yes
outputdirectory + The directory to write the generated files to. If not set, the files + are written to the directory containing the grammar file. + No
buildparserSets the BUILD_PARSER grammar option. This is a boolean option.No
buildtokenmanagerSets the BUILD_TOKEN_MANAGER grammar option. This is a boolean option.No
cachetokensSets the CACHE_TOKENS grammar option. This is a boolean option.No
choiceambiguitycheckSets the CHOICE_AMBIGUITY_CHECK grammar option. This is an integer option.No
commontokenactionSets the COMMON_TOKEN_ACTION grammar option. This is a boolean option.No
debuglookaheadSets the DEBUG_LOOKAHEAD grammar option. This is a boolean option.No
debugparserSets the DEBUG_PARSER grammar option. This is a boolean option.No
debugtokenmanagerSets the DEBUG_TOKEN_MANAGER grammar option. This is a boolean option.No
errorreportingSets the ERROR_REPORTING grammar option. This is a boolean option.No
forcelacheckSets the FORCE_LA_CHECK grammar option. This is a boolean option.No
ignorecaseSets the IGNORE_CASE grammar option. This is a boolean option.No
javaunicodeescapeSets the JAVA_UNICODE_ESCAPE grammar option. This is a boolean option.No
jdkversionSets the JDK_VERSION option. This is a string option.No
keeplinecolumnSets the KEEP_LINE_COLUMN grammar option. This is a boolean option.No
lookaheadSets the LOOKAHEAD grammar option. This is an integer option.No
optimizetokenmanagerSets the OPTIMIZE_TOKEN_MANAGER grammar option. This is a boolean option.No
otherambiguitycheckSets the OTHER_AMBIGUITY_CHECK grammar option. This is an integer option.No
sanitycheckSets the SANITY_CHECK grammar option. This is a boolean option.No
staticSets the STATIC grammar option. This is a boolean option.No
unicodeinputSets the UNICODE_INPUT grammar option. This is a boolean option.No
usercharstreamSets the USER_CHAR_STREAM grammar option. This is a boolean option.No
usertokenmanagerSets the USER_TOKEN_MANAGER grammar option. This is a boolean option.No
+

Example

+
+<javacc
+    target="src/Parser.jj"
+    outputdirectory="build/src"
+    javacchome="c:/program files/JavaCC"
+    static="true"
+/>
+
+

+ This invokes JavaCC on grammar file src/Parser.jj, writing the generated + files to build/src. The grammar option STATIC is set to true when + invoking JavaCC. +

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/javadoc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/javadoc.html new file mode 100644 index 000000000..1afd1a73b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/javadoc.html @@ -0,0 +1,894 @@ + + + + + + +Javadoc Task + + + + +

Javadoc/Javadoc2

+

Description

+

Generates code documentation using the javadoc tool.

+

The source directory will be recursively scanned for Java source files to process +but only those matching the inclusion rules, and not matching the exclusions rules +will be passed to the javadoc tool. This +allows wildcards to be used to choose between package names, reducing verbosity +and management costs over time. This task, however, has no notion of +"changed" files, unlike the javac task. This means +all packages will be processed each time this task is run. In general, however, +this task is used much less frequently.

+

NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the +same VM as Apache Ant without breaking functionality. For this reason, this task +always forks the VM. This overhead is not significant since javadoc is normally a heavy +application and will be called infrequently.

+

NOTE: the packagelist attribute allows you to specify the list of packages to +document outside of the Ant file. It's a much better practice to include everything +inside the build.xml file. This option was added in order to make it easier to +migrate from regular makefiles, where you would use this option of javadoc. +The packages listed in packagelist are not checked, so the task performs even +if some packages are missing or broken. Use this option if you wish to convert from +an existing makefile. Once things are running you should then switch to the regular +notation.

+ +

DEPRECATION: the javadoc2 task simply points to the javadoc task and it's +there for back compatibility reasons. Since this task will be removed in future +versions, you are strongly encouraged to use javadoc +instead.

+ +

In the table below, 1.2 means available if your current Java VM is +a 1.2 VM (but not 1.3 or later), 1.4+ for any VM of at least version 1.4, otherwise +any VM of at least version 1.2 is acceptable. JDKs <1.4 are no longer supported. +If you specify the executable attribute it is up to you +to ensure that this command supports the attributes you wish to use.

+ +

Note:
When generating the JavaDocs for classes which contains annotations +you maybe get a java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl. +This is due bug-6442982. The cause is that JavaDoc cannot find the implementations of used annotations. +The workaround is providing the jars with these implementations (like JAXBs @XmlType, ...) +to <javadoc> using classpath, classpathref attributes or nested +<classpath> element.

+ +

Note: many problems with running javadoc stem from command + lines that have become too long - even though the error message + doesn't give the slightest hint this may be the problem. If you + encounter problems with the task, try to set + the useexternalfile attribute to true + first.

+ +

If you use multiple ways to specify where javadoc should be looking + for sources your result will be the union of all specified + documentations. If you, e.g., specify a sourcepath attribute and + also a nested packageset both pointing at the same directory your + excludepackagenames attribute won't have any effect unless it agrees + with the exclude patterns of the packageset (and vice versa).

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionAvailabilityRequired
sourcepathSpecify where to find source filesallAt least one of the three or nested + <sourcepath>, <fileset> or + <packageset>
sourcepathrefSpecify where to find source files by reference to a PATH defined elsewhere.all
sourcefilesComma separated list of source files -- see also + the nested source element.all
destdirDestination directory for output filesallYes, unless a doclet has been specified.
maxmemoryMax amount of memory to allocate to the javadoc VMallNo
packagenamesComma separated list of package files (with terminating + wildcard) -- see also the nested package element.allNo
packageListThe name of a file containing the packages to processallNo
classpathSpecify where to find user class filesallNo
BootclasspathOverride location of class files loaded by the bootstrap + class loaderallNo
classpathrefSpecify where to find user class files by reference to a PATH defined elsewhere.allNo
bootclasspathrefOverride location of class files loaded by the + bootstrap class loader by reference to a + PATH defined elsewhere.allNo
ExtdirsOverride location of installed extensionsallNo
OverviewRead overview documentation from HTML fileallNo
accessAccess mode: one of public, protected, + package, or privateallNo (default protected)
PublicShow only public classes and membersallNo
ProtectedShow protected/public classes and members (default)allNo
PackageShow package/protected/public classes and membersallNo
PrivateShow all classes and membersallNo
OldGenerate output using JDK 1.1 emulating + doclet.
+ Note: as of Ant 1.8.0 this attribute doesn't have any + effect since the javadoc of Java 1.4 (required by Ant 1.8.0) + doesn't support the -1.1 switch anymore.		1.2No
VerboseOutput messages about what Javadoc is doingallNo
LocaleLocale to be used, e.g. en_US or en_US_WINallNo
EncodingSource file encoding nameallNo
VersionInclude @version paragraphsallNo
UseCreate class and package usage pagesallNo
AuthorInclude @author paragraphsallNo
SplitindexSplit index into one file per letterallNo
WindowtitleBrowser window title for the documentation (text)allNo
DoctitleInclude title for the package index(first) page (html-code)allNo
HeaderInclude header text for each page (html-code)allNo
FooterInclude footer text for each page (html-code)allNo
bottomInclude bottom text for each page (html-code)allNo
linkCreate links to javadoc output at the given URL + -- see also the nested link element.allNo
linkofflineLink to docs at <url> using package list at + <url2> - separate the URLs by using a space character -- see + also the nested link element.allNo
groupGroup specified packages together in overview + page. The format is as described below -- see also the nested + group element.allNo
nodeprecatedDo not include @deprecated informationallNo
nodeprecatedlistDo not generate deprecated listallNo
notreeDo not generate class hierarchyallNo
noindexDo not generate indexallNo
nohelpDo not generate help linkallNo
nonavbarDo not generate navigation barallNo
serialwarnGenerate warning about @serial tagallNo
helpfileSpecifies the HTML help file to useallNo
stylesheetfileSpecifies the CSS stylesheet to useallNo
charsetCharset for cross-platform viewing of generated + documentationallNo
docencodingOutput file encoding nameallNo
docletSpecifies the class file that starts the doclet + used in generating the documentation -- see also the nested + doclet element.allNo
docletpathSpecifies the path to the doclet class file that is specified with the -doclet option.allNo
docletpathrefSpecifies the path to the doclet class file that + is specified with the -doclet option by reference to a PATH defined elsewhere.allNo
additionalparamLets you add additional parameters to the javadoc + command line. Useful for doclets. Parameters containing spaces + need to be quoted using &quot; -- see also the nested + arg element.allNo
failonerrorStop the buildprocess if the command exits with a + returncode other than 0.allNo
excludepackagenamescomma separated list of packages you don't want + docs for -- see also the nested excludepackage element.allNo
defaultexcludesindicates whether default excludes should be used + (yes | no); default excludes are used when omitted.allNo
useexternalfileindicates whether the sourcefile name specified + in srcfiles or as nested source elements should be written to a + temporary file to make the command line shorter. Also applies to + the package names specified via the packagenames attribute or + nested package elements. Since Ant 1.7.0, also applies + to all the other command line options. + (yes | no). Default is no.allNo
sourceNecessary to enable javadoc to handle assertions + present in J2SE v 1.4 source code. Set this to "1.4" to + documents code that compiles using "javac -source + 1.4".
+ A default value for this attribute can be provided using the magic + ant.build.javac.source + property.		1.4+No
linksourceGenerate hyperlinks to source files. + since Ant 1.6. + (yes | no). Default is no.1.4+No
breakiteratorUse the new breakiterator algorithm. + since Ant 1.6. + (yes | no). Default is no.1.4+No
noqualifierEnables the -noqualifier argument - + must be all or a colon separated list of packages. + since Ant 1.6.1.4+No
includenosourcepackagesIf set to true, packages that don't contain Java + source but a package.html will get documented as well. + since Ant 1.6.3.allNo (default is false)
executableSpecify a particular javadoc executable + to use in place of the default binary (found in the same JDK as Ant is running in). + since Ant 1.6.3.allNo
docfilessubdirsEnables deep-copying of doc-files + subdirectories. Defaults to false. since Ant 1.8.0.1.4No
excludedocfilessubdirColon-separated list of doc-files' + subdirectories to exclude if docfilessubdirs is + true. since Ant 1.8.0.1.4No
+ +

Format of the group attribute

+

The arguments are comma-delimited. Each single argument is 2 +space-delimited strings, where the first one is the group's title and +the second one a colon delimited list of packages.

+

If you need to specify more than one group, or a group whose title +contains a comma or a space character, using nested group elements is highly +recommended.

+

E.g.:

+
    group="XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*"
+ +

Parameters specified as nested elements

+ +

packageset

+ +

A DirSet. All matched +directories that contain Java source files will be passed to javadoc +as package names. Package names are created from the directory names +by translating the directory separator into dots. Ant assumes the +base directory of the packageset points to the root of a package +hierarchy.

+ +

The packagenames, excludepackagenames and +defaultexcludes attributes of the task have no effect on +the nested <packageset> elements.

+ +

fileset

+ +

A FileSet. All matched +files will be passed to javadoc as source files. Ant will +automatically add the include pattern **/*.java (and +**/package.html if includenosourcepackages is true) to +these filesets.

+ +

Nested filesets can be used to document sources that are in the +default package or if you want to exclude certain files from +documentation. If you want to document all source files and don't use +the default package, packagesets should be used instead as this +increases javadocs performance.

+ +

The packagenames, excludepackagenames and +defaultexcludes attributes of the task have no effect on +the nested <fileset> elements.

+ +

sourcefiles

+ +

A container for arbitrary file system based resource +collections. All files contained in any of the nested collections +(this includes nested filesets, filelists or paths) will be passed to +javadoc as source files.

+ +

package

+

Same as one entry in the list given by packagenames.

+ +
Parameters
+ + + + + + + + + + + +
AttributeDescriptionRequired
nameThe package name (may be a wildcard)Yes
+ +

excludepackage

+

Same as one entry in the list given by excludepackagenames.

+ +
Parameters
+Same as for package. + +

source

+

Same as one entry in the list given by sourcefiles.

+ +
Parameters
+ + + + + + + + + + + +
AttributeDescriptionRequired
fileThe source file to documentYes
+ +

doctitle

+ +

Same as the doctitle attribute, but you can nest text +inside the element this way.

+ +

If the nested text contains line breaks, you must use the + useexternalfile attribute and set it to true.

+ +

header

+ +

Similar to <doctitle>.

+ +

footer

+ +

Similar to <doctitle>.

+ +

bottom

+ +

Similar to <doctitle>.

+ +

link

+

Create link to javadoc output at the given URL. This performs the +same role as the link and linkoffline attributes. You can use either +syntax (or both at once), but with the nested elements you can easily +specify multiple occurrences of the arguments.

+ +
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
hrefThe URL for the external documentation you wish + to link to. This can be an absolute URL, or a relative file + name.Yes
offlineTrue if this link is not available online at the time of + generating the documentationNo
packagelistLocThe location to the directory containing the package-list file for + the external documentationOne of the two if the offline attribute is true
packagelistURLThe URL of the the directory containing the package-list file for + the external documentation
resolveLinkIf the link attribute is a relative file name, + Ant will first try to locate the file relative to the current + project's basedir and if it finds a file there use an absolute URL + for the link attribute, otherwise it will pass the file name + verbatim to the javadoc command.No, default is false.
+ +

group

+

Separates packages on the overview page into whatever groups you +specify, one group per table. This performs the same role as the group +attribute. You can use either syntax (or both at once), but with the +nested elements you can easily specify multiple occurrences of the +arguments.

+ +
Parameters
+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
titleTitle of the groupYes, unless nested <title> given
packagesList of packages to include in that group. Multiple packages are separated with ':'.Yes, unless nested <package>s given
+ +

The title may be specified as a nested <title> element +with text contents, and the packages may be listed with nested +<package> elements as for the main task.

+ +

doclet

+

The doclet nested element is used to specify the +doclet +that javadoc will use to process the input source files. A number of the standard javadoc arguments +are actually arguments of the standard doclet. If these are specified in the javadoc +task's attributes, they will be passed to the doclet specified in the +<doclet> nested element. Such attributes should only be specified, +therefore, if they can be interpreted by the doclet in use.

+ +

If the doclet requires additional parameters, these can be specified with +<param> elements within the <doclet> +element. These parameters are restricted to simple strings. An example usage +of the doclet element is shown below:

+ +
  <javadoc ... >
+     <doclet name="theDoclet"
+             path="path/to/theDoclet">
+        <param name="-foo" value="foovalue"/>
+        <param name="-bar" value="barvalue"/>
+     </doclet>
+  </javadoc>
+
+ +

tag

+ +

If you want to specify a standard tag using a nested tag element +because you want to determine the order the tags are output, you must +not set the description attribute for those tags.

+ +
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameName of the tag (e.g. todo)Yes, unless the dir attribute is specified.
descriptionDescription for tag (e.g. To do:) + No, the javadoc executable will pick a default if this is not specified. +
enabledWhether or not the tag is enabled (defaults to true)No
scopeScope for the tag - the elements in which it can be used. This + is a comma separated list of some of the elements: overview, + packages, types, constructors, + methods, fields or the default, all.No
dirIf this attribute is specified, this element will behave as an implicit + fileset. The files included by this fileset should + contain each tag definition on a separate line, as described in the + Javadoc reference guide: + 
ejb.bean:t:XDoclet EJB Tag
+todo:a:To Do
+ Note: The Javadoc reference quide has double quotes around +the description part of the definition. This will not work when used in +a file, as the definition is quoted again when given to +the javadoc program. +
+ Note: If this attribute is specified, all the other attributes in this + element will be ignored. + 		No
+ +

taglet

+

The taglet nested element is used to specify custom + taglets.

+ +
Parameters
+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the taglet class + (e.g. + com.sun.tools.doclets.ToDoTaglet)Yes
pathA path specifying the search path for the taglet class + (e.g. /home/taglets). + The path may also be specified by a nested <path> elementNo
+ +

sourcepath, classpath and bootclasspath

+

Javadoc's sourcepath, classpath and +bootclasspath attributes are PATH like +structure and can also be set via nested sourcepath, +classpath and bootclasspath elements +respectively.

+ +

arg

+ +

Use nested <arg> to specify additional +arguments. See Command line +arguments. Since Ant 1.6

+ +

Example

+
  <javadoc packagenames="com.dummy.test.*"
+           sourcepath="src"
+           excludepackagenames="com.dummy.test.doc-files.*"
+           defaultexcludes="yes"
+           destdir="docs/api"
+           author="true"
+           version="true"
+           use="true"
+           windowtitle="Test API">
+    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+    <tag name="todo" scope="all" description="To do:"/>
+    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
+    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
+  </javadoc>
+ +

is the same as

+ +
  <javadoc
+           destdir="docs/api"
+           author="true"
+           version="true"
+           use="true"
+           windowtitle="Test API">
+
+    <packageset dir="src" defaultexcludes="yes">
+      <include name="com/dummy/test/**"/>
+      <exclude name="com/dummy/test/doc-files/**"/>
+    </packageset>
+
+    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+    <tag name="todo" scope="all" description="To do:"/>
+    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
+    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
+  </javadoc>
+ +

or

+ +
  <javadoc
+           destdir="docs/api"
+           author="true"
+           version="true"
+           use="true"
+           windowtitle="Test API">
+
+    <fileset dir="src" defaultexcludes="yes">
+      <include name="com/dummy/test/**"/>
+      <exclude name="com/dummy/test/doc-files/**"/>
+    </fileset>
+
+    <doctitle><![CDATA[<h1>Test</h1>]]></doctitle>
+    <bottom><![CDATA[<i>Copyright &#169; 2000 Dummy Corp. All Rights Reserved.</i>]]></bottom>
+    <tag name="todo" scope="all" description="To do:"/>
+    <group title="Group 1 Packages" packages="com.dummy.test.a*"/>
+    <group title="Group 2 Packages" packages="com.dummy.test.b*:com.dummy.test.c*"/>
+    <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="C:\tmp"/>
+    <link href="http://developer.java.sun.com/developer/products/xml/docs/api/"/>
+  </javadoc>
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/javah.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/javah.html new file mode 100644 index 000000000..306499f81 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/javah.html @@ -0,0 +1,243 @@ + + + + + + +Javah Task + + + + +

Javah

+

Description

+

Generates JNI headers from a Java class.

+

When this task executes, it will generate the C header and source files that +are needed to implement native methods. JNI operates differently depending on +whether JDK1.2 +(or later) or pre-JDK1.2 +systems are used.

+ +

It is possible to use different compilers. This can be selected +with the implementation attribute or a nested element. Here are the choices of the attribute:

+
    +
  • default - the default compiler (kaffeh or sun) for the platform.
    • +
  • sun (the standard compiler of the JDK)
    • +
  • kaffeh (the native standard compiler of Kaffe)
    • +
  • gcjh (the native standard compiler + of gcj and gij) since Apache Ant 1.8.2
    • +
+ +

Note: if you are using this task to work on multiple files + the command line may become too long on some operating systems. + Unfortunately the javah command doesn't support command argument + files the way javac (for example) does, so all that can be done is + breaking the amount of classes to compile into smaller chunks.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
classthe fully-qualified name of the class (or classes, + separated by commas)Yes
outputFileconcatenates the resulting header or source files for all the classes listed into this fileYes
destdirsets the directory where javah saves the header files or the + stub files.
forcespecifies that output files should always be written (JDK1.2 only)No
oldspecifies that old JDK1.0-style header files should be generated + (otherwise output file contain JNI-style native method function prototypes) (JDK1.2 only)No
stubsgenerate C declarations from the Java object file (used with old)No
verbosecauses Javah to print a message concerning the status of the generated filesNo
classpaththe classpath to use.No
bootclasspathlocation of bootstrap class files.No
extdirs location of installed extensions.No
implementationThe compiler implementation to use. If this + attribute is not set, the default compiler for the current VM + will be used. (See the above list of valid compilers.)No
+

Either outputFile or destdir must be supplied, but not both. 

+ +

Parameters specified as nested elements

+ +

arg

+ +

You can specify additional command line arguments for the compiler +with nested <arg> elements. These elements are +specified like Command-line Arguments +but have an additional attribute that can be used to enable arguments +only if a given compiler implementation will be used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
valueSee + Command-line Arguments.Exactly one of these.
line
file
path
prefixSee + Command-line Arguments. + Since Ant 1.8.No
suffixNo
implementationOnly pass the specified argument if the chosen compiler + implementation matches the value of this attribute. Legal values + are the same as those in the above list of valid compilers.)No
+ +

implementationclasspath since Ant 1.8.0

+ +

A PATH like structure holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.

+ +

Any nested element of a type that implements JavahAdapter + since Ant 1.8.0

+ +

If a defined type implements the JavahAdapter + interface a nested element of that type can be used as an + alternative to the implementation attribute.

+ +

Examples

+
  <javah destdir="c" class="org.foo.bar.Wibble"/>
+

makes a JNI header of the named class, using the JDK1.2 JNI model. Assuming +the directory 'c' already exists, the file org_foo_bar_Wibble.h +is created there. If this file already exists, it is left unchanged.

+
  <javah outputFile="wibble.h">
+    <class name="org.foo.bar.Wibble,org.foo.bar.Bobble"/>
+  </javah>
+

is similar to the previous example, except the output is written to a file +called wibble.h +in the current directory.

+
  <javah destdir="c" force="yes">
+    <class name="org.foo.bar.Wibble"/>
+    <class name="org.foo.bar.Bobble"/>
+    <class name="org.foo.bar.Tribble"/>
+  </javah>
+

writes three header files, one for each of the classes named. Because the +force option is set, these header files are always written when the Javah task +is invoked, even if they already exist.

+
  <javah destdir="c" verbose="yes" old="yes" force="yes">
+    <class name="org.foo.bar.Wibble"/>
+    <class name="org.foo.bar.Bobble"/>
+    <class name="org.foo.bar.Tribble"/>
+  </javah>
+  <javah destdir="c" verbose="yes" stubs="yes" old="yes" force="yes">
+    <class name="org.foo.bar.Wibble"/>
+    <class name="org.foo.bar.Bobble"/>
+    <class name="org.foo.bar.Tribble"/>
+  </javah>
+

writes the headers for the three classes using the 'old' JNI format, then +writes the corresponding .c stubs. The verbose option will cause Javah to +describe its progress.

+ +

If you want to use a custom + JavahAdapter org.example.MyAdapter you can either + use the implementation attribute:

+
+<javah destdir="c" class="org.foo.bar.Wibble"
+       implementation="org.example.MyAdapter"/>
+
+

or a define a type and nest this into the task like in:

+
+<componentdef classname="org.example.MyAdapter"
+              name="myadapter"/>
+<javah destdir="c" class="org.foo.bar.Wibble">
+  <myadapter/>
+</javah>
+
+

in which case your javah adapter can support attributes and + nested elements of its own.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jdepend.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jdepend.html new file mode 100644 index 000000000..7a9639da3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jdepend.html @@ -0,0 +1,177 @@ + + + + + + +JDepend Task + + + + + + +

JDepend

+ +

Description

+ +

Invokes the JDepend parser.

+ +

This parser "traverses a set of Java source file directories and generates design quality metrics for each Java package". +It allows to "automatically measure the quality of a design in terms of its extensibility, reusability, and maintainability to +effectively manage and control package dependencies."

+ +

Source file directories are defined by nested +<sourcespath>; Class file directories are defined +by nested <classesespath>, see nested elements.

+ +

Optionally, you can also set the outputfile name where the output is stored. By default the task writes its report to the standard output.

+ +

The task requires at least the JDepend 1.2 version.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
outputfileThe output file name. If not set, the output is printed on the standard output.No
formatThe format to write the output in. The default is "text", the alternative is "xml"No
forkRun the tests in a separate VM.No, default is "off"
haltonerrorStop the build process if an error occurs during the jdepend analysis.No, default is "off"
timeoutCancel the operation if it doesn't finish in the given time (measured in milliseconds). (Ignored if fork is disabled.)No
jvmThe command used to invoke the Java Virtual Machine, default is 'java'. The command is resolved by java.lang.Runtime.exec(). (Ignored if fork is disabled.)No, default "java"
dirThe directory to invoke the VM in. (Ignored if fork is disabled)No
includeruntimeImplicitly add the classes required to run jdepend + in forked mode. (Ignored if fork is disabled). Since Apache Ant 1.6.No, default is "no".
classpathrefthe classpath to use, given as reference to a PATH defined elsewhere.No
+ +

Nested Elements

+ +

jdepend supports four nested elements: +<classpath>, <classespath> and +<sourcespath>, that represent PATH like structures, and +<exclude>.

+ +

<sourcespath> is used to define the paths of the +source code to analyze, but it is deprecated. With version 2.5 of +JDepend, only class files are analyzed. The nested element +<classespath> replaces <sourcespath> and is used to define +the paths of compiled class code to analyze; the <sourcespath> +variable is still available in case you are using an earlier version +of JDepend. The <exclude> element can be used to set packages +to ignore (requires JDepend 2.5 or above).

+ +

Examples

+ +
+
+<jdepend classpathref="base.path">
+    <classespath>
+        <pathelement location="build"/>
+    </classespath>
+</jdepend>
+
+
+
+ +

This invokes JDepend on the build directory, writing +the output on the standard output. The classpath is defined using a +classpath reference.

+ +
+
+<jdepend outputfile="docs/jdepend.xml" fork="yes" format="xml">
+    <sourcespath>
+        <pathelement location="src"/>
+    </sourcespath>
+    <classpath>
+        <pathelement location="classes"/>
+        <pathelement location="lib/jdepend.jar"/>
+    </classpath>
+</jdepend>
+
+
+ +

This invokes JDepend in a separate VM on the src and +testsrc directories, writing the output to the +<docs/jdepend.xml> file in xml format. The +classpath is defined using nested elements.

+ +
+
+<jdepend classpathref="base.path">
+    <exclude name="java.*>
+    <exclude name="javax.*>
+    <classespath>
+        <pathelement location="build"/>
+    </classespath>
+</jdepend>
+
+
+ +

This invokes JDepend with the build directory as the base for class +files to analyze, and will ignore all classes in the java.* and +javax.* packages.

+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jjdoc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jjdoc.html new file mode 100644 index 000000000..fdecc9e3f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jjdoc.html @@ -0,0 +1,116 @@ + + + + + + + +JJDoc Task + + + +

+JJDoc

+

Since Apache Ant 1.6

+

Description

+ +

Invokes the JJDoc preprocessor +for the JavaCC compiler compiler. It takes a JavaCC parser specification +and produces documentation for the BNF grammar. +It can operate in three modes, determined by command line options. +

To use the jjdoc task, set the target attribute to the name +of the JavaCC grammar file to process. You also need to specify the directory +containing the JavaCC installation using the javacchome attribute, +so that ant can find the JavaCC classes. Optionally, you can also set the +outputfile to write the generated BNF documentation file to a specific (directory and) file. +Otherwise jjdoc writes the generated BNF documentation file as the JavaCC +grammar file with a suffix .txt or .html.

+

This task only invokes JJDoc if the grammar file is newer than the +generated BNF documentation file.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetThe javacc grammar file to process.Yes
javacchomeThe directory containing the JavaCC distribution.Yes
outputfileThe file to write the generated BNF documentation file to. If not set, +the file is written with the same name as the JavaCC grammar file but with a the suffix .html or .txt. No
textSets the TEXT BNF documentation option. This is a boolean +option.No
onetableSets the ONE_TABLE BNF documentation option. This is a boolean option.No
+ +

+Example

+ +
+
<jjdoc 
+    target="src/Parser.jj" 
+    outputfile="doc/ParserBNF.html"
+    javacchome="c:/program files/JavaCC" 
+/>
+
+This invokes JJDoc on grammar file src/Parser.jj, writing the generated +BNF documentation file, ParserBNF.html, file to doc. +
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jjtree.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jjtree.html new file mode 100644 index 000000000..4787faad6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jjtree.html @@ -0,0 +1,556 @@ + + + + + + + +JJTree Task + + + +

+JJTree

+ +

+Description

+

Invokes the JJTree preprocessor +for the JavaCC compiler compiler. It inserts parse tree building actions +at various places in the JavaCC source that it generates. The output of +JJTree is run through JavaCC to create the parser. +

To use the jjtree task, set the target attribute to the name +of the JJTree grammar file to process. You also need to specify the directory +containing the JavaCC installation using the javacchome attribute, +so that Ant can find the JavaCC classes. Optionally, you can also set the +outputdirectory +to write the generated JavaCC grammar and node files to a specific directory. +Otherwise jjtree writes the generated JavaCC grammar and node files to the directory +containing the JJTree grammar file. As an extra option, you can also set the +outputfile to write the generated JavaCC grammar file to a specific (directory and) file. +Otherwise jjtree writes the generated JavaCC grammar file as the JJTree +grammar file with a suffix .jj.

+

This task only invokes JJTree if the grammar file is newer than the +generated JavaCC file.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetThe jjtree grammar file to process.Yes
javacchomeThe directory containing the JavaCC distribution.Yes
outputdirectoryThe directory to write the generated JavaCC grammar and node files to. +If not set, the files are written to the directory containing the grammar file. No
outputfileThe file to write the generated JavaCC grammar file +to. If not set, the file is written with the same name as the JJTree +grammar file but with a the suffix .jj. This is a +filename relative to outputdirectory if specified, the +project's basedir.No
buildnodefilesSets the BUILD_NODE_FILES grammar option. This is a boolean +option.No
multiSets the MULTI grammar option. This is a boolean option.No
nodedefaultvoidSets the NODE_DEFAULT_VOID grammar option. This is a boolean +option.No
nodefactorySets the NODE_FACTORY grammar option. This is boolean option.No
nodescopehookSets the NODE_SCOPE_HOOK grammar option. This is a boolean +option.No
nodeusesparserSets the NODE_USES_PARSER grammar option. This is a boolean +option.No
staticSets the STATIC grammar option. This is a boolean option.No
visitorSets the VISITOR grammar option. This is a boolean option.No
nodepackageSets the NODE_PACKAGE grammar option. This is a string option.No
visitorexceptionSets the VISITOR_EXCEPTION grammar option. This is a string +option.No
nodeprefixSets the NODE_PREFIX grammar option. This is a string option.No
+ +

+Example

+ +
+
<jjtree 
+    target="src/Parser.jjt" 
+    outputdirectory="build/src"
+    javacchome="c:/program files/JavaCC" 
+    nodeusesparser="true"
+/>
+
+This invokes JJTree on grammar file src/Parser.jjt, writing the generated +grammar file, Parser.jj, file to build/src. The grammar option NODE_USES_PARSER +is set to true when invoking JJTree. +
+ +

Comparison output locations between command line JJTree and different Ant taskdef versions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Command Line JJTree options +
     and Generated Files (working directory: /tmp)		Ant 1.5.3 versus command lineAnt 1.6 versus command line
jjtree  grammar.jjt
+    /tmp/grammar.jj
+    /tmp/<generated>.java
+ 		SameSame
jjtree  relative/grammar.jjt
+    /tmp/grammar.jj
+    /tmp/<generated>.java
+ 
+/tmp/relative/grammar.jj
+/tmp/relative/<generated>.java
+ 		Same
jjtree  /tmp/absolute/grammar.jjt
+    /tmp/grammar.jj
+    /tmp/<generated>.java
+ 
+/tmp/absolute/grammar.jj
+/tmp/absolute/<generated>.java
+ 		Same
jjtree  -OUTPUT_DIRECTORY:relative  grammar.jjt
+    /tmp/relative/grammar.jj
+    /tmp/relative/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_DIRECTORY:relative  relative/grammar.jjt
+    /tmp/relative/grammar.jj
+    /tmp/relative/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_DIRECTORY:relative  /tmp/absolute/grammar.jjt
+    /tmp/relative/grammar.jj
+    /tmp/relative/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_DIRECTORY:/tmp/absolute/  grammar.jjt
+    /tmp/absolute/grammar.jj
+    /tmp/absolute/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_DIRECTORY:/tmp/absolute/  relative/grammar.jjt
+    /tmp/absolute/grammar.jj
+    /tmp/absolute/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_DIRECTORY:/tmp/absolute/  /tmp/absolute/grammar.jjt
+    /tmp/absolute/grammar.jj
+    /tmp/absolute/<generated>.java
+ 		SameSame
jjtree  -OUTPUT_FILE:output.jj  grammar.jjt
+    /tmp/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  relative/grammar.jjt
+    /tmp/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  /tmp/absolute/grammar.jjt
+    /tmp/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:relative  grammar.jjt
+    /tmp/relative/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:relative  relative/grammar.jjt
+    /tmp/relative/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:relative  /tmp/absolute/grammar.jjt
+    /tmp/relative/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  grammar.jjt
+    /tmp/absolute/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  relative/grammar.jjt
+    /tmp/absolute/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  /tmp/absolute/grammar.jjt
+    /tmp/absolute/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  relative/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  /tmp/absolute/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:relative  grammar.jjt
+    /tmp/relative/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:relative  relative/grammar.jjt
+    /tmp/relative/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:relative  /tmp/absolute/grammar.jjt
+    /tmp/relative/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  grammar.jjt
+    /tmp/absolute/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  relative/grammar.jjt
+    /tmp/absolute/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  /tmp/absolute/grammar.jjt
+    /tmp/absolute/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  relative/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  /tmp/absolute/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:D:/tmp/subdir/output.jj  grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedNot Supported *)
jjtree  -OUTPUT_FILE:D:/tmp/subdir/output.jj  relative/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedNot Supported *)
jjtree  -OUTPUT_FILE:D:/tmp/subdir/output.jj  /tmp/absolute/grammar.jjt
+    /tmp/subdir/output.jj
+    /tmp/<generated>.java
+ 		Not SupportedNot Supported *)
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:relative  grammar.jjt
+    /tmp/relative/tmp/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:relative  relative/grammar.jjt
+    /tmp/relative/tmp/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:relative  /tmp/absolute/grammar.jjt
+    /tmp/relative/tmp/subdir/output.jj
+    /tmp/relative/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  grammar.jjt
+    /tmp/absolute/tmp/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  relative/grammar.jjt
+    /tmp/absolute/tmp/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
jjtree  -OUTPUT_FILE:/tmp/subdir/output.jj  -OUTPUT_DIRECTORY:/tmp/absolute/  /tmp/absolute/grammar.jjt
+    /tmp/absolute/tmp/subdir/output.jj
+    /tmp/absolute/<generated>.java
+ 		Not SupportedSame
+ +

*) Footnote: When running JJTree with the Ant taskdef jjtree the option -OUTPUT_DIRECTORY must always +be set, because the project's basedir and the Ant working directory might differ. So even if you don't specify the jjtree taskdef +outputdirectory JJTree will be called with the -OUTPUT_DIRECTORY set to the project's basedirectory. +But when the -OUTPUT_DIRECTORY is set, the -OUTPUT_FILE setting is handled as if relative to this +-OUTPUT_DIRECTORY. Thus when the -OUTPUT_FILE is absolute or contains a drive letter we have a +problem. +Therefore absolute outputfiles (when the outputdirectory isn't specified) are made relative to the default directory. +And for this reason outputfiles that contain a drive letter can't be supported.

+ +

By the way: specifying a drive letter in the -OUTPUT_FILE when the -OUTPUT_DIRECTORY is set, also +results in strange behavior when running JJTree from the command line.

+ +
+ + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jlink.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jlink.html new file mode 100644 index 000000000..45ef96152 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jlink.html @@ -0,0 +1,177 @@ + + + + +JLink Task + + + +

Jlink

+

Deprecated

+

This task has been deprecated. Use a zipfileset + or zipgroupfileset with the + Jar task or Zip task + instead.

+ +

Description:

+

Links entries from sub-builds and libraries.

+ +

The jlink task can be used to build jar and zip files, similar to +the jar task. +However, jlink provides options for controlling the way entries from +input files +are added to the output file. Specifically, capabilities for merging +entries from +multiple zip or jar files is available.

+ +

If a mergefile is specified directly (eg. at the top level of a +mergefiles +pathelement) and the mergefile ends in ".zip" or +".jar", +entries in the mergefile will be merged into the outfile. A file with +any other extension +will be added to the output file, even if it is specified in the +mergefiles element. +Directories specified in either the mergefiles or addfiles element +are added to the +output file as you would expect: all files in subdirectories are +recursively added to +the output file with appropriate prefixes in the output file +(without merging). +

+ +

+In the case where duplicate entries and/or files are found among the +files to be merged or +added, jlink merges or adds the first entry and ignores all subsequent entries. +

+ +

+jlink ignores META-INF directories in mergefiles. Users should supply their +own manifest information for the output file. +

+ +

It is possible to refine the set of files that are being jlinked. +This can be +done with the includes, includesfile, excludes, +excludesfile, +and defaultexcludes attributes on the addfiles and +mergefiles +nested elements. With the includes or includesfile +attribute you specify the files you want to have included by using patterns. +The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. The patterns are +relative to the base directory.

+ + + +

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
outfilethe path of the output file.Yes
compresswhether or not the output should be compressed. +true, + yes, or on result in compressed output. + If omitted, output will be uncompressed (inflated).No
mergefilesfiles to be merged into the output, if possible.At least one of +mergefiles or addfiles
addfilesfiles to be added to the output.
+ +

Examples

+ +

The following will merge the entries in mergefoo.jar and mergebar.jar +into out.jar. +mac.jar and pc.jar will be added as single entries to out.jar.

+
+<jlink compress="false" outfile="out.jar">
+   <mergefiles>
+     <pathelement path="${build.dir}/mergefoo.jar"/>
+     <pathelement path="${build.dir}/mergebar.jar"/>
+   </mergefiles>
+   <addfiles>
+     <pathelement path="${build.dir}/mac.jar"/>
+     <pathelement path="${build.dir}/pc.zip"/>
+   </addfiles>
+</jlink>
+
+ +

Non-deprecated alternative to the above:

+
+<jar compress="false" destfile="out.jar">
+  <zipgroupfileset dir="${build.dir}">
+    <include name="mergefoo.jar"/>
+    <include name="mergebar.jar"/>
+  </zipgroupfileset>
+  <fileset dir="${build.dir}">
+    <include name="mac.jar"/>
+    <include name="pc.jar"/>
+  </fileset>
+</jar>
+
+ +

Suppose the file foo.jar contains two entries: bar.class and +barnone/myClass.zip. +Suppose the path for file foo.jar is build/tempbuild/foo.jar. The +following example +will provide the entry tempbuild/foo.jar in the out.jar.

+
+<jlink compress="false" outfile="out.jar">
+   <mergefiles>
+     <pathelement path="build/tempbuild"/>
+   </mergefiles>
+</jlink>
+
+ +

However, the next example would result in two top-level entries in out.jar, +namely bar.class and barnone/myClass.zip

+
+<jlink compress="false" outfile="out.jar">
+   <mergefiles>
+     <pathelement path="build/tempbuild/foo.jar"/>
+   </mergefiles>
+</jlink>
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/jspc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/jspc.html new file mode 100644 index 000000000..052fc41ff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/jspc.html @@ -0,0 +1,308 @@ + + + + + + +JSPC Task + + + + +

jspc (deprecated)

+

Description

+ +

Apache Ant task to run the JSP compiler and turn JSP pages into Java source. + +

Deprecated if you use this task with Tomcat's Jasper JSP +compiler, you should seriously consider using the task shipping with +Tomcat instead. This task is only tested against Tomcat 4.x. There +are known problems with Tomcat 5.x that won't get fixed in Ant, please +use Tomcat's jspc task instead.
+Instead of relying on container specific JSP-compilers we suggest deploying +the raw files (*.jsp) and use the container build-in functions: after deploying run +a test suite (e.g. with Cactus or +HttpUnit) against the deployed web +application. So you'll get the test result and the compiled JSPs. +

+ +

+ +This task can be used to precompile JSP pages for fast initial invocation +of JSP pages, deployment on a server without the full JDK installed, +or simply to syntax check the pages without deploying them. +In most cases, a javac task is usually the next stage in the build process. +The task does basic dependency checking to prevent unnecessary recompilation -this +checking compares source and destination timestamps, and does not factor +in class or taglib dependencies, or <jsp:include> references. + +

+By default the task uses the Jasper JSP compiler. This +means the task needs jasper.jar and jasper-runtime.jar, which come with +builds of Tomcat 4/Catalina from the +Jakarta Tomcat project, +and any other Jar files which may be needed in future versions (it changes) + +We recommend (in March 2003) Tomcat version 4.1.x for the most robust version +of Jasper. + +

+There are many limitations with this task which partially stem from the +many versions of Jasper, others from implementation 'issues' in the task +(i.e. nobody's willingness to radically change large bits of it to work +around jasper). Because of this and the fact that JSP pages do not have +to be portable across implementations -or versions of implementations- +this task is better used for validating JSP pages before deployment, +rather than precompiling them. For that, just deploy and run your httpunit +junit tests after deployment to compile and test your pages, all in one +go. + +

+ + +

Parameters

+The Task has the following attributes:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
destdirWhere to place the generated files. They are located + under here according to the given package name.Yes
srcdirWhere to look for source jsp files.Yes
verboseThe verbosity integer to pass to the compiler. Default="0"No
packageName of the destination package for generated java + classes.No
compilerclass name of a JSP compiler adapter, + such as "jasper" or "jasper41"No -defaults to "jasper"
iepluginJava Plugin classid for Internet Explorer.No
mapped(boolean) Generate separate write() calls for each HTML + line in the JSP.No
classpathThe classpath to use to run the jsp compiler. + This can also be specified + by the nested element classpath + Path).No, but it seems to work better when used
classpathrefA Reference. As + per classpathNo
failonerrorflag to control action on compile failures: default=yesNo
uribase + The uri context of relative URI + references in the JSP pages. If it does not + exist then it is derived from the location of the file + relative to the declared or derived value of uriroot. + No
uriroot + The root directory that uri files should be resolved + against. + No
compiler + Class name of jsp compiler adapter to use. Defaults to + the standard adapter for Jasper. + No
compilerclasspathThe classpath used to find the compiler adapter specified + by the compiler attribute.No
webincOutput file name for the fraction of web.xml that lists servlets.No
webxmlFile name for web.xml to be generatedNo
+ +

The mapped option will, if set to true, split the JSP text content into a +one line per call format. There are comments above and below the mapped +write calls to localize where in the JSP file each line of text comes +from. This can lead to a minor performance degradation (but it is bound +by a linear complexity). Without this options all adjacent writes are +concatenated into a single write.

+ +

The ieplugin option is used by the <jsp:plugin> tags. +If the Java Plug-in COM Class-ID you want to use changes then it can be +specified here. This should not need to be altered.

+ +

uriroot specifies the root of the web +application. This is where all absolute uris will be resolved from. +If it is not specified then the first JSP page will be used to derive +it. To derive it each parent directory of the first JSP page is +searched for a WEB-INF directory, and the directory closest to +the JSP page that has one will be used. If none can be found then the +directory Jasperc was called from will be used. This only affects pages +translated from an explicitly declared JSP file -including references +to taglibs

+ +

uribase is used to establish the uri context of +relative URI references in the JSP pages. If it does not exist then it +is derived from the location of the file relative to the declared or +derived value of uriroot. This only affects pages +translated from an explicitly declared JSP file.

+ +

Parameters specified as nested elements

+ +This task is a directory based task, like +javac, so the jsp files to be compiled are located as java +files are by javac. That is, elements such as includes and +excludes can be used directly inside the task declaration. + +

+ +Elements specific to the jspc task are:- + +

classpath

+ +The classpath used to compile the JSP pages, specified as for any other +classpath. + +

classpathref

+a reference to an existing classpath + +

webapp

+Instructions to jasper to build an entire web application. +The base directory must have a WEB-INF subdirectory beneath it. +When used, the task hands off all dependency checking to the compiler. + + + + + + + + + + + +
AttributeDescriptionRequired
basedirthe base directory of the web applicationYes
+

Example

+
+<jspc srcdir="${basedir}/src/war"
+      destdir="${basedir}/gensrc"
+      package="com.i3sp.jsp"
+      compiler="jasper41"
+      verbose="9">
+  <include name="**/*.jsp"/>
+</jspc>
+
+Build all jsp pages under src/war into the destination /gensrc, in a +package hierarchy beginning with com.i3sp.jsp. +
+<jspc
+      destdir="interim"
+      verbose="1"
+      srcdir="src"
+      compiler="jasper41"
+      package="com.i3sp.jsp">
+  <include name="**/*.jsp"/>
+</jspc>
+<depend
+         srcdir="interim"
+         destdir="build"
+         cache="build/dependencies"
+         classpath="lib/taglibs.jar"/>
+<javac
+         srcdir="interim"
+         destdir="build"
+         classpath="lib/taglibs.jar"
+         debug="on"/>
+
+Generate jsp pages then javac them down to +bytecodes. Include lib/taglib jar in the java compilation. + Dependency checking is used to scrub the +java files if class dependencies indicate it is needed. + +

Notes

+Using the package attribute it is possible to identify the resulting +java files and thus do full dependency checking - this task should only rebuild +java files if their jsp file has been modified. However, this only works +with some versions of jasper. By default the checking supports tomcat 4.0.x +with the "jasper" compiler, set the compiler to "jasper41" for the tomcat4.1.x +dependency checking. +Even when it does work, changes in +.TLD imports or in compile time includes do not get picked up. + +

+Jasper generates JSP pages against the JSP1.2 specification -a copy of +version 2.3 of the servlet specification is needed on the classpath to +compile the Java code. + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/junit.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/junit.html new file mode 100644 index 000000000..f3894c2f0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/junit.html @@ -0,0 +1,768 @@ + + + + +JUnit Task + + + +

JUnit

+

Description

+ +

This task runs tests from the JUnit testing framework. The latest +version of the framework can be found at +http://www.junit.org. +This task has been tested with JUnit 3.0 up to JUnit 3.8.2; it won't +work with versions prior to JUnit 3.0. It also works with JUnit 4.0, including +"pure" JUnit 4 tests using only annotations and no JUnit4TestAdapter.

+

Note: This task depends on external libraries not included +in the Apache Ant distribution. See +Library Dependencies for more information. +

+

+Note: +You must have junit.jar available. +You can do one of: +

+
    +
  1. +Put both junit.jar and ant-junit.jar in +ANT_HOME/lib. +
    2. +
  2. +Do not put either in ANT_HOME/lib, and instead +include their locations in your CLASSPATH environment variable. +
    3. +
  3. +Add both JARs to your classpath using -lib. +
    4. +
  4. +Specify the locations of both JARs using +a <classpath> element in a <taskdef> in the build file. +
    5. +
  5. +Leave ant-junit.jar in its default location in ANT_HOME/lib +but include junit.jar in the <classpath> passed +to <junit>. (since Ant 1.7) +
    6. +
+

+See the +FAQ for details. +

+ +

Tests are defined by nested test or +batchtest tags (see nested +elements).

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
printsummaryPrint one-line statistics for each testcase. Can + take the values on, + off, and + withOutAndErr. + withOutAndErr is the same + as on but also includes the output of the test + as written to System.out and System.err.No; default is off.
forkRun the tests in a separate VM.No; default is off.
forkmodeControls how many Java Virtual Machines get + created if you want to fork some tests. Possible values are + "perTest" (the default), "perBatch" and + "once". "once" creates only a single Java VM + for all tests while "perTest" creates a new VM for each + TestCase class. "perBatch" creates a VM for each nested + <batchtest> and one collecting all nested + <test>s. Note that only tests with the same + settings of filtertrace, haltonerror, + haltonfailure, errorproperty and + failureproperty can share a VM, so even if you set + forkmode to "once", Ant may have to create + more than a single Java VM. This attribute is ignored for tests + that don't get forked into a new Java VM. since Ant 1.6.2No; default is perTest.
haltonerrorStop the build process if an error occurs during the test + run.No; default is off.
errorpropertyThe name of a property to set in the event of an error.No
haltonfailureStop the build process if a test fails (errors are + considered failures as well).No; default is off.
failurepropertyThe name of a property to set in the event of a failure + (errors are considered failures as well).No.
filtertraceFilter out Junit and Ant stack frames from error and failure stack traces.No; default is on.
timeoutCancel the individual tests if they don't finish + in the given time (measured in milliseconds). Ignored if + fork is disabled. When running multiple tests + inside the same Java VM (see forkMode), timeout applies to the + time that all tests use together, not to an individual + test.No
maxmemoryMaximum amount of memory to allocate to the forked VM. + Ignored if fork is disabled. Note: + If you get java.lang.OutOfMemoryError: Java heap space + in some of your tests then you need to raise the size like + maxmemory="128m"No
jvmThe command used to invoke the Java Virtual Machine, + default is 'java'. The command is resolved by + java.lang.Runtime.exec(). + Ignored if fork is disabled.No; default is java.
dirThe directory in which to invoke the VM. Ignored if + fork is disabled.No
newenvironmentDo not propagate the old environment when new + environment variables are specified. Ignored if fork is + disabled.No; default is false.
includeantruntimeImplicitly add the Ant classes required to run + the tests and JUnit to the classpath in forked mode. + No; default is true.
showoutputSend any output generated by tests to Ant's + logging system as well as to the formatters. By default only the + formatters receive the output.No
outputtoformatters + Since Ant 1.7.0.
+ Send any output generated by tests to the test formatters. + This is "true" by default. + 		No
tempdirWhere Ant should place temporary files. + Since Ant 1.6.No; default is the project's base + directory.
reloadingWhether or not a new classloader should be instantiated for each test case.
+ Ignore if fork is set to true. + Since Ant 1.6.		No; default is true.
clonevmIf set to true true, then all system properties + and the bootclasspath of the forked Java Virtual Machine will be + the same as those of the Java VM running Ant. Default is + "false" (ignored if fork is disabled). + since Ant 1.7No
logfailedtestsWhen Ant executes multiple tests and doesn't stop + on errors or failures it will log a "FAILED" message for each + failing test to its logging system. If you set this option to + false, the message will not be logged and you have to rely on the + formatter output to find the failing tests. + since Ant 1.8.0No
enableTestListenerEventsWhether Ant should send fine grained information + about the running tests to Ant's logging system at the verbose + level. Such events may be used by custom test listeners to show + the progress of tests.
+ Defaults to false.
+ Can be overridden by a magic + property.
+ since Ant 1.8.2 - Ant 1.7.0 to 1.8.1 behave as + if this attribute was true by default.		No
+ +

By using the errorproperty and failureproperty +attributes, it is possible to +perform setup work (such as starting an external server), execute the test, +clean up, and still fail the build in the event of a failure.

+ +

The filtertrace attribute condenses error and failure +stack traces before reporting them. +It works with both the plain and XML formatters. It filters out any lines +that begin with the following string patterns:

+   "junit.framework.TestCase"
+   "junit.framework.TestResult"
+   "junit.framework.TestSuite"
+   "junit.framework.Assert."
+   "junit.swingui.TestRunner"
+   "junit.awtui.TestRunner"
+   "junit.textui.TestRunner"
+   "java.lang.reflect.Method.invoke("
+   "sun.reflect."
+   "org.apache.tools.ant."
+   "org.junit."
+   "junit.framework.JUnit4TestAdapter"
+ +

Nested Elements

+ +

The <junit> task +supports a nested <classpath> +element that represents a PATH like +structure.

+ +

As of Ant 1.7, this classpath may be used to refer to junit.jar +as well as your tests and the tested code. + +

jvmarg

+ +

If fork is enabled, additional parameters may be passed to +the new VM via nested <jvmarg> elements. For example:

+ +
+<junit fork="yes">
+  <jvmarg value="-Djava.compiler=NONE"/>
+  ...
+</junit>
+
+ +

would run the test in a VM without JIT.

+ +

<jvmarg> allows all attributes described in Command-line Arguments.

+ +

sysproperty

+ +

Use nested <sysproperty> elements to specify system +properties required by the class. These properties will be made available +to the VM during the execution of the test (either ANT's VM or the forked VM, +if fork is enabled). +The attributes for this element are the same as for environment variables.

+ +
+<junit fork="no">
+  <sysproperty key="basedir" value="${basedir}"/>
+  ...
+</junit>
+
+ +

would run the test in ANT's VM and make the basedir property +available to the test.

+ +

syspropertyset

+ +

You can specify a set of properties to be used as system properties +with syspropertysets.

+ +

since Ant 1.6.

+ +

env

+ +

It is possible to specify environment variables to pass to the +forked VM via nested <env> elements. For a description +of the <env> element's attributes, see the +description in the exec task.

+ +

Settings will be ignored if fork is disabled.

+ +

bootclasspath

+ +

The location of bootstrap class files can be specified using this +PATH like structure - will be ignored +if fork is not true or the target VM doesn't +support it (i.e. Java 1.1).

+ +

since Ant 1.6.

+ +

permissions

+

Security permissions can be revoked and granted during the execution of the +class via a nested permissions element. For more information please +see permissions

+ +

Settings will be ignored if fork is enabled.

+ +

since Ant 1.6.

+ +

assertions

+ +

You can control enablement of Java 1.4 assertions with an +<assertions> +subelement.

+ +

Assertion statements are currently ignored in non-forked mode.

+ +

since Ant 1.6.

+ +

formatter

+ +

The results of the tests can be printed in different +formats. Output will always be sent to a file, unless you set the +usefile attribute to false. +The name of the file is determined by the +name of the test and can be set by the outfile attribute +of <test>.

+ +

There are four predefined formatters - one prints the test results +in XML format, the other emits plain text. The formatter named +brief will only print detailed information for testcases +that failed, while plain gives a little statistics line +for all test cases. Custom formatters that need to implement +org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +can be specified.

+ +

If you use the XML formatter, it may not include the same output +that your tests have written as some characters are illegal in XML +documents and will be dropped.

+ +

The fourth formatter named failure (since Ant 1.8.0) +collects all failing testXXX() +methods and creates a new TestCase which delegates only these +failing methods. The name and the location can be specified via Java System property or Ant property +ant.junit.failureCollector. The value has to point to the directory and +the name of the resulting class (without suffix). It defaults to java-tmp-dir/FailedTests.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
typeUse a predefined formatter (either + xml, plain, brief or failure).Exactly one of these.
classnameName of a custom formatter class.
extensionExtension to append to the output filename.Yes, if classname has been used.
usefileBoolean that determines whether output should be + sent to a file.No; default is true.
ifOnly use formatter if the named property is set.No; default is true.
unlessOnly use formatter if the named property is not set.No; default is true.
+ +

test

+ +

Defines a single test class.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameName of the test class.Yes
methodsComma-separated list of names of test case methods to execute. + Since 1.8.2 +

The methods attribute can be useful in the following scenarios:

+
    +
  • A test method has failed and you want to re-run the test method + to test a fix or re-run the test under the Java debugger without + having to wait for the other (possibly long running) test methods + to complete.
    • +
  • One or more test methods are running slower than expected and you + want to re-run them under a Java profiler (without the overhead + of running the profiler whilst other test methods are being + executed).
    • +
+

If the methods attribute is used but no test method + is specified, then no test method from the suite will be executed.

+ 		No; default is to run all test methods in the suite.
forkRun the tests in a separate VM. + Overrides value set in <junit>.No
haltonerrorStop the build process if an error occurs during the test + run. Overrides value set in <junit>.No
errorpropertyThe name of a property to set in the event of an error. + Overrides value set in <junit>.No
haltonfailureStop the build process if a test fails (errors are + considered failures as well). Overrides value set in + <junit>.No
failurepropertyThe name of a property to set in the event of a failure + (errors are considered failures as well). Overrides value set in + <junit>.No
filtertraceFilter out Junit and Ant stack frames from error and failure stack + traces. Overrides value set in <junit>.No; default is on.
todirDirectory to write the reports to.No; default is the current directory.
outfileBase name of the test result. The full filename is + determined by this attribute and the extension of + formatter.No; default is + TEST-name, where name is the name of + the test specified in the name attribute.
ifOnly run test if the named property is set.No
unlessOnly run test if the named property is not set.No
+ +

Tests can define their own formatters via nested +<formatter> elements.

+ +

batchtest

+ +

Define a number of tests based on pattern matching.

+ +

batchtest collects the included resources from any number +of nested Resource Collections. It then +generates a test class name for each resource that ends in +.java or .class.

+ +

Any type of Resource Collection is supported as a nested element, +prior to Ant 1.7 only <fileset> has been +supported.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
forkRun the tests in a separate VM. + Overrides value set in <junit>.No
haltonerrorStop the build process if an error occurs during the test + run. Overrides value set in <junit>.No
errorpropertyThe name of a property to set in the event of an error. + Overrides value set in <junit>.No
haltonfailureStop the build process if a test fails (errors are + considered failures as well). Overrides value set in + <junit>.No
failurepropertyThe name of a property to set in the event of a failure + (errors are considered failures as well). Overrides value set in + <junit>No
filtertraceFilter out Junit and Ant stack frames from error and failure stack + traces. Overrides value set in <junit>.No; default is on.
todirDirectory to write the reports to.No; default is the current directory.
ifOnly run tests if the named property is set.No
unlessOnly run tests if the named property is not set.No
+ +

Batchtests can define their own formatters via nested +<formatter> elements.

+ +

Forked tests and tearDown

+ +

If a forked test runs into a timeout, Ant will terminate the Java + VM process it has created, which probably means the + test's tearDown method will never be called. The same + is true if the forked VM crashes for some other reason.

+ +

Starting with Ant 1.8.0, a special formatter is distributed with + Ant that tries to load the testcase that was in the forked VM and + invoke that class' tearDown method. This formatter has + the following limitations:

+ +
    +
  • It runs in the same Java VM as Ant itself, this is a different + Java VM than the one that was executing the test and it may see a + different classloader (and thus may be unable to load the tast + class).
    • +
  • It cannot determine which test was run when the timeout/crash + occured if the forked VM was running multiple test. I.e. the + formatter cannot work with any forkMode other + than perTest and it won't do anything if the test + class contains a suite() method.
    • +
+ +

If the formatter recognizes an incompatible forkMode + or a suite method or fails to load the test class it + will silently do nothing.

+ +

The formatter doesn't have any effect on tests that were not + forked or didn't cause timeouts or VM crashes.

+ +

To enable the formatter, add a formatter like

+ +
+<formatter classname="org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash"
+           usefile="false"/>
+
+ +

to your junit task.

+ +

ant.junit.enabletestlistenerevents + magic property

+ +

Since Ant 1.8.2 the enableTestListenerEvents + attribute of the task controls whether fine grained logging messages + will be sent to the task's verbose log. In addition to this + attribute Ant will consult the + property ant.junit.enabletestlistenerevents and the + value of the property overrides the setting of the attribute.

+ +

This property exists so that containers running Ant that depend on + the additional logging events can ensure they will be generated even + if the build file disables them.

+ +

Examples

+ +
+<junit>
+  <test name="my.test.TestCase"/>
+</junit>
+
+ +

Runs the test defined in my.test.TestCase in the same +VM. No output will be generated unless the test fails.

+ +
+<junit printsummary="yes" fork="yes" haltonfailure="yes">
+  <formatter type="plain"/>
+  <test name="my.test.TestCase"/>
+</junit>
+
+ +

Runs the test defined in my.test.TestCase in a +separate VM. At the end of the test, a one-line summary will be +printed. A detailed report of the test can be found in +TEST-my.test.TestCase.txt. The build process will be +stopped if the test fails.

+ +
+<junit printsummary="yes" haltonfailure="yes">
+  <classpath>
+    <pathelement location="${build.tests}"/>
+    <pathelement path="${java.class.path}"/>
+  </classpath>
+
+  <formatter type="plain"/>
+
+  <test name="my.test.TestCase" haltonfailure="no" outfile="result">
+    <formatter type="xml"/>
+  </test>
+
+  <batchtest fork="yes" todir="${reports.tests}">
+    <fileset dir="${src.tests}">
+      <include name="**/*Test*.java"/>
+      <exclude name="**/AllTests.java"/>
+    </fileset>
+  </batchtest>
+</junit>
+
+ +

Runs my.test.TestCase in the same VM, ignoring the +given CLASSPATH; only a warning is printed if this test fails. In +addition to the plain text test results, for this test a XML result +will be output to result.xml. +Then, for each matching file in the directory defined for +${src.tests} a +test is run in a separate VM. If a test fails, the build process is +aborted. Results are collected in files named +TEST-name.txt and written to +${reports.tests}.

+ +
+<target name="test">
+    <property name="collector.dir" value="${build.dir}/failingTests"/>
+    <property name="collector.class" value="FailedTests"/>
+    <!-- Delete 'old' collector classes -->
+    <delete>
+        <fileset dir="${collector.dir}" includes="${collector.class}*.class"/>
+    </delete>
+    <!-- compile the FailedTests class if present --> 
+    <javac srcdir="${collector.dir}" destdir="${collector.dir}"/>
+    <available file="${collector.dir}/${collector.class}.class" property="hasFailingTests"/>
+    <junit haltonerror="false" haltonfailure="false">
+        <sysproperty key="ant.junit.failureCollector" value="${collector.dir}/${collector.class}"/>
+        <classpath>
+            <pathelement location="${collector.dir}"/>
+        </classpath>
+        <batchtest todir="${collector.dir}" unless="hasFailingTests">
+            <fileset dir="${collector.dir}" includes="**/*.java" excludes="**/${collector.class}.*"/>
+            <!-- for initial creation of the FailingTests.java -->
+            <formatter type="failure"/>
+            <!-- I want to see something ... -->
+            <formatter type="plain" usefile="false"/>
+        </batchtest>
+        <test name="FailedTests" if="hasFailingTests">
+            <!-- update the FailingTests.java -->
+            <formatter type="failure"/>
+            <!-- again, I want to see something -->
+            <formatter type="plain" usefile="false"/>
+        </test>
+    </junit>
+</target>
+
+

On the first run all tests are collected via the <batchtest/> +element. It's plain formatter shows the output on the console. The +failure formatter creates a java source file in +${build.dir}/failingTests/FailedTests.java which extends +junit.framework.TestCase and returns from a suite() +method a test suite for the failing tests.
+On a second run the collector class exists and instead of the <batchtest/> +the single <test/> will run. So only the failing test cases are re-run. +The two nested formatters are for displaying (for the user) and for updating the collector +class. +

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/junitreport.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/junitreport.html new file mode 100644 index 000000000..cdf171e2e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/junitreport.html @@ -0,0 +1,205 @@ + + + + +JUnitReport Task + + + + +

JUnitReport

+Merge the individual XML files generated by the JUnit task and eventually apply +a stylesheet on the resulting merged document to provide a browsable report of +the testcases results. +

Note: This task depends on external libraries not included in +the Apache Ant distribution. See +Library Dependencies for more information.

+ +

Requirements

+ +

The task needs Apache Xalan 2.4.1+ or Xalan XSLTC +(JDK 1.4 contains a version of Xalan-J 2.x while JDK 1.5 ships with a +version of XSLTC). Starting from JDK 1.4.2-01 it ships with a bundled +Xalan-J 2.4.1+, meaning that JDK version prior to 1.4.2-01 won't work +out of the box. The table below summarize the compatibility status. +

+ + + + + +
XalanSun JDK BundleStatus
2.4.1+JDK 1.4.2-01+OK
XSLTCJDK 1.5.xOK
2.xJDK 1.4.xDEPRECATED
Use ${ant.home}/etc/junit-frames-xalan1.xsl +
Upgrade Xalan using the JDK endorsement mechanism
+ +

With Ant 1.6.2 we had to decide between supporting Xalan-J 1/Xalan J 2.4.1- +and Xalan 2.4.1+/XSLTC, since there was no way to support both couples at the same +time.

+

With Ant 1.7 we had to drop support Xalan-J 1, since Xalan-J 1 has not +available anymore for quite some time.

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
tofileThe name of the XML file that will aggregate all individual + XML testsuite previously generated by the JUnit task.No. Default to TESTS-TestSuites.xml
todirThe directory where should be written the file resulting + from the individual XML testsuite aggregation.No. Default to current directory
+

Nested Elements

+

fileset

+

junitreport collects individual xml files generated by the JUnit +task using the nested <FileSet> +element.

+

report

+

Generate a browsable report based on the document created by the merge.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
formatThe format of the generated report. Must be "noframes" + or "frames".No, default to "frames"
styledirThe directory where the stylesheets are defined. They must + be conforming to the following conventions: +
    +
  • frames format: the stylesheet must be named junit-frames.xsl.
    • +
  • noframes format: the stylesheet must be named junit-noframes.xsl.
    • +
+ 		No. Default to embedded stylesheets.
todirThe directory where the files resulting from the + transformation should be written to.No. Default to current directory
+

Ant assumes the following concerning the frames and noframes formats :

+

The frames format uses +a stylesheet which is generating output only by redirecting.

+

The +noframes format does not use redirecting and generates one +file called junit-noframes.html.

+

Custom versions of junit-frames.xsl or junit-noframes.xsl must adhere to the above conventions.

+ +

Nested Element of the report tag

+

param

+Since Ant 1.7the report tag supports nested param tags. +These tags can pass XSL parameters to the stylesheet. +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameName of the XSL parameterYes
expressionText value to be placed into the param.
+ Was originally intended to be an XSL expression.		Yes
ifThe param will only be passed if this property is set.No
unlessThe param will not be passed if this property is set.No
+ +

The built-in stylesheets support the following parameters:

+ + + + + + + + + + + +
XSL-ParameterDescriptionRequired
TITLETitle used in <title> and <h1> tagsNo. Defaults to Unit Test Results.
+ + + +

Example of report

+
+ 
<junitreport todir="./reports">
+  <fileset dir="./reports">
+    <include name="TEST-*.xml"/>
+  </fileset>
+  <report format="frames" todir="./report/html"/>
+</junitreport>
+
+
+

would generate a TESTS-TestSuites.xml file in the directory reports and +generate the default framed report in the directory report/html.

+

Example of report with xsl params

+
+ 
+<junitreport todir="${outputdir}">
+    <fileset dir="${jrdir}">
+        <include name="TEST-*.xml"/>
+    </fileset>
+    <report todir="${outputdir}/html"
+        styledir="junitreport"
+        format="frames">
+        <param name="key1" expression="value1"/>
+        <param name="key2" expression="value2"/>
+    </report>
+</junitreport>
+
+
+

This example requires a file called junitreport/junit-frames.xsl. + The XSL parameters key1 and key2 will be passed to the XSL transformation.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/length.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/length.html new file mode 100644 index 000000000..18c62c768 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/length.html @@ -0,0 +1,127 @@ + + + + + + +Length Task + + + + +

Length

+

Description

+

Display or set a property containing length information for + a string, a file, or one or more nested + Resource Collections. + Can also be used as a condition. Since Apache Ant 1.6.3

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe property to set. If omitted + the results are written to the log. Ignored when + processing as a condition.No
fileSingle file whose length to report.One of these, + or one or more nested filesets
resourceSingle resource whose length to report (using extended + properties handling). + Since Ant 1.8.1 +
stringThe string whose length to report.
modeFile length mode; when "all" the resulting + value is the sum of all included resources' lengths; when "each" + the task outputs the absolute path and length of each included resource, + one per line. Ignored when processing as a condition.No; default is "all"
trimWhether to trim when operating on a string. Default false.No; only valid when string is set
lengthComparison length for processing as a condition.Yes, in condition mode
whenComparison type: "equal", "eq", "greater", "gt", "less", + "lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal) + for use when operating as a condition.No; default is "equal"
+ +

Parameters specified as nested elements

+ +

Resource Collections

+

You can include resources via nested + Resource Collections.

+ +

Examples

+ +
<length string="foo" property="length.foo" />
+
+

Stores the length of the string "foo" in the property named +length.foo.

+ +
<length file="bar" property="length.bar" />
+
+

Stores the length of file "bar" in the property named +length.bar.

+ +
+<length property="length" mode="each">
+    <fileset dir="." includes="foo,bar"/>
+</length>
+
+

Writes the file paths of foo and bar and their length into +the property length.

+ +
+<length property="length" mode="all">
+    <fileset dir="." includes="foo,bar"/>
+</length>
+
+

Adds the length of foo and bar and stores the result in property length.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/loadfile.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadfile.html new file mode 100644 index 000000000..59291ed3a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadfile.html @@ -0,0 +1,133 @@ + + + + +LoadFile Task + + + + + +

LoadFile

+

Description

+

+Specialization of loadresource that +works on files exclusively and provides a srcFile attribute for +convenience. Unless an encoding is specified, the encoding of the +current locale is used. +

+

If the resource content is empty (maybe after processing a filterchain) +the property is not set.

+ + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcFilesource fileYes
propertyproperty to save toYes
encodingencoding to use when loading the fileNo
failonerrorWhether to halt the build on failureNo, default "true"
quietDo not display a diagnostic message (unless Apache Ant has been + invoked with the -verbose or -debug + switches) or modify the exit status to reflect an error. Setting this to + "true" implies setting failonerror to "false". + Since Ant 1.7.0. + No, default "false"
+

+The LoadFile task supports nested +FilterChains. + +

Examples

+
    <loadfile property="message"
+      srcFile="message.txt"/>
+
+Load file message.txt into property "message"; an <echo> +can print this. This is identical to +
    <loadresource property="message">
+       <file file="message.txt"/>
+    </loadresource>
+
+

+ +
    <loadfile property="encoded-file"
+      srcFile="loadfile.xml"
+      encoding="ISO-8859-1"/>
+
+Load a file using the latin-1 encoding + +
    <loadfile
+      property="optional.value"
+      srcFile="optional.txt"
+      failonerror="false"/>
+
+Load a file, don't fail if it is missing (a message is printed, though) + +
    <loadfile
+      property="mail.recipients"
+      srcFile="recipientlist.txt">
+      <filterchain>
+        <striplinebreaks/>
+      </filterchain>
+    </loadfile>
+
+Load a property which can be used as a parameter for another task (in this case mail), +merging lines to ensure this happens. + +
    <loadfile
+      property="system.configuration.xml"
+      srcFile="configuration.xml">
+        <filterchain>
+          <expandproperties/>
+        </filterchain>
+    </loadfile>
+
+Load an XML file into a property, expanding all properties declared +in the file in the process. + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/loadproperties.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadproperties.html new file mode 100644 index 000000000..69fa23a6c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadproperties.html @@ -0,0 +1,140 @@ + + + + +LoadProperties Task + + + + + +

LoadProperties

+

Description

+

+Load a file's contents as Apache Ant properties. This is equivalent +to <property file|resource="..."/> except that it +supports nested <filterchain> elements. +Also if the file is missing, the build is halted with an error, rather +than a warning being printed. +

+ +

Note: the default value of this +task's prefixValues attribute is different from the +default value of the same attribute in +the <property> +task.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcFilesource fileOne of these or a + nested resource
resourcethe resource name of the property file
encodingencoding to use when loading the fileNo
classpaththe classpath to use when looking up a resource.No
classpathrefthe classpath to use when looking up a resource, + given as reference + to a <path> defined elsewhere..No
prefixPrefix to apply to loaded properties; + a "." is appended to the prefix if not specified. Since Ant 1.8.1No
prefixValuesWhether to apply the prefix when expanding the + right hand side of the properties. + Since Ant 1.8.2No (default=true)
+ +

Parameters specified as nested elements

+ +

any resource or single element +resource collection

+ +

The specified resource will be used as src. Since Ant 1.7

+ +

FilterChain

+ +

classpath

+ +

for use with the resource attribute.

+ +

Examples

+
    <loadproperties srcFile="file.properties"/>
+
+or +
+    <loadproperties>
+      <file file="file.properties"/>
+    </loadproperties>
+
+Load contents of file.properties as Ant properties. + +
    <loadproperties srcFile="file.properties">
+      <filterchain>
+        <linecontains>
+          <contains value="import."/>
+        </linecontains>
+      </filterchain>
+    </loadproperties>
+
+Read the lines that contain the string "import." +from the file "file.properties" and load them as +Ant properties. + +
+    <loadproperties>
+      <gzipresource>
+        <url url="http://example.org/url.properties.gz"/>
+      </gzipresource>
+    </loadproperties>
+
+Load contents of http://example.org/url.properties.gz, uncompress it +on the fly and load the contents as Ant properties. + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/loadresource.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadresource.html new file mode 100644 index 000000000..f2b20c06d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/loadresource.html @@ -0,0 +1,93 @@ + + + + +LoadResource Task + + + + + +

LoadResource

+ +

Since Apache Ant 1.7

+ +

Description

+

+Load a text resource into a single property. Unless an encoding is +specified, the encoding of the current locale is used. Resources to +load are specified as nested resource elements or single +element resource collections. If the resource content is empty (maybe after +processing a filterchain) the property is not set. +

+ +

Since properties are immutable, the task will not change the value + of an existing property.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyproperty to save toYes
encodingencoding to use when loading the resourceNo
failonerrorWhether to halt the build on failureNo, default "true"
quietDo not display a diagnostic message (unless Ant has been + invoked with the -verbose or -debug + switches) or modify the exit status to reflect an error. Setting this to + "true" implies setting failonerror to "false". + No, default "false"
+

+The LoadResource task supports nested +FilterChains. + +

Examples

+
+<loadresource property="homepage">
+  <url url="http://ant.apache.org/index.html"/>
+</loadresource>
+
+Load the entry point of Ant's homepage into property "homepage"; an +<echo> can print this. + +

For more examples see the loadfile task.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/local.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/local.html new file mode 100644 index 000000000..f8519903e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/local.html @@ -0,0 +1,186 @@ + + + + + + +Local Task + + + + +

Local

+

Description

+

Adds a local property to the current scope. Property scopes exist at Apache Ant's +various "block" levels. These include targets as well as the +Parallel and Sequential +task containers (including Macrodef bodies). A local +property at a given scope "shadows" properties of the same name at higher scopes, +including the global scope. Note that using the Local task at the global +level effectively makes the property local to the "anonymous target" in which +top-level operations are carried out; it will not be defined for other targets +in the buildfile. Since Ant 1.8

+ +

A property is made local if the <local> task + preceedes its definition. See the examples section.

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
nameThe property to declare in the current scopeYes
+ +

Examples

+ +

Temporarily shadow a global property's value

+ +
+    <property name="foo" value="foo"/>
+
+    <target name="step1">
+        <echo>Before local: foo is ${foo}</echo>
+        <local name="foo"/>
+        <property name="foo" value="bar"/>
+        <echo>After local: foo is ${foo}</echo>
+    </target>
+
+    <target name="step2" depends="step1">
+        <echo>In step2: foo is ${foo}</echo>
+    </target>
+
+ +

outputs

+ +
+step1:
+     [echo] Before local: foo is foo
+     [echo] After local: foo is bar
+
+step2:
+     [echo] In step2: foo is foo
+
+ +

here the local-task shadowed the global definition + of foo for the remainder of the target step1.

+ +

Creating thread local properties

+ +
+    <property name="foo" value="foo"/>
+
+    <parallel>
+        <echo>global 1: foo is ${foo}</echo>
+        <sequential>
+            <local name="foo"/>
+            <property name="foo" value="bar.1"/>
+            <echo>First sequential: foo is ${foo}</echo>
+        </sequential>
+        <sequential>
+            <sleep seconds="1"/>
+            <echo>global 2: foo is ${foo}</echo>
+        </sequential>
+        <sequential>
+            <local name="foo"/>
+            <property name="foo" value="bar.2"/>
+            <echo>Second sequential: foo is ${foo}</echo>
+        </sequential>
+        <echo>global 3: foo is ${foo}</echo>
+    </parallel>
+
+ +

outputs something similar to

+ +
+     [echo] global 3: foo is foo
+     [echo] global 1: foo is foo
+     [echo] First sequential: foo is bar.1
+     [echo] Second sequential: foo is bar.2
+     [echo] global 2: foo is foo
+
+ +

Use inside macrodef

+ +

This probably is where local can be applied in the most useful + way. If you needed a "temporary property" inside a macrodef in Ant + prior to Ant 1.8.0 you had to try to come up with a property name + that would be unique across macro invocations.

+ +

Say you wanted to write a macro that created the parent directory + of a given file. A naive approach would be:

+ +
+    <macrodef name="makeparentdir">
+        <attribute name="file"/>
+        <sequential>
+            <dirname property="parent" file="@{file}"/>
+            <mkdir dir="${parent}"/>
+        </sequential>
+    </macrodef>
+    <makeparentdir file="some-dir/some-file"/>
+
+ +

but this would create a global property "parent" on the first + invocation - and since properties are not mutable, any subsequent + invocation will see the same value and try to create the same + directory as the first invocation.

+ +

The recommendation prior to Ant 1.8.0 was to use a property name + based on one of the macro's attributes, like

+ +
+    <macrodef name="makeparentdir">
+        <attribute name="file"/>
+        <sequential>
+            <dirname property="parent.@{file}" file="@{file}"/>
+            <mkdir dir="${parent.@{file}}"/>
+        </sequential>
+    </macrodef>
+
+ +

Now invocations for different files will set different properties + and the directories will get created. Unfortunately this "pollutes" + the global properties space. In addition it may be hard to come up + with unique names in some cases.

+ +

Enter <local>:

+ +
+    <macrodef name="makeparentdir">
+        <attribute name="file"/>
+        <sequential>
+            <local name="parent"/>
+            <dirname property="parent" file="@{file}"/>
+            <mkdir dir="${parent}"/>
+        </sequential>
+    </macrodef>
+
+ +

Each invocation gets its own property name "parent" and there will + be no global property of that name at all.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/macrodef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/macrodef.html new file mode 100644 index 000000000..b2d53e67f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/macrodef.html @@ -0,0 +1,376 @@ + + + + + + + MacroDef Task + + + + +

MacroDef

+

Description

+

+ This defines a new task using a <sequential> + nested task as a template. Nested elements <attribute> and + <element> are used to specify attributes and elements of + the new task. These get substituted into the <sequential> + task when the new task is run. +

+

Note

+

+ You can also use prior defined attributes for default-values in + other attributes. See the examples. +

+

+ since Apache Ant 1.6 +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the new definition.Yes
uri + The uri that this definition should live in. + No
descriptionA description of the macrodef + (for documentation purposes only). + No
backtrace + This controls the error traceback if they is an + error detected when running the macro. If this is + set to true, there will be an error trackback, if false + there will not be one. Since Ant 1.7. + No; default true
+

Parameters specified as nested elements

+

attribute

+

+ This is used to specify attributes of the new task. The values + of the attributes get substituted into the templated task. + The attributes will be required attributes unless a default + value has been set. +

+

+ This attribute is placed in the body of the templated + task using a notation similar to the ant property notation + - @{attribute name}. (May be remembered as "put the substitution + AT this location"). +

+

+ The escape sequence @@ is used to escape @. This allows @{x} to be + placed in the text without substitution of x by using @@{x}. + This corresponds to the $$ escape sequence for properties. +

+

+ The case of the attribute is ignored, so @{myAttribute} is treated the + same as @{MyAttribute}. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the new attributeYes
default + The default value of the attribute. + No
description + This contains a description of the attribute. + since ant 1.6.1 + No
+

element

+

+ This is used to specify nested elements of the new task. + The contents of the nested elements of the task instance + are placed in the templated task at the tag name. +

+

+ The case of the element name is ignored. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the elementYes
optional + If true this nested element is optional. Default is + false - i.e the nested element is required in + the new task. + No
implicit + If true this nested element is implicit. This means that + any nested elements of the macrodef instance will be placed + in the element indicated by the name of this element. + There can only be one element if an element is implicit. + The default value is false. since ant 1.6.2 + No
description + This contains a description + informing the user what the contents of the element are expected to be. + since ant 1.6.1 + No
+

text

+

+ This is used to specify the treatment of text contents of the macro invocation. + If this element is not present, then any nested text in the macro invocation + will be an error. If the text element is present, then the name + becomes an attribute that gets set to the nested text of the macro invocation. + Since ant 1.6.1. +

+

+ The case of the text name is ignored. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the text attributeYes
optional + If true nested text in the macro is optional, default is "false". + No
trim + If true, the nested text is trimmed of white space, + default is "false". + No
description + This contains a description + informing the user what the nested text of the macro is expected + to be. + No
+ +

Examples

+

+ The following example defined a task called testing and + runs it. +

+
+
+<macrodef name="testing">
+   <attribute name="v" default="NOT SET"/>
+   <element name="some-tasks" optional="yes"/>
+   <sequential>
+      <echo>v is @{v}</echo>
+      <some-tasks/>
+   </sequential>
+</macrodef>
+
+<testing v="This is v">
+   <some-tasks>
+      <echo>this is a test</echo>
+   </some-tasks>
+</testing>
+
+
+

+ The following fragment defines a task called <call-cc> which + take the attributes "target", "link" and "target.dir" and the + nested element "cc-elements". The body of the task + uses the <cc> task from the + ant-contrib project. +

+
+
+<macrodef name="call-cc">
+   <attribute name="target"/>
+   <attribute name="link"/>
+   <attribute name="target.dir"/>
+   <element name="cc-elements"/>
+   <sequential>
+      <mkdir dir="${obj.dir}/@{target}"/>
+      <mkdir dir="@{target.dir}"/>
+         <cc link="@{link}" objdir="${obj.dir}/@{target}"
+             outfile="@{target.dir}/@{target}">
+            <compiler refid="compiler.options"/>
+            <cc-elements/>
+         </cc>
+      </sequential>
+</macrodef>
+
+
+

+ This then can be used as follows: +

+
+
+<call-cc target="unittests" link="executable"
+         target.dir="${build.bin.dir}">
+   <cc-elements>
+      <includepath location="${gen.dir}"/>
+      <includepath location="test"/>
+      <fileset dir="test/unittest" includes = "**/*.cpp"/>
+      <fileset dir="${gen.dir}" includes = "*.cpp"/>
+      <linker refid="linker-libs"/>
+   </cc-elements>
+</call-cc>
+
+
+

+ The following fragment shows <call-cc>, but this time + using an implicit element and with the link and target.dir arguments + having default values. +

+
+
+<macrodef name="call-cc">
+   <attribute name="target"/>
+   <attribute name="link" default="executable"/>
+   <attribute name="target.dir" default="${build.bin.dir}"/>
+   <element name="cc-elements" implicit="yes"/>
+   <sequential>
+      <mkdir dir="${obj.dir}/@{target}"/>
+      <mkdir dir="@{target.dir}"/>
+         <cc link="@{link}" objdir="${obj.dir}/@{target}"
+             outfile="@{target.dir}/@{target}">
+            <compiler refid="compiler.options"/>
+            <cc-elements/>
+         </cc>
+      </sequential>
+</macrodef>
+
+
+

+ This then can be used as follows, note that <cc-elements> + is not specified. +

+
+
+<call-cc target="unittests">
+   <includepath location="${gen.dir}"/>
+   <includepath location="test"/>
+   <fileset dir="test/unittest" includes = "**/*.cpp"/>
+   <fileset dir="${gen.dir}" includes = "*.cpp"/>
+   <linker refid="linker-libs"/>
+</call-cc>
+
+
+

+ The following shows the use of the text element. +

+
+
+<macrodef name="echotest">
+   <text name="text"/>
+   <sequential>
+      <echo>@{text}</echo>
+   </sequential>
+</macrodef>
+<echotest>
+   Hello world
+</echotest>
+
+
+

+ The following uses a prior defined attribute for setting the + default value of another. The output would be + one=test two=test. If you change the order of lines + *1 and *2 the output would be one=test two=@{one}, + because while processing the two-line the value for + one is not set. +

+
+
+<macrodef name="test">
+   <attribute name="one"/>                     *1
+   <attribute name="two" default="@{one}"/>    *2
+   <sequential>
+      <echo>one=@{one}   two=@{two}</echo>
+   </sequential>
+</macrodef>
+<test one="test"/>
+
+
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/mail.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/mail.html new file mode 100644 index 000000000..665911f06 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/mail.html @@ -0,0 +1,339 @@ + + + + + + +Mail Task + + + + +

Mail

+

Description

+

+ A task to send SMTP email. +

+

+ This task can send mail using either plain + text, UU encoding, or MIME format mail, depending on what is available. +

+

+ SMTP auth and SSL/TLS require JavaMail and are only available in MIME format. +

+

+ Attachments may be sent using nested + <attachments> elements, which are path-like structures. This means + any filesystem based resource or resource + collection can be used to point to attachments. Prior to Apache Ant 1.7 + only <fileset> has been supported as a nested + element, you can still use this directly without an + <attachments> container. +

+

+ Note: This task may depend on external libraries + that are not included in the Ant distribution. + See Library Dependencies + for more information. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fromEmail address of sender.Either a from attribute, or a <from> + element.
replytoReplyto email address.No
tolistComma-separated list of recipients.At least one of these, or the + equivalent elements.
cclistComma-separated list of recipients to carbon copy
bcclistComma-separated list of recipients to blind carbon copy +
messageMessage to send in the body of the email.One of these or a + <message> element.
messagefileFile to send as the body of the email. Property + values in the file will be expanded.
messagemimetypeThe content type of the message. The default is + text/plain.No
filesFiles to send as attachments to the email. Separate multiple + file names using a comma or space. You can also use <fileset> + elements to specify files.No
failonerrorflag to indicate whether to halt the build on + any error. The default value is true.No.
includefilenamesInclude filename(s) before file contents. + Valid only when the plain encoding is used. The default + value is false.No
mailhostHost name of the SMTP server. The default value is + localhost.No
mailportTCP port of the SMTP server. The default value is 25.No
useruser name for SMTP authYes, if SMTP auth is required on your SMTP server

+ the email message will be then sent using Mime and requires JavaMail
passwordpassword for SMTP authYes, if SMTP auth is required on your SMTP server

+ the email message will be then sent using Mime and requires JavaMail
ssl"true", "on" or "yes" accepted here

+ indicates whether you need TLS/SSL		No
encodingSpecifies the encoding to use for the content of the email. + Values are mime, uu, plain, or + auto. The default value is auto. + uu or plain are not compatible with SMTP authNo
charsetCharacter set of the email.
+ You can also set the charset in the message nested element.
+ These options are mutually exclusive.		No
subjectEmail subject line.No
ignoreInvalidRecipientsBoolean. Whether the task should try to send + the message to as many recipients as possible and should only + fail if neither is reachable. Since Ant 1.8.0.No, default is false
enableStartTLS"true", "on" or "yes" accepted here

+ whether the STARTTLS command used to switch to an encrypted + connection for authentication should be supported. Requires + JavaMail. Since Ant 1.8.0		No
+ +

Note regarding the attributes containing email addresses

+Since Ant 1.6, the attributes from, replyto, tolist, cclist, bcclist +can contain email addresses of the form : +
    +
  • address@xyz.com
    • +
  • name <address@xyz.com>
    • +
  • <address@xyz.com> name
    • +
  • (name) address@xyz.com
    • +
  • address@xyz.com (name)
    • +
+

You need to enter the angle brackets as XML entities +&gt; and &lt;.

+ +

Parameters specified as nested elements

+ +

to / cc / bcc / from/ replyto

+

Adds an email address element. It takes the following attributes:

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe display name for the address.No
addressThe email address.Yes
+ +

message

+ +

Specifies the message to include in the email body. It takes the following +attributes:

+ + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcThe file to use as the message.No
mimetypeThe content type to use for the message.No
charsetCharacter set of the message
+ You can also set the charset as attribute of the enclosing mail task.
+ These options are mutually exclusive.		No
+ +

If the src attribute is not specified, then text can be added +inside the <message> element. Property expansion will occur +in the message, whether it is specified as an external file or as text within +the <message> element.

+ +

header

+

Since Ant 1.7, arbitrary mail headers can be added by + specifying these attributes on one or more nested header elements:

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name associated with this mail header.Yes
valueThe value to assign to this mail header.Yes
+ +

It is permissible to duplicate the name attribute amongst multiple headers. +

+ +

Examples

+ +
+<mail from="me"
+      tolist="you"
+      subject="Results of nightly build"
+      files="build.log"/>
+
+ +

Sends an email from me to you with a subject of +Results of nightly build and includes the contents of the file +build.log in the body of the message.

+ +
+<mail mailhost="smtp.myisp.com" mailport="1025" subject="Test build">
+  <from address="config@myisp.com"/>
+  <replyto address="me@myisp.com"/>
+  <to address="all@xyz.com"/>
+  <message>The ${buildname} nightly build has completed</message>
+  <attachments>
+    <fileset dir="dist">
+      <include name="**/*.zip"/>
+    </fileset>
+  </attachments>
+</mail>
+
+ +

Sends an eMail from config@myisp.com to all@xyz.com with a subject of +Test Build. Replies to this email will go to me@myisp.com. +Any zip files from the dist directory are attached.  The +task will attempt to use JavaMail and fall back to UU encoding or no encoding in +that order depending on what support classes are available. ${buildname} +will be replaced with the buildname property's value.

+ +
+<property name="line2" value="some_international_message"/>
+<echo message="${line2}"/>
+
+<mail mailhost="somehost@xyz.com" mailport="25" subject="Test build"  charset="utf-8">
+  <from address="me@myist.com"/>
+  <to address="all@xyz.com"/>
+  <message>some international text:${line2}</message>
+</mail>
+
+ +

Sends an eMail from me@myisp.com to all@xyz.com with a subject of +Test Build, the message body being coded in UTF-8 + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/makeurl.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/makeurl.html new file mode 100644 index 000000000..bef63e28d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/makeurl.html @@ -0,0 +1,236 @@ + + + + + + Makeurl + Task + + + + + + + + + + + + + + + + + +
+ + + +
+ Makeurl + Task + + + + Apache Ant + +
+
+ + + + + + + + + + +
 
+ + + Description +
+This task takes one or more filenames and turns them into URLs, which it then assigns to a property. +Useful when setting up RMI or JNLP codebases, for example. +Nested filesets are supported; if present, these are turned into the URLs with the supplied separator between them (default: space). +

+

Examples:

+
+<makeurl file="${user.home}/.m2/repository" property="m2.repository.url"/>
+
+Sets the property m2.repository.url to the file: URL of the local Maven2 repository. +
+<makeurl property="codebase"><fileset dir="lib includes="*.jar"/></makeurl>
+
+Set the property codebase to the three URLs of the files provided as nested elements. +
+ + + + + + + + + + + + +
 
+ + + Parameters +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Attribute + + Description + + Type + + Requirement +
+ file + + name of a file to be converted into a URL + + File + + optional, if a nested fileset or path is supplied +
+ property + + name of a property to set to the URL + + String + + required +
+ separator + + separator for the multi-URL option + + String + + optional +
+ validate + + validate that every named file exists + + boolean + + optional; default: true +
+
+ + + + + + + + + + +
 
+ + + Parameters as nested elements +
+ + + + + +
 
+ + fileset (org.apache.tools.ant.types.FileSet) +
+ A fileset of JAR files to include in the URL list, each separated by the separator. + + + +
+ + + + + + +
 
+ + path (org.apache.tools.ant.types.Path) +
+ Add a path to the URL. All elements in the path will be converted to individual URL entries. + + + +
+ + +
+ + + +
+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/manifest.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/manifest.html new file mode 100644 index 000000000..0d275b21c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/manifest.html @@ -0,0 +1,197 @@ + + + + + + +Manifest Task + + + + +

Manifest

+

Description

+

Creates a manifest file.

+ +

This task can be used to write a Manifest file, optionally +replacing or updating an existing file.

+ + + +

Manifests are processed according to the +Jar +file specification.. Specifically, a manifest element consists of +a set of attributes and sections. These sections in turn may contain +attributes. Note in particular that this may result in manifest lines +greater than 72 bytes being wrapped and continued on the next +line.

+ +

+ The Apache Ant team regularly gets complaints that this task in generating invalid + manifests. By and large, this is not the case: we believe that we are following + the specification to the letter. The usual problem is that some third party + manifest reader is not following the same specification as well as they think + they should; we cannot generate invalid manifest files just because one + single application is broken. J2ME runtimes appear to be particularly troublesome. +

+ +

+ If you find that Ant generates manifests incompatible with your runtime, take + a manifest it has built, fix it up however you need and switch to using the <zip> + task to create the JAR, feeding in the hand-crafted manifest. +

+ + + +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe manifest-file to create/update.Yes
modeOne of "update" or "replace", default is "replace".No
encodingThe encoding used to read the existing manifest + when updating. The task will always use UTF-8 when writing the + manifest.No, defaults to UTF-8 encoding.
mergeClassPathAttributesWhether to merge the Class-Path attributes found + in different manifests (if updating). If false, only the + attribute of the most recent manifest will be preserved. + Since Ant 1.8.0. +
unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.		No, default is false
flattenAttributesWhether to merge attributes occuring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + Since Ant 1.8.0.No, default is false
+ +

Nested elements

+

attribute

+

One attribute for the manifest file. Those attributes that are +not nested into a section will be added to the "Main" section.

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namethe name of the attribute,
+ must match the regexp [A-Za-z0-9][A-Za-z0-9-_]*. + 		Yes
valuethe value of the attribute.Yes
+ + +

section

+

A manifest section - you can nest attribute elements into sections.

+ + + + + + + + + + + + +
AttributeDescriptionRequired
namethe name of the section.No, if omitted it will be assumed + to be the main section.
+ +

Examples

+ +
+  <manifest file="MANIFEST.MF">
+    <attribute name="Built-By" value="${user.name}"/>
+    <section name="common">
+      <attribute name="Specification-Title" value="Example"/>
+      <attribute name="Specification-Version" value="${version}"/>
+      <attribute name="Specification-Vendor" value="Example Organization"/>
+      <attribute name="Implementation-Title" value="common"/>
+      <attribute name="Implementation-Version" value="${version} ${TODAY}"/> 
+      <attribute name="Implementation-Vendor" value="Example Corp."/>
+    </section>
+    <section name="common/class1.class">
+      <attribute name="Sealed" value="false"/>
+    </section>
+  </manifest>
+
+ +

Creates or replaces the file MANIFEST.MF. Note that the Built-By +attribute will take the value of the Ant property ${user.name}. The +same is true for the ${version} and ${TODAY} properties. This example +produces a MANIFEST.MF that contains +package +version identification for the package common.

+ +

The manifest produced by the above would look like this:

+ +
Manifest-Version: 1.0
+Built-By: bodewig
+Created-By: Apache Ant 1.7
+
+Name: common
+Specification-Title: Example
+Specification-Vendor: Example Organization
+Implementation-Vendor: Example Corp.
+Specification-Version: 1.2
+Implementation-Version: 1.2 February 19 2006
+Implementation-Title: common
+
+Name: common/class1.class
+Sealed: false
+
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/manifestclasspath.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/manifestclasspath.html new file mode 100644 index 000000000..e3786e4bd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/manifestclasspath.html @@ -0,0 +1,112 @@ + + + + + + +ManifestClassPath Task + + + + +

Manifestclasspath

+ +

Description

+

Converts a Path into a property +whose value is appropriate for a Manifest's +Class-Path attribute.

+ +

This task is often used to work around command line limitations on Windows +when using very long class paths when launching an application. The long class +path normally specified on the command line is replaced by a single (possibly +empty) jar file which an in-manifest Class-Path attribute whose value lists +all the jar and zip files the class path should contain. The files referenced +from this attribute must be found relatively to the jar file itself, usually +in the same directory. The Java VM automically uses all file entries listed +in the Class-Path attributes of a jar to locate/load classes. Note though that +it silently ignores entries for which it cannot find any corresponding file.

+ +

Note that the property value created may be longer than a manifest's maximum +72 characters per line, but will be properly wrapped as per the Jar +specification by the <manifest> element, where the +defined property is re-referenced.

+ +

since Apache Ant 1.7

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertythe name of the property to set. This property must + not already be set.Yes
jarfile + the filename for the Jar which will contain the manifest that will + use the property this task will set. This file need not exist yet, + but its parent directory must exist. + Yes
maxParentLevels + The maximum number of parent directories one is allowed to traverse + to navigate from the jar file to the path entry. Put differently, the + maximum number of .. which is allowed in the relative path from the + jar file to a given class path enty. Specify 0 to enforce a path + entry to be in the same directory (or one of its sub-directories) + as the jar file itself. Defaults to 2 levels.No
+ +

Parameters specified as nested elements

+

classpath

+

A Path-like element, which can be +defined in-place, or refer to a path defined elsewhere using the +<classpath refid="pathid" /> syntax. +This classpath must not be empty, and is required.

+ +

Examples

+
+ 
+    <manifestclasspath property="jar.classpath"
+                       jarfile="build/acme.jar">
+      <classpath refid="classpath" />
+    </manifestclasspath>
+
+

Assuming a path of id "classpath" was already defined, convert this + path relatively to the build/ directory that will contain acme.jar, which + can later be created with <jar> with a nested + <manifest> element that lists an + <attribute name="Class-Path" value="${jar.classpath}" />. +

+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/mimemail.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/mimemail.html new file mode 100644 index 000000000..c0ec7b551 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/mimemail.html @@ -0,0 +1,115 @@ + + + + + + +MimeMail Task + + + + +

MimeMail

+ +

Deprecated

+

This task has been deprecated. Use the mail task instead.

+ +

Description

+

Sends SMTP mail with MIME attachments. +JavaMail +and Java +Activation Framework are required for this task.

+

Multiple files can be attached using FileSets.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
messageThe message bodyNo, but only one of of 'message' or + 'messageFile' may be specified.  If not specified, a fileset must be + provided.
messageFileA filename to read and used as the message body
messageMimeTypeMIME type to use for 'message' or 'messageFile' when + attached.No, defaults to "text/plain"
tolistComma-separated list of To: recipientsYes, at least one of 'tolist', 'cclist', + or 'bcclist' must be specified.
cclistComma-separated list of CC: recipients 
bcclistComma-separated list of BCC: recipients 
mailhostHost name of the mail server.No, default to "localhost"
subjectEmail subject line.No
fromEmail address of sender.Yes
failonerrorStop the build process if an error occurs sending the + e-mail.No, default to "true"
+

Examples

+

Send a single HTML file as the body of a message

+
    <mimemail messageMimeType="text/html" messageFile="overview-summary.html"
+        tolist="you" subject="JUnit Test Results: ${TODAY}" from="me"/>
+

Sends all files in a directory as attachments

+
    <mimemail message="See attached files" tolist="you" subject="Attachments" from="me">
+        <fileset dir=".">
+            <include name="dist/*.*"/>
+        </fileset>
+    </mimemail>
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/mkdir.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/mkdir.html new file mode 100644 index 000000000..5d945c0f1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/mkdir.html @@ -0,0 +1,52 @@ + + + + + + +Mkdir Task + + + + +

Mkdir

+

Description

+

Creates a directory. Also non-existent parent directories are created, when +necessary. Does nothing if the directory already exist.

+

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
dirthe directory to create.Yes
+

Examples

+
<mkdir dir="${dist}"/>
+

creates a directory ${dist}.

+
<mkdir dir="${dist}/lib"/>
+

creates a directory ${dist}/lib.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/move.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/move.html new file mode 100644 index 000000000..b47d59cd5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/move.html @@ -0,0 +1,236 @@ + + + + + + +Move Task + + + + +

Move

+

Description

+

Moves a file to a new file or directory, or collections of files to +a new directory. By default, the +destination file is overwritten if it already exists. When overwrite is +turned off, then files are only moved if the source file is newer than +the destination file, or when the destination file does not exist.

+ +

Resource +Collections are used to select a group of files to move. Only +file system based resource collections are supported, this includes filesets, filelist and path. Prior to Apache Ant 1.7 only +<fileset> has been supported as a nested element. +To use a resource collection, the todir attribute must be +set.

+ +

Since Ant 1.6.3, the file attribute may be used to move +(rename) an entire directory. If tofile denotes an existing file, or +there is a directory by the same name in todir, the action will fail. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filethe file or directory to moveOne of file or + at least one nested resource collection element
preservelastmodifiedGive the moved files the same last modified + time as the original source files. + (Note: Ignored on Java 1.1)No; defaults to false.
tofilethe file to move toWith the file attribute, + either tofile or todir can be used. With nested filesets, + if the fileset size is greater than 1 or if the only entry in the fileset is a + directory or if the file attribute is already specified, only + todir is allowed
todirthe directory to move to
overwriteoverwrite existing files even if the destination + files are newer (default is "true")No
forceOverwrite read-only destination + files. since Ant 1.8.2No; defaults to false.
filteringindicates whether token filtering should take place during + the move. See the filter task for a description of + how filters work.No
flattenignore directory structure of source directory, + copy all files into a single directory, specified by the todir + attribute (default is "false").Note that you can achieve the + same effect by using a flatten mapperNo
includeEmptyDirsCopy empty directories included with the nested FileSet(s). + Defaults to "yes".No
failonerrorIf false, log a warning message, but do not stop the + build, when the file to copy does not exist or one of the nested + filesets points to a directory that doesn't exist or an error occurs + while moving. + No; defaults to true.
verboseLog the files that are being moved.No; defaults to false.
encodingThe encoding to assume when filter-copying the + files. since Ant 1.5.No - defaults to default JVM encoding
outputencodingThe encoding to use when writing the files. + since Ant 1.6.No - defaults to the value of the encoding + attribute if given or the default JVM encoding otherwise.
enablemultiplemapping + If true the task will process to all the mappings for a + given source path. If false the task will only process + the first file or directory. This attribute is only relevant + if there is a mapper subelement. + since Ant 1.6.No - defaults to false.
granularityThe number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. since Ant + 1.6.
+

Parameters specified as nested elements

+

mapper

+

You can define file name transformations by using a nested mapper element. The default mapper used by +<move> is the identity.

+

Note that the source name handed to the mapper depends on the +resource collection you use. If you use <fileset> +or any other collection that provides a base directory, the name +passed to the mapper will be a relative filename, relative to the base +directory. In any other case the absolute filename of the source will +be used.

+

filterchain

+

The Move task supports nested +FilterChains.

+ +

+If <filterset> and <filterchain> elements are used inside the +same <move> task, all <filterchain> elements are processed first +followed by <filterset> elements. +

+ +

Examples

+

Move a single file (rename a file)

+
+  <move file="file.orig" tofile="file.moved"/>
+
+

Move a single file to a directory

+
+  <move file="file.orig" todir="dir/to/move/to"/>
+
+

Move a directory to a new directory

+
+  <move todir="new/dir/to/move/to">
+    <fileset dir="src/dir"/>
+  </move>
+
+ or, since Ant 1.6.3: +
+  <move file="src/dir" tofile="new/dir/to/move/to"/>
+
+

Move a set of files to a new directory

+
+  <move todir="some/new/dir">
+    <fileset dir="my/src/dir">
+      <include name="**/*.jar"/>
+      <exclude name="**/ant.jar"/>
+    </fileset>
+  </move>
+
+

Move a list of files to a new directory

+
+  <move todir="some/new/dir">
+    <filelist dir="my/src/dir">
+      <file name="file1.txt"/>
+      <file name="file2.txt"/>
+    </filelist>
+  </move>
+
+

Append ".bak" to the names of all files +in a directory.

+
+  <move todir="my/src/dir" includeemptydirs="false">
+    <fileset dir="my/src/dir">
+      <exclude name="**/*.bak"/>
+    </fileset>
+    <mapper type="glob" from="*" to="*.bak"/>
+  </move>
+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/native2ascii.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/native2ascii.html new file mode 100644 index 000000000..c50483b9f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/native2ascii.html @@ -0,0 +1,246 @@ + + + +Native2Ascii Task + +

Native2Ascii

+ +

Description:

+ +

+ Converts files from native encodings to ASCII with escaped Unicode. + A common usage is to convert source files maintained in a native + operating system encoding, to ASCII prior to compilation. +

+ +

+ Files in the directory src + are converted from a native encoding to ASCII. + By default, all files in the directory are converted. + However, conversion may be limited to selected files using + includes and excludes attributes. + For more information on file matching patterns, + see the section on + directory based tasks. + If no encoding is specified, + the default encoding for the JVM is used. + If ext is specified, then output files are renamed + to use it as a new extension. + More sophisticated file name translations can be achieved using a nested + <mapper> element. By default an + identity mapper will be used. + If dest and src point to the same directory, + the ext attribute or a nested <mapper> + is required. +

+ +

+ This task forms an implicit File Set, + and supports most attributes of <fileset> + (dir becomes src) as well as + nested <include>, <exclude>, + and <patternset> elements. +

+ +

It is possible to use different converters. This can be selected + with the implementation attribute or a nested element. + Here are the choices of the attribute:

+
    +
  • default - the default converter (kaffe or sun) for the platform.
    • +
  • sun (the standard converter of the JDK)
    • +
  • kaffe (the standard converter of Kaffe)
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
reverseReverse the sense of the conversion, + i.e. convert from ASCII to native only supported by the + sun converterNo
encodingThe native encoding the files are in + (default is the default encoding for the JVM)No
srcThe directory to find files in (default is basedir)No
destThe directory to output file toYes
extFile extension to use in renaming output filesNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). + Default excludes are used when omitted. + No
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be excluded. + No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
implementationThe converter implementation to use. + If this attribute is not set, the default converter for the + current VM will be used. (See the above list of valid converters.)No
+ +

Parameters specified as nested elements

+ +

arg

+ +

You can specify additional command line arguments for the converter +with nested <arg> elements. These elements are +specified like Command-line Arguments +but have an additional attribute that can be used to enable arguments +only if a given converter implementation will be used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
valueSee + Command-line Arguments.Exactly one of these.
line
file
path
implementationOnly pass the specified argument if the chosen converter + implementation matches the value of this attribute. Legal values + are the same as those in the above list of valid compilers.)No
+ +

implementationclasspath since Apache Ant 1.8.0

+ +

A PATH like structure holding the + classpath to use when loading the converter implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in converters.

+ +

Any nested element of a type that implements Native2AsciiAdapter + since Ant 1.8.0

+ +

If a defined type implements the Native2AsciiAdapter + interface a nested element of that type can be used as an + alternative to the implementation attribute.

+ +

Examples

+ + 
+<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir"
+   includes="**/*.eucjis" ext=".java"/>
+
+ +

+ Converts all files in the directory srcdir + ending in .eucjis from the EUCJIS encoding to ASCII + and renames them to end in .java. +

+ +
+<native2ascii encoding="EUCJIS" src="native/japanese" dest="src"
+   includes="**/*.java"/>
+
+ +

+ Converts all the files ending in .java + in the directory native/japanese to ASCII, + placing the results in the directory src. + The names of the files remain the same. +

+ +

If you want to use a custom + Native2AsciiAdapter org.example.MyAdapter you can either + use the implementation attribute:

+
+<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir"
+       includes="**/*.eucjis" ext=".java"
+       implementation="org.example.MyAdapter"/>
+
+

or a define a type and nest this into the task like in:

+
+<componentdef classname="org.example.MyAdapter"
+              name="myadapter"/>
+<native2ascii encoding="EUCJIS" src="srcdir" dest="srcdir"
+       includes="**/*.eucjis" ext=".java">
+  <myadapter/>
+</native2ascii>
+
+

in which case your native2ascii adapter can support attributes and + nested elements of its own.

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/netrexxc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/netrexxc.html new file mode 100644 index 000000000..c492af9c6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/netrexxc.html @@ -0,0 +1,338 @@ + + + + + + +NetRexxC Task + + + + +

NetRexxC

+

Description

+

Compiles a NetRexx +source tree within the running (Apache Ant) VM.

+

The source and destination directory will be recursively scanned for +NetRexx source files to compile. Only NetRexx files that have no corresponding +class file or where the class file is older than the java file will be compiled.

+

Files in the source tree are copied to the destination directory, +allowing support files to be located properly in the classpath. The source +files are copied because the NetRexx compiler cannot produce class files in a +specific directory via parameters

+

The directory structure of the source tree should follow the package +hierarchy.

+

It is possible to refine the set of files that are being compiled/copied. +This can be done with the includes, includesfile, excludes, excludesfile and +defaultexcludes attributes. With the includes or includesfile attribute you +specify the files you want to have included by using patterns. The +exclude or excludesfile attribute is used to specify the files you want to have +excluded. This is also done with patterns. And finally with the +defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes srcdir) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

All properties except classpath, srcdir and destDir are also available as properties in the form +ant.netrexxc.attributename, eg.
+<property name="ant.netrexxc.verbose" value="noverbose"/>
+or from the command line as
+ant -Dant.netrexxc.verbose=noverbose ... +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
binaryWhether literals are treated as the java binary + type rather than the NetRexx typesNo
classpathThe classpath to use during compilationNo
commentsWhether comments are passed through to the + generated java sourceNo
compactWhether error messages come out in compact or + verbose format. Default is the compact format.No
compileWhether the NetRexx compiler should compile the + generated java codeNo
consoleWhether or not messages should be displayed on the + 'console'. Note that this task will rely on the default value for filtering compile messages.No
crossrefWhether variable cross references are generatedNo
decimalWhether decimal arithmetic should be used for the + NetRexx code. Setting this to off will report decimal arithmetic + as an error, for performance critical applications.No
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted.No
destDirthe destination directory into which the NetRexx + source files should be copied and then compiledYes
diagWhether diagnostic information about the compile is + generatedNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
explicitWhether variables must be declared explicitly + before useNo
formatWhether the generated java code is formatted nicely + or left to match NetRexx line numbers for call stack debuggingNo
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
javaWhether the generated java code is producedNo
keepSets whether the generated java source file should be kept + after compilation. The generated files will have an extension of + .java.keep, not .java. Use removeKeepExtension to change that.No
logoWhether the compiler text logo is displayed when + compilingNo
removeKeepExtensionTells wether the trailing .keep in nocompile-mode should + be removed so that the resulting java source really ends on .java. This + facilitates the use of the javadoc tool lateron.No
replaceWhether the generated .java file should be replaced + when compilingNo
savelogWhether the compiler messages will be written to + NetRexxC.log as well as to the consoleNo
sourcedirTells the NetRexx compiler to store the class files in the + same directory as the source files. The alternative is the working + directoryNo
srcDirSet the source dir to find the source NetRexx + filesYes
strictargsTells the NetRexx compiler that method calls always + need parentheses, even if no arguments are needed, e.g. + aStringVar.getBytes vs. + aStringVar.getBytes()No
strictassignTells the NetRexx compile that assignments must + match exactly on typeNo
strictcaseSpecifies whether the NetRexx compiler should be + case sensitive or notNo
strictimportWhether classes need to be imported explicitly using an + import statement. By default the NetRexx compiler will + import certain packages automaticallyNo
strictpropsWhether local properties need to be qualified + explicitly using thisNo
strictsignalWhether the compiler should force catching of + exceptions by explicitly named typesNo
symbolsWhether debug symbols should be generated into the + class fileNo
timeAsks the NetRexx compiler to print compilation + times to the consoleNo
traceTurns on or off tracing and directs the resultant + trace outputNo
utf8Tells the NetRexx compiler that the source is in UTF8No
verboseWhether lots of warnings and error messages should + be generatedNo
suppressMethodArgumentNotUsedTells whether we should filter out the + &Method argument not used& messages in strictargs mode.No
suppressPrivatePropertyNotUsedTells whether we should filter out the + &Private Property defined, but not used& messages in strictargs mode.No
suppressVariableNotUsedTells whether we should filter out the + &Variable set but not used& messages in strictargs mode. + Please be careful with this one, as you can hide errors behind it!No
suppressExceptionNotSignalledTells whether we should filter out the + &Exception is declared, but not signaled within the method& + messages in strictsignal mode.No
suppressDeprecationTells whether we should filter out any deprecation-messages + of the compiler out.No
+

Examples

+
+

<netrexxc srcDir="/source/project" + includes="vnr/util/*" + destDir="/source/project/build" + classpath="/source/project2/proj.jar" + comments="true" + crossref="false" replace="true" + keep="true"/> +

+
+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/nice.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/nice.html new file mode 100644 index 000000000..03c0eaaaa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/nice.html @@ -0,0 +1,70 @@ + + + + + + +Nice Task + + + + +

Nice

+

Description

+

Provide "nice-ness" to the current thread + and/or query the current value.

+

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
currentprioritythe name of the property whose value should be + set to the current "nice-ness" level. + No
newprioritythe value to which the + "nice-ness" level should be set. + Must be a valid Java Thread priority. + No
+

Examples

+
   <nice newpriority="10"/>
+Set the Thread priority to 10 (highest). +
   <nice currentpriority="priority"/>
+Store the current Thread priority in the user property "priority". +
+   <nice currentpriority="currentpriority" newpriority="1"/>
+
+

Set the current Thread priority to 1 (lowest), storing the original +priority in the user property "currentpriority". This +can be used to set the priority back to its original value later. +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/pack.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/pack.html new file mode 100644 index 000000000..60ae1e527 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/pack.html @@ -0,0 +1,76 @@ + + + + + + +GZip/BZip2 Tasks + + + + +

GZip/BZip2

+

Description

+

Packs a resource using the GZip or BZip2 algorithm. +The output file is only generated if it doesn't exist or the source +resource is newer.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcthe file to gzip/bzip.Yes, or a nested resource collection.
destfilethe destination file to create.Exactly one of the two.
zipfilethe deprecated old name of destfile.
+

any resource or single element +resource collection

+ +

The specified resource will be used as src. Since Apache Ant 1.7

+ +

Examples

+
+<gzip src="test.tar" destfile="test.tar.gz"/>
+
+
+<bzip2 src="test.tar" destfile="test.tar.bz2"/>
+
+
+<gzip destfile="archive.tar.gz">
+  <url url="http://example.org/archive.tar"/>
+</gzip>
+
+

downloads http://example.org/archive.tar and compresses it +to archive.tar.gz in the project's basedir on the fly.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/parallel.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/parallel.html new file mode 100644 index 000000000..87a7baf10 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/parallel.html @@ -0,0 +1,236 @@ + + + + + + +Parallel Task + + + + +

Parallel

+

Description

+

+ Executes nested tasks in parallel with no guarantees of thread safety. + Every task will run in its own thread, with the likelihood of + concurrency problems scaling with the number of CPUs on the host system. +

+

Warning: While the Apache Ant core is believed to be thread safe, no such + guarantees are made about tasks, which are not tested for thread safety during + Ant's test process. + Third party tasks may or may not be thread safe, and some of Ant's core tasks, such as + <javac> are definitely not re-entrant. This is because they use libraries that + were never designed to be used in a multithreaded environment. +

+

+ The primary use case for <parallel> is to run external programs + such as an application server, and the JUnit or TestNG test suites at the + same time. Anyone trying to run large Ant task sequences in parallel, such + as javadoc and javac at the same time, is implicitly taking on the task + of identifying and fixing all concurrency bugs the tasks that they run. + +

+

+ Accordingly, while this task has uses, it should be considered an advanced + task which should be used in certain batch-processing or testing situations, + rather than an easy trick to speed up build times on a multiway CPU. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
threadCountMaximum numbers of thread to use.No
threadsPerProcessorMaximum number of threads to use per available processor +(Java 1.4+)No, defers to threadCount
timeoutNumber of milliseconds before execution is terminatedNo
failonanyIf any of the nested tasks fails, execution of the task completes + at that point without waiting for any other tasks to complete.No, default is false.
pollIntervalCurrently has no effectNo, default is 1000
+ +

Parallel tasks have a number of uses in an Ant build file including:

+
    +
  • Taking advantage of available processing resources to execute external + programs simultaneously.
    • +
  • Testing servers, where the server can be run in one thread and the test +harness is run in another thread.
    • +
+ +

Any valid Ant task may be embedded within a +parallel task, including other parallel tasks, though there is no guarantee that +the tasks will be thread safe in such an environment.

+ +

While the tasks within the parallel task are being run, the main +thread will be blocked waiting for all the child threads to complete. If +execution is terminated by a timeout or a nested task failure when the +failonany +flag is set, the parallel task will complete without waiting for other nested +tasks to complete in other threads. +

+ +

If any of the tasks within the <parallel> task fails and failonany is +not set, the remaining tasks in other threads will continue to run until +all threads have completed. In this situation, the parallel task will also fail.

+ +

The parallel task may be combined with the +sequential task to define sequences of tasks to be executed on each thread +within the parallel block

+ +

The threadCount attribute can be used to place a maximum number of available +threads for the execution. When not present all child tasks will be executed at +once. When present then the maximum number of concurrently executing tasks will +not exceed the number of threads specified. Furthermore, each task will be +started in the order they are given. But no guarantee is made as to the speed +of execution or the order of completion of the tasks, only that each will be +started before the next.

+ +

If you are using Java 1.4 or later you can also use the threadsPerProcessor +and the number of available threads will be the stated multiple of the number of +processors (there is no affinity to a particular processor however). This will +override the value in threadCount. If threadsPerProcessor +is specified on any older JVM, then the value in threadCount will be used as is.

+ +

When using threadCount and threadsPerProcessor + care should be taken to ensure that the build does not deadlock. + This can be caused by tasks such as waitfor + taking up all available threads before the tasks that would unlock the + waitfor +would occur. This is not a replacement for Java Language level thread +semantics and is best used for "embarassingly parallel" tasks.

+ + +

Parameters specified as nested elements

+ +

daemons

+

+The parallel task supports a <daemons> nested element. This is a list of tasks +which are to be run in parallel daemon threads. The parallel task will not wait for +these tasks to complete. Being daemon threads, however, they will not prevent Ant from +completing, whereupon the threads are terminated. Failures in daemon threads which +occur before the parallel task itself finishes will be reported and can cause +parallel to throw an exception. Failures which occur after parallel has completed are not +reported. +

+ +

Daemon tasks can be used, for example, to start test servers which might not be easily +terminated from Ant. By using <daemons> such servers do not halt the build. +

+ + +

Examples

+
+<parallel>
+  <wlrun ... >
+  <sequential>
+    <sleep seconds="30"/>
+    <junit fork="true" forkmode="once" ... >
+    <wlstop/>
+  </sequential>
+</parallel>
+
+

This example represents a typical pattern for testing a server application. +In one thread the server is started (the <wlrun> task). +The other thread consists +of a three tasks which are performed in sequence. The <sleep> task is used to +give the server time to come up. Another task which is capable of validating +that the server is available could be used in place of the <sleep> task. The +<junit> test harness then runs, again in its own JVM. Once the tests are complete, the server is stopped +(using <wlstop> in this example), allowing both threads to complete. The +<parallel> task will also complete at this time and the build will then +continue.

+ +
+<parallel>
+  <javac fork="true"...> <!-- compiler servlet code -->
+  <wljspc ...> <!-- precompile JSPs -->
+</parallel>
+
+ +

This example shows two independent tasks being run to achieve better +resource utilization during the build. In this instance, some servlets are being +compiled in one thead and a set of JSPs is being precompiled in another. Developers +need to be careful that the two tasks are independent, both in +terms of their dependencies and in terms of their potential interactions in +Ant's external environment. Here we set fork="true" for the +<javac> task, so that it runs in a new process; +if the <wljspc> task used the javac compiler in-VM +(it may), concurrency problems may arise. +

+ + + <macrodef name="dbpurge"> + <attribute file="file"/> + <sequential> + <java jar="utils/dbpurge.jar" fork="true" > + <arg file="@{file} /> + </java> + </sequential> +</macrodef> + +<parallel threadCount='4'> + <dbpurge file="db/one" /> + <dbpurge file="db/two" /> + <dbpurge file="db/three" /> + <dbpurge file="db/four" /> + <dbpurge file="db/five" /> + <dbpurge file="db/six" /> + <dbpurge file="db/seven" /> + <dbpurge file="db/eight" /> + <!-- repeated about 40 times --> +</parallel> + + +

This example represents a typical need for use of the threadCount and +threadsPerProcessor attributes. Spinning up all 40 of those tasks could cripple +the system for memory and CPU time. By limiting the number of +concurrent executions you can reduce contention for CPU, memory and disk IO, +and so actually finish faster. This is also a good +candidiate for use of threadCount (and possibly threadsPerProcessor) because +each task is independent (every new JVM is forked) and has no dependencies on +the other tasks.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/patch.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/patch.html new file mode 100644 index 000000000..96a5ee9a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/patch.html @@ -0,0 +1,111 @@ + + + + + + +Patch Task + + + + +

Patch

+

Description

+

Applies a diff file to originals. ; requires "patch" to be + on the execution path.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
patchfilethe file that includes the diff outputYes
originalfilethe file to patchNo, tries to guess it from the diff + file
destfilethe file to send the output to instead of + patching the file(s) in place. since Apache Ant 1.6No.
backupsKeep backups of the unpatched filesNo
quietWork silently unless an error occursNo
reverseAssume patch was created with old and new files + swapped.No
ignorewhitespaceIgnore whitespace differences.No
stripStrip the smallest prefix containing num leading + slashes from filenames.No
dirThe directory in which to run the patch command.No, default is the project's basedir.
failonerrorStop the buildprocess if the command exits with a + return code signaling failure. Defaults to false. + since Ant 1.8.0No
+

Examples

+
  <patch patchfile="module.1.0-1.1.patch"/>
+

applies the diff included in module.1.0-1.1.patch to the +files in base directory guessing the filename(s) from the diff output.

+
  <patch patchfile="module.1.0-1.1.patch" strip="1"/>
+

like above but one leading directory part will be removed. i.e. if +the diff output looked like

+
+--- a/mod1.0/A	Mon Jun  5 17:28:41 2000
++++ a/mod1.1/A	Mon Jun  5 17:28:49 2000
+
+the leading a/ will be stripped. + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/pathconvert.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/pathconvert.html new file mode 100644 index 000000000..41f56f471 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/pathconvert.html @@ -0,0 +1,224 @@ + + + + + + +PathConvert Task + + + + +

Pathconvert

+

Description

+

Converts nested +ResourceCollections, or a reference to just one, into a path +form for a particular platform, optionally storing the result into +a given property. It can also be used when you need +to convert a Resource Collection into a list, separated by a given +character, such as a comma or space, or, conversely, e.g. to convert a list +of files in a FileList into a path. +

+

Nested <map> elements can be specified to map Windows +drive letters to Unix paths, and vice-versa.

+

More complex transformations can be achieved using a nested +<mapper> +(since Apache Ant 1.6.2). +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
targetos + The target architecture. Must be one of 'unix', 'windows', + 'netware', 'tandem' or 'os/2'. + This is a shorthand mechanism for specifying both + pathsep and dirsep + according to the specified target architecture. + No
dirsep + The character(s) to use as the directory separator in the + generated paths. + No, defaults to current JVM File.separator
pathsep + The character(s) to use as the path-element separator in the + generated paths. + No, defaults to current JVM File.pathSeparator
propertyThe name of the property in which to place the converted path.No, result will be logged if unset
refidWhat to convert, given as a + reference to a + <path>, <fileset>, + <dirset>, or <filelist> + defined elsewhereNo; if omitted, a nested + <path> element must be supplied.
setonemptyShould the property be set, even if the result + is the empty string? + No; default is "true". +
preserveduplicatesWhether to preserve duplicate resources. Since Ant 1.8No; default "false". +
+

Parameters specified as nested elements

+

map

+

Specifies the mapping of path prefixes between Unix and Windows.

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
from + The prefix to match. Note that this value is case-insensitive when + the build is running on a Windows platform and case-sensitive + when running on a Unix platform. + Since Ant 1.7.0, on Windows this value is also insensitive + to the slash style used for directories, one can use '/' or '\'. + Yes
toThe replacement text to use when from is matched.Yes
+ +

Each map element specifies a single replacement map to be applied to the elements of + the path being processed. If no map entries are specified, then no path prefix mapping + is performed. +

+

Note: The map elements are applied in the order specified, +and only the first matching map element is applied. So, the ordering of +your map elements can be important, if any from values are +prefixes of other from values. +

+

Resource Collections

+

If the refid attribute is not specified, then one or more + nested Resource +Collections must be supplied.

+

mapper

+

A single nested +<mapper> element can be specified +to perform any of various filename transformations (since Ant 1.6.2). +

+ +

Examples

+

In the examples below, assume that the ${wl.home} property +has the value +d:\weblogic, and ${wl.home.unix} has the value +/weblogic.

+

Example 1

+
+    <path id="wl.path">
+      <pathelement location="${wl.home}/lib/weblogicaux.jar"/>
+      <pathelement location="${wl.home}/classes"/>
+      <pathelement location="${wl.home}/mssqlserver4/classes"/>
+      <pathelement location="c:\winnt\System32"/>
+    </path>
+    
+    <pathconvert targetos="unix" property="wl.path.unix" refid="wl.path">
+      <map from="${wl.home}" to="${wl.home.unix}"/>
+      <map from="c:" to=""/>
+    </pathconvert>
+
+

will generate the path shown below +and store it in the property named wl.path.unix. +

+
+/weblogic/lib/weblogicaux.jar:/weblogic/classes:/weblogic/mssqlserver4/classes:/WINNT/SYSTEM32
+
+ +

Example 2

+Given a FileList defined as: +
+  <filelist id="custom_tasks.jars"
+        dir="${env.HOME}/ant/lib"
+        files="njavac.jar,xproperty.jar"/>
+
+then: +
+    <pathconvert targetos="unix" property="custom_tasks.jars" refid="custom_tasks.jars">
+      <map from="${env.HOME}" to="/usr/local"/>
+    </pathconvert>
+
+will convert the list of files to the following Unix path: +
+/usr/local/ant/lib/njavac.jar:/usr/local/ant/lib/xproperty.jar
+
+ +

Example 3

+
+    <fileset dir="${src.dir}" id="src.files">
+      <include name="**/*.java"/>
+    </fileset>
+  
+    <pathconvert pathsep="," property="javafiles" refid="src.files"/>
+
+

This example takes the set of files determined by the fileset (all files ending +in .java), joins them together separated by commas, and places the resulting +list into the property javafiles. The directory separator is not specified, so +it defaults to the appropriate character for the current platform. Such a list could +then be used in another task, like javadoc, that requires a comma separated +list of files. +

+

Example 4

+
+    <pathconvert property="prop" dirsep="|">
+      <map from="${basedir}/abc/" to=''/>
+      <path location="abc/def/ghi"/>
+    </pathconvert>
+
+

+ This example sets the property "prop" to "def|ghi" on + Windows and on Unix. +

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/perforce.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/perforce.html new file mode 100644 index 000000000..2d84df00b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/perforce.html @@ -0,0 +1,1006 @@ + + + + +Perforce Tasks + + +

Perforce Tasks User Manual

+

by

+ +
+

Contents

+ +
+

Introduction

+

These tasks provide an interface to the Perforce SCM. +The org.apache.tools.ant.taskdefs.optional.perforce package consists of a simple framework to support +p4 functionality as well as some Apache Ant tasks encapsulating frequently used (by me :-) p4 commands. +However, the addition of new p4 commands is a pretty simple task (see the source). +Although it is possible to use these commands on the desktop, +they were primarily intended to be used by automated build systems.

+ +

Note: These tasks require the oro regular +expression package. See library dependencies for the precise +version required. +You will also need the Perforce client executable (p4 or p4.exe but not p4win.exe) in your path. +

+ + + +

The Tasks

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TaskDescription
P4SyncSynchronise a workspace to a depot
P4ChangeRequest a new changelist from the Perforce server
P4EditOpen files for edit (checkout)
P4SubmitSubmit a changelist to the Perforce server (checkin)
P4HaveList current files in client view, useful for reporting
P4LabelCreate a label reflecting files in the current workspace
P4LabelsyncSyncs an existing label
P4CounterObtain or set the value of a counter
P4ReopenMove files between changelists
P4RevertRevert files
P4AddAdd files
P4DeleteDelete files
P4IntegrateIntegrate files
P4ResolveResolve files
P4FstatShow differences between local repository and p4 repository
+ +

General P4 Properties

+

Each p4 task requires a number of settings, either through build-wide properties, individual attributes +or environment variables. These are +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyAttributeEnv VarDescriptionDefault
p4.portportP4PORTThe p4d server and port to connect toperforce:1666
p4.clientclientP4CLIENTThe p4 client spec to useThe logged in username
p4.useruserP4USERThe p4 usernameThe logged in username
--view--The client, branch or label view to operate upon. See the p4 user guide for more info.//...
+

Your local installation of Perforce may require other settings (e.g. +P4PASSWD, P4CONFIG). Many of these settings can be set using the globalopts +attribute (described below), but not all. If a setting cannot be set +by the command-line options, then it can only be set outside of Ant as an +environment variable. +

+

+Additionally, you may also specify the following attributes: +

+

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
failonerrorSpecifies whether to stop the build + (true|yes|on) + or keep going (false|no|off) + if an error is returned from the p4 command.No; defaults to true.
globalopts
Specifies global options for perforce to use while + executing the task. These properties should be concatenated into one + string,
+ such as "-P password -C EUCJIS". Use the command-line option + syntax, NOT the environment variable names. See the
+ Perforce Command Reference for details.		No
+

+ +

Examples

+

Setting in the environment:-

+

+(Unix csh)

+
setenv P4PORT myperforcebox:1666
+

(Unix sh et al)

+
P4USER=myp4userid; export P4USER
+

Using build properties:-

+
<property name="p4.client" value="nightlybuild"/>
+

Using task attributes:-

+
+<p4Whatever
+	port="myserver:1666"
+	client="smoketest"
+	user="smoketestdude"
+	.
+	.
+	.
+/>
+
+ +

+For more information regarding the underlying 'p4' commands you are referred to the Perforce Command Reference +available from the Perforce website. +

+ + +
+

Task Descriptions

+

P4Sync

+

Description:

+

Synchronize the current workspace with the depot.

+ +

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
forceforce a refresh of files, if this attribute has + been set.no - if omitted, it will be off, + otherwise a refresh will be forced.
labelsync client to labelno
+ +

Examples

+
<p4sync label="nightlybuild-0.0123" force="foo"/>
+<p4sync view="//depot/projects/projectfoo/main/src/..."/>
+
+
+ + + +

P4Change

+

Description:

+

Request a new changelist from the Perforce server. +This task sets the ${p4.change} property which can then be passed to P4Submit, +P4Edit, or P4Add, or P4Delete, +then to P4Submit. +

+

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
descriptionDescription for ChangeList. If none specified, it will + default to "AutoSubmit By Ant"No.
+ +

Examples

+
<p4change description="Change Build Number in Script">
+
+
+ + + + +

P4Edit

+

Description:

+

Open file(s) for edit. P4Change should be used to obtain a new changelist for P4Edit as, +although P4Edit can open files to the default change, P4Submit cannot yet submit it. +

+

Parameters

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
viewThe filespec to request to editYes
changeAn existing changelist number to assign files to.No, but see above.
+ +

Examples

+
+<p4edit
+    view="//depot/projects/projectfoo/main/src/Blah.java..."
+    change="${p4.change}"/>
+
+
+ + + + +

P4Submit

+

Description:

+

Submit a changelist, usually obtained from P4Change. +

P4Submit will also change the value of the property p4.change if the change list is renamed by the Perforce server. +

P4Submit will set a property p4.needsresolve to 1 if the change could not be submitted due to files needing resolving. +

Files will need resolve if at the time of checking in, the revision that was checked out to do the current edit +is not the latest any more. +

If no files need resolve, the p4.needsresolve will be set to 0. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
changeThe changelist number to submitYes
changepropertyName of a property to which the new change number + will be assigned if the Perforce server renumbers the change
+ Since Ant 1.6.1		No
needsresolvepropertyName of property which will be set to true + if the submit requires a resolve
+ Since Ant 1.6.1		No
+ +

Examples

+
<p4submit change="${p4.change}"/>
+
+
+ + + + +

P4Have

+

Description:

+

List handy file info reflecting the current client contents. +

+

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
None----
+ +

Examples

+
<p4have/>
+
+
+ + + + +

P4Label

+

Description:

+

Create a new label and set contents to reflect current client file revisions. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the labelYes
viewclient view to use for label
+ The view can contain multiple lines separated by ; or :		No
descLabel DescriptionNo
lockLock the label once created.No
+

Examples

+
+<p4label
+	name="NightlyBuild:${DSTAMP}:${TSTAMP}" 
+	desc="Auto Nightly Build"
+	lock="locked"
+	view="//firstdepot/...;//secondepot/foo/bar/..."
+/>
+
+
+ + +

P4Labelsync

+

Description:

+

Syncs an existing label against the current workspace or against specified revisions. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequiredPerforce command line flag
nameThe name of the labelYes-l labelname
view + list of files or revision specs separated by : or ;
+ in the absence of this attribute, the labelsync will be done against the current Perforce client or the value of the p4client attribute or the value of the p4.client property or the value of the environment variable P4CLIENT		Nofile[revRange] ...
simulationmodeDisplays which effect the operation would have on the label but do not actually do itNo-n
addIf set to true, preserve files which exist in the label, but not in the current viewNo-a
deleteIf set to true, remove from the label the files mentioned in the view attributeNo-d
+

Examples

+
+<
+p4labelsync
+name="current_release"
+view="//depot/...#head;//depot2/file1#25"
+add="true"
+/>
+
+This example will add into the label called current_release the current head revision of all the files located under //depot +and the revision 25 of the file //depot2/file1. +
+<
+p4labelsync
+name="current_release"
+p4client="myclient"
+/>
+
+This example will update the label called current_release so that it reflects the Perforce client myclient.
+Files present in the label before the sync and not present currently in the client will be removed from the label, because the add attribute is not set. +
+<
+p4labelsync
+name="current_release"
+/>
+
+This example will update the label called current_release so that it reflects the current default client for the ant Perforce tasks.
+The default client is by order of priority : +
    +
  • +the value of the p4.client property if set in the project +
    • +
  • +the value of the P4CLIENT environment variable +
    • +
  • +the default Perforce client from the Windows registry under Windows operating systems +
    • +
+Files present in the label before the sync and not present currently in the client will be removed from the label, because the add attribute is not set. +
+ + +

P4Counter

+

Description:

+

+Obtain or set the value of a counter. When used in its base form +(where only the counter name is provided), the counter value will be +printed to the output stream. When the value is provided, the counter +will be set to the value provided. When a property name is provided, +the property will be filled with the value of the counter. You may +not specify to both get and set the value of the counter in the same +Task. +

+

+The user performing this task must have Perforce "review" permissions +as defined by Perforce protections in order for this task to succeed. +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the counterYes
valueThe new value for the counterNo
propertyThe property to be set with the value of the counterNo
+ +

Examples

+Print the value of the counter named "last-clean-build" to the output stream: +
+<p4counter name="last-clean-build"/>
+
+Set the value of the counter based on the value of the "TSTAMP" property: +
+<p4counter name="last-clean-build" value="${TSTAMP}"/>
+
+Set the value of the "p4.last.clean.build" property to the current +value of the "last-clean-build" counter: +
+<p4counter name="last-clean-build" property="p4.last.clean.build"/>
+
+
+ + + + +

P4Reopen

+

Description:

+

+Move (or reopen in Perforce speak) checkout files between changelists. +

+

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
tochangeThe changelist to move files to.Yes
+ +

Examples

+Move all open files to the default changelist +
+<p4reopen view="//..." tochange="default"/>
+
+Create a new changelist then reopen into it, any files from the view //projects/foo/main/... +
+<p4change description="Move files out of the way"/>
+<p4reopen view="//projects/foo/main/..." tochange="${p4.change}"/>
+
+
+ + + +

P4Revert

+

Description:

+

+Reverts files. +

+

Parameters

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
changeThe changelist to revert.No
revertOnlyUnchangedRevert only unchanged files (p4 revert -a)No
+ +

Examples

+Revert everything! +
+<p4revert view="//..."/>
+
+Revert any unchanged files in the default change +
+<p4revert change="default" revertonlyunchanged="true"/>
+
+
+ +

P4Add

+

Description:

+

+Adds files specified in nested fileset children. +

+

Parameters

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
commandlengthA positive integer specifying the maximum length + of the commandline when calling Perforce to add the files. + Defaults to 450, higher values mean faster execution, + but also possible failures.No
changelistIf specified the open files are associated with the +specified pending changelist number; otherwise the open files are +associated with the default changelist.No
+ +

Examples

+Require a changelist, add all java files starting from a directory, +and submit + +
+<p4change/>
+<p4add commandlength="20000" changelist="${p4.change}">
+    <fileset dir="../dir/src/" includes="**/*.java"/>
+<p4add>
+<p4submit change="${p4.change}"/>
+
+
+ +

P4Fstat

+

Description:

+

+Lists files under Perforce control and files not under Perforce control in one or several filesets +

+

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
showfiltershould be one of + + + + +
valuedescription
"all"list all files, first the ones which are under Perforce control, then the others
"existing"list only files under Perforce control
"non-existing"list only files which are not under Perforce control
+ 		Yes
filesetone or several fileset(s)yes (at least one fileset is needed)
+Several nested filesets can be used with P4Fstat, one should be there at least. +

Examples

+will list all the files under C:\dev\gnu\depot, sorted by under Perforce or not under Perforce
+
+<project name="p4fstat" default="p4fstat" basedir="C:\dev\gnu">
+    <target name="p4fstat" >
+        <p4fstat showfilter="all">
+            <fileset dir="depot" includes="**/*"/>
+        </p4fstat>
+    </target>
+</project>

+
+ + + + +

P4Delete

+

Description:

+

Open file(s) for delete. P4Change should be used to obtain a new changelist for P4Delete as, +although P4Delete can open files to the default change, P4Submit cannot yet submit it. +

+

Parameters

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
viewThe filespec to request to deleteYes
changeAn existing changelist number to assign files to.No, but see above.
+ +

Examples

+
+<p4delete
+    view="//depot/projects/projectfoo/main/src/Blah.java..."
+    change="${p4.change}"/>
+
+
+

P4Integrate

+

Description:

+

Open file(s) for integrate. P4Change should be used to obtain a new changelist for P4Integrate as, +although P4Integrate can open files to the default change, P4Submit cannot yet submit it. +

+

Parameters

+

If this task is used without using a branch definition, both fromfile and tofile must be supplied. +If a branch definition is supplied, at least one of fromfile or tofile should be supplied. +Both fromfile and tofile can be supplied together with a branch definition.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequiredPerforce command line flag
fromfileOriginal file or viewrequired if a branch is not specified
tofileTarget file or view.required if a branch is not specified
branchName of branch specificationNo-b
changeAn existing changelist number to assign files to.No, but see above.-c
forceintegrateForces integration regardless of previous integration history (*)No-f
restoredeletedrevisionsEnables integration around deleted revisions (*)No-d
leavetargetrevisionPrevents target files from being synced to head revision before integration (*)No-h
enablebaselessmergesForces integration to existing target files which have no integration history relative to the source files (*)No-i
simulationmodeDisplays which integrations are necessary but do not actually schedule them (*)No-n
reversebranchmappingsReverses mappings in the branch view, with source and target files exchanging place (*)No-r
propagatesourcefiletypeMakes source file type propagate to existing target files (*)No-t
nocopynewtargetfilesPrevents the physical delivery on disk of new target files (*)No-v
+
+(*) The following applies for a number of flags. The default is false. To set the flag, use "true" + +

Examples

+
+<p4integrate
+    fromfile="//depot/projects/projectfoo/main/src/Blah.java..."
+    tofile="//depot/projects/projectfoo/release/src/Blah.java..."
+    change="${p4.change}"/>
+
+
+

P4Resolve

+

Description:

+

Resolves files. You want to do this if : +

    +
  • +there have been or there may be concurrent edits of the same file. For instance, you have begun to edit a file, and while you were working on it, somebody has submitted a new version of the same file. When you first attempt to submit your file(s), you will get a message (property p4.needsresolve set). +
    • +
  • +you have just been doing an integration to existing target files +
    • +
+P4Resolve does not use a change list number (it takes it from the files it is working on). +

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequiredPerforce command line flag
viewThe filespec to request to deleteYes
resolvemodeShould have one of these values : +
    +
  • "automatic"
    • +
  • "force"
    • +
  • "safe"
    • +
  • "theirs"
    • +
  • "yours"
    • +
Yescorresponds to one of -am -af -as -at -ay
redoallallows previously resolved files to be resolved again (*)No-f
simulationmodeLists the integrations which would be performed, without actually doing them. (*)No-n
forcetextmodeAttempts a textual merge, even for binary files (*)No-t
markersforallPuts in markers for all changes, conflicting or not (*)No-v
+
+(*) The following applies for a number of flags. The default is false. To set the flag, use "true" + +

Examples

+
+<p4resolve
+    view="//depot/projects/projectfoo/main/src/Blah.java..."
+    resolvemode="automatic"/>
+
+ +

Change History

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Sept 2000--Internal Release within Rubus
Nov 2000V1.0Initial Release donated to ASF :-)
Jan 2001V1.1Fixed cross platform (NT/Unix) bug
+ Refactored p4 output handling code
+ Refactored exec'ing code
Jan 2003V1.2Added globalopts to P4Base to allow + additional global options to be set.
+ Added p4fstat task
May 2003V1.3Added p4labelsync, p4resolve, p4integrate.
+ Changed p4submit (detection of changes of change numbers, + and of failed submits due to resolution needed)
Jan 2004Ant 1.6.1 +Changed p4submit, needsresolveproperty and changeproperty added
+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/presetdef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/presetdef.html new file mode 100644 index 000000000..c7f381c0a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/presetdef.html @@ -0,0 +1,184 @@ + + + + + + +PreSetDef Task + + + + + +

PreSetDef

+

Description

+

+ The preset definition generates a new definition + based on a current definition with some attributes + or elements preset. +

+

+ since Apache Ant 1.6 +

+

+ The resolution of properties in any of the attributes or + nested text takes place with the definition is used and not + when the preset definition is defined. +

+

Parameters

+ + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namethe name of the new definitionYes
uri + The uri that this definition should live in. + No
+

Parameters specified as nested elements

+

another type with attributes or elements set

+

The <presetdef> task takes one nested element as a parameter. + This nested element can be any other type or task. The attributes + and elements that need to be preset are placed here. +

+ +

Examples

+ The following fragment defines a javac task with the debug, deprecation + srcdir and destdir + attributes set. It also has a src element to source files from a generated + directory. +
+
+<presetdef name="my.javac">
+   <javac debug="${debug}" deprecation="${deprecation}"
+          srcdir="${src.dir}" destdir="${classes.dir}">
+      <src path="${gen.dir}"/>
+   </javac>
+</presetdef>
+
+
+ This can be used as a normal javac task - example: +
+
+<my.javac/>
+
+
+ The attributes specified in the preset task may be overridden - i.e. + they may be seen as optional attributes - example: +
+
+<my.javac srcdir="${test.src}" deprecation="no"/>
+
+
+ One may put a presetdef definition in an antlib. + For example suppose the jar file antgoodies.jar has + the antlib.xml as follows: +
+
+<antlib>
+   <taskdef resource="com/acme/antgoodies/tasks.properties"/>
+   <!-- Implement the common use of the javac command -->
+   <presetdef name="javac">
+      <javac deprecation="${deprecation}" debug="${debug}"
+             srcdir="src" destdir="classes"/>
+   </presetdef>
+</antlib>
+
+
+ One may then use this in a build file as follows: +
+
+<project default="example" xmlns:antgoodies="antlib:com.acme.antgoodies">
+   <target name="example">
+      <!-- Compile source -->
+      <antgoodies:javac srcdir="src/main"/>
+      <!-- Compile test code -->
+      <antgoodies:javac srcdir="src/test"/>
+   </target>
+</project>
+
+
+

+ The following is an example of evaluation of properties when the + definition is used: +

+
+
+<target name="defineandcall">
+   <presetdef name="showmessage">
+      <echo>message is '${message}'</echo>
+   </presetdef>
+   <showmessage/>
+   <property name="message" value="Message 1"/>
+   <showmessage/>
+   <antcall target="called">
+      <param name="message" value="Message 2"/>
+   </antcall>
+</target>
+<target name="called">
+   <showmessage/>
+</target>
+
+
+

+ The command ant defineandcall results in the output: +

+
+
+defineandcall:
+[showmessage] message is '${message}'
+[showmessage] message is 'Message 1'
+
+called:
+[showmessage] message is 'Message 2'
+
+
+

+It is possible to use a trick to evaluate properties when the definition is +made rather than used. This can be useful if you do not expect some +properties to be available in child builds run with +<ant ... inheritall="false">: +

+
+<macrodef name="showmessage-presetdef">
+  <attribute name="messageval"/>
+  <presetdef name="showmessage">
+    <echo>message is '@{messageval}'</echo>
+  </presetdef>
+</macrodef>
+<showmessage-presetdef messageval="${message}"/>
+
+
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/projecthelper.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/projecthelper.html new file mode 100644 index 000000000..ea78eb2e0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/projecthelper.html @@ -0,0 +1,59 @@ + + + + + + +ProjectHelper Task + + + + +

ProjectHelper

+

Description

+

This task is provided for the purpose of allowing the user to install a different +ProjectHelper at runtime. +

+

The helpers will be added after all the already registered helpers, but before +the default one (ProjectHelper2) +

+

See the description of Apache Ant's +Project Helper for more information. +

+

Since Ant 1.8.2

+ +

Parameters specified as nested elements

+ +You may specify many configured org.apache.tools.ant.ProjectHelper instances. + +

Example

+ +

Install a custom ProjectHelper implementation + (assuming MyProjectHelper extends ProjectHelper):

+ +
+<typedef classname="org.example.MyProjectHelper"
+              name="myprojecthelper"/>
+<projecthelper>
+  <myprojecthelper/>
+</projecthelper>
+
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/property.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/property.html new file mode 100644 index 000000000..c0a3b9615 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/property.html @@ -0,0 +1,347 @@ + + + + + + +Property Task + + + + +

Property

+

Description

+

Sets a property +(by name and value), or set of properties (from file or +resource) in the project. Properties are case sensitive.

+ Properties are immutable: whoever sets a property first freezes it for the + rest of the build; they are most definitely not variables. +

There are seven ways to set properties:

+
    +
  • By supplying both the name and one of value or location attribute.
    • +
  • By supplying the name and nested text.
    • +
  • By supplying both the name and refid attribute.
    • +
  • By setting the file attribute with the filename of the property + file to load. This property file has the format as defined by the file used + in the class java.util.Properties, with the same rules about how + non-ISO8859-1 characters must be escaped.
    • +
  • By setting the url attribute with the url from which to load the + properties. This url must be directed to a file that has the format as defined + by the file used in the class java.util.Properties.
    • +
  • By setting the resource attribute with the resource name of the + property file to load. A resource is a property file on the current + classpath, or on the specified classpath.
    • +
  • By setting the environment attribute with a prefix to use. + Properties will be defined for every environment variable by + prefixing the supplied name and a period to the name of the variable.
    • +
+

Although combinations of these ways are possible, only one should be used +at a time. Problems might occur with the order in which properties are set, for +instance.

+

The value part of the properties being set, might contain references to other +properties. These references are resolved at the time these properties are set. +This also holds for properties loaded from a property file.

+

A list of predefined properties can be found here.

+

Since Apache Ant 1.7.1 it is possible to load properties defined in xml +according to Suns DTD, +if Java5+ is present. For this the name of the file, resource or url has +to end with .xml.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namethe name of the property to set.No
valuethe value of the property.One of these or + nested text, when using the name attribute
locationSets the property to the absolute filename of the + given file. If the value of this attribute is an absolute path, it + is left unchanged (with / and \ characters converted to the + current platforms conventions). Otherwise it is taken as a path + relative to the project's basedir and expanded.
refidReference to an object + defined elsewhere. Only yields reasonable results for references + to PATH like structures or properties.
resource the name of the classpath resource containing + properties settings in properties file format.One of these, when + not using the name attribute
filethe location of the properties file to load.
urla url containing properties-format settings.
environmentthe prefix to use when retrieving environment variables. Thus + if you specify environment="myenv" you will be able to access OS-specific + environment variables via property names "myenv.PATH" or + "myenv.TERM". Note that if you supply a property name with a final + "." it will not be doubled; i.e. environment="myenv." will still + allow access of environment variables through "myenv.PATH" and + "myenv.TERM". This functionality is currently only implemented + on select platforms. Feel free to send patches to increase the + number of platforms on which this functionality is supported ;).
+ Note also that properties are case-sensitive, even if the + environment variables on your operating system are not; e.g. Windows 2000's + system path variable is set to an Ant property named "env.Path" + rather than "env.PATH".
classpaththe classpath to use when looking up a resource.No
classpathrefthe classpath to use when looking up a resource, + given as reference to a <path> defined + elsewhere..No
prefixPrefix to apply to properties loaded using file, + resource, or url. + A "." is appended to the prefix if not specified.No
prefixValuesWhether to apply the prefix when expanding the + right hand side of properties loaded using file, + resource, or url. + Since Ant 1.8.2No (default=false)
relativeIf set to true the relative path + to basedir is set. Since Ant 1.8.0No (default=false)
basedirThe basedir to calculate the relative path + from. Since Ant 1.8.0No (default=${basedir})
+ +

OpenVMS Users

+

With the environment attribute this task will load all defined +logicals on an OpenVMS system. Logicals with multiple equivalence names get +mapped to a property whose value is a comma separated list of all equivalence +names. If a logical is defined in multiple tables, only the most local +definition is available (the table priority order being PROCESS, JOB, GROUP, +SYSTEM). +

+ +

Any OS except OpenVMS

+

Starting with Ant 1.8.2 if Ant detects it is running of a Java 1.5 + VM (or better) Ant will use System.getenv rather than + its own OS dependent native implementation. For some OSes this + causes minor differences when compared to older versions of Ant. + For a full list + see Bugzilla + Issue 49366. In particular:

+
    +
  • On Windows Ant will now return additional "environment + variables" that correspond to the drive specific current working + directories when Ant is run from the command line. The keys of + these variables starts with an equals sign.
    • +
  • Some users reported that some Cygwin specific variables (in + particular PROMPT) was no longer present.
    • +
  • On OS/2 Ant no longer returns the BEGINLIBPATH variable.
    • +
+ +

Parameters specified as nested elements

+

classpath

+

Property's classpath attribute is a PATH like structure and can also be set via a nested +classpath element.

+ +

Examples

+
  <property name="foo.dist" value="dist"/>
+

sets the property foo.dist to the value "dist".

+ +
  <property name="foo.dist">dist</property>
+

sets the property foo.dist to the value "dist".

+ +
  <property file="foo.properties"/>
+

reads a set of properties from a file called "foo.properties".

+ +
  <property url="http://www.mysite.com/bla/props/foo.properties"/>
+

reads a set of properties from the address "http://www.mysite.com/bla/props/foo.properties".

+ +
  <property resource="foo.properties"/>
+

reads a set of properties from a resource called "foo.properties".

+

Note that you can reference a global properties file for all of your Ant +builds using the following:

+ +
  <property file="${user.home}/.ant-global.properties"/>
+

since the "user.home" property is defined by the Java virtual machine +to be your home directory. Where the "user.home" property resolves to in +the file system depends on the operating system version and the JVM implementation. +On Unix based systems, this will map to the user's home directory. On modern Windows +variants, this will most likely resolve to the user's directory in the "Documents +and Settings" or "Users" folder. Older windows variants such as Windows 98/ME are less +predictable, as are other operating system/JVM combinations.

+ +
+  <property environment="env"/>
+  <echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/>
+  <echo message="ANT_HOME is set to = ${env.ANT_HOME}"/>
+
+

reads the system environment variables and stores them in properties, prefixed with "env". +Note that this only works on select operating systems. +Two of the values are shown being echoed. +

+ +
+  <property environment="env"/>
+  <property file="${user.name}.properties"/>
+  <property file="${env.STAGE}.properties"/>
+  <property file="build.properties"/>
+
+

This buildfile uses the properties defined in build.properties. Regarding to the +environment variable STAGE some or all values could be overwritten, e.g. having +STAGE=test and a test.properties you have special values for that (like another +name for the test server). Finally all these values could be overwritten by personal settings with +a file per user.

+ +
+  <property name="foo" location="my/file.txt" relative="true" basedir=".."/>
+
+

Stores the relative path in foo: projectbasedir/my/file.txt

+ +
+  <property name="foo" location="my/file.txt" relative="true" basedir="cvs"/>
+
+

Stores the relative path in foo: ../my/file.txt

+ + +

Property Files

+ +As stated, this task will load in a properties file stored in the file +system, or as a resource on a classpath. Here are some interesting facts +about this feature +
    +
  1. If the file is not there, nothing is printed except at -verbose log +level. This lets you have optional configuration files for every +project, that team members can customize. +
  2. The rules for this format are laid down +by Sun. +This makes it hard for Team Ant to field bug reports about it. +
  3. Trailing spaces are not stripped. It may have been what you wanted. +
  4. Want unusual characters? Escape them \u0456 or \" style. +
  5. Ant Properties are expanded in the file +
  6. If you want to expand properties defined inside the same file and + you use the prefix attribute of the task, you must use the same + prefix when expanding the properties or + set prefixValues to true.
    7. +
+In-file property expansion is very cool. Learn to use it. +

+Example: +

+build.compiler=jikes
+deploy.server=lucky
+deploy.port=8080
+deploy.url=http://${deploy.server}:${deploy.port}/
+
+ + + +

Notes about environment variables

+

+ Ant runs on Java 1.2 therefore it cant use Java5 features for accessing environment + variables. So it starts a command in a new process which prints the environment variables, + analyzes the output and creates the properties.
+ There are commands for the following operating systems implemented in + + Execute.java (method getProcEnvCommand()): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OScommand
os/2 cmd /c set
windows
* win9x command.com /c set
* other cmd /c set
z/os /bin/env OR /usr/bin/env OR env (depending on read rights)
unix /bin/env OR /usr/bin/env OR env (depending on read rights)
netware env
os/400 env
openvms show logical
+

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyfile.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyfile.html new file mode 100644 index 000000000..7450c0a4b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyfile.html @@ -0,0 +1,232 @@ + + + + + +PropertyFile Task + + + + +

PropertyFile

+ +
+

Introduction

+

Apache Ant provides an optional task for editing property files. This is +very useful when wanting to make unattended modifications to +configuration files for application servers and +applications. Currently, the task maintains a working property file +with the ability to add properties or make changes to existing +ones. Since Ant 1.8.0 comments and layout of the original properties +file are preserved.

+ +

Since Ant 1.8.2 the linefeed-style of the original file + will be preserved as well, as long as style used to be consistent. + In general, linefeeds of the updated file will be the same as the + first linefeed found when reading it.

+ +
+

PropertyFile Task

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
fileLocation of the property file to be editedYes
commentHeader for the file itselfno
jdkpropertiesUse java.lang.Properties, which will + loose comments and layout of file (default is 'false'). since + Ant 1.8.0no
+ +

The boolean attribute 'jdkproperties' is provided to recover the +previous behaviour of the task, in which the layout and any comments +in the properties file were lost by the task.

+ +

Parameters specified as nested elements

+

Entry

+

Use nested <entry> +elements to specify actual modifications to the property file itself.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
keyName of the property name/value pairYes
valueValue to set (=), to add (+) or subtract (-)At least one must be specified, if operation is not delete
defaultInitial value to set for a property if it is not + already defined in the property file.
+ For type date, an additional keyword is allowed: "now"
typeRegard the value as : int, date or string (default)No
operationOne of the following operations:

+ for all datatypes:
    +
  • "del" : deletes an entry
    • +
  • "+" : adds a value to the existing value
    • +
  • "=" : sets a value instead of the existing value (default)
    • +

for date and int only:
    +
  • "-" : subtracts a value from the existing value
    • +
+ 		No
patternFor int and date type only. If present, Values will + be parsed and formatted accordingly.No
unitThe unit of the value to be applied to date +/- operations. + Valid Values are: +
    +
  • millisecond
    • +
  • second
    • +
  • minute
    • +
  • hour
    • +
  • day (default)
    • +
  • week
    • +
  • month
    • +
  • year
    • +
+ This only applies to date types using a +/- operation. + 		No
+

The rules used when setting a property value are shown below.  The +operation occurs after these rules are considered.

+ +
    +
  • If only value is specified, the property is set to it regardless of its + previous value.
    • +
  • If only default is specified and the property previously existed in the + property file, it is unchanged.
    • +
  • If only default is specified and the property did not exist in the + property file, the property is set to default.
    • +
  • If value and default are both specified and the property previously + existed in the property file, the property is set to value.
    • +
  • If value and default are both specified and the property did not exist in + the property file, the property is set to default.
    • +
+

 

+ +

Examples

+ +

The following changes the my.properties file. Assume my.properties look like:

+ +
# A string value
+akey=original value
+
+# The following is a counter, which will be incremented by 1 for
+# each time the build is run.
+anint=1
+ +

After running, the file would now look like +

+
#My properties
+#Wed Aug 31 13:47:19 BST 2005
+# A string value
+akey=avalue
+
+# The following is a counter, which will be incremented by 1 for
+# each time the build is run.
+anint=2
+
+adate=2005/08/31 13\:47
+
+formated.int=0014
+
+formated.date=243 13\:47
+

+The slashes conform to the expectations of the Properties class. The file will be stored in a manner so that each character is examined and escaped if necessary. +

+ +

+The layout and comment of the original file is preserved. New properties are added at the end of the file. Existing properties are overwritten in place. +

+ +
<propertyfile
+    file="my.properties"
+    comment="My properties">
+  <entry  key="akey" value="avalue"/>
+  <entry  key="adate" type="date" value="now"/>
+  <entry  key="anint" type="int" default="0" operation="+"/>
+  <entry  key="formated.int" type="int" default="0013" operation="+" pattern="0000"/>
+  <entry  key="formated.date" type="date" value="now" pattern="DDD HH:mm"/>
+</propertyfile>
+
+

+To produce dates relative from today :

+
<propertyfile
+    file="my.properties"
+    comment="My properties">
+  <entry  key="formated.date-1"
+      type="date" default="now" pattern="DDD"
+      operation="-" value="1"/>
+  <entry  key="formated.tomorrow"
+      type="date" default="now" pattern="DDD"
+      operation="+" value="1"/>
+</propertyfile>
+
+ +

+Concatenation of strings :

+
<propertyfile
+    file="my.properties"
+    comment="My properties">
+  <entry  key="progress" default="" operation="+" value="."/>
+</propertyfile>
+
+

Each time called, a "." will be appended to "progress" +

+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyhelper.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyhelper.html new file mode 100644 index 000000000..6c73b0be7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/propertyhelper.html @@ -0,0 +1,108 @@ + + + + + + +PropertyHelper Task + + + + +

PropertyHelper

+

Description

+

This task is provided for the purpose of allowing the user to +(a) install a different PropertyHelper at runtime, or +(b) (hopefully more often) install one or more PropertyHelper Delegates into the +PropertyHelper active on the current Project. This is somewhat advanced Apache Ant usage and +assumes a working familiarity with the modern Ant APIs. See the description of Ant's +Property Helper for more information. +Since Ant 1.8.0

+ +

Parameters specified as nested elements

+ +

PropertyHelper

+You may specify exactly one configured org.apache.tools.ant.PropertyHelper instance. + +

PropertyHelper.Delegate

+You may specify, either in conjunction with a new PropertyHelper or not, one or +more configured implementations of the org.apache.tools.ant.PropertyHelper.Delegate +interface. A deeper understanding of the API is required here, however, as Delegate +is a marker interface only: the nested arguments must implement a Delegate +subinterface in order to do anything meaningful. + +

delegate

+

A generic <delegate> element which can use project references +is also provided:

+ +
Parameters
+ + + + + + + + + + + +
AttributeDescriptionRequired
refidThe id of a PropertyHelper.Delegate to install.Yes
+ +

Examples

+ +

Install a completely different PropertyHelper implementation + (assuming MyPropertyHelper extends PropertyHelper):

+ +
+<componentdef classname="org.example.MyPropertyHelper"
+              name="mypropertyhelper"/>
+<propertyhelper>
+  <mypropertyhelper/>
+</propertyhelper>
+
+ +

Add a new PropertyEvaluator delegate + (assuming MyPropertyEvaluator implements + PropertyHelper.PropertyEvaluator). Note that PropertyHelper + uses the configured delegates in LIFO order. I.e. the delegate + added by this task will be consulted before any previously defined + delegate and in particular before the built-in ones.

+ +
+<componentdef classname="org.example.MyPropertyEvaluator"
+              name="mypropertyevaluator"/>
+<propertyhelper>
+  <mypropertyevaluator/>
+</propertyhelper>
+
+ +

Add a new PropertyEvaluator delegate using the refid syntax:

+ +
+<typedef classname="org.example.MyPropertyEvaluator"
+         name="mypropertyevaluator"/>
+<mypropertyevaluator id="evaluator"/>
+<propertyhelper>
+  <delegate refid="evaluator"/>
+</propertyhelper>
+
+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/pvcstask.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/pvcstask.html new file mode 100644 index 000000000..a95b32ece --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/pvcstask.html @@ -0,0 +1,295 @@ + + + + + + + +PVCS task + + + +

+Apache Ant Pvcs Task User Manual

+ +

Note: +Before using this task, the user running Ant must have access to the +commands of PVCS (get and pcli) and must have access to the +repository. Note that the way to specify the repository is platform +dependent so use property to specify location of repository. +

+ +by +
+ +Version 1.1 - 2001/06/27
+

Problems with UNC pathnames and the use of () in paths are fixed and an updateonly + argument introduced.

+Version 1.0 - 2001/01/31
+

Initial release.

+
+

+Table of Contents

+ +
+ +

Introduction

+The pvcs task allows the user of Ant to extract the latest edition +of the source code from a PVCS repository. PVCS is a version control system +developed by Merant. +
+This version has been tested against PVCS version 6.5 and 6.6 under Windows and Solaris. + +
+

Pvcs Task

+

Description

+The pvcs task is set to point at a PVCS repository and optionally a project +within that repository, and can from that specification get the latest +version of the files contained by the repository. +

+Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
repositoryThe location of the repository (see your PVCS +manuals)Yes
pvcsprojectThe project within the PVCS repository to extract +files from ("/" is root project and that is default if this attribute isn't +specified)No
labelOnly files marked with this label are extracted.No
promotiongroupOnly files within this promotion group are extracted. Using +both the label and the promotiongroup tag will cause the files in the +promotion group and with that label to be extracted. +No
configpath of a non default .cfg file. +Can be given absolute or relative to Ant's base directory. +No
forceIf set to yes all files that exists and are writable are overwritten. Default no causes the files that are writable to be ignored. This stops the PVCS command get to stop asking questions!No
workspaceBy specifying a workspace, the files are extracted to that location. A PVCS workspace is a +name for a location of the workfiles and isn't as such the location itself. You define the location for a workspace +using the PVCS GUI clients. If this isn't specified the default workspace for the current user is used.No
pvcsbinOn some systems the PVCS executables pcli +and get are not found in the PATH. In such cases this attribute +should be set to the bin directory of the PVCS installation containing +the executables mentioned before. If this attribute isn't specified the +tag expects the executables to be found using the PATH environment variable.No
ignorereturncodeIf set to true the return value from executing + the pvcs commands are ignored.No
updateonlyIf set to true files are gotten only if + newer than existing local files.No
filenameformatThe format of your folder names in a + format suitable for java.text.MessageFormat. + Defaults to {0}-arc({1}). Repositories where + the archive extension is not -arc should set + this.No
linestartUsed to parse the output of the pcli + command. It defaults to "P:. The parser already + knows about / and \\, this property is useful in cases where the + repository is accessed on a Windows platform via a drive letter + mapping.No
revisionRetrieve the specified revision.No
useridUse the specified userid.No
+

Nested Elements

+ +

pvcsproject element

+

pvcs supports a nested +<pvcsproject> element, that represents a project +within the PVCS repository to extract files from. By nesting multiple +<pvcsproject> elements under the +<pvcs> task, multiple projects can be +specified.

+ +

Parameters

+ + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the pvcs projectYes
+ +

Examples

+The following set-up extracts the latest version of the files in the pvcs repository. +
+  <!-- =================================================================== -->
+  <!-- Get the latest version                                              -->
+  <!-- =================================================================== -->
+  <target name="getlatest">
+    <pvcs repository="/mnt/pvcs" pvcsproject="/myprj"/>
+  </target>
+
+

Now run:

+ant getlatest +

This will cause the following output to appear:

+
+  getlatest:
+  [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
+  [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
+  [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
+  [pvcs] Copyright 1985-2000 MERANT. All rights reserved.
+  [pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc
+  [pvcs] rev 1.1
+  [pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tools.java-arc
+  [pvcs] rev 1.5
+
+  BUILD SUCCESSFUL
+
+  Total time: 19 seconds
+ +This next example extracts the latest version of the files in the pvcs +repository from two projects using nested <pvcsproject> elements. +
+  <!-- ===================================================================-->
+  <!-- Get latest from myprj and myprj2                                   -->
+  <!-- ===================================================================-->
+  <target name="getlatest2">
+    <pvcs repository="/mnt/pvcs">
+      <pvcsproject name="/myprj"/>
+      <pvcsproject name="/myprj2"/>
+    </pvcs>
+  </target>
+
+

Now run:

+ant getlatest2 +

This will cause the following output to appear:

+
+  getlatest2:
+  [pvcs] PVCS Version Manager (VMGUI) v6.6.10 (Build 870) for Windows NT/80x86
+  [pvcs] Copyright 1985-2000 MERANT.  All rights reserved.
+  [pvcs] PVCS Version Manager (get) v6.6.10 (Build 870) for Windows NT/80x86
+  [pvcs] Copyright 1985-2000 MERANT.  All rights reserved.
+  [pvcs] c:\myws\myprj\main.java <- C:\mypvcs\archives\myprj\main.java-arc
+  [pvcs] rev 1.1
+  [pvcs] c:\myws\myprj\apache\tool.java <- C:\mypvcs\archives\myprj\apache\tool.java-arc
+  [pvcs] rev 1.5
+  [pvcs] c:\myws\myprj2\apache\tool2.java <- C:\mypvcs\archives\myprj2\apache\tool2.java-arc
+  [pvcs] rev 1.2
+
+  BUILD SUCCESSFUL
+
+  Total time: 22 seconds
+ +
+

PVCS is a registered trademark of MERANT.

+ + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/recorder.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/recorder.html new file mode 100644 index 000000000..7a0b2d558 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/recorder.html @@ -0,0 +1,172 @@ + + + + + + +Recorder Task + + + + +

Record

+

Description

+

A recorder is a listener to the current build process that records the +output to a file.

+ +

Several recorders can exist at the same time. Each recorder is +associated with a file. The filename is used as a unique identifier for +the recorders. The first call to the recorder task with an unused filename +will create a recorder (using the parameters provided) and add it to the +listeners of the build. All subsequent calls to the recorder task using +this filename will modify that recorders state (recording or not) or other +properties (like logging level).

+ +

Some technical issues: the file's print stream is flushed for "finished" +events (buildFinished, targetFinished and taskFinished), and is closed on +a buildFinished event.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
nameThe name of the file this logger is associated with.yes
actionThis tells the logger what to do: should it start + recording or stop? The first time that the recorder task is called for + this logfile, and if this attribute is not provided, then the default + for this attribute is "start". If this attribute is not provided on + subsequent calls, then the state remains as previous. + [Values = {start|stop}, Default = no state change]no
appendShould the recorder append to a file, or create a new + one? This is only applicable the first time this task is called for + this file. [Values = {yes|no}, Default=no]no
emacsmodeRemoves [task] banners like Apache Ant's + -emacs command line switch if set to + true.no, default is false
loglevelAt what logging level should this recorder instance + record to? This is not a once only parameter (like append + is) -- you can increase or decrease the logging level as the build process + continues. [Values= {error|warn|info|verbose|debug}, Default = no change] + no
+ +

Examples

+

The following build.xml snippet is an example of how to use the recorder +to record just the <javac> task:

+
+    ...
+    <compile >
+        <record name="log.txt" action="start"/>
+        <javac ...
+        <record name="log.txt" action="stop"/>
+    <compile/>
+    ...
+
+ +

The following two calls to <record> set up two +recorders: one to file "records-simple.log" at logging level info +(the default) and one to file "ISO.log" using logging level of +verbose.

+
+    ...
+    <record name="records-simple.log"/>
+    <record name="ISO.log" loglevel="verbose"/>
+    ...
+
+ +

Notes

+

There is some functionality that I would like to be able to add in the +future. They include things like the following:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
listenerA classname of a build listener to use from this point + on instead of the default listener.no
includetargetA comma-separated list of targets to automatically + record. If this value is "all", then all targets are recorded. + [Default = all]no
excludetargetno
includetaskA comma-separated list of task to automatically + record or not. This could be difficult as it could conflict with the + includetarget/excludetarget. (e.g.: + includetarget="compile" exlcudetask="javac", what should + happen?)no
excludetaskno
actionadd greater flexibility to the action attribute. Things + like close to close the print stream.no
+ + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/rename.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/rename.html new file mode 100644 index 000000000..330fbe3a8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/rename.html @@ -0,0 +1,64 @@ + + + + + + +Rename Task + + + + +

Rename

+

Deprecated

+

This task has been deprecated. Use the Move task instead.

+

Description

+

Renames a given file.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
srcfile to rename.Yes
destnew name of the file.Yes
replaceEnable replacing of existing file (default: on).No
+

Examples

+
  <rename src="foo.jar" dest="${name}-${version}.jar"/>
+

Renames the file foo.jar to ${name}-${version}.jar (assuming name + and version being predefined properties). If a file named ${name}-${version}.jar + already exists, it will be removed prior to renaming foo.jar.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/renameextensions.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/renameextensions.html new file mode 100644 index 000000000..d2cbcdb39 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/renameextensions.html @@ -0,0 +1,123 @@ + + + + + + +RenameExtensions Task + + + + +

RenameExtensions

+

Deprecated

+

This task has been deprecated. Use the move +task with a glob mapper instead.

+

Description

+

Renames files in the srcDir directory ending with the +fromExtension string so that they end with the +toExtension string. Files are only replaced if +replace is true +

+

See the section on +directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns. +This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes srcDir) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when + omitted.No
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when + omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
fromExtentionThe string that files must end in to be renamedYes
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
replaceWhether the file being renamed to should be + replaced if it already existsNo
srcDirThe starting directory for files to search inYes
toExtensionThe string that renamed files will end with on + completionYes
+

Examples

+
+

<renameext srcDir="/source/project1" + includes="**" + excludes="**/samples/*" + fromExtension=".java.keep" + toExtension=".java" + replace="true"/> + +

+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/replace.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/replace.html new file mode 100644 index 000000000..36204d0cb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/replace.html @@ -0,0 +1,242 @@ + + + + + + +Replace Task + + + + +

Replace

+

Description

+

Replace is a directory based task for replacing the occurrence of a given string with another string +in selected file.

+

If you want to replace a text that crosses line boundaries, you +must use a nested <replacetoken> element.

+ +

The output file is only written if it differs from the existing +file. This prevents spurious rebuilds based on unchanged files which +have been regenerated by this task.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filefile for which the token should be replaced.Exactly one of the two.
dirThe base directory to use when replacing a token in + multiple files.
encodingThe encoding of the files upon which replace operates.No - defaults to default JVM encoding
tokenthe token which must be replaced.Yes, unless a nested + replacetoken element or the replacefilterfile + attribute is used.
valuethe new value for the token. When omitted, an empty string + ("") is used.No
summaryIndicates whether a summary of the replace operation + should be produced, detailing how many token occurrences + and files were processed + No, by default no summary is produced
propertyFilevalid property file from which properties specified using nested <replacefilter> elements are drawn.Yes only if property attribute of <replacefilter> is used.
replacefilterfilevalid property file. Each property will be + treated as a replacefilter where token is the name of + the property and value is the properties value. + No.
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
preserveLastModifiedKeep the file timestamp(s) even if the file(s) + is(are) modified. since Apache Ant 1.8.0.No, defaults to false
failOnNoReplacementsWhether to fail the build if the task didn't do + anything. since Ant 1.8.0.No, defaults to false
+

Examples

+
  <replace file="${src}/index.html" token="@@@" value="wombat"/>
+

replaces occurrences of the string "@@@" with the string +"wombat", in the file ${src}/index.html.

+

Parameters specified as nested elements

+

This task forms an implicit FileSet and +supports most attributes of <fileset> as well as the +nested <include>, <exclude> and +<patternset> elements.

+

Since Ant 1.8.0 this task supports any filesystem + based resource + collections as nested elements.

+

replacetoken and replacevalue

+

If either the text you want to replace or the replacement text +cross line boundaries, you can use nested elements to specify +them.

+

The elements support attributes:

+ + + + + + + + + + + +
AttributeDescriptionRequired
expandPropertiesWhether to expand properties in the nested text. + since Ant 1.8.0.No, defaults to true.
+

Examples

+
+<replace dir="${src}" value="wombat">
+  <include name="**/*.html"/>
+  <replacetoken><![CDATA[multi line
+token]]></replacetoken>
+</replace>
+
+

replaces occurrences of the string "multi +line\ntoken" with the string "wombat", in all +HTML files in the directory ${src}.Where \n is +the platform specific line separator.

+
+<replace file="${src}/index.html">
+  <replacetoken><![CDATA[two line
+token]]></replacetoken>
+  <replacevalue><![CDATA[two line
+token]]></replacevalue>
+</replace>
+
+

replacefilter

+

In addition to allowing for multiple replacements, optional nested <replacefilter> elements allow replacement values to be extracted from a property file. The name of this file is specified using the <replace> attribute propertyFile. +

+ + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
tokenThe string to search for.Yes unless a nested replacetoken + is specified
valueThe replacement string.Either may be specified, but not both. Both can be omitted, if desired.
propertyName of the property whose value is to serve as the replacement value.
+

Since Ant 1.8.0 token and value can be specified as nested elements + just like in the task itself.

+

If neither value nor property is used, the value provided using the <replace> attribute value and/or the <replacevalue> element is used. If no value was specified using either of these options, the token is replaced with an empty string. +

+

Examples

+
+<replace 
+    file="configure.sh"
+    value="defaultvalue"
+    propertyFile="src/name.properties">
+  <replacefilter 
+    token="@token1@"/>
+  <replacefilter 
+    token="@token2@" 
+    value="value2"/>
+  <replacefilter 
+    token="@token3@" 
+    property="property.key"/>
+  <replacefilter>
+    <replacetoken>@token4@</replacetoken> 
+    <replacevalue>value4</replacevalue>
+  </replacefilter>
+</replace>
+
+

In file configure.sh, replace all instances of "@token1@" with "defaultvalue", all instances of "@token2@" with "value2", and all instances of "@token3@" with the value of the property "property.key", as it appears in property file src/name.properties.

+

Note: It is possible to use either the token/<replacetoken> and value/<replacevalue> attributes/elements, the nested replacefilter elements, or both in the same operation. +

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/replaceregexp.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/replaceregexp.html new file mode 100644 index 000000000..9d1276d09 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/replaceregexp.html @@ -0,0 +1,168 @@ + + + + + + +ReplaceRegExp Task + + + +

ReplaceRegExp

+

Description

+

ReplaceRegExp is a directory based task for replacing the +occurrence of a given regular expression with a substitution pattern +in a selected file or set of files.

+ +

The output file is only written if it differs from the existing +file. This prevents spurious rebuilds based on unchanged files which +have been regenerated by this task.

+ +

Similar to regexp +type mappers this task needs a supporting regular expression +library and an implementation of +org.apache.tools.ant.util.regexp.Regexp. +See details in the documentation of the Regexp Type.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
filefile for which the regular expression should be replaced.Yes if no nested <fileset> is used
matchThe regular expression pattern to match in the file(s)Yes, if no nested <regexp> is used
replaceThe substitution pattern to place in the file(s) in place + of the regular expression.Yes, if no nested <substitution> is used
flagsThe flags to use when matching the regular expression. For more + information, consult the Perl5 syntax
+ g : Global replacement. Replace all occurrences found
+ i : Case Insensitive. Do not consider case in the match
+ m : Multiline. Treat the string as multiple lines of input, using "^" and "$" as the start or end of any line, respectively, rather than start or end of string.
+ s : Singleline. Treat the string as a single line of input, using "." to match any character, including a newline, which normally, it would not match.
+ 		No
bylineProcess the file(s) one line at a time, executing the replacement + on one line at a time (true/false). This is useful if you + want to only replace the first occurrence of a regular expression on + each line, which is not easy to do when processing the file as a whole. + Defaults to false.No
encodingThe encoding of the file. since Apache Ant 1.6No - defaults to default JVM encoding
preserveLastModifiedKeep the file timestamp(s) even if the file(s) + is(are) modified. since Ant 1.8.0.No, defaults to false
+

Examples

+
+<replaceregexp file="${src}/build.properties"
+               match="OldProperty=(.*)"
+               replace="NewProperty=\1"
+               byline="true"
+/>
+
+

replaces occurrences of the property name "OldProperty" + with "NewProperty" in a properties file, preserving the existing +value, in the file ${src}/build.properties

+ +

Parameters specified as nested elements

+

This task supports a nested FileSet + element.

+

Since Ant 1.8.0 this task supports any filesystem + based resource + collections as nested elements.

+

This task supports a nested Regexp element to specify + the regular expression. You can use this element to refer to a previously + defined regular expression datatype instance.

+
+ <regexp id="id" pattern="alpha(.+)beta"/>
+ <regexp refid="id"/> +
+

This task supports a nested Substitution element to specify + the substitution pattern. You can use this element to refer to a previously + defined substitution pattern datatype instance.

+
+ <substitution id="id" expression="beta\1alpha"/>
+ <substitution refid="id"/> +
+

Examples

+
+ 
+<replaceregexp byline="true">
+  <regexp pattern="OldProperty=(.*)"/>
+  <substitution expression="NewProperty=\1"/>
+  <fileset dir=".">
+    <include name="*.properties"/>
+  </fileset>
+</replaceregexp>
+
+

replaces occurrences of the property name "OldProperty" + with "NewProperty" in a properties file, preserving the existing +value, in all files ending in .properties in the current directory

+ +
+
<replaceregexp match="\s+" replace=" " flags="g" byline="true">
+    <fileset dir="${html.dir}" includes="**/*.html"/>
+</replaceregexp>
+
+

replaces all whitespaces (blanks, tabs, etc) by one blank remaining the +line separator. So with input + +

+
+<html>    <body>
+<<TAB>><h1>    T E S T   </h1>  <<TAB>>    
+<<TAB>> </body></html>
+
+would converted to +
+<html> <body>
+ <h1> T E S T </h1> </body></html>
+
+

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/resourcecount.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/resourcecount.html new file mode 100644 index 000000000..a34506b13 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/resourcecount.html @@ -0,0 +1,107 @@ + + + + + + +ResourceCount Task + + + + +

ResourceCount

+ +

Description

+

Display or set a property containing the size of a nested + Resource Collection. + Can also be used as a condition. Since Apache Ant 1.7

+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
propertyThe property to set. If omitted the results are written + to the log. Ignored when processing as a condition.No
refidA reference + to a Resource Collection. + Yes, unless a nested Resource Collection is supplied +
countComparison count for processing as a condition.Yes, in condition mode
whenComparison type: "equal", "eq", "greater", "gt", "less", + "lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal) + for use when operating as a condition.No; default is "equal"
+ +

Parameters specified as nested elements

+

Resource Collection

+

A single + Resource Collection +should be specified via a nested element or the refid attribute. +

+ +

Examples

+
<resourcecount property="count.foo">
+  <filelist dir="." files="foo,bar" />
+</resourcecount>
+
+

Stores the number of resources in the specified filelist (two) +in the property named count.foo.

+ +
+<project>
+  <property name="file" value="${ant.file}"/>
+  <resourcecount property="file.lines">
+    <tokens>
+      <concat>
+        <filterchain>
+          <tokenfilter>
+            <linetokenizer/>
+          </tokenfilter>
+        </filterchain>
+        <fileset file="${file}"/>
+      </concat>
+    </tokens>
+  </resourcecount>
+  <echo>The file '${file}' has ${file.lines} lines.</echo>
+</project>
+
+

Stores the number of lines of the current buildfile in the property file.lines. +Requires Ant 1.7.1+ as <concat> has to be resource.

+ + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/retry.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/retry.html new file mode 100644 index 000000000..04ee8a567 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/retry.html @@ -0,0 +1,55 @@ + + + + + + +Retry Task + + +

Retry

+

Description

+

Retry is a container which executes a single nested task until either: there is no failure; or: +its retrycount has been exceeded. If this happens a BuildException is thrown. +Since Apache Ant 1.7.1

+ +

Parameters

+ + + + + + + + + + + +
AttributeDescriptionRequired
retrycountnumber of times to attempt to execute the nested taskYes
+

Any valid Ant task may be embedded within the retry task.

+ +

Example

+
+<retry retrycount="3">
+  <get src="http://www.unreliable-server.com/unreliable.tar.gz" 
+       dest="/home/retry/unreliable.tar.gz" />
+</retry>
+
+

This example shows how to use <retry> to wrap a task which must interact with an unreliable network resource.

+ + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/rexec.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/rexec.html new file mode 100644 index 000000000..02f6fe23a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/rexec.html @@ -0,0 +1,116 @@ + + + + + + +RExec Task + + + + +

RExec

+

Description

+Task to automate a remote rexec session. Just like the Telnet task, +it uses nested <read> to indicate strings to wait for, and +<write> tags to specify text to send to the remote process. + +

Note: This task depends on external libraries not included in the Apache Ant distribution. +See Library Dependencies for more information.

+ +

You can specify the commands you want to execute as nested elements +or via the command attribute, we recommend you use the command +attribute. If you use the command attribute, you must use the +username and password attributes as well.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeValuesRequired
useridthe login id to use on the remote server.No
passwordthe login password to use on the remote server.No
serverthe address of the remote rexec server.Yes
commandthe command to execute on the remote server.No
portthe port number of the remote rexec server. Defaults to port 512 in BSD Unix systems.No
timeoutset a default timeout to wait for a response. Specified in seconds. Default is no timeout.No
+

Nested Elements

+The input to send to the server, and responses to wait for, are +described as nested elements. + +

read

+ +

declare (as a text child of this element) a string to wait for. +The element supports the timeout attribute, which overrides any +timeout specified for the task as a whole. It also has a string +attribute, which is an alternative to specifying the string as +a text element. +

+It is not necessary to declare a closing <read> element like for the Telnet task. The connection is not broken until the command has completed and +the input stream (output of the command) is terminated. + +

write

+ +

describes the text to send to the server. The echo boolean +attribute controls whether the string is echoed to the local log; +this is "true" by default +

+

Example

+A simple example of connecting to a server and running a command. + +
+<rexec userid="bob" password="badpass" server="localhost" command="ls"/>
+
+ +The task can be used with other ports as well: +
+<rexec port="80" userid="bob" password="badpass" server="localhost" command="ls"/>
+
+ + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/rmic.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/rmic.html new file mode 100644 index 000000000..b644c68cd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/rmic.html @@ -0,0 +1,353 @@ + + + + + + +Rmic Task + + + + +

Rmic

+

Description

+

Runs the rmic compiler for a certain class.

+

Rmic can be run on a single class (as specified with the classname +attribute) or a number of classes at once (all classes below base that +are neither _Stub nor _Skel classes). If you want to rmic a single +class and this class is a class nested into another class, you have to +specify the classname in the form Outer$$Inner instead of +Outer.Inner.

+

It is possible to refine the set of files that are being rmiced. This can be +done with the includes, includesfile, excludes, excludesfile and defaultexcludes +attributes. With the includes or includesfile attribute you specify the files you want to +have included by using patterns. The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

+

This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes base) as well as the nested +<include>, <exclude> and +<patternset> elements.

+

It is possible to use different compilers. This can be selected +with the "build.rmic" property, the compiler +attribute. or a nested element. +Here are the choices:

+
    +
  • default -the default compiler (kaffe or sun) for the platform. +
  • sun (the standard compiler of the JDK)
    • +
  • kaffe (the standard compiler of Kaffe)
    • +
  • weblogic
    • +
  • forking - the sun compiler forked into a separate process (since Apache Ant 1.7)
    • +
  • xnew - the sun compiler forked into a separate process, + with the -Xnew option (since Ant 1.7). + This is the most reliable way to use -Xnew
    • +
  • "" (empty string). This has the same behaviour as not setting the compiler attribute. + First the value of build.rmic is used if defined, and if not, the default + for the platform is chosen. If build.rmic is set to this, you get the default. + +
+ +

The miniRMI +project contains a compiler implementation for this task as well, +please consult miniRMI's documentation to learn how to use it.

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
basethe location to store the compiled files. + Also serves as the parent directory for any non-Fileset includes, etc. + (This functionality has remained unchanged.)*1
destdirthe location to store the compiled files.
classnamethe class for which to run rmic.No
filteringindicates whether token filtering should take placeNo
sourcebasePass the "-keepgenerated" flag to rmic and + move the generated source file to the given sourcebase directory.No
stubversionSpecify the JDK version for the generated stub code. + Specify "1.1" to pass the "-v1.1" option to rmic, + "1.2" for -v12, compat for -vcompat.
+ Since Ant1.7, if you do not specify a version, and do not ask + for iiop or idl files, "compat" is selected. + + 		No, default="compat"
classpathThe classpath to use during compilationNo
classpathrefThe classpath to use during compilation, given as reference to a PATH defined elsewhereNo
includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
verifycheck that classes implement Remote before handing them + to rmic (default is false)No
iiopindicates that portable (RMI/IIOP) stubs should be generatedNo
iiopoptsadditional arguments for IIOP class generationNo
idlindicates that IDL output files should be generatedNo
idloptsadditional arguments for IDL file generationNo
debuggenerate debug info (passes -g to rmic). Defaults to false.No
includeAntRuntimewhether to include the Ant run-time libraries; + defaults to yes.No
includeJavaRuntimewhether to include the default run-time + libraries from the executing VM; defaults to no.No
extdirslocation of installed extensions.No
compilerThe compiler implementation to use. + If this attribute is not set, the value of the + build.rmic property, if set, will be used. + Otherwise, the default compiler for the current VM will be used. + (See the above list of valid + compilers.)No
executableComplete path to the rmic + executable to use in case of the forking + or xnew compiler. + Defaults to the rmic compiler of the Java version that is currently + running Ant.
+ Since Ant 1.8.0.		No
listfilesIndicates whether the source files to be compiled will + be listed; defaults to no.
+ Since Ant 1.8.0.		No
+ +

*1: +

    +
  • Maintaining compatibility, base, when specified by + itself, serves as both the parent directory for any source files + AND the output directory.
    • +
  • destdir can be used to specify the output + directory, allowing for base to be used as the parent + directory for any source files.
    • +
  • At least one of either base or destdir + must be specified and exist, or a runtime error will + occur.
    • +
+

+ +

Parameters specified as nested elements

+

classpath and extdirs

+

Rmic's classpath and extdirs attributes are PATH like structure and can also be set via a nested +classpath and extdirs elements.

+ +

compilerarg

+ +

You can specify additional command line arguments for the compiler +with nested <compilerarg> elements. These elements +are specified like Command-line +Arguments but have an additional attribute that can be used to +enable arguments only if a given compiler implementation will be +used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
valueSee + Command-line Arguments.Exactly one of these.
line
file
path
prefixSee + Command-line Arguments. + Since Ant 1.8.No
suffixNo
compilerOnly pass the specified argument if the chosen + compiler implementation matches the value of this attribute. + Legal values are the + same as those in the above list of valid + compilers.)No
+ +

compilerclasspath since Ant 1.8.0

+ +

A PATH like structure holding the + classpath to use when loading the compiler implementation if a + custom class has been specified. Doesn't have any effect when + using one of the built-in compilers.

+ +

Any nested element of a type that implements RmicAdapter + since Ant 1.8.0

+ +

If a defined type implements the RmicAdapter + interface a nested element of that type can be used as an + alternative to the compiler attribute.

+ +

Examples

+
  <rmic classname="com.xyz.FooBar" base="${build}/classes"/>
+

runs the rmic compiler for the class com.xyz.FooBar. The +compiled files will be stored in the directory ${build}/classes.

+
  <rmic base="${build}/classes" includes="**/Remote*.class"/>
+

runs the rmic compiler for all classes with .class +files below ${build}/classes whose classname starts with +Remote. The compiled files will be stored in the directory +${build}/classes.

+ +

If you want to use a custom + RmicAdapter org.example.MyAdapter you can either + use the compiler attribute:

+
+<rmic classname="com.xyz.FooBar"
+      base="${build}/classes"
+      compiler="org.example.MyAdapter"/>
+
+

or a define a type and nest this into the task like in:

+
+<componentdef classname="org.example.MyAdapter"
+              name="myadapter"/>
+<rmic classname="com.xyz.FooBar"
+      base="${build}/classes">
+  <myadapter/>
+</rmic>
+
+

in which case your compiler adapter can support attributes and + nested elements of its own.

+ + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/rpm.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/rpm.html new file mode 100644 index 000000000..61cde7189 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/rpm.html @@ -0,0 +1,123 @@ + + + + + + +Rpm Task + + + + +

Rpm

+

Description

+

+ A basic task for invoking the rpm executable to build a RedHat Package Manager Linux installation + file. The task currently only works on Linux or other Unix platforms with rpm support. +

+ +

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
specFileThe name of the spec file to be used. This must be relative to the SPECS directory + under the root of the RPM set in the topDir attribute.Yes
topDir + This is the directory which will have the expected + subdirectories, SPECS, SOURCES, BUILD, SRPMS. If this isn't specified, + the default RPM directory of the system (or user, if ~/.rpmmacros defines it) is used (often + /usr/src/rpm.
+ Defining a topdir will set %_topdir to the specified directory -there is no need + to edit your .rpmmacros file. + 		No, but your build file is very brittle if it is not set.
cleanBuildDirThis will remove the generated files in the BUILD + directory. + See the the --clean option of rpmbuild. + No
removeSpecThis will remove the spec file from SPECS. + See the the --rmspec option of rpmbuild. + No
removeSourceFlag (optional, default=false) + to remove the sources after the build. + See the the --rmsource option of rpmbuild.No
rpmBuildCommandThe executable to use for building the RPM. + Defaults to rpmbuild if it can be found or + rpm otherwise. Set this if you don't have either on + your PATH or want to use a different executable. Since Apache Ant + 1.6.No
commandThe command to pass to the rpmbuild program. The default is "-bb"No
quietSuppress output. Defaults to false.No
output/errorWhere standard output and error goNo
failOnErrorStop the buildprocess if the RPM build command exits with + a non-zero retuncode. Defaults to falseNo
+ +

Examples

+
+    <rpm
+        specFile="example.spec"
+        topDir="build/rpm"
+        cleanBuildDir="true"
+        failOnError="true"/>
+
+ + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/schemavalidate.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/schemavalidate.html new file mode 100644 index 000000000..fce3f201f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/schemavalidate.html @@ -0,0 +1,283 @@ + + + + + +SchemaValidate Task + + + + +

SchemaValidate

+

Description

+ +

This task validates XML files described by an XML Schema. +The task extends the XmlValidate task with XSD-specific features.

+
    +
  1. The parser is created validating and namespace aware +
    2. +
  2. Validation is turned on.
    3. +
  3. Schema validation is turned on.
    4. +
  4. Any no-namespace schema URL or file supplied is used as the no-namespace schema +
  5. All nested schema declarations are turned into the list of namespace-url +bindings for schema lookup. +
+ +Note that nested catalogs are still used for lookup of the URLs given as the +sources of schema documents, so you can still delegate lookup to a catalog, you +just need to list all schema URIs and their URL equivalents. + +

This task supports the use of nested +

  • <xmlcatalog> elements
    • +
  • <schema> elements, that bind a namespace URI to a URL or a + local filename. +
  • <dtd> elements which are used to resolve DTDs and entities.
    • +
  • <attribute> elements which are used to set features on the parser. + These can be any number of + http://xml.org/sax/features/ + or other features that your parser may support.
    • +
  • <property> elements, containing string properties +

    + +

    +The task only supports SAX2 or later parsers: it is an error to specify a SAX1 +parser. + + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnamethe parser to use.No
    classpathrefwhere to find the parser class. + Optionally can use an embedded <classpath> element.No
    disableDTD + Flag to disable DTD support. DTD support is needed to + validate XSD files themselves, amongst others. + No - default false
    failonerrorfails on a error if set to true (defaults to true).No
    filethe file(s) you want to check. (optionally can use an embedded fileset)No
    fullchecking + enable full schema checking. Slow but strict. + No - default true
    lenient + if true, only check the XML document is well formed + No
    noNamespaceFile + filename of a no-namespace XSD file to provide the + schema for no-namespace XML content. + No
    noNamespaceURL + URL of a no-namespace XSD file to provide the + schema for no-namespace XML content. + No
    warnlog parser warn events.No
    + +

    Nested Elements

    + + +

    schema

    +

    +Identify the name and location of a schema that may be used in validating +the document(s). +

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namespaceURI of the schema namespaceYes
    urlURL of the schemaOne of url or file is required
    filefile of the schemaOne of url or file is required
    + +

    dtd

    +

    +<dtd> is used to specify different locations for DTD resolution. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    publicIdPublic ID of the DTD to resolveYes
    locationLocation of the DTD to use, which can be a file, + a resource, or a URLYes
    +

    xmlcatalog

    +

    The <xmlcatalog> +element is used to perform entity resolution.

    +

    attribute

    +

    The <attribute> element is used to set parser features.
    +Features usable with the xerces parser are defined here : + Setting features
    + +SAX features are defined here: + http://xml.org/sax/features/
    +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the featureYes
    valueThe boolean value of the featureYes
    +

    + +

    property

    +

    The <property> element is used to set properties. +These properties are defined here for the xerces XML parser implementation : + XML Parser properties +Properties can be used to set the schema used to validate the XML file. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the featureYes
    valueThe string value of the propertyYes
    +

    + + +

    Examples

    +
    +    <schemavalidate
+      noNamespaceFile="document.xsd"
+      file="xml/endpiece.xml">
+    </schemavalidate>
+
    +Validate a document against an XML schema. The document does not declare +any schema itself, which is why the noNamespaceFile is needed. +
    +    <presetdef name="validate-soap">
+      <schemavalidate >
+        <schema namespace="http://schemas.xmlsoap.org/ws/2003/03/addressing"
+          file="${soap.dir}/ws-addressing.xsd" />
+        <schema namespace="http://www.w3.org/2003/05/soap-envelope"
+          file="${soap.dir}/soap12.xsd" />
+        <schema namespace="http://schemas.xmlsoap.org/wsdl/"
+          file="${soap.dir}/wsdl.xsd" />
+        <schema namespace="http://www.w3.org/2001/XMLSchema"
+          file="${soap.dir}/XMLSchema.xsd" />
+        </schemavalidate>
+    </presetdef>
+
    +Declare a new preset task, <validate-soap>, that validates +XSD and WSDL documents against the relevant specifications. +To validate XSD documents, you also need XMLSchema.dtd and datatypes.dtd in +the same directory as XMLSchema.xsd, or pointed to via the catalog. All +these files can be fetched from +the W3C. +
    +    <validate-soap file="xml/test.xsd"/>
+
    +Use the preset task defined above to validate an XML Schema document. +
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/scp.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/scp.html new file mode 100644 index 000000000..51586f02d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/scp.html @@ -0,0 +1,275 @@ + + + + + + +SCP Task + + + + +

    SCP

    +

    Description

    + +

    since Apache Ant 1.6

    + +

    Copies a file or FileSet to or from a (remote) machine running an SSH daemon. +FileSet only works for copying files from the local machine to a +remote machine.

    + +

    Note: This task depends on external libraries not included +in the Ant distribution. See Library Dependencies +for more information. This task has been tested with jsch-0.1.2 and later.

    + +

    See also the sshexec task

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe file to copy. This can be a local path or a + remote path of the form user[:password]@host:/directory/path. + :password can be omitted if you use key based + authentication or specify the password attribute. The way remote + path is recognized is whether it contains @ character or not. This + will not work if your localPath contains @ character.Yes, unless a nested + <fileset> element is used.
    localFileThis is an alternative to the file attribute. But + this must always point to a local file. The reason this was added + was that when you give file attribute it is treated as remote if + it contains @ character. This character can exist also in local + paths. since Ant 1.6.2Alternative to file attribute.
    remoteFileThis is an alternative to the file attribute. But + this must always point to a remote file. since Ant 1.6.2Alternative to file attribute.
    todirThe directory to copy to. This can be a local path + or a remote path of the form user[:password]@host:/directory/path. + :password can be omitted if you use key based + authentication or specify the password attribute. The way remote + path is recognized is whether it contains @ character or not. This + will not work if your localPath contains @ character.Yes
    localTodirThis is an alternative to the todir + attribute. But this must always point to a local directory. The + reason this was added was that when you give todir attribute it is + treated as remote if it contains @ character. This character can + exist also in local paths. since Ant 1.6.2Alternative to todir attribute.
    localTofileChanges the file name to the given name while + receiving it, only useful if receiving a single file. since + Ant 1.6.2Alternative to todir attribute.
    remoteTodirThis is an alternative to the todir + attribute. But this must always point to a remote directory. + since Ant 1.6.2Alternative to todir attribute.
    remoteTofileChanges the file name to the given name while + sending it, only useful if sending a single file. since + Ant 1.6.2Alternative to todir attribute.
    portThe port to connect to on the remote host.No, defaults to 22.
    trustThis trusts all unknown hosts if set to yes/true.
    + Note If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.    		No, defaults to No.
    knownhostsThis sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.No, defaults to + ${user.home}/.ssh/known_hosts.
    failonerrorWhether to halt the build if the transfer fails. + No; defaults to true.
    passwordThe password.Not if you are using key based + authentication or the password has been given in the file or + todir attribute.
    keyfileLocation of the file holding the private key.Yes, if you are using key based + authentication.
    passphrasePassphrase for your private key.No, defaults to an empty string.
    verboseDetermines whether SCP outputs verbosely to the + user. Currently this means outputting dots/stars showing the + progress of a file transfer. since Ant 1.6.2No; defaults to false.
    sftpDetermines whether SCP uses the sftp protocol. + The sftp protocol is the file transfer protocol of SSH2. It is + recommended that this be set to true if you are copying to/from a + server that doesn't support scp1. since Ant 1.7No; defaults to false.
    preserveLastModifiedDetermines whether the last modification + timestamp of downloaded files is preserved. It only works when + transferring from a remote to a local system and probably doesn't + work with a server that doesn't support SSH2. since Ant + 1.8.0No; defaults to false.
    +

    Parameters specified as nested elements

    + +

    fileset

    +

    FileSets are used to select +sets of files to copy. + To use a fileset, the todir attribute must be set.

    + +

    Examples

    +

    Copy a single local file to a remote machine

    +
    +  <scp file="myfile.txt" todir="user:password@somehost:/home/chuck"/>
+
    + +

    Copy a single local file to a remote machine with separate +password attribute

    +
    +  <scp file="myfile.txt" todir="user@somehost:/home/chuck" password="password"/>
+
    + +

    Copy a single local file to a remote machine using key base +authentication.

    +
    +  <scp file="myfile.txt"
+       todir="user@somehost:/home/chuck" 
+       keyfile="${user.home}/.ssh/id_dsa"
+       passphrase="my extremely secret passphrase"
+  />
+
    + +

    Copy a single remote file to a local directory

    +
    +  <scp file="user:password@somehost:/home/chuck/myfile.txt" todir="../some/other/dir"/>
+
    + +

    Copy a remote directory to a local directory

    +
    +  <scp file="user:password@somehost:/home/chuck/*" todir="/home/sara"/>
+
    + +

    Copy a local directory to a remote directory

    +
    +  <scp todir="user:password@somehost:/home/chuck/">
+    <fileset dir="src_dir"/>
+  </scp>
+
    +

    Copy a set of files to a directory

    +
    +  <scp todir="user:password@somehost:/home/chuck">
+    <fileset dir="src_dir">
+      <include name="**/*.java"/>
+    </fileset>
+  </scp>
+
+  <scp todir="user:password@somehost:/home/chuck">
+    <fileset dir="src_dir" excludes="**/*.java"/>
+  </scp>
+
    + +

    Security Note: Hard coding passwords and/or usernames +in scp task can be a serious security hole. Consider using variable +substitution and include the password on the command line. For example: +

    +

    +    <scp todir="${username}:${password}@host:/dir" ...>
+
    +Invoking ant with the following command line: +
    +    ant -Dusername=me -Dpassword=mypassword target1 target2
+
    + +Is slightly better, but the username/password is exposed to all users on an Unix +system (via the ps command). The best approach is to use the +<input> task and/or retrieve the password from a (secured) +.properties file. + +

    + +

    Unix Note: File permissions are not retained when files +are copied; they end up with the default UMASK permissions +instead. This is caused by the lack of any means to query or set file +permissions in the current Java runtimes. If you need a permission- +preserving copy function, use <exec executable="scp" ... > +instead. +

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/script.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/script.html new file mode 100644 index 000000000..fb008224a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/script.html @@ -0,0 +1,393 @@ + + + + + + +Script Task + + + + +

    Script

    +

    Description

    +

    Execute a script in a + Apache BSF + or + JSR 223 supported language. +

    +

    Note: + This task depends on external libraries not included in the Apache Ant distribution. + See Library Dependencies + for more information. +

    +

    + The task may use the BSF scripting manager or the JSR 223 manager that + is included in JDK6 and higher. This is controlled by the manager + attribute. The JSR 223 scripting manager is indicated by "javax". +

    +

    All items (tasks, targets, etc) of the running project are + accessible from the script, using either their name or + id attributes (as long as their names are considered + valid Java identifiers, that is). + This is controlled by the "setbeans" attribute of the task. + The name "project" is a pre-defined reference to the Project, which can be + used instead of the project name. The name "self" is a pre-defined reference to the actual + <script>-Task instance.
    From these objects you have access to the Ant Java API, see the +JavaDoc (especially for +Project and +Script) for more information.

    +

    If you are using JavaScript under BSF, a good resource is +http://www.mozilla.org/rhino/doc.html as we are using their JavaScript interpreter.

    +

    Scripts can do almost anything a task written in Java could do.

    +

    Rhino provides a special construct - the JavaAdapter. With that you can +create an object which implements several interfaces, extends classes and for which you +can overwrite methods. Because this is an undocumented feature (yet), here is the link +to an explanation: +Groups@Google: "Rhino, enum.js, JavaAdapter?" by Norris Boyd in the newsgroup +netscape.public.mozilla.jseng.

    + +

    If you are creating Targets programmatically, make sure you set the +Location to a useful value. In particular all targets should have +different location values.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    languageThe programming language the script is written in. + Must be a supported Apache BSF or JSR 223 languageYes
    manager + Since: Ant 1.7. + The script engine manager to use. This can have + one of three values ("auto", "bsf" or "javax"). + The default value is "auto". +
    +
  • "bsf" use the BSF scripting manager to run + the language.
    • +
  • "javax" use the javax.scripting manager + to run the language. (This will only work for JDK6 and higher).
    • +
  • "auto" use the BSF engine if it exists, + otherwise use the javax.scripting manager.
    • +
    +     		No
    srcThe location of the script as a file, if not inlineNo
    setbeans + This attribute controls whether to set variables for + all properties, references and targets in the running script. + If this attribute is false, only the the "project" and "self" variables are set. + If this attribute is true all the variables are set. The default value of this + attribute is "true". Since Ant 1.7 + No
    classpath + The classpath to pass into the script. Since Ant 1.7 + No
    classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + Since Ant 1.7No
    +

    Parameters specified as nested elements

    +

    classpath

    +

    Since Ant 1.7

    +

    + Script's classpath attribute is a + path-like structure and can also be set via a nested + <classpath> element. +

    + If a classpath is set, it will be used as the current thread + context classloader, and + as the classloader given to the BSF manager. + This means that it can be used to specify + the classpath containing the language implementation for BSF + or for JSR 223 managers. + This can be useful if one wants + to keep ${user.home}/.ant/lib free of lots of scripting language + specific jar files. +

    +

    + NB: (Since Ant 1.7.1) + This classpath can be used to + specify the location of + the BSF jar file and/or languages + that have engines in the BSF jar file. This includes the + javascript, jython, netrexx and jacl languages. +

    +

    +

    Examples

    +The following snippet shows use of five different languages: + 
    +    <property name="message" value="Hello world"/>
+
+    <script language="groovy">
+      println("message is " + message)
+    </script>
+
+    <script language="beanshell">
+      System.out.println("message is " + message);
+    </script>
+
+    <script language="judoscript">
+        println 'message is ', message
+    </script>
+
+    <script language="ruby">
+        print 'message is ', $message, "\n"
+    </script>
+
+    <script language="jython">
+print "message is %s" % message
+    </script>
+
    +
    +

    + Note that for the jython example, the script contents must + start on the first column. +

    +

    + Note also that for the ruby example, the names of the set variables are prefixed + by a '$'. +

    + The following script shows a little more complicated jruby example: +

    + 
    +<script language="ruby">
+  xmlfiles = Dir.new(".").entries.delete_if { |i| ! (i =~ /\.xml$/) }
+  xmlfiles.sort.each { |i| $self.log(i) }
+</script>
+
    +
    +

    + The same example in groovy is: +

    + 
    +<script language="groovy">
+  xmlfiles = new java.io.File(".").listFiles().findAll{ it =~ "\.xml$"}
+  xmlfiles.sort().each { self.log(it.toString())}
+</script>
+
    +
    +

    + The following example shows the use of classpath to specify the location + of the beanshell jar file. +

    + 
    +<script language="beanshell" setbeans="true">
+  <classpath>
+    <fileset dir="${user.home}/lang/beanshell" includes="*.jar" />
+  </classpath>
+  System.out.println("Hello world");
+</script>
+
    +
    +

    + The following script uses javascript to create a number of + echo tasks and execute them. +

    +
    +<project name="squares" default="main" basedir=".">
+
+  <target name="main">
+
+    <script language="javascript"> <![CDATA[
+
+      for (i=1; i<=10; i++) {
+        echo = squares.createTask("echo");
+        echo.setMessage(i*i);
+        echo.perform();
+      }
+
+    ]]> </script>
+
+  </target>
+
+</project>
+
    +

    generates

    +
    +main:
+1
+4
+9
+16
+25
+36
+49
+64
+81
+100
+
+BUILD SUCCESSFUL
+
    + +

    Now a more complex example using the Java API and the Ant API. The goal is to list the +filesizes of all files a <fileset/> caught.

    +
    +
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="MyProject" basedir="." default="main">
+
+  <property name="fs.dir" value="src"/>
+  <property name="fs.includes" value="**/*.txt"/>
+  <property name="fs.excludes" value="**/*.tmp"/>
+
+  <target name="main">
+    <script language="javascript"> <![CDATA[
+
+      // import statements
+      // importPackage(java.io);
+      importClass(java.io.File);
+
+      // Access to Ant-Properties by their names
+      dir      = project.getProperty("fs.dir");
+      includes = MyProject.getProperty("fs.includes");
+      excludes = self.getProject()  .getProperty("fs.excludes");
+
+      // Create a <fileset dir="" includes=""/>
+      fs = project.createDataType("fileset");
+      fs.setDir( new File(dir) );
+      fs.setIncludes(includes);
+      fs.setExcludes(excludes);
+
+      // Get the files (array) of that fileset
+      ds = fs.getDirectoryScanner(project);
+      srcFiles = ds.getIncludedFiles();
+
+      // iterate over that array
+      for (i=0; i<srcFiles.length; i++) {
+
+        // get the values via Java API
+        var basedir  = fs.getDir(project);
+        var filename = srcFiles[i];
+        var file = new File(basedir, filename);
+        var size = file.length();
+
+        // create and use a Task via Ant API
+        echo = MyProject.createTask("echo");
+        echo.setMessage(filename + ": " + size + " byte");
+        echo.perform();
+      }
+    ]]></script>
+  </target>
+</project>
+
    +

    We want to use the Java API. Because we don't want always typing the package signature +we do an import. Rhino knows two different methods for import statements: one for packages +and one for a single class. By default only the java packages are available, so +java.lang.System can be directly imported with importClass/importPackage. +For other packages you have to prefix the full classified name with Packages. +For example Ant's FileUtils class can be imported with +importClass(Packages.org.apache.tools.ant.util.FileUtils) +
    +The <script> task populates the Project instance under +the name project, so we can use that reference. Another way is to use its given name +or getting its reference from the task itself.
    +The Project provides methods for accessing and setting properties, creating DataTypes and +Tasks and much more.
    +After creating a FileSet object we initialize that by calling its set-methods. Then we can +use that object like a normal Ant task (<copy> for example).
    +For getting the size of a file we instantiate a java.io.File. So we are using +normal Java API here.
    +Finally we use the <echo> task for producing the output. The task is not executed by +its execute() method, because the perform() method (implemented in Task itself) does the +appropriate logging before and after invoking execute(). +

    +

    + Here is an example of using beanshell to create an ant + task. This task will add filesets and paths to a referenced + path. If the path does not exist, it will be created. +

    +
    +<!--
+       Define addtopath task
+ -->
+<script language="beanshell">
+    import org.apache.tools.ant.Task;
+    import org.apache.tools.ant.types.Path;
+    import org.apache.tools.ant.types.FileSet;
+    public class AddToPath extends Task {
+        private Path path;
+        public void setRefId(String id) {
+            path = getProject().getReference(id);
+            if (path == null) {
+                path = new Path(getProject());
+                getProject().addReference(id, path);
+            }
+        }
+        public void add(Path c) {
+            path.add(c);
+        }
+        public void add(FileSet c) {
+            path.add(c);
+        }
+        public void execute() {
+            // Do nothing
+        }
+    }
+    project.addTaskDefinition("addtopath", AddToPath.class);
+</script>
+
    +

    + An example of using this task to create a path + from a list of directories (using antcontrib's + + <for> task) follows: +

    +
    +<path id="main.path">
+  <fileset dir="build/classes"/>
+</path>
+<ac:for param="ref" list="commons,fw,lps"
+        xmlns:ac="antlib:net.sf.antcontrib">
+  <sequential>
+    <addtopath refid="main.path">
+      <fileset dir="${dist.dir}/@{ref}/main"
+               includes="**/*.jar"/>
+    </addtopath>
+  </sequential>
+</ac:for>
+
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/scriptdef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/scriptdef.html new file mode 100644 index 000000000..1746128ad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/scriptdef.html @@ -0,0 +1,332 @@ + + + + + + +Scriptdef Task + + + + +

    Scriptdef

    +

    Description

    +

    Scriptdef can be used to define an Apache Ant task using a scripting language. Ant +scripting languages supported by +Apache BSF +or + JSR 223 +may be +used to define the script. Scriptdef provides a mechanism to encapsulate +control logic from a build within an Ant task minimizing the need for +providing control style tasks in Ant itself. Complex logic can be made +available while retaining the simple structure of an Ant build file. Scriptdef +is also useful for prototyping new custom tasks. Certainly as the complexity +of the script increases it would be better to migrate the task definition +into a Java based custom task. +

    + +

    Note: This task depends on external libraries not included in the +Ant distribution. See +Library Dependencies +for more information.

    + + + +

    The attributes and nested elements supported by the task may be defined +using <attribute> and <element> nested elements. These are +available to the script that implements the task as two collection style +script variables attributes and elements. The +elements in the attributes collection may be accessed by the +attribute name. The elements collection is accessed by the nested +element name. This will return a list of all instances of the nested element. +The instances in this list may be accessed by an integer index. +

    + +

    Note: Ant will turn all attribute and element names into all +lowercase names, so even if you use name="SomeAttribute", you'll have +to use "someattribute" to retrieve the attribute's value from the +attributes collection.

    + +

    The name "self" (since Ant 1.6.3) is a pre-defined reference to the + script def task instance. + It can be used for logging, or for integration with the rest of + ant. the self.text attribute contains + any nested text passed to the script

    + +

    If an attribute or element is not passed in, +then attributes.get() or elements.get() will +return null. It is up to the script to perform any checks and validation. +self.fail(String message)can be used to raise a +BuildException. +

    + + +

    The name "project" is a pre-defined reference to the Ant Project. For +more information on writing scripts, please refer to the +<script> task +

    + + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe name of the task to be created using the scriptYes
    languageThe programming language the script is written in. + Must be a supported Apache BSF or JSR 223 languageYes
    manager + The script engine manager to use. + See the script task + for using this attribute. + No - default is "auto"
    srcThe location of the script as a file, if not inlineNo
    uri + The XML namespace uri that this definition should live in. + No
    classpath + The classpath to pass into the script. + No
    classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + No
    loaderRefthe name of the loader that is + used to load the script, constructed from the specified + classpath. This allows multiple script defintions + to reuse the same class loader. + No
    + +

    Nested elements

    +

    attribute

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe name of the attributeYes
    + +

    element

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe name of the nested element to be supported by the + task defined by the scriptYes
    classnamethe classname of the class to be used for the nested element. + This specifies the class directly and is an alternative to specifying + the Ant type name.No
    typeThis is the name of an Ant task or type which is to + be used when this element is to be created. This is an alternative + to specifying the class name directly. If the type is in a namespace, + the URI and a : must be prefixed to the type. For example + type="antlib:example.org:newtype"No
    any resource or resource collectionSince Ant1.7.1, this task can load scripts + from any resource supplied as a nested element. when No
    + +

    classpath

    +

    + See the script task + for using this nested element. +

    + + +

    Examples

    + +

    +The following definition creates a task which supports an attribute called +attr and two nested elements, one being a fileset and the other a path. When +executed, the resulting task logs the value of the attribute and the basedir +of the first fileset. +

    + +
    +  <scriptdef name="scripttest" language="javascript">
+    <attribute name="attr1"/>
+    <element name="fileset" type="fileset"/>
+    <element name="path" type="path"/>
+    <![CDATA[
+
+      self.log("Hello from script");
+      self.log("Attribute attr1 = " + attributes.get("attr1"));
+      self.log("First fileset basedir = "
+        + elements.get("fileset").get(0).getDir(project));
+
+    ]]>
+  </scriptdef>
+
+  <scripttest attr1="test">
+    <path>
+      <pathelement location="src"/>
+    </path>
+    <fileset dir="src"/>
+    <fileset dir="main"/>
+  </scripttest>
+
    + +

    +The following variation on the above script lists the number of fileset elements +and iterates through them +

    +
    +  <scriptdef name="scripttest2" language="javascript">
+    <element name="fileset" type="fileset"/>
+    <![CDATA[
+      filesets = elements.get("fileset");
+      self.log("Number of filesets = " + filesets.size());
+      for (i = 0; i < filesets.size(); ++i) {
+        self.log("fileset " + i + " basedir = "
+          + filesets.get(i).getDir(project));
+      }
+    ]]>
+  </scriptdef>
+
+  <scripttest2>
+    <fileset dir="src"/>
+    <fileset dir="main"/>
+  </scripttest2>
+
    + +

    +When a script has a syntax error, the scriptdef name will be listed in the +error. For example in the above script, removing the closing curly bracket +would result in this error +

    + +

    build.xml:15: SyntaxError: missing } in compound +statement (scriptdef <scripttest2>; line 10)

    + +

    +Script errors are only detected when a script task is actually executed. +

    +

    + The next example does uses nested text in Jython. It also declares + the script in a new xml namespace, which must be used to refer to + the task. Declaring scripts in a new namespace guarantees that Ant will + not create a task of the same (namespace,localname) name pair. +

    + +
    +<target name="echo-task-jython">
+  <scriptdef language="jython"
+      name="echo"
+      uri="http://example.org/script">
+      <![CDATA[
+self.log("text: " +self.text)
+    ]]>
+    </scriptdef>
+</target>
+
+<target name="testEcho" depends="echo-task-jython"
+    xmlns:s="http://example.org/script">
+  <s:echo>nested text</s:echo>
+</target>
+
    + +The next example shows the use of <classpath> and +"loaderref" to get access to the beanshell jar. +
    +    <scriptdef name="b1" language="beanshell"
+               loaderref="beanshell-ref">
+      <attribute name="a"/>
+      <classpath
+        path="${user.home}/scripting/beanshell/bsh-1.3b1.jar"/>
+      self.log("attribute a is " + attributes.get("a"));
+    </scriptdef>
+
+    <scriptdef name="b2" language="beanshell"
+               loaderref="beanshell-ref">
+      <attribute name="a2"/>
+      self.log("attribute a2 is " + attributes.get("a2"));
+    </scriptdef>
+
+    <b1 a="this is an 'a'"/>
+    <b2 a2="this is an 'a2' for b2"/>
+
    +

    Testing Scripts

    + +

    +The easiest way to test scripts is to use the +AntUnit ant library. +This will run all targets in a script that begin with "test" (and their dependencies).

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sequential.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sequential.html new file mode 100644 index 000000000..d3deda64b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sequential.html @@ -0,0 +1,55 @@ + + + + + + +Sequential Task + + + + +

    Sequential

    +

    Description

    +

    Sequential is a container task - it can contain other Apache Ant tasks. The nested +tasks are simply executed in sequence. Sequential's primary use is to support +the sequential execution of a subset of tasks within the +parallel task

    + +

    The sequential task has no attributes and does not support any nested +elements apart from Ant tasks. Any valid Ant task may be embedded within the +sequential task.

    + +

    Example

    +
    +<parallel>
+  <wlrun ... >
+  <sequential>
+    <sleep seconds="30"/>
+    <junit ... >
+    <wlstop/>
+  </sequential>
+</parallel>
+
    +

    This example shows how the sequential task is used to execute three tasks in +sequence, while another task is being executed in a separate thread.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/serverdeploy.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/serverdeploy.html new file mode 100644 index 000000000..87d0777db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/serverdeploy.html @@ -0,0 +1,335 @@ + + + + + + +ServerDeploy Task + + + + + +

    Apache Ant ServerDeploy User Manual

    +

    by

    + + + +

    +
    +

    At present the tasks support:
    + +

    +Over time we expect further optional tasks to support additional J2EE Servers. +

    + +
    + + + + + + + + +
    TaskApplication Servers
    serverdeployNested Elements
    genericGeneric task
    jonasJOnAS 2.4
    weblogicWeblogic
    + + +

    ServerDeploy element

    + +

    Description:

    + +

    The serverdeploy task is used to run a "hot" deployment tool for +vendor-specific J2EE server. The task requires nested elements which define +the attributes of the vendor-specific deployment tool being executed. +Vendor-specific deployment tools elements may enforce rules for which +attributes are required, depending on the tool. +

    + +

    Parameters:

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    actionThis is the action to be performed. For most cases this + will be "deploy". Some tools support additional actions, such as "delete", "list", + "undeploy", "update"...Yes
    sourceA fully qualified path/filename of the component to be deployed. + This may be an .ear, .jar, .war, or any other type that is supported by the server. + Tool dependent
    + +

    Nested Elements

    + +

    The serverdeploy task supports a nested classpath element to set the classpath.

    + +

    Vendor-specific nested elements

    + +

    Parameters used for all tools:

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classpathThe classpath to be passed to the JVM running the tool. + The classpath may also be supplied as a nested element.Tool dependent
    serverThe address or URL for the server where the component will be deployed.Tool dependent
    usernameThe user with privileges to deploy applications to the server.Tool dependent
    passwordThe password of the user with privileges to deploy applications to the server.Tool dependent
    + +

    Also supported are nested vendor-specific elements.

    + +     +

    Generic element

    +This element is provided for generic Java-based deployment tools. +The generic task accepts (but does not require) nested arg +and jvmarg elements. +A JVM will be spawned with the provided attributes. It is recommended +that a vendor-specific element be used over the generic one if at all +possible. +

    The following attributes are supported by the generic element.

    +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnameThis is the fully qualified classname of the Java based + deployment tool to execute.Yes
    +

    + +

    Nested Elements

    +

    The generic element supports nested <arg> and <jvmarg> elements.

    + +

    Example

    + +

    This example shows the use of generic deploy element to deploy a component +using a Java based deploy tool:

    + +
    +    <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear">
+        <generic classname="com.yamato.j2ee.tools.deploy.DeployTool"
+            classpath="${classpath}"
+            username="${user.name}"
+            password="${user.password}">
+            <arg value="-component=WildStar"/>
+            <arg value="-force"/>
+            <jvmarg value="-ms64m"/>
+            <jvmarg value="-mx128m"/>
+        </generic>
+    </serverdeploy>
+
    + +     +

    WebLogic element

    +

    +The WebLogic element contains additional attributes to run the +weblogic.deploy deployment tool. +

    Valid actions for the tool are deploy, undeploy, +list, update, and delete. +

    If the action is deploy or update, +the application and source attributes must be set. +If the action is undeploy or delete, +the application attribute must be set. If the username +attribute is omitted, it defaults to "system". The password attribute is +required for all actions. +

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    applicationThis is the name of the application being deployedYes
    componentThis is the component string for deployment targets. + It is in the form <component>:<target1>,<target2>... + Where component is the archive name (minus the .jar, .ear, .war + extension). Targets are the servers where the components will be deployedno
    debugIf set to true, additional information will be + printed during the deployment process.No
    + + +

    Examples

    + +

    This example shows the use of serverdeploy to deploy a component to a WebLogic server:

    + +
    +    <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear">
+        <weblogic application="myapp"
+            server="t3://myserver:7001"
+            classpath="${weblogic.home}/lib/weblogic.jar"
+            username="${user.name}"
+            password="${user.password}"
+            component="ejb_foobar:myserver,productionserver"
+            debug="true"/>
+    </serverdeploy>
+
    + +

    This example shows serverdeploy being used to delete a component from a +WebLogic server:

    + +
    +    <serverdeploy action="delete" source="${lib.dir}/ejb_myApp.jar"/>
+        <weblogic application="myapp"
+            server="t3://myserver:7001"
+            classpath="${weblogic.home}/lib/weblogic.jar"
+            username="${user.name}"
+            password="${user.password}"/>
+    </serverdeploy>
+
    + +     +

    JOnAS (Java Open Application Server) element

    +

    +The JOnAS element contains additional attributes to run the +JonasAdmin deployment tool. +

    Valid actions for the tool are deploy, undeploy, +list and update. +

    You can't use user and password property with this +task. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    jonasrootThe root directory for JOnAS.Yes
    orbChoose your ORB : RMI, JEREMIE, DAVID, ... If omitted, it defaults + to the one present in classpath. The corresponding JOnAS JAR is + automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must + specify davidhost and davidport properties.No
    davidhostThe value for the system property : david.CosNaming.default_host .No
    davidportThe value for the system property : david.CosNaming.default_port .No
    classnameThis is the fully qualified classname of the Java based + deployment tool to execute. Default to org.objectweb.jonas.adm.JonasAdminNo
    + +

    Nested Elements

    +

    The jonas element supports nested <arg> and <jvmarg> elements.

    + + +

    Examples

    + +

    This example shows the use of serverdeploy to deploy a component to a JOnAS server:

    + +
    +    <serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.jar">
+        <jonas server="MyJOnAS" jonasroot="${jonas.root}">
+
+           <classpath>
+               <pathelement path="${jonas.root}/lib/RMI_jonas.jar"/>
+               <pathelement path="${jonas.root}/config/"/>
+           </classpath>
+        </jonas>
+    </serverdeploy>
+
    + +

    This example shows serverdeploy being used to list the components from a +JOnAS server and a WebLogic server:

    + +
    +    <serverdeploy action="list"/>
+        <jonas jonasroot="${jonas.root}" orb="JEREMIE"/>
+        <weblogic application="myapp"
+            server="t3://myserver:7001"
+            classpath="${weblogic.home}/lib/weblogic.jar"
+            username="${user.name}"
+            password="${user.password}"/>
+    </serverdeploy>
+
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/setproxy.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/setproxy.html new file mode 100644 index 000000000..60aa984e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/setproxy.html @@ -0,0 +1,222 @@ + + + + + + Setproxy + Task + + + + + + + + + + + + + + + + + +
    + + + +
    + Setproxy + Task +
    Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. +     		+ + + Apache Ant + +
    +
    + + + + + + + + + + +
     
    + + + Description +
    + Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites, and remote ftp sites. You can nominate an http and ftp proxy, or a socks server, reset the server settings, or do nothing at all.

    Examples 

    <setproxy/>
    do nothing 
    <setproxy proxyhost="firewall"/>
    set the proxy to firewall:80 
    <setproxy proxyhost="firewall" proxyport="81"/>
    set the proxy to firewall:81 
    <setproxy proxyhost=""/>
    stop using the http proxy; don't change the socks settings 
    <setproxy socksproxyhost="socksy"/>
    use socks via socksy:1080 
    <setproxy socksproxyhost=""/>
    stop using the socks server.

    You can set a username and password for http with the proxyHost and proxyPassword attributes. On Java1.4 and above these can also be used against SOCKS5 servers.

    +
    + + + + + + + + + + + + +
     
    + + + Parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Attribute + + Description + + Type + + Requirement +
    + nonproxyhosts + + A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com + + String + + Optional +
    + proxyhost + + the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled + + String +
    + proxypassword + + Set the password for the proxy. Used only if the proxyUser is set. + + String +
    + proxyport + + the HTTP/ftp proxy port number; default is 80 + + int +
    + proxyuser + + set the proxy user. Probably requires a password to accompany this setting. Default="" + + String +
    + socksproxyhost + + The name of a Socks server. Set to "" to turn socks proxying off. + + String +
    + socksproxyport + + Set the ProxyPort for socks connections. The default value is 1080 + + int +
    +
    + + + + + + + + + + +
     
    + + + Parameters as nested elements +
    + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/signjar.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/signjar.html new file mode 100644 index 000000000..65b5bea17 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/signjar.html @@ -0,0 +1,245 @@ + + + + + + +SignJar Task + + + + +

    SignJar

    +

    Description

    +

    Signs JAR files with the jarsigner command line tool. +It will take a named file in the jar attribute, and an optional +destDir or signedJar attribute. Nested paths are also +supported; here only an (optional) destDir is allowed. If a destination +directory or explicit JAR file name is not provided, JARs are signed in place. +

    +

    +Dependency rules +

    +
      +
    • Nonexistent destination JARs are created/signed
      • +
    • Out of date destination JARs are created/signed
      • +
    • If a destination file and a source file are the same, +and lazy is true, the JAR is only signed if it does not +contain a signature by this alias.
      • +
    • If a destination file and a source file are the same, +and lazy is false, the JAR is signed.
      • +
    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    jarthe jar file to signYes, unless nested paths have + been used.
    aliasthe alias to sign underYes.
    storepasspassword for keystore integrity.Yes.
    keystorekeystore locationNo
    storetypekeystore typeNo
    keypasspassword for private key (if different)No
    sigfilename of .SF/.DSA fileNo
    signedjarname of signed JAR file. This can only be set when + the jar attribute is set.No.
    verbose(true | false) verbose output when signingNo; default false
    internalsf(true | false) include the .SF file inside the signature +blockNo; default false
    sectionsonly(true | false) don't compute hash of entire manifestNo; default false
    lazyflag to control whether the presence of a signature + file means a JAR is signed. This is only used when the target JAR matches + the source JARNo; default false
    maxmemorySpecifies the maximum memory the jarsigner VM will use. Specified in the + style of standard java memory specs (e.g. 128m = 128 MBytes)No
    preservelastmodifiedGive the signed files the same last modified + time as the original jar files.No; default false.
    tsaurlURL for a timestamp authority for timestamped + JAR files in Java1.5+No
    tsacertalias in the keystore for a timestamp authority for + timestamped JAR files in Java1.5+No
    executableSpecify a particular jarsigner executable + to use in place of the default binary (found in the same JDK as + Apache Ant is running in).
    + Must support the same command line options as the Sun JDK + jarsigner command. + since Ant 1.8.0.    		No
    forceWhether to force signing of the jar file even if + it doesn't seem to be out of date or already signed. + since Ant 1.8.0.No; default false
    +

    Parameters as nested elements

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    pathpath of JAR files to sign. since Ant 1.7No
    filesetfileset of JAR files to sign. No
    mapperA mapper to rename jar files during signingNo, and only one can be supplied
    syspropertyJVM system properties, with the syntax of Ant + environment variables No, and only one can be supplied
    + + +

    Examples

    + 
    +<signjar jar="${dist}/lib/ant.jar"
+alias="apache-group" storepass="secret"/>
+
    +

    + signs the ant.jar with alias "apache-group" accessing the + keystore and private key via "secret" password. +

    + 
    +<signjar destDir="signed"
+    alias="testonly" keystore="testkeystore"
+    storepass="apacheant"
+    preservelastmodified="true">
+  <path>
+    <fileset dir="dist" includes="**/*.jar" />
+  </path>
+  <flattenmapper />
+</signjar>
+
    +

    +Sign all JAR files matching the dist/**/*.jar pattern, copying them to the +directory "signed" afterwards. The flatten mapper means that they will +all be copied to this directory, not to subdirectories. + +

    + 
    +<signjar
+    alias="testonly" keystore="testkeystore"
+    storepass="apacheant"
+    lazy="true"
+    >
+  <path>
+    <fileset dir="dist" includes="**/*.jar" />
+  </path>
+</signjar>
+
    +

    +Sign all the JAR files in dist/**/*.jar in-situ. Lazy signing is used, +so the files will only be signed if they are not already signed. +

    +

    About timestamp signing

    + +

    +Timestamped JAR files are a new feature in Java1.5; a feature supported in Ant since +Ant 1.7. Ant does not yet support proxy setup for this singing process. +

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sleep.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sleep.html new file mode 100644 index 000000000..80827b515 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sleep.html @@ -0,0 +1,85 @@ + + + + + +Sleep Task + + + + +

    Sleep

    +

    Description

    +

    A task for sleeping a short period of time, useful when a build or deployment + process requires an interval between tasks.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    hourshours to to add to the sleep timeNo
    minutes minutes to add to the sleep timeNo
    secondsseconds to add to the sleep timeNo
    millisecondsmilliseconds to add to the sleep timeNo
    failonerrorflag controlling whether to break the build on an error. + No
    +

    The sleep time is the sum of specified values, hours, minutes seconds and milliseconds. + A negative value can be supplied to any of them provided the total sleep time + is positive

    +

    Note that sleep times are always hints to be interpred by the OS how it feels + - small times may either be ignored or rounded up to a minimum timeslice. Note + also that the system clocks often have a fairly low granularity too, which complicates + measuring how long a sleep actually took.

    +

    Examples

    +
       <sleep milliseconds="10"/>
    +Sleep for about 10 mS. +
       <sleep seconds="2"/>
    +Sleep for about 2 seconds. +
       <sleep hours="1" minutes="-59" seconds="-58"/>
    +

    Sleep for one hour less 59:58, or two seconds again

    +
       <sleep/>
    +Sleep for no time at all. This may yield the CPU time to another thread or process. + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sos.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sos.html new file mode 100644 index 000000000..c068263b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sos.html @@ -0,0 +1,503 @@ + + + + + + + +SOS Tasks + + + + +
    +

    SourceOffSite Tasks User Manual

    + +
    by + +Version 1.1 2002/01/23 +
    +
    + +
    +

    Contents

    + + +
    + +

    Introduction

    + +

    These tasks provide an interface to the +Microsoft Visual SourceSafe SCM via +SourceGear's SourceOffSite +product. SourceOffSite is an add-on to Microsoft's VSS, that allows remote +development teams and tele-commuters that need fast and secure read/write +access to a centralized SourceSafe database via any TCP/IP connection. SOS +provides Linux ,Solaris & Windows clients. The + org.apache.tools.ant.taskdefs.optional.sos +package consists of a simple framework to support SOS functionality as well +as some Apache Ant tasks encapsulating frequently used SOS commands. Although it +is possible to use these commands on the desktop, they were primarily intended +to be used by automated build systems. These tasks have been tested with +SourceOffSite version 3.5.1 connecting to VisualSourceSafe 6.0. The tasks +have been tested with Linux, Solaris & Windows2000.

    + +

    The Tasks

    + + + + + + + + + + + + + + + + + + + + + +
    sosgetRetrieves a read-only copy of the specified project or file.
    soslabelAssigns a label to the specified project.
    soscheckinUpdates VSS with changes made to a checked out file or project, + and unlocks the VSS master copy.
    soscheckoutRetrieves a read-write copy of the specified project + or file, locking the VSS master copy
    +
    + +
    +

    Task Descriptions

    + +

    SOSGet
    +

    +

    Description

    + Task to perform GET commands with SOS
    +

    Parameters

    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    soscmdDirectory which contains soscmd(.exe)
    + soscmd(.exe) must be in the path if this is not specified    		No
    vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
    sosserverpathaddress & port of the SOS server - eg. 192.168.0.1:8888Yes
    projectpathSourceSafe project path - eg. $/SourceRoot/Project1Yes
    fileFilename to act upon
    + If no file is specified then act upon the project    		No
    usernameSourceSafe usernameYes
    passwordSourceSafe passwordNo
    localpathOverride the working directory and get to the specified pathNo
    soshomeThe path to the SourceOffSite home directoryNo
    nocompresstrue or false - disable compressionNo
    recursivetrue or false - Only works with the GetProject commandNo
    versiona version number to get - Only works with the GetFile commandNo
    labela label version to get - Only works with the GetProject commandNo
    nocachetrue or false - Only needed if SOSHOME is set as an environment variableNo
    verbosetrue or false - Status messages are displayedNo
    + +

    Example

    + +
    +<sosget verbose="true"
+        recursive="true"
+        username="build"
+        password="build"
+        localpath="tmp"
+        projectpath="$/SourceRoot/project1"
+        sosserverpath="192.168.10.6:8888"
+        vssserverpath="d:\vss\srcsafe.ini"/>
+
    +Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini" Does a recursive GetProject on +$/SourceRoot/project1, using tmp as the working +directory.
    +
    + +
    +

    SOSLabel

    + +

    Description

    + Task to perform Label commands with SOS
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    soscmdDirectory which contains soscmd(.exe)
    + soscmd(.exe) must be in the path if this is not specified    		No
    vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
    sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
    projectpathSourceSafe project path - eg. $/SourceRoot/Project1Yes
    usernameSourceSafe usernameYes
    passwordSourceSafe passwordNo
    labelThe label to apply to a projectYes
    commentA comment to be applied to all files being labeledNo
    verbosetrue or false - Status messages are displayedNo
    + +

    Example

    +
    +<soslabel username="build"
+          password="build"
+          label="test label"
+          projectpath="$/SourceRoot/project1"
+          sosserverpath="192.168.10.6:8888"
+          vssserverpath="d:\vss\srcsafe.ini"/>
+
    + +Connects to a SourceOffsite server on 192.168.10.6:8888 with +build,build as the username & password. The SourceSafe database resides +on the same box as the SOS server & the VSS database is at +"d:\vss\srcsafe.ini". Labels the $/SourceRoot/project1 +project with "test label".
    +
    + +

    + +

    SOSCheckIn

    + +

    Description

    + Task to perform CheckIn commands with SOS
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    soscmdDirectory which contains soscmd(.exe)
    + soscmd(.exe) must be in the path if this is not specified    		No
    vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
    sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
    projectpathSourceSafe project path - eg. $/SourceRoot/Project1Yes
    fileFilename to act upon
    If no file is specified then act upon the project    		No
    usernameSourceSafe usernameYes
    passwordSourceSafe passwordNo
    localpathOverride the working directory and get to the specified pathNo
    soshomeThe path to the SourceOffSite home directoryNo
    nocompresstrue or false - disable compressionNo
    recursivetrue or false - Only works with the CheckOutProject commandNo
    nocachetrue or false - Only needed if SOSHOME is set as an environment variableNo
    verbosetrue or false - Status messages are displayedNo
    commentA comment to be applied to all files being checked inNo
    + +

    Example

    +
    +<soscheckin username="build"
+            password="build"
+            file="foobar.txt"
+            verbose="true"
+            comment="comment abc"
+            projectpath="$/SourceRoot/project1"
+            sosserverpath="server1:8888"
+            vssserverpath="\\server2\vss\srcsafe.ini"/>
+
    + +Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called +"vss". Checks-in only the "foobar.txt" file adding +a comment of "comment abc". Extra status messages will be +displayed on screen.
    +
    + +
    +

    SOSCheckOut

    + +

    Description

    + Task to perform CheckOut commands with SOS
    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    soscmdDirectory which contains soscmd(.exe)
    + soscmd(.exe) must be in the path if this is not specified    		No
    vssserverpathpath to the srcsafe.ini - eg. \\server\vss\srcsafe.iniYes
    sosserverpathaddress and port of the SOS server - eg. 192.168.0.1:8888Yes
    projectpathSourceSafe project path - eg. $/SourceRoot/Project1Yes
    fileFilename to act upon
    If no file is specified then act upon the project    		No
    usernameSourceSafe usernameYes
    passwordSourceSafe passwordNo
    localpathOverride the working directory and get to the specified pathNo
    soshomeThe path to the SourceOffSite home directoryNo
    nocompresstrue or false - disable compressionNo
    recursivetrue or false - Only works with the CheckOutProject commandNo
    nocachetrue or false - Only needed if SOSHOME is set as an environment variableNo
    verbosetrue or false - Status messages are displayedNo
    +
    + +

    Example

    +
    +<soscheckout soscmd="/usr/local/bin"
+             verbose="true"
+             username="build"
+             password="build"
+             projectpath="$/SourceRoot/project1"
+             sosserverpath="192.168.10.6:8888"
+             vssserverpath="\\server2\vss\srcsafe.ini"/>
+
    + +Connects to a SourceOffsite server on server1:8888 with build,build as +the username & password. The SourceSafe database resides on a different +box (server2) & the VSS database is on a share called +"vss". Checks-out "project1", Only the +"project1" directory will be locked as the recursive option +was not set. Extra status messages will be displayed on screen. The +soscmd(.exe) file to be used resides in /usr/local/bin.
    +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sound.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sound.html new file mode 100644 index 000000000..1095f80cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sound.html @@ -0,0 +1,123 @@ + + + + + + +Sound Task + + + + +

    Sound

    +

    Description

    +

    Plays a sound-file at the end of the build, according to whether +the build failed or succeeded. You can specify either a specific +sound-file to play, or, if a directory is specified, the +<sound> task will randomly select a file to play. +Note: At this point, the random selection is based on all the files +in the directory, not just those ending in appropriate suffixes +for sound-files, so be sure you only have sound-files in the +directory you specify.

    +

    More precisely <sound> registers a hook that is +triggered when the build finishes. Therefore you have to place this +task as top level or inside a target which is always executed.

    +

    +Unless you are running on Java 1.3 or later, you need the Java Media Framework +on the classpath (javax.sound). +

    + + +

    Nested Elements

    +

    success

    +

    Specifies the sound to be played if the build succeeded.

    +

    fail

    +

    Specifies the sound to be played if the build failed.

    + +

    Nested Element Parameters

    +

    +The following attributes may be used on the <success> +and <fail> elements:

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    sourcethe path to a sound-file directory, or the name of a +specific sound-file, to be played. If this file does not exist, an error message +will be logged. + Yes
    loopsthe number of extra times to play the sound-file; + default is 0. + No
    durationthe amount of time (in milliseconds) to play + the sound-file. + No
    + +

    Examples

    +
    +
    +<target name="fun" if="fun" unless="fun.done">
+  <sound>
+    <success source="${user.home}/sounds/bell.wav"/>
+    <fail source="${user.home}/sounds/ohno.wav" loops="2"/>
+  </sound>
+  <property name="fun.done" value="true"/>
+</target>
+
    +
    +plays the bell.wav sound-file if the build succeeded, or +the ohno.wav sound-file if the build failed, three times, +if the fun property is set to true. +If the target +is a dependency of an "initialization" target that other +targets depend on, the +fun.done property prevents the target from being executed +more than once. +
    +
    +<target name="fun" if="fun" unless="fun.done">
+  <sound>
+    <success source="//intranet/sounds/success"/>
+    <fail source="//intranet/sounds/failure"/>
+  </sound>
+  <property name="fun.done" value="true"/>
+</target>
+
    +
    +randomly selects a sound-file to play when the build succeeds or fails. + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/splash.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/splash.html new file mode 100644 index 000000000..35e925099 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/splash.html @@ -0,0 +1,156 @@ + + + + + + +Apache Ant User Manual + + + + +

    Splash

    +

    by Les Hughes (leslie.hughes@rubus.com) +

    Description

    +

    This task creates a splash screen. The splash screen is displayed +for the duration of the build and includes a handy progress bar as +well. Use in conjunction with the sound task to provide interest +whilst waiting for your builds to complete...

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequiredDefault
    imageurlA URL pointing to an image to display.Noantlogo.gif from the classpath
    showdurationInitial period to pause the build to show the + splash in milliseconds.No5000 ms
    progressregexpProgress regular expression which is used to + parse the output and dig out current progress. Exactly one group + pattern must exists, and it represents the progress number (0-100) + (i.e "Progress: (.*)%")
    + since Apache Ant 1.8.0    		Noprogress is increased every action + and log output line
    displaytextdisplay text presented in the splash window
    + since Ant 1.8.0    		NoBuilding ...
    +

    Deprecated properties

    + +The following properties can be used to configure the proxy settings to retrieve +an image from behind a firewall. However, the settings apply not just to this +task, but to all following tasks. Therefore they are now mostly deprecated in +preference to the <setproxy> task, that makes it clear to readers of +the build exactly what is going on. We say mostly as this task's support +includes proxy authentication, so you may still need to use its +proxy attributes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    useproxyUse a proxy to access imgurl. Note: Only tested + on JDK 1.2.2 and aboveNoNone
    proxyIP or hostname of the proxy serverNoNone
    portProxy portnumberNoNone
    userUser to authenticate to the proxy as.NoNone
    passwordProxy passwordNoNone
    +

    Examples

    +
    +<splash/>
+
    +

    Splash images/ant_logo_large.gif from the classpath.

    +
    +<splash imageurl="http://jakarta.apache.org/images/jakarta-logo.gif"
+           useproxy="true"
+           showduration="5000"/>
+
+
    +

    Splashes the jakarta logo, for an initial period of 5 seconds.

    + +

    Splash with controlled progress and nondefault text

    +
    +        <target name="test_new_features">
+                <echo>New features</echo>
+                <splash progressRegExp="Progress: (.*)%" showduration="0" displayText="Test text"/>
+                <sleep seconds="1"/>
+                <echo>Progress: 10%</echo>
+                <sleep seconds="1"/>
+                <echo>Progress: 20%</echo>
+                <sleep seconds="1"/>
+                <echo>Progress: 50%</echo>
+                <sleep seconds="1"/>
+                <echo>Progress: 70%</echo>
+                <sleep seconds="1"/>
+                <echo>Progress: 100%</echo>
+                <sleep seconds="3"/>
+        </target>
+
    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sql.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sql.html new file mode 100644 index 000000000..da6c3a339 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sql.html @@ -0,0 +1,505 @@ + + + + + +SQL Task + + + +

    Sql

    +

    Description

    +

    Executes a series of SQL statements via JDBC to a database. Statements can +either be read in from a text file using the src attribute or from +between the enclosing SQL tags.

    + +

    Multiple statements can be provided, separated by semicolons (or the +defined delimiter). Individual lines within the statements can be +commented using either --, // or REM at the start of the line.

    + +

    The autocommit attribute specifies whether auto-commit should be +turned on or off whilst executing the statements. If auto-commit is turned +on each statement will be executed and committed. If it is turned off the +statements will all be executed as one transaction.

    + +

    The onerror attribute specifies how to proceed when an error occurs +during the execution of one of the statements. +The possible values are: continue execution, only show the error; +stop execution, log the error but don't fail the task +and abort execution and transaction and fail task.

    + +

    +Proxies. Some JDBC drivers (including the Oracle thin driver), + use the JVM's proxy settings to route their JDBC operations to the database. + Since Apache Ant1.7, Ant running on Java1.5 or later defaults to + using + the proxy settings of the operating system. + Accordingly, the OS proxy settings need to be valid, or Ant's proxy + support disabled with -noproxy option. +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    driverClass name of the jdbc driverYes
    urlDatabase connection urlYes
    useridDatabase user nameYes
    passwordDatabase passwordYes
    srcFile containing SQL statementsYes, unless statements enclosed within tags
    encodingThe encoding of the files containing SQL statementsNo - defaults to default JVM encoding
    delimiterString that separates SQL statementsNo, default ";"
    autocommitAuto commit flag for database connection (default false)No, default "false"
    printPrint result sets from the statements (default false)No, default "false"
    showheadersPrint headers for result sets from the statements (default true)No, default "true"
    showtrailersPrint trailer for number of rows affected (default true)No, default "true"
    outputOutput file for result sets (defaults to System.out) + Since Ant 1.8 can specify any Resource that supports output (see + note). + No (print to System.out by default)
    appendwhether output should be appended to or overwrite + an existing file. Defaults to false.No, ignored if output does not + specify a filesystem destination.
    classpathClasspath used to load driverNo (use system classpath)
    classpathrefThe classpath to use, given as a reference to a path defined elsewhere.No (use system classpath)
    onerrorAction to perform when statement fails: continue, stop, abortNo, default "abort"
    rdbmsExecute task only if this rdbmsNo (no restriction)
    versionExecute task only if rdbms version matchNo (no restriction)
    cachingShould the task cache loaders and the driver?No (default=true)
    delimitertypeControl whether the delimiter will only be recognized on a line by itself.
    + Can be "normal" -anywhere on the line, or "row", meaning it must be on a line by itself    		No (default:normal)
    keepformatControl whether the format of the sql will be preserved.
    + Useful when loading packages and procedures. +     		No (default=false)
    escapeprocessingControl whether the Java statement + object will perform escape substitution.
    + See Statement's + API docs for details. Since Ant 1.6. +     		No (default=true)
    expandpropertiesSet to true to turn on property expansion in + nested SQL, inline in the task or nested transactions. Since Ant 1.7. + No (default=true)
    rawblobsIf true, will write raw streams rather than hex encoding when + printing BLOB results. Since Ant 1.7.1.No, default false
    failOnConnectionErrorIf false, will only print a warning + message and not execute any statement if the task fails to connect + to the database. Since Ant 1.8.0.No, default true
    strictDelimiterMatchingIf false, delimiters will be searched + for in a case-insesitive manner (i.e. delimer="go" matches "GO") + and surrounding whitespace will be ignored (delimter="go" matches + "GO "). Since Ant 1.8.0.No, default true
    showWarningsIf true, SQLWarnings will be logged at + the WARN level. Since Ant 1.8.0.
    + Note: even if the attribute is set to false, warnings that + apply to the connection will be logged at the verbose level.    		No, default false
    treatWarningsAsErrorsIf true, SQLWarnings will be treated + like errors - and the logic selected via the onError attribute + applies. + Since Ant 1.8.0.No, default false
    csvColumnSeparatorThe column separator used when printing + the results. + Since Ant 1.8.0.No, default ','
    csvQuoteCharacterThe character used to quote column + values.
    + If set, columns that contain either the column separator or the + quote character itself will be surrounded by the quote character. + The quote character itself will be doubled if it appears inside of + the column's value.
    + Note: BLOB values will never be quoted. + Since Ant 1.8.0.    		No, default is not set (i.e. no quoting + ever occurs)
    errorpropertyThe name of a property to set in the event of an + error. Since Ant 1.8.0No
    warningpropertyThe name of a property to set in the event of an + warning. Since Ant 1.8.0No
    rowcountpropertyThe name of a property to set to the number of rows + updated by the first statement/transaction that actually returned + a row count. Since Ant 1.8.0No
    + +

    Parameters specified as nested elements

    +

    transaction

    +

    Use nested <transaction> +elements to specify multiple blocks of commands to the executed +executed in the same connection but different transactions. This +is particularly useful when there are multiple files to execute +on the same schema.

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    srcFile containing SQL statementsYes, unless statements enclosed within tags
    +

    The <transaction> element supports any resource or single element +resource collection as nested element to specify the resource +containing the SQL statements.

    + +

    any resource or resource +collection

    + +

    You can specify multiple sources via nested resource collection +elements. Each resource of the collection will be run in a +transaction of its own. Prior to Ant 1.7 only filesets were +supported. Use a sort resource collection to get a predictable order +of transactions.

    + +

    classpath

    +

    Sql's classpath attribute is a PATH like structure and can also be set via a nested +classpath element. It is used to load the JDBC classes.

    + +

    connectionProperty

    +

    Since Ant 1.8.0

    +

    Use nested <connectionProperty> elements to + specify additional JDBC properties that need to be set when + connecting to the database.

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameName of the propertyYes
    valueValue of the propertyYes
    + +

    Examples

    +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    src="data.sql"
+/>
+
    + +

    Connects to the database given in url as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within +the file data.sql

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    src="data.sql">
+  <connectionProperty name="internal_logon" value="SYSDBA">
+</sql>
+
    + +

    Connects to the database given in url as the sa user using +the org.database.jdbcDriver and executes the SQL statements contained +within the file data.sql. Also sets the +property internal_logon to the value SYSDBA.

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    >
+insert
+into table some_table
+values(1,2,3,4);
+
+truncate table some_other_table;
+</sql>
+
    + +

    Connects to the database given in url as the sa + user using the org.database.jdbcDriver and executes the two SQL statements + inserting data into some_table and truncating some_other_table. Ant Properties + in the nested text will not be expanded.

    + +

    Note that you may want to enclose your statements in +<![CDATA[ ... ]]> sections so you don't +need to escape <, > & +or other special characters. For example:

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    ><![CDATA[
+
+update some_table set column1 = column1 + 1 where column2 < 42;
+
+]]></sql>
+
    + +The following command turns property expansion in nested text on (it is off purely for backwards +compatibility), then creates a new user in the HSQLDB database using Ant properties. + +
    <sql
+    driver="org.hsqldb.jdbcDriver";
+    url="jdbc:hsqldb:file:${database.dir}"
+    userid="sa"
+    password=""
+    expandProperties="true"
+    >
+  <transaction>
+    CREATE USER ${newuser} PASSWORD ${newpassword}
+  </transaction>
+</sql>
+
    + + +

    The following connects to the database given in url as the sa user using +the org.database.jdbcDriver and executes the SQL statements contained within +the files data1.sql, data2.sql and data3.sql and then executes the truncate +operation on some_other_table.

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass" >
+  <transaction  src="data1.sql"/>
+  <transaction  src="data2.sql"/>
+  <transaction  src="data3.sql"/>
+  <transaction>
+    truncate table some_other_table;
+  </transaction>
+</sql>
+
    + +

    The following example does the same as (and may execute additional +SQL files if there are more files matching the pattern +data*.sql) but doesn't guarantee that data1.sql will be +run before data2.sql.

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass">
+  <path>
+    <fileset dir=".">
+      <include name="data*.sql"/>
+    </fileset>
+  </path>
+  <transaction>
+    truncate table some_other_table;
+  </transaction>
+</sql>
+
    + +

    The following connects to the database given in url as the sa user using the +org.database.jdbcDriver and executes the SQL statements contained within the +file data.sql, with output piped to outputfile.txt, searching /some/jdbc.jar +as well as the system classpath for the driver class.

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    src="data.sql"
+    print="yes"
+    output="outputfile.txt"
+    >
+<classpath>
+	<pathelement location="/some/jdbc.jar"/>
+</classpath>
+</sql>
+
    + +

    The following will only execute if the RDBMS is "oracle" and the version +starts with "8.1."

    + +
    <sql
+    driver="org.database.jdbcDriver"
+    url="jdbc:database-url"
+    userid="sa"
+    password="pass"
+    src="data.sql"
+    rdbms="oracle"
+    version="8.1."
+    >
+insert
+into table some_table
+values(1,2,3,4);
+
+truncate table some_other_table;
+</sql>
+
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sshexec.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sshexec.html new file mode 100644 index 000000000..caf0aac3f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sshexec.html @@ -0,0 +1,229 @@ + + + + + + +SSHEXEC Task + + + + +

    SSHEXEC

    +

    Description

    + +

    since Apache Ant 1.6

    + +

    Runs a command on a remote machine running SSH daemon. +

    + +

    Note: This task depends on external libraries not included +in the Ant distribution. See Library Dependencies +for more information. This task has been tested with jsch-0.1.29 and above +and won't work with versions of jsch earlier than +0.1.28.

    + +

    See also the scp task

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    hostThe hostname or IP address of the remote host to which you wish to connect.Yes
    usernameThe username on the remote host to which you are connecting.Yes
    commandThe command to run on the remote host.Either this or commandResource must be set
    commandResourceThe resource (file) that contains the commands to run on the remote host. + Since Ant 1.7.1Either this or command must be set
    portThe port to connect to on the remote host.No, defaults to 22.
    trustThis trusts all unknown hosts if set to yes/true.
    + Note If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.    		No, defaults to No.
    knownhostsThis sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.No, defaults to + ${user.home}/.ssh/known_hosts.
    failonerrorWhether to halt the build if the command does not complete successfully. + No; defaults to true.
    passwordThe password.Not if you are using key based + authentication or the password has been given in the file or + todir attribute.
    keyfileLocation of the file holding the private key.Yes, if you are using key based + authentication.
    passphrasePassphrase for your private key.No, defaults to an empty string.
    outputName of a file to which to write the output.No
    appendWhether output file should be appended to or overwritten. Defaults to false, meaning overwrite any existing file.No
    outputpropertyThe name of a property in which the output of the + command should be stored. If you use the commandResource + attribute, each command's output will be prefixed by the + command itself.No
    timeoutStop the command if it doesn't finish within the + specified time (given in milliseconds unlike telnet, which + expects a timeout in seconds). + Defaults to 0 which means "wait forever".No
    inputA file from which the executed command's standard + input is taken. This attribute is mutually exclusive with the + inputstring attribute.
    + When executing more than one command via commandResource, input + will be read for each command. + since Ant 1.8.0    		No
    verboseDetermines whether sshexec outputs verbosely to the user.
    + Similar output is generated as the ssh commandline tool wit the -v option. + since Ant 1.8.0    		No, defaults to false
    inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute.
    + When executing more than one command via commandResource, input + will be read for each command. + since Ant 1.8.0    		No
    + +

    Examples

    +

    Run a command on a remote machine using password authentication

    +
    +  <sshexec host="somehost"
+	username="dude"
+	password="yo"
+	command="touch somefile"/>
+
    + +

    Run a command on a remote machine using key authentication

    +
    +  <sshexec host="somehost"
+	username="dude"
+	keyfile="${user.home}/.ssh/id_dsa"
+	passphrase="yo its a secret"
+	command="touch somefile"/>
+
    + +

    Run a command on a remote machine using key authentication with no passphrase

    +
    +  <sshexec host="somehost"
+	username="dude"
+	keyfile="${user.home}/.ssh/id_dsa"
+	command="touch somefile"/>
+
    + +

    Run a set of commands from a command resource (file) on a remote machine using key authentication with no passphrase

    +
    +  <sshexec host="somehost"
+	username="dude"
+	keyfile="${user.home}/.ssh/id_dsa"
+	commandResource="to_run"/>
+
    + + +

    Security Note: Hard coding passwords and/or usernames +in sshexec task can be a serious security hole. Consider using variable +substitution and include the password on the command line. For example:
    +

    +  <sshexec host="somehost"
+	username="${username}"
+	password="${password}"
+	command="touch somefile"/>
+
    +Invoking ant with the following command line: +
    +    ant -Dusername=me -Dpassword=mypassword target1 target2
+
    + +Is slightly better, but the username/password is exposed to all users +on an Unix system (via the ps command). The best approach is to use +the +<input> task and/or retrieve the password from a (secured) +.properties file. +

    + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sshsession.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sshsession.html new file mode 100644 index 000000000..e9696d1f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sshsession.html @@ -0,0 +1,288 @@ + + + + + + +SSHSESSION Task + + + + +

    SSHSESSION

    +

    Description

    + +

    since Apache Ant 1.8.0

    + +

    A Task which establishes an SSH connection with a remote machine +running SSH daemon, optionally establishes any number of local or +remote tunnels over that connection, then executes any nested tasks +before taking down the connection. +

    + +

    Note: This task depends on external libraries not included +in the Ant +distribution. See Library +Dependencies for more information. This task has been tested with +jsch-0.1.33 and above and won't work with versions of jsch earlier +than 0.1.28.

    + +

    See also the sshexec +and scp tasks

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    hostThe hostname or IP address of the remote host to which you wish to connect.Yes
    usernameThe username on the remote host to which you are connecting.Yes
    portThe port to connect to on the remote host.No, defaults to 22.
    localtunnelsA comma-delimited list of + colon-delimited lport:rhost:rport triplets defining + local port forwarding.
    If + nested localtunnel elements are also + provided, both sets of tunnels will be established.    		No
    remotetunnelsA comma-delimited list of + colon-delimited rport:lhost:lport triplets defining + remote port forwarding.
    If + nested remotetunnel elements are + also provided, both sets of tunnels will be established.    		No
    trustThis trusts all unknown hosts if set to yes/true.
    + Note If you set this to false (the default), the + host you connect to must be listed in your knownhosts file, this + also implies that the file exists.    		No, defaults to No.
    knownhostsThis sets the known hosts file to use to validate + the identity of the remote host. This must be a SSH2 format file. + SSH1 format is not supported.No, defaults to + ${user.home}/.ssh/known_hosts.
    failonerrorWhether to halt the build if the command does not complete successfully. + No; defaults to true.
    passwordThe password.Not if you are using key based + authentication or the password has been given in the file or + todir attribute.
    keyfileLocation of the file holding the private key.Yes, if you are using key based + authentication.
    passphrasePassphrase for your private key.No, defaults to an empty string.
    timeoutGive up if the connection cannot be established + within the specified time (given in milliseconds). Defaults to 0 + which means "wait forever".No
    + +

    Parameters specified as nested elements

    + +

    localtunnel

     +

    Optionally, any number of localtunnel elements can be used to +define local port forwarding over the SSH connection. If the +localtunnels parameter was also specified, both sets of tunnels will +be established.

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    lportThe number of the local port to be forwarded.Yes
    rhostThe hostname or IP address of the remote host to + which the local port should be forwarded.Yes
    rportThe number of the port on the remote host to + which the local port should be forwarded.Yes
    + +

    remotetunnel

     +

    Optionally, any number of remotetunnel elements can be used to +define remote port forwarding over the SSH connection. If the +remotetunnels parameter was also specified, both sets of tunnels will +be established.

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    rportThe number of the remote port to be forwarded.Yes
    lhostThe hostname or IP address of the local host to + which the remote port should be forwarded.Yes
    lportThe number of the port on the local host to which + the remote port should be forwarded.Yes
    + +

    sequential

     +

    The sequential element is a required parameter. It is a container +for nested Tasks which are to be executed once the SSH connection is +established and all local and/or remote tunnels established.

    + +

    Examples

    +

    Connect to a remote machine using password authentication, +forward the local cvs port to the remote host, and execute a cvs +command locally, which can use the tunnel.

    +
    +  <sshsession host="somehost"
+    username="dude"
+    password="yo"
+    localtunnels="2401:localhost:2401"
+  >
+    <sequential>
+      <cvs  command="update ${cvs.parms} ${module}"
+        cvsRoot="${cvs.root}"
+        dest="${local.root}"
+        failonerror="true"
+      />
+    </sequential>
+  </sshsession>
+
    + +

    Do the same thing using nested localtunnel element.

    +
    +  <sshsession host="somehost"
+    username="dude"
+    password="yo"
+  >
+    <localtunnel lport="2401" rhost="localhost" rport="2401"/>
+    <sequential>
+      <cvs  command="update ${cvs.parms} ${module}"
+        cvsRoot="${cvs.root}"
+        dest="${local.root}"
+        failonerror="true"
+    />
+    </sequential>
+  </sshsession>
+
    + +

    Connect to a remote machine using key authentication, forward +port 1080 to port 80 of an intranet server which is not directly +accessible, then run a get task using that tunnel.

    +
    +  <sshsession host="somehost"
+  username="dude"
+  keyfile="${user.home}/.ssh/id_dsa"
+  passphrase="yo its a secret"/>
+    <LocalTunnel lport="1080" rhost="intranet.mycomp.com" rport="80"/>
+    <sequential>
+      <get src="http://localhost:1080/somefile" dest="temp/somefile"/>
+    </sequential>
+  </sshsession>
+
    + + +

    Security Note: Hard coding passwords or +passphrases and/or usernames in sshsession task can be a serious +security hole. Consider using variable substitution and include the +password on the command line. For example:
    +

    +  <sshsession host="somehost"
+  username="${username}"
+  password="${password}"
+  localtunnels="2401:localhost:2401">
+    <sequential>
+      <sometask/>
+    </sequential>
+  </sshsession>
+
    + +Invoking ant with the following command line: +
    +    ant -Dusername=me -Dpassword=mypassword target1 target2
+
    + +Is slightly better, but the username/password is exposed to all users +on an Unix system (via the ps command). The best approach is to use +the +<input> task and/or retrieve the password from a (secured) +.properties file. +

    + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/starteam.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/starteam.html new file mode 100644 index 000000000..462b458ec --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/starteam.html @@ -0,0 +1,990 @@ + + + + + +StarTeam Tasks + + +

    StarTeam Support

    + + +

    +The StarTeam revision control system was recently acquired by Borland. +These tasks make use of functions from the StarTeam API to work with that system. +As a result they are only available to licensed users of StarTeam. You must have +starteam-sdk.jar in your classpath to run these tasks. +For more information about the StarTeam API and how to license it, see +the Borland web site.

    +

    + All the StarTeam task names are in lower case. +

    +

    Important Note on Installation and Licensing:

    +

    +On Windows machines, the mere presence of starteam-sdk.jar on the classpath +is not sufficient for getting these tasks to work properly. These tasks also require a +fully-installed and fully-licensed version of the StarGate Runtime. This is part +of a StarTeam client installation or may be installed separately. The full client +install is not required. In particular, the Windows path must include the directory where +the StarGate Runtime .dll files are installed. +

    +Earlier versions of Apache Ant (prior to 1.5.2) did not have this restriction because they +were not as dependent on the StarTeam runtime - which the newer versions use to access +StarTeam file status information. The older versions lacked this important capability. +

    +
    + + +

    Common Parameters for All Starteam Tasks

     +

    +The following parameters, having to do with making the connection to a StarTeam project, are common to all the following tasks except the deprecated StarTeam task. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    usernameThe username of the account used to log in to the StarTeam server.yes
    passwordThe password of the account used to log in to the StarTeam server.yes
    URLA string of the form servername:portnum/project/view +which enables user to set all of these elements in one string. Either this ...
    servernameThe name of the StarTeam server.... or all four of these must be defined.
    serverportThe port number of the StarTeam server.
    projectnameThe name of the StarTeam project on which to operate.
    viewnameThe name of the view in the StarTeam project on which to operate.
    + +
    + + +

    STCheckout

     + +

    Description

    + +Checks out files from a StarTeam project. + +

    +The includes and excludes attributes function differently from +other tasks in Ant. Inclusion/exclusion by folder is NOT supported. +

    + +

    Parameters

    +See also the required common StarTeam parameters.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    rootstarteamfolderThe root of the subtree in the StarTeam repository from which to + check out files. Defaults to the root folder of the view ('/'). + If supplied, this should always be an "absolute" path, that is, it should begin with a '/'. + Relative paths have little meaning in this context and confuse StarTeam. + no
    rootlocalfolderThe local folder which will be the root of the tree to which files are checked out. If this is not supplied, then the StarTeam "default folder" associated with rootstarteamfolder is used. + no
    createworkingdirscreates local folders even when the corresponding StarTeam folder is empty. Defaults to "true".no
    deleteuncontrolledif true, any files NOT in StarTeam will be deleted. Defaults to "true".no
    includesOnly check out files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    excludesDo not check out files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    labelCheck out files as of this label. The label must exist in starteam or an exception will be thrown.Either or neither, but not both, may be specified. Neither locked or unlocked may be true if either label or asofdate is specified.
    asofdateCheck out files as of this date. The date must + be formatted in ISO8601 datetime + (yyyy-MM-dd'T'HH:mm:ss), ISO8601 + date(yyyy-MM-dd) or a user-defined SimpleDateFormat + defined in the asofDateFormat attribute. If the date + is not parsable by the default or selected format, an exception + will be thrown. Since Ant 1.6.
    asofdateformatjava.util.SimpleDateFormat compatible string used + to parse the asofdate attribute. Since Ant + 1.6.no
    recursiveIndicates if subfolders should be searched for files to check out. Defaults to "true".no
    forcedIf true, checkouts will occur regardless of the status +that StarTeam is maintaining for the file. If false, status will be used to determine which files to check out. Defaults to "false".no
    lockedIf true, file will be locked against changes by other +users. If false (default) has no effect. + Either or neither, but not both, may be true. Neither may be true if a label or an asofdate is specified.
    unlockedIf true, file will be unlocked so that other users may +change it. This is a way to reverse changes that have not yet been checked in. +If false (default) has no effect.
    userepositorytimestamptrue means checked out files will get the repository timestamp. +false(default) means the checked out files will be timestamped at the time +of checkout. no
    preloadfileinformationThe StarTeam server has the ability to preload file metadata for an + entire tree prior to beginning action on that tree. Doing so can in some instances + lead to substantially faster actions, particularly over large trees. Setting this + to "yes" (default) engages this functionality, setting it to "no" turns it off.no
    convertEOLIf true, (default) all ascii files will have their end-of-line + characters adjusted to that of the local machine on checkout. This is normally + what you'd want but if for some reason you don't want that to happen, set it to false + and the files will be checked out with whatever end-of-line characters are used on + the server. no
    + +

    Examples

    + +
    +  <stcheckout servername="STARTEAM" 
+              serverport="49201"
+              projectname="AProject" 
+              viewname="AView"
+              username="auser"
+              password="secret"
+              rootlocalfolder="C:\dev\buildtest\co"
+              forced="true"
+  />
+
    + +The minimum necessary to check out files out from a StarTeam server. This will +check out all files in the AView view of the AProject project to +C:\dev\buildtest\co. Empty folders in StarTeam will have local folders +created for them and any non-StarTeam files found in the tree will be deleted. + +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView" 
+              username="auser"
+              password="secret"
+              rootlocalfolder="C:\dev\buildtest\co"
+              forced="true"
+  />
+
    +And this is a simpler way of accomplishing the same thing as the previous example, using the URL attribute. +

    +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView" 
+              username="auser"
+              password="secret"
+              rootlocalfolder="C:\dev\buildtest\co"
+              rootstarteamfolder="\Dev"
+              excludes="*.bak *.old"
+              label="v2.6.001"
+              forced="true"
+  />
+
    + +This will check out all files from the Dev folder and below that do not +end in .bak or .old with the label v2.6.001. + +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
+              username="auser"
+              password="secret"
+              rootlocalfolder="C:\dev\buildtest\co"
+              includes="*.htm,*.html"
+              excludes="index.*"
+              forced="true"
+  />
+
    + + +This is an example of overlapping includes and excludes attributes. Because +excludes takes precedence over includes, files named index.html will +not be checked out by this command. + +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
+              username="auser"
+              password="secret"
+              rootlocalfolder="C:\dev\buildtest\co"
+              includes="*.htm,*.html"
+              excludes="index.*"
+              forced="true"
+              recursive="false"
+  />
+
    +This example is like the previous one, but will only check out files in +C:\dev\buildtest\co, because of the turning off of the recursive attribute. + +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
+              username="auser"
+              password="secret"
+              rootstarteamfolder="src/java"
+              rootlocalfolder="C:\dev\buildtest\co"
+              forced="true"
+  />
+
    +

    +
    +  <stcheckout URL="STARTEAM:49201/Aproject/AView"
+              username="auser"
+              password="secret"
+              rootstarteamfolder="src/java"
+  />
+
    +

    +
    + <stcheckout URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootstarteamfolder="src/java"
+             rootlocalfolder="C:\dev\buildtest\co\src\java"
+             forced="true"
+  />
+
    + +In the preceding three examples, assuming that the AProject project has a default folder of +"C:\work\AProject", the first example will check out the tree of files rooted in the src/java folder of the AView view of the AProject in the StarTeam repository to a local tree rooted at C:\dev\buildtest\co, +the second to a tree rooted at C:\work\AProject\src\java (since no rootlocalfolder is specified) and the third to a tree rooted at C:\dev\buildtest\co\src\java. Note also, that since the second example does not set "forced" true, only those files which the repository considers out-of-date will be checked out. +
    + + +

    STCheckin

     + +

    Description

    + +Checks files into a StarTeam project. Optionally adds files and in the local tree that are not managed by the repository to its control. + +

    +The includes and excludes attributes function differently from +other tasks in Ant. Inclusion/exclusion by folder is NOT supported. +

    + +

    Parameters

    +See also the required common StarTeam parameters.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    rootstarteamfolderThe root of the subtree in the StarTeam repository into which to + files will be checked. Defaults to the root folder of the view ('/'). + If supplied, this should always be an "absolute" path, that is, it should begin with a '/'. + Relative paths have little meaning in this context and confuse StarTeam.no
    rootlocalfolderThe local folder which will be the root of the tree to which files are checked out. If this is not supplied, then the StarTeam "default folder" associated with rootstarteamfolder is used. no
    commentCheckin comment to be saved with the file.no
    adduncontrolledif true, any files or folders NOT in StarTeam will be +added to the repository. Defaults to "false".no
    includesOnly check in files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    excludesDo not check in files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    recursiveIndicates if subfolders should be searched for files to check in. Defaults to "false".no
    forcedIf true, checkins will occur regardless of the status +that StarTeam is maintaining for the file. If false, checkins will use this status to decide which files to update. Defaults to "false".no
    unlockedIf true, file will be unlocked so that other users may +change it. If false (default) lock status will not change. + no
    preloadfileinformationThe StarTeam server has the ability to preload file metadata for an + entire tree prior to beginning action on that tree. Doing so can in some instances + lead to substantially faster actions, particularly over large trees. Setting this + to "yes" (default) engages this functionality, setting it to "no" turns it off.no
    + +

    Examples

    + +
    +  <stcheckin servername="STARTEAM" 
+             serverport="49201"
+             projectname="AProject" 
+             viewname="AView"
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             forced="true"
+  />
+
    + +The minimum necessary to check files into a StarTeam server. This will +check all files on the local tree rooted at C:\dev\buildtest\co +into the AView view of the AProject project in the repository. +For files and folders in the local tree but not in starteam, nothing will be done. Since the forced attribute is set, the files which are checked in will be checked in without regard to what the StarTeam repository considers their status to be. This is a reasonable choice of attributes since StarTeam's status for a file is calculated based on the local file in the StarTeam default directory, not on the directory we are actually working with. + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView" 
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             forced="true"
+  />
+
    +And this is a simpler way of giving the same commands as the command above using the URL shortcut. +

    +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView" 
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             rootstarteamfolder="\Dev"
+             excludes="*.bak *.old"
+             forced="true"
+  />
+
    + +This will check all files in to the Dev folder and below that do not +end in .bak or .old from the tree rooted at"C:\dev\buildtest\co" . + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             includes="*.htm,*.html"
+             excludes="index.*"
+             forced="true"
+  />
+
    + + +This is an example of overlapping includes and excludes attributes. Because +excludes takes precedence over includes, files named index.html will +not be checked in by this command. + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             rootstarteamfolder="src/java"
+             includes="*.htm,*.html"
+             excludes="index.*"
+             forced="true"
+             recursive="false"
+  />
+
    +This example is like the previous one, but will only check in files from +C:\dev\buildtest\co, because of the turning off of the recursive attribute. + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             rootstarteamfolder="src/java"
+             includes="version.txt"
+             forced="true"
+             recursive="false"
+  />
+
    +This example is like the previous one, but will only check only in one file, C:\dev\buildtest\co\version.txt to the StarTeam folder src/java. + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootlocalfolder="C:\dev\buildtest\co"
+             rootstarteamfolder="src/java"
+             includes="version.java"
+             forced="true"
+             recursive="false"
+             addUncontrolled="true"
+             comment="Fix Bug #667"
+  />
+
    +This example is like the previous one, but will only check only in one file, C:\dev\buildtest\co\version.java to the StarTeam folder src/java. Because the addUncontrolled attribute has been set, if StarTeam does not already control this file in this location, it will be added to the repository. Also, it will write a comment to the repository for this version of the file. + +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootstarteamfolder="src/java"
+             rootlocalfolder="C:\dev\buildtest\co"
+             forced="true"
+  />
+
    +

    +
    +  <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootstarteamfolder="src/java"
+  />
+
    +

    +
    + <stcheckin URL="STARTEAM:49201/Aproject/AView"
+             username="auser"
+             password="secret"
+             rootstarteamfolder="src/java"
+             rootlocalfolder="C:\dev\buildtest\co\src\java"
+             forced="true"
+  />
+
    + +In the preceding three examples, assuming that the AProject project has a default folder of C:\work\buildtest\co\AProject, +the first example will check in files from a tree rooted at C:\dev\buildtest\co, +the second from a tree rooted at C:\work\buildtest\co\AProject\src\java, +and the third from a tree rooted at C:\dev\buildtest\co\src\java all to a tree rooted at src/java + +
    + + +

    STLabel

     + +

    Description

    + +Creates a view label in StarTeam at the specified view. The label will be classified by StarTeam as a "build label". This task will fail if there already exists in viewname a label with the same name as the label parameter. + +

    Parameters

    +See also the required common StarTeam parameters.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    labelThe name to be given to the labelyes
    descriptionA description of the label to be stored in the StarTeam project.yes
    revisionlabelYes means that the label attribute is to be saved as a "revision label". No (default) means that it will be saved as a "view label"no
    buildlabelYes means that the label attribute is to be saved as a "build label". + This means that Change Requests which have an "AddressedIn" field value of "next build" + will have this label assigned to that field when the label is created. + No (default) means that no CRs will have this label assigned to them. This will have no effect if revisionlabel is also true. no
    lastbuildThe timestamp of the build that will be stored with the label. Must be formatted yyyyMMddHHmmssno
    + +

    Examples

    + +This example shows the use of this tag. It will create a View label that is a build label named Version 6.2 with +"Thorough description" as its description. +
    +  <tstamp>
+    <format property="nowstamp" pattern="yyyyMMddHHmmss" locale="en"/>
+  </tstamp>  
+  <stlabel URL="STARTEAM:49201/Aproject/AView"
+           username="auser"
+           password="secret"
+           label="Version 6.2"
+           lastbuild="${nowstamp}"
+           description="Thorough description"
+  />
+
    +This example creates a non-build View label named Version 6.3 with +"Thorough description" as its description. +
    +  <tstamp>
+    <format property="nowstamp" pattern="yyyyMMddHHmmss" locale="en"/>
+  </tstamp>  
+  <stlabel URL="STARTEAM:49201/Aproject/AView"
+           username="auser"
+           password="secret"
+           label="Version 6.3"
+           lastbuild="${nowstamp}"
+           description="Thorough description"
+           buildlabel="false"
+  />
+
    +This example will create a Revision label that is a build label named Version 6.2.00.001 with +"revision label" as its description. +
    +  <tstamp>
+    <format property="nowstamp" pattern="yyyyMMddHHmmss" locale="en"/>
+  </tstamp>  
+  <stlabel URL="STARTEAM:49201/Aproject/AView"
+           username="auser"
+           password="secret"
+           label="Version 6.2.00.001"
+           description="revision label"
+           revisionlabel="true"
+  />
+
    + +
    + +

    STList

     + +

    Description

    + +Produces a listing of the contents of the StarTeam repository at the specified view and StarTeamFolder. The listing will contain the name of the user, if any, who has the file locked, the size of the file, its lastModifiedDate in the repository, the name of the file, and the status of the local file in the default local directory relative to the repository. + +

    Parameters

    +See also the required common StarTeam parameters.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    rootstarteamfolderThe root of the subtree in the StarTeam repository to be listed. Defaults to the root folder of the view ('/'). If supplied, this should always be an "absolute" path, that is, it should begin with a '/'. + Relative paths have little meaning in this context and confuse StarTeam.no
    rootlocalfolderThe local folder which will be the root of the tree to which files are compared. If this is not supplied, then the StarTeam "default folder" associated with rootstarteamfolder is used and a status field will appear in the listing. Otherwise, the status field will not appear. + no
    includesOnly list files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    excludesDo not list files that match at least one of the patterns in this list. Patterns must be separated by commas. Patterns in excludes take precedence over patterns in includes.no
    labelList files, dates, and statuses as of this label. The label must exist in starteam or an exception will be thrown. If not specified, the most recent version of each file will be listed.no
    asofdateList files, dates, and statuses as of this date. + The date must be formatted in ISO8601 datetime + (yyyy-MM-dd'T'HH:mm:ss), ISO8601 + date(yyyy-MM-dd) or a user-defined SimpleDateFormat + defined in the asofDateFormat attribute. If the date + is not parsable by the default or selected format, an exception + will be thrown. Since Ant 1.6.no
    asofdateformatjava.util.SimpleDateFormat compatible string used + to parse the asofdate attribute. Since Ant + 1.6.no
    recursiveIndicates if subfolders should be searched for files to list. Defaults to "true".no
    listuncontrolledif true, any files or folders NOT in StarTeam will be included in the listing. + If false, they won't. Defaults to "true".no
    preloadfileinformationThe StarTeam server has the ability to preload file metadata for an + entire tree prior to beginning action on that tree. Doing so can in some instances + lead to substantially faster actions, particularly over large trees. Setting this + to "yes" (default) engages this functionality, setting it to "no" turns it off.no
    +

    Examples

    + +
    +
+  <stlist url="WASHINGTON:49201/build"
+          username="auser"
+          password="secret"
+ />
+
    + +The above command might produce the following listing: + +
    +   [stlist] Folder: Build (Default folder: C:/work/build)
+   [stlist] Folder: dev (Default folder: C:/work/build/dev)
+   [stlist] Out of date  Sue Developer        1/1/02 7:25:47 PM CST     4368 build.xml
+   [stlist] Missing      George Hacker        1/1/02 7:25:49 PM CST       36 Test01.properties
+   [stlist] Current                           1/1/02 7:25:49 PM CST     4368 build2.xml
+   [stlist] Folder: test (Default folder C:/work/build/dev/test)
+   [stlist] Missing                           1/1/02 7:25:50 PM CST     4368 build2.xml
+
    + +while adding a rootlocalfolder and an excludes param ... + +
    +
+  <stlist url="WASHINGTON:49201/build"
+          username="auser"
+          password="secret"
+          rootlocalfolder="srcdir2"
+          excludes="*.properties"
+ />
+
    + +might produce this listing. The status is missing because we are not going against the default folder. + +
    +   [stlist] overriding local folder to srcdir2
+   [stlist] Folder: Build (Local folder: srcdir2)
+   [stlist] Folder: dev (Local folder: srcdir2/dev)
+   [stlist] Sue Developer        1/1/02 7:25:47 PM CST     4368 build.xml
+   [stlist]                      1/1/02 7:25:49 PM CST     4368 build2.xml
+   [stlist] Folder: test (Local folder: srcdir2/dev/test)
+   [stlist]                      1/1/02 7:25:50 PM CST     4368 build2.xml
+ 
+
+
    + +
    + + +

    Starteam

     +

    Deprecated

    +

    This task has been deprecated. Use the STCheckout task instead.

    +

    Description

    + +Checks out files from a StarTeam project. + +

    +The includes and excludes attributes function differently from +other tasks in Ant. Multiple patterns must be separated by spaces, not +commas. See the examples for more information.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    usernameThe username of the account used to log in to the StarTeam server.yes
    passwordThe password of the account used to log in to the StarTeam server.yes
    servernameThe name of the StarTeam server.yes
    serverportThe port number of the StarTeam server.yes
    projectnameThe name of the StarTeam project.yes
    viewnameThe name of the view in the StarTeam project.yes
    targetfolderThe folder to which files are checked out. What this precisely means is determined by the targetFolderAbsolute param.yes
    targetFolderAbsoluteDetermines how targetfolder is interpreted, that is, whether the StarTeam "default folder" for the project is factored in (false) or whether targetFolder is a complete mapping to foldername (true). + If "true", the target tree will be rooted at targetfolder+"default folder". If false, the target tree will be rooted at targetfolder. Defaults to "false". no
    foldernameThe subfolder in the project from which to check out files.no
    forceOverwrite existing folders if this is set to "true". Defaults to "false".no
    recursionIndicates if subfolders should be searched for files to check out. Defaults to "true".no
    verboseProvides progress information. Defaults to "false".no
    includesOnly check out files that match at least one of the patterns in this list. Patterns must be separated by spaces. Patterns in excludes take precedence over patterns in includes.no
    excludesDo not check out files that match at least one of the patterns in this list. Patterns must be separated by spaces. Patterns in excludes take precedence over patterns in includes.no
    + +

    Examples

    + +
    +  <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+  />
+
    + +The minimum necessary to check out files out from a StarTeam server. This will +check out all files in the AView view of the AProject project to +C:\dev\buildtest\co. + +
    +  <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            foldername="\Dev"
+            excludes="*.bak *.old"
+            force="true"
+  />
+
    + +This will checkout all files from the Dev folder and below that do not +end in .bak or .old. The force flag will cause any existing files to be +overwritten by the version in StarTeam. + +
    +  <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            includes="*.htm *.html"
+            excludes="index.*"
+  />
+
    + + + +This is an example of overlapping includes and excludes attributes. Because +excludes takes precedence over includes, files named index.html will +not be checked out by this command. + + +
    + <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            foldername="src/java"
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            targetfolderabsolute="true"
+  />
+
    +

    +
    + <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            foldername="src/java"
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co"
+            targetfolderabsolute ="false"
+  />
+
    +

    +
    + <starteam servername="STARTEAM" 
+            serverport="49201"
+            projectname="AProject" 
+            foldername="src/java"
+            viewname="AView"
+            username="auser"
+            password="secret"
+            targetfolder="C:\dev\buildtest\co\src\java"
+            targetfolderabsolute="true"
+  />
+
    + +In the preceding three examples, assuming that the AProject project has a default folder of +"AProject", the first example will check the files located in starteam under src/java out to a tree rooted at C:\dev\buildtest\co, +the second to a tree rooted at C:\dev\buildtest\co\AProject\src\java and the third to a tree rooted at C:\dev\buildtest\co\src\java. + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/style.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/style.html new file mode 100644 index 000000000..5ade572de --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/style.html @@ -0,0 +1,545 @@ + + + + + + +XSLT Task + + + + +

    XSLT

    +

    The name style is a deprecated name for the same task.

    +

    Description

    +

    Process a set of documents via XSLT.

    +

    This is useful for building views of XML based documentation, +or for generating code.

    +

    Note: If you are using JDK 1.4 or higher, this task does not require external libraries +not supplied in the Apache Ant distribution. However, often the built in XSL engine is not as up +to date as a fresh download, so an update is still highly recommended + in particular since the built-in XSLT processors of Java 5 (and to a + certain extent Java 6) are known to have serious issues. +See Library Dependencies for more information.

    +

    It is possible to refine the set of files that are being processed. This can be +done with the includes, includesfile, excludes, excludesfile and defaultexcludes +attributes. With the includes or includesfile attribute you specify the files you want to +have included by using patterns. The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

    +

    This task forms an implicit FileSet and supports all + attributes of <fileset> (dir becomes basedir) + as well as the nested <include>, <exclude> + and <patternset> elements.

    + +

    Note: Unlike other similar tasks, this task treats +directories that have been matched by the include/exclude patterns of +the implicit fileset in a special way. It will apply the stylesheets +to all files contain in them as well. Since the default include +pattern is ** this means it will apply the stylesheet to +all files. If you specify an excludes pattern, it may still work on +the files matched by those patterns because the parent directory has +been matched. If this behavior is not what you want, set the +scanincludedirectories attribute to false.

    + +

    Starting with Ant 1.7 this task supports nested resource collections +in addition to (or instead of, depending on the useImplicitFileset +attribute) the implicit fileset formed by this task.

    + +

    This task supports the use of a nested <param> element which is used to pass values + to an <xsl:param> declaration.

    +

    This task supports the use of a nested xmlcatalog +element which is used to perform Entity and URI resolution.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    basedirwhere to find the source XML file, default is the + project's basedir.No
    destdirdirectory in which to store the results.Yes, unless in and out have been + specified.
    extensiondesired file extension to be used for the targets. If not + specified, the default is ".html". Will be ignored if + a nested <mapper> has been specified.No
    stylename of the stylesheet to use - given either relative + to the project's basedir or as an absolute path.
    +
    + Alternatively, a nested element which ant can interpret as a resource + can be used to indicate where to find the stylesheet
    + deprecated variation :
    + If the stylesheet cannot be found, and if you have specified the + attribute basedir for the task, ant will assume that the style + attribute is relative to the basedir of the task. +     		No, if the location of + the stylesheet is specified using a nested <style> element
    classpaththe classpath to use when looking up the XSLT + processor.No
    classpathrefthe classpath to use, given as reference to a path defined elsewhere.No
    forceRecreate target files, even if they are newer + than their corresponding source files or the stylesheet.No; default is false
    processorname of the XSLT processor to use. + Permissible value is :
      +
    • "trax" for a TraX compliant processor (ie JAXP interface + implementation such as Xalan 2 or Saxon)
    + Defaults to trax. +
    + Support for xalan1 has been removed in ant 1.7. +     		No
    includescomma- or space-separated list of patterns of files that must be included. + All files are included when omitted.No
    includesfilethe name of a file. Each line of this file is taken to be + an include patternNo
    excludescomma- or space-separated list of patterns of files that must be excluded. + No files (except default excludes) are excluded when omitted.No
    excludesfilethe name of a file. Each line of this file is taken to be + an exclude patternNo
    defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
    inspecifies a single XML document to be styled. Should be used + with the out attribute.No
    outspecifies the output name for the styled result from the + in attribute.No
    scanincludeddirectoriesIf any directories are matched by the + includes/excludes patterns, try to transform all files in these + directories. Default is trueNo
    reloadstylesheetControl whether the stylesheet transformer is created + anew for every transform opertaion. If you set this to true, performance may + suffer, but you may work around a bug in certain Xalan-J versions. + Default is false. Since Ant 1.5.2.No
    useImplicitFilesetWhether the implicit fileset formed by this task + shall be used. If you set this to false you must use nested + resource collections - or the in attribute, in which case this + attribute has no impact anyway. Default is true. + Since Ant 1.7.No
    filenameparameterSpecifies a xsl parameter for accessing the name + of the current processed file. If not set, the file name is not + passed to the transformation. + Since Ant 1.7.No
    filedirparameterSpecifies a xsl parameter for accessing the directory + of the current processed file. For files in the current directory a + value of '.' will be passed to the transformation. + If not set, the directory is not passed to the transformation. + Since Ant 1.7.No
    supressWarningsWhether processor warnings shall be suppressed. + This option requires support by the processor, it is supported by + the trax processor bundled with Ant. + Since Ant 1.8.0.No, default is false.
    failOnErrorWhether the build should fail if any error + occurs. Note that transformation errors can still be surpressed by + setting failOnTransformationError to false even if this attribute + is true. + Since Ant 1.8.0.No, default is true.
    failOnTransformationErrorWhether the build should fail if an error occurs + while transforming the document. Note that this attribute has no + effect of failOnError is false. + Since Ant 1.8.0.No, default is true.
    failOnNoResourcesWhether the build should fail if the nested + resource collection is empty. Note that this attribute has no + effect of failOnError is false. + Since Ant 1.8.0.No, default is true.
    +

    Parameters specified as nested elements

    + +

    any resource +collection

    + +

    since Ant 1.7

    + +

    Use resource collections to specify resources that the stylesheet +should be applied to. Use a nested mapper and the task's destdir +attribute to specify the output files.

    + +

    classpath

    +

    The classpath to load the processor from can be specified via a +nested <classpath>, as well - that is, a +path-like structure.

    + +

    xmlcatalog

    +

    The xmlcatalog +element is used to perform Entity and URI resolution.

    + +

    param

    +

    Param is used to pass a parameter to the XSL stylesheet.

    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameName of the XSL parameterYes
    expressionText value to be placed into the param.
    + Was originally intended to be an XSL expression.    		Yes
    ifThe param will only be passed if this property is set.No
    unlessThe param will not be passed if this property is set.No
    +
    + +

    outputproperty ('trax' processors only)

    +

    Used to specify how you wish the result tree to be output +as specified in the +XSLT specifications. +

    +

    Parameters

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameName of the propertyYes
    valuevalue of the property.Yes
    +
    + +

    factory ('trax' processors only)

    +Used to specify factory settings. +
    +

    Parameters

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    namefully qualified classname of the + transformer factory to use. For example + org.apache.xalan.processor.TransformerFactoryImpl + or org.apache.xalan.xsltc.trax.TransformerFactoryImpl + or net.sf.saxon.TransformerFactoryImpl... + No. Defaults to the JAXP lookup mechanism.
    +

    Parameters specified as nested elements

    +

    attribute

    +

    Used to specify settings of the processor factory. +The attribute names and values are entirely processor specific +so you must be aware of the implementation to figure them out. +Read the documentation of your processor. +For example, in Xalan 2.x: +

      +
    • http://xml.apache.org/xalan/features/optimize (boolean)
      • +
    • http://xml.apache.org/xalan/features/incremental (boolean)
      • +
    • ...
      • +
    +And in Saxon 7.x: +
      +
    • http://saxon.sf.net/feature/allow-external-functions (boolean)
      • +
    • http://saxon.sf.net/feature/timing (boolean)
      • +
    • http://saxon.sf.net/feature/traceListener (string)
      • +
    • http://saxon.sf.net/feature/treeModel (integer)
      • +
    • http://saxon.sf.net/feature/linenumbering (integer)
      • +
    • ...
      • +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameName of the attributeYes
    valuevalue of the attribute.Yes
    +
    +
    +

    mapper

    + +

    since Ant 1.6.2

    + +

    You can define filename transformations by using a nested mapper element. The default mapper +used by <xslt> removes the file extension from the +source file and adds the extension specified via the extension +attribute.

    + +

    style

    + +

    Since Ant 1.7

    + +

    The nested style element can be used to specify your stylesheet in terms +of Ant's resource types. With +this element, the stylesheet should be specified as a nested resource or +single-element collection. Alternatively, use the refid to +specify the resource or collection as a reference.

    + +

    sysproperty

    +

    Use nested <sysproperty> elements to specify +system properties required by the factory or transformation. These +properties will be made available to the VM during the execution of +the class. The attributes for this element are the same as +for environment variables.

    + +

    since Ant 1.8.0.

    + +

    syspropertyset

    + +

    You can specify a set of properties to be used as system properties +with syspropertysets.

    + +

    since Ant 1.8.0.

    + +

    Examples

    +
    + 
    +<xslt basedir="doc" destdir="build/doc"
+       extension=".html" style="style/apache.xsl"/>
    +

    Using an xmlcatalog

    + 
    +<xslt basedir="doc" destdir="build/doc"
+      extension=".html" style="style/apache.xsl">
+  <xmlcatalog refid="mycatalog"/>
+</xslt>
+
+<xslt basedir="doc" destdir="build/doc"
+   extension=".html" style="style/apache.xsl">
+   <xmlcatalog>
+       <dtd
+         publicId="-//ArielPartners//DTD XML Article V1.0//EN"
+         location="com/arielpartners/knowledgebase/dtd/article.dtd"/>
+   </xmlcatalog>
+</xslt>
+
    +

    Using XSL parameters

    +
    +<xslt basedir="doc" destdir="build/doc"
+      extension=".html" style="style/apache.xsl">
+  <param name="date" expression="07-01-2000"/>
+</xslt>
    + +

    Then if you declare a global parameter "date" with the top-level + element <xsl:param name="date"/>, the variable + $date will subsequently have the value 07-01-2000. +

    + +

    Using output properties

    +
    +<xslt in="doc.xml" out="build/doc/output.xml"
+      style="style/apache.xsl">
+  <outputproperty name="method" value="xml"/>
+  <outputproperty name="standalone" value="yes"/>
+  <outputproperty name="encoding" value="iso8859_1"/>
+  <outputproperty name="indent" value="yes"/>
+</xslt>
+
    + +

    Using factory settings

    +
    +<xslt in="doc.xml" out="build/doc/output.xml"
+      style="style/apache.xsl">
+  <factory name="org.apache.xalan.processor.TransformerFactoryImpl">
+    <attribute name="http://xml.apache.org/xalan/features/optimize" value="true"/>
+  </factory>
+</xslt>
    + +

    Using a mapper

    +
    +<xslt basedir="in" destdir="out"
+      style="style/apache.xsl">
+  <mapper type="glob" from="*.xml.en" to="*.html.en"/>
+</xslt>
    + +

    Using a nested resource to define the stylesheet

    + 
    +<xslt in="data.xml" out="${out.dir}/out.xml">
+    <style>
+        <url url="${printParams.xsl.url}"/>
+    </style>
+    <param name="set" expression="value"/>
+</xslt>
    + +

    Print the current processed file name

    +
    +<project>
+  <xslt style="printFilename.xsl" destdir="out" basedir="in" extension=".txt"
+        filenameparameter="filename"
+        filedirparameter="filedir"
+  />
+</project>
+
+<xsl:stylesheet
+  version="1.0"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+    <xsl:param name="filename"></xsl:param>
+    <xsl:param name="filedir">.</xsl:param>
+
+<xsl:template match="/">
+  Current file is <xsl:value-of select="$filename"/> in directory <xsl:value-of select="$filedir"/>.
+</xsl:template>
+
+</xsl:stylesheet>
+
    + +

    Use an XInclude-aware version of Xerces while transforming

    + +
    +<xslt ...>
+    <sysproperty key="org.apache.xerces.xni.parser.XMLParserConfiguration"
+                 value="org.apache.xerces.parsers.XIncludeParserConfiguration"
+     />
+<xslt>
+
    +
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/subant.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/subant.html new file mode 100644 index 000000000..f3c23ee2b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/subant.html @@ -0,0 +1,610 @@ + + + + + + Subant + Task + + + + + + + + + + + + + + + + + +
    + + + +
    + Subant + Task +
    Calls a given target for all defined sub-builds. +     		+ + + Apache Ant + +
    +
    + + + + + + + + + + +
     
    + + + Description +
    +

    + Calls a given target for all defined sub-builds. + This is an extension + of ant for bulk project execution. + + This task must not be used outside of a + target if it invokes the same build file it is + part of. +

    +

    Since Apache Ant 1.6

    + +

    subant uses ant internally so many things + said in ant's manual page apply + here as well.

    + + + + + + +
    + + + Use with directories +
    +

    + subant can be used with directory sets to execute a build from different directories. + 2 different options are offered : +

    +
      +
    • + to run the same build file /somepath/otherpath/mybuild.xml + with different base directories, use the genericantfile attribute +
      • +
    • if you want to run directory1/mybuild.xml, directory2/mybuild.xml, ...., + use the antfile attribute. The subant task does not set the base directory for you in this case, because you can specify it in each build file. +
      • +
    + +
    + +
    + + + + + + + + + + + + +
     
    + + + Parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Attribute + + Description + + Type + + Requirement +
    + antfile + + Build file name, to use in conjunction with directories.
    Defaults to "build.xml".
    If genericantfile is set, this attribute is ignored.     +     		+ String + + Optional +
    + buildpath + + Set the buildpath to be used to find sub-projects. + + Path +
    + buildpathref + + Buildpath to use, by reference. + + Reference +
    + failonerror + + Sets whether to fail with a build exception on error, or go on. + + boolean +
    + genericantfile + + Build file path, to use in conjunction with directories.
    Use genericantfile, in order to run the same build file with different basedirs.
    If this attribute is set, antfile is ignored.     +     		+ File +
    + inheritall + + Corresponds to + <ant>'s + inheritall attribute but defaults + to false in this task.. + + boolean +
    + inheritrefs + + Corresponds to <ant>'s inheritrefs attribute. + + boolean +
    + output + + Corresponds to <ant>'s output attribute. + + String +
    + target + + + + String +
    + verbose + + + Enable/ disable log messages showing when each sub-build path is entered/ exited. + The default value is false. + + boolean +
    +
    + + + + + + + + + + +
     
    + + + Parameters as nested elements +
    + + + + + +
     
    + + any filesystem based resource collection +
    + This includes <fileset>, + <dirset> and <filelist> + which are the nested resource collections supported prior + to Ant 1.7. + + + +
    + + + + + + +
     
    + + dirset (org.apache.tools.ant.types.DirSet) +
    + Adds a directory set to the implicit build path.

    Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! + + + +

    + + + + + + +
     
    + + filelist (org.apache.tools.ant.types.FileList) +
    + Adds an ordered file list to the implicit build path.

    Note that contrary to file and directory sets, file lists can reference non-existent files or directories! + + + +

    + + + + + + +
     
    + + fileset (org.apache.tools.ant.types.FileSet) +
    + Adds a file set to the implicit build path.

    Note that the directories will be added to the build path in no particular order, so if order is significant, one should use a file list instead! + + + +

    + + + + + + +
     
    + + property (org.apache.tools.ant.taskdefs.Property) +
    + Corresponds to <ant>'s nested <property> element. + +

    When more than one nested <property> element + would set a property of the same name, the one declared last will + win. This is for backwards compatibility reasons even so it is + different from the way <property> tasks in build + files behave.

    + + + + +
    + + + + + + +
     
    + + propertyset (org.apache.tools.ant.types.PropertySet) +
    + Corresponds to <ant>'s nested <propertyset> element. + + + +
    + + + + + + +
     
    + + buildpath (org.apache.tools.ant.types.Path) +
    + Creates a nested build path, and add it to the implicit build path. + + + +
    + + + + + + +
     
    + + buildpathelement (org.apache.tools.ant.types.Path.PathElement) +
    + Creates a nested <buildpathelement>, and add it to the implicit build path. + + + +
    + + + + + + + + + + + +
     
    + + target (org.apache.tools.ant.taskdefs.Ant.TargetElement) +
    + You can specify multiple targets using nested <target> elements + instead of using the target attribute. These will be executed as if + Ant had been invoked with a single target whose dependencies are the + targets so specified, in the order specified. + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the called target.Yes
    +

    since Ant 1.7.

    +
    + + + +
    + + + + + + + + + + + +
     
    + + + Examples +
    + 
    +        <project name="subant" default="subant1">
+            <property name="build.dir" value="subant.build"/>
+            <target name="subant1">
+                <subant target="">
+                    <property name="build.dir" value="subant1.build"/>
+                    <property name="not.overloaded" value="not.overloaded"/>
+                    <fileset dir="." includes="*/build.xml"/>
+                </subant>
+            </target>
+        </project>
+
    +

    + this snippet build file will run ant in each subdirectory of the project directory, + where a file called build.xml can be found. + The property build.dir will have the value subant1.build in the ant projects called by subant. +

    +
    +          <subant target="">
+              <propertyset>
+                  <propertyref prefix="toplevel"/>
+                  <mapper type="glob" from="foo*" to="bar*"/>
+              </propertyset>
+              <fileset dir="." includes="*/build.xml"/>
+          </subant>
+
    +

    + this snippet build file will run ant in each subdirectory of the project directory, + where a file called build.xml can be found. + All properties whose name starts with "foo" are passed, their names are changed to start with "bar" instead +

    +
    +          <subant target="compile" genericantfile="/opt/project/build1.xml">
+              <dirset dir="." includes="projects*"/>
+          </subant>
+
    +

    + assuming the subdirs of the project dir are called projects1, projects2, projects3 + this snippet will execute the compile target of /opt/project/build1.xml, + setting the basedir to projects1, projects2, projects3 +

    + + +

    Now a little more complex - but useful - scenario. Assume that we have + a directory structure like this:

    + 
    +        root
+          |  common.xml
+          |  build.xml
+          |
+          +-- modules
+                +-- modA
+                |     +-- src
+                +-- modB
+                      +-- src
+
+        common.xml:
    
+        <project>
+            <property name="src.dir"      value="src"/>
+            <property name="build.dir"    value="build"/>
+            <property name="classes.dir"  value="${build.dir}/classes"/>
+
+            <target name="compile">
+                <mkdir dir="${classes.dir}"/>
+                <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
+            </target>
+
+            <!-- more targets -->
+        </project>
+
+        build.xml:
    
+        <project>
+
+            <macrodef name="iterate">
+                <attribute name="target"/>
+                <sequential>
+                    <subant target="@{target}">
+                        <fileset dir="modules" includes="*/build.xml"/>
+                    </subant>
+                </sequential>
+            </macrodef>
+
+
+            <target name="compile">
+                <iterate target="compile"/>
+            </target>
+
+            <!-- more targets -->
+        </project>
+
+        modules/modA/build.xml:
    
+        <project name="modA">
+            <import file="../../common.xml"/>
+        </project>
+
    + +

    This results in very small buildfiles in the modules, maintainable + buildfile (common.xml) and a clear project structure. Additionally + the root buildfile is capable to run the whole build over all + modules. +

    + + 
    +        <subant failonerror="false">
+            <fileset dir="." includes="**/build.xml" excludes="build.xml"/>
+            <target name="clean"/>
+            <target name="build"/>
+        </subant>
+
    + +

    Does a "clean build" for each subproject.

    +

    Hint: because buildfiles are plain xml, you could generate the + masterbuildfile from the common buildfile by using a XSLT transformation: +

    + + 
    +        <xslt in="common.xml"
+              out="master.xml"
+              style="${ant.home}/etc/common2master.xsl"
+        />
+
    + + + +
    + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/symlink.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/symlink.html new file mode 100644 index 000000000..df42abd6a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/symlink.html @@ -0,0 +1,146 @@ + + + + + + +Symlink Task + + + + +

    Symlink

    +

    Description

    +

    Manages symbolic links on Unix based platforms. Can be used to +make an individual link, delete a link, create multiple links from properties files, +or create properties files describing links in the specified directories. +Existing links are not overwritten by default. + +

    FileSets are used to select a +set of links to record, or a set of property files to create links from.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    actionThe type of action to perform, may be "single", + "record", "recreate" or "delete".No, defaults to single.
    linkThe name of the link to be created or deleted.
    + Note this attribute is resolved against the current + working directory rather than the project's basedir for + historical reasons. It is recommended you always use an + absolute path or a path like ${basedir}/some-path + as its value. +     		required for + action="single" or "delete". Ignored in other actions.
    resourceThe resource the link should point to.required for action="single". Ignored in other actions.
    linkfilenameThe name of the properties file to create in + each included directory.required for action="record". + Ignored in other actions.
    overwriteOverwrite existing links or not.No; defaults to false.
    failonerrorStop build if true, log a warning message, but do not stop the build, + when the an error occurs if false. + No; defaults to true.
    +

    Parameters specified as nested elements

    + +

    fileset

    +

    FileSets + are used when action = "record" to select directories and linknames to be recorded. + They are also used when action = "recreate" to specify both the name of the property + files to be processed, and the directories in which they can be found. At least one + fileset is required for each case.

    + +

    Examples

    + +

    Make a link named "foo" to a resource named "bar.foo" in subdir:

    + 
    +  <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/>
+
    + +

    Record all links in subdir and it's descendants in files named + "dir.links"

    + 
    +  <symlink action="record" linkfilename="dir.links">
+     <fileset dir="${dir.top}" includes="subdir/**"/>
+  </symlink>
+
    + +

    Recreate the links recorded in the previous example:

    + 
    +  <symlink action="recreate">
+     <fileset dir="${dir.top}" includes="subdir/**/dir.links"/>  
+  </symlink>
+
    + +

    Delete a link named "foo": + 

    + <symlink action="delete" link="${dir.top}/foo"/>
+
    + +

    Java 1.2 and earlier: Due to limitations on executing system + level commands in Java versions earlier than 1.3 this task may have difficulty + operating with a relative path in ANT_HOME. The typical symptom is an + IOException where Apache Ant can't find /some/working/directory${ANT_HOME}/bin/antRun + or something similar. The workaround is to change your ANT_HOME environment + variable to an absolute path, which will remove the /some/working/directory portion + of the above path and allow ant to find the correct commandline execution script. + +

    LIMITATIONS: Because Java has no direct support for + handling symlinks this task divines them by comparing canonical and + absolute paths. On non-unix systems this may cause false positives. + Furthermore, any operating system on which the command + ln -s <linkname> <resourcename> is not a valid + command on the command line will not be able to use action="single" or + action="recreate". Action="record" and action=delete should still work. Finally, + the lack of support for symlinks in Java means that all links are recorded as + links to the canonical resource name. Therefore the link: + link --> subdir/dir/../foo.bar will be recorded as + link=subdir/foo.bar and restored as + link --> subdir/foo.bar

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/sync.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/sync.html new file mode 100644 index 000000000..b1f77c580 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/sync.html @@ -0,0 +1,167 @@ + + + + + + +Sync Task + + + + +

    Sync

    +

    Since Apache Ant 1.6

    +

    Description

    + +

    Synchronize a target directory from the files defined in one or +more Resource Collections.

    + +

    Any file in the target directory that has not been matched by at +least one of the nested resource collections gets removed. I.e. if you exclude a +file in your sources and a file of that name is present in the target +dir, it will get removed from the target.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    todirthe target directory to sync with the resource collectionsYes
    overwriteOverwrite existing files even if the destination + files are newer.No; defaults to false.
    includeEmptyDirsCopy any empty directories included in the + resource collection(s).
    + Note this attribute also controls the behavior for any + nested <preserveintarget> element. If this attribute is + false (the default) empty directories that only exist in the + target directory will be removed even if they are matched by + the patterns of <preserveintarget>. This can be + overridden by <preserveintarget>'s + preserveEmptyDirs attribute. +     		No; defaults to false.
    failonerrorIf is set to false, log a warning message, but do not stop the build, + when one of the nested filesets points to a directory that + doesn't exist. + No; defaults to true.
    verboseLog the files that are being copied.No; defaults to false.
    granularityThe number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS + systems. This can also be useful if source and target files live + on separate machines with clocks being out of sync. since Ant + 1.6.2.No.
    + +

    Parameters specified as nested elements

    + +

    fileset or any other resource collection

    +

    Resource +Collections are used to select groups of files to copy. To use a +resource collection, the todir attribute must be set.

    +

    Prior to Ant 1.7 only <fileset> has been +supported as a nested element.

    + +

    preserveInTarget

    + +

    Since Ant 1.7.0

    + +

    Specifies files or directories that should be kept in the target +directory even if they are not present in one of the source +directories.

    + +

    This nested element is like a FileSet except that it doesn't +support the dir attribute and the usedefaultexcludes attribute +defaults to false.

    + +
    Additional Parameters
    + + + + + + + + + + + +
    AttributeDescriptionRequired
    preserveEmptyDirsOverrules the includeEmptydirs setting for + directories matched by this element. If you want to preserve + empty directories that are not in your source directory you can + either set the task's includeemptydirs attribute or this one. + If the two attribute values conflict, this attribute + "wins".No, defaults to the value of the + task's includeemptydirs attribute
    + +

    Examples

    + +
    +<sync todir="site">
+  <fileset dir="generated-site"/>
+</sync>
+
    +

    overwrites all files in site with newer files from +generated-site, deletes files from site that are not +present in generated-site.

    + +
    +<sync todir="site">
+  <fileset dir="generated-site"/>
+  <preserveintarget>
+    <include name="**/CVS/**"/>
+  </preserveintarget>
+</sync>
+
    +

    overwrites all files in site with newer files from +generated-site, deletes files from site that are not +present in generated-site but keeps all files in any +CVS sub-directory.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/tar.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/tar.html new file mode 100644 index 000000000..91f63d33b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/tar.html @@ -0,0 +1,252 @@ + + + + + + +Tar Task + + + + +

    Tar

    +

    Description

    +

    Creates a tar archive.

    +

    The basedir attribute is the reference directory from where to tar.

    +

    This task is a directory based task +and, as such, forms an implicit Fileset. This +defines which files, relative to the basedir, will be included in the +archive. The tar task supports all the attributes of Fileset to refine the +set of files to be included in the implicit fileset.

    + +

    In addition to the implicit fileset, the tar task supports nested + resource collections and a special form of filesets. These +filesets are extended to allow control over the access mode, username and groupname +to be applied to the tar entries. This is useful, for example, when preparing archives for + Unix systems where some files need to have execute permission. By + default this task will use Unix permissions of 644 for files and 755 + for directories.

    + +

    Early versions of tar did not support path lengths greater than 100 +characters. Modern versions of tar do so, but in incompatible ways. +The behaviour of the tar task when it encounters such paths is +controlled by the longfile attribute. +If the longfile attribute is set to fail, any long paths will +cause the tar task to fail. If the longfile attribute is set to +truncate, any long paths will be truncated to the 100 character +maximum length prior to adding to the archive. If the value of the longfile +attribute is set to omit then files containing long paths will be +omitted from the archive. Either option ensures that the archive can be +untarred by any compliant version of tar. If the loss of path or file +information is not acceptable, and it rarely is, longfile may be set to the +value gnu. The tar task will then produce a GNU tar file which +can have arbitrary length paths. Note however, that the resulting archive will +only be able to be untarred with GNU tar. The default for the longfile +attribute is warn which behaves just like the gnu option except +that it produces a warning for each file path encountered that does not match +the limit.

    + +

    This task can perform compression by setting the compression attribute to "gzip" +or "bzip2".

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    destfilethe tar-file to create.Yes
    basedirthe directory from which to tar the files.No
    longfileDetermines how long files (>100 chars) are to be + handled. Allowable values are "truncate", "fail", + "warn", "omit" and "gnu". Default is + "warn".No
    includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
    includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
    excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
    excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
    defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
    compressioncompression method. Allowable values are + "none", "gzip" and "bzip2". Default is + "none".No
    + +

    Nested Elements

    + +The tar task supports nested tarfileset elements. These are +extended FileSets which, +in addition to the standard elements, support one additional +attributes + + + + + + + + + + + + +
    AttributeDescriptionRequired
    preserveLeadingSlashesIndicates whether leading `/'s should + be preserved in the file names. Default is false.No
    + +

    any other resource collection

    +

    Resource +Collections are used to select groups of files to archive.

    +

    Prior to Apache Ant 1.7 only <fileset> has been +supported as a nested element.

    + +

    Examples

    +
    +<tar destfile="${dist}/manual.tar" basedir="htdocs/manual"/>
+<gzip destfile="${dist}/manual.tar.gz" src="${dist}/manual.tar"/>
    +

    tars all files in the htdocs/manual directory into a file called manual.tar +in the ${dist} directory, then applies the gzip task to compress +it.

    + +
    +<tar destfile="${dist}/manual.tar"
+     basedir="htdocs/manual"
+     excludes="mydocs/**, **/todo.html"
+/>
    +

    tars all files in the htdocs/manual directory into a file called manual.tar +in the ${dist} directory. Files in the directory mydocs, +or files with the name todo.html are excluded.

    + +
    +<tar destfile="${basedir}/docs.tar">
+  <tarfileset dir="${dir.src}/docs"
+              fullpath="/usr/doc/ant/README"
+              preserveLeadingSlashes="true">
+    <include name="readme.txt"/>
+  </tarfileset>
+  <tarfileset dir="${dir.src}/docs"
+              prefix="/usr/doc/ant"
+              preserveLeadingSlashes="true">
+    <include name="*.html"/>
+  </tarfileset>
+</tar>
    +

    + Writes the file docs/readme.txt as + /usr/doc/ant/README into the archive. All + *.html files in the docs directory are + prefixed by /usr/doc/ant, so for example + docs/index.html is written as + /usr/doc/ant/index.html to the archive. +

    + +
    +<tar longfile="gnu"
+     destfile="${dist.base}/${dist.name}-src.tar">
+  <tarfileset dir="${dist.name}/.." filemode="755" username="ant" group="ant">
+    <include name="${dist.name}/bootstrap.sh"/>
+    <include name="${dist.name}/build.sh"/>
+  </tarfileset>
+  <tarfileset dir="${dist.name}/.." username="ant" group="ant">
+    <include name="${dist.name}/**"/>
+    <exclude name="${dist.name}/bootstrap.sh"/>
+    <exclude name="${dist.name}/build.sh"/>
+  </tarfileset>
+</tar>
+
    +

    This example shows building a tar which uses the GNU extensions for long paths and +where some files need to be marked as executable (mode 755) +and the rest are use the default mode (read-write by owner). The first +fileset selects just the executable files. The second fileset must exclude +the executable files and include all others.

    + + + +

    Note: The tar task does not ensure that a file is only selected +by one resource collection. If the same file is selected by more than one collection, it will be included in the +tar file twice, with the same path.

    + +

    Note: The patterns in the include and exclude +elements are considered to be relative to the corresponding dir +attribute as with all other filesets. In the example above, +${dist.name} is not an absolute path, but a simple name +of a directory, so ${dist.name} is a valid path relative +to ${dist.name}/...

    + + +
    +<tar destfile="release.tar.gz" compression="gzip">
+  <zipfileset src="release.zip"/>
+</tar>
+
    +

    Re-packages a ZIP archive as a GZip compressed tar archive. If +Unix file permissions have been stored as part of the ZIP file, they +will be retained in the resulting tar archive.

    + + +

    Note: + Please note the tar task creates a tar file, it does not append + to an existing tar file. The existing tar file is replaced instead. + As with most tasks in Ant, the task only takes action if the output + file (the tar file in this case) is older than the input files, or + if the output file does not exist. +

    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/taskdef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/taskdef.html new file mode 100644 index 000000000..4f6f5d2b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/taskdef.html @@ -0,0 +1,44 @@ + + + + + + +TaskDef Task + + + + +

    Taskdef

    +

    Description

    +

    Adds a task definition to the current project, such that this new task can be + used in the current project.

    +

    This task is a form of Typedef with the + attributes "adapter" and "adaptto" set to the values + "org.apache.tools.ant.TaskAdapter" and "org.apache.tools.ant.Task" + respectively. Anything said in the manual + page of typedef applies to taskdef as well.

    +

    Examples

    +
      <taskdef name="myjavadoc" classname="com.mydomain.JavadocTask"/>
    +

    makes a task called myjavadoc available to Apache Ant. The class com.mydomain.JavadocTask +implements the task.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/telnet.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/telnet.html new file mode 100644 index 000000000..0ac65b378 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/telnet.html @@ -0,0 +1,155 @@ + + + + + + +Telnet Task + + + + +

    Telnet

    +

    Description

    +Task to automate a remote telnet session. The task uses +nested <read> to indicate strings to wait for, and +<write> tags to specify text to send. + +

    If you do specify a userid and password, the system will +assume a common unix prompt to wait on. This behavior can be easily over-ridden.

    +

    Note: This task depends on external libraries not included in the Apache Ant distribution. +See Library Dependencies for more information.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    useridthe login id to use on the telnet server.Only if password is specified
    passwordthe login password to use on the telnet server.Only if userid is specified
    serverthe address of the remote telnet server.Yes
    portthe port number of the remote telnet server. Defaults to port 23.No
    initialCRsend a cr after connecting ("yes"). Defaults to "no".No
    timeoutset a default timeout to wait for a response. Specified in seconds. Default is no timeout.No
    +

    Nested Elements

    +The commands to send to the server, and responses to wait for, are +described as nested elements. + +

    read

    + +

    declare (as a text child of this element) a string to wait for. +The element supports the timeout attribute, which overrides any +timeout specified for the task as a whole. It also has a string +attribute, which is an alternative to specifying the string as +a text element. +

    +Always declare an opening and closing +<read> element to ensure that statements are not sent before +the connection is ready, and that the connection is not broken before +the final command has completed. + +

    write

    + +

    describes the text to send to the server. The echo boolean +attribute controls whether the string is echoed to the local log; +this is "true" by default +

    +

    Examples

    +A simple example of connecting to a server and running a command. This assumes + a prompt of "ogin:" for the userid, and a prompt of "assword:" + for the password. + +
    +<telnet userid="bob" password="badpass" server="localhost">
+   <read>/home/bob</read>
+   <write>ls</write>
+   <read string="/home/bob"/>
+</telnet>
+
    + +This task can be rewritten as: +
    +<telnet server="localhost">
+   <read>ogin:</read>
+   <write>bob</write>
+   <read>assword:</read>
+   <write>badpass</write>
+   <read>/home/bob</read>
+   <write>ls</write>
+   <read>/home/bob</read>
+</telnet>
+
    + +A timeout can be specified at the <telnet> level or at the <read> level. +This will connect, issue a sleep command that is suppressed from displaying and wait +10 seconds before quitting. +
    +<telnet userid="bob" password="badpass" server="localhost" timeout="20">
+   <read>/home/bob</read>
+   <write echo="false">sleep 15</write>
+   <read timeout="10">/home/bob</read>
+</telnet>
+
    + +The task can be used with other ports as well: +
    +<telnet port="80" server="localhost" timeout="20">
+   <read/>
+   <write>GET / http/0.9</write>
+   <write/>
+   <read timeout="10">&lt;/HTML&gt;</read>
+</telnet>
+
    +

    +To use this task against the WinNT telnet service, you need to configure the service to use +classic authentication rather than NTLM negotiated authentication. +This can be done in the Telnet Server Admin app: +select "display/change registry settings", then "NTLM", then set the value of NTLM to 1. +

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/tempfile.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/tempfile.html new file mode 100644 index 000000000..28f8404ea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/tempfile.html @@ -0,0 +1,231 @@ + + + + + + Tempfile + Task + + + + + + + + + + + + + + + + + +
    + + + +
    + Tempfile + Task +
    This task sets a property to the name of a temporary file. +     		+ + + Apache Ant + +
    +
    + + + + + + + + + + +
     
    + + + Description +
    + + This task sets a property to the name of a temporary file. + Unlike java.io.File.createTempFile, + this task does not actually create the temporary file, but it does guarantee that the + file did not exist when the task was executed. + +

    Examples: + + 

    <tempfile property="temp.file"/>
    + + create a temporary file + + 
    <tempfile property="temp.file" suffix=".xml"/>
    + + create a temporary file with the .xml suffix + + 
    <tempfile property="temp.file" destDir="build"/>
    + + create a temporary file in the build subdirectory + +
    + + + + + + + + + + + + +
     
    + + + Parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + Attribute + + Description + + Type + + Requirement +
    + property + + Sets the property you wish to assign the temporary file to. + + String + + Required +
    + destdir + + Sets the destination directory. If not set, the basedir directory is used instead. + + File + + Optional +
    + prefix + + Sets the optional prefix string for the temp file. + + String +
    + suffix + + Sets the optional suffix string for the temp file. + + String +
    + deleteonexit + + Whether the temp file will be marked for deletion on normal exit of the Java Virtual Machine (even though the file may never be created); default false. Since Apache Ant 1.7 + + boolean +
    + createfile + + Whether the temp file should be created by this task; default false.Since Ant 1.8 + + boolean +
    +
    + + + + + + + + + + +
     
    + + + Parameters as nested elements +
    + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/touch.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/touch.html new file mode 100644 index 000000000..263ea7075 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/touch.html @@ -0,0 +1,157 @@ + + + + + + +Touch Task + + + + +

    Touch

    +

    Description

    + +

    Changes the modification time of a resource and possibly creates it +at the same time. In addition to working with a single file, this Task +can also work on resources and +resource collections (which also includes directories). Prior to Apache Ant +1.7 only FileSet or Filelist +(since Ant 1.6) have been supported.

    + +

    Ant uses the API of java.io.File to set the last + modification time which has some limitations. For example the + timestamp granularity depends on the operating system and sometimes + the operating system may allow a granularity smaller than + milliseconds. If you need more control you have to fall back to + the <exec> task and native commands.

    + +

    Starting with Ant 1.8.2 Ant will log a warning message if it fails + to change the file modification time. This will happen if you try + to change the modification time of a file you do not own on many + Unix systems, for example.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe name of the file.Unless a nested resource collection element + has been specified.
    millisSpecifies the new modification time of the file + in milliseconds since midnight Jan 1 1970.No--datetime takes + precedence, however if both are omitted the current time is assumed.
    datetimeSpecifies the new modification time of the file. The + special value "now" indicates the current time + (now supported since Ant 1.8).
    patternSimpleDateFormat-compatible pattern string. + Defaults to MM/DD/YYYY HH:MM AM_or_PM or MM/DD/YYYY HH:MM:SS AM_or_PM. + Since Ant 1.6.3No
    mkdirsWhether to create nonexistent parent + directories when touching new files. Since Ant 1.6.3No, default false.
    verboseWhether to log the creation of new files. + Since Ant 1.6.3No, default true.
    +

    Parameters specified as nested elements

    +

    any resource collection

    + +

    You can use any number of nested resource collection elements to +define the resources for this task and refer to resources defined +elsewhere. Note: resources passed to this task must implement +the org.apache.tools.ant.types.resources.Touchable +interface, this is true for all filesystem-based resources like those +returned by path, fileset ot filelist.

    + +

    For backwards compatibility directories matched by nested filesets +will be "touched" as well, use a <type> selector to suppress +this. This only applies to filesets nested into the task directly, +not to filesets nested into a path or any other resource +collection.

    + +

    mapper

    +

    Since Ant 1.6.3, a nested + mapper can be specified. Files specified via nested + filesets, filelists, or the file + attribute are mapped using the specified mapper. For each file mapped, + the resulting files are touched. If no time has been specified and + the original file exists its timestamp will be used. + If no time has been specified and the original file does not exist the + current time is used. Since Ant 1.8 the task settings (millis, + and datetime) have priority over the timestamp of the original + file.

    +

    Examples

    +
      <touch file="myfile"/>
    +

    creates myfile if it doesn't exist and changes the +modification time to the current time.

    +
      <touch file="myfile" datetime="06/28/2000 2:02 pm"/>
    +

    creates myfile if it doesn't exist and changes the +modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24 +hour times).

    +
      <touch datetime="09/10/1974 4:30 pm">
+    <fileset dir="src_dir"/>
+  </touch>
    +

    changes the modification time to Oct, 09 1974 4:30 pm of all files and directories + found in src_dir.

    +
      <touch file="myfile" datetime="06/28/2000 2:02:17 pm"/>
    +

    creates myfile if it doesn't exist and changes the +modification time to Jun, 28 2000 2:02:17 pm (14:02:17 for those used to 24 +hour times), if the filesystem allows a precision of one second - a +time close to it otherwise.

    +
      <touch file="foo">
+    <mapper type="glob" from="foo" to="bar" />
+  </touch>
+
    +

    creates bar if it doesn't exist and changes the +modification time to that of foo.

    + +
      <touch file="foo" datetime="now">
+    <mapper type="regexp" from="^src(.*)\.java" to="shadow\1.empty" />
+  </touch>
+
    +

    creates files in the shadow directory for every java file in the + src directory if it doesn't exist and changes the modification + time of those files to the current time.

    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/translate.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/translate.html new file mode 100644 index 000000000..10e812a90 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/translate.html @@ -0,0 +1,182 @@ + + + + + + +Translate Task + + + + +

    Translate

    +

    Description

    +

    Identifies keys in files delimited by special tokens +and translates them with values read from resource bundles. +

    +

    +A resource bundle contains locale-specific key-value pairs. +A resource bundle is a hierarchical set of property files. +A bundle name makes up its base family name. Each file that +makes up this bundle has this name plus its locale. For example, +if the resource bundle name is MyResources, the file that contains +German text will take the name MyResources_de. In addition to +language, country and variant are also used to form the files in +the bundle. +

    +

    +The resource bundle lookup searches for resource files with various +suffixes on the basis of (1) the desired locale and (2) the default +locale (basebundlename), in the following order from lower-level +(more specific) to parent-level (less specific): +

    +
    +basebundlename + "_" + language1 + "_" + country1 + "_" + variant1
+basebundlename + "_" + language1 + "_" + country1
+basebundlename + "_" + language1
+basebundlename
+basebundlename + "_" + language2 + "_" + country2 + "_" + variant2
+basebundlename + "_" + language2 + "_" + country2
+basebundlename + "_" + language2
+
    +

    +The file names generated thus are appended with the string ".properties" +to make up the file names that are to be used. +

    +

    +File encoding is supported. The encoding scheme of the source files, +destination files and the bundle files can be specified. + +Destination files can be explicitly overwritten using the +forceoverwrite attribute. If forceoverwrite +is false, the destination file is overwritten only if either the +source file or any of the files that make up the bundle have been +modified after the destination file was last modified. +

    +

    +New in Apache Ant 1.6:
    +Line endings of source files are preserved in the translated files. +

    +

    FileSets are used to select files to +translate. +

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    todirDestination directory where destination files are + to be created.Yes
    starttokenThe starting token to identify keys.Yes
    endtokenThe ending token to identify keys.Yes
    bundleFamily name of resource bundle.Yes
    bundlelanguage + Locale specific language of resource bundle. Defaults to + default locale's language. + No
    bundlecountry + Locale specific country of resource bundle. Defaults to + default locale's country. + No
    bundlevariant + Locale specific variant of resource bundle. Defaults to + the default variant of the country and language being used. + No
    srcencodingSource file encoding scheme. Defaults to + system default file encoding.No
    destencodingDestination file encoding scheme. Defaults to + source file encoding.No
    bundleencodingResource Bundle file encoding scheme. Defaults to + source file encoding.No
    forceoverwriteOverwrite existing files even if the destination + files are newer. Defaults to "no".No
    +

    Parameters specified as nested elements

    + +

    fileset

    +

    FileSets are used to select files that + contain keys for which value translated files are to be generated. +

    +

    Examples

    +

    Translate source file encoded in english into its japanese +equivalent using a resource bundle encoded in japanese. +

    +
    +  <translate toDir="$(dest.dir}/ja"
+        starttoken="#"
+        endtoken="#"
+        bundle="resource/BaseResource"
+        bundlelanguage="ja"
+        forceoverwrite="yes"
+        srcencoding="ISO8859_1"
+        destencoding="SJIS"
+        bundleencoding="SJIS">
+        <fileset dir="${src.dir}">
+            <include name="**/*.jsp"/>
+        </fileset>
+  </translate>
+
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/truncate.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/truncate.html new file mode 100644 index 000000000..b7df3f7e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/truncate.html @@ -0,0 +1,109 @@ + + + + + + +Truncate Task + + + + +

    Truncate

    +

    Description

    + +

    Set the length of one or more files, as the intermittently available +truncate Unix utility/function. In addition to working with +a single file, this Task can also work on +resources and resource collections. +Since Apache Ant 1.7.1. +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe name of the file.Unless a nested resource collection element + has been specified.
    lengthSpecifies the new file length (in bytes) to set. + The following suffixes are supported: +
      +
    • K : Kilobytes (1024 bytes)
      • +
    • M : Megabytes (1024 K)
      • +
    • G : Gigabytes (1024 M)
      • +
    • T : Terabytes (1024 G)
      • +
    • P : Petabytes (1024 T)
      • +
    +     		At most one of these. + Omitting both implies length="0". +
    adjustSpecifies the number of bytes + (and positive/negative direction) + by which to adjust file lengths. The same suffixes are supported + for this attribute as for the length attribute. +
    createWhether to create nonexistent files.No, default true.
    mkdirsWhether to create nonexistent parent + directories when creating new files.No, default false.
    +

    Parameters specified as nested elements

    +

    any resource collection

    + +

    You can use any number of nested resource collection elements to +define the resources for this task and refer to resources defined +elsewhere. Note: resources passed to this task are expected +to be filesystem-based.

    + +

    Examples

    + +
      <truncate file="foo" />
    +

    Sets the length of file foo to zero.

    + +
      <truncate file="foo" length="1K" />
    +

    Sets the length of file foo to 1 kilobyte (1024 bytes).

    + +
      <truncate file="foo" adjust="1K" />
    +

    Adjusts the length of file foo upward by 1 kilobyte.

    + +
      <truncate file="foo" adjust="-1M" />
    +

    Adjusts the length of file foo downward by 1 megabyte.

    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/tstamp.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/tstamp.html new file mode 100644 index 000000000..3a5a97be9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/tstamp.html @@ -0,0 +1,161 @@ + + + + + + +TStamp Task + + + + +

    Tstamp

    + +

    Description

    +

    Sets the DSTAMP, TSTAMP, and TODAY +properties in the current project. By default, +the DSTAMP property is in the +format "yyyyMMdd", TSTAMP is in the +format "hhmm", and TODAY is in the +format "MMMM dd yyyy". Use the nested <format> element +to specify a different format.

    + +

    These properties can be used in the build-file, for instance, to create +time-stamped filenames, or used to replace placeholder tags inside documents +to indicate, for example, the release date. The best place for this task is +probably in an initialization target.

    + +

    Parameters

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    prefixPrefix used for all properties set. The default is no prefix.No
    + +

    Nested Elements

    +The Tstamp task supports a <format> nested element that +allows a property to be set to the current date and time in a given format. +The date/time patterns are as defined in the Java +SimpleDateFormat class. +The format element also allows offsets to be applied to the time to generate different time values. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    property + The property to receive the date/time string in the given pattern. + Yes
    patternThe date/time pattern to be used. The values are as defined by the Java SimpleDateFormat class.Yes
    timezoneThe timezone to use for displaying time. The values are as defined by the Java TimeZone class.No
    offsetThe numeric offset to the current timeNo
    unitThe unit of the offset to be applied to the current time. + Valid Values are +
      +
    • millisecond
      • +
    • second
      • +
    • minute
      • +
    • hour
      • +
    • day
      • +
    • week
      • +
    • month
      • +
    • year
      • +
    +     		No
    localeThe locale used to create date/time string. The general + form is "language, country, variant" but either variant or variant and + country may be omitted. For more information please refer to documentation + for the + Locale + class.No
    + +

    Examples

    + +
    +  <tstamp/>
+
    + +

    +sets the standard DSTAMP, TSTAMP, +and TODAY properties according to the default formats.

    +
    +  <tstamp>
+    <format property="TODAY_UK" pattern="d-MMMM-yyyy" locale="en,UK"/>
+  </tstamp>
+
    +

    +sets the standard properties as well as the property +TODAY_UK with the date/time pattern "d-MMMM-yyyy" +using English locale (eg. 21-May-2001).

    + +
    +  <tstamp>
+      <format property="touch.time" pattern="MM/dd/yyyy hh:mm aa"
+              offset="-5" unit="hour"/>
+  </tstamp>
+
    +

    +Creates a timestamp, in the property touch.time, 5 hours before the current time. The format in this example +is suitable for use with the <touch> task. The standard properties are set also.

    + +
    +  <tstamp prefix="start"/>
+
    +

    +Sets three properties with the standard formats, prefixed with "start.": +start.DSTAMP, start.TSTAMP, and start.TODAY.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/typedef.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/typedef.html new file mode 100644 index 000000000..7d0de52c3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/typedef.html @@ -0,0 +1,262 @@ + + + + + + +Typedef Task + + + + +

    Typedef

    +

    Description

    +

    + Adds a task or a data type definition to the current project + such that this new type or task can be used in the current project. +

    +

    + A Task is any class that extends org.apache.tools.ant.Task or + can be adapted as a Task using an adapter class. +

    +

    + Data types are things like paths or + filesets that can be defined at + the project level and referenced via their ID attribute. + Custom data types usually need custom tasks to put them to good use. +

    +

    + Two attributes are needed to make a definition: the name that + identifies this data type uniquely, and the full name of the class + (including its package name) that implements this type. +

    +

    + You can also define a group of definitions at once using the file or + resource attributes. These attributes point to files in the format of + Java property files or an xml format. +

    +

    + For property files each line defines a single data type in the + format:

    + 
    +    typename=fully.qualified.java.classname
+
    + +

    + The xml format is described in the + Antlib section. +

    + +

    If you are defining tasks or types that share the same classpath + with multiple taskdef or typedef tasks, the corresponding classes + will be loaded by different + Java ClassLoaders. + Two classes with the same name loaded via different ClassLoaders + are not the same class from the point of view of the Java VM, they + don't share static variables and instances of these classes can't + access private methods or attributes of instances defined by "the + other class" of the same name. They don't even belong to the same + Java package and can't access package private code, either.

    + +

    The best way to load several tasks/types that are supposed to + cooperate with each other via shared Java code is to use the + resource attribute and an antlib descriptor. If this is not + possible, the second best option is to use the loaderref attribute + and specify the same name for each and every typedef/taskdef - + this way the classes will share the same ClassLoader. Note that + the typedef/taskdef tasks must use identical classpath defintions + (this includes the order of path components) for the loaderref + attribute to work.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe name of the data typeYes, unless the file or resource type + attributes have been specified.
    classnamethe full class name implementing the data typeYes, unless file or resource + have been specified.
    fileName of the file to load definitions from.No
    resource + Name of the resource to load definitions from. + If multiple resources by this name are found along the classpath, + and the format is "properties", the first resource will be loaded; + otherwise all such resources will be loaded. + No
    formatThe format of the file or resource. The values + are "properties" or "xml". If the value is "properties" the file/resource + is a property file contains name to classname pairs. If the value + is "xml", the file/resource is an xml file/resource structured according + to Antlib. + The default is "properties" unless the file/resource name ends with + ".xml", in which case the format attribute will have the value "xml". + since Apache Ant 1.6 + No
    classpath the classpath to + use when looking up classname.No
    classpathref + a reference to a classpath to use when looking up classname. + No
    loaderRefthe name of the loader that is + used to load the class, constructed from the specified classpath. Use + this to allow multiple tasks/types to be loaded with the same loader, + so they can call each other. since Ant 1.5 No
    onerrorThe action to take if there was a failure in defining the + type. The values are fail: cause a build exception; report: + output a warning, but continue; ignore: do nothing. + since Ant 1.6 + An additional value is failall: cause all behavior of fail, + as well as a build exception for the resource or file attribute + if the resource or file is not found. since Ant 1.7 + The default is fail. + No
    adapterA class that is used to adapt the defined class to + another interface/class. The adapter class must implement the interface + "org.apache.tools.ant.TypeAdapter". The adapter class will be used + to wrap the defined class unless the defined class implements/extends + the class defined by the attribute "adaptto". + If "adaptto" is not set, the defined class will always be wrapped. + since Ant 1.6 + No
    adapttoThis attribute is used in conjunction with the + adapter attribute. + If the defined class does not implement/extend the interface/class + specified by this attribute, the adaptor class will be used + to wrap the class. since Ant 1.6 + No
    uri + The uri that this definition should live in. + since Ant 1.6 + No
    +

    Parameters specified as nested elements

    +

    classpath

    +

    Typedef's classpath attribute is a + path-like structure and can also be set + via a nested classpath element.

    + +

    Examples

    + The following fragment defines define a type called urlset. + 
    +    <typedef name="urlset" classname="com.mydomain.URLSet"/>
    + The data type is now available to Ant. The + class com.mydomain.URLSet implements this type.

    + + +

    + Assuming a class org.acme.ant.RunnableAdapter that + extends Task and implements org.apache.tools.ant.TypeAdapter, + and in the execute method invokes run on the proxied object, + one may use a Runnable class as an Ant task. The following fragment + defines a task called runclock. +

    + 
    +    <typedef name="runclock"
+             classname="com.acme.ant.RunClock"
+             adapter="org.acme.ant.RunnableAdapter"/>
+
    + + +

    + The following fragment shows the use of the classpathref and + loaderref to load up two definitions. +

    + 
    +    <path id="lib.path">
+      <fileset dir="lib" includes="lib/*.jar"/>
+    </path>
+
+    <typedef name="filter1"
+             classname="org.acme.filters.Filter1"
+             classpathref="lib.path"
+             loaderref="lib.path.loader"
+             />
+    <typedef name="filter2"
+             classname="org.acme.filters.Filter2"
+             loaderref="lib.path.loader"
+             />
+
    + + +

    + If you want to load an antlib into a special xml-namespace, the uri attribute + is important: +

    + 
    +  <project xmlns:antcontrib="antlib:net.sf.antcontrib">
+     <taskdef uri="antlib:net.sf.antcontrib"
+              resource="net/sf/antcontrib/antlib.xml"
+              classpath="path/to/ant-contrib.jar"/>
+
    + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/unpack.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/unpack.html new file mode 100644 index 000000000..dcc88a9a8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/unpack.html @@ -0,0 +1,117 @@ + + + + + + +GUnzip/BUnzip2 Task + + + + +

    GUnzip/BUnzip2

    +

    Description

    +

    Expands a resource packed using GZip or BZip2.

    + +

    If dest is a directory the name of the destination file is +the same as src (with the ".gz" or ".bz2" +extension removed if present). If dest is omitted, the parent +dir of src is taken. The file is only expanded if the source +resource is newer than the destination file, or when the destination file +does not exist.

    + +

    Parameters

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    srcthe file to expand.Yes, or a nested resource collection.
    destthe destination file or directory.No
    +

    Parameters specified as nested elements

    + +

    any resource or single element +resource collection

    + +

    The specified resource will be used as src.

    + +

    Examples

    +
    +<gunzip src="test.tar.gz"/>
+
    +

    expands test.tar.gz to test.tar

    +
    +<bunzip2 src="test.tar.bz2"/>
+
    +

    expands test.tar.bz2 to test.tar

    +
    +<gunzip src="test.tar.gz" dest="test2.tar"/>
+
    +

    expands test.tar.gz to test2.tar

    +
    +<gunzip src="test.tar.gz" dest="subdir"/>
+
    +

    expands test.tar.gz to subdir/test.tar (assuming +subdir is a directory).

    +
    +<gunzip dest=".">
+  <url url="http://example.org/archive.tar.gz"/>
+</gunzip>
+
    +

    downloads http://example.org/archive.tar.gz and expands it +to archive.tar in the project's basedir on the fly.

    + +

    Related tasks

    + +
    +<gunzip src="some-archive.gz" dest="some-dest-dir"/>
+
    + +is identical to + +
    +<copy todir="some-dest-dir">
+  <gzipresource>
+    <file file="some-archive.gz"/>
+  </gzipresource>
+  <mapper type="glob" from="*.gz" to="*"/>
+</copy>
+
    + +

    The same is also true for <bunzip2> and +<bzip2resource>. <copy> offers +additional features like filtering files on the fly, +allowing a file to be mapped to multiple destinations, preserving the +last modified time or a configurable file system timestamp +granularity.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/untar.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/untar.html new file mode 100644 index 000000000..bfaf28f11 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/untar.html @@ -0,0 +1,35 @@ + + + + + + +Untar Task + + + + +

    Untar

    +

    Description

    +

    Untars a tarfile.

    + +This document has moved here + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/unzip.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/unzip.html new file mode 100644 index 000000000..1fc4c3958 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/unzip.html @@ -0,0 +1,243 @@ + + + + + + +Unzip Task + + + + +

    Unjar/Untar/Unwar/Unzip

    +

    Description

    +

    Unzips a zip-, war-, or jar file.

    +

    PatternSets are used to select files to extract +from the archive. If no patternset is used, all files are extracted. +

    + +

    Resource +Collections may be used to select archived files to perform +unarchival upon. Only file system based resource collections are +supported by Unjar/Unwar/Unzip, this includes fileset, filelist, path, and files. +Untar supports arbitrary resource collections. +Prior to Apache Ant 1.7 only fileset has been supported as a nested element.

    + +

    You can define filename transformations by using a nested mapper element. The default mapper is the +identity mapper. +

    +

    File permissions will not be restored on extracted files.

    +

    The untar task recognizes the long pathname entries used by GNU tar.

    + +

    Please note that different ZIP tools handle timestamps +differently when it comes to applying timezone offset calculations of +files. Some ZIP libraries will store the timestamps as they've been +read from the filesystem while others will modify the timestamps both +when reading and writing the files to make all timestamps use the same +timezone. A ZIP archive created by one library may extract files with +"wrong timestamps" when extracted by another library.

    + +

    Ant's ZIP classes use the same algorithm as the InfoZIP tools and +zlib (timestamps get adjusted), Windows' "compressed folders" function +and WinZIP don't change the timestamps. This means that using the +unzip task on files created by Windows' compressed folders function +may create files with timestamps that are "wrong", the same is true if +you use Windows' functions to extract an Ant generated ZIP +archive.

    + + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    srcarchive file to expand.Yes, if filesets are not used.
    destdirectory where to store the expanded files.Yes
    overwriteOverwrite files, even if they are newer than the + corresponding entries in the archive (true or false, default is + true).No
    compressionNote: This attribute is only available for + the untar task.
    + compression method. Allowable values are "none", + "gzip" and "bzip2". Default is + "none".    		No
    encodingNote: This attribute is not available for + the untar task.
    + The character encoding that has been used for filenames + inside the zip file. For a list of possible values see http://download.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html.
    + Defaults to "UTF8", use the magic value + native-encoding for the platform's default character + encoding. +
    See also the discussion in the + zip task page    		No
    failOnEmptyArchivewhether trying to extract an empty archive is an + error. since Ant 1.8.0No, defaults to false
    stripAbsolutePathSpecwhether Ant should remove leading '/' or '\' + characters from the extracted file name before extracing it. + Note that this changes the entry's name before applying + include/exclude patterns and before using the nested mappers (if + any). since Ant 1.8.0No, defaults to false
    scanForUnicodeExtraFieldsNote: This attribute is not available for + the untar task.
    + If the archive contains uncode extra fields then use them to set + the file names, ignoring the specified encoding. +
    See also the discussion in the + zip task page    		No, defaults to true
    +

    Examples

    +
    +<unzip src="${tomcat_src}/tools-src.zip" dest="${tools.home}"/>
+
    +

    +

    +<gunzip src="tools.tar.gz"/>
+<untar src="tools.tar" dest="${tools.home}"/>
+
    +
    +<unzip src="${tomcat_src}/tools-src.zip"
+       dest="${tools.home}">
+    <patternset>
+        <include name="**/*.java"/>
+        <exclude name="**/Test*.java"/>
+    </patternset>
+</unzip>
+
    +

    +

    +<unzip dest="${tools.home}">
+    <patternset>
+        <include name="**/*.java"/>
+        <exclude name="**/Test*.java"/>
+    </patternset>
+    <fileset dir=".">
+        <include name="**/*.zip"/>
+        <exclude name="**/tmp*.zip"/>
+    </fileset>
+</unzip>
+
    +

    +

    +<unzip src="apache-ant-bin.zip" dest="${tools.home}">
+    <patternset>
+        <include name="apache-ant/lib/ant.jar"/>
+    </patternset>
+    <mapper type="flatten"/>
+</unzip>
+
    + +

    Related tasks

    + +
    +<unzip src="some-archive" dest="some-dir">
+  <patternset>
+    <include name="some-pattern"/>
+  </patternset>
+  <mapper type="some-mapper"/>
+</unzip>
+
    + +is identical to + +
    +<copy todir="some-dir" preservelastmodified="true">
+  <zipfileset src="some-archive">
+    <patternset>
+      <include name="some-pattern"/>
+    </patternset>
+  </zipfileset>
+  <mapper type="some-mapper"/>
+</copy>
+
    + +

    The same is also true for <untar> and +<tarfileset>. <copy> offers +additional features like filtering files on the fly, +allowing a file to be mapped to multiple destinations or a +configurable file system timestamp granularity.

    + +
    <zip destfile="new.jar">
+  <zipfileset src="old.jar">
+    <exclude name="do/not/include/this/class"/>
+  </zipfileset>
+</zip>
+
    +

    "Deletes" files from a zipfile.

    + +
    +<unzip src="${ant.home}/lib/ant.jar" dest="...">
+  <patternset>
+    <include name="images/"/>
+  </patternset>
+</unzip>
+
    +

    This extracts all images from ant.jar which are stored in the images directory +of the Jar (or somewhere under it). While extracting the directory structure (images) +will be taken.

    + +
    +<unzip src="${ant.home}/lib/ant.jar" dest="...">
+  <patternset>
+    <include name="**/ant_logo_large.gif"/>
+    <include name="**/LICENSE.txt"/>
+  </patternset>
+</unzip>
+
    +

    This extracts the two files ant_logo_large.gif and LICENSE.txt from the +ant.jar. More exactly: it extracts all files with these names from anywhere in the source file. While extracting the directory structure will be taken.

    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/uptodate.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/uptodate.html new file mode 100644 index 000000000..c724f2065 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/uptodate.html @@ -0,0 +1,177 @@ + + + + + + +Uptodate Task + + + + +

    Uptodate

    +

    Description

    +

    Sets a property if a target file or set of target files is more up-to-date +than a source file or set of source files. A single source file is specified +using the srcfile attribute. A set of source files is specified +using the nested <srcfiles> +elements. These are FileSets, +whereas multiple target files are specified using a nested +<mapper> element.

    +

    By default, the value of the property is set to true if +the timestamp of the source file(s) is not more recent than the timestamp of +the corresponding target file(s). You can set the value to something other +than the default by specifying the value attribute.

    +

    If a <srcfiles> element is used, without also specifying +a <mapper> element, the default behavior is to use a +merge mapper, with the +to attribute set to the value of the +targetfile attribute.

    +

    Normally, this task is used to set properties that are useful to avoid +target execution depending on the relative age of the specified files.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    propertyThe name of the property to set.Yes
    valueThe value to set the property to.No; defaults to true.
    srcfileThe file to check against the target file(s).Yes, unless a nested + <srcfiles> or <srcresources> + element is present.
    targetfileThe file for which we want to determine the status.Yes, unless a nested + <mapper> element is present.
    + +

    Parameters specified as nested elements

    +

    srcfiles

    +

    The nested <srcfiles> element is a +fileset and allows you to +specify a set of files to check against the target file(s).

    + +

    Note: You can specify either the srcfile +attribute or nested <srcfiles> elements, but not both. + +

    Note that the task will completely ignore any directories that seem + to be matched by the srcfiles fileset, it will only consider normal + files. If you need logic that applies to directories as well, use a + nested srcresource and a dirset (for example).

    + +

    srcresources

    +

    The nested <srcresources> element is a union and allows you to +specify a collection of resources to check against the target file(s). +Since Apache Ant 1.7

    + +

    mapper

    +

    The nested <mapper> element allows you to specify +a set of target files to check for being up-to-date with respect to a +set of source files.

    +

    + The mapper "to" attribute is relative to the target file, or to + the "dir" attribute of the nested srcfiles element. +

    +

    + Since Ant 1.6.3, + one can use a filenamemapper type in place of the mapper element. +

    +

    Examples

    +
      <uptodate property="xmlBuild.notRequired" targetfile="${deploy}\xmlClasses.jar" >
+    <srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
+  </uptodate>
    +

    sets the property xmlBuild.notRequired to true +if the ${deploy}/xmlClasses.jar file is more up-to-date than +any of the DTD files in the ${src}/xml directory.

    +

    This can be written as:

    +
      <uptodate property="xmlBuild.notRequired">
+    <srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
+    <mapper type="merge" to="${deploy}\xmlClasses.jar"/>
+  </uptodate>
    +as well. + +The xmlBuild.notRequired property can then be used in a +<target> tag's unless attribute to +conditionally run that target. For example, running the following target:

    +
    +<target name="xmlBuild" depends="chkXmlBuild" unless="xmlBuild.notRequired">
+  ...
+</target>
+
    +will first run the chkXmlBuild target, which contains +the <uptodate> task that determines whether +xmlBuild.notRequired gets set. The property named in +the unless attribute is then checked for being set/not set. +If it did get set (ie., the jar file is up-to-date), +then the xmlBuild target won't be run. +

    + +

    The following example shows a single source file being checked +against a single target file:

    +
      <uptodate property="isUpToDate"
+            srcfile="/usr/local/bin/testit"
+            targetfile="${build}/.flagfile"/>
+
    +

    sets the property isUpToDate to true +if /usr/local/bin/testit is not newer than +${build}/.flagfile.

    +

    +

    + The following shows usage of a relative mapper. +

    + 
    +    <uptodate property="checkUptodate.uptodate">
+      <srcfiles dir="src" includes="*"/>
+      <mapper type="merge" to="../dest/output.done"/>
+    </uptodate>
+    <echo message="checkUptodate result: ${checkUptodate.uptodate}"/>
+
    +

    + The previous example can be a bit confusing, so it may be better to + use absolute paths: +

    + 
    +    <property name="dest.dir" location="dest"/>
+    <uptodate property="checkUptodate.uptodate">
+      <srcfiles dir="src" includes="*"/>
+      <mapper type="merge" to="${dest.dir}/output.done"/>
+    </uptodate>
+
    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/vss.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/vss.html new file mode 100644 index 000000000..f91c082d2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/vss.html @@ -0,0 +1,823 @@ + + + + +Microsoft Visual SourceSafe(VSS) Tasks + + +

    Microsoft Visual SourceSafe Tasks User Manual

    +

    by

    + +
    +

    Contents

    + +
    +

    Introduction

    +

    These tasks provide an interface to the +Microsoft Visual SourceSafe SCM. +The org.apache.tools.ant.taskdefs.optional.vss package consists of a simple framework to support +vss functionality as well as some Apache Ant tasks encapsulating frequently used vss commands. +Although it is possible to use these commands on the desktop, +they were primarily intended to be used by automated build systems.

    +

    +If you get a CreateProcesss IOError=2 when running these, it means +that ss.exe was not found. Check to see if you can run it from the +command line -you may need to alter your path, or set the ssdir +property. +

    The Tasks

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    vssgetRetrieves a copy of the specified VSS file(s).
    vsslabelAssigns a label to the specified version or current version of a file or project.
    vsshistoryShows the history of a file or project in VSS.
    vsscheckinUpdates VSS with changes made to a checked out file, and unlocks the VSS master copy.
    vsscheckoutCopies a file from the current project to the current folder, for the purpose of editing.
    vssaddAdds a new file into the VSS Archive
    vsscpChange the current project being used in VSS
    vsscreateCreates a project in VSS.
    + +
    +

    Task Descriptions

    + + + +

    VssGet

    +

    Description

    +Task to perform GET commands to Microsoft Visual SourceSafe. +

    If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project/file(s) you wish to + perform the action on.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    localpathOverride the working directory and get to the specified pathNo
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    writabletrue or false; default falseNo
    recursivetrue or false; default false. Note however that in the SourceSafe UI + , there is a setting accessed via Tools/Options/GeneralTab called + "Act on projects recursively". If this setting is checked, + then the recursive attribute is effectively ignored, and the get + will always be done recursively + No
    versiona version number to getNo, only one of these allowed
    datea date stamp to get at
    labela label to get for
    quietsuppress output (off by default)No
    autoresponseWhat to respond with (sets the -I option). By default, -I- is + used; values of Y or N will be appended to this.No
    writablefilesBehavior when local files are writable. Valid options are: replace, + skip and fail; Defaults to fail +
    skip implies failonerror=false    		No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    filetimestampSet the behavior for timestamps of local files. Valid options are current, + modified, or updated. Defaults to current.No
    +

    Note that only one of version, date or label should be specified

    +

    Examples

    +
    +
    +<vssget localPath="C:\mysrc\myproject"
+        recursive="true"
+        label="Release1"
+        login="me,mypassword"
+        vsspath="$/source/aProject"
+        writable="true"/>
+
    +
    +

    Does a get on the VSS-Project $/source/myproject using the username +me and the password mypassword. It will recursively get the files +which are labeled Release1 and write them to the local directory +C:\mysrc\myproject. The local files will be writable.

    +
    + + + +

    VssLabel

    +

    Description

    +Task to perform LABEL commands to Microsoft Visual SourceSafe. +

    Assigns a label to the specified version or current version of a file or +project.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project/file(s) you wish to + perform the action on.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    labelA label to apply to the hierarchyYes
    versionAn existing file or project version to label. By default the current + version is labeled.No
    commentThe comment to use for this label. Empty or '-' for no comment.No
    autoresponseWhat to respond with (sets the -I option). By default, -I- is + used; values of Y or N will be appended to this.No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    +

    Examples

    +
    +
    +<vsslabel vsspath="$/source/aProject"
+          login="me,mypassword"
+          label="Release1"/>
+
    +
    +

    Labels the current version of the VSS project $/source/aProject with +the label Release1 using the username me and the password +mypassword. +

    +
    +
    +<vsslabel vsspath="$/source/aProject/myfile.txt"
+          version="4"
+          label="1.03.004"/>
+
    +
    +

    Labels version 4 of the VSS file $/source/aProject/myfile.txt with the +label 1.03.004. If this version already has a label, the operation (and +the build) will fail. +

    +
    + + + +

    VssHistory

    +

    Description

    +Task to perform HISTORY commands to Microsoft Visual SourceSafe. +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project/file(s) you wish to + perform the action on.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    fromDateStart date for comparisonSee below
    toDateEnd date for comparisonSee below
    dateFormatFormat of dates in fromDate and toDate. Used when calculating dates with + the numdays attribute. This string uses the formatting rules of SimpleDateFormat. + Defaults to DateFormat.SHORT.No
    fromLabelStart label for comparisonNo
    toLabelStart label for comparisonNo
    numdaysThe number of days for comparison.See below
    outputFile to write the diff.No
    recursivetrue or falseNo
    stylebrief, codediff, default or nofile. The default is default.No
    userName the user whose changes we would like to seeNo
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    + +

    Specifying the time-frame

    +

    There are different ways to specify what time-frame you wish to evaluate:

    +
      +
    • Changes between two dates: Specify both fromDate and toDate
      • +
    • Changes before a date: Specify toDate
      • +
    • Changes after a date: Specify fromDate
      • +
    • Changes X Days before a date: Specify toDate and (negative!) numDays
      • +
    • Changes X Days after a date: Specify fromDate and numDays
      • +
    + + +

    Examples

    +
    + 
    +<vsshistory vsspath="$/myProject" recursive="true"
+            fromLabel="Release1"
+            toLabel="Release2"/>
+
    +
    +

    Shows all changes between "Release1" and "Release2".

    + +
    + 
    +<vsshistory vsspath="$/myProject" recursive="true"
+            fromDate="01.01.2001"
+            toDate="31.03.2001"/>
+
    +
    +

    Shows all changes between January 1st 2001 and March 31st 2001 (in Germany, date must be specified according to your locale).

    + +
    + 
    +<tstamp>
+  <format property="to.tstamp" pattern="M-d-yy;h:mma"/>
+</tstamp>
+
+<vsshistory vsspath="$/myProject" recursive="true"
+            numDays="-14"
+            dateFormat="M-d-yy;h:mma"
+            toDate="${to.tstamp}"/>
+
    +
    +

    Shows all changes in the 14 days before today.

    +
    + + + +

    VssCheckin

    +

    Description

    +Task to perform CHECKIN commands to Microsoft Visual SourceSafe. +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project/file(s) you wish to + perform the action on.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    localpathOverride the working directory and get to the specified pathNo
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    writabletrue or falseNo
    recursivetrue or falseNo
    commentComment to use for the files that where checked in.No
    autoresponse'Y', 'N' or empty. Specify how to reply to questions from VSS.No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    + +

    Examples

    +
    +
    +<vsscheckin vsspath="$/test/test*"
+            localpath="D:\build\"
+            comment="Modified by automatic build"/>
+
    +
    +

    Checks in the file(s) named test* in the project $/test using +the local directory D:\build.

    +
    + + + +

    VssCheckout

    +

    Description

    +Task to perform CHECKOUT commands to Microsoft Visual SourceSafe. +

    If you specify two or more attributes from version, date and +label only one will be used in the order version, date, label.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project/file(s) you wish to + perform the action on.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    localpathOverride the working directory and get to the specified pathNo
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    writabletrue or falseNo
    recursivetrue or falseNo
    versiona version number to getNo, only one of these allowed
    datea date stamp to get at
    labela label to get for
    writablefilesBehavior when local files are writable. Valid options are: replace, + skip and fail; Defaults to fail +
    skip implies failonerror=false    		No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    filetimestampSet the behavior for timestamps of local files. Valid options are current, + modified, or updated. Defaults to current.No
    getlocalcopySet the behavior to retrieve local copies of the files. Defaults to true.No
    + +

    Examples

    +
    +
    +<vsscheckout vsspath="$/test"
+             localpath="D:\build"
+             recursive="true"
+             login="me,mypass"/>
+
    +
    +

    Does a recursive checkout of the project $/test to the directory D:\build. +

    +
    + + + +

    VssAdd

    +

    Description

    +Task to perform ADD commands to Microsoft Visual SourceSafe. +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    localpathSpecify the local file(s) to add to VSSYes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    writabletrue or falseNo
    recursivetrue or falseNo
    commentComment to use for the files that where checked in.No
    autoresponse'Y', 'N' or empty. Specify how to reply to questions from VSS.No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    + +

    Examples

    +
    +
    +<vssadd localpath="D:\build\build.00012.zip"
+            comment="Added by automatic build"/>
+
    +
    +

    Add the file named build.00012.zip into the project current working +directory (see vsscp).

    +
    + + + +

    VssCp

    +

    Description

    +

    Task to perform CP (Change Project) commands to Microsoft Visual SourceSafe.

    +

    This task is typically used before a VssAdd in order to set the target project

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    vsspathSourceSafe path which specifies the project you wish to + make the current project.Yes
    loginusername[,password] - The username and password needed to get access + to VSS. Note that you may need to specify both (if you have a password) - + Ant/VSS will hang if you leave the password out and VSS does not accept + login without a password. No
    ssdirdirectory where ss.exe resides. By default the + task expects it to be in the PATH.No
    serverPathdirectory where srcsafe.ini resides.No
    failonerrorStop the buildprocess if ss.exe exits with a returncode of 100. Defaults to trueNo
    + +

    Examples

    +
    +
    +<vsscp vsspath="$/Projects/ant"/>
+
    +
    +

    Sets the current VSS project to $/Projects/ant.

    +
    + + + +

    VssCreate

    +

    Description

    + Task to perform CREATE commands to Microsoft Visual Source Safe. +

    Creates a new project in VSS.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    loginusername,passwordNo
    vsspathSourceSafe path of project to be createdYes
    ssdirdirectory where ss.exe resides. By default the task expects it to be in the PATH.No
    quietsuppress output (off by default)No
    failOnErrorfail if there is an error creating the project (true by default)No
    autoresponseWhat to respond with (sets the -I option). By default, -I- is used; values of Y or N will be appended to this.No
    commentThe comment to use for this label. Empty or '-' for no comment.No
    +

    Examples

    +
    +
    +<vsscreate vsspath="$/existingProject/newProject"/>
+
    +
    +

    Creates the VSS-Project $/existingProject/newProject.

    +
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/waitfor.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/waitfor.html new file mode 100644 index 000000000..54ff8edf6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/waitfor.html @@ -0,0 +1,133 @@ + + + + + + +WaitFor Task + + + + +

    Waitfor

    +

    Description

    +

    Blocks execution until a set of specified conditions become true. This is intended + to be used with the parallel task to + synchronize a set of processes.

    +

    The conditions to wait for are defined in nested elements, +if multiple conditions are specified, then the task will wait until all conditions are true..

    +

    +

    If both maxwait and maxwaitunit are not specified, the maxwait is 3 minutes (180000 milliseconds).

    +

    If the timeoutproperty attribute has been set, a +property of that name will be created if the condition didn't come +true within the specified time.

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    maxwaitThe maximum amount of time to wait for all the required conditions + to become true before failing the task. Defaults to 180000 maxwaitunits.No
    maxwaitunitThe unit of time that must be used to interpret the value of the + maxwait attribute. Defaults to millisecond. + Valid Values are +
      +
    • millisecond
      • +
    • second
      • +
    • minute
      • +
    • hour
      • +
    • day
      • +
    • week
      • +
    +     		No
    checkeveryThe amount of time to wait between each test of the conditions. + Defaults to 500 checkeveryunits.No
    checkeveryunitThe unit of time that must be used to interpret the value of the + checkevery attribute. Defaults to millisecond. + Valid Values are +
      +
    • millisecond
      • +
    • second
      • +
    • minute
      • +
    • hour
      • +
    • day
      • +
    • week
      • +
    +     		No
    timeoutpropertythe name of the property to set if maxwait has + been exceeded.No
    +

    Nested Elements

    + +

    The available conditions that satisfy the +<waitfor> task are the same as those for the +<condition> task. See +here for the full list.

    + +

    Examples

    +
    +<waitfor maxwait="30" maxwaitunit="second">
+        <available file="errors.log"/>
+</waitfor>
+
    +

    waits up to 30 seconds for a file called errors.log to appear.

    +
    +<waitfor maxwait="3" maxwaitunit="minute" checkevery="500">
+        <http url="http://localhost/myapp/index.html"/>
+</waitfor>
+
    +

    waits up to 3 minutes (and checks every 500 milliseconds) for a web server on localhost + to serve up the specified URL.

    +
    +<waitfor maxwait="10" maxwaitunit="second">
+        <and>
+            <socket server="dbserver" port="1521"/>
+            <http url="http://webserver/mypage.html"/>
+        </and>
+</waitfor>
+
    +

    waits up to 10 seconds for a server on the dbserver machine to begin listening + on port 1521 and for the http://webserver/mypage.html web page + to become available.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/war.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/war.html new file mode 100644 index 000000000..20eac3766 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/war.html @@ -0,0 +1,355 @@ + + + + + + +WAR Task + + + + +

    War

    +

    Description

    +

    An extension of the Jar task with special +treatment for files that should end up in the +WEB-INF/lib, WEB-INF/classes or +WEB-INF directories of the Web Application Archive.

    +

    (The War task is a shortcut for specifying the particular layout of a WAR file. +The same thing can be accomplished by using the prefix and fullpath +attributes of zipfilesets in a Zip or Jar task.)

    +

    The extended zipfileset element from the zip task + (with attributes prefix, fullpath, and src) + is available in the War task. The task is also resource-enabled + and will add nested resources and resource collections to the archive.

    + +

    + Before Servlet API 2.5/Java EE 5, a WEB-INF/web.xml file was mandatory in a + WAR file, so this task failed if the webxml attribute was missing. + As the web.xml file is now optional, the webxml attribute may now + be made optional. However, as most real web applications do need a web.xml file, + it is not optional by default. The task will fail if the file is not + included, unless the needxmlfile attribute + is set to false. The task + will warn if more than one web.xml file is added to the JAR + through the filesets. +

    + + +

    Please note that the Zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the duplicate attribute +to a value other than its default, "add".

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    destfilethe WAR file to create.Exactly one of the two.
    warfileDeprecated name of the file to create + -use destfile instead.
    webxmlThe servlet configuration descriptor to use (WEB-INF/web.xml).Yes, unless needxmlfile is true, + the file is pulled in via a nested fileset, or an existing WAR file is + being updated.
    needxmlfileFlag to indicate whether or not the web.xml file is needed. + It should be set to false when generating + servlet 2.5+ WAR files without a web.xml file. + Since Apache Ant 1.7No -default "true"
    basedirthe directory from which to jar the files.No
    compressNot only store data but also compress them, + defaults to true. Unless you set the keepcompression + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.No
    keepcompressionFor entries coming from existing archives (like + nested zipfilesets or while updating the archive), keep + the compression as it has been originally instead of using the + compress attribute. Defaults false. Since Ant + 1.6No
    encodingThe character encoding to use for filenames + inside the archive. Defaults to UTF8. It is not + recommended to change this value as the created archive will most + likely be unreadable for Java otherwise. +
    See also the discussion in the + zip task page    		No
    filesonlyStore only file entries, defaults to falseNo
    includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
    includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
    excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
    excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
    defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
    manifestthe manifest file to use.No
    filesetmanifestbehavior when a Manifest is found in a zipfileset or zipgroupfileset file is found. Valid values are "skip", "merge", and "mergewithoutmain". "merge" will merge all of the manifests together, and merge this into any other specified manifests. "mergewithoutmain" merges everything but the Main section of the manifests. Default value is "skip". + No
    whenmanifestonlybehavior when no files match. Valid values are "fail", "skip", and "create". Default is "create".No
    updateindicates whether to update or overwrite + the destination file if it already exists. Default is "false".No
    duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
    roundupWhether the file modification times will be + rounded up to the next even number of seconds.
    + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.
    + Defaults to true. Since Ant 1.6.2    		No
    levelNon-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). Since Ant 1.7No
    preserve0permissionswhen updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.
    + Set this attribute to true if you really want to preserve the + original permission field.since Ant 1.8.0 +     		No, default is false
    useLanguageEncodingFlagWhether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + Since Ant 1.8.0. +
    See also the discussion in the + zip task page    		No, default is true
    createUnicodeExtraFieldsWhether to create unicode extra fields to store + the file names a second time inside the entry's metadata. +
    Possible values are "never", "always" and "not-encodable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + Since Ant 1.8.0. +
    See also the discussion in the + zip task page    		No, default is "never"
    fallbacktoUTF8Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + Since Ant 1.8.0. +
    See also the discussion in the + zip task page    		No, default is false
    mergeClassPathAttributesWhether to merge the Class-Path attributes found + in different manifests (if merging manifests). If false, only + the attribute of the last merged manifest will be preserved. + Since Ant 1.8.0. +
    unless you also set flattenAttributes to true this may + result in manifests containing multiple Class-Path attributes + which violates the manifest specification.    		No, default is false
    flattenAttributesWhether to merge attributes occuring more than + once in a section (this can only happen for the Class-Path + attribute) into a single attribute. + Since Ant 1.8.0.No, default is false
    + +

    Nested elements

    + +

    lib

    +

    The nested lib element specifies a FileSet. All files included in this fileset will +end up in the WEB-INF/lib directory of the war file.

    + +

    classes

    +

    The nested classes element specifies a FileSet. All files included in this fileset will +end up in the WEB-INF/classes directory of the war file.

    + +

    webinf

    +

    The nested webinf element specifies a FileSet. All files included in this fileset will +end up in the WEB-INF directory of the war file. If this +fileset includes a file named web.xml, the file is +ignored and you will get a warning.

    + +

    metainf

    +

    The nested metainf element specifies a FileSet. All files included in this fileset will +end up in the META-INF directory of the war file. If this +fileset includes a file named MANIFEST.MF, the file is +ignored and you will get a warning.

    + +

    manifest, indexjars, service

    +These are inherited from <jar> + +

    Examples

    + +

    Assume the following structure in the project's base directory:

    +
    +thirdparty/libs/jdbc1.jar
+thirdparty/libs/jdbc2.jar
+build/main/com/myco/myapp/Servlet.class
+src/metadata/myapp.xml
+src/html/myapp/index.html
+src/jsp/myapp/front.jsp
+src/graphics/images/gifs/small/logo.gif
+src/graphics/images/gifs/large/logo.gif
+
    +then the war file myapp.war created with +
    +<war destfile="myapp.war" webxml="src/metadata/myapp.xml">
+  <fileset dir="src/html/myapp"/>
+  <fileset dir="src/jsp/myapp"/>
+  <lib dir="thirdparty/libs">
+    <exclude name="jdbc1.jar"/>
+  </lib>
+  <classes dir="build/main"/>
+  <zipfileset dir="src/graphics/images/gifs"
+              prefix="images"/>
+</war>
+
    +will consist of +
    +WEB-INF/web.xml
+WEB-INF/lib/jdbc2.jar
+WEB-INF/classes/com/myco/myapp/Servlet.class
+META-INF/MANIFEST.MF
+index.html
+front.jsp
+images/small/logo.gif
+images/large/logo.gif
+
    +using Ant's default manifest file. The content of +WEB-INF/web.xml is identical to +src/metadata/myapp.xml. + +

    We regulary receive bug reports that this task is creating the WEB-INF +directory as web-inf (all lower case), and thus it is our fault your webapp doesn't work. The cause +of these complaints lies in WinZip, which turns an all upper-case +directory into an all lower case one in a fit of helpfulness. Please check that +jar xvf yourwebapp.war shows the same behaviour before filing another +report.
    +Winzip has an option allowing all uppercase names (which is off by default!). It can be enabled by: +Menu "Options" -> "Configuration", "View" property/tab page, then "General" group box has an option called "Allow all uppercase file names". +

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/whichresource.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/whichresource.html new file mode 100644 index 000000000..5b2b54eab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/whichresource.html @@ -0,0 +1,120 @@ + + + + + + + Whichresource Task + + + + + + +

    Whichresource

    +

    Description

    +

    + Find a class or resource on the supplied classpath, or the + system classpath if none is supplied. + The named property is set if the item can be found. + For example: +

    +
    +  <whichresource resource="/log4j.properties" property="log4j.url" >
+
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    property + The property to fill with the URL of the resource of class. + Yes
    class + The name of the class to look for. + Exactly one of these.
    resource + The name of the resource to look for. +
    classpath + The classpath to use when looking up class + or resource. + No
    classpathref + The classpath to use, given as a + reference + to a path defined elsewhere. + Since Apache Ant 1.7.1. + No
    +

    Parameters specified as nested elements

    +

    classpath

    +

    + Whichresource's classpath attribute is a + path-like structure and can also be + set via a nested <classpath> element. +

    +

    Examples

    +

    + The following shows using a classpath reference. +

    +
    +  <path id="bsf.classpath">
+    <fileset dir="${user.home}/lang/bsf" includes="*.jar"/>
+  </path>
+  <whichresource property="bsf.class.location"
+                 class="org.apache.bsf.BSFManager"
+                 classpathref="bsf.classpath"/>
+  <echo>${bsf.class.location}</echo>
+
    +

    + The following shows using a nested classpath. +

    +
    +  <whichresource
+    property="ant-contrib.antlib.location"
+    resource="net/sf/antcontrib/antlib.xml">
+    <classpath>
+      <path path="f:/testing/ant-contrib/target/ant-contrib.jar"/>
+    </classpath>
+  </whichresource>
+  <echo>${ant-contrib.antlib.location}</echo>
+
    + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/wljspc.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/wljspc.html new file mode 100644 index 000000000..566349470 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/wljspc.html @@ -0,0 +1,99 @@ + + + +WLJSPC Task + +

    wljspc

    +

    Description

    +

    Class to precompile JSP's using weblogic's jsp compiler (weblogic.jspc)

    +Tested only on Weblogic 4.5.1 - NT4.0 and Solaris 5.7,5.8
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeValuesRequired
    srcroot of source tree for JSP, ie, the document root for your weblogic serverYes
    +dest root of destination directory, what you have set as WorkingDir in the weblogic propertiesYes
    +package start package name under which your JSP's would be compiledYes
    +classpathClass path to use when compiling jsp'sYes
    +

    +
    + +A classpath should be set which contains the weblogic classes as well as all application classes
    +referenced by the JSP. The system classpath is also appended when the jspc is called, so you may
    +choose to put everything in the classpath while calling Apache Ant. However, since presumably the JSP's will reference
    +classes being build by Ant, it would be better to explicitly add the classpath in the task
    +
    +The task checks timestamps on the JSP's and the generated classes, and compiles
    +only those files that have changed.
    +
    +It follows the weblogic naming convention of putting classes in
    + _dirName/_fileName.class for dirname/fileName.jsp
    +
    +

    +


    +Example
    +

    +

    +

    +<target name="jspcompile" depends="compile">
+  <wljspc src="c:\\weblogic\\myserver\\public_html" dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp">
+    <classpath>
+      <pathelement location="${weblogic.classpath}"/>
+      <pathelement path="${compile.dest}"/>
+    </classpath>
+  </wljspc>
+</target>
+
    + +

    + +

    Limitations

    +
      +
    • This works only on weblogic 4.5.1
      • +
    • It compiles the files thru the Classic compiler only.
      • +
    • Since it is my experience that weblogic jspc throws out of memory error on being given too +many files at one go, it is called multiple times with one jsp file each.
      • +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlproperty.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlproperty.html new file mode 100644 index 000000000..293cf2455 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlproperty.html @@ -0,0 +1,289 @@ + + + + +XmlProperty Task + + + + +

    XmlProperty

    +

    Description

    +

    +Loads property values from a well-formed xml file. There are no other restrictions +than "well-formed". You can choose the layout you want. For example this XML property file: +

    +  <root>
+    <properties>
+      <foo>bar</foo>
+    </properties>
+  </root>
+
    +is roughly equivalent to this Java property file: +
    +  root.properties.foo = bar
+
    + +

    +By default, this load +does no processing of the input. In particular, unlike the +Property task, property references +(i.e., ${foo}) are not resolved. +

    + +

    Semantic Attributes

    + +Input processing can be enabled by using the semanticAttributes +attribute. If this attribute is set to true (its default is +false), the following processing occurs as the input XML file +is loaded: +
      +
    • Property references are resolved.
      • +
    • The following attributes are treated differently: +
        +
      • id: The property is associated with the given id value.
        • +
      • location: The property is treated as a file location
        • +
      • refid: The property is set to the value of the + referenced property.
        • +
      • value: The property is set to the value indicated.
        • +
      +
      • +
    • Path-like Structures can be defined + by use of the following attributes: +
        +
      • pathid: The given id is used to identify a path. The + nested XML tag name is ignored. Child elements can be used + (XML tag names are ignored) to identify elements of the path.
        • +
      +
      • +
    +

    +For example, with semantic attribute processing enabled, this XML property +file: +

    +  <root>
+    <properties>
+      <foo location="bar"/>
+      <quux>${root.properties.foo}</quux>
+    </properties>
+  </root>
+
    +is roughly equivalent to the following fragments in a build.xml file: +
    +  <property name="root.properties.foo" location="bar"/>
+  <property name="root.properties.quux" value="${root.properties.foo}"/>
+
    + +

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe XML file to parse.Yes, or a nested resource collection.
    prefixThe prefix to prepend to each propertyNo
    keepRootKeep the xml root tag as the + first value in the property name.No, default is true.
    validateValidate the input file (e.g. by a DTD). Otherwise the XML must only be well-formed.No, default is false.
    collapseAttributesTreat attributes as nested elements.No, default is false.
    semanticAttributesEnable special handling of certain attribute names. + See the Semantic Attributes + section for more information.No, default is false.
    includeSemanticAttributeInclude the semantic attribute name + as part of the property name. Ignored if + semanticAttributes is not set to true. + See the Semantic Attributes + section for more information.No, default is false.
    rootDirectoryThe directory to use for resolving file references. Ignored + if semanticAttributes is not set to true.No, default is ${basedir}.
    delimiterDelimiter for splitting multiple values.
    since Apache Ant 1.7.1    		No, defaults to comma
    + +

    Nested Elements

    +

    xmlcatalog

    +

    The <xmlcatalog> +element is used to perform entity resolution.

    + +

    any resource or single element +resource collection

    + +

    The specified resource will be used as input.

    + + +

    Examples

    +     + +

    Non-semantic Attributes

    + +

    Here is an example xml file that does not have any semantic attributes.

    + +
    +   <root-tag myattr="true">
+    <inner-tag someattr="val">Text</inner-tag>
+    <a2><a3><a4>false</a4></a3></a2>
+   </root-tag>
+
    + +
    default loading
    +

    This entry in a build file: +

       <xmlproperty file="somefile.xml"/>
    +is equivalent to the following properties: +
    +   root-tag(myattr)=true
+   root-tag.inner-tag=Text
+   root-tag.inner-tag(someattr)=val
+   root-tag.a2.a3.a4=false
+
    + +
    collapseAttributes=false
    +

    This entry in a build file: +

       <xmlproperty file="somefile.xml" collapseAttributes="true"/>
    +is equivalent to the following properties: +
    +   root-tag.myattr=true
+   root-tag.inner-tag=Text
+   root-tag.inner-tag.someatt=val
+   root-tag.a2.a3.a4=false
+
    + +
    keepRoot=false
    +

    This entry in a build file: +

       <xmlproperty file="somefile.xml" keepRoot="false"/>
    +is equivalent to the following properties: +
    +   inner-tag=Text
+   inner-tag(someattr)=val
+   a2.a3.a4=false
+
    + +

    Semantic Attributes

    + +

    Here is an example xml file that has semantic attributes.

    +
    +  <root-tag>
+    <version value="0.0.1"/>
+    <build folder="build">
+      <classes id="build.classes" location="${build.folder}/classes"/>
+      <reference refid="build.classes"/>
+    </build>
+    <compile>
+      <classpath pathid="compile.classpath">
+        <pathelement location="${build.classes}"/>
+      </classpath>
+    </compile>
+    <run-time>
+      <jars>*.jar</jars>
+      <classpath pathid="run-time.classpath">
+        <path refid="compile.classpath"/>
+        <pathelement path="${run-time.jars}"/>
+      </classpath>
+    </run-time>
+  </root-tag>
+
    + +
    default loading (semanticAttributes=true)
    +

    This entry in a build file: +

       <xmlproperty file="somefile.xml" keepRoot="false"
+                semanticAttributes="true"/>
    +is equivalent to the following entries in a build file: +
    +  <property name="version" value="0.0.1"/>
+  <property name="build.folder" value="build"/>
+  <property name="build.classes" location="${build.folder}/classes" id="build.classes"/>
+  <property name="build.reference" refid="build.classes"/>
+
+  <property name="run-time.jars" value="*.jar"/>
+
+  <path id="compile.classpath">
+    <pathelement location="${build.classes}"/>
+  </path>
+
+  <path id="run-time.classpath">
+    <path refid="compile.classpath"/>
+    <pathelement path="${run-time.jars}"/>
+  </path>
+
    + +
    includeSemanticAttribute="true"
    +

    This entry in a build file: +

       <xmlproperty file="somefile.xml"
+                semanticAttributes="true" keepRoot="false"
+                includeSemanticAttribute="true"/>
+
    +is equivalent to the following entries in a build file: +
    +  <property name="version.value" value="0.0.1"/>
+  <property name="build.folder" value="build"/>
+  <property name="build.classes.location" location="${build.folder}/classes"/>
+  <property name="build.reference.refid" refid="build.classes"/>
+
+  <property name="run-time.jars" value="*.jar"/>
+
+  <path id="compile.classpath">
+    <pathelement location="${build.classes}"/>
+  </path>
+
+  <path id="run-time.classpath">
+    <path refid="compile.classpath"/>
+    <pathelement path="${run-time.jars}"/>
+  </path>
+
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlvalidate.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlvalidate.html new file mode 100644 index 000000000..c362bbe38 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/xmlvalidate.html @@ -0,0 +1,263 @@ + + + + + +XMLValidate Task + + + + +

    XMLValidate

    +

    Description

    + +

    This task checks that XML files are valid (or only well formed). The +task uses the SAX2 parser implementation provided by JAXP by default +(probably the one that is used by Apache Ant itself), but one can specify any +SAX1/2 parser if needed.

    + +

    This task supports the use of nested +

  • <xmlcatalog> elements
    • +
  • <dtd> elements which are used to resolve DTDs and entities
    • +
  • <attribute> elements which are used to set features on the parser. + These can be any number of + http://xml.org/sax/features/ + or other features that your parser may support.
    • +
  • <property> elements, containing string properties +

    + +

    Warning : JAXP creates by default a non namespace aware parser. +The "http://xml.org/sax/features/namespaces" feature is set +by default to false by the JAXP implementation used by ant. To validate +a document containing namespaces, +set the namespaces feature to true explicitly by nesting the following element: +

    +  <attribute name="http://xml.org/sax/features/namespaces" value="true"/>
+
    +If you are using for instance a xsi:noNamespaceSchemaLocation attribute in your XML files, +you will need this namespace support feature. +

    +

    If you are using a parser not generated by JAXP, by using the classname attribute of xmlvalidate, this warning +may not apply.

    + + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    filethe file(s) you want to check. (optionally can use an embedded fileset)No
    lenient + if true, only check the XML document is well formed + (ignored if the specified parser is a SAX1 parser) + No
    classnamethe parser to use.No
    classpathrefwhere to find the parser class. Optionally can use an embedded <classpath> element.No
    failonerrorfails on a error if set to true (defaults to true).No
    warnlog parser warn events.No
    + +

    Nested Elements

    +

    dtd

    +

    +<dtd> is used to specify different locations for DTD resolution. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    publicIdPublic ID of the DTD to resolveYes
    locationLocation of the DTD to use, which can be a file, + a resource, or a URLYes
    +

    xmlcatalog

    +

    The <xmlcatalog> +element is used to perform entity resolution.

    +

    attribute

    +

    The <attribute> element is used to set parser features.
    +Features usable with the xerces parser are defined here : + Setting features
    + +SAX features are defined here: + http://xml.org/sax/features/
    +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the featureYes
    valueThe boolean value of the featureYes
    +

    + +

    property

    +

    The <property> element is used to set properties. +These properties are defined here for the xerces XML parser implementation : + XML Parser properties +Properties can be used to set the schema used to validate the XML file. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the featureYes
    valueThe string value of the propertyYes
    +

    + + +

    Examples

    +
    +<xmlvalidate file="toto.xml"/>
+
    +Validate toto.xml +
    +<xmlvalidate failonerror="no" lenient="yes" warn="yes"
+             classname="org.apache.xerces.parsers.SAXParser">
+             classpath="lib/xerces.jar">
+  <fileset dir="src" includes="style/*.xsl"/>
+</xmlvalidate>
+
    +Validate all .xsl files in src/style, but only warn if there is an error, rather than +halt the build. +
    +
+<xmlvalidate file="struts-config.xml" warn="false">
+  <dtd publicId="-//Apache Software Foundation//DTD Struts Configuration 1.0//EN"
+       location="struts-config_1_0.dtd"/>
+</xmlvalidate>
+
    + +Validate a struts configuration, using a local copy of the DTD. +
     
+<xmlvalidate failonerror="no">
+  <fileset dir="${project.dir}" includes="**/*.xml"/>
+  <xmlcatalog refid="mycatalog"/>
+</xmlvalidate>
+
    + +Scan all XML files in the project, using a predefined catalog to map URIs to local files. +
    +<xmlvalidate failonerror="no">
+  <fileset dir="${project.dir}" includes="**/*.xml"/>
+  <xmlcatalog>
+       <dtd
+         publicId="-//ArielPartners//DTD XML Article V1.0//EN"
+         location="com/arielpartners/knowledgebase/dtd/article.dtd"/>
+  </xmlcatalog>
+</xmlvalidate>
+
    +Scan all XML files in the project, using the catalog defined inline. + +
    +<xmlvalidate failonerror="yes" lenient="no" warn="yes">
+  <fileset dir="xml" includes="**/*.xml"/>
+  <attribute name="http://xml.org/sax/features/validation" value="true"/>
+  <attribute name="http://apache.org/xml/features/validation/schema"  value="true"/>
+  <attribute name="http://xml.org/sax/features/namespaces" value="true"/>
+</xmlvalidate>
+
    +Validate all .xml files in xml directory with the parser configured to perform XSD validation. +Note: The parser must support the feature +http://apache.org/xml/features/validation/schema. +The schemavalidate task is better for validating +W3C XML Schemas, as it extends this task with the right options automatically enabled, +and makes it easy to add a list of schema files/URLs to act as sources. + +
    +
+<pathconvert dirsep="/" property="xsd.file">
+<path>
+   <pathelement location="xml/doc.xsd"/>
+</path>
+</pathconvert>
+
+<xmlvalidate file="xml/endpiece-noSchema.xml" lenient="false"
+  failonerror="true" warn="true">
+  <attribute name="http://apache.org/xml/features/validation/schema"
+  value="true"/>
+  <attribute name="http://xml.org/sax/features/namespaces" value="true"/>
+  <property
+  name="http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
+  value="${xsd.file}"/>
+</xmlvalidate>
+
    +
    +Validate the file xml/endpiece-noSchema.xml against the schema xml/doc.xsd. +
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Tasks/zip.html b/tools/apache-ant-1.8.2/docs/manual/Tasks/zip.html new file mode 100644 index 000000000..9231047d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Tasks/zip.html @@ -0,0 +1,493 @@ + + + + + + +Zip Task + + + + +

    Zip

    +

    Description

    +

    Creates a zipfile.

    +

    The basedir attribute is the reference directory from where to zip.

    +

    Note that file permissions will not be stored in the resulting zipfile.

    +

    It is possible to refine the set of files that are being zipped. This can be +done with the includes, includesfile, excludes, excludesfile and defaultexcludes +attributes. With the includes or includesfile attribute you specify the files you want to +have included by using patterns. The exclude or excludesfile attribute is used to specify +the files you want to have excluded. This is also done with patterns. And +finally with the defaultexcludes attribute, you can specify whether you +want to use default exclusions or not. See the section on directory based tasks, on how the +inclusion/exclusion of files works, and how to write patterns.

    +

    This task forms an implicit FileSet and +supports most attributes of <fileset> +(dir becomes basedir) as well as the nested +<include>, <exclude> and +<patternset> elements.

    +

    Or, you may place within it nested file sets, or references to file sets. +In this case basedir is optional; the implicit file set is only used +if basedir is set. You may use any mixture of the implicit file set +(with basedir set, and optional attributes like includes +and optional subelements like <include>); explicit nested +<fileset> elements so long as at least one fileset total is specified. The ZIP file will +only reflect the relative paths of files within each fileset. The Zip task and its derivatives know a special form of a fileset named zipfileset that has additional attributes (described below).

    +

    The Zip task also supports the merging of multiple zip files into the zip file. +This is possible through either the src attribute of any nested filesets +or by using the special nested fileset zipgroupfileset.

    + +

    The update parameter controls what happens if the ZIP +file already exists. When set to yes, the ZIP file is +updated with the files specified. (New files are added; old files are +replaced with the new versions.) When set to no (the +default) the ZIP file is overwritten if any of the files that would be +added to the archive are newer than the entries inside the archive. +Please note that ZIP files store file modification times with a +granularity of two seconds. If a file is less than two seconds newer +than the entry in the archive, Apache Ant will not consider it newer.

    + +

    The whenempty parameter controls what happens when no files match. +If skip (the default), the ZIP is not created and a warning is issued. +If fail, the ZIP is not created and the build is halted with an error. +If create, an empty ZIP file (explicitly zero entries) is created, +which should be recognized as such by compliant ZIP manipulation tools.

    +

    This task will now use the platform's default character encoding +for filenames - this is consistent with the command line ZIP tools, +but causes problems if you try to open them from within Java and your +filenames contain non US-ASCII characters. Use the encoding attribute +and set it to UTF8 to create zip files that can safely be read by +Java. For a more complete discussion, +see below

    + +

    Starting with Ant 1.5.2, <zip> can store Unix permissions +inside the archive (see description of the filemode and dirmode +attributes for <zipfileset>). +Unfortunately there is no portable way to store these permissions. +Ant uses the algorithm used by Info-Zip's +implementation of the zip and unzip commands - these are the default +versions of zip and unzip for many Unix and Unix-like systems.

    + +

    Please note that the zip format allows multiple files of the same +fully-qualified name to exist within a single archive. This has been +documented as causing various problems for unsuspecting users. If you wish +to avoid this behavior you must set the duplicate attribute +to a value other than its default, "add".

    + +

    Please also note that different ZIP tools handle timestamps +differently when it comes to applying timezone offset calculations of +files. Some ZIP libraries will store the timestamps as they've been +read from the filesystem while others will modify the timestamps both +when reading and writing the files to make all timestamps use the same +timezone. A ZIP archive created by one library may extract files with +"wrong timestamps" when extracted by another library.

    + +

    Ant's ZIP classes use the same algorithm as the InfoZIP tools and +zlib (timestamps get adjusted), Windows' "compressed folders" function +and WinZIP don't change the timestamps. This means that using the +unzip task on files created by Windows' compressed folders function +may create files with timestamps that are "wrong", the same is true if +you use Windows' functions to extract an Ant generated ZIP +archive.

    + +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    destfilethe zip-file to create.Exactly one of the two.
    zipfilethe deprecated old name of destfile.
    basedirthe directory from which to zip the files.No
    compressNot only store data but also compress them, + defaults to true. Unless you set the keepcompression + attribute to false, this will apply to the entire archive, not + only the files you've added while updating.No
    keepcompressionFor entries coming from existing archives (like + nested zipfilesets or while updating the archive), keep + the compression as it has been originally instead of using the + compress attribute. Defaults false. Since Ant + 1.6No
    encodingThe character encoding to use for filenames + inside the zip file. For a list of possible values see http://download.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html. + Defaults to the platform's default character encoding. +
    See also the discussion below    		No
    filesonlyStore only file entries, defaults to falseNo
    includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.No
    includesfilethe name of a file. Each line of this file is + taken to be an include patternNo
    excludescomma- or space-separated list of patterns of files that must be + excluded. No files (except default excludes) are excluded when omitted.No
    excludesfilethe name of a file. Each line of this file is + taken to be an exclude patternNo
    defaultexcludesindicates whether default excludes should be used or not + ("yes"/"no"). Default excludes are used when omitted.No
    updateindicates whether to update or overwrite + the destination file if it already exists. Default is "false".No
    whenemptybehavior when no files match. Valid values are "fail", "skip", and "create". Default is "skip".No
    duplicatebehavior when a duplicate file is found. Valid values are "add", "preserve", and "fail". The default value is "add". No
    roundupWhether the file modification times will be + rounded up to the next even number of seconds.
    + Zip archives store file modification times with a granularity of + two seconds, so the times will either be rounded up or down. If + you round down, the archive will always seem out-of-date when you + rerun the task, so the default is to round up. Rounding up may + lead to a different type of problems like JSPs inside a web + archive that seem to be slightly more recent than precompiled + pages, rendering precompilation useless.
    + Defaults to true. Since Ant 1.6.2    		No
    commentComment to store in the archive. Since Ant 1.6.3No
    levelNon-default level at which file compression should be + performed. Valid values range from 0 (no compression/fastest) to 9 + (maximum compression/slowest). Since Ant 1.7No
    preserve0permissionswhen updating an archive or adding entries from a + different archive Ant will assume that a Unix permissions value of + 0 (nobody is allowed to do anything to the file/directory) means + that the permissions haven't been stored at all rather than real + permissions and will instead apply its own default values.
    + Set this attribute to true if you really want to preserve the + original permission field.since Ant 1.8.0 +     		No, default is false
    useLanguageEncodingFlagWhether to set the language encoding flag if the + encoding is UTF-8. This setting doesn't have any effect if the + encoding is not UTF-8. + Since Ant 1.8.0. +
    See also the discussion below    		No, default is true
    createUnicodeExtraFieldsWhether to create unicode extra fields to store + the file names a second time inside the entry's metadata. +
    Possible values are "never", "always" and "not-encodable" + which will only add Unicode extra fields if the file name cannot + be encoded using the specified encoding. + Since Ant 1.8.0. +
    See also the discussion below    		No, default is "never"
    fallbacktoUTF8Whether to use UTF-8 and the language encoding + flag instead of the specified encoding if a file name cannot be + encoded using the specified encoding. + Since Ant 1.8.0. +
    See also the discussion below    		No, default is false
    + +

    Encoding of File Names

    + +

    Traditionally the ZIP archive format uses CodePage 437 as encoding + for file name, which is not sufficient for many international + character sets.

    + +

    Over time different archivers have chosen different ways to work + around the limitation - the java.util.zip packages + simply uses UTF-8 as its encoding for example.

    + +

    Ant has been offering the encoding attribute of the zip and unzip + task as a way to explicitly specify the encoding to use (or expect) + since Ant 1.4. It defaults to the platform's default encoding for + zip and UTF-8 for jar and other jar-like tasks (war, ear, ...) as + well as the unzip family of tasks.

    + +

    More recent versions of the ZIP specification introduce something + called the "language encoding flag" which can be used to + signal that a file name has been encoded using UTF-8. Starting with + Ant 1.8.0 all zip-/jar- and similar archives written by Ant will set + this flag, if the encoding has been set to UTF-8. Our + interoperabilty tests with existing archivers didn't show any ill + effects (in fact, most archivers ignore the flag to date), but you + can turn off the "language encoding flag" by setting the attribute + useLanguageEncodingFlag to false on the + zip-task if you should encounter problems.

    + +

    The unzip (and similar tasks) -task will recognize the language + encoding flag and ignore the encoding set on the task if it has been + found.

    + +

    The InfoZIP developers have introduced new ZIP extra fields that + can be used to add an additional UTF-8 encoded file name to the + entry's metadata. Most archivers ignore these extra fields. The + zip family of tasks support an + option createUnicodeExtraFields since Ant 1.8.0 which + makes Ant write these extra fields either for all entries ("always") + or only those whose name cannot be encoded using the spcified + encoding (not-encodeable), it defaults to "never" since the extra + fields create bigger archives.

    + +

    The fallbackToUTF8 attribute of zip can be used to create archives + that use the specified encoding in the majority of cases but UTF-8 and + the language encoding flag for filenames that cannot be encoded + using the specified encoding.

    + +

    The unzip-task will recognize the unicode extra fields by default + and read the file name information from them, unless you set the + optional attribute scanForUnicodeExtraFields to + false.

    + +

    Recommendations for Interoperability

    + +

    The optimal setting of flags depends on the archivers you expect as + consumers/producers of the ZIP archives. Below are some test + results which may be superseeded with later versions of each + tool.

    + +
      +
    • The java.util.zip package used by the jar executable or to read + jars from your CLASSPATH reads and writes UTF-8 names, it doesn't + set or recognize any flags or unicode extra fields.
      • + +
    • 7Zip writes CodePage 437 by default but uses UTF-8 and the + language encoding flag when writing entries that cannot be encoded + as CodePage 437 (similar to the zip task with fallbacktoUTF8 set + to true). It recognizes the language encoding flag when reading + and ignores the unicode extra fields.
      • + +
    • WinZIP writes CodePage 437 and uses unicode extra fields by + default. It recognizes the unicode extra field and the language + encoding flag when reading.
      • + +
    • Windows' "compressed folder" feature doesn't recognize any flag + or extra field and creates archives using the platforms default + encoding - and expects archives to be in that encoding when reading + them.
      • + +
    • InfoZIP based tools can recognize and write both, it is a + compile time option and depends on the platform so your mileage + may vary.
      • + +
    • PKWARE zip tools recognize both and prefer the language encoding + flag. They create archives using CodePage 437 if possible and UTF-8 + plus the language encoding flag for file names that cannot be + encoded as CodePage 437.
      • +
    + +

    So, what to do?

    + +

    If you are creating jars, then java.util.zip is your main + consumer. We recommend you set the encoding to UTF-8 and keep the + language encoding flag enabled. The flag won't help or hurt + java.util.zip but archivers that support it will show the correct + file names.

    + +

    For maximum interop it is probably best to set the encoding to + UTF-8, enable the language encoding flag and create unicode extra + fields when writing ZIPs. Such archives should be extracted + correctly by java.util.zip, 7Zip, WinZIP, PKWARE tools and most + likely InfoZIP tools. They will be unusable with Windows' + "compressed folders" feature and bigger than archives without the + unicode extra fields, though.

    + +

    If Windows' "compressed folders" is your primary consumer, then + your best option is to explicitly set the encoding to the target + platform. You may want to enable creation of unicode extra fields + so the tools that support them will extract the file names + correctly.

    + +

    Parameters specified as nested elements

    + +

    any resource collection

    +

    Resource +Collections are used to select groups of files to archive.

    +

    Prior to Ant 1.7 only <fileset> and +<zipfileset> have been supported as nested elements.

    + + +

    zipgroupfileset

    +

    A <zipgroupfileset> allows for multiple zip files to be +merged into the archive. Each file found in this fileset is added to the archive +the same way that zipfileset src files are added.

    + +

    <zipgroupfileset> is + a fileset and supports all + of its attributes and nested elements. + +

    Examples

    +
      <zip destfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+  />
    +

    zips all files in the htdocs/manual directory into a file called manual.zip +in the ${dist} directory.

    +
      <zip destfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       update="true"
+  />
    +

    zips all files in the htdocs/manual directory into a file called manual.zip +in the ${dist} directory. If manual.zip +doesn't exist, it is created; otherwise it is updated with the +new/changed files.

    +
      <zip destfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       excludes="mydocs/**, **/todo.html"
+  />
    +

    zips all files in the htdocs/manual directory. Files in the directory mydocs, +or files with the name todo.html are excluded.

    +
      <zip destfile="${dist}/manual.zip"
+       basedir="htdocs/manual"
+       includes="api/**/*.html"
+       excludes="**/todo.html"
+  />
    +

    zips all files in the htdocs/manual directory. Only html files under the directory api +are zipped, and files with the name todo.html are excluded.

    +
      <zip destfile="${dist}/manual.zip">
+    <fileset dir="htdocs/manual"/>
+    <fileset dir="." includes="ChangeLog.txt"/>
+  </zip>
    +

    zips all files in the htdocs/manual directory, and also adds the file ChangeLog.txt in the +current directory. ChangeLog.txt will be added to the top of the ZIP file, just as if +it had been located at htdocs/manual/ChangeLog.txt.

    +
      <zip destfile="${dist}/manual.zip">
+    <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/>
+    <zipfileset dir="." includes="ChangeLog27.txt" fullpath="docs/ChangeLog.txt"/>
+    <zipfileset src="examples.zip" includes="**/*.html" prefix="docs/examples"/>
+  </zip>
    +

    zips all files in the htdocs/manual directory into the docs/user-guide directory +in the archive, adds the file ChangeLog27.txt in the +current directory as docs/ChangeLog.txt, and includes all the html files in examples.zip +under docs/examples. The archive might end up containing the files:

    +
        docs/user-guide/html/index.html
+    docs/ChangeLog.txt
+    docs/examples/index.html
+
    +

    +The code +

    +  <zip destfile="${dist}/manual.zip">
+    <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/>
+    <zipgroupfileset dir="." includes="examples*.zip"/>
+  </zip>
+
    +

    +

    zips all files in the htdocs/manual directory into the docs/user-guide directory in the archive and includes all the files in any file that maches examples*.zip, such as all files within examples1.zip or examples_for_brian.zip. +The same can be achieved with +

    +  <zip destfile="${dist}/manual.zip">
+    <mappedresources>
+      <fileset dir="htdocs/manual"/>
+      <globmapper from="*" to="docs/user-guide/*"/>
+    </mappedresources>
+    <archives>
+      <zips>
+        <fileset dir="." includes="examples*.zip"/>
+      </zips>
+    </archives>
+  </zip>
+
    + +The next example + +
    +<zip dest="release.zip">
+  <tarfileset src="release.tar"/>
+</zip>
+
    + +

    re-packages a TAR archive as a ZIP archive. If Unix file +permissions have been stored as part of the TAR file, they will be +retained in the resulting ZIP archive.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/antlib.html b/tools/apache-ant-1.8.2/docs/manual/Types/antlib.html new file mode 100644 index 000000000..3b06a162d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/antlib.html @@ -0,0 +1,267 @@ + + + + + + +AntLib + + + +

    Antlib

    + + +

    Description

    +

    + An antlib file is an xml file with a root element of "antlib". + Antlib's elements are Apache Ant definition tasks - like + + and Taskdef, + or any Ant task that extends + org.apache.tools.ant.taskdefs.AntlibDefinition. +

    +

    + The current set of declarations bundled with Ant that do this are: +

    +
      +
    1. Typedef +
      2. +
    2. Taskdef +
      3. +
    3. Macrodef +
      4. +
    4. Presetdef +
      5. +
    5. Scriptdef +
      6. +
    +

    + A group of tasks and types may be defined together in an antlib + file. For example the file sample.xml contains the following: +

    +
    + 
    +<?xml version="1.0"?>
+<antlib>
+   <typedef name="if" classname="org.acme.ant.If"/>
+   <typedef name="scriptpathmapper"
+            classname="org.acme.ant.ScriptPathMapper"
+            onerror="ignore"/>
+   <macrodef name="print">
+      <attribute name="file"/>
+      <sequential>
+         <concat taskname="print">
+            <fileset dir="." includes="@{file}"/>
+         </concat>
+      </sequential>
+   </macrodef>
+</antlib>
+
    +
    +

    + It defines two types or tasks, if and scriptpathmapper. + This antlib file may be used in a build script as follows: +

    +
    + 
    +<typedef file="sample.xml"/>
+
    +
    +

    + The other attributes of <typedef> may be used as well. + For example, assuming that the sample.xml is in a jar + file sample.jar also containing the classes, the + following build fragment will define the if and scriptpathmapper + tasks/types and place them in the namespace uri samples:/acme.org. +

    +
    + 
    +<typedef resource="org/acme/ant/sample.xml"
+         uri="samples:/acme.org"/>
+
    +
    +

    + The definitions may then be used as follows: +

    +
    + 
    +<sample:if valuetrue="${props}" xmlns:sample="samples:/acme.org">
+   <sample:scriptpathmapper language="beanshell">
+      some bean shell
+   </sample:scriptpathmapper>
+</sample:if>
+
    +
    + + +

    Antlib namespace

    +

    + The name space URIs with the pattern antlib:java package + are given special treatment. +

    +

    + When Ant encounters a element with a namespace URI with this pattern, it + will check to see if there is a resource of the name antlib.xml in + the package directory in the default classpath. +

    +

    + For example, assuming that the file antcontrib.jar has been placed + in the directory ${ant.home}/lib and it contains the resource + net/sf/antcontrib/antlib.xml which has all antcontrib's definitions + defined, the following build file will automatically load the antcontrib + definitions at location HERE: +

    +
    + 
    +<project default="deletetest" xmlns:antcontrib="antlib:net.sf.antcontrib">
+   <macrodef name="showdir">
+      <attribute name="dir"/>
+      <sequential>
+         <antcontrib:shellscript shell="bash">  <!-- HERE -->
+            ls -Rl @{dir}
+         </antcontrib:shellscript>
+      </sequential>
+   </macrodef>
+
+   <target name="deletetest">
+      <delete dir="a" quiet="yes"/>
+      <mkdir dir="a/b"/>
+      <touch file="a/a.txt"/>
+      <touch file="a/b/b.txt"/>
+      <delete>
+         <fileset dir="a"/>
+      </delete>
+      <showdir dir="a"/>
+   </target>
+</project>
+
    +
    +

    + The requirement that the resource is in the default classpath + may be removed in future versions of Ant.

    +

    + + +

    Load antlib from inside of the buildfile

    +

    + If you want to seperate the antlib from your local Ant installation, e.g. because you + want to hold that jar in your projects SCM system, you have to specify a classpath, so + that Ant could find that jar. The best solution is loading the antlib with <taskdef>. +

    +
    + 
    +<project xmlns:antcontrib="antlib:net.sf.antcontrib">
+   <taskdef uri="antlib:net.sf.antcontrib"
+            resource="net/sf/antcontrib/antlib.xml"
+            classpath="path/to/ant-contrib.jar"/>
+   
+   <target name="iterate">
+      <antcontrib:for param="file">
+         <fileset dir="."/>
+         <sequential>
+            <echo message="- @{file}"/>
+         </sequential>
+      </antcontrib:for>
+   </target>
+</project>
+
    +
    + + + + +

    Current namespace

    +

    + Definitions defined in antlibs may be used in antlibs. However + the namespace that definitions are placed in are dependent on + the <typedef> that uses the antlib. To deal with this + problem, the definitions are placed in the namepace URI ant:current + for the duration of the antlib execution. + For example the following antlib defines the task <if>, the + type <isallowed> and a macro + <ifallowed> that makes use of the task and type: +

    +
    + 
    +<antlib xmlns:current="ant:current">
+   <taskdef name="if" classname="org.acme.ant.If"/>
+   <typedef name="isallowed" classname="org.acme.ant.Isallowed"/>
+   <macrodef name="ifallowed">
+      <attribute name="action"/>
+      <element name="do"/>
+      <sequential>
+         <current:if>
+            <current:isallowed test="@{action}"/>
+            <current:then>
+               <do/>
+            </current:then>
+         </current:if>
+      </sequential>
+   </macrodef>
+</antlib>
+
    +
    + + +

    Other examples and comments

    +

    + Antlibs may make use of other antlibs. +

    +

    + As the names defined in the antlib are in the namespace uri as + specified by the calling <typedef> or by automatic element + resolution, one may reuse names from core ant types and tasks, + provided the caller uses a namespace uri. For example, the + following antlib may be used to define defaults for various + tasks: +

    +
    + 
    +<antlib xmlns:antcontrib="antlib:net.sf.antcontrib">
+   <presetdef name="javac">
+      <javac deprecation="${deprecation}"
+             debug="${debug}"/>
+   </presetdef>
+   <presetdef name="delete">
+      <delete quiet="yes"/>
+   </presetdef>
+   <presetdef name="shellscript">
+      <antcontrib:shellscript shell="bash"/>
+   </presetdef>
+</antlib>
+
    +
    +

    + This may be used as follows: +

    +
    + 
    +<project xmlns:local="localpresets">
+   <typedef file="localpresets.xml" uri="localpresets"/>
+   <local:shellscript>
+      echo "hello world"
+   </local:shellscript>
+</project>
+
    +
    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/assertions.html b/tools/apache-ant-1.8.2/docs/manual/Types/assertions.html new file mode 100644 index 000000000..bbf823a3a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/assertions.html @@ -0,0 +1,208 @@ + + + + + + +Assertions type + + + + +

    Assertions

    +

    +The assertions type enables or disables the Java 1.4 assertions feature, +on a whole Java program, or components of a program. It can be used +in <java> and +<junit> to add extra validation to code. + +

    +Assertions are covered in the +J2SDK 1.4 documentation, +and the +Java Language Specification. + +

    +The key points to note are that a java.lang.AssertionError +is thrown when an assertion fails, and that the facility is only available +on Java 1.4 and later. To enable assertions one must set source="1.4" +(or later) in <javac> when the source is being compiled, and +that the code must contain assert statements to be tested. The +result of such an action is code that neither compiles or runs on earlier +versions of Java. For this reason Apache Ant itself currently contains no assertions. +

    + +When assertions are enabled (or disabled) in a task through nested +assertions elements, the class loader or command line is modified with the +appropriate options. This means that the JVM executed must be a Java 1.4 +or later JVM, even if there are no assertions in the code. Attempting to +enable assertions on earlier VMs will result in an "Unrecognized option" +error and the JVM will not start. + +

    +

    Attributes

    +

    + + +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    enableSystemAssertionsFlag to turn system assertions on or off.No; default is "unspecified"
    +

    +When system assertions have been neither enabled nor disabled, then +the JVM is not given any assertion information - the default action of the + current JVMs is to disable system assertions. +

    +Note also that there is no apparent documentation for what parts of the +JRE come with useful assertions. + +

    Nested elements

    + +

    enable

    +

    +Enable assertions in portions of code. +If neither a package nor class is specified, assertions are turned on in all (user) code. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classThe name of a class on which to enable assertions.No
    package + The name of a package in which to enable assertions on all classes. (Includes subpackages.) + Use "..." for the anonymous package. + No
    + +

    disable

    +

    +Disable assertions in portions of code. + +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classThe name of a class on which to disable assertions.No
    package + The name of a package in which to disable assertions on all classes. (Includes subpackages.) + Use "..." for the anonymous package. + No
    +

    + +Because assertions are disabled by default, it only makes sense to disable +assertions where they have been enabled in a parent package. + + +

    Examples

    + +
    Example: enable assertions in all user classes
    + +All classes not in the JRE (i.e. all non-system classes) will have assertions turned on. +
    +<assertions>
+  <enable/>
+</assertions>
+
    + +
    Example: enable a single class
    + +Enable assertions in a class called Test +
    +<assertions>
+  <enable class="Test"/>
+</assertions>
+
    + +
    Example: enable a package
    + +Enable assertions in the org.apache package +and all packages starting with the org.apache. prefix +
    +<assertions>
+  <enable package="org.apache"/>
+</assertions>
+
    + +
    Example: System assertions
    + +Example: enable system assertions and assertions in all org.apache packages except +for Ant (but including org.apache.tools.ant.Main) +
    +<assertions enableSystemAssertions="true">
+  <enable package="org.apache"/>
+  <disable package="org.apache.tools.ant"/>
+  <enable class="org.apache.tools.ant.Main"/>
+</assertions>
+
    + +
    Example: disabled and anonymous package assertions
    + +Disable system assertions; enable those in the anonymous package +
    +<assertions enableSystemAssertions="false">
+  <enable package="..."/>
+</assertions>
+
    + + +
    Example: referenced assertions
    + +This type is a datatype, so you can declare assertions and use them later + +
    +<assertions id="project.assertions">
+  <enable package="org.apache.test"/>
+</assertions>
+
+<assertions refid="project.assertions"/>
+
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/classfileset.html b/tools/apache-ant-1.8.2/docs/manual/Types/classfileset.html new file mode 100644 index 000000000..74a2af80c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/classfileset.html @@ -0,0 +1,119 @@ + + + + + +ClassFileSet Type + + + +

    ClassFileSet

    +

    A classfileset is a specialised type of fileset which, given a set of +"root" classes, will include all of the class files upon which the +root classes depend. This is typically used to create a jar with all of the +required classes for a particular application. +

    +

    +classfilesets are typically used by reference. They are declared with an +"id" value and this is then used as a reference where a normal fileset +is expected. +

    +

    +This type requires the jakarta-BCEL library. +

    + + +

    Attributes

    +

    The class fileset support the following attributes in addition +to those supported by the +standard fileset: +

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    rootclassA single root class nameNo
    + +

    Nested Elements

    + +

    Root

    +

    +When more than one root class is required, multiple nested <root> elements +may be used +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnameThe fully qualified name of the root classYes
    + +

    RootFileSet

    +

    +A root fileset is used to add a set of root classes from a fileset. In this case the entries in +the fileset are expected to be Java class files. The name of the Java class is determined by the +relative location of the classfile in the fileset. So, the file +org/apache/tools/ant/Project.class corresponds to the Java class +org.apache.tools.ant.Project.

    + +

    Examples

    +
    +<classfileset id="reqdClasses" dir="${classes.dir}">
+  <root classname="org.apache.tools.ant.Project"/>
+</classfileset>
+
    + +

    This example creates a fileset containing all the class files upon which the +org.apache.tools.ant.Project class depends. This fileset could +then be used to create a jar. +

    + +
    +<jar destfile="minimal.jar">
+  <fileset refid="reqdClasses"/>
+</jar>
+
    + +
    +<classfileset id="reqdClasses" dir="${classes.dir}">
+  <rootfileset dir="${classes.dir}" includes="org/apache/tools/ant/Project*.class"/>
+</classfileset>
+
    + +

    This example constructs the classfileset using all the class with names starting with Project +in the org.apache.tools.ant package

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/custom-programming.html b/tools/apache-ant-1.8.2/docs/manual/Types/custom-programming.html new file mode 100644 index 000000000..96bade33c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/custom-programming.html @@ -0,0 +1,415 @@ + + + + + +Custom Components + + +

    Custom Components

    +

    Overview

    +

    + Custom components are conditions, selectors, filters and other + objects that are defined outside Apache Ant core. +

    +

    + In Ant 1.6 custom conditions, selectors and filters has + been overhauled. +

    +

    + It is now possible to define custom conditions, selectors and filters + that behave like Ant Core components. + This is achieved by allowing datatypes defined in build scripts + to be used as custom components if the class of the datatype + is compatible, or has been adapted by an adapter class. +

    +

    + The old methods of defining custom components are still supported. +

    +

    Definition and use

    +

    + A custom component is a normal Java class that implements a particular + interface or extends a particular class, or has been adapted to the + interface or class. +

    +

    + It is exactly like writing a + custom task. + One defines attributes and nested elements by writing setter + methods and add methods. +

    +

    + After the class has been written, it is added to the ant system + by using <typedef>. +

    +

    Custom Conditions

    +

    + Custom conditions are datatypes that implement + org.apache.tools.ant.taskdefs.condition.Condition. + For example a custom condition that returns true if a + string is all upper case could be written as: +

    +
    + 
    +package com.mydomain;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.taskdefs.condition.Condition;
+
+public class AllUpperCaseCondition implements Condition {
+    private String value;
+
+    // The setter for the "value" attribute
+    public void setValue(String value) {
+        this.value = value;
+    }
+
+    // This method evaluates the condition
+    public boolean eval() {
+        if (value == null) {
+            throw new BuildException("value attribute is not set");
+        }
+        return value.toUpperCase().equals(value);
+   }
+}
+
    +
    + +

    + Adding the condition to the system is achieved as follows: +

    +
    + 
    +<typedef
+    name="alluppercase"
+    classname="com.mydomain.AllUpperCaseCondition"
+    classpath="${mydomain.classes}"/>
+
    +
    +

    + This condition can now be used wherever a Core Ant condition + is used. +

    +
    + 
    +<condition property="allupper">
+   <alluppercase value="THIS IS ALL UPPER CASE"/>
+</condition>
+
    +
    +

    Custom Selectors

    +

    + Custom selectors are datatypes that implement + org.apache.tools.ant.types.selectors.FileSelector. +

    +

    There is only one method required. + public boolean isSelected(File basedir, String filename, + File file). + It returns true + or false depending on whether the given file should be + selected or not. +

    +

    + An example of a custom selection that selects filenames ending + in ".java" would be: +

    +
    + 
    +package com.mydomain;
+import java.io.File;
+import org.apache.tools.ant.types.selectors.FileSelector;
+public class JavaSelector implements FileSelector {
+    public boolean isSelected(File b, String filename, File f) {
+       return filename.toLowerCase().endsWith(".java");
+    }
+}
+
    +
    +

    + Adding the selector to the system is achieved as follows: +

    +
    + 
    +<typedef
+    name="javaselector"
+    classname="com.mydomain.JavaSelector"
+    classpath="${mydomain.classes}"/>
+
    +
    +

    + This selector can now be used wherever a Core Ant selector + is used, for example: +

    +
    + 
    +<copy todir="to">
+   <fileset dir="src">
+      <javaselector/>
+   </fileset>
+</copy>
+
    +
    + +

    + One may use + org.apache.tools.ant.types.selectors.BaseSelector, + a convenience class that provides reasonable default + behaviour. + It has some predefined behaviours you can take advantage + of. Any time you encounter a problem when setting attributes or + adding tags, you can call setError(String errmsg) and the class + will know that there is a problem. Then, at the top of your + isSelected() method call validate() and + a BuildException will be thrown with the contents of your error + message. The validate() method also gives you a + last chance to check your settings for consistency because it + calls verifySettings(). Override this method and + call setError() within it if you detect any + problems in how your selector is set up. +

    +

    + To write custom selector containers one should extend + org.apache.tools.ant.types.selectors.BaseSelectorContainer. + Implement the + public boolean isSelected(File baseDir, String filename, File file) + method to do the right thing. Chances are you'll want to iterate + over the selectors under you, so use + selectorElements() to get an iterator that will do + that. +

    +

    + For example to create a selector container that will select files + if a certain number of contained selectors select, one could write + a selector as follows: +

    +
    + 
    +public class MatchNumberSelectors extends BaseSelectorContainer {
+    private int number = -1;
+    public void setNumber(int number) {
+        this.number = number;
+    }
+    public void verifySettings() {
+        if (number < 0) {
+           throw new BuildException("Number attribute should be set");
+        }
+    }
+    public boolean isSelected(File baseDir, String filename, File file) {
+        validate();
+        int numberSelected = 0;
+        for (Enumeration e = selectorElements(); e.hasNextElement();) {
+            FileSelector s = (FileSelector) e.nextElement();
+            if (s.isSelected(baseDir, filename, file)) {
+                numberSelected++;
+            }
+        }
+        return numberSelected == number;
+    }
+}
+
    +
    +

    + To define and use this selector one could do: +

    +
    + 
    +<typedef name="numberselected"
+         classname="com.mydomain.MatchNumberSelectors"/>
+...
+<fileset dir="${src.path}">
+   <numberselected number="2">
+      <contains text="script" casesensitive="no"/>
+      <size value="4" units="Ki" when="more"/>
+      <javaselector/>
+   </numberselected>
+</fileset>
+
    +
    +

    + The custom selector +

    +

    + The custom selector was the pre ant 1.6 way of defining custom selectors. + This method is still supported for backward compatibility. +

    +

    You can write your own selectors and use them within the selector + containers by specifying them within the <custom> tag.

    + +

    To create a new Custom Selector, you have to create a class that + implements + org.apache.tools.ant.types.selectors.ExtendFileSelector. + The easiest way to do that is through the convenience base class + org.apache.tools.ant.types.selectors.BaseExtendSelector, + which provides all of the methods for supporting + <param> tags. First, override the + isSelected() method, and optionally the + verifySettings() method. If your custom + selector requires parameters to be set, you can also override + the setParameters() method and interpret the + parameters that are passed in any way you like. Several of the + core selectors demonstrate how to do that because they can + also be used as custom selectors.

    + + +

    Once that is written, you include it in your build file by using + the <custom> tag. +

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnameThe name of your class that implements + org.apache.tools.ant.types.selectors.FileSelector. + Yes
    classpathThe classpath to use in order to load the + custom selector class. If neither this classpath nor the + classpathref are specified, the class will be + loaded from the classpath that Ant uses. + No
    classpathrefA reference to a classpath previously + defined. If neither this reference nor the + classpath above are specified, the class will be + loaded from the classpath that Ant uses. + No
    + +

    Here is how you use <custom> to + use your class as a selector: +

    + + 
    +<fileset dir="${mydir}" includes="**/*">
+    <custom classname="com.mydomain.MySelector">
+        <param name="myattribute" value="myvalue"/>
+    </custom>
+</fileset>
+
    + + +

    The core selectors that can also be used as custom selectors + are

    + +
      +
    • Contains Selector with + classname org.apache.tools.ant.types.selectors.ContainsSelector +
      • +
    • Date Selector with + classname org.apache.tools.ant.types.selectors.DateSelector +
      • +
    • Depth Selector with + classname org.apache.tools.ant.types.selectors.DepthSelector +
      • +
    • Filename Selector with + classname org.apache.tools.ant.types.selectors.FilenameSelector +
      • +
    • Size Selector with + classname org.apache.tools.ant.types.selectors.SizeSelector +
      • +
    + +

    Here is the example from the Depth Selector section rewritten + to use the selector through <custom>.

    + + 
    +<fileset dir="${doc.path}" includes="**/*">
+    <custom classname="org.apache.tools.ant.types.selectors.DepthSelector">
+        <param name="max" value="1"/>
+    </custom>
+</fileset>
+
    + +

    Selects all files in the base directory and one directory below + that.

    + +

    Custom Filter Readers

    +

    + Custom filter readers selectors are datatypes that implement + org.apache.tools.ant.types.filters.ChainableReader. +

    +

    There is only one method required. + Reader chain(Reader reader). + This returns a reader that filters input from the specified + reader. +

    +

    + For example a filterreader that removes every second character + could be: +

    +
    + 
    +public class RemoveOddCharacters implements ChainableReader {
+   public Reader chain(Reader reader) {
+      return new BaseFilterReader(reader) {
+          int count = 0;
+          public int read() throws IOException {
+              while (true) {
+                int c = in.read();
+                if (c == -1) {
+                    return c;
+                }
+                count++;
+                if ((count % 2) == 1) {
+                    return c;
+                }
+              }
+          }
+      }
+   }
+}
+
    +
    +

    + For line oriented filters it may be easier to extend + ChainableFilterReader an inner class of + org.apache.tools.ant.filters.TokenFilter. +

    +

    + For example a filter that appends the line number could be +

    +
    + 
    +public class AddLineNumber extends ChainableReaderFilter {
+   private void lineNumber = 0;
+   public String filter(String string) {
+      lineNumber++;
+      return "" + lineNumber + "\t" + string;
+   }
+}
+
    +
    + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/description.html b/tools/apache-ant-1.8.2/docs/manual/Types/description.html new file mode 100644 index 000000000..85942be00 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/description.html @@ -0,0 +1,46 @@ + + + + + + +Apache Ant User Manual + + + + +

    Description

    +

    Description

    +

    Allows for a description of the project to be specified that +will be included in the output of the ant ‑projecthelp +command.

    + +

    Parameters

    +

    (none)

    +

    Examples

    +
      
+<description>
+This buildfile is used to build the Foo subproject within 
+the large, complex Bar project.
+</description>
+
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/dirset.html b/tools/apache-ant-1.8.2/docs/manual/Types/dirset.html new file mode 100644 index 000000000..1a046a6d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/dirset.html @@ -0,0 +1,151 @@ + + + + + + +DirSet Type + + + + +

    DirSet

    +

    A DirSet is a group of directories. These directories can be found in a +directory tree starting in a base directory and are matched by +patterns taken from a number of PatternSets +and Selectors. +

    +

    PatternSets can be specified as nested +<patternset> elements. In addition, DirSet holds +an implicit PatternSet and supports the nested +<include>, <includesfile>, +<exclude> and <excludesfile> +elements of <patternset> directly, as well as +<patternset>'s attributes.

    +

    Selectors are available as nested elements within the DirSet. +If any of the selectors within the DirSet do not select the directory, it +is not considered part of the DirSet. This makes a DirSet +equivalent to an <and> selector container.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    dirThe root of the directory tree of this DirSet.Yes
    includesA comma- or space-separated list of patterns of directories that + must be included; all directories are included when omitted.No
    includesfileThe name of a file; each line of this file is + taken to be an include pattern.No
    excludesA comma- or space-separated list of patterns of directories that + must be excluded; no directories are excluded when omitted.No
    excludesfileThe name of a file; each line of this file is + taken to be an exclude pattern.No
    casesensitiveSpecifies whether case-sensitivity should be applied + (true|yes|on or + false|no|off).No; defaults to true.
    followsymlinksShall symbolic links be followed? Defaults to + true. See fileset's documentation.No
    erroronmissingdir + Specify what happens if the base directory does not exist. + If true a build error will happen, if false, the dirset + will be ignored/empty. + Defaults to true. + Since Apache Ant 1.7.1 (default is true for backward compatibility + reasons.) + No
    + +

    Examples

    + +
    +<dirset dir="${build.dir}">
+  <include name="apps/**/classes"/>
+  <exclude name="apps/**/*Test*"/>
+</dirset>
+
    +

    Groups all directories named classes found under the +apps subdirectory of ${build.dir}, except those +that have the text Test in their name.

    + +
    +<dirset dir="${build.dir}">
+  <patternset id="non.test.classes">
+    <include name="apps/**/classes"/>
+    <exclude name="apps/**/*Test*"/>
+  </patternset>
+</dirset>
+
    +

    Groups the same directories as the above example, but also establishes +a PatternSet that can be referenced in other +<dirset> elements, rooted at a different directory.

    + +
    +<dirset dir="${debug_build.dir}">
+  <patternset refid="non.test.classes"/>
+</dirset>
+
    +

    Groups all directories in directory ${debug_build.dir}, +using the same patterns as the above example.

    + +
    +<dirset id="dirset" dir="${workingdir}">
+   <present targetdir="${workingdir}">
+        <mapper type="glob" from="*" to="*/${markerfile}" />
+   </present>
+</dirset>
+
    +

    Selects all directories somewhere under ${workingdir} +which contain a ${markerfile}.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/extension.html b/tools/apache-ant-1.8.2/docs/manual/Types/extension.html new file mode 100644 index 000000000..4f9943712 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/extension.html @@ -0,0 +1,114 @@ + + + + + +Extension Type + + + +

    Extension

    +

    Utility type that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.

    +

    Note that this type +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html.

    + +

    Attributes

    +

    The extension type supports the following attributes: +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    extensionNameThe name of extensionyes
    specificationVersionThe version of extension specification (Must be in + dewey decimal aka dotted decimal notation. 3.2.4)no
    specificationVendorThe specification vendorno
    implementationVersionThe version of extension implementation (Must be in + dewey decimal aka dotted decimal notation. 3.2.4)no
    implementationVendorThe implementation vendorno
    implementationVendorIdThe implementation vendor IDno
    implementationURLThe url from which to retrieve extension.no
    + +

    Examples

    +
    +<extension id="e1"
+    extensionName="MyExtensions"
+    specificationVersion="1.0"
+    specificationVendor="Peter Donald"
+    implementationVendorID="vv"
+    implementationVendor="Apache"
+    implementationVersion="2.0"
+    implementationURL="http://somewhere.com/myExt.jar"/>
+
    + +

    Fully specific extension object.

    + +
    +<extension id="e1"
+    extensionName="MyExtensions"
+    specificationVersion="1.0"
+    specificationVendor="Peter Donald"/>
+
    + +

    Extension object that just species the specification details.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/extensionset.html b/tools/apache-ant-1.8.2/docs/manual/Types/extensionset.html new file mode 100644 index 000000000..fdebd0429 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/extensionset.html @@ -0,0 +1,83 @@ + + + + + +ExtensionSet Type + + + +

    ExtensionSet

    +

    Utility type that represents a set of Extensions.

    +

    Note that this type +works with extensions as defined by the "Optional Package" specification. + For more information about optional packages, see the document +Optional Package Versioning in the documentation bundle for your +Java2 Standard Edition package, in file +guide/extensions/versioning.html or online at + +http://download.oracle.com/javase/1.3/docs/guide/extensions/versioning.html.

    + +

    Nested Elements

    + +

    extension

    +

    Extension object to add to set.

    + +

    fileset

    +

    FileSets all files contained + contained within set that are jars and implement an extension are added + to extension set.

    + +

    LibFileSet

    +

    All files contained contained within set that are jars and implement + an extension are added to extension set. However the extension information + may be modified by attributes of libfileset

    + +

    Examples

    +
    +<extension id="e1"
+    extensionName="MyExtensions"
+    specificationVersion="1.0"
+    specificationVendor="Peter Donald"
+    implementationVendorID="vv"
+    implementationVendor="Apache"
+    implementationVersion="2.0"
+    implementationURL="http://somewhere.com/myExt.jar"/>
+
+<libfileset id="lfs"
+               includeUrl="true"
+               includeImpl="false"
+               dir="tools/lib">
+  <include name="*.jar"/>
+</libfileset>
+
+<extensionSet id="exts">
+  <libfileset dir="lib">
+    <include name="*.jar"/>
+  </libfileset>
+  <libfileset refid="lfs"/>
+  <extension refid="e1"/>
+</extensionSet>
+
+
    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/filelist.html b/tools/apache-ant-1.8.2/docs/manual/Types/filelist.html new file mode 100644 index 000000000..57c981d35 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/filelist.html @@ -0,0 +1,120 @@ + + + + + + +FileList Type + + + + +

    FileList

    + +

    FileLists are explicitly named lists of files. Whereas FileSets +act as filters, returning only those files that exist in the file +system and match specified patterns, FileLists are useful for +specifying files that may or may not exist. Multiple files are +specified as a list of files, relative to the specified directory, +with no support for wildcard expansion (filenames with wildcards will be +included in the list unchanged). +FileLists can appear inside tasks that support this feature or as stand-alone +types. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    dirThe base directory of this FileList.Yes
    filesThe list of file names. This is a list of + file name separated by whitespace, or by commas. + Yes, unless there is a nested file element
    +

    Nested Element: file

    +

    + This represents a file name. The nested element allows filenames containing + white space and commas. +

    +

    Since Apache Ant 1.6.2

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the file.Yes
    +

    Examples

    +
    +<filelist 
+    id="docfiles" 
+    dir="${doc.src}"
+    files="foo.xml,bar.xml"/> 
+
    + +

    The files ${doc.src}/foo.xml and +${doc.src}/bar.xml. Note that these files may not (yet) +actually exist. +

    + +
    +<filelist 
+    id="docfiles" 
+    dir="${doc.src}"
+    files="foo.xml
+           bar.xml"/> 
+
    + +

    Same files as the example above.

    + +
    +<filelist refid="docfiles"/> 
+
    + +

    Same files as the example above.

    + +
    +<filelist 
+    id="docfiles" 
+    dir="${doc.src}">
+    <file name="foo.xml"/>
+    <file name="bar.xml"/>
+</filelist>
+
    + +

    Same files as the example above.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/fileset.html b/tools/apache-ant-1.8.2/docs/manual/Types/fileset.html new file mode 100644 index 000000000..10e78f7c7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/fileset.html @@ -0,0 +1,183 @@ + + + + + + +FileSet Type + + + + +

    FileSet

    +

    A FileSet is a group of files. These files can be found in a +directory tree starting in a base directory and are matched by +patterns taken from a number of PatternSets and +Selectors. +

    PatternSets can be specified as nested +<patternset> elements. In addition, FileSet holds +an implicit PatternSet and supports the nested +<include>, <includesfile>, +<exclude> and <excludesfile> +elements of PatternSet directly, as well as PatternSet's +attributes.

    +

    Selectors are available as nested elements within the FileSet. +If any of the selectors within the FileSet do not select the file, the +file is not considered part of the FileSet. This makes a FileSet +equivalent to an <and> selector container.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    dirthe root of the directory tree of this FileSet.Either dir or file must be specified
    fileshortcut for specifying a single-file fileset
    defaultexcludesindicates whether default excludes should be used or not + (yes | no); default excludes are used when omitted.No
    includescomma- or space-separated list of patterns of files that must be + included; all files are included when omitted.No
    includesfilethe name of a file; each line of this file is + taken to be an include pattern.No
    excludescomma- or space-separated list of patterns of files that must be + excluded; no files (except default excludes) are excluded when omitted.No
    excludesfilethe name of a file; each line of this file is + taken to be an exclude pattern.No
    casesensitiveMust the include and exclude patterns be treated in a case sensitive way? + Defaults to true.No
    followsymlinksShall symbolic links be followed? Defaults to + true. See the note below.No
    erroronmissingdir + Specify what happens if the base directory does not exist. + If true a build error will happen, if false, the fileset + will be ignored/empty. + Defaults to true. + Since Apache Ant 1.7.1 (default is true for backward compatibility + reasons.) + No
    + +

    Note: All files/directories for which +the canonical path is different from its path are considered symbolic +links. On Unix systems this usually means the file really is a +symbolic link but it may lead to false results on other +platforms.

    + +

    Examples

    +
    +<fileset dir="${server.src}" casesensitive="yes">
+  <include name="**/*.java"/>
+  <exclude name="**/*Test*"/>
+</fileset>
+
    +

    Groups all files in directory ${server.src} that are Java +source files and don't have the text Test in their +name.

    + +
    +<fileset dir="${server.src}" casesensitive="yes">
+  <patternset id="non.test.sources">
+    <include name="**/*.java"/>
+    <exclude name="**/*Test*"/>
+  </patternset>
+</fileset>
+
    +

    Groups the same files as the above example, but also establishes +a PatternSet that can be referenced in other +<fileset> elements, rooted at a different directory.

    + +
    +<fileset dir="${client.src}" >
+  <patternset refid="non.test.sources"/>
+</fileset>
+
    +

    Groups all files in directory ${client.src}, using the +same patterns as the above example.

    + +
    +<fileset dir="${server.src}" casesensitive="yes">
+  <filename name="**/*.java"/>
+  <filename name="**/*Test*" negate="true"/>
+</fileset>
+
    +

    Groups the same files as the top example, but using the +<filename> selector.

    + +
    +<fileset dir="${server.src}" casesensitive="yes">
+  <filename name="**/*.java"/>
+  <not>
+    <filename name="**/*Test*"/>
+  </not>
+</fileset>
+
    +

    Groups the same files as the previous example using a combination of the +<filename> selector and the <not> +selector container.

    + +
    +<fileset dir="src" includes="main/" />
+
    +

    Selects all files in src/main (e.g. src/main/Foo.java or +src/main/application/Bar.java).

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/filterchain.html b/tools/apache-ant-1.8.2/docs/manual/Types/filterchain.html new file mode 100644 index 000000000..b9f893ad8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/filterchain.html @@ -0,0 +1,1668 @@ + + + + + + +FilterChains and FilterReaders + + + + +

    FilterChains and FilterReaders

    +Consider the flexibility of Unix pipes. If you wanted, +for example, to copy just those lines that contained the +string blee from the first 10 lines of a text file 'foo' +(you wouldn't want to filter a binary file) +to a file 'bar', you would do something like:

    + +cat foo|head -n10|grep blee > bar +

    +Apache Ant was not flexible enough. There was no way for the +<copy> task to do something similar. If you wanted +the <copy> task to get the first 10 lines, you would have +had to create special attributes:

    + +<copy file="foo" tofile="bar" head="10" contains="blee"/> +

    +The obvious problem thus surfaced: Ant tasks would not be able +to accommodate such data transformation attributes as they would +be endless. The task would also not know in which order these +attributes were to be interpreted. That is, must the task execute the +contains attribute first and then the head attribute or vice-versa? +What Ant tasks needed was a mechanism to allow pluggable filter (data +transformer) chains. Ant would provide a few filters for which there +have been repeated requests. Users with special filtering needs +would be able to easily write their own and plug them in.

    + +The solution was to refactor data transformation oriented +tasks to support FilterChains. A FilterChain is a group of +ordered FilterReaders. Users can define their own FilterReaders +by just extending the java.io.FilterReader class. Such custom +FilterReaders can be easily plugged in as nested elements of +<filterchain> by using <filterreader> elements. +

    +Example: +

    +<copy file="${src.file}" tofile="${dest.file}">
+  <filterchain>
+    <filterreader classname="your.extension.of.java.io.FilterReader">
+      <param name="foo" value="bar"/>
+    </filterreader>
+    <filterreader classname="another.extension.of.java.io.FilterReader">
+      <classpath>
+        <pathelement path="${classpath}"/>
+      </classpath>
+      <param name="blah" value="blee"/>
+      <param type="abra" value="cadabra"/>
+    </filterreader>
+  </filterchain>
+</copy>
+
    + +Ant provides some built-in filter readers. These filter readers +can also be declared using a syntax similar to the above syntax. +However, they can be declared using some simpler syntax also.

    +Example: +

    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <headfilter lines="15"/>
+  </filterchain>
+</loadfile>
+
    +is equivalent to: +
    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+      <param name="lines" value="15"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +The following built-in tasks support nested <filterchain> elements.
    +Concat,
    +Copy,
    +LoadFile,
    +LoadProperties,
    +Move

    + +A FilterChain is formed by defining zero or more of the following +nested elements.
    +FilterReader
    +ClassConstants
    +EscapeUnicode
    +ExpandProperties
    +HeadFilter
    +LineContains
    +LineContainsRegExp
    +PrefixLines
    +ReplaceTokens
    +StripJavaComments
    +StripLineBreaks
    +StripLineComments
    +SuffixLines
    +TabsToSpaces
    +TailFilter
    +DeleteCharacters
    +ConcatFilter
    +TokenFilter
    +FixCRLF
    +SortFilter
    + +

    FilterReader

    + +The filterreader element is the generic way to +define a filter. User defined filter elements are +defined in the build file using this. Please note that +built in filter readers can also be defined using this +syntax. + +A FilterReader element must be supplied with a class name as +an attribute value. The class resolved by this name must +extend java.io.FilterReader. If the custom filter reader +needs to be parameterized, it must implement +org.apache.tools.type.Parameterizable. + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnameThe class name of the filter reader.Yes
    + +

    +

    Nested Elements:

    +<filterreader> supports <classpath> and <param> +as nested elements. Each <param> element may take in the following +attributes - name, type and value. +

    +The following FilterReaders are supplied with the default +distribution. + +

    ClassConstants

    +

    + This filters basic constants defined in a Java Class, + and outputs them in lines composed of the format name=value. + This filter uses the bcel library to understand the Java Class file. + See Library Dependencies. +

    +

    + Important: + This filter is different from most of the other filters. + Most of the filters operate on a sequence of characters. + This filter operates on the sequence of bytes that makes up + a class. However the bytes arrive to the filter as a sequence + of characters. This means that one must be careful on the + choice of character encoding to use. Most encoding lose information + on conversion from an arbitary sequence of bytes to characters + and back again to bytes. In particular the usual default + character encodings (CP152 and UTF-8) do. + For this reason, since Ant 1.7, the character + encoding ISO-8859-1 is used to convert from characters back to + bytes, so one has to use this encoding for reading the java + class file. +

    Example:

    + +This loads the basic constants defined in a Java class as Ant properties. + +
    +<loadproperties srcfile="foo.class" encoding="ISO-8859-1">
+  <filterchain>
+    <classconstants/>
+  </filterchain>
+</loadproperties>
+
    + +This loads the constants from a Java class file as Ant properties, +prepending the names with a prefix. + + 
    +<loadproperties srcfile="build/classes/org/acme/bar.class"
+                encoding="ISO-8859-1">
+  <filterchain>
+    <classconstants/>
+    <prefixlines prefix="ini."/>
+  </filterchain>
+</loadproperties>
+
    +

    EscapeUnicode

    +

    +This filter converts its input by changing all non US-ASCII characters +into their equivalent unicode escape backslash u plus 4 digits.

    + +

    since Ant 1.6

    + +

    Example:

    + +This loads the basic constants defined in a Java class as Ant properties. +
    +<loadproperties srcfile="non_ascii_property.properties">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.EscapeUnicode"/>
+  </filterchain>
+</loadproperties>
+
    + +Convenience method: +
    +<loadproperties srcfile="non_ascii_property.properties">
+  <filterchain>
+    <escapeunicode/>
+  </filterchain>
+</loadproperties>
+
    + +

    ExpandProperties

    +

    +If the data contains data that represents Ant +properties (of the form ${...}), that is substituted +with the property's actual value. +

    +

    Example:

    + +This results in the property modifiedmessage holding the value +"All these moments will be lost in time, like teardrops in the rain" +
    +<echo
+  message="All these moments will be lost in time, like teardrops in the ${weather}"
+  file="loadfile1.tmp"
+  />
+<property name="weather" value="rain"/>
+<loadfile property="modifiedmessage" srcFile="loadfile1.tmp">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.ExpandProperties"/>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<echo
+  message="All these moments will be lost in time, like teardrops in the ${weather}"
+  file="loadfile1.tmp"
+  />
+<property name="weather" value="rain"/>
+<loadfile property="modifiedmessage" srcFile="loadfile1.tmp">
+  <filterchain>
+    <expandproperties/>
+  </filterchain>
+</loadfile>
+
    + +

    HeadFilter

    + +This filter reads the first few lines from the data supplied to it. + + + + + + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    linesNumber of lines to be read. + Defaults to "10"
    A negative value means that all lines are + passed (useful with skip)    		No
    skipNumber of lines to be skipped (from the beginning). + Defaults to "0"No
    +

    +

    Example:

    + +This stores the first 15 lines of the supplied data in the property src.file.head +
    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+      <param name="lines" value="15"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <headfilter lines="15"/>
+  </filterchain>
+</loadfile>
+
    + +This stores the first 15 lines, skipping the first 2 lines, of the supplied data +in the property src.file.head. (Means: lines 3-17) +
    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <headfilter lines="15" skip="2"/>
+  </filterchain>
+</loadfile>
+
    + +See the testcases for more examples (src\etc\testcases\filters\head-tail.xml in the +source distribution). + +

    LineContains

    + +This filter includes only those lines that contain all the user-specified +strings. + + + + + + + + + + + + + + + + + +
    Parameter TypeParameter ValueRequired
    containsSubstring to be searched for.Yes
    negateWhether to select + non-matching lines only. Since Ant 1.7No
    +

    +

    Example:

    + +This will include only those lines that contain foo and +bar. +
    +<filterreader classname="org.apache.tools.ant.filters.LineContains">
+  <param type="contains" value="foo"/>
+  <param type="contains" value="bar"/>
+</filterreader>
+
    + +Convenience method: +
    +<linecontains>
+  <contains value="foo"/>
+  <contains value="bar"/>
+</linecontains>
+
    + +Negation: +
    +<filterreader classname="org.apache.tools.ant.filters.LineContains">
+  <param type="negate" value="true"/>
+  <param type="contains" value="foo"/>
+  <param type="contains" value="bar"/>
+</filterreader>
+
    +or +
    +<linecontains negate="true">
+  <contains value="foo"/>
+  <contains value="bar"/>
+</linecontains>
+
    + +

    LineContainsRegExp

    + +Filter which includes only those lines that contain the user-specified +regular expression matching strings. + + + + + + + + + + + + + + + + + + + + + + +
    Parameter TypeParameter ValueRequired
    regexpRegular expression to be searched for.Yes
    negateWhether to select + non-matching lines only. Since Ant 1.7No
    casesensitivePerform a case sensitive + match. Default is true. Since Ant 1.8.2No
    + +See Regexp Type for the description of the nested element regexp and of +the choice of regular expression implementation. +

    Example:

    + +This will fetch all those lines that contain the pattern foo +
    +<filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp">
+  <param type="regexp" value="foo*"/>
+</filterreader>
+
    + +Convenience method: +
    +<linecontainsregexp>
+  <regexp pattern="foo*"/>
+</linecontainsregexp>
+
    + +Negation: +
    +<filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp">
+  <param type="negate" value="true"/>
+  <param type="regexp" value="foo*"/>
+</filterreader>
+
    +or +
    +<linecontainsregexp negate="true">
+  <regexp pattern="foo*"/>
+</linecontainsregexp>
+
    + +

    PrefixLines

    + +Attaches a prefix to every line. + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    prefixPrefix to be attached to lines.Yes
    +

    +

    Example:

    + +This will attach the prefix Foo to all lines. +
    +<filterreader classname="org.apache.tools.ant.filters.PrefixLines">
+  <param name="prefix" value="Foo"/>
+</filterreader>
+
    + +Convenience method: +
    +<prefixlines prefix="Foo"/>
+
    + +

    SuffixLines

    + +Attaches a suffix to every line. + +

    since Ant 1.8.0

    + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    suffixSuffix to be attached to lines.Yes
    +

    +

    Example:

    + +This will attach the suffix Foo to all lines. +
    +<filterreader classname="org.apache.tools.ant.filters.SuffixLines">
+  <param name="suffix" value="Foo"/>
+</filterreader>
+
    + +Convenience method: +
    +<suffixlines suffix="Foo"/>
+
    + +

    ReplaceTokens

    + +This filter reader replaces all strings that are +sandwiched between begintoken and endtoken with +user defined values. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Parameter TypeParameter NameParameter ValueRequired
    tokencharbegintokenCharacter marking the + beginning of a token. Defaults to @No
    tokencharendtokenCharacter marking the + end of a token. Defaults to @No
    User defined String.tokenUser defined search String.Yes
    Not applicable.propertiesfileProperties file to take tokens from.No
    User defined String.valueReplace-value for the tokenNo
    +

    + +

    Example:

    + +This replaces occurrences of the string @DATE@ in the data +with today's date and stores it in the property ${src.file.replaced} +
    +<tstamp/>
+<loadfile srcfile="${src.file}" property="${src.file.replaced}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens">
+      <param type="token" name="DATE" value="${TODAY}"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<tstamp/>
+<loadfile srcfile="${src.file}" property="${src.file.replaced}">
+  <filterchain>
+    <replacetokens>
+      <token key="DATE" value="${TODAY}"/>
+    </replacetokens>
+  </filterchain>
+</loadfile>
+
    + +This will treat each properties file entry in sample.properties as a token/key pair : +
    +<loadfile srcfile="${src.file}" property="${src.file.replaced}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens">
+      <param type="propertiesfile" value="sample.properties"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+</filterchain>
+
    + +

    StripJavaComments

    + +This filter reader strips away comments from the data, +using Java syntax guidelines. This filter does not +take in any parameters. +

    +

    Example:

    + +
    +<loadfile srcfile="${java.src.file}" property="${java.src.file.nocomments}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.StripJavaComments"/>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${java.src.file}" property="${java.src.file.nocomments}">
+  <filterchain>
+    <stripjavacomments/>
+  </filterchain>
+</loadfile>
+
    + +

    StripLineBreaks

    + +This filter reader strips away specific characters +from the data supplied to it. + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    linebreaksCharacters that are to + be stripped out. Defaults to "\r\n"No
    +

    +

    Examples:

    + +This strips the '\r' and '\n' characters. +
    +<loadfile srcfile="${src.file}" property="${src.file.contents}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks"/>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${src.file}" property="${src.file.contents}">
+  <filterchain>
+    <striplinebreaks/>
+  </filterchain>
+</loadfile>
+
    + +This treats the '(' and ')' characters as line break characters and +strips them. +
    +<loadfile srcfile="${src.file}" property="${src.file.contents}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.StripLineBreaks">
+      <param name="linebreaks" value="()"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +

    StripLineComments

    + +This filter removes all those lines that begin with strings +that represent comments as specified by the user. + + + + + + + + + + + + +
    Parameter TypeParameter ValueRequired
    commentStrings that identify a line as a comment + when they appear at the start of the line.Yes
    +

    +

    Examples:

    + +This removes all lines that begin with #, --, REM, rem and // +
    +<filterreader classname="org.apache.tools.ant.filters.StripLineComments">
+  <param type="comment" value="#"/>
+  <param type="comment" value="--"/>
+  <param type="comment" value="REM "/>
+  <param type="comment" value="rem "/>
+  <param type="comment" value="//"/>
+</filterreader>
+
    + +Convenience method: +
    +<striplinecomments>
+  <comment value="#"/>
+  <comment value="--"/>
+  <comment value="REM "/>
+  <comment value="rem "/>
+  <comment value="//"/>
+</striplinecomments>
+
    + +

    TabsToSpaces

    + +This filter replaces tabs with spaces + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    tablengthDefaults to "8"No
    +

    +

    Examples:

    + +This replaces tabs in ${src.file} with spaces. +
    +<loadfile srcfile="${src.file}" property="${src.file.notab}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.TabsToSpaces"/>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${src.file}" property="${src.file.notab}">
+  <filterchain>
+    <tabstospaces/>
+  </filterchain>
+</loadfile>
+
    + +

    TailFilter

    + +This filter reads the last few lines from the data supplied to it. + + + + + + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    linesNumber of lines to be read. + Defaults to "10"
    A negative value means that all lines are + passed (useful with skip)    		No
    skipNumber of lines to be skipped (from the end). + Defaults to "0" No
    +

    + +

    Background:

    +With HeadFilter and TailFilter you can extract each part of a text file you want. +This graphic shows the dependencies: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Content Filter
    Line 1     + + + + + + + + + + + + + + + + + + + + + +
     
    <filterchain>
+    <headfilter lines="2"/>
+</filterchain>
     
    <filterchain>
+    <tailfilter lines="-1" skip="2"/>
+</filterchain>
     
    <filterchain>
+    <headfilter lines="-1" skip="2"/>
+</filterchain>
     
    <filterchain>
+    <headfilter lines="-1" skip="2"/>
+    <tailfilter lines="-1" skip="2"/>
+</filterchain>
     
    <filterchain>
+    <tailfilter lines="2"/>
+</filterchain>
    +
    Line 2
    Line 3  
    Line 4
    Line 5  
    Lines ...
    Line 95
    Line 96  
    Line 97
    Line 98  
    Line 99
    + + + +

    Examples:

    + +This stores the last 15 lines of the supplied data in the property ${src.file.tail} +
    +<loadfile srcfile="${src.file}" property="${src.file.tail}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.TailFilter">
+      <param name="lines" value="15"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${src.file}" property="${src.file.tail}">
+  <filterchain>
+    <tailfilter lines="15"/>
+  </filterchain>
+</loadfile>
+
    + + +This stores the last 5 lines of the first 15 lines of the supplied +data in the property ${src.file.mid} +
    +<loadfile srcfile="${src.file}" property="${src.file.mid}">
+  <filterchain>
+    <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+      <param name="lines" value="15"/>
+    </filterreader>
+    <filterreader classname="org.apache.tools.ant.filters.TailFilter">
+      <param name="lines" value="5"/>
+    </filterreader>
+  </filterchain>
+</loadfile>
+
    + +Convenience method: +
    +<loadfile srcfile="${src.file}" property="${src.file.mid}">
+  <filterchain>
+    <headfilter lines="15"/>
+    <tailfilter lines="5"/>
+  </filterchain>
+</loadfile>
+
    + + +This stores the last 10 lines, skipping the last 2 lines, of the supplied data +in the property src.file.head. (Means: if supplied data contains 60 lines, +lines 49-58 are extracted) +
    +<loadfile srcfile="${src.file}" property="src.file.head">
+  <filterchain>
+    <tailfilter lines="10" skip="2"/>
+  </filterchain>
+</loadfile>
+
    + +

    DeleteCharacters

    + +

    This filter deletes specified characters.

    +

    since Ant 1.6

    +

    This filter is only available in the convenience form.

    + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    chars + The characters to delete. This attribute is + backslash enabled. + Yes
    +

    +

    Examples:

    + +Delete tabs and returns from the data. +
    +<deletecharacters chars="\t\r"/>
+
    + +

    ConcatFilter

    +

    This filter prepends or appends the content file to the filtered files.

    +

    since Ant 1.6

    + + + + + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    prepend + The name of the file which content should be prepended to the file. + No
    append + The name of the file which content should be appended to the file. + No
    +

    + +

    Examples:

    + +Do nothing: +
    +<filterchain>
+    <concatfilter/>
+</filterchain>
+
    + +Adds a license text before each java source: +
    +<filterchain>
+    <concatfilter prepend="apache-license-java.txt"/>
+</filterchain>
+
    + + + +

    TokenFilter

    +This filter tokenizes the inputstream into strings and passes these +strings to filters of strings. Unlike the other filterreaders, this does +not support params, only convenience methods are implemented. +The tokenizer and the string filters are defined by nested elements. +

    since Ant 1.6

    +

    +Only one tokenizer element may be used, the LineTokenizer is the +default if none are specified. A tokenizer +splits the input into token strings and trailing delimiter strings. +

    +There may be zero or more string filters. A string filter processes +a token and either returns a string or a null. +It the string is not null it is passed to the next filter. This +proceeds until all the filters are called. +If a string is returned after all the filters, the string is +outputs with its associated token delimitier +(if one is present). +The trailing delimiter may be overridden by the delimOutput +attribute. +

    +blackslash interpretation +A number of attributes (including delimOutput) interpret +backslash escapes. The following are understood: \n, \r, \f, \t +and \\. + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    delimOutput + This overrides the tokendelimiter + returned by the tokenizer if it is not empty. This + attribute is backslash enabled. +No
    +

    + + The following tokenizers are provided by the default distribution. +

    + LineTokenizer
    + FileTokenizer
    + StringTokenizer
    +

    + + The following string filters are provided by the default distribution. +

    + ReplaceString
    + ContainsString
    + ReplaceRegex
    + ContainsRegex
    + Trim
    + IgnoreBlank
    + DeleteCharacters
    + UniqFilter
    +

    + + The following string filters are provided by the optional distribution. +

    + ScriptFilter
    +

    + +Some of the filters may be used directly within a filter chain. In this +case a tokenfilter is created implicitly. An extra attribute "byline" +is added to the filter to specify whether to use a linetokenizer +(byline="true") or a filetokenizer (byline="false"). The default +is "true". +

    + +

    LineTokenizer

    +This tokenizer splits the input into lines. +The tokenizer delimits lines +by "\r", "\n" or "\r\n". +This is the default tokenizer. + + + + + + + + + + + +
    AttributeDescriptionRequired
    includeDelims + Include the line endings in the token. + Default is false. + No
    +

    Examples:

    + +Convert input current line endings to unix style line endings. +
    +<tokenfilter delimoutput="\n"/>
+
    + + +Remove blank lines. +
    +<tokenfilter>
+    <ignoreblank/>
+</tokenfilter>
+
+
    + +

    FileTokenizer

    +This tokenizer treats all the input as a token. So be +careful not to use this on very large input. +

    Examples:

    + +Replace the first occurrence of package with //package. +
    +<tokenfilter>
+      <filetokenizer/>
+      <replaceregex pattern="([\n\r]+[ \t]*|^[ \t]*)package"
+                    flags="s"
+                    replace="\1//package"/>
+</tokenfilter>
+
    + +

    StringTokenizer

    +This tokenizer is based on java.util.StringTokenizer. +It splits up the input into strings separated by white space, or +by a specified list of delimiting characters. +If the stream starts with delimiter characters, the first +token will be the empty string (unless the delimsaretokens +attribute is used). + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    delimsThe delimiter characters. White space + is used if this is not set. (White space is defined + in this case by java.lang.Character.isWhitespace()). + No
    delimsaretokensIf this is true, + each delimiter character is returned as a token. + Default is false. + No
    suppressdelims + If this is true, delimiters are not returned. + Default is false. + No
    includeDelims + Include the delimiters in the token. + Default is false. + No
    + +

    Examples:

    + +Surround each non space token with a "[]". + +
    +<tokenfilter>
+    <stringtokenizer/>
+    <replaceregex pattern="(.+)" replace="[\1]"/>
+</tokenfilter>
+
+
    + +

    ReplaceString

    +This is a simple filter to replace strings. +This filter may be used directly within a filterchain. + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fromThe string that must be replaced.Yes
    toThe new value for the replaced string. When omitted + an empty string is used. + No
    + +

    Examples:

    + +Replace "sun" with "moon". + +
    +<tokenfilter>
+    <replacestring from="sun" to="moon"/>
+</tokenfilter>
+
    + +

    ContainsString

    +This is a simple filter to filter tokens that contains +a specified string. + + + + + + + + + + + + +
    AttributeDescriptionRequired
    containsThe string that the token must contain.Yes
    + +

    Examples:

    + +Include only lines that contain "foo"; + +
    +<tokenfilter>
+    <containsstring contains="foo"/>
+</tokenfilter>
+
+
    + +

    ReplaceRegex

    +This string filter replaces regular expressions. +This filter may be used directly within a filterchain. +

    + See Regexp Type +concerning the choice of the implementation. +

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    patternThe regular expression pattern to match in + the token.Yes
    replaceThe substitution pattern to replace the matched + regular expression. When omitted an empty string is used.No
    flagsSee +ReplaceRegexp +for an explanation of regex flags.No
    +

    Examples:

    + +Replace all occurrences of "hello" with "world", ignoring case. + +
    +<tokenfilter>
+    <replaceregex pattern="hello" replace="world" flags="gi"/>
+</tokenfilter>
+
+
    + +

    ContainsRegex

    +This filters strings that match regular expressions. +The filter may optionally replace the matched regular expression. +This filter may be used directly within a filterchain. +

    +See +Regexp Type +concerning the choice of regular expression implementation. +

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    patternThe regular expression pattern to match in + the token.Yes
    replaceThe substitution pattern to replace the matched + regular expression. When omitted the orignal token is returned. + No
    flagsSee +ReplaceRegexp +for an explanation of regex flags.No
    + +

    Examples:

    + +Filter lines that contain "hello" or "world", ignoring case. + +
    +<tokenfilter>
+    <containsregex pattern="(hello|world)" flags="i"/>
+</tokenfilter>
+
+
    + +This example replaces lines like "SUITE(TestSuite, bits);" with +"void register_bits();" and removes other lines. + +
    +<tokenfilter>
+    <containsregex
+        pattern="^ *SUITE\(.*,\s*(.*)\s*\).*"
+        replace="void register_\1();"/>
+</tokenfilter>
+
    + +

    Trim

    +This filter trims whitespace from the start and end of +tokens. +This filter may be used directly within a filterchain. +

    IgnoreBlank

    +This filter removes empty tokens. +This filter may be used directly within a filterchain. +

    DeleteCharacters

    +This filter deletes specified characters from tokens. + + + + + + + + + + + + +
    AttributeDescriptionRequired
    charsThe characters to delete. This attribute + is backslash enabled.Yes
    + +

    Examples:

    + +Delete tabs from lines, trim the lines and removes empty lines. + +
    +<tokenfilter>
+    <deletecharacters chars="\t"/>
+    <trim/>
+    <ignoreblank/>
+</tokenfilter>
+
+
    + +

    UniqFilter

    + +

    Suppresses all tokens that match their ancestor token. It is most + useful if combined with a sort filter.

    + +

    This filter may be used directly within a filterchain.

    + +

    Example:

    + +This suppresses duplicate lines. +
    +<tokenfilter>
+  <uniqfilter/>
+</tokenfilter>
+
    + +

    ScriptFilter

    +This is an optional filter that executes a script in a +Apache BSF + or + JSR 223 +supported language.

    +See the Script task for +an explanation of scripts and dependencies. +

    +

    +The script is provided with an object self that has +getToken() and setToken(String) methods. +The getToken() method returns the current token. The setToken(String) +method replaces the current token. +

    + +This filter may be used directly within a filterchain.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    language The programming language the script is written in. +Must be a supported Apache BSF or JSR 223 languageYes
    manager + The script engine manager to use. + See the script task + for using this attribute. + No - default is "auto"
    srcThe location of the script as a file, if not inline + No
    setbeanswhether to have all properties, references and targets as + global variables in the script. since Ant 1.8.0No, default is "true".
    classpath + The classpath to pass into the script. + No
    classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + No
    +

    + This filter can take a nested <classpath> element. + See the script task + on how to use this element. +

    +

    Examples:

    + +Convert to uppercase: +
    +<tokenfilter>
+    <scriptfilter language="javascript">
+        self.setToken(self.getToken().toUpperCase());
+    </scriptfilter>
+</tokenfilter>
+
    + +Remove lines containing the string "bad" while +copying text files: +
    + 
    +<copy todir="dist">
+  <fileset dir="src" includes="**/*.txt"/>
+  <filterchain>
+    <scriptfilter language="beanshell">
+        if (self.getToken().indexOf("bad") != -1) {
+            self.setToken(null);
+        }
+    </scriptfilter>
+  </filterchain>
+</copy>
+
    +
    + +

    Custom tokenizers and string filters

    + +Custom string filters and tokenizers may be plugged in by +extending the interfaces org.apache.tools.ant.filters.TokenFilter.Filter +and org.apache.tools.ant.util.Tokenizer respectly. + +They are defined the build file using <typedef/>. For +example a string filter that capitalizes words may be declared as: +
    +package my.customant;
+import org.apache.tools.ant.filters.TokenFilter;
+
+public class Capitalize
+    implements TokenFilter.Filter
+{
+    public String filter(String token) {
+        if (token.length() == 0)
+            return token;
+        return token.substring(0, 1).toUpperCase() +
+                token.substring(1);
+   }
+}
+
    + +This may be used as follows: +
    +  <typedef name="capitalize" classname="my.customant.Capitalize"
+           classpath="my.customant.path"/>
+  <copy file="input" tofile="output">
+    <filterchain>
+      <tokenfilter>
+        <stringtokenizer/>
+        <capitalize/>
+      </tokenfilter>
+    </filterchain>
+  </copy>
+
    + + +

    SortFilter

    +

    since Ant 1.8.0

    + +

    The sort filter reads all lines and sorts them. The sort order can + be reversed and it is possible to specify a custom implementation of + the java.util.Comparator interface to get even more + control.

    + + + + + + + + + + + + + + + + + +
    Parameter NameParameter ValueRequired
    reversewhether to reverse the sort order, + defaults to false. Note: this parameter is ignored if + the comparator parameter is present as well.No
    comparatorClass name of a class that + implements java.util.Comparator for Strings. This + class will be used to determine the sort order of lines.No
    + +

    This filter is also available using the + name sortfilter. The reverse parameter + becomes an attribute, comparator can be specified by + using a nested element.

    + +

    Examples:

    + +
    +  <copy todir="build">
+      <fileset dir="input" includes="*.txt"/>
+      <filterchain>
+          <sortfilter/>
+      </filterchain>
+  </copy>
+
    + +

    +Sort all files *.txt from src location +into build location. The lines of each file are sorted in +ascendant order comparing the lines via the +String.compareTo(Object o) method. +

    + +
    +  <copy todir="build">
+      <fileset dir="input" includes="*.txt"/>
+      <filterchain>
+          <sortfilter reverse="true"/>
+      </filterchain>
+  </copy>
+
    + +

    +Sort all files *.txt from src location into reverse +order and copy them into build location. +

    + +
    +  <copy todir="build">
+      <fileset dir="input" includes="*.txt"/>
+      <filterchain>
+          <filterreader classname="org.apache.tools.ant.filters.SortFilter">
+            <param name="comparator" value="org.apache.tools.ant.filters.EvenFirstCmp"/>
+          </filterreader>
+      </filterchain>
+  </copy>
+
    + +

    +Sort all files *.txt from src location using as +sorting criterium EvenFirstCmp class, that sorts the file +lines putting even lines first then odd lines for example. The modified files +are copied into build location. The EventFirstCmp, +has to an instanciable class via Class.newInstance(), +therefore in case of inner class has to be static. It also has to +implement java.util.Comparator interface, for example: +

    + +
    +        package org.apache.tools.ant.filters;
+        ...(omitted)
+          public final class EvenFirstCmp implements <b>Comparator</b> {
+            public int compare(Object o1, Object o2) {
+            ...(omitted)
+            }
+          }
+
    + +

    The example above is equivalent to:

    + +
    +  <componentdef name="evenfirst"
+                classname="org.apache.tools.ant.filters.EvenFirstCmp"/>
+  <copy todir="build">
+      <fileset dir="input" includes="*.txt"/>
+      <filterchain>
+          <sortfilter>
+              <evenfirst/>
+          </sortfilter>
+      </filterchain>
+  </copy>
+
    + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/filterset.html b/tools/apache-ant-1.8.2/docs/manual/Types/filterset.html new file mode 100644 index 000000000..0ac198991 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/filterset.html @@ -0,0 +1,184 @@ + + + + + + +FilterSet Type + + + +

    FilterSet

    + +

    FilterSets are groups of filters. Filters can be defined as token-value +pairs +or be read in from a file. FilterSets can appear inside tasks that support this +feature or at the same level as <target> - i.e., as +children of +<project>.

    + +

    FilterSets support the id and refid +attributes. You can define a FilterSet with an id +attribute and then refer to that definition from another FilterSet +with a refid attribute. It is also possible to nest +filtersets into filtersets to get a set union of the contained +filters.

    + +

    In addition, FilterSets can specify +begintoken and/or +endtoken attributes to define what to match.

    +

    Filtersets are used for doing +replacements in tasks such as <copy>, etc.

    + +

    If you specify multiple values for the same token, the last one + defined within a filterset will be used.

    + +

    +Note: When a filterset is used in an operation, the files are +processed in text mode and the filters applied line by line. This means that +the copy operations will typically corrupt binary files. When applying filters +you should ensure that the set of files being filtered are all text files. +

    + +

    Filterset

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionDefaultRequired
    begintokenThe string marking the beginning of a token (eg., + @DATE@).@No
    endtokenThe string marking the end of a token (eg., + @DATE@).@No
    filtersfileSpecify a single filtersfile.noneNo
    recurseIndicates whether the replacement text of tokens + should be searched for more tokens. Since Ant 1.6.3trueNo
    onmissingfiltersfileIndicate behavior when a nonexistent filtersfile + is specified. One of "fail", "warn", "ignore". Since Ant 1.7"fail"No
    + +

    Filter

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    tokenThe token to replace (eg., @DATE@)Yes
    valueThe value to replace it with + (eg., Thursday, April 26, 2001).Yes
    + +

    Filtersfile

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileA properties file of + name-value pairs from which to load the tokens.Yes
    + +

    Examples

    + +

    You are copying the version.txt file to the dist +directory from the build directory +but wish to replace the token @DATE@ with today's date.

    +
    +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
+  <filterset>
+    <filter token="DATE" value="${TODAY}"/>
+  </filterset>
+</copy>
+
    + +

    You are copying the version.txt file to the dist +directory from the build directory +but wish to replace the token %DATE* with today's date.

    +
    +<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
+  <filterset begintoken="%" endtoken="*">
+    <filter token="DATE" value="${TODAY}"/>
+  </filterset>
+</copy>
+
    + +

    Copy all the docs but change all dates and appropriate notices as stored in a file.

    +
    +<copy toDir="${dist.dir}/docs">
+  <fileset dir="${build.dir}/docs">
+    <include name="**/*.html">
+  </fileset>
+  <filterset begintoken="%" endtoken="*">
+    <filtersfile file="${user.dir}/dist.properties"/>
+  </filterset>
+</copy>
+
    + +

    Define a FilterSet and reference it later.

    +
    +<filterset id="myFilterSet" begintoken="%" endtoken="*">
+  <filter token="DATE" value="${TODAY}"/>
+</filterset>
+
+<copy file="${build.dir}/version.txt" toFile="${dist.dir}/version.txt">
+  <filterset refid="myFilterSet"/>
+</copy>
+
    + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/mapper.html b/tools/apache-ant-1.8.2/docs/manual/Types/mapper.html new file mode 100644 index 000000000..7a71feea3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/mapper.html @@ -0,0 +1,972 @@ + + + + + + +Mapper Type + + + + +

    Mapping File Names

    +

    Some tasks take source files and create target files. Depending on +the task, it may be quite obvious which name a target file will have +(using javac, you know there will be +.class files for your .java files) - in +other cases you may want to specify the target files, either to help +Apache Ant or to get an extra bit of functionality.

    +

    While source files are usually specified as filesets, you don't specify target files directly - +instead, you tell Ant how to find the target file(s) for one source file. An +instance of org.apache.tools.ant.util.FileNameMapper is +responsible for this. It constructs target file names based on rules +that can be parameterized with from and to +attributes - the exact meaning of which is implementation-dependent.

    +

    These instances are defined in <mapper> elements +with the following attributes:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    typespecifies one of the built-in implementations.Exactly one of these
    classnamespecifies the implementation by class name.
    classpaththe classpath to use when looking up + classname.No
    classpathrefthe classpath to use, given as reference to a path defined elsewhere.No
    fromthe from attribute for the given + implementation.Depends on implementation.
    tothe to attribute for the given + implementation.Depends on implementation.
    +

    Note that Ant will not automatically convert / or \ characters in +the to and from attributes to the correct +directory separator of your current platform. If you need to specify +this separator, use ${file.separator} instead. + For the regexpmapper, ${file.separator} will not work, +as on windows it is the '\' character, and this is an escape character +for regular expressions, one should use the handledirsep attribute +instead. +

    +

    Parameters specified as nested elements

    +

    The classpath can be specified via a nested +<classpath>, as well - that is, +a path-like structure.

    +

    Since Ant 1.7.0, nested File Mappers can +be supplied via either <mapper> elements or +<typedef>'d +implementations of org.apache.tools.ant.util.FileNameMapper. +If nested File Mappers are specified by either means, the mapper will be +implicitly configured as a composite mapper. +

    +
    +

    The built-in mapper types are:

    +

    All built-in mappers are case-sensitive.

    +

    As of Ant 1.7.0, each of the built-in mapper implementation + types is directly accessible using a specific tagname. This makes it + possible for filename mappers to support attributes in addition to + the generally available to and from.
    + The <mapper type|classname="..."> usage + form remains valid for reasons of backward compatibility.

    + + + + + +

    identity

    +

    The target file name is identical to the source file name. Both +to and from will be ignored.

    +Examples: +
    +<mapper type="identity"/>
+<identitymapper/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaA.java
    foo/bar/B.javafoo/bar/B.java
    C.propertiesC.properties
    Classes/dir/dir2/A.propertiesClasses/dir/dir2/A.properties
    + + + + + +

    flatten

    +

    The target file name is identical to the source file name, with all +leading directory information stripped off. Both to and +from will be ignored.

    +Examples: +
    +<mapper type="flatten"/>
+<flattenmapper/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaA.java
    foo/bar/B.javaB.java
    C.propertiesC.properties
    Classes/dir/dir2/A.propertiesA.properties
    + + + + + +

    merge

    +

    The target file name will always be the same, as defined by +to - from will be ignored.

    +
    Examples:
    +
    +<mapper type="merge" to="archive.tar"/>
+<mergemapper to="archive.tar"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaarchive.tar
    foo/bar/B.javaarchive.tar
    C.propertiesarchive.tar
    Classes/dir/dir2/A.propertiesarchive.tar
    + + + + + +

    glob

    +

    Both to and from are required and define patterns that may +contain at most one *. For each source file that matches +the from pattern, a target file name will be constructed +from the to pattern by substituting the * in +the to pattern with the text that matches the +* in the from pattern. Source file names +that don't match the from pattern will be ignored.

    +Examples: +
    +<mapper type="glob" from="*.java" to="*.java.bak"/>
+<globmapper from="*.java" to="*.java.bak"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaA.java.bak
    foo/bar/B.javafoo/bar/B.java.bak
    C.propertiesignored
    Classes/dir/dir2/A.propertiesignored
    +
    +<mapper type="glob" from="C*ies" to="Q*y"/>
+<globmapper from="C*ies" to="Q*y"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaignored
    foo/bar/B.javaignored
    C.propertiesQ.property
    Classes/dir/dir2/A.propertiesQlasses/dir/dir2/A.property
    +

    + The globmapper mapper can take the following extra attributes. +

    + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    casesensitive + If this is false, the mapper will ignore case when matching the glob pattern. + This attribute can be true or false, the default is true. + Since Ant 1.6.3. + No
    handledirsep + If this is specified, the mapper will ignore the difference between the normal + directory separator characters - \ and /. + This attribute can be true or false, the default is false. + This attribute is useful for cross-platform build files. + Since Ant 1.6.3. + No
    +

    + An example: +

    + 
    +      <pathconvert property="x" targetos="unix">
+        <path path="Aj.Java"/>
+        <mapper>
+        <chainedmapper>
+          <flattenmapper/>
+          <globmapper from="a*.java" to="*.java.bak" casesensitive="no"/>
+        </chainedmapper>
+        </mapper>
+      </pathconvert>
+      <echo>x is ${x}</echo>
+
    +

    + will output "x is j.java.bak". +

    +

    + and +

    + 
    +      <pathconvert property="x" targetos="unix">
+        <path path="d/e/f/j.java"/>
+        <mapper>
+          <globmapper from="${basedir}\d/e\*" to="*" ignoredirchar="yes"/>
+        </mapper>
+      </pathconvert>
+      <echo>x is ${x}</echo>
+
    +

    + will output "x is f/j.java". +

    + + + + + + +

    regexp

    + +

    Both to and from are required and define +regular expressions. If the source file name (as a whole or in part) +matches the from pattern, the target file name will be +constructed from the +to pattern, using \0 to \9 as +back-references for the full match (\0) or the matches of +the subexpressions in parentheses. The to pattern +determines the whole file name, so if you wanted to +replace the extension of a file you should not use from="\.old$" +to=".new" but rather from="(.*)\.old$" to="\1.new" +(or rather use a glob mapper in this case).

    + +

    Source files not matching the from pattern will be +ignored.

    + +

    Note that you need to escape a dollar-sign ($) with +another dollar-sign in Ant.

    + +

    The regexp mapper needs a supporting library and an implementation +of org.apache.tools.ant.util.regexp.RegexpMatcher that + hides the specifics of the library. Since Ant 1.8.0 Ant + requires Java 1.4 to run, so the implementation based on + the java.util.regex package will always be available. + You can still use Jakarta ORO or Jakarta Regex instead if your + provide the corresponding jar in your CLASSPATH.

    + +

    For information about using gnu.regexp or gnu.rex with Ant, see this +article.

    + +

    If you want to use one of the regular expression + libraries other than java.util.regex you need to also use + the corresponding ant-[apache-oro, apache-regexp].jar +from the Ant release you are using. +Make sure, both will be loaded from the same +classpath, that is either put them into your CLASSPATH, +ANT_HOME/lib directory or a nested +<classpath> element of the mapper - you cannot have +ant-[apache-oro, apache-regexp].jar in ANT_HOME/lib + and the library +in a nested <classpath>.

    +

    Ant will choose the regular-expression library based on the +following algorithm:

    +
      +
    • If the system property +ant.regexp.matcherimpl has been set, it is taken as the +name of the class implementing +org.apache.tools.ant.util.regexp.RegexpMatcher that +should be used.
      • +
    • If it has not been set, uses the JDK 1.4 classes.
      • +
    + +Examples: +
    +<mapper type="regexp" from="^(.*)\.java$$" to="\1.java.bak"/>
+<regexpmapper from="^(.*)\.java$$" to="\1.java.bak"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaA.java.bak
    foo/bar/B.javafoo/bar/B.java.bak
    C.propertiesignored
    Classes/dir/dir2/A.propertiesignored
    +
    +<mapper type="regexp" from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/>
+<regexpmapper from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javaignored
    foo/bar/B.javafoo/bar/bar-B.java
    C.propertiesignored
    Classes/dir/dir2/A.propertiesClasses/dir/dir2/dir2-A.properties
    +
    +<mapper type="regexp" from="^(.*)\.(.*)$$" to="\2.\1"/>
+<regexpmapper from="^(.*)\.(.*)$$&" to="\2.\1"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    A.javajava.A
    foo/bar/B.javajava.foo/bar/B
    C.propertiesproperties.C
    Classes/dir/dir2/A.propertiesproperties.Classes/dir/dir2/A
    +
    +<mapper type="regexp" from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/>
+<regexpmapper from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/>
+
    + + + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file name
    ClassLoader.classClassLoader.java
    java/lang/ClassLoader.classjava/lang/ClassLoader.java
    java\lang\ClassLoader$1.classjava\lang\ClassLoader.java
    java/lang/ClassLoader$foo$1.classjava/lang/ClassLoader.java
    +

    + The regexpmapper mapper can take the following extra attributes. +

    + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    casesensitive + If this is false, the mapper will ignore case when matching the pattern. + This attribute can be true or false, the default is true. + Since Ant 1.6.3. + No
    handledirsep + If this is specified, the mapper will treat a \ character in a filename + as a / for the purposes of matching. + This attribute can be true or false, the default is false. + This attribute is useful for cross-platform build files. + Since Ant 1.6.3. + No
    +

    + An example: +

    + 
    +      <pathconvert property="x" targetos="unix">
+        <path path="Aj.Java"/>
+        <chainedmapper>
+          <flattenmapper/>
+          <regexpmapper from="a(.*)\.java" to="\1.java.bak" casesensitive="no"/>
+        </chainedmapper>
+      </pathconvert>
+      <echo>x is ${x}</echo>
+
    +

    + will output "x is j.java.bak". +

    +

    + and +

    + 
    +    <pathconvert property="hd.prop" targetos="windows">
+      <path path="d\e/f\j.java"/>
+      <chainedmapper>
+        <regexpmapper from="${basedir}/d/e/(.*)" to="\1" handledirsep="yes"/>
+      </chainedmapper>
+    </pathconvert>
+
    +

    + will set hd.prop to "f\j.java". +

    + + + + + +

    package

    +

    Sharing the same syntax as the glob mapper, +the package mapper replaces +directory separators found in the matched source pattern with dots in the target +pattern placeholder. This mapper is particularly useful in combination +with <uptodate> and <junit> output.

    +

    The to and from attributes are both required.

    +Example: +
    +<mapper type="package" from="*Test.java" to="TEST-*Test.xml"/>
+<packagemapper from="*Test.java" to="TEST-*Test.xml"/>
+
    + + + + + + + + + + + + + +
    Source file nameTarget file name
    org/apache/tools/ant/util/PackageMapperTest.javaTEST-org.apache.tools.ant.util.PackageMapperTest.xml
    org/apache/tools/ant/util/Helper.javaignored
    + + + + + +

    unpackage (since Ant 1.6.0)

    +

    This mapper is the inverse of the package mapper. + It replaces the dots in a package name with directory separators. This + is useful for matching XML formatter results against their JUnit test + test cases. The mapper shares the sample syntax + as the glob mapper. +

    +

    The to and from attributes are both required.

    +Example: +
    +<mapper type="unpackage" from="TEST-*Test.xml" to="${test.src.dir}/*Test.java">
+<unpackagemapper from="TEST-*Test.xml" to="${test.src.dir}/*Test.java">
+
    + + + + + + + + + +
    Source file nameTarget file name
    TEST-org.acme.AcmeTest.xml${test.src.dir}/org/acme/AcmeTest.java
    + + + + + +

    composite (since Ant 1.7.0)

    +

    This mapper implementation can contain multiple nested mappers. + File mapping is performed by passing the source filename to each nested + <mapper> in turn, returning all results. + The to and from attributes are ignored.

    +

    Starting with Ant 1.8.0 the order of the mapped results is the + same as the order of the nested mappers; prior to Ant 1.8.0 the + order has been undefined.

    +Examples: +
    +<compositemapper>
+  <identitymapper/>
+  <packagemapper from="*.java" to="*"/>
+</compositemapper>
+
    + + + + + + + + + + + + +
    Source file nameTarget file names
    foo/bar/A.javafoo/bar/A.java
    foo.bar.A
    +

    The composite mapper has no corresponding + <mapper type> attribute. +

    + + + + + +

    chained (since Ant 1.7.0)

    +

    This mapper implementation can contain multiple nested mappers. + File mapping is performed by passing the source filename to the first + nested mapper, its results to the second, and so on. The target filenames + generated by the last nested mapper comprise the ultimate results of the + mapping operation. The to and from attributes are ignored.

    +Examples: +
    +<chainedmapper>
+  <flattenmapper/>
+  <globmapper from="*" to="new/path/*"/>
+  <mapper>
+    <globmapper from="*" to="*1"/>
+    <globmapper from="*" to="*2"/>
+  </mapper>
+</chainedmapper>
+
    + + + + + + + + + + + + + + + + + + + +
    Source file nameTarget file names
    foo/bar/A.javanew/path/A.java1
    new/path/A.java2
    boo/far/B.javanew/path/B.java1
    new/path/B.java2
    +

    The chained mapper has no corresponding + <mapper type> attribute. +

    + + + + + +

    filtermapper (since Ant 1.6.3)

    +

    + This mapper implementation applies a filterchain + to the source file name. +

    +Examples: +
    +<filtermapper>
+  <replacestring from="\" to="/"/>
+</filtermapper>
+
    + + + + + + + + + + +
    Source file nameTarget file names
    foo\bar\A.javafoo/bar/A.java
    +
    +<filtermapper>
+  <scriptfilter language="beanshell">
+    self.setToken(self.getToken().toUpperCase());
+  </scriptfilter>
+</filtermapper>
+
    + + + + + + + + + + +
    Source file nameTarget file names
    foo\bar\A.javaFOO\BAR\A.JAVA
    + +

    The filtermapper has no corresponding + <mapper type> attribute. +

    + + + + + +

    scriptmapper (since Ant 1.7)

    +

    +This mapper executes a script written in Apache BSF +or + JSR 223 +supported language, once per file to map.

    +The script can be declared inline or in a specified file. +

    +

    +See the Script task for +an explanation of scripts and dependencies. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    language + Scripting language + Yes
    manager + The script engine manager to use. + See the script task + for using this attribute. + No - default is "auto"
    src + File containing the script + No
    setbeanswhether to have all properties, references and targets as + global variables in the script. since Ant 1.8.0No, default is "true".
    classpath + The classpath to pass into the script. + No
    classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + No
    +

    + This filename mapper can take a nested <classpath> element. + See the script task + on how to use this element. +

    + +

    + Example: +

    +
    +<scriptmapper language="javascript">
+  self.addMappedName(source.toUpperCase());
+  self.addMappedName(source.toLowerCase());
+</scriptmapper>
+
    + + + + + + + + + + + + + +
    Source file nameTarget file names
    foo\bar\A.javaFOO\BAR\A.JAVA
    foo\bar\a.java
    + +

    +To use this mapper, the scripts need access to the source file, +and the ability to return multiple mappings. Here are the relevant beans and +their methods. The script is called once for every source file, with the +list of mapped names reset after every invocation. + + + + + + + + + + + + + + + + + + + + + + +
    Script beanDescription
    source: String + The file/path to map +
    self + the scriptmapper itself +
    self.addMappedName(String name) + Add a new mapping +
    self.clear() + Reset the list of files. +
    + +

    The scriptmapper has no corresponding + <mapper type> attribute. +

    + +

    firstmatchmapper (since Ant 1.8.0)

    +

    + This mapper supports an arbitrary number of nested mappers and + returns the results of the first mapper that matches. This is + different from composite mapper + which collects the results of all matching children.

    +Examples: +
    +<firstmatchmapper>
+  <globmapper from="*.txt" to="*.bak"/>
+  <globmapper from="*A.*" to="*B.*"/>
+</firstmatchmapper>
+
    + + + + + + + + + + + + + + +
    Source file nameTarget file names
    foo/bar/A.txtfoo/bar/A.bak
    foo/bar/A.javafoo/bar/B.java
    + +

    The firstmatchmapper has no corresponding + <mapper type> attribute. +

    + +

    cutdirsmapper (since Ant 1.8.2)

    + +

    This mapper strips a configured number of leading directories from + the source file name.

    + +Examples: +
    +<cutdirsmapper dirs="1"/>
+
    + + + + + + + + + + +
    Source file nameTarget file names
    foo/bar/A.txtbar/A.txt
    + +

    The cutdirsmapper has no +corresponding <mapper type> attribute.

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    dirs + Number of directories to strip (must be a positive number). + Yes
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/namespace.html b/tools/apache-ant-1.8.2/docs/manual/Types/namespace.html new file mode 100644 index 000000000..07b7d3c0f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/namespace.html @@ -0,0 +1,220 @@ + + + +XmlNamespaceSupport + +

    XML Namespace Support

    + Apache Ant 1.6 introduces support for XML namespaces. +

    History

    + +

    + All releases of Ant prior to Ant 1.6 do not support XML namespaces. + No support basically implies two things here: +

    +
      +
    • Element names correspond to the "qname" of the tags, which is + usually the same as the local name. But if the build file writer uses + colons in names of defined tasks/types, those become part of the + element name. Turning on namespace support gives colon-separated + prefixes in tag names a special meaning, and thus build files using + colons in user-defined tasks and types will break. +
      • +
    • Attributes with the names 'xmlns' and 'xmlns:<prefix>' + are not treated specially, which means that custom tasks and types have + actually been able to use such attributes as parameter names. Again, + such tasks/types are going to break when namespace support is enabled + on the parser. +
      • +
    +

    Use of colons in element names has been discouraged in the past, + and using any attribute starting with "xml" is actually strongly + discouraged by the XML spec to reserve such names for future use. +

    +

    Motivation

    + +

    In build files using a lot of custom and third-party tasks, it is + easy to get into name conflicts. When individual types are defined, the + build file writer can do some namespacing manually (for example, using + "tomcat-deploy" instead of just "deploy"). But when defining whole + libraries of types using the <typedef> 'resource' attribute, the + build file writer has no chance to override or even prefix the names + supplied by the library.

    +

    Assigning Namespaces

    + +

    + Adding a 'prefix' attribute to <typedef> might have been enough, + but XML already has a well-known method for namespacing. Thus, instead + of adding a 'prefix' attribute, the <typedef> and <taskdef> + tasks get a 'uri' attribute, which stores the URI of the XML namespace + with which the type should be associated: + 

     <typedef resource="org/example/tasks.properties" uri="http://example.org/tasks"/>
+ <my:task xmlns:my="http://example.org/tasks">
+    ...
+ </my:task>
+
    +

    As the above example demonstrates, the namespace URI needs to be + specified at least twice: one time as the value of the 'uri' attribute, + and another time to actually map the namespace to occurrences of + elements from that namespace, by using the 'xmlns' attribute. This + mapping can happen at any level in the build file: + 

     <project name="test" xmlns:my="http://example.org/tasks"> 
+   <typedef resource="org/example/tasks.properties" uri="http://example.org/tasks"/>
+   <my:task>
+     ...
+   </my:task>
+ </project>
+
    +

    + Use of a namespace prefix is of course optional. Therefore + the example could also look like this: + 

     <project name="test"> 
+   <typedef resource="org/example/tasks.properties" uri="http://example.org/tasks"/>
+   <task xmlns="http://example.org/tasks">
+     ...
+   </task>
+ </project>
+
    +

    + Here, the namespace is set as the default namespace for the <task> + element and all its descendants. +

    +

    Default namespace

    +

    + The default namespace used by Ant is "antlib:org.apache.tools.ant". +

    + 
    +<typedef resource="org/example/tasks.properties" uri="antlib:org.apache.tools.ant"/>
+<task>
+      ....
+</task>
+
    + + + +

    Namespaces and Nested Elements

    + +

    + Almost always in Ant 1.6, elements nested inside a namespaced + element have the same namespace as their parent. So if 'task' in the + example above allowed a nested 'config' element, the build file snippet + would look like this: + 

     <typedef resource="org/example/tasks.properties" uri="http://example.org/tasks"/>
+ <my:task xmlns:my="http://example.org/tasks">
+   <my:config a="foo" b="bar"/>
+   ...
+ </my:task>
+
    +

    If the element allows or requires a lot of nested elements, the + prefix needs to be used for every nested element. Making the namespace + the default can reduce the verbosity of the script: + 

     <typedef resource="org/example/tasks.properties" uri="http://example.org/tasks"/>
+          <task xmlns="http://example.org/tasks">
+          <config a="foo" b="bar"/>
+   ...
+          </task>
+
    +

    + From Ant 1.6.2, elements nested inside a namespaced element may also be + in Ant's default namespace. This means that the following is now allowed: +

    + 

     <typedef resource="org/example/tasks.properties"
+   uri="http://example.org/tasks"/>
+ <my:task xmlns:my="http://example.org/tasks">
+   <config a="foo" b="bar"/>
+   ...
+ </my:task>
+
    + +

    Namespaces and Attributes

    + +

    + Attributes are only used to configure the element they belong to if: +

    +
      +
    • they have no namespace (note that the default namespace does *not* apply to attributes) +
      • +
    • they are in the same namespace as the element they belong to +
      • +
    +

    + Other attributes are simply ignored. +

    +

    + This means that both: +

    +

    + 

     <my:task xmlns:my="http://example.org/tasks">
+   <my:config a="foo" b="bar"/>
+   ...
+ </my:task>
+
    +

    + and +

    + 
     <my:task xmlns:my="http://example.org/tasks">
+   <my:config my:a="foo" my:b="bar"/>
+   ...
+ </my:task>
+
    +

    + result in the parameters "a" and "b" being used as parameters to configure the nested "config" element. +

    +

    It also means that you can use attributes from other namespaces + to markup the build file with extra metadata, such as RDF and + XML-Schema (whether that's a good thing or not). The same is not true + for elements from unknown namespaces, which result in a error. +

    +

    Mixing Elements from Different Namespaces

    + +

    Now comes the difficult part: elements from different namespaces can + be woven together under certain circumstances. This has a lot to do + with the Ant 1.6 + add type introspection rules: + Ant types and tasks are now free to accept arbritrary named types as + nested elements, as long as the concrete type implements the interface + expected by the task/type. The most obvious example for this is the + <condition> task, which supports various nested conditions, all + of which extend the interface Condition. To integrate a + custom condition in Ant, you can now simply <typedef> the + condition, and then use it anywhere nested conditions are allowed + (assuming the containing element has a generic add(Condition) or addConfigured(Condition) method): +

     <typedef resource="org/example/conditions.properties" uri="http://example.org/conditions"/>
+ <condition property="prop" xmlns="http://example.org/conditions">
+   <and>
+     <available file="bla.txt"/>
+     <my:condition a="foo"/>
+   </and>
+ </condition>
+
    +

    + In Ant 1.6, this feature cannot be used as much as we'd all like to: a + lot of code has not yet been adapted to the new introspection rules, + and elements like Ant's built-in conditions and selectors are not + really types in 1.6. This is expected to change in Ant 1.7. +

    +

    Namespaces and Antlib

    + +

    + The new AntLib + feature is also very much integrated with the namespace support in Ant + 1.6. Basically, you can "import" Antlibs simply by using a special + scheme for the namespace URI: the antlib scheme, which expects the package name in which a special antlib.xml file is located. +

    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/patternset.html b/tools/apache-ant-1.8.2/docs/manual/Types/patternset.html new file mode 100644 index 000000000..3ece3ec5c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/patternset.html @@ -0,0 +1,189 @@ + + + + + + +PatternSet Type + + + + +

    PatternSet

    +

    Patterns can be grouped to +sets and later be referenced by their id attribute. They +are defined via a patternset element, which can appear +nested into a FileSet or a directory-based +task that constitutes an implicit FileSet. In addition, +patternsets can be defined as a stand alone element at +the same level as target — i.e., as children of +project as well as as children of +target.

    Patterns can be specified by nested +<include>, or <exclude> elements +or the following attributes.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescription
    includescomma- or space-separated list of patterns of files that must be + included. All files are included when omitted.
    includesfilethe name of a file; each line of this file is + taken to be an include pattern. You can specify more than one + include file by using a nested includesfile elements.
    excludescomma- or space-separated list of patterns of files that must be + excluded; no files (except default excludes) are excluded when omitted.
    excludesfilethe name of a file; each line of this file is + taken to be an exclude pattern. You can specify more than one + exclude file by using a nested excludesfile elements.
    +

    Parameters specified as nested elements

    +

    include and exclude

    +

    Each such element defines a single pattern for files to include or +exclude.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe pattern + to in/exclude.Yes
    ifOnly use this pattern if the named property is set.No
    unlessOnly use this pattern if the named property is + not set.No
    +

    includesfile and excludesfile

    +

    If you want to list the files to include or exclude external to +your build file, you should use the includesfile/excludesfile +attributes or elements. Using the attribute, you can only specify a +single file of each type, while the nested elements can be specified +more than once - the nested elements also support if/unless attributes +you can use to test the existance of a property.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    namethe name of the file holding the patterns to + in/exclude.Yes
    ifOnly read this file if the named property is set.No
    unlessOnly read this file if the named property is + not set.No
    +

    patternset

    +

    Patternsets may be nested within one another, adding the nested +patterns to the parent patternset.

    +

    invert

    +

    A nested patternset can be inverted using the <invert> +element. Since Apache Ant 1.7.1

    +

    Examples

    +
    +<patternset id="non.test.sources">
+  <include name="**/*.java"/>
+  <exclude name="**/*Test*"/>
+</patternset>
+
    +

    Builds a set of patterns that matches all .java files +that do not contain the text Test in their name. This set +can be referred to via +<patternset refid="non.test.sources"/>, +by tasks that support this feature, or by FileSets.

    +

    Note that while the includes and +excludes attributes accept +multiple elements separated by commas or spaces, the nested +<include> and <exclude> elements expect their name +attribute to hold a single pattern.

    +

    The nested elements allow you to use if and unless arguments to +specify that the element should only be used if a property is set, or +that it should be used only if a property is not set.

    +

    For example

    +
    +<patternset id="sources">
+  <include name="std/**/*.java"/>
+  <include name="prof/**/*.java" if="professional"/>
+  <exclude name="**/*Test*"/>
+</patternset>
+
    +

    will only include the files in the sub-directory prof if the property +professional is set to some value.

    +

    The two sets

    +
    +<patternset includesfile="some-file"/>
+
    +

    and

    +
    +<patternset>
+  <includesfile name="some-file"/> 
+<patternset/>
+
    +

    are identical. The include patterns will be read from the file +some-file, one pattern per line.

    +
    +<patternset>
+  <includesfile name="some-file"/> 
+  <includesfile name="${some-other-file}" 
+                if="some-other-file"
+  /> 
+<patternset/>
+
    +

    will also read include patterns from the file the property +some-other-file points to, if a property of that name has +been defined.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/permissions.html b/tools/apache-ant-1.8.2/docs/manual/Types/permissions.html new file mode 100644 index 000000000..6e7f2649e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/permissions.html @@ -0,0 +1,164 @@ + + + + + + +Permissions type + + + + +

    Permissions

    +

    +Permissions represents a set of security permissions granted or revoked to +a specific part code executed in the JVM where Apache Ant is running in. +The actual Permissions are specified via a set of nested permission items either +<grant>ed or <revoke>d.

    +

    +In the base situation a base set of permissions granted. +Extra permissions can be +granted. A granted permission can be overruled by revoking a permission. +The security manager installed by the permissions will throw an +SecurityException if +the code subject to these permissions try to use an permission that has not been +granted or that has been revoked.

    +

    Nested elements

    +

    grant

    +

    +Indicates a specific permission is always granted. Its attributes indicate which +permissions are granted.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classThe fully qualified name of the Permission class.Yes
    nameThe name of the Permission. The actual contents depends on the + Permission class.No
    actionsThe actions allowed. The actual contents depend on the + Permission class and name.No
    +

    +Implied permissions are granted. +

    +

    +Please note that some Permission classes may actually need a name and / or actions in order to function properly. The name and actions are parsed by the actual +Permission class. +

    +

    revoke

    +

    +Indicates a specific permission is revoked.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classThe fully qualified name of the Permission class.Yes
    nameThe name of the Permission. The actual contents depends on the + Permission class.No
    actionsThe actions allowed. The actual contents depend on the + Permission class and name.No
    +

    +Implied permissions are not resolved and therefore also not revoked. +

    +

    +The name can handle the * wildcard at the end of the name, in which case all +permissions of the specified class of which the name starts with the specified name +(excluding the *) are revoked. Note that the - wildcard often supported by the +granted properties is not supported. +If the name is left empty all names match, and are revoked. +If the actions are left empty all actions match, and are revoked. +

    +

    Base set

    +A permissions set implictly contains the following permissions: +
    +<grant class="java.net.SocketPermission" name="localhost:1024-" actions="listen">
+<grant class="java.util.PropertyPermission" name="java.version" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vendor" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vendor.url" actions="read">
+<grant class="java.util.PropertyPermission" name="java.class.version" actions="read">
+<grant class="java.util.PropertyPermission" name="os.name" actions="read">
+<grant class="java.util.PropertyPermission" name="os.version" actions="read">
+<grant class="java.util.PropertyPermission" name="os.arch" actions="read">
+<grant class="java.util.PropertyPermission" name="file.encoding" actions="read">
+<grant class="java.util.PropertyPermission" name="file.separator" actions="read">
+<grant class="java.util.PropertyPermission" name="path.separator" actions="read">
+<grant class="java.util.PropertyPermission" name="line.separator" actions="read">
+<grant class="java.util.PropertyPermission" name="java.specification.version" actions="read">
+<grant class="java.util.PropertyPermission" name="java.specification.vendor" actions="read">
+<grant class="java.util.PropertyPermission" name="java.specification.name" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.specification.version" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.specification.vendor" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.specification.name" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.version" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.vendor" actions="read">
+<grant class="java.util.PropertyPermission" name="java.vm.name" actions="read">
+
    +These permissions can be revoked via <revoke> elements if necessary. + +

    Examples

    +
    +<permissions>
+  <grant class="java.security.AllPermission"/>
+  <revoke class="java.util.PropertyPermission"/>
+</permissions>
+
    +

    +Grants all permissions to the code except for those handling Properties. +

    +
    +<permissions>
+  <grant class="java.net.SocketPermission" name="foo.bar.com" action="connect"/>
+  <grant class="java.util.PropertyPermission" name="user.home" action="read,write"/>
+</permissions>
+
    +

    +Grants the base set of permissions with the addition of a SocketPermission to connect +to foo.bar.com and the permission to read and write the user.home system property. +

    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/propertyset.html b/tools/apache-ant-1.8.2/docs/manual/Types/propertyset.html new file mode 100644 index 000000000..94fcf44e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/propertyset.html @@ -0,0 +1,143 @@ + + + + + + +PropertySet Type + + + + +

    PropertySet

    +

    Since Apache Ant 1.6

    + +

    Groups a set of properties to be used by reference in a task that +supports this.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    dynamicWhether to reevaluate the set everytime the set + is used. Default is "true".No
    negateWhether to negate results. If + "true", all properties not + selected by nested elements will be returned. Default is + "false". Since Ant 1.6.2 + No
    +

    Parameters specified as nested elements

    + +

    propertyref

    + +

    Selects properties from the current project to be included in the +set.

    + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameSelect the property with the given name.Exactly one of these.
    prefixSelect the properties whose name starts with the + given string.
    regexSelect the properties that match the given + regular expression. Similar to regexp type mappers, this + requires a supported regular expression library.
    builtinSelects a builtin set of properties. Valid + values for this attribute are all for all Ant + properties, system for the system properties and + commandline for all properties specified on the + command line when invoking Ant (plus a number of special + internal Ant properties).
    + +

    propertyset

    + +

    A propertyset can be used as the set union of more +propertysets.

    + +

    For example:

    + +
    +<propertyset id="properties-starting-with-foo">
+  <propertyref prefix="foo"/>
+</propertyset>
+<propertyset id="properties-starting-with-bar">
+  <propertyref prefix="bar"/>
+</propertyset>
+<propertyset id="my-set">
+  <propertyset refid="properties-starting-with-foo"/>
+  <propertyset refid="properties-starting-with-bar"/>
+</propertyset>
+
    + +

    collects all properties whose name starts with either +"foo" or "bar" in the set named +"my-set".

    + +

    mapper

    + +

    A mapper - at maximum one mapper can be +specified. The mapper is used to change the names of the property +keys, for example: + +

    +<propertyset id="properties-starting-with-foo">
+  <propertyref prefix="foo"/>
+  <mapper type="glob" from="foo*" to="bar*"/>
+</propertyset>
+
    + +

    collects all properties whose name starts with "foo", but +changes the names to start with "bar" instead.

    + +

    If supplied, the nested mapper will be applied +subsequent to any negation of matched properties.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/redirector.html b/tools/apache-ant-1.8.2/docs/manual/Types/redirector.html new file mode 100644 index 000000000..e3191cd0d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/redirector.html @@ -0,0 +1,183 @@ + + + + + + +Redirector Type + + + + +

    I/O redirection

    +

    For many tasks, input and output can be defined in a fairly +straightforward fashion. The exec +task, used to execute an external process, stands as a very +basic example. The executed process may accept input, produce +output, or do either or both depending upon various circumstances. +Output may be classified as "output" or as "error +output." The <redirector> type provides a concrete means +of redirecting input and output featuring the use of +File Mappers to specify +source (input) and destination (output/error) files. Since Apache Ant 1.6.2 +

    The <redirector> element accepts the following attributes:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    outputName of a file to which output should be written. + If the error stream is not also redirected to a file or property, + it will appear in this output.No
    errorThe file to which the standard error of the + command should be redirected.No
    logErrorThis attribute is used when you wish to see + error output in Ant's log and you are redirecting output to + a file/property. The error output will not be included in + the output file/property. If you redirect error with the + error or errorProperty attributes, this will + have no effect.No
    appendWhether output and error files should be + appended to rather than overwritten. Defaults to + false.No
    createemptyfilesWhether output and error files should be + created even when empty. Defaults to true.No
    outputpropertyThe name of a property in which the output of the + command should be stored. Unless the error stream is redirected + to a separate file or stream, this property will include the + error output.No
    errorpropertyThe name of a property in which the standard error + of the command should be stored.No
    inputA file from which the executed command's standard input + is taken. This attribute is mutually exclusive with the + inputstring attribute.No
    inputstringA string which serves as the input stream for the + executed command. This attribute is mutually exclusive with the + input attribute.No
    inputencodingThe input encoding.No
    outputencodingThe output encoding.No
    errorencodingThe error encoding.No
    alwayslogAlways send to the log in addition to + any other destination. Since Ant 1.6.3. + No, default is false
    loginputstringControls the display of inputstring's value in + log messages. Set to false when sending sensitive data + (e.g. passwords) to external processes. Since Ant 1.6.3. + No, default is true
    +

    Parameters specified as nested elements

    +

    inputmapper

    +

    A single File Mapper used to redirect process +input. Multiple mapping results should concatenate all mapped files as input. +Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <inputmapper> is not compatible with either of the +input or inputstring attributes.

    +

    outputmapper

    +

    A single File Mapper used to redirect process +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <outputmapper> is not compatible with the +output attribute.

    +

    errormapper

    +

    A single File Mapper used to redirect error +output. Mapping will ordinarily be performed on a task-specified sourcefile; +consult the documentation of the individual task for more details. +A nested <errormapper> is not compatible with the +error attribute.

    +

    inputfilterchain

    +

    A FilterChain can be +applied to the process input.

    +

    outputfilterchain

    +

    A FilterChain can be +applied to the process output.

    +

    errorfilterchain

    +

    A FilterChain can be +applied to the error output.

    +

    Usage

    +Tasks known to support I/O redirection: + +

    The expected behavior of a <redirector> is to a great degree +dependent on the supporting task. Any possible points of confusion +should be noted at the task level.

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/regexp.html b/tools/apache-ant-1.8.2/docs/manual/Types/regexp.html new file mode 100644 index 000000000..f7880ad2e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/regexp.html @@ -0,0 +1,114 @@ + + + + + + +Regexp Type + + + + +

    Regexp

    +

    +Regexp represents a regular expression. +

    Parameters

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    patternregular expression patternYes
    + +

    Examples

    +
    +     <regexp id="myregexp" pattern="alpha(.+)beta"/>
    
+
    +

    +Defines a regular expression for later use with id myregexp. +

    +
    +     <regexp refid="myregexp"/>
    
+
    +

    +Use the regular expression with id myregexp. +

    +

    Choice of regular expression implementation

    +

    +Apache Ant comes with +wrappers for +the java.util.regex package, +jakarta-regexp +and jakarta-ORO, +See installation dependencies + concerning the supporting libraries.

    +

    +The property ant.regexp.regexpimpl governs which regular expression implementation will be chosen. +Possible values for this property are : +

      +
    • +org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp +
      • +
    • +org.apache.tools.ant.util.regexp.JakartaOroRegexp +
      • +
    • +org.apache.tools.ant.util.regexp.JakartaRegexpRegexp +
      • +
    +It can also be another implementation of the interface org.apache.tools.ant.util.regexp.Regexp. +If ant.regexp.regexpimpl is not defined, Ant uses Jdk14Regexp as this is always available.

    +

    +There are cross-platform issues for matches related to line terminator. +For example if you use $ to anchor your regular expression on the end of a line +the results might be very different depending on both your platform and the regular +expression library you use. It is 'highly recommended' that you test your pattern on +both Unix and Windows platforms before you rely on it. +

      +
    • Jakarta Oro defines a line terminator as '\n' and is consistent with Perl.
      • +
    • Jakarta RegExp uses a system-dependent line terminator.
      • +
    • JDK 1.4 uses '\n', '\r\n', '\u0085', '\u2028', '\u2029' as a default + but is configured in the wrapper to use only '\n' (UNIX_LINE)
      • +
    +We strongly recommend that you use Jakarta Oro. +

    +

    Usage

    +The following tasks and types use the Regexp type : + +

    +These string filters also use the mechanism of regexp to choose a regular expression implementation : +

    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/resources.html b/tools/apache-ant-1.8.2/docs/manual/Types/resources.html new file mode 100644 index 000000000..d75d773c0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/resources.html @@ -0,0 +1,1274 @@ + + + + + + +Resources and Resource Collections + + + + +

    Resources

    +

    +A file-like entity can be abstracted to the concept of a resource. +In addition to providing access to file-like attributes, a resource +implementation should, when possible, provide the means to read content +from and/or write content to the underlying entity. Although the resource +concept was introduced in Apache Ant 1.5.2, resources are available for +explicit use beginning in Ant 1.7. +

    + +

    The built-in resource types are:

    + + + +

    resource

    + +

    A basic resource. Other resource types derive from this basic +type; as such all its attributes are available, though in most cases +irrelevant attributes will be ignored. This and all resource +implementations are also usable as single-element +Resource Collections. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of this resourceNo
    existsWhether this resource existsNo, default true
    lastmodifiedThe last modification time of this resourceNo
    directoryWhether this resource is directory-likeNo, default false
    sizeThe size of this resourceNo
    + +

    file

    + +

    Represents a file accessible via local filesystem conventions.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    fileThe file represented by this resourceYes
    basedirThe base directory of this resource. When this + attribute is set, attempts to access the name of the resource + will yield a path relative to this location.No
    + +

    javaresource

    + +

    Represents a resource loadable via a Java classloader.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of the resource.Yes
    classpaththe classpath to use when looking up a resource.No
    classpathrefthe classpath to use when looking up a resource, + given as reference + to a <path> defined elsewhere..No
    loaderRefthe name of the loader that is + used to load the resource, constructed from the specified classpath.No
    parentFirstWhether to consult the parent classloader first - + the parent classloader most likely is the system classloader - + when using a nested classpath. Defaults + to true.
    + Since Ant 1.8.0    		No
    + +

    The classpath can also be specified as nested classpath element, +where <classpath> is a path-like structure.

    + +

    zipentry

    + +

    Represents an entry in a ZIP archive. The archive can be specified +using the archive attribute or a nested single-element resource +collection. zipentry only supports file system resources +as nested elements.

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    zipfile or its alias name archiveThe zip file containing this resourceYes, unless a nested resource + collection has been specified.
    nameThe name of the archived resourceYes
    encodingThe encoding of the zipfileNo; + platform default used if unspecified
    + +

    tarentry

    + +

    Represents an entry in a TAR archive. The archive can be specified +using the archive attribute or a nested single-element resource +collection.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    archiveThe tar archive containing this resourceYes, unless a nested resource + collection has been specified.
    nameThe name of the archived resourceYes
    + +

    gzipresource

    + +

    This is not a stand-alone resource, but a wrapper around another +resource providing compression of the resource's contents on the fly. +A single element resource collection must be specified as a nested +element.

    + +

    bzip2resource

    + +

    This is not a stand-alone resource, but a wrapper around another +resource providing compression of the resource's contents on the fly. +A single element resource collection must be specified as a nested +element.

    + +

    url

    + +

    Represents a URL.

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    urlThe url to exposeExactly one of these
    fileThe file to expose as a file: url
    baseUrlThe base URL which must be combined with relativePath
    relativePathRelative path that defines the url combined with + baseUrlIf using baseUrl
    + +

    string

    + +

    Represents a Java String. It can be written to, but only once, after which +it will be an error to write to again.

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    valueThe value of this resourceNo
    + +

    The resource also supports nested text, which can only be supplied if the value attribute is unset: +

    +
    +  <string>
+        self.log("Ant version =${ant.version}");
+  </string>
+
    + +

    + +

    propertyresource

    + +

    Represents an Ant property.

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe property nameYes
    + +
    +

    Resource Collections

    +

    +A Resource Collection is an abstraction of an entity that groups +together a number of resources. Several of +Ant's "legacy" datatypes have been modified to behave as Resource Collections: +

    +

    +

    Strangely, some tasks can even legitimately behave as resource collections: +

      +
    • concat + exposes a concatenated resource, and adds e.g. + filtering + to Ant's resource-related capabilities. +
      • +
    +

    +

    The additional built-in resource collections are:

    +
      +
    • resources - generic resource collection
      • +
    • files - collection of files similar to + fileset
      • +
    • restrict - restrict a resource collection + to include only resources meeting specified criteria
      • +
    • sort - sorted resource collection
      • +
    • first - first n resources from a + nested collection
      • +
    • last - last n resources from a + nested collection
      • +
    • tokens - string tokens + gathered from a nested collection
      • +
    • union - set union of nested resource collections
      • +
    • intersect - set intersection + of nested resource collections
      • +
    • difference - set difference + of nested resource collections
      • +
    • mappedresources - generic + resource collection wrapper that maps the names of the nested + resources using a mapper.
      • +
    • archives - wraps around different + resource collections and treats the nested resources as ZIP or TAR + archives that will be extracted on the fly.
      • +
    • resourcelist - a collection of + resources who's names have been read from another resource.
      • +
    +

    resources

    +

    A generic resource collection, designed for use with + references. + For example, if a third-party Ant task generates a Resource Collection + of an unknown type, it can still be accessed via a + <resources> collection. The secondary use of this + collection type is as a container of other resource collections, + preserving the order of nested collections as well as + duplicate resources (contrast with union). +

    +
    + + + + + + + + + + + +
    AttributeDescriptionRequired
    cacheWhether to cache results. since Ant 1.8.0No, default false
    +
    + +

    files

    +

    A group of files. These files are matched by absolute patterns + taken from a number of PatternSets. + These can be specified as nested <patternset> + elements. In addition, <files> holds an implicit + PatternSet and supports the nested <include>, + <includesfile>, <exclude> + and <excludesfile> elements of PatternSet directly, + as well as PatternSet's attributes. +

    +

    File Selectors are available as nested + elements. A file must be selected by all selectors in order to be included; + <files> is thus equivalent to an + <and> file selector container. +

    +

    More simply put, this type is equivalent to a + fileset with no base directory. + Please note that without a base directory, + filesystem scanning is based entirely on include and exclude patterns. + A filename (or any) + selector can only influence the scanning process after + the file has been included based on pattern-based selection. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    includescomma- or space-separated list of patterns + of files that must be includedAt least one of these
    includesfilethe name of a file; each line of this file is + taken to be an include pattern.
    excludescomma- or space-separated list of patterns + of files that must be excludedNo, default none + (except default excludes when true)
    excludesfilethe name of a file; each line of this file is + taken to be an exclude pattern.
    defaultexcludesWhether + default excludes + should be usedNo, default true
    casesensitiveWhether patterns are case-sensitiveNo, default true
    followsymlinksWhether to follow symbolic links + (see note below)No, default true
    + +

    Note: All files/directories for which +the canonical path is different from its path are considered symbolic +links. On Unix systems this usually means the file really is a +symbolic link but it may lead to false results on other +platforms. +

    + +

    restrict

    +

    Restricts a nested resource collection using resource selectors: +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    +

    Parameters specified as nested elements

    +

    A single resource collection is required.

    +

    Nested resource selectors are used to "narrow down" the included + resources. These are patterned after file + selectors but are, unsurprisingly, targeted to resources. + Several built-in resource selectors are available in the internal + antlib + org.apache.tools.ant.types.resources.selectors: +

    + +
      +
    • name - select resources by name.
      • +
    • exists - select existing resources.
      • +
    • date - select resources by date.
      • +
    • type - select resources by type.
      • +
    • size - select resources by size.
      • +
    • instanceof + - select resources by class or Ant datatype.
      • +
    • and - "and" nested resource selectors.
      • +
    • or - "or" nested resource selectors.
      • +
    • not - "not" a nested resource selector.
      • +
    • none + - select resources selected by no nested resource selectors.
      • +
    • majority - select resources selected + by a majority of nested resource selectors.
      • +
    • modified - select resources which + content has changed.
      • +
    • contains - select resources + containing a particular text string.
      • +
    • containsregexp - select + resources whose contents match a particular regular expression.
      • +
    • compare - select resources + based on comparison to other resources.
      • +
    • readable - + Select files (resources must be files) if they are readable.
      • +
    • writable - + Select files (resources must be files) if they are writable.
      • +
    + +

    name

    +

    Selects resources by name.

    + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name pattern to test using standard Ant + patterns.Exactly one of + the two
    regexThe regular expression matching files to select.
    casesensitiveWhether name comparisons are case-sensitiveNo, default true
    handledirsep + If this is specified, the mapper will treat a \ character in a + resource name or name attribute as a / for the purposes of + matching. This attribute can be true or false, the default is + false. + Since Ant 1.8.0. + No
    + +

    exists

    +

    Selects existing resources.

    + +

    date

    +

    Selects resources by date.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    millisThe comparison date/time in ms since January 1, 1970One of these
    datetimeThe formatted comparison date/time
    patternSimpleDateFormat-compatible pattern + for use with the datetime attribute + No, default is "MM/DD/YYYY HH:MM AM_or_PM"
    granularityThe number of milliseconds leeway to use when + comparing file modification times. This is needed because not + every file system supports tracking the last modified time to + the millisecond level.No; default varies by platform: + FAT filesystems = 2 sec; Unix = 1 sec; NTFS = 1 ms.
    whenOne of "before", "after", "equal"No, default "equal"
    + +

    type

    +

    Selects resources by type (file or directory).

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    typeOne of "file", "dir", "any" (since Ant 1.8)Yes
    + +

    size

    +

    Selects resources by size.

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    sizeThe size to compareYes
    whenOne of "equal", "eq", "greater", "gt", "less", "lt", + "ge" (greater or equal), "ne" (not equal), "le" (less or equal)No, default "equal"
    + +

    instanceof

    +

    Selects resources by type.

    + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classThe class of which the resource must be an instanceOne of these
    typeThe Ant type that must + be assignable from the resource
    uriThe uri in which type must be definedNo
    + +

    and

    +

    Selects a resource if it is selected by all nested resource selectors.

    + +

    or

    +

    Selects a resource if it is selected + by at least one nested resource selector.

    + +

    not

    +

    Negates the selection result of the single + nested resource selector allowed.

    + +

    none

    +

    Selects a resource if it is selected + by no nested resource selectors.

    + +

    majority

    +

    Selects a resource if it is selected + by the majority of nested resource selectors.

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    allowtieWhether a tie (when there is an even number + of nested resource selectors) is considered a majorityNo, default true
    + +

    compare

    +

    Selects a resource based on its comparison to one or more "control" + resources using nested resource comparators.

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    whenComparison ("equal"/"eq", "greater"/"gt", "less"/"lt", + "le" (less or equal), "ge" (greater or equal), "ne" (not equal).No, default "equal"
    againstQuantifier ("all"/"each"/"every", "any"/"some", + (exactly) "one", "most"/"majority", "none".No, default "all"
    +

    Parameters specified as nested elements

    +

    The resources against which comparisons will be made must be specified + using the nested <control> element, which denotes a + resources collection.

    +

    Examples

    +

    Assuming the namespace settings +

      rsel="antlib:org.apache.tools.ant.types.resources.selectors"
+  rcmp="antlib:org.apache.tools.ant.types.resources.comparators"
+

    + 
    +<restrict>
+  <fileset dir="src" includes="a,b,c,d,e,f,g" />
+  <rsel:compare when="le" against="all">
+    <control>
+      <resource name="d" />
+    </control>
+    <rcmp:name />
+  </rsel:compare>
+</restrict>
+
    +

    Selects files a, b, c, and d.

    + 
    +    <project rsel="antlib:org.apache.tools.ant.types.resources.selectors">
+        <macrodef name="copyFromPath">
+            <attribute name="todir"/>
+            <attribute name="refid"/>
+            <element name="nested-resource-selectors" optional="yes" implicit="true"/>
+            <sequential>
+                <mkdir dir="@{todir}" taskname="copyFromPath"/>
+                <copy todir="@{todir}" taskname="copyFromPath">
+                    <restrict>
+                        <path refid="@{refid}"/>
+                        <rsel:or>
+                            <nested-resource-selectors/>
+                        </rsel:or>
+                    </restrict>
+                    <flattenmapper/>
+                </copy>
+            </sequential>
+        </macrodef>
+        <copyFromPath refid="classpath" todir="todir">
+            <rsel:name name="log4j.properties"/>
+            <rsel:name name="default.properties"/>
+        </copyFromPath>
+     </project>
+
    +

    Creates the todir directory and copies (if present) the + files log4j.properties and default.properties + from the Classpath (already used while compiling). +

    + + 
    +  <project>
+      <filelist id="allfiles" dir="${ant.home}/bin" files="ant.cmd,foo.txt,ant.bat,bar.txt,ant"/>
+      <restrict id="missingfiles">
+          <filelist refid="allfiles"/>
+          <rsel:not xmlns:rsel="antlib:org.apache.tools.ant.types.resources.selectors">
+              <rsel:exists/>
+          </rsel:not>
+      </restrict>
+      <echo>These files are missed: ${toString:missingfiles}</echo>
+  </project>
+
    +

    The resource collection allfiles defines a list of files which are expected. The restrict + missingfiles uses the <not><exists> selector for getting all files + which are not present. Finally we use the toString: pathshortcut for + getting them in a readable form: [echo] These files are missed: ....foo.txt;....bar.txt

    + +
    + +

    sort

    + +

    Sorts a nested resource collection according to the resources' + natural order, or by one or more nested resource + comparators:

    +
    + + + + + + + + + + + +
    AttributeDescriptionRequired
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    +

    Parameters specified as nested elements

    +

    A single resource collection is required.

    +

    The sort can be controlled and customized by specifying one or more + resource comparators. Resources can be sorted according to multiple + criteria; the first specified is the "outermost", while the last + specified is the "innermost". Several built-in resource comparators + are available in the internal antlib + org.apache.tools.ant.types.resources.comparators: +

    +

    Resource Comparators:

    +
      +
    • name - sort resources by name
      • +
    • exists - sort resources by existence
      • +
    • date - sort resources by date
      • +
    • type - sort resources by type
      • +
    • size - sort resources by size
      • +
    • content - sort resources by content
      • +
    • reverse - reverse the natural sort order, + or that of a single nested resource comparator
      • +
    + +

    name

    +

    Sort resources by name.

    + +

    exists

    +

    Sort resources by existence. + Not existing is considered "less than" existing.

    + +

    date

    +

    Sort resources by date.

    + +

    type

    +

    Sort resources by type (file or directory). + Because directories contain files, they are considered "greater".

    + +

    size

    +

    Sort resources by size.

    + +

    content

    +

    Sort resources by content.

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    binaryWhether content should be compared in binary mode. + If false, content will be compared without regard to + platform-specific line-ending conventions.No, default true
    + +

    reverse

    +

    Reverse the natural sort order, or that of a single nested comparator.

    + +

    Examples

    + 
    +    <property name="eol" value="${line.separator}" />
+    <pathconvert property="sorted" pathsep="${eol}">
+      <sort>
+        <tokens>
+          <string value="foo bar etc baz" />
+          <stringtokenizer />
+        </tokens>
+      </sort>
+    </pathconvert>
    +

    The resource of type string "foo bar etc baz" is split into four tokens by + the stringtokenizer. These tokens are sorted and there sorted gets the value + of "bar baz etc foo".

    + + 
    +    <sort>
+      <fileset dir="foo" />
+      <reverse xmlns="antlib:org.apache.tools.ant.types.resources.comparators">
+        <date />
+      </reverse>
+    </sort>
    +

    This takes all files from foo + and sorts them by modification date in reverse order. + Because the resource comparators used (<reverse> + and <date>) are in an internal antlib + their namespace must be set explicitly. +

    + +
    + +

    first

    +

    Includes the first count resources from a nested resource collection. +This can be used in conjunction with the sort collection, +for example, to select the first few oldest, largest, etc. resources from a +larger collection.

    +
    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    countThe number of resources to includeNo, default 1
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    +

    Parameters specified as nested elements

    +

    A single resource collection is required.

    +
    + +

    last

    +

    Includes the last count resources from a nested resource collection. +This can be used in conjunction with the sort collection, +for example, to select the last few oldest, largest, etc. resources from a +larger collection. Since Ant 1.7.1.

    +
    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    countThe number of resources to includeNo, default 1
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    +

    Parameters specified as nested elements

    +

    A single resource collection is required.

    +
    + +

    tokens

    +

    Includes the string tokens gathered from a nested + resource collection. Uses the same tokenizers supported by the +TokenFilter. Imaginative + use of this resource collection can implement equivalents for such Unix + functions as sort, grep -c, wc and + wc -l.

    +
    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    encodingThe encoding of the nested resourcesNo, default is platform default
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    +

    Parameters specified as nested elements

    +
      +
    • A single resource collection is required.
      • +
    • One nested tokenizer may be specified. If omitted, a + LineTokenizer will be used. +
      • +
    +

    Examples

    + 
    <concat>
+  <union>
+    <sort>
+      <tokens>
+        <resources refid="input" />
+        <linetokenizer includedelims="true" />
+      </tokens>
+    </sort>
+  </union>
+</concat>
+
    +

    Implements Unix sort -u against resource collection input.

    +
    + +

    Set operations

    +
    +

    The following resource collections implement set operations:

    + + +

    union

    +

    Union of nested resource collections.

    + +

    intersect

    +

    Intersection of nested resource collections.

    + +

    difference

    +

    Difference of nested resource collections.

    + +

    The following attributes apply to all set-operation resource collections: +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    cacheWhether to cache results; disabling + may seriously impact performanceNo, default true
    + +

    Examples

    + 
    +    <resources id="A">
+        <string value="a"/>
+        <string value="b"/>
+    </resources>
+    <resources id="B">
+        <string value="b"/>
+        <string value="c"/>
+    </resources>
+    <union id="union"><resources refid="A"/><resources refid="B"/></union>
+    <intersect id="intersect"><resources refid="A"/><resources refid="B"/></intersect>
+    <difference id="difference"><resources refid="A"/><resources refid="B"/></difference>
+    <echo>
+      A: ${toString:A}                    = a;b
+      B: ${toString:B}                    = b;c
+
+      union     : ${toString:union}       = a;b;c
+      intersect : ${toString:intersect}   = b
+      difference: ${toString:difference}  = a;c
+    </echo>
+
    +
    + +

    mappedresources

    + +

    Since Ant 1.8.0

    + +

    Wraps another resource collection and maps the names of the nested + resources using a mapper.

    + +

    Even if mappedresources wraps a resource collection that + consists of file-system based resources, mappedresources + will not appear to be file-system based. This means you can't + use mappedresources with tasks that only allow file-system + based resources.

    + +
    +

    Parameters specified as attributes

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    cacheWhether to cache results; enabling + may improve performance. Since Ant 1.8.1No, default false
    enablemultiplemappings + If true the the collection will use all the mappings for a + given source path. If false the it will only process the first + resource. + since Ant 1.8.1.No - defaults to false.
    + +

    Parameters specified as nested elements

    +

    A single resource collection is required.

    +

    A single mapper can be used to map + names. If no mapper has been given (which doesn't make any sense, + honestly), an identity mapper will be used.

    + +

    Examples

    + +

    Copies all files from a given directory to a target directory + adding ".bak" as an extension. Note this could be done with a + mapper nested into copy directly as well.

    + + 
    +    <copy todir="${target}">
+      <mappedresources>
+        <fileset dir="${src}"/>
+        <globmapper from="*" to="*.bak"/>
+      </mappedresources>
+    </copy>
+
    + +

    Creates a WAR archive adding all CLASSPATH entries that are files + to the WEB-INF/lib directory without keeping their + files-system structure.

    + + 
    +    <war destfile="${output}">
+      <mappedresources>
+        <restrict>
+          <path path="${java.class.path}"/>
+          <type type="file"/>
+        </restrict>
+        <chainedmapper>
+          <flattenmapper/>
+          <globmapper from="*" to="WEB-INF/lib/*"/>
+        </chainedmapper>
+      </mappedresources>
+    </war>
+
    +
    + +

    archives

    + +

    Since Ant 1.8.0

    + +

    This resource collection accepts an arbitrary number of nested + resources and assumes that all those resources must be either ZIP or + TAR archives. The resources returned + by <archives> are the contents of the nested + archives.

    + +

    This resource collection is a generalization + of zipgroupfileset + which is only supported by the zip family of tasks.

    + +

    archives doesn't support any attributes.

    + +
    +

    Parameters specified as nested elements

    + +

    <archives> has two nested + elements <zips> and + <tars> that are unions + themselves, i.e. they accept arbitrary many resource(collection)s + as nested elements.

    + +

    The nested resources of <zips> are treated as ZIP archives, + the nested resources of <tars> as TAR archives.

    + +

    Examples

    + +

    Copies all files from all jars that are on the classpath + to ${target}.

    + + 
    +    <copy todir="${target}">
+      <archives>
+        <zips>
+          <restrict>
+            <path path="${java.class.path}"/>
+            <name name="*.jar"/>
+          </restrict>
+        </zips>
+      </archives>
+    </copy>
+
    +
    + +

    resourcelist

    + +

    Since Ant 1.8.0

    + +

    This resource collection accepts an arbitrary number of nested + resources, reads those resources and returns a resource for each + line read.

    + +

    If the line contains a colon, Ant will try to use it as an URL and + if that fails (or the line doesn't contain a colon) will return a + file resource with the line's content as its name.

    + +

    Properties will be expanded for each line. If the property + expansion yields a resource object rather than a string (for example + because of custom property helpers), the resources will be returned + directly.

    + +

    <resourcelist> is a generalization + of <filelist>.

    + +
    + + + + + + + + + + + +
    AttributeDescriptionRequired
    encodingThe encoding of the nested resourcesNo, default is platform default
    +
    + +
    +

    Parameters specified as nested elements

    + +

    <resourcelist> accepts arbitrary many + resource(collection)s as nested elements.

    + +

    In addition <resourcelist> supports + nested <filterchain> elements that can be used + to filter/modify the read resources before their lines get + expanded. Such a nested element corresponds to + a filterchain.

    + +

    Examples

    + +

    The following example copies a file from the first URL of + several alternatives that can actually be reached. It assumes + that the file mirrors.txt looks like

    + + 
    +    mirrors.txt:
+http://best.mirror.example.org/
+http://second.best.mirror.example.org/mirror/of/best/
+https://yet.another.mirror/
+http://the.original.site/
+
    + + 
    +    <copy todir="${target}">
+      <first>
+        <restrict>
+          <resourcelist>
+            <file file="mirrors.txt"/>
+          </resourcelist>
+          <exists/>
+        </restrict>
+      </first>
+    </copy>
+
    +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/selectors-program.html b/tools/apache-ant-1.8.2/docs/manual/Types/selectors-program.html new file mode 100644 index 000000000..c93c14e8f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/selectors-program.html @@ -0,0 +1,264 @@ + + + + + +Programming Selectors in Apache Ant + + + +

    Programming your own Selectors

    + +

    Selector Programming API

    + +

    Want to define your own selectors? It's easy!

    + +

    First, pick the type of selector that you want to define. There + are three types, and a recipe for each one follows. Chances are + you'll want to work with the first one, Custom Selectors.

    + +
      +
    1. Custom Selectors + +

      This is the category that Apache Ant provides specifically for you to + define your own Selectors. Anywhere you want to use your selector + you use the <custom> element and specify + the class name of your selector within it. See the + Custom Selectors + section of the Selector page for details. The + <custom> element can be used anywhere + the core selectors can be used. It can be contained within + Selector Containers, + for example.

      + +

      To create a new Custom Selector, you have to create a class that + implements + org.apache.tools.ant.types.selectors.ExtendFileSelector. + The easiest way to do that is through the convenience base class + org.apache.tools.ant.types.selectors.BaseExtendSelector, + which provides all of the methods for supporting + <param> tags. First, override the + isSelected() method, and optionally the + verifySettings() method. If your custom + selector requires parameters to be set, you can also override + the setParameters() method and interpret the + parameters that are passed in any way you like. Several of the + core selectors demonstrate how to do that because they can + also be used as custom selectors.

      + +
    2. Core Selectors + +

      These are the selectors used by Ant itself. To implement one of + these, you will have to alter some of the classes contained within + Ant.

      + +
        +

      • First, create a class that implements + org.apache.tools.ant.types.selectors.FileSelector. + You can either choose to implement all methods yourself from + scratch, or you can extend + org.apache.tools.ant.types.selectors.BaseSelector + instead, a convenience class that provides reasonable default + behaviour for many methods.

        + +

        There is only one method required. + public boolean isSelected(File basedir, String filename, + File file) + is the real purpose of the whole exercise. It returns true + or false depending on whether the given file should be + selected from the list or not.

        + +

        If you are using + org.apache.tools.ant.types.selectors.BaseSelector + there are also some predefined behaviours you can take advantage + of. Any time you encounter a problem when setting attributes or + adding tags, you can call setError(String errmsg) and the class + will know that there is a problem. Then, at the top of your + isSelected() method call validate() and + a BuildException will be thrown with the contents of your error + message. The validate() method also gives you a + last chance to check your settings for consistency because it + calls verifySettings(). Override this method and + call setError() within it if you detect any + problems in how your selector is set up.

        + +

        You may also want to override toString().

        + +

      • Put an add method for your selector in + org.apache.tools.ant.types.selectors.SelectorContainer. + This is an interface, so you will also have to add an implementation + for the method in the classes which implement it, namely + org.apache.tools.ant.types.AbstractFileSet, + org.apache.tools.ant.taskdefs.MatchingTask and + org.apache.tools.ant.types.selectors.BaseSelectorContainer. + Once it is in there, it will be available everywhere that core + selectors are appropriate.

        +
      + +
    3. Selector Containers +

      Got an idea for a new Selector Container? Creating a new one is + no problem:

      +
        +

      • Create a new class that implements + org.apache.tools.ant.types.selectors.SelectorContainer. + This will ensure that your new + Container can access any new selectors that come along. Again, there + is a convenience class available for you called + org.apache.tools.ant.types.selectors.BaseSelectorContainer. +

        +

      • Implement the + public boolean isSelected(String filename, File file) + method to do the right thing. Chances are you'll want to iterate + over the selectors under you, so use + selectorElements() to get an iterator that will do + that.

        +

      • Again, put an add method for your container in + org.apache.tools.ant.types.selectors.SelectorContainer + and its implementations + org.apache.tools.ant.types.AbstractFileSet and + org.apache.tools.ant.types.selectors.BaseSelectorContainer. +

        +
      +
    + +

    Testing Selectors

    + +

    For a robust component (and selectors are (Project)Components) tests are + necessary. For testing Tasks we use JUnit TestCases - more specific + org.apache.tools.ant.BuildFileTest extends junit.framework.TestCase. + Some of its features like configure the (test) project by reading its buildfile and + execute targets we need for selector tests also. Therefore we use that BuildFileTest. + But testing selectors requires some more work: having a set of files, instantiate + and configure the selector, check the selection work and more. Because we usually + extend BaseExtendSelector its features have to be tested also (e.g. setError()). +

    + +

    That's why we have a base class for doing our selector tests: + org.apache.tools.ant.types.selectors.BaseSelectorTest.

    + +

    This class extends TestCase and therefore can included in the set of Ant's + unit tests. It holds an instance of preconfigured BuildFileTest. Configuration + is done by parsing the src/etc/testcases/types/selectors.xml. BaseSelectorTest + then gives us helper methods for handling multiple selections.

    + +

    Because the term "testcase" or "testenvironment" are so often used, this + special testenvironment got a new name: bed. Like you initialize the + test environment by calling setUp() and cleaning by calling tearDown() (or like + to make your bed before go sleeping) you have to do that work with your + bed by calling makeBed() respecitive cleanupBed().

    + +

    A usual test scenario is

      +
    1. make the bed
      2. +
    2. instantiate the selector
      3. +
    3. configure the selector
      4. +
    4. let the selector do some work
      5. +
    5. verify the work
      6. +
    6. clean the bed
      7. +
    +

    + +

    For common way of instantiation you have to override the getInstance() + simply by returning a new object of your selector. For easier "selection and verification work" + BaseSelectorTest provides the method performTests() which + iterates over all files (and directories) in the String array filenames + and checks whether the given selector returns the expected result. If an error + occurred (especially the selector does not return the expected result) the test + fails and the failing filenames are logged.

    + +

    An example test would be:

    +package org.apache.tools.ant.types.selectors;
+
+public class MySelectorTest extends BaseSelectorTest {
+
+    public MySelectorTest(String name) {
+        super(name);
+    }
+
+    public BaseSelector getInstance() {
+        return new MySelector();
+    }
+
+    public void testCase1() {
+        try {
+            // initialize test environment 'bed'
+            makeBed();
+
+            // Configure the selector
+            MySelector s = (MySelector)getSelector();
+            s.addParam("key1", "value1");
+            s.addParam("key2", "value2");
+            s.setXX(true);
+            s.setYY("a value");
+
+            // do the tests
+            performTests(s, "FTTTTTTTTTTT");  // First is not selected - rest is
+
+        } finally {
+            // cleanup the environment
+            cleanupBed();
+        }
+    }
+}
+
    + As an example of an error JUnit could log
    +    [junit]     FAILED
+    [junit] Error for files: .;copy.filterset.filtered;tar/gz/asf-logo.gif.tar.gz
+    [junit] expected:<FTTTFTTTF...> but was:<TTTTTTTTT...>
+    [junit] junit.framework.ComparisonFailure: Error for files: .;copy.filterset.filtered;tar/gz/asf-logo.gif.tar.gz
+    [junit] expected:<FTTTFTTTF...> but was:<TTTTTTTTT...>
+    [junit]     at junit.framework.Assert.assertEquals(Assert.java:81)
+    [junit]     at org.apache.tools.ant.types.selectors.BaseSelectorTest.performTest(BaseSelectorTest.java:194)
+

    + +

    Described above the test class should provide a getInstance() + method. But that isn't used here. The used getSelector() method is + implemented in the base class and gives an instance of an Ant Project to + the selector. This is usually done inside normal build file runs, but not + inside this special environment, so this method gives the selector the + ability to use its own Project object (getProject()), for example + for logging.

    + + +

    Logging

    + +

    During development and maybe later you sometimes need the output of information. + Therefore Logging is needed. Because the selector extends BaseExtendSelector or directly + BaseSelector it is an Ant DataType and therefore a ProjectComponent.
    + That means that you have access to the project object and its logging capability. + ProjectComponent itself provides log methods which will do the + access to the project instance. Logging is therefore done simply with: + 

    +        log( "message" );
+
    + or + 
    +        log( "message" , loglevel );
+
    + where the loglevel is one of the values
      +
    • org.apache.tools.ant.Project.MSG_ERR
      • +
    • org.apache.tools.ant.Project.MSG_WARN
      • +
    • org.apache.tools.ant.Project.MSG_INFO (= default)
      • +
    • org.apache.tools.ant.Project.MSG_VERBOSE
      • +
    • org.apache.tools.ant.Project.MSG_DEBUG
      • +
    +

    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/selectors.html b/tools/apache-ant-1.8.2/docs/manual/Types/selectors.html new file mode 100644 index 000000000..eee0a8942 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/selectors.html @@ -0,0 +1,1580 @@ + + + + + + Selectors in Apache Ant + + + +

    Selectors

    + +

    Selectors are a mechanism whereby the files that make up a + <fileset> can be selected based on criteria + other than filename as provided by the <include> + and <exclude> tags.

    + +

    How to use a Selector

    + +

    A selector is an element of FileSet, and appears within it. It can + also be defined outside of any target by using the <selector> tag + and then using it as a reference. +

    + +

    Different selectors have different attributes. Some selectors can + contain other selectors, and these are called + Selector Containers. + There is also a category of selectors that allow + user-defined extensions, called + Custom Selectors. + The ones built in to Apache Ant are called + Core Selectors. +

    + + +

    Core Selectors

    + +

    Core selectors are the ones that come standard + with Ant. They can be used within a fileset and can be contained + within Selector Containers.

    + +

    The core selectors are:

    + +
      +
    • <contains> - Select + files that contain a particular text string
      • +
    • <date> - Select files + that have been modified either before or after a particular date + and time
      • +
    • <depend> - Select files + that have been modified more recently than equivalent files + elsewhere
      • +
    • <depth> - Select files + that appear so many directories down in a directory tree
      • +
    • <different> - Select files + that are different from those elsewhere
      • +
    • <filename> - Select + files whose name matches a particular pattern. Equivalent to + the include and exclude elements of a patternset.
      • +
    • <present> - Select + files that either do or do not exist in some other location
      • +
    • <containsregexp> - Select + files that match a regular expression
      • +
    • <size> - Select files + that are larger or smaller than a particular number of bytes.
      • +
    • <type> - Select files + that are either regular files or directories.
      • +
    • <modified> - Select files if + the return value of the configured algorithm is different from that + stored in a cache.
      • +
    • <signedselector> - Select files if + they are signed, and optionally if they have a signature of a certain name. +
      • +
    • <scriptselector> - + Use a BSF or JSR 223 scripting language to create + your own selector +
      • +
    • <readable> - + Select files if they are readable.
      • +
    • <writable> - + Select files if they are writable.
      • +
    + + +

    Contains Selector

    + +

    The <contains> tag in a FileSet limits + the files defined by that fileset to only those which contain the + string specified by the text attribute. + .

    +

    The <contains> selector can be used as a + ResourceSelector (see the + <restrict> + ResourceCollection).

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    textSpecifies the text that every file must contain + Yes
    casesensitiveWhether to pay attention to case when looking + for the string in the text attribute. Default is + true. + No
    ignorewhitespaceWhether to eliminate whitespace before checking + for the string in the text attribute. Default is + false. + No
    + +

    Here is an example of how to use the Contains Selector:

    + + 
    +<fileset dir="${doc.path}" includes="**/*.html">
+    <contains text="script" casesensitive="no"/>
+</fileset>
+
    + +

    Selects all the HTML files that contain the string + script.

    + + + +

    Date Selector

    + +

    The <date> tag in a FileSet will put + a limit on the files specified by the include tag, so that tags + whose last modified date does not meet the date limits specified + by the selector will not end up being selected.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    datetimeSpecifies the date and time to test for. + Should be in the format MM/DD/YYYY HH:MM AM_or_PM, or + an alternative pattern specified via the pattern + attribute. + At least one of the two.
    millisThe number of milliseconds since 1970 that should + be tested for. It is usually much easier to use the datetime + attribute. +
    whenIndicates how to interpret the date, whether + the files to be selected are those whose last modified times should + be before, after, or equal to the specified value. Acceptable + values for this attribute are: +
      +
    • before - select files whose last modified date is before the indicated date +
    • after - select files whose last modified date is after the indicated date +
    • equal - select files whose last modified date is this exact date +
    + The default is equal. +     		No
    granularityThe number of milliseconds leeway to use when + comparing file modification times. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + No
    patternThe SimpleDateFormat-compatible pattern + to use when interpreting the datetime attribute. + Since Ant 1.6.2 + No
    checkdirs + Indicates whether or not to check dates on directories. + No, defaults to false
    + +

    Here is an example of how to use the Date Selector:

    + + 
    +<fileset dir="${jar.path}" includes="**/*.jar">
+    <date datetime="01/01/2001 12:00 AM" when="before"/>
+</fileset>
+
    + +

    Selects all JAR files which were last modified before midnight + January 1, 2001.

    + + + +

    Depend Selector

    + +

    The <depend> tag selects files + whose last modified date is later than another, equivalent file in + another location.

    + +

    The <depend> tag supports the use of a + contained <mapper> element + to define the location of the file to be compared against. If no + <mapper> element is specified, the + identity type mapper is used.

    + +

    The <depend> selector is case-sensitive.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    targetdirThe base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <mapper> element, if any. + Yes
    granularityThe number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + No
    + +

    Here is an example of how to use the Depend Selector:

    + + 
    +<fileset dir="${ant.1.5}/src/main" includes="**/*.java">
+    <depend targetdir="${ant.1.4.1}/src/main"/>
+</fileset>
+
    + +

    Selects all the Java source files which were modified in the + 1.5 release. +

    + + + +

    Depth Selector

    + +

    The <depth> tag selects files based on + how many directory levels deep they are in relation to the base + directory of the fileset. +

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    minThe minimum number of directory levels below + the base directory that a file must be in order to be selected. + Default is no limit. + At least one of the two.
    maxThe maximum number of directory levels below + the base directory that a file can be and still be selected. + Default is no limit. +
    + +

    Here is an example of how to use the Depth Selector:

    + + 
    +<fileset dir="${doc.path}" includes="**/*">
+    <depth max="1"/>
+</fileset>
+
    + +

    Selects all files in the base directory and one directory below + that.

    + + +

    Different Selector

    + +

    The <different> selector will select a file + if it is deemed to be 'different' from an equivalent file in + another location. The rules for determining difference between + the two files are as follows: +

      +
    1. If a file is only present in the resource collection you apply + the selector to but not in targetdir (or after applying the + mapper) the file is selected. +
    2. If a file is only present in targetdir (or after applying the + mapper) it is ignored. +
    3. Files with different lengths are different. +
    4. If ignoreFileTimes is turned off, then differing file + timestamps will cause files to be regarded as different. +
    5. Unless ignoreContents is set to true, + a byte-for-byte check is run against the two files. +
    + + This is a useful selector to work with programs and tasks that don't handle + dependency checking properly; even if a predecessor task always creates its + output files, followup tasks can be driven off copies made with a different + selector, so their dependencies are driven on the absolute state of the + files, not just a timestamp. For example: anything fetched from a web site, + or the output of some program. To reduce the amount of checking, when using + this task inside a <copy> task, set + preservelastmodified to true to propagate the timestamp + from the source file to the destination file.

    + + The <different> selector supports the use of a + contained <mapper> element + to define the location of the file to be compared against. If no + <mapper> element is specified, the + identity type mapper is used.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    targetdirThe base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <mapper> element, if any. + Yes
    ignoreFileTimesWhether to use file times in the comparison or not. + Default is true (time differences are ignored). + No
    ignoreContentsWhether to do a byte per byte compare. + Default is false (contents are compared). + Since Ant 1.6.3 + No
    granularityThe number of milliseconds leeway to give before + deciding a file is out of date. This is needed because not every + file system supports tracking the last modified time to the + millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems. + No
    + +

    Here is an example of how to use the Different Selector:

    + + 
    +<fileset dir="${ant.1.5}/src/main" includes="**/*.java">
+    <different targetdir="${ant.1.4.1}/src/main"
+        ignoreFileTimes="true"/>
+</fileset>
+
    + +

    Compares all the Java source files between the 1.4.1 and the 1.5 release + and selects those who are different, disregarding file times. +

    + + +

    Filename Selector

    + +

    The <filename> tag acts like the + <include> and <exclude> + tags within a fileset. By using a selector instead, however, + one can combine it with all the other selectors using whatever + selector container is desired. +

    + +

    The <filename> selector is + case-sensitive.

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    nameThe name of files to select. The name parameter + can contain the standard Ant wildcard characters. + Exactly one of + the two
    regexThe regular expression matching files to select.
    casesensitiveWhether to pay attention to case when looking + at file names. Default is "true". + No
    negateWhether to reverse the effects of this filename + selection, therefore emulating an exclude rather than include + tag. Default is "false". + No
    + +

    Here is an example of how to use the Filename Selector:

    + + 
    +<fileset dir="${doc.path}" includes="**/*">
+    <filename name="**/*.css"/>
+</fileset>
+
    + +

    Selects all the cascading style sheet files.

    + + + +

    Present Selector

    + +

    The <present> tag selects files + that have an equivalent file in another directory tree.

    + +

    The <present> tag supports the use of a + contained <mapper> element + to define the location of the file to be tested against. If no + <mapper> element is specified, the + identity type mapper is used.

    + +

    The <present> selector is case-sensitive.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    targetdirThe base directory to look for the files to compare + against. The precise location depends on a combination of this + attribute and the <mapper> element, if any. + Yes
    presentWhether we are requiring that a file is present in + the src directory tree only, or in both the src and the target + directory tree. Valid values are: +
      +
    • srconly - select files only if they are in the src + directory tree but not in the target directory tree +
    • both - select files only if they are present both in the + src and target directory trees +
    + Default is both. Setting this attribute to "srconly" + is equivalent to wrapping the selector in the <not> + selector container. +     		No
    + +

    Here is an example of how to use the Present Selector:

    + + 
    +<fileset dir="${ant.1.5}/src/main" includes="**/*.java">
+    <present present="srconly" targetdir="${ant.1.4.1}/src/main"/>
+</fileset>
+
    + +

    Selects all the Java source files which are new in the + 1.5 release. +

    + + +

    Regular Expression Selector

    + +

    The <containsregexp> tag in a FileSet limits + the files defined by that fileset to only those which contents contain a + match to the regular expression specified by the expression attribute. +

    +

    The <containsregexp> selector can be used as a + ResourceSelector (see the + <restrict> + ResourceCollection).

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    expressionSpecifies the regular expression that must + match true in every fileYes
    casesensitivePerform a case sensitive match. Default is + true. since Ant 1.8.2No
    multiline + Perform a multi line match. + Default is false. since Ant 1.8.2No
    singleline + This allows '.' to match new lines. + SingleLine is not to be confused with multiline, SingleLine is a perl + regex term, it corresponds to dotall in java regex. + Default is false. since Ant 1.8.2No
    + +

    Here is an example of how to use the regular expression Selector:

    + + 
    +<fileset dir="${doc.path}" includes="*.txt">
+    <containsregexp expression="[4-6]\.[0-9]"/>
+</fileset>
+
    + +

    Selects all the text files that match the regular expression + (have a 4,5 or 6 followed by a period and a number from 0 to 9). + + + +

    Size Selector

    + +

    The <size> tag in a FileSet will put + a limit on the files specified by the include tag, so that tags + which do not meet the size limits specified by the selector will not + end up being selected.

    + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    valueThe size of the file which should be tested for. + Yes
    unitsThe units that the value attribute + is expressed in. When using the standard single letter SI + designations, such as "k","M", or + "G", multiples of 1000 are used. If you want to use + power of 2 units, use the IEC standard: "Ki" for 1024, + "Mi" for 1048576, and so on. The default is no units, + which means the value attribute expresses the exact + number of bytes. + No
    whenIndicates how to interpret the size, whether + the files to be selected should be larger, smaller, or equal to + that value. Acceptable values for this attribute are: +
      +
    • less - select files less than the indicated size +
    • more - select files greater than the indicated size +
    • equal - select files this exact size +
    + The default is equal. +     		No
    + +

    Here is an example of how to use the Size Selector:

    + + 
    +<fileset dir="${jar.path}">
+  <patternset>
+    <include name="**/*.jar"/>
+  </patternset>
+  <size value="4" units="Ki" when="more"/>
+</fileset>
+
    + +

    Selects all JAR files that are larger than 4096 bytes.

    + + +

    Type Selector

    + +

    The <type> tag selects files of a certain type: + directory or regular.

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    typeThe type of file which should be tested for. + Acceptable values are: +
      +
    • file - regular files
      • +
    • dir - directories
      • +
    +     		Yes
    + +

    Here is an example of how to use the Type Selector to select only + directories in ${src}

    + + 
    +<fileset dir="${src}">
+  <type type="dir"/>
+</fileset>
+
    + +

    The Type Selector is often used in conjunction with other selectors. + For example, to select files that also exist in a template + directory, but avoid selecting empty directories, use: + +

    +<fileset dir="${src}">
+    <and>
+        <present targetdir="template"/>
+        <type type="file"/>
+    </and>
+</fileset>
+
    + + + +

    Modified Selector

    +

    The <modified> selector computes a value for a file, compares that + to the value stored in a cache and select the file, if these two values + differ.

    +

    Because this selector is highly configurable the order in which the selection is done + is:

      +
    1. get the absolute path for the file
      2. +
    2. get the cached value from the configured cache (absolute path as key)
      3. +
    3. get the new value from the configured algorithm
      4. +
    4. compare these two values with the configured comparator
      5. +
    5. update the cache if needed and requested
      6. +
    6. do the selection according to the comparison result
      7. +
    +

    The comparison, computing of the hashvalue and the store is done by implementation + of special interfaces. Therefore they may provide additional parameters.

    + +

    The <modified> selector can be used as a + ResourceSelector (see the + <restrict> + ResourceCollection). + In that case it maps simple file resources to files and does its job. If the + resource is from another type, the <modified> selector tries + to (attention!) copy the content into a local file for computing the + hashvalue.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    algorithm The type of algorithm should be used. + Acceptable values are (further information see later): +
      +
    • hashvalue - HashvalueAlgorithm
      • +
    • digest - DigestAlgorithm
      • +
    • checksum - ChecksumAlgorithm
      • +
    +     		No, defaults to digest
    cache The type of cache should be used. + Acceptable values are (further information see later): +
      +
    • propertyfile - PropertyfileCache
      • +
    +     		No, defaults to propertyfile
    comparator The type of comparator should be used. + Acceptable values are (further information see later): +
      +
    • equal - EqualComparator
      • +
    • rule - java.text.RuleBasedCollator + + (see note for restrictions) +
      • +
    +     		No, defaults to equal
    algorithmclass Classname of custom algorithm implementation. Lower + priority than algorithm. No
    cacheclass Classname of custom cache implementation. Lower + priority than cache. No
    comparatorclass Classname of custom comparator implementation. Lower + priority than comparator. No
    update Should the cache be updated when values differ? (boolean) No, defaults to true
    seldirs Should directories be selected? (boolean) No, defaults to true
    selres Should Resources whithout an InputStream, and + therefore without checking, be selected? (boolean) No, defaults to true. Only relevant + when used as ResourceSelector.
    delayupdate If set to true, the storage of the cache will be delayed until the + next finished BuildEvent; task finished, target finished or build finished, + whichever comes first. This is provided for increased performance. If set + to false, the storage of the cache will happen with each change. This + attribute depends upon the update attribute. (boolean) No, defaults to true
    + +

    These attributes can be set with nested <param/> tags. With <param/> + tags you can set other values too - as long as they are named according to + the following rules:

      +
    • algorithm : same as attribute algorithm
      • +
    • cache : same as attribute cache
      • +
    • comparator : same as attribute comparator
      • +
    • algorithmclass : same as attribute algorithmclass
      • +
    • cacheclass : same as attribute cacheclass
      • +
    • comparatorclass : same as attribute comparatorclass
      • +
    • update : same as attribute update
      • +
    • seldirs : same as attribute seldirs
      • +
    • algorithm.* : Value is transfered to the algorithm via its + setXX-methods
      • +
    • cache.* : Value is transfered to the cache via its + setXX-methods
      • +
    • comparator.* : Value is transfered to the comparator via its + setXX-methods
      • +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Algorithm options
    NameDescription
    hashvalue Reads the content of a file into a java.lang.String + and use thats hashValue(). No additional configuration required. +
    digest Uses java.security.MessageDigest. This Algorithm supports + the following attributes: +
      +
    • algorithm.algorithm (optional): Name of the Digest algorithm + (e.g. 'MD5' or 'SHA', default = MD5)
      • +
    • algorithm.provider (optional): Name of the Digest provider + (default = null)
      • +
    +
    checksum Uses java.util.zip.Checksum. This Algorithm supports + the following attributes: +
      +
    • algorithm.algorithm (optional): Name of the algorithm + (e.g. 'CRC' or 'ADLER', default = CRC)
      • +
    +
    Cache options
    propertyfile Use the java.util.Properties class and its possibility + to load and store to file. + This Cache implementation supports the following attributes: +
      +
    • cache.cachefile (optional): Name of the properties-file + (default = cache.properties)
      • +
    +
    Comparator options
    equal Very simple object comparison.
    rule Uses java.text.RuleBasedCollator for Object + comparison. + + (see note for restrictions) +
    + +

    The <modified> selector supports a nested + <classpath> element that represents a + PATH like structure for finding custom interface implementations.

    + +

    Here are some examples of how to use the Modified Selector:

    + + 
    +    <copy todir="dest">
+        <fileset dir="src">
+            <modified/>
+        </fileset>
+    </copy>
+
    +

    This will copy all files from src to dest which content has changed. + Using an updating PropertyfileCache with cache.properties and + MD5-DigestAlgorithm.

    + + 
    +    <copy todir="dest">
+        <fileset dir="src">
+            <modified update="true"
+                      seldirs="true"
+                      cache="propertyfile"
+                      algorithm="digest"
+                      comparator="equal">
+                <param name="cache.cachefile"     value="cache.properties"/>
+                <param name="algorithm.algorithm" value="MD5"/>
+            </modified>
+        </fileset>
+    </copy>
+
    +

    This is the same example rewritten as CoreSelector with setting the all the values + (same as defaults are).

    + + 
    +    <copy todir="dest">
+        <fileset dir="src">
+            <custom class="org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector">
+                <param name="update"     value="true"/>
+                <param name="seldirs"    value="true"/>
+                <param name="cache"      value="propertyfile"/>
+                <param name="algorithm"  value="digest"/>
+                <param name="comparator" value="equal"/>
+                <param name="cache.cachefile"     value="cache.properties"/>
+                <param name="algorithm.algorithm" value="MD5"/>
+            </custom>
+        </fileset>
+    </copy>
+
    +

    And this is the same rewritten as CustomSelector.

    + + 
    +  <target name="generate-and-upload-site">
+      <echo> generate the site using forrest </echo>
+      <antcall target="site"/>
+
+      <echo> upload the changed file </echo>
+      <ftp server="${ftp.server}" userid="${ftp.user}" password="${ftp.pwd}">
+          <fileset dir="htdocs/manual">
+              <modified/>
+          </fileset>
+      </ftp>
+  </target>
+
    +

    A useful scenario for this selector inside a build environment + for homepage generation (e.g. with + Apache Forrest). Here all changed files are uploaded to the server. The + CacheSelector saves therefore much upload time.

    + + 
    +  <modified cacheclassname="com.mycompany.MyCache">
+      <classpath>
+          <pathelement location="lib/mycompony-antutil.jar"/>
+      </classpath>
+  </modified>
+
    +

    Uses com.mycompany.MyCache from a jar outside of Ants own classpath + as cache implementation

    + + +

    Note on RuleBasedCollator

    +

    The RuleBasedCollator needs a format for its work, but its needed while + instantiation. There is a problem in the initialization algorithm for this + case. Therefore you should not use this (or tell me the workaround :-).

    + + +

    Signed Selector

    + +

    + The <signedselector> tag selects signed files and optionaly + signed with a certain name. +

    +

    + This selector has been added in Apache Ant 1.7. +

    + + + + + + + + + + + +
    AttributeDescriptionRequired
    name The signature name to check for.no
    + + +

    Readable Selector

    + +

    The <readable> selector selects only files + that are readable. Ant only invokes + java.io.File#canRead so if a file is unreadable + but the Java VM cannot detect this state, this selector will + still select the file.

    + + +

    Writable Selector

    + +

    The <writable> selector selects only files + that are writable. Ant only invokes + java.io.File#canWrite so if a file is unwritable + but the Java VM cannot detect this state, this selector will + still select the file.

    + + +

    Script Selector

    + +

    + The <scriptselector> element enables you + to write a complex selection algorithm in any + Apache BSF + or + JSR 223 + supported language. + See the Script task for + an explanation of scripts and dependencies. +

    +

    + This selector was added in Apache Ant 1.7. +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    languagelanguage of the script.yes
    manager + The script engine manager to use. + See the script task + for using this attribute. + No - default is "auto"
    srcfilename of the scriptno
    setbeanswhether to have all properties, references and targets as + global variables in the script.No, default is "true".
    classpath + The classpath to pass into the script. + No
    classpathrefThe classpath to use, given as a + reference to a path defined elsewhere. + No
    +

    + This selector can take a nested <classpath> element. + See the script task + on how to use this element. +

    +

    + If no src attribute is supplied, the script must be nested + inside the selector declaration. +

    +

    The embedded script is invoked for every test, with + the bean self + is bound to the selector. It has an attribute selected + must can be set using setSelected(boolean) to select that + file. + +

    + + The following beans are configured for every script, alongside + the classic set of project, properties, and targets. + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    BeanDescriptionType
    selfselector instanceorg.apache.tools.ant.types.optional
    filenamefilename of the selectionString
    filefile of the selectionjava.io.File
    basedirFileset base directoryjava.io.File
    +

    + The self bean maps to the selector, which has the following + attributes. Only the selected flag is writeable, the rest + are read only via their getter methods. + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionType
    selectedwriteable flag to select this fileboolean
    filenamefilename of the selectionString
    filefile of the selectionjava.io.File
    basedirFileset base directoryjava.io.File
    + +

    + Example +

    +
    +    <scriptselector language="javascript">
+      self.setSelected(true);
+    </scriptselector>
+
    +

    + Selects every file. +

    + +
    +    <scriptselector language="javascript">
+      self.setSelected((filename.length%2)==0);
+    </scriptselector>
+
    +Select files whose filename length is even. + + +

    Selector Containers

    + +

    To create more complex selections, a variety of selectors that + contain other selectors are available for your use. They combine the + selections of their child selectors in various ways.

    + +

    The selector containers are:

    + +
      +
    • <and> - select a file only if all + the contained selectors select it. +
    • <majority> - select a file + if a majority of its selectors select it. +
    • <none> - select a file only if + none of the contained selectors select it. +
    • <not> - can contain only one + selector, and reverses what it selects and doesn't select. +
    • <or> - selects a file if any one + of the contained selectors selects it. +
    • <selector> - contains only one + selector and forwards all requests to it without alteration, provided + that any "if" or + "unless" conditions are met. This + is the selector to use if you want to define a reference. It is + usable as an element of <project>. It is also + the one to use if you want selection of files to be dependent on + Ant property settings. +
    + +

    All selector containers can contain any other selector, including + other containers, as an element. Using containers, the selector tags + can be arbitrarily deep. Here is a complete list of allowable + selector elements within a container:

    + +
      +
    • <and>
      • +
    • <contains>
      • +
    • <custom>
      • +
    • <date>
      • +
    • <depend>
      • +
    • <depth>
      • +
    • <filename>
      • +
    • <majority>
      • +
    • <none>
      • +
    • <not>
      • +
    • <or>
      • +
    • <present>
      • +
    • <selector>
      • +
    • <size>
      • +
    + + +

    And Selector

    + +

    The <and> tag selects files that are + selected by all of the elements it contains. It returns as + soon as it finds a selector that does not select the file, + so it is not guaranteed to check every selector. +

    + +

    Here is an example of how to use the And Selector:

    + + 
    +<fileset dir="${dist}" includes="**/*.jar">
+    <and>
+        <size value="4" units="Ki" when="more"/>
+        <date datetime="01/01/2001 12:00 AM" when="before"/>
+    </and>
+</fileset>
+
    + +

    Selects all the JAR file larger than 4096 bytes which haven't been update + since the last millenium. +

    + + + +

    Majority Selector

    + +

    The <majority> tag selects files provided + that a majority of the contained elements also select it. Ties are + dealt with as specified by the allowtie attribute. +

    + + + + + + + + + + + + +
    AttributeDescriptionRequired
    allowtieWhether files should be selected if there + are an even number of selectors selecting them as are + not selecting them. Default is true. + No
    + + +

    Here is an example of how to use the Majority Selector:

    + + 
    +<fileset dir="${docs}" includes="**/*.html">
+    <majority>
+        <contains text="project" casesensitive="false"/>
+        <contains text="taskdef" casesensitive="false"/>
+        <contains text="IntrospectionHelper" casesensitive="true"/>
+    </majority>
+</fileset>
+
    + +

    Selects all the HTML files which contain at least two of the three + phrases "project", "taskdef", and "IntrospectionHelper" (this last phrase must + match case exactly). +

    + + + +

    None Selector

    + +

    The <none> tag selects files that are + not selected by any of the elements it contains. It returns as + soon as it finds a selector that selects the file, + so it is not guaranteed to check every selector. +

    + +

    Here is an example of how to use the None Selector:

    + + 
    +<fileset dir="${src}" includes="**/*.java">
+    <none>
+        <present targetdir="${dest}"/>
+        <present targetdir="${dest}">
+            <mapper type="glob" from="*.java" to="*.class"/>
+        </present>
+    </none>
+</fileset>
+
    + +

    Selects only Java files which do not have equivalent java or + class files in the dest directory. +

    + + + +

    Not Selector

    + +

    The <not> tag reverses the meaning of the + single selector it contains. +

    + +

    Here is an example of how to use the Not Selector:

    + + 
    +<fileset dir="${src}" includes="**/*.java">
+    <not>
+        <contains text="test"/>
+    </not>
+</fileset>
+
    + +

    Selects all the files in the src directory that do not contain the + string "test". +

    + + + +

    Or Selector

    + +

    The <or> tag selects files that are + selected by any one of the elements it contains. It returns as + soon as it finds a selector that selects the file, + so it is not guaranteed to check every selector. +

    + +

    Here is an example of how to use the Or Selector:

    + + 
    +<fileset dir="${basedir}">
+    <or>
+        <depth max="0"/>
+        <filename name="*.png"/>
+        <filename name="*.gif"/>
+        <filename name="*.jpg"/>
+    </or>
+</fileset>
+
    + +

    Selects all the files in the top directory along with all the + image files below it. +

    + + + +

    Selector Reference

    + +

    The <selector> tag is used to create selectors + that can be reused through references. It is the only selector which can + be used outside of + any target, as an element of the <project> tag. It + can contain only one other selector, but of course that selector can + be a container. +

    + +

    The <selector> tag can also be used to select + files conditionally based on whether an Ant property exists or not. + This functionality is realized using the "if" and + "unless" attributes in exactly the same way they + are used on targets or on the <include> and + <exclude> tags within a + <patternset>.

    + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    ifAllow files to be selected only if the named + property is set. + No
    unlessAllow files to be selected only if the named + property is not set. + No
    + +

    Here is an example of how to use the Selector Reference:

    + + 
    +<project default="all" basedir="./ant">
+
+    <selector id="completed">
+        <none>
+            <depend targetdir="build/classes">
+                <mapper type="glob" from="*.java" to="*.class"/>
+            </depend>
+            <depend targetdir="docs/manual/api">
+                <mapper type="glob" from="*.java" to="*.html"/>
+            </depend>
+        </none>
+    </selector>
+
+    <target>
+        <zip>
+            <fileset dir="src/main" includes="**/*.java">
+                <selector refid="completed"/>
+            </fileset>
+        </zip>
+    </target>
+
+</project>
+
    + +

    Zips up all the Java files which have an up-to-date equivalent + class file and javadoc file associated with them. +

    + +

    And an example of selecting files conditionally, based on whether + properties are set:

    + + 
    +<fileset dir="${working.copy}">
+    <or>
+        <selector if="include.tests">
+            <filename name="**/*Test.class">
+        </selector>
+        <selector if="include.source">
+            <and>
+                <filename name="**/*.java">
+                <not>
+                    <selector unless="include.tests">
+                        <filename name="**/*Test.java">
+                    </selector>
+                </not>
+            </and>
+        </selector>
+    </or>
+</fileset>
+
    + +

    A fileset that conditionally contains Java source files and Test + source and class files.

    + + +

    Custom Selectors

    + +

    You can write your own selectors and use them within the selector + containers by specifying them within the <custom> tag.

    + +

    First, you have to write your selector class in Java. The only + requirement it must meet in order to be a selector is that it implements + the org.apache.tools.ant.types.selectors.FileSelector + interface, which contains a single method. See + Programming Selectors in Ant for + more information.

    + +

    Once that is written, you include it in your build file by using + the <custom> tag. +

    + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    classnameThe name of your class that implements + org.apache.tools.ant.types.selectors.FileSelector. + Yes
    classpathThe classpath to use in order to load the + custom selector class. If neither this classpath nor the + classpathref are specified, the class will be + loaded from the classpath that Ant uses. + No
    classpathrefA reference to a classpath previously + defined. If neither this reference nor the + classpath above are specified, the class will be + loaded from the classpath that Ant uses. + No
    + +

    Here is how you use <custom> to + use your class as a selector: +

    + + 
    +<fileset dir="${mydir}" includes="**/*">
+    <custom classname="com.mydomain.MySelector">
+        <param name="myattribute" value="myvalue"/>
+    </custom>
+</fileset>
+
    + +

    A number of core selectors can also be used as custom selectors + by specifying their attributes using <param> elements. These + are

    + +
      +
    • Contains Selector with + classname org.apache.tools.ant.types.selectors.ContainsSelector +
    • Date Selector with + classname org.apache.tools.ant.types.selectors.DateSelector +
    • Depth Selector with + classname org.apache.tools.ant.types.selectors.DepthSelector +
    • Filename Selector with + classname org.apache.tools.ant.types.selectors.FilenameSelector +
    • Size Selector with + classname org.apache.tools.ant.types.selectors.SizeSelector +
    + +

    Here is the example from the Depth Selector section rewritten + to use the selector through <custom>.

    + + 
    +<fileset dir="${doc.path}" includes="**/*">
+    <custom classname="org.apache.tools.ant.types.selectors.DepthSelector">
+        <param name="max" value="1"/>
+    </custom>
+</fileset>
+
    + +

    Selects all files in the base directory and one directory below + that.

    + +

    For more details concerning writing your own selectors, consult + Programming Selectors in Ant.

    + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/tarfileset.html b/tools/apache-ant-1.8.2/docs/manual/Types/tarfileset.html new file mode 100644 index 000000000..6eb416160 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/tarfileset.html @@ -0,0 +1,171 @@ + + + + + + +TarFileSet Type + + +

    TarFileSet

    + +

    TarFileSet has been added as a stand-alone type in Apache Ant +1.7.

    + +

    A <tarfileset> is a special form of a <fileset> which can behave in 2 +different ways :
    +

    +
      +
    • When the src attribute + is used - or a nested resource collection has been specified, the + tarfileset is populated with tar entries found in the file src.
      +
      • +
    • When the dir attribute +is used, the tarfileset is populated with filesystem files found under dir.
      +
      • +
    +

    <tarfileset> supports all attributes of <fileset> +in addition to those listed below.
    +

    +

    A tarfileset can be defined with the id attribute and referred to with the refid attribute. This is also true +for tarfileset which has been added in Ant 1.7.
    +

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    prefixall files in the fileset are prefixed with that +path in the archive.No
    fullpaththe file described by the fileset is placed at +that exact location in the archive.No
    srcmay be used in place of the dir attribute + to specify a tar file whose contents will be extracted and included +in the archive.No
    filemodeA 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +plain files. Default is 644.No
    dirmodeA 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +directories. Default is 755.No
    usernameThe username for the tar entry. This is not the same as the UID. + No
    groupThe groupname for the tar entry. This is not the same as the GID. + No
    uidThe user identifier (UID) for the tar entry. This is an integer value + and is not the same as the username. + No
    gidThe group identifier (GID) for the tar entry. + No
    erroronmissingarchive + Specify what happens if the archive does not exist. + If true, a build error will happen; if false, the fileset + will be ignored/empty. + Defaults to true. + Since Ant 1.8.0 + No
    +

    The fullpath attribute can only be set for filesets that +represent a single file. The prefix and fullpath +attributes cannot both be set on the same fileset.

    +

    When using the src attribute, include and exclude patterns +may be used to specify a subset of the archive for inclusion in the +archive as with the dir attribute.

    + +

    Please note that currently only the tar task uses the permission and +ownership attributes.

    + +

    Parameters specified as nested elements

    + +

    any resource or single element +resource collection

    + +

    The specified resource will be used as src.

    + +

    Examples

    +
    +
    +  <copy todir="some-dir">
+    <tarfileset includes="lib/**">
+      <bzip2resource>
+        <url url="http://example.org/dist/some-archive.tar.bz2"/>
+      </bzip2resource>
+    </tarfileset>
+  </copy>
+
    + +

    downloads the archive some-archive.tar.bz2, uncompresses and +extracts it on the fly, copies the contents of the lib directory into +some-dir and discards the rest of the archive. File timestamps will +be compared between the archive's entries and files inside the target +directory, no files get overwritten unless they are out-of-date.

    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/xmlcatalog.html b/tools/apache-ant-1.8.2/docs/manual/Types/xmlcatalog.html new file mode 100644 index 000000000..a0ddafc0f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/xmlcatalog.html @@ -0,0 +1,306 @@ + + + + + + +XMLCatalog Type + + + + +

    XMLCatalog

    + +

    An XMLCatalog is a catalog of public resources such as DTDs or +entities that are referenced in an XML document. Catalogs are +typically used to make web references to resources point to a locally +cached copy of the resource.

    + +

    This allows the XML Parser, XSLT Processor or other consumer of XML +documents +to efficiently allow a local substitution for a resource available on the +web. +

    +

    Note: This task uses, but does not depend on external +libraries not included in the Apache Ant distribution. See Library Dependencies for more +information.

    +

    This data type provides a catalog of resource locations based +on the +OASIS "Open Catalog" standard. The catalog entries are used +both for Entity resolution and URI resolution, in accordance with +the org.xml.sax.EntityResolver and +javax.xml.transform.URIResolver interfaces as defined +in the Java API for XML +Processing (JAXP) Specification.

    +

    For example, in a web.xml file, the DTD is referenced as: +

    +<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
+  "http://java.sun.com/j2ee/dtds/web-app_2_2.dtd">
+
    +The XML processor, without XMLCatalog support, would need to retrieve the +DTD from +the URL specified whenever validation of the document was required. +

    +

    This can be very time consuming during the build process, +especially where network throughput is limited. Alternatively, you +can do the following: +

      +
    1. Copy web-app_2_2.dtd onto your local disk somewhere (either in the +filesystem or even embedded inside a jar or zip file on the classpath).
      2. +
    2. Create an <xmlcatalog> with a <dtd> +element whose location attribute points to the file.
      3. +
    3. Success! The XML processor will now use the local copy instead of calling out +to the internet.
      4. +
    +

    +

    XMLCatalogs can appear inside tasks +that support this feature or at the same level as target +- i.e., as children of project for reuse across different +tasks, +e.g. XML Validation and XSLT Transformation. The XML Validate task +uses XMLCatalogs for entity resolution. The XSLT Transformation +task uses XMLCatalogs for both entity and URI resolution.

    +

    XMLCatalogs are specified as either a reference to another +XMLCatalog, defined previously in a build file, or as a list of +dtd or entity locations. In addition, +external catalog files may be specified in a nested catalogpath , +but they will be ignored unless the resolver library from +xml-commons is available in the system classpath. Due to backwards +incompatible changes in the resolver code after the release of +resolver 1.0, Ant will not support resolver.jar in version 1.0 - we +expect a resolver release 1.1 to happen before Ant 1.6 gets +released. A separate classpath for entity resolution may be +specified inline via nested classpath elements; otherwise +the system classpath is used for this as well.

    +

    XMLCatalogs can also be nested inside other XMLCatalogs. For +example, a "superset" XMLCatalog could be made by including several +nested XMLCatalogs that referred to other, previously defined +XMLCatalogs.

    +

    Resource locations can be specified either in-line or in +external catalog file(s), or both. In order to use an external +catalog file, the xml-commons resolver library ("resolver.jar") +must be in your path. External catalog files may be either +plain text format or +XML format. If the xml-commons resolver library is not found in the +classpath, external catalog files, specified in catalogpath, +will be ignored and a warning +will be logged. In this case, however, processing of inline entries will +proceed normally.

    +

    Currently, only <dtd> and +<entity> elements may be specified inline; these +roughly correspond to OASIS catalog entry types PUBLIC and +URI respectively. By contrast, external catalog files +may use any of the entry types defined in the + ++OASIS specification.

    +

    Entity/DTD/URI Resolution Algorithm

    + +When an entity, DTD, or URI is looked up by the XML processor, the +XMLCatalog searches its list of entries to see if any match. That is, +it attempts to match the publicId attribute of each entry +with the PublicID or URI of the entity to be resolved. Assuming a +matching entry is found, XMLCatalog then executes the following steps: + +

    1. Filesystem lookup

    + +

    The location is first looked up in the filesystem. If +the location is a relative path, the ant project basedir +attribute is used as the base directory. If the location +specifies an absolute path, it is used as is. Once we have an +absolute path in hand, we check to see if a valid and readable file +exists at that path. If so, we are done. If not, we proceed to the +next step.

    + +

    2. Classpath lookup

    + +

    The location is next looked up in the classpath. +Recall that jar files are merely fancy zip files. For classpath +lookup, the location is used as is (no base is +prepended). We use a Classloader to attempt to load the resource from +the classpath. For example, if hello.jar is in the classpath and it +contains foo/bar/blat.dtd it will resolve an entity whose +location is foo/bar/blat.dtd. Of course, it +will not resolve an entity whose location is +blat.dtd. + + +

    3a. Apache xml-commons resolver lookup

    + +

    What happens next depends on whether the resolver library from +xml-commons is available on the classpath. If so, we defer all +further attempts at resolving to it. The resolver library supports +extremely sophisticated functionality like URL rewriting and so on, +which can be accessed by making the appropriate entries in external +catalog files (XMLCatalog does not yet provide inline support for all +of the entries defined in the OASIS +standard).

    + +

    3. URL-space lookup

    + +

    Finally, we attempt to make a URL out of the location. +At first this may seem like this would defeat the purpose of +XMLCatalogs -- why go back out to the internet? But in fact, this can +be used to (in a sense) implement HTTP redirects, substituting one URL +for another. The mapped-to URL might also be served by a local web +server. If the URL resolves to a valid and readable resource, we are +done. Otherwise, we give up. In this case, the XML processor will +perform its normal resolution algorithm. Depending on the processor +configuration, further resolution failures may or may not result in +fatal (i.e. build-ending) errors.

    + +

    XMLCatalog attributes

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    ida unique name for an XMLCatalog, used for referencing +the + XMLCatalog's contents from another XMLCatalogNo
    refidthe id of another XMLCatalog whose +contents + you would like to be used for this XMLCatalogNo
    + +

    XMLCatalog nested elements

    +

    dtd/entity

    +

    The dtd and entity elements used to specify +XMLCatalogs are identical in their structure

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    publicIdThe public identifier used when defining a dtd or +entity, + e.g. "-//Sun Microsystems, Inc.//DTD Web Application +2.2//EN" + Yes
    locationThe location of the local replacement to be used for +the public identifier specified. This may be specified as a file name, +resource name found on the classpath, or a URL. Relative paths will +be resolved according to the base, which by default is the Ant project +basedir. + Yes
    +

    classpath

    +

    The classpath to use for entity +resolution. The nested <classpath> is a +path-like structure.

    +

    catalogpath

    +

    +The nested catalogpath element is a path-like structure listing catalog files to +search. All files in this path are assumed to be OASIS catalog files, in +either + +plain text format or +XML format. Entries specifying nonexistent files will be ignored. If the +resolver library from xml-commons is not available in the classpath, all +catalogpaths will be ignored and a warning will be logged. +

    +

    Examples

    +

    Set up an XMLCatalog with a single dtd referenced locally in a user's +home +directory:

    +
    +    <xmlcatalog>
+        <dtd 
+            publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
+            location="/home/dion/downloads/docbook/docbookx.dtd"/>
+    </xmlcatalog>
+
    +

    Set up an XMLCatalog with a multiple dtds to be found either in the +filesystem (relative to the Ant project basedir) or in the classpath: +

    +
    +    <xmlcatalog id="commonDTDs">
+        <dtd 
+            publicId="-//OASIS//DTD DocBook XML V4.1.2//EN"
+            location="docbook/docbookx.dtd"/>
+        <dtd 
+            publicId="-//Sun Microsystems, Inc.//DTD Web Application 2.2//EN"
+            location="web-app_2_2.dtd"/>
+    </xmlcatalog>
+
    + +

    Set up an XMLCatalog with a combination of DTDs and entities as +well as a nested XMLCatalog and external catalog files in both +formats:

    + +
    +    <xmlcatalog id="allcatalogs">
+        <dtd 
+            publicId="-//ArielPartners//DTD XML Article V1.0//EN"
+            location="com/arielpartners/knowledgebase/dtd/article.dtd"/>
+        <entity 
+            publicId="LargeLogo"
+            location="com/arielpartners/images/ariel-logo-large.gif"/>
+        <xmlcatalog refid="commonDTDs"/>
+            <catalogpath>
+                <pathelement location="/etc/sgml/catalog"/>
+                <fileset 
+                    dir="/anetwork/drive"
+                    includes="**/catalog"/>
+                <fileset 
+                    dir="/my/catalogs"
+                    includes="**/catalog.xml"/>
+            </catalogpath>
+        </xmlcatalog>
+    </xmlcatalog>
+
    +

    To reference the above XMLCatalog in an xslt task:

    +

    +    <xslt basedir="${source.doc}"
+           destdir="${dest.xdocs}"
+           extension=".xml"
+           style="${source.xsl.converter.docbook}"
+           includes="**/*.xml"
+           force="true">
+        <xmlcatalog refid="allcatalogs"/>
+    </xslt>
+
    + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/Types/zipfileset.html b/tools/apache-ant-1.8.2/docs/manual/Types/zipfileset.html new file mode 100644 index 000000000..c29a8dad7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/Types/zipfileset.html @@ -0,0 +1,147 @@ + + + + + + +ZipFileSet Type + + +

    ZipFileSet

    + +

    A <zipfileset> is a special form of a <fileset> which can behave in 2 +different ways :
    +

    +
      +
    • When the src attribute + is used - or a nested resource collection has been specified + (since Apache Ant 1.7), the zipfileset is populated with + zip entries found in the file src.
      +
      • +
    • When the dir attribute +is used, the zipfileset is populated with filesystem files found under dir.
      +
      • +
    +

    <zipfileset> supports all attributes of <fileset> +in addition to those listed below.
    +

    +

    Since Ant 1.6, a zipfileset can be defined with the id attribute and referred to with +the refid attribute.
    +

    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    prefixall files in the fileset are prefixed with that +path in the archive.No
    fullpaththe file described by the fileset is placed at +that exact location in the archive.No
    srcmay be used in place of the dir attribute + to specify a zip file whose contents will be extracted and included +in the archive.No
    filemodeA 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +plain files. Default is 644. since Ant 1.5.2.No
    dirmodeA 3 digit octal string, specify the user, group +and other modes in the standard Unix fashion. Only applies to +directories. Default is 755. since Ant 1.5.2.No
    encodingThe character encoding to use for filenames + inside the zip file. For a list of possible values see http://download.oracle.com/javase/1.5.0/docs/guide/intl/encoding.doc.html. + Defaults to the platform's default character encoding. + Only supported by zipfileset.No
    erroronmissingarchive + Specify what happens if the archive does not exist. + If true, a build error will happen; if false, the fileset + will be ignored/empty. + Defaults to true. + Since Ant 1.8.0 + No
    +

    The fullpath attribute can only be set for filesets that +represent a single file. The prefix and fullpath +attributes cannot both be set on the same fileset.

    +

    When using the src attribute, include and exclude patterns +may be used to specify a subset of the archive for inclusion in the +archive as with the dir attribute.

    + +

    Please note that currently only the tar and zip tasks use the permission.

    + +

    Parameters specified as nested elements

    + +

    any file system based resource or +single element resource collection

    + +

    The specified resource will be used as src.

    + +

    Examples

    +
    + 
      <zip destfile="${dist}/manual.zip">
        <zipfileset dir="htdocs/manual" prefix="docs/user-guide"/>
        <zipfileset dir="." includes="ChangeLog27.txt" fullpath="docs/ChangeLog.txt"/>
        <zipfileset src="examples.zip" includes="**/*.html" prefix="docs/examples"/>
      </zip>
    +

    zips all files in the htdocs/manual directory into +the docs/user-guide directory in the archive, adds the +file ChangeLog27.txt in the current directory as docs/ChangeLog.txt, +and includes all the html files in examples.zip under docs/examples. +The archive might end up containing the files:

    + docs/user-guide/html/index.html
    +docs/ChangeLog.txt
    +docs/examples/index.html
    +
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/antexternal.html b/tools/apache-ant-1.8.2/docs/manual/antexternal.html new file mode 100644 index 000000000..02d2f7b58 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/antexternal.html @@ -0,0 +1,160 @@ + + + + + + +InputHandler + + + +

    Using Apache Ant™ Tasks Outside of Ant

    + +

    Rationale

    + +

    Apache Ant provides a rich set of tasks for buildfile creators and +administrators. But what about programmers? Can the functionality +provided by Ant tasks be used in java programs?

    + +

    Yes, and its quite easy. Before getting into the details, however, +we should mention the pros and cons of this approach: + +

    Pros

    + + + + + + + + + + + + + + +
    Robust +Ant tasks are very robust. They have been banged on by many people. +Ant tasks have been used in many different contexts, and have +therefore been instrumented to take care of a great many boundary +conditions and potentially obscure errors. +
    Cross Platform +Ant tasks are cross platform. They have been tested on all of the +volume platforms, and several rather unusual ones (Netware and OS/390, to +name a few). +
    Community Support +Using Ant tasks means you have less of your own code to support. Ant +code is supported by the entire Apache Ant community. +
    + +

    Cons

    + + + + + + + + + + +
    Dependency on Ant Libraries +Obviously, if you use an Ant task in your code, you will have to add +"ant.jar" to your path. Of course, you could use a code optimizer to +remove the unnecessary classes, but you will still probably require a +chunk of the Ant core. +
    Loss of Flexibility +At some point, if you find yourself having to modify the Ant code, it +probably makes more sense to "roll your own." Of course, you can +still steal some code snippets and good ideas. This is the beauty of +open source! +
    + + +

    Example

    + +

    Let's say you want to unzip a zip file programmatically from java +into a certain directory. Of course you could write your own routine +to do this, but why not use the Ant task that has already been written?

    + +

    In my example, I wanted to be able to unzip a file from within an +XSLT Transformation. XSLT Transformers can be extended by plugging in +static methods in java. I therefore need a function something like +this:

    + +
    +/**
+ * Unzip a zip file into a given directory.
+ *
+ * @param zipFilepath A pathname representing a local zip file
+ * @param destinationDir where to unzip the archive to
+ */
+ static public void unzip(String zipFilepath, String destinationDir)
+
    + +

    +The Ant task to perform this function is +org.apache.tools.ant.taskdefs.Expand. All we have to do +is create a dummy Ant Project and Target, +set the Task parameters that would normally be set in a +buildfile, and call execute().

    + +

    First, let's make sure we have the proper includes:

    + +
    +import org.apache.tools.ant.Project;
+import org.apache.tools.ant.Target;
+import org.apache.tools.ant.taskdefs.Expand;
+import java.io.File;
+
    + +

    The function call is actually quite simple:

    + +
    +static public void unzip(String zipFilepath, String destinationDir) {
+
+    final class Expander extends Expand {
+        public Expander() {
+ 	    project = new Project();
+	    project.init();
+	    taskType = "unzip";
+	    taskName = "unzip";
+	    target = new Target();
+	}	
+    }
+    Expander expander = new Expander();
+    expander.setSrc(new File(zipfile));
+    expander.setDest(new File(destdir));
+    expander.execute();
+
    + +

    In actual practice, you will probably want to add your own error +handling code and you may not want to use a local inner class. +However, the point of the example is to show how an Ant task can be +called programmatically in relatively few lines of code.

    + +

    The question you are probably asking yourself at this point is: +How would I know which classes and methods have to be called in +order to set up a dummy Project and Target? The answer is: you +don't. Ultimately, you have to be willing to get your feet wet and +read the source code. The above example is merely designed to whet +your appetite and get you started. Go for it!

    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/anttaskslist.html b/tools/apache-ant-1.8.2/docs/manual/anttaskslist.html new file mode 100644 index 000000000..bd1204946 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/anttaskslist.html @@ -0,0 +1,41 @@ + + + + + + +Apache Ant User Manual + + + + + + +

    Table of Contents

    + +

    Apache Ant Tasks

    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/allclasses-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/allclasses-frame.html new file mode 100644 index 000000000..35c508d0f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/allclasses-frame.html @@ -0,0 +1,2002 @@ + + + + + + +All Classes (Apache Ant API) + + + + + + + + + + +All Classes +
    + + + + + +
    AbstractAccessTask +
    +AbstractAnalyzer +
    +AbstractClasspathResource +
    +AbstractClasspathResource.ClassLoaderWithFlag +
    +AbstractCvsTask +
    +AbstractCvsTask.Module +
    +AbstractFileSet +
    +AbstractHotDeploymentTool +
    +AbstractJarSignerTask +
    +AbstractResourceCollectionWrapper +
    +AbstractScriptComponent +
    +AbstractSelectorContainer +
    +AbstractSshMessage +
    +AbstractUnicodeExtraField +
    +AggregateTransformer +
    +AggregateTransformer.Format +
    +Algorithm +
    +AncestorAnalyzer +
    +And +
    +And +
    +AndSelector +
    +AnsiColorLogger +
    +Ant +
    +Ant.Reference +
    +Ant.TargetElement +
    +AntAnalyzer +
    +AntClassLoader +
    +AntClassLoader2 +
    +AntClassLoader5 +
    +AntFilterReader +
    +Antlib +
    +AntlibDefinition +
    +ANTLR +
    +AntMain +
    +AntResolver +
    +AntSoundPlayer +
    +AntStructure +
    +AntStructure.StructurePrinter +
    +AntTypeDefinition +
    +AntVersion +
    +AntXMLContext +
    +ApacheCatalog +
    +ApacheCatalogResolver +
    +Appendable +
    +Apt +
    +Apt.Option +
    +AptCompilerAdapter +
    +AptExternalCompilerAdapter +
    +Arc +
    +ArchiveFileSet +
    +ArchiveResource +
    +Archives +
    +ArchiveScanner +
    +AsiExtraField +
    +Assertions +
    +Assertions.BaseAssertion +
    +Assertions.DisabledAssertion +
    +Assertions.EnabledAssertion +
    +Attrib +
    +AugmentReference +
    +Available +
    +Available.FileDir +
    +Base64Converter +
    +BaseExtendSelector +
    +BaseFilterReader +
    +Basename +
    +BaseParamFilterReader +
    +BaseResourceCollectionContainer +
    +BaseResourceCollectionWrapper +
    +BaseSelector +
    +BaseSelectorContainer +
    +BaseTest +
    +BasicShape +
    +BatchTest +
    +BCFileSet +
    +BigProjectLogger +
    +BindTargets +
    +BlockFor +
    +BorlandDeploymentTool +
    +BorlandGenerateClient +
    +BriefJUnitResultFormatter +
    +BuildEvent +
    +BuildException +
    +BuildListener +
    +BuildLogger +
    +BuildNumber +
    +BuildTimeoutException +
    +BUnzip2 +
    +BZip2 +
    +BZip2Constants +
    +BZip2Resource +
    +Cab +
    +Cache +
    +CallTarget +
    +CBZip2InputStream +
    +CBZip2OutputStream +
    +CCCheckin +
    +CCCheckout +
    +CCLock +
    +CCMCheck +
    +CCMCheckin +
    +CCMCheckinDefault +
    +CCMCheckout +
    +CCMCreateTask +
    +CCMkattr +
    +CCMkbl +
    +CCMkdir +
    +CCMkelem +
    +CCMklabel +
    +CCMklbtype +
    +CCMReconfigure +
    +CCRmtype +
    +CCUnCheckout +
    +CCUnlock +
    +CCUpdate +
    +CentralDirectoryParsingZipExtraField +
    +ChainableReader +
    +ChainedMapper +
    +ChainReaderHelper +
    +ChangeLogTask +
    +ChangeLogWriter +
    +Checksum +
    +Checksum.FormatElement +
    +ChecksumAlgorithm +
    +Chgrp +
    +Chmod +
    +Chown +
    +ClassConstants +
    +ClassCPInfo +
    +ClassFile +
    +ClassFileIterator +
    +ClassfileSet +
    +ClassfileSet.ClassRoot +
    +ClassFileUtils +
    +Classloader +
    +ClassNameReader +
    +ClasspathUtils +
    +ClasspathUtils.Delegate +
    +ClearCase +
    +CloseResources +
    +CollectionUtils +
    +CollectionUtils.EmptyEnumeration +
    +ColorMapper +
    +Commandline +
    +Commandline.Argument +
    +CommandlineJava +
    +CommandlineJava.SysProperties +
    +CommonsLoggingListener +
    +Compare +
    +Comparison +
    +Compatability +
    +Compatibility +
    +CompilerAdapter +
    +CompilerAdapterExtension +
    +CompilerAdapterFactory +
    +Componentdef +
    +ComponentHelper +
    +CompositeMapper +
    +CompressedResource +
    +Concat +
    +Concat.TextElement +
    +ConcatFileInputStream +
    +ConcatFilter +
    +ConcatResourceInputStream +
    +Condition +
    +ConditionBase +
    +ConditionTask +
    +ConstantCPInfo +
    +ConstantPool +
    +ConstantPoolEntry +
    +Constants +
    +ContainerMapper +
    +Contains +
    +ContainsRegexpSelector +
    +ContainsSelector +
    +Content +
    +ContentTransformingResource +
    +Continuus +
    +Copy +
    +Copydir +
    +Copyfile +
    +CopyPath +
    +CutDirsMapper +
    +Cvs +
    +CVSEntry +
    +CVSPass +
    +CvsTagDiff +
    +CvsTagEntry +
    +CvsUser +
    +CvsVersion +
    +DataType +
    +Date +
    +Date +
    +DateSelector +
    +DateSelector.TimeComparisons +
    +DateUtils +
    +DefaultCompilerAdapter +
    +DefaultExcludes +
    +DefaultExecutor +
    +DefaultInputHandler +
    +DefaultJspCompilerAdapter +
    +DefaultLogger +
    +DefaultNative2Ascii +
    +DefaultRmicAdapter +
    +DefBase +
    +Definer +
    +Definer.Format +
    +Definer.OnError +
    +DelegatedResourceComparator +
    +Delete +
    +Deltree +
    +DemuxInputStream +
    +DemuxOutputStream +
    +Depend +
    +DependencyAnalyzer +
    +DependencyVisitor +
    +DependScanner +
    +DependSelector +
    +DependSet +
    +DepthSelector +
    +Description +
    +DescriptorHandler +
    +DeweyDecimal +
    +DeweyDecimal +
    +Diagnostics +
    +DiagnosticsTask +
    +Difference +
    +DifferentSelector +
    +DigestAlgorithm +
    +Directory +
    +DirectoryIterator +
    +DirectoryScanner +
    +Dirname +
    +DirSet +
    +Dispatchable +
    +DispatchTask +
    +DispatchUtils +
    +DOMElementWriter +
    +DOMElementWriter.XmlNamespacePolicy +
    +DOMUtil +
    +DOMUtil.NodeFilter +
    +DOMUtil.NodeListImpl +
    +DOMUtils +
    +DoubleCPInfo +
    +Draw +
    +DrawOperation +
    +DTDLocation +
    +DynamicAttribute +
    +DynamicAttributeNS +
    +DynamicConfigurator +
    +DynamicConfiguratorNS +
    +DynamicElement +
    +DynamicElementNS +
    +Ear +
    +Echo +
    +Echo.EchoLevel +
    +EchoProperties +
    +EchoProperties.FormatAttribute +
    +EchoXML +
    +EchoXML.NamespacePolicy +
    +EJBDeploymentTool +
    +EjbJar +
    +EjbJar.CMPVersion +
    +EjbJar.DTDLocation +
    +EjbJar.NamingScheme +
    +Ellipse +
    +EmailAddress +
    +EmailTask +
    +EmailTask.Encoding +
    +EnumeratedAttribute +
    +Enumerations +
    +Environment +
    +Environment.Variable +
    +EqualComparator +
    +Equals +
    +ErrorInQuitException +
    +EscapeUnicode +
    +Exec +
    +ExecTask +
    +Execute +
    +ExecuteJava +
    +ExecuteOn +
    +ExecuteOn.FileDirBoth +
    +ExecuteStreamHandler +
    +ExecuteWatchdog +
    +Executor +
    +Exists +
    +Exists +
    +Exit +
    +ExitException +
    +ExitStatusException +
    +Expand +
    +ExpandProperties +
    +ExtendFileSelector +
    +ExtendSelector +
    +Extension +
    +ExtensionAdapter +
    +ExtensionPoint +
    +ExtensionResolver +
    +ExtensionSet +
    +ExtensionUtil +
    +ExtraAttribute +
    +ExtraFieldUtils +
    +ExtraFieldUtils.UnparseableExtraField +
    +FacadeTaskHelper +
    +FailureRecorder +
    +FailureRecorder.TestInfos +
    +FieldRefCPInfo +
    +FileList +
    +FileList.FileName +
    +FileNameMapper +
    +FilenameSelector +
    +FileProvider +
    +FileResource +
    +FileResourceIterator +
    +Files +
    +FileScanner +
    +FileSelector +
    +FileSet +
    +FilesMatch +
    +FileSystem +
    +FileTokenizer +
    +FileUtils +
    +Filter +
    +FilterChain +
    +FilterMapper +
    +FilterSet +
    +FilterSet.Filter +
    +FilterSet.OnMissing +
    +FilterSetCollection +
    +First +
    +FirstMatchMapper +
    +FixCRLF +
    +FixCRLF.AddAsisRemove +
    +FixCRLF.CrLf +
    +FixCrLfFilter +
    +FixCrLfFilter.AddAsisRemove +
    +FixCrLfFilter.CrLf +
    +FlatFileNameMapper +
    +FlexInteger +
    +FloatCPInfo +
    +ForkingSunRmic +
    +FormatterElement +
    +FormatterElement.TypeAttribute +
    +FTP +
    +FTP.Action +
    +FTP.FTPFileProxy +
    +FTP.FTPSystemType +
    +FTP.Granularity +
    +FTP.LanguageCode +
    +FTPTask +
    +FTPTask.Action +
    +FTPTask.FTPSystemType +
    +FTPTask.Granularity +
    +FTPTaskMirror +
    +FTPTaskMirrorImpl +
    +FTPTaskMirrorImpl.FTPFileProxy +
    +FullAnalyzer +
    +Funtest +
    +Gcj +
    +Gcjh +
    +GenerateKey +
    +GenerateKey.DistinguishedName +
    +GenerateKey.DnameParam +
    +GenericDeploymentTool +
    +GenericHotDeploymentTool +
    +Get +
    +Get.Base64Converter +
    +Get.DownloadProgress +
    +Get.NullProgress +
    +Get.VerboseProgress +
    +GetProperty +
    +GlobPatternMapper +
    +GreedyInputHandler +
    +GUnzip +
    +GZip +
    +GZipResource +
    +HasFreeSpace +
    +HashvalueAlgorithm +
    +HasMethod +
    +Header +
    +HeadFilter +
    +HostInfo +
    +HotDeploymentTool +
    +Http +
    +IdentityMapper +
    +IdentityStack +
    +IgnoreDependenciesExecutor +
    +Image +
    +ImageOperation +
    +ImmutableResourceException +
    +ImplementationSpecificArgument +
    +ImportTask +
    +InnerClassFilenameFilter +
    +Input +
    +Input.HandlerType +
    +InputHandler +
    +InputRequest +
    +InstanceOf +
    +IntegerCPInfo +
    +InterfaceMethodRefCPInfo +
    +Intersect +
    +IntrospectionHelper +
    +IntrospectionHelper.Creator +
    +IPlanetDeploymentTool +
    +IPlanetEjbc +
    +IPlanetEjbcTask +
    +IsFailure +
    +IsFalse +
    +IsFileSelected +
    +IsLastModified +
    +IsLastModified.CompareMode +
    +IsReachable +
    +IsReference +
    +IsSet +
    +IsSigned +
    +IsTrue +
    +JakartaOroMatcher +
    +JakartaOroRegexp +
    +JakartaRegexpMatcher +
    +JakartaRegexpRegexp +
    +Jar +
    +Jar.FilesetManifestConfig +
    +Jar.StrictMode +
    +JarFileIterator +
    +JarLibAvailableTask +
    +JarLibDisplayTask +
    +JarLibManifestTask +
    +JarLibResolveTask +
    +JarMarker +
    +Jasper41Mangler +
    +JasperC +
    +Java +
    +Javac +
    +Javac12 +
    +Javac13 +
    +JavaCC +
    +JavacExternal +
    +JavaClassHelper +
    +JavaConstantResource +
    +Javadoc +
    +Javadoc.AccessType +
    +Javadoc.ExtensionInfo +
    +Javadoc.Html +
    +Javadoc.PackageName +
    +Javadoc.SourceFile +
    +JavaEnvUtils +
    +Javah +
    +JavahAdapter +
    +JavahAdapterFactory +
    +JavaResource +
    +JavaxScriptRunner +
    +JAXPUtils +
    +JbossDeploymentTool +
    +JDBCTask +
    +JDependTask +
    +JDependTask.FormatAttribute +
    +Jdk14RegexpMatcher +
    +Jdk14RegexpRegexp +
    +Jikes +
    +Jikes +
    +JikesOutputParser +
    +JJDoc +
    +JJTree +
    +jlink +
    +JlinkTask +
    +JonasDeploymentTool +
    +JonasHotDeploymentTool +
    +JspC +
    +JspC.WebAppParameter +
    +JspCompilerAdapter +
    +JspCompilerAdapterFactory +
    +JspMangler +
    +JspNameMangler +
    +JUnit4TestMethodAdapter +
    +JUnitResultFormatter +
    +JUnitTask +
    +JUnitTask.ForkMode +
    +JUnitTask.JUnitLogOutputStream +
    +JUnitTask.JUnitLogStreamHandler +
    +JUnitTask.SummaryAttribute +
    +JUnitTask.TestResultHolder +
    +JUnitTaskMirror +
    +JUnitTaskMirror.JUnitResultFormatterMirror +
    +JUnitTaskMirror.JUnitTestRunnerMirror +
    +JUnitTaskMirror.SummaryJUnitResultFormatterMirror +
    +JUnitTaskMirrorImpl +
    +JUnitTest +
    +JUnitTestRunner +
    +JUnitVersionHelper +
    +Jvc +
    +Kaffeh +
    +KaffeNative2Ascii +
    +KaffeRmic +
    +KeepAliveInputStream +
    +KeepAliveOutputStream +
    +KeySubst +
    +Kjc +
    +Last +
    +Launcher +
    +LaunchException +
    +LayoutPreservingProperties +
    +LazyFileOutputStream +
    +LazyHashtable +
    +LazyResourceCollectionWrapper +
    +LeadPipeInputStream +
    +Length +
    +Length.FileMode +
    +Length.When +
    +LibFileSet +
    +LineContains +
    +LineContains.Contains +
    +LineContainsRegExp +
    +LineOrientedOutputStream +
    +LineTokenizer +
    +LinkedHashtable +
    +LoaderUtils +
    +LoadFile +
    +LoadProperties +
    +LoadResource +
    +Local +
    +LocalProperties +
    +LocalPropertyStack +
    +Location +
    +LocationResolver +
    +Locator +
    +Log4jListener +
    +LogLevel +
    +LogListener +
    +LogOutputResource +
    +LogOutputStream +
    +LogStreamHandler +
    +LongCPInfo +
    +MacroDef +
    +MacroDef.Attribute +
    +MacroDef.NestedSequential +
    +MacroDef.TemplateElement +
    +MacroDef.Text +
    +MacroInstance +
    +MacroInstance.Element +
    +MagicNames +
    +Mailer +
    +MailLogger +
    +MailMessage +
    +Main +
    +Majority +
    +MajoritySelector +
    +MakeUrl +
    +Manifest +
    +Manifest.Attribute +
    +Manifest.Section +
    +ManifestClassPath +
    +ManifestException +
    +ManifestTask +
    +ManifestTask.Mode +
    +MappedResource +
    +MappedResourceCollection +
    +Mapper +
    +Mapper.MapperType +
    +MappingSelector +
    +Matches +
    +MatchingTask +
    +MergingMapper +
    +Message +
    +MethodRefCPInfo +
    +MimeMail +
    +MimeMailer +
    +Mkdir +
    +ModifiedSelector +
    +ModifiedSelector.AlgorithmName +
    +ModifiedSelector.CacheName +
    +ModifiedSelector.ComparatorName +
    +Move +
    +MSVSS +
    +MSVSS.CurrentModUpdated +
    +MSVSS.WritableFiles +
    +MSVSSADD +
    +MSVSSCHECKIN +
    +MSVSSCHECKOUT +
    +MSVSSConstants +
    +MSVSSCP +
    +MSVSSCREATE +
    +MSVSSGET +
    +MSVSSHISTORY +
    +MSVSSHISTORY.BriefCodediffNofile +
    +MSVSSLABEL +
    +MultipleChoiceInputRequest +
    +Name +
    +Name +
    +NameAndTypeCPInfo +
    +Native2Ascii +
    +Native2AsciiAdapter +
    +Native2AsciiAdapterFactory +
    +NetRexxC +
    +NetRexxC.TraceAttr +
    +NetRexxC.VerboseAttr +
    +Nice +
    +NoBannerLogger +
    +NoExitSecurityManager +
    +None +
    +NoneSelector +
    +Not +
    +Not +
    +NotSelector +
    +NullReturn +
    +Or +
    +Or +
    +OrSelector +
    +Os +
    +OutErrSummaryJUnitResultFormatter +
    +OutputStreamFunneler +
    +P4Add +
    +P4Base +
    +P4Change +
    +P4Counter +
    +P4Delete +
    +P4Edit +
    +P4Fstat +
    +P4Handler +
    +P4HandlerAdapter +
    +P4Have +
    +P4Integrate +
    +P4Label +
    +P4Labelsync +
    +P4OutputHandler +
    +P4OutputStream +
    +P4Reopen +
    +P4Resolve +
    +P4Revert +
    +P4Submit +
    +P4Sync +
    +Pack +
    +PackageNameMapper +
    +Parallel +
    +Parallel.TaskList +
    +Parameter +
    +Parameterizable +
    +ParseNextProperty +
    +ParseProperties +
    +ParserSupports +
    +Patch +
    +Path +
    +PathConvert +
    +PathConvert.TargetOs +
    +PathTokenizer +
    +PatternSet +
    +Permissions +
    +Permissions.Permission +
    +PlainJUnitResultFormatter +
    +PrefixLines +
    +PresentSelector +
    +PresentSelector.FilePresence +
    +PreSetDef +
    +PreSetDef.PreSetDefinition +
    +ProfileLogger +
    +Project +
    +ProjectComponent +
    +ProjectHelper +
    +ProjectHelper.OnMissingExtensionPoint +
    +ProjectHelper2 +
    +ProjectHelper2.AntHandler +
    +ProjectHelper2.ElementHandler +
    +ProjectHelper2.MainHandler +
    +ProjectHelper2.ProjectHandler +
    +ProjectHelper2.RootHandler +
    +ProjectHelper2.TargetHandler +
    +ProjectHelperImpl +
    +ProjectHelperRepository +
    +ProjectHelperTask +
    +PropertiesfileCache +
    +Property +
    +PropertyExpander +
    +PropertyFile +
    +PropertyFile.Entry +
    +PropertyFile.Entry.Operation +
    +PropertyFile.Entry.Type +
    +PropertyFile.Unit +
    +PropertyFileInputHandler +
    +PropertyHelper +
    +PropertyHelper.Delegate +
    +PropertyHelper.PropertyEvaluator +
    +PropertyHelper.PropertySetter +
    +PropertyHelperTask +
    +PropertyOutputStream +
    +PropertyResource +
    +PropertySet +
    +PropertySet.BuiltinPropertySetName +
    +PropertySet.PropertyRef +
    +Provider +
    +ProxyDiagnostics +
    +ProxySetup +
    +PumpStreamHandler +
    +PumpStreamHandler.ThreadWithPumper +
    +Pvcs +
    +PvcsProject +
    +Quantifier +
    +ReadableSelector +
    +ReaderInputStream +
    +Recorder +
    +Recorder.ActionChoices +
    +Recorder.VerbosityLevelChoices +
    +RecorderEntry +
    +Rectangle +
    +Redirector +
    +RedirectorElement +
    +Reference +
    +ReflectUtil +
    +ReflectWrapper +
    +Regexp +
    +RegexpFactory +
    +RegexpMatcher +
    +RegexpMatcherFactory +
    +RegexpPatternMapper +
    +RegexpUtil +
    +RegularExpression +
    +Rename +
    +RenameExtensions +
    +Replace +
    +ReplaceRegExp +
    +ReplaceTokens +
    +ReplaceTokens.Token +
    +ResolvePropertyMap +
    +Resource +
    +ResourceCollection +
    +ResourceComparator +
    +ResourceContains +
    +ResourceCount +
    +ResourceDecorator +
    +ResourceExists +
    +ResourceFactory +
    +ResourceList +
    +ResourceLocation +
    +Resources +
    +ResourceSelector +
    +ResourceSelectorContainer +
    +ResourcesMatch +
    +ResourceUtils +
    +ResourceUtils.ResourceSelectorProvider +
    +Restrict +
    +Retry +
    +Retryable +
    +RetryHandler +
    +Reverse +
    +RExecTask +
    +Rmic +
    +RmicAdapter +
    +RmicAdapterFactory +
    +Rotate +
    +Rpm +
    +RuntimeConfigurable +
    +Scale +
    +Scale.ProportionsAttribute +
    +SchemaValidate +
    +SchemaValidate.SchemaLocation +
    +Scp +
    +ScpFromMessage +
    +ScpFromMessageBySftp +
    +ScpToMessage +
    +ScpToMessageBySftp +
    +Script +
    +ScriptCondition +
    +ScriptDef +
    +ScriptDef.Attribute +
    +ScriptDef.NestedElement +
    +ScriptDefBase +
    +ScriptFilter +
    +ScriptFixBSFPath +
    +ScriptMapper +
    +ScriptRunner +
    +ScriptRunner +
    +ScriptRunnerBase +
    +ScriptRunnerCreator +
    +ScriptRunnerHelper +
    +ScriptSelector +
    +SecureInputHandler +
    +SelectorContainer +
    +SelectorScanner +
    +SelectorUtils +
    +SelectSelector +
    +SendEmail +
    +Sequential +
    +ServerDeploy +
    +Service +
    +SetProxy +
    +SignedSelector +
    +SignJar +
    +SimpleBigProjectLogger +
    +SimpleP4OutputHandler +
    +SingleCheckExecutor +
    +Size +
    +Size +
    +SizeLimitCollection +
    +SizeSelector +
    +SizeSelector.ByteUnits +
    +SizeSelector.SizeComparisons +
    +Sj +
    +Sleep +
    +SmtpResponseReader +
    +Socket +
    +Sort +
    +SortFilter +
    +SOS +
    +SOSCheckin +
    +SOSCheckout +
    +SOSCmd +
    +SOSGet +
    +SOSLabel +
    +SoundTask +
    +SourceFileScanner +
    +Specification +
    +SplashTask +
    +SplitClassLoader +
    +SQLExec +
    +SQLExec.DelimiterType +
    +SQLExec.OnError +
    +SSHBase +
    +SSHExec +
    +SSHSession +
    +SSHSession.NestedSequential +
    +SSHUserInfo +
    +StreamPumper +
    +StringCPInfo +
    +StringInputStream +
    +StringResource +
    +StringTokenizer +
    +StringUtils +
    +StripJavaComments +
    +StripLineBreaks +
    +StripLineComments +
    +StripLineComments.Comment +
    +SubAnt +
    +SubBuildListener +
    +Substitution +
    +SuffixLines +
    +SummaryJUnitResultFormatter +
    +SunJavah +
    +SunNative2Ascii +
    +SunRmic +
    +SymbolicLinkUtils +
    +Symlink +
    +Sync +
    +Sync.MyCopy +
    +Sync.SyncTarget +
    +TabsToSpaces +
    +TailFilter +
    +Tar +
    +Tar.TarCompressionMethod +
    +Tar.TarFileSet +
    +Tar.TarLongFileMode +
    +TarBuffer +
    +TarConstants +
    +TarEntry +
    +TarFileSet +
    +Target +
    +TarInputStream +
    +TarOutputStream +
    +TarResource +
    +TarScanner +
    +TarUtils +
    +Task +
    +TaskAdapter +
    +TaskConfigurationChecker +
    +TaskContainer +
    +Taskdef +
    +TaskLogger +
    +TaskOutputStream +
    +TearDownOnVmCrash +
    +TeeOutputStream +
    +TelnetTask +
    +TempFile +
    +Text +
    +TimeComparison +
    +TimeoutObserver +
    +TimestampedLogger +
    +TokenFilter +
    +TokenFilter.ChainableReaderFilter +
    +TokenFilter.ContainsRegex +
    +TokenFilter.ContainsString +
    +TokenFilter.DeleteCharacters +
    +TokenFilter.FileTokenizer +
    +TokenFilter.Filter +
    +TokenFilter.IgnoreBlank +
    +TokenFilter.ReplaceRegex +
    +TokenFilter.ReplaceString +
    +TokenFilter.StringTokenizer +
    +TokenFilter.Trim +
    +TokenizedPath +
    +TokenizedPattern +
    +Tokenizer +
    +Tokens +
    +Touch +
    +Touch.DateFormatFactory +
    +Touchable +
    +Transform +
    +TransformOperation +
    +Translate +
    +TraXLiaison +
    +Truncate +
    +Tstamp +
    +Tstamp.Unit +
    +Type +
    +Type +
    +Type.FileDir +
    +TypeAdapter +
    +Typedef +
    +TypeFound +
    +TypeSelector +
    +TypeSelector.FileType +
    +UnicodeCommentExtraField +
    +UnicodePathExtraField +
    +Union +
    +UniqFilter +
    +UnixStat +
    +UnknownElement +
    +Unpack +
    +UnPackageNameMapper +
    +UnparseableExtraFieldData +
    +UnrecognizedExtraField +
    +UnsupportedAttributeException +
    +UnsupportedElementException +
    +Untar +
    +Untar.UntarCompressionMethod +
    +UpToDate +
    +URLProvider +
    +URLResolver +
    +URLResource +
    +Utf8CPInfo +
    +UUEncoder +
    +VectorSet +
    +VerifyJar +
    +WaitFor +
    +WaitFor.Unit +
    +War +
    +Watchdog +
    +WeakishReference +
    +WeakishReference.HardReference +
    +WeakishReference12 +
    +WeblogicDeploymentTool +
    +WebLogicHotDeploymentTool +
    +WeblogicTOPLinkDeploymentTool +
    +WebsphereDeploymentTool +
    +WhichResource +
    +WLJspc +
    +WLRmic +
    +WorkerAnt +
    +WritableSelector +
    +Xalan2TraceSupport +
    +XMLCatalog +
    +XMLConstants +
    +XmlConstants +
    +XMLFragment +
    +XMLJUnitResultFormatter +
    +XmlLogger +
    +XmlProperty +
    +XMLResultAggregator +
    +XMLValidateTask +
    +XMLValidateTask.Attribute +
    +XMLValidateTask.Property +
    +XNewRmic +
    +Xor +
    +XSLTLiaison +
    +XSLTLiaison2 +
    +XSLTLiaison3 +
    +XSLTLogger +
    +XSLTLoggerAware +
    +XSLTProcess +
    +XSLTProcess.Factory +
    +XSLTProcess.Factory.Attribute +
    +XSLTProcess.OutputProperty +
    +XSLTProcess.Param +
    +XSLTTraceSupport +
    +Zip +
    +Zip.ArchiveState +
    +Zip.Duplicate +
    +Zip.UnicodeExtraField +
    +Zip.WhenEmpty +
    +ZipEntry +
    +ZipExtraField +
    +ZipFile +
    +ZipFileSet +
    +ZipLong +
    +ZipOutputStream +
    +ZipOutputStream.UnicodeExtraFieldPolicy +
    +ZipResource +
    +ZipScanner +
    +ZipShort +
    +ZipUtil +
    +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/allclasses-noframe.html b/tools/apache-ant-1.8.2/docs/manual/api/allclasses-noframe.html new file mode 100644 index 000000000..0a5c0542f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/allclasses-noframe.html @@ -0,0 +1,2002 @@ + + + + + + +All Classes (Apache Ant API) + + + + + + + + + + +All Classes +
    + + + + + +
    AbstractAccessTask +
    +AbstractAnalyzer +
    +AbstractClasspathResource +
    +AbstractClasspathResource.ClassLoaderWithFlag +
    +AbstractCvsTask +
    +AbstractCvsTask.Module +
    +AbstractFileSet +
    +AbstractHotDeploymentTool +
    +AbstractJarSignerTask +
    +AbstractResourceCollectionWrapper +
    +AbstractScriptComponent +
    +AbstractSelectorContainer +
    +AbstractSshMessage +
    +AbstractUnicodeExtraField +
    +AggregateTransformer +
    +AggregateTransformer.Format +
    +Algorithm +
    +AncestorAnalyzer +
    +And +
    +And +
    +AndSelector +
    +AnsiColorLogger +
    +Ant +
    +Ant.Reference +
    +Ant.TargetElement +
    +AntAnalyzer +
    +AntClassLoader +
    +AntClassLoader2 +
    +AntClassLoader5 +
    +AntFilterReader +
    +Antlib +
    +AntlibDefinition +
    +ANTLR +
    +AntMain +
    +AntResolver +
    +AntSoundPlayer +
    +AntStructure +
    +AntStructure.StructurePrinter +
    +AntTypeDefinition +
    +AntVersion +
    +AntXMLContext +
    +ApacheCatalog +
    +ApacheCatalogResolver +
    +Appendable +
    +Apt +
    +Apt.Option +
    +AptCompilerAdapter +
    +AptExternalCompilerAdapter +
    +Arc +
    +ArchiveFileSet +
    +ArchiveResource +
    +Archives +
    +ArchiveScanner +
    +AsiExtraField +
    +Assertions +
    +Assertions.BaseAssertion +
    +Assertions.DisabledAssertion +
    +Assertions.EnabledAssertion +
    +Attrib +
    +AugmentReference +
    +Available +
    +Available.FileDir +
    +Base64Converter +
    +BaseExtendSelector +
    +BaseFilterReader +
    +Basename +
    +BaseParamFilterReader +
    +BaseResourceCollectionContainer +
    +BaseResourceCollectionWrapper +
    +BaseSelector +
    +BaseSelectorContainer +
    +BaseTest +
    +BasicShape +
    +BatchTest +
    +BCFileSet +
    +BigProjectLogger +
    +BindTargets +
    +BlockFor +
    +BorlandDeploymentTool +
    +BorlandGenerateClient +
    +BriefJUnitResultFormatter +
    +BuildEvent +
    +BuildException +
    +BuildListener +
    +BuildLogger +
    +BuildNumber +
    +BuildTimeoutException +
    +BUnzip2 +
    +BZip2 +
    +BZip2Constants +
    +BZip2Resource +
    +Cab +
    +Cache +
    +CallTarget +
    +CBZip2InputStream +
    +CBZip2OutputStream +
    +CCCheckin +
    +CCCheckout +
    +CCLock +
    +CCMCheck +
    +CCMCheckin +
    +CCMCheckinDefault +
    +CCMCheckout +
    +CCMCreateTask +
    +CCMkattr +
    +CCMkbl +
    +CCMkdir +
    +CCMkelem +
    +CCMklabel +
    +CCMklbtype +
    +CCMReconfigure +
    +CCRmtype +
    +CCUnCheckout +
    +CCUnlock +
    +CCUpdate +
    +CentralDirectoryParsingZipExtraField +
    +ChainableReader +
    +ChainedMapper +
    +ChainReaderHelper +
    +ChangeLogTask +
    +ChangeLogWriter +
    +Checksum +
    +Checksum.FormatElement +
    +ChecksumAlgorithm +
    +Chgrp +
    +Chmod +
    +Chown +
    +ClassConstants +
    +ClassCPInfo +
    +ClassFile +
    +ClassFileIterator +
    +ClassfileSet +
    +ClassfileSet.ClassRoot +
    +ClassFileUtils +
    +Classloader +
    +ClassNameReader +
    +ClasspathUtils +
    +ClasspathUtils.Delegate +
    +ClearCase +
    +CloseResources +
    +CollectionUtils +
    +CollectionUtils.EmptyEnumeration +
    +ColorMapper +
    +Commandline +
    +Commandline.Argument +
    +CommandlineJava +
    +CommandlineJava.SysProperties +
    +CommonsLoggingListener +
    +Compare +
    +Comparison +
    +Compatability +
    +Compatibility +
    +CompilerAdapter +
    +CompilerAdapterExtension +
    +CompilerAdapterFactory +
    +Componentdef +
    +ComponentHelper +
    +CompositeMapper +
    +CompressedResource +
    +Concat +
    +Concat.TextElement +
    +ConcatFileInputStream +
    +ConcatFilter +
    +ConcatResourceInputStream +
    +Condition +
    +ConditionBase +
    +ConditionTask +
    +ConstantCPInfo +
    +ConstantPool +
    +ConstantPoolEntry +
    +Constants +
    +ContainerMapper +
    +Contains +
    +ContainsRegexpSelector +
    +ContainsSelector +
    +Content +
    +ContentTransformingResource +
    +Continuus +
    +Copy +
    +Copydir +
    +Copyfile +
    +CopyPath +
    +CutDirsMapper +
    +Cvs +
    +CVSEntry +
    +CVSPass +
    +CvsTagDiff +
    +CvsTagEntry +
    +CvsUser +
    +CvsVersion +
    +DataType +
    +Date +
    +Date +
    +DateSelector +
    +DateSelector.TimeComparisons +
    +DateUtils +
    +DefaultCompilerAdapter +
    +DefaultExcludes +
    +DefaultExecutor +
    +DefaultInputHandler +
    +DefaultJspCompilerAdapter +
    +DefaultLogger +
    +DefaultNative2Ascii +
    +DefaultRmicAdapter +
    +DefBase +
    +Definer +
    +Definer.Format +
    +Definer.OnError +
    +DelegatedResourceComparator +
    +Delete +
    +Deltree +
    +DemuxInputStream +
    +DemuxOutputStream +
    +Depend +
    +DependencyAnalyzer +
    +DependencyVisitor +
    +DependScanner +
    +DependSelector +
    +DependSet +
    +DepthSelector +
    +Description +
    +DescriptorHandler +
    +DeweyDecimal +
    +DeweyDecimal +
    +Diagnostics +
    +DiagnosticsTask +
    +Difference +
    +DifferentSelector +
    +DigestAlgorithm +
    +Directory +
    +DirectoryIterator +
    +DirectoryScanner +
    +Dirname +
    +DirSet +
    +Dispatchable +
    +DispatchTask +
    +DispatchUtils +
    +DOMElementWriter +
    +DOMElementWriter.XmlNamespacePolicy +
    +DOMUtil +
    +DOMUtil.NodeFilter +
    +DOMUtil.NodeListImpl +
    +DOMUtils +
    +DoubleCPInfo +
    +Draw +
    +DrawOperation +
    +DTDLocation +
    +DynamicAttribute +
    +DynamicAttributeNS +
    +DynamicConfigurator +
    +DynamicConfiguratorNS +
    +DynamicElement +
    +DynamicElementNS +
    +Ear +
    +Echo +
    +Echo.EchoLevel +
    +EchoProperties +
    +EchoProperties.FormatAttribute +
    +EchoXML +
    +EchoXML.NamespacePolicy +
    +EJBDeploymentTool +
    +EjbJar +
    +EjbJar.CMPVersion +
    +EjbJar.DTDLocation +
    +EjbJar.NamingScheme +
    +Ellipse +
    +EmailAddress +
    +EmailTask +
    +EmailTask.Encoding +
    +EnumeratedAttribute +
    +Enumerations +
    +Environment +
    +Environment.Variable +
    +EqualComparator +
    +Equals +
    +ErrorInQuitException +
    +EscapeUnicode +
    +Exec +
    +ExecTask +
    +Execute +
    +ExecuteJava +
    +ExecuteOn +
    +ExecuteOn.FileDirBoth +
    +ExecuteStreamHandler +
    +ExecuteWatchdog +
    +Executor +
    +Exists +
    +Exists +
    +Exit +
    +ExitException +
    +ExitStatusException +
    +Expand +
    +ExpandProperties +
    +ExtendFileSelector +
    +ExtendSelector +
    +Extension +
    +ExtensionAdapter +
    +ExtensionPoint +
    +ExtensionResolver +
    +ExtensionSet +
    +ExtensionUtil +
    +ExtraAttribute +
    +ExtraFieldUtils +
    +ExtraFieldUtils.UnparseableExtraField +
    +FacadeTaskHelper +
    +FailureRecorder +
    +FailureRecorder.TestInfos +
    +FieldRefCPInfo +
    +FileList +
    +FileList.FileName +
    +FileNameMapper +
    +FilenameSelector +
    +FileProvider +
    +FileResource +
    +FileResourceIterator +
    +Files +
    +FileScanner +
    +FileSelector +
    +FileSet +
    +FilesMatch +
    +FileSystem +
    +FileTokenizer +
    +FileUtils +
    +Filter +
    +FilterChain +
    +FilterMapper +
    +FilterSet +
    +FilterSet.Filter +
    +FilterSet.OnMissing +
    +FilterSetCollection +
    +First +
    +FirstMatchMapper +
    +FixCRLF +
    +FixCRLF.AddAsisRemove +
    +FixCRLF.CrLf +
    +FixCrLfFilter +
    +FixCrLfFilter.AddAsisRemove +
    +FixCrLfFilter.CrLf +
    +FlatFileNameMapper +
    +FlexInteger +
    +FloatCPInfo +
    +ForkingSunRmic +
    +FormatterElement +
    +FormatterElement.TypeAttribute +
    +FTP +
    +FTP.Action +
    +FTP.FTPFileProxy +
    +FTP.FTPSystemType +
    +FTP.Granularity +
    +FTP.LanguageCode +
    +FTPTask +
    +FTPTask.Action +
    +FTPTask.FTPSystemType +
    +FTPTask.Granularity +
    +FTPTaskMirror +
    +FTPTaskMirrorImpl +
    +FTPTaskMirrorImpl.FTPFileProxy +
    +FullAnalyzer +
    +Funtest +
    +Gcj +
    +Gcjh +
    +GenerateKey +
    +GenerateKey.DistinguishedName +
    +GenerateKey.DnameParam +
    +GenericDeploymentTool +
    +GenericHotDeploymentTool +
    +Get +
    +Get.Base64Converter +
    +Get.DownloadProgress +
    +Get.NullProgress +
    +Get.VerboseProgress +
    +GetProperty +
    +GlobPatternMapper +
    +GreedyInputHandler +
    +GUnzip +
    +GZip +
    +GZipResource +
    +HasFreeSpace +
    +HashvalueAlgorithm +
    +HasMethod +
    +Header +
    +HeadFilter +
    +HostInfo +
    +HotDeploymentTool +
    +Http +
    +IdentityMapper +
    +IdentityStack +
    +IgnoreDependenciesExecutor +
    +Image +
    +ImageOperation +
    +ImmutableResourceException +
    +ImplementationSpecificArgument +
    +ImportTask +
    +InnerClassFilenameFilter +
    +Input +
    +Input.HandlerType +
    +InputHandler +
    +InputRequest +
    +InstanceOf +
    +IntegerCPInfo +
    +InterfaceMethodRefCPInfo +
    +Intersect +
    +IntrospectionHelper +
    +IntrospectionHelper.Creator +
    +IPlanetDeploymentTool +
    +IPlanetEjbc +
    +IPlanetEjbcTask +
    +IsFailure +
    +IsFalse +
    +IsFileSelected +
    +IsLastModified +
    +IsLastModified.CompareMode +
    +IsReachable +
    +IsReference +
    +IsSet +
    +IsSigned +
    +IsTrue +
    +JakartaOroMatcher +
    +JakartaOroRegexp +
    +JakartaRegexpMatcher +
    +JakartaRegexpRegexp +
    +Jar +
    +Jar.FilesetManifestConfig +
    +Jar.StrictMode +
    +JarFileIterator +
    +JarLibAvailableTask +
    +JarLibDisplayTask +
    +JarLibManifestTask +
    +JarLibResolveTask +
    +JarMarker +
    +Jasper41Mangler +
    +JasperC +
    +Java +
    +Javac +
    +Javac12 +
    +Javac13 +
    +JavaCC +
    +JavacExternal +
    +JavaClassHelper +
    +JavaConstantResource +
    +Javadoc +
    +Javadoc.AccessType +
    +Javadoc.ExtensionInfo +
    +Javadoc.Html +
    +Javadoc.PackageName +
    +Javadoc.SourceFile +
    +JavaEnvUtils +
    +Javah +
    +JavahAdapter +
    +JavahAdapterFactory +
    +JavaResource +
    +JavaxScriptRunner +
    +JAXPUtils +
    +JbossDeploymentTool +
    +JDBCTask +
    +JDependTask +
    +JDependTask.FormatAttribute +
    +Jdk14RegexpMatcher +
    +Jdk14RegexpRegexp +
    +Jikes +
    +Jikes +
    +JikesOutputParser +
    +JJDoc +
    +JJTree +
    +jlink +
    +JlinkTask +
    +JonasDeploymentTool +
    +JonasHotDeploymentTool +
    +JspC +
    +JspC.WebAppParameter +
    +JspCompilerAdapter +
    +JspCompilerAdapterFactory +
    +JspMangler +
    +JspNameMangler +
    +JUnit4TestMethodAdapter +
    +JUnitResultFormatter +
    +JUnitTask +
    +JUnitTask.ForkMode +
    +JUnitTask.JUnitLogOutputStream +
    +JUnitTask.JUnitLogStreamHandler +
    +JUnitTask.SummaryAttribute +
    +JUnitTask.TestResultHolder +
    +JUnitTaskMirror +
    +JUnitTaskMirror.JUnitResultFormatterMirror +
    +JUnitTaskMirror.JUnitTestRunnerMirror +
    +JUnitTaskMirror.SummaryJUnitResultFormatterMirror +
    +JUnitTaskMirrorImpl +
    +JUnitTest +
    +JUnitTestRunner +
    +JUnitVersionHelper +
    +Jvc +
    +Kaffeh +
    +KaffeNative2Ascii +
    +KaffeRmic +
    +KeepAliveInputStream +
    +KeepAliveOutputStream +
    +KeySubst +
    +Kjc +
    +Last +
    +Launcher +
    +LaunchException +
    +LayoutPreservingProperties +
    +LazyFileOutputStream +
    +LazyHashtable +
    +LazyResourceCollectionWrapper +
    +LeadPipeInputStream +
    +Length +
    +Length.FileMode +
    +Length.When +
    +LibFileSet +
    +LineContains +
    +LineContains.Contains +
    +LineContainsRegExp +
    +LineOrientedOutputStream +
    +LineTokenizer +
    +LinkedHashtable +
    +LoaderUtils +
    +LoadFile +
    +LoadProperties +
    +LoadResource +
    +Local +
    +LocalProperties +
    +LocalPropertyStack +
    +Location +
    +LocationResolver +
    +Locator +
    +Log4jListener +
    +LogLevel +
    +LogListener +
    +LogOutputResource +
    +LogOutputStream +
    +LogStreamHandler +
    +LongCPInfo +
    +MacroDef +
    +MacroDef.Attribute +
    +MacroDef.NestedSequential +
    +MacroDef.TemplateElement +
    +MacroDef.Text +
    +MacroInstance +
    +MacroInstance.Element +
    +MagicNames +
    +Mailer +
    +MailLogger +
    +MailMessage +
    +Main +
    +Majority +
    +MajoritySelector +
    +MakeUrl +
    +Manifest +
    +Manifest.Attribute +
    +Manifest.Section +
    +ManifestClassPath +
    +ManifestException +
    +ManifestTask +
    +ManifestTask.Mode +
    +MappedResource +
    +MappedResourceCollection +
    +Mapper +
    +Mapper.MapperType +
    +MappingSelector +
    +Matches +
    +MatchingTask +
    +MergingMapper +
    +Message +
    +MethodRefCPInfo +
    +MimeMail +
    +MimeMailer +
    +Mkdir +
    +ModifiedSelector +
    +ModifiedSelector.AlgorithmName +
    +ModifiedSelector.CacheName +
    +ModifiedSelector.ComparatorName +
    +Move +
    +MSVSS +
    +MSVSS.CurrentModUpdated +
    +MSVSS.WritableFiles +
    +MSVSSADD +
    +MSVSSCHECKIN +
    +MSVSSCHECKOUT +
    +MSVSSConstants +
    +MSVSSCP +
    +MSVSSCREATE +
    +MSVSSGET +
    +MSVSSHISTORY +
    +MSVSSHISTORY.BriefCodediffNofile +
    +MSVSSLABEL +
    +MultipleChoiceInputRequest +
    +Name +
    +Name +
    +NameAndTypeCPInfo +
    +Native2Ascii +
    +Native2AsciiAdapter +
    +Native2AsciiAdapterFactory +
    +NetRexxC +
    +NetRexxC.TraceAttr +
    +NetRexxC.VerboseAttr +
    +Nice +
    +NoBannerLogger +
    +NoExitSecurityManager +
    +None +
    +NoneSelector +
    +Not +
    +Not +
    +NotSelector +
    +NullReturn +
    +Or +
    +Or +
    +OrSelector +
    +Os +
    +OutErrSummaryJUnitResultFormatter +
    +OutputStreamFunneler +
    +P4Add +
    +P4Base +
    +P4Change +
    +P4Counter +
    +P4Delete +
    +P4Edit +
    +P4Fstat +
    +P4Handler +
    +P4HandlerAdapter +
    +P4Have +
    +P4Integrate +
    +P4Label +
    +P4Labelsync +
    +P4OutputHandler +
    +P4OutputStream +
    +P4Reopen +
    +P4Resolve +
    +P4Revert +
    +P4Submit +
    +P4Sync +
    +Pack +
    +PackageNameMapper +
    +Parallel +
    +Parallel.TaskList +
    +Parameter +
    +Parameterizable +
    +ParseNextProperty +
    +ParseProperties +
    +ParserSupports +
    +Patch +
    +Path +
    +PathConvert +
    +PathConvert.TargetOs +
    +PathTokenizer +
    +PatternSet +
    +Permissions +
    +Permissions.Permission +
    +PlainJUnitResultFormatter +
    +PrefixLines +
    +PresentSelector +
    +PresentSelector.FilePresence +
    +PreSetDef +
    +PreSetDef.PreSetDefinition +
    +ProfileLogger +
    +Project +
    +ProjectComponent +
    +ProjectHelper +
    +ProjectHelper.OnMissingExtensionPoint +
    +ProjectHelper2 +
    +ProjectHelper2.AntHandler +
    +ProjectHelper2.ElementHandler +
    +ProjectHelper2.MainHandler +
    +ProjectHelper2.ProjectHandler +
    +ProjectHelper2.RootHandler +
    +ProjectHelper2.TargetHandler +
    +ProjectHelperImpl +
    +ProjectHelperRepository +
    +ProjectHelperTask +
    +PropertiesfileCache +
    +Property +
    +PropertyExpander +
    +PropertyFile +
    +PropertyFile.Entry +
    +PropertyFile.Entry.Operation +
    +PropertyFile.Entry.Type +
    +PropertyFile.Unit +
    +PropertyFileInputHandler +
    +PropertyHelper +
    +PropertyHelper.Delegate +
    +PropertyHelper.PropertyEvaluator +
    +PropertyHelper.PropertySetter +
    +PropertyHelperTask +
    +PropertyOutputStream +
    +PropertyResource +
    +PropertySet +
    +PropertySet.BuiltinPropertySetName +
    +PropertySet.PropertyRef +
    +Provider +
    +ProxyDiagnostics +
    +ProxySetup +
    +PumpStreamHandler +
    +PumpStreamHandler.ThreadWithPumper +
    +Pvcs +
    +PvcsProject +
    +Quantifier +
    +ReadableSelector +
    +ReaderInputStream +
    +Recorder +
    +Recorder.ActionChoices +
    +Recorder.VerbosityLevelChoices +
    +RecorderEntry +
    +Rectangle +
    +Redirector +
    +RedirectorElement +
    +Reference +
    +ReflectUtil +
    +ReflectWrapper +
    +Regexp +
    +RegexpFactory +
    +RegexpMatcher +
    +RegexpMatcherFactory +
    +RegexpPatternMapper +
    +RegexpUtil +
    +RegularExpression +
    +Rename +
    +RenameExtensions +
    +Replace +
    +ReplaceRegExp +
    +ReplaceTokens +
    +ReplaceTokens.Token +
    +ResolvePropertyMap +
    +Resource +
    +ResourceCollection +
    +ResourceComparator +
    +ResourceContains +
    +ResourceCount +
    +ResourceDecorator +
    +ResourceExists +
    +ResourceFactory +
    +ResourceList +
    +ResourceLocation +
    +Resources +
    +ResourceSelector +
    +ResourceSelectorContainer +
    +ResourcesMatch +
    +ResourceUtils +
    +ResourceUtils.ResourceSelectorProvider +
    +Restrict +
    +Retry +
    +Retryable +
    +RetryHandler +
    +Reverse +
    +RExecTask +
    +Rmic +
    +RmicAdapter +
    +RmicAdapterFactory +
    +Rotate +
    +Rpm +
    +RuntimeConfigurable +
    +Scale +
    +Scale.ProportionsAttribute +
    +SchemaValidate +
    +SchemaValidate.SchemaLocation +
    +Scp +
    +ScpFromMessage +
    +ScpFromMessageBySftp +
    +ScpToMessage +
    +ScpToMessageBySftp +
    +Script +
    +ScriptCondition +
    +ScriptDef +
    +ScriptDef.Attribute +
    +ScriptDef.NestedElement +
    +ScriptDefBase +
    +ScriptFilter +
    +ScriptFixBSFPath +
    +ScriptMapper +
    +ScriptRunner +
    +ScriptRunner +
    +ScriptRunnerBase +
    +ScriptRunnerCreator +
    +ScriptRunnerHelper +
    +ScriptSelector +
    +SecureInputHandler +
    +SelectorContainer +
    +SelectorScanner +
    +SelectorUtils +
    +SelectSelector +
    +SendEmail +
    +Sequential +
    +ServerDeploy +
    +Service +
    +SetProxy +
    +SignedSelector +
    +SignJar +
    +SimpleBigProjectLogger +
    +SimpleP4OutputHandler +
    +SingleCheckExecutor +
    +Size +
    +Size +
    +SizeLimitCollection +
    +SizeSelector +
    +SizeSelector.ByteUnits +
    +SizeSelector.SizeComparisons +
    +Sj +
    +Sleep +
    +SmtpResponseReader +
    +Socket +
    +Sort +
    +SortFilter +
    +SOS +
    +SOSCheckin +
    +SOSCheckout +
    +SOSCmd +
    +SOSGet +
    +SOSLabel +
    +SoundTask +
    +SourceFileScanner +
    +Specification +
    +SplashTask +
    +SplitClassLoader +
    +SQLExec +
    +SQLExec.DelimiterType +
    +SQLExec.OnError +
    +SSHBase +
    +SSHExec +
    +SSHSession +
    +SSHSession.NestedSequential +
    +SSHUserInfo +
    +StreamPumper +
    +StringCPInfo +
    +StringInputStream +
    +StringResource +
    +StringTokenizer +
    +StringUtils +
    +StripJavaComments +
    +StripLineBreaks +
    +StripLineComments +
    +StripLineComments.Comment +
    +SubAnt +
    +SubBuildListener +
    +Substitution +
    +SuffixLines +
    +SummaryJUnitResultFormatter +
    +SunJavah +
    +SunNative2Ascii +
    +SunRmic +
    +SymbolicLinkUtils +
    +Symlink +
    +Sync +
    +Sync.MyCopy +
    +Sync.SyncTarget +
    +TabsToSpaces +
    +TailFilter +
    +Tar +
    +Tar.TarCompressionMethod +
    +Tar.TarFileSet +
    +Tar.TarLongFileMode +
    +TarBuffer +
    +TarConstants +
    +TarEntry +
    +TarFileSet +
    +Target +
    +TarInputStream +
    +TarOutputStream +
    +TarResource +
    +TarScanner +
    +TarUtils +
    +Task +
    +TaskAdapter +
    +TaskConfigurationChecker +
    +TaskContainer +
    +Taskdef +
    +TaskLogger +
    +TaskOutputStream +
    +TearDownOnVmCrash +
    +TeeOutputStream +
    +TelnetTask +
    +TempFile +
    +Text +
    +TimeComparison +
    +TimeoutObserver +
    +TimestampedLogger +
    +TokenFilter +
    +TokenFilter.ChainableReaderFilter +
    +TokenFilter.ContainsRegex +
    +TokenFilter.ContainsString +
    +TokenFilter.DeleteCharacters +
    +TokenFilter.FileTokenizer +
    +TokenFilter.Filter +
    +TokenFilter.IgnoreBlank +
    +TokenFilter.ReplaceRegex +
    +TokenFilter.ReplaceString +
    +TokenFilter.StringTokenizer +
    +TokenFilter.Trim +
    +TokenizedPath +
    +TokenizedPattern +
    +Tokenizer +
    +Tokens +
    +Touch +
    +Touch.DateFormatFactory +
    +Touchable +
    +Transform +
    +TransformOperation +
    +Translate +
    +TraXLiaison +
    +Truncate +
    +Tstamp +
    +Tstamp.Unit +
    +Type +
    +Type +
    +Type.FileDir +
    +TypeAdapter +
    +Typedef +
    +TypeFound +
    +TypeSelector +
    +TypeSelector.FileType +
    +UnicodeCommentExtraField +
    +UnicodePathExtraField +
    +Union +
    +UniqFilter +
    +UnixStat +
    +UnknownElement +
    +Unpack +
    +UnPackageNameMapper +
    +UnparseableExtraFieldData +
    +UnrecognizedExtraField +
    +UnsupportedAttributeException +
    +UnsupportedElementException +
    +Untar +
    +Untar.UntarCompressionMethod +
    +UpToDate +
    +URLProvider +
    +URLResolver +
    +URLResource +
    +Utf8CPInfo +
    +UUEncoder +
    +VectorSet +
    +VerifyJar +
    +WaitFor +
    +WaitFor.Unit +
    +War +
    +Watchdog +
    +WeakishReference +
    +WeakishReference.HardReference +
    +WeakishReference12 +
    +WeblogicDeploymentTool +
    +WebLogicHotDeploymentTool +
    +WeblogicTOPLinkDeploymentTool +
    +WebsphereDeploymentTool +
    +WhichResource +
    +WLJspc +
    +WLRmic +
    +WorkerAnt +
    +WritableSelector +
    +Xalan2TraceSupport +
    +XMLCatalog +
    +XMLConstants +
    +XmlConstants +
    +XMLFragment +
    +XMLJUnitResultFormatter +
    +XmlLogger +
    +XmlProperty +
    +XMLResultAggregator +
    +XMLValidateTask +
    +XMLValidateTask.Attribute +
    +XMLValidateTask.Property +
    +XNewRmic +
    +Xor +
    +XSLTLiaison +
    +XSLTLiaison2 +
    +XSLTLiaison3 +
    +XSLTLogger +
    +XSLTLoggerAware +
    +XSLTProcess +
    +XSLTProcess.Factory +
    +XSLTProcess.Factory.Attribute +
    +XSLTProcess.OutputProperty +
    +XSLTProcess.Param +
    +XSLTTraceSupport +
    +Zip +
    +Zip.ArchiveState +
    +Zip.Duplicate +
    +Zip.UnicodeExtraField +
    +Zip.WhenEmpty +
    +ZipEntry +
    +ZipExtraField +
    +ZipFile +
    +ZipFileSet +
    +ZipLong +
    +ZipOutputStream +
    +ZipOutputStream.UnicodeExtraFieldPolicy +
    +ZipResource +
    +ZipScanner +
    +ZipShort +
    +ZipUtil +
    +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/constant-values.html b/tools/apache-ant-1.8.2/docs/manual/api/constant-values.html new file mode 100644 index 000000000..d0ef90819 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/constant-values.html @@ -0,0 +1,6966 @@ + + + + + + +Constant Field Values (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents + + + + + + +
    +org.apache.*
    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.ComponentHelper
    +public static final java.lang.StringCOMPONENT_HELPER_REFERENCE"ant.ComponentHelper"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.DefaultLogger
    +public static final intLEFT_COLUMN_SIZE12
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.Diagnostics
    +protected static final java.lang.StringERROR_PROPERTY_ACCESS_BLOCKED"Access to this property blocked by a security manager"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.DirectoryScanner
    +public static final java.lang.StringDOES_NOT_EXIST_POSTFIX" does not exist."
    +public static final intMAX_LEVELS_OF_SYMLINKS5
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.IntrospectionHelper
    +protected static final java.lang.StringNOT_SUPPORTED_CHILD_POSTFIX"\" element."
    +protected static final java.lang.StringNOT_SUPPORTED_CHILD_PREFIX" doesn\'t support the nested \""
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.MagicNames
    +public static final java.lang.StringANT_EXECUTOR_CLASSNAME"ant.executor.class"
    +public static final java.lang.StringANT_EXECUTOR_REFERENCE"ant.executor"
    +public static final java.lang.StringANT_FILE"ant.file"
    +public static final java.lang.StringANT_FILE_TYPE"ant.file.type"
    +public static final java.lang.StringANT_FILE_TYPE_FILE"file"
    +public static final java.lang.StringANT_FILE_TYPE_URL"url"
    +public static final java.lang.StringANT_HOME"ant.home"
    +public static final java.lang.StringANT_JAVA_VERSION"ant.java.version"
    +public static final java.lang.StringANT_LIB"ant.core.lib"
    +public static final java.lang.StringANT_VERSION"ant.version"
    +public static final java.lang.StringANTLIB_PREFIX"antlib:"
    +public static final java.lang.StringBUILD_JAVAC_SOURCE"ant.build.javac.source"
    +public static final java.lang.StringBUILD_JAVAC_TARGET"ant.build.javac.target"
    +public static final java.lang.StringBUILD_SYSCLASSPATH"build.sysclasspath"
    +public static final java.lang.StringPROJECT_BASEDIR"basedir"
    +public static final java.lang.StringPROJECT_DEFAULT_TARGET"ant.project.default-target"
    +public static final java.lang.StringPROJECT_HELPER_CLASS"org.apache.tools.ant.ProjectHelper"
    +public static final java.lang.StringPROJECT_HELPER_SERVICE"META-INF/services/org.apache.tools.ant.ProjectHelper"
    +public static final java.lang.StringPROJECT_INVOKED_TARGETS"ant.project.invoked-targets"
    +public static final java.lang.StringPROJECT_NAME"ant.project.name"
    +public static final java.lang.StringREFID_CLASSPATH_LOADER_PREFIX"ant.loader."
    +public static final java.lang.StringREFID_CLASSPATH_REUSE_LOADER"ant.reuse.loader"
    +public static final java.lang.StringREFID_LOCAL_PROPERTIES"ant.LocalProperties"
    +public static final java.lang.StringREFID_PROJECT_HELPER"ant.projectHelper"
    +public static final java.lang.StringREFID_PROPERTY_HELPER"ant.PropertyHelper"
    +public static final java.lang.StringREGEXP_IMPL"ant.regexp.regexpimpl"
    +public static final java.lang.StringREPOSITORY_DIR_PROPERTY"ant.maven.repository.dir"
    +public static final java.lang.StringREPOSITORY_URL_PROPERTY"ant.maven.repository.url"
    +public static final java.lang.StringSCRIPT_REPOSITORY"org.apache.ant.scriptrepo"
    +public static final java.lang.StringSYSTEM_LOADER_REF"ant.coreLoader"
    +public static final java.lang.StringTASKDEF_PROPERTIES_RESOURCE"/org/apache/tools/ant/taskdefs/defaults.properties"
    +public static final java.lang.StringTYPEDEFS_PROPERTIES_RESOURCE"/org/apache/tools/ant/types/defaults.properties"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.Main
    +public static final java.lang.StringDEFAULT_BUILD_FILENAME"build.xml"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.Project
    +public static final java.lang.StringJAVA_1_0"1.0"
    +public static final java.lang.StringJAVA_1_1"1.1"
    +public static final java.lang.StringJAVA_1_2"1.2"
    +public static final java.lang.StringJAVA_1_3"1.3"
    +public static final java.lang.StringJAVA_1_4"1.4"
    +public static final intMSG_DEBUG4
    +public static final intMSG_ERR0
    +public static final intMSG_INFO2
    +public static final intMSG_VERBOSE3
    +public static final intMSG_WARN1
    +public static final java.lang.StringTOKEN_END"@"
    +public static final java.lang.StringTOKEN_START"@"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.ProjectHelper
    +public static final java.lang.StringANT_CORE_URI"antlib:org.apache.tools.ant"
    +public static final java.lang.StringANT_CURRENT_URI"ant:current"
    +public static final java.lang.StringANT_TYPE"ant-type"
    +public static final java.lang.StringANTLIB_URI"antlib:"
    +public static final java.lang.StringHELPER_PROPERTY"org.apache.tools.ant.ProjectHelper"
    +public static final java.lang.StringPROJECTHELPER_REFERENCE"ant.projectHelper"
    +public static final java.lang.StringSERVICE_ID"META-INF/services/org.apache.tools.ant.ProjectHelper"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.helper.ProjectHelper2
    +public static final java.lang.StringREFID_TARGETS"ant.targets"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.input.PropertyFileInputHandler
    +public static final java.lang.StringFILE_NAME_KEY"ant.input.properties"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.launch.Launcher
    +public static final java.lang.StringANT_PRIVATEDIR".ant"
    +public static final java.lang.StringANT_PRIVATELIB"lib"
    +public static final java.lang.StringANTHOME_PROPERTY"ant.home"
    +public static final java.lang.StringANTLIBDIR_PROPERTY"ant.library.dir"
    +protected static final intEXIT_CODE_ERROR2
    +public static final java.lang.StringMAIN_CLASS"org.apache.tools.ant.Main"
    +public static final java.lang.StringUSER_HOMEDIR"user.home"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.launch.Locator
    +public static final java.lang.StringERROR_NOT_FILE_URI"Can only handle valid file: URIs, not "
    +public static final java.lang.StringURI_ENCODING"UTF-8"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.listener.BigProjectLogger
    +public static final java.lang.StringFOOTER"======================================================================"
    +public static final java.lang.StringHEADER"======================================================================"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.listener.CommonsLoggingListener
    +public static final java.lang.StringPROJECT_LOG"org.apache.tools.ant.Project"
    +public static final java.lang.StringTARGET_LOG"org.apache.tools.ant.Target"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.listener.Log4jListener
    +public static final java.lang.StringLOG_ANT"org.apache.tools.ant"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.listener.TimestampedLogger
    +public static final java.lang.StringSPACER" - at "
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.AbstractCvsTask
    +public static final intDEFAULT_COMPRESSION_LEVEL3
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.AbstractJarSignerTask
    +public static final java.lang.StringERROR_NO_SOURCE"jar must be set through jar attribute or nested filesets"
    +protected static final java.lang.StringJARSIGNER_COMMAND"jarsigner"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Antlib
    +public static final java.lang.StringTAG"antlib"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Apt
    +public static final java.lang.StringERROR_IGNORING_COMPILER_OPTION"Ignoring compiler attribute for the APT task, as it is fixed"
    +public static final java.lang.StringERROR_WRONG_JAVA_VERSION"Apt task requires Java 1.5+"
    +public static final java.lang.StringEXECUTABLE_NAME"apt"
    +public static final java.lang.StringWARNING_IGNORING_FORK"Apt only runs in its own JVM; fork=false option ignored"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Classloader
    +public static final java.lang.StringSYSTEM_LOADER_REF"ant.coreLoader"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.CopyPath
    +public static final java.lang.StringERROR_NO_DESTDIR"No destDir specified"
    +public static final java.lang.StringERROR_NO_MAPPER"No mapper specified"
    +public static final java.lang.StringERROR_NO_PATH"No path specified"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Definer.Format
    +public static final intPROPERTIES0
    +public static final intXML1
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Definer.OnError
    +public static final intFAIL0
    +public static final intFAIL_ALL3
    +public static final intIGNORE2
    +public static final java.lang.StringPOLICY_FAIL"fail"
    +public static final java.lang.StringPOLICY_FAILALL"failall"
    +public static final java.lang.StringPOLICY_IGNORE"ignore"
    +public static final java.lang.StringPOLICY_REPORT"report"
    +public static final intREPORT1
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Execute
    +public static final intINVALID2147483647
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth
    +public static final java.lang.StringDIR"dir"
    +public static final java.lang.StringFILE"file"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Expand
    +public static final java.lang.StringERROR_MULTIPLE_MAPPERS"Cannot define more than one mapper"
    +public static final java.lang.StringNATIVE_ENCODING"native-encoding"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.FixCRLF
    +public static final java.lang.StringERROR_FILE_AND_SRCDIR"<fixcrlf> error: srcdir and file are mutually exclusive"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.MakeUrl
    +public static final java.lang.StringERROR_MISSING_FILE"A source file is missing :"
    +public static final java.lang.StringERROR_NO_FILES"No files defined"
    +public static final java.lang.StringERROR_NO_PROPERTY"No property defined"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Manifest
    +public static final java.lang.StringATTRIBUTE_CLASSPATH"Class-Path"
    +public static final java.lang.StringATTRIBUTE_FROM"From"
    +public static final java.lang.StringATTRIBUTE_MANIFEST_VERSION"Manifest-Version"
    +public static final java.lang.StringATTRIBUTE_NAME"Name"
    +public static final java.lang.StringATTRIBUTE_SIGNATURE_VERSION"Signature-Version"
    +public static final java.lang.StringDEFAULT_MANIFEST_VERSION"1.0"
    +public static final java.lang.StringEOL"\r\n"
    +public static final java.lang.StringERROR_FROM_FORBIDDEN"Manifest attributes should not start with \"From\" in \""
    +public static final java.lang.StringJAR_ENCODING"UTF-8"
    +public static final intMAX_LINE_LENGTH72
    +public static final intMAX_SECTION_LENGTH70
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.ManifestTask
    +public static final java.lang.StringVALID_ATTRIBUTE_CHARS"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Rmic
    +public static final java.lang.StringERROR_BASE_NOT_SET"base or destdir attribute must be set!"
    +public static final java.lang.StringERROR_LOADING_CAUSED_EXCEPTION". Loading caused Exception: "
    +public static final java.lang.StringERROR_NO_BASE_EXISTS"base or destdir does not exist: "
    +public static final java.lang.StringERROR_NOT_A_DIR"base or destdir is not a directory:"
    +public static final java.lang.StringERROR_NOT_DEFINED". It is not defined."
    +public static final java.lang.StringERROR_NOT_FOUND". It could not be found."
    +public static final java.lang.StringERROR_RMIC_FAILED"Rmic failed; see the compiler error output for details."
    +public static final java.lang.StringERROR_UNABLE_TO_VERIFY_CLASS"Unable to verify class "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.SignJar
    +public static final java.lang.StringERROR_BAD_MAP"Cannot map source file to anything sensible: "
    +public static final java.lang.StringERROR_MAPPER_WITHOUT_DEST"The destDir attribute is required if a mapper is set"
    +public static final java.lang.StringERROR_NO_ALIAS"alias attribute must be set"
    +public static final java.lang.StringERROR_NO_STOREPASS"storepass attribute must be set"
    +public static final java.lang.StringERROR_SIGNEDJAR_AND_PATHS"You cannot specify the signed JAR when using paths or filesets"
    +public static final java.lang.StringERROR_TODIR_AND_SIGNEDJAR"\'destdir\' and \'signedjar\' cannot both be set"
    +public static final java.lang.StringERROR_TOO_MANY_MAPPERS"Too many mappers"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.SQLExec.DelimiterType
    +public static final java.lang.StringNORMAL"normal"
    +public static final java.lang.StringROW"row"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Tar
    +public static final java.lang.StringFAIL"fail"
    +public static final java.lang.StringGNU"gnu"
    +public static final java.lang.StringOMIT"omit"
    +public static final java.lang.StringTRUNCATE"truncate"
    +public static final java.lang.StringWARN"warn"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.Tar.TarLongFileMode
    +public static final java.lang.StringFAIL"fail"
    +public static final java.lang.StringGNU"gnu"
    +public static final java.lang.StringOMIT"omit"
    +public static final java.lang.StringTRUNCATE"truncate"
    +public static final java.lang.StringWARN"warn"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.VerifyJar
    +public static final java.lang.StringERROR_NO_FILE"Not found :"
    +public static final java.lang.StringERROR_NO_VERIFY"Failed to verify "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.WaitFor
    +public static final longDEFAULT_CHECK_MILLIS500L
    +public static final longDEFAULT_MAX_WAIT_MILLIS180000L
    +public static final longONE_DAY86400000L
    +public static final longONE_HOUR3600000L
    +public static final longONE_MILLISECOND1L
    +public static final longONE_MINUTE60000L
    +public static final longONE_SECOND1000L
    +public static final longONE_WEEK604800000L
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.WaitFor.Unit
    +public static final java.lang.StringDAY"day"
    +public static final java.lang.StringHOUR"hour"
    +public static final java.lang.StringMILLISECOND"millisecond"
    +public static final java.lang.StringMINUTE"minute"
    +public static final java.lang.StringSECOND"second"
    +public static final java.lang.StringWEEK"week"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.XSLTLiaison
    +public static final java.lang.StringFILE_PROTOCOL_PREFIX"file://"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.XSLTProcess
    +public static final java.lang.StringPROCESSOR_TRAX"trax"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter
    +public static final java.lang.StringAPT_ENTRY_POINT"com.sun.tools.apt.Main"
    +public static final java.lang.StringAPT_METHOD_NAME"process"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.compilers.Javac12
    +protected static final java.lang.StringCLASSIC_COMPILER_CLASSNAME"sun.tools.javac.Main"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.condition.IsReachable
    +public static final intDEFAULT_TIMEOUT30
    +public static final java.lang.StringERROR_BAD_TIMEOUT"Invalid timeout value"
    +public static final java.lang.StringERROR_BAD_URL"Bad URL "
    +public static final java.lang.StringERROR_BOTH_TARGETS"Both url and host have been specified"
    +public static final java.lang.StringERROR_NO_HOST_IN_URL"No hostname in URL "
    +public static final java.lang.StringERROR_NO_HOSTNAME"No hostname defined"
    +public static final java.lang.StringERROR_ON_NETWORK"network error to "
    +public static final java.lang.StringMETHOD_NAME"isReachable"
    +public static final java.lang.StringMSG_NO_REACHABLE_TEST"cannot do a proper reachability test on this Java version"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.condition.Os
    +public static final java.lang.StringFAMILY_9X"win9x"
    +public static final java.lang.StringFAMILY_DOS"dos"
    +public static final java.lang.StringFAMILY_MAC"mac"
    +public static final java.lang.StringFAMILY_NETWARE"netware"
    +public static final java.lang.StringFAMILY_NT"winnt"
    +public static final java.lang.StringFAMILY_OS2"os/2"
    +public static final java.lang.StringFAMILY_OS400"os/400"
    +public static final java.lang.StringFAMILY_TANDEM"tandem"
    +public static final java.lang.StringFAMILY_UNIX"unix"
    +public static final java.lang.StringFAMILY_VMS"openvms"
    +public static final java.lang.StringFAMILY_WINDOWS"windows"
    +public static final java.lang.StringFAMILY_ZOS"z/os"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.condition.ParserSupports
    +public static final java.lang.StringERROR_BOTH_ATTRIBUTES"Property and feature attributes are exclusive"
    +public static final java.lang.StringERROR_NO_ATTRIBUTES"Neither feature or property are set"
    +public static final java.lang.StringERROR_NO_VALUE"A value is needed when testing for property support"
    +public static final java.lang.StringFEATURE"feature"
    +public static final java.lang.StringNOT_RECOGNIZED" not recognized: "
    +public static final java.lang.StringNOT_SUPPORTED" not supported: "
    +public static final java.lang.StringPROPERTY"property"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.email.EmailTask
    +public static final java.lang.StringAUTO"auto"
    +public static final java.lang.StringMIME"mime"
    +public static final java.lang.StringPLAIN"plain"
    +public static final java.lang.StringUU"uu"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation
    +public static final intDECREMENT_OPER1
    +public static final intDELETE_OPER3
    +public static final intEQUALS_OPER2
    +public static final intINCREMENT_OPER0
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type
    +public static final intDATE_TYPE1
    +public static final intINTEGER_TYPE0
    +public static final intSTRING_TYPE2
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.SchemaValidate
    +public static final java.lang.StringERROR_DUPLICATE_SCHEMA"Duplicate declaration of schema "
    +public static final java.lang.StringERROR_NO_XSD_SUPPORT"Parser does not support Xerces or JAXP schema features"
    +public static final java.lang.StringERROR_PARSER_CREATION_FAILURE"Could not create parser"
    +public static final java.lang.StringERROR_SAX_1"SAX1 parsers are not supported"
    +public static final java.lang.StringERROR_TOO_MANY_DEFAULT_SCHEMAS"Only one of defaultSchemaFile and defaultSchemaURL allowed"
    +public static final java.lang.StringMESSAGE_ADDING_SCHEMA"Adding schema "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation
    +public static final java.lang.StringERROR_NO_FILE"File not found: "
    +public static final java.lang.StringERROR_NO_LOCATION"No file or URL supplied for the schema "
    +public static final java.lang.StringERROR_NO_URI"No namespace URI"
    +public static final java.lang.StringERROR_NO_URL_REPRESENTATION"Cannot make a URL of "
    +public static final java.lang.StringERROR_TWO_LOCATIONS"Both URL and File were given for schema "
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.XMLValidateTask
    +protected static final java.lang.StringINIT_FAILED_MSG"Could not start xml validation: "
    +public static final java.lang.StringMESSAGE_FILES_VALIDATED" file(s) have been successfully validated."
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
    +public static final java.lang.StringFLAG_COMMENT"/comment"
    +public static final java.lang.StringFLAG_TASK"/task"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault
    +public static final java.lang.StringDEFAULT_TASK"default"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask
    +public static final java.lang.StringFLAG_COMMENT"/synopsis"
    +public static final java.lang.StringFLAG_PLATFORM"/plat"
    +public static final java.lang.StringFLAG_RELEASE"/release"
    +public static final java.lang.StringFLAG_RESOLVER"/resolver"
    +public static final java.lang.StringFLAG_SUBSYSTEM"/subsystem"
    +public static final java.lang.StringFLAG_TASK"/task"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure
    +public static final java.lang.StringFLAG_PROJECT"/project"
    +public static final java.lang.StringFLAG_RECURSE"/recurse"
    +public static final java.lang.StringFLAG_VERBOSE"/verbose"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ccm.Continuus
    +public static final java.lang.StringCOMMAND_CHECKIN"ci"
    +public static final java.lang.StringCOMMAND_CHECKOUT"co"
    +public static final java.lang.StringCOMMAND_CREATE_TASK"create_task"
    +public static final java.lang.StringCOMMAND_DEFAULT_TASK"default_task"
    +public static final java.lang.StringCOMMAND_RECONFIGURE"reconfigure"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_IDENTICAL"-identical"
    +public static final java.lang.StringFLAG_KEEPCOPY"-keep"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_NOWARN"-nwarn"
    +public static final java.lang.StringFLAG_PRESERVETIME"-ptime"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout
    +public static final java.lang.StringFLAG_BRANCH"-branch"
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_NODATA"-ndata"
    +public static final java.lang.StringFLAG_NOWARN"-nwarn"
    +public static final java.lang.StringFLAG_OUT"-out"
    +public static final java.lang.StringFLAG_RESERVED"-reserved"
    +public static final java.lang.StringFLAG_UNRESERVED"-unreserved"
    +public static final java.lang.StringFLAG_VERSION"-version"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCLock
    +public static final java.lang.StringFLAG_COMMENT"-comment"
    +public static final java.lang.StringFLAG_NUSERS"-nusers"
    +public static final java.lang.StringFLAG_OBSOLETE"-obsolete"
    +public static final java.lang.StringFLAG_PNAME"-pname"
    +public static final java.lang.StringFLAG_REPLACE"-replace"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_RECURSE"-recurse"
    +public static final java.lang.StringFLAG_REPLACE"-replace"
    +public static final java.lang.StringFLAG_VERSION"-version"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_FULL"-full"
    +public static final java.lang.StringFLAG_IDENTICAL"-identical"
    +public static final java.lang.StringFLAG_INCREMENTAL"-incremental"
    +public static final java.lang.StringFLAG_NLABEL"-nlabel"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_NOCHECKOUT"-nco"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem
    +public static final java.lang.StringFLAG_CHECKIN"-ci"
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_ELTYPE"-eltype"
    +public static final java.lang.StringFLAG_MASTER"-master"
    +public static final java.lang.StringFLAG_NOCHECKOUT"-nco"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_NOWARN"-nwarn"
    +public static final java.lang.StringFLAG_PRESERVETIME"-ptime"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_RECURSE"-recurse"
    +public static final java.lang.StringFLAG_REPLACE"-replace"
    +public static final java.lang.StringFLAG_VERSION"-version"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_GLOBAL"-global"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_ORDINARY"-ordinary"
    +public static final java.lang.StringFLAG_PBRANCH"-pbranch"
    +public static final java.lang.StringFLAG_REPLACE"-replace"
    +public static final java.lang.StringFLAG_SHARED"-shared"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype
    +public static final java.lang.StringFLAG_COMMENT"-c"
    +public static final java.lang.StringFLAG_COMMENTFILE"-cfile"
    +public static final java.lang.StringFLAG_FORCE"-force"
    +public static final java.lang.StringFLAG_IGNORE"-ignore"
    +public static final java.lang.StringFLAG_NOCOMMENT"-nc"
    +public static final java.lang.StringFLAG_RMALL"-rmall"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout
    +public static final java.lang.StringFLAG_KEEPCOPY"-keep"
    +public static final java.lang.StringFLAG_RM"-rm"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock
    +public static final java.lang.StringFLAG_COMMENT"-comment"
    +public static final java.lang.StringFLAG_PNAME"-pname"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate
    +public static final java.lang.StringFLAG_CURRENTTIME"-ctime"
    +public static final java.lang.StringFLAG_GRAPHICAL"-graphical"
    +public static final java.lang.StringFLAG_LOG"-log"
    +public static final java.lang.StringFLAG_NOVERWRITE"-noverwrite"
    +public static final java.lang.StringFLAG_OVERWRITE"-overwrite"
    +public static final java.lang.StringFLAG_PRESERVETIME"-ptime"
    +public static final java.lang.StringFLAG_RENAME"-rename"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
    +public static final java.lang.StringCOMMAND_CHECKIN"checkin"
    +public static final java.lang.StringCOMMAND_CHECKOUT"checkout"
    +public static final java.lang.StringCOMMAND_LOCK"lock"
    +public static final java.lang.StringCOMMAND_LSCO"lsco"
    +public static final java.lang.StringCOMMAND_MKATTR"mkattr"
    +public static final java.lang.StringCOMMAND_MKBL"mkbl"
    +public static final java.lang.StringCOMMAND_MKDIR"mkdir"
    +public static final java.lang.StringCOMMAND_MKELEM"mkelem"
    +public static final java.lang.StringCOMMAND_MKLABEL"mklabel"
    +public static final java.lang.StringCOMMAND_MKLBTYPE"mklbtype"
    +public static final java.lang.StringCOMMAND_RMTYPE"rmtype"
    +public static final java.lang.StringCOMMAND_UNCHECKOUT"uncheckout"
    +public static final java.lang.StringCOMMAND_UNLOCK"unlock"
    +public static final java.lang.StringCOMMAND_UPDATE"update"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
    +public static final intCONSTANT_CLASS7
    +public static final intCONSTANT_DOUBLE6
    +public static final intCONSTANT_FIELDREF9
    +public static final intCONSTANT_FLOAT4
    +public static final intCONSTANT_INTEGER3
    +public static final intCONSTANT_INTERFACEMETHODREF11
    +public static final intCONSTANT_LONG5
    +public static final intCONSTANT_METHODREF10
    +public static final intCONSTANT_NAMEANDTYPE12
    +public static final intCONSTANT_STRING8
    +public static final intCONSTANT_UTF81
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool
    +protected static final java.lang.StringBAS_DD"ejb-inprise.xml"
    +protected static final java.lang.StringBES_DD"ejb-borland.xml"
    +protected static final java.lang.StringDEFAULT_BAS_DTD_LOCATION"/com/inprise/j2ee/xml/dtds/ejb-inprise.dtd"
    +protected static final java.lang.StringDEFAULT_BAS45_EJB11_DTD_LOCATION"/com/inprise/j2ee/xml/dtds/ejb-jar.dtd"
    +protected static final java.lang.StringJAVA2IIOP"java2iiop"
    +public static final java.lang.StringPUBLICID_BORLAND_EJB"-//Inprise Corporation//DTD Enterprise JavaBeans 1.1//EN"
    +protected static final java.lang.StringVERIFY"com.inprise.ejb.util.Verify"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion
    +public static final java.lang.StringCMP1_0"1.0"
    +public static final java.lang.StringCMP2_0"2.0"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme
    +public static final java.lang.StringBASEJARNAME"basejarname"
    +public static final java.lang.StringDESCRIPTOR"descriptor"
    +public static final java.lang.StringDIRECTORY"directory"
    +public static final java.lang.StringEJB_NAME"ejb-name"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
    +public static final java.lang.StringANALYZER_CLASS_FULL"org.apache.tools.ant.util.depend.bcel.FullAnalyzer"
    +public static final java.lang.StringANALYZER_CLASS_SUPER"org.apache.tools.ant.util.depend.bcel.AncestorAnalyzer"
    +public static final java.lang.StringANALYZER_FULL"full"
    +public static final java.lang.StringANALYZER_NONE"none"
    +public static final java.lang.StringANALYZER_SUPER"super"
    +public static final java.lang.StringDEFAULT_ANALYZER"super"
    +public static final intDEFAULT_BUFFER_SIZE1024
    +protected static final java.lang.StringEJB_DD"ejb-jar.xml"
    +public static final intJAR_COMPRESS_LEVEL9
    +protected static final java.lang.StringMANIFEST"META-INF/MANIFEST.MF"
    +protected static final java.lang.StringMETA_DIR"META-INF/"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool
    +protected static final java.lang.StringJBOSS_CMP10D"jaws.xml"
    +protected static final java.lang.StringJBOSS_CMP20D"jbosscmp-jdbc.xml"
    +protected static final java.lang.StringJBOSS_DD"jboss.xml"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool
    +protected static final java.lang.StringDAVID_ORB"DAVID"
    +protected static final java.lang.StringEJB_JAR_1_1_DTD"ejb-jar_1_1.dtd"
    +protected static final java.lang.StringEJB_JAR_1_1_PUBLIC_ID"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
    +protected static final java.lang.StringEJB_JAR_2_0_DTD"ejb-jar_2_0.dtd"
    +protected static final java.lang.StringEJB_JAR_2_0_PUBLIC_ID"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
    +protected static final java.lang.StringGENIC_CLASS"org.objectweb.jonas_ejb.genic.GenIC"
    +protected static final java.lang.StringJEREMIE_ORB"JEREMIE"
    +protected static final java.lang.StringJONAS_DD"jonas-ejb-jar.xml"
    +protected static final java.lang.StringJONAS_EJB_JAR_2_4_DTD"jonas-ejb-jar_2_4.dtd"
    +protected static final java.lang.StringJONAS_EJB_JAR_2_4_PUBLIC_ID"-//ObjectWeb//DTD JOnAS 2.4//EN"
    +protected static final java.lang.StringJONAS_EJB_JAR_2_5_DTD"jonas-ejb-jar_2_5.dtd"
    +protected static final java.lang.StringJONAS_EJB_JAR_2_5_PUBLIC_ID"-//ObjectWeb//DTD JOnAS 2.5//EN"
    +protected static final java.lang.StringOLD_GENIC_CLASS_1"org.objectweb.jonas_ejb.tools.GenWholeIC"
    +protected static final java.lang.StringOLD_GENIC_CLASS_2"org.objectweb.jonas_ejb.tools.GenIC"
    +protected static final java.lang.StringRMI_ORB"RMI"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool
    +protected static final java.lang.StringCOMPILER_EJB11"weblogic.ejbc"
    +protected static final java.lang.StringCOMPILER_EJB20"weblogic.ejbc20"
    +protected static final java.lang.StringDEFAULT_COMPILER"default"
    +protected static final java.lang.StringDEFAULT_WL51_DTD_LOCATION"/weblogic/ejb/deployment/xml/weblogic-ejb-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL51_EJB11_DTD_LOCATION"/weblogic/ejb/deployment/xml/ejb-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL60_51_DTD_LOCATION"/weblogic/ejb20/dd/xml/weblogic510-ejb-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL60_DTD_LOCATION"/weblogic/ejb20/dd/xml/weblogic600-ejb-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL60_EJB11_DTD_LOCATION"/weblogic/ejb20/dd/xml/ejb11-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL60_EJB20_DTD_LOCATION"/weblogic/ejb20/dd/xml/ejb20-jar.dtd"
    +protected static final java.lang.StringDEFAULT_WL70_DTD_LOCATION"/weblogic/ejb20/dd/xml/weblogic700-ejb-jar.dtd"
    +public static final java.lang.StringPUBLICID_EJB11"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
    +public static final java.lang.StringPUBLICID_EJB20"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
    +public static final java.lang.StringPUBLICID_WEBLOGIC_EJB510"-//BEA Systems, Inc.//DTD WebLogic 5.1.0 EJB//EN"
    +public static final java.lang.StringPUBLICID_WEBLOGIC_EJB600"-//BEA Systems, Inc.//DTD WebLogic 6.0.0 EJB//EN"
    +public static final java.lang.StringPUBLICID_WEBLOGIC_EJB700"-//BEA Systems, Inc.//DTD WebLogic 7.0.0 EJB//EN"
    +protected static final java.lang.StringWL_CMP_DD"weblogic-cmp-rdbms-jar.xml"
    +protected static final java.lang.StringWL_DD"weblogic-ejb-jar.xml"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool
    +public static final java.lang.StringPUBLICID_EJB11"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
    +public static final java.lang.StringPUBLICID_EJB20"-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN"
    +protected static final java.lang.StringSCHEMA_DIR"Schema/"
    +protected static final java.lang.StringWAS_BND"ibm-ejb-jar-bnd.xmi"
    +protected static final java.lang.StringWAS_CMP_MAP"Map.mapxmi"
    +protected static final java.lang.StringWAS_CMP_SCHEMA"Schema.dbxmi"
    +protected static final java.lang.StringWAS_EXT"ibm-ejb-jar-ext.xmi"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
    +public static final java.lang.StringACTION_DELETE"delete"
    +public static final java.lang.StringACTION_DEPLOY"deploy"
    +public static final java.lang.StringACTION_LIST"list"
    +public static final java.lang.StringACTION_UNDEPLOY"undeploy"
    +public static final java.lang.StringACTION_UPDATE"update"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool
    +protected static final java.lang.StringDEFAULT_ORB"RMI"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.javacc.JavaCC
    +protected static final java.lang.StringCOM_JAVACC_CLASS"javacc.Main"
    +protected static final java.lang.StringCOM_JJDOC_CLASS"jjdoc.JJDocMain"
    +protected static final java.lang.StringCOM_JJTREE_CLASS"jjtree.Main"
    +protected static final java.lang.StringCOM_PACKAGE"COM.sun.labs."
    +protected static final java.lang.StringORG_JAVACC_CLASS"parser.Main"
    +protected static final java.lang.StringORG_JJDOC_CLASS"jjdoc.JJDocMain"
    +protected static final java.lang.StringORG_JJTREE_CLASS"jjtree.Main"
    +protected static final java.lang.StringORG_PACKAGE_3_0"org.netbeans.javacc."
    +protected static final java.lang.StringORG_PACKAGE_3_1"org.javacc."
    +protected static final intTASKDEF_TYPE_JAVACC1
    +protected static final intTASKDEF_TYPE_JJDOC3
    +protected static final intTASKDEF_TYPE_JJTREE2
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.javah.Gcjh
    +public static final java.lang.StringIMPLEMENTATION_NAME"gcjh"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.javah.Kaffeh
    +public static final java.lang.StringIMPLEMENTATION_NAME"kaffeh"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.javah.SunJavah
    +public static final java.lang.StringIMPLEMENTATION_NAME"sun"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer
    +public static final java.lang.StringFRAMES"frames"
    +public static final java.lang.StringNOFRAMES"noframes"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder
    +public static final java.lang.StringMAGIC_PROPERTY_CLASS_LOCATION"ant.junit.failureCollector"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.FormatterElement
    +public static final java.lang.StringBRIEF_FORMATTER_CLASS_NAME"org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter"
    +public static final java.lang.StringFAILURE_RECORDER_CLASS_NAME"org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder"
    +public static final java.lang.StringPLAIN_FORMATTER_CLASS_NAME"org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter"
    +public static final java.lang.StringXML_FORMATTER_CLASS_NAME"org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.JUnitTask
    +public static final java.lang.StringENABLE_TESTLISTENER_EVENTS"ant.junit.enabletestlistenerevents"
    +public static final java.lang.StringTESTLISTENER_PREFIX"junit.framework.TestListener: "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode
    +public static final java.lang.StringONCE"once"
    +public static final java.lang.StringPER_BATCH"perBatch"
    +public static final java.lang.StringPER_TEST"perTest"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror
    +public static final intERRORS2
    +public static final intFAILURES1
    +public static final java.lang.StringIGNORED_FILE_NAME"IGNORETHIS"
    +public static final intSUCCESS0
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper
    +public static final java.lang.StringJUNIT_FRAMEWORK_JUNIT4_TEST_CASE_FACADE"junit.framework.JUnit4TestCaseFacade"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.XMLConstants
    +public static final java.lang.StringATTR_CLASSNAME"classname"
    +public static final java.lang.StringATTR_ERRORS"errors"
    +public static final java.lang.StringATTR_FAILURES"failures"
    +public static final java.lang.StringATTR_ID"id"
    +public static final java.lang.StringATTR_MESSAGE"message"
    +public static final java.lang.StringATTR_NAME"name"
    +public static final java.lang.StringATTR_PACKAGE"package"
    +public static final java.lang.StringATTR_TESTS"tests"
    +public static final java.lang.StringATTR_TIME"time"
    +public static final java.lang.StringATTR_TYPE"type"
    +public static final java.lang.StringATTR_VALUE"value"
    +public static final java.lang.StringERROR"error"
    +public static final java.lang.StringFAILURE"failure"
    +public static final java.lang.StringHOSTNAME"hostname"
    +public static final java.lang.StringPROPERTIES"properties"
    +public static final java.lang.StringPROPERTY"property"
    +public static final java.lang.StringSYSTEM_ERR"system-err"
    +public static final java.lang.StringSYSTEM_OUT"system-out"
    +public static final java.lang.StringTESTCASE"testcase"
    +public static final java.lang.StringTESTSUITE"testsuite"
    +public static final java.lang.StringTESTSUITES"testsuites"
    +public static final java.lang.StringTIMESTAMP"timestamp"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator
    +public static final java.lang.StringDEFAULT_DIR"."
    +public static final java.lang.StringDEFAULT_FILENAME"TESTS-TestSuites.xml"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii
    +public static final java.lang.StringIMPLEMENTATION_NAME"kaffe"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii
    +public static final java.lang.StringIMPLEMENTATION_NAME"sun"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.net.FTP
    +protected static final intCHMOD5
    +public static final intDEFAULT_FTP_PORT21
    +protected static final intDEL_FILES2
    +protected static final intGET_FILES1
    +protected static final intLIST_FILES3
    +protected static final intMK_DIR4
    +protected static final intRM_DIR6
    +protected static final intSEND_FILES0
    +protected static final intSITE_CMD7
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.net.FTPTask
    +public static final intCHMOD5
    +public static final intDEFAULT_FTP_PORT21
    +public static final intDEL_FILES2
    +public static final intGET_FILES1
    +public static final intLIST_FILES3
    +public static final intMK_DIR4
    +public static final intRM_DIR6
    +public static final intSEND_FILES0
    +public static final intSITE_CMD7
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient
    +protected static final intTERMINAL_TYPE24
    +protected static final intTERMINAL_TYPE_IS0
    +protected static final intTERMINAL_TYPE_SEND1
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
    +public static final java.lang.StringCOMMAND_CHECKIN_FILE"CheckInFile"
    +public static final java.lang.StringCOMMAND_CHECKIN_PROJECT"CheckInProject"
    +public static final java.lang.StringCOMMAND_CHECKOUT_FILE"CheckOutFile"
    +public static final java.lang.StringCOMMAND_CHECKOUT_PROJECT"CheckOutProject"
    +public static final java.lang.StringCOMMAND_GET_FILE"GetFile"
    +public static final java.lang.StringCOMMAND_GET_PROJECT"GetProject"
    +public static final java.lang.StringCOMMAND_HISTORY"GetFileHistory"
    +public static final java.lang.StringCOMMAND_LABEL"AddLabel"
    +public static final java.lang.StringCOMMAND_SOS_EXE"soscmd"
    +public static final java.lang.StringFLAG_COMMAND"-command"
    +public static final java.lang.StringFLAG_COMMENT"-log"
    +public static final java.lang.StringFLAG_FILE"-file"
    +public static final java.lang.StringFLAG_LABEL"-label"
    +public static final java.lang.StringFLAG_NO_CACHE"-nocache"
    +public static final java.lang.StringFLAG_NO_COMPRESSION"-nocompress"
    +public static final java.lang.StringFLAG_PASSWORD"-password"
    +public static final java.lang.StringFLAG_PROJECT"-project"
    +public static final java.lang.StringFLAG_RECURSION"-recursive"
    +public static final java.lang.StringFLAG_SOS_HOME"-soshome"
    +public static final java.lang.StringFLAG_SOS_SERVER"-server"
    +public static final java.lang.StringFLAG_USERNAME"-name"
    +public static final java.lang.StringFLAG_VERBOSE"-verbose"
    +public static final java.lang.StringFLAG_VERSION"-revision"
    +public static final java.lang.StringFLAG_VSS_SERVER"-database"
    +public static final java.lang.StringFLAG_WORKING_DIR"-workdir"
    +public static final java.lang.StringPROJECT_PREFIX"$"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.testing.Funtest
    +public static final java.lang.StringAPPLICATION_EXCEPTION"Application Exception"
    +public static final java.lang.StringAPPLICATION_FORCIBLY_SHUT_DOWN"Application forcibly shut down"
    +public static final java.lang.StringSHUTDOWN_INTERRUPTED"Shutdown interrupted"
    +public static final java.lang.StringSKIPPING_TESTS"Condition failed -skipping tests"
    +public static final java.lang.StringTEARDOWN_EXCEPTION"Teardown Exception"
    +public static final java.lang.StringWARN_OVERRIDING"Overriding previous definition of "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
    +public static final java.lang.StringCOMMAND_ADD"Add"
    +public static final java.lang.StringCOMMAND_CHECKIN"Checkin"
    +public static final java.lang.StringCOMMAND_CHECKOUT"Checkout"
    +public static final java.lang.StringCOMMAND_CP"CP"
    +public static final java.lang.StringCOMMAND_CREATE"Create"
    +public static final java.lang.StringCOMMAND_GET"Get"
    +public static final java.lang.StringCOMMAND_HISTORY"History"
    +public static final java.lang.StringCOMMAND_LABEL"Label"
    +public static final java.lang.StringFLAG_AUTORESPONSE_DEF"-I-"
    +public static final java.lang.StringFLAG_AUTORESPONSE_NO"-I-N"
    +public static final java.lang.StringFLAG_AUTORESPONSE_YES"-I-Y"
    +public static final java.lang.StringFLAG_BRIEF"-B"
    +public static final java.lang.StringFLAG_CODEDIFF"-D"
    +public static final java.lang.StringFLAG_COMMENT"-C"
    +public static final java.lang.StringFLAG_FILETIME_DEF"-GTC"
    +public static final java.lang.StringFLAG_FILETIME_MODIFIED"-GTM"
    +public static final java.lang.StringFLAG_FILETIME_UPDATED"-GTU"
    +public static final java.lang.StringFLAG_LABEL"-L"
    +public static final java.lang.StringFLAG_LOGIN"-Y"
    +public static final java.lang.StringFLAG_NO_FILE"-F-"
    +public static final java.lang.StringFLAG_NO_GET"-G-"
    +public static final java.lang.StringFLAG_OUTPUT"-O"
    +public static final java.lang.StringFLAG_OVERRIDE_WORKING_DIR"-GL"
    +public static final java.lang.StringFLAG_QUIET"-O-"
    +public static final java.lang.StringFLAG_RECURSION"-R"
    +public static final java.lang.StringFLAG_REPLACE_WRITABLE"-GWR"
    +public static final java.lang.StringFLAG_SKIP_WRITABLE"-GWS"
    +public static final java.lang.StringFLAG_USER"-U"
    +public static final java.lang.StringFLAG_VERSION"-V"
    +public static final java.lang.StringFLAG_VERSION_DATE"-Vd"
    +public static final java.lang.StringFLAG_VERSION_LABEL"-VL"
    +public static final java.lang.StringFLAG_WRITABLE"-W"
    +public static final java.lang.StringPROJECT_PREFIX"$"
    +public static final java.lang.StringSS_EXE"ss"
    +public static final java.lang.StringSTYLE_BRIEF"brief"
    +public static final java.lang.StringSTYLE_CODEDIFF"codediff"
    +public static final java.lang.StringSTYLE_DEFAULT"default"
    +public static final java.lang.StringSTYLE_NOFILE"nofile"
    +public static final java.lang.StringTIME_CURRENT"current"
    +public static final java.lang.StringTIME_MODIFIED"modified"
    +public static final java.lang.StringTIME_UPDATED"updated"
    +public static final java.lang.StringVALUE_FROMDATE"~d"
    +public static final java.lang.StringVALUE_FROMLABEL"~L"
    +public static final java.lang.StringVALUE_NO"-N"
    +public static final java.lang.StringVALUE_YES"-Y"
    +public static final java.lang.StringWRITABLE_FAIL"fail"
    +public static final java.lang.StringWRITABLE_REPLACE"replace"
    +public static final java.lang.StringWRITABLE_SKIP"skip"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
    +public static final java.lang.StringRMI_SKEL_SUFFIX"_Skel"
    +public static final java.lang.StringRMI_STUB_SUFFIX"_Stub"
    +public static final java.lang.StringRMI_TIE_SUFFIX"_Tie"
    +public static final java.lang.StringSTUB_1_1"-v1.1"
    +public static final java.lang.StringSTUB_1_2"-v1.2"
    +public static final java.lang.StringSTUB_COMPAT"-vcompat"
    +public static final java.lang.StringSTUB_OPTION_1_1"1.1"
    +public static final java.lang.StringSTUB_OPTION_1_2"1.2"
    +public static final java.lang.StringSTUB_OPTION_COMPAT"compat"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic
    +public static final java.lang.StringCOMPILER_NAME"forking"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.KaffeRmic
    +public static final java.lang.StringCOMPILER_NAME"kaffe"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory
    +public static final java.lang.StringDEFAULT_COMPILER"default"
    +public static final java.lang.StringERROR_NOT_RMIC_ADAPTER"Class of unexpected Type: "
    +public static final java.lang.StringERROR_UNKNOWN_COMPILER"Class not found: "
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.SunRmic
    +public static final java.lang.StringCOMPILER_NAME"sun"
    +public static final java.lang.StringERROR_NO_RMIC_ON_CLASSPATH"Cannot use SUN rmic, as it is not available. A common solution is to set the environment variable JAVA_HOME"
    +public static final java.lang.StringERROR_RMIC_FAILED"Error starting SUN rmic: "
    +public static final java.lang.StringRMIC_CLASSNAME"sun.rmi.rmic.Main"
    +public static final java.lang.StringRMIC_EXECUTABLE"rmic"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.WLRmic
    +public static final java.lang.StringCOMPILER_NAME"weblogic"
    +public static final java.lang.StringERROR_NO_WLRMIC_ON_CLASSPATH"Cannot use WebLogic rmic, as it is not available. Add it to Ant\'s classpath with the -lib option"
    +public static final java.lang.StringERROR_WLRMIC_FAILED"Error starting WebLogic rmic: "
    +public static final java.lang.StringUNSUPPORTED_STUB_OPTION"Unsupported stub option: "
    +public static final java.lang.StringWL_RMI_SKEL_SUFFIX"_WLSkel"
    +public static final java.lang.StringWL_RMI_STUB_SUFFIX"_WLStub"
    +public static final java.lang.StringWLRMIC_CLASSNAME"weblogic.rmic"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.taskdefs.rmic.XNewRmic
    +public static final java.lang.StringCOMPILER_NAME"xnew"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.ArchiveFileSet
    +public static final intDEFAULT_DIR_MODE16877
    +public static final intDEFAULT_FILE_MODE33188
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.FilterSet
    +public static final java.lang.StringDEFAULT_TOKEN_END"@"
    +public static final java.lang.StringDEFAULT_TOKEN_START"@"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.RegularExpression
    +public static final java.lang.StringDATA_TYPE_NAME"regexp"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.Resource
    +public static final longUNKNOWN_DATETIME0L
    +public static final longUNKNOWN_SIZE-1L
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.Substitution
    +public static final java.lang.StringDATA_TYPE_NAME"substitution"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.XMLCatalog
    +public static final java.lang.StringAPACHE_RESOLVER"org.apache.tools.ant.types.resolver.ApacheCatalogResolver"
    +public static final java.lang.StringCATALOG_RESOLVER"org.apache.xml.resolver.tools.CatalogResolver"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.optional.depend.DependScanner
    +public static final java.lang.StringDEFAULT_ANALYZER_CLASS"org.apache.tools.ant.util.depend.bcel.FullAnalyzer"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.optional.image.ColorMapper
    +public static final java.lang.StringCOLOR_BLACK"black"
    +public static final java.lang.StringCOLOR_BLUE"blue"
    +public static final java.lang.StringCOLOR_CYAN"cyan"
    +public static final java.lang.StringCOLOR_DARKGRAY"darkgray"
    +public static final java.lang.StringCOLOR_DARKGREY"darkgrey"
    +public static final java.lang.StringCOLOR_GRAY"gray"
    +public static final java.lang.StringCOLOR_GREEN"green"
    +public static final java.lang.StringCOLOR_GREY"grey"
    +public static final java.lang.StringCOLOR_LIGHTGRAY"lightgray"
    +public static final java.lang.StringCOLOR_LIGHTGREY"lightgrey"
    +public static final java.lang.StringCOLOR_MAGENTA"magenta"
    +public static final java.lang.StringCOLOR_ORANGE"orange"
    +public static final java.lang.StringCOLOR_PINK"pink"
    +public static final java.lang.StringCOLOR_RED"red"
    +public static final java.lang.StringCOLOR_WHITE"white"
    +public static final java.lang.StringCOLOR_YELLOW"yellow"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.ContainsRegexpSelector
    +public static final java.lang.StringEXPRESSION_KEY"expression"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.ContainsSelector
    +public static final java.lang.StringCASE_KEY"casesensitive"
    +public static final java.lang.StringCONTAINS_KEY"text"
    +public static final java.lang.StringEXPRESSION_KEY"expression"
    +public static final java.lang.StringWHITESPACE_KEY"ignorewhitespace"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.DateSelector
    +public static final java.lang.StringCHECKDIRS_KEY"checkdirs"
    +public static final java.lang.StringDATETIME_KEY"datetime"
    +public static final java.lang.StringGRANULARITY_KEY"granularity"
    +public static final java.lang.StringMILLIS_KEY"millis"
    +public static final java.lang.StringPATTERN_KEY"pattern"
    +public static final java.lang.StringWHEN_KEY"when"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.DepthSelector
    +public static final java.lang.StringMAX_KEY"max"
    +public static final java.lang.StringMIN_KEY"min"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.FilenameSelector
    +public static final java.lang.StringCASE_KEY"casesensitive"
    +public static final java.lang.StringNAME_KEY"name"
    +public static final java.lang.StringNEGATE_KEY"negate"
    +public static final java.lang.StringREGEX_KEY"regex"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.SelectorUtils
    +public static final java.lang.StringDEEP_TREE_MATCH"**"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.SizeSelector
    +public static final java.lang.StringSIZE_KEY"value"
    +public static final java.lang.StringUNITS_KEY"units"
    +public static final java.lang.StringWHEN_KEY"when"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.TypeSelector
    +public static final java.lang.StringTYPE_KEY"type"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.types.selectors.TypeSelector.FileType
    +public static final java.lang.StringDIR"dir"
    +public static final java.lang.StringFILE"file"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.ClasspathUtils
    +public static final java.lang.StringREUSE_LOADER_REF"ant.reuse.loader"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.DateUtils
    +public static final java.lang.StringISO8601_DATE_PATTERN"yyyy-MM-dd"
    +public static final java.lang.StringISO8601_DATETIME_PATTERN"yyyy-MM-dd\'T\'HH:mm:ss"
    +public static final java.lang.StringISO8601_TIME_PATTERN"HH:mm:ss"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.FileUtils
    +public static final longFAT_FILE_TIMESTAMP_GRANULARITY2000L
    +public static final longNTFS_FILE_TIMESTAMP_GRANULARITY1L
    +public static final longUNIX_FILE_TIMESTAMP_GRANULARITY1000L
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.JavaEnvUtils
    +public static final java.lang.StringJAVA_1_0"1.0"
    +public static final java.lang.StringJAVA_1_1"1.1"
    +public static final java.lang.StringJAVA_1_2"1.2"
    +public static final java.lang.StringJAVA_1_3"1.3"
    +public static final java.lang.StringJAVA_1_4"1.4"
    +public static final java.lang.StringJAVA_1_5"1.5"
    +public static final java.lang.StringJAVA_1_6"1.6"
    +public static final java.lang.StringJAVA_1_7"1.7"
    +public static final intVERSION_1_010
    +public static final intVERSION_1_111
    +public static final intVERSION_1_212
    +public static final intVERSION_1_313
    +public static final intVERSION_1_414
    +public static final intVERSION_1_515
    +public static final intVERSION_1_616
    +public static final intVERSION_1_717
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.OutputStreamFunneler
    +public static final longDEFAULT_TIMEOUT_MILLIS1000L
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.ProxySetup
    +public static final java.lang.StringFTP_NON_PROXY_HOSTS"ftp.nonProxyHosts"
    +public static final java.lang.StringFTP_PROXY_HOST"ftp.proxyHost"
    +public static final java.lang.StringFTP_PROXY_PORT"ftp.proxyPort"
    +public static final java.lang.StringHTTP_NON_PROXY_HOSTS"http.nonProxyHosts"
    +public static final java.lang.StringHTTP_PROXY_HOST"http.proxyHost"
    +public static final java.lang.StringHTTP_PROXY_PASSWORD"http.proxyPassword"
    +public static final java.lang.StringHTTP_PROXY_PORT"http.proxyPort"
    +public static final java.lang.StringHTTP_PROXY_USERNAME"http.proxyUser"
    +public static final java.lang.StringHTTPS_NON_PROXY_HOSTS"https.nonProxyHosts"
    +public static final java.lang.StringHTTPS_PROXY_HOST"https.proxyHost"
    +public static final java.lang.StringHTTPS_PROXY_PORT"https.proxyPort"
    +public static final java.lang.StringSOCKS_PROXY_HOST"socksProxyHost"
    +public static final java.lang.StringSOCKS_PROXY_PASSWORD"java.net.socks.password"
    +public static final java.lang.StringSOCKS_PROXY_PORT"socksProxyPort"
    +public static final java.lang.StringSOCKS_PROXY_USERNAME"java.net.socks.username"
    +public static final java.lang.StringUSE_SYSTEM_PROXIES"java.net.useSystemProxies"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.ResourceUtils
    +public static final java.lang.StringISO_8859_1"ISO-8859-1"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.Retryable
    +public static final intRETRY_FOREVER-1
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.UUEncoder
    +protected static final intDEFAULT_MODE644
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.Watchdog
    +public static final java.lang.StringERROR_INVALID_TIMEOUT"timeout less than 1."
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.WorkerAnt
    +public static final java.lang.StringERROR_NO_TASK"No task defined"
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.XmlConstants
    +public static final java.lang.StringFEATURE_DISALLOW_DTD"http://apache.org/xml/features/disallow-doctype-decl"
    +public static final java.lang.StringFEATURE_EXTERNAL_ENTITIES"http://xml.org/sax/features/external-general-entities"
    +public static final java.lang.StringFEATURE_JAXP12_SCHEMA_LANGUAGE"http://java.sun.com/xml/jaxp/properties/schemaLanguage"
    +public static final java.lang.StringFEATURE_JAXP12_SCHEMA_SOURCE"http://java.sun.com/xml/jaxp/properties/schemaSource"
    +public static final java.lang.StringFEATURE_NAMESPACES"http://xml.org/sax/features/namespaces"
    +public static final java.lang.StringFEATURE_VALIDATION"http://xml.org/sax/features/validation"
    +public static final java.lang.StringFEATURE_XSD"http://apache.org/xml/features/validation/schema"
    +public static final java.lang.StringFEATURE_XSD_FULL_VALIDATION"http://apache.org/xml/features/validation/schema-full-checking"
    +public static final java.lang.StringPROPERTY_NO_NAMESPACE_SCHEMA_LOCATION"http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation"
    +public static final java.lang.StringPROPERTY_SCHEMA_LOCATION"http://apache.org/xml/properties/schema/external-schemaLocation"
    +public static final java.lang.StringURI_XSD"http://www.w3.org/2001/XMLSchema"
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.depend.AbstractAnalyzer
    +public static final intMAX_LOOPS1000
    + +

    + +

    + + + + + + + + + + + + +
    org.apache.tools.ant.util.java15.ProxyDiagnostics
    +public static final java.lang.StringDEFAULT_DESTINATION"http://ant.apache.org/"
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.regexp.Regexp
    +public static final intREPLACE_ALL16
    +public static final intREPLACE_FIRST1
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.ant.util.regexp.RegexpMatcher
    +public static final intMATCH_CASE_INSENSITIVE256
    +public static final intMATCH_DEFAULT0
    +public static final intMATCH_MULTILINE4096
    +public static final intMATCH_SINGLELINE65536
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.bzip2.BZip2Constants
    +public static final intbaseBlockSize100000
    +public static final intG_SIZE50
    +public static final intMAX_ALPHA_SIZE258
    +public static final intMAX_CODE_LEN23
    +public static final intMAX_SELECTORS18002
    +public static final intN_GROUPS6
    +public static final intN_ITERS4
    +public static final intNUM_OVERSHOOT_BYTES20
    +public static final intRUNA0
    +public static final intRUNB1
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.bzip2.CBZip2OutputStream
    +protected static final intCLEARMASK-2097153
    +protected static final intDEPTH_THRESH10
    +protected static final intGREATER_ICOST15
    +protected static final intLESSER_ICOST0
    +public static final intMAX_BLOCKSIZE9
    +public static final intMIN_BLOCKSIZE1
    +protected static final intQSORT_STACK_SIZE1000
    +protected static final intSETMASK2097152
    +protected static final intSMALL_THRESH20
    +protected static final intWORK_FACTOR30
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.mail.MailMessage
    +public static final java.lang.StringDEFAULT_HOST"localhost"
    +public static final intDEFAULT_PORT25
    + +

    + +

    + + + + + + + + + + + + + + + + + +
    org.apache.tools.tar.TarBuffer
    +public static final intDEFAULT_BLKSIZE10240
    +public static final intDEFAULT_RCDSIZE512
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.tar.TarConstants
    +public static final intCHKSUMLEN8
    +public static final intDEVLEN8
    +public static final intGIDLEN8
    +public static final intGNAMELEN32
    +public static final java.lang.StringGNU_LONGLINK"././@LongLink"
    +public static final java.lang.StringGNU_TMAGIC"ustar "
    +public static final byteLF_BLK52
    +public static final byteLF_CHR51
    +public static final byteLF_CONTIG55
    +public static final byteLF_DIR53
    +public static final byteLF_FIFO54
    +public static final byteLF_GNUTYPE_LONGNAME76
    +public static final byteLF_LINK49
    +public static final byteLF_NORMAL48
    +public static final byteLF_OLDNORM0
    +public static final byteLF_SYMLINK50
    +public static final intMAGICLEN8
    +public static final longMAXSIZE8589934591L
    +public static final intMODELEN8
    +public static final intMODTIMELEN12
    +public static final intNAMELEN100
    +public static final intSIZELEN12
    +public static final java.lang.StringTMAGIC"ustar"
    +public static final intUIDLEN8
    +public static final intUNAMELEN32
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.tar.TarEntry
    +public static final intDEFAULT_DIR_MODE16877
    +public static final intDEFAULT_FILE_MODE33188
    +public static final intMAX_NAMELEN31
    +public static final intMILLIS_PER_SECOND1000
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.tar.TarOutputStream
    +public static final intLONGFILE_ERROR0
    +public static final intLONGFILE_GNU2
    +public static final intLONGFILE_TRUNCATE1
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField
    +public static final intREAD_KEY2
    +public static final intSKIP_KEY1
    +public static final intTHROW_KEY0
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.zip.UnixStat
    +public static final intDEFAULT_DIR_PERM493
    +public static final intDEFAULT_FILE_PERM420
    +public static final intDEFAULT_LINK_PERM511
    +public static final intDIR_FLAG16384
    +public static final intFILE_FLAG32768
    +public static final intLINK_FLAG40960
    +public static final intPERM_MASK4095
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.zip.ZipEntry
    +public static final intCENATT36
    +public static final intCENATX38
    +public static final intCENCOM32
    +public static final intCENCRC16
    +public static final intCENDSK34
    +public static final intCENEXT30
    +public static final intCENFLG8
    +public static final intCENHDR46
    +public static final intCENHOW10
    +public static final intCENLEN24
    +public static final intCENNAM28
    +public static final intCENOFF42
    +public static final longCENSIG33639248L
    +public static final intCENSIZ20
    +public static final intCENTIM12
    +public static final intCENVEM4
    +public static final intCENVER6
    +public static final intENDCOM20
    +public static final intENDHDR22
    +public static final intENDOFF16
    +public static final longENDSIG101010256L
    +public static final intENDSIZ12
    +public static final intENDSUB8
    +public static final intENDTOT10
    +public static final intEXTCRC4
    +public static final intEXTHDR16
    +public static final intEXTLEN12
    +public static final longEXTSIG134695760L
    +public static final intEXTSIZ8
    +public static final intLOCCRC14
    +public static final intLOCEXT28
    +public static final intLOCFLG6
    +public static final intLOCHDR30
    +public static final intLOCHOW8
    +public static final intLOCLEN22
    +public static final intLOCNAM26
    +public static final longLOCSIG67324752L
    +public static final intLOCSIZ18
    +public static final intLOCTIM10
    +public static final intLOCVER4
    +public static final intPLATFORM_FAT0
    +public static final intPLATFORM_UNIX3
    + +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    org.apache.tools.zip.ZipOutputStream
    +public static final intDEFAULT_COMPRESSION-1
    +public static final intDEFLATED8
    +public static final intEFS_FLAG2048
    +public static final intSTORED0
    +public static final intUFT8_NAMES_FLAG2048
    + +

    + +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/deprecated-list.html b/tools/apache-ant-1.8.2/docs/manual/api/deprecated-list.html new file mode 100644 index 000000000..67c7db35c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/deprecated-list.html @@ -0,0 +1,1058 @@ + + + + + + +Deprecated List (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Deprecated Classes
    org.apache.tools.ant.loader.AntClassLoader2 +
    +          since 1.7 + Just use AntClassLoader itself. 
    org.apache.tools.ant.taskdefs.Copydir +
    +          The copydir task is deprecated since Ant 1.2. Use copy instead. 
    org.apache.tools.ant.taskdefs.Copyfile +
    +          The copyfile task is deprecated since Ant 1.2. Use + copy instead. 
    org.apache.tools.ant.taskdefs.CopyPath +
    +          this task should have never been released and was + obsoleted by ResourceCollection support in Copy available since Ant + 1.7.0. Don't use it. 
    org.apache.tools.ant.taskdefs.Deltree +
    +          The deltree task is deprecated since Ant 1.2. Use + delete instead. 
    org.apache.tools.ant.taskdefs.optional.extension.DeweyDecimal +
    +          use org.apache.tools.ant.util.DeweyDecimal instead. + Deprecated since ant 1.8 
    org.apache.tools.ant.taskdefs.Exec +
    +          since 1.2. + delegate to Execute + instead. 
    org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    +          since 1.7.0. 
    org.apache.tools.ant.taskdefs.compilers.Javac12 +
    +          Use Javac13 instead. 
    org.apache.tools.ant.taskdefs.Jikes +
    +          since 1.2. + Merged into the class Javac. 
    org.apache.tools.ant.taskdefs.JikesOutputParser +
    +          since 1.2. + Use Jikes' exit value to detect compilation failure. 
    org.apache.tools.ant.taskdefs.KeySubst +
    +          KeySubst is deprecated since Ant 1.1. Use Filter + Copy + instead. 
    org.apache.tools.ant.taskdefs.optional.net.MimeMail +
    +          since 1.6.x. + Use EmailTask instead. 
    org.apache.tools.ant.taskdefs.Rename +
    +          The rename task is deprecated since Ant 1.2. Use move instead. 
    org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    +          since 1.5.x. + Use <move> instead 
    org.apache.tools.ant.util.ScriptRunner +
    +          Implementation moved to another location. Use + that org.apache.tools.ant.types.optional.ScriptRunner instead. 
    org.apache.tools.ant.taskdefs.TaskOutputStream +
    +          since 1.2.x. + Use LogOutputStream instead. 
    org.apache.tools.ant.util.WeakishReference +
    +          deprecated 1.7; will be removed in Ant1.8 + Just use WeakReference directly. 
    org.apache.tools.ant.util.WeakishReference.HardReference +
    +          since 1.7. + Hopefully nobody is using this. 
    org.apache.tools.ant.util.optional.WeakishReference12 +
    +          since 1.7. + Just use WeakReference directly. + Note that in ant1.7 is parent was changed to extend HardReference. + This is because the latter has access to the (package scoped) + WeakishReference(Object) constructor, and both that and this are thin + facades on the underlying no-longer-abstract base class. 
    +  +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Deprecated Fields
    org.apache.tools.ant.types.DataType.checked +
    +          since 1.7. + The user should not be directly referencing + variable. Please use DataType.setChecked(boolean) or + DataType.isChecked() instead. 
    org.apache.tools.ant.util.DateUtils.DATE_HEADER_FORMAT +
    +          DateFormat is not thread safe, and we cannot guarantee that + some other code is using the format in parallel. + Deprecated since ant 1.8 
    org.apache.tools.ant.DirectoryScanner.DEFAULTEXCLUDES +
    +          since 1.6.x. + Use the getDefaultExcludes + method instead. 
    org.apache.tools.ant.ProjectComponent.description +
    +          since 1.6.x. + You should not be accessing this variable directly. 
    org.apache.tools.zip.ZipOutputStream.EFS_FLAG +
    +          use ZipOutputStream.UFT8_NAMES_FLAG instead 
    org.apache.tools.ant.taskdefs.Tar.FAIL +
    +          since 1.5.x. + Tar.FAIL is deprecated and is replaced with + Tar.TarLongFileMode.FAIL 
    org.apache.tools.ant.taskdefs.Tar.GNU +
    +          since 1.5.x. + Tar.GNU is deprecated and is replaced with + Tar.TarLongFileMode.GNU 
    org.apache.tools.ant.Project.JAVA_1_0 +
    +          since 1.5.x. + Use JavaEnvUtils.JAVA_1_0 instead. 
    org.apache.tools.ant.Project.JAVA_1_1 +
    +          since 1.5.x. + Use JavaEnvUtils.JAVA_1_1 instead. 
    org.apache.tools.ant.Project.JAVA_1_2 +
    +          since 1.5.x. + Use JavaEnvUtils.JAVA_1_2 instead. 
    org.apache.tools.ant.Project.JAVA_1_3 +
    +          since 1.5.x. + Use JavaEnvUtils.JAVA_1_3 instead. 
    org.apache.tools.ant.Project.JAVA_1_4 +
    +          since 1.5.x. + Use JavaEnvUtils.JAVA_1_4 instead. 
    org.apache.tools.ant.ProjectComponent.location +
    +          since 1.6.x. + You should not be accessing this variable directly. + Please use the ProjectComponent.getLocation() method. 
    org.apache.tools.ant.taskdefs.Tar.OMIT +
    +          since 1.5.x. + Tar.OMIT is deprecated and is replaced with + Tar.TarLongFileMode.OMIT 
    org.apache.tools.ant.ProjectComponent.project +
    +          since 1.6.x. + You should not be directly accessing this variable directly. + You should access project object via the getProject() + or setProject() accessor/mutators. 
    org.apache.tools.ant.types.DataType.ref +
    +          since 1.7. + The user should not be directly referencing + variable. Please use DataType.getRefid() instead. 
    org.apache.tools.ant.Task.target +
    +          since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getOwningTarget() method. 
    org.apache.tools.ant.Task.taskName +
    +          since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getTaskName() method. 
    org.apache.tools.ant.Task.taskType +
    +          since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getTaskType() method. 
    org.apache.tools.ant.taskdefs.Tar.TRUNCATE +
    +          since 1.5.x. + Tar.TRUNCATE is deprecated and is replaced with + Tar.TarLongFileMode.TRUNCATE 
    org.apache.tools.ant.taskdefs.Tar.WARN +
    +          since 1.5.x. + Tar.WARN is deprecated and is replaced with + Tar.TarLongFileMode.WARN 
    org.apache.tools.ant.Task.wrapper +
    +          since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getWrapper() method. 
    +  +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Deprecated Methods
    org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter.addExtdirsToClasspath(Path) +
    +          since 1.5.x. + Use org.apache.tools.ant.types.Path#addExtdirs instead. 
    org.apache.tools.ant.Project.addFilter(String, String) +
    +          since 1.4.x. + Use getGlobalFilterSet().addFilter(token,value) 
    org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.addSysproperty(Environment.Variable) +
    +          since ant 1.6 
    org.apache.tools.ant.taskdefs.Tar.archiveIsUpToDate(String[]) +
    +          since 1.5.x. + use the two-arg version instead. 
    org.apache.tools.ant.ProjectHelper.configure(Object, AttributeList, Project) +
    +          since 1.6.x. + Use IntrospectionHelper for each property. 
    org.apache.tools.ant.taskdefs.XSLTProcess.configureLiaison(File) +
    +          since Ant 1.7 
    org.apache.tools.ant.Project.copyFile(File, File) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(File, File, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(File, File, boolean, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(File, File, boolean, boolean, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(String, String) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(String, String, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(String, String, boolean, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.Project.copyFile(String, String, boolean, boolean, boolean) +
    +          since 1.4.x 
    org.apache.tools.ant.taskdefs.MacroInstance.createDynamicElement(String) +
    +          since 1.6.x. 
    org.apache.tools.ant.IntrospectionHelper.createElement(Project, Object, String) +
    +          since 1.6.x. + This is not a namespace aware method. 
    org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask.createSourcespath() +
    +          since 1.6.x. 
    org.apache.tools.ant.util.FileUtils.createTempFile(String, String, File) +
    +          since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. 
    org.apache.tools.ant.util.FileUtils.createTempFile(String, String, File, boolean) +
    +          since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. 
    org.apache.tools.ant.taskdefs.optional.unix.Symlink.deleteSymlink(File) +
    +          use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead 
    org.apache.tools.ant.taskdefs.optional.unix.Symlink.deleteSymlink(String) +
    +          use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead 
    org.apache.tools.ant.taskdefs.Get.doGet(int, Get.DownloadProgress) +
    +          only gets the first configured resource 
    org.apache.tools.ant.util.CollectionUtils.equals(Dictionary, Dictionary) +
    +          since 1.6.x. 
    org.apache.tools.ant.util.CollectionUtils.equals(Vector, Vector) +
    +          since 1.6.x. 
    org.apache.tools.ant.taskdefs.optional.script.ScriptDef.executeScript(Map, Map) +
    +          since 1.7. + Use executeScript(attribute, elements, instance) instead. 
    org.apache.tools.ant.RuntimeConfigurable.getAttributes() +
    +          Deprecated since Ant 1.6 in favor of RuntimeConfigurable.getAttributeMap(). 
    org.apache.tools.ant.ProjectHelper.getContextClassLoader() +
    +          since 1.6.x. + Use LoaderUtils.getContextClassLoader() 
    org.apache.tools.ant.types.ArchiveFileSet.getDirMode() +
    +          since 1.7. 
    org.apache.tools.ant.BuildException.getException() +
    +          Use Throwable.getCause() instead. 
    org.apache.tools.ant.types.ArchiveFileSet.getFileMode() +
    +          since 1.7. 
    org.apache.tools.ant.Project.getFilters() +
    +          since 1.4.x + Use getGlobalFilterSet().getFilterHash(). 
    org.apache.tools.ant.types.ArchiveFileSet.getFullpath() +
    +          since 1.7. 
    org.apache.tools.ant.Project.getJavaVersion() +
    +          since 1.5.x. + Use org.apache.tools.ant.util.JavaEnvUtils instead. 
    org.apache.tools.ant.PropertyHelper.getNext() +
    +          use the delegate mechanism instead 
    org.apache.tools.ant.util.FileUtils.getParentFile(File) +
    +          since 1.7. Just use File.getParentFile() directly. 
    org.apache.tools.ant.types.ArchiveFileSet.getPrefix() +
    +          since 1.7. 
    org.apache.tools.ant.taskdefs.Execute.getProcEnvironment() +
    +          use #getEnvironmentVariables instead 
    org.apache.tools.ant.PropertyHelper.getProperty(String, String) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.PropertyHelper.getPropertyHook(String, String, boolean) +
    +          PropertyHelper chaining is deprecated. 
    org.apache.tools.ant.types.Mapper.getRef() +
    +          since Ant 1.7.1 because a mapper might ref a + FileNameMapper implementation directly. 
    org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask.getSourcespath() +
    +          since 1.6.x. 
    org.apache.tools.ant.taskdefs.optional.TraXLiaison.getSystemId(File) +
    +          since 1.5.x. + Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead. 
    org.apache.tools.ant.PropertyHelper.getUserProperty(String, String) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.AntClassLoader.initializeClass(Class) +
    +          since 1.6.x. + Use Class.forName with initialize=true instead. 
    org.apache.tools.ant.Diagnostics.isOptionalAvailable() +
    +          Obsolete since Ant 1.8.2 
    org.apache.tools.ant.util.FileUtils.isSymbolicLink(File, String) +
    +          use SymbolicLinkUtils instead 
    org.apache.tools.ant.util.FileUtils.newFileUtils() +
    +          since 1.7. + Use getFileUtils instead, + FileUtils do not have state. 
    org.apache.tools.ant.ProjectHelper.parsePropertyString(String, Vector, Vector) +
    +          since 1.6.x. + Use PropertyHelper. 
    org.apache.tools.ant.PropertyHelper.parsePropertyString(String, Vector, Vector) +
    +          use the other mechanisms of this class instead 
    org.apache.tools.ant.taskdefs.SQLExec.printResults(PrintStream) +
    +          since 1.6.x. + Use the two arg version instead. 
    org.apache.tools.ant.taskdefs.optional.image.Image.processFile(File) +
    +          this method isn't used anymore 
    org.apache.tools.ant.util.CollectionUtils.putAll(Dictionary, Dictionary) +
    +          since 1.6.x. 
    org.apache.tools.ant.ProjectHelper.replaceProperties(Project, String) +
    +          since 1.6.x. + Use project.replaceProperties(). 
    org.apache.tools.ant.ProjectHelper.replaceProperties(Project, String, Hashtable) +
    +          since 1.6.x. + Use PropertyHelper. 
    org.apache.tools.ant.property.ResolvePropertyMap.resolveAllProperties(Map) +
    +          since Ant 1.8.2, use the three-arg method instead. 
    org.apache.tools.ant.property.ResolvePropertyMap.resolveAllProperties(Map, String) +
    +          since Ant 1.8.2, use the three-arg method instead. 
    org.apache.tools.ant.Project.resolveFile(String, File) +
    +          since 1.4.x 
    org.apache.tools.ant.taskdefs.optional.net.FTP.setAction(String) +
    +          since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. 
    org.apache.tools.ant.taskdefs.optional.net.FTPTask.setAction(String) +
    +          since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. 
    org.apache.tools.ant.RuntimeConfigurable.setAttributes(AttributeList) +
    +          since 1.6.x. 
    org.apache.tools.ant.taskdefs.optional.ReplaceRegExp.setByLine(String) +
    +          since 1.6.x. + Use setByLine(boolean). 
    org.apache.tools.zip.ZipEntry.setComprSize(long) +
    +          since 1.7. + Use setCompressedSize directly. 
    org.apache.tools.ant.taskdefs.FixCRLF.setCr(FixCRLF.AddAsisRemove) +
    +          since 1.4.x. + Use setEol instead. 
    org.apache.tools.ant.Project.setDefaultTarget(String) +
    +          since 1.5.x. + Use setDefault. 
    org.apache.tools.ant.taskdefs.Unpack.setDest(String) +
    +          since 1.5.x. + setDest(String) is deprecated and is replaced with + setDest(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. 
    org.apache.tools.ant.taskdefs.Ear.setEarfile(File) +
    +          since 1.5.x. + Use setDestFile(destfile) instead. 
    org.apache.tools.ant.taskdefs.Javadoc.setExtdirs(String) +
    +          since 1.5.x. + Use the Javadoc.setExtdirs(Path) version. 
    org.apache.tools.ant.taskdefs.Zip.setFile(File) +
    +          since 1.5.x. + Use setDestFile(File) instead. 
    org.apache.tools.ant.Project.setFileLastModified(File, long) +
    +          since 1.4.x 
    org.apache.tools.ant.taskdefs.Concat.setForce(boolean) +
    +          use #setOverwrite instead 
    org.apache.tools.ant.taskdefs.optional.ANTLR.setGlib(String) +
    +          since ant 1.6 
    org.apache.tools.ant.PropertyHelper.setInheritedProperty(String, String, Object) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.taskdefs.Jar.setJarfile(File) +
    +          since 1.5.x. + Use setDestFile(File) instead. 
    org.apache.tools.ant.taskdefs.Tar.setLongfile(String) +
    +          since 1.5.x. + setLongFile(String) is deprecated and is replaced with + setLongFile(Tar.TarLongFileMode) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the mode in its own class. 
    org.apache.tools.ant.taskdefs.SendEmail.setMailport(Integer) +
    +          since 1.5.x. + Use EmailTask.setMailport(int) instead. 
    org.apache.tools.ant.PropertyHelper.setNewProperty(String, String, Object) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.PropertyHelper.setNext(PropertyHelper) +
    +          use the delegate mechanism instead 
    org.apache.tools.ant.taskdefs.ExecuteJava.setOutput(PrintStream) +
    +          since 1.4.x. + manage output at the task level. 
    org.apache.tools.ant.taskdefs.Copy.setPreserveLastModified(String) +
    +          since 1.5.x. + setPreserveLastModified(String) has been deprecated and + replaced with setPreserveLastModified(boolean) to + consistently let the Introspection mechanism work. 
    org.apache.tools.ant.PropertyHelper.setProperty(String, String, Object, boolean) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.PropertyHelper.setPropertyHook(String, String, Object, boolean, boolean, boolean) +
    +          PropertyHelper chaining is deprecated. 
    org.apache.tools.ant.taskdefs.Classloader.setReverse(boolean) +
    +          use setParentFirst with a negated argument instead 
    org.apache.tools.ant.taskdefs.DefBase.setReverseLoader(boolean) +
    +          since 1.6.x. + stop using this attribute 
    org.apache.tools.ant.taskdefs.Execute.setSpawn(boolean) +
    +            
    org.apache.tools.ant.taskdefs.Unpack.setSrc(String) +
    +          since 1.5.x. + setSrc(String) is deprecated and is replaced with + setSrc(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. 
    org.apache.tools.ant.taskdefs.Tar.setTarfile(File) +
    +          since 1.5.x. + For consistency with other tasks, please use setDestFile(). 
    org.apache.tools.ant.taskdefs.PathConvert.setTargetos(String) +
    +          since 1.5.x. + Use the method taking a TargetOs argument instead. 
    org.apache.tools.ant.taskdefs.Available.setType(String) +
    +          since 1.5.x. + setType(String) is deprecated and is replaced with + setType(Available.FileDir) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. 
    org.apache.tools.ant.taskdefs.Tstamp.CustomFormat.setUnit(String) +
    +          since 1.5.x. + setUnit(String) is deprecated and is replaced with + setUnit(Tstamp.Unit) to make Ant's + Introspection mechanism do the work and also to + encapsulate operations on the unit in its own + class. 
    org.apache.tools.ant.taskdefs.optional.splash.SplashTask.setUseproxy(boolean) +
    +          since 1.5.x. + Use org.apache.tools.ant.taskdefs.optional.SetProxy 
    org.apache.tools.ant.taskdefs.Property.setUserProperty(boolean) +
    +          since 1.5.x. + This was never a supported feature and has been + deprecated without replacement. 
    org.apache.tools.ant.PropertyHelper.setUserProperty(String, String, Object) +
    +          namespaces are unnecessary. 
    org.apache.tools.ant.taskdefs.War.setWarfile(File) +
    +          since 1.5.x. + Use setDestFile(File) instead 
    org.apache.tools.ant.taskdefs.Zip.setZipfile(File) +
    +          since 1.5.x. + Use setDestFile(File) instead. 
    org.apache.tools.ant.types.CommandlineJava.size() +
    +          since 1.7. + Please dont use this, it effectively creates the + entire command. 
    org.apache.tools.ant.taskdefs.Touch.touch(File) +
    +          since 1.6.x. 
    org.apache.tools.ant.Project.translatePath(String) +
    +          since 1.7 + Use FileUtils.translatePath instead. 
    org.apache.tools.ant.Diagnostics.validateVersion() +
    +          Obsolete since Ant 1.8.2 
    +  +

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Deprecated Constructors
    org.apache.tools.ant.taskdefs.ExecuteWatchdog(int) +
    +          since 1.5.x. + Use constructor with a long type instead. + (1.4.x compatibility) 
    org.apache.tools.ant.types.resources.FileResourceIterator() +
    +          in favor of FileResourceIterator.FileResourceIterator(Project) 
    org.apache.tools.ant.types.resources.FileResourceIterator(File) +
    +          in favor of FileResourceIterator.FileResourceIterator(Project, File) 
    org.apache.tools.ant.types.resources.FileResourceIterator(File, String[]) +
    +          in favor of FileResourceIterator.FileResourceIterator(Project, File, String[]) 
    org.apache.tools.ant.Main(String[]) +
    +          since 1.6.x 
    org.apache.tools.ant.types.Reference() +
    +          since 1.7. + Please use Reference.Reference(Project,String) + instead. 
    org.apache.tools.ant.types.Reference(String) +
    +          since 1.7. + Please use Reference.Reference(Project,String) + instead. 
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/help-doc.html b/tools/apache-ant-1.8.2/docs/manual/api/help-doc.html new file mode 100644 index 000000000..b1dfe17a6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/help-doc.html @@ -0,0 +1,213 @@ + + + + + + +API Help (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Overview

    +
    + +

    +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/index-all.html b/tools/apache-ant-1.8.2/docs/manual/api/index-all.html new file mode 100644 index 000000000..f1aca8a42 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/index-all.html @@ -0,0 +1,32839 @@ + + + + + + +Index (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
    +

    +A

    +
    +
    AbstractAccessTask - Class in org.apache.tools.ant.taskdefs.optional.unix
     
    AbstractAccessTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Chmod task for setting file and directory permissions. +
    AbstractAnalyzer - Class in org.apache.tools.ant.util.depend
    An abstract implementation of the analyzer interface providing support + for the bulk of interface methods.
    AbstractAnalyzer() - +Constructor for class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Setup the analyzer +
    AbstractClasspathResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of anything that is accessed via a Java classloader.
    AbstractClasspathResource() - +Constructor for class org.apache.tools.ant.types.resources.AbstractClasspathResource +
      +
    AbstractClasspathResource.ClassLoaderWithFlag - Class in org.apache.tools.ant.types.resources
     
    AbstractCvsTask - Class in org.apache.tools.ant.taskdefs
    original Cvs.java 1.20 + + NOTE: This implementation has been moved here from Cvs.java with + the addition of some accessors for extensibility.
    AbstractCvsTask() - +Constructor for class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    empty no-arg constructor +
    AbstractCvsTask.Module - Class in org.apache.tools.ant.taskdefs
     
    AbstractCvsTask.Module() - +Constructor for class org.apache.tools.ant.taskdefs.AbstractCvsTask.Module +
      +
    AbstractFileSet - Class in org.apache.tools.ant.types
    Class that holds an implicit patternset and supports nested + patternsets and creates a DirectoryScanner using these patterns.
    AbstractFileSet() - +Constructor for class org.apache.tools.ant.types.AbstractFileSet +
    Construct a new AbstractFileSet. +
    AbstractFileSet(AbstractFileSet) - +Constructor for class org.apache.tools.ant.types.AbstractFileSet +
    Construct a new AbstractFileSet, shallowly cloned + from the specified AbstractFileSet. +
    AbstractHotDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.j2ee
    Abstract class to support vendor-specific hot deployment tools.
    AbstractHotDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
      +
    AbstractJarSignerTask - Class in org.apache.tools.ant.taskdefs
    This is factored out from SignJar; a base class that can be used + for both signing and verifying JAR files using jarsigner
    AbstractJarSignerTask() - +Constructor for class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
      +
    AbstractResourceCollectionWrapper - Class in org.apache.tools.ant.types.resources
    Base class for a ResourceCollection that wraps a single nested + ResourceCollection.
    AbstractResourceCollectionWrapper() - +Constructor for class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
      +
    AbstractScriptComponent - Class in org.apache.tools.ant.types.optional
    This is a ProjectComponent that has script support built in + Use it as a foundation for scriptable things.
    AbstractScriptComponent() - +Constructor for class org.apache.tools.ant.types.optional.AbstractScriptComponent +
      +
    AbstractSelectorContainer - Class in org.apache.tools.ant.types.selectors
    This is the a base class a container of selectors - it does + not need do be a selector itself.
    AbstractSelectorContainer() - +Constructor for class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
      +
    AbstractSshMessage - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Abstract class for ssh upload and download
    AbstractSshMessage(Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Constructor for AbstractSshMessage +
    AbstractSshMessage(boolean, Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Constructor for AbstractSshMessage +
    AbstractUnicodeExtraField - Class in org.apache.tools.zip
    A common base class for Unicode extra information extra fields.
    AbstractUnicodeExtraField() - +Constructor for class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    AbstractUnicodeExtraField(String, byte[], int, int) - +Constructor for class org.apache.tools.zip.AbstractUnicodeExtraField +
    Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry. +
    AbstractUnicodeExtraField(String, byte[]) - +Constructor for class org.apache.tools.zip.AbstractUnicodeExtraField +
    Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry. +
    accept(File, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.InnerClassFilenameFilter +
    Check if the file name passes the filter. +
    accept(Node) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeFilter +
      +
    ACTION_DELETE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    The delete action String +
    ACTION_DEPLOY - +Static variable in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    The deploy action String +
    ACTION_LIST - +Static variable in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    The list action String +
    ACTION_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    ACTION_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    ACTION_TARGET_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    ACTION_TARGET_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    ACTION_UNDEPLOY - +Static variable in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    The undeploy action String +
    ACTION_UPDATE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    The update action String +
    actOnTestResult(int, boolean, JUnitTest, String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property. +
    actOnTestResult(JUnitTask.TestResultHolder, JUnitTest, String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property. +
    add(Comparator) - +Method in class org.apache.tools.ant.filters.SortFilter +
    Set the comparator to be used as sorting criterium as nested element. +
    add(Tokenizer) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    add an arbitrary tokenizer +
    add(TokenFilter.Filter) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    Add an arbitrary filter +
    add(PropertyHelper.Delegate) - +Method in class org.apache.tools.ant.PropertyHelper +
    Add the specified delegate object to this PropertyHelper. +
    add(AntStructure.StructurePrinter) - +Method in class org.apache.tools.ant.taskdefs.AntStructure +
    The StructurePrinter to use. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Add a resource collection. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.CloseResources +
      +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Add an arbitrary ResourceCollection. +
    add(Condition) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an arbitrary condition +
    add(Resource) - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    The resource to test. +
    add(Resource) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceExists +
    The resource to test. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourcesMatch +
    Add a resource collection. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add a collection of files to copy. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add a nested filenamemapper. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. add a mapper +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Add an arbitrary ResourceCollection to be deleted. +
    add(FileSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add an arbitrary selector +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Add a collection of resources upon which to operate. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Add a nested FileNameMapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Add a resource collection. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    A nested filenamemapper +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Adds URLs to get. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Add a nested filenamemapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    The resource to import. +
    add(CompilerAdapter) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the compiler adapter explicitly. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ResourceCollectionContainer +
    Add a resource collection to the container. +
    add(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Add a FileSet. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Add a ResourceCollection. +
    add(FileSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add an arbitary selector +
    add(ImageOperation) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add an ImageOperation to chain. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add a nested filenamemapper. +
    add(JavahAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Set the adapter explicitly. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BatchTest +
    Add a new ResourceCollection instance to this + batchtest. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    A nested filenamemapper +
    add(Native2AsciiAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Set the adapter explicitly. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Add any source resource. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Add an arbitrary ResourceCollection. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Add a nested filenamemapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Add the ResourceCollection to count. +
    add(RmicAdapter) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Set the compiler adapter explicitly. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    add a mapper to determine file naming policy. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Adds a collection of resources (nested element). +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Adds a resource collection to the implicit build path. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Adds a collection of filesystem resources to copy. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Add a collection of resources to archive. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Add a FileNameMapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Add a collection of resources to touch. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Add a nested (filesystem-only) ResourceCollection. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    A nested filenamemapper +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Adds a collection of resources to style in addition to the + given file or the implicit fileset. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Adds a nested filenamemapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add a collection of resources to be archived. +
    add(FileSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add an arbitary selector. +
    add(ChainableReader) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a chainfilter filter. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.types.Mapper +
    Add a nested FileNameMapper. +
    add(Path) - +Method in class org.apache.tools.ant.types.Path +
    Adds a nested path +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.Path +
    Add a nested ResourceCollection. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.types.PropertySet +
    Add a nested FileNameMapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Add a ResourceCollection to the container. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Add a ResourceCollection to the container. +
    add(ResourceComparator) - +Method in class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
    Add a delegate ResourceComparator. +
    add(ResourceComparator) - +Method in class org.apache.tools.ant.types.resources.comparators.Reverse +
    Add the ResourceComparator to reverse. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Adds the required nested ResourceCollection. +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Add a nested filenamemapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Adds a source. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.Resources +
    Add a ResourceCollection. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Add the ResourceCollection. +
    add(ResourceSelector) - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Add a ResourceSelector. +
    add(ResourceComparator) - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Add a ResourceComparator to this Compare selector. +
    add(ResourceSelector) - +Method in class org.apache.tools.ant.types.resources.selectors.Not +
    Set the ResourceSelector. +
    add(ResourceSelector) - +Method in class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Add a ResourceSelector to the container. +
    add(ResourceComparator) - +Method in class org.apache.tools.ant.types.resources.Sort +
    Add a ResourceComparator to this Sort ResourceCollection. +
    add(Tokenizer) - +Method in class org.apache.tools.ant.types.resources.Tokens +
    Add the nested Tokenizer to this Tokens ResourceCollection. +
    add(FileSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add an arbitary selector +
    add(FileSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add an arbitary selector +
    add(FileSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add an arbitary selector +
    add(FileNameMapper) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Add a FileNameMapper. +
    add(ResourceCollection) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Add any source resource. +
    add(Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    add(int, Object) - +Method in class org.apache.tools.ant.util.VectorSet +
    This implementation may not add the element at the given index + if it is already contained in the collection. +
    addAddFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Adds a file to be added into the output. +
    addAddFiles(String[]) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Adds several file to be added into the output. +
    addAll(Collection) - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Add the Collection of ResourceCollections to the container. +
    addAll(Collection) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    addAll(int, Collection) - +Method in class org.apache.tools.ant.util.VectorSet +
    This implementation may not add all elements at the given index + if any of them are already contained in the collection. +
    addAnd(And) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <and> condition "container". +
    addAnd(AndSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add an "And" selector entry on the selector list +
    addAnd(AndSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add an "And" selector entry on the selector list +
    addAnd(AndSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add an "And" selector entry on the selector list. +
    addAnd(AndSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add an "And" selector entry on the selector list +
    addAnd(AndSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add an "And" selector entry on the selector list +
    addAnd(AndSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add an "And" selector entry on the selector list +
    addApplication(Sequential) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Add an application. +
    addArc(Arc) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Add an arc. +
    addArchives(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.Ear +
    Adds zipfileset. +
    addArg(CommandlineJava, String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    add an argument oneple to the argument list, if the value aint null +
    addArg(CommandlineJava, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    add an argument tuple to the argument list, if the value aint null +
    addArg(CommandlineJava, String, File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    add an argument tuple to the arg list, if the file parameter aint null +
    addArguments(String[]) - +Method in class org.apache.tools.ant.types.Commandline +
    Append the arguments to the existing command. +
    addArgumentsToList(ListIterator) - +Method in class org.apache.tools.ant.types.Commandline +
    Append all the arguments to the tail of a supplied list. +
    addAsFirstExtraField(ZipExtraField) - +Method in class org.apache.tools.zip.ZipEntry +
    Adds an extra field - replacing an already present extra field + of the same type. +
    addAssertions(Assertions) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add assertions to enable in this program (if fork=true). +
    addAssertions(Assertions) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Assertions to enable in this program (if fork=true) +
    addAttribute(ScriptDef.Attribute) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Add an attribute definition to this script. +
    addAttribute(XSLTProcess.Factory.Attribute) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory +
    Create an instance of a factory attribute. +
    addAttributeAndCheck(Manifest.Attribute) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Add an attribute to the section +
    addAvailable(Available) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <available> condition. +
    addBasedir(File) - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
      +
    addBcc(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a "bcc" address element. +
    addBean(String, Object) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Add a single object into the script context. +
    addBeans(Map) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Add a list of named objects to the list to be exported to the script +
    addBlock(BlockFor) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Add a block. +
    addBottom(Javadoc.Html) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the text to be placed at the bottom of each output file. +
    addBuildFailedSound(File, int, Long) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
      +
    addBuildListener(BuildListener) - +Method in class org.apache.tools.ant.Project +
    Add a build listener to the list. +
    addBuildListeners(Project) - +Method in class org.apache.tools.ant.Main +
    Adds the listeners specified in the command line arguments, + along with the default listener, to the specified project. +
    addBuildSuccessfulSound(File, int, Long) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
      +
    addCc(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a "cc" address element. +
    addChecksum(Checksum) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <checksum> condition. +
    addChild(RuntimeConfigurable) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Adds a child element to the wrapped element. +
    addChild(UnknownElement) - +Method in class org.apache.tools.ant.UnknownElement +
    Adds a child element to this element. +
    addClassConstants(ClassConstants) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a ClassConstants filter. +
    addClasses(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.War +
    add files under WEB-INF/classes +
    addClassPath(Path) - +Method in class org.apache.tools.ant.taskdefs.ManifestClassPath +
    Adds the classpath to convert. +
    addClasspath(Path) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Add the classpath. +
    addClassPath(Path) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Add a classpath to the classpath being used by the analyzer. +
    addClassPath(Path) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Add a classpath to the classpath being used by the analyzer. +
    addClasspathEntry(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Search for the given resource and add the directory or archive + that contains it to the classpath. +
    addClasspathEntry(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Search for the given resource and add the directory or archive + that contains it to the classpath. +
    addCommandArgument(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    This needs to be public to allow configuration + of commands externally. +
    addCommandArgument(Commandline, String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    This method adds a command line argument to an external command. +
    addCommandToList(ListIterator) - +Method in class org.apache.tools.ant.types.Commandline +
    Add the entire command, including (optional) executable to a list. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the source resource. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    Set the source resource. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Support arbitrary file system based resource collections. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    Set the source resource. +
    addConfigured(ProjectHelper) - +Method in class org.apache.tools.ant.taskdefs.ProjectHelperTask +
      +
    addConfigured(PropertyHelper) - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask +
    Add a new PropertyHelper to be set on the Project. +
    addConfigured(PropertyHelper.Delegate) - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask +
    Add a PropertyHelper delegate to the existing or new PropertyHelper. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Support arbitrary file system based resource collections. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.SQLExec.Transaction +
    Set the source resource. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Set the source Archive resource. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Set the source resource. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Set the source Archive file for the archivefileset. +
    addConfigured(FileNameMapper) - +Method in class org.apache.tools.ant.types.Mapper +
    Cannot mix add and addconfigured in same type, so + provide this to override the add method. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Sets the archive that holds this as a single element Resource + collection. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Sets the resource to wrap using a single-element collection. +
    addConfigured(ResourceCollection) - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Sets the archive that holds this as a single element Resource + collection. +
    addConfigured(FileNameMapper) - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    Add a configured FileNameMapper instance. +
    addConfigured(FileNameMapper) - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    Add a configured FileNameMapper instance. +
    addConfigured(FileNameMapper) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    An add configured version of the add method. +
    addConfiguredAnt(AntResolver) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Adds Ant resolver to run an Ant build file to generate a library. +
    addConfiguredAttribute(MacroDef.Attribute) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Add an attribute element. +
    addConfiguredAttribute(Manifest.Attribute) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Add an attribute to the manifest - it is added to the main section. +
    addConfiguredAttribute(Manifest.Attribute) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Add an attribute to the section. +
    addConfiguredAttribute(Manifest.Attribute) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Add an attribute to the manifest - it is added to the main section. +
    addConfiguredAttribute(ExtraAttribute) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    Adds an attribute that is to be put in main section of manifest. +
    addConfiguredCommandline(Commandline) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Adds direct command-line to execute. +
    addConfiguredCommandline(Commandline, boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Configures and adds the given Commandline. +
    addConfiguredComment(StripLineComments.Comment) - +Method in class org.apache.tools.ant.filters.StripLineComments +
    Adds a comment element to the list of prefixes. +
    addConfiguredContains(LineContains.Contains) - +Method in class org.apache.tools.ant.filters.LineContains +
    Adds a contains element. +
    addConfiguredDepends(ExtensionSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    Adds a set of extensions that this library requires. +
    addConfiguredElement(MacroDef.TemplateElement) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Add an element element. +
    addConfiguredErrorMapper(Mapper) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Add the error file mapper. +
    addConfiguredExtension(ExtensionAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
    Set the Extension looking for. +
    addConfiguredExtension(ExtensionAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    Adds an extension that this library implements. +
    addConfiguredExtension(ExtensionAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Set the Extension looking for. +
    addConfiguredExtensionSet(ExtensionSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
    Adds a set of extensions to search in. +
    addConfiguredFile(FileList.FileName) - +Method in class org.apache.tools.ant.types.FileList +
    Add a nested <file> nested element. +
    addConfiguredFilterSet(FilterSet) - +Method in class org.apache.tools.ant.types.FilterSet +
    Add a Filterset to this filter set. +
    addConfiguredGrant(Permissions.Permission) - +Method in class org.apache.tools.ant.types.Permissions +
    Adds a permission to be granted. +
    addConfiguredIndexJars(Path) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Add a path to index jars. +
    addConfiguredInputMapper(Mapper) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Add the input file mapper. +
    addConfiguredInvert(PatternSet) - +Method in class org.apache.tools.ant.types.PatternSet +
    Add an inverted patternset. +
    addConfiguredLocation(LocationResolver) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Adds location resolver to look for a library in a location + relative to project directory. +
    addConfiguredManifest(Manifest) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Allows the manifest for the archive file to be provided inline + in the build file rather than in an external file. +
    addConfiguredMapper(Mapper) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Add a Mapper. +
    addConfiguredMapper(Mapper) - +Method in class org.apache.tools.ant.types.Mapper +
    Add a Mapper +
    addConfiguredMapper(Mapper) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Add a Mapper. +
    addConfiguredOptions(ExtensionSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    Adds a set of extensions that this library optionally requires. +
    addConfiguredOutputMapper(Mapper) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Add the output file mapper. +
    addConfiguredPatternset(PatternSet) - +Method in class org.apache.tools.ant.types.PatternSet +
    This is a patternset nested element. +
    addConfiguredProvider(Provider) - +Method in class org.apache.tools.ant.types.spi.Service +
    Add a nested provider element. +
    addConfiguredRedirector(RedirectorElement) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Add a RedirectorElement to this task. +
    addConfiguredRedirector(RedirectorElement) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a RedirectorElement to this task. +
    addConfiguredRegexp(RegularExpression) - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Adds a regexp element. +
    addConfiguredRevoke(Permissions.Permission) - +Method in class org.apache.tools.ant.types.Permissions +
    Adds a permission to be revoked. +
    addConfiguredRoot(ClassfileSet.ClassRoot) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Add a nested root class definition to this class file set. +
    addConfiguredSchema(SchemaValidate.SchemaLocation) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    add the schema +
    addConfiguredSection(Manifest.Section) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Add a section to the manifest +
    addConfiguredSection(Manifest.Section) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Add a section to the manifest +
    addConfiguredService(Service) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    A nested SPI service element. +
    addConfiguredStyle(Resources) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Add a nested <style> element. +
    addConfiguredSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds a system property that tests can access. +
    addConfiguredTarget(Ant.TargetElement) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Add a target to this Ant invocation. +
    addConfiguredTarget(Ant.TargetElement) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Add a target to the list of targets to invoke. +
    addConfiguredTarget(Ant.TargetElement) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Add a target to this Ant invocation. +
    addConfiguredText(MacroDef.Text) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Add the text element. +
    addConfiguredToken(ReplaceTokens.Token) - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    Adds a token element to the map of tokens to replace. +
    addConfiguredUrl(URLResolver) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Adds a URL resolver to download a library from a URL + to a local file. +
    addConfiguredXMLCatalog(XMLCatalog) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    add an XMLCatalog as a nested element; optional. +
    addConfiguredXMLCatalog(XMLCatalog) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    add an XMLCatalog as a nested element; optional. +
    addConfiguredXMLCatalog(XMLCatalog) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Add the catalog to our internal catalog +
    addConfiguredXMLCatalog(XMLCatalog) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Loads a nested <xmlcatalog> into our + definition. +
    addConnectionProperty(Property) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Additional properties to put into the JDBC connection string. +
    addContains(Contains) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add a <contains> condition. +
    addContains(ContainsSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a contains selector entry on the selector list +
    addContains(ContainsSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a contains selector entry on the selector list +
    addContains(ContainsSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a contains selector entry on the selector list. +
    addContains(ContainsSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a contains selector entry on the selector list +
    addContains(ContainsSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a contains selector entry on the selector list +
    addContains(ContainsSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a contains selector entry on the selector list +
    addContainsRegex(TokenFilter.ContainsRegex) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    contains regex filter +
    addContainsRegex(TokenFilter.ContainsRegex) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a containsregex filter. +
    addContainsRegexp(ContainsRegexpSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a regular expression selector entry on the selector list +
    addContainsRegexp(ContainsRegexpSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a regular expression selector entry on the selector list +
    addContainsRegexp(ContainsRegexpSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a regular expression selector entry on the selector list. +
    addContainsRegexp(ContainsRegexpSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a regular expression selector entry on the selector list +
    addContainsRegexp(ContainsRegexpSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a regular expression selector entry on the selector list +
    addContainsRegexp(ContainsRegexpSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a regular expression selector entry on the selector list +
    addContainsString(TokenFilter.ContainsString) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    contains string filter +
    addContinuation(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Add a continuation line from the Manifest file. +
    addCurrentCompilerArgs(Commandline) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Adds the command line arguments specific to the current implementation. +
    addCustom(ExtendSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add an extended selector entry on the selector list +
    addCustom(ExtendSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add an extended selector entry on the selector list +
    addCustom(ExtendSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add an extended selector entry on the selector list. +
    addCustom(ExtendSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add an extended selector entry on the selector list +
    addCustom(ExtendSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add an extended selector entry on the selector list +
    addCustom(ExtendSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add an extended selector entry on the selector list +
    addDaemons(Parallel.TaskList) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Add a group of daemon threads +
    addDataType(RuntimeConfigurable) - +Method in class org.apache.tools.ant.ExtensionPoint +
    Throws an exception. +
    addDataType(RuntimeConfigurable) - +Method in class org.apache.tools.ant.Target +
    Adds the wrapper for a data type element to this target. +
    addDataTypeDefinition(String, Class) - +Method in class org.apache.tools.ant.ComponentHelper +
    Adds a new datatype definition. +
    addDataTypeDefinition(AntTypeDefinition) - +Method in class org.apache.tools.ant.ComponentHelper +
    Describe addDataTypeDefinition method here. +
    addDataTypeDefinition(String, Class) - +Method in class org.apache.tools.ant.Project +
    Add a new datatype definition. +
    addDate(DateSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a selector date entry on the selector list +
    addDate(DateSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a selector date entry on the selector list +
    addDate(DateSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a selector date entry on the selector list. +
    addDate(DateSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a selector date entry on the selector list +
    addDate(DateSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a selector date entry on the selector list +
    addDate(DateSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a selector date entry on the selector list +
    addDefaultExclude(String) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Add a pattern to the default excludes unless it is already a + default exclude. +
    addDefaultExcludes() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Add default exclusions to the current exclusions set. +
    addDefaultExcludes() - +Method in interface org.apache.tools.ant.FileScanner +
    Adds default exclusions to the current exclusions set. +
    addDefaultExcludes() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
      +
    addDefinition(ClassLoader, String, String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Add a definition using the attributes of Definer +
    addDefinitionsToList(ListIterator) - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Add all definitions (including property sets) to a list. +
    addDeleteCharacters(TokenFilter.DeleteCharacters) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    delete chars +
    addDeleteCharacters(TokenFilter.DeleteCharacters) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a delete characters filter. +
    addDepend(DependSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a depends selector entry on the selector list +
    addDepend(DependSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a depends selector entry on the selector list +
    addDepend(DependSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a depends selector entry on the selector list. +
    addDepend(DependSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a depends selector entry on the selector list +
    addDepend(DependSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a depends selector entry on the selector list +
    addDepend(DependSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a depends selector entry on the selector list +
    addDependency(String) - +Method in class org.apache.tools.ant.Target +
    Adds a dependency to this target. +
    addDeploymentTool(EJBDeploymentTool) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Add a deployment tool to the list of deployment tools that will be + processed +
    addDepth(DepthSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a depth selector entry on the selector list +
    addDepth(DepthSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a depth selector entry on the selector list +
    addDepth(DepthSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a depth selector entry on the selector list. +
    addDepth(DepthSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a depth selector entry on the selector list +
    addDepth(DepthSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a depth selector entry on the selector list +
    addDepth(DepthSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a depth selector entry on the selector list +
    addDifferent(DifferentSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a type selector entry on the type list +
    addDifferent(DifferentSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a DifferentSelector entry on the selector list. +
    addDifferent(DifferentSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    adds a different selector to the selector list +
    addDifferent(DifferentSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    adds a different selector to the selector list +
    addDifferent(DifferentSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add the different selector +
    addDirectory(Directory) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Add a directory to the child directories. +
    addDirset(DirSet) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Add a set of directories upon which to operate. +
    addDirset(DirSet) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Adds a directory set to the implicit build path. +
    addDirset(DirSet) - +Method in class org.apache.tools.ant.types.Path +
    Adds a nested <dirset> element. +
    addDisable(Assertions.DisabledAssertion) - +Method in class org.apache.tools.ant.types.Assertions +
    disable assertions +
    addDoctitle(Javadoc.Html) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Add a document title to use for the overview page. +
    addDraw(Draw) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add a Draw ImageOperation to the chain. +
    addDraw(Draw) - +Method in class org.apache.tools.ant.types.optional.image.ImageOperation +
    Add a draw to the operation. +
    addDTD(ResourceLocation) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Creates the nested <dtd> element. +
    addedDirs - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    addElement(ScriptDef.NestedElement) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Add a nested element definition. +
    addElement(Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    addEllipse(Ellipse) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Add an ellipse. +
    addEnable(Assertions.EnabledAssertion) - +Method in class org.apache.tools.ant.types.Assertions +
    enable assertions +
    addEntity(ResourceLocation) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Creates the nested <entity> element. +
    addEntry(ConstantPoolEntry) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Add an entry to the constant pool. +
    addEntry(CatalogEntry) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalog +
    This method overrides the superclass method of the same name + in order to add catalog entries back to the controlling + XMLCatalog instance. +
    addEnv(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Add an environment variable to the launched process. +
    addEnv(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add an environment variable. +
    addEnv(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds an environment variable; used when forking. +
    addEquals(Equals) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <equals> condition. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    A test caused an error. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Add the failed test to the list. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Interface TestListener. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Interface TestListener. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Empty +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
    Only invoke tearDown if the suite is known and not the dummy + test we get when a Batch fails and the error is an actual + error generated by Ant. +
    addError(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Interface TestListener. +
    addEscapeUnicode(EscapeUnicode) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add an EscapeUnicode filter. +
    addExcludePackage(Javadoc.PackageName) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Add a package to be excluded from the Javadoc run. +
    addExcludes(String[]) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Add to the list of exclude patterns to use. +
    addExisting(Path) - +Method in class org.apache.tools.ant.types.Path +
    Adds the components on the given path which exist to this + Path. +
    addExisting(Path, boolean) - +Method in class org.apache.tools.ant.types.Path +
    Same as addExisting, but support classpath behavior if tryUserDir + is true. +
    addExpandProperties(ExpandProperties) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add an ExpandProperties filter. +
    addExtdirs(Path) - +Method in class org.apache.tools.ant.types.Path +
    Emulation of extdirs feature in java >= 1.2. +
    addExtdirsToClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.types.Path#addExtdirs instead. +
    addExtension(Extension, Attributes) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Add Extension to the specified manifest Attributes. +
    addExtension(Extension, String, Attributes) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Add Extension to the specified manifest Attributes. +
    addExtension(ExtensionAdapter) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
    Adds an extension that this library requires. +
    addExtraField(ZipExtraField) - +Method in class org.apache.tools.zip.ZipEntry +
    Adds an extra field - replacing an already present extra field + of the same type. +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Interface TestListener for JUnit <= 3.4. +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Interface TestListener for JUnit > 3.4. +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Add the failed test to the list. +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Interface TestListener for JUnit <= 3.4. +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Interface TestListener for JUnit > 3.4. +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Interface TestListener for JUnit <= 3.4. +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Interface TestListener for JUnit > 3.4. +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Empty +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Interface TestListener for JUnit > 3.4. +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    addFailure(Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Interface TestListener for JUnit <= 3.4. +
    addFailure(Test, AssertionFailedError) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Interface TestListener for JUnit > 3.4. +
    addFile(String, String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Adds a file to the CVSEntry +
    addFile(String, String, String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Adds a file to the CVSEntry +
    addFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Add a file to the list of files. +
    addFilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    List of files to concatenate. +
    addFilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Add a list of source files upon which to operate. +
    addFilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Adds an ordered file list to the implicit build path. +
    addFilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Add a filelist to touch. +
    addFilelist(FileList) - +Method in class org.apache.tools.ant.types.Path +
    Adds a nested <filelist> element. +
    addFilename(FilenameSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a selector filename entry on the selector list +
    addFilename(FilenameSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a selector filename entry on the selector list +
    addFilename(FilenameSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a selector filename entry on the selector list. +
    addFilename(FilenameSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a selector filename entry on the selector list +
    addFilename(FilenameSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a selector filename entry on the selector list +
    addFilename(FilenameSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a selector filename entry on the selector list +
    addFiles(Commandline, ProjectComponent, File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii +
    Adds source and dest files to the command line. +
    addFiles(String[]) - +Method in class org.apache.tools.ant.types.resources.FileResourceIterator +
    Add an array of filenames to this FileResourceIterator. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Adds a set of files to sign +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Files to generate checksums for. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Set of files to concatenate. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add a set of files to copy. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Adds a set of files about which cvs logs will be generated. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Adds a set of files to be deleted. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a set of files (nested fileset attribute). +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Add a set of files upon which to operate. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Add a fileset +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a fileset. +
    addFileSet(FileSet) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    a fileset of jar files to include in the URL, each + separated by the separator +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Adds a set of files to archive. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Adds a set of files to copy. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
    Adds a set of files about which extensions data will be extracted. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask +
    Adds a set of files about which library data will be displayed. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Adds a set of files to translate as a nested fileset element. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add a set of files to be deleted. +
    addFileSet(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Add a fileset. +
    addFileSet(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BatchTest +
    Add a new fileset instance to this batchtest. +
    addFileSet(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Add a new fileset containing the XML results to aggregate +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    A set of files to upload or download +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    A set of files to upload or download +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Add +
    Add a fileset whose files will be added to Perforce. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
    Adds a fileset to be examined by p4fstat. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    list files to apply the replacement to +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Adds a FileSet tranfer to remote host. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Add a fileset to this task. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    specify a set of file to be checked +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Adds a set of files (nested fileset attribute). +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Adds a file set to the implicit build path. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Adds a set of files to copy. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Add a set of files to touch. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Adds a set of files. +
    addFileset(FileSet) - +Method in class org.apache.tools.ant.types.Path +
    Adds a nested <fileset> element. +
    addFilesMatch(FilesMatch) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add a <filesmatch> condition. +
    addFileToJar(JarOutputStream, File, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Utility method that encapsulates the logic of adding a file entry to + a .jar file. +
    addFileTokenizer(TokenFilter.FileTokenizer) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    add a file tokenizer +
    addFilter(String, String) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x. + Use getGlobalFilterSet().addFilter(token,value) +
    addFilter(FilterSet.Filter) - +Method in class org.apache.tools.ant.types.FilterSet +
    Add a new filter. +
    addFilter(String, String) - +Method in class org.apache.tools.ant.types.FilterSet +
    Add a new filter made from the given token and value. +
    addFilterChain(FilterChain) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Adds a FilterChain. +
    addFilterChain(FilterChain) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Adds a FilterChain. +
    addFilterChain(FilterChain) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    Add the FilterChain element. +
    addFilterChain(FilterChain) - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Adds a FilterChain. +
    addFilterReader(AntFilterReader) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add an AntFilterReader filter. +
    addFilterSet(FilterSet) - +Method in class org.apache.tools.ant.types.FilterSetCollection +
    Add a filterset to the collection. +
    addFooter(Concat.TextElement) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Add a footer to the concatenated output +
    addFooter(Javadoc.Html) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the footer text to be placed at the bottom of each output file. +
    addFormatter(FormatterElement) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Allow a formatter nested element. +
    addFormatter(FormatterElement) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Add a new formatter to all tests of this task. +
    addFormatter(JUnitTaskMirror.JUnitResultFormatterMirror) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Add a formatter to the test. +
    addFormatter(JUnitResultFormatter) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Add a formatter. +
    addFormatter(JUnitTaskMirror.JUnitResultFormatterMirror) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Add a formatter to the test.. +
    addFrom(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a from address element. +
    addGeneric(GenericHotDeploymentTool) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Creates a generic deployment tool. +
    addHeader(Concat.TextElement) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Add a header to the concatenated output +
    addHeader(Javadoc.Html) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the header text to be placed at the top of each output file. +
    addHeadFilter(HeadFilter) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a HeadFilter filter. +
    addHttp(Http) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <http> condition. +
    addIdReference(String, Object) - +Method in class org.apache.tools.ant.Project +
    Add an id reference. +
    addIgnoreBlank(TokenFilter.IgnoreBlank) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    ignore blank filter +
    addIgnoreBlank(TokenFilter.IgnoreBlank) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add an ignoreBlank filter. +
    addImageOperation(ImageOperation) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add an ImageOperation to chain. +
    addImplementationArgument(ImplementationSpecificArgument) - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Command line argument. +
    addIsFalse(IsFalse) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add a <isfalse> condition. +
    addIsFileSelected(IsFileSelected) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <isfileselected> condition. +
    addIsReference(IsReference) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <isreference> condition. +
    addIsSet(IsSet) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <isset> condition. +
    addIsTrue(IsTrue) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add a <istrue> condition. +
    addJavaLibraries() - +Method in class org.apache.tools.ant.AntClassLoader +
    add any libraries that come with different java versions + here +
    addJavaRuntime() - +Method in class org.apache.tools.ant.types.Path +
    Add the Java Runtime classes to this Path instance. +
    addJonas(JonasHotDeploymentTool) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Creates a JOnAS deployment tool, for deployment to JOnAS servers. +
    addLib(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.War +
    add files under WEB-INF/lib/ +
    addLibfileset(LibFileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
    Adds a set of files about which extensions data will be extracted. +
    addLineContains(LineContains) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a LineContains filter. +
    addLineContainsRegExp(LineContainsRegExp) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a LineContainsRegExp filter. +
    addLineTokenizer(LineTokenizer) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    add a line tokenizer - this is the default. +
    addLoaderPackageRoot(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Adds a package root to the list of packages which must be loaded using + this loader. +
    addLocal(String) - +Method in class org.apache.tools.ant.property.LocalProperties +
    Add a local property to the current scope. +
    addLocal(String) - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Add a local property. +
    addLocationToBuildException(BuildException, Location) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Add location to build exception. +
    addMajority(MajoritySelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a majority selector entry on the selector list +
    addMajority(MajoritySelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a majority selector entry on the selector list +
    addMajority(MajoritySelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a majority selector entry on the selector list. +
    addMajority(MajoritySelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a majority selector entry on the selector list +
    addMajority(MajoritySelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a majority selector entry on the selector list +
    addMajority(MajoritySelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a majority selector entry on the selector list +
    addMappedName(String) - +Method in class org.apache.tools.ant.types.optional.ScriptMapper +
    Add a mapped name +
    addMapper(Mapper) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Add a mapper to convert the file names. +
    addMapper(Mapper) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Defines the mapper to map source to destination files. +
    addMergeFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Adds a file to be merged into the output. +
    addMergeFiles(String[]) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Adds several files to be merged into the output. +
    addMessage(Message) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a message element. +
    addMetainf(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Adds a zipfileset to include in the META-INF directory. +
    addModified(ModifiedSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add the modified selector +
    addModified(ModifiedSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add the modified selector +
    addModified(ModifiedSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add the modified selector. +
    addModified(ModifiedSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add the modified selector +
    addModified(ModifiedSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add the modified selector +
    addModified(ModifiedSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add the modified selector +
    addModule(AbstractCvsTask.Module) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    add a named module/package. +
    addNone(NoneSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a "None" selector entry on the selector list +
    addNone(NoneSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a "None" selector entry on the selector list +
    addNone(NoneSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a "None" selector entry on the selector list. +
    addNone(NoneSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a "None" selector entry on the selector list +
    addNone(NoneSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a "None" selector entry on the selector list +
    addNone(NoneSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a "None" selector entry on the selector list +
    addNot(Not) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <not> condition "container". +
    addNot(NotSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a "Not" selector entry on the selector list +
    addNot(NotSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a "Not" selector entry on the selector list +
    addNot(NotSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a "Not" selector entry on the selector list. +
    addNot(NotSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a "Not" selector entry on the selector list +
    addNot(NotSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a "Not" selector entry on the selector list +
    addNot(NotSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a "Not" selector entry on the selector list +
    addOr(Or) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <or> condition "container". +
    addOr(OrSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add an "Or" selector entry on the selector list +
    addOr(OrSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add an "Or" selector entry on the selector list +
    addOr(OrSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add an "Or" selector entry on the selector list. +
    addOr(OrSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add an "Or" selector entry on the selector list +
    addOr(OrSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add an "Or" selector entry on the selector list +
    addOr(OrSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add an "Or" selector entry on the selector list +
    addOrReplaceTarget(Target) - +Method in class org.apache.tools.ant.Project +
    Add a target to the project, or replaces one with the same + name. +
    addOrReplaceTarget(String, Target) - +Method in class org.apache.tools.ant.Project +
    Add a target to the project, or replaces one with the same + name. +
    addOs(Os) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <os> condition. +
    addPackage(Javadoc.PackageName) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Add a single package to be processed. +
    addPackage(Javadoc.PackageName) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Add a package nested element. +
    addPackageset(DirSet) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a packageset. +
    addParam(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Add a parameter. +
    addParam(String, String) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLiaison +
    Add a parameter to be set during the XSL transformation. +
    addParam(Parameter) - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Add a Parameter. +
    addParam(Parameter) - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Create new parameters to pass to custom selector. +
    addParam(String, Object) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for nested <param> tags. +
    addParam(Parameter) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for nested <param> tags. +
    addParentDirs(File, String, ZipOutputStream, String, int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Ensure all parent dirs of a given entry have been added. +
    addPath(Path) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    add a path to the URL. +
    addPathComponent(File) - +Method in class org.apache.tools.ant.AntClassLoader +
    Add a path component. +
    addPathElement(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Adds an element to the classpath to be searched. +
    addPathFile(File) - +Method in class org.apache.tools.ant.AntClassLoader +
    Add a file to the path. +
    addPatternset(PatternSet) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Add a patternset. +
    addPrefixLines(PrefixLines) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a PrefixLines filter. +
    addPresent(PresentSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a present selector entry on the selector list +
    addPresent(PresentSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a present selector entry on the selector list +
    addPresent(PresentSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a present selector entry on the selector list. +
    addPresent(PresentSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a present selector entry on the selector list +
    addPresent(PresentSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a present selector entry on the selector list +
    addPresent(PresentSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a present selector entry on the selector list +
    addPreserveInTarget(Sync.SyncTarget) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    A container for patterns and selectors that can be used to + specify files that should be kept in the target even if they + are not present in any source directory. +
    addProperties(Properties) - +Method in class org.apache.tools.ant.taskdefs.Property +
    iterate through a set of properties, + resolve them then assign them +
    addProperty(String, String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    add a name value pair to the project property set +
    addProperty(String, Object) - +Method in class org.apache.tools.ant.taskdefs.Property +
    add a name value pair to the project property set +
    addProperty(Property) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + nested <property> element. +
    addPropertyref(PropertySet.PropertyRef) - +Method in class org.apache.tools.ant.types.PropertySet +
    Add a property reference (nested element) to the references to be used. +
    addPropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Add a set of properties to pass to the new project. +
    addPropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Set of properties to pass to the new project. +
    addPropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    A set of properties to write. +
    addPropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + nested <propertyset> element. +
    addPropertyset(PropertySet) - +Method in class org.apache.tools.ant.types.PropertySet +
    Add another property set to this set. +
    addPublicEntry(String, String, URL) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalogResolver +
    Add a PUBLIC catalog entry to the controlling XMLCatalog instance. +
    addPvcsproject(PvcsProject) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Specify a project within the PVCS repository to extract files from. +
    addReadable(ReadableSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
      +
    addReadable(ReadableSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
      +
    addReadable(ReadableSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
      +
    addRectangle(Rectangle) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Add a rectangle to the operation... +
    addRectangle(Rectangle) - +Method in class org.apache.tools.ant.types.optional.image.ImageOperation +
    Add a rectangle to the operation. +
    addRectangle(Rectangle) - +Method in class org.apache.tools.ant.types.optional.image.TransformOperation +
    Add a rectangle to the operation.. +
    addReference(String, Object) - +Method in class org.apache.tools.ant.Project +
    Add a reference to the project. +
    addReference(Ant.Reference) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Add a Reference element identifying a data type to carry + over to the new project. +
    addReference(Ant.Reference) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Reference element identifying a data type to carry + over to the invoked target. +
    addReference(Ant.Reference) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + nested <reference> element. +
    addRegexp(RegularExpression) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    A regular expression. +
    addReplaceRegex(TokenFilter.ReplaceRegex) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    replace regex filter +
    addReplaceRegex(TokenFilter.ReplaceRegex) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a replaceregex filter. +
    addReplaceString(TokenFilter.ReplaceString) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    replace string filter +
    addReplaceString(TokenFilter.ReplaceString) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a replacestring filter. +
    addReplaceTokens(ReplaceTokens) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a ReplaceTokens filter. +
    addReplyTo(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a replyto address element. +
    addReporting(Sequential) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    set reporting sequence of tasks. +
    addResources(FileSet, Resource[], ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add the given resources. +
    addResources(ResourceCollection, Resource[], ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add the given resources. +
    addRootClass(String) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Add a root class. +
    addRootClass(String) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Add a root class. +
    addRootFileset(FileSet) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Add a fileset to which contains a collection of root classes used to + drive the search from classes. +
    addRotate(Rotate) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add a Rotate ImageOperation to the chain. +
    addRotate(Rotate) - +Method in class org.apache.tools.ant.types.optional.image.ImageOperation +
    Add a rotate to the operation. +
    addScale(Scale) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Add a Scale ImageOperation to the chain. +
    addScale(Scale) - +Method in class org.apache.tools.ant.types.optional.image.ImageOperation +
    Add a scale to the operation. +
    addSchemaLocations() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    build a string list of all schema locations, then set the relevant + property. +
    addSelector(SelectSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a "Select" selector entry on the selector list +
    addSelector(SelectSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a "Select" selector entry on the selector list +
    addSelector(SelectSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a "Select" selector entry on the selector list. +
    addSelector(SelectSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a "Select" selector entry on the selector list +
    addSelector(SelectSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a "Select" selector entry on the selector list +
    addSelector(SelectSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a "Select" selector entry on the selector list +
    addSetup(Sequential) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Add a setup sequence. +
    addSize(SizeSelector) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a selector size entry on the selector list +
    addSize(SizeSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a selector size entry on the selector list +
    addSize(SizeSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a selector size entry on the selector list. +
    addSize(SizeSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    add a selector size entry on the selector list +
    addSize(SizeSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    add a selector size entry on the selector list +
    addSize(SizeSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add a selector size entry on the selector list +
    addSocket(Socket) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add a <socket> condition. +
    addSource(Javadoc.SourceFile) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Add a single source file. +
    addSourcePath(Path) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Add a source path to the source path used by this analyzer. +
    addSourcePath(Path) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Add a source path to the source path used by this analyzer. +
    addSrcfilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Add a list of source files. +
    addSrcfiles(FileSet) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Nested <srcfiles> element. +
    addSrcfileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Add a set of source files. +
    addStringTokenizer(TokenFilter.StringTokenizer) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    add a string tokenizer +
    addStripJavaComments(StripJavaComments) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a StripJavaCommands filter. +
    addStripLineBreaks(StripLineBreaks) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a StripLineBreaks filter. +
    addStripLineComments(StripLineComments) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a StripLineComments filter. +
    addStubVersionOptions() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    This is an override point; get the stub version off the rmic command and + translate that into a compiler-specific argument +
    addStubVersionOptions() - +Method in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    This is an override point; no stub version is returned. +
    addSuffixLines(SuffixLines) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a SuffixLines filter. +
    addSupportClasses(Hashtable) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Adds any classes the user specifies using support nested elements + to the ejbFiles Hashtable. +
    addSysproperties(CommandlineJava.SysProperties) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Add a set of system properties. +
    addSysproperties(CommandlineJava.SysProperties) - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Add a propertyset to the total set. +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Add a system property. +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a system property. +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Add a nested sysproperty element. +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Deprecated. since ant 1.6 +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    A system property to set during transformation. +
    addSysproperty(Environment.Variable) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Add a system property. +
    addSyspropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a set of properties as system properties. +
    addSyspropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds a set of properties that will be used as system properties + that tests can access. +
    addSyspropertyset(PropertySet) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    A set of system properties to set during transformation. +
    addSyspropertyset(PropertySet) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Add a set of system properties. +
    addSyspropertyset(PropertySet) - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Add a propertyset to the total set. +
    addSystemPackageRoot(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Adds a package root to the list of packages which must be loaded on the + parent loader. +
    addTabsToSpaces(TabsToSpaces) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a TabsToSpaces filter. +
    addTaglet(Javadoc.ExtensionInfo) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Add a taglet +
    addTailFilter(TailFilter) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a TailFilter filter. +
    addTarget(Target) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    add a new target +
    addTarget(Target) - +Method in class org.apache.tools.ant.Project +
    Add a new target to the project. +
    addTarget(String, Target) - +Method in class org.apache.tools.ant.Project +
    Add a new target to the project. +
    addTargetfilelist(FileList) - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Add a list of target files. +
    addTargetfileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Add a set of target files. +
    addTask(Task) - +Method in class org.apache.tools.ant.ExtensionPoint +
    Throws an exception. +
    addTask(Task) - +Method in class org.apache.tools.ant.Target +
    Adds a task to this target. +
    addTask(Task) - +Method in interface org.apache.tools.ant.TaskContainer +
    Adds a task to this task container +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.Antlib +
    add a task to the list of tasks +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.NestedSequential +
    Add a task or type to the container. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    Add a unknownElement for the macro instances nested elements. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance.Element +
    Add an unknown element (to be snipped into the macroDef instance) +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    Add a nested task to Sequential. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.NestedSequential +
    Add a task or type to the container. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Add a nested task to execute in parallel. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.Parallel.TaskList +
    Add a nested task to execute parallel (asynchron). +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef +
    Add a nested task to predefine attributes and elements on. +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.Retry +
    set the task +
    addTask(Task) - +Method in class org.apache.tools.ant.taskdefs.Sequential +
    Add a nested task to Sequential. +
    addTaskDefinition(String, Class) - +Method in class org.apache.tools.ant.ComponentHelper +
    Adds a new task definition to the project. +
    addTaskDefinition(String, Class) - +Method in class org.apache.tools.ant.Project +
    Add a new task definition to the project. +
    addTeardown(Sequential) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    set teardown sequence of tasks. +
    addTest(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Add a new single testcase. +
    addTests(Sequential) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    add tests. +
    addTestSuite(Element, Element) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Add a new testsuite node to the document. +
    addText(String) - +Method in class org.apache.tools.ant.filters.StripLineComments.Comment +
    Alt. +
    addText(Project, Object, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Adds PCDATA to an element, using the element's + void addText(String) method, if it has one. +
    addText(Project, Object, char[], int, int) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Adds the content of #PCDATA sections to an element. +
    addText(Project, Object, String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Adds the content of #PCDATA sections to an element. +
    addText(String) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Adds characters from #PCDATA areas to the wrapped element. +
    addText(char[], int, int) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Adds characters from #PCDATA areas to the wrapped element. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    This method adds text which appears in the 'concat' element. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    set the text using inline +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Set a multiline message. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Adds a textual part of the message +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Set a multiline message. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Input +
    Set a multiline message. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.Html +
    Add text to the element. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    Set the text contents for the macro. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask +
    the message as nested text +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask +
    the message as nested text +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Set the script text. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Set the script text. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    Set the script text. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.BlockFor +
    Set the error text; all properties are expanded in the message. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Set a (multiline) property as nested text. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.Replace.NestedString +
    The text of the element. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set an inline SQL command to execute. +
    addText(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec.Transaction +
    Set inline text +
    addText(String) - +Method in class org.apache.tools.ant.types.Description +
    Adds descriptive text to the project. +
    addText(String) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    The script text. +
    addText(Text) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Add text to the operation.. +
    addText(Text) - +Method in class org.apache.tools.ant.types.optional.image.ImageOperation +
    Add text to the operation. +
    addText(String) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    The script text. +
    addText(String) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    The script text. +
    addText(String) - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Add nested text to this resource. +
    addText(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Set the script text. +
    addText(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Add script text. +
    addText(String) - +Method in class org.apache.tools.ant.util.XMLFragment +
    Add nested text, expanding properties as we go +
    addText(String) - +Method in class org.apache.tools.ant.util.XMLFragment.Child +
    Add nested text. +
    addTimeoutObserver(TimeoutObserver) - +Method in class org.apache.tools.ant.util.Watchdog +
    Add a timeout observer. +
    addTitle(Javadoc.Html) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Set the title attribute using a nested Html value. +
    addTo(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Add a to address element. +
    addTokenFilter(TokenFilter) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a TokenFilter filter. +
    addTrim(TokenFilter.Trim) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    trim filter +
    addTrim(TokenFilter.Trim) - +Method in class org.apache.tools.ant.types.FilterChain +
    Add a trim filter. +
    addType(TypeSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a type selector entry on the type list +
    addType(TypeSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a selector type entry on the selector list. +
    addType(TypeSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    adds a type selector to the selector list +
    addType(TypeSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    adds a type selector to the selector list +
    addType(TypeSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    add the type selector +
    addUptodate(UpToDate) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Add an <uptodate> condition. +
    addURIEntry(String, String, URL) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalogResolver +
    Add a URI catalog entry to the controlling XMLCatalog instance. +
    addUser(CvsUser) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Add a user to list changelog knows about. +
    addValue(ExecTask, String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    add a value argument to a command +
    addValue(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Add a new value to this attribute - making it multivalued. +
    addVariable(Environment.Variable) - +Method in class org.apache.tools.ant.types.Environment +
    add a variable. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Add any vendor specific files which should be included in the + EJB Jar. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Add any vendor specific files which should be included in the + EJB Jar. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Add the iAS-specific EJB descriptor to the list of files which will be + written to the JAR file. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
    Add any vendor specific files which should be included in the + EJB Jar. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Add any vendor specific files which should be included in the + EJB Jar.. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Add any vendor specific files which should be included in the EJB Jar. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
    Add any vendor specific files which should be included in the + EJB Jar. +
    addVendorFiles(Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Add any vendor specific files which should be included in the EJB Jar. +
    addVmExit(JUnitTest, JUnitTaskMirror.JUnitResultFormatterMirror, OutputStream, String, String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror +
    Add the formatter to be called when the jvm exits before + the test suite finishs. +
    addVmExit(JUnitTest, JUnitTaskMirror.JUnitResultFormatterMirror, OutputStream, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirrorImpl +
    Add the formatter to be called when the jvm exits before + the test suite finishs.. +
    addWebApp(JspC.WebAppParameter) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Adds a single webapp. +
    addWebinf(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.War +
    files to add under WEB-INF; +
    addWeblogic(WebLogicHotDeploymentTool) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Creates a WebLogic deployment tool, for deployment to WebLogic servers. +
    addWritable(WritableSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
      +
    addWritable(WritableSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
      +
    addWritable(WritableSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
      +
    addZipfileset(ZipFileSet) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Adds a set of files that can be + read from an archive and be given a prefix/fullpath. +
    addZipGroupFileset(FileSet) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Adds a group of zip files. +
    adjustToLong(int) - +Static method in class org.apache.tools.zip.ZipOutputStream +
    Assumes a negative integer really is a positive integer that + has wrapped around and re-creates the original value. +
    AFTER - +Static variable in class org.apache.tools.ant.types.TimeComparison +
    After Comparison. +
    AggregateTransformer - Class in org.apache.tools.ant.taskdefs.optional.junit
    Transform a JUnit xml report.
    AggregateTransformer(Task) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    constructor creating the transformer from the junitreport task. +
    AggregateTransformer.Format - Class in org.apache.tools.ant.taskdefs.optional.junit
    defines acceptable formats.
    AggregateTransformer.Format() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer.Format +
      +
    Algorithm - Interface in org.apache.tools.ant.types.selectors.modifiedselector
    The Algorithm defines how a value for a file is computed.
    alias - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    The alias of signer. +
    alias - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
    The alias of signer. +
    ALL - +Static variable in class org.apache.tools.ant.types.Quantifier +
    ALL instance +
    allTests() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    return an enumeration listing each test, then each batchtest +
    alphabet - +Static variable in class org.apache.tools.ant.util.Base64Converter +
    Provided for BC purposes +
    ALWAYS - +Static variable in class org.apache.tools.zip.ZipOutputStream.UnicodeExtraFieldPolicy +
    Always create Unicode extra fields. +
    ANALYZER_CLASS_FULL - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The analyzer class for the super analyzer +
    ANALYZER_CLASS_SUPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The analyzer class for the super analyzer +
    ANALYZER_FULL - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    A dependency analyzer name to find all related classes +
    ANALYZER_NONE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    A dependency analyzer name for no analyzer +
    ANALYZER_SUPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    A dependency analyzer name to find ancestor classes +
    AncestorAnalyzer - Class in org.apache.tools.ant.util.depend.bcel
    A dependency analyzer which returns superclass and superinterface + dependencies.
    AncestorAnalyzer() - +Constructor for class org.apache.tools.ant.util.depend.bcel.AncestorAnalyzer +
    Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied +
    And - Class in org.apache.tools.ant.taskdefs.condition
    <and> condition container.
    And() - +Constructor for class org.apache.tools.ant.taskdefs.condition.And +
      +
    And - Class in org.apache.tools.ant.types.resources.selectors
    And ResourceSelector.
    And() - +Constructor for class org.apache.tools.ant.types.resources.selectors.And +
    Default constructor. +
    And(ResourceSelector[]) - +Constructor for class org.apache.tools.ant.types.resources.selectors.And +
    Convenience constructor. +
    AndSelector - Class in org.apache.tools.ant.types.selectors
    This selector has a collection of other selectors, all of which have to + select a file in order for this selector to select it.
    AndSelector() - +Constructor for class org.apache.tools.ant.types.selectors.AndSelector +
    Default constructor. +
    angle - +Variable in class org.apache.tools.ant.types.optional.image.Rotate +
      +
    AnsiColorLogger - Class in org.apache.tools.ant.listener
    Uses ANSI Color Code Sequences to colorize messages + sent to the console.
    AnsiColorLogger() - +Constructor for class org.apache.tools.ant.listener.AnsiColorLogger +
      +
    Ant - Class in org.apache.tools.ant.taskdefs
    Build a sub-project.
    Ant() - +Constructor for class org.apache.tools.ant.taskdefs.Ant +
    simple constructor +
    Ant(Task) - +Constructor for class org.apache.tools.ant.taskdefs.Ant +
    create a task bound to its creator +
    Ant.Reference - Class in org.apache.tools.ant.taskdefs
    Helper class that implements the nested <reference> + element of <ant> and <antcall>.
    Ant.Reference() - +Constructor for class org.apache.tools.ant.taskdefs.Ant.Reference +
    Creates a reference to be configured by Ant. +
    Ant.TargetElement - Class in org.apache.tools.ant.taskdefs
    Helper class that implements the nested <target> + element of <ant> and <antcall>.
    Ant.TargetElement() - +Constructor for class org.apache.tools.ant.taskdefs.Ant.TargetElement +
    Default constructor. +
    ANT_CORE_URI - +Static variable in class org.apache.tools.ant.ProjectHelper +
    The URI for ant name space +
    ANT_CURRENT_URI - +Static variable in class org.apache.tools.ant.ProjectHelper +
    The URI for antlib current definitions +
    ANT_EXECUTOR_CLASSNAME - +Static variable in class org.apache.tools.ant.MagicNames +
    Property defining the classname of an executor. +
    ANT_EXECUTOR_REFERENCE - +Static variable in class org.apache.tools.ant.MagicNames +
    Reference to the current Ant executor. +
    ANT_FILE - +Static variable in class org.apache.tools.ant.MagicNames +
    property for ant file name. +
    ANT_FILE_TYPE - +Static variable in class org.apache.tools.ant.MagicNames +
    property for type of ant build file (either file or url) + Value: "ant.file.type" +
    ANT_FILE_TYPE_FILE - +Static variable in class org.apache.tools.ant.MagicNames +
    ant build file of type file + Value: "file" +
    ANT_FILE_TYPE_URL - +Static variable in class org.apache.tools.ant.MagicNames +
    ant build file of type url + Value: "url" +
    ANT_HOME - +Static variable in class org.apache.tools.ant.MagicNames +
    Property used to store the location of ant. +
    ANT_JAVA_VERSION - +Static variable in class org.apache.tools.ant.MagicNames +
    Property used to store the java version ant is running in. +
    ANT_LIB - +Static variable in class org.apache.tools.ant.MagicNames +
    Property used to store the location of the ant library (typically the ant.jar file.) + Value: "ant.core.lib" +
    ANT_PRIVATEDIR - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The directory name of the per-user ant directory. +
    ANT_PRIVATELIB - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The name of a per-user library directory. +
    ANT_TYPE - +Static variable in class org.apache.tools.ant.ProjectHelper +
    Polymorphic attribute +
    ANT_VERSION - +Static variable in class org.apache.tools.ant.MagicNames +
    Ant version property. +
    AntAnalyzer - Class in org.apache.tools.ant.taskdefs.optional.depend
    An analyzer which uses the depend task's bytecode classes to analyze + dependencies
    AntAnalyzer() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.AntAnalyzer +
    Default constructor +
    AntClassLoader - Class in org.apache.tools.ant
    Used to load classes within ant with a different classpath from + that used to start ant.
    AntClassLoader(ClassLoader, Project, Path) - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Create an Ant ClassLoader for a given project, with + a parent classloader and an initial classpath. +
    AntClassLoader() - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Create an Ant Class Loader +
    AntClassLoader(Project, Path) - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Creates a classloader for the given project using the classpath given. +
    AntClassLoader(ClassLoader, Project, Path, boolean) - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Creates a classloader for the given project using the classpath given. +
    AntClassLoader(Project, Path, boolean) - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Creates a classloader for the given project using the classpath given. +
    AntClassLoader(ClassLoader, boolean) - +Constructor for class org.apache.tools.ant.AntClassLoader +
    Creates an empty class loader. +
    AntClassLoader2 - Class in org.apache.tools.ant.loader
    Deprecated. since 1.7 + Just use AntClassLoader itself.
    AntClassLoader2() - +Constructor for class org.apache.tools.ant.loader.AntClassLoader2 +
    Deprecated. No args constructor. +
    AntClassLoader5 - Class in org.apache.tools.ant.loader
    Overrides getResources which became non-final in Java5 and + implements Closeable
    AntClassLoader5(ClassLoader, Project, Path, boolean) - +Constructor for class org.apache.tools.ant.loader.AntClassLoader5 +
    Creates a classloader for the given project using the classpath given. +
    AntFilterReader - Class in org.apache.tools.ant.types
    An AntFilterReader is a wrapper class that encloses the classname + and configuration of a Configurable FilterReader.
    AntFilterReader() - +Constructor for class org.apache.tools.ant.types.AntFilterReader +
      +
    ANTHOME_PROPERTY - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The Ant Home (installation) Directory property. +
    Antlib - Class in org.apache.tools.ant.taskdefs
    Antlib task.
    Antlib() - +Constructor for class org.apache.tools.ant.taskdefs.Antlib +
      +
    ANTLIB_PREFIX - +Static variable in class org.apache.tools.ant.MagicNames +
    prefix for antlib URIs: + "antlib:" +
    ANTLIB_URI - +Static variable in class org.apache.tools.ant.ProjectHelper +
    The URI for defined types/tasks - the format is antlib: +
    AntlibDefinition - Class in org.apache.tools.ant.taskdefs
    Base class for tasks that that can be used in antlibs.
    AntlibDefinition() - +Constructor for class org.apache.tools.ant.taskdefs.AntlibDefinition +
      +
    ANTLIBDIR_PROPERTY - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The Ant Library Directory property. +
    ANTLR - Class in org.apache.tools.ant.taskdefs.optional
    Invokes the ANTLR Translator generator on a grammar file.
    ANTLR() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Constructor for ANTLR task. +
    AntMain - Interface in org.apache.tools.ant.launch
    Interface used to bridge to the actual Main class without any + messy reflection
    AntResolver - Class in org.apache.tools.ant.taskdefs.optional.extension.resolvers
    Resolver that just returns s specified location.
    AntResolver() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
      +
    AntSoundPlayer - Class in org.apache.tools.ant.taskdefs.optional.sound
    This class is designed to be used by any AntTask that requires audio output.
    AntSoundPlayer() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Constructor for AntSoundPlayer. +
    AntStructure - Class in org.apache.tools.ant.taskdefs
    Creates a partial DTD for Ant from the currently known tasks.
    AntStructure() - +Constructor for class org.apache.tools.ant.taskdefs.AntStructure +
      +
    AntStructure.StructurePrinter - Interface in org.apache.tools.ant.taskdefs
    Writes the actual structure information.
    AntTypeDefinition - Class in org.apache.tools.ant
    This class contains all the information + on a particular ant type, + the classname, adaptor and the class + it should be assignable from.
    AntTypeDefinition() - +Constructor for class org.apache.tools.ant.AntTypeDefinition +
      +
    AntVersion - Class in org.apache.tools.ant.taskdefs.condition
    An Ant version condition.
    AntVersion() - +Constructor for class org.apache.tools.ant.taskdefs.condition.AntVersion +
      +
    AntXMLContext - Class in org.apache.tools.ant.helper
    Context information for the ant processing.
    AntXMLContext(Project) - +Constructor for class org.apache.tools.ant.helper.AntXMLContext +
    constructor +
    ANY - +Static variable in class org.apache.tools.ant.types.Quantifier +
    ANY instance +
    ANY - +Static variable in class org.apache.tools.ant.types.resources.selectors.Type +
    Static any type selector. +
    APACHE_RESOLVER - +Static variable in class org.apache.tools.ant.types.XMLCatalog +
    The name of the bridge to the Apache xml-commons resolver + class, used to determine whether resolver.jar is present in the + classpath. +
    ApacheCatalog - Class in org.apache.tools.ant.types.resolver
    This class extends the Catalog class provided by Norman Walsh's + resolver library in xml-commons in order to add classpath entity + and URI resolution.
    ApacheCatalog() - +Constructor for class org.apache.tools.ant.types.resolver.ApacheCatalog +
      +
    ApacheCatalogResolver - Class in org.apache.tools.ant.types.resolver
    This class extends the CatalogResolver class provided by Norman + Walsh's resolver library in xml-commons.
    ApacheCatalogResolver() - +Constructor for class org.apache.tools.ant.types.resolver.ApacheCatalogResolver +
      +
    append - +Variable in class org.apache.tools.ant.taskdefs.Echo +
      +
    append(Path) - +Method in class org.apache.tools.ant.types.Path +
    Append the contents of the other Path instance to this. +
    append(PatternSet, Project) - +Method in class org.apache.tools.ant.types.PatternSet +
    Adds the patterns of the other instance to this set. +
    append(Enumeration, Enumeration) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Append one enumeration to another. +
    Appendable - Interface in org.apache.tools.ant.types.resources
    Interface to be implemented by "appendable" resources.
    appendBuiltin(PropertySet.BuiltinPropertySetName) - +Method in class org.apache.tools.ant.types.PropertySet +
    Allow builtin (all, system or commandline) properties in the set. +
    appendCDATA(Element, String) - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Adds a nested CDATA section. +
    appendCDATAElement(Element, String, String) - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Adds a nested CDATA section in a new child element. +
    appendExcludes(String[]) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Appends excludes to the current list of include + patterns. +
    appendExcludes(String[]) - +Method in class org.apache.tools.ant.types.resources.Files +
    Append excludes to the current list of include + patterns. +
    appendFiles(Vector, DirectoryScanner) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Append all files found by a directory scanner to a vector. +
    appendIncludes(String[]) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Appends includes to the current list of include + patterns. +
    appendIncludes(String[]) - +Method in class org.apache.tools.ant.types.resources.Files +
    Append includes to the current list of include + patterns. +
    appendName(String) - +Method in class org.apache.tools.ant.types.PropertySet +
    Allow properties of a particular name in the set. +
    appendPrefix(String) - +Method in class org.apache.tools.ant.types.PropertySet +
    Allow properties whose names start with a prefix in the set. +
    appendRegex(String) - +Method in class org.apache.tools.ant.types.PropertySet +
    Allow properties whose names match a regex in the set. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.types.resources.Files +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    Add a new selector into this container. +
    appendSelector(FileSelector) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Add a new selector into this container. +
    appendText(Element, String) - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Adds nested text. +
    appendTextElement(Element, String, String) - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Adds nested text in a new child element. +
    APPLICATION_EXCEPTION - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Application exception : "Application Exception" +
    APPLICATION_FORCIBLY_SHUT_DOWN - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    "Application forcibly shut down" +
    apply(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert.MapEntry +
    Apply this map entry to a given path element. +
    applyAssertions(List) - +Method in class org.apache.tools.ant.types.Assertions +
    add the assertions to a list in a format suitable + for adding to a command line +
    applyAssertions(CommandlineJava) - +Method in class org.apache.tools.ant.types.Assertions +
    apply all the assertions to the command. +
    applyAssertions(ListIterator) - +Method in class org.apache.tools.ant.types.Assertions +
    add the assertions to a list in a format suitable + for adding to a command line +
    applyPreSet(RuntimeConfigurable) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Apply presets, attributes and text are set if not currently set. +
    applyPreSet(UnknownElement) - +Method in class org.apache.tools.ant.UnknownElement +
    This is used then the realobject of the UE is a PreSetDefinition. +
    applyWebProxySettings() - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    if the proxy port and host settings are not null, then the settings + get applied these settings last beyond the life of the object and + apply to all network connections + Relevant docs: buglist #4183340 +
    Apt - Class in org.apache.tools.ant.taskdefs
    Apt Task for running the Annotation processing tool for JDK 1.5.
    Apt() - +Constructor for class org.apache.tools.ant.taskdefs.Apt +
    Construtor for Apt task. +
    Apt.Option - Class in org.apache.tools.ant.taskdefs
    The nested option element.
    Apt.Option() - +Constructor for class org.apache.tools.ant.taskdefs.Apt.Option +
    Constructor for Option +
    APT_ENTRY_POINT - +Static variable in class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
    class in tools.jar that implements APT +
    APT_METHOD_NAME - +Static variable in class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
    method used to compile. +
    AptCompilerAdapter - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the apt compiler for JDK 1.5 +

    + As usual, the low level entry points for Java tools are neither documented or + stable; this entry point may change from that of 1.5.0_01-b08 without any + warning at all.

    AptCompilerAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
      +
    AptExternalCompilerAdapter - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the apt compiler for JDK 1.5 using an external process
    AptExternalCompilerAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.AptExternalCompilerAdapter +
      +
    Arc - Class in org.apache.tools.ant.types.optional.image
    Draw an arc.
    Arc() - +Constructor for class org.apache.tools.ant.types.optional.image.Arc +
      +
    archeight - +Variable in class org.apache.tools.ant.types.optional.image.Rectangle +
      +
    ARCHIVE_LOCATIONS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ARCHIVE_LOCATIONS_VS_MAJOR_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ArchiveFileSet - Class in org.apache.tools.ant.types
    A ArchiveFileSet is a FileSet with extra attributes useful in the + context of archiving tasks.
    ArchiveFileSet() - +Constructor for class org.apache.tools.ant.types.ArchiveFileSet +
    Constructor for ArchiveFileSet +
    ArchiveFileSet(FileSet) - +Constructor for class org.apache.tools.ant.types.ArchiveFileSet +
    Constructor using a fileset arguement. +
    ArchiveFileSet(ArchiveFileSet) - +Constructor for class org.apache.tools.ant.types.ArchiveFileSet +
    Constructor using a archive fileset arguement. +
    archiveIsUpToDate(String[]) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + use the two-arg version instead. +
    archiveIsUpToDate(String[], File) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Is the archive up to date in relationship to a list of files. +
    archiveIsUpToDate(Resource) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Is the archive up to date in relationship to a list of files. +
    ArchiveResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of an entry inside an archive.
    ArchiveResource() - +Constructor for class org.apache.tools.ant.types.resources.ArchiveResource +
    Default constructor. +
    ArchiveResource(File) - +Constructor for class org.apache.tools.ant.types.resources.ArchiveResource +
    Construct a ArchiveResource representing the specified + entry in the specified archive. +
    ArchiveResource(File, boolean) - +Constructor for class org.apache.tools.ant.types.resources.ArchiveResource +
    Construct a ArchiveResource representing the specified + entry in the specified archive. +
    ArchiveResource(Resource, boolean) - +Constructor for class org.apache.tools.ant.types.resources.ArchiveResource +
    Construct a ArchiveResource representing the specified + entry in the specified archive. +
    Archives - Class in org.apache.tools.ant.types.resources
    A resource collection that treats all nested resources as archives + and returns the contents of the archives as its content.
    Archives() - +Constructor for class org.apache.tools.ant.types.resources.Archives +
      +
    ArchiveScanner - Class in org.apache.tools.ant.types
    ArchiveScanner accesses the pattern matching algorithm in DirectoryScanner, + which are protected methods that can only be accessed by subclassing.
    ArchiveScanner() - +Constructor for class org.apache.tools.ant.types.ArchiveScanner +
      +
    archiveType - +Variable in class org.apache.tools.ant.taskdefs.optional.Cab +
      +
    archiveType - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    arcwidth - +Variable in class org.apache.tools.ant.types.optional.image.Rectangle +
      +
    areNmtokens(String[]) - +Method in class org.apache.tools.ant.taskdefs.AntStructure +
    Do the Strings all match the XML-NMTOKEN production? +
    areSame(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Are the two File instances pointing to the same object on the + file system? +
    as(Class) - +Method in class org.apache.tools.ant.types.Resource +
    Returns a view of this resource that implements the interface + given as the argument or null if there is no such view. +
    as(Class) - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Suppress FileProvider, re-implement Appendable +
    as(Class) - +Method in class org.apache.tools.ant.types.resources.MappedResource +
    Suppress FileProvider +
    as(Class) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Returns a view of this resource that implements the interface + given as the argument or null if there is no such view. +
    asBoolean() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.SummaryAttribute +
    gives the boolean equivalent of the authorized values +
    asCollection(Iterator) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Returns a collection containing all elements of the iterator. +
    asEnumeration(Iterator) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Adapt the specified Iterator to the Enumeration interface. +
    asFileResource(FileProvider) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to turn any fileProvider into a basic + FileResource with the file's immediate parent as the basedir, + for tasks that need one. +
    AsiExtraField - Class in org.apache.tools.zip
    Adds Unix file permission and UID/GID fields as well as symbolic + link handling.
    AsiExtraField() - +Constructor for class org.apache.tools.zip.AsiExtraField +
    Constructor for AsiExtraField. +
    asIterator(Enumeration) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Adapt the specified Enumeration to the Iterator interface. +
    asOptions(String) - +Static method in class org.apache.tools.ant.util.regexp.RegexpUtil +
    convert regex option flag characters to regex options + + g - Regexp.REPLACE_ALL + i - RegexpMatcher.MATCH_CASE_INSENSITIVE + m - RegexpMatcher.MATCH_MULTILINE + s - RegexpMatcher.MATCH_SINGLELINE + +
    asOptions(boolean) - +Static method in class org.apache.tools.ant.util.regexp.RegexpUtil +
    Convert flag to regex options. +
    asOptions(boolean, boolean, boolean) - +Static method in class org.apache.tools.ant.util.regexp.RegexpUtil +
    Convert flags to regex options. +
    assemBuf - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    assemLen - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    assertConfig(boolean, String) - +Method in class org.apache.tools.ant.TaskConfigurationChecker +
    Asserts that a condition is true. +
    assertFilesystemOnly(ResourceCollection) - +Method in class org.apache.tools.ant.types.Path +
    Verify the specified ResourceCollection is filesystem-only. +
    Assertions - Class in org.apache.tools.ant.types
    The assertion datatype.
    Assertions() - +Constructor for class org.apache.tools.ant.types.Assertions +
      +
    Assertions.BaseAssertion - Class in org.apache.tools.ant.types
    base class for our assertion elements.
    Assertions.BaseAssertion() - +Constructor for class org.apache.tools.ant.types.Assertions.BaseAssertion +
      +
    Assertions.DisabledAssertion - Class in org.apache.tools.ant.types
    A disabled assertion disables things
    Assertions.DisabledAssertion() - +Constructor for class org.apache.tools.ant.types.Assertions.DisabledAssertion +
      +
    Assertions.EnabledAssertion - Class in org.apache.tools.ant.types
    an enabled assertion enables things
    Assertions.EnabledAssertion() - +Constructor for class org.apache.tools.ant.types.Assertions.EnabledAssertion +
      +
    assertNotReference() - +Method in class org.apache.tools.ant.types.PropertySet +
    Ensures this data type is not a reference. +
    assumeJava11() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.1 command line switches? +
    assumeJava12() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.2 command line switches? +
    assumeJava13() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.3 command line switches? +
    assumeJava14() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.4 command line switches? +
    assumeJava15() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.5 command line switches? +
    assumeJava16() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.6 command line switches? +
    assumeJava17() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Shall we assume JDK 1.7 command line switches? +
    asTarFileSet(ArchiveFileSet) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Copies fullpath, prefix and permission attributes from the + ArchiveFileSet to a new TarFileSet (or returns it unchanged if + it already is a TarFileSet). +
    ATTR_CLASSNAME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    classname attribute for testcase elements +
    ATTR_ERRORS - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    errors attribute for testsuite elements +
    ATTR_FAILURES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    failures attribute for testsuite elements +
    ATTR_ID - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    id attribute +
    ATTR_MESSAGE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    message attribute for failure elements +
    ATTR_NAME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    name attribute for property, testcase and testsuite elements +
    ATTR_PACKAGE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    package attribute for the aggregate document +
    ATTR_TESTS - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    tests attribute for testsuite elements +
    ATTR_TIME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    time attribute for testcase and testsuite elements +
    ATTR_TYPE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    type attribute for failure and error elements +
    ATTR_VALUE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    value attribute for property elements +
    Attrib - Class in org.apache.tools.ant.taskdefs.optional.windows
    Attrib equivalent for Win32 environments.
    Attrib() - +Constructor for class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Constructor for Attrib. +
    ATTRIBUTE_CLASSPATH - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The Class-Path Header is special - it can be duplicated +
    ATTRIBUTE_FROM - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The From Header is disallowed in a Manifest +
    ATTRIBUTE_MANIFEST_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The standard manifest version header +
    ATTRIBUTE_NAME - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The Name Attribute is the first in a named section +
    ATTRIBUTE_SIGNATURE_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The standard Signature Version header +
    attributes - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    AugmentReference - Class in org.apache.tools.ant.taskdefs
    Ant task to dynamically augment a previously declared reference.
    AugmentReference() - +Constructor for class org.apache.tools.ant.taskdefs.AugmentReference +
      +
    AUTO - +Static variable in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Constant to show that the best available mailer should be used. +
    Available - Class in org.apache.tools.ant.taskdefs
    Will set the given property if the requested resource is available at + runtime.
    Available() - +Constructor for class org.apache.tools.ant.taskdefs.Available +
      +
    available() - +Method in class org.apache.tools.ant.util.ReaderInputStream +
      +
    available() - +Method in class org.apache.tools.tar.TarInputStream +
    Get the available data that can be read from the current + entry in the archive. +
    Available.FileDir - Class in org.apache.tools.ant.taskdefs
    EnumeratedAttribute covering the file types to be checked for, either + file or dir.
    Available.FileDir() - +Constructor for class org.apache.tools.ant.taskdefs.Available.FileDir +
      +
    +
    +

    +B

    +
    +
    backslash(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
    Ensure that a string is backslashing slashes so that it does not + confuse them with Perl substitution delimiter in Oro. +
    BAS_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
      +
    Base64Converter - Class in org.apache.tools.ant.util
    BASE 64 encoding of a String or an array of bytes.
    Base64Converter() - +Constructor for class org.apache.tools.ant.util.Base64Converter +
      +
    baseBlockSize - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    basedir - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The base directory to be scanned. +
    BaseExtendSelector - Class in org.apache.tools.ant.types.selectors
    Convenience base class for all selectors accessed through ExtendSelector.
    BaseExtendSelector() - +Constructor for class org.apache.tools.ant.types.selectors.BaseExtendSelector +
    Default constructor. +
    BaseFilterReader - Class in org.apache.tools.ant.filters
    Base class for core filter readers.
    BaseFilterReader() - +Constructor for class org.apache.tools.ant.filters.BaseFilterReader +
    Constructor used by Ant's introspection mechanism. +
    BaseFilterReader(Reader) - +Constructor for class org.apache.tools.ant.filters.BaseFilterReader +
    Creates a new filtered reader. +
    BASEJARNAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
    Naming scheme where the generated jar is named by the basejarname + attribute +
    Basename - Class in org.apache.tools.ant.taskdefs
    Sets a property to the base name of a specified file, optionally minus a + suffix.
    Basename() - +Constructor for class org.apache.tools.ant.taskdefs.Basename +
      +
    BaseParamFilterReader - Class in org.apache.tools.ant.filters
    Parameterized base class for core filter readers.
    BaseParamFilterReader() - +Constructor for class org.apache.tools.ant.filters.BaseParamFilterReader +
    Constructor for "dummy" instances. +
    BaseParamFilterReader(Reader) - +Constructor for class org.apache.tools.ant.filters.BaseParamFilterReader +
    Creates a new filtered reader. +
    BaseResourceCollectionContainer - Class in org.apache.tools.ant.types.resources
    Base class for ResourceCollections that nest multiple ResourceCollections.
    BaseResourceCollectionContainer() - +Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Create a new BaseResourceCollectionContainer. +
    BaseResourceCollectionContainer(Project) - +Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Create a new BaseResourceCollectionContainer. +
    BaseResourceCollectionWrapper - Class in org.apache.tools.ant.types.resources
    Base class for a ResourceCollection that wraps a single nested + ResourceCollection.
    BaseResourceCollectionWrapper() - +Constructor for class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper +
      +
    BaseSelector - Class in org.apache.tools.ant.types.selectors
    A convenience base class that you can subclass Selectors from.
    BaseSelector() - +Constructor for class org.apache.tools.ant.types.selectors.BaseSelector +
    Do nothing constructor. +
    BaseSelectorContainer - Class in org.apache.tools.ant.types.selectors
    This is the base class for selectors that can contain other selectors.
    BaseSelectorContainer() - +Constructor for class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Default constructor. +
    BaseTest - Class in org.apache.tools.ant.taskdefs.optional.junit
    Baseclass for BatchTest and JUnitTest.
    BaseTest() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    BasicShape - Class in org.apache.tools.ant.types.optional.image
    Draw a basic shape
    BasicShape() - +Constructor for class org.apache.tools.ant.types.optional.image.BasicShape +
      +
    BatchTest - Class in org.apache.tools.ant.taskdefs.optional.junit
    Create then run JUnitTest's based on the list of files + given by the fileset attribute.
    BatchTest(Project) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BatchTest +
    create a new batchtest instance +
    bcc(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the bcc address. +
    bccList - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    BCFileSet - Class in org.apache.tools.ant.types.resources
    Utility FileSet that includes directories for backwards-compatibility + with certain tasks e.g.
    BCFileSet() - +Constructor for class org.apache.tools.ant.types.resources.BCFileSet +
    Default constructor. +
    BCFileSet(FileSet) - +Constructor for class org.apache.tools.ant.types.resources.BCFileSet +
    Construct a new BCFileSet from the specified FileSet. +
    BEFORE - +Static variable in class org.apache.tools.ant.types.TimeComparison +
    Before Comparison. +
    beginDownload() - +Method in interface org.apache.tools.ant.taskdefs.Get.DownloadProgress +
    begin a download +
    beginDownload() - +Method in class org.apache.tools.ant.taskdefs.Get.NullProgress +
    begin a download +
    beginDownload() - +Method in class org.apache.tools.ant.taskdefs.Get.VerboseProgress +
    begin a download +
    beginExecution() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    init processing logic; this is retained through our execution(s) +
    BES_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
      +
    BigProjectLogger - Class in org.apache.tools.ant.listener
    This is a special logger that is designed to make it easier to work + with big projects, those that use imports and + subant to build complex systems.
    BigProjectLogger() - +Constructor for class org.apache.tools.ant.listener.BigProjectLogger +
      +
    BindTargets - Class in org.apache.tools.ant.taskdefs
    Simple task which bind some targets to some defined extension point
    BindTargets() - +Constructor for class org.apache.tools.ant.taskdefs.BindTargets +
      +
    bindToComponent(ProjectComponent) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Bind the runner to a project component. +
    bindToComponentMinimum(ProjectComponent) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Bind the runner to a project component. +
    bindToKeystore(ExecTask) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    bind to a keystore if the attributes are there +
    bindToOwner(Task) - +Method in class org.apache.tools.ant.Task +
    Bind a task to another; use this when configuring a newly created + task to do work on behalf of another. +
    BlockFor - Class in org.apache.tools.ant.taskdefs.optional.testing
     
    BlockFor() - +Constructor for class org.apache.tools.ant.taskdefs.optional.testing.BlockFor +
    Constructor that takes the name of the task in the task name. +
    BlockFor(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.testing.BlockFor +
    Constructor that takes the name of the task in the task name. +
    bootclasspath - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    BorlandDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    BorlandDeploymentTool is dedicated to the Borland Application Server 4.5 and 4.5.1 + This task generates and compiles the stubs and skeletons for all ejb described into the + Deployment Descriptor, builds the jar file including the support files and verify + whether the produced jar is valid or not.
    BorlandDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
      +
    BorlandGenerateClient - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Generates a Borland Application Server 4.5 client JAR using as + input the EJB JAR file.
    BorlandGenerateClient() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
      +
    br - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    BRIEF_FORMATTER_CLASS_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    brief formatter class +
    BriefJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Prints plain text output of the test to a specified Writer.
    BriefJUnitResultFormatter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Constructor for BriefJUnitResultFormatter. +
    buf - +Variable in class org.apache.tools.zip.ZipOutputStream +
    This buffer servers as a Deflater. +
    buffer - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    buffer - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    bufferSize - +Variable in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    The size of the buffer to be used. +
    BUILD_JAVAC_SOURCE - +Static variable in class org.apache.tools.ant.MagicNames +
    property that provides the default value for javac's and + javadoc's source attribute. +
    BUILD_JAVAC_TARGET - +Static variable in class org.apache.tools.ant.MagicNames +
    property that provides the default value for javac's target attribute. +
    BUILD_SYSCLASSPATH - +Static variable in class org.apache.tools.ant.MagicNames +
    System classpath policy. +
    buildArgsPrefix() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Builds the prefix arguments to pass to weblogic.deploy. +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin +
    Build the command line. +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout +
    Build the command line
    + + CheckOutFile required parameters: -server -name -password -database -project -file
    + CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
    + + CheckOutProject required parameters: -server -name -password -database -project
    + CheckOutProject optional parameters:-workdir -recursive -verbose -nocache + -nocompression -soshome
    +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
    Build the command line
    + + GetFile required parameters: -server -name -password -database -project -file
    + GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome
    + + GetProject required parameters: -server -name -password -database -project
    + GetProject optional parameters: -label -workdir -recursive -verbose -nocache + -nocompression -soshome
    +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel +
    Build the command line
    + AddLabel required parameters: -server -name -password -database -project -label
    + AddLabel optional parameters: -verbose -comment
    +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Builds a command line to execute ss. +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Builds a command line to execute ss. +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Builds a command line to execute ss. +
    buildCmdLine() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP +
    Builds a command line to execute ss. +
    buildDeployArgs() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Builds the arguments to pass to weblogic.deploy for deployment actions + ("deploy" and "update"). +
    BuildEvent - Class in org.apache.tools.ant
    Class representing an event occurring during a build.
    BuildEvent(Project) - +Constructor for class org.apache.tools.ant.BuildEvent +
    Construct a BuildEvent for a project level event. +
    BuildEvent(Target) - +Constructor for class org.apache.tools.ant.BuildEvent +
    Construct a BuildEvent for a target level event. +
    BuildEvent(Task) - +Constructor for class org.apache.tools.ant.BuildEvent +
    Construct a BuildEvent for a task level event. +
    BuildException - Exception in org.apache.tools.ant
    Signals an error condition during a build
    BuildException() - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs a build exception with no descriptive information. +
    BuildException(String) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given descriptive message. +
    BuildException(String, Throwable) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given message and exception as + a root cause. +
    BuildException(String, Throwable, Location) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given message and exception as + a root cause and a location in a file. +
    BuildException(Throwable) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given exception as a root cause. +
    BuildException(String, Location) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given descriptive message and a + location in a file. +
    BuildException(Throwable, Location) - +Constructor for exception org.apache.tools.ant.BuildException +
    Constructs an exception with the given exception as + a root cause and a location in a file. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Cleans up any resources held by this classloader at the end + of a build. +
    buildFinished(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that the last target has finished. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that the last target has finished.. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that the last target has finished.. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.MailLogger +
    Sends an e-mail with the log results. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals that the last target has finished. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired after the last target has finished. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Cleans recorder registry. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that the last target has finished.. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that the last target has finished. +
    buildFinished(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when the build finishes, this adds the time taken and any + error stacktrace to the build element and writes the document to disk. +
    buildListArgs() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Builds the arguments to pass to weblogic.deploy for the list action +
    BuildListener - Interface in org.apache.tools.ant
    Instances of classes that implement this interface can register + to be notified when things happened during a build.
    BuildLogger - Interface in org.apache.tools.ant
    Interface used by Ant to log the build output.
    buildMap(File, File, String[], FileNameMapper, Hashtable) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add to a map of files/directories to copy. +
    buildMap(Resource[], File, FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Create a map of resources to copy. +
    BuildNumber - Class in org.apache.tools.ant.taskdefs
    Read, increment, and write a build number in a file + It will first + attempt to read a build number from a file, then set the property + "build.number" to the value that was read in (or 0 if no such value).
    BuildNumber() - +Constructor for class org.apache.tools.ant.taskdefs.BuildNumber +
      +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    buildStarted(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that a build has started. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    Responds to a build being started by just remembering the current time. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that a build has started.. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that a build has started.. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals that a build has started. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired before any targets are started. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that a build has started.. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that a build has started. +
    buildStarted(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when the build starts, this builds the top-level element for the + document and remembers the time of the start of the build. +
    BuildTimeoutException - Exception in org.apache.tools.ant.taskdefs.optional.testing
    This exception is used to indicate timeouts.
    BuildTimeoutException() - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs a build exception with no descriptive information. +
    BuildTimeoutException(String) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given descriptive message. +
    BuildTimeoutException(String, Throwable) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given message and exception as + a root cause. +
    BuildTimeoutException(String, Throwable, Location) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given message and exception as + a root cause and a location in a file. +
    BuildTimeoutException(Throwable) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given exception as a root cause. +
    BuildTimeoutException(String, Location) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given descriptive message and a + location in a file. +
    BuildTimeoutException(Throwable, Location) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException +
    Constructs an exception with the given exception as + a root cause and a location in a file. +
    buildUndeployArgs() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Builds the arguments to pass to weblogic.deploy for undeployment actions + ("undeploy" and "delete"). +
    BUnzip2 - Class in org.apache.tools.ant.taskdefs
    Expands a file that has been compressed with the BZIP2 + algorithm.
    BUnzip2() - +Constructor for class org.apache.tools.ant.taskdefs.BUnzip2 +
      +
    BZip2 - Class in org.apache.tools.ant.taskdefs
    Compresses a file with the BZIP2 algorithm.
    BZip2() - +Constructor for class org.apache.tools.ant.taskdefs.BZip2 +
      +
    BZip2Constants - Interface in org.apache.tools.bzip2
    Base class for both the compress and decompress classes.
    BZip2Resource - Class in org.apache.tools.ant.types.resources
    A Bzip2 compressed resource.
    BZip2Resource() - +Constructor for class org.apache.tools.ant.types.resources.BZip2Resource +
    A no-arg constructor +
    BZip2Resource(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.BZip2Resource +
    Constructor with another resource to wrap. +
    +
    +

    +C

    +
    +
    Cab - Class in org.apache.tools.ant.taskdefs.optional
    Create a CAB archive.
    Cab() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Cab +
      +
    Cache - Interface in org.apache.tools.ant.types.selectors.modifiedselector
    A Cache let the user store key-value-pairs in a permanent manner and access + them.
    calculateCheckEveryMillis() - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Get the check wait time, in milliseconds. +
    calculateMaxWaitMillis() - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Get the maxiumum wait time, in milliseconds. +
    CallTarget - Class in org.apache.tools.ant.taskdefs
    Call another target in the same project.
    CallTarget() - +Constructor for class org.apache.tools.ant.taskdefs.CallTarget +
      +
    canParseAntlibDescriptor(Resource) - +Method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task. +
    canParseAntlibDescriptor(Resource) - +Method in class org.apache.tools.ant.ProjectHelper +
    Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task. +
    canParseBuildFile(Resource) - +Method in class org.apache.tools.ant.ProjectHelper +
    Check if the helper supports the kind of file. +
    CASE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Used for parameterized custom selector +
    CASE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Used for parameterized custom selector +
    CATALOG_RESOLVER - +Static variable in class org.apache.tools.ant.types.XMLCatalog +
    Resolver base class +
    CBZip2InputStream - Class in org.apache.tools.bzip2
    An input stream that decompresses from the BZip2 format (without the file + header chars) to be read as any other stream.
    CBZip2InputStream(InputStream) - +Constructor for class org.apache.tools.bzip2.CBZip2InputStream +
    Constructs a new CBZip2InputStream which decompresses bytes read from + the specified stream. +
    CBZip2OutputStream - Class in org.apache.tools.bzip2
    An output stream that compresses into the BZip2 format (without the file + header chars) into another stream.
    CBZip2OutputStream(OutputStream) - +Constructor for class org.apache.tools.bzip2.CBZip2OutputStream +
    Constructs a new CBZip2OutputStream with a blocksize of 900k. +
    CBZip2OutputStream(OutputStream, int) - +Constructor for class org.apache.tools.bzip2.CBZip2OutputStream +
    Constructs a new CBZip2OutputStream with specified blocksize. +
    cc(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the cc address. +
    CCCheckin - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs ClearCase checkin.
    CCCheckin() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
      +
    CCCheckout - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs ClearCase checkout.
    CCCheckout() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
      +
    ccList - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    CCLock - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs a ClearCase Lock command.
    CCLock() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
      +
    CCMCheck - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Class common to all check commands (checkout, checkin,checkin default task);
    CCMCheck() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Constructor for CCMCheck. +
    CCMCheckin - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Performs Continuus checkin command.
    CCMCheckin() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckin +
    Default constructor - setup checkin command +
    CCMCheckinDefault - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Performs Continuus Checkin Default task command.
    CCMCheckinDefault() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault +
    Constructor for CCMCheckinDefault. +
    CCMCheckout - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Performs Continuus checkout command.
    CCMCheckout() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckout +
    default constructor +
    CCMCreateTask - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Creates new Continuus ccm task and sets it as the default.
    CCMCreateTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Constructor for CCMCreateTask. +
    CCMkattr - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Task to perform mkattr command to ClearCase.
    CCMkattr() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
      +
    CCMkbl - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Task to CreateBaseline command to ClearCase.
    CCMkbl() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
      +
    CCMkdir - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs ClearCase mkdir.
    CCMkdir() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
      +
    CCMkelem - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs ClearCase mkelem.
    CCMkelem() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
      +
    CCMklabel - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Task to perform mklabel command to ClearCase.
    CCMklabel() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
      +
    CCMklbtype - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Task to perform mklbtype command to ClearCase.
    CCMklbtype() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
      +
    CCMReconfigure - Class in org.apache.tools.ant.taskdefs.optional.ccm
    Task allows to reconfigure a project, recursively or not
    CCMReconfigure() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Constructor for CCMReconfigure. +
    CCRmtype - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Task to perform rmtype command to ClearCase.
    CCRmtype() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
      +
    CCUnCheckout - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs ClearCase UnCheckout command.
    CCUnCheckout() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
      +
    CCUnlock - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs a ClearCase Unlock command.
    CCUnlock() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
      +
    CCUpdate - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    Performs a ClearCase Update command.
    CCUpdate() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
      +
    CentralDirectoryParsingZipExtraField - Interface in org.apache.tools.zip
    ZipExtraField that knows how to parse central + directory data.
    CFH_SIG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    central file header signature +
    chain(Reader) - +Method in interface org.apache.tools.ant.filters.ChainableReader +
    Returns a reader with the same configuration as this one, + but filtering input from the specified reader. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.ClassConstants +
    Creates a new ClassConstants using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Creates a new ConcatReader using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.EscapeUnicode +
    Creates a new EscapeUnicode using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.ExpandProperties +
    Creates a new ExpandProperties filter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Create a new FixCrLfFilter using the passed in Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.HeadFilter +
    Creates a new HeadFilter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.LineContains +
    Creates a new LineContains using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Creates a new LineContainsRegExp using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.PrefixLines +
    Creates a new PrefixLines filter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    Creates a new ReplaceTokens using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.SortFilter +
    Creates a new SortReader using the passed in Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.StripJavaComments +
    Creates a new StripJavaComments using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.StripLineBreaks +
    Creates a new StripLineBreaks using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.StripLineComments +
    Creates a new StripLineComments using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.SuffixLines +
    Creates a new SuffixLines filter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.TabsToSpaces +
    Creates a new TabsToSpaces using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.TailFilter +
    Creates a new TailFilter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    Creates a new TokenFilter using the passed in + Reader for instantiation. +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter +
    Chain a tokenfilter reader to a reader, +
    chain(Reader) - +Method in class org.apache.tools.ant.filters.TokenFilter.DeleteCharacters +
    factory method to provide a reader that removes + the characters from a reader as part of a filter + chain +
    chain(Reader) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Chain this task as a reader. +
    ChainableReader - Interface in org.apache.tools.ant.filters
    Interface indicating that a reader may be chained to another one.
    ChainedMapper - Class in org.apache.tools.ant.util
    A ContainerMapper that chains the results of the first + nested FileNameMappers into sourcefiles for the second, + the second to the third, and so on, returning the resulting mapped + filenames from the last nested FileNameMapper.
    ChainedMapper() - +Constructor for class org.apache.tools.ant.util.ChainedMapper +
      +
    ChainReaderHelper - Class in org.apache.tools.ant.filters.util
    Process a FilterReader chain.
    ChainReaderHelper() - +Constructor for class org.apache.tools.ant.filters.util.ChainReaderHelper +
      +
    change - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Delete +
    number of the change list to work on +
    change - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Edit +
    number of the change list to work on +
    change - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
    change list number +
    ChangeLogTask - Class in org.apache.tools.ant.taskdefs.cvslib
    Examines the output of cvs log and group related changes together.
    ChangeLogTask() - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
      +
    ChangeLogWriter - Class in org.apache.tools.ant.taskdefs.cvslib
    Class used to generate an XML changelog.
    ChangeLogWriter() - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.ChangeLogWriter +
      +
    characters(char[], int, int, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    Handles text within an element. +
    characters(char[], int, int, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ElementHandler +
    Adds text to the task, using the wrapper +
    characters(char[], int, int) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Handle text within an element, calls currentHandler.characters. +
    characters(char[], int, int) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    SAX parser call-back method invoked whenever characters are located within + an element. +
    check(ResourceCollection) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Checks whether the archive is out-of-date with respect to the resources + of the given collection. +
    check(File, String[]) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Checks whether the archive is out-of-date with respect to the + given files, ensures that the archive won't contain itself. +
    check() - +Method in class org.apache.tools.ant.types.spi.Provider +
    Check if the component has been configured correctly. +
    check() - +Method in class org.apache.tools.ant.types.spi.Service +
    Check if this object is configured correctly as a nested + element. +
    checkAndAddDependants(Hashtable) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Add all available classes, that depend on Remote, Home, Bean, PK +
    checkAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Checks to see that all required parameters are set. +
    checkAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Checks to see that all required parameters are set. +
    checkAttributesAllowed() - +Method in class org.apache.tools.ant.types.DataType +
    check that it is ok to set attributes, i.e that no reference is defined +
    checkChildrenAllowed() - +Method in class org.apache.tools.ant.types.DataType +
    check that it is ok to add children, i.e that no reference is defined +
    checkClass(Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Checks if the attributes are correct. +
    checkClass(Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Check if the attributes are correct. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Check the attributes and nested elements. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Has the user set all necessary attributes? +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Check the configuration of this ExecuteOn instance. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Check configuration. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Check if the attributes and nested elements are correct. +
    checkConfiguration(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    This method is called as the first step in the processDescriptor method + to allow vendor-specific subclasses to validate the task configuration + prior to processing the descriptor. +
    checkConfiguration(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Verifies that the user selections are valid. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Verifies that the user selections are valid. +
    checkConfiguration(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Verify the configuration. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chgrp +
    Ensure that all the required arguments and other conditions have + been set. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chown +
    Ensure that all the required arguments and other conditions have + been set. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Check the attributes. +
    checkConfiguration() - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Check that this task has been configured properly. +
    CHECKDIRS_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    checked - +Variable in class org.apache.tools.ant.types.DataType +
    Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use DataType.setChecked(boolean) or + DataType.isChecked() instead. +
    checkEntry() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Validate settings and ensure that the represented "archive entry" + has been established. +
    checkErrors() - +Method in class org.apache.tools.ant.TaskConfigurationChecker +
    Checks if there are any collected errors and throws a BuildException + with all messages if there was one or more. +
    checkException() - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    This method will rethrow the exception that was possibly caught during + the run of the process. +
    checkExit(int) - +Method in class org.apache.tools.ant.util.optional.NoExitSecurityManager +
    Override SecurityManager#checkExit. +
    checkLanguage() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Check if the language attribute is set. +
    checkNamespace(String) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    Will be called every time a namespace is reached. +
    checkOptions() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    check for invalid options +
    checkParameters() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Check that all required attributes have been set and nothing + silly has been entered. +
    checkPermission(Permission) - +Method in class org.apache.tools.ant.util.optional.NoExitSecurityManager +
    Override SecurityManager#checkPermission. +
    checkProxyClass(Class) - +Method in class org.apache.tools.ant.TaskAdapter +
    Check if the proxy class is a valid class to use + with this adapter. +
    checkProxyClass(Class) - +Method in class org.apache.tools.ant.taskdefs.AugmentReference +
    Check if the proxy class is compatible with this adapter - i.e. +
    checkProxyClass(Class) - +Method in interface org.apache.tools.ant.TypeAdapter +
    Check if the proxy class is compatible with this adapter - i.e. +
    Checksum - Class in org.apache.tools.ant.taskdefs
    Used to create or verify file checksums.
    Checksum() - +Constructor for class org.apache.tools.ant.taskdefs.Checksum +
      +
    Checksum.FormatElement - Class in org.apache.tools.ant.taskdefs
    Helper class for the format attribute.
    Checksum.FormatElement() - +Constructor for class org.apache.tools.ant.taskdefs.Checksum.FormatElement +
    Constructor for FormatElement +
    ChecksumAlgorithm - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Computes a 'checksum' for the content of file using + java.util.zip.CRC32 and java.util.zip.Adler32.
    ChecksumAlgorithm() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
      +
    checkTaskClass(Class) - +Method in class org.apache.tools.ant.ComponentHelper +
    Checks whether or not a class is suitable for serving as Ant task. +
    checkTaskClass(Class) - +Method in class org.apache.tools.ant.Project +
    Check whether or not a class is suitable for serving as Ant task. +
    checkTaskClass(Class, Project) - +Static method in class org.apache.tools.ant.TaskAdapter +
    Checks whether or not a class is suitable to be adapted by TaskAdapter. +
    Chgrp - Class in org.apache.tools.ant.taskdefs.optional.unix
    Chgrp equivalent for unix-like environments.
    Chgrp() - +Constructor for class org.apache.tools.ant.taskdefs.optional.unix.Chgrp +
    Chgrp task for setting unix group of a file. +
    CHKSUMLEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the checksum field in a header buffer. +
    Chmod - Class in org.apache.tools.ant.taskdefs
    Chmod equivalent for unix-like environments.
    Chmod() - +Constructor for class org.apache.tools.ant.taskdefs.Chmod +
    Chmod task for setting file and directory permissions. +
    CHMOD - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    CHMOD - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    chooseBlockSize(long) - +Static method in class org.apache.tools.bzip2.CBZip2OutputStream +
    Chooses a blocksize based on the given length of the data to compress. +
    Chown - Class in org.apache.tools.ant.taskdefs.optional.unix
    Chown equivalent for unix-like environments.
    Chown() - +Constructor for class org.apache.tools.ant.taskdefs.optional.unix.Chown +
    Chown task for setting file and directory permissions. +
    circularReference() - +Method in class org.apache.tools.ant.types.DataType +
    Creates an exception that indicates the user has generated a + loop of data types referencing each other. +
    ClassConstants - Class in org.apache.tools.ant.filters
    Assembles the constants declared in a Java class in + key1=value1(line separator)key2=value2 + format.
    ClassConstants() - +Constructor for class org.apache.tools.ant.filters.ClassConstants +
    Constructor for "dummy" instances. +
    ClassConstants(Reader) - +Constructor for class org.apache.tools.ant.filters.ClassConstants +
    Creates a new filtered reader. +
    ClassCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    The constant pool entry which stores class information.
    ClassCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo +
    Constructor. +
    classExists(ClassLoader, String) - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Check if a classloader has a classname resource. +
    ClassFile - Class in org.apache.tools.ant.taskdefs.optional.depend
    A ClassFile object stores information about a Java class.
    ClassFile() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.ClassFile +
      +
    ClassFileIterator - Interface in org.apache.tools.ant.taskdefs.optional.depend
    Iterator interface for iterating over a set of class files
    ClassfileSet - Class in org.apache.tools.ant.types.optional.depend
    A ClassfileSet is a FileSet that enlists all classes that depend on a + certain set of root classes.
    ClassfileSet() - +Constructor for class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Default constructor. +
    ClassfileSet(ClassfileSet) - +Constructor for class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Create a ClassfileSet from another ClassfileSet. +
    ClassfileSet.ClassRoot - Class in org.apache.tools.ant.types.optional.depend
    Inner class used to contain info about root classes.
    ClassfileSet.ClassRoot() - +Constructor for class org.apache.tools.ant.types.optional.depend.ClassfileSet.ClassRoot +
      +
    ClassFileUtils - Class in org.apache.tools.ant.taskdefs.optional.depend
    Utility class file routines.
    ClassFileUtils() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.ClassFileUtils +
      +
    CLASSIC_COMPILER_CLASSNAME - +Static variable in class org.apache.tools.ant.taskdefs.compilers.Javac12 +
    Deprecated.   +
    Classloader - Class in org.apache.tools.ant.taskdefs
    EXPERIMENTAL + Create or modifies ClassLoader.
    Classloader() - +Constructor for class org.apache.tools.ant.taskdefs.Classloader +
    Default constructor +
    classname - +Variable in class org.apache.tools.ant.types.Mapper +
      +
    ClassNameReader - Class in org.apache.tools.ant.taskdefs.optional.jlink
    Provides a quick and dirty way to determine the true name of a class + given just an InputStream.
    ClassNameReader() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jlink.ClassNameReader +
      +
    classNameToResource(String) - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Return the resource name of a class name. +
    classpath - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    classpath - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    classpath - +Variable in class org.apache.tools.ant.types.Mapper +
      +
    ClasspathUtils - Class in org.apache.tools.ant.util
    Offers some helper methods on the Path structure in ant.
    ClasspathUtils() - +Constructor for class org.apache.tools.ant.util.ClasspathUtils +
      +
    ClasspathUtils.Delegate - Class in org.apache.tools.ant.util
    Delegate that helps out any specific ProjectComponent that needs + dynamic classloading.
    cleanup() - +Method in class org.apache.tools.ant.AntClassLoader +
    Cleans up any resources held by this classloader. +
    cleanUp() - +Method in class org.apache.tools.ant.taskdefs.Ear +
    Make sure we don't think we already have a application.xml next + time this task gets executed. +
    cleanUp() - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    reset the monitor flag and the process. +
    cleanUp() - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Make sure we don't think we already have a MANIFEST next time this task + gets executed. +
    cleanup() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Removes resources. +
    cleanup() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Cleans up resources. +
    cleanup() - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
      +
    cleanup() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Cleans up resources. +
    cleanUp() - +Method in class org.apache.tools.ant.taskdefs.War +
    Make sure we don't think we already have a web.xml next time this task + gets executed. +
    cleanUp() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Do any clean up necessary to allow this instance to be used again. +
    cleanup() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource.ClassLoaderWithFlag +
      +
    clear() - +Method in class org.apache.tools.ant.types.Commandline +
    Clear out the whole command line. +
    clear() - +Method in class org.apache.tools.ant.types.optional.ScriptMapper +
    Reset the list of files +
    clear() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Clear the container. +
    clear() - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    clear() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    clear() - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    clearArgs() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Clear out the arguments to this java task. +
    clearArgs() - +Method in class org.apache.tools.ant.types.Commandline +
    Clear out the arguments but leave the executable in place for + another operation. +
    clearCache() - +Static method in class org.apache.tools.ant.IntrospectionHelper +
    Clears the static cache of on build finished. +
    ClearCase - Class in org.apache.tools.ant.taskdefs.optional.clearcase
    A base class for creating tasks for executing commands on ClearCase.
    ClearCase() - +Constructor for class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
      +
    clearDependencies() - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Clear the curretn set of collected dependencies. +
    clearJavaArgs() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Clear out the java arguments. +
    CLEARMASK - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    clearResults() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Clear the result caches for a scan. +
    clearScript() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Clear the current script text content. +
    clone() - +Method in class org.apache.tools.ant.ProjectComponent +
      +
    clone() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Clone this section +
    clone() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
      +
    clone() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Creates a deep clone of this instance, except for the nested + selectors (the list of selectors is a shallow clone of this + instance's list). +
    clone() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Return a ArchiveFileSet that has the same properties + as this one. +
    clone() - +Method in class org.apache.tools.ant.types.Assertions +
    clone the objects. +
    clone() - +Method in class org.apache.tools.ant.types.Commandline +
    Generate a deep clone of the contained object. +
    clone() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Deep clone the object. +
    clone() - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Create a deep clone. +
    clone() - +Method in class org.apache.tools.ant.types.DataType +
      +
    clone() - +Method in class org.apache.tools.ant.types.DirSet +
    Return a DirSet that has the same basedir and same patternsets + as this one. +
    clone() - +Method in class org.apache.tools.ant.types.FileSet +
    Return a FileSet that has the same basedir and same patternsets + as this one. +
    clone() - +Method in class org.apache.tools.ant.types.FilterSet +
    Clone the filterset. +
    clone() - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Clone this data type. +
    clone() - +Method in class org.apache.tools.ant.types.Path +
    Clone this Path. +
    clone() - +Method in class org.apache.tools.ant.types.PatternSet +
      +
    clone() - +Method in class org.apache.tools.ant.types.Resource +
    Clone this Resource. +
    clone() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Implement clone. +
    clone() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Implement clone. +
    clone() - +Method in class org.apache.tools.ant.types.resources.Files +
    Create a deep clone of this instance, except for the nested selectors + (the list of selectors is a shallow clone of this instance's list). +
    clone() - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Implement clone. +
    clone() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
      +
    clone() - +Method in class org.apache.tools.ant.types.TarFileSet +
    Return a TarFileSet that has the same properties + as this one. +
    clone() - +Method in class org.apache.tools.ant.types.ZipFileSet +
    Return a ZipFileSet that has the same properties + as this one. +
    clone() - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    clone() - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    clone() - +Method in class org.apache.tools.zip.AsiExtraField +
      +
    clone() - +Method in class org.apache.tools.zip.ZipEntry +
    Overwrite clone. +
    clone() - +Method in class org.apache.tools.zip.ZipLong +
      +
    clone() - +Method in class org.apache.tools.zip.ZipShort +
      +
    close() - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Equivalent to flushing the stream. +
    close() - +Method in class org.apache.tools.ant.loader.AntClassLoader5 +
    +
    close() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. Close the reader. +
    close() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream +
    Writes all remaining +
    close() - +Method in class org.apache.tools.ant.util.ConcatFileInputStream +
    Close the stream. +
    close() - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Close the stream. +
    close(Writer) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Close a Writer without throwing any exception if something went wrong. +
    close(Reader) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Close a Reader without throwing any exception if something went wrong. +
    close(OutputStream) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Close a stream without throwing any exception if something went wrong. +
    close(InputStream) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Close a stream without throwing any exception if something went wrong. +
    close(Channel) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Close a Channel without throwing any exception if something went wrong. +
    close(URLConnection) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Closes an URLConnection if its concrete implementation provides + a way to close it that Ant knows of. +
    close() - +Method in class org.apache.tools.ant.util.KeepAliveInputStream +
    This method does nothing. +
    close() - +Method in class org.apache.tools.ant.util.KeepAliveOutputStream +
    This method does nothing. +
    close() - +Method in class org.apache.tools.ant.util.LazyFileOutputStream +
    Close the file. +
    close() - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Writes all remaining +
    close() - +Method in class org.apache.tools.ant.util.PropertyOutputStream +
    Close the PropertyOutputStream, storing the property. +
    close() - +Method in class org.apache.tools.ant.util.ReaderInputStream +
    Closes the Reader. +
    close() - +Method in class org.apache.tools.ant.util.TeeOutputStream +
    Close both output streams. +
    close() - +Method in class org.apache.tools.bzip2.CBZip2InputStream +
      +
    close() - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
      +
    close() - +Method in class org.apache.tools.mail.SmtpResponseReader +
    Closes the underlying stream. +
    close() - +Method in class org.apache.tools.tar.TarBuffer +
    Close the TarBuffer. +
    close() - +Method in class org.apache.tools.tar.TarInputStream +
    Closes this stream. +
    close() - +Method in class org.apache.tools.tar.TarOutputStream +
    Ends the TAR archive and closes the underlying OutputStream. +
    close() - +Method in class org.apache.tools.zip.ZipFile +
    Closes the archive. +
    close() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Closes this output stream and releases any system resources + associated with the stream. +
    closeElement(Element, Writer, int, String, boolean) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes a DOM tree to a stream. +
    closeEntry() - +Method in class org.apache.tools.tar.TarOutputStream +
    Close an entry. +
    closeEntry() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes all necessary data for this entry. +
    closeQuietly(ZipFile) - +Static method in class org.apache.tools.zip.ZipFile +
    close a zipfile quietly; throw no io fault, do nothing + on a null parameter +
    CloseResources - Class in org.apache.tools.ant.taskdefs
    Not a real task but used during tests.
    CloseResources() - +Constructor for class org.apache.tools.ant.taskdefs.CloseResources +
      +
    closeStreams(Process) - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    Close the streams belonging to the given Process. +
    cmdl - +Variable in class org.apache.tools.ant.taskdefs.ExecTask +
      +
    CMP1_0 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion +
    1.0 value +
    CMP2_0 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion +
    2.0 value +
    CollectionUtils - Class in org.apache.tools.ant.util
    A set of helper methods related to collection manipulation.
    CollectionUtils() - +Constructor for class org.apache.tools.ant.util.CollectionUtils +
      +
    CollectionUtils.EmptyEnumeration - Class in org.apache.tools.ant.util
    An empty enumeration.
    CollectionUtils.EmptyEnumeration() - +Constructor for class org.apache.tools.ant.util.CollectionUtils.EmptyEnumeration +
    Constructor for the EmptyEnumeration +
    COLOR_BLACK - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    black string +
    COLOR_BLUE - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    blue string +
    COLOR_CYAN - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    cyan string +
    COLOR_DARKGRAY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    black string +
    COLOR_DARKGREY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    darkgrey string +
    COLOR_GRAY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    gray string +
    COLOR_GREEN - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    green string +
    COLOR_GREY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    grey string +
    COLOR_LIGHTGRAY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    lightgray string +
    COLOR_LIGHTGREY - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    lightgrey string +
    COLOR_MAGENTA - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    magenta string +
    COLOR_ORANGE - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    orange string +
    COLOR_PINK - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    pink string +
    COLOR_RED - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    reg string +
    COLOR_WHITE - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    white string +
    COLOR_YELLOW - +Static variable in class org.apache.tools.ant.types.optional.image.ColorMapper +
    yellow string +
    ColorMapper - Class in org.apache.tools.ant.types.optional.image
     
    COM_JAVACC_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    COM_JJDOC_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    COM_JJTREE_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    COM_PACKAGE - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    command - +Variable in class org.apache.tools.ant.taskdefs.Jikes +
    Deprecated.   +
    COMMAND_ADD - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Add' command +
    COMMAND_CHECKIN - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    The 'Checkin' command +
    COMMAND_CHECKIN - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Checkin' command +
    COMMAND_CHECKIN - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Checkin' command +
    COMMAND_CHECKIN_FILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The checkin file command +
    COMMAND_CHECKIN_PROJECT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The checkin project command +
    COMMAND_CHECKOUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    The 'Checkout' command +
    COMMAND_CHECKOUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Checkout' command +
    COMMAND_CHECKOUT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Checkout' command +
    COMMAND_CHECKOUT_FILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The checkout file command +
    COMMAND_CHECKOUT_PROJECT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The checkout project command +
    COMMAND_CP - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'CP' command +
    COMMAND_CREATE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Create' command +
    COMMAND_CREATE_TASK - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    The 'CreateTask' command +
    COMMAND_DEFAULT_TASK - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    The 'Reconfigure' command +
    COMMAND_GET - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Get' command +
    COMMAND_GET_FILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The get file command +
    COMMAND_GET_PROJECT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The get project command +
    COMMAND_HISTORY - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The get history command +
    COMMAND_HISTORY - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'History' command +
    COMMAND_LABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The add label command +
    COMMAND_LABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The 'Label' command +
    COMMAND_LOCK - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Lock' command +
    COMMAND_LSCO - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'LsCheckout' command +
    COMMAND_MKATTR - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mkattr' command +
    COMMAND_MKBL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mkbl' command +
    COMMAND_MKDIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mkdir' command +
    COMMAND_MKELEM - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mkelem' command +
    COMMAND_MKLABEL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mklabel' command +
    COMMAND_MKLBTYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Mklbtype' command +
    COMMAND_RECONFIGURE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    The 'Reconfigure' command +
    COMMAND_RMTYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Rmtype' command +
    COMMAND_SOS_EXE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The sos executable +
    COMMAND_UNCHECKOUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'UndoCheckout' command +
    COMMAND_UNLOCK - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Unlock' command +
    COMMAND_UPDATE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    The 'Update' command +
    commandLine - +Variable in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Commandline to be executed. +
    Commandline - Class in org.apache.tools.ant.types
    Commandline objects help handling command lines specifying processes to + execute.
    Commandline(String) - +Constructor for class org.apache.tools.ant.types.Commandline +
    Create a command line from a string. +
    Commandline() - +Constructor for class org.apache.tools.ant.types.Commandline +
    Create an empty command line. +
    Commandline.Argument - Class in org.apache.tools.ant.types
    Used for nested xml command line definitions.
    Commandline.Argument() - +Constructor for class org.apache.tools.ant.types.Commandline.Argument +
      +
    Commandline.Marker - Class in org.apache.tools.ant.types
    Class to keep track of the position of an Argument.
    CommandlineJava - Class in org.apache.tools.ant.types
    A representation of a Java command line that is + a composite of 2 Commandlines.
    CommandlineJava() - +Constructor for class org.apache.tools.ant.types.CommandlineJava +
    Constructor uses the VM we are running on now. +
    CommandlineJava.SysProperties - Class in org.apache.tools.ant.types
    Specialized Environment class for System properties.
    CommandlineJava.SysProperties() - +Constructor for class org.apache.tools.ant.types.CommandlineJava.SysProperties +
      +
    CommonsLoggingListener - Class in org.apache.tools.ant.listener
    Jakarta Commons Logging listener.
    CommonsLoggingListener() - +Constructor for class org.apache.tools.ant.listener.CommonsLoggingListener +
    Construct the listener and make sure that a LogFactory + can be obtained. +
    compare(Object, Object) - +Method in class org.apache.tools.ant.types.resources.comparators.ResourceComparator +
    Compare two objects. +
    Compare - Class in org.apache.tools.ant.types.resources.selectors
    ResourceSelector that compares against "control" Resource(s) + using ResourceComparators.
    Compare() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Compare +
      +
    compare(Object, Object) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.EqualComparator +
    Implements Comparator.compare(). +
    compare(long, long) - +Static method in class org.apache.tools.ant.types.TimeComparison +
    Compare two times. +
    compare(long, long, long) - +Static method in class org.apache.tools.ant.types.TimeComparison +
    Compare two times. +
    compareContent(Resource, Resource, boolean) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Compare the content of two Resources. +
    compareTo(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos +
    The SortedMap needs comparable elements. +
    compareTo(Object) - +Method in class org.apache.tools.ant.types.Resource +
    Delegates to a comparison of names. +
    compareTo(Object) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Compare this ArchiveResource to another Resource. +
    compareTo(Object) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Compare this FileResource to another Resource. +
    compareTo(Object) - +Method in class org.apache.tools.ant.types.resources.JavaResource +
    Compare this JavaResource to another Resource. +
    compareTo(Object) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Delegates to a comparison of names. +
    Comparison - Class in org.apache.tools.ant.types
    EnumeratedAttribute for generic comparisons.
    Comparison() - +Constructor for class org.apache.tools.ant.types.Comparison +
    Default constructor. +
    Comparison(String) - +Constructor for class org.apache.tools.ant.types.Comparison +
    Construct a new Comparison with the specified value. +
    Compatability - Class in org.apache.tools.ant.taskdefs.optional.extension
    Enum used in (@link Extension) to indicate the compatability + of one extension to another.
    Compatibility - Class in org.apache.tools.ant.taskdefs.optional.extension
    Enum used in (@link Extension) to indicate the compatibility + of one extension to another.
    COMPATIBLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Enum indicating that extension is compatible with other extension. +
    COMPATIBLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Enum indicating that extension is compatible with other Package + Specification. +
    compile() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Perform the compilation. +
    compile(String[]) - +Method in class org.apache.tools.ant.taskdefs.Jikes +
    Deprecated. Do the compile with the specified arguments. +
    compile(Javah) - +Method in class org.apache.tools.ant.taskdefs.optional.javah.Gcjh +
    Performs the actual compilation. +
    compile(Javah) - +Method in interface org.apache.tools.ant.taskdefs.optional.javah.JavahAdapter +
    Performs the actual compilation. +
    compile(Javah) - +Method in class org.apache.tools.ant.taskdefs.optional.javah.Kaffeh +
    Performs the actual compilation. +
    compile(Javah) - +Method in class org.apache.tools.ant.taskdefs.optional.javah.SunJavah +
    Performs the actual compilation. +
    compileClasspath - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    compileList - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    compileList - +Variable in class org.apache.tools.ant.taskdefs.Javac +
      +
    compileList - +Variable in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
      +
    compiler - +Variable in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
      +
    COMPILER_EJB11 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    COMPILER_EJB20 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    COMPILER_NAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic +
    the name of this adapter for users to select +
    COMPILER_NAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.KaffeRmic +
    the name of this adapter for users to select +
    COMPILER_NAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    the name of this adapter for users to select +
    COMPILER_NAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    the name of this adapter for users to select +
    COMPILER_NAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.XNewRmic +
    the name of this adapter for users to select +
    CompilerAdapter - Interface in org.apache.tools.ant.taskdefs.compilers
    The interface that all compiler adapters must adhere to.
    CompilerAdapterExtension - Interface in org.apache.tools.ant.taskdefs.compilers
    Extension interface for compilers that support source extensions + other than .java.
    CompilerAdapterFactory - Class in org.apache.tools.ant.taskdefs.compilers
    Creates the necessary compiler adapter, given basic criteria.
    compileSourcepath - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    complete() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Complete redirection. +
    COMPLETED_ACTION_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    COMPLETED_ACTION_STRS - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    completeDirMap - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    COMPONENT_HELPER_REFERENCE - +Static variable in class org.apache.tools.ant.ComponentHelper +
    reference under which we register ourselves with a project -"ant.ComponentHelper" +
    Componentdef - Class in org.apache.tools.ant.taskdefs
    Adds a compenent definition to the current project.
    Componentdef() - +Constructor for class org.apache.tools.ant.taskdefs.Componentdef +
    Default constructor. +
    ComponentHelper - Class in org.apache.tools.ant
    Component creation and configuration.
    ComponentHelper() - +Constructor for class org.apache.tools.ant.ComponentHelper +
    Creates a new ComponentHelper instance. +
    CompositeMapper - Class in org.apache.tools.ant.util
    A ContainerMapper that unites the results of its constituent + FileNameMappers into a single set of result filenames.
    CompositeMapper() - +Constructor for class org.apache.tools.ant.util.CompositeMapper +
      +
    CompressedResource - Class in org.apache.tools.ant.types.resources
    A compressed resource.
    CompressedResource() - +Constructor for class org.apache.tools.ant.types.resources.CompressedResource +
    no arg constructor +
    CompressedResource(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.CompressedResource +
    Constructor with another resource to wrap. +
    computeCheckSum(byte[]) - +Static method in class org.apache.tools.tar.TarUtils +
    Compute the checksum of a tar entry header. +
    Concat - Class in org.apache.tools.ant.taskdefs
    This class contains the 'concat' task, used to concatenate a series + of files into a single stream.
    Concat() - +Constructor for class org.apache.tools.ant.taskdefs.Concat +
    Construct a new Concat task. +
    Concat.TextElement - Class in org.apache.tools.ant.taskdefs
    sub element points to a file or contains text
    Concat.TextElement() - +Constructor for class org.apache.tools.ant.taskdefs.Concat.TextElement +
      +
    ConcatFileInputStream - Class in org.apache.tools.ant.util
    Special InputStream that will + concatenate the contents of an array of files.
    ConcatFileInputStream(File[]) - +Constructor for class org.apache.tools.ant.util.ConcatFileInputStream +
    Construct a new ConcatFileInputStream + with the specified File[]. +
    ConcatFilter - Class in org.apache.tools.ant.filters
    Concats a file before and/or after the file.
    ConcatFilter() - +Constructor for class org.apache.tools.ant.filters.ConcatFilter +
    Constructor for "dummy" instances. +
    ConcatFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.ConcatFilter +
    Creates a new filtered reader. +
    ConcatResourceInputStream - Class in org.apache.tools.ant.util
    Special InputStream that will + concatenate the contents of Resources from a single ResourceCollection.
    ConcatResourceInputStream(ResourceCollection) - +Constructor for class org.apache.tools.ant.util.ConcatResourceInputStream +
    Construct a new ConcatResourceInputStream + for the specified ResourceCollection. +
    concatSystemBootClasspath(String) - +Method in class org.apache.tools.ant.types.Path +
    Concatenates the system boot class path in the order specified + by the ${build.sysclasspath} property - using the supplied + value if ${build.sysclasspath} has not been set. +
    concatSystemClasspath() - +Method in class org.apache.tools.ant.types.Path +
    Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using "last" as + default value. +
    concatSystemClasspath(String) - +Method in class org.apache.tools.ant.types.Path +
    Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using the supplied value + if ${build.sysclasspath} has not been set. +
    Condition - Interface in org.apache.tools.ant.taskdefs.condition
    Interface for conditions to use inside the <condition> task.
    ConditionBase - Class in org.apache.tools.ant.taskdefs.condition
    Baseclass for the <condition> task as well as several + conditions - ensures that the types of conditions inside the task + and the "container" conditions are in sync.
    ConditionBase() - +Constructor for class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Simple constructor. +
    ConditionBase(String) - +Constructor for class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Constructor that takes the name of the task in the task name. +
    ConditionTask - Class in org.apache.tools.ant.taskdefs
    Task to set a property conditionally using <uptodate>, <available>, + and many other supported conditions.
    ConditionTask() - +Constructor for class org.apache.tools.ant.taskdefs.ConditionTask +
    Constructor, names this task "condition". +
    config(String, Object) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Configure an aspect of the analyzer. +
    config(String, Object) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Configure an aspect of the analyzer. +
    configure(Object, AttributeList, Project) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Deprecated. since 1.6.x. + Use IntrospectionHelper for each property. +
    configure(EjbJar.Config) - +Method in interface org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool +
    Configure this tool for use in the ejbjar task. +
    configure(EjbJar.Config) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Configure this tool for use in the ejbjar task. +
    configure(XSLTProcess) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Specific configuration for the TRaX liaison. +
    configure(XSLTProcess) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLiaison2 +
    Configure the liasion from the XSLTProcess task +
    configure(Redirector) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Configure the specified Redirector. +
    configure(Redirector, String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Configure the specified Redirector + for the specified sourcefile. +
    configure() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Configures this Selector. +
    configure(Object) - +Method in class org.apache.tools.ant.UnknownElement +
    Configure the given object from this UnknownElement +
    configureArchive(ArchiveFileSet, Resource) - +Method in class org.apache.tools.ant.types.resources.Archives +
    Configures the archivefileset based on this type's settings, + set the source. +
    configureCommandline(Commandline) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Configure a commandline element for things like cvsRoot, quiet, etc. +
    configureFileSet(ArchiveFileSet) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +
    configureFileSet(ArchiveFileSet) - +Method in class org.apache.tools.ant.types.TarFileSet +
    Configure a fileset based on this fileset. +
    configureId(Object, Attributes) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    Scans an attribute list for the id attribute and + stores a reference to the target object in the project if an + id is found. +
    configureLiaison(File) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Deprecated. since Ant 1.7 +
    configureLiaison(Resource) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Loads the stylesheet and set xsl:param parameters. +
    configureProject(Project, File) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Configures the project with the contents of the specified build file. +
    configureTrace(Transformer, XSLTProcess.TraceConfiguration) - +Method in class org.apache.tools.ant.taskdefs.optional.Xalan2TraceSupport +
      +
    configureTrace(Transformer, XSLTProcess.TraceConfiguration) - +Method in interface org.apache.tools.ant.taskdefs.optional.XSLTTraceSupport +
      +
    connect() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Ensure that we have a connection. +
    CONSTANT_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Class entries. +
    CONSTANT_DOUBLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Double entries. +
    CONSTANT_FIELDREF - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Field Reference entries. +
    CONSTANT_FLOAT - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Float entries. +
    CONSTANT_INTEGER - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Integer entries. +
    CONSTANT_INTERFACEMETHODREF - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Interface Method Reference entries. +
    CONSTANT_LONG - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Long entries. +
    CONSTANT_METHODREF - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Method Reference entries. +
    CONSTANT_NAMEANDTYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for Name and Type entries. +
    CONSTANT_STRING - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for String entries. +
    CONSTANT_UTF8 - +Static variable in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Tag value for UTF8 entries. +
    ConstantCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A Constant Pool entry which represents a constant value.
    ConstantCPInfo(int, int) - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo +
    Initialise the constant entry. +
    ConstantPool - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    The constant pool of a Java class.
    ConstantPool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Initialise the constant pool. +
    ConstantPoolEntry - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    An entry in the constant pool.
    ConstantPoolEntry(int, int) - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Initialise the constant pool entry. +
    Constants - Class in org.apache.tools.ant.taskdefs.optional.junit
    Constants, like filenames shared between various classes in this package.
    Constants() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.Constants +
      +
    ContainerMapper - Class in org.apache.tools.ant.util
    A FileNameMapper that contains + other FileNameMappers.
    ContainerMapper() - +Constructor for class org.apache.tools.ant.util.ContainerMapper +
      +
    Contains - Class in org.apache.tools.ant.taskdefs.condition
    Is one string part of another string?
    Contains() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Contains +
      +
    contains(FileNameMapper) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Return true if this ContainerMapper or any of + its sub-elements contains the specified FileNameMapper. +
    contains(Object) - +Method in class org.apache.tools.ant.util.IdentityStack +
    Override methods that use .equals() comparisons on elements. +
    contains(Object) - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Check if the table contains a particular value. +
    contains(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    contains(Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    CONTAINS_KEY - +Static variable in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Used for parameterized custom selector +
    containsAll(Collection) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    containsKey(Object) - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Check if the table contains a particular key. +
    containsKey(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    containsPattern(String) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Does the tokenized pattern contain the given string? +
    containsProperties(String) - +Method in class org.apache.tools.ant.property.ParseProperties +
    Learn whether a String contains replaceable properties. +
    containsProperties(String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Learn whether a String contains replaceable properties. +
    ContainsRegexpSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on a regular expression.
    ContainsRegexpSelector() - +Constructor for class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Creates a new ContainsRegexpSelector instance. +
    ContainsSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files/resources based on whether they contain a + particular string.
    ContainsSelector() - +Constructor for class org.apache.tools.ant.types.selectors.ContainsSelector +
    Creates a new ContainsSelector instance. +
    containsValue(String) - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
    Is this value included in the enumeration? +
    containsValue(Object) - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Delegates to contains. +
    containsValue(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    Content - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by content.
    Content() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Content +
      +
    contentEquals(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Compares the contents of two files. +
    contentEquals(File, File, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Compares the contents of two files. +
    contentEquals(Resource, Resource, boolean) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Compares the contents of two Resources. +
    ContentTransformingResource - Class in org.apache.tools.ant.types.resources
    A resource that transforms the content of another resource.
    ContentTransformingResource() - +Constructor for class org.apache.tools.ant.types.resources.ContentTransformingResource +
    no arg constructor +
    ContentTransformingResource(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Constructor with another resource to wrap. +
    Continuus - Class in org.apache.tools.ant.taskdefs.optional.ccm
    A base class for creating tasks for executing commands on Continuus 5.1.
    Continuus() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
      +
    convert(Native2Ascii, File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii +
    Splits the task into setting up the command line switches +
    convert(Native2Ascii, File, File) - +Method in interface org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapter +
    Convert the encoding of srcFile writing to destFile. +
    convertDotName(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.depend.ClassFileUtils +
    Convert a class name from java source file dot notation to class file + slash notation.. +
    convertRegexOptions(String) - +Static method in class org.apache.tools.ant.filters.TokenFilter +
    convert regex option flag characters to regex options + + g - Regexp.REPLACE_ALL + i - Regexp.MATCH_CASE_INSENSITIVE + m - Regexp.MATCH_MULTILINE + s - Regexp.MATCH_SINGLELINE + +
    convertSlashName(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.depend.ClassFileUtils +
    Convert a class name from class file slash notation to java source + file dot notation. +
    copy() - +Method in class org.apache.tools.ant.property.LocalProperties +
    Copy the stack for a parallel thread. +
    copy() - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Copy the stack for a parallel thread. +
    Copy - Class in org.apache.tools.ant.taskdefs
    Copies a file or directory to a new file + or directory.
    Copy() - +Constructor for class org.apache.tools.ant.taskdefs.Copy +
    Copy task constructor. +
    copy(Project) - +Method in class org.apache.tools.ant.UnknownElement +
    Make a copy of the unknown element and set it in the new project. +
    Copydir - Class in org.apache.tools.ant.taskdefs
    Deprecated. The copydir task is deprecated since Ant 1.2. Use copy instead.
    Copydir() - +Constructor for class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated.   +
    copyEntryContents(OutputStream) - +Method in class org.apache.tools.tar.TarInputStream +
    Copies the contents of the current tar archive entry directly into + an output stream. +
    copyFile(String, String) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(String, String, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(String, String, boolean, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(String, String, boolean, boolean, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(File, File) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(File, File, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(File, File, boolean, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    copyFile(File, File, boolean, boolean, boolean) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    Copyfile - Class in org.apache.tools.ant.taskdefs
    Deprecated. The copyfile task is deprecated since Ant 1.2. Use + copy instead.
    Copyfile() - +Constructor for class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated.   +
    copyFile(String, String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination. +
    copyFile(String, String, FilterSetCollection) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination + specifying if token filtering must be used. +
    copyFile(String, String, FilterSetCollection, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination specifying if token + filtering must be used and if source files may overwrite newer destination files. +
    copyFile(String, String, FilterSetCollection, boolean, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination + specifying if token + filtering must be used, if source files may overwrite newer destination + files and the last + modified time of destFile file should be made equal to + the last modified time + of sourceFile. +
    copyFile(String, String, FilterSetCollection, boolean, boolean, String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files and the last + modified time of destFile file should be made equal to the last modified time + of sourceFile. +
    copyFile(String, String, FilterSetCollection, Vector, boolean, boolean, String, Project) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +
    copyFile(String, String, FilterSetCollection, Vector, boolean, boolean, String, String, Project) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if filter chains must be used, if source files may overwrite newer + destination files and the last modified time of destFile file should be made + equal to the last modified time of sourceFile. +
    copyFile(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination. +
    copyFile(File, File, FilterSetCollection) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination + specifying if token filtering must be used. +
    copyFile(File, File, FilterSetCollection, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used and if + source files may overwrite newer destination files. +
    copyFile(File, File, FilterSetCollection, boolean, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + source files may overwrite newer destination files and the + last modified time of destFile file should be made equal + to the last modified time of sourceFile. +
    copyFile(File, File, FilterSetCollection, boolean, boolean, String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files, the last + modified time of destFile file should be made equal to the last modified time + of sourceFile and which character encoding to assume. +
    copyFile(File, File, FilterSetCollection, Vector, boolean, boolean, String, Project) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +
    copyFile(File, File, FilterSetCollection, Vector, boolean, boolean, String, String, Project) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +
    copyFile(File, File, FilterSetCollection, Vector, boolean, boolean, boolean, String, String, Project) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +
    copyFile(File, File, FilterSetCollection, Vector, boolean, boolean, boolean, String, String, Project, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +
    copyInheritedProperties(Project) - +Method in class org.apache.tools.ant.Project +
    Copy all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument. +
    copyInheritedProperties(Project) - +Method in class org.apache.tools.ant.PropertyHelper +
    Copies all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument. +
    CopyPath - Class in org.apache.tools.ant.taskdefs
    Deprecated. this task should have never been released and was + obsoleted by ResourceCollection support in Copy available since Ant + 1.7.0. Don't use it.
    CopyPath() - +Constructor for class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated.   +
    copyResource(Resource, Resource) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to copy content from one Resource to another. +
    copyResource(Resource, Resource, Project) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to copy content from one Resource to another. +
    copyResource(Resource, Resource, FilterSetCollection, Vector, boolean, boolean, String, String, Project) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +
    copyResource(Resource, Resource, FilterSetCollection, Vector, boolean, boolean, boolean, String, String, Project) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +
    copyResource(Resource, Resource, FilterSetCollection, Vector, boolean, boolean, boolean, String, String, Project, boolean) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +
    copyUserProperties(Project) - +Method in class org.apache.tools.ant.Project +
    Copy all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument. +
    copyUserProperties(Project) - +Method in class org.apache.tools.ant.PropertyHelper +
    Copies all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument. +
    couldHoldIncluded(String) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a name matches the start of at least one include + pattern. +
    countConditions() - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Count the conditions. +
    counter - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    name of the counter +
    countTestCases() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    crashed - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.TestResultHolder +
    true if the test crashed +
    create(Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Create an instance of the definition. +
    create() - +Method in class org.apache.tools.ant.IntrospectionHelper.Creator +
    Create an object using this creator, which is determined by introspection. +
    create(Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Fake create an object, used by IntrospectionHelper and UnknownElement + to see that this is a predefined object. +
    createAddfiles() - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Establishes the object that contains the files to + be added to the output. +
    createAnonymousSchema() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    create a schema location to hold the anonymous + schema +
    createAntlib(Project, URL, String) - +Static method in class org.apache.tools.ant.taskdefs.Antlib +
    Static method to read an ant lib definition from + a url. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Adds a command-line argument. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a command-line argument. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a command-line argument. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Add a nested argument element to hand to the deployment tool; optional. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Adds an implementation specific command-line argument. +
    createArg() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Adds an implementation specific command-line argument. +
    createArgument() - +Method in class org.apache.tools.ant.types.Commandline +
    Create an argument object. +
    createArgument(boolean) - +Method in class org.apache.tools.ant.types.Commandline +
    Create an argument object and add it to our list of args. +
    createArgument() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Create a new argument to the java program. +
    createAttachments() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Creates a Path as container for attachments. +
    createAttribute() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Add an attribute nested element. +
    createBatchTest() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds a set of tests based on pattern matching. +
    createBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a path to the bootclasspath. +
    createBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a path to the bootclasspath. +
    createBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create a Path to be configured with the boot classpath +
    createBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Adds path to bootstrap class files. +
    createBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds a path to the bootclasspath. +
    createBootclasspath(Project) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Create a boot classpath. +
    createBorland() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for Borland server. +
    createBuildpath() - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Creates a nested build path, and add it to the implicit build path. +
    createBuildpathElement() - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Creates a nested <buildpathelement>, + and add it to the implicit build path. +
    createCatalogPath() - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Creates a nested <catalogpath> element. +
    createChildElement(Element, String) - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Creates a named Element and appends it to the given element, + returns it. +
    createClass() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Adds class to process. +
    createClassespath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Adds a path to class code to analyze. +
    createClassLoader(Path) - +Method in class org.apache.tools.ant.Project +
    Factory method to create a class loader for loading classes from + a given path. +
    createClassLoader(ClassLoader, Path) - +Method in class org.apache.tools.ant.Project +
    Factory method to create a class loader for loading classes from + a given path. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Available +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Create a classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Create the classpath to be used when searching for component being + defined. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Add a path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create a Path to be configured with the classpath to use +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Add a path to the classpath for loading the driver. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Add a classpath to use when looking up a resource. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Adds a classpath to be set + because a directory might be given for Antlr debug. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Adds a classpath to be used for this dependency check. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Adds path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds to the classpath used to locate the super classes and + interfaces of the classes that will make up the EJB JAR. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Add the classpath for the user classes +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Adds to the classpath used when compiling the EJB stubs and skeletons. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Add a classpath as a nested element. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Path to use for classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Adds a path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Adds a path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Maybe creates a nested classpath element. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds path to classpath used for tests. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Property +
    The classpath to use when looking up a resource. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Creates a nested classpath element. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    Adds a path to the classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the optional classpath to the XSL processor +
    createClasspath() - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Set the classpath to load the FilterReader through (nested element). +
    createClasspath(Project) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Create a classpath. +
    createClasspath() - +Method in class org.apache.tools.ant.types.Mapper +
    Set the classpath to load the FileNameMapper through (nested element). +
    createClasspath() - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Classpath to be used when searching for classes and resources. +
    createClasspath() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Add a classpath to use when looking up a resource. +
    createClasspath() - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Specify the classpath to use to load the Selector (nested element). +
    createClasspath() - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Allows nested classpath elements. +
    createClasspath() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Delegate method handling the <classpath> tag. +
    createClasspath() - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Classpath to be used when searching for classes and resources. +
    createCompilerArg() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds an implementation specific command-line argument. +
    createCompilerArg() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Adds an implementation specific command line argument. +
    createCompilerClasspath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The classpath to use when loading the compiler implementation + if it is not a built-in one. +
    createCompilerclasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Support nested compiler classpath, used to locate compiler adapter +
    createCompilerClasspath() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    The classpath to use when loading the compiler implementation + if it is not a built-in one. +
    createComponent(UnknownElement, String, String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Factory method to create the components. +
    createComponent(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Create an object for a component. +
    createCondition() - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Add a condition element. +
    createCondition() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Add a condition element. +
    createControl() - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Create the nested control element. +
    createDataType(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Creates a new instance of a data type. +
    createDataType(String) - +Method in class org.apache.tools.ant.Project +
    Create a new instance of a data type. +
    createDefaultReader() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    Create a reader if the use of the class did not specify another one. +
    createDefaultReader() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    create a reader if the use of the class did not specify another one. +
    createDelegate() - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask +
    Add a nested <delegate refid="foo" /> element. +
    createDname() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Distinguished name list. +
    createDoclet() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create a doclet to be used in the documentation generation. +
    createDocument() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Create a DOM tree. +
    createDTD() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Create a DTD location record. +
    createDTD() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Create a DTD location record; optional. +
    createDynamicElement(String) - +Method in interface org.apache.tools.ant.DynamicElement +
    Create an element with the given name +
    createDynamicElement(String, String, String) - +Method in interface org.apache.tools.ant.DynamicElementNS +
    Create an element with the given name +
    createDynamicElement(String) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    Deprecated. since 1.6.x. +
    createDynamicElement(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    Create a nested element +
    createDynamicElement(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute +
    Not used. +
    createDynamicElement(String, String, String) - +Method in class org.apache.tools.ant.util.XMLFragment.Child +
    Creates a nested element. +
    createDynamicElement(String, String, String) - +Method in class org.apache.tools.ant.util.XMLFragment +
    Creates a nested element. +
    createElement(Project, Object, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Deprecated. since 1.6.x. + This is not a namespace aware method. +
    createEmptyZip(File) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Create an empty jar file. +
    createEmptyZip(File) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Create an empty zip file +
    createEntry() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile +
    The entry nested element. +
    createErrorFilterChain() - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Create a nested error FilterChain. +
    createExclude() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Add a name entry on the exclude list. +
    createExclude() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a name entry on the exclude list +
    createExclude() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a name entry on the exclude list +
    createExclude() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    add a name entry on the exclude list +
    createExclude() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a name entry to the exclude list. +
    createExclude() - +Method in class org.apache.tools.ant.types.PatternSet +
    add a name entry on the exclude list +
    createExclude() - +Method in class org.apache.tools.ant.types.resources.Files +
    Add a name entry to the exclude list. +
    createExcludesFile() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a name entry on the include files list +
    createExcludesFile() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a name entry on the include files list +
    createExcludesFile() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a name entry to the excludes files list. +
    createExcludesFile() - +Method in class org.apache.tools.ant.types.PatternSet +
    add a name entry on the exclude files list +
    createExcludesFile() - +Method in class org.apache.tools.ant.types.resources.Files +
    Add a name entry to the excludes files list. +
    createExec() - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Create a new exec delegate. +
    createExtdirs() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a path to extdirs. +
    createExtdirs() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Maybe creates a nested extdirs element. +
    createExtraField(ZipShort) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Create an instance of the approriate ExtraField, falls back to + UnrecognizedExtraField. +
    createFactory() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Create the factory element to configure a trax liaison. +
    createFactoryPath() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Add a path to the factoryPath attribute. +
    createFail() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask +
    add a sound when the build fails +
    createFilepath() - +Method in class org.apache.tools.ant.taskdefs.Available +
    Path to search for file resources. +
    createFilterChain() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add a FilterChain. +
    createFilterSet() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Add a filterset. +
    createFiltersfile() - +Method in class org.apache.tools.ant.types.FilterSet +
    Create a new FiltersFile. +
    createFormat() - +Method in class org.apache.tools.ant.taskdefs.Tstamp +
    create a custom format with the current prefix. +
    createGroup() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Separates packages on the overview page into whatever + groups you specify, one group per table. +
    createHandler() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Create the StreamHandler to use with our Execute instance. +
    createHandler() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Create the ExecuteStreamHandler instance that will be used + during execution. +
    createHandler() - +Method in class org.apache.tools.ant.taskdefs.Input +
    Create a nested handler element. +
    createHandler() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Create the StreamHandler to use with our Execute instance. +
    createHeader() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Create a nested header element. +
    createImplementationClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    The classpath to use when loading the javah implementation + if it is not a built-in one. +
    createImplementationClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    The classpath to use when loading the native2ascii + implementation if it is not a built-in one. +
    createInclude() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Add a name entry on the include list. +
    createInclude() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a name entry on the include list +
    createInclude() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a name entry on the include list +
    createInclude() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a name entry to the include list. +
    createInclude() - +Method in class org.apache.tools.ant.types.PatternSet +
    add a name entry on the include list +
    createInclude() - +Method in class org.apache.tools.ant.types.resources.Files +
    Add a name entry to the include list. +
    createIncludesFile() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a name entry on the include files list +
    createIncludesFile() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a name entry on the include files list +
    createIncludesFile() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Add a name entry to the include files list. +
    createIncludesFile() - +Method in class org.apache.tools.ant.types.PatternSet +
    add a name entry on the include files list +
    createIncludesFile() - +Method in class org.apache.tools.ant.types.resources.Files +
    Add a name entry to the include files list. +
    createInputFilterChain() - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Create a nested input FilterChain. +
    createInstance(String) - +Method in class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Create an instance of a matcher from a classname. +
    createIplanet() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for iPlanet Application Server. +
    createIterator() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Do create an iterator on the resource collection. +
    createIterator() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper +
      +
    createIterator() - +Method in class org.apache.tools.ant.types.resources.LazyResourceCollectionWrapper +
      +
    createJarSigner() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    create the jarsigner executable task +
    createJboss() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for JBoss server. +
    createJonas() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for JOnAS server. +
    createJvmarg() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Adds a JVM argument. +
    createJvmarg() - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Adds a new JVM argument. +
    createJvmarg() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Add a nested argment element to hand to the JVM running the + deployment tool. +
    createJvmarg(CommandlineJava) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Create a new JVM argument. +
    createJvmarg() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds a JVM argument; ignored if not forking. +
    createLink() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create link to Javadoc output at the given URL. +
    createListFile(Vector) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Creates a list file. +
    createLoader() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    create a classloader for this definition +
    createLocalTunnel() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
      +
    createMangler() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.JasperC +
      +
    createMangler() - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapter +
      +
    createMap() - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Create a nested MAP element. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Define the mapper to map source to destination files. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Create a nested Mapper element to use for mapping + source files to target files. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Defines the mapper to map source entries to destination files. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.Get +
    Define the mapper to map source to destination files. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Defines the mapper to map source to destination files. +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Defines the FileNameMapper to use (nested mapper element). +
    createMapper() - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Defines the FileNameMapper to use (nested mapper element). +
    createMapper() - +Method in class org.apache.tools.ant.types.PropertySet +
    Create a mapper to map the property names. +
    createMapper() - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Define the mapper to map source to destination files. +
    createMapper() - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    Defines the FileNameMapper to use (nested mapper element). +
    createMapper() - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    Defines the FileNameMapper to use (nested mapper element). +
    createMarker() - +Method in class org.apache.tools.ant.types.Commandline +
    Return a marker. +
    createMergefiles() - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Establishes the object that contains the files to + be merged into the output. +
    createMergeMapper(File) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Create a merge mapper pointing to the specified destination file. +
    createNestedElement(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Create a nested element to be configured. +
    createNewFile(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    This was originally an emulation of File.createNewFile for JDK 1.1, + but it is now implemented using that method (Ant 1.6.3 onwards). +
    createNewFile(File, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Create a new file, optionally creating parent directories. +
    createObject(Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Create an instance of the definition. +
    createOption() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Create a nested option. +
    createOutputFilterChain() - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Create a nested output FilterChain. +
    createOutputProperty() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Create an instance of an output property to be configured. +
    createParam() - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Create a new Property to pass to the invoked target(s). +
    createParam() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName +
    Create a param nested element. +
    createParam() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletInfo +
    Create a doclet parameter to be configured by Ant. +
    createParam() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    Create an instance of an XSL parameter for configuration by Ant. +
    createParam() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Create an instance of an XSL parameter for configuration by Ant. +
    createParents(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Creates all parent directories specified in a complete relative + pathname. +
    createParents(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Creates all parent directories specified in a complete relative + pathname. +
    createPath() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Adds a path of files to sign. +
    createPath() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Path of files to concatenate. +
    createPath() - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Create a path. +
    createPath() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Create an empty nested path to be configured by Ant with the + classpath for the extension. +
    createPath() - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Create a nested path element. +
    createPath() - +Method in class org.apache.tools.ant.types.Path +
    Creates a nested <path> element. +
    createPathElement() - +Method in class org.apache.tools.ant.types.Path +
    Creates the nested <pathelement> element. +
    createPatternSet() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Add a set of patterns. +
    createPatternSet() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    add a set of patterns +
    createPatternSet() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    add a set of patterns +
    createPatternSet() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Creates a nested patternset. +
    createPatternSet() - +Method in class org.apache.tools.ant.types.resources.Files +
    Create a nested patternset. +
    createPermissions() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the permissions for the application run inside the same JVM. +
    createPermissions() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Sets the permissions for the application run inside the same JVM. +
    createProcessErrorPump(InputStream, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Create the pump to handle error output. +
    createProcessOutputPump(InputStream, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Create the pump to handle process output. +
    createProperty() - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Property to pass to the new project. +
    createProperty() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Creates a property. +
    createPump(InputStream, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Creates a stream pumper to copy the given input stream to the + given output stream. +
    createPump(InputStream, OutputStream, boolean) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Creates a stream pumper to copy the given input stream to the + given output stream. +
    createPump(InputStream, OutputStream, boolean, boolean) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Creates a stream pumper to copy the given input stream to the + given output stream. +
    createRead() - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    A string to wait for from the server. +
    createRead() - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    A string to wait for from the server. +
    createReference(Object) - +Static method in class org.apache.tools.ant.util.WeakishReference +
    Deprecated. create the appropriate type of reference for the java version +
    createRegexp() - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    A regular expression. +
    createRegexpInstance(String) - +Method in class org.apache.tools.ant.util.regexp.RegexpFactory +
    Wrapper over RegexpMatcherFactory.createInstance that ensures that + we are dealing with a Regexp implementation. +
    createRemoteTunnel() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
      +
    createReplacefilter() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Add a nested <replacefilter> element. +
    createReplaceToken() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Create a token to filter as the text of a nested element. +
    createReplaceToken() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Create a token to filter as the text of a nested element. +
    createReplaceValue() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Create a string to replace the token as the text of a nested element. +
    createReplaceValue() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Create a string to replace the token as the text of a nested element. +
    createReport() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Generate a report based on the document created by the merge. +
    createRunner(String, String, ClassLoader) - +Method in class org.apache.tools.ant.util.ScriptRunnerCreator +
    Create a ScriptRunner. +
    createSequential() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    This is the sequential nested element of the macrodef. +
    createSequential() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    This is the sequential nested element of the macrodef. +
    createSourceFiles() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a container for resource collections. +
    createSourcepath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a path to sourcepath. +
    createSourcepath() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create a path to be configured with the locations of the source + files. +
    createSources() - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Create a nested sources element. +
    createSourcespath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Deprecated. since 1.6.x. +
    createSrc() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a path for source compilation. +
    createSrcfile() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Create a placeholder indicating where on the command line + the name of the source file should be inserted. +
    createSrcResources() - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Nested resource collections as sources. +
    createStreams() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Create the input, error and output streams based on the configuration + options. +
    createSubProject() - +Method in class org.apache.tools.ant.Project +
    Create and initialize a subproject. +
    createSubstitution() - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    A substitution pattern. +
    createSuccess() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask +
    add a sound when the build succeeds +
    createSupport() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a fileset for support elements. +
    createTag() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Creates and adds a -tag argument. +
    createTarFileSet() - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Add a new fileset with the option to specify permissions +
    createTargetfile() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Create a placeholder indicating where on the command line + the name of the target file should be inserted. +
    createTargets() - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Create a nested targets element. +
    createTars() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Wrapper to identify nested resource collections as ZIP + archives. +
    createTask(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Creates a new instance of a task. +
    createTask(String) - +Method in class org.apache.tools.ant.Project +
    Create a new instance of a task, adding it to a list of + created tasks for later invalidation. +
    createTempFile(String, String, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. +
    createTempFile(String, String, File, boolean, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Create a temporary file in a given directory. +
    createTempFile(String, String, File, boolean) - +Method in class org.apache.tools.ant.util.FileUtils +
    Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. +
    createTrace() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Enables Xalan2 traces and uses the given configuration. +
    createTransaction() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Add a SQL transaction to execute +
    createUnifiedSourcePath() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    clone our path and add all explicitly specified FileSets as + well, patch in the jar attribute as a new fileset if it is + defined. +
    createUnifiedSources() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    clone our filesets vector, and patch in the jar attribute as a new + fileset, if is defined +
    createVmArgument() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Create a new JVM argument. +
    createVmsJavaOptionFile(String[]) - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Writes the command into a temporary DCL script and returns the + corresponding File object. +
    createWASClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Get the classpath to the websphere classpaths. +
    createWatchdog() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Create the Watchdog to kill a runaway process. +
    createWatchdog() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Create the Watchdog to kill a runaway process. +
    createWatchdog() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    createWatchdog() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
      +
    createWeblogic() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for Weblogic server. +
    createWeblogictoplink() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for Weblogic when using the Toplink + Object-Relational mapping. +
    createWebsphere() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Adds a deployment tool for Websphere 4.0 server. +
    createWLClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Get the classpath to the weblogic classpaths. +
    createWrite() - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Add text to send to the server + A subTask <write> tag was found. +
    createWrite() - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Add text to send to the server + A subTask <write> tag was found. +
    createXmlReader() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    create the XML reader. +
    createZips() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Wrapper to identify nested resource collections as ZIP + archives. +
    currBytes - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    currentElement - +Variable in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Instance variable used to store the name of the current element being + processed by the SAX parser. +
    currentFile - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
      +
    currEntry - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    currentText - +Variable in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    The text of the current element +
    currentWrapper() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    get the current runtime configurable wrapper + can return null +
    currName - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    currSize - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    CutDirsMapper - Class in org.apache.tools.ant.types.mappers
    A mapper that strips of the a configurable number of leading + directories from a file name.
    CutDirsMapper() - +Constructor for class org.apache.tools.ant.types.mappers.CutDirsMapper +
      +
    Cvs - Class in org.apache.tools.ant.taskdefs
    Performs operations on a CVS repository.
    Cvs() - +Constructor for class org.apache.tools.ant.taskdefs.Cvs +
    CVS Task - now implemented by the Abstract CVS Task base class +
    CVSEntry - Class in org.apache.tools.ant.taskdefs.cvslib
    CVS Entry.
    CVSEntry(Date, String, String) - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Creates a new instance of a CVSEntry +
    CVSPass - Class in org.apache.tools.ant.taskdefs
    Adds an new entry to a CVS password file.
    CVSPass() - +Constructor for class org.apache.tools.ant.taskdefs.CVSPass +
    Create a CVS task using the default cvspass file location. +
    CvsTagDiff - Class in org.apache.tools.ant.taskdefs.cvslib
    Examines the output of cvs rdiff between two tags.
    CvsTagDiff() - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
      +
    CvsTagEntry - Class in org.apache.tools.ant.taskdefs.cvslib
    Holds the information of a line of rdiff
    CvsTagEntry(String) - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Creates a new CvsTagEntry +
    CvsTagEntry(String, String) - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Creates a new CvsTagEntry +
    CvsTagEntry(String, String, String) - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Creates a new CvsTagEntry +
    CvsUser - Class in org.apache.tools.ant.taskdefs.cvslib
    Represents a CVS user with a userID and a full name.
    CvsUser() - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
      +
    CvsVersion - Class in org.apache.tools.ant.taskdefs.cvslib
    this task allows to find out the client and the server version of a + CVS installation + + example usage : + <cvsversion + cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + passfile="c:/programme/cygwin/home/antoine/.cvspass" + clientversionproperty="apacheclient" + serverversionproperty="apacheserver" /> + + the task can be used also in the API by calling its execute method, + then calling getServerVersion and/or getClientVersion
    CvsVersion() - +Constructor for class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
      +
    +
    +

    +D

    +
    +
    DATA_TYPE_NAME - +Static variable in class org.apache.tools.ant.types.RegularExpression +
    Name of this data type +
    DATA_TYPE_NAME - +Static variable in class org.apache.tools.ant.types.Substitution +
    The name of this data type +
    DataType - Class in org.apache.tools.ant.types
    Base class for those classes that can appear inside the build file + as stand alone data types.
    DataType() - +Constructor for class org.apache.tools.ant.types.DataType +
      +
    Date - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by last modification date.
    Date() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Date +
      +
    Date - Class in org.apache.tools.ant.types.resources.selectors
    Date ResourceSelector.
    Date() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Date +
      +
    DATE_HEADER_FORMAT - +Static variable in class org.apache.tools.ant.util.DateUtils +
    Deprecated. DateFormat is not thread safe, and we cannot guarantee that + some other code is using the format in parallel. + Deprecated since ant 1.8 +
    DATE_TYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
    date +
    DateSelector - Class in org.apache.tools.ant.types.selectors
    Selector that chooses files based on their last modified date.
    DateSelector() - +Constructor for class org.apache.tools.ant.types.selectors.DateSelector +
    Creates a new DateSelector instance. +
    DateSelector.TimeComparisons - Class in org.apache.tools.ant.types.selectors
    Enumerated attribute with the values for time comparison.
    DateSelector.TimeComparisons() - +Constructor for class org.apache.tools.ant.types.selectors.DateSelector.TimeComparisons +
      +
    DATETIME_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    DateUtils - Class in org.apache.tools.ant.util
    Helper methods to deal with date/time formatting with a specific + defined format (ISO8601) + or a plurialization correct elapsed time in minutes and seconds.
    DAVID_ORB - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    DAVID ORB. +
    DAY - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    day string +
    dbfactory - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    XML Parser factory accessible to subclasses +
    DD_SIG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    data descriptor signature +
    debug - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    DEBUG - +Static variable in class org.apache.tools.ant.types.LogLevel +
    DEBUG loglevel constant. +
    debug(String) - +Method in class org.apache.tools.ant.util.TaskLogger +
    Log a message with MSG_DEBUG priority +
    debug - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    debug - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    declareSysProperty(ExecTask, Environment.Variable) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
      +
    decodeHex(char[]) - +Static method in class org.apache.tools.ant.taskdefs.Checksum +
    Converts an array of characters representing hexadecimal values into an + array of bytes of those same values. +
    decodeUri(String) - +Static method in class org.apache.tools.ant.launch.Locator +
    Decodes an Uri with % characters. +
    decompress(String, InputStream) - +Method in class org.apache.tools.ant.taskdefs.Untar.UntarCompressionMethod +
    This method wraps the input stream with the + corresponding decompression method +
    DECREMENT_OPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    - +
    DEEP_TREE_MATCH - +Static variable in class org.apache.tools.ant.types.selectors.SelectorUtils +
    The pattern that matches an arbitrary number of directories. +
    def - +Variable in class org.apache.tools.zip.ZipOutputStream +
    This Deflater object is used for output. +
    DEFAULT - +Static variable in class org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy +
      +
    DEFAULT_ANALYZER - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The default analyzer +
    DEFAULT_ANALYZER_CLASS - +Static variable in class org.apache.tools.ant.types.optional.depend.DependScanner +
    The name of the analyzer to use by default. +
    DEFAULT_BAS45_EJB11_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
      +
    DEFAULT_BAS_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
      +
    DEFAULT_BLKSIZE - +Static variable in class org.apache.tools.tar.TarBuffer +
    Default block size +
    DEFAULT_BUFFER_SIZE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The default buffer byte size to use for IO +
    DEFAULT_BUILD_FILENAME - +Static variable in class org.apache.tools.ant.Main +
    The default build file name. +
    DEFAULT_CHECK_MILLIS - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    default check time +
    DEFAULT_CLASS_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Default location and name for the generated JUnit class file, + in the temp directory + FailedTests +
    DEFAULT_COMPILER - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    DEFAULT_COMPILER - +Static variable in class org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory +
    If the compiler has this name use a default compiler. +
    DEFAULT_COMPRESSION - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    Default compression level for deflated entries. +
    DEFAULT_COMPRESSION_LEVEL - +Static variable in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Default compression level to use, if compression is enabled via + setCompression( true ). +
    DEFAULT_DESTINATION - +Static variable in class org.apache.tools.ant.util.java15.ProxyDiagnostics +
    "http://ant.apache.org/" +
    DEFAULT_DF_FACTORY - +Static variable in class org.apache.tools.ant.taskdefs.Touch +
      +
    DEFAULT_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    The default directory: .. +
    DEFAULT_DIR_MODE - +Static variable in class org.apache.tools.ant.types.ArchiveFileSet +
    Default value for the dirmode attribute. +
    DEFAULT_DIR_MODE - +Static variable in class org.apache.tools.tar.TarEntry +
    Default permissions bits for directories +
    DEFAULT_DIR_PERM - +Static variable in interface org.apache.tools.zip.UnixStat +
    Default permissions for directories. +
    DEFAULT_FILE_MODE - +Static variable in class org.apache.tools.ant.types.ArchiveFileSet +
    Default value for the filemode attribute. +
    DEFAULT_FILE_MODE - +Static variable in class org.apache.tools.tar.TarEntry +
    Default permissions bits for files +
    DEFAULT_FILE_PERM - +Static variable in interface org.apache.tools.zip.UnixStat +
    Default permissions for plain files. +
    DEFAULT_FILENAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    the default file name: TESTS-TestSuites.xml +
    DEFAULT_FTP_PORT - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Default port for FTP +
    DEFAULT_FTP_PORT - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Default port for FTP +
    DEFAULT_HOST - +Static variable in class org.apache.tools.mail.MailMessage +
    default mailhost +
    DEFAULT_LINK_PERM - +Static variable in interface org.apache.tools.zip.UnixStat +
    Default permissions for symbolic links. +
    DEFAULT_MANIFEST_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    Default Manifest version if one is not specified +
    DEFAULT_MAX_WAIT_MILLIS - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    default wait time +
    DEFAULT_MODE - +Static variable in class org.apache.tools.ant.util.UUEncoder +
      +
    DEFAULT_ORB - +Static variable in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Description of the Field +
    DEFAULT_PORT - +Static variable in class org.apache.tools.mail.MailMessage +
    default port for SMTP: 25 +
    DEFAULT_RCDSIZE - +Static variable in class org.apache.tools.tar.TarBuffer +
    Default record size +
    DEFAULT_TASK - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault +
    The default task +
    DEFAULT_TIMEOUT - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    The default timeout. +
    DEFAULT_TIMEOUT_MILLIS - +Static variable in class org.apache.tools.ant.util.OutputStreamFunneler +
    Default timeout. +
    DEFAULT_TOKEN_END - +Static variable in class org.apache.tools.ant.types.FilterSet +
    The default token end string +
    DEFAULT_TOKEN_START - +Static variable in class org.apache.tools.ant.types.FilterSet +
    The default token start string +
    DEFAULT_WL51_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    DEFAULT_WL51_EJB11_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 5.1 dtd location +
    DEFAULT_WL60_51_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    DEFAULT_WL60_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    DEFAULT_WL60_EJB11_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 6.0 ejb 1.1 dtd location +
    DEFAULT_WL60_EJB20_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 6.0 ejb 2.0 dtd location +
    DEFAULT_WL70_DTD_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    DefaultCompilerAdapter - Class in org.apache.tools.ant.taskdefs.compilers
    This is the default implementation for the CompilerAdapter interface.
    DefaultCompilerAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    DEFAULTEXCLUDES - +Static variable in class org.apache.tools.ant.DirectoryScanner +
    Deprecated. since 1.6.x. + Use the getDefaultExcludes + method instead. +
    DefaultExcludes - Class in org.apache.tools.ant.taskdefs
    Alters the default excludes for the entire build..
    DefaultExcludes() - +Constructor for class org.apache.tools.ant.taskdefs.DefaultExcludes +
      +
    DefaultExecutor - Class in org.apache.tools.ant.helper
    Default Target executor implementation.
    DefaultExecutor() - +Constructor for class org.apache.tools.ant.helper.DefaultExecutor +
      +
    defaultInput(byte[], int, int) - +Method in class org.apache.tools.ant.Project +
    Read data from the default input stream. +
    DefaultInputHandler - Class in org.apache.tools.ant.input
    Prompts on System.err, reads input from System.in
    DefaultInputHandler() - +Constructor for class org.apache.tools.ant.input.DefaultInputHandler +
    Empty no-arg constructor +
    DefaultJspCompilerAdapter - Class in org.apache.tools.ant.taskdefs.optional.jsp.compilers
    This is the default implementation for the JspCompilerAdapter interface.
    DefaultJspCompilerAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
      +
    DefaultLogger - Class in org.apache.tools.ant
    Writes build events to a PrintStream.
    DefaultLogger() - +Constructor for class org.apache.tools.ant.DefaultLogger +
    Sole constructor. +
    DefaultNative2Ascii - Class in org.apache.tools.ant.taskdefs.optional.native2ascii
    encapsulates the handling common to diffent Native2Asciiadapter + implementations.
    DefaultNative2Ascii() - +Constructor for class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii +
    No-arg constructor. +
    DefaultRmicAdapter - Class in org.apache.tools.ant.taskdefs.rmic
    This is the default implementation for the RmicAdapter interface.
    DefaultRmicAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Default constructor +
    DefBase - Class in org.apache.tools.ant.taskdefs
    Base class for Definitions handling uri and class loading.
    DefBase() - +Constructor for class org.apache.tools.ant.taskdefs.DefBase +
      +
    defineClassFromData(File, byte[], String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Define a class given its bytes +
    definePackage(File, String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Define the package information associated with a class. +
    definePackage(File, String, Manifest) - +Method in class org.apache.tools.ant.AntClassLoader +
    Define the package information when the class comes from a + jar with a manifest +
    Definer - Class in org.apache.tools.ant.taskdefs
    Base class for Taskdef and Typedef - handles all + the attributes for Typedef.
    Definer() - +Constructor for class org.apache.tools.ant.taskdefs.Definer +
      +
    Definer.Format - Class in org.apache.tools.ant.taskdefs
    Enumerated type for format attribute
    Definer.Format() - +Constructor for class org.apache.tools.ant.taskdefs.Definer.Format +
      +
    Definer.OnError - Class in org.apache.tools.ant.taskdefs
    Enumerated type for onError attribute
    Definer.OnError() - +Constructor for class org.apache.tools.ant.taskdefs.Definer.OnError +
    Constructor +
    Definer.OnError(String) - +Constructor for class org.apache.tools.ant.taskdefs.Definer.OnError +
    Constructor using a string. +
    deflate() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes next block of compressed data to the output stream. +
    DEFLATED - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    Compression method for deflated entries. +
    DEL_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    DEL_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    DelegatedResourceComparator - Class in org.apache.tools.ant.types.resources.comparators
    Delegates to other ResourceComparators or, if none specified, + uses Resources' natural ordering.
    DelegatedResourceComparator() - +Constructor for class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
      +
    delegateIteratorToList() - +Method in class org.apache.tools.ant.types.Path +
    Helps determine whether to preserve BC by calling list() on subclasses. +
    Delete - Class in org.apache.tools.ant.taskdefs
    Deletes a file or directory, or set of files defined by a fileset.
    Delete() - +Constructor for class org.apache.tools.ant.taskdefs.Delete +
      +
    delete() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Delete a symlink. +
    delete() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Deletes the cache. +
    delete() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Deletes the cache and its underlying file. +
    delete(File) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Delete the file with File.delete() if the argument is not null. +
    DELETE_OPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    del +
    deleteDir(File) - +Method in class org.apache.tools.ant.taskdefs.Move +
    Go and delete the directory tree. +
    deleteDir(File, boolean) - +Method in class org.apache.tools.ant.taskdefs.Move +
    Go and delete the directory tree. +
    deleteEmptyJavaFiles() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    delete any java output files that are empty + this is to get around a little defect in jasper: when it + fails, it leaves incomplete files around. +
    deleteSymbolicLink(File, Task) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Delete a symlink (without deleting the associated resource). +
    deleteSymlink(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead +
    deleteSymlink(File) - +Static method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead +
    delFile(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Delete a file from the remote host. +
    delFile(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Delete a file from the remote host. +
    Deltree - Class in org.apache.tools.ant.taskdefs
    Deprecated. The deltree task is deprecated since Ant 1.2. Use + delete instead.
    Deltree() - +Constructor for class org.apache.tools.ant.taskdefs.Deltree +
    Deprecated.   +
    demuxFlush(String, boolean) - +Method in class org.apache.tools.ant.Project +
    Demultiplex flush operations so that each task receives the appropriate + messages. +
    demuxInput(byte[], int, int) - +Method in class org.apache.tools.ant.Project +
    Demux an input request to the correct task. +
    DemuxInputStream - Class in org.apache.tools.ant
    Passes input requests to the project object for demuxing into + individual tasks and threads.
    DemuxInputStream(Project) - +Constructor for class org.apache.tools.ant.DemuxInputStream +
    Create a DemuxInputStream for the given project +
    demuxOutput(String, boolean) - +Method in class org.apache.tools.ant.Project +
    Demultiplex output so that each task receives the appropriate + messages. +
    DemuxOutputStream - Class in org.apache.tools.ant
    Logs content written by a thread and forwards the buffers onto the + project object which will forward the content to the appropriate + task.
    DemuxOutputStream(Project, boolean) - +Constructor for class org.apache.tools.ant.DemuxOutputStream +
    Creates a new instance of this class. +
    depend - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    Depend - Class in org.apache.tools.ant.taskdefs.optional.depend
    Generates a dependency file for a given set of classes.
    Depend() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.Depend +
      +
    DependencyAnalyzer - Interface in org.apache.tools.ant.util.depend
    A dependency analyzer analyzes dependencies between Java classes to + determine the minimal set of classes which are required by a set of + "root" classes.
    DependencyVisitor - Class in org.apache.tools.ant.util.depend.bcel
    A BCEL visitor implementation to collect class dependency information
    DependencyVisitor() - +Constructor for class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
      +
    DependScanner - Class in org.apache.tools.ant.types.optional.depend
    DirectoryScanner for finding class dependencies.
    DependScanner(DirectoryScanner) - +Constructor for class org.apache.tools.ant.types.optional.depend.DependScanner +
    Create a DependScanner, using the given scanner to provide the basic + set of files from which class files come. +
    DependSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on whether they are newer than + a matching file in another directory tree.
    DependSelector() - +Constructor for class org.apache.tools.ant.types.selectors.DependSelector +
    Creates a new DependSelector instance. +
    DependSet - Class in org.apache.tools.ant.taskdefs
    Examines and removes out of date target files.
    DependSet() - +Constructor for class org.apache.tools.ant.taskdefs.DependSet +
      +
    dependsOn(String) - +Method in class org.apache.tools.ant.Target +
    Does this target depend on the named target? +
    deploy() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Perform the actual deployment. +
    deploy() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Perform the actual deployment. +
    deploy() - +Method in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    Perform the actual deployment. +
    deploy() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Perform the actual deployment. +
    deprecation - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    depth() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
    The depth (or length) of a path. +
    depth() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    The depth (or length) of a pattern. +
    DEPTH_THRESH - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    DepthSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on the how deep in the directory + tree they are.
    DepthSelector() - +Constructor for class org.apache.tools.ant.types.selectors.DepthSelector +
    Creates a new DepthSelector instance. +
    desc - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
      +
    describeArguments() - +Method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeArguments(Commandline) - +Static method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeArguments(String[]) - +Static method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeArguments(String[], int) - +Static method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeCommand() - +Method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeCommand(Commandline) - +Static method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeCommand(String[]) - +Static method in class org.apache.tools.ant.types.Commandline +
    Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeCommand() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +
    describeJavaCommand() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Return a String that describes the java command and arguments + for in-VM executions. +
    description - +Variable in class org.apache.tools.ant.ProjectComponent +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. +
    description - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
      +
    Description - Class in org.apache.tools.ant.types
    Description is used to provide a project-wide description element + (that is, a description that applies to a buildfile as a whole).
    Description() - +Constructor for class org.apache.tools.ant.types.Description +
      +
    DESCRIPTOR - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
    Naming scheme where the generated jar name is based on the name of + the deployment descriptor file +
    DescriptorHandler - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Inner class used by EjbJar to facilitate the parsing of deployment + descriptors and the capture of appropriate information.
    DescriptorHandler(Task, File) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Constructor for DescriptorHandler. +
    dest - +Variable in class org.apache.tools.ant.taskdefs.Unpack +
      +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    destination directory +
    destDir - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    the output directory when using paths. +
    destFile - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    determineDependencies(Vector, Vector) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.AntAnalyzer +
    Determine the dependencies of the configured root classes. +
    determineDependencies(Vector, Vector) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Determine the dependencies of the current set of root classes +
    determineDependencies(Vector, Vector) - +Method in class org.apache.tools.ant.util.depend.bcel.AncestorAnalyzer +
    Determine the dependencies of the configured root classes. +
    determineDependencies(Vector, Vector) - +Method in class org.apache.tools.ant.util.depend.bcel.FullAnalyzer +
    Determine the dependencies of the configured root classes. +
    DEVLEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the devices field in a header buffer. +
    DeweyDecimal - Class in org.apache.tools.ant.taskdefs.optional.extension
    Deprecated. use org.apache.tools.ant.util.DeweyDecimal instead. + Deprecated since ant 1.8
    DeweyDecimal(int[]) - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.DeweyDecimal +
    Deprecated. Construct a DeweyDecimal from an array of integer components. +
    DeweyDecimal(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.DeweyDecimal +
    Deprecated. Construct a DeweyDecimal from string in DeweyDecimal format. +
    DeweyDecimal - Class in org.apache.tools.ant.util
    Utility class to contain version numbers in "Dewey Decimal" + syntax.
    DeweyDecimal(int[]) - +Constructor for class org.apache.tools.ant.util.DeweyDecimal +
    Construct a DeweyDecimal from an array of integer components. +
    DeweyDecimal(String) - +Constructor for class org.apache.tools.ant.util.DeweyDecimal +
    Construct a DeweyDecimal from string in DeweyDecimal format. +
    diagnoseCreationFailure(String, String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Handler called to do decent diagnosis on instantiation failure. +
    Diagnostics - Class in org.apache.tools.ant
    A little diagnostic helper that output some information that may help + in support.
    DiagnosticsTask - Class in org.apache.tools.ant.taskdefs
    This is a task that hands off work to the Diagnostics module.
    DiagnosticsTask() - +Constructor for class org.apache.tools.ant.taskdefs.DiagnosticsTask +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.AntFilterReader +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
      +
    dieOnCircularReference() - +Method in class org.apache.tools.ant.types.DataType +
    Convenience method. +
    dieOnCircularReference(Project) - +Method in class org.apache.tools.ant.types.DataType +
    Convenience method. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.DataType +
    Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.FilterChain +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.Path +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.PropertySet +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.Archives +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
    Overrides the version from DataType to recurse on nested ResourceSelector +s. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.comparators.Reverse +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.Resources +
    Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.Restrict +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Overrides the version from DataType + to recurse on nested ResourceComparators. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Overrides the version from DataType to recurse on nested ResourceSelectors. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.Sort +
    Overrides the BaseResourceCollectionContainer version + to recurse on nested ResourceComparators. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.resources.Tokens +
    Overrides the BaseResourceCollectionContainer version + to check the nested Tokenizer. +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
      +
    dieOnCircularReference(Stack, Project) - +Method in class org.apache.tools.ant.types.XMLCatalog +
      +
    Difference - Class in org.apache.tools.ant.types.resources
    ResourceCollection representing the difference between + two or more nested ResourceCollections.
    Difference() - +Constructor for class org.apache.tools.ant.types.resources.Difference +
      +
    DifferentSelector - Class in org.apache.tools.ant.types.selectors
    This selector selects files against a mapped set of target files, selecting + all those files which are different.
    DifferentSelector() - +Constructor for class org.apache.tools.ant.types.selectors.DifferentSelector +
      +
    DigestAlgorithm - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Computes a 'hashvalue' for the content of file using + java.security.MessageDigest.
    DigestAlgorithm() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
      +
    dir - +Variable in class org.apache.tools.ant.taskdefs.Delete +
      +
    DIR - +Static variable in class org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth +
    Dir value +
    DIR - +Static variable in class org.apache.tools.ant.types.resources.selectors.Type +
    Static dir type selector. +
    DIR - +Static variable in class org.apache.tools.ant.types.selectors.TypeSelector.FileType +
    the string value for dir +
    DIR_FLAG - +Static variable in interface org.apache.tools.zip.UnixStat +
    Indicates directories. +
    dirCopyMap - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    DIRECTORY - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
    Naming scheme where the generated jar name is based on the + name of the directory containing the deployment descriptor +
    Directory - Class in org.apache.tools.ant.taskdefs.optional.ssh
    A helper object for Scp representing a directory in a file system.
    Directory(File) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Constructor for a Directory. +
    Directory(File, Directory) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Constructor for a Directory. +
    DirectoryIterator - Class in org.apache.tools.ant.taskdefs.optional.depend
    An iterator which iterates through the contents of a java directory.
    DirectoryIterator(File, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.DirectoryIterator +
    Creates a directory iterator. +
    directoryIterator() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get an iterator over the child Directories. +
    DirectoryScanner - Class in org.apache.tools.ant
    Class for scanning a directory for files/directories which match certain + criteria.
    DirectoryScanner() - +Constructor for class org.apache.tools.ant.DirectoryScanner +
    Sole constructor. +
    Dirname - Class in org.apache.tools.ant.taskdefs
    Determines the directory name of the specified file.
    Dirname() - +Constructor for class org.apache.tools.ant.taskdefs.Dirname +
      +
    dirsDeselected - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The directories which matched at least one include and no excludes + but which a selector discarded. +
    DirSet - Class in org.apache.tools.ant.types
    Subclass as hint for supporting tasks that the included directories + instead of files should be used.
    DirSet() - +Constructor for class org.apache.tools.ant.types.DirSet +
    Constructor for DirSet. +
    DirSet(DirSet) - +Constructor for class org.apache.tools.ant.types.DirSet +
    Constructor for DirSet, with DirSet to shallowly clone. +
    dirsExcluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The directories which matched at least one include and at least one + exclude. +
    dirsIncluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The directories which matched at least one include and no excludes + and were selected. +
    dirsNotIncluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The directories which were found and did not match any includes. +
    DISCLAIMER - +Static variable in class org.apache.tools.ant.types.Commandline +
      +
    Dispatchable - Interface in org.apache.tools.ant.dispatch
    Classes implementing this interface specify the + name of the parameter that contains the name + of the task's method to execute.
    DispatchTask - Class in org.apache.tools.ant.dispatch
    Tasks extending this class may contain multiple actions.
    DispatchTask() - +Constructor for class org.apache.tools.ant.dispatch.DispatchTask +
      +
    DispatchUtils - Class in org.apache.tools.ant.dispatch
    Determines and Executes the action method for the task.
    DispatchUtils() - +Constructor for class org.apache.tools.ant.dispatch.DispatchUtils +
      +
    dissect(String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Dissect the specified absolute path. +
    dname - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    document - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    the xml document to process +
    DOES_NOT_EXIST_POSTFIX - +Static variable in class org.apache.tools.ant.DirectoryScanner +
    The end of the exception message if something that should be + there doesn't exist. +
    doesHandledirSep() - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Whether the difference between / and \ (the two common + directory characters) is ignored. +
    doesTypeExist(String) - +Method in class org.apache.tools.ant.taskdefs.condition.TypeFound +
    test for a task or other ant type existing in the current project +
    doFileOperations() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Actually does the file (and possibly empty directory) copies. +
    doFileOperations() - +Method in class org.apache.tools.ant.taskdefs.Move +
    Override copy's doFileOperations to move the files instead of copying them. +
    doFTP() - +Method in interface org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirror +
      +
    doFTP() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
      +
    doGet(int, Get.DownloadProgress) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Deprecated. only gets the first configured resource +
    doGet(URL, File, int, Get.DownloadProgress) - +Method in class org.apache.tools.ant.taskdefs.Get +
    make a get request, with the supplied progress and logging info. +
    DOMElementWriter - Class in org.apache.tools.ant.util
    Writes a DOM tree to a given Writer.
    DOMElementWriter() - +Constructor for class org.apache.tools.ant.util.DOMElementWriter +
    Create an element writer. +
    DOMElementWriter(boolean) - +Constructor for class org.apache.tools.ant.util.DOMElementWriter +
    Create an element writer + XML namespaces will be ignored. +
    DOMElementWriter(boolean, DOMElementWriter.XmlNamespacePolicy) - +Constructor for class org.apache.tools.ant.util.DOMElementWriter +
    Create an element writer + XML namespaces will be ignored. +
    DOMElementWriter.XmlNamespacePolicy - Class in org.apache.tools.ant.util
    Whether namespaces should be ignored for elements and attributes.
    DOMElementWriter.XmlNamespacePolicy(boolean, boolean) - +Constructor for class org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy +
      +
    DOMUtil - Class in org.apache.tools.ant.taskdefs.optional.junit
    Some utilities that might be useful when manipulating DOM trees.
    DOMUtil.NodeFilter - Interface in org.apache.tools.ant.taskdefs.optional.junit
    Filter interface to be applied when iterating over a DOM tree.
    DOMUtil.NodeListImpl - Class in org.apache.tools.ant.taskdefs.optional.junit
    custom implementation of a nodelist
    DOMUtil.NodeListImpl() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeListImpl +
      +
    DOMUtils - Class in org.apache.tools.ant.util
    Some utility methods for common tasks when building DOM trees in memory.
    DOMUtils() - +Constructor for class org.apache.tools.ant.util.DOMUtils +
      +
    doReplace(RegularExpression, Substitution, String, int) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Invoke a regular expression (r) on a string (input) using + substitutions (s) for a matching regex. +
    doReplace(File, int) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Perform the replacement on a file +
    doReport(PrintStream) - +Static method in class org.apache.tools.ant.Diagnostics +
    Print a report to the given stream. +
    doReport(PrintStream, int) - +Static method in class org.apache.tools.ant.Diagnostics +
    Print a report to the given stream. +
    doResourceOperations(Map) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Actually does the resource copies. +
    doSiteCommand(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sends a site command to the ftp server +
    doSiteCommand(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Sends a site command to the ftp server +
    doSleep(long) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    sleep for a period of time +
    DoubleCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    The constant pool entry subclass used to represent double constant + values.
    DoubleCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.DoubleCPInfo +
    Constructor +
    doubleFilePass - +Variable in class org.apache.tools.ant.taskdefs.Zip +
    If this flag is true, execute() will run most operations twice, + the first time with skipWriting set to + true and the second time with setting it to false. +
    doValidate(File) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    parse the file +
    Draw - Class in org.apache.tools.ant.types.optional.image
     
    Draw() - +Constructor for class org.apache.tools.ant.types.optional.image.Draw +
      +
    DrawOperation - Interface in org.apache.tools.ant.types.optional.image
    Interface which represents an Operation which is "drawable", such + as a Rectangle, Circle or Text.
    DTDLocation - Class in org.apache.tools.ant.types
    Helper class to handle the DTD nested element.
    DTDLocation() - +Constructor for class org.apache.tools.ant.types.DTDLocation +
      +
    duplicate - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    DynamicAttribute - Interface in org.apache.tools.ant
    Enables a task to control unknown attributes
    DynamicAttributeNS - Interface in org.apache.tools.ant
    Enables a task to control unknown attributes.
    DynamicConfigurator - Interface in org.apache.tools.ant
    Enables a task to control unknown attributes and elements.
    DynamicConfiguratorNS - Interface in org.apache.tools.ant
    Enables a task to control unknown attributes and elements.
    DynamicElement - Interface in org.apache.tools.ant
    Enables a task to control unknown elements.
    DynamicElementNS - Interface in org.apache.tools.ant
    Enables a task to control unknown elements.
    +
    +

    +E

    +
    +
    Ear - Class in org.apache.tools.ant.taskdefs
    Creates a EAR archive.
    Ear() - +Constructor for class org.apache.tools.ant.taskdefs.Ear +
    Create an Ear task. +
    Echo - Class in org.apache.tools.ant.taskdefs
    Writes a message to the Ant logging facilities.
    Echo() - +Constructor for class org.apache.tools.ant.taskdefs.Echo +
      +
    Echo.EchoLevel - Class in org.apache.tools.ant.taskdefs
    The enumerated values for the level attribute.
    Echo.EchoLevel() - +Constructor for class org.apache.tools.ant.taskdefs.Echo.EchoLevel +
      +
    EchoProperties - Class in org.apache.tools.ant.taskdefs.optional
    Displays all the current properties in the build.
    EchoProperties() - +Constructor for class org.apache.tools.ant.taskdefs.optional.EchoProperties +
      +
    EchoProperties.FormatAttribute - Class in org.apache.tools.ant.taskdefs.optional
    A enumerated type for the format attribute.
    EchoProperties.FormatAttribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.EchoProperties.FormatAttribute +
      +
    EchoXML - Class in org.apache.tools.ant.taskdefs
    Echo XML.
    EchoXML() - +Constructor for class org.apache.tools.ant.taskdefs.EchoXML +
      +
    EchoXML.NamespacePolicy - Class in org.apache.tools.ant.taskdefs
     
    EchoXML.NamespacePolicy() - +Constructor for class org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy +
      +
    EchoXML.NamespacePolicy(String) - +Constructor for class org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy +
      +
    EFS_FLAG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    Deprecated. use ZipOutputStream.UFT8_NAMES_FLAG instead +
    EJB_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Name for EJB Deployment descriptor within EJB jars +
    EJB_JAR_1_1_DTD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Name of the standard deployment descriptor DTD (these files are stored in + the ${JONAS_ROOT}/xml directory). +
    EJB_JAR_1_1_PUBLIC_ID - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Public Id of the standard deployment descriptor DTD. +
    EJB_JAR_2_0_DTD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
      +
    EJB_JAR_2_0_PUBLIC_ID - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
      +
    EJB_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
    Naming scheme where generated jar is determined from the ejb-name in + the deployment descripor +
    EJBDeploymentTool - Interface in org.apache.tools.ant.taskdefs.optional.ejb
    The interface to implement for deployment tools.
    ejbFiles - +Variable in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Instance variable that stores the names of the files as they will be + put into the jar file, mapped to File objects Accessed by the SAX + parser call-back method characters(). +
    EjbJar - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Provides automated EJB JAR file creation.
    EjbJar() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
      +
    EjbJar.CMPVersion - Class in org.apache.tools.ant.taskdefs.optional.ejb
    CMP versions supported + valid CMP versions are 1.0 and 2.0
    EjbJar.CMPVersion() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion +
      +
    EjbJar.DTDLocation - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Inner class used to record information about the location of a local DTD
    EjbJar.DTDLocation() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.DTDLocation +
      +
    EjbJar.NamingScheme - Class in org.apache.tools.ant.taskdefs.optional.ejb
    An EnumeratedAttribute class for handling different EJB jar naming + schemes
    EjbJar.NamingScheme() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
      +
    ejbName - +Variable in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Instance variable that stores the value found in the <ejb-name> element +
    elements() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BatchTest +
    Return all JUnitTest instances obtain by applying the fileset rules. +
    elements() - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Get a enumeration over the elements. +
    elements() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    Ellipse - Class in org.apache.tools.ant.types.optional.image
    Draw an ellipse.
    Ellipse() - +Constructor for class org.apache.tools.ant.types.optional.image.Ellipse +
      +
    emacsMode - +Variable in class org.apache.tools.ant.DefaultLogger +
    Whether or not to use emacs-style output +
    emacsMode - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    EmailAddress - Class in org.apache.tools.ant.taskdefs.email
    Holds an email address.
    EmailAddress() - +Constructor for class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Creates an empty email address +
    EmailAddress(String) - +Constructor for class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Creates a new email address based on the given string +
    EmailTask - Class in org.apache.tools.ant.taskdefs.email
    A task to send SMTP email.
    EmailTask() - +Constructor for class org.apache.tools.ant.taskdefs.email.EmailTask +
      +
    EmailTask.Encoding - Class in org.apache.tools.ant.taskdefs.email
    Enumerates the encoding constants.
    EmailTask.Encoding() - +Constructor for class org.apache.tools.ant.taskdefs.email.EmailTask.Encoding +
      +
    EMPTY_ITERATOR - +Static variable in class org.apache.tools.ant.types.resources.Resources +
    static empty Iterator +
    EMPTY_LIST - +Static variable in class org.apache.tools.ant.util.CollectionUtils +
    Collections.emptyList() is Java5+. +
    EMPTY_PATH - +Static variable in class org.apache.tools.ant.types.selectors.TokenizedPath +
    Instance that holds no tokens at all. +
    EMPTY_PATTERN - +Static variable in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Instance that holds no tokens at all. +
    emptyBehavior - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    emptyChangeList - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
      +
    ENABLE_TESTLISTENER_EVENTS - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Name of magic property that enables test listener events. +
    enableJAXP12SchemaValidation() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    Set schema attributes in a JAXP 1.2 engine. +
    enableProxies() - +Method in class org.apache.tools.ant.util.ProxySetup +
    turn proxies on; + if the proxy key is already set to some value: leave alone. +
    enableXercesSchemaValidation() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    Turn on XSD support in Xerces. +
    encode(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName +
    Encode a name or value. +
    encode(String) - +Method in class org.apache.tools.ant.util.Base64Converter +
    Encode a string into base64 encoding. +
    encode(byte[]) - +Method in class org.apache.tools.ant.util.Base64Converter +
    Encode a byte array into base64 encoding. +
    encode(String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Escape <, > & ', " as their entities and + drop characters that are illegal in XML documents. +
    encode(InputStream, OutputStream) - +Method in class org.apache.tools.ant.util.UUEncoder +
    UUEncode bytes from the input stream, and write them as text characters + to the output stream. +
    encodeAttributeValue(String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Escape <, > & ', " as their entities, \n, + \r and \t as numeric entities and drop characters that are + illegal in XML documents. +
    encodedata(String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Drop characters that are illegal in XML documents. +
    encodeURI(String) - +Static method in class org.apache.tools.ant.launch.Locator +
    Encodes an Uri with % characters. +
    encoding - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    endDownload() - +Method in interface org.apache.tools.ant.taskdefs.Get.DownloadProgress +
    end a download +
    endDownload() - +Method in class org.apache.tools.ant.taskdefs.Get.NullProgress +
    end a download +
    endDownload() - +Method in class org.apache.tools.ant.taskdefs.Get.VerboseProgress +
    end a download +
    endElement(String, String, String) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Handles the end of an element. +
    endElement(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    SAX parser call-back method that is invoked when an element is exited. +
    endExecution() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    any cleanup logic +
    endPrefixMapping(String) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    End of prefix to uri mapping. +
    endPrefixMapping(String) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    End a namepace prefix to uri mapping +
    endsWith(String) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    true if the last token equals the given string. +
    endsWith(StringBuffer, String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Checks that a string buffer ends up with a given string. +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    A test ended. +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Interface TestListener. +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Interface TestListener. +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Empty +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    endTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Interface TestListener. +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    The whole testsuite ended. +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + The whole testsuite ended. +
    endTestSuite(JUnitTest) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +
    The whole testsuite ended. +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    The whole testsuite ended. +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    The whole testsuite ended. +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    endTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    The whole testsuite ended. +
    enterAntLib(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Called at the start of processing an antlib. +
    enterScope() - +Method in class org.apache.tools.ant.property.LocalProperties +
    enter the scope +
    enterScope() - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Enter the local scope. +
    entries - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    entryOffset - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    entrySet() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    entrySize - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    EnumeratedAttribute - Class in org.apache.tools.ant.types
    Helper class for attributes that can only take one of a fixed list + of values.
    EnumeratedAttribute() - +Constructor for class org.apache.tools.ant.types.EnumeratedAttribute +
    bean constructor +
    Enumerations - Class in org.apache.tools.ant.taskdefs.optional.junit
    A couple of methods related to enumerations that might be useful.
    env - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    Environment - Class in org.apache.tools.ant.types
    Wrapper for environment variables.
    Environment() - +Constructor for class org.apache.tools.ant.types.Environment +
    constructor +
    Environment.Variable - Class in org.apache.tools.ant.types
    representation of a single env value
    Environment.Variable() - +Constructor for class org.apache.tools.ant.types.Environment.Variable +
    Constructor for variable +
    EOCD_SIG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    end of central dir signature +
    EOL - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The End-Of-Line marker in manifests +
    EQUAL - +Static variable in class org.apache.tools.ant.types.Comparison +
    Equal Comparison. +
    EQUAL - +Static variable in class org.apache.tools.ant.types.TimeComparison +
    Equal Comparison. +
    EqualComparator - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Simple implementation of Comparator for use in CacheSelector.
    EqualComparator() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.EqualComparator +
      +
    equals(Object) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove +
    Equality depending in the index. +
    equals(Object) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.CrLf +
    Equality depending in the index. +
    equals(Object) - +Method in class org.apache.tools.ant.Location +
    Equality operation. +
    Equals - Class in org.apache.tools.ant.taskdefs.condition
    Simple comparison condition.
    Equals() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Equals +
      +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
    equality method +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    equality method. +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
    equality method +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
      +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
      +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
      +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos +
      +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    equality test checks namespace, location and filename. +
    equals(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    The equality method. +
    equals(Object) - +Method in class org.apache.tools.ant.types.Resource +
    Implement basic Resource equality. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Compare another Object to this ArchiveResource for equality. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
    Equality method based on the vector of resources, + or if a reference, the referredto object. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.comparators.ResourceComparator +
    Test for equality with this ResourceComparator. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Compare another Object to this FileResource for equality. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.MappedResource +
    Equality check based on the resource's name in addition to the + resource itself. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Override to implement equality with equivalent Resources, + since we are capable of proxying them. +
    equals(Object) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Test whether an Object equals this URLResource. +
    equals(Object) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
    true if the original paths are equal. +
    equals(Object) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    true if the original patterns are equal. +
    equals(Vector, Vector) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Deprecated. since 1.6.x. +
    equals(Dictionary, Dictionary) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Deprecated. since 1.6.x. +
    equals(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    equals(TarEntry) - +Method in class org.apache.tools.tar.TarEntry +
    Determine if the two entries are equal. +
    equals(Object) - +Method in class org.apache.tools.tar.TarEntry +
    Determine if the two entries are equal. +
    equals(Object) - +Method in class org.apache.tools.zip.ZipEntry +
    The equality method. +
    equals(Object) - +Method in class org.apache.tools.zip.ZipLong +
    Override to make two instances with same value equal. +
    equals(Object) - +Method in class org.apache.tools.zip.ZipShort +
    Override to make two instances with same value equal. +
    EQUALS_OPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    = +
    err - +Variable in class org.apache.tools.ant.DefaultLogger +
    PrintStream to write error messages to +
    ERR - +Static variable in class org.apache.tools.ant.types.LogLevel +
    ERR loglevel constant. +
    error - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    ERROR - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the error element +
    error(TransformerException) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Log an error. +
    error(SAXParseException) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
    receive notification of a recoverable error +
    error(String) - +Method in class org.apache.tools.ant.util.TaskLogger +
    Log a message with MSG_ERR priority +
    ERROR_BAD_MAP - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "Cannot map source file to anything sensible: " +
    ERROR_BAD_TIMEOUT - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error when invalid timeout value is defined +
    ERROR_BAD_URL - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error message when an invalid url is used. +
    ERROR_BASE_NOT_SET - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    base attribute not set message +
    ERROR_BOTH_ATTRIBUTES - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    error - combined attributes not allowed +
    ERROR_BOTH_TARGETS - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error message when url and host are specified. +
    ERROR_DUPLICATE_SCHEMA - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    Duplicate declaration of schema +
    ERROR_FILE_AND_SRCDIR - +Static variable in class org.apache.tools.ant.taskdefs.FixCRLF +
    error string for using srcdir and file +
    ERROR_FROM_FORBIDDEN - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    Error for attributes +
    ERROR_IGNORING_COMPILER_OPTION - +Static variable in class org.apache.tools.ant.taskdefs.Apt +
    An warning message when ignoring compiler attribute. +
    ERROR_INVALID_TIMEOUT - +Static variable in class org.apache.tools.ant.util.Watchdog +
    Error string. +
    ERROR_LOADING_CAUSED_EXCEPTION - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    loaded error message +
    ERROR_MAPPER_WITHOUT_DEST - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "The destDir attribute is required if a mapper is set" +
    ERROR_MISSING_FILE - +Static variable in class org.apache.tools.ant.taskdefs.MakeUrl +
    Missing file +
    ERROR_MULTIPLE_MAPPERS - +Static variable in class org.apache.tools.ant.taskdefs.Expand +
    Error message when more that one mapper is defined +
    ERROR_NO_ALIAS - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "alias attribute must be set" +
    ERROR_NO_ATTRIBUTES - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    error - missing attribute +
    ERROR_NO_BASE_EXISTS - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    base not exists message +
    ERROR_NO_DESTDIR - +Static variable in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. No destdir attribute +
    ERROR_NO_FILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    File not found +
    ERROR_NO_FILE - +Static variable in class org.apache.tools.ant.taskdefs.VerifyJar +
    no file message "Not found :" +
    ERROR_NO_FILES - +Static variable in class org.apache.tools.ant.taskdefs.MakeUrl +
    No files defined +
    ERROR_NO_HOST_IN_URL - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error message when no hostname in url. +
    ERROR_NO_HOSTNAME - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error when no hostname is defined +
    ERROR_NO_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    No location provided +
    ERROR_NO_MAPPER - +Static variable in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. No mapper +
    ERROR_NO_PATH - +Static variable in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. No path +
    ERROR_NO_PROPERTY - +Static variable in class org.apache.tools.ant.taskdefs.MakeUrl +
    No property defined +
    ERROR_NO_RMIC_ON_CLASSPATH - +Static variable in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    Error message to use with the sun rmic is not the classpath. +
    ERROR_NO_SOURCE - +Static variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    error string for unit test verification: "jar must be set through jar attribute or nested filesets" +
    ERROR_NO_STOREPASS - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "storepass attribute must be set" +
    ERROR_NO_TASK - +Static variable in class org.apache.tools.ant.util.WorkerAnt +
    Error message if invoked with no task +
    ERROR_NO_URI - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    No namespace URI +
    ERROR_NO_URL_REPRESENTATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Cannot make URL +
    ERROR_NO_VALUE - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    error - no value +
    ERROR_NO_VERIFY - +Static variable in class org.apache.tools.ant.taskdefs.VerifyJar +
    Error output if there is a failure to verify the jar. +
    ERROR_NO_WLRMIC_ON_CLASSPATH - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    The error string to use if not able to find the weblogic rmic +
    ERROR_NO_XSD_SUPPORT - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    schema features not supported +
    ERROR_NOT_A_DIR - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    base not a directory message +
    ERROR_NOT_DEFINED - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    not defined message +
    ERROR_NOT_FILE_URI - +Static variable in class org.apache.tools.ant.launch.Locator +
    Error string used when an invalid uri is seen +
    ERROR_NOT_FOUND - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    could not be found message +
    ERROR_NOT_RMIC_ADAPTER - +Static variable in class org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory +
    The error message to be used when the class is not an rmic adapter. +
    ERROR_ON_NETWORK - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Network error message is seen. +
    ERROR_PARSER_CREATION_FAILURE - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    unable to create parser +
    ERROR_PROPERTY_ACCESS_BLOCKED - +Static variable in class org.apache.tools.ant.Diagnostics +
    The error text when a security manager blocks access to a property. +
    ERROR_RMIC_FAILED - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    rmic failed message +
    ERROR_RMIC_FAILED - +Static variable in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    Error message to use when there is an error starting the sun rmic compiler +
    ERROR_SAX_1 - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    SAX1 not supported +
    ERROR_SIGNEDJAR_AND_PATHS - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification "You cannot specify the signed JAR when using paths or filesets" +
    ERROR_TODIR_AND_SIGNEDJAR - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "\'destdir\' and \'signedjar\' cannot both be set" +
    ERROR_TOO_MANY_DEFAULT_SCHEMAS - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    too many default schemas +
    ERROR_TOO_MANY_MAPPERS - +Static variable in class org.apache.tools.ant.taskdefs.SignJar +
    error string for unit test verification: "Too many mappers" +
    ERROR_TWO_LOCATIONS - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Both URL and File were given for schema +
    ERROR_UNABLE_TO_VERIFY_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.Rmic +
    unable to verify message +
    ERROR_UNKNOWN_COMPILER - +Static variable in class org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory +
    The error message to be used when the compiler cannot be found. +
    ERROR_WLRMIC_FAILED - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    The error string to use if not able to start the weblogic rmic +
    ERROR_WRONG_JAVA_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.Apt +
    A warning message if used with java < 1.5. +
    errorCount() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the number of errors. +
    errorFlag - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    errorHandler - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    ErrorInQuitException - Exception in org.apache.tools.mail
    Specialized IOException that get thrown if SMPT's QUIT command fails.
    ErrorInQuitException(IOException) - +Constructor for exception org.apache.tools.mail.ErrorInQuitException +
    Initialise from an IOException +
    errorOnMissingDir - +Variable in class org.apache.tools.ant.DirectoryScanner +
    Whether a missing base directory is an error. +
    errorProperty - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    errors - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    ERRORS - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    An error occurred. +
    EscapeUnicode - Class in org.apache.tools.ant.filters
    This method converts non-latin characters to unicode escapes.
    EscapeUnicode() - +Constructor for class org.apache.tools.ant.filters.EscapeUnicode +
    Constructor for "dummy" instances. +
    EscapeUnicode(Reader) - +Constructor for class org.apache.tools.ant.filters.EscapeUnicode +
    Creates a new filtered reader. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.Available +
    Evaluate the availability of a resource. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Calculate the checksum(s) +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.And +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Evalute the condition. +
    eval() - +Method in interface org.apache.tools.ant.taskdefs.condition.Condition +
    Is this condition true? +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Contains +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.FilesMatch +
    comparison method of the interface +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
    Evaluate the condition. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Is this condition true?. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Http +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsFailure +
    Fulfill the condition interface. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsFalse +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsFileSelected +
    Evaluate the selector with the file. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Evaluate the condition. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsReference +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsSet +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsSigned +
    Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.IsTrue +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Not +
    Evaluate condition +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Or +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the type of + that set in setFamily. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Is this condition true?. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Evaluates the condition. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceExists +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.ResourcesMatch +
    Verify that all resources match. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Socket +
      +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.TypeFound +
    Is this condition true? +
    eval() - +Method in class org.apache.tools.ant.taskdefs.condition.Xor +
    Evaluate the contained conditions. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.Length +
    Fulfill the condition contract. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Fulfill the condition contract. +
    eval() - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Evaluate (all) target and source file(s) to + see if the target(s) is/are up-to-date. +
    eval() - +Method in class org.apache.tools.ant.types.optional.ScriptCondition +
    Is this condition true? +
    evalFeature() - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Set a feature +
    evalName(Project) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    This validates the name - checks the if and unless + properties. +
    evalProperty() - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Set a property +
    evaluate(String, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalProperties +
    Evaluate a property. +
    evaluate(String, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Evaluate a property. +
    evaluate(String, PropertyHelper) - +Method in interface org.apache.tools.ant.PropertyHelper.PropertyEvaluator +
    Evaluate a property. +
    evaluate(int) - +Method in class org.apache.tools.ant.types.Comparison +
    Evaluate a comparison result as from Comparator.compare() or Comparable.compareTo(). +
    evaluate(boolean[]) - +Method in class org.apache.tools.ant.types.Quantifier +
    Evaluate a boolean array. +
    evaluate(int, int) - +Method in class org.apache.tools.ant.types.Quantifier +
    Evaluate integer true vs. +
    evaluate(long, long) - +Method in class org.apache.tools.ant.types.TimeComparison +
    Evaluate two times against this TimeComparison. +
    evaluate(long, long, long) - +Method in class org.apache.tools.ant.types.TimeComparison +
    Evaluate two times against this TimeComparison. +
    evaluateScript(String) - +Method in class org.apache.tools.ant.util.optional.JavaxScriptRunner +
    Do the work to eval the script. +
    evaluateScript(String) - +Method in class org.apache.tools.ant.util.optional.ScriptRunner +
    Evaluate the script. +
    evaluateScript(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Evaluate the script. +
    everythingIncluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    Whether or not everything tested so far has been included. +
    excludes - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The patterns for the files to be excluded. +
    Exec - Class in org.apache.tools.ant.taskdefs
    Deprecated. since 1.2. + delegate to Execute + instead.
    Exec() - +Constructor for class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Constructor for Exec. +
    execP4Command(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    no usages found for this method + runs a Perforce command without a handler +
    execP4Command(String, P4Handler) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Execute P4 command assembled by subclasses. +
    execSQL(String, PrintStream) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Exec the sql statement. +
    ExecTask - Class in org.apache.tools.ant.taskdefs
    Executes a given command if the os platform is appropriate.
    ExecTask() - +Constructor for class org.apache.tools.ant.taskdefs.ExecTask +
    Create an instance. +
    ExecTask(Task) - +Constructor for class org.apache.tools.ant.taskdefs.ExecTask +
    create an instance that is helping another task. +
    EXECUTABLE_NAME - +Static variable in class org.apache.tools.ant.taskdefs.Apt +
    The name of the apt tool. +
    execute(Object) - +Static method in class org.apache.tools.ant.dispatch.DispatchUtils +
    Determines and Executes the action method for the task. +
    execute() - +Method in class org.apache.tools.ant.Target +
    Executes the target if the "if" and "unless" conditions are + satisfied. +
    execute() - +Method in class org.apache.tools.ant.Task +
    Called by the project to let the task do its work. +
    execute() - +Method in class org.apache.tools.ant.TaskAdapter +
    Executes the proxied task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Do the execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Antlib +
    Execute the nested tasks, setting the classloader for + any tasks that derive from Definer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.AntStructure +
    Build the antstructure DTD. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Do the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Available +
    Entry point when operating as a task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Basename +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.BindTargets +
      +
    execute() - +Method in class org.apache.tools.ant.taskdefs.BuildNumber +
    Run task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Delegate the work to the ant task instance, after setting it up. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Calculate the checksum(s). +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Carry out the chmoding. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    do the classloader manipulation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.CloseResources +
      +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
    Run the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.AptExternalCompilerAdapter +
    Performs a compile using the Javac externally. +
    execute() - +Method in interface org.apache.tools.ant.taskdefs.compilers.CompilerAdapter +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Gcj +
    Performs a compile using the gcj compiler. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Javac12 +
    Deprecated. Run the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Javac13 +
    Run the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.JavacExternal +
    Performs a compile using the Javac externally. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Jikes +
    Performs a compile using the Jikes compiler from IBM. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Jvc +
    Run the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Kjc +
    Run the compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.compilers.Sj +
    Performs a compile using the sj compiler from Symantec. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Execute the concat task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Run as a task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    See whether our nested condition holds and set the property. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Perform the copy operation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated. Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. This is a very minimal derivative of the nomal copy logic. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Execute task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Execute task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    the execute method running CvsVersion +
    execute() - +Method in class org.apache.tools.ant.taskdefs.CVSPass +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.DefaultExcludes +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Run the definition. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Delete the file(s). +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Deltree +
    Deprecated. Do the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.DiagnosticsTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Dirname +
    Execute this task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.EchoXML +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Send an email. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Do the work. +
    Execute - Class in org.apache.tools.ant.taskdefs
    Runs an external program.
    Execute() - +Constructor for class org.apache.tools.ant.taskdefs.Execute +
    Creates a new execute object using PumpStreamHandler for + stream handling. +
    Execute(ExecuteStreamHandler) - +Constructor for class org.apache.tools.ant.taskdefs.Execute +
    Creates a new execute object. +
    Execute(ExecuteStreamHandler, ExecuteWatchdog) - +Constructor for class org.apache.tools.ant.taskdefs.Execute +
    Creates a new execute object. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Runs a process defined by the command line and returns its exit status. +
    execute(Project) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Execute the Java class against the specified Ant Project. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Throw a BuildException to exit (fail) the build. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Do the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Filter +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Get +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.HostInfo +
    set the properties. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
      +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Input +
    Actual method executed by ant. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Do the execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Do the execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Length +
    Execute the length task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    load Ant properties from the source file or resource +
    execute() - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    read in a source file to a property +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Local +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Create a new ant type based on the embedded tasks and types. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    Execute the templates instance. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    Create the url +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ManifestClassPath +
    Sets a property, which must not already exist, with a space + separated list of files and directories relative to the jar + file's parent directory. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Create or update the Manifest when used as a task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Mkdir +
    create the directory and all parents +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Nice +
    Execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    execute this task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Do the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Invoked by Ant after the task is prepared, when it is ready to execute + this task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Compiles the stub and skeletons for the specified EJBs, if they need to + be updated. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Check attributes values, load resource map and translate +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Executes the Task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    Do the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Does the adding and merging. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.JasperC +
    Our execute method. +
    execute() - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapter +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    execute by building up a list of files that + have changed and hand them off to a jsp compiler +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Runs the testcase. +
    execute(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Run the tests. +
    execute(List) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Execute a list of tests in a single forked Java VM. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Aggregate all testsuites into a single document and write it to the + specified directory and file. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Runs the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Runs the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.MimeMail +
    Deprecated. Executes this build task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Verify that all parameters are included. +
    execute(RExecTask.AntRExecClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecRead +
    Execute the read exec task. +
    execute(RExecTask.AntRExecClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask +
    Execute the subtask. +
    execute(RExecTask.AntRExecClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecWrite +
    Execute the write exec task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    Does the work. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Verify that all parameters are included. +
    execute(TelnetTask.AntTelnetClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetRead +
    Execute the read task. +
    execute(TelnetTask.AntTelnetClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask +
    Execute the subtask. +
    execute(TelnetTask.AntTelnetClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetWrite +
    Execute the write task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Executes the task - performs the actual compiler call. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Add +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
    creates a new Perforce change list + sets the p4.change property to the number of the new change list +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    again, properties are mutable in this tsk +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Delete +
    executes the p4 delete task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Edit +
    Run the p4 edit command +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
    Executes the p4fstat task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Have +
    Execute the Perforce have command. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    execute the p4 integrate +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    execute the p4 resolve +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Revert +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Sync +
    do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
      +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Run the script using the helper object. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Define the script. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    Locate the script defining task and execute the script by passing + control to it +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Execute the created command line. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Carry out the transfer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Execute this task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Carry out the transfer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp +
    Carry out the transfer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Carry out the transfer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Carry out the transfer. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    Execute the command on the remote host. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    Establish the ssh session and execute all nestedTasks +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Run the functional test sequence. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    The standard method for executing any task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    execute the task +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Pack +
    validate, then hand off to the subclass +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Execute the parallel tasks +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Patch +
    execute patch +
    execute() - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Do the execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.PreSetDef +
    Make a new definition. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ProjectHelperTask +
      +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Property +
    set the property in the project to the value. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    The main execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Rename +
    Deprecated. Renames the file src to dest +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Do the execution. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Execute as a Task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Retry +
    perform the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    execute by creating an instance of an implementation + class and getting to do the work +
    execute() - +Method in class org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic +
    exec by creating a new command +
    execute() - +Method in class org.apache.tools.ant.taskdefs.rmic.KaffeRmic +
    Call the rmic compiler. +
    execute() - +Method in interface org.apache.tools.ant.taskdefs.rmic.RmicAdapter +
    Call the rmic compiler. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    Run the rmic compiler. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    Carry out the rmic compilation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Sequential +
    Execute all nestedTasks. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    sign the jar(s) +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    Executes this build task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Load the sql file and then execute it +
    execute() - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Runs the various sub-builds. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Execute the sync task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Tar +
    do the business +
    execute() - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Creates the temporary file. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Execute the touch operation. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Called by the project to let the task do its work.. +
    execute(Project, Date, Location) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    validate parameter and execute the format. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Tstamp +
    create the timestamps. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Execute the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Sets property to true if target file(s) have a more recent timestamp + than (each of) the corresponding source file(s). +
    execute() - +Method in class org.apache.tools.ant.taskdefs.VerifyJar +
    verify our jar files +
    execute() - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Check repeatedly for the specified conditions until they become + true or the timeout expires. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    execute it +
    execute() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Run the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Executes the task. +
    execute() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    validate and build +
    execute() - +Method in class org.apache.tools.ant.UnknownElement +
    Executes the real object if it's a task. +
    execute() - +Method in interface org.apache.tools.ant.util.Retryable +
    Called to execute the code. +
    execute(Retryable, String) - +Method in class org.apache.tools.ant.util.RetryHandler +
    Execute the Retryable code with specified number of retries. +
    executeAsForked(CommandlineJava, ExecuteWatchdog) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Execute the task by forking a new JVM. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object.. +
    executeDrawOperation() - +Method in interface org.apache.tools.ant.types.optional.image.DrawOperation +
    Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Ellipse +
    Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object.. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Rectangle +
    Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object.. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Rotate +
    Performs the image rotation when being handled as a DrawOperation. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object.. +
    executeDrawOperation() - +Method in class org.apache.tools.ant.types.optional.image.Text +
    Draw the text. +
    executeExternalCompile(String[], int) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Do the compile with the specified arguments. +
    executeExternalCompile(String[], int, boolean) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Do the compile with the specified arguments. +
    executeFork() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    launch the generate client using system api. +
    executeForkV4() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    launch the generate client using system api. +
    executeForkV5() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    launch the generate client using system api. +
    executeInVM(CommandlineJava) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Execute inside VM. +
    ExecuteJava - Class in org.apache.tools.ant.taskdefs
    Execute a Java class.
    ExecuteJava() - +Constructor for class org.apache.tools.ant.taskdefs.ExecuteJava +
      +
    executeJava() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Do the execution and return a return code. +
    executeJava(CommandlineJava) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Execute the specified CommandlineJava. +
    executeJava() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    launch the generate client using java api. +
    executeMain() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Build the zip file. +
    ExecuteOn - Class in org.apache.tools.ant.taskdefs
    Executes a given command, supplying a set of files as arguments.
    ExecuteOn() - +Constructor for class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    executeOn(Properties) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    Apply the nested element to the properties. +
    ExecuteOn.FileDirBoth - Class in org.apache.tools.ant.taskdefs
    Enumerated attribute with the values "file", "dir" and "both" + for the type attribute.
    ExecuteOn.FileDirBoth() - +Constructor for class org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth +
      +
    executeOrQueue(Enumeration, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Executes all tests that don't need to be forked (or all tests + if the runIndividual argument is true. +
    executeRetryable(RetryHandler, Retryable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Executable a retryable object. +
    executeRetryable(RetryHandler, Retryable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Executable a retryable object. +
    executeScript(Map, Map) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Deprecated. since 1.7. + Use executeScript(attribute, elements, instance) instead. +
    executeScript(Map, Map, ScriptDefBase) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Execute the script. +
    executeScript(String) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Run a script +
    executeScript(String) - +Method in class org.apache.tools.ant.util.optional.JavaxScriptRunner +
    Do the work to run the script. +
    executeScript(String) - +Method in class org.apache.tools.ant.util.optional.ScriptRunner +
    Do the work. +
    executeScript(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Do the work. +
    executeSortedTargets(Vector) - +Method in class org.apache.tools.ant.Project +
    Execute a Vector of sorted targets. +
    ExecuteStreamHandler - Interface in org.apache.tools.ant.taskdefs
    Used by Execute to handle input and output stream of + subprocesses.
    executeTarget(String) - +Method in class org.apache.tools.ant.Project +
    Execute the specified target and any targets it depends on. +
    executeTargets(Project, String[]) - +Method in interface org.apache.tools.ant.Executor +
    Execute the specified Targets for the specified Project. +
    executeTargets(Project, String[]) - +Method in class org.apache.tools.ant.helper.DefaultExecutor +
    Execute the specified Targets for the specified Project.. +
    executeTargets(Project, String[]) - +Method in class org.apache.tools.ant.helper.IgnoreDependenciesExecutor +
    Execute the specified Targets for the specified Project.. +
    executeTargets(Project, String[]) - +Method in class org.apache.tools.ant.helper.SingleCheckExecutor +
    Execute the specified Targets for the specified Project.. +
    executeTargets(Vector) - +Method in class org.apache.tools.ant.Project +
    Execute the specified sequence of targets, and the targets + they depend on. +
    executeTransformOperation(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Performs the transformations.. +
    executeTransformOperation(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.Rotate +
    Performs the image rotation when being handled as a TransformOperation. +
    executeTransformOperation(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Performs the transformations.. +
    executeTransformOperation(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.TransformOperation +
    Performs the transformations. +
    ExecuteWatchdog - Class in org.apache.tools.ant.taskdefs
    Destroys a process running for too long.
    ExecuteWatchdog(long) - +Constructor for class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Creates a new watchdog with a given timeout. +
    ExecuteWatchdog(int) - +Constructor for class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Deprecated. since 1.5.x. + Use constructor with a long type instead. + (1.4.x compatibility) +
    Executor - Interface in org.apache.tools.ant
    Target executor abstraction.
    exists() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find out if the file exists +
    exists() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    exists() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find out if the file exists +
    exists() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    Exists - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by existence.
    Exists() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Exists +
      +
    Exists - Class in org.apache.tools.ant.types.resources.selectors
    Exists ResourceSelector.
    Exists() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Exists +
      +
    exit(int) - +Method in class org.apache.tools.ant.Main +
    This operation is expected to call System.exit(int), which + is what the base version does. +
    Exit - Class in org.apache.tools.ant.taskdefs
    Exits the active build, giving an additional message + if available.
    Exit() - +Constructor for class org.apache.tools.ant.taskdefs.Exit +
      +
    EXIT_CODE_ERROR - +Static variable in class org.apache.tools.ant.launch.Launcher +
    Exit code on trouble +
    exitAntLib() - +Method in class org.apache.tools.ant.ComponentHelper +
    Called at the end of processing an antlib. +
    exitCode - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.TestResultHolder +
    the exit code of the test. +
    ExitException - Exception in org.apache.tools.ant
    Used to report exit status of classes which call System.exit().
    ExitException(int) - +Constructor for exception org.apache.tools.ant.ExitException +
    Constructs an exit exception. +
    ExitException(String, int) - +Constructor for exception org.apache.tools.ant.ExitException +
    Constructs an exit exception. +
    exitScope() - +Method in class org.apache.tools.ant.property.LocalProperties +
    exit the scope +
    exitScope() - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Exit the local scope. +
    ExitStatusException - Exception in org.apache.tools.ant
    BuildException + exit status.
    ExitStatusException(int) - +Constructor for exception org.apache.tools.ant.ExitStatusException +
    Constructs an ExitStatusException. +
    ExitStatusException(String, int) - +Constructor for exception org.apache.tools.ant.ExitStatusException +
    Constructs an ExitStatusException. +
    ExitStatusException(String, int, Location) - +Constructor for exception org.apache.tools.ant.ExitStatusException +
    Construct an exit status exception with location information too +
    Expand - Class in org.apache.tools.ant.taskdefs
    Unzip a file.
    Expand() - +Constructor for class org.apache.tools.ant.taskdefs.Expand +
      +
    expand(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Convenience method to expand properties. +
    expandedDname - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    expandFile(FileUtils, File, File) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    This method is to be overridden by extending unarchival tasks. +
    expandFile(FileUtils, File, File) - +Method in class org.apache.tools.ant.taskdefs.Untar +
    This method is to be overridden by extending unarchival tasks. +
    ExpandProperties - Class in org.apache.tools.ant.filters
    Expands Ant properties, if any, in the data.
    ExpandProperties() - +Constructor for class org.apache.tools.ant.filters.ExpandProperties +
    Constructor for "dummy" instances. +
    ExpandProperties(Reader) - +Constructor for class org.apache.tools.ant.filters.ExpandProperties +
    Creates a new filtered reader. +
    expandResource(Resource, File) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    This method is to be overridden by extending unarchival tasks. +
    expandResource(Resource, File) - +Method in class org.apache.tools.ant.taskdefs.Untar +
    This method is to be overridden by extending unarchival tasks. +
    EXPRESSION_KEY - +Static variable in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Key to used for parameterized custom selector +
    EXPRESSION_KEY - +Static variable in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Key to used for parameterized custom selector +
    extdirs - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    ExtendFileSelector - Interface in org.apache.tools.ant.types.selectors
    This is the interface to be used by all custom selectors, those that are + called through the <custom> tag.
    ExtendSelector - Class in org.apache.tools.ant.types.selectors
    Selector that selects files by forwarding the request on to other classes.
    ExtendSelector() - +Constructor for class org.apache.tools.ant.types.selectors.ExtendSelector +
    Default constructor. +
    Extension - Class in org.apache.tools.ant.taskdefs.optional.extension
    Utility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.
    Extension(String, String, String, String, String, String, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    The constructor to create Extension object. +
    EXTENSION_LIST - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for EXTENSION_LIST. +
    EXTENSION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for EXTENSION_NAME. +
    ExtensionAdapter - Class in org.apache.tools.ant.taskdefs.optional.extension
    Simple class that represents an Extension and conforms to Ants + patterns.
    ExtensionAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
      +
    ExtensionPoint - Class in org.apache.tools.ant
    An extension point build files can provide as a place where other + build files can add new dependencies.
    ExtensionPoint() - +Constructor for class org.apache.tools.ant.ExtensionPoint +
      +
    ExtensionResolver - Interface in org.apache.tools.ant.taskdefs.optional.extension
    Interface to locate a File that satisfies extension.
    ExtensionSet - Class in org.apache.tools.ant.taskdefs.optional.extension
    The Extension set lists a set of "Optional Packages" / + "Extensions".
    ExtensionSet() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
      +
    ExtensionUtil - Class in org.apache.tools.ant.taskdefs.optional.extension
    A set of useful methods relating to extensions.
    ExtraAttribute - Class in org.apache.tools.ant.taskdefs.optional.extension
    Simple holder for extra attributes in main section of manifest.
    ExtraAttribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute +
      +
    extract() - +Method in class org.apache.tools.ant.taskdefs.BUnzip2 +
    Do the unbzipping. +
    extract() - +Method in class org.apache.tools.ant.taskdefs.GUnzip +
    Implement the gunzipping. +
    extract() - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Do the uncompressing. +
    extractFile(FileUtils, File, File, InputStream, String, Date, boolean, FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    extract a file to a directory +
    extractNameFromComponentName(String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    extract the element name from a component name +
    extractNameOrDefault(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Get the name of an event +
    extractProjectName(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    Get the project name or null +
    extractTargetName(BuildEvent) - +Method in class org.apache.tools.ant.listener.SimpleBigProjectLogger +
    Override point, extract the target name +
    extractTargetName(BuildEvent) - +Method in class org.apache.tools.ant.NoBannerLogger +
    Override point, extract the target name +
    extractUriFromComponentName(String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    extract a uri from a component name +
    extractVariablePart(String) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Returns the part of the given string that matches the * in the + "from" pattern. +
    extractVariablePart(String) - +Method in class org.apache.tools.ant.util.PackageNameMapper +
    Returns the part of the given string that matches the * in the + "from" pattern replacing file separators with dots +
    extractVariablePart(String) - +Method in class org.apache.tools.ant.util.UnPackageNameMapper +
    Returns the part of the given string that matches the * in the + "from" pattern replacing dots with file separators +
    ExtraFieldUtils - Class in org.apache.tools.zip
    ZipExtraField related methods
    ExtraFieldUtils() - +Constructor for class org.apache.tools.zip.ExtraFieldUtils +
      +
    ExtraFieldUtils.UnparseableExtraField - Class in org.apache.tools.zip
    "enum" for the possible actions to take if the extra field + cannot be parsed.
    +
    +

    +F

    +
    +
    FacadeTaskHelper - Class in org.apache.tools.ant.util.facade
    Helper class for facade implementations - encapsulates treatment of + explicit implementation choices, magic properties and + implementation specific command line arguments.
    FacadeTaskHelper(String) - +Constructor for class org.apache.tools.ant.util.facade.FacadeTaskHelper +
      +
    FacadeTaskHelper(String, String) - +Constructor for class org.apache.tools.ant.util.facade.FacadeTaskHelper +
      +
    FAIL - +Static variable in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
    fail if the extension-point is not defined +
    fail(String) - +Method in class org.apache.tools.ant.TaskConfigurationChecker +
    Registers an error. +
    FAIL - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    Enumerated values +
    fail(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    Utility method for nested scripts; throws a BuildException + with the given message. +
    FAIL - +Static variable in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + Tar.FAIL is deprecated and is replaced with + Tar.TarLongFileMode.FAIL +
    FAIL - +Static variable in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    permissible values for longfile attribute +
    FAIL - +Static variable in class org.apache.tools.ant.types.FilterSet.OnMissing +
    Fail value +
    FAIL_ALL - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    Enumerated values +
    failed - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
      +
    failonerror - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    failOnError - +Variable in class org.apache.tools.ant.taskdefs.ExecTask +
      +
    failOnError - +Variable in class org.apache.tools.ant.taskdefs.Javac +
      +
    failOnError - +Variable in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    flag to control action on execution trouble +
    failOnError - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Keep going or fail on error - defaults to fail. +
    failOnError - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    FAILURE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the failure element +
    FAILURE_RECORDER_CLASS_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    failure recorder class +
    failureCount() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the number of failures. +
    failureProperty - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    FailureRecorder - Class in org.apache.tools.ant.taskdefs.optional.junit
    Collects all failing test cases and creates a new JUnit test class containing + a suite() method which calls these failed tests.
    FailureRecorder() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
      +
    FailureRecorder.TestInfos - Class in org.apache.tools.ant.taskdefs.optional.junit
    TestInfos holds information about a given test for later use.
    FailureRecorder.TestInfos(Test) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos +
    This constructor extracts the needed information from the given test. +
    FAILURES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Some tests failed. +
    FAMILY_9X - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_DOS - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_MAC - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_NETWARE - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_NT - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_OS2 - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_OS400 - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_TANDEM - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_UNIX - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_VMS - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_WINDOWS - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAMILY_ZOS - +Static variable in class org.apache.tools.ant.taskdefs.condition.Os +
    OS family that can be tested for. +
    FAT_FILE_TIMESTAMP_GRANULARITY - +Static variable in class org.apache.tools.ant.util.FileUtils +
    The granularity of timestamps under FAT. +
    fatalError(TransformerException) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Log a fatal error. +
    fatalError(SAXParseException) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
    record a fatal error +
    FEATURE - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    feature +
    FEATURE_DISALLOW_DTD - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    the apache.org/xml disalllow doctype decl feature +
    FEATURE_EXTERNAL_ENTITIES - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    the sax external entities feature +
    FEATURE_JAXP12_SCHEMA_LANGUAGE - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for schema language +
    FEATURE_JAXP12_SCHEMA_SOURCE - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for schema source +
    FEATURE_NAMESPACES - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for namespace support +
    FEATURE_VALIDATION - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for validation +
    FEATURE_XSD - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for xsd +
    FEATURE_XSD_FULL_VALIDATION - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for full validation +
    fetchEntry() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Fetch information from the named entry inside the archive. +
    fetchEntry() - +Method in class org.apache.tools.ant.types.resources.TarResource +
    fetches information from the named entry inside the archive. +
    fetchEntry() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    fetches information from the named entry inside the archive. +
    FieldRefCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A FieldRef CP Info
    FieldRefCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Constructor. +
    file - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    file - +Variable in class org.apache.tools.ant.taskdefs.Delete +
      +
    file - +Variable in class org.apache.tools.ant.taskdefs.Echo +
      +
    FILE - +Static variable in class org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth +
    File value +
    file - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    file to be validated +
    file - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    FILE - +Static variable in class org.apache.tools.ant.types.resources.selectors.Type +
    Static file type selector. +
    FILE - +Static variable in class org.apache.tools.ant.types.selectors.TypeSelector.FileType +
    the string value for file +
    FILE_FLAG - +Static variable in interface org.apache.tools.zip.UnixStat +
    Indicates plain files. +
    FILE_NAME_KEY - +Static variable in class org.apache.tools.ant.input.PropertyFileInputHandler +
    Name of the system property we expect to hold the file name. +
    FILE_PROTOCOL_PREFIX - +Static variable in interface org.apache.tools.ant.taskdefs.XSLTLiaison +
    the file protocol prefix for systemid. +
    fileCopyMap - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    FileList - Class in org.apache.tools.ant.types
    FileList represents an explicitly named list of files.
    FileList() - +Constructor for class org.apache.tools.ant.types.FileList +
    The default constructor. +
    FileList(FileList) - +Constructor for class org.apache.tools.ant.types.FileList +
    A copy constructor. +
    FileList.FileName - Class in org.apache.tools.ant.types
    Inner class corresponding to the <file> nested element.
    FileList.FileName() - +Constructor for class org.apache.tools.ant.types.FileList.FileName +
      +
    fileNameEquals(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Compares two filenames. +
    FileNameMapper - Interface in org.apache.tools.ant.util
    Interface to be used by SourceFileScanner.
    FilenameSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on the filename.
    FilenameSelector() - +Constructor for class org.apache.tools.ant.types.selectors.FilenameSelector +
    Creates a new FilenameSelector instance. +
    FileProvider - Interface in org.apache.tools.ant.types.resources
    This is an interface that resources that can provide a file should implement.
    FileResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of a File.
    FileResource() - +Constructor for class org.apache.tools.ant.types.resources.FileResource +
    Default constructor. +
    FileResource(File, String) - +Constructor for class org.apache.tools.ant.types.resources.FileResource +
    Construct a new FileResource using the specified basedir and relative name. +
    FileResource(File) - +Constructor for class org.apache.tools.ant.types.resources.FileResource +
    Construct a new FileResource from a File. +
    FileResource(Project, File) - +Constructor for class org.apache.tools.ant.types.resources.FileResource +
    Create a new FileResource. +
    FileResource(Project, String) - +Constructor for class org.apache.tools.ant.types.resources.FileResource +
    Constructor for Ant attribute introspection. +
    FileResourceIterator - Class in org.apache.tools.ant.types.resources
    Iterator of FileResources from filenames.
    FileResourceIterator() - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Deprecated. in favor of FileResourceIterator.FileResourceIterator(Project) +
    FileResourceIterator(Project) - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Create a new FileResourceIterator. +
    FileResourceIterator(File) - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Deprecated. in favor of FileResourceIterator.FileResourceIterator(Project, File) +
    FileResourceIterator(Project, File) - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Construct a new FileResourceIterator relative to the specified + base directory. +
    FileResourceIterator(File, String[]) - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Deprecated. in favor of FileResourceIterator.FileResourceIterator(Project, File, String[]) +
    FileResourceIterator(Project, File, String[]) - +Constructor for class org.apache.tools.ant.types.resources.FileResourceIterator +
    Construct a new FileResourceIterator over the specified filenames, + relative to the specified base directory. +
    files - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    Files - Class in org.apache.tools.ant.types.resources
    ResourceCollection implementation; like AbstractFileSet with absolute paths.
    Files() - +Constructor for class org.apache.tools.ant.types.resources.Files +
    Construct a new Files collection. +
    Files(Files) - +Constructor for class org.apache.tools.ant.types.resources.Files +
    Construct a new Files collection, shallowly cloned + from the specified Files. +
    FileScanner - Interface in org.apache.tools.ant
    An interface used to describe the actions required of any type of + directory scanner.
    filesDeselected - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The files which matched at least one include and no excludes and + which a selector discarded. +
    FileSelector - Interface in org.apache.tools.ant.types.selectors
    This is the interface to be used by all selectors.
    fileset - +Variable in class org.apache.tools.ant.taskdefs.MatchingTask +
      +
    FileSet - Class in org.apache.tools.ant.types
    Moved out of MatchingTask to make it a standalone object that could + be referenced (by scripts for example).
    FileSet() - +Constructor for class org.apache.tools.ant.types.FileSet +
    Constructor for FileSet. +
    FileSet(FileSet) - +Constructor for class org.apache.tools.ant.types.FileSet +
    Constructor for FileSet, with FileSet to shallowly clone. +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    the filesets of the jars to sign +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.Delete +
      +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
      +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    the list of all filesets, that should contains the xml to aggregate +
    filesets - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    sets of file to be validated +
    filesExcluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The files which matched at least one include and at least + one exclude. +
    filesIncluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The files which matched at least one include and no excludes + and were selected. +
    filesIterator() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get an iterator over the files. +
    fileSize() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get the number of files in the files attribute. +
    FilesMatch - Class in org.apache.tools.ant.taskdefs.condition
    Compares two files for equality based on size and + content.
    FilesMatch() - +Constructor for class org.apache.tools.ant.taskdefs.condition.FilesMatch +
      +
    filesNotIncluded - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The files which did not match any includes or selectors. +
    FileSystem - Class in org.apache.tools.ant.types.resources.comparators
    Compares filesystem Resources.
    FileSystem() - +Constructor for class org.apache.tools.ant.types.resources.comparators.FileSystem +
      +
    FileTokenizer - Class in org.apache.tools.ant.util
    Class to read the complete input into a string.
    FileTokenizer() - +Constructor for class org.apache.tools.ant.util.FileTokenizer +
      +
    fileToURL(File) - +Static method in class org.apache.tools.ant.launch.Locator +
    Convert a File to a URL. +
    fileUtils - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    FileUtils - Class in org.apache.tools.ant.util
    This class also encapsulates methods which allow Files to be + referred to using abstract path names which are translated to native + system file paths at runtime as well as copying files or setting + their last modification time.
    FileUtils() - +Constructor for class org.apache.tools.ant.util.FileUtils +
    Empty constructor. +
    fill - +Variable in class org.apache.tools.ant.types.optional.image.BasicShape +
      +
    fillMapsFromArchive(Resource, String, Map, Map, Map, Map) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Fills the file and directory maps with resources read from the archive. +
    fillMapsFromArchive(Resource, String, Map, Map, Map, Map) - +Method in class org.apache.tools.ant.types.TarScanner +
    Fills the file and directory maps with resources read from the + archive. +
    fillMapsFromArchive(Resource, String, Map, Map, Map, Map) - +Method in class org.apache.tools.ant.types.ZipScanner +
    Fills the file and directory maps with resources read from the + archive. +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsRegex +
    apply regex and substitution on a string +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsString +
    Filter strings that contain the contains attribute +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.DeleteCharacters +
    remove characters from a string +
    filter(String) - +Method in interface org.apache.tools.ant.filters.TokenFilter.Filter +
    filter and/of modify a string +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.IgnoreBlank +
      +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceRegex +
      +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceString +
    Filter a string 'line' replacing from with to + (C&P from the Replace task) +
    filter(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.Trim +
      +
    filter(String) - +Method in class org.apache.tools.ant.filters.UniqFilter +
      +
    Filter - Class in org.apache.tools.ant.taskdefs
    Sets a token filter that is used by the file copy tasks + to do token substitution.
    Filter() - +Constructor for class org.apache.tools.ant.taskdefs.Filter +
      +
    filter(String) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Called filter the token. +
    FilterChain - Class in org.apache.tools.ant.types
    FilterChain may contain a chained set of filter readers.
    FilterChain() - +Constructor for class org.apache.tools.ant.types.FilterChain +
      +
    filterChains - +Variable in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Chain of filters +
    filtering - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    filterJvmCompilerArgs(String[]) - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Strip out all -J args from the command list. +
    FilterMapper - Class in org.apache.tools.ant.types.mappers
    This is a FileNameMapper based on a FilterChain.
    FilterMapper() - +Constructor for class org.apache.tools.ant.types.mappers.FilterMapper +
      +
    filterResource(Resource) - +Method in class org.apache.tools.ant.types.resources.LazyResourceCollectionWrapper +
    Specify if the resource should be filtered or not. +
    FilterSet - Class in org.apache.tools.ant.types
    A set of filters to be applied to something.
    FilterSet() - +Constructor for class org.apache.tools.ant.types.FilterSet +
    Default constructor. +
    FilterSet(FilterSet) - +Constructor for class org.apache.tools.ant.types.FilterSet +
    Create a Filterset from another filterset. +
    FilterSet.Filter - Class in org.apache.tools.ant.types
    Individual filter component of filterset.
    FilterSet.Filter(String, String) - +Constructor for class org.apache.tools.ant.types.FilterSet.Filter +
    Constructor for the Filter object. +
    FilterSet.Filter() - +Constructor for class org.apache.tools.ant.types.FilterSet.Filter +
    No-argument conmstructor. +
    FilterSet.FiltersFile - Class in org.apache.tools.ant.types
    The filtersfile nested element.
    FilterSet.FiltersFile() - +Constructor for class org.apache.tools.ant.types.FilterSet.FiltersFile +
    Constructor for the FiltersFile object. +
    FilterSet.OnMissing - Class in org.apache.tools.ant.types
    EnumeratedAttribute to set behavior WRT missing filtersfiles: + "fail" (default), "warn", "ignore".
    FilterSet.OnMissing() - +Constructor for class org.apache.tools.ant.types.FilterSet.OnMissing +
    Default constructor. +
    FilterSet.OnMissing(String) - +Constructor for class org.apache.tools.ant.types.FilterSet.OnMissing +
    Convenience constructor. +
    FilterSetCollection - Class in org.apache.tools.ant.types
    A FilterSetCollection is a collection of filtersets each of which may have + a different start/end token settings.
    FilterSetCollection() - +Constructor for class org.apache.tools.ant.types.FilterSetCollection +
    Constructor for a FilterSetCollection. +
    FilterSetCollection(FilterSet) - +Constructor for class org.apache.tools.ant.types.FilterSetCollection +
    Constructor for a FilterSetCollection. +
    filterStack(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Filters stack frames from internal JUnit and Ant classes +
    filtertrace - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    finalize() - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
    Overriden to close the stream. +
    finalizeZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Finalize the zip output stream. +
    finalizeZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    method for subclasses to override +
    findClass(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Searches for and load a class on the classpath of this class loader. +
    findFile(File, boolean) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
    From base traverse the filesystem in order to find + a file that matches the given name. +
    findJarName(String, String[]) - +Static method in class org.apache.tools.ant.taskdefs.Jar +
    try to guess the name of the given file. +
    findResources(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath. +
    findResources(String, boolean) - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath. +
    finish(Thread) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Waits for a thread to finish while trying to make it finish + quicker by stopping the pumper (if the thread is a ThreadWithPumper instance) or interrupting + the thread. +
    finish() - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
      +
    finish() - +Method in class org.apache.tools.tar.TarOutputStream +
    Ends the TAR archive without closing the underlying OutputStream. +
    finish() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Finishs writing the contents and closes this as well as the + underlying stream. +
    fireBuildFinished(Throwable) - +Method in class org.apache.tools.ant.Project +
    Send a "build finished" event to the build listeners + for this project. +
    fireBuildStarted() - +Method in class org.apache.tools.ant.Project +
    Send a "build started" event + to the build listeners for this project. +
    fireMessageLogged(Project, String, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" project level event + to the build listeners for this project. +
    fireMessageLogged(Project, String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" project level event + to the build listeners for this project. +
    fireMessageLogged(Target, String, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" target level event + to the build listeners for this project. +
    fireMessageLogged(Target, String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" target level event + to the build listeners for this project. +
    fireMessageLogged(Task, String, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" task level event + to the build listeners for this project. +
    fireMessageLogged(Task, String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Send a "message logged" task level event + to the build listeners for this project. +
    fireSubBuildFinished(Throwable) - +Method in class org.apache.tools.ant.Project +
    Send a "subbuild finished" event to the build listeners for + this project. +
    fireSubBuildStarted() - +Method in class org.apache.tools.ant.Project +
    Send a "subbuild started" event to the build listeners for + this project. +
    fireTargetFinished(Target, Throwable) - +Method in class org.apache.tools.ant.Project +
    Send a "target finished" event to the build listeners + for this project. +
    fireTargetStarted(Target) - +Method in class org.apache.tools.ant.Project +
    Send a "target started" event to the build listeners + for this project. +
    fireTaskFinished(Task, Throwable) - +Method in class org.apache.tools.ant.Project +
    Send a "task finished" event to the build listeners for this + project. +
    fireTaskStarted(Task) - +Method in class org.apache.tools.ant.Project +
    Send a "task started" event to the build listeners + for this project. +
    fireTimeoutOccured() - +Method in class org.apache.tools.ant.util.Watchdog +
    Inform the observers that a timeout has occurred. +
    First - Class in org.apache.tools.ant.types.resources
    ResourceCollection that contains the first count elements of + another ResourceCollection, a la the UNIX head command.
    First() - +Constructor for class org.apache.tools.ant.types.resources.First +
      +
    FirstMatchMapper - Class in org.apache.tools.ant.util
    A ContainerMapper that returns the results of its + first constituent FileNameMappers that matches.
    FirstMatchMapper() - +Constructor for class org.apache.tools.ant.util.FirstMatchMapper +
      +
    fixClassLoader(ClassLoader, String) - +Method in class org.apache.tools.ant.util.ScriptFixBSFPath +
    Check if need to mess about with the classloader. +
    FixCRLF - Class in org.apache.tools.ant.taskdefs
    Converts text source files to local OS formatting conventions, as + well as repair text files damaged by misconfigured or misguided editors or + file transfer programs.
    FixCRLF() - +Constructor for class org.apache.tools.ant.taskdefs.FixCRLF +
      +
    FixCRLF.AddAsisRemove - Class in org.apache.tools.ant.taskdefs
    Enumerated attribute with the values "asis", "add" and "remove".
    FixCRLF.AddAsisRemove() - +Constructor for class org.apache.tools.ant.taskdefs.FixCRLF.AddAsisRemove +
      +
    FixCRLF.CrLf - Class in org.apache.tools.ant.taskdefs
    Enumerated attribute with the values "asis", "cr", "lf" and "crlf".
    FixCRLF.CrLf() - +Constructor for class org.apache.tools.ant.taskdefs.FixCRLF.CrLf +
      +
    FixCRLF.OneLiner - Class in org.apache.tools.ant.taskdefs
    Deprecated. since 1.7.0.
    FixCRLF.OneLiner(File) - +Constructor for class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. Constructor. +
    FixCrLfFilter - Class in org.apache.tools.ant.filters
    Converts text to local OS formatting conventions, as well as repair text + damaged by misconfigured or misguided editors or file transfer programs.
    FixCrLfFilter() - +Constructor for class org.apache.tools.ant.filters.FixCrLfFilter +
    Constructor for "dummy" instances. +
    FixCrLfFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.FixCrLfFilter +
    Create a new filtered reader. +
    FixCrLfFilter.AddAsisRemove - Class in org.apache.tools.ant.filters
    Enumerated attribute with the values "asis", "add" and "remove".
    FixCrLfFilter.AddAsisRemove() - +Constructor for class org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove +
      +
    FixCrLfFilter.CrLf - Class in org.apache.tools.ant.filters
    Enumerated attribute with the values "asis", "cr", "lf" and "crlf".
    FixCrLfFilter.CrLf() - +Constructor for class org.apache.tools.ant.filters.FixCrLfFilter.CrLf +
      +
    FLAG_AUTORESPONSE_DEF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -I- flag +
    FLAG_AUTORESPONSE_NO - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -I-N flag +
    FLAG_AUTORESPONSE_YES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -I-Y flag +
    FLAG_BRANCH - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -branch flag -- checks out the file on a specified branch +
    FLAG_BRIEF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -B flag +
    FLAG_CHECKIN - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -ci flag -- checkin element after creation +
    FLAG_CODEDIFF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -D flag +
    FLAG_COMMAND - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The command option +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    -comment flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    /comment -- comments associated to the task +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    -comment flag -- method to use for commenting events +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -c flag -- comment to attach to the element +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    -c flag -- comment to attach to the directory +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -c flag -- comment to attach to the file +
    FLAG_COMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    -comment flag -- method to use for commenting events +
    FLAG_COMMENT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The log option +
    FLAG_COMMENT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -C flag +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    -cfile flag -- file containing a comment to attach to the directory +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_COMMENTFILE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -cfile flag -- file containing a comment to attach to the file +
    FLAG_CURRENTTIME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -ctime flag -- modified time is written as the current time +
    FLAG_ELTYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -eltype flag -- element type to use during creation +
    FLAG_FILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The file option +
    FLAG_FILETIME_DEF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GTC flag +
    FLAG_FILETIME_MODIFIED - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GTM flag +
    FLAG_FILETIME_UPDATED - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GTU flag +
    FLAG_FORCE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -force flag -- suppresses confirmation prompts +
    FLAG_FULL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -full flag -- baseline to be created is full +
    FLAG_GLOBAL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB +
    FLAG_GRAPHICAL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -graphical flag -- display graphical dialog during update operation +
    FLAG_IDENTICAL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -identical flag -- allows the file to be checked in even if it is identical to the original +
    FLAG_IDENTICAL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -identical flag -- allows the file to be checked in even if it is identical to the original +
    FLAG_IGNORE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -ignore flag -- ignore pre-trigger operations when removing a trigger type +
    FLAG_INCREMENTAL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -incremental flag -- baseline to be created is incremental +
    FLAG_KEEPCOPY - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -keep flag -- keeps a copy of the file with a .keep extension +
    FLAG_KEEPCOPY - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
    -keep flag -- keep a copy of the file with .keep extension +
    FLAG_LABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The label option +
    FLAG_LABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -L flag +
    FLAG_LOG - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -log flag -- file to log status to +
    FLAG_LOGIN - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -Y flag +
    FLAG_MASTER - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -master flag -- change mastership of main branch to current site +
    FLAG_NLABEL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -nlabel -- baseline to be created without a label +
    FLAG_NO_CACHE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The no cache option +
    FLAG_NO_COMPRESSION - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The no compression option +
    FLAG_NO_FILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -F- flag +
    FLAG_NO_GET - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -G- flag +
    FLAG_NOCHECKOUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    -nco flag -- do not checkout element after creation +
    FLAG_NOCHECKOUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -nco flag -- do not checkout element after creation +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -nc flag -- no comment is specified +
    FLAG_NOCOMMENT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -nc flag -- no comment is specified +
    FLAG_NODATA - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -ndata flag -- checks out the file but does not create an editable file containing its data +
    FLAG_NOVERWRITE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -noverwrite flag -- do not overwrite hijacked files +
    FLAG_NOWARN - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -nwarn flag -- suppresses warning messages +
    FLAG_NOWARN - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -nwarn flag -- suppresses warning messages +
    FLAG_NOWARN - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -nwarn flag -- suppresses warning messages +
    FLAG_NUSERS - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    -nusers flag -- list of users to exclude from lock +
    FLAG_OBSOLETE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    -obsolete flag -- mark locked object as obsolete +
    FLAG_ORDINARY - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -ordinary flag -- creates a label type that can be used only in the current VOB +
    FLAG_OUT - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -out flag -- create a writable file under a different filename +
    FLAG_OUTPUT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -O flag +
    FLAG_OVERRIDE_WORKING_DIR - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GL flag +
    FLAG_OVERWRITE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -overwrite flag -- overwrite hijacked files +
    FLAG_PASSWORD - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The password option +
    FLAG_PBRANCH - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -pbranch flag -- allows label type to be used once per branch +
    FLAG_PLATFORM - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    /platform flag -- target platform +
    FLAG_PNAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    -pname flag -- pathname to lock +
    FLAG_PNAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    -pname flag -- pathname to lock +
    FLAG_PRESERVETIME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    -ptime flag -- preserves the modification time +
    FLAG_PRESERVETIME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    -ptime flag -- preserves the modification time on checkin +
    FLAG_PRESERVETIME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -ptime flag -- modified time is written as the VOB time +
    FLAG_PROJECT - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    /project flag -- target project +
    FLAG_PROJECT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The project option +
    FLAG_QUIET - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -O- flag +
    FLAG_RECURSE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    /recurse -- +
    FLAG_RECURSE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -recurse flag -- process all subdirectories +
    FLAG_RECURSE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -recurse flag -- process all subdirectories +
    FLAG_RECURSION - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The recursive option +
    FLAG_RECURSION - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -R flag +
    FLAG_RELEASE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    /release flag +
    FLAG_RENAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    -rename flag -- rename hijacked files with .keep extension +
    FLAG_REPLACE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    -replace flag -- replace existing lock on object(s) +
    FLAG_REPLACE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -replace flag -- replace the existing value of the attribute +
    FLAG_REPLACE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -replace flag -- replace another label of the same type +
    FLAG_REPLACE - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -replace flag -- replace existing label definition of the same type +
    FLAG_REPLACE_WRITABLE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GWR flag +
    FLAG_RESERVED - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -reserved flag -- check out the file as reserved +
    FLAG_RESOLVER - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    /resolver flag +
    FLAG_RM - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
    -rm flag -- remove the copy of the file +
    FLAG_RMALL - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    -rmall flag -- removes all instances of a type and the type object itself +
    FLAG_SHARED - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    -shared flag -- sets the way mastership is checked by ClearCase +
    FLAG_SKIP_WRITABLE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -GWS flag +
    FLAG_SOS_HOME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The sos home option +
    FLAG_SOS_SERVER - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The server option +
    FLAG_SUBSYSTEM - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    /release flag +
    FLAG_TASK - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    -task flag -- associate checkout task with task +
    FLAG_TASK - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    -task flag -- associate checkout task with task +
    FLAG_UNRESERVED - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -reserved flag -- check out the file as unreserved +
    FLAG_USER - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -U flag +
    FLAG_USERNAME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The username option +
    FLAG_VERBOSE - +Static variable in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    /recurse -- +
    FLAG_VERBOSE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The verbose option +
    FLAG_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    -version flag -- allows checkout of a version that is not main latest +
    FLAG_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    -version flag -- attach attribute to specified version +
    FLAG_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    -version flag -- attach label to specified version +
    FLAG_VERSION - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The revision option +
    FLAG_VERSION - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -V flag +
    FLAG_VERSION_DATE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -Vd flag +
    FLAG_VERSION_LABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -VL flag +
    FLAG_VSS_SERVER - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The database (vss server) option +
    FLAG_WORKING_DIR - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The workdir option +
    FLAG_WRITABLE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -W flag +
    FlatFileNameMapper - Class in org.apache.tools.ant.util
    Implementation of FileNameMapper that always returns the source + file name without any leading directory information.
    FlatFileNameMapper() - +Constructor for class org.apache.tools.ant.util.FlatFileNameMapper +
      +
    flatten - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    flattenToString(Collection) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Creates a comma separated list of all values held in the given + collection. +
    FlexInteger - Class in org.apache.tools.ant.types
    Helper class which can be used for Ant task attribute setter methods to allow + the build file to specify an integer in either decimal, octal, or hexadecimal + format.
    FlexInteger(String) - +Constructor for class org.apache.tools.ant.types.FlexInteger +
    Constructor used by Ant's introspection mechanism for attribute population +
    FloatCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A Float CP Info
    FloatCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FloatCPInfo +
    Constructor. +
    flush() - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Writes all remaining data in the buffer associated + with the current thread to the project. +
    flush() - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Flush this log stream +
    flush() - +Method in class org.apache.tools.ant.util.TeeOutputStream +
    Flush both output streams. +
    flush() - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
      +
    flush() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Flushes this output stream and forces any buffered output bytes + to be written out to the stream. +
    FOOTER - +Static variable in class org.apache.tools.ant.listener.BigProjectLogger +
    Footer string for the log. +
    forceLoadClass(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Loads a class through this class loader even if that class is available + on the parent classpath. +
    forceLoadSystemClass(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Loads a class through this class loader but defer to the parent class + loader. +
    forceOverwrite - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    fork(ProjectComponent) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Run the Java command in a separate VM, this does not give you + the full flexibility of the Java task, but may be enough for + simple needs. +
    fork - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    ForkingSunRmic - Class in org.apache.tools.ant.taskdefs.rmic
    This is an extension of the sun rmic compiler, which forks rather than + executes it inline.
    ForkingSunRmic() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic +
      +
    format - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    the format to use for the report. +
    format(long, String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Format a date/time into a specific pattern. +
    format(Date, String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Format a date/time into a specific pattern. +
    formatElapsedTime(long) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Format an elapsed time into a plurialization correct string. +
    formatError(String, Test, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Format an error and print it. +
    FormatterElement - Class in org.apache.tools.ant.taskdefs.optional.junit
    A wrapper for the implementations of JUnitResultFormatter.
    FormatterElement() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
      +
    FormatterElement.TypeAttribute - Class in org.apache.tools.ant.taskdefs.optional.junit
    Enumerated attribute with the values "plain", "xml", "brief" and "failure".
    FormatterElement.TypeAttribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.TypeAttribute +
      +
    formatters - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    formatTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Format the test for printing.. +
    formatTime(long) - +Static method in class org.apache.tools.ant.DefaultLogger +
    Convenience method to format a specified length of time. +
    fos - +Variable in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated.   +
    FRAMES - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    name of the frames format. +
    frequency(Collection, Object) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Counts how often the given Object occurs in the given + collection using equals() for comparison. +
    from - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    from - +Variable in class org.apache.tools.ant.types.Mapper +
      +
    from(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the from address. +
    fromArray(Object[]) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.Enumerations +
    creates an enumeration from an array of objects. +
    fromCompound(Enumeration[]) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.Enumerations +
    creates an enumeration from an array of enumeration. +
    fromDosTime(ZipLong) - +Static method in class org.apache.tools.zip.ZipFile +
    Convert a DOS date/time field to a Date object. +
    fromJarURI(String) - +Static method in class org.apache.tools.ant.launch.Locator +
    Crack a JAR URI. +
    fromPostfix - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Part of "from" pattern after the *. +
    fromPrefix - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Part of "from" pattern before the *. +
    fromURI(String) - +Static method in class org.apache.tools.ant.launch.Locator +
    Constructs a file path from a file: URI. +
    fromURI(String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Constructs a file path from a file: URI. +
    FTP - Class in org.apache.tools.ant.taskdefs.optional.net
    Basic FTP client.
    FTP() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    ftp - +Variable in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
      +
    ftp - +Variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
      +
    FTP.Action - Class in org.apache.tools.ant.taskdefs.optional.net
    an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
    FTP.Action() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.Action +
      +
    FTP.FTPDirectoryScanner - Class in org.apache.tools.ant.taskdefs.optional.net
    internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false
    FTP.FTPDirectoryScanner(FTPClient) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
    constructor +
    FTP.FTPDirectoryScanner.AntFTPFile - Class in org.apache.tools.ant.taskdefs.optional.net
    an AntFTPFile is a representation of a remote file
    FTP.FTPDirectoryScanner.AntFTPFile(FTPClient, FTPFile, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    constructor +
    FTP.FTPDirectoryScanner.AntFTPFile(FTP.FTPDirectoryScanner.AntFTPFile, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    other constructor +
    FTP.FTPDirectoryScanner.AntFTPRootFile - Class in org.apache.tools.ant.taskdefs.optional.net
    special class to represent the remote directory itself
    FTP.FTPDirectoryScanner.AntFTPRootFile(FTPClient, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile +
    constructor +
    FTP.FTPFileProxy - Class in org.apache.tools.ant.taskdefs.optional.net
    internal class providing a File-like interface to some of the information + available from the FTP server
    FTP.FTPFileProxy(FTPFile) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
    creates a proxy to a FTP file +
    FTP.FTPFileProxy(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
    creates a proxy to a FTP directory +
    FTP.FTPSystemType - Class in org.apache.tools.ant.taskdefs.optional.net
    one of the valid system type keys recognized by the systemTypeKey + attribute.
    FTP.FTPSystemType() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPSystemType +
      +
    FTP.Granularity - Class in org.apache.tools.ant.taskdefs.optional.net
    represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
    FTP.Granularity() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity +
      +
    FTP.LanguageCode - Class in org.apache.tools.ant.taskdefs.optional.net
    Enumerated class for languages.
    FTP.LanguageCode() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTP.LanguageCode +
      +
    FTP_NON_PROXY_HOSTS - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the ftp hosts not to be proxied property +
    FTP_PROXY_HOST - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the ftp proxyhost property +
    FTP_PROXY_PORT - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the ftp proxyport property +
    FTPTask - Class in org.apache.tools.ant.taskdefs.optional.net
    Basic FTP client.
    FTPTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    FTPTask.Action - Class in org.apache.tools.ant.taskdefs.optional.net
    an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
    FTPTask.Action() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Action +
      +
    FTPTask.FTPSystemType - Class in org.apache.tools.ant.taskdefs.optional.net
    one of the valid system type keys recognized by the systemTypeKey + attribute.
    FTPTask.FTPSystemType() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTask.FTPSystemType +
      +
    FTPTask.Granularity - Class in org.apache.tools.ant.taskdefs.optional.net
    represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
    FTPTask.Granularity() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Granularity +
      +
    FTPTaskMirror - Interface in org.apache.tools.ant.taskdefs.optional.net
     
    FTPTaskMirrorImpl - Class in org.apache.tools.ant.taskdefs.optional.net
     
    FTPTaskMirrorImpl(FTPTask) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Constructor. +
    FTPTaskMirrorImpl.FTPDirectoryScanner - Class in org.apache.tools.ant.taskdefs.optional.net
    internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false
    FTPTaskMirrorImpl.FTPDirectoryScanner(FTPClient) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
    constructor +
    FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile - Class in org.apache.tools.ant.taskdefs.optional.net
    an AntFTPFile is a representation of a remote file
    FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(FTPClient, FTPFile, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    constructor +
    FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    other constructor +
    FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile - Class in org.apache.tools.ant.taskdefs.optional.net
    special class to represent the remote directory itself
    FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile(FTPClient, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile +
    constructor +
    FTPTaskMirrorImpl.FTPFileProxy - Class in org.apache.tools.ant.taskdefs.optional.net
    internal class providing a File-like interface to some of the information + available from the FTP server
    FTPTaskMirrorImpl.FTPFileProxy(FTPFile) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
    creates a proxy to a FTP file +
    FTPTaskMirrorImpl.FTPFileProxy(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
    creates a proxy to a FTP directory +
    FullAnalyzer - Class in org.apache.tools.ant.util.depend.bcel
    An analyzer capable fo traversing all class - class relationships.
    FullAnalyzer() - +Constructor for class org.apache.tools.ant.util.depend.bcel.FullAnalyzer +
    Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied +
    Funtest - Class in org.apache.tools.ant.taskdefs.optional.testing
    Task to provide functional testing under Ant, with a fairly complex worflow of: + + + Conditional execution + Application to start + A probe to "waitfor" before running tests + A tests sequence + A reporting sequence that runs after the tests have finished + A "teardown" clause that runs after the rest. + Automated termination of the program it executes, if a timeout is not met + Checking of a failure property and automatic raising of a fault + (with the text in failureText) + if test shutdown and reporting succeeded + + + The task is designed to be framework neutral; it will work with JUnit, + TestNG and other test frameworks That can be + executed from Ant.
    Funtest() - +Constructor for class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
      +
    +
    +

    +G

    +
    +
    G_SIZE - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    garbage_collect - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    Gcj - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the gcj compiler.
    Gcj() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Gcj +
      +
    Gcjh - Class in org.apache.tools.ant.taskdefs.optional.javah
    Adapter to the native gcjh compiler.
    Gcjh() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javah.Gcjh +
      +
    genComponentName(String, String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Map a namespaced {uri,name} to an internal string format. +
    generatedId - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    the current generated id +
    GenerateKey - Class in org.apache.tools.ant.taskdefs
    Generates a key in a keystore.
    GenerateKey() - +Constructor for class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    GenerateKey.DistinguishedName - Class in org.apache.tools.ant.taskdefs
    A class corresponding to the dname nested element.
    GenerateKey.DistinguishedName() - +Constructor for class org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName +
      +
    GenerateKey.DnameParam - Class in org.apache.tools.ant.taskdefs
    A DistinguishedName parameter.
    GenerateKey.DnameParam() - +Constructor for class org.apache.tools.ant.taskdefs.GenerateKey.DnameParam +
      +
    GenericDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    A deployment tool which creates generic EJB jars.
    GenericDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    No arg constructor +
    GenericHotDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.j2ee
    A generic tool for J2EE server hot deployment.
    GenericHotDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
      +
    GENIC_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    GenIC class name (JOnAS 2.5) +
    get(Project) - +Static method in class org.apache.tools.ant.property.LocalProperties +
    Get a localproperties for the given project. +
    Get - Class in org.apache.tools.ant.taskdefs
    Gets a particular file from a URL source.
    Get() - +Constructor for class org.apache.tools.ant.taskdefs.Get +
      +
    get(Object) - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Returns a value for a given key from the cache. +
    get(Object) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Returns a value for a given key from the cache. +
    get(int) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return the component at specified index. +
    get(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    get() - +Method in class org.apache.tools.ant.util.WeakishReference +
    Deprecated. Returns this reference object's referent. +
    Get.Base64Converter - Class in org.apache.tools.ant.taskdefs
    Provide this for Backward Compatibility.
    Get.Base64Converter() - +Constructor for class org.apache.tools.ant.taskdefs.Get.Base64Converter +
      +
    Get.DownloadProgress - Interface in org.apache.tools.ant.taskdefs
    Interface implemented for reporting + progess of downloading.
    Get.NullProgress - Class in org.apache.tools.ant.taskdefs
    do nothing with progress info
    Get.NullProgress() - +Constructor for class org.apache.tools.ant.taskdefs.Get.NullProgress +
      +
    Get.VerboseProgress - Class in org.apache.tools.ant.taskdefs
    verbose progress system prints to some output stream
    Get.VerboseProgress(PrintStream) - +Constructor for class org.apache.tools.ant.taskdefs.Get.VerboseProgress +
    Construct a verbose progress reporter. +
    GET_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    GET_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find out the absolute path of the file +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile +
    find the absolute path +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find out the absolute path of the file +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile +
    find the absolute path +
    getAbsolutePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    getAccount() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getAction() - +Method in class org.apache.tools.ant.dispatch.DispatchTask +
    Get the action. +
    getAction() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Returns the action field. +
    getAction() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.Action +
    Get the symbolic equivalent of the action value. +
    getAction() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Action +
    Get the symbolic equivalent of the action value. +
    getAction() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getActionParameterName() - +Method in interface org.apache.tools.ant.dispatch.Dispatchable +
    Get the name of the parameter. +
    getActionParameterName() - +Method in class org.apache.tools.ant.dispatch.DispatchTask +
    Get the action parameter name. +
    getActions() - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Get the actions. +
    getActualVMCommand() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the VM command parameters, including memory settings. +
    getAdapter(String, ProjectComponent) - +Static method in class org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory +
    Creates the JavahAdapter based on the user choice and + potentially the VM vendor. +
    getAdapter(String, ProjectComponent, Path) - +Static method in class org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory +
    Creates the JavahAdapter based on the user choice and + potentially the VM vendor. +
    getAdapter(String, ProjectComponent) - +Static method in class org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapterFactory +
    Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor. +
    getAdapter(String, ProjectComponent, Path) - +Static method in class org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapterFactory +
    Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor. +
    getAddress() - +Method in class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Returns the address +
    getAddTextMethod() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns the addText method when the introspected + class supports nested text. +
    getAlgorithm() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Get the algorithm type to use. +
    getAntlibClassLoader() - +Method in class org.apache.tools.ant.taskdefs.AntlibDefinition +
    The current antlib classloader +
    getAntTypeTable() - +Method in class org.apache.tools.ant.ComponentHelper +
    Returns the current datatype definition hashtable. +
    getAntVersion() - +Static method in class org.apache.tools.ant.Main +
    Returns the Ant version information, if available. +
    getAppend() - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Returns append attribute. +
    getAppendOutputStream() - +Method in interface org.apache.tools.ant.types.resources.Appendable +
    Get an appending OutputStream. +
    getAppendOutputStream() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get an appending OutputStream. +
    getAppendOutputStream() - +Method in class org.apache.tools.ant.types.resources.LogOutputResource +
    Get an appending OutputStream. +
    getApplicationException() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Get the application exception. +
    getApt() - +Method in class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
    Get the facade task that fronts this adapter +
    getApt() - +Method in class org.apache.tools.ant.taskdefs.compilers.AptExternalCompilerAdapter +
    Get the facade task that fronts this adapter +
    getAptExecutable() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the name of the apt executable. +
    getArchive() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Get the archive that holds this Resource. +
    getArchiveFile(File) - +Static method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Helper method to retrieve the path used to store the JavaCC.zip + or javacc.jar which is different from versions. +
    getArgs() - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Retrieves the command line arguments enabled for the current + facade implementation. +
    getArguments() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Builds the arguments to pass to weblogic.deploy according to the + supplied action. +
    getArguments() - +Method in class org.apache.tools.ant.types.Commandline +
    Returns all arguments defined by addLine, + addValue or the argument object. +
    getAssembledReader() - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Assemble the reader +
    getAssertions() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the current assertions. +
    getAsStream() - +Method in class org.apache.tools.ant.types.spi.Service +
    Return the implementations of this + services as an inputstream. +
    getAtLeast() - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Get the atleast attribute. +
    getAttribute(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Get a attribute of the section +
    getAttribute() - +Method in exception org.apache.tools.ant.UnsupportedAttributeException +
    Get the attribute that is wrong. +
    getAttributeKeys() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Get the attribute keys. +
    getAttributeMap() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns a read-only map of attributes supported by the introspected class. +
    getAttributeMap() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Return the attribute map. +
    getAttributeMethod(String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns the setter method of a named attribute. +
    getAttributes() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns an enumeration of the names of the attributes supported by the introspected class. +
    getAttributes() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Deprecated. Deprecated since Ant 1.6 in favor of RuntimeConfigurable.getAttributeMap(). +
    getAttributes() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Gets this macro's attribute (and define?) list. +
    getAttributes() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory +
    return the attribute elements. +
    getAttributeType(String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns the type of a named attribute. +
    getAttributeValue(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Get the value of the attribute with the name given. +
    getAuthor() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Gets the author of the CVSEntry +
    getAutoresponse() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the auto response string. +
    getAvailable(Manifest) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return an array of Extension objects representing optional + packages that are available in the JAR file associated with the + specified Manifest. +
    getBackTrace() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
      +
    getBase() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the base directory to output generated class. +
    getBase() - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    getBasedir() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the base directory to be scanned. +
    getBasedir() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the base directory to be scanned. +
    getBaseDir() - +Method in class org.apache.tools.ant.Project +
    Return the base directory of the project as a file object. +
    getBasedir() - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    get the base directory +
    getBaseDir() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Return the basedir to which the name is relative. +
    getBaselineRootName() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get baseline_root_name +
    getBeans() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the beans used for the script. +
    getBeginToken() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get the begin token for this filterset. +
    getBlockSize() - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
    Returns the blocksize parameter specified at construction time. +
    getBlockSize() - +Method in class org.apache.tools.tar.TarBuffer +
    Get the TAR Buffer's block size. +
    getBootClassPath() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Combines a user specified bootclasspath with the system + bootclasspath taking build.sysclasspath into account. +
    getBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the bootclasspath that will be used to compile the classes + against. +
    getBootclasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    The bootclasspath to use. +
    getBootclasspath() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the boot classpath. +
    getBorlandDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Get the borland descriptor handler. +
    getBranch() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get branch name +
    getBranch() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    get the branch +
    getBufferSize() - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    Get the size in bytes of the read buffer. +
    getBuildException() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Get any build exception. +
    getBuildFailedMessage() - +Method in class org.apache.tools.ant.DefaultLogger +
    This is an override point: the message that indicates whether a build failed. +
    getBuildFailedMessage() - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    This is an override point: the message that indicates whether + a build failed. +
    getBuildFailedMessage() - +Method in class org.apache.tools.ant.listener.TimestampedLogger +
    This is an override point: the message that indicates whether a build failed. +
    getBuildFile() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the build file +
    getBuildFileParent() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the parent build file of this build file +
    getBuildFileParentURL() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the parent build file of this build file +
    getBuildFileURL() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the build file +
    getBuildListeners() - +Method in class org.apache.tools.ant.Project +
    Return a copy of the list of build listeners for the project. +
    getBuildSuccessfulMessage() - +Method in class org.apache.tools.ant.DefaultLogger +
    This is an override point: the message that indicates that a build succeeded. +
    getBuildSuccessfulMessage() - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    This is an override point: the message that indicates that + a build succeeded. +
    getBuildSuccessfulMessage() - +Method in class org.apache.tools.ant.listener.TimestampedLogger +
    This is an override point: the message that indicates that a build succeeded. +
    getBytes() - +Method in class org.apache.tools.zip.ZipLong +
    Get value as four bytes in big endian byte order. +
    getBytes(long) - +Static method in class org.apache.tools.zip.ZipLong +
    Get value as four bytes in big endian byte order. +
    getBytes(String) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Retrieve the bytes for the given String in the encoding set for + this Stream. +
    getBytes() - +Method in class org.apache.tools.zip.ZipShort +
    Get value as two bytes in big endian byte order. +
    getBytes(int) - +Static method in class org.apache.tools.zip.ZipShort +
    Get value as two bytes in big endian byte order. +
    getCache() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Get the cache type to use. +
    getCachefile() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Getter. +
    getCalendarField() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Unit +
    Convert the value to a Calendar field index. +
    getCalendarField() - +Method in class org.apache.tools.ant.taskdefs.Tstamp.Unit +
    Convert the value to int unit value. +
    getCatalogPath() - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Returns the catalog path in which to attempt to resolve DTDs. +
    getCcmAction() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Get the value of ccmAction. +
    getCcmCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Builds and returns the command string to execute ccm +
    getCcmProject() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Get the value of project. +
    getCentralDirectoryData() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getCentralDirectoryData() - +Method in class org.apache.tools.zip.AsiExtraField +
    Delegate to local file data. +
    getCentralDirectoryData() - +Method in class org.apache.tools.zip.JarMarker +
    The actual data to put central directory - without Header-ID or + length specifier. +
    getCentralDirectoryData() - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    The actual data to put into central directory. +
    getCentralDirectoryData() - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Get the central data. +
    getCentralDirectoryData() - +Method in interface org.apache.tools.zip.ZipExtraField +
    The actual data to put into central directory - without Header-ID or + length specifier. +
    getCentralDirectoryExtra() - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves the extra data for the central directory. +
    getCentralDirectoryLength() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getCentralDirectoryLength() - +Method in class org.apache.tools.zip.AsiExtraField +
    Delegate to local file data. +
    getCentralDirectoryLength() - +Method in class org.apache.tools.zip.JarMarker +
    Length of the extra field in the central directory - without + Header-ID or length specifier. +
    getCentralDirectoryLength() - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    Length of the complete extra field in the central directory. +
    getCentralDirectoryLength() - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Get the central data length. +
    getCentralDirectoryLength() - +Method in interface org.apache.tools.zip.ZipExtraField +
    Length of the extra field in the central directory - without + Header-ID or length specifier. +
    getChange() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    get the changelist number +
    getCharset() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Returns the character set of mail message. +
    getCharset() - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Returns the charset of mail message. +
    getCheckClass() - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Get the comparison class. +
    getCheckedRef(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Performs the check for circular references and returns the + referenced object. +
    getCheckedRef() - +Method in class org.apache.tools.ant.types.DataType +
    Performs the check for circular references and returns the + referenced object. +
    getCheckedRef(Project) - +Method in class org.apache.tools.ant.types.DataType +
    Performs the check for circular references and returns the + referenced object. +
    getCheckedRef(Class, String) - +Method in class org.apache.tools.ant.types.DataType +
    Performs the check for circular references and returns the + referenced object. +
    getCheckedRef(Class, String, Project) - +Method in class org.apache.tools.ant.types.DataType +
    Performs the check for circular references and returns the + referenced object. +
    getCheckin() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get ci flag status +
    getCheckSumOctalBytes(long, byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Parse the checksum octal integer from a header buffer. +
    getChild(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get a child directory of this directory. +
    getChildByTagName(Node, String) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil +
    Iterate over the children of a given node and return the first node + that has a specific name. +
    getChildren() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Returns an enumeration of all child wrappers. +
    getChildren() - +Method in class org.apache.tools.ant.UnknownElement +
      +
    getChmod() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getChoices() - +Method in class org.apache.tools.ant.input.MultipleChoiceInputRequest +
      +
    getClassContainer(String) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Get the file that contains the class definition +
    getClassContainer(String) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Get the file that contains the class definition +
    getClassDependencies() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Get the list of classes upon which root classes depend. +
    getClassDependencies() - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Get the list of classes upon which root classes depend. +
    getClassEntry(String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given CONSTANT_CLASS entry in the constant pool. +
    getClasses() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Names of the classes to process. +
    getClassespath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Gets the classespath. +
    getClassLoader() - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Get the classloader for this definition. +
    getClassLoader() - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Get the classloader for this definition. +
    getClassLoader() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    combines the various ways that could specify a ClassLoader and + potentially creates one that needs to be cleaned up when it is + no longer needed so that classes can get garbage collected. +
    getClassLoader() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Returns and initializes the classloader for this class. +
    getClassLoader() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Finds or creates the classloader for this object. +
    getClassLoaderForBuild() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Returns a Classloader object which parses the passed in generic EjbJar classpath. +
    getClassLoaderForPath(Project, Reference) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Convenience overloaded version of ClasspathUtils.getClassLoaderForPath(Project, Reference, boolean). +
    getClassLoaderForPath(Project, Reference, boolean) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Convenience overloaded version of ClasspathUtils.getClassLoaderForPath(Project, Path, + String, boolean). +
    getClassLoaderForPath(Project, Path, String) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Convenience overloaded version of ClasspathUtils.getClassLoaderForPath(Project, Path, String, boolean). +
    getClassLoaderForPath(Project, Path, String, boolean) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Convenience overloaded version of ClasspathUtils.getClassLoaderForPath(Project, Path, String, boolean, boolean). +
    getClassLoaderForPath(Project, Path, String, boolean, boolean) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Gets a classloader that loads classes from the classpath + defined in the path argument. +
    getClassLoaderFromJar(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it. +
    getClassLoaderFromJar(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it. +
    getClassLoadId() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Computes the loaderId based on the configuration of the component. +
    getClassName() - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Get the classname of the definition. +
    getClassname() - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Returns the classname of the object we are defining. +
    getClassname() - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Get the classname of the InputHandler. +
    getClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo +
    Get the class name of this entry. +
    getClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Get the classname attribute. +
    getClassName(InputStream) - +Static method in class org.apache.tools.ant.taskdefs.optional.jlink.ClassNameReader +
    Get the class name of a class in an input stream. +
    getClassname() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Get name of class to be used as the formatter. +
    getClassName() - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Get the classname of the definition. +
    getClassname() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the class name to compile. +
    getClassName() - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Get the className attribute. +
    getClassName() - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    what is the class name? +
    getClassname() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the name of the class to be run. +
    getClassname() - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet.ClassRoot +
    Get the name of the root class. +
    getClassName() - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Get the class of the permission. +
    getClassName() - +Method in class org.apache.tools.ant.types.spi.Provider +
      +
    getClasspath() - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns the classpath this classloader will consult. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
      +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the classpath to be used for this compilation. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the classpath. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    get the classpath used by this LoadProperties. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Gets the classpath to be used for this dependency check. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    gets the classpath field. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    gets the classpath field. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    The classpath to use. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Gets the classpath to be used for this compilation. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the classpath. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the classpath used when looking up a resource. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Gets the CLASSPATH this rmic process will use. +
    getClasspath() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the classpath. +
    getClasspath() - +Method in interface org.apache.tools.ant.taskdefs.rmic.RmicAdapter +
    The CLASSPATH this rmic process will use. +
    getClasspath() - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Get the classpath. +
    getClasspath() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the classpath for the command. +
    getClasspath() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    get the classpath used by this LoadProperties. +
    getClasspath() - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Get the classpath +
    getClasspath() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    The classpath. +
    getClasspathId() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Returns the class path id of the class path delegate. +
    getClassRefs() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.ClassFile +
    Get the classes which this class references. +
    getClassSource(Class) - +Static method in class org.apache.tools.ant.launch.Locator +
    Find the directory or jar file the class has been loaded from. +
    getClassSource(Class) - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Find the directory or jar file the class has been loaded from. +
    getClearToolCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Builds and returns the command string to execute cleartool +
    getClient() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    return the attached FTP client object. +
    getClient() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    return the attached FTP client object. +
    getClientVersion() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    Get the CVS client version +
    getCmpDescriptors() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Returns the list of CMP descriptors referenced in the EJB descriptors. +
    getCmpversion() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Gets the CMP version. +
    getCode() - +Method in class org.apache.tools.ant.taskdefs.condition.IsFailure +
    Get the return code that will be checked by this IsFailure condition. +
    getCollapseAttributes() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Template method for subclasses to return a Collection object of Resources. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper +
    Template method for subclasses to return a Collection of Resources. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Difference +
    Calculate the difference of the nested ResourceCollections. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.First +
    Take the first count elements. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Intersect +
    Calculate the intersection of the nested ResourceCollections. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Last +
    Take the last count elements. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Sort +
    Sort the contained elements. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Tokens +
    Sort the contained elements. +
    getCollection() - +Method in class org.apache.tools.ant.types.resources.Union +
    Unify the contained Resources. +
    getCollection(boolean) - +Method in class org.apache.tools.ant.types.resources.Union +
    Unify the contained Resources. +
    getColorByName(String) - +Static method in class org.apache.tools.ant.types.optional.image.ColorMapper +
    Convert a color name to a color value. +
    getColumnNumber() - +Method in class org.apache.tools.ant.Location +
      +
    getCombinedClasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the classpath by combining the one from the surrounding task, if any + and the one from this tool. +
    getCommand() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    accessor to a command line as string + + This should be deprecated + AntoineLL July 23d 2003 +
    getCommandline() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Returns the commandline used to create a subprocess. +
    getCommandline(String[], File[]) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Construct the command line for parallel execution. +
    getCommandline(String, File) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Construct the command line for serial execution. +
    getCommandLine() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Accessor to the command line. +
    getCommandline() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Get the command line used to run the tests. +
    getCommandline() - +Method in class org.apache.tools.ant.types.Commandline +
    Return the executable and all defined arguments. +
    getCommandline() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the command line to run a Java vm. +
    getCommandPrefix() - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    get the prefix used to begin the command; -ea or -da. +
    getCommandPrefix() - +Method in class org.apache.tools.ant.types.Assertions.DisabledAssertion +
    get the prefix used to begin the command; -ea or -da. +
    getCommandPrefix() - +Method in class org.apache.tools.ant.types.Assertions.EnabledAssertion +
    get the prefix used to begin the command; -ea or -da. +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Gets the comment for the CVSEntry +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Get the value of comment. +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of comment. +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get comment method +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get comment string +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Get comment method +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the comment +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the comment string. +
    getComment() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Comment of the archive +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get comment file +
    getCommentFile() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get comment file +
    getComparator() - +Method in class org.apache.tools.ant.filters.SortFilter +
    Returns the comparator to be used for sorting. +
    getComparator() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Get the comparator type to use. +
    getCompatibilityWith(Extension) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return a Compatibility enum indicating the relationship of this + Extension with the specified Extension. +
    getCompatibilityWith(Specification) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Return a Compatibility enum indicating the relationship of this + Package Specification with the specified + Extension. +
    getCompileClasspath() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Builds the compilation classpath. +
    getCompileClasspath() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Builds the compilation classpath. +
    getCompiledPattern(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Get a compiled representation of the regexp pattern +
    getCompiledPattern(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Compile the pattern. +
    getCompiledPattern(int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Get a compiled representation of the regexp pattern +
    getCompileList() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    get the list of files to compile +
    getCompileList() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
      +
    getCompiler() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the compiler class name. +
    getCompiler(String, Task) - +Static method in class org.apache.tools.ant.taskdefs.compilers.CompilerAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getCompiler(String, Task, Path) - +Static method in class org.apache.tools.ant.taskdefs.compilers.CompilerAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getCompiler() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The implementation for this particular task. +
    getCompiler(String, Task) - +Static method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getCompiler(String, Task, AntClassLoader) - +Static method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getCompiler() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    get the name of the current compiler +
    getCompilerclasspath() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    get the classpath used to find the compiler adapter +
    getCompilerOptions(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Convert the generic options to the regex compiler specific options. +
    getCompilerOptions(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Convert the generic options to the regex compiler specific options. +
    getCompilerOptions(int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Convert the generic options to the regex compiler specific options. +
    getCompilerVersion() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The implementation for this particular task. +
    getComponentClass(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Return the class of the component name. +
    getComponentHelper(Project) - +Static method in class org.apache.tools.ant.ComponentHelper +
    Find a project component for a specific project, creating + it if it does not exist. +
    getComponentName() - +Method in class org.apache.tools.ant.UnknownElement +
      +
    getCompressionName() - +Method in class org.apache.tools.ant.types.resources.BZip2Resource +
    Get the name of the compression method. +
    getCompressionName() - +Method in class org.apache.tools.ant.types.resources.CompressedResource +
    Get the name of the compression method used. +
    getCompressionName() - +Method in class org.apache.tools.ant.types.resources.GZipResource +
    Get the name of the compression method. +
    getConditions() - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Iterate through all conditions. +
    getConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the basename terminator. +
    getConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    returns the path of the configuration file to be used +
    getConfiguredParent() - +Method in class org.apache.tools.ant.AntClassLoader +
    Gets the parent as has been specified in the constructor or via + setParent. +
    getConnection() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Creates a new Connection as using the driver, url, userid and password + specified. +
    getConnection() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Caches the connection returned by the base class's getConnection method. +
    getConstantEntry(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given constant value entry in the constant pool. +
    getConstants(byte[]) - +Static method in class org.apache.tools.ant.filters.util.JavaClassHelper +
    Get the constants declared in a file as name=value +
    getContent() - +Method in class org.apache.tools.ant.types.Environment.Variable +
    get the assigment string + This is not ready for insertion into a property file without following + the escaping rules of the properties class. +
    getContent() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the content of this StringResource. +
    getContextClassLoader() - +Static method in class org.apache.tools.ant.ProjectHelper +
    Deprecated. since 1.6.x. + Use LoaderUtils.getContextClassLoader() +
    getContextClassLoader() - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    JDK1.1 compatible access to set the context class loader. +
    getCopyOfDataTypeDefinitions() - +Method in class org.apache.tools.ant.Project +
    Return the current datatype definition map. +
    getCopyOfReferences() - +Method in class org.apache.tools.ant.Project +
    Return a map of the references in the project (String to + Object). +
    getCopyOfTargets() - +Method in class org.apache.tools.ant.Project +
    Return the map of targets. +
    getCopyOfTaskDefinitions() - +Method in class org.apache.tools.ant.Project +
    Return the current task definition map. +
    getCoreLoader() - +Method in class org.apache.tools.ant.Project +
    Return the core classloader to use for this project. +
    getCount() - +Method in class org.apache.tools.ant.types.resources.SizeLimitCollection +
    Get the number of resources to be included. +
    getCreateUnicodeExtraFields() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether Unicode extra fields will be created. +
    getCurpwd() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    returns the path of the directory containing the AntFTPFile. +
    getCurpwd() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    returns the path of the directory containing the AntFTPFile. +
    getCurpwdPlusFileSep() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    returns the path of the directory containing the AntFTPFile. +
    getCurpwdPlusFileSep() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    returns the path of the directory containing the AntFTPFile. +
    getCurrentAntHandler() - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Returns the current ant handler object. +
    getCurrentAntlibUri() - +Method in class org.apache.tools.ant.ComponentHelper +
      +
    getCurrentArgs() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Returns the (implementation specific) settings given as nested + arg elements. +
    getCurrentArgs() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Returns the (implementation specific) settings given as nested + arg elements. +
    getCurrentBlockNum() - +Method in class org.apache.tools.tar.TarBuffer +
    Get the current block number, zero based. +
    getCurrentCompilerArgs() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the additional implementation specific command line arguments. +
    getCurrentCompilerArgs() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Get the additional implementation specific command line arguments. +
    getCurrentExtraFields() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Provides the extra fields for the zip entry currently being + added to the archive - if any. +
    getCurrentPrefixSeparator() - +Static method in class org.apache.tools.ant.ProjectHelper +
    The separator between the prefix and the target name. +
    getCurrentProjectName() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the current project name +
    getCurrentRecordNum() - +Method in class org.apache.tools.tar.TarBuffer +
    Get the current record number, within the current block, zero based. +
    getCurrentTarget() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    get the current target +
    getCurrentTargetPrefix() - +Static method in class org.apache.tools.ant.ProjectHelper +
    The prefix to prepend to imported target names. +
    getCurrentTargets() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    Get the targets in the current source file. +
    getCurrentTime() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get current time status +
    getCvsRoot() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the CVSROOT variable +
    getCvsRsh() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the CVS_RSH variable +
    getDataTypeDefinitions() - +Method in class org.apache.tools.ant.ComponentHelper +
    Returns the current type definition hashtable. +
    getDataTypeDefinitions() - +Method in class org.apache.tools.ant.Project +
    Return the current datatype definition hashtable. +
    getDataTypeName() - +Method in class org.apache.tools.ant.types.DataType +
    Gets as descriptive as possible a name used for this datatype instance. +
    getDate() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Gets the date of the CVSEntry +
    getDate() - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Return the current Date in a format suitable for a SMTP date + header. +
    getDateForHeader() - +Static method in class org.apache.tools.ant.util.DateUtils +
    Returns the current Date in a format suitable for a SMTP date + header. +
    getDatetime() - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Get the date & time in String format. +
    getDebug() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the debug flag. +
    getDebug() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the debug flag. +
    getDebugLevel() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the value of debugLevel. +
    getDefault() - +Static method in class org.apache.tools.ant.taskdefs.Checksum.FormatElement +
    Get the default value - CHECKSUM. +
    getDefault() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    getDefault() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    getDefault() - +Static method in class org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory +
    Determines the default choice of adapter based on the VM + vendor. +
    getDefault() - +Static method in class org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapterFactory +
    Determines the default choice of adapter based on the VM + vendor. +
    getDefaultBuildFile() - +Method in class org.apache.tools.ant.ProjectHelper +
    The file name of the build script to be parsed if none specified on the command line +
    getDefaultBuildFile() - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Get the default build file name to use when launching the task. +
    getDefaultBuildFile() - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Get the default build file name to use when launching the task. +
    getDefaultDateFormatConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getDefaultDateFormatConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getDefaultEncoding() - +Method in class org.apache.tools.ant.util.FileUtils +
    Get the default encoding. +
    getDefaultExcludes() - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Get the list of patterns that should be excluded by default. +
    getDefaultexcludes() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Whether default exclusions should be used or not. +
    getDefaultexcludes() - +Method in class org.apache.tools.ant.types.resources.Files +
    Get whether default exclusions should be used or not. +
    getDefaultExtension() - +Method in class org.apache.tools.ant.taskdefs.BUnzip2 +
    Get the default extension. +
    getDefaultExtension() - +Method in class org.apache.tools.ant.taskdefs.GUnzip +
    Get the default extension. +
    getDefaultExtension() - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Get the extension. +
    getDefaultInputStream() - +Method in class org.apache.tools.ant.Project +
    Get this project's input stream. +
    getDefaultManifest() - +Static method in class org.apache.tools.ant.taskdefs.Manifest +
    Construct a manifest from Ant's default manifest file. +
    getDefaultOutput() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Get the default output for a formatter. +
    getDefaultTarget() - +Method in class org.apache.tools.ant.Project +
    Return the name of the default target of the project. +
    getDefaultValue() - +Method in class org.apache.tools.ant.input.InputRequest +
    Gets a configured default value. +
    getDefinition(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    Return the antTypeDefinition for a componentName. +
    getDelayUpdate() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Getter for the delay update +
    getDelegate(ProjectComponent) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Obtains a delegate that helps out with classic classpath configuration. +
    getDelegateInterfaces(PropertyHelper.Delegate) - +Static method in class org.apache.tools.ant.PropertyHelper +
    Get all Delegate interfaces (excluding Delegate itself) from the specified Delegate. +
    getDelegates(Class) - +Method in class org.apache.tools.ant.PropertyHelper +
    Get the Collection of delegates of the specified type. +
    getDelimiter() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Get the current delimiter. +
    getDepend() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the depend flag. +
    getDependencies() - +Method in class org.apache.tools.ant.Target +
    Returns an enumeration of the dependencies of this target. +
    getDependencies() - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Get the dependencies collected by this visitor +
    getDeprecation() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the deprecation flag. +
    getDescription() - +Method in class org.apache.tools.ant.Project +
    Return the project description, if one has been set. +
    getDescription() - +Method in class org.apache.tools.ant.ProjectComponent +
    Returns the description of the current action. +
    getDescription() - +Method in class org.apache.tools.ant.Target +
    Returns the description of this target. +
    getDescription() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    getDescription() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Gets the description of this element. +
    getDescription() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    getDescription() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    getDescription(Project) - +Static method in class org.apache.tools.ant.types.Description +
    Return the descriptions from all the targets of + a project. +
    getDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get a descriptionHandler. +
    getDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
    Get the descriptor handler. +
    getDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Get a descriptionHandler.. +
    getDeselectedDirectories() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the directories which were selected out and + therefore not ultimately included. +
    getDeselectedDirectories() - +Method in interface org.apache.tools.ant.types.selectors.SelectorScanner +
    Directories which were selected out of a scan. +
    getDeselectedFiles() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the files which were selected out and + therefore not ultimately included. +
    getDeselectedFiles() - +Method in interface org.apache.tools.ant.types.selectors.SelectorScanner +
    Files which were selected out of a scan. +
    getDest() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    get the file where the checked out files should be placed +
    getDestdir() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the destination directory into which the java source files + should be compiled. +
    getDestdir() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Gets the destination directory. +
    getDestDir() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the destination directory. +
    getDestdir() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    The destination directory, if any. +
    getDestdir() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the destination directory. +
    getDestdir() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the base directory to output the generated files. +
    getDestFile() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    The file to create. +
    getDestinationFile() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Get the full destination file where to write the result. +
    getDir() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getDir() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Retrieves the base-directory for this instance. +
    getDir(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Retrieves the base-directory for this instance. +
    getDir(Project) - +Method in class org.apache.tools.ant.types.FileList +
      +
    getDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC.WebAppParameter +
    query current directory +
    getDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get the directory file. +
    getDirectoryEntries() - +Method in class org.apache.tools.tar.TarEntry +
    If this entry represents a file, and the file is a directory, return + an array of TarEntries for this entry's children. +
    getDirectoryScanner(File) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Returns the directory scanner needed to access the files to process. +
    getDirectoryScanner() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Returns the directory scanner needed to access the files to process. +
    getDirectoryScanner(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Returns the directory scanner needed to access the files to process. +
    getDirectoryScanner(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Return the DirectoryScanner associated with this FileSet. +
    getDirectoryScanner(Project) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Return the DirectoryScanner associated with this FileSet. +
    getDirMode(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Get the dir mode of the archive fileset +
    getDirMode() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Deprecated. since 1.7. +
    getDirs(File, DirectoryScanner) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Return the list of Directories from this DirectoryScanner that + should be included on the command line. +
    getDisplayname() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
    Get the user's full name +
    getDisplayName() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Returns the display-name element read from the standard EJB descriptor. +
    getDocumentBuilder() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns a newly created DocumentBuilder. +
    getDocumentBuilderFactory() - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    Get the Document Builder Factory +
    getDuration() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Gets the duration in milliseconds the file should be played. +
    getDynamic() - +Method in class org.apache.tools.ant.types.PropertySet +
    Get the dynamic attribute. +
    getEjbcClass() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Get the ejbc compiler class. +
    getEjbFiles() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Returns a Hashtable which contains a list of EJB class files processed by + the ejbc utility (both "source" class files as well as stubs and + skeletons). +
    getEjbName() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Getter method that returns the value of the <ejb-name> element. +
    getElement() - +Method in exception org.apache.tools.ant.UnsupportedElementException +
    Get the element that is wrong. +
    getElementCreator(Project, String, Object, String, UnknownElement) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    returns an object that creates and stores an object + for an element of a parent. +
    getElementHandler() - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Returns element handler +
    getElementMethod(String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns the adder or creator method of a named nested element. +
    getElementName(Object) - +Method in class org.apache.tools.ant.ComponentHelper +
    Returns a description of the type of the given element. +
    getElementName(Object, boolean) - +Method in class org.apache.tools.ant.ComponentHelper +
    Returns a description of the type of the given element. +
    getElementName(Project, Object, boolean) - +Static method in class org.apache.tools.ant.ComponentHelper +
    Convenient way to get some element name even when you may not have a + Project context. +
    getElementName(Object) - +Method in class org.apache.tools.ant.Project +
    Return a description of the type of the given element, with + special handling for instances of tasks and data types. +
    getElements() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Gets this macro's elements. +
    getElements() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    True if the listener is to print events that occur as each + node is 'executed' in the stylesheet. +
    getElementTag() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Returns the tag name of the wrapped element. +
    getElementType(String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns the type of a named nested element. +
    getEltype() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get element type +
    getEmptyChangeList() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
    returns the text of an empty change list +
    getEnableRemoteVerification() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getEnableTestListenerEvents() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Whether test listener events shall be generated. +
    getEncoding() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get the character encoding to be used. +
    getEncoding() - +Method in class org.apache.tools.ant.taskdefs.Expand +
      +
    getEncoding() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the java source file encoding name. +
    getEncoding() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    The value of the encoding attribute. +
    getEncoding() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Encoding to use for filenames. +
    getEncoding() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the encoding used by this StringResource. +
    getEncoding() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Get the encoding to use with the zipfile. +
    getEncoding() - +Method in class org.apache.tools.ant.types.ZipFileSet +
    Get the encoding used for this ZipFileSet. +
    getEncoding() - +Method in class org.apache.tools.zip.ZipFile +
    The encoding to use for filenames and the file comment. +
    getEncoding() - +Method in class org.apache.tools.zip.ZipOutputStream +
    The encoding to use for filenames and the file comment. +
    getEndToken() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get the end token for this filterset. +
    getEntityResolver() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    accessor to the xmlCatalog used in the task +
    getEntityResolver() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getEntries() - +Method in class org.apache.tools.zip.ZipFile +
    Returns all entries. +
    getEntry(int) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get an constant pool entry at a particular index. +
    getEntry(String) - +Method in class org.apache.tools.zip.ZipFile +
    Returns a named entry - or null if no entry by + that name exists. +
    getEnvironment() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Returns the environment used to create a subprocess. +
    getEnvironment() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the environment attribute. +
    getEnvironmentVariables() - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    Find the list of environment variables for this process. +
    getEof() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Get how DOS EOF (control-z) characters are being handled. +
    getEofStr() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. get the eof string. +
    getEol() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Get how EndOfLine characters are being handled. +
    getErr() - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Get the error stream. +
    getError() - +Method in class org.apache.tools.ant.types.selectors.BaseSelector +
    Returns any error messages that have been set. +
    getErrorFlag() - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Indicate if there were errors during the compile +
    getErrorMessage() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    gets the error message recorded by the Perforce handler +
    getErrorOnMissingDir() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Gets whether an error is/shold be thrown if the base directory + does not exist. +
    getErrorProperty() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the failure property name. +
    getErrorStream() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the stream to which the stderr from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute error + has been set, the output stream will go to the file denoted by the error attribute + otherwise the stderr output will go to ant's logging system +
    getErrorStream() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Get the error stream for the redirector +
    getExactly() - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Get the exactly attribute. +
    getException() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the exception that was thrown, if any. +
    getException() - +Method in exception org.apache.tools.ant.BuildException +
    Deprecated. Use Throwable.getCause() instead. +
    getException() - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    Get the exception encountered, if any. +
    getException() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Get whatever was thrown, which may or may not be a buildException. +
    getExcludedDirectories() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns. +
    getExcludedDirectories() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns. +
    getExcludedDirectories() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.. +
    getExcludedFiles() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns. +
    getExcludedFiles() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns. +
    getExcludedFiles() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.. +
    getExcludePatterns(Project) - +Method in class org.apache.tools.ant.types.PatternSet +
    Returns the filtered include patterns. +
    getExcludes() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getExecutable() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The value of the executable attribute, if any. +
    getExecutable() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Explicitly specified name of the executable to use when forking + - if any. +
    getExecutable() - +Method in class org.apache.tools.ant.types.Commandline +
    Get the executable. +
    getExecutableName() - +Method in class org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic +
    Override point. +
    getExecute(Commandline, ExecuteStreamHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Get the execute object. +
    getExecuteStreamHandler() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    find the handler and instantiate it if it does not exist yet +
    getExecutor() - +Method in class org.apache.tools.ant.Project +
    Get this Project's Executor (setting it if necessary). +
    getExitValue() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Query the exit value of the process. +
    getExpanders() - +Method in class org.apache.tools.ant.PropertyHelper +
    Get the expanders. +
    getExpandProperties() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    is property expansion inside inline text enabled? +
    getExplicitChoice() - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Retrieves the explicit user choice. +
    getExposedClass(Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Get the exposed class for this + definition. +
    getExposedClass(Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Get the exposed class for this definition. +
    getExpression() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Get the parameter's value +
    getExpression(Project) - +Method in class org.apache.tools.ant.types.Substitution +
    Gets the pattern string for this RegularExpression in the + given project. +
    getExtdirs() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the extension directories that will be used during the + compilation. +
    getExtdirs() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the extension directories that will be used during the + compilation. +
    getExtension() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Get the extension used for the report file. +
    getExtension() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    True if the listener is to print information after each + extension event. +
    getExtensionName() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the name of the extension. +
    getExtensionPoints() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns a read-only list of extension points supported + by the introspected class. +
    getExtensionStack() - +Method in class org.apache.tools.ant.ProjectHelper +
    Extension stack. +
    getExternalAttributes() - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves the external file attributes. +
    getExtraField(ZipShort) - +Method in class org.apache.tools.zip.ZipEntry +
    Looks up an extra field by its header id. +
    getExtraFields() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Retrieves extra fields. +
    getExtraFields() - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves all extra fields that have been parsed successfully. +
    getExtraFields(boolean) - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves extra fields. +
    getFactory() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the factory option for the apt compiler. +
    getFactory() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Get the factory instance configured for this processor +
    getFactoryPath() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the factory path attribute. +
    getFailOnEmptyArchive() - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Whether try ing to expand an empty archive would be an error. +
    getFailOnErr() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Get failonerr flag status +
    getFailonerror() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the failonerror flag. +
    getFailonerror() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Gets the failonerror flag. +
    getFailonerror() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Get the failonerror flag. +
    getFailure() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
    did an error happen during last parsing ? +
    getFailureProperty() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the failure property name. +
    getFallbackFormat() - +Method in interface org.apache.tools.ant.taskdefs.Touch.DateFormatFactory +
      +
    getFallBackToUTF8() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding. +
    getFastRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case. +
    getFastRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case. +
    getField(Object, String) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Get the value of a field in an object. +
    getFieldClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Gets the name of the class defining the field +
    getFieldName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Get the name of the field +
    getFieldRefEntry(String, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given CONSTANT_FIELDREF entry in the constant + pool. +
    getFieldType() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Get the type of the field +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Gets the filename for this CvsTagEntry +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.Definer +
      +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.SourceFile +
    Get the source file. +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Get the value of file. +
    getFile(FTPFile[], String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find a file matching a string in an array of FTPFile. +
    getFile(FTPClient, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Retrieve a single file from the remote host. +
    getFile(FTPFile[], String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find a file matching a string in an array of FTPFile. +
    getFile(FTPClient, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Retrieve a single file from the remote host. +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Get the file. +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the file attribute. +
    getFile() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getFile() - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    get the file that is currently to be tested +
    getFile() - +Method in interface org.apache.tools.ant.types.resources.FileProvider +
    Get the file represented by this Resource. +
    getFile() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the file represented by this FileResource. +
    getFile() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's file. +
    getFileDependencies() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Get the list of files in the file system upon which the root classes + depend. +
    getFileDependencies() - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Get the list of files in the file system upon which the root classes + depend. +
    getFileList() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the list of files to be compiled. +
    getFileList() - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Get the complete list of files to be included in the cab. +
    getFileList() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets file list to compile. +
    getFileMode(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Get the mode of the archive fileset +
    getFileMode() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Deprecated. since 1.7. +
    getFileName() - +Method in class org.apache.tools.ant.Location +
      +
    getFilename() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the filename to be acted upon. +
    getFilename() - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
      +
    getFilename() - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    get the filename of the file +
    getFilenameFormat() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    The filenameFormat attribute defines a MessageFormat string used + to parse the output of the pcli command. +
    getFileNames(FileSet) - +Static method in class org.apache.tools.ant.taskdefs.Tar +
    Grabs all included files and directors from the FileSet and + returns them as an array of (relative) file names. +
    getFiles() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Gets the files in this CVSEntry +
    getFiles(File, DirectoryScanner) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Return the list of files from this DirectoryScanner that should + be included on the command line. +
    getFiles() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Getter method that returns the set of files to include in the EJB jar. +
    getFiles() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Get all .xml files in the fileset. +
    getFiles(Project) - +Method in class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
    Get a list of files and directories specified in the fileset. +
    getFiles(Project) - +Method in class org.apache.tools.ant.types.FileList +
    Returns the list of files represented by this FileList. +
    getFilesAndDirs(FileList) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Return the list of files or directories from this FileList that + should be included on the command line. +
    getFilesets() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getFileTimeStamp() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the value set for the FileTimeStamp. +
    getFileTimestampGranularity() - +Method in class org.apache.tools.ant.util.FileUtils +
    Get the granularity of file timestamps. +
    getFileURL(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Get the URL for a file taking into account # characters. +
    getFileUtils() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get the FileUtils for this task. +
    getFileUtils() - +Static method in class org.apache.tools.ant.util.FileUtils +
    Method to retrieve The FileUtils, which is shared by all users of this + method. +
    getFilterChains() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get the filterchains being applied to this operation. +
    getFilteredTrace(Throwable) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Returns a filtered stack trace. +
    getFilterHash() - +Method in class org.apache.tools.ant.types.FilterSet +
    Gets the filter hash of the FilterSet. +
    getFiltering() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets whether token filtering is set +
    getFilterReaders() - +Method in class org.apache.tools.ant.types.FilterChain +
    Return the filters. +
    getFilters() - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x + Use getGlobalFilterSet().getFilterHash(). +
    getFilters() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get the filters in the filter set. +
    getFilterSets() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get the filtersets being applied to this operation. +
    getFiltertrace() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the filtertrace attribute. +
    getFixlast() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Get whether a missing EOL be added to the final line of the stream. +
    getFooter() - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Override point: return the footer string for the entry/exit message +
    getForce() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Whether read-only destinations will be overwritten. +
    getForce() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Whether output files should always be written. +
    getForce() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get value of force +
    getFork() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getFork() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the fork attribute. +
    getFormat() - +Method in class org.apache.tools.ant.taskdefs.Checksum.FormatElement +
    Convert this enumerated type to a MessageFormat. +
    getFormatters() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the formatters set for this test. +
    getFragment() - +Method in class org.apache.tools.ant.util.XMLFragment +
      +
    getFromfile() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    get the from file specification +
    getFull() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get full flag status +
    getFullClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.ClassFile +
    Get the class' fully qualified name in dot format. +
    getFullpath(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Return the full pathname of the single entry in this fileset. +
    getFullpath() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Deprecated. since 1.7. +
    getFunnelInstance() - +Method in class org.apache.tools.ant.util.OutputStreamFunneler +
    Get a "funnel" OutputStream instance to + write to this OutputStreamFunneler's underlying + OutputStream. +
    getGeneration() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    True if the listener is to print information after each + result-tree generation event. +
    getGetLocalCopy() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Builds and returns the -G- flag if required. +
    getGid() - +Method in class org.apache.tools.ant.types.resources.TarResource +
      +
    getGid() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    getGlobal() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get global flag status +
    getGlobalFilterSet() - +Method in class org.apache.tools.ant.Project +
    Return the set of global filters. +
    getGranularity() - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Get the timestamp granularity used by this ResourceSelector. +
    getGranularityMillis() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getGraphical() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get graphical flag status +
    getGroup() - +Method in class org.apache.tools.ant.types.resources.TarResource +
      +
    getGroup() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    getGroupId() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's group id. +
    getGroupId() - +Method in class org.apache.tools.zip.AsiExtraField +
    Get the group id. +
    getGroupName() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's group name. +
    getGroups(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Returns a Vector of matched groups found in the argument + using default options. +
    getGroups(String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Returns a Vector of matched groups found in the argument. +
    getGroups(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Returns a Vector of matched groups found in the argument + using default options. +
    getGroups(String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Returns a Vector of matched groups found in the argument. +
    getGroups(String) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Returns a Vector of matched groups found in the argument + using default options. +
    getGroups(String, int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Returns a Vector of matched groups found in the argument. +
    getGroups(String) - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Returns a Vector of matched groups found in the argument + using default options. +
    getGroups(String, int) - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Get the match groups from this regular expression. +
    getHaltonerror() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getHaltonerror() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the haltonerror attribute. +
    getHaltonfailure() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the haltonfailure attribute. +
    getHeader() - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Override point: return the header string for the entry/exit message +
    getHeaderId() - +Method in class org.apache.tools.zip.AsiExtraField +
    The Header-ID. +
    getHeaderId() - +Method in class org.apache.tools.zip.JarMarker +
    The Header-ID. +
    getHeaderId() - +Method in class org.apache.tools.zip.UnicodeCommentExtraField +
      +
    getHeaderId() - +Method in class org.apache.tools.zip.UnicodePathExtraField +
      +
    getHeaderId() - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    The Header-ID. +
    getHeaderId() - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Get the header id. +
    getHeaderId() - +Method in interface org.apache.tools.zip.ZipExtraField +
    The Header-ID. +
    getHeight() - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Get the height. +
    getHelper(Class) - +Static method in class org.apache.tools.ant.IntrospectionHelper +
    Returns a helper for the given class, either from the cache + or by creating a new instance. +
    getHelper(Project, Class) - +Static method in class org.apache.tools.ant.IntrospectionHelper +
    Returns a helper for the given class, either from the cache + or by creating a new instance. +
    getHelpers() - +Method in class org.apache.tools.ant.ProjectHelperRepository +
    Get an iterator on the list of project helpers configured. +
    getHost() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Get the host. +
    getHref() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Get the href attribute. +
    getId() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Returns the id for this element. +
    getIdentical() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get identical flag status +
    getIdentical() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get identical flag status +
    getIdl() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets IDL flags. +
    getIdlopts() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets additional arguments for idl compile. +
    getIeplugin() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the IE CLASSID value. +
    getIf() - +Method in class org.apache.tools.ant.Target +
    Returns the "if" property condition of this target. +
    getIfCondition() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    The if expression +
    getIgnore() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get ignore flag status +
    getIgnoreReturnCode() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get value of ignorereturncode +
    getIiop() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets iiop flags. +
    getIiopopts() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets additional arguments for iiop. +
    getImplementation() - +Method in class org.apache.tools.ant.types.Mapper +
    Returns a fully configured FileNameMapper implementation. +
    getImplementation() - +Method in class org.apache.tools.ant.types.Mapper.MapperType +
      +
    getImplementation() - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Retrieves the implementation. +
    getImplementationClass() - +Method in class org.apache.tools.ant.types.Mapper +
    Gets the Class object associated with the mapper implementation. +
    getImplementationClasspath(Project) - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    The classpath to use when loading the implementation. +
    getImplementationTitle() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the title of the specification. +
    getImplementationURL() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the url of the extensions implementation. +
    getImplementationVendor() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the vendor of the extensions implementation. +
    getImplementationVendor() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the vendor of the extensions implementation. +
    getImplementationVendorID() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the vendorID of the extensions implementation. +
    getImplementationVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the version of the extensions implementation. +
    getImplementationVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the version of the implementation. +
    getImplicitFileSet() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Accessor for the implicit fileset. +
    getImplicitTarget() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    get the implicit target +
    getImportStack() - +Method in class org.apache.tools.ant.ProjectHelper +
    Import stack. +
    getIncludeantruntime() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets whether or not the ant classpath is to be included in the classpath. +
    getIncludeantruntime() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets whether or not the ant classpath is to be included in the + task's classpath. +
    getIncludedDirectories() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedDirectories() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedDirectories() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedDirectories() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.. +
    getIncludedDirsCount() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the count of included directories. +
    getIncludedDirsCount() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Override parent implementation. +
    getIncludedDirsCount() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the count of included directories.. +
    getIncludedFiles() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the files which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedFiles() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedFiles() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns. +
    getIncludedFiles() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Get the names of the class files on which baseClass depends. +
    getIncludedFilesCount() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the count of included files. +
    getIncludedFilesCount() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Override parent implementation. +
    getIncludedFilesCount() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the count of included files.. +
    getIncludeEmptyDirs() - +Method in class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Get the includeEmptyDirs attribute. +
    getIncludeFileNames() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Get whether file names should be included. +
    getIncludejavaruntime() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets whether or not the java runtime should be included in this + task's classpath. +
    getIncludejavaruntime() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets whether or not the java runtime should be included in this + task's classpath. +
    getIncludePatterns(Project) - +Method in class org.apache.tools.ant.types.PatternSet +
    Returns the filtered include patterns. +
    getIncludeSementicAttribute() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getIndex() - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
      +
    getIndividualTests() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Merge all individual tests from the batchtest with all individual tests + and return an enumeration over all JUnitTest. +
    getInError() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    gets whether or not the task has encountered an error +
    getInheritedProperties() - +Method in class org.apache.tools.ant.Project +
    Return a copy of the inherited property hashtable. +
    getInheritedProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns a copy of the inherited property hashtable +
    getInitialized() - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Returns the initialized status. +
    getInitialSiteCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getInput() - +Method in class org.apache.tools.ant.input.InputRequest +
    Retrieves the user input. +
    getInputHandler() - +Method in class org.apache.tools.ant.Project +
    Retrieve the current input handler. +
    getInputStream() - +Method in class org.apache.tools.ant.input.DefaultInputHandler +
    Returns the input stream from which the user input should be read. +
    getInputStream() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Get the input stream for the redirector +
    getInputStream() - +Method in class org.apache.tools.ant.types.Resource +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Return an InputStream for reading the contents of this Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Return an InputStream for reading the contents of this Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.TarResource +
    Return an InputStream for reading the contents of this Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get an InputStream for the Resource. +
    getInputStream() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Return an InputStream for reading the contents of this Resource. +
    getInputStream(ZipEntry) - +Method in class org.apache.tools.zip.ZipFile +
    Returns an InputStream for reading the contents of the given entry. +
    getInstance() - +Static method in class org.apache.tools.ant.ProjectHelperRepository +
      +
    getInstance(Class, String) - +Static method in class org.apache.tools.ant.types.EnumeratedAttribute +
    Factory method for instantiating EAs via API in a more + developer friendly way. +
    getInstance(ResourceCollection) - +Static method in class org.apache.tools.ant.types.resources.Union +
    Static convenience method to union an arbitrary set of Resources. +
    getInstance() - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Retrieves the instance of the Singleton. +
    getInstance(Stack) - +Static method in class org.apache.tools.ant.util.IdentityStack +
    Get an IdentityStack containing the contents of the specified Stack. +
    getInstance() - +Static method in class org.apache.tools.zip.JarMarker +
    Since JarMarker is stateless we can always use the same instance. +
    getInterfaceMethodClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Gets the name of the class defining the interface method +
    getInterfaceMethodName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Get the name of the interface method +
    getInterfaceMethodRefEntry(String, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given CONSTANT_INTERFACEMETHODREF entry in the + constant pool. +
    getInterfaceMethodType() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Gets the type of the interface method +
    getInternalAttributes() - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves the internal file attributes. +
    getInternalInheritedProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    special back door for subclasses, internal access to the hashtables +
    getInternalProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    special back door for subclasses, internal access to the hashtables +
    getInternalUserProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    special back door for subclasses, internal access to the hashtables +
    getJar() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the name of the jar to be run. +
    getJarBaseName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file. +
    getJarBaseName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file.. +
    getJava() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    get the java attribute. +
    getJavac() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Get the Javac task instance associated with this compiler adapter +
    getJavacExecutable() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The name of the javac executable to use in fork-mode. +
    getJavaCommand() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the Java command to be used. +
    getJavafiles() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Get whether the stream is to be treated as though it contains Java + source. +
    getJavaHome() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Return the value of ${java.home} +
    getJavaVersion() - +Static method in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JavaEnvUtils instead. +
    getJavaVersion() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Returns the version of Java this class is running under. +
    getJavaVersionNumber() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Returns the version of Java this class is running under. +
    getJdkExecutable(String) - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Finds an executable that is part of a JDK installation based on + the java.home system property. +
    getJreExecutable(String) - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Finds an executable that is part of a JRE installation based on + the java.home system property. +
    getJrePackages() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    get a vector of strings of packages built into + that platforms runtime jar(s) +
    getJrePackageTestCases() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Testing helper method; kept here for unification of changes. +
    getJspc() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    get the owner +
    getJvmDebugLevel() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Get the debug level. +
    getKeepCopy() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get keepcopy flag status +
    getKeepCopy() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
    Get keepcopy flag status +
    getKeepEngine() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the keep engine attribute. +
    getKeeproot() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getKey() - +Method in class org.apache.tools.ant.filters.ReplaceTokens.Token +
    Returns the key for this token. +
    getKey() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Get the attribute's Key - its name in lower case. +
    getKey() - +Method in class org.apache.tools.ant.types.Environment.Variable +
    key accessor +
    getKey() - +Method in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Key of the action to take. +
    getKeyfile() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Returns the keyfile. +
    getLabel() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get value of label +
    getLabel() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the label +
    getLabel() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the label string. +
    getLanguage() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the script language +
    getLanguage() - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Get the language. +
    getLastModified() - +Method in class org.apache.tools.ant.types.Resource +
    Tells the modification time in milliseconds since 01.01.1970 (the "epoch"). +
    getLastModified() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Get the last modified date of this Resource. +
    getLastModified() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the modification time in milliseconds since 01.01.1970 . +
    getLastModified() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Tells the modification time in milliseconds since 01.01.1970 . +
    getLastModified() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Tells the modification time in milliseconds since 01.01.1970 . +
    getLength() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeListImpl +
    Get the number of nodes in the list. +
    getLengthOfTask() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
    Return the number of files seen. +
    getLevel() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Get the compression level. +
    getLevel() - +Method in class org.apache.tools.ant.types.LogLevel +
    get the level of the echo of the current value +
    getLHost() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    getLiaison() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Get the Liason implementation to use in processing. +
    getLineNumber() - +Method in class org.apache.tools.ant.Location +
      +
    getLineStart() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    The lineStart attribute is used to parse the output of the pcli + command. +
    getLink() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    if the file is a symbolic link, find out to what it is pointing +
    getLink() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    if the file is a symbolic link, find out to what it is pointing +
    getLinkedFile() - +Method in class org.apache.tools.zip.AsiExtraField +
    Name of linked file +
    getLinkName() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's link name. +
    getListfiles() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the listfiles flag. +
    getListing() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getLoader() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Get the classloader used to create a driver. +
    getLoader() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Classloader for the user-specified classpath. +
    getLoader() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource.ClassLoaderWithFlag +
      +
    getLoader() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Get the loader. +
    getLoaderId() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Returns the loader id of the class path Delegate. +
    getLoaderMap() - +Static method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Get the cache of loaders and drivers. +
    getLocalFile() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Get the local file +
    getLocalFile() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Get the local file. +
    getLocalFileDataData() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getLocalFileDataData() - +Method in class org.apache.tools.zip.AsiExtraField +
    The actual data to put into local file data - without Header-ID + or length specifier. +
    getLocalFileDataData() - +Method in class org.apache.tools.zip.JarMarker +
    The actual data to put into local file data - without Header-ID + or length specifier. +
    getLocalFileDataData() - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    The actual data to put into local file data. +
    getLocalFileDataData() - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Get the local data. +
    getLocalFileDataData() - +Method in interface org.apache.tools.zip.ZipExtraField +
    The actual data to put into local file data - without Header-ID + or length specifier. +
    getLocalFileDataExtra() - +Method in class org.apache.tools.zip.ZipEntry +
    Retrieves the extra data for the local file data. +
    getLocalFileDataLength() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getLocalFileDataLength() - +Method in class org.apache.tools.zip.AsiExtraField +
    Length of the extra field in the local file data - without + Header-ID or length specifier. +
    getLocalFileDataLength() - +Method in class org.apache.tools.zip.JarMarker +
    Length of the extra field in the local file data - without + Header-ID or length specifier. +
    getLocalFileDataLength() - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    Length of the complete extra field in the local file data. +
    getLocalFileDataLength() - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Get the length of the local data. +
    getLocalFileDataLength() - +Method in interface org.apache.tools.zip.ZipExtraField +
    Length of the extra field in the local file data - without + Header-ID or length specifier. +
    getLocalPath() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Builds and returns the working directory. +
    getLocalpath() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the localpath string. +
    getLocalpath() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Returns the local path without the flag.; required +
    getLocation() - +Method in exception org.apache.tools.ant.BuildException +
    Returns the file location where the error occurred. +
    getLocation() - +Method in class org.apache.tools.ant.ProjectComponent +
    Returns the file/location where this task was defined. +
    getLocation() - +Method in class org.apache.tools.ant.Target +
    Get the location of this target's definition. +
    getLocation() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the build file location associated with this element's task. +
    getLocation() - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    getLocationURLs(File) - +Static method in class org.apache.tools.ant.launch.Locator +
    Get an array of URLs representing all of the jar files in the + given location. +
    getLocationURLs(File, String[]) - +Static method in class org.apache.tools.ant.launch.Locator +
    Get an array of URLs representing all of the files of a given set of + extensions in the given location. +
    getLocator() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    access the locator +
    getLog() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get log file +
    getLogin() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the login string. +
    getLogLevel() - +Method in class org.apache.tools.ant.taskdefs.Jar.StrictMode +
      +
    getLongOctalBytes(long, byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Parse an octal long integer from a header buffer. +
    getLoops() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Sets the number of times the source file should be played. +
    getLPort() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    getLPort() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    getMacroDef() - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
      +
    getMagicNumber(byte[]) - +Static method in class org.apache.tools.ant.types.Resource +
    Create a "magic number" for use in hashCode calculations. +
    getMainClass(File, int) - +Static method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Helper method to retrieve main class which is different from versions. +
    getMainClass(Path, int) - +Static method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Helper method to retrieve main class which is different from versions. +
    getMainHandler() - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Returns main handler +
    getMainSection() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Get the main section of the manifest +
    getMajorVersionNumber(File) - +Static method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Helper method to determine the major version number of JavaCC. +
    getManagerName() - +Method in class org.apache.tools.ant.util.optional.JavaxScriptRunner +
    Get the name of the manager prefix. +
    getManagerName() - +Method in class org.apache.tools.ant.util.optional.ScriptRunner +
    Get the name of the manager prefix. +
    getManagerName() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the name of the manager prefix used for this + scriptrunner. +
    getManifestFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the manifets file to use for building the generic jar. +
    getManifestVersion() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Get the version of the manifest +
    getMapper() - +Method in class org.apache.tools.ant.taskdefs.Expand +
    get a mapper for a file +
    getMapper() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    This implementation returns a mapper that may return up to two + file names. +
    getMapper() - +Method in interface org.apache.tools.ant.taskdefs.rmic.RmicAdapter +
    Maps source class files to the files generated by this rmic + implementation. +
    getMapper() - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    get the active mapper; may be null +
    getMapper() - +Method in class org.apache.tools.ant.types.PropertySet +
    Get the mapper attribute. +
    getMappers() - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Get the List of FileNameMappers. +
    getMaster() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get master flag status +
    getMaxLevelsOfSymlinks() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    The maximum number of times a symbolic link may be followed + during a scan. +
    getMemoryInitialSize() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the memoryInitialSize flag. +
    getMemoryMaximumSize() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the memoryMaximumSize flag. +
    getMessage() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the logging message. +
    getMessageLevel() - +Method in class org.apache.tools.ant.taskdefs.LogOutputStream +
    Get the level. +
    getMethod() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    The compression method that has been used. +
    getMethodClassName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Get the name of the class defining the method +
    getMethodName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Get the name of the method. +
    getMethodRefEntry(String, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given CONSTANT_METHODREF entry in the constant + pool. +
    getMethodType() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Get the type signature of the method. +
    getMillis() - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    Calculate timestamp as millis either based on millis or + dateTime (and pattern) attribute. +
    getMillis() - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Get the date/time in ms. +
    getMillis() - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Returns the millisecond value the selector is set for. +
    getMilliseconds(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity +
    returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter. +
    getMilliseconds(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Granularity +
    returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter. +
    getMimeType() - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Returns the content type +
    getMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
      +
    getMode() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Get the file or dir mode for this Resource. +
    getMode() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's mode. +
    getMode() - +Method in class org.apache.tools.zip.AsiExtraField +
    File mode of this file. +
    getMode(int) - +Method in class org.apache.tools.zip.AsiExtraField +
    Get the file mode for given permissions with the correct file type. +
    getModified() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Getter for the modified count +
    getModTime() - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's modification time. +
    getModules() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
      +
    getMultiplier() - +Method in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    Convert the value to a multipler (millisecond to unit). +
    getName() - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Return the definition's name. +
    getName() - +Method in class org.apache.tools.ant.Project +
    Return the project name, if one has been set. +
    getName() - +Method in class org.apache.tools.ant.Target +
    Returns the name of this target. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask.Module +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Ant.TargetElement +
    Get the name of this TargetElement. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Apt.Option +
    Get the name attribute. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Definer +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Returns the display name +
    getName() - +Method in class org.apache.tools.ant.taskdefs.email.Header +
    Get the name of this Header. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DnameParam +
    Get the name attribute. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletParam +
    Get the parameter name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Get the name of the extension. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.PackageName +
    Get the package name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Gets the name of this element. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Get the Attribute's name +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Get the Section's name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    Get the name component of this entry +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah.ClassArgument +
    Get the name attribute. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the name of the test class. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    get the name of the file +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    get the name of the file +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject +
    Get the name of the project +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Gets the user name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute +
    Gets the attribute name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property +
    accessor to the name of the property +
    getName() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the property name. +
    getName() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty +
      +
    getName() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Get the parameter name +
    getName() - +Method in class org.apache.tools.ant.types.FileList.FileName +
      +
    getName() - +Method in class org.apache.tools.ant.types.Parameter +
    Get the name attribute. +
    getName() - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
      +
    getName() - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Get the name of the permission. +
    getName() - +Method in class org.apache.tools.ant.types.Resource +
    Name attribute will contain the path of a file relative to the + root directory of its fileset or the recorded path of a zip + entry. +
    getName() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the name of this FileResource. +
    getName() - +Method in class org.apache.tools.ant.types.resources.MappedResource +
    Maps the name. +
    getName() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Get the name of the resource. +
    getName() - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Get the pattern used by this Name ResourceSelector. +
    getName() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Synchronize access. +
    getName() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get the name of this URLResource + (its file component minus the leading separator). +
    getName() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's name. +
    getName() - +Method in class org.apache.tools.zip.ZipEntry +
    Get the name of the entry. +
    getNameAndTypeEntry(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given CONSTANT_NAMEANDTYPE entry in the constant + pool. +
    getNameBytes(StringBuffer, byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Determine the number of bytes in an entry name. +
    getNameCRC32() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getNamedResources(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Finds all the resources with the given name. +
    getNamespace() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Get the namespace. +
    getNamespace() - +Method in class org.apache.tools.ant.UnknownElement +
    Return the namespace of the XML element associated with this component. +
    getNamespaceXMLReader() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns a newly created SAX 2 XMLReader, which is namespace aware +
    getNeeded() - +Method in class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
    The amount of free space required +
    getNested() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.NestedSequential +
      +
    getNested() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.NestedSequential +
      +
    getNestedElementMap() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns a read-only map of nested elements supported + by the introspected class. +
    getNestedElements() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns an enumeration of the names of the nested elements supported + by the introspected class. +
    getNestedTask() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Convert the nested sequential to an unknown element +
    getNewProject() - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Get the (sub)-Project instance currently in use. +
    getNext() - +Method in class org.apache.tools.ant.ComponentHelper +
    Get the next chained component helper. +
    getNext() - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. use the delegate mechanism instead +
    getNextClassFile() - +Method in interface org.apache.tools.ant.taskdefs.optional.depend.ClassFileIterator +
    Get the next class file in the iteration +
    getNextClassFile() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.DirectoryIterator +
    Template method to allow subclasses to supply elements for the + iteration. +
    getNextClassFile() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.JarFileIterator +
    Get the next ClassFile object from the jar +
    getNextEntry() - +Method in class org.apache.tools.tar.TarInputStream +
    Get the next entry in this tar archive. +
    getNlabel() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get nlabel status +
    getNoCache() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the NoCache flag. +
    getNoCheckout() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Get no checkout flag status +
    getNoCheckout() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get no checkout flag status +
    getNoCompress() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the NoCompress flag. +
    getNoData() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get nodata flag status +
    getNodeAttribute(Node, String) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil +
    return the attribute value of an element. +
    getNoDebugArgument() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    The argument the compiler wants to see if the debug attribute + has been set to false. +
    getNoDebugArgument() - +Method in class org.apache.tools.ant.taskdefs.compilers.Sj +
    Returns null since sj either has -g for debug=true or no + argument at all. +
    getNoNamespaceSchemaURL() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    get the URL of the no namespace schema +
    getNonFileSetResourcesToAdd(ResourceCollection[], File, boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. +
    getNotco() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get notco flag status +
    getNotFollowedSymlinks() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Absolute paths of all symbolic links that haven't been followed + but would have been followed had followsymlinks been true or + maxLevelsOfSymlinks been bigger. +
    getNotFoundException(String, String) - +Method in class org.apache.tools.ant.UnknownElement +
    Returns a very verbose exception for when a task/data type cannot + be found. +
    getNotIncludedDirectories() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the directories which matched none of the include + patterns. +
    getNotIncludedDirectories() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the directories which matched none of the include + patterns. +
    getNotIncludedDirectories() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the names of the directories which matched none of the include + patterns.. +
    getNotIncludedFiles() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return the names of the files which matched none of the include + patterns. +
    getNotIncludedFiles() - +Method in interface org.apache.tools.ant.FileScanner +
    Returns the names of the files which matched none of the include + patterns. +
    getNotIncludedFiles() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Return the names of the files which matched none of the include + patterns.. +
    getNotNullFile() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the file represented by this FileResource, ensuring it is not null. +
    getNowarn() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Should the -nowarn option be used. +
    getNoWarn() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get nowarn flag status +
    getNoWarn() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get nowarn flag status +
    getNoWarn() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Get nowarn flag status +
    getNoWarn() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get nowarn flag status +
    getNSParserFactory() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns the parser factory to use to create namespace aware parsers. +
    getNumEntries() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Get the number of Constant Pool Entry slots within the constant pool + occupied by this entry. +
    getNusers() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get nusers list +
    getObject() - +Method in class org.apache.tools.ant.util.ReflectWrapper +
      +
    getObjectValue() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the Object value of this PropertyResource. +
    getObjselect() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get list of objects to be locked +
    getObjselect() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Get list of objects to be locked +
    getObjSelect() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Get the object to operate on +
    getObsolete() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get obsolete flag status +
    getOctalBytes(long, byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Parse an octal integer from a header buffer. +
    getOld() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Whether old JDK1.0-style header files should be generated. +
    getOnMissingFiltersFile() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get the onMissingFiltersFile setting. +
    getOptimize() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the optimize flag. +
    getOptional() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    getOptionalAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Adds the optional attributes to the command line. +
    getOptions() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the options to the compiler. +
    getOptions() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Gets the options for the EJB Deploy operation +
    getOptions(Manifest) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return the set of Extension objects representing "Optional + Packages" that the application declares they will use if present. +
    getOrdinary() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get ordinary flag status +
    getOs() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    List of operating systems on which the command may be executed. +
    getOsFamily() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Restrict this execution to a single OS Family +
    getOut() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get out file +
    getOut() - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Get the output stream. +
    getOutfile() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the name of the output file +
    getOutput(FormatterElement, JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If the formatter sends output to a file, return that file. +
    getOutput() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the output file string. +
    getOutputDir() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the base directory to output the generated files, + favoring destdir if set, otherwise defaulting to basedir. +
    getOutputEncoding() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get the character encoding for output files. +
    getOutputfile() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    The destination file, if any. +
    getOutputFile() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getOutputProperties() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Get an enumeration on the outputproperties. +
    getOutputStream() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the stream to which the stdout from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute output + has been set, the output stream will go to the output file + otherwise the output will go to ant's logging system +
    getOutputStream() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Get the output stream for the redirector +
    getOutputStream() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    The stream to write traces to. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.Resource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.LogOutputResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.TarResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get an OutputStream for the Resource. +
    getOutputStream() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Get an OutputStream for the Resource. +
    getOverwrite() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get overwrite hijacked files status +
    getOwningTarget() - +Method in class org.apache.tools.ant.Task +
    Returns the container target of this task. +
    getPackage() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the package or module to operate upon +
    getPackage() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the name of the package. +
    getPackagelistLoc() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Get the packetList location attribute. +
    getPackagelistURL() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Get the packetList location attribute. +
    getPackageName() - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    what is the package name? +
    getPackages() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Get the packages as a collon separated list. +
    getParameter() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.TagArgument +
    Returns the -tag parameter this argument represented. +
    getParameters() - +Method in class org.apache.tools.ant.filters.BaseParamFilterReader +
    Returns the parameters to be used by this filter. +
    getParameters() - +Method in class org.apache.tools.ant.types.selectors.BaseExtendSelector +
    Allows access to the parameters gathered and set within the + <custom> tag. +
    getParams() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName +
    Get the nested parameters. +
    getParams() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletInfo +
    Get the doclet's parameters. +
    getParams() - +Method in class org.apache.tools.ant.types.AntFilterReader +
    The parameters for this filter. +
    getParent() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    getParent() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    getParent() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get the parent Directory. +
    getParentFile(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Deprecated. since 1.7. Just use File.getParentFile() directly. +
    getParser() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns a newly created SAX 1 Parser, using the default parser + factory. +
    getParserFactory() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns the parser factory to use. +
    getPartition() - +Method in class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
    The partition/device to check +
    getParts() - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Return the constituent parts of this Argument. +
    getParts() - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Return the converted pathelements. +
    getParts(String) - +Method in class org.apache.tools.ant.util.facade.ImplementationSpecificArgument +
    Return the parts this Argument consists of, if the + implementation matches the chosen implementation. +
    getPassFile() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    find the password file +
    getPassphrase(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Gets the pass phrase of the user. +
    getPassphrase() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Returns the passphrase. +
    getPassword() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the password. +
    getPassword() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Returns the password field. +
    getPassword() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getPassword() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the password +
    getPassword() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Gets the user's password. +
    getPath() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Get the extension's path. +
    getPath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    getPath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    getPath() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Get the path components of this directory. +
    getPath(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Convert a file path to an array of path components. +
    getPath(List) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Gets path from a List of Strings. +
    getPath(List, char) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Gets path from a List of Strings. +
    getPathStack(String) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Gets all names of the path as an array of Strings. +
    getPattern(Project) - +Method in class org.apache.tools.ant.types.RegularExpression +
    Gets the pattern string for this RegularExpression in the + given project. +
    getPattern() - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Get the pattern for use with the datetime attribute. +
    getPattern() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
      +
    getPattern() - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Get a String representation of the regexp pattern +
    getPattern() - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Get a String representation of the regexp pattern +
    getPattern() - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Get a String representation of the regexp pattern +
    getPattern() - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Get a String representation of the regexp pattern +
    getPbranch() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get pbranch flag status +
    getPhaseOfMoon(Calendar) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Calculate the phase of the moon for a given date. +
    getPlatform() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of platform. +
    getPlatform() - +Method in class org.apache.tools.zip.ZipEntry +
    Platform specification to put into the "version made + by" part of the central file header. +
    getPname() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get the pathname to be locked +
    getPname() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Get the pathname to be locked +
    getPolicy() - +Method in class org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy +
      +
    getPolicy() - +Method in class org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField +
      +
    getPolyType() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Get the polymorphic type for this element. +
    getPort() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    access the port of CVS +
    getPort() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getPort() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Get the port attribute. +
    getPosition() - +Method in class org.apache.tools.ant.types.Commandline.Marker +
    Return the number of arguments that preceded this marker. +
    getPostToken() - +Method in class org.apache.tools.ant.util.FileTokenizer +
    Return the intra-token string +
    getPostToken() - +Method in class org.apache.tools.ant.util.LineTokenizer +
      +
    getPostToken() - +Method in class org.apache.tools.ant.util.StringTokenizer +
      +
    getPostToken() - +Method in interface org.apache.tools.ant.util.Tokenizer +
    return the string between tokens, after the + previous token. +
    getPrefix() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the prefix attribute. +
    getPrefix() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getPrefix(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Return the prefix prepended to entries in the archive file. +
    getPrefix() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Deprecated. since 1.7. +
    getPrefix() - +Method in class org.apache.tools.ant.types.Commandline.Marker +
    Get the prefix to be placed in front of the inserted argument. +
    getPrefixMapping(String) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    prefix to namespace uri mapping +
    getPrefixValues() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +
    getPrepend() - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Returns prepend attribute. +
    getPreprocessDir() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the preprocessdir attribute. +
    getPreserve0Permissions() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Assume 0 Unix mode is intentional. +
    getPreserveEmptyDirs() - +Method in class org.apache.tools.ant.taskdefs.Sync.SyncTarget +
    Whether empty directories matched by this fileset should be + preserved. +
    getPreserveLastModified() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get whether to give the copied files the same last modified time as + the original files. +
    getPreserveLastModified() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
      +
    getPreserveLeadingSlashes() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
      +
    getPreserveTime() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Get preservetime flag status +
    getPreserveTime() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Get preservetime flag status +
    getPreserveTime() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get preserve time status +
    getPreSets() - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Get the preset values. +
    getPreviousRevision() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Gets the previous revision for this CvsTagEntry +
    getPrimaryFormat() - +Method in interface org.apache.tools.ant.taskdefs.Touch.DateFormatFactory +
      +
    getPrintStream() - +Method in class org.apache.tools.mail.MailMessage +
    Returns a PrintStream that can be used to write the body of the message. +
    getPriority() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the priority of the logging message. +
    getProcEnvironment() - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    Deprecated. use #getEnvironmentVariables instead +
    getProgressMonitor() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Get the progress monitor. +
    getProject() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the project that fired this event. +
    getProject() - +Method in class org.apache.tools.ant.ComponentHelper +
    Get the project. +
    getProject() - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Returns the project this filter is part of. +
    getProject() - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Get the project +
    getProject() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    find out the project to which this antxml context belongs +
    getProject(Object) - +Static method in class org.apache.tools.ant.Project +
    Get the Project instance associated with the specified object. +
    getProject() - +Method in class org.apache.tools.ant.ProjectComponent +
    Returns the project to which this component belongs. +
    getProject() - +Method in interface org.apache.tools.ant.property.ParseNextProperty +
    Get the current project. +
    getProject() - +Method in class org.apache.tools.ant.property.ParseProperties +
    Get the project. +
    getProject() - +Method in class org.apache.tools.ant.PropertyHelper +
    Get this PropertyHelper's Project. +
    getProject() - +Method in class org.apache.tools.ant.Target +
    Returns the project this target belongs to. +
    getProject() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Get the project this compiler adapter was created in. +
    getProject() - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Get this condition's Project. +
    getProject() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    get our project +
    getProject() - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Get the project associated with this recorder entry. +
    getProject() - +Method in interface org.apache.tools.ant.TypeAdapter +
    Gets the project +
    getProject() - +Method in class org.apache.tools.ant.types.Reference +
    Get the associated project, if any; may be null. +
    getProject() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the project for this runner. +
    getProjectHandler() - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Returns project handler +
    getProjectHelper() - +Static method in class org.apache.tools.ant.ProjectHelper +
    Get the first project helper found in the classpath +
    getProjectHelperForAntlib(Resource) - +Method in class org.apache.tools.ant.ProjectHelperRepository +
    Get the helper that will be able to parse the specified antlib. +
    getProjectHelperForBuildFile(Resource) - +Method in class org.apache.tools.ant.ProjectHelperRepository +
    Get the helper that will be able to parse the specified build file. +
    getProjectPath() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the project path +
    getPromotiongroup() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get value of promotiongroup +
    getPrompt(InputRequest) - +Method in class org.apache.tools.ant.input.DefaultInputHandler +
    Constructs user prompt from a request. +
    getPrompt() - +Method in class org.apache.tools.ant.input.InputRequest +
    Retrieves the prompt text. +
    getProperties() - +Method in class org.apache.tools.ant.Project +
    Return a copy of the properties table. +
    getProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns a copy of the properties table. +
    getProperties() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the properties used in the test. +
    getProperties(File) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Load a properties file. +
    getProperties(Resource) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Load a properties resource. +
    getProperties() - +Method in class org.apache.tools.ant.types.PropertySet +
    This is the operation to get the existing or recalculated properties. +
    getProperty(String) - +Method in class org.apache.tools.ant.Project +
    Return the value of a property, if it is set. +
    GetProperty - Interface in org.apache.tools.ant.property
    Interface to a class (normally PropertyHelper) to get a property.
    getProperty(String) - +Method in interface org.apache.tools.ant.property.GetProperty +
    Returns the value of a property if it is set. +
    getProperty(String) - +Method in class org.apache.tools.ant.property.ResolvePropertyMap +
    Returns the value of a property if it is set. +
    getProperty(Project, String) - +Static method in class org.apache.tools.ant.PropertyHelper +
    A helper static method to get a property + from a particular project. +
    getProperty(String, String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    getProperty(String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns the value of a property, if it is set. +
    getProperty() - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Get the name of the property to hold the ant version. +
    getProperty() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Get the name of the property whose value is to serve as + the replacement value. +
    getPropertyHelper(Project) - +Static method in class org.apache.tools.ant.PropertyHelper +
    Factory method to create a property processor. +
    getPropertyHook(String, String, boolean) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. PropertyHelper chaining is deprecated. +
    getProxy() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Get the object for which this RuntimeConfigurable holds the configuration + information. +
    getProxy() - +Method in class org.apache.tools.ant.TaskAdapter +
    Returns the target object being proxied. +
    getProxy() - +Method in class org.apache.tools.ant.taskdefs.AugmentReference +
    Returns the proxy object. +
    getProxy() - +Method in interface org.apache.tools.ant.TypeAdapter +
    Returns the proxy object. +
    getPublicId() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Get the publicId of the DTD +
    getPublicId() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Returns the Public ID of the DTD specified in the EJB descriptor. +
    getPublicId() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    The iAS ejbc utility doesn't require the Public ID of the descriptor's + DTD for it to process correctly--this method always returns null + . +
    getPublicId() - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    getPumper() - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler.ThreadWithPumper +
      +
    getPvcsbin() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get name of the PVCS bin directory +
    getPvcsproject() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get name of the project in the PVCS repository +
    getPvcsprojects() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get name of the project in the PVCS repository +
    getQName() - +Method in class org.apache.tools.ant.UnknownElement +
    Return the qname of the XML element associated with this component. +
    getQuiet() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the quiet string. +
    getRdbms() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the rdbms. +
    getRealObject() - +Method in class org.apache.tools.ant.IntrospectionHelper.Creator +
      +
    getRealThing() - +Method in class org.apache.tools.ant.UnknownElement +
    Return the configured object +
    getRecentDateFormatConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getRecentDateFormatConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getRecorder(String, Project) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Gets the recorder that's associated with the passed in name. +
    getRecordSize() - +Method in class org.apache.tools.tar.TarBuffer +
    Get the TAR Buffer's record size. +
    getRecordSize() - +Method in class org.apache.tools.tar.TarInputStream +
    Get the record size being used by this stream's TarBuffer. +
    getRecordSize() - +Method in class org.apache.tools.tar.TarOutputStream +
    Get the record size being used by this stream's TarBuffer. +
    getRecurse() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get recurse flag status +
    getRecurse() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get recurse flag status +
    getRecursive() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the 'recursive' Flag. +
    getRecursive() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the recursive string. +
    getRedirector() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    get the redirector. +
    getRef(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Performs the check for circular references and returns the + referenced FileSet. +
    getRef(Project) - +Method in class org.apache.tools.ant.types.FileList +
    Performs the check for circular references and returns the + referenced FileList. +
    getRef() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get the referenced filter set. +
    getRef() - +Method in class org.apache.tools.ant.types.Mapper +
    Deprecated. since Ant 1.7.1 because a mapper might ref a + FileNameMapper implementation directly. +
    getRef() - +Method in class org.apache.tools.ant.types.PropertySet +
    Performs the check for circular references and returns the + referenced PropertySet. +
    getRef(Project) - +Method in class org.apache.tools.ant.types.RegularExpression +
    Get the RegularExpression this reference refers to in + the given project. +
    getRef() - +Method in class org.apache.tools.ant.types.resources.Files +
    Perform the check for circular references and return the + referenced Files collection. +
    getRef(Project) - +Method in class org.apache.tools.ant.types.Substitution +
    Get the RegularExpression this reference refers to in + the given project. +
    getRef(Project) - +Method in class org.apache.tools.ant.types.TarFileSet +
    A TarFileset accepts another TarFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +
    getRef(Project) - +Method in class org.apache.tools.ant.types.ZipFileSet +
    A ZipFileset accepts another ZipFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +
    getReference(String) - +Method in class org.apache.tools.ant.Project +
    Look up a reference by its key (ID). +
    getReferencedObject(Project) - +Method in class org.apache.tools.ant.types.Reference +
    Resolve the reference, using the associated project if + it set, otherwise use the passed in project. +
    getReferencedObject() - +Method in class org.apache.tools.ant.types.Reference +
    Resolve the reference, looking in the associated project. +
    getReferencedOrProxied() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the referenced or proxied Resource, if applicable. +
    getReferences() - +Method in class org.apache.tools.ant.Project +
    Return a map of the references in the project (String to Object). +
    getRefid() - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Get the refid of this Handler. +
    getRefid() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the refid attribute. +
    getRefid() - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask.DelegateElement +
    Get the refid. +
    getRefid() - +Method in class org.apache.tools.ant.types.DataType +
    get the reference set on this object +
    getRefId() - +Method in class org.apache.tools.ant.types.Reference +
    Get the reference id of this reference. +
    getRegex() - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Get the regular expression used by this Name ResourceSelector. +
    getRegexp(Project) - +Method in class org.apache.tools.ant.types.RegularExpression +
    provides a reference to the Regexp contained in this +
    getRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find out the relative path to the rootPath of the enclosing scanner. +
    getRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile +
    find out the relative path to root +
    getRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find out the relative path to the rootPath of the enclosing scanner. +
    getRelativePath() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile +
    find out the relative path to root +
    getRelativePath(File, File) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Calculates the relative path between two files. +
    getRelease() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of release. +
    getRemotedir() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getRemoteInterface(Class) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Returns the topmost interface that extends Remote for a given + class - if one exists. +
    getRemotePath() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Get the remote path +
    getRemotePath() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Get the remote path. +
    getRename() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Get rename hijacked files status +
    getReplace() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Get replace flag status +
    getReplace() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get replace flag status +
    getReplace() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get replace flag status +
    getReplace() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get replace flag status +
    getReplaceValue() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Get the replacement value for this filter token. +
    getRepository() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get network name of the PVCS repository +
    getRequired(Manifest) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return the set of Extension objects representing optional + packages that are required by the application contained in the JAR + file associated with the specified Manifest. +
    getRequiredAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Sets the executable and add the required attributes to the command line. +
    getReserved() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get reserved flag status +
    getResolveExecutable() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Indicates whether to attempt to resolve the executable to a + file. +
    getResolvemode() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    returns the resolve mode +
    getResolver() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of resolver. +
    getResource(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Finds the resource with the given name. +
    getResource(String) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Get the named resource. +
    getResource(String) - +Method in class org.apache.tools.ant.Project +
    Resolve the file relative to the project's basedir and return it as a + FileResource. +
    getResource() - +Method in class org.apache.tools.ant.taskdefs.Definer +
      +
    getResource() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the resource attribute. +
    getResource() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getResource(String) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Get the named Resource. +
    getResource(String) - +Method in interface org.apache.tools.ant.types.ResourceFactory +
    Query a resource (file, zipentry, ...) by name +
    getResource(String) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Create a new resource that matches a relative or absolute path. +
    getResource() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    De-references refids if any, ensures a wrapped resource has + been specified. +
    getResource(String) - +Method in class org.apache.tools.ant.util.SourceFileScanner +
    Returns resource information for a file at destination. +
    getResourceAsStream(String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns a stream to read the requested resource name. +
    getResourceCollection() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Get the nested ResourceCollection. +
    getResourceCollections() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Get the nested ResourceCollections. +
    getResources(String) - +Method in class org.apache.tools.ant.loader.AntClassLoader5 +
    +
    getResourceSource(ClassLoader, String) - +Static method in class org.apache.tools.ant.launch.Locator +
    Find the directory or jar a given resource has been loaded from. +
    getResourceSource(ClassLoader, String) - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Find the directory or a give resource has been loaded from. +
    getResourcesToAdd(ResourceCollection[], File, boolean) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. +
    getResourcesToAdd() - +Method in class org.apache.tools.ant.taskdefs.Zip.ArchiveState +
    Get the resources to add. +
    getResourcesToAdd(ResourceCollection[], File, boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. +
    getResourcesToAdd(FileSet[], File, boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. +
    getResourceURL(File, String) - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns the URL of a given resource in the given file which may + either be a directory or a zip file. +
    getResponse() - +Method in class org.apache.tools.mail.SmtpResponseReader +
    Read until the server indicates that the response is complete. +
    getRestrictedDefinitions(String) - +Method in class org.apache.tools.ant.ComponentHelper +
    This returns a list of restricted definitions for a name. +
    getRetCode() - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Returns what System.exit() would return in the standalone version. +
    getRetCode() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Returns what System.exit() would return in the standalone version. +
    getRetriesAllowed() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getReverse() - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    The value of the reverse attribute. +
    getRevision() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Gets the revision for this CvsTagEntry +
    getRevision() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get value of revision +
    getRHost() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    getRmAll() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get rmall flag status +
    getRmic() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Get the Rmic attributes +
    getRmic(String, Task) - +Static method in class org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getRmic(String, Task, Path) - +Static method in class org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory +
    Based on the parameter passed in, this method creates the necessary + factory desired. +
    getRootClasses() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Get an enumeration of the root classes +
    getRootDirectory() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getRPort() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    getRPort() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    getRunner() - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Get our script runner +
    getRunTime() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the run time. +
    getRuntimeConfigurableWrapper() - +Method in class org.apache.tools.ant.Task +
    Returns the wrapper used for runtime configuration. +
    getScanForUnicodeExtraFields() - +Method in class org.apache.tools.ant.taskdefs.Expand +
      +
    getSchemaLocationURL() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    get the URL of the schema +
    getScript() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the current script text content. +
    getScriptClassLoader() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Get the classloader used to load the script engine. +
    getScriptRunner() - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Create and set text on a script. +
    getSection(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Get a particular section from the manifest +
    getSectionNames() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Get the section names in this manifest. +
    getSections() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Return an array containing sections to which specification applies + or null if relevent to no sections. +
    getSelection() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    True if the listener is to print information after each + selection event. +
    getSelectors(Project) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Returns the set of selectors as an array. +
    getSelectors(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Returns the set of selectors as an array. +
    getSelectors() - +Method in class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Return an Iterator over the nested selectors. +
    getSelectors(Project) - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Returns the set of selectors as an array. +
    getSelectors(Project) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Returns the set of selectors as an array. +
    getSelectors(Project) - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    Returns the set of selectors as an array. +
    getSelectors(Project) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Returns the set of selectors as an array. +
    getSemanticAttributes() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getSeparator() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getServer() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Returns the server field. +
    getServer() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getServerLanguageCodeConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getServerLanguageCodeConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getServerTimeZoneConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getServerTimeZoneConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getServerVersion() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    Get the CVS server version +
    getShared() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get shared flag status +
    getShortMonthNamesConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getShortMonthNamesConfig() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getSiteCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getSize() - +Method in class org.apache.tools.ant.types.Resource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Do compute the size of the resource collection. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper +
      +
    getSize() - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.LazyResourceCollectionWrapper +
      +
    getSize() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.selectors.Size +
    Get the size compared to by this Size ResourceSelector. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get the size of this Resource. +
    getSize() - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return number of components in DeweyDecimal. +
    getSize() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's file size. +
    getSkelClassSuffix() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Gets the skeleton class suffix +
    getSkelClassSuffix() - +Method in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    Get the suffix for the rmic skeleton classes +
    getSosCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the executable to run. +
    getSosHome() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the SOS home directory. +
    getSosServerPath() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the SOS serve path. +
    getSource() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the value of source. +
    getSource() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    Returns the source field (the path/filename of the component to be + deployed. +
    getSource() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Gets the location of the file to get the audio. +
    getSourceBase() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the source dirs to find the source java files. +
    getSourceContainer(String) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Get the file that contains the class source. +
    getSourceContainer(String) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Get the file that contains the class source. +
    getSourcepath() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the sourcepath to be used for this compilation. +
    getSourcespath() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Deprecated. since 1.6.x. +
    getSpecifications(Manifest) - +Static method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Return an array of Package Specification objects. +
    getSpecificationTitle() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the title of the specification. +
    getSpecificationVendor() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the vendor of the extensions specification. +
    getSpecificationVendor() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the vendor of the specification. +
    getSpecificationVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Get the version of the extensions specification. +
    getSpecificationVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Get the version of the specification. +
    getSrc(Project) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Get the archive from which entries will be extracted. +
    getSrc() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Get the archive file from which entries will be extracted. +
    getSrcdir() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the source dirs to find the source java files. +
    getSrcDir() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the source dir. +
    getSrcResource() - +Method in class org.apache.tools.ant.taskdefs.Pack +
    The source resource. +
    getSSCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the sscommand string. +
    getStackTrace(Throwable) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Convenient method to retrieve the full stacktrace from a given exception. +
    getState() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. get the state. +
    getStatement() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Creates and configures a Statement instance which is then + cached for subsequent calls. +
    getStatus() - +Method in exception org.apache.tools.ant.ExitException +
    The status code returned by System.exit() +
    getStatus() - +Method in exception org.apache.tools.ant.ExitStatusException +
    Get the status code. +
    getString(byte[]) - +Method in class org.apache.tools.zip.ZipFile +
    Retrieve a String from the given bytes using the encoding set + for this ZipFile. +
    getStubClassSuffix() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Gets the stub class suffix +
    getStubClassSuffix() - +Method in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    Get the suffix for the rmic stub classes +
    getStubs() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Whether C declarations from the Java object file should be generated. +
    getStubVersion() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Gets the JDK version for the generated stub code. +
    getStyle() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the style string. +
    getStylesheet() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    access the stylesheet to be used as a resource. +
    getStylesheetSystemId() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    Get the systemid of the appropriate stylesheet based on its + name and styledir. +
    getSubProjectExecutor() - +Method in interface org.apache.tools.ant.Executor +
    Get the appropriate subproject Executor instance. +
    getSubProjectExecutor() - +Method in class org.apache.tools.ant.helper.DefaultExecutor +
    Get the appropriate subproject Executor instance.. +
    getSubProjectExecutor() - +Method in class org.apache.tools.ant.helper.IgnoreDependenciesExecutor +
    Get the appropriate subproject Executor instance.. +
    getSubProjectExecutor() - +Method in class org.apache.tools.ant.helper.SingleCheckExecutor +
    Get the appropriate subproject Executor instance.. +
    getSubsOptions(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroRegexp +
    Convert ant regexp substitution option to oro options. +
    getSubsOptions(int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpRegexp +
    Convert ant regexp substitution option to apache regex options. +
    getSubsOptions(int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp +
    Convert ant regexp substitution option to jdk1.4 options. +
    getSubSystem() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of subSystem. +
    getSuffix() - +Method in class org.apache.tools.ant.types.Commandline.Marker +
    Get the suffix to be placed at the end of the inserted argument. +
    getSupportedFileExtensions() - +Method in interface org.apache.tools.ant.taskdefs.compilers.CompilerAdapterExtension +
    Returns a list of source file extensions that are recognized by + this compiler adapter. +
    getSupportedFileExtensions() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    By default, only recognize files with a Java extension, + but specialized compilers can recognize multiple kinds + of files. +
    getSuppressWarnings() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether to suppress warning messages of the processor. +
    getSymbolicLinkUtils() - +Static method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Method to retrieve The SymbolicLinkUtils, which is shared by + all users of this method. +
    getSysProperties() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Get the system properties of the command line. +
    getSystemId(File) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead. +
    getSystemId(File) - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    This is a best attempt to provide a URL.toExternalForm() from + a file URL. +
    getSystemJavac() - +Method in class org.apache.tools.ant.taskdefs.Javac +
      +
    getSystemProperties() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the system properties object. +
    getSystemProxySetting() - +Static method in class org.apache.tools.ant.util.ProxySetup +
    Get the current system property settings +
    getSystemTypeKey() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    getSystemTypeKey() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getTab() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Return how tab characters are being handled. +
    getTablength() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Get the tab length to use. +
    getTag() - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    tag or branch +
    getTag() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Get the Entry's type tag. +
    getTag() - +Method in class org.apache.tools.ant.UnknownElement +
    Returns the name of the XML element which generated this unknown + element. +
    getTarget() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the target that fired this event. +
    getTarget() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the target VM that the classes will be compiled for. +
    getTargetHandler() - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Returns target handler +
    getTargets() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    access the vector of targets +
    getTargets() - +Method in class org.apache.tools.ant.Project +
    Return the hashtable of targets. +
    getTargetSelectorForSource(Resource) - +Method in interface org.apache.tools.ant.util.ResourceUtils.ResourceSelectorProvider +
      +
    getTask() - +Method in class org.apache.tools.ant.BuildEvent +
    Returns the task that fired this event. +
    getTask() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Get the value of task. +
    getTask() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Get the value of task. +
    getTask() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the task for this tool. +
    getTask() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Returns the task field, a ServerDeploy object. +
    getTask() - +Method in class org.apache.tools.ant.UnknownElement +
    Returns the task instance after it has been created and if it is a task. +
    getTask() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Get the task +
    getTaskDefinitions() - +Method in class org.apache.tools.ant.ComponentHelper +
    Returns the current task definition hashtable. +
    getTaskDefinitions() - +Method in class org.apache.tools.ant.Project +
    Return the current task definition hashtable. +
    getTaskException() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Get the task exception. +
    getTaskName() - +Method in class org.apache.tools.ant.Task +
    Returns the name to use in logging messages. +
    getTaskName() - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Returns the name to use in logging messages. +
    getTaskName() - +Method in class org.apache.tools.ant.UnknownElement +
    Returns the name to use in logging messages. +
    getTasks() - +Method in class org.apache.tools.ant.Target +
    Returns the current set of tasks to be executed by this target. +
    getTaskSuccess() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the result of the javac task (success or failure). +
    getTaskType() - +Method in class org.apache.tools.ant.Task +
    Return the type of task. +
    getTeardownException() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Get the teardown exception. +
    getTempdir() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Where Ant should place temporary files. +
    getTemplates() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    True if the listener is to print an event whenever a + template is invoked. +
    getTestCaseClassName(Test) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper +
    Tries to find the name of the class which a test represents + across JUnit 3 and 4. +
    getTestCaseName(Test) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper +
    JUnit 3.7 introduces TestCase.getName() and subsequent versions + of JUnit remove the old name() method. +
    getTestClass() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    getTestException() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Get the test exception. +
    getTests() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    getText() - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Get the text content of this element. +
    getText() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.Html +
    Get the current text for the element. +
    getText() - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
      +
    getText() - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    get the text of this element; may be null +
    getText() - +Method in class org.apache.tools.ant.taskdefs.Replace.NestedString +
      +
    getThreadTask(Thread) - +Method in class org.apache.tools.ant.Project +
    Get the current task associated with a thread, if any. +
    getTieClassSuffix() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Gets the tie class suffix +
    getTimeDiffMillis() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getTimeout() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    getTimestamp() - +Method in class org.apache.tools.ant.DefaultLogger +
    Get the current time. +
    getTimestampGranularity() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getTitle() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Get the title. +
    getTodir() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Get the destination directory. +
    getToDir() - +Method in class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Get the destination directory. +
    getTofile() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    get the to file specification +
    getToken() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Get the string to search for. +
    getToken() - +Method in class org.apache.tools.ant.types.FilterSet.Filter +
    Gets the Token attribute of the Filter object. +
    getToken() - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    The current token +
    getToken(Reader) - +Method in class org.apache.tools.ant.util.FileTokenizer +
    Get the complete input as a string +
    getToken(Reader) - +Method in class org.apache.tools.ant.util.LineTokenizer +
    get the next line from the input +
    getToken(Reader) - +Method in class org.apache.tools.ant.util.StringTokenizer +
    find and return the next token +
    getToken(Reader) - +Method in interface org.apache.tools.ant.util.Tokenizer +
    get the next token from the input stream +
    getToolsJar() - +Static method in class org.apache.tools.ant.launch.Locator +
    Get the File necessary to load the Sun compiler tools. +
    getToRefid() - +Method in class org.apache.tools.ant.taskdefs.Ant.Reference +
    Get the id under which this reference will be stored in the new + project. +
    getTraceConfiguration() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Configuration for Xalan2 traces. +
    getTrim() - +Method in class org.apache.tools.ant.taskdefs.Length +
    Learn whether strings will be trimmed. +
    getTrim() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    getTrust() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
      +
    getTsacert() - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    get the -tsacert option +
    getTsaurl() - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    get the -tsaurl url +
    getType() - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Get the handler type. +
    getType() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    Get the type signature of this entry +
    getType() - +Method in class org.apache.tools.ant.types.Parameter +
    Get the type attribute. +
    getType() - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Get the comparison type. +
    getType() - +Method in class org.apache.tools.ant.types.spi.Service +
      +
    getTypeClass(Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Get the definition class. +
    getTypeClass(Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Get the definition class. +
    getTypeKind() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get type-kind string +
    getTypeName() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get attribute type-name +
    getTypeName() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get type-name +
    getTypeName() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get type-name string +
    getTypeName() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get type-name string +
    getTypeValue() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get the attribute type-value +
    getUid() - +Method in class org.apache.tools.ant.types.resources.TarResource +
      +
    getUid() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    getUmask() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getUnicodeName() - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    getUniqueClassLoaderForPath(Project, Path, boolean) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Gets a fresh, different, previously unused classloader that uses the + passed path as its classpath. +
    getUnixMode() - +Method in class org.apache.tools.zip.ZipEntry +
    Unix permission. +
    getUnknownElements() - +Method in class org.apache.tools.ant.taskdefs.MacroInstance.Element +
      +
    getUnless() - +Method in class org.apache.tools.ant.Target +
    Returns the "unless" property condition of this target. +
    getUnlessCondition() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    The unless expression +
    getUnparseableExtraFieldData() - +Method in class org.apache.tools.zip.ZipEntry +
    Looks up extra field data that couldn't be parsed correctly. +
    getUpdateOnly() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    get the updateOnly attribute. +
    getURI() - +Method in class org.apache.tools.ant.taskdefs.AntlibDefinition +
    The URI for this definition. +
    getURI() - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Get the type's URI. +
    getURIandLocation() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    validate the fields then create a "uri location" string +
    getUribase() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the uri base value. +
    getUriroot() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the uri root value. +
    getUrl() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the url. +
    getUrl() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    The URL containing the schema. +
    getUrl() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the url attribute. +
    getURL() - +Method in class org.apache.tools.ant.types.resources.JavaResource +
    Get the URL represented by this Resource. +
    getURL() - +Method in interface org.apache.tools.ant.types.resources.URLProvider +
    Get the URL represented by this Resource. +
    getURL() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get the URL used by this URLResource. +
    getUseLanguageEnodingFlag() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether the language encoding flag will be used. +
    getUser() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the user string. +
    getUserID() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
    Get the user's id. +
    getUserId() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the userId. +
    getUserid() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    getUserId() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get the userid. +
    getUserId() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's user id. +
    getUserId() - +Method in class org.apache.tools.zip.AsiExtraField +
    Get the user id. +
    getUserInfo() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Get the user information. +
    getUserName() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Returns the userName field. +
    getUsername() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the username +
    getUserName() - +Method in class org.apache.tools.ant.types.resources.TarResource +
      +
    getUserName() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    getUserName() - +Method in class org.apache.tools.tar.TarEntry +
    Get this entry's user name. +
    getUserProperties() - +Method in class org.apache.tools.ant.Project +
    Return a copy of the user property hashtable. +
    getUserProperties() - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns a copy of the user property hashtable +
    getUserProperty(String) - +Method in class org.apache.tools.ant.Project +
    Return the value of a user property, if it is set. +
    getUserProperty(String, String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    getUserProperty(String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns the value of a user property, if it is set. +
    getUTF8Entry(String) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the index of a given UTF8 constant pool entry. +
    getValidate() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
      +
    getValidCount() - +Method in class org.apache.tools.ant.types.resources.SizeLimitCollection +
    Get the count, verifying it is >= 0. +
    getValue() - +Method in class org.apache.tools.ant.filters.LineContains.Contains +
    Returns the contains string. +
    getValue() - +Method in class org.apache.tools.ant.filters.ReplaceTokens.Token +
    Returns the value for this token. +
    getValue() - +Method in class org.apache.tools.ant.filters.StripLineComments.Comment +
    Returns the prefix for this type of line comment. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Apt.Option +
    Get the value attribute. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
      +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.email.Header +
    Get the value of this Header. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DnameParam +
    Get the value attribute. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletParam +
    Get the parameter value. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Get the Attribute's value. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo +
    Get the value of the constant. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo +
    Get the string value of the UTF-8 entry +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute +
    Gets the attribute value. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property +
    getter for the value of the property +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Property +
    Get the property value. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Get replacement String. +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute +
      +
    getValue() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty +
      +
    getValue() - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
      +
    getValue() - +Method in class org.apache.tools.ant.types.Environment.Variable +
    value accessor +
    getValue() - +Method in class org.apache.tools.ant.types.FilterSet.Filter +
    Gets the Value attribute of the Filter object. +
    getValue() - +Method in class org.apache.tools.ant.types.optional.ScriptCondition +
    get the current value of the conditon +
    getValue() - +Method in class org.apache.tools.ant.types.Parameter +
    Get the value attribute. +
    getValue() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the value of this PropertyResource. +
    getValue() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the value of this StringResource, resolving to the root reference if needed. +
    getValue(File) - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Algorithm +
    Get the value for a file. +
    getValue(File) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
    Computes a value for a file content with the specified checksum algorithm. +
    getValue(File) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    Computes a value for a file content with the specified digest algorithm. +
    getValue(File) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.HashvalueAlgorithm +
    Computes a 'hashvalue' for a file content. +
    getValue() - +Method in class org.apache.tools.zip.ZipLong +
    Get value as Java long. +
    getValue(byte[], int) - +Static method in class org.apache.tools.zip.ZipLong +
    Helper method to get the value as a Java long from four bytes starting at given array offset +
    getValue(byte[]) - +Static method in class org.apache.tools.zip.ZipLong +
    Helper method to get the value as a Java long from a four-byte array +
    getValue() - +Method in class org.apache.tools.zip.ZipShort +
    Get value as Java int. +
    getValue(byte[], int) - +Static method in class org.apache.tools.zip.ZipShort +
    Helper method to get the value as a java int from two bytes starting at given array offset +
    getValue(byte[]) - +Static method in class org.apache.tools.zip.ZipShort +
    Helper method to get the value as a java int from a two-byte array +
    getValues() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.CrLf +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Available.FileDir +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Checksum.FormatElement +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified.CompareMode +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Definer.Format +
    get the values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Definer.OnError +
    get the values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask.Encoding +
    finds the valid encoding values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.AddAsisRemove +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.CrLf +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Input.HandlerType +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Jar.FilesetManifestConfig +
    Get the list of valid strings. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Jar.StrictMode +
    Get List of valid strings. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.AccessType +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Length.FileMode +
    Return the possible values for FileMode. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Get all the attribute's values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.ManifestTask.Mode +
    Get Allowed values for the mode attribute. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties.FormatAttribute +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme +
    Gets the values of the NamingScheme +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask.FormatAttribute +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer.Format +
    list authorized values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.TypeAttribute +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.SummaryAttribute +
    list the possible values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.Action +
    Get the valid values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPSystemType +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.LanguageCode +
    Return the value values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Action +
    Get the valid values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask.FTPSystemType +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask.Granularity +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC.TraceAttr +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC.VerboseAttr +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Unit +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS.CurrentModUpdated +
    Gets the list of allowable values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS.WritableFiles +
    Gets the list of allowable values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY.BriefCodediffNofile +
    Gets the list of allowable values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.PathConvert.TargetOs +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Recorder.ActionChoices +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.SQLExec.DelimiterType +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.SQLExec.OnError +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod +
    Get valid enumeration values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Tstamp.Unit +
    Get the valid values. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Untar.UntarCompressionMethod +
    Get valid enumeration values +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Zip.Duplicate +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField +
      +
    getValues() - +Method in class org.apache.tools.ant.taskdefs.Zip.WhenEmpty +
    The string values for the enumerated value +
    getValues() - +Method in class org.apache.tools.ant.types.Comparison +
    Return the possible values. +
    getValues() - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.types.FilterSet.OnMissing +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.types.LogLevel +
      +
    getValues() - +Method in class org.apache.tools.ant.types.Mapper.MapperType +
      +
    getValues() - +Method in class org.apache.tools.ant.types.optional.image.Scale.ProportionsAttribute +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.types.PropertySet.BuiltinPropertySetName +
    This is the only method a subclass needs to implement.. +
    getValues() - +Method in class org.apache.tools.ant.types.Quantifier +
    Return the possible values. +
    getValues() - +Method in class org.apache.tools.ant.types.resources.selectors.Type.FileDir +
    Return the possible values. +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.AlgorithmName +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.CacheName +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.ComparatorName +
    This is the only method a subclass needs to implement. +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.PresentSelector.FilePresence +
      +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.SizeSelector.ByteUnits +
      +
    getValues() - +Method in class org.apache.tools.ant.types.selectors.TypeSelector.FileType +
      +
    getValues() - +Method in class org.apache.tools.ant.types.TimeComparison +
    Return the possible values. +
    getVariables() - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Get the properties as an array; this is an override of the + superclass, as it evaluates all the properties. +
    getVariables() - +Method in class org.apache.tools.ant.types.Environment +
    get the variable list as an array +
    getVariablesVector() - +Method in class org.apache.tools.ant.types.Environment +
    Get the raw vector of variables. +
    getVendorDDPrefix(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Get the prefix for vendor deployment descriptors. +
    getVendorOutputJarFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Get the vendor specific name of the Jar that will be output.. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Gets the verbose flag. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Whether verbose output should get generated. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the verbose level. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the 'verbose' Flag. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Is the verbose attribute set. +
    getVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Get the verbose flag. +
    getVerify() - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Get verify flag. +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the version. +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Get version flag status +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Get version flag status +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get version flag status +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the version +
    getVersion() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the version string. +
    getVersionDate() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the Version date string. +
    getVersionDateLabel() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the version string. +
    getVersionLabel() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the version string. +
    getViewPath() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Get the path to the item in a clearcase view +
    getViewPathBasename() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Get the basename path of the item in a clearcase view +
    getVmCommand() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the VM command, including memory. +
    getVmversion() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get the vm version. +
    getVOB() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Get VOB name +
    getVOB() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Get VOB name +
    getVOB() - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Get VOB name +
    getVsspath() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the vssserverpath string. +
    getVssServerPath() - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Get the VSS server path +
    getWarnings() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Get the warnings for this manifest. +
    getWarnings() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Get the warnings for this section. +
    getWebApp() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the web app. +
    getWebinc() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Get the webinc attribute. +
    getWeblogicDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Get the weblogic descriptor handler. +
    getWebsphereDescriptorHandler(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Get a description handler. +
    getWebxml() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Filename for web.xml. +
    getWhen() - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Get the comparison mode. +
    getWhen() - +Method in class org.apache.tools.ant.types.resources.selectors.Size +
    Get the comparison mode. +
    getWidth() - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Get the width. +
    getWorkingDirectory() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Return the working directory. +
    getWorkspace() - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Get name of the workspace to store the retrieved files +
    getWrapper() - +Method in class org.apache.tools.ant.Task +
    Return the runtime configurable structure for this task. +
    getWrapper() - +Method in class org.apache.tools.ant.UnknownElement +
    Get the RuntimeConfigurable instance for this UnknownElement, containing + the configuration information. +
    getWrapperStack() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    access the stack of wrappers +
    getWritable() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the writable string. +
    getWritableFiles() - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Gets the value to determine the behaviour when encountering writable files. +
    getXMLCatalog() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Get the XML catalog containing entity definitions +
    getXmlReader() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    get the XML reader. +
    getXMLReader() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns a newly created SAX 2 XMLReader, using the default parser + factory. +
    getZipfile() - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Get the zipfile that holds this ZipResource. +
    GIDLEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the group id field in a header buffer. +
    GlobPatternMapper - Class in org.apache.tools.ant.util
    Implementation of FileNameMapper that does simple wildcard pattern + replacements.
    GlobPatternMapper() - +Constructor for class org.apache.tools.ant.util.GlobPatternMapper +
      +
    GNAMELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the group name field in a header buffer. +
    GNU - +Static variable in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + Tar.GNU is deprecated and is replaced with + Tar.TarLongFileMode.GNU +
    GNU - +Static variable in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    permissible values for longfile attribute +
    GNU_LONGLINK - +Static variable in interface org.apache.tools.tar.TarConstants +
    The namr of the GNU tar entry which contains a long name. +
    GNU_TMAGIC - +Static variable in interface org.apache.tools.tar.TarConstants +
    The magic tag representing a GNU tar archive. +
    grabArchives() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Turns all nested resources into corresponding ArchiveFileSets + and returns an iterator over the collected archives. +
    grabFilesAndDirs(String, List, List) - +Static method in class org.apache.tools.ant.taskdefs.Jar +
    Grab lists of all root-level files and all directories + contained in the given archive. +
    grabNonFileSetResources(ResourceCollection[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Fetch all included and not excluded resources from the collections. +
    grabResources(FileSet[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Fetch all included and not excluded resources from the sets. +
    granularity - +Variable in class org.apache.tools.ant.types.selectors.MappingSelector +
      +
    GRANULARITY_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    GREATER - +Static variable in class org.apache.tools.ant.types.Comparison +
    Greater Comparison. +
    GREATER_EQUAL - +Static variable in class org.apache.tools.ant.types.Comparison +
    Greater-or-Equal Comparison. +
    GREATER_ICOST - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    GreedyInputHandler - Class in org.apache.tools.ant.input
    Prompts on System.err, reads input from System.in until EOF
    GreedyInputHandler() - +Constructor for class org.apache.tools.ant.input.GreedyInputHandler +
    Empty no-arg constructor +
    guessRpmBuildCommand() - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Checks whether rpmbuild is on the PATH and returns + the absolute path to it - falls back to rpm + otherwise. +
    GUnzip - Class in org.apache.tools.ant.taskdefs
    Expands a file that has been compressed with the GZIP + algorithm.
    GUnzip() - +Constructor for class org.apache.tools.ant.taskdefs.GUnzip +
      +
    GZip - Class in org.apache.tools.ant.taskdefs
    Compresses a file with the GZIP algorithm.
    GZip() - +Constructor for class org.apache.tools.ant.taskdefs.GZip +
      +
    GZipResource - Class in org.apache.tools.ant.types.resources
    A GZip compressed resource.
    GZipResource() - +Constructor for class org.apache.tools.ant.types.resources.GZipResource +
    A no-arg constructor +
    GZipResource(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.GZipResource +
    Constructor with another resource to wrap. +
    +
    +

    +H

    +
    +
    haltOnError - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    haltOnFail - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    handleChildren(Object, RuntimeConfigurable) - +Method in class org.apache.tools.ant.UnknownElement +
    Creates child elements, creates children of the children + (recursively), and sets attributes of the child elements. +
    handleError(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Throws an exception with the given message if failOnError is + true, otherwise logs the message using the WARN level. +
    handleError(Throwable) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Throws an exception with the given nested exception if + failOnError is true, otherwise logs the message using the WARN + level. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.Task +
    Handles an error line by logging it with the WARN priority. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Handle error output. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Handle error output. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Handle output sent to System.err and flush the stream. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Pass output sent to System.err to the TestRunner so it can + collect it for the formatters. +
    handleErrorFlush(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Handle output sent to System.err. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Handle output sent to System.err.. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Handle a flush operation on the error stream +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Pass output sent to System.err to the new project. +
    handleErrorFlush(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Handles error output sent to System.err by this task or its real task. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.Task +
    Handles an error output by logging it with the WARN priority. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Handle error output. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Handle error output. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Handle output sent to System.err. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Pass output sent to System.err to the TestRunner so it can + collect it for the formatters. +
    handleErrorOutput(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Handle output sent to System.err. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Handle output sent to System.err.. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Process error output +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Pass output sent to System.err to the new project. +
    handleErrorOutput(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Handles error output sent to System.err by this task or its real task. +
    handleFlush(String) - +Method in class org.apache.tools.ant.Task +
    Handles output by logging it with the INFO priority. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Handles output. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Handles output. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Pass output sent to System.out to specified output file. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Pass output sent to System.out to the TestRunner so it can + collect ot for the formatters. +
    handleFlush(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Handle output sent to System.out. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Handle output sent to System.out.. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Process data due to a flush operation. +
    handleFlush(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Pass output sent to System.out to the new project. +
    handleFlush(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Handles output sent to System.out by this task or its real task. +
    handleInput(InputRequest) - +Method in class org.apache.tools.ant.input.DefaultInputHandler +
    Prompts and requests input. +
    handleInput(InputRequest) - +Method in class org.apache.tools.ant.input.GreedyInputHandler +
    Prompts and requests input. +
    handleInput(InputRequest) - +Method in interface org.apache.tools.ant.input.InputHandler +
    Handle the request encapsulated in the argument. +
    handleInput(InputRequest) - +Method in class org.apache.tools.ant.input.PropertyFileInputHandler +
    Picks up the input from a property, using the prompt as the + name of the property. +
    handleInput(InputRequest) - +Method in class org.apache.tools.ant.input.SecureInputHandler +
    Handle the input +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.Task +
    Handle an input request by this task. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Handles input. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Handles input. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Handle an input request by this task. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Handle an input request by this task. +
    handleInput(byte[], int, int) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Handle an input request. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Handle input. +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Handle an input request +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Process input into the ant task +
    handleInput(byte[], int, int) - +Method in class org.apache.tools.ant.UnknownElement +
    Delegate to realThing if present and if it as task. +
    handleOutput(String) - +Method in class org.apache.tools.ant.Task +
    Handles output by logging it with the INFO priority. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Handles output. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Handles output. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Pass output sent to System.out to specified output file. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Pass output sent to System.out to the TestRunner so it can + collect it for the formatters. +
    handleOutput(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Handle output sent to System.out. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Handle a string destined for standard output. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Pass output sent to System.out to specified output. +
    handleOutput(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Pass output sent to System.out to the new project. +
    handleOutput(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Handles output sent to System.out by this task or its real task. +
    handleTransformationError(Exception) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Throws an exception with the given nested exception if + failOnError and failOnTransformationError are true, otherwise + logs the message using the WARN level. +
    hasBeenSet() - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Tests whether the implementation has been chosen by the user + (either via a magic property or explicitly. +
    hasCpDelegate() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Check if classpath attributes have been set. +
    hasDirModeBeenSet() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Whether the user has specified the mode explicitly. +
    hasErrorInCase(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    test whether a file or directory exists, with an error in the + upper/lower case spelling of the name. +
    hasFileModeBeenSet() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Whether the user has specified the mode explicitly. +
    hasFilters() - +Method in class org.apache.tools.ant.types.FilterSet +
    Test to see if this filter set has filters. +
    hasFilters() - +Method in class org.apache.tools.ant.types.FilterSetCollection +
    Test to see if this filter set it empty. +
    hasFlag(int, int) - +Static method in class org.apache.tools.ant.util.regexp.RegexpUtil +
    Check the options has a particular flag set. +
    HasFreeSpace - Class in org.apache.tools.ant.taskdefs.condition
    <hasfreespace>
    HasFreeSpace() - +Constructor for class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
      +
    hasGroupBeenSet() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    hasGroupIdBeenSet() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    hashCode() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove +
    Hashcode depending on the index. +
    hashCode() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter.CrLf +
    Hashcode depending on the index. +
    hashCode() - +Method in class org.apache.tools.ant.Location +
    Hash operation. +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos +
      +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Generate a hashcode depending on the namespace, url and file name. +
    hashCode() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    The hashcode method. +
    hashCode() - +Method in class org.apache.tools.ant.types.Resource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
    Hashcode based on the rules for equality. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.comparators.ResourceComparator +
    Hashcode based on the rules for equality. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.MappedResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Get the hash code for this Resource. +
    hashCode() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
      +
    hashCode() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
      +
    hashCode() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    hashCode() - +Method in class org.apache.tools.tar.TarEntry +
    Hashcodes are based on entry names. +
    hashCode() - +Method in class org.apache.tools.zip.ZipEntry +
    Get the hashCode of the entry. +
    hashCode() - +Method in class org.apache.tools.zip.ZipLong +
    Override to make two instances with same value equal. +
    hashCode() - +Method in class org.apache.tools.zip.ZipShort +
    Override to make two instances with same value equal. +
    hasHitEOF - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    HashvalueAlgorithm - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Computes a 'hashvalue' for the content of file using String.hashValue().
    HashvalueAlgorithm() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.HashvalueAlgorithm +
      +
    HasMethod - Class in org.apache.tools.ant.taskdefs.condition
    test for a method
    HasMethod() - +Constructor for class org.apache.tools.ant.taskdefs.condition.HasMethod +
      +
    hasMoreElements() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated.   +
    hasMoreElements() - +Method in class org.apache.tools.ant.util.CollectionUtils.EmptyEnumeration +
      +
    hasMoreLines(String) - +Method in class org.apache.tools.mail.SmtpResponseReader +
    Should we expect more input? +
    hasMoreTokens() - +Method in class org.apache.tools.ant.PathTokenizer +
    Tests if there are more path elements available from this tokenizer's + path. +
    hasNext() - +Method in class org.apache.tools.ant.types.resources.FileResourceIterator +
    Find out whether this FileResourceIterator has more elements. +
    hasPatterns() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Indicates whether there are any patterns here. +
    hasPatterns(Project) - +Method in class org.apache.tools.ant.types.PatternSet +
    Helper for FileSet classes. +
    hasPatterns() - +Method in class org.apache.tools.ant.types.resources.Files +
    Find out whether this Files collection has patterns. +
    hasReference(String) - +Method in class org.apache.tools.ant.Project +
    Does the project know this reference? +
    hasResources() - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Has either a path or a fileset been specified? +
    hasSelectors() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Indicates whether there are any selectors here. +
    hasSelectors() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Indicates whether there are any selectors here. +
    hasSelectors() - +Method in class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Learn whether this ResourceSelectorContainer has selectors. +
    hasSelectors() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Indicates whether there are any selectors here. +
    hasSelectors() - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Indicates whether there are any selectors here. +
    hasSelectors() - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    Indicates whether there are any selectors here. +
    hasSelectors() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Indicates whether there are any selectors here. +
    hasUpdatedFile() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Get the value of the updatedFile attribute. +
    hasUserIdBeenSet() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    hasUserNameBeenSet() - +Method in class org.apache.tools.ant.types.TarFileSet +
      +
    hasWildcards(String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests if a string contains stars or question marks +
    haveBootclasspath(boolean) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Determine whether the bootclasspath has been specified, and whether it + shall really be used (build.sysclasspath could be set or the VM may not + support it). +
    haveClasspath() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Determine whether the classpath has been specified, and whether it shall + really be used or be nulled by build.sysclasspath. +
    haveSlowResults - +Variable in class org.apache.tools.ant.DirectoryScanner +
    Whether or not our results were built by a slow scan. +
    hbMakeCodeLengths(char[], int[], int, int) - +Static method in class org.apache.tools.bzip2.CBZip2OutputStream +
    This method is accessible by subclasses for historical + purposes. +
    HEADER - +Static variable in class org.apache.tools.ant.listener.BigProjectLogger +
    Header string for the log. +
    Header - Class in org.apache.tools.ant.taskdefs.email
    Class representing a generic e-mail header.
    Header() - +Constructor for class org.apache.tools.ant.taskdefs.email.Header +
      +
    headers - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    HeadFilter - Class in org.apache.tools.ant.filters
    Reads the first n lines of a stream.
    HeadFilter() - +Constructor for class org.apache.tools.ant.filters.HeadFilter +
    Constructor for "dummy" instances. +
    HeadFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.HeadFilter +
    Creates a new filtered reader. +
    height - +Variable in class org.apache.tools.ant.types.optional.image.Arc +
      +
    height - +Variable in class org.apache.tools.ant.types.optional.image.Ellipse +
      +
    height - +Variable in class org.apache.tools.ant.types.optional.image.Rectangle +
      +
    HELPER_PROPERTY - +Static variable in class org.apache.tools.ant.ProjectHelper +
    Name of JVM system property which provides the name of the + ProjectHelper class to use. +
    host - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    HostInfo - Class in org.apache.tools.ant.taskdefs
    Sets properties to the host provided, or localhost if no information is + provided.
    HostInfo() - +Constructor for class org.apache.tools.ant.taskdefs.HostInfo +
      +
    HOSTNAME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    name of host running the tests +
    HotDeploymentTool - Interface in org.apache.tools.ant.taskdefs.optional.j2ee
    An interface for vendor-specific "hot" deployment tools.
    HOUR - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    hour string +
    Http - Class in org.apache.tools.ant.taskdefs.condition
    Condition to wait for a HTTP request to succeed.
    Http() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Http +
      +
    HTTP_NON_PROXY_HOSTS - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the ftp proxyport property +
    HTTP_PROXY_HOST - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the http proxyhost property +
    HTTP_PROXY_PASSWORD - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the http proxy password property +
    HTTP_PROXY_PORT - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the http proxyport property +
    HTTP_PROXY_USERNAME - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the http proxy username property +
    HTTPS_NON_PROXY_HOSTS - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the http hosts not to be proxied property +
    HTTPS_PROXY_HOST - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the https proxyhost property +
    HTTPS_PROXY_PORT - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the https proxyport property +
    +
    +

    +I

    +
    +
    IdentityMapper - Class in org.apache.tools.ant.util
    Implementation of FileNameMapper that always returns the source file name.
    IdentityMapper() - +Constructor for class org.apache.tools.ant.util.IdentityMapper +
      +
    IdentityStack - Class in org.apache.tools.ant.util
    Identity Stack.
    IdentityStack() - +Constructor for class org.apache.tools.ant.util.IdentityStack +
    Default constructor. +
    IdentityStack(Object) - +Constructor for class org.apache.tools.ant.util.IdentityStack +
    Construct a new IdentityStack with the specified Object + as the bottom element. +
    ifProperty - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    IGNORE - +Static variable in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
    ignore the extensionOf attribute if the extension-point is not defined +
    IGNORE - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    Enumerated values +
    IGNORE - +Static variable in class org.apache.tools.ant.types.FilterSet.OnMissing +
    Ignore value +
    IGNORE - +Static variable in class org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy +
    Ignores namespaces for elements and attributes, the default. +
    IGNORED_FILE_NAME - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Used in formatter arguments as a placeholder for the basename + of the output file (which gets replaced by a test specific + output file name later). +
    IgnoreDependenciesExecutor - Class in org.apache.tools.ant.helper
    Target executor implementation that ignores dependencies.
    IgnoreDependenciesExecutor() - +Constructor for class org.apache.tools.ant.helper.IgnoreDependenciesExecutor +
      +
    ignoringThrowable(String, Throwable) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    log that we are ignoring something rather than rethrowing it. +
    Image - Class in org.apache.tools.ant.taskdefs.optional.image
    A MatchingTask which relies on JAI (Java + Advanced Imaging) to perform image manipulation operations on + existing images.
    Image() - +Constructor for class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    ImageOperation - Class in org.apache.tools.ant.types.optional.image
     
    ImageOperation() - +Constructor for class org.apache.tools.ant.types.optional.image.ImageOperation +
      +
    ImmutableResourceException - Exception in org.apache.tools.ant.types.resources
    Exception thrown when an attempt is made to get an OutputStream + from an immutable Resource.
    ImmutableResourceException() - +Constructor for exception org.apache.tools.ant.types.resources.ImmutableResourceException +
    Default constructor. +
    ImmutableResourceException(String) - +Constructor for exception org.apache.tools.ant.types.resources.ImmutableResourceException +
    Construct a new ImmutableResourceException with the specified message. +
    IMPLEMENTATION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.javah.Gcjh +
      +
    IMPLEMENTATION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.javah.Kaffeh +
    the name of the javah adapter - kaffeh +
    IMPLEMENTATION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.javah.SunJavah +
    the name of the javah adapter - sun +
    IMPLEMENTATION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii +
    Identifies this adapter. +
    IMPLEMENTATION_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii +
    Identifies this adapter. +
    IMPLEMENTATION_TITLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for IMPLEMENTATION_TITLE. +
    IMPLEMENTATION_URL - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for IMPLEMENTATION_URL. +
    IMPLEMENTATION_VENDOR - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for IMPLEMENTATION_VENDOR. +
    IMPLEMENTATION_VENDOR - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for IMPLEMENTATION_VENDOR. +
    IMPLEMENTATION_VENDOR_ID - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for IMPLEMENTATION_VENDOR_ID. +
    IMPLEMENTATION_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for IMPLEMENTATION_VERSION. +
    IMPLEMENTATION_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for IMPLEMENTATION_VERSION. +
    ImplementationSpecificArgument - Class in org.apache.tools.ant.util.facade
    Extension of Commandline.Argument with a new attribute that choses + a specific implementation of the facade.
    ImplementationSpecificArgument() - +Constructor for class org.apache.tools.ant.util.facade.ImplementationSpecificArgument +
    Constructor for ImplementationSpecificArgument. +
    implementsOwnDependencyChecking() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    ask if compiler can sort out its own dependencies +
    implementsOwnDependencyChecking() - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapter +
    ask if compiler can sort out its own dependencies +
    importNode(Node, Node) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil +
    Simple tree walker that will clone recursively a node. +
    ImportTask - Class in org.apache.tools.ant.taskdefs
    Task to import another build file into the current project.
    ImportTask() - +Constructor for class org.apache.tools.ant.taskdefs.ImportTask +
      +
    includeAntRuntime - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    includeEmpty - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    includeEmpty - +Variable in class org.apache.tools.ant.taskdefs.Delete +
      +
    includeFileNames - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    includeJavaRuntime - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    includes - +Variable in class org.apache.tools.ant.DirectoryScanner +
    The patterns for the files to be included. +
    INCOMPATIBLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Enum indicating that extension is incompatible with + other extension in ways other than other enums + indicate). +
    INCOMPATIBLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    This enum indicates that an extension is incompatible with + other Package Specification in ways other than other enums + indicate. +
    INCREMENT_OPER - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    + +
    indexOf(Object, int) - +Method in class org.apache.tools.ant.util.IdentityStack +
    Override methods that use .equals() comparisons on elements. +
    indexOfValue(String) - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
    get the index of a value in this enumeration. +
    INFO - +Static variable in class org.apache.tools.ant.types.LogLevel +
    INFO loglevel constant. +
    info(String) - +Method in class org.apache.tools.ant.util.TaskLogger +
    Log a message with MSG_INFO priority +
    inheritIDReferences(Project) - +Method in class org.apache.tools.ant.Project +
    Inherit the id references. +
    init() - +Method in class org.apache.tools.ant.Project +
    Initialise the project. +
    init() - +Method in class org.apache.tools.ant.Task +
    Called by the project to let the task initialize properly. +
    init() - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Creates a Project instance for the project to call. +
    init() - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Initialize this task by creating new instance of the ant task and + configuring it by calling its own init method. +
    init() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
      +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Adds the jars or directories containing Antlr + this should make the forked JVM work without having to + specify it directly. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Adds the jars or directories containing Ant, this task and + JUnit to the classpath - this should make the forked JVM work + without having to specify them directly. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    init-Method sets defaults from Properties. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    sets attributes Port, Client, User from properties + if these properties are defined. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    Called by the project to let the task initialize properly. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask +
    Initialize the task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Initialize this task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Initialize the task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Initialize the task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Called by the project to let the task initialize properly. +
    init(File) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
    initialises the class +
    init() - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Overridden so we can add the task as build listener. +
    init() - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Initialize the sync task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Initializes the task. +
    init() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Initialize internal instance of XMLCatalog +
    init() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Initialize DirectoryScanner data structures. +
    INIT_FAILED_MSG - +Static variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    initAll() - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Used to be part of init. +
    initAllDone - +Variable in class org.apache.tools.ant.util.LazyHashtable +
      +
    initChecksum() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
    Initialize the checksum interface. +
    initDefaultDefinitions() - +Method in class org.apache.tools.ant.ComponentHelper +
    This method is initialization code implementing the original ant component + loading from /org/apache/tools/ant/taskdefs/default.properties + and /org/apache/tools/ant/types/default.properties. +
    initializeClass(Class) - +Static method in class org.apache.tools.ant.AntClassLoader +
    Deprecated. since 1.6.x. + Use Class.forName with initialize=true instead. +
    initialValue() - +Method in class org.apache.tools.ant.property.LocalProperties +
    Get the initial value. +
    initMessageDigest() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    Initialize the security message digest. +
    initProperties() - +Method in class org.apache.tools.ant.Project +
    Initializes the properties. +
    initScriptRunner() - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Initialize the script runner. +
    initSubProject(ComponentHelper) - +Method in class org.apache.tools.ant.ComponentHelper +
    Used with creating child projects. +
    initSubProject(Project) - +Method in class org.apache.tools.ant.Project +
    Initialize a subproject. +
    initValidator() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    init the parser : load the parser class, and set features if necessary It + is only after this that the reader is valid +
    initValidator() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    init the parser : + load the parser class, and set features if necessary + It is only after this that the reader is valid +
    initZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Ear +
    Initialize the output stream. +
    initZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Initialize the zip output stream. +
    initZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.War +
    override of parent; validates configuration + before initializing the output stream. +
    initZipOutputStream(ZipOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    method for subclasses to override +
    InnerClassFilenameFilter - Class in org.apache.tools.ant.taskdefs.optional.ejb
    A filename filter for inner class files of a particular class.
    innerCreateAndSet(Class, Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Inner implementation of the AntTypeDefinition.createAndSet(Project, Class) logic, with no + exception catching +
    innerGetTypeClass() - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Try and load a class, with no attempt to catch any fault. +
    Input - Class in org.apache.tools.ant.taskdefs
    Reads an input line from the console.
    Input() - +Constructor for class org.apache.tools.ant.taskdefs.Input +
    No arg constructor. +
    Input.Handler - Class in org.apache.tools.ant.taskdefs
    Represents an InputHandler.
    Input.Handler() - +Constructor for class org.apache.tools.ant.taskdefs.Input.Handler +
      +
    Input.HandlerType - Class in org.apache.tools.ant.taskdefs
    EnumeratedAttribute representing the built-in input handler types: + "default", "propertyfile", "greedy", "secure" (since Ant 1.8).
    Input.HandlerType() - +Constructor for class org.apache.tools.ant.taskdefs.Input.HandlerType +
      +
    InputHandler - Interface in org.apache.tools.ant.input
    Plugin to Ant to handle requests for user input.
    InputRequest - Class in org.apache.tools.ant.input
    Encapsulates an input request.
    InputRequest(String) - +Constructor for class org.apache.tools.ant.input.InputRequest +
    Construct an InputRequest. +
    insertElementAt(Object, int) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    InstanceOf - Class in org.apache.tools.ant.types.resources.selectors
    InstanceOf ResourceSelector.
    InstanceOf() - +Constructor for class org.apache.tools.ant.types.resources.selectors.InstanceOf +
      +
    instructions - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    instructions - +Variable in class org.apache.tools.ant.types.optional.image.ImageOperation +
      +
    INTEGER_TYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
    int +
    IntegerCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    An Integer CP Info
    IntegerCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.IntegerCPInfo +
    Constructor. +
    integerSetDirMode(int) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755 +
    integerSetFileMode(int) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 +
    InterfaceMethodRefCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A InterfaceMethodRef CP Info
    InterfaceMethodRefCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Constructor. +
    internalSetEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Supports grand-children that want to support the attribute + where the child-class doesn't (i.e. +
    internalSetScanForUnicodeExtraFields(boolean) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Supports grand-children that want to support the attribute + where the child-class doesn't (i.e. +
    internalsf - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    flag for internal sf signing +
    Intersect - Class in org.apache.tools.ant.types.resources
    ResourceCollection representing the intersection + of multiple nested ResourceCollections.
    Intersect() - +Constructor for class org.apache.tools.ant.types.resources.Intersect +
      +
    IntrospectionHelper - Class in org.apache.tools.ant
    Helper class that collects the methods a task or nested element + holds to set attributes, create nested elements or hold PCDATA + elements.
    IntrospectionHelper.Creator - Class in org.apache.tools.ant
    creator - allows use of create/store external + to IntrospectionHelper.
    intValue() - +Method in class org.apache.tools.ant.types.FlexInteger +
    Returns the decimal integer value +
    INVALID - +Static variable in class org.apache.tools.ant.taskdefs.Execute +
    Invalid exit code. +
    invalidateExistingIterators() - +Method in class org.apache.tools.ant.types.resources.Resources +
    Allow subclasses to notify existing Iterators they have experienced concurrent modification. +
    invoke(Object, String) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Call a method on the object with no parameters. +
    invoke(Object, String, Class, Object) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Call a method on the object with one argument. +
    invoke(Object, String, Class, Object, Class, Object) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Call a method on the object with two argument. +
    invoke(String) - +Method in class org.apache.tools.ant.util.ReflectWrapper +
    Call a method on the object with no parameters. +
    invoke(String, Class, Object) - +Method in class org.apache.tools.ant.util.ReflectWrapper +
    Call a method on the object with one argument. +
    invoke(String, Class, Object, Class, Object) - +Method in class org.apache.tools.ant.util.ReflectWrapper +
    Call a method on the object with one argument. +
    invokeCircularReferenceCheck(DataType, Stack, Project) - +Static method in class org.apache.tools.ant.types.DataType +
    Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes. +
    invokeStatic(Object, String) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Call a method on the object with no parameters. +
    IPlanetDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    This class is used to generate iPlanet Application Server (iAS) 6.0 stubs and + skeletons and build an EJB Jar file.
    IPlanetDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
      +
    IPlanetEjbc - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Compiles EJB stubs and skeletons for the iPlanet Application + Server (iAS).
    IPlanetEjbc(File, File, File, String, SAXParser) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Constructs an instance which may be used to process EJB descriptors and + generate EJB stubs and skeletons, if needed. +
    IPlanetEjbc.EjbcException - Exception in org.apache.tools.ant.taskdefs.optional.ejb
    This inner class is used to signal any problems during the execution of + the ejbc compiler.
    IPlanetEjbc.EjbcException(String) - +Constructor for exception org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc.EjbcException +
    Constructs an exception with the given descriptive message. +
    IPlanetEjbcTask - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Compiles EJB stubs and skeletons for the iPlanet Application Server.
    IPlanetEjbcTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
      +
    is272() - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Whether the antlr version is 2.7.2 (or higher). +
    isAbsolute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
    FTP files are stored as absolute paths +
    isAbsolute() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
    FTP files are stored as absolute paths +
    isAbsolutePath(String) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Verifies that the specified filename represents an absolute path. +
    isActionValid() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Determines if the "action" attribute defines a valid action. +
    isActionValid() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Determines if the "action" attribute defines a valid action. +
    isActionValid() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Determines if the action supplied is valid. +
    isActionValid() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Determines if the action supplied is valid. +
    isAdd() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view +
    isAddingNewFiles() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Indicates if the task is adding new files into the archive as opposed to + copying back unchanged files from the backup copy +
    isApacheHarmony() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Checks whether the current VM is Apache Harmony. +
    isAppendSupported() - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Learn whether the transformation performed allows appends. +
    isArch(String) - +Static method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the + given OS architecture. +
    isAtLeastJavaVersion(String) - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class. +
    isAttributeSupported(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Indicates whether the task supports a given attribute name +
    isAutocommit() - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Gets the autocommit. +
    isAvailable() - +Static method in class org.apache.tools.ant.taskdefs.rmic.KaffeRmic +
    test for kaffe being on the system +
    isBinary() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isBinary() - +Method in class org.apache.tools.ant.types.resources.comparators.Content +
    Learn whether this Content ResourceComparator is operating in binary mode. +
    isCache() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Learn whether to cache collections. +
    isCache() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Learn whether to cache collections. +
    isCache() - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Learn whether to cache collections. +
    isCaching(boolean) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Set the caching attribute. +
    isCaseSensitive - +Variable in class org.apache.tools.ant.DirectoryScanner +
    Whether or not the file system should be treated as a case sensitive + one. +
    isCaseSensitive() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Find out whether include exclude patterns are matched in a + case sensitive way. +
    isCaseSensitive() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Find out if the fileset is case sensitive. +
    isCaseSensitive() - +Method in class org.apache.tools.ant.types.resources.Files +
    Find out if this Files collection is case-sensitive. +
    isCaseSensitive() - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Learn whether this Name ResourceSelector is case-sensitive. +
    isChecked() - +Method in class org.apache.tools.ant.types.DataType +
    The flag that is used to indicate that circular references have been checked. +
    isClosureRequired() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Indicate if the analyzer is required to follow + indirect class relationships. +
    isCompatibleWith(Extension) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return true if the specified Extension + (which represents an optional package required by an application) + is satisfied by this Extension (which represents an + optional package that is already installed. +
    isCompatibleWith(Specification) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Return true if the specified package + is satisfied by this Specification. +
    isCompile() - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Get the compile option for the apt compiler. +
    isCompress() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether we want to compress the files or only store them; +
    isConfigurationSet() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isContainer() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Indicates whether the introspected class is a task container, + supporting arbitrary nested tasks/types. +
    isContextLoaderAvailable() - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Indicates if the context class loader methods are available +
    isContextRelativePath(String) - +Static method in class org.apache.tools.ant.util.FileUtils +
    On DOS and NetWare, the evaluation of certain file + specifications is context-dependent. +
    isCreateFile() - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Learn whether createFile flag is set for this tempfile task. +
    isDanglingSymbolicLink(String) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a broken symbolic link. +
    isDanglingSymbolicLink(File) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a broken symbolic link. +
    isDanglingSymbolicLink(File, String) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a broken symbolic link. +
    isDelete() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view +
    isDeleteOnExit() - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Learn whether deleteOnExit is set for this tempfile task. +
    isDescendent(TarEntry) - +Method in class org.apache.tools.tar.TarEntry +
    Determine if the given entry is a descendant of this entry. +
    isDir() - +Method in class org.apache.tools.ant.taskdefs.Available.FileDir +
    Indicate if the value specifies a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    tell if a file is a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    isDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    tell if a file is a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    isDirectory() - +Method in class org.apache.tools.ant.types.Resource +
    Tells if the resource is a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Learn whether this Resource represents a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Learn whether the resource is a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Tells if the resource is a directory. +
    isDirectory() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Tells if the resource is a directory. +
    isDirectory() - +Method in class org.apache.tools.tar.TarEntry +
    Return whether or not this entry represents a directory. +
    isDirectory() - +Method in class org.apache.tools.zip.AsiExtraField +
    Is this entry a directory? +
    isDirectory() - +Method in class org.apache.tools.zip.ZipEntry +
    Is this entry a directory? +
    isDynamic() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Indicates whether the introspected class is a dynamic one, + supporting arbitrary nested elements and/or attributes. +
    isEmpty(Resource[][]) - +Static method in class org.apache.tools.ant.taskdefs.Zip +
    Check is the resource arrays are empty. +
    isEmpty() - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Check if the table is empty. +
    isEmpty() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    isEnableBaselessMerges() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    gets the enablebaselessmerges flag +
    isEnableMultipleMapping() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Get whether multiple mapping is enabled. +
    isEOFRecord(byte[]) - +Method in class org.apache.tools.tar.TarBuffer +
    Determine if an archive record indicate End of Archive. +
    isEqual(DeweyDecimal) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return true if this DeweyDecimal is + equal to the other DeweyDecimal. +
    isEverythingIncluded() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Return whether or not the scanner has included all the files or + directories it has come across so far. +
    isExcluded(String) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a name matches against at least one exclude + pattern. +
    isExists() - +Method in class org.apache.tools.ant.types.Resource +
    The exists attribute tells whether a resource exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Learn whether this resource exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Find out whether this Resource represents an existing Resource. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Learn whether this file exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Find out whether this Resource exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    The exists attribute tells whether a file exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    The exists attribute tells whether a resource exists. +
    isExists() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Find out whether the URL exists . +
    isFailMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    IsFailure - Class in org.apache.tools.ant.taskdefs.condition
    Condition to test a return-code for failure.
    IsFailure() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsFailure +
      +
    isFailure(int) - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    Checks whether exitValue signals a failure on the current + system (OS specific). +
    isFailure() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Did this execute return in a failure. +
    IsFalse - Class in org.apache.tools.ant.taskdefs.condition
    Condition that tests whether a given string evals to false
    IsFalse() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsFalse +
      +
    isFamily(String) - +Static method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the + given OS family. +
    isFile() - +Method in class org.apache.tools.ant.taskdefs.Available.FileDir +
    Indicate if the value specifies a file. +
    isFile() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    isFile() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    isFileFileSet(ResourceCollection) - +Static method in class org.apache.tools.ant.taskdefs.Tar +
    whether the given resource collection is a (subclass of) + FileSet that only contains file system resources. +
    IsFileSelected - Class in org.apache.tools.ant.taskdefs.condition
    This is a condition that checks to see if a file passes an embedded selector.
    IsFileSelected() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsFileSelected +
      +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Implement ResourceCollection. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.DirSet +
    Always returns true. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.FileList +
    Always returns true. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.FileSet +
    Always returns true. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.Path +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Check if this resource is only for filesystems. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.PropertySet +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.Resource +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in interface org.apache.tools.ant.types.ResourceCollection +
    Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.Archives +
      +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.Files +
    Always returns true. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.Resources +
    Fulfill the ResourceCollection contract. +
    isFilesystemOnly() - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Fulfill the ResourceCollection contract. +
    isFinished() - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    Tells whether the end of the stream has been reached. +
    isFinished() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Query the task/thread for being finished. +
    isFirstPass() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether this is the first time the archive building methods are invoked. +
    isFollowSymlinks() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Get whether or not a DirectoryScanner follows symbolic links. +
    isFollowSymlinks() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Find out if the fileset wants to follow symbolic links. +
    isFollowSymlinks() - +Method in class org.apache.tools.ant.types.resources.Files +
    Find out whether symbolic links should be followed. +
    isForce() - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    Should the task force signing of a jar even it is already + signed? +
    isForceIntegrate() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    gets the forceintegrate flag +
    isForcetextmode() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    If set to true, attempts a textual merge, even for binary files +
    isForkedJavac() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Is this a forked invocation of JDK's javac? +
    isGij() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Checks whether the current Java VM is the GNU interpreter gij + or we are running in a gcj precompiled binary. +
    isGNULongNameEntry() - +Method in class org.apache.tools.tar.TarEntry +
    Indicate if this entry is a GNU long name block +
    isGnuMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    isGreaterThan(DeweyDecimal) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return true if this DeweyDecimal is + greater than the other DeweyDecimal. +
    isGreaterThanOrEqual(DeweyDecimal) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return true if this DeweyDecimal is + greater than or equal to the other DeweyDecimal. +
    isHidden() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
    FTP files cannot be hidden +
    isHidden() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
    FTP files cannot be hidden +
    isIgnoreErrors() - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Find out whether this ConcatResourceInputStream ignores errors. +
    isIgnoreNoncriticalErrors() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isIgnoringProjectTag() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    tells whether the project tag is being ignored +
    isImplicit() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Gets whether this element is implicit. +
    isIncluded(String) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a name matches against at least one include + pattern. +
    isIncludeDestClasses() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Get the value of the includeDestClasses property. +
    isInIncludeMode() - +Static method in class org.apache.tools.ant.ProjectHelper +
    Whether the current file should be read in include as opposed + to import mode. +
    isInIncludeMode() - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    Whether the task is in include (as opposed to import) mode. +
    isInPath(File) - +Method in class org.apache.tools.ant.AntClassLoader +
    Indicate if the given file is in this loader's path +
    isInputValid() - +Method in class org.apache.tools.ant.input.InputRequest +
    Is the user input valid? +
    isInputValid() - +Method in class org.apache.tools.ant.input.MultipleChoiceInputRequest +
      +
    isInUpdateMode() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Are we updating an existing archive? +
    isInvalid() - +Method in class org.apache.tools.ant.Task +
    Has this task been marked invalid? +
    isJavaVersion(String) - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class. +
    isJdkCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Is the compiler implementation a jdk compiler +
    isKaffe() - +Static method in class org.apache.tools.ant.util.JavaEnvUtils +
    Checks whether the current Java VM is Kaffe. +
    isKeepGoingMode() - +Method in class org.apache.tools.ant.Project +
    Return the keep-going mode. +
    IsLastModified - Class in org.apache.tools.ant.taskdefs.condition
    Condition that makes assertions about the last modified date of a + resource.
    IsLastModified() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsLastModified +
      +
    IsLastModified.CompareMode - Class in org.apache.tools.ant.taskdefs.condition
     
    IsLastModified.CompareMode() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsLastModified.CompareMode +
      +
    IsLastModified.CompareMode(String) - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsLastModified.CompareMode +
      +
    isLeadingPath(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Learn whether one path "leads" another. +
    isLeaveTargetRevision() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    gets the leavetargetrevision flag +
    isLegalCharacter(char) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Is the given character allowed inside an XML document? +
    isLessThan(DeweyDecimal) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return true if this DeweyDecimal is + less than the other DeweyDecimal. +
    isLessThanOrEqual(DeweyDecimal) - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return true if this DeweyDecimal is + less than or equal to the other DeweyDecimal. +
    isLink() - +Method in class org.apache.tools.zip.AsiExtraField +
    Is this entry a symbolic link? +
    isLinkOffline() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Get the linkOffline attribute. +
    isMapped() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    If true, generate separate write() calls for each HTML line + in the JSP. +
    isMarkersforall() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    If set to true, puts in markers for all changes, conflicting or not +
    isMimeTypeSpecified() - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Returns true if the mimeType has been set. +
    isName(String) - +Static method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the + given OS name. +
    isNativeBuild() - +Method in class org.apache.tools.ant.taskdefs.compilers.Gcj +
    Whether any of the arguments given via <compilerarg> + implies that compilation to native code is requested. +
    isNegated() - +Method in class org.apache.tools.ant.filters.LineContains +
    Find out whether we have been negated. +
    isNegated() - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Find out whether we have been negated. +
    isNewer() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isNmtoken(String) - +Method in class org.apache.tools.ant.taskdefs.AntStructure +
    Does this String match the XML-NMTOKEN production? +
    isNocopynewtargetfiles() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    indicates intention to suppress the copying on the local hard disk of new target files. +
    ISO8601_DATE_PATTERN - +Static variable in class org.apache.tools.ant.util.DateUtils +
    ISO8601-like pattern for date. +
    ISO8601_DATETIME_PATTERN - +Static variable in class org.apache.tools.ant.util.DateUtils +
    ISO8601-like pattern for date-time. +
    ISO8601_TIME_PATTERN - +Static variable in class org.apache.tools.ant.util.DateUtils +
    ISO8601-like pattern for time. +
    ISO_8859_1 - +Static variable in class org.apache.tools.ant.util.ResourceUtils +
    Name of charset "ISO Latin Alphabet No. +
    isOmitMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    isOptional() - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Gets whether this element is optional. +
    isOptionalAvailable() - +Static method in class org.apache.tools.ant.Diagnostics +
    Deprecated. Obsolete since Ant 1.8.2 +
    isOs(String, String, String, String) - +Static method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the + given OS family, name, architecture and version +
    isOutOfDate() - +Method in class org.apache.tools.ant.taskdefs.Zip.ArchiveState +
    Return the outofdate status. +
    isOutOfDate(File, File, int) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Returns dependency information on these two files. +
    isOutOfDate(Resource, Resource, int) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Returns dependency information on these two resources. +
    isOutOfDate(Resource, Resource, long) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Returns dependency information on these two resources. +
    isPassive() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isPortExplicitlySpecified() - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Whether the port has been explicitly specified by the user. +
    isPreserveDuplicates() - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Get the preserveDuplicates. +
    isPreserveLastModified() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isPropagatesourcefiletype() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    returns flag indicating if propagation of source file type is sought +
    IsReachable - Class in org.apache.tools.ant.taskdefs.condition
    Test for a host being reachable using ICMP "ping" packets & echo operations.
    IsReachable() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsReachable +
      +
    isRebuildRequired(File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Helper method to check to see if a weblogic EBJ1.1 jar needs to be + rebuilt using ejbc. +
    isRebuildRequired(File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Helper method to check to see if a websphere EBJ1.1 jar needs to be + rebuilt using ejbdeploy. +
    isRecurse() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Get the value of recurse. +
    isRecurse() - +Method in class org.apache.tools.ant.types.FilterSet +
    Get whether recursive token expansion is enabled. +
    isRedoall() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    allows previously resolved files to be resolved again +
    IsReference - Class in org.apache.tools.ant.taskdefs.condition
    Condition that tests whether a given reference has been defined.
    IsReference() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsReference +
      +
    isReference() - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Learn whether the refid attribute of this element been set. +
    isReference() - +Method in class org.apache.tools.ant.types.DataType +
    Has the refid attribute of this element been set? +
    isReference(String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Is the given argument a character or entity reference? +
    isReferenceOrProxy() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Learn whether this PropertyResource either refers to another Resource + or proxies another Resource due to its object property value being said Resource. +
    isRemoveComments() - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
    Returns true if comments are removed along with + properties, or false otherwise. +
    isResolved() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Indicates whether this entry has been resolved. +
    isRestoreDeletedRevisions() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    gets the restoredeletedrevisions flag +
    isRestrict() - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Get the restrict attribute. +
    isReverse() - +Method in class org.apache.tools.ant.filters.SortFilter +
    Returns true if the sorting process will be in reverse + order, otherwise the sorting process will be in ascendant order. +
    isReversebranchmappings() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    returns the flag indicating if reverse branch mappings are sought +
    isReverseLoader() - +Method in class org.apache.tools.ant.taskdefs.DefBase +
      +
    isReverseLoader() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Get the reverseLoader setting. +
    isRoot() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Directory +
    Is this a root Directory? +
    isSax1Parser() - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    test that returns true if we are using a SAX1 parser. +
    isSeekable() - +Method in class org.apache.tools.zip.ZipOutputStream +
    This method indicates whether this archive is writing to a + seekable stream (i.e., to a random access file). +
    isSelected(String, File) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Test whether a file should be selected. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Method that each selector will implement to create their selection + behaviour. +
    isSelected() - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    get state of selected flag +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.And +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Exists +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Majority +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.None +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Not +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Or +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in interface org.apache.tools.ant.types.resources.selectors.ResourceSelector +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Size +
    Return true if this Resource is selected. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.resources.selectors.Type +
    Return true if this Resource is selected. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.AndSelector +
    Returns true (the file is selected) only if all other selectors + agree that the file should be selected. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.BaseExtendSelector +
    Method that each selector will implement to create their + selection behaviour. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.BaseSelector +
    Method that each selector will implement to create their + selection behaviour. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Method that each selector will implement to create their selection + behaviour. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Tests a regular expression against each line of text in the file. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Tests a regular expression against each line of text in a Resource. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    The heart of the matter. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Allows the custom selector to choose whether to select a file. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in interface org.apache.tools.ant.types.selectors.FileSelector +
    Method that each selector will implement to create their + selection behaviour. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.MajoritySelector +
    Returns true (the file is selected) if most of the other selectors + agree. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    The heart of the matter. +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Implementation of ResourceSelector.isSelected(). +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Implementation of BaseExtendSelector.isSelected(). +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.NoneSelector +
    Returns true (the file is selected) only if all other selectors + agree that the file should not be selected. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.OrSelector +
    Returns true (the file is selected) if any of the other selectors + agree that the file should be selected. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.ReadableSelector +
      +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.selectors.ReadableSelector +
      +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Returns true (the file is selected) only if the if property (if any) + exists, the unless property (if any) doesn't exist, and the + contained selector (if any) selects the file. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.SignedSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.TypeSelector +
    The heart of the matter. +
    isSelected(File, String, File) - +Method in class org.apache.tools.ant.types.selectors.WritableSelector +
      +
    isSelected(Resource) - +Method in class org.apache.tools.ant.types.selectors.WritableSelector +
      +
    IsSet - Class in org.apache.tools.ant.taskdefs.condition
    Condition that tests whether a given property has been set.
    IsSet() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsSet +
      +
    IsSigned - Class in org.apache.tools.ant.taskdefs.condition
    Checks whether a jarfile is signed: if the name of the + signature is passed, the file is checked for presence of that + particular signature; otherwise the file is checked for the + existence of any signature.
    IsSigned() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsSigned +
      +
    isSigned(File, String) - +Static method in class org.apache.tools.ant.taskdefs.condition.IsSigned +
    Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature. +
    isSigned(File) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    test for a file being signed, by looking for a signature in the META-INF + directory with our alias/sigfile. +
    isSimulationMode() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    gets the simulationmode flag +
    isSimulationmode() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -n flag of p4 labelsync - display changes without actually doing them +
    isSimulationmode() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    read the simulation mode flag +
    isSkipFailedTransfers() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isStartTLSEnabled() - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    isSymbolicLink() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    tell if a file is a symbolic link +
    isSymbolicLink() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    tell if a file is a symbolic link +
    isSymbolicLink(File, String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Deprecated. use SymbolicLinkUtils instead +
    isSymbolicLink(File) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a symbolic link. +
    isSymbolicLink(String) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a symbolic link. +
    isSymbolicLink(File, String) - +Method in class org.apache.tools.ant.util.SymbolicLinkUtils +
    Checks whether a given file is a symbolic link. +
    isSymlink(File) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
    Do we have to traverse a symlink when trying to reach path from + basedir? +
    isTimeDiffAuto() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isTraverseSymlinks() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    find out if a symbolic link is encountered in the relative path of this file + from rootPath. +
    isTraverseSymlinks() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    find out if a symbolic link is encountered in the relative path of this file + from rootPath. +
    IsTrue - Class in org.apache.tools.ant.taskdefs.condition
    Condition that tests whether a given string evals to true
    IsTrue() - +Constructor for class org.apache.tools.ant.taskdefs.condition.IsTrue +
      +
    isTruncateMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    isUpToDate(Vector) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Check to see if the target is up to date with respect to input files. +
    isUpToDate(FTPClient, File, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Checks to see if the remote file is current as compared with the local + file. +
    isUpToDate(FTPClient, File, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Checks to see if the remote file is current as compared with the local + file. +
    isUpToDate(File, File) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    Compare a jar file with its corresponding signed jar. +
    isUpToDate(File, File, long) - +Method in class org.apache.tools.ant.util.FileUtils +
    Returns true if the source is older than the dest. +
    isUpToDate(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Returns true if the source is older than the dest. +
    isUpToDate(long, long, long) - +Method in class org.apache.tools.ant.util.FileUtils +
    Compare two timestamps for being up to date using + the specified granularity. +
    isUpToDate(long, long) - +Method in class org.apache.tools.ant.util.FileUtils +
    Compare two timestamps for being up to date using the + current granularity. +
    isValid() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Algorithm +
    Checks its prerequisites. +
    isValid() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Checks its prerequisites. +
    isValid() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
    This algorithm supports only CRC and Adler. +
    isValid() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    This algorithm supports only MD5 and SHA. +
    isValid() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.HashvalueAlgorithm +
    This algorithm doesn't need any configuration. +
    isValid() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    This cache is valid if the cachefile is set. +
    isValidNameCharacter(char) - +Static method in class org.apache.tools.ant.taskdefs.MacroDef +
    Check if a character is a valid character for an element or + attribute name. +
    isValidOs() - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Check if the os is valid. +
    isValidOs() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Is this the OS the user wanted? +
    isValidOs() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Automatically approve Unix OS's. +
    isValidOs() - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Check if the os is valid. +
    isValidRdbms(Connection) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Verify we are connected to the correct RDBMS +
    isValidRmiRemote(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Load named class and test whether it can be rmic'ed +
    isVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Get the value of verbose. +
    isVerbose() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    isVersion(String) - +Static method in class org.apache.tools.ant.taskdefs.condition.Os +
    Determines if the OS on which Ant is executing matches the + given OS version. +
    isWarnMode() - +Method in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
      +
    isWatching() - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Indicates whether or not the watchdog is still monitoring the process. +
    isWithoutAnyResources() - +Method in class org.apache.tools.ant.taskdefs.Zip.ArchiveState +
    find out if there are absolutely no resources to add +
    item(int) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeListImpl +
    Get a particular node. +
    iterator() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Implement ResourceCollection. +
    iterator() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.Commandline +
    Get an iterator to the arguments list. +
    iterator() - +Method in class org.apache.tools.ant.types.DirSet +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.FileList +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.FileSet +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.Path +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Create an iterator. +
    iterator() - +Method in class org.apache.tools.ant.types.PropertySet +
    Fulfill the ResourceCollection interface. +
    iterator() - +Method in class org.apache.tools.ant.types.Resource +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in interface org.apache.tools.ant.types.ResourceCollection +
    Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Merges the nested collections. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.BCFileSet +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.Files +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.Resources +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Fulfill the ResourceCollection contract. +
    iterator() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Returns an iterator over the keys in the cache. +
    iterator() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Returns an iterator over the keys in the cache. +
    +
    +

    +J

    +
    +
    JakartaOroMatcher - Class in org.apache.tools.ant.util.regexp
    Implementation of RegexpMatcher for Jakarta-ORO.
    JakartaOroMatcher() - +Constructor for class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Constructor for JakartaOroMatcher. +
    JakartaOroRegexp - Class in org.apache.tools.ant.util.regexp
    Regular expression implementation using the Jakarta Oro package
    JakartaOroRegexp() - +Constructor for class org.apache.tools.ant.util.regexp.JakartaOroRegexp +
    Constructor for JakartaOroRegexp +
    JakartaRegexpMatcher - Class in org.apache.tools.ant.util.regexp
    Implementation of RegexpMatcher for Jakarta-Regexp.
    JakartaRegexpMatcher() - +Constructor for class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
      +
    JakartaRegexpRegexp - Class in org.apache.tools.ant.util.regexp
    Regular expression implementation using the Jakarta Regexp package
    JakartaRegexpRegexp() - +Constructor for class org.apache.tools.ant.util.regexp.JakartaRegexpRegexp +
    Constructor for JakartaRegexpRegexp +
    jar - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    The name of the jar file. +
    Jar - Class in org.apache.tools.ant.taskdefs
    Creates a JAR archive.
    Jar() - +Constructor for class org.apache.tools.ant.taskdefs.Jar +
    constructor +
    Jar.FilesetManifestConfig - Class in org.apache.tools.ant.taskdefs
    The manifest config enumerated type.
    Jar.FilesetManifestConfig() - +Constructor for class org.apache.tools.ant.taskdefs.Jar.FilesetManifestConfig +
      +
    Jar.StrictMode - Class in org.apache.tools.ant.taskdefs
    The strict enumerated type.
    Jar.StrictMode() - +Constructor for class org.apache.tools.ant.taskdefs.Jar.StrictMode +
    Public no arg constructor. +
    Jar.StrictMode(String) - +Constructor for class org.apache.tools.ant.taskdefs.Jar.StrictMode +
    Constructor with an arg. +
    JAR_COMPRESS_LEVEL - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The level to use for compression +
    JAR_ENCODING - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    Encoding to be used for JAR files. +
    JarFileIterator - Class in org.apache.tools.ant.taskdefs.optional.depend
    A class file iterator which iterates through the contents of a Java jar + file.
    JarFileIterator(InputStream) - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.JarFileIterator +
    Construct an iterator over a jar stream +
    JarLibAvailableTask - Class in org.apache.tools.ant.taskdefs.optional.extension
    Checks whether an extension is present in a fileset or an extensionSet.
    JarLibAvailableTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
      +
    JarLibDisplayTask - Class in org.apache.tools.ant.taskdefs.optional.extension
    Displays the "Optional Package" and "Package Specification" information + contained within the specified JARs.
    JarLibDisplayTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask +
      +
    JarLibManifestTask - Class in org.apache.tools.ant.taskdefs.optional.extension
    Generates a manifest that declares all the dependencies.
    JarLibManifestTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
      +
    JarLibResolveTask - Class in org.apache.tools.ant.taskdefs.optional.extension
    Tries to locate a JAR to satisfy an extension and place + location of JAR into property.
    JarLibResolveTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
      +
    JarMarker - Class in org.apache.tools.zip
    If this extra field is added as the very first extra field of the + archive, Solaris will consider it an executable jar file.
    JarMarker() - +Constructor for class org.apache.tools.zip.JarMarker +
    No-arg constructor +
    JARSIGNER_COMMAND - +Static variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    name of JDK program we are looking for +
    Jasper41Mangler - Class in org.apache.tools.ant.taskdefs.optional.jsp
    this class implements the name mangling rules of the jasper in tomcat4.1.x + which is likely to remain for some time
    Jasper41Mangler() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.Jasper41Mangler +
      +
    JasperC - Class in org.apache.tools.ant.taskdefs.optional.jsp.compilers
    The implementation of the jasper compiler.
    JasperC(JspMangler) - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.compilers.JasperC +
    Constructor for JasperC. +
    Java - Class in org.apache.tools.ant.taskdefs
    Launcher for Java applications.
    Java() - +Constructor for class org.apache.tools.ant.taskdefs.Java +
    Normal constructor +
    Java(Task) - +Constructor for class org.apache.tools.ant.taskdefs.Java +
    create a bound task +
    JAVA2IIOP - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Java2iiop executable +
    JAVA_1_0 - +Static variable in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_0 instead. +
    JAVA_1_0 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.0 +
    JAVA_1_1 - +Static variable in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_1 instead. +
    JAVA_1_1 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.1 +
    JAVA_1_2 - +Static variable in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_2 instead. +
    JAVA_1_2 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.2 +
    JAVA_1_3 - +Static variable in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_3 instead. +
    JAVA_1_3 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.3 +
    JAVA_1_4 - +Static variable in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_4 instead. +
    JAVA_1_4 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.4 +
    JAVA_1_5 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.5 +
    JAVA_1_6 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.6 +
    JAVA_1_7 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Version constant for Java 1.7 +
    Javac - Class in org.apache.tools.ant.taskdefs
    Compiles Java source files.
    Javac() - +Constructor for class org.apache.tools.ant.taskdefs.Javac +
    Javac task for compilation of Java files. +
    Javac.ImplementationSpecificArgument - Class in org.apache.tools.ant.taskdefs
    Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation.
    Javac.ImplementationSpecificArgument() - +Constructor for class org.apache.tools.ant.taskdefs.Javac.ImplementationSpecificArgument +
      +
    Javac12 - Class in org.apache.tools.ant.taskdefs.compilers
    Deprecated. Use Javac13 instead.
    Javac12() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Javac12 +
    Deprecated.   +
    Javac13 - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the javac compiler for JDK 1.3 + This is primarily a cut-and-paste from the original javac task before it + was refactored.
    Javac13() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Javac13 +
      +
    JavaCC - Class in org.apache.tools.ant.taskdefs.optional.javacc
    JavaCC compiler compiler task.
    JavaCC() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Constructor +
    JavacExternal - Class in org.apache.tools.ant.taskdefs.compilers
    Performs a compile using javac externally.
    JavacExternal() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.JavacExternal +
      +
    JavaClassHelper - Class in org.apache.tools.ant.filters.util
    Helper class that filters constants from a Java Class
    JavaClassHelper() - +Constructor for class org.apache.tools.ant.filters.util.JavaClassHelper +
      +
    JavaConstantResource - Class in org.apache.tools.ant.types.resources
    A resource that is a java constant.
    JavaConstantResource() - +Constructor for class org.apache.tools.ant.types.resources.JavaConstantResource +
      +
    Javadoc - Class in org.apache.tools.ant.taskdefs
    Generates Javadoc documentation for a collection + of source code.
    Javadoc() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc +
      +
    Javadoc.AccessType - Class in org.apache.tools.ant.taskdefs
    EnumeratedAttribute implementation supporting the Javadoc scoping + values.
    Javadoc.AccessType() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.AccessType +
      +
    Javadoc.DocletInfo - Class in org.apache.tools.ant.taskdefs
    This class stores info about doclets.
    Javadoc.DocletInfo() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.DocletInfo +
      +
    Javadoc.DocletParam - Class in org.apache.tools.ant.taskdefs
    Inner class used to manage doclet parameters.
    Javadoc.DocletParam() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.DocletParam +
      +
    Javadoc.ExtensionInfo - Class in org.apache.tools.ant.taskdefs
    A project aware class used for Javadoc extensions which take a name + and a path such as doclet and taglet arguments.
    Javadoc.ExtensionInfo() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
      +
    Javadoc.GroupArgument - Class in org.apache.tools.ant.taskdefs
    A class corresponding to the group nested element.
    Javadoc.GroupArgument() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Constructor for GroupArgument +
    Javadoc.Html - Class in org.apache.tools.ant.taskdefs
    An HTML element in the Javadoc.
    Javadoc.Html() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.Html +
      +
    Javadoc.LinkArgument - Class in org.apache.tools.ant.taskdefs
    Represents a link triplet (href, whether link is offline, + location of the package list if off line)
    Javadoc.LinkArgument() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Constructor for LinkArguement +
    Javadoc.PackageName - Class in org.apache.tools.ant.taskdefs
    Used to track info about the packages to be javadoc'd
    Javadoc.PackageName() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.PackageName +
      +
    Javadoc.ResourceCollectionContainer - Class in org.apache.tools.ant.taskdefs
    Holds a collection of ResourceCollections.
    Javadoc.ResourceCollectionContainer() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.ResourceCollectionContainer +
      +
    Javadoc.SourceFile - Class in org.apache.tools.ant.taskdefs
    This class is used to manage the source files to be processed.
    Javadoc.SourceFile() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.SourceFile +
    Default constructor +
    Javadoc.SourceFile(File) - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.SourceFile +
    Constructor specifying the source file directly +
    Javadoc.TagArgument - Class in org.apache.tools.ant.taskdefs
    Class representing a -tag argument.
    Javadoc.TagArgument() - +Constructor for class org.apache.tools.ant.taskdefs.Javadoc.TagArgument +
    Sole constructor. +
    JavaEnvUtils - Class in org.apache.tools.ant.util
    A set of helper methods related to locating executables or checking + conditons of a given Java installation.
    Javah - Class in org.apache.tools.ant.taskdefs.optional
    Generates JNI header files using javah.
    Javah() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Javah +
    No arg constructor. +
    Javah.ClassArgument - Class in org.apache.tools.ant.taskdefs.optional
    A class corresponding the the nested "class" element.
    Javah.ClassArgument() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Javah.ClassArgument +
    Constructor for ClassArgument. +
    JavahAdapter - Interface in org.apache.tools.ant.taskdefs.optional.javah
    Interface for different backend implementations of the Javah task.
    JavahAdapterFactory - Class in org.apache.tools.ant.taskdefs.optional.javah
    Creates the JavahAdapter based on the user choice and + potentially the VM vendor.
    JavahAdapterFactory() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory +
      +
    JavaResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of something loadable via a Java classloader.
    JavaResource() - +Constructor for class org.apache.tools.ant.types.resources.JavaResource +
    Default constructor. +
    JavaResource(String, Path) - +Constructor for class org.apache.tools.ant.types.resources.JavaResource +
    Construct a new JavaResource using the specified name and + classpath. +
    javaToClass(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.BatchTest +
    Convenient method to convert a pathname without extension to a + fully qualified classname. +
    JavaxScriptRunner - Class in org.apache.tools.ant.util.optional
    This class is used to run scripts using JSR 223.
    JavaxScriptRunner() - +Constructor for class org.apache.tools.ant.util.optional.JavaxScriptRunner +
      +
    JAXPUtils - Class in org.apache.tools.ant.util
    Collection of helper methods that retrieve a ParserFactory or + Parsers and Readers.
    JAXPUtils() - +Constructor for class org.apache.tools.ant.util.JAXPUtils +
      +
    JBOSS_CMP10D - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
      +
    JBOSS_CMP20D - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
      +
    JBOSS_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
      +
    JbossDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    The deployment tool to add the jboss specific deployment descriptor to the ejb jar file.
    JbossDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
      +
    JDBCTask - Class in org.apache.tools.ant.taskdefs
    Handles JDBC configuration needed by SQL type tasks.
    JDBCTask() - +Constructor for class org.apache.tools.ant.taskdefs.JDBCTask +
      +
    JDependTask - Class in org.apache.tools.ant.taskdefs.optional.jdepend
    Runs JDepend tests.
    JDependTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
      +
    JDependTask.FormatAttribute - Class in org.apache.tools.ant.taskdefs.optional.jdepend
    A class for the enumerated attribute format, + values are xml and text.
    JDependTask.FormatAttribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask.FormatAttribute +
      +
    Jdk14RegexpMatcher - Class in org.apache.tools.ant.util.regexp
    Implementation of RegexpMatcher for the built-in regexp matcher of + JDK 1.4.
    Jdk14RegexpMatcher() - +Constructor for class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Constructor for JakartaOroRegexp +
    Jdk14RegexpRegexp - Class in org.apache.tools.ant.util.regexp
    Regular expression implementation using the JDK 1.4 regular expression package
    Jdk14RegexpRegexp() - +Constructor for class org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp +
    Constructor for Jdk14RegexpRegexp +
    jdkSaveProperties(Properties, OutputStream, String) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    JDK 1.2 allows for the safer method + Properties.store(OutputStream, String), which throws an + IOException on an output error. +
    JEREMIE_ORB - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    JEREMIE ORB. +
    Jikes - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the jikes compiler.
    Jikes() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Jikes +
      +
    Jikes - Class in org.apache.tools.ant.taskdefs
    Deprecated. since 1.2. + Merged into the class Javac.
    Jikes(JikesOutputParser, String, Project) - +Constructor for class org.apache.tools.ant.taskdefs.Jikes +
    Deprecated. Constructs a new Jikes object. +
    JikesOutputParser - Class in org.apache.tools.ant.taskdefs
    Deprecated. since 1.2. + Use Jikes' exit value to detect compilation failure.
    JikesOutputParser(Task, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Construct a new Parser object +
    JJDoc - Class in org.apache.tools.ant.taskdefs.optional.javacc
    Runs the JJDoc compiler compiler.
    JJDoc() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    Constructor +
    JJTree - Class in org.apache.tools.ant.taskdefs.optional.javacc
    Runs the JJTree compiler compiler.
    JJTree() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Constructor +
    jlink - Class in org.apache.tools.ant.taskdefs.optional.jlink
    jlink links together multiple .jar files.
    jlink() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
      +
    JlinkTask - Class in org.apache.tools.ant.taskdefs.optional.jlink
    This class defines objects that can link together various jar and + zip files.
    JlinkTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
      +
    JONAS_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Default JOnAS deployment descriptor name. +
    JONAS_EJB_JAR_2_4_DTD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Name of the JOnAS-specific deployment descriptor DTD (these files are + stored in the ${JONAS_ROOT}/xml directory). +
    JONAS_EJB_JAR_2_4_PUBLIC_ID - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Public Id of the JOnAS-specific deployment descriptor DTD. +
    JONAS_EJB_JAR_2_5_DTD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
      +
    JONAS_EJB_JAR_2_5_PUBLIC_ID - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
      +
    JonasDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    The deployment tool to add the jonas specific deployment descriptors to the + ejb JAR file.
    JonasDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
      +
    JonasHotDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.j2ee
    An Ant wrapper task for the weblogic.deploy tool.
    JonasHotDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
      +
    jop - +Variable in class org.apache.tools.ant.taskdefs.Jikes +
    Deprecated.   +
    JspC - Class in org.apache.tools.ant.taskdefs.optional.jsp
    Runs a JSP compiler.
    JspC() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
      +
    JspC.WebAppParameter - Class in org.apache.tools.ant.taskdefs.optional.jsp
    static inner class used as a parameter element
    JspC.WebAppParameter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.JspC.WebAppParameter +
      +
    JspCompilerAdapter - Interface in org.apache.tools.ant.taskdefs.optional.jsp.compilers
    The interface that all jsp compiler adapters must adher to.
    JspCompilerAdapterFactory - Class in org.apache.tools.ant.taskdefs.optional.jsp.compilers
    Creates the necessary compiler adapter, given basic criteria.
    JspMangler - Interface in org.apache.tools.ant.taskdefs.optional.jsp
    This is an interface to the Mangler service that jspc needs to map + JSP file names to java files.
    JspNameMangler - Class in org.apache.tools.ant.taskdefs.optional.jsp
    This is a class derived from the Jasper code + (org.apache.jasper.compiler.CommandLineCompiler) to map from a JSP filename + to a valid Java classname.
    JspNameMangler() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.JspNameMangler +
      +
    JUnit4TestMethodAdapter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Adapter between JUnit 3.8.x API and JUnit 4.x API for execution of tests + and listening of events (test start, test finish, test failure).
    JUnit4TestMethodAdapter(Class, String[]) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
    Creates a new adapter for the given class and a method within the class. +
    JUNIT_FRAMEWORK_JUNIT4_TEST_CASE_FACADE - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper +
    Name of the JUnit4 class we look for. +
    JUnitResultFormatter - Interface in org.apache.tools.ant.taskdefs.optional.junit
    This Interface describes classes that format the results of a JUnit + testrun.
    JUnitTask - Class in org.apache.tools.ant.taskdefs.optional.junit
    Runs JUnit tests.
    JUnitTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Creates a new JUnitRunner and enables fork of a new Java VM. +
    JUnitTask.ForkMode - Class in org.apache.tools.ant.taskdefs.optional.junit
    These are the different forking options
    JUnitTask.ForkMode() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    No arg constructor. +
    JUnitTask.ForkMode(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    Constructor using a value. +
    JUnitTask.JUnitLogOutputStream - Class in org.apache.tools.ant.taskdefs.optional.junit
    A stream handler for handling the junit task.
    JUnitTask.JUnitLogOutputStream(Task, int) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.JUnitLogOutputStream +
    Constructor. +
    JUnitTask.JUnitLogStreamHandler - Class in org.apache.tools.ant.taskdefs.optional.junit
    A log stream handler for junit.
    JUnitTask.JUnitLogStreamHandler(Task, int, int) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.JUnitLogStreamHandler +
    Constructor. +
    JUnitTask.SummaryAttribute - Class in org.apache.tools.ant.taskdefs.optional.junit
    Print summary enumeration values.
    JUnitTask.SummaryAttribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.SummaryAttribute +
      +
    JUnitTask.TestResultHolder - Class in org.apache.tools.ant.taskdefs.optional.junit
    A value class that contains the result of a test.
    JUnitTask.TestResultHolder() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.TestResultHolder +
      +
    JUnitTaskMirror - Interface in org.apache.tools.ant.taskdefs.optional.junit
    Handles the portions of JUnitTask which need to directly access + actual JUnit classes, so that junit.jar need not be on Ant's startup classpath.
    JUnitTaskMirror.JUnitResultFormatterMirror - Interface in org.apache.tools.ant.taskdefs.optional.junit
    The interface that JUnitResultFormatter extends.
    JUnitTaskMirror.JUnitTestRunnerMirror - Interface in org.apache.tools.ant.taskdefs.optional.junit
    Interface that test runners implement.
    JUnitTaskMirror.SummaryJUnitResultFormatterMirror - Interface in org.apache.tools.ant.taskdefs.optional.junit
    The interface that SummaryJUnitResultFormatter extends.
    JUnitTaskMirrorImpl - Class in org.apache.tools.ant.taskdefs.optional.junit
    Implementation of the part of the junit task which can directly refer to junit.* classes.
    JUnitTaskMirrorImpl(JUnitTask) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirrorImpl +
    Constructor. +
    JUnitTest - Class in org.apache.tools.ant.taskdefs.optional.junit
    Run a single JUnit test.
    JUnitTest() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    No arg constructor. +
    JUnitTest(String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Constructor with name. +
    JUnitTest(String, boolean, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Constructor with options. +
    JUnitTest(String, boolean, boolean, boolean, String[]) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Constructor with options. +
    JUnitTestRunner - Class in org.apache.tools.ant.taskdefs.optional.junit
    Simple Testrunner for JUnit that runs all tests of a testsuite.
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor for fork=true or when the user hasn't specified a + classpath. +
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor for fork=true or when the user hasn't specified a + classpath. +
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor for fork=true or when the user hasn't specified a + classpath. +
    JUnitTestRunner(JUnitTest, String[], boolean, boolean, boolean, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor for fork=true or when the user hasn't specified a + classpath. +
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean, ClassLoader) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor to use when the user has specified a classpath. +
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean, boolean, ClassLoader) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor to use when the user has specified a classpath. +
    JUnitTestRunner(JUnitTest, boolean, boolean, boolean, boolean, boolean, ClassLoader) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor to use when the user has specified a classpath. +
    JUnitTestRunner(JUnitTest, String[], boolean, boolean, boolean, boolean, boolean, ClassLoader) - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Constructor to use when the user has specified a classpath. +
    JUnitVersionHelper - Class in org.apache.tools.ant.taskdefs.optional.junit
    Work around for some changes to the public JUnit API between + different JUnit releases.
    JUnitVersionHelper() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper +
      +
    Jvc - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the jvc compiler from microsoft.
    Jvc() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Jvc +
      +
    +
    +

    +K

    +
    +
    Kaffeh - Class in org.apache.tools.ant.taskdefs.optional.javah
    Adapter to the native kaffeh compiler.
    Kaffeh() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javah.Kaffeh +
      +
    KaffeNative2Ascii - Class in org.apache.tools.ant.taskdefs.optional.native2ascii
    Adapter to kaffe.tools.native2ascii.Native2Ascii.
    KaffeNative2Ascii() - +Constructor for class org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii +
      +
    KaffeRmic - Class in org.apache.tools.ant.taskdefs.rmic
    The implementation of the rmic for Kaffe
    KaffeRmic() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.KaffeRmic +
      +
    KeepAliveInputStream - Class in org.apache.tools.ant.util
    Class that can be used to wrap System.in + without getting anxious about any client closing the stream.
    KeepAliveInputStream(InputStream) - +Constructor for class org.apache.tools.ant.util.KeepAliveInputStream +
    Constructor of KeepAliveInputStream. +
    KeepAliveOutputStream - Class in org.apache.tools.ant.util
    Class that can be used to wrap System.out and System.err + without getting anxious about any client closing the stream.
    KeepAliveOutputStream(OutputStream) - +Constructor for class org.apache.tools.ant.util.KeepAliveOutputStream +
    Constructor of KeepAliveOutputStream. +
    keyalg - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    keypass - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    password for the key in the store +
    keypass - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    keys() - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Get an enumeration over the keys. +
    keys() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    keySet() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    keysize - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    keystore - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    The url or path of keystore file. +
    keystore - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
    The name of keystore file. +
    KeySubst - Class in org.apache.tools.ant.taskdefs
    Deprecated. KeySubst is deprecated since Ant 1.1. Use Filter + Copy + instead.
    KeySubst() - +Constructor for class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated.   +
    keywords - +Static variable in class org.apache.tools.ant.taskdefs.optional.jsp.JspNameMangler +
    this is the list of keywords which can not be used as classnames +
    killedProcess() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Test for an untimely death of the process. +
    killedProcess() - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Get whether the process was killed. +
    killedProcess() - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Indicates whether the last process run was killed on timeout or not. +
    Kjc - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the Java compiler for KJC.
    Kjc() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Kjc +
      +
    knownEntities - +Variable in class org.apache.tools.ant.util.DOMElementWriter +
    Don't try to be too smart but at least recognize the predefined + entities. +
    +
    +

    +L

    +
    +
    Last - Class in org.apache.tools.ant.types.resources
    ResourceCollection that contains the last count elements of + another ResourceCollection, a la the UNIX tail command.
    Last() - +Constructor for class org.apache.tools.ant.types.resources.Last +
      +
    lastDelimiterPosition(StringBuffer, String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
      +
    lastErrorMessage - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
      +
    lastIndexOf(Object, int) - +Method in class org.apache.tools.ant.util.IdentityStack +
    Override methods that use .equals() comparisons on elements. +
    lastModified() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    lastModified() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    launch(Project, String[], String[], File, boolean) - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    Creates a process that runs a command. +
    launchDiag - +Static variable in class org.apache.tools.ant.launch.Launcher +
    launch diagnostics flag; for debugging trouble at launch time. +
    Launcher - Class in org.apache.tools.ant.launch
    This is a launcher for Ant.
    Launcher() - +Constructor for class org.apache.tools.ant.launch.Launcher +
      +
    LaunchException - Exception in org.apache.tools.ant.launch
    Signals an error condition during launching
    LaunchException(String) - +Constructor for exception org.apache.tools.ant.launch.LaunchException +
    Constructs an exception with the given descriptive message. +
    LayoutPreservingProperties - Class in org.apache.tools.ant.util
    A Properties collection which preserves comments and whitespace + present in the input stream from which it was loaded.
    LayoutPreservingProperties() - +Constructor for class org.apache.tools.ant.util.LayoutPreservingProperties +
    Create a new, empty, Properties collection, with no defaults. +
    LayoutPreservingProperties(Properties) - +Constructor for class org.apache.tools.ant.util.LayoutPreservingProperties +
    Create a new, empty, Properties collection, with the specified defaults. +
    lazy - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    Whether to assume a jar which has an appropriate .SF file in is already + signed. +
    LazyFileOutputStream - Class in org.apache.tools.ant.util
    Class that delays opening the output file until the first bytes + shall be written or the method open has been invoked + explicitly.
    LazyFileOutputStream(String) - +Constructor for class org.apache.tools.ant.util.LazyFileOutputStream +
    Creates a stream that will eventually write to the file with + the given name and replace it. +
    LazyFileOutputStream(String, boolean) - +Constructor for class org.apache.tools.ant.util.LazyFileOutputStream +
    Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it. +
    LazyFileOutputStream(File) - +Constructor for class org.apache.tools.ant.util.LazyFileOutputStream +
    Creates a stream that will eventually write to the file with + the given name and replace it. +
    LazyFileOutputStream(File, boolean) - +Constructor for class org.apache.tools.ant.util.LazyFileOutputStream +
    Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it. +
    LazyFileOutputStream(File, boolean, boolean) - +Constructor for class org.apache.tools.ant.util.LazyFileOutputStream +
    Creates a stream that will eventually write to the file with + the given name, optionally append to instead of replacing + it, and optionally always create a file (even if zero length). +
    LazyHashtable - Class in org.apache.tools.ant.util
    Hashtable implementation that allows delayed construction + of expensive objects + + All operations that need access to the full list of objects + will call initAll() first.
    LazyHashtable() - +Constructor for class org.apache.tools.ant.util.LazyHashtable +
    No arg constructor. +
    LazyResourceCollectionWrapper - Class in org.apache.tools.ant.types.resources
    Resource collection which load underlying resource collection only on demand + with support for caching
    LazyResourceCollectionWrapper() - +Constructor for class org.apache.tools.ant.types.resources.LazyResourceCollectionWrapper +
      +
    LeadPipeInputStream - Class in org.apache.tools.ant.util
    Special PipedInputStream that will not die + when the writing Thread is no longer alive.
    LeadPipeInputStream() - +Constructor for class org.apache.tools.ant.util.LeadPipeInputStream +
    Construct a new LeadPipeInputStream. +
    LeadPipeInputStream(int) - +Constructor for class org.apache.tools.ant.util.LeadPipeInputStream +
    Construct a new LeadPipeInputStream + with the specified buffer size. +
    LeadPipeInputStream(PipedOutputStream) - +Constructor for class org.apache.tools.ant.util.LeadPipeInputStream +
    Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream. +
    LeadPipeInputStream(PipedOutputStream, int) - +Constructor for class org.apache.tools.ant.util.LeadPipeInputStream +
    Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream, using a + circular buffer of the specified size. +
    LEFT_COLUMN_SIZE - +Static variable in class org.apache.tools.ant.DefaultLogger +
    Size of left-hand column for right-justified task name. +
    Length - Class in org.apache.tools.ant.taskdefs
    Gets lengths: of files/resources, byte size; of strings, length (optionally trimmed).
    Length() - +Constructor for class org.apache.tools.ant.taskdefs.Length +
      +
    length() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy +
      +
    length() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy +
      +
    Length.FileMode - Class in org.apache.tools.ant.taskdefs
    EnumeratedAttribute operation mode
    Length.FileMode() - +Constructor for class org.apache.tools.ant.taskdefs.Length.FileMode +
      +
    Length.When - Class in org.apache.tools.ant.taskdefs
    EnumeratedAttribute for the when attribute.
    Length.When() - +Constructor for class org.apache.tools.ant.taskdefs.Length.When +
      +
    lenient - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    LESS - +Static variable in class org.apache.tools.ant.types.Comparison +
    Less Comparison. +
    LESS_EQUAL - +Static variable in class org.apache.tools.ant.types.Comparison +
    Less-or-Equal Comparison. +
    LESSER_ICOST - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    LF_BLK - +Static variable in interface org.apache.tools.tar.TarConstants +
    Block device file type. +
    LF_CHR - +Static variable in interface org.apache.tools.tar.TarConstants +
    Character device file type. +
    LF_CONTIG - +Static variable in interface org.apache.tools.tar.TarConstants +
    Contiguous file type. +
    LF_DIR - +Static variable in interface org.apache.tools.tar.TarConstants +
    Directory file type. +
    LF_FIFO - +Static variable in interface org.apache.tools.tar.TarConstants +
    FIFO (pipe) file type. +
    LF_GNUTYPE_LONGNAME - +Static variable in interface org.apache.tools.tar.TarConstants +
    Identifies the *next* file on the tape as having a long name. +
    LF_LINK - +Static variable in interface org.apache.tools.tar.TarConstants +
    Link file type. +
    LF_NORMAL - +Static variable in interface org.apache.tools.tar.TarConstants +
    Normal file type. +
    LF_OLDNORM - +Static variable in interface org.apache.tools.tar.TarConstants +
    LF_ constants represent the "link flag" of an entry, or more commonly, + the "entry type". +
    LF_SYMLINK - +Static variable in interface org.apache.tools.tar.TarConstants +
    Symbolic link file type. +
    LFH_SIG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    local file header signature +
    LibFileSet - Class in org.apache.tools.ant.taskdefs.optional.extension
    LibFileSet represents a fileset containing libraries.
    LibFileSet() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.LibFileSet +
      +
    LINE_SEP - +Static variable in class org.apache.tools.ant.util.StringUtils +
    the line separator for this OS +
    LineContains - Class in org.apache.tools.ant.filters
    Filter which includes only those lines that contain all the user-specified + strings.
    LineContains() - +Constructor for class org.apache.tools.ant.filters.LineContains +
    Constructor for "dummy" instances. +
    LineContains(Reader) - +Constructor for class org.apache.tools.ant.filters.LineContains +
    Creates a new filtered reader. +
    LineContains.Contains - Class in org.apache.tools.ant.filters
    Holds a contains element
    LineContains.Contains() - +Constructor for class org.apache.tools.ant.filters.LineContains.Contains +
      +
    LineContainsRegExp - Class in org.apache.tools.ant.filters
    Filter which includes only those lines that contain the user-specified + regular expression matching strings.
    LineContainsRegExp() - +Constructor for class org.apache.tools.ant.filters.LineContainsRegExp +
    Constructor for "dummy" instances. +
    LineContainsRegExp(Reader) - +Constructor for class org.apache.tools.ant.filters.LineContainsRegExp +
    Creates a new filtered reader. +
    LineOrientedOutputStream - Class in org.apache.tools.ant.util
    Invokes processLine whenever a full line has + been written to this stream.
    LineOrientedOutputStream() - +Constructor for class org.apache.tools.ant.util.LineOrientedOutputStream +
      +
    lineSplit(String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Splits up a string into a list of lines. +
    LineTokenizer - Class in org.apache.tools.ant.util
    class to tokenize the input as lines seperated + by \r (mac style), \r\n (dos/windows style) or \n (unix style)
    LineTokenizer() - +Constructor for class org.apache.tools.ant.util.LineTokenizer +
      +
    link() - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Performs the linking of files. +
    LINK_FLAG - +Static variable in interface org.apache.tools.zip.UnixStat +
    Indicates symbolic links. +
    LinkedHashtable - Class in org.apache.tools.ant.util
    Subclass of Hashtable that wraps a LinkedHashMap to provide + predictable iteration order.
    LinkedHashtable() - +Constructor for class org.apache.tools.ant.util.LinkedHashtable +
      +
    LinkedHashtable(int) - +Constructor for class org.apache.tools.ant.util.LinkedHashtable +
      +
    LinkedHashtable(int, float) - +Constructor for class org.apache.tools.ant.util.LinkedHashtable +
      +
    LinkedHashtable(Map) - +Constructor for class org.apache.tools.ant.util.LinkedHashtable +
      +
    list() - +Method in class org.apache.tools.ant.types.Path +
    Returns all path elements defined by this and nested path objects. +
    list() - +Method in class org.apache.tools.ant.types.resources.Union +
    Returns all Resources in String format. +
    LIST_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    LIST_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    listChildNodes(Node, DOMUtil.NodeFilter, boolean) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil +
    list a set of node that match a specific filter. +
    listFile(FTPClient, BufferedWriter, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    List information about a single file from the remote host. +
    listFile(FTPClient, BufferedWriter, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    List information about a single file from the remote host. +
    listFiles - +Variable in class org.apache.tools.ant.taskdefs.Javac +
      +
    listFiles(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
    list the files present in one directory. +
    listFiles(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
    cd into one directory and + list the files present in one directory. +
    listFiles(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
    list the files present in one directory. +
    listFiles(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
    cd into one directory and + list the files present in one directory. +
    listLibraries() - +Static method in class org.apache.tools.ant.Diagnostics +
    return the list of jar files existing in ANT_HOME/lib + and that must have been picked up by Ant script. +
    listLines(PrintStream) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
    Echo the lines of the properties (including blanks and comments) to the + stream. +
    listResources() - +Method in class org.apache.tools.ant.types.resources.Union +
    Convenience method. +
    load() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Loads the cache, must handle not existing cache. +
    load() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Load the cache from underlying properties file. +
    load(InputStream) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    loadClass(String, boolean) - +Method in class org.apache.tools.ant.AntClassLoader +
    Loads a class with this class loader. +
    loadClass(String, String, Class) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Loads the specified class and initializes an object of that class. +
    loadClass(String, boolean) - +Method in class org.apache.tools.ant.util.SplitClassLoader +
      +
    loadEnvironment(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    load the environment values +
    LoaderUtils - Class in org.apache.tools.ant.util
    ClassLoader utility methods
    LoaderUtils() - +Constructor for class org.apache.tools.ant.util.LoaderUtils +
      +
    LoadFile - Class in org.apache.tools.ant.taskdefs
    Load a file into a property
    LoadFile() - +Constructor for class org.apache.tools.ant.taskdefs.LoadFile +
      +
    loadFile(File) - +Method in class org.apache.tools.ant.taskdefs.Property +
    load properties from a file +
    loadProperties(ClassLoader, URL) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Load type definitions as properties from a URL. +
    LoadProperties - Class in org.apache.tools.ant.taskdefs
    Load a file's contents as Ant properties.
    LoadProperties() - +Constructor for class org.apache.tools.ant.taskdefs.LoadProperties +
      +
    LoadResource - Class in org.apache.tools.ant.taskdefs
    Load a resource into a property
    LoadResource() - +Constructor for class org.apache.tools.ant.taskdefs.LoadResource +
      +
    loadResource(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    load properties from a resource in the current classpath +
    loadResource(Resource) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Add a resource to the source list. +
    loadResources(ResourceCollection) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Add all resources in a resource collection to the source list. +
    loadUrl(URL) - +Method in class org.apache.tools.ant.taskdefs.Property +
    load properties from a url +
    Local - Class in org.apache.tools.ant.taskdefs
    Task to create a local property in the current scope.
    Local() - +Constructor for class org.apache.tools.ant.taskdefs.Local +
      +
    LocalProperties - Class in org.apache.tools.ant.property
    Thread local class containing local properties.
    LocalPropertyStack - Class in org.apache.tools.ant.property
    A stack of local property maps.
    LocalPropertyStack() - +Constructor for class org.apache.tools.ant.property.LocalPropertyStack +
      +
    Location - Class in org.apache.tools.ant
    Stores the location of a piece of text within a file (file name, + line number and column number).
    Location(String) - +Constructor for class org.apache.tools.ant.Location +
    Creates a location consisting of a file name but no line number or + column number. +
    Location(Locator) - +Constructor for class org.apache.tools.ant.Location +
    Creates a location from the SAX locator using the system ID as + the filename. +
    Location(String, int, int) - +Constructor for class org.apache.tools.ant.Location +
    Creates a location consisting of a file name, line number and + column number. +
    location - +Variable in class org.apache.tools.ant.ProjectComponent +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the ProjectComponent.getLocation() method. +
    location - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    LocationResolver - Class in org.apache.tools.ant.taskdefs.optional.extension.resolvers
    Resolver that just returns s specified location.
    LocationResolver() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver +
      +
    Locator - Class in org.apache.tools.ant.launch
    The Locator is a utility class which is used to find certain items + in the environment.
    lock - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
      +
    log(String, int) - +Method in class org.apache.tools.ant.AntClassLoader +
    Logs a message through the project object if one has been provided. +
    log(String) - +Method in class org.apache.tools.ant.DefaultLogger +
    Empty implementation which allows subclasses to receive the + same output that is generated here. +
    log(String) - +Method in class org.apache.tools.ant.listener.MailLogger +
    Receives and buffers log messages. +
    log(String) - +Method in class org.apache.tools.ant.Project +
    Write a message to the log with the default log level + of MSG_INFO . +
    log(String, int) - +Method in class org.apache.tools.ant.Project +
    Write a project level message to the log with the given log level. +
    log(String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Write a project level message to the log with the given log level. +
    log(Task, String, int) - +Method in class org.apache.tools.ant.Project +
    Write a task level message to the log with the given log level. +
    log(Task, String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Write a task level message to the log with the given log level. +
    log(Target, String, int) - +Method in class org.apache.tools.ant.Project +
    Write a target level message to the log with the given log level. +
    log(Target, String, Throwable, int) - +Method in class org.apache.tools.ant.Project +
    Write a target level message to the log with the given log level. +
    log(String) - +Method in class org.apache.tools.ant.ProjectComponent +
    Logs a message with the default (INFO) priority. +
    log(String, int) - +Method in class org.apache.tools.ant.ProjectComponent +
    Logs a message with the given priority. +
    log(String) - +Method in class org.apache.tools.ant.Task +
    Logs a message with the default (INFO) priority. +
    log(String, int) - +Method in class org.apache.tools.ant.Task +
    Logs a message with the given priority. +
    log(Throwable, int) - +Method in class org.apache.tools.ant.Task +
    Logs a message with the given priority. +
    log(String, Throwable, int) - +Method in class org.apache.tools.ant.Task +
    Logs a message with the given priority. +
    log(String, int) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Log a message to the Ant output. +
    log(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Logging facade in INFO-mode. +
    log(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Log a message to the log listener. +
    log(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener +
    Method for the loglistener to implement to recieve log messages. +
    log(String) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLogger +
    Log a message. +
    log(String, int) - +Method in class org.apache.tools.ant.util.ConcatFileInputStream +
    Log a message with the specified logging level. +
    log(String, int) - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Log a message with the specified logging level. +
    log(String, int) - +Method in class org.apache.tools.ant.util.LeadPipeInputStream +
    Log a message with the specified logging level. +
    Log4jListener - Class in org.apache.tools.ant.listener
    Listener which sends events to Log4j logging system
    Log4jListener() - +Constructor for class org.apache.tools.ant.listener.Log4jListener +
    Construct the listener and make sure there is a valid appender. +
    LOG_ANT - +Static variable in class org.apache.tools.ant.listener.Log4jListener +
    log category we log into +
    logAndAddFiles(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +
    logAndAddFilesToCompile(Commandline) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +
    logAndAddFilesToCompile(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +
    logAndAddFilesToCompile(JspC, Vector, CommandlineJava) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +
    logAndAddFilesToCompile(Commandline) - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +
    logFlush() - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Close output. +
    logFlush() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Flush the output stream - if there is one. +
    logLevel - +Variable in class org.apache.tools.ant.taskdefs.Echo +
      +
    LogLevel - Class in org.apache.tools.ant.types
    The enumerated values for Ant's log level.
    LogLevel() - +Constructor for class org.apache.tools.ant.types.LogLevel +
    Public constructor. +
    LogListener - Interface in org.apache.tools.ant.taskdefs.optional.ssh
    Interface for ssh log listeners to implement.
    LogOutputResource - Class in org.apache.tools.ant.types.resources
    Output-only Resource that always appends to Ant's log.
    LogOutputResource(ProjectComponent) - +Constructor for class org.apache.tools.ant.types.resources.LogOutputResource +
    Create a new LogOutputResource. +
    LogOutputResource(ProjectComponent, int) - +Constructor for class org.apache.tools.ant.types.resources.LogOutputResource +
    Create a new LogOutputResource. +
    LogOutputStream - Class in org.apache.tools.ant.taskdefs
    Logs each line written to this stream to the log system of ant.
    LogOutputStream(ProjectComponent) - +Constructor for class org.apache.tools.ant.taskdefs.LogOutputStream +
    Create a new LogOutputStream for the specified ProjectComponent. +
    LogOutputStream(Task, int) - +Constructor for class org.apache.tools.ant.taskdefs.LogOutputStream +
    Creates a new instance of this class. +
    LogOutputStream(ProjectComponent, int) - +Constructor for class org.apache.tools.ant.taskdefs.LogOutputStream +
    Creates a new instance of this class. +
    logStats(long, long, long) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Log transfer stats to the log listener. +
    LogStreamHandler - Class in org.apache.tools.ant.taskdefs
    Logs standard output and error of a subprocess to the log system of ant.
    LogStreamHandler(Task, int, int) - +Constructor for class org.apache.tools.ant.taskdefs.LogStreamHandler +
    Creates log stream handler +
    LogStreamHandler(ProjectComponent, int, int) - +Constructor for class org.apache.tools.ant.taskdefs.LogStreamHandler +
    Creates log stream handler +
    logWhenWriting(String, int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Logs a message at the given output level, but only if this is + the pass that will actually create the archive. +
    LongCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A Long CP Info
    LongCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.LongCPInfo +
    Constructor. +
    LONGFILE_ERROR - +Static variable in class org.apache.tools.tar.TarOutputStream +
    Fail if a long file name is required in the archive. +
    LONGFILE_GNU - +Static variable in class org.apache.tools.tar.TarOutputStream +
    GNU tar extensions are used to store long file names in the archive. +
    LONGFILE_TRUNCATE - +Static variable in class org.apache.tools.tar.TarOutputStream +
    Long paths will be truncated in the archive. +
    longFileMode - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    lSep - +Static variable in class org.apache.tools.ant.DefaultLogger +
    Line separator +
    lSep - +Static variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    +
    +

    +M

    +
    +
    MacroDef - Class in org.apache.tools.ant.taskdefs
    Describe class MacroDef here.
    MacroDef() - +Constructor for class org.apache.tools.ant.taskdefs.MacroDef +
      +
    MacroDef.Attribute - Class in org.apache.tools.ant.taskdefs
    An attribute for the MacroDef task.
    MacroDef.Attribute() - +Constructor for class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    MacroDef.NestedSequential - Class in org.apache.tools.ant.taskdefs
    The class corresponding to the sequential nested element.
    MacroDef.NestedSequential() - +Constructor for class org.apache.tools.ant.taskdefs.MacroDef.NestedSequential +
      +
    MacroDef.TemplateElement - Class in org.apache.tools.ant.taskdefs
    A nested element for the MacroDef task.
    MacroDef.TemplateElement() - +Constructor for class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
      +
    MacroDef.Text - Class in org.apache.tools.ant.taskdefs
    A nested text element for the MacroDef task.
    MacroDef.Text() - +Constructor for class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    MacroInstance - Class in org.apache.tools.ant.taskdefs
    The class to be placed in the ant type definition.
    MacroInstance() - +Constructor for class org.apache.tools.ant.taskdefs.MacroInstance +
      +
    MacroInstance.Element - Class in org.apache.tools.ant.taskdefs
    Embedded element in macro instance
    MacroInstance.Element() - +Constructor for class org.apache.tools.ant.taskdefs.MacroInstance.Element +
      +
    MAGIC - +Static variable in class org.apache.tools.ant.types.Resource +
    Magic number +
    MAGIC_PROPERTY_CLASS_LOCATION - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    This is the name of a magic System property ("ant.junit.failureCollector"). +
    MAGICLEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the magic field in a header buffer. +
    MagicNames - Class in org.apache.tools.ant
    Magic names used within Ant.
    Mailer - Class in org.apache.tools.ant.taskdefs.email
    Base class for the various emailing implementations.
    Mailer() - +Constructor for class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    MailLogger - Class in org.apache.tools.ant.listener
    Buffers log messages from DefaultLogger, and sends an e-mail with the + results.
    MailLogger() - +Constructor for class org.apache.tools.ant.listener.MailLogger +
      +
    MailMessage - Class in org.apache.tools.mail
    A class to help send SMTP email.
    MailMessage() - +Constructor for class org.apache.tools.mail.MailMessage +
    Constructs a new MailMessage to send an email. +
    MailMessage(String) - +Constructor for class org.apache.tools.mail.MailMessage +
    Constructs a new MailMessage to send an email. +
    MailMessage(String, int) - +Constructor for class org.apache.tools.mail.MailMessage +
    Constructs a new MailMessage to send an email. +
    main(String[]) - +Static method in class org.apache.tools.ant.Diagnostics +
    main entry point for command line +
    main(String[]) - +Static method in class org.apache.tools.ant.launch.Launcher +
    Entry point for starting command line Ant. +
    Main - Class in org.apache.tools.ant
    Command line entry point into Ant.
    Main() - +Constructor for class org.apache.tools.ant.Main +
    Constructor used when creating Main for later arg processing + and startup +
    Main(String[]) - +Constructor for class org.apache.tools.ant.Main +
    Deprecated. since 1.6.x +
    main(String[]) - +Static method in class org.apache.tools.ant.Main +
    Command line entry point. +
    main(String[]) - +Static method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. A test method. +
    main(String[]) - +Static method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Main application method for the iPlanet Application Server ejbc utility. +
    main(String[]) - +Static method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    The command line entry point for jlink. +
    main(String[]) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Entry point for standalone (forked) mode. +
    MAIN_CLASS - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The startup class that is to be run. +
    MAJORITY - +Static variable in class org.apache.tools.ant.types.Quantifier +
    MAJORITY instance +
    Majority - Class in org.apache.tools.ant.types.resources.selectors
    Majority ResourceSelector.
    Majority() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Majority +
    Default constructor. +
    Majority(ResourceSelector[]) - +Constructor for class org.apache.tools.ant.types.resources.selectors.Majority +
    Convenience constructor. +
    MajoritySelector - Class in org.apache.tools.ant.types.selectors
    This selector is here just to shake up your thinking a bit.
    MajoritySelector() - +Constructor for class org.apache.tools.ant.types.selectors.MajoritySelector +
    Default constructor. +
    makeObject(UnknownElement, RuntimeConfigurable) - +Method in class org.apache.tools.ant.UnknownElement +
    Creates a named task or data type. +
    makeRemoteDir(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Create the specified directory on the remote host. +
    makeRemoteDir(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Create the specified directory on the remote host. +
    makeResourceFromURI(String) - +Static method in class org.apache.tools.ant.taskdefs.Definer +
    This is where the logic to map from a URI to an antlib resource + is kept. +
    makeTask(UnknownElement, RuntimeConfigurable) - +Method in class org.apache.tools.ant.UnknownElement +
    Creates a named task and configures it up to the init() stage. +
    MakeUrl - Class in org.apache.tools.ant.taskdefs
    This task takes file and turns them into a URL, which it then assigns + to a property.
    MakeUrl() - +Constructor for class org.apache.tools.ant.taskdefs.MakeUrl +
      +
    Manifest - Class in org.apache.tools.ant.taskdefs
    Holds the data of a jar manifest.
    Manifest() - +Constructor for class org.apache.tools.ant.taskdefs.Manifest +
    Construct an empty manifest +
    Manifest(Reader) - +Constructor for class org.apache.tools.ant.taskdefs.Manifest +
    Read a manifest file from the given reader +
    MANIFEST - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The standard MANIFEST file +
    Manifest.Attribute - Class in org.apache.tools.ant.taskdefs
    An attribute for the manifest.
    Manifest.Attribute() - +Constructor for class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Construct an empty attribute +
    Manifest.Attribute(String) - +Constructor for class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Construct an attribute by parsing a line from the Manifest +
    Manifest.Attribute(String, String) - +Constructor for class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Construct a manifest by specifying its name and value +
    Manifest.Section - Class in org.apache.tools.ant.taskdefs
    A manifest section - you can nest attribute elements into sections.
    Manifest.Section() - +Constructor for class org.apache.tools.ant.taskdefs.Manifest.Section +
      +
    ManifestClassPath - Class in org.apache.tools.ant.taskdefs
    Converts a Path into a property suitable as a Manifest classpath.
    ManifestClassPath() - +Constructor for class org.apache.tools.ant.taskdefs.ManifestClassPath +
      +
    ManifestException - Exception in org.apache.tools.ant.taskdefs
    Exception thrown indicating problems in a JAR Manifest
    ManifestException(String) - +Constructor for exception org.apache.tools.ant.taskdefs.ManifestException +
    Constructs an exception with the given descriptive message. +
    ManifestTask - Class in org.apache.tools.ant.taskdefs
    Creates a manifest file for inclusion in a JAR, Ant task wrapper + around Manifest.
    ManifestTask() - +Constructor for class org.apache.tools.ant.taskdefs.ManifestTask +
    Default constructor +
    ManifestTask.Mode - Class in org.apache.tools.ant.taskdefs
    Helper class for Manifest's mode attribute.
    ManifestTask.Mode() - +Constructor for class org.apache.tools.ant.taskdefs.ManifestTask.Mode +
      +
    map - +Variable in class org.apache.tools.ant.types.selectors.MappingSelector +
      +
    mapFileName(String) - +Method in class org.apache.tools.ant.types.mappers.CutDirsMapper +
    Returns an array containing the target filename(s) for the + given source file.. +
    mapFileName(String) - +Method in class org.apache.tools.ant.types.mappers.FilterMapper +
    Return the result of the filters on the sourcefilename. +
    mapFileName(String) - +Method in class org.apache.tools.ant.types.optional.ScriptMapper +
    Returns an array containing the target filename(s) for the given source + file. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.ChainedMapper +
    Returns an array containing the target filename(s) for the + given source file.. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.CompositeMapper +
    Returns an array containing the target filename(s) for the + given source file.. +
    mapFileName(String) - +Method in interface org.apache.tools.ant.util.FileNameMapper +
    Returns an array containing the target filename(s) for the + given source file. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.FirstMatchMapper +
    Returns an array containing the target filename(s) for the + given source file.. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.FlatFileNameMapper +
    Returns an one-element array containing the source file name + without any leading directory information. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.IdentityMapper +
    Returns an one-element array containing the source file name. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.MergingMapper +
    Returns an one-element array containing the file name set via setTo. +
    mapFileName(String) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise. +
    mapJspToJavaName(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.Jasper41Mangler +
    map from a jsp file to a java filename; does not do packages +
    mapJspToJavaName(File) - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.JspMangler +
    map from a jsp file to a java filename; does not do packages +
    mapJspToJavaName(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspNameMangler +
    map from a jsp file to a java filename; does not do packages +
    mapPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.Jasper41Mangler +
    taking in the substring representing the path relative to the source dir + return a new string representing the destination path +
    mapPath(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.JspMangler +
    taking in the substring representing the path relative to the source dir + return a new string representing the destination path +
    mapPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspNameMangler +
    taking in the substring representing the path relative to the source dir + return a new string representing the destination path + not supported, as jasper in tomcat4.0 doesnt either +
    MappedResource - Class in org.apache.tools.ant.types.resources
    A decorator around a different resource that uses a mapper to + dynamically remap the resource's name.
    MappedResource(Resource, FileNameMapper) - +Constructor for class org.apache.tools.ant.types.resources.MappedResource +
    Wraps an existing resource. +
    MappedResourceCollection - Class in org.apache.tools.ant.types.resources
    Wrapper around a resource collections that maps the names of the + other collection using a configured mapper.
    MappedResourceCollection() - +Constructor for class org.apache.tools.ant.types.resources.MappedResourceCollection +
      +
    mapper - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    Mapper - Class in org.apache.tools.ant.types
    Element to define a FileNameMapper.
    Mapper(Project) - +Constructor for class org.apache.tools.ant.types.Mapper +
    Construct a new Mapper element. +
    Mapper.MapperType - Class in org.apache.tools.ant.types
    Class as Argument to FileNameMapper.setType.
    Mapper.MapperType() - +Constructor for class org.apache.tools.ant.types.Mapper.MapperType +
    Constructor for the MapperType enumeration +
    mapperElement - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    mapperElement - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    mapperElement - +Variable in class org.apache.tools.ant.taskdefs.UpToDate +
      +
    mapperElement - +Variable in class org.apache.tools.ant.types.selectors.MappingSelector +
      +
    MappingSelector - Class in org.apache.tools.ant.types.selectors
    A mapping selector is an abstract class adding mapping support to the base + selector
    MappingSelector() - +Constructor for class org.apache.tools.ant.types.selectors.MappingSelector +
    Creates a new MappingSelector instance. +
    mapToJavaFile(JspMangler, File, File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    get a filename from our jsp file. +
    mark(int) - +Method in class org.apache.tools.ant.util.ReaderInputStream +
    Marks the read limit of the Reader. +
    mark(int) - +Method in class org.apache.tools.tar.TarInputStream +
    Since we do not support marking just yet, we do nothing. +
    markSupported() - +Method in class org.apache.tools.ant.util.ReaderInputStream +
      +
    markSupported() - +Method in class org.apache.tools.tar.TarInputStream +
    Since we do not support marking just yet, we return false. +
    match(String, String) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a string matches against a pattern. +
    match(String, String, boolean) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a string matches against a pattern. +
    match(String) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Matches a jar entry against the includes/excludes list, + normalizing the path separator. +
    match(String, String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a string matches against a pattern. +
    match(String, String, boolean) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a string matches against a pattern. +
    MATCH_CASE_INSENSITIVE - +Static variable in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Perform a case insenstive match +
    MATCH_DEFAULT - +Static variable in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Default Mask (case insensitive, neither multiline nor + singleline specified). +
    MATCH_MULTILINE - +Static variable in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Treat the input as a multiline input +
    MATCH_SINGLELINE - +Static variable in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Treat the input as singleline input ('.' matches newline) +
    matcher - +Variable in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
      +
    Matches - Class in org.apache.tools.ant.taskdefs.condition
    Simple regular expression condition.
    Matches() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Matches +
      +
    matches(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Does the given argument match the pattern using default options? +
    matches(String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Does the given argument match the pattern? +
    matches(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Does the given argument match the pattern? +
    matches(String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Does the given argument match the pattern? +
    matches(String) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Does the given argument match the pattern using default options? +
    matches(String, int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Does the given argument match the pattern? +
    matches(String) - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Does the given argument match the pattern? +
    matches(String, int) - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Does this regular expression match the input, given + certain options +
    MatchingTask - Class in org.apache.tools.ant.taskdefs
    This is an abstract task that should be used by all those tasks that + require to include or exclude files based on pattern matching.
    MatchingTask() - +Constructor for class org.apache.tools.ant.taskdefs.MatchingTask +
      +
    matchPath(String, String) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a given path matches a given pattern. +
    matchPath(String, String, boolean) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a given path matches a given pattern. +
    matchPath(String, String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a given path matches a given pattern. +
    matchPath(String, String, boolean) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a given path matches a given pattern. +
    matchPath(TokenizedPath, boolean) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Tests whether or not a given path matches a given pattern. +
    matchPatternStart(String, String) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a given path matches the start of a given + pattern up to the first "**". +
    matchPatternStart(String, String, boolean) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Test whether or not a given path matches the start of a given + pattern up to the first "**". +
    matchPatternStart(String, String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a given path matches the start of a given + pattern up to the first "**". +
    matchPatternStart(String, String, boolean) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Tests whether or not a given path matches the start of a given + pattern up to the first "**". +
    matchStartOf(TokenizedPath, boolean) - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Tests whether or not this pattern matches the start of + a path. +
    max - +Variable in class org.apache.tools.ant.types.selectors.DepthSelector +
    max attribute +
    MAX_ALPHA_SIZE - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    MAX_BLOCKSIZE - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    The maximum supported blocksize == 9. +
    MAX_CODE_LEN - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    MAX_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DepthSelector +
    Used for parameterized custom selector +
    MAX_LEVELS_OF_SYMLINKS - +Static variable in class org.apache.tools.ant.DirectoryScanner +
    default value for maxLevelsOfSymlinks +
    MAX_LINE_LENGTH - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    The max length of a line in a Manifest +
    MAX_LOOPS - +Static variable in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Maximum number of loops for looking for indirect dependencies. +
    MAX_NAMELEN - +Static variable in class org.apache.tools.tar.TarEntry +
    Maximum length of a user's name in the tar file +
    MAX_SECTION_LENGTH - +Static variable in class org.apache.tools.ant.taskdefs.Manifest +
    Max length of a line section which is continued. +
    MAX_SELECTORS - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    maxMemory - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    The maximum amount of memory to use for Jar signer +
    MAXSIZE - +Static variable in interface org.apache.tools.tar.TarConstants +
    The maximum size of a file in a tar archive (That's 11 sevens, octal). +
    maybeConfigure(Project) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Configures the wrapped element and all its children. +
    maybeConfigure(Project, boolean) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Configures the wrapped element. +
    maybeConfigure() - +Method in class org.apache.tools.ant.Task +
    Configures this task - if it hasn't been done already. +
    maybeConfigure() - +Method in class org.apache.tools.ant.UnknownElement +
    Creates the real object instance and child elements, then configures + the attributes and text of the real object. +
    maybeSetResultPropertyValue(int) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Helper method to set result property to the + passed in value if appropriate. +
    maybeSetResultPropertyValue(int) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Helper method to set result property to the + passed in value if appropriate. +
    memoryInitialSize - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    memoryMaximumSize - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    merge(Manifest) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Merge the contents of the given manifest into this manifest + without merging Class-Path attributes. +
    merge(Manifest, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Merge the contents of the given manifest into this manifest + without merging Class-Path attributes. +
    merge(Manifest, boolean, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Merge the contents of the given manifest into this manifest +
    merge(Manifest.Section) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Merge in another section without merging Class-Path attributes. +
    merge(Manifest.Section, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Merge in another section +
    mergeCentralDirectoryData(ZipExtraField[]) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Merges the central directory fields of the given ZipExtraFields. +
    mergedFile - +Variable in class org.apache.tools.ant.util.MergingMapper +
      +
    mergeExcludes(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Get the merged exclude patterns for this AbstractFileSet. +
    mergeExcludes(Project) - +Method in class org.apache.tools.ant.types.resources.Files +
    Get the merged exclude patterns for this Files collection. +
    mergeIncludes(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Get the merged include patterns for this AbstractFileSet. +
    mergeIncludes(Project) - +Method in class org.apache.tools.ant.types.resources.Files +
    Get the merged include patterns for this Files collection. +
    mergeLocalFileDataData(ZipExtraField[]) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Merges the local file data fields of the given ZipExtraFields. +
    mergePatterns(Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Get the merged patterns for this AbstractFileSet. +
    mergePatterns(Project) - +Method in class org.apache.tools.ant.types.resources.Files +
    Get the merged patterns for this Files collection. +
    MergingMapper - Class in org.apache.tools.ant.util
    Implementation of FileNameMapper that always returns the same + target file name.
    MergingMapper() - +Constructor for class org.apache.tools.ant.util.MergingMapper +
      +
    MergingMapper(String) - +Constructor for class org.apache.tools.ant.util.MergingMapper +
      +
    message - +Variable in class org.apache.tools.ant.taskdefs.Echo +
      +
    message - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    Message - Class in org.apache.tools.ant.taskdefs.email
    Class representing an email message.
    Message() - +Constructor for class org.apache.tools.ant.taskdefs.email.Message +
    Creates a new empty message +
    Message(String) - +Constructor for class org.apache.tools.ant.taskdefs.email.Message +
    Creates a new message based on the given string +
    Message(File) - +Constructor for class org.apache.tools.ant.taskdefs.email.Message +
    Creates a new message using the contents of the given file. +
    MESSAGE_ADDING_SCHEMA - +Static variable in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    adding schema +
    MESSAGE_FILES_VALIDATED - +Static variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Message for sucessfull validation +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    messageLogged(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals a message logging event. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    Logs a message, if the priority is suitable. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals a message logging event.. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals a message logging event.. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.NoBannerLogger +
    Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals a message logging event. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired whenever a message is logged. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals a message logging event.. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals a message logging event. +
    messageLogged(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when a message is logged, this adds a message element to the + most appropriate parent element (task, target or build) and records + the priority and text of the message. +
    META_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    The standard META-INF directory in jar files +
    METHOD_NAME - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    The method name to look for in InetAddress +
    MethodRefCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A MethodRef CP Info
    MethodRefCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Constructor. +
    MILLIS_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    MILLIS_PER_SECOND - +Static variable in class org.apache.tools.tar.TarEntry +
    Convert millis to seconds +
    MILLISECOND - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    millisecond string +
    MIME - +Static variable in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Constant to allow the Mime mailer to be requested +
    MimeMail - Class in org.apache.tools.ant.taskdefs.optional.net
    Deprecated. since 1.6.x. + Use EmailTask instead.
    MimeMail() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.MimeMail +
    Deprecated.   +
    MimeMailer - Class in org.apache.tools.ant.taskdefs.email
    Uses the JavaMail classes to send Mime format email.
    MimeMailer() - +Constructor for class org.apache.tools.ant.taskdefs.email.MimeMailer +
      +
    min - +Variable in class org.apache.tools.ant.types.selectors.DepthSelector +
    min attribute +
    MIN_BLOCKSIZE - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    The minimum supported blocksize == 1. +
    MIN_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DepthSelector +
    Used for parameterized custom selector +
    MINUTE - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    minute string +
    MK_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    MK_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    Mkdir - Class in org.apache.tools.ant.taskdefs
    Creates a given directory.
    Mkdir() - +Constructor for class org.apache.tools.ant.taskdefs.Mkdir +
      +
    MODELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the mode field in a header buffer. +
    ModifiedSelector - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Selector class that uses Algorithm, Cache and Comparator + for its work.
    ModifiedSelector() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Bean-Constructor. +
    ModifiedSelector.AlgorithmName - Class in org.apache.tools.ant.types.selectors.modifiedselector
    The enumerated type for algorithm.
    ModifiedSelector.AlgorithmName() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.AlgorithmName +
      +
    ModifiedSelector.CacheName - Class in org.apache.tools.ant.types.selectors.modifiedselector
    The enumerated type for cache.
    ModifiedSelector.CacheName() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.CacheName +
      +
    ModifiedSelector.ComparatorName - Class in org.apache.tools.ant.types.selectors.modifiedselector
    The enumerated type for algorithm.
    ModifiedSelector.ComparatorName() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.ComparatorName +
      +
    MODTIMELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the modification time field in a header buffer. +
    Move - Class in org.apache.tools.ant.taskdefs
    Moves a file or directory to a new file or directory.
    Move() - +Constructor for class org.apache.tools.ant.taskdefs.Move +
    Constructor of object. +
    MSG_DEBUG - +Static variable in class org.apache.tools.ant.Project +
    Message priority of "debug". +
    MSG_ERR - +Static variable in class org.apache.tools.ant.Project +
    Message priority of "error". +
    MSG_INFO - +Static variable in class org.apache.tools.ant.Project +
    Message priority of "information". +
    MSG_NO_REACHABLE_TEST - +Static variable in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Error message when no reachably test avail. +
    MSG_VERBOSE - +Static variable in class org.apache.tools.ant.Project +
    Message priority of "verbose". +
    MSG_WARN - +Static variable in class org.apache.tools.ant.Project +
    Message priority of "warning". +
    msgOutputLevel - +Variable in class org.apache.tools.ant.DefaultLogger +
    Lowest level of message to write out +
    MSVSS - Class in org.apache.tools.ant.taskdefs.optional.vss
    A base class for creating tasks for executing commands on Visual SourceSafe.
    MSVSS() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
      +
    MSVSS.CurrentModUpdated - Class in org.apache.tools.ant.taskdefs.optional.vss
    Extention of EnumeratedAttribute to hold the values for file time stamp.
    MSVSS.CurrentModUpdated() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSS.CurrentModUpdated +
      +
    MSVSS.WritableFiles - Class in org.apache.tools.ant.taskdefs.optional.vss
    Extention of EnumeratedAttribute to hold the values for writable filess.
    MSVSS.WritableFiles() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSS.WritableFiles +
      +
    MSVSSADD - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs Add commands to Microsoft Visual SourceSafe.
    MSVSSADD() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
      +
    MSVSSCHECKIN - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs CheckIn commands to Microsoft Visual SourceSafe.
    MSVSSCHECKIN() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
      +
    MSVSSCHECKOUT - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs CheckOut commands to Microsoft Visual SourceSafe.
    MSVSSCHECKOUT() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
      +
    MSVSSConstants - Interface in org.apache.tools.ant.taskdefs.optional.vss
    Holds all the constants for the VSS tasks.
    MSVSSCP - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs CP (Change Project) commands to Microsoft Visual SourceSafe.
    MSVSSCP() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP +
      +
    MSVSSCREATE - Class in org.apache.tools.ant.taskdefs.optional.vss
    Creates a new project in Microsoft Visual SourceSafe.
    MSVSSCREATE() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE +
      +
    MSVSSGET - Class in org.apache.tools.ant.taskdefs.optional.vss
    Perform Get commands from Microsoft Visual SourceSafe.
    MSVSSGET() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
      +
    MSVSSHISTORY - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs History commands to Microsoft Visual SourceSafe.
    MSVSSHISTORY() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
      +
    MSVSSHISTORY.BriefCodediffNofile - Class in org.apache.tools.ant.taskdefs.optional.vss
    Extention of EnumeratedAttribute to hold the values for style.
    MSVSSHISTORY.BriefCodediffNofile() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY.BriefCodediffNofile +
      +
    MSVSSLABEL - Class in org.apache.tools.ant.taskdefs.optional.vss
    Performs Label commands to Microsoft Visual SourceSafe.
    MSVSSLABEL() - +Constructor for class org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL +
      +
    MultipleChoiceInputRequest - Class in org.apache.tools.ant.input
    Encapsulates an input request.
    MultipleChoiceInputRequest(String, Vector) - +Constructor for class org.apache.tools.ant.input.MultipleChoiceInputRequest +
      +
    +
    +

    +N

    +
    +
    N_GROUPS - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    N_ITERS - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    name() - +Method in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
      +
    name - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
      +
    name - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
      +
    name - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    Name - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by name.
    Name() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Name +
      +
    Name - Class in org.apache.tools.ant.types.resources.selectors
    Name ResourceSelector.
    Name() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Name +
      +
    NAME_KEY - +Static variable in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Used for parameterized custom selector +
    NameAndTypeCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A NameAndType CP Info
    NameAndTypeCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    Constructor. +
    NAMELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the name field in a header buffer. +
    Native2Ascii - Class in org.apache.tools.ant.taskdefs.optional
    Converts files from native encodings to ASCII.
    Native2Ascii() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    No args constructor +
    Native2AsciiAdapter - Interface in org.apache.tools.ant.taskdefs.optional.native2ascii
    Interface for an adapter to a native2ascii implementation.
    Native2AsciiAdapterFactory - Class in org.apache.tools.ant.taskdefs.optional.native2ascii
    Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor.
    Native2AsciiAdapterFactory() - +Constructor for class org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapterFactory +
      +
    NATIVE_ENCODING - +Static variable in class org.apache.tools.ant.taskdefs.Expand +
      +
    needsCleanup() - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource.ClassLoaderWithFlag +
      +
    needToRebuild(Hashtable, File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    This method checks the timestamp on each file listed in the + ejbFiles and compares them to the timestamp on the jarFile + . +
    NEGATE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Used for parameterized custom selector +
    NetRexxC - Class in org.apache.tools.ant.taskdefs.optional
    Compiles NetRexx source files.
    NetRexxC() - +Constructor for class org.apache.tools.ant.taskdefs.optional.NetRexxC +
      +
    NetRexxC.TraceAttr - Class in org.apache.tools.ant.taskdefs.optional
    Enumerated class corresponding to the trace attribute.
    NetRexxC.TraceAttr() - +Constructor for class org.apache.tools.ant.taskdefs.optional.NetRexxC.TraceAttr +
      +
    NetRexxC.VerboseAttr - Class in org.apache.tools.ant.taskdefs.optional
    Enumerated class corresponding to the verbose attribute.
    NetRexxC.VerboseAttr() - +Constructor for class org.apache.tools.ant.taskdefs.optional.NetRexxC.VerboseAttr +
      +
    NEVER - +Static variable in class org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField +
      +
    NEVER - +Static variable in class org.apache.tools.zip.ZipOutputStream.UnicodeExtraFieldPolicy +
    Never create Unicode extra fields. +
    newAntClassLoader(ClassLoader, Project, Path, boolean) - +Static method in class org.apache.tools.ant.AntClassLoader +
    Factory method +
    newArchiveScanner() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Creates a scanner for this type of archive. +
    newArchiveScanner() - +Method in class org.apache.tools.ant.types.TarFileSet +
    Create a new scanner. +
    newArchiveScanner() - +Method in class org.apache.tools.ant.types.ZipFileSet +
    Return a new archive scanner based on this one. +
    newCatalog() - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalog +
    Create a new ApacheCatalog instance. +
    newDocument() - +Static method in class org.apache.tools.ant.util.DOMUtils +
    Get a new Document instance, +
    newEnvironment - +Variable in class org.apache.tools.ant.taskdefs.ExecTask +
      +
    newFileUtils() - +Static method in class org.apache.tools.ant.util.FileUtils +
    Deprecated. since 1.7. + Use getFileUtils instead, + FileUtils do not have state. +
    newInstance(String) - +Static method in class org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove +
    Create an instance of this enumerated value based on the string value. +
    newInstance(String) - +Static method in class org.apache.tools.ant.filters.FixCrLfFilter.CrLf +
    Create an instance of this enumerated value based on the string value. +
    newInstance() - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Helper method obtaining a fresh instance of the class specified + in the @classname and using the specified classpath. +
    newInstance(String, ClassLoader) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Creates a fresh object instance of the specified classname. +
    newInstance(String, ClassLoader, Class) - +Static method in class org.apache.tools.ant.util.ClasspathUtils +
    Creates a fresh object instance of the specified classname. +
    newInstance(Class, Class[], Object[]) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    Create an instance of a class using the constructor matching + the given arguments. +
    newJUnitTestRunner(JUnitTest, String[], boolean, boolean, boolean, boolean, boolean, AntClassLoader) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror +
    Create a new test runner for a test. +
    newJUnitTestRunner(JUnitTest, String[], boolean, boolean, boolean, boolean, boolean, AntClassLoader) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirrorImpl +
    Create a new test runner for a test.. +
    newParserFactory() - +Static method in class org.apache.tools.ant.util.JAXPUtils +
    Returns a new parser factory instance. +
    newRegexp() - +Method in class org.apache.tools.ant.util.regexp.RegexpFactory +
    Create a new regular expression matcher instance. +
    newRegexp(Project) - +Method in class org.apache.tools.ant.util.regexp.RegexpFactory +
    Create a new regular expression matcher instance. +
    newRegexpMatcher() - +Method in class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Create a new regular expression instance. +
    newRegexpMatcher(Project) - +Method in class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Create a new regular expression instance. +
    newSummaryJUnitResultFormatter() - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror +
    Create a summary result formatter. +
    newSummaryJUnitResultFormatter() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirrorImpl +
    Create a summary result formatter.. +
    next() - +Method in class org.apache.tools.ant.types.resources.FileResourceIterator +
    Get the next element from this FileResourceIterator. +
    nextElement() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. get the next element. +
    nextElement() - +Method in class org.apache.tools.ant.util.CollectionUtils.EmptyEnumeration +
      +
    nextLine() - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. Move to the next line. +
    nextResource() - +Method in class org.apache.tools.ant.types.resources.FileResourceIterator +
    Convenience method to return the next resource. +
    nextToken() - +Method in class org.apache.tools.ant.PathTokenizer +
    Returns the next path element from this tokenizer. +
    Nice - Class in org.apache.tools.ant.taskdefs
    A task to provide "nice-ness" to the current thread, and/or to + query the current value.
    Nice() - +Constructor for class org.apache.tools.ant.taskdefs.Nice +
      +
    NoBannerLogger - Class in org.apache.tools.ant
    Extends DefaultLogger to strip out empty targets.
    NoBannerLogger() - +Constructor for class org.apache.tools.ant.NoBannerLogger +
    Sole constructor. +
    noChildrenAllowed() - +Method in class org.apache.tools.ant.types.DataType +
    Creates an exception that indicates that this XML element must + not have child elements if the refid attribute is set. +
    NoExitSecurityManager - Class in org.apache.tools.ant.util.optional
    This is intended as a replacement for the default system manager.
    NoExitSecurityManager() - +Constructor for class org.apache.tools.ant.util.optional.NoExitSecurityManager +
      +
    NOFRAMES - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    name of the no frames format. +
    NONE - +Static variable in class org.apache.tools.ant.types.Quantifier +
    NONE instance +
    NONE - +Static variable in class org.apache.tools.ant.types.resources.Resources +
    static empty ResourceCollection +
    None - Class in org.apache.tools.ant.types.resources.selectors
    None ResourceSelector.
    None() - +Constructor for class org.apache.tools.ant.types.resources.selectors.None +
    Default constructor. +
    None(ResourceSelector[]) - +Constructor for class org.apache.tools.ant.types.resources.selectors.None +
    Convenience constructor. +
    NoneSelector - Class in org.apache.tools.ant.types.selectors
    This selector has a collection of other selectors.
    NoneSelector() - +Constructor for class org.apache.tools.ant.types.selectors.NoneSelector +
    Default constructor. +
    NORMAL - +Static variable in class org.apache.tools.ant.taskdefs.SQLExec.DelimiterType +
    The enumerated strings +
    normalize(String) - +Method in class org.apache.tools.ant.util.FileUtils +
    "Normalize" the given absolute path. +
    Not - Class in org.apache.tools.ant.taskdefs.condition
    <not> condition.
    Not() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Not +
      +
    Not - Class in org.apache.tools.ant.types.resources.selectors
    Not ResourceSelector.
    Not() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Not +
    Default constructor. +
    Not(ResourceSelector) - +Constructor for class org.apache.tools.ant.types.resources.selectors.Not +
    Convenience constructor. +
    NOT_ENCODEABLE - +Static variable in class org.apache.tools.zip.ZipOutputStream.UnicodeExtraFieldPolicy +
    Create Unicode extra fields for filenames that cannot be + encoded using the specified encoding. +
    NOT_EQUAL - +Static variable in class org.apache.tools.ant.types.Comparison +
    Not-Equal Comparison. +
    NOT_RECOGNIZED - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    error - not recognized +
    NOT_SUPPORTED - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    error - not supported +
    NOT_SUPPORTED_CHILD_POSTFIX - +Static variable in class org.apache.tools.ant.IntrospectionHelper +
    part of the error message created by throwNotSupported. +
    NOT_SUPPORTED_CHILD_PREFIX - +Static variable in class org.apache.tools.ant.IntrospectionHelper +
    part of the error message created by throwNotSupported. +
    NotSelector - Class in org.apache.tools.ant.types.selectors
    This selector has one other selectors whose meaning it inverts.
    NotSelector() - +Constructor for class org.apache.tools.ant.types.selectors.NotSelector +
    Default constructor. +
    NotSelector(FileSelector) - +Constructor for class org.apache.tools.ant.types.selectors.NotSelector +
    Constructor that inverts the meaning of its argument. +
    NTFS_FILE_TIMESTAMP_GRANULARITY - +Static variable in class org.apache.tools.ant.util.FileUtils +
    The granularity of timestamps under the NT File System. +
    NULL - +Static variable in class org.apache.tools.ant.property.NullReturn +
    a value to use in a property helper to stop looking properties +
    NullReturn - Class in org.apache.tools.ant.property
    Class to represent a null and to stop the chain of lookups.
    NUM_OVERSHOOT_BYTES - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    +
    +

    +O

    +
    +
    okToDelete(File) - +Method in class org.apache.tools.ant.taskdefs.Move +
    Its only ok to delete a directory tree if there are no files in it. +
    OLD_GENIC_CLASS_1 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Old GenIC class name (JOnAS 2.4.x). +
    OLD_GENIC_CLASS_2 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Old GenIC class name. +
    OMIT - +Static variable in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + Tar.OMIT is deprecated and is replaced with + Tar.TarLongFileMode.OMIT +
    OMIT - +Static variable in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    permissible values for longfile attribute +
    ONCE - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    fork once only +
    ONE - +Static variable in class org.apache.tools.ant.types.Quantifier +
    ONE instance +
    ONE_DAY - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    a day in milliseconds +
    ONE_HOUR - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    an hour in milliseconds +
    ONE_MILLISECOND - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    a millisecond +
    ONE_MINUTE - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    a minute in milliseconds +
    ONE_SECOND - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    a second in milliseconds +
    ONE_WEEK - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor +
    a week in milliseconds +
    oneBuf - +Variable in class org.apache.tools.tar.TarInputStream +
    This contents of this array is not used at all in this class, + it is only here to avoid repreated object creation during calls + to the no-arg read method. +
    oneBuf - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    onEndChild(String, String, String, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    Handle the end of a element. +
    onEndElement(String, String, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    This method is called when this element and all elements nested into it have been + handled. +
    onEndElement(String, String, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ElementHandler +
    Handles the end of the element. +
    onEndElement(String, String, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.TargetHandler +
    Handle the end of the project, sets the current target of the + context to be the implicit target. +
    ONLY_QUALIFY_ELEMENTS - +Static variable in class org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy +
    Ignores namespaces for attributes. +
    onStartChild(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    Handles the start of an element. +
    onStartChild(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ElementHandler +
    Handles the start of an element within a target. +
    onStartChild(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.MainHandler +
    Handle the project tag +
    onStartChild(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ProjectHandler +
    Handles the start of a top-level element within the project. +
    onStartChild(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.TargetHandler +
    Handles the start of an element within a target. +
    onStartElement(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
    Handles the start of an element. +
    onStartElement(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ElementHandler +
    Initialisation routine called after handler creation + with the element name and attributes. +
    onStartElement(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.ProjectHandler +
    Initialisation routine called after handler creation + with the element name and attributes. +
    onStartElement(String, String, String, Attributes, AntXMLContext) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.TargetHandler +
    Initialisation routine called after handler creation + with the element name and attributes. +
    onSuccessfulValidation(int) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    handler called on successful file validation. +
    onSuccessfulValidation(int) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    handler called on successful file validation. +
    onTick() - +Method in interface org.apache.tools.ant.taskdefs.Get.DownloadProgress +
    tick handler +
    onTick() - +Method in class org.apache.tools.ant.taskdefs.Get.NullProgress +
    tick handler +
    onTick() - +Method in class org.apache.tools.ant.taskdefs.Get.VerboseProgress +
    tick handler +
    open() - +Method in class org.apache.tools.ant.util.LazyFileOutputStream +
    Explicitly open the file for writing. +
    openElement(Element, Writer, int, String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes the opening tag - including all attributes - + corresponding to a DOM element. +
    openElement(Element, Writer, int, String, boolean) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes the opening tag - including all attributes - + corresponding to a DOM element. +
    openExecChannel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Open an ssh channel. +
    openInputStream(ClassLoader) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    open the inpout stream from a specific classloader +
    openInputStream(ClassLoader) - +Method in class org.apache.tools.ant.types.resources.JavaConstantResource +
    open the input stream from a specific classloader +
    openInputStream(ClassLoader) - +Method in class org.apache.tools.ant.types.resources.JavaResource +
    open the input stream from a specific classloader +
    openSession() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Open an ssh seession. +
    openSftpChannel() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Open an ssh sftp channel. +
    optimize - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    OPTIONAL_EXTENSION_LIST - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Name object for Optional-Extension-List + manifest attribute used for declaring optional dependencies on + installed extensions. +
    Or - Class in org.apache.tools.ant.taskdefs.condition
    <or> condition container.
    Or() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Or +
      +
    Or - Class in org.apache.tools.ant.types.resources.selectors
    Or ResourceSelector.
    Or() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Or +
    Default constructor. +
    Or(ResourceSelector[]) - +Constructor for class org.apache.tools.ant.types.resources.selectors.Or +
    Convenience constructor. +
    org.apache.tools.ant - package org.apache.tools.ant
     
    org.apache.tools.ant.dispatch - package org.apache.tools.ant.dispatch
     
    org.apache.tools.ant.filters - package org.apache.tools.ant.filters
     
    org.apache.tools.ant.filters.util - package org.apache.tools.ant.filters.util
     
    org.apache.tools.ant.helper - package org.apache.tools.ant.helper
     
    org.apache.tools.ant.input - package org.apache.tools.ant.input
     
    org.apache.tools.ant.launch - package org.apache.tools.ant.launch
     
    org.apache.tools.ant.listener - package org.apache.tools.ant.listener
     
    org.apache.tools.ant.loader - package org.apache.tools.ant.loader
     
    org.apache.tools.ant.property - package org.apache.tools.ant.property
    Contains helper classes for ant properties.
    org.apache.tools.ant.taskdefs - package org.apache.tools.ant.taskdefs
     
    org.apache.tools.ant.taskdefs.compilers - package org.apache.tools.ant.taskdefs.compilers
     
    org.apache.tools.ant.taskdefs.condition - package org.apache.tools.ant.taskdefs.condition
     
    org.apache.tools.ant.taskdefs.cvslib - package org.apache.tools.ant.taskdefs.cvslib
     
    org.apache.tools.ant.taskdefs.email - package org.apache.tools.ant.taskdefs.email
     
    org.apache.tools.ant.taskdefs.optional - package org.apache.tools.ant.taskdefs.optional
     
    org.apache.tools.ant.taskdefs.optional.ccm - package org.apache.tools.ant.taskdefs.optional.ccm
     
    org.apache.tools.ant.taskdefs.optional.clearcase - package org.apache.tools.ant.taskdefs.optional.clearcase
     
    org.apache.tools.ant.taskdefs.optional.depend - package org.apache.tools.ant.taskdefs.optional.depend
     
    org.apache.tools.ant.taskdefs.optional.depend.constantpool - package org.apache.tools.ant.taskdefs.optional.depend.constantpool
     
    org.apache.tools.ant.taskdefs.optional.ejb - package org.apache.tools.ant.taskdefs.optional.ejb
     
    org.apache.tools.ant.taskdefs.optional.extension - package org.apache.tools.ant.taskdefs.optional.extension
     
    org.apache.tools.ant.taskdefs.optional.extension.resolvers - package org.apache.tools.ant.taskdefs.optional.extension.resolvers
     
    org.apache.tools.ant.taskdefs.optional.i18n - package org.apache.tools.ant.taskdefs.optional.i18n
     
    org.apache.tools.ant.taskdefs.optional.image - package org.apache.tools.ant.taskdefs.optional.image
     
    org.apache.tools.ant.taskdefs.optional.j2ee - package org.apache.tools.ant.taskdefs.optional.j2ee
     
    org.apache.tools.ant.taskdefs.optional.javacc - package org.apache.tools.ant.taskdefs.optional.javacc
     
    org.apache.tools.ant.taskdefs.optional.javah - package org.apache.tools.ant.taskdefs.optional.javah
     
    org.apache.tools.ant.taskdefs.optional.jdepend - package org.apache.tools.ant.taskdefs.optional.jdepend
     
    org.apache.tools.ant.taskdefs.optional.jlink - package org.apache.tools.ant.taskdefs.optional.jlink
     
    org.apache.tools.ant.taskdefs.optional.jsp - package org.apache.tools.ant.taskdefs.optional.jsp
     
    org.apache.tools.ant.taskdefs.optional.jsp.compilers - package org.apache.tools.ant.taskdefs.optional.jsp.compilers
     
    org.apache.tools.ant.taskdefs.optional.junit - package org.apache.tools.ant.taskdefs.optional.junit
     
    org.apache.tools.ant.taskdefs.optional.native2ascii - package org.apache.tools.ant.taskdefs.optional.native2ascii
     
    org.apache.tools.ant.taskdefs.optional.net - package org.apache.tools.ant.taskdefs.optional.net
     
    org.apache.tools.ant.taskdefs.optional.perforce - package org.apache.tools.ant.taskdefs.optional.perforce
    ANT Tasks for Perforce integration.
    org.apache.tools.ant.taskdefs.optional.pvcs - package org.apache.tools.ant.taskdefs.optional.pvcs
     
    org.apache.tools.ant.taskdefs.optional.script - package org.apache.tools.ant.taskdefs.optional.script
     
    org.apache.tools.ant.taskdefs.optional.sos - package org.apache.tools.ant.taskdefs.optional.sos
    + Ant tasks for working with a SourceOffSite source control system.
    org.apache.tools.ant.taskdefs.optional.sound - package org.apache.tools.ant.taskdefs.optional.sound
     
    org.apache.tools.ant.taskdefs.optional.splash - package org.apache.tools.ant.taskdefs.optional.splash
     
    org.apache.tools.ant.taskdefs.optional.ssh - package org.apache.tools.ant.taskdefs.optional.ssh
     
    org.apache.tools.ant.taskdefs.optional.testing - package org.apache.tools.ant.taskdefs.optional.testing
     
    org.apache.tools.ant.taskdefs.optional.unix - package org.apache.tools.ant.taskdefs.optional.unix
     
    org.apache.tools.ant.taskdefs.optional.vss - package org.apache.tools.ant.taskdefs.optional.vss
     
    org.apache.tools.ant.taskdefs.optional.windows - package org.apache.tools.ant.taskdefs.optional.windows
     
    org.apache.tools.ant.taskdefs.rmic - package org.apache.tools.ant.taskdefs.rmic
     
    org.apache.tools.ant.types - package org.apache.tools.ant.types
     
    org.apache.tools.ant.types.mappers - package org.apache.tools.ant.types.mappers
     
    org.apache.tools.ant.types.optional - package org.apache.tools.ant.types.optional
     
    org.apache.tools.ant.types.optional.depend - package org.apache.tools.ant.types.optional.depend
     
    org.apache.tools.ant.types.optional.image - package org.apache.tools.ant.types.optional.image
     
    org.apache.tools.ant.types.resolver - package org.apache.tools.ant.types.resolver
    Ant integration with xml-commons resolver.
    org.apache.tools.ant.types.resources - package org.apache.tools.ant.types.resources
     
    org.apache.tools.ant.types.resources.comparators - package org.apache.tools.ant.types.resources.comparators
     
    org.apache.tools.ant.types.resources.selectors - package org.apache.tools.ant.types.resources.selectors
     
    org.apache.tools.ant.types.selectors - package org.apache.tools.ant.types.selectors
     
    org.apache.tools.ant.types.selectors.modifiedselector - package org.apache.tools.ant.types.selectors.modifiedselector
     
    org.apache.tools.ant.types.spi - package org.apache.tools.ant.types.spi
     
    org.apache.tools.ant.util - package org.apache.tools.ant.util
     
    org.apache.tools.ant.util.depend - package org.apache.tools.ant.util.depend
     
    org.apache.tools.ant.util.depend.bcel - package org.apache.tools.ant.util.depend.bcel
     
    org.apache.tools.ant.util.facade - package org.apache.tools.ant.util.facade
     
    org.apache.tools.ant.util.java15 - package org.apache.tools.ant.util.java15
     
    org.apache.tools.ant.util.optional - package org.apache.tools.ant.util.optional
     
    org.apache.tools.ant.util.regexp - package org.apache.tools.ant.util.regexp
     
    org.apache.tools.bzip2 - package org.apache.tools.bzip2
     
    org.apache.tools.mail - package org.apache.tools.mail
     
    org.apache.tools.tar - package org.apache.tools.tar
     
    org.apache.tools.zip - package org.apache.tools.zip
     
    ORG_JAVACC_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ORG_JJDOC_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ORG_JJTREE_CLASS - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ORG_PACKAGE_3_0 - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    ORG_PACKAGE_3_1 - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    OrSelector - Class in org.apache.tools.ant.types.selectors
    This selector has a collection of other selectors, any of which have to + select a file in order for this selector to select it.
    OrSelector() - +Constructor for class org.apache.tools.ant.types.selectors.OrSelector +
    Default constructor. +
    Os - Class in org.apache.tools.ant.taskdefs.condition
    Condition that tests the OS type.
    Os() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Os +
    Default constructor +
    Os(String) - +Constructor for class org.apache.tools.ant.taskdefs.condition.Os +
    Constructor that sets the family attribute +
    out - +Variable in class org.apache.tools.ant.DefaultLogger +
    PrintStream to write non-error messages to +
    OutErrSummaryJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Used instead of SummaryJUnitResultFormatter in forked tests if + withOutAndErr is requested.
    OutErrSummaryJUnitResultFormatter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.OutErrSummaryJUnitResultFormatter +
    Empty +
    outputLog(String, int) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Log an output message. +
    OutputStreamFunneler - Class in org.apache.tools.ant.util
    Manages a set of OutputStreams to + write to a single underlying stream, which is + closed only when the last "funnel" + has been closed.
    OutputStreamFunneler(OutputStream) - +Constructor for class org.apache.tools.ant.util.OutputStreamFunneler +
    Create a new OutputStreamFunneler for + the specified OutputStream. +
    OutputStreamFunneler(OutputStream, long) - +Constructor for class org.apache.tools.ant.util.OutputStreamFunneler +
    Create a new OutputStreamFunneler for + the specified OutputStream, with the + specified timeout value. +
    overwrite - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    owner - +Variable in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    our owner +
    +
    +

    +P

    +
    +
    P4Add - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Adds specified files to Perforce.
    P4Add() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Add +
      +
    P4Base - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Base class for Perforce (P4) ANT tasks.
    P4Base() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
      +
    P4Change - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Requests a new changelist from the Perforce server.
    P4Change() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
      +
    P4Client - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce Client (eg myclientspec) +
    P4CmdOpts - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce command opts. +
    P4Counter - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Obtains or sets the value of a counter.
    P4Counter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
      +
    P4Delete - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Checkout files for deletion.
    P4Delete() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Delete +
      +
    P4Edit - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Open file(s) for edit.
    P4Edit() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Edit +
      +
    P4Fstat - Class in org.apache.tools.ant.taskdefs.optional.perforce
    P4Fstat--find out which files are under Perforce control and which are not.
    P4Fstat() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
      +
    P4Handler - Interface in org.apache.tools.ant.taskdefs.optional.perforce
    Interface for p4 job output stream handler.
    P4HandlerAdapter - Class in org.apache.tools.ant.taskdefs.optional.perforce
    base class to manage streams around the execution of the Perforce + command line client
    P4HandlerAdapter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
      +
    P4Have - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Lists Perforce files currently on client.
    P4Have() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Have +
      +
    P4Integrate - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Integrate file(s).
    P4Integrate() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
      +
    P4Label - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Creates a new Perforce label and set contents to reflect current + client file revisions.
    P4Label() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
      +
    P4Labelsync - Class in org.apache.tools.ant.taskdefs.optional.perforce
    This method syncs an existing Perforce label against the Perforce client + or against a set of files/revisions.
    P4Labelsync() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
      +
    P4Opts - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce 'global' opts. +
    P4OutputHandler - Interface in org.apache.tools.ant.taskdefs.optional.perforce
    Interface for p4 job output stream handler.
    P4OutputStream - Class in org.apache.tools.ant.taskdefs.optional.perforce
    heavily inspired from LogOutputStream + this stream class calls back the P4Handler on each line of stdout or stderr read
    P4OutputStream(P4Handler) - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream +
    creates a new P4OutputStream for a P4Handler +
    P4Port - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce Server Port (eg KM01:1666) +
    P4Reopen - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Reopen Perforce checkout files between changelists.
    P4Reopen() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen +
      +
    P4Resolve - Class in org.apache.tools.ant.taskdefs.optional.perforce
     
    P4Resolve() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
      +
    P4Revert - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Revert Perforce open files or files in a changelist
    P4Revert() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Revert +
      +
    P4Submit - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Submits a numbered changelist to Perforce.
    P4Submit() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
      +
    P4Submit.P4SubmitAdapter - Class in org.apache.tools.ant.taskdefs.optional.perforce
    internal class used to process the output of p4 submit
    P4Submit.P4SubmitAdapter(P4Base) - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit.P4SubmitAdapter +
    Constructor. +
    P4Sync - Class in org.apache.tools.ant.taskdefs.optional.perforce
    Synchronize client space to a Perforce depot view.
    P4Sync() - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.P4Sync +
      +
    P4User - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce User (eg fbloggs) +
    P4View - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perforce view for commands. +
    pack() - +Method in class org.apache.tools.ant.taskdefs.BZip2 +
    Compress the zipFile. +
    pack() - +Method in class org.apache.tools.ant.taskdefs.GZip +
    perform the GZip compression operation. +
    Pack - Class in org.apache.tools.ant.taskdefs
    Abstract Base class for pack tasks.
    Pack() - +Constructor for class org.apache.tools.ant.taskdefs.Pack +
      +
    pack() - +Method in class org.apache.tools.ant.taskdefs.Pack +
    subclasses must implement this method to do their compression +
    PackageNameMapper - Class in org.apache.tools.ant.util
    Maps directory name matches into a dotted package name.
    PackageNameMapper() - +Constructor for class org.apache.tools.ant.util.PackageNameMapper +
      +
    Parallel - Class in org.apache.tools.ant.taskdefs
    Executes the contained tasks in separate threads, continuing + once all are completed.
    Parallel() - +Constructor for class org.apache.tools.ant.taskdefs.Parallel +
      +
    Parallel.TaskList - Class in org.apache.tools.ant.taskdefs
    Class which holds a list of tasks to execute
    Parallel.TaskList() - +Constructor for class org.apache.tools.ant.taskdefs.Parallel.TaskList +
      +
    Parameter - Class in org.apache.tools.ant.types
    A parameter is composed of a name, type and value.
    Parameter() - +Constructor for class org.apache.tools.ant.types.Parameter +
      +
    Parameterizable - Interface in org.apache.tools.ant.types
    Parameterizable objects take genric key value pairs.
    parameters - +Variable in class org.apache.tools.ant.types.selectors.BaseExtendSelector +
    The passed in parameter array. +
    parentWrapper() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    get the runtime configurable wrapper of the parent project + can return null +
    parse(Project, Object) - +Method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Parse a source xml input. +
    parse(Project, Object, ProjectHelper2.RootHandler) - +Method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Parses the project file, configuring the project as it goes. +
    parse(Project, Object) - +Method in class org.apache.tools.ant.helper.ProjectHelperImpl +
    Parses the project file, configuring the project as it goes. +
    parse(Project, Object) - +Method in class org.apache.tools.ant.ProjectHelper +
    Parses the project file, configuring the project as it goes. +
    parse(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Parse a line into name and value pairs +
    parse(byte[]) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Split the array into ExtraFields and populate them with the + given data as local file data, throwing an exception if the + data cannot be parsed. +
    parse(byte[], boolean) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Split the array into ExtraFields and populate them with the + given data, throwing an exception if the data cannot be parsed. +
    parse(byte[], boolean, ExtraFieldUtils.UnparseableExtraField) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Split the array into ExtraFields and populate them with the + given data. +
    parseAntlibDescriptor(Project, Resource) - +Method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Parse the given URL as an antlib descriptor an return the + content as something that can be turned into an Antlib task. +
    parseAntlibDescriptor(Project, Resource) - +Method in class org.apache.tools.ant.ProjectHelper +
    Parse the given URL as an antlib descriptor and return the + content as something that can be turned into an Antlib task. +
    parseCatalog(String) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalogResolver +
    XMLCatalog calls this to add an external catalog file for each + file within a <catalogfiles> fileset. +
    parseDateFromHeader(String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Parses the string in a format suitable for a SMTP date header. +
    parseDepends(String, String, String) - +Static method in class org.apache.tools.ant.Target +
      +
    parseEjbFiles(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed. +
    parseEjbFiles(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed. +
    parseFromCentralDirectoryData(byte[], int, int) - +Method in interface org.apache.tools.zip.CentralDirectoryParsingZipExtraField +
    Populate data from this array as if it was in central directory data. +
    parseFromCentralDirectoryData(byte[], int, int) - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    Populate data from this array as if it was in central directory data. +
    parseFromCentralDirectoryData(byte[], int, int) - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
      +
    parseFromLocalFileData(byte[], int, int) - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    parseFromLocalFileData(byte[], int, int) - +Method in class org.apache.tools.zip.AsiExtraField +
    Populate data from this array as if it was in local file data. +
    parseFromLocalFileData(byte[], int, int) - +Method in class org.apache.tools.zip.JarMarker +
    Populate data from this array as if it was in local file data. +
    parseFromLocalFileData(byte[], int, int) - +Method in class org.apache.tools.zip.UnparseableExtraFieldData +
    Populate data from this array as if it was in local file data. +
    parseFromLocalFileData(byte[], int, int) - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
      +
    parseFromLocalFileData(byte[], int, int) - +Method in interface org.apache.tools.zip.ZipExtraField +
    Populate data from this array as if it was in local file data. +
    parseHumanSizes(String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Takes a human readable size representation eg 10K + a long value. +
    parseIso8601Date(String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Parse a string as a date using the ISO8601_DATE format which is + yyyy-MM-dd +
    parseIso8601DateTime(String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Parse a string as a datetime using the ISO8601_DATETIME format which is + yyyy-MM-dd'T'HH:mm:ss +
    parseIso8601DateTimeOrDate(String) - +Static method in class org.apache.tools.ant.util.DateUtils +
    Parse a string as a date using the either the ISO8601_DATETIME + or ISO8601_DATE formats. +
    parseName(byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Parse an entry name from a header buffer. +
    ParseNextProperty - Interface in org.apache.tools.ant.property
    Helper for PropertyExpander that can be + used to expand property references to values.
    parseNextProperty(String, ParsePosition) - +Method in interface org.apache.tools.ant.property.ParseNextProperty +
    Return any property that can be parsed from the specified position + in the specified String. +
    parseNextProperty(String, ParsePosition) - +Method in class org.apache.tools.ant.property.ParseProperties +
    Return any property that can be parsed from the specified position + in the specified String. +
    parseOctal(byte[], int, int) - +Static method in class org.apache.tools.tar.TarUtils +
    Parse an octal string from a header buffer. +
    parseOutput(BufferedReader) - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Parse the output of a jikes compiler +
    ParseProperties - Class in org.apache.tools.ant.property
    Parse properties using a collection of expanders.
    ParseProperties(Project, Collection, GetProperty) - +Constructor for class org.apache.tools.ant.property.ParseProperties +
    Constructor with a getProperty. +
    parseProperties(String) - +Method in class org.apache.tools.ant.property.ParseProperties +
    Decode properties from a String representation. +
    parseProperties(String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Decode properties from a String representation. +
    parsePropertyName(String, ParsePosition, ParseNextProperty) - +Method in interface org.apache.tools.ant.property.PropertyExpander +
    Determine whether there is a property reference at the current + ParsePosition and return its name (or null if there is none). +
    parsePropertyString(String, Vector, Vector) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Deprecated. since 1.6.x. + Use PropertyHelper. +
    parsePropertyString(String, Vector, Vector) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. use the other mechanisms of this class instead +
    ParserSupports - Class in org.apache.tools.ant.taskdefs.condition
    Test for the XML parser supporting a particular feature
    ParserSupports() - +Constructor for class org.apache.tools.ant.taskdefs.condition.ParserSupports +
      +
    parseTarHeader(byte[]) - +Method in class org.apache.tools.tar.TarEntry +
    Parse an entry's header information from a header buffer. +
    parseTestMethodNamesList(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Parses a comma-separated list of method names and check their validity. +
    parseUnknownElement(Project, URL) - +Method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Parse an unknown element from a url +
    passesConditions() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Ensures that the selector passes the conditions placed + on it with if and unless. +
    password - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    Patch - Class in org.apache.tools.ant.taskdefs
    Patches a file by applying a 'diff' file to it; requires "patch" to be + on the execution path.
    Patch() - +Constructor for class org.apache.tools.ant.taskdefs.Patch +
      +
    Path - Class in org.apache.tools.ant.types
    This object represents a path as used by CLASSPATH or PATH + environment variable.
    Path(Project, String) - +Constructor for class org.apache.tools.ant.types.Path +
    Invoked by IntrospectionHelper for setXXX(Path p) + attribute setters. +
    Path(Project) - +Constructor for class org.apache.tools.ant.types.Path +
    Construct an empty Path. +
    Path.PathElement - Class in org.apache.tools.ant.types
    Helper class, holds the nested <pathelement> values.
    Path.PathElement() - +Constructor for class org.apache.tools.ant.types.Path.PathElement +
      +
    PathConvert - Class in org.apache.tools.ant.taskdefs
    Converts path and classpath information to a specific target OS + format.
    PathConvert() - +Constructor for class org.apache.tools.ant.taskdefs.PathConvert +
    Construct a new instance of the PathConvert task. +
    PathConvert.MapEntry - Class in org.apache.tools.ant.taskdefs
    Helper class, holds the nested <map> values.
    PathConvert.MapEntry() - +Constructor for class org.apache.tools.ant.taskdefs.PathConvert.MapEntry +
      +
    PathConvert.TargetOs - Class in org.apache.tools.ant.taskdefs
    An enumeration of supported targets: + "windows", "unix", "netware", and "os/2".
    PathConvert.TargetOs() - +Constructor for class org.apache.tools.ant.taskdefs.PathConvert.TargetOs +
      +
    PathTokenizer - Class in org.apache.tools.ant
    A Path tokenizer takes a path and returns the components that make up + that path.
    PathTokenizer(String) - +Constructor for class org.apache.tools.ant.PathTokenizer +
    Constructs a path tokenizer for the specified path. +
    PATTERN_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    PatternSet - Class in org.apache.tools.ant.types
    Named collection of include/exclude tags.
    PatternSet() - +Constructor for class org.apache.tools.ant.types.PatternSet +
    Creates a new PatternSet instance. +
    PatternSet.NameEntry - Class in org.apache.tools.ant.types
    inner class to hold a name on list.
    PatternSet.NameEntry() - +Constructor for class org.apache.tools.ant.types.PatternSet.NameEntry +
      +
    PER_BATCH - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    fork once per batch of tests +
    PER_TEST - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode +
    fork once per test class +
    perform() - +Method in class org.apache.tools.ant.Task +
    Performs this task if it's still valid, or gets a replacement + version and performs that otherwise. +
    performRotate(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.Rotate +
    Rotate an image. +
    performScale(PlanarImage) - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Scale an image. +
    performTasks() - +Method in class org.apache.tools.ant.Target +
    Performs the tasks within this target (if the conditions are met), + firing target started/target finished messages around a call to + execute. +
    PERM_MASK - +Static variable in interface org.apache.tools.zip.UnixStat +
    Bits used for permissions (and sticky bit) +
    Permissions - Class in org.apache.tools.ant.types
    This class implements a security manager meant for usage by tasks that run inside the + Ant VM.
    Permissions() - +Constructor for class org.apache.tools.ant.types.Permissions +
    Create a set of Permissions. +
    Permissions(boolean) - +Constructor for class org.apache.tools.ant.types.Permissions +
    Create a set of permissions. +
    Permissions.Permission - Class in org.apache.tools.ant.types
    Represents a permission.
    Permissions.Permission() - +Constructor for class org.apache.tools.ant.types.Permissions.Permission +
      +
    PLAIN - +Static variable in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Constant to allow the plaintext mailer to be requested +
    PLAIN_FORMATTER_CLASS_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    plain formatter class +
    PlainJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Prints plain text output of the test to a specified Writer.
    PlainJUnitResultFormatter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    No arg constructor +
    PLATFORM_FAT - +Static variable in class org.apache.tools.zip.ZipEntry +
      +
    PLATFORM_UNIX - +Static variable in class org.apache.tools.zip.ZipEntry +
      +
    POLICY_FAIL - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    text value of onerror option "fail" +
    POLICY_FAILALL - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    text value of onerror option "failall" +
    POLICY_IGNORE - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    text value of onerror option "ignore" +
    POLICY_REPORT - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    text value of onerror option "report" +
    popWrapper() - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    remove a runtime configurable wrapper from the stack +
    port - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    postfixLength - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Length of the postfix ("from" pattern). +
    prefix - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    prefixLength - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Length of the prefix ("from" pattern). +
    PrefixLines - Class in org.apache.tools.ant.filters
    Attaches a prefix to every line.
    PrefixLines() - +Constructor for class org.apache.tools.ant.filters.PrefixLines +
    Constructor for "dummy" instances. +
    PrefixLines(Reader) - +Constructor for class org.apache.tools.ant.filters.PrefixLines +
    Creates a new filtered reader. +
    prepareExec() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Create an Execute instance with the correct working directory set. +
    preprocessCompilerArgs(String[]) - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Preprocess the compiler arguments in any way you see fit. +
    preprocessCompilerArgs(String[]) - +Method in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    Strip out all -J args from the command list. +
    preprocessCompilerArgs(String[]) - +Method in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    Strip out all -J args from the command list. +
    PresentSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on whether they appear in another + directory tree.
    PresentSelector() - +Constructor for class org.apache.tools.ant.types.selectors.PresentSelector +
    Creates a new PresentSelector instance. +
    PresentSelector.FilePresence - Class in org.apache.tools.ant.types.selectors
    Enumerated attribute with the values for indicating where a file's + presence is allowed and required.
    PresentSelector.FilePresence() - +Constructor for class org.apache.tools.ant.types.selectors.PresentSelector.FilePresence +
      +
    preserveLastModified - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    PreSetDef - Class in org.apache.tools.ant.taskdefs
    The preset definition task generates a new definition + based on a current definition with some attributes or + elements preset.
    PreSetDef() - +Constructor for class org.apache.tools.ant.taskdefs.PreSetDef +
      +
    PreSetDef.PreSetDefinition - Class in org.apache.tools.ant.taskdefs
    This class contains the unknown element and the object + that is predefined.
    PreSetDef.PreSetDefinition(AntTypeDefinition, UnknownElement) - +Constructor for class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Creates a new PresetDefinition instance. +
    primaryReader - +Variable in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    The primary reader to which the reader chain is to be attached. +
    print(PrintStream) - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Prints the message onto an output stream +
    printChangeLog(PrintWriter, CVSEntry[]) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogWriter +
    Print out the specified entries. +
    printElementDecl(PrintWriter, Project, String, Class) - +Method in interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter +
    Print the definition for a given element. +
    printHead(PrintWriter, Project, Hashtable, Hashtable) - +Method in interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter +
    Prints the header of the generated output. +
    printMessage(String, PrintStream, int) - +Method in class org.apache.tools.ant.DefaultLogger +
    Prints a message to a PrintStream. +
    printMessage(String, PrintStream, int) - +Method in class org.apache.tools.ant.listener.AnsiColorLogger +
    Prints a message to a PrintStream.. +
    printResults(PrintStream) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Deprecated. since 1.6.x. + Use the two arg version instead. +
    printResults(ResultSet, PrintStream) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    print any results in the result set. +
    printTail(PrintWriter) - +Method in interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter +
    Prints the trailer. +
    printTargetDecl(PrintWriter) - +Method in interface org.apache.tools.ant.taskdefs.AntStructure.StructurePrinter +
    Prints the definition for the target element. +
    process(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.perforce.P4Handler +
    processing of one line of stdout or of stderr +
    process(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    subclasses of P4HandlerAdapter must implement this routine + processing of one line of stdout or of stderr +
    process(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.perforce.P4OutputHandler +
    implementations will be able to process lines of output from Perforce +
    process(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit.P4SubmitAdapter +
    process a line of stdout/stderr coming from Perforce +
    process(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.SimpleP4OutputHandler +
    process one line of stderr/stdout + if error conditions are detected, then setters are called on the + parent +
    processBuffer(ByteArrayOutputStream) - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Converts the buffer to a string and sends it to the project. +
    processBuffer() - +Method in class org.apache.tools.ant.taskdefs.LogOutputStream +
    Converts the buffer to a string and sends it to processLine +
    processBuffer() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream +
    Converts the buffer to a string and sends it to processLine +
    processBuffer() - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Converts the buffer to a string and sends it to + processLine +
    processDescriptor(String, SAXParser) - +Method in interface org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool +
    Process a deployment descriptor, generating the necessary vendor specific + deployment files. +
    processDescriptor(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Process a deployment descriptor, generating the necessary vendor specific + deployment files.. +
    processDescriptor(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Process a deployment descriptor, generating the necessary vendor specific + deployment files... +
    processDescriptor(String, SAXParser) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Process a deployment descriptor, generating the necessary vendor specific + deployment files... +
    processDir(File, String[], File, FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Executes all the chained ImageOperations on the files inside + the directory. +
    processElement() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Called when an endelement is seen. +
    processExceptions() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Now faults are analysed. +
    processFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Deprecated. this method isn't used anymore +
    processFile(File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Executes all the chained ImageOperations on the file + specified. +
    processFlush(ByteArrayOutputStream) - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Converts the buffer to a string and sends it to the project. +
    processLine(String) - +Method in class org.apache.tools.ant.taskdefs.LogOutputStream +
    Logs a line to the log system of ant. +
    processLine(String, int) - +Method in class org.apache.tools.ant.taskdefs.LogOutputStream +
    Logs a line to the log system of ant. +
    processLine(String, int) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.JUnitLogOutputStream +
    Logs a line. +
    processLine(String) - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Processes a line. +
    processNode(Node, String, Object) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Process the given node, adding any required attributes from + this child node alone -- but not processing any + children. +
    PROCESSOR_TRAX - +Static variable in class org.apache.tools.ant.taskdefs.XSLTProcess +
    The default processor is trax +
    processSuccess() - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Actions to be taken on a successful waitfor. +
    processTimeout() - +Method in class org.apache.tools.ant.taskdefs.optional.testing.BlockFor +
    If the wait fails, a BuildException is thrown. +
    processTimeout() - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Actions to be taken on an unsuccessful wait. +
    ProfileLogger - Class in org.apache.tools.ant.listener
    This is a special logger that is designed to profile builds.
    ProfileLogger() - +Constructor for class org.apache.tools.ant.listener.ProfileLogger +
      +
    Project - Class in org.apache.tools.ant
    Central representation of an Ant project.
    Project() - +Constructor for class org.apache.tools.ant.Project +
    Create a new Ant project. +
    project - +Variable in class org.apache.tools.ant.ProjectComponent +
    Deprecated. since 1.6.x. + You should not be directly accessing this variable directly. + You should access project object via the getProject() + or setProject() accessor/mutators. +
    project - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    project - +Variable in class org.apache.tools.ant.taskdefs.Jikes +
    Deprecated.   +
    PROJECT_BASEDIR - +Static variable in class org.apache.tools.ant.MagicNames +
    property name for basedir of the project. +
    PROJECT_DEFAULT_TARGET - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the property holding the default target of the + currently executing project, if one has been specified. +
    PROJECT_HELPER_CLASS - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of JVM system property which provides the name of the ProjectHelper class to use. +
    PROJECT_HELPER_SERVICE - +Static variable in class org.apache.tools.ant.MagicNames +
    The service identifier in jars which provide ProjectHelper implementations. +
    PROJECT_INVOKED_TARGETS - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the property holding a comma separated list of targets + that have been invoked (from the command line). +
    PROJECT_LOG - +Static variable in class org.apache.tools.ant.listener.CommonsLoggingListener +
    name of the category under which project events are logged +
    PROJECT_NAME - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the property holding the name of the currently + executing project, if one has been specified. +
    PROJECT_PREFIX - +Static variable in interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd +
    The project prefix +
    PROJECT_PREFIX - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    Dollar Sigh to prefix the project path +
    ProjectComponent - Class in org.apache.tools.ant
    Base class for components of a project, including tasks and data types.
    ProjectComponent() - +Constructor for class org.apache.tools.ant.ProjectComponent +
    Sole constructor. +
    ProjectHelper - Class in org.apache.tools.ant
    Configures a Project (complete with Targets and Tasks) based on + a build file.
    ProjectHelper() - +Constructor for class org.apache.tools.ant.ProjectHelper +
    Default constructor +
    ProjectHelper.OnMissingExtensionPoint - Class in org.apache.tools.ant
    Possible value for target's onMissingExtensionPoint attribute.
    ProjectHelper2 - Class in org.apache.tools.ant.helper
    Sax2 based project reader
    ProjectHelper2() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2 +
      +
    ProjectHelper2.AntHandler - Class in org.apache.tools.ant.helper
    The common superclass for all SAX event handlers used to parse + the configuration file.
    ProjectHelper2.AntHandler() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.AntHandler +
      +
    ProjectHelper2.ElementHandler - Class in org.apache.tools.ant.helper
    Handler for all project elements ( tasks, data types )
    ProjectHelper2.ElementHandler() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.ElementHandler +
    Constructor. +
    ProjectHelper2.MainHandler - Class in org.apache.tools.ant.helper
    The main handler - it handles the <project> tag.
    ProjectHelper2.MainHandler() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.MainHandler +
      +
    ProjectHelper2.ProjectHandler - Class in org.apache.tools.ant.helper
    Handler for the top level "project" element.
    ProjectHelper2.ProjectHandler() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.ProjectHandler +
      +
    ProjectHelper2.RootHandler - Class in org.apache.tools.ant.helper
    Handler for ant processing.
    ProjectHelper2.RootHandler(AntXMLContext, ProjectHelper2.AntHandler) - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Creates a new RootHandler instance. +
    ProjectHelper2.TargetHandler - Class in org.apache.tools.ant.helper
    Handler for "target" and "extension-point" elements.
    ProjectHelper2.TargetHandler() - +Constructor for class org.apache.tools.ant.helper.ProjectHelper2.TargetHandler +
      +
    PROJECTHELPER_REFERENCE - +Static variable in class org.apache.tools.ant.ProjectHelper +
    name of project helper reference that we add to a project +
    ProjectHelperImpl - Class in org.apache.tools.ant.helper
    Original helper.
    ProjectHelperImpl() - +Constructor for class org.apache.tools.ant.helper.ProjectHelperImpl +
    default constructor +
    ProjectHelperRepository - Class in org.apache.tools.ant
    Repository of ProjectHelper found in the classpath or via + some System properties.
    ProjectHelperTask - Class in org.apache.tools.ant.taskdefs
    Task to install project helper into Ant's runtime
    ProjectHelperTask() - +Constructor for class org.apache.tools.ant.taskdefs.ProjectHelperTask +
      +
    prompt(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Prompts a string. +
    promptKeyboardInteractive(String, String, String, String[], boolean[]) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Implementation of UIKeyboardInteractive#promptKeyboardInteractive. +
    promptPassphrase(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Implement the UserInfo interface. +
    promptPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Implement the UserInfo interface. +
    promptYesNo(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Implement the UserInfo interface. +
    PROPERTIES - +Static variable in class org.apache.tools.ant.taskdefs.Definer.Format +
    Enumerated values +
    PROPERTIES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the properties element +
    PropertiesfileCache - Class in org.apache.tools.ant.types.selectors.modifiedselector
    Use java.util.Properties for storing the values.
    PropertiesfileCache() - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Bean-Constructor. +
    PropertiesfileCache(File) - +Constructor for class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Constructor. +
    PROPERTY - +Static variable in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    property +
    PROPERTY - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the property element +
    property - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    name of an optional property +
    Property - Class in org.apache.tools.ant.taskdefs
    Sets a property by name, or set of properties (from file or + resource) in the project.
    Property() - +Constructor for class org.apache.tools.ant.taskdefs.Property +
    Constructor for Property. +
    Property(boolean) - +Constructor for class org.apache.tools.ant.taskdefs.Property +
    Constructor for Property. +
    Property(boolean, Project) - +Constructor for class org.apache.tools.ant.taskdefs.Property +
    Constructor for Property. +
    PROPERTY_NO_NAMESPACE_SCHEMA_LOCATION - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for location of no-name schema +
    PROPERTY_SCHEMA_LOCATION - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    property for location of xml schema +
    PropertyExpander - Interface in org.apache.tools.ant.property
    Responsible for locating a property reference inside a String.
    PropertyFile - Class in org.apache.tools.ant.taskdefs.optional
    Modifies settings in a property file.
    PropertyFile() - +Constructor for class org.apache.tools.ant.taskdefs.optional.PropertyFile +
      +
    PropertyFile.Entry - Class in org.apache.tools.ant.taskdefs.optional
    Instance of this class represents nested elements of + a task propertyfile.
    PropertyFile.Entry() - +Constructor for class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
      +
    PropertyFile.Entry.Operation - Class in org.apache.tools.ant.taskdefs.optional
    Enumerated attribute with the values "+", "-", "="
    PropertyFile.Entry.Operation() - +Constructor for class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
      +
    PropertyFile.Entry.Type - Class in org.apache.tools.ant.taskdefs.optional
    Enumerated attribute with the values "int", "date" and "string".
    PropertyFile.Entry.Type() - +Constructor for class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
      +
    PropertyFile.Unit - Class in org.apache.tools.ant.taskdefs.optional
    Borrowed from Tstamp
    PropertyFile.Unit() - +Constructor for class org.apache.tools.ant.taskdefs.optional.PropertyFile.Unit +
    no arg constructor +
    PropertyFileInputHandler - Class in org.apache.tools.ant.input
    Reads input from a property file, the file name is read from the + system property ant.input.properties, the prompt is the key for input.
    PropertyFileInputHandler() - +Constructor for class org.apache.tools.ant.input.PropertyFileInputHandler +
    Empty no-arg constructor. +
    PropertyHelper - Class in org.apache.tools.ant
    Deals with properties - substitution, dynamic properties, etc.
    PropertyHelper() - +Constructor for class org.apache.tools.ant.PropertyHelper +
    Default constructor. +
    PropertyHelper.Delegate - Interface in org.apache.tools.ant
    Marker interface for a PropertyHelper delegate.
    PropertyHelper.PropertyEvaluator - Interface in org.apache.tools.ant
    Looks up a property's value based on its name.
    PropertyHelper.PropertySetter - Interface in org.apache.tools.ant
    Sets or overrides a property.
    PropertyHelperTask - Class in org.apache.tools.ant.taskdefs
    This task is designed to allow the user to install a different + PropertyHelper on the current Project.
    PropertyHelperTask() - +Constructor for class org.apache.tools.ant.taskdefs.PropertyHelperTask +
      +
    PropertyHelperTask.DelegateElement - Class in org.apache.tools.ant.taskdefs
    Nested delegate for refid usage.
    PropertyOutputStream - Class in org.apache.tools.ant.util
    Exception thrown when an attempt is made to get an OutputStream + from an immutable Resource.
    PropertyOutputStream(Project, String) - +Constructor for class org.apache.tools.ant.util.PropertyOutputStream +
    Construct a new PropertyOutputStream for the specified Project + and property name, trimming the property value. +
    PropertyOutputStream(Project, String, boolean) - +Constructor for class org.apache.tools.ant.util.PropertyOutputStream +
    Construct a new PropertyOutputStream for + the specified Project, property name, and trim mode. +
    PropertyResource - Class in org.apache.tools.ant.types.resources
    Exposes an Ant property as a Resource.
    PropertyResource() - +Constructor for class org.apache.tools.ant.types.resources.PropertyResource +
    Default constructor. +
    PropertyResource(Project, String) - +Constructor for class org.apache.tools.ant.types.resources.PropertyResource +
    Construct a new PropertyResource with the specified name. +
    PropertySet - Class in org.apache.tools.ant.types
    A set of properties.
    PropertySet() - +Constructor for class org.apache.tools.ant.types.PropertySet +
      +
    PropertySet.BuiltinPropertySetName - Class in org.apache.tools.ant.types
    Used for propertyref's builtin attribute.
    PropertySet.BuiltinPropertySetName() - +Constructor for class org.apache.tools.ant.types.PropertySet.BuiltinPropertySetName +
      +
    PropertySet.PropertyRef - Class in org.apache.tools.ant.types
    This is a nested class containing a reference to some properties + and optionally a source of properties.
    PropertySet.PropertyRef() - +Constructor for class org.apache.tools.ant.types.PropertySet.PropertyRef +
      +
    Provider - Class in org.apache.tools.ant.types.spi
    ANT Jar-Task SPI extension + This class corresponds to the nested element + <provider type="type"> in the <service type=""> + nested element of the jar task.
    Provider() - +Constructor for class org.apache.tools.ant.types.spi.Provider +
      +
    ProxyDiagnostics - Class in org.apache.tools.ant.util.java15
    This class exists to create a string that tells diagnostics about the current + state of proxy diagnostics.
    ProxyDiagnostics(String) - +Constructor for class org.apache.tools.ant.util.java15.ProxyDiagnostics +
    create a diagnostics binding for a specific URI +
    ProxyDiagnostics() - +Constructor for class org.apache.tools.ant.util.java15.ProxyDiagnostics +
    create a proxy diagnostics tool bound to + ProxyDiagnostics.DEFAULT_DESTINATION +
    proxyHost - +Variable in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    proxy details +
    proxyPort - +Variable in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    name of proxy port +
    ProxySetup - Class in org.apache.tools.ant.util
    Code to do proxy setup.
    ProxySetup(Project) - +Constructor for class org.apache.tools.ant.util.ProxySetup +
    create a proxy setup class bound to this project +
    PUBLICID_BORLAND_EJB - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Borland 1.1 ejb id +
    PUBLICID_EJB11 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    EJB11 id +
    PUBLICID_EJB11 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    ID for ejb 1.1 +
    PUBLICID_EJB20 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    EJB20 id +
    PUBLICID_EJB20 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    ID for ejb 2.0 +
    PUBLICID_WEBLOGIC_EJB510 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 5.1.0 id +
    PUBLICID_WEBLOGIC_EJB600 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 6.0.0 id +
    PUBLICID_WEBLOGIC_EJB700 - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Weblogic 7.0.0 id +
    PumpStreamHandler - Class in org.apache.tools.ant.taskdefs
    Copies standard output and error of subprocesses to standard output and + error of the parent process.
    PumpStreamHandler(OutputStream, OutputStream, InputStream, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Construct a new PumpStreamHandler. +
    PumpStreamHandler(OutputStream, OutputStream, InputStream) - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Construct a new PumpStreamHandler. +
    PumpStreamHandler(OutputStream, OutputStream) - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Construct a new PumpStreamHandler. +
    PumpStreamHandler(OutputStream) - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Construct a new PumpStreamHandler. +
    PumpStreamHandler() - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Construct a new PumpStreamHandler. +
    PumpStreamHandler.ThreadWithPumper - Class in org.apache.tools.ant.taskdefs
    Specialized subclass that allows access to the running StreamPumper.
    PumpStreamHandler.ThreadWithPumper(StreamPumper) - +Constructor for class org.apache.tools.ant.taskdefs.PumpStreamHandler.ThreadWithPumper +
      +
    pushAndInvokeCircularReferenceCheck(DataType, Stack, Project) - +Static method in class org.apache.tools.ant.types.DataType +
    Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes. +
    pushWrapper(RuntimeConfigurable) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    add a runtime configurable wrapper to the internal stack +
    put(Object, Object) - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Saves a key-value-pair in the cache. +
    put(Object, Object) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Saves a key-value-pair in the cache. +
    put(Object, Object) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    put(Object, Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    putAll(Dictionary, Dictionary) - +Static method in class org.apache.tools.ant.util.CollectionUtils +
    Deprecated. since 1.6.x. +
    putAll(Map) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    putNextEntry(TarEntry) - +Method in class org.apache.tools.tar.TarOutputStream +
    Put an entry on the output stream. +
    putNextEntry(ZipEntry) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Begin writing next entry. +
    Pvcs - Class in org.apache.tools.ant.taskdefs.optional.pvcs
    Extracts the latest edition of the source code from a PVCS repository.
    Pvcs() - +Constructor for class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Creates a Pvcs object +
    PvcsProject - Class in org.apache.tools.ant.taskdefs.optional.pvcs
    represents a project within the PVCS repository to extract files from.
    PvcsProject() - +Constructor for class org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject +
    no arg constructor +
    +
    +

    +Q

    +
    +
    QSORT_STACK_SIZE - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    QUALIFY_ALL - +Static variable in class org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy +
    Qualifies namespaces for elements and attributes. +
    Quantifier - Class in org.apache.tools.ant.types
    EnumeratedAttribute for quantifier comparisons.
    Quantifier() - +Constructor for class org.apache.tools.ant.types.Quantifier +
    Default constructor. +
    Quantifier(String) - +Constructor for class org.apache.tools.ant.types.Quantifier +
    Construct a new Quantifier with the specified value. +
    quoteArgument(String) - +Static method in class org.apache.tools.ant.types.Commandline +
    Put quotes around the given String if necessary. +
    +
    +

    +R

    +
    +
    rcs - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    read() - +Method in class org.apache.tools.ant.DemuxInputStream +
    Read a byte from the project's demuxed input. +
    read(byte[], int, int) - +Method in class org.apache.tools.ant.DemuxInputStream +
    Read bytes from the project's demuxed input. +
    read(char[], int, int) - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Reads characters into a portion of an array. +
    read() - +Method in class org.apache.tools.ant.filters.ClassConstants +
    Reads and assembles the constants declared in a class file. +
    read() - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.EscapeUnicode +
    Returns the next character in the filtered stream, converting non latin + characters to unicode escapes. +
    read() - +Method in class org.apache.tools.ant.filters.ExpandProperties +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Return the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.HeadFilter +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.LineContains +
    Returns the next character in the filtered stream, only including + lines from the original stream which contain all of the specified words. +
    read() - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions. +
    read() - +Method in class org.apache.tools.ant.filters.PrefixLines +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    Returns the next character in the filtered stream, replacing tokens + from the original stream. +
    read() - +Method in class org.apache.tools.ant.filters.SortFilter +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.StripJavaComments +
    Returns the next character in the filtered stream, not including + Java comments. +
    read() - +Method in class org.apache.tools.ant.filters.StripLineBreaks +
    Returns the next character in the filtered stream, only including + characters not in the set of line-breaking characters. +
    read() - +Method in class org.apache.tools.ant.filters.StripLineComments +
    Returns the next character in the filtered stream, only including + lines from the original stream which don't start with any of the + specified comment prefixes. +
    read() - +Method in class org.apache.tools.ant.filters.SuffixLines +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.TabsToSpaces +
    Returns the next character in the filtered stream, converting tabs + to the specified number of spaces. +
    read() - +Method in class org.apache.tools.ant.filters.TailFilter +
    Returns the next character in the filtered stream. +
    read() - +Method in class org.apache.tools.ant.filters.TokenFilter +
    Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions. +
    read(BufferedReader) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Read a section through a reader. +
    read(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.ClassFile +
    Read the class from a data stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo +
    Read the entry from a stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Read the constant pool from a class input stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.DoubleCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FloatCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.IntegerCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.LongCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo +
    read a constant pool entry from a class stream. +
    read(DataInputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo +
    read a constant pool entry from a class stream. +
    read() - +Method in class org.apache.tools.ant.util.ConcatFileInputStream +
    Read a byte. +
    read() - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Read a byte. +
    read() - +Method in class org.apache.tools.ant.util.LeadPipeInputStream +
    Read a byte from the stream. +
    read() - +Method in class org.apache.tools.ant.util.ReaderInputStream +
    Reads from the Reader, returning the same value. +
    read(byte[], int, int) - +Method in class org.apache.tools.ant.util.ReaderInputStream +
    Reads from the Reader into a byte array +
    read() - +Method in class org.apache.tools.bzip2.CBZip2InputStream +
      +
    read(byte[], int, int) - +Method in class org.apache.tools.bzip2.CBZip2InputStream +
      +
    read() - +Method in class org.apache.tools.tar.TarInputStream +
    Reads a byte from the current tar archive entry. +
    read(byte[], int, int) - +Method in class org.apache.tools.tar.TarInputStream +
    Reads bytes from the current tar archive entry. +
    READ - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Read the extra field data into an instance of UnparseableExtraFieldData. +
    READ_KEY - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Key for "read" action. +
    ReadableSelector - Class in org.apache.tools.ant.types.selectors
    A selector that selects readable files.
    ReadableSelector() - +Constructor for class org.apache.tools.ant.types.selectors.ReadableSelector +
      +
    readBuf - +Variable in class org.apache.tools.tar.TarInputStream +
      +
    readEntry(DataInputStream) - +Static method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Read a constant pool entry from a stream. +
    reader - +Variable in class org.apache.tools.mail.SmtpResponseReader +
      +
    readerClassName - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    ReaderInputStream - Class in org.apache.tools.ant.util
    Adapts a Reader as an InputStream.
    ReaderInputStream(Reader) - +Constructor for class org.apache.tools.ant.util.ReaderInputStream +
    Construct a ReaderInputStream + for the specified Reader. +
    ReaderInputStream(Reader, String) - +Constructor for class org.apache.tools.ant.util.ReaderInputStream +
    Construct a ReaderInputStream + for the specified Reader, + with the specified encoding. +
    readFilters() - +Method in class org.apache.tools.ant.taskdefs.Filter +
    Read the filters. +
    readFiltersFromFile(File) - +Method in class org.apache.tools.ant.types.FilterSet +
    Read the filters from the given file. +
    readFully() - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Reads to the end of the stream, returning the contents as a String. +
    readFully(Reader) - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Read data from the reader and return the + contents as a string. +
    readFully(Reader) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Read from reader till EOF. +
    readFully(Reader, int) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Read from reader till EOF. +
    readLine() - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Reads a line of text ending with '\n' (or until the end of the stream). +
    readRecord() - +Method in class org.apache.tools.tar.TarBuffer +
    Read a record from the input stream and return the data. +
    reconfigure(Project) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Reconfigure the element, even if it has already been configured. +
    reconfigure() - +Method in class org.apache.tools.ant.Task +
    Force the task to be reconfigured from its RuntimeConfigurable. +
    record() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Record symlinks. +
    recordBuf - +Variable in class org.apache.tools.tar.TarOutputStream +
      +
    Recorder - Class in org.apache.tools.ant.taskdefs
    Adds a listener to the current build process that records the + output to a file.
    Recorder() - +Constructor for class org.apache.tools.ant.taskdefs.Recorder +
      +
    Recorder.ActionChoices - Class in org.apache.tools.ant.taskdefs
    A list of possible values for the setAction() method.
    Recorder.ActionChoices() - +Constructor for class org.apache.tools.ant.taskdefs.Recorder.ActionChoices +
      +
    Recorder.VerbosityLevelChoices - Class in org.apache.tools.ant.taskdefs
    A list of possible values for the setLoglevel() method.
    Recorder.VerbosityLevelChoices() - +Constructor for class org.apache.tools.ant.taskdefs.Recorder.VerbosityLevelChoices +
      +
    RecorderEntry - Class in org.apache.tools.ant.taskdefs
    This is a class that represents a recorder.
    RecorderEntry(String) - +Constructor for class org.apache.tools.ant.taskdefs.RecorderEntry +
      +
    recreate() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Restore symlinks. +
    recreateSrc() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Recreate src. +
    Rectangle - Class in org.apache.tools.ant.types.optional.image
     
    Rectangle() - +Constructor for class org.apache.tools.ant.types.optional.image.Rectangle +
      +
    redirector - +Variable in class org.apache.tools.ant.taskdefs.ExecTask +
      +
    redirector - +Variable in class org.apache.tools.ant.taskdefs.Java +
      +
    Redirector - Class in org.apache.tools.ant.taskdefs
    The Redirector class manages the setup and connection of input and output + redirection for an Ant project component.
    Redirector(Task) - +Constructor for class org.apache.tools.ant.taskdefs.Redirector +
    Create a redirector instance for the given task +
    Redirector(ProjectComponent) - +Constructor for class org.apache.tools.ant.taskdefs.Redirector +
    Create a redirector instance for the given task +
    redirectorElement - +Variable in class org.apache.tools.ant.taskdefs.ExecTask +
      +
    redirectorElement - +Variable in class org.apache.tools.ant.taskdefs.Java +
      +
    RedirectorElement - Class in org.apache.tools.ant.types
    Element representation of a Redirector.
    RedirectorElement() - +Constructor for class org.apache.tools.ant.types.RedirectorElement +
      +
    ref - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    ref - +Variable in class org.apache.tools.ant.types.DataType +
    Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use DataType.getRefid() instead. +
    Reference - Class in org.apache.tools.ant.types
    Class to hold a reference to another object in the project.
    Reference() - +Constructor for class org.apache.tools.ant.types.Reference +
    Deprecated. since 1.7. + Please use Reference.Reference(Project,String) + instead. +
    Reference(String) - +Constructor for class org.apache.tools.ant.types.Reference +
    Deprecated. since 1.7. + Please use Reference.Reference(Project,String) + instead. +
    Reference(Project, String) - +Constructor for class org.apache.tools.ant.types.Reference +
    Create a reference to a named ID in a particular project. +
    REFID_CLASSPATH_LOADER_PREFIX - +Static variable in class org.apache.tools.ant.MagicNames +
    Prefix used to store classloader references. +
    REFID_CLASSPATH_REUSE_LOADER - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the magic property that controls classloader reuse. +
    REFID_LOCAL_PROPERTIES - +Static variable in class org.apache.tools.ant.MagicNames +
    Reference used to store the local properties. +
    REFID_PROJECT_HELPER - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of ProjectHelper reference that we add to a project. +
    REFID_PROPERTY_HELPER - +Static variable in class org.apache.tools.ant.MagicNames +
    Reference used to store the property helper. +
    REFID_TARGETS - +Static variable in class org.apache.tools.ant.helper.ProjectHelper2 +
    Reference holding the (ordered) target Vector +
    ReflectUtil - Class in org.apache.tools.ant.util
    Utility class to handle reflection on java objects.
    ReflectWrapper - Class in org.apache.tools.ant.util
    Utility class to handle reflection on java objects.
    ReflectWrapper(ClassLoader, String) - +Constructor for class org.apache.tools.ant.util.ReflectWrapper +
    Construct a wrapped object using the no arg constructor. +
    ReflectWrapper(Object) - +Constructor for class org.apache.tools.ant.util.ReflectWrapper +
    Constructor using a passed in object. +
    reg - +Variable in class org.apache.tools.ant.util.RegexpPatternMapper +
      +
    REGEX_KEY - +Static variable in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Used for parameterized custom selector +
    Regexp - Interface in org.apache.tools.ant.util.regexp
    Interface which represents a regular expression, and the operations + that can be performed on it.
    REGEXP_IMPL - +Static variable in class org.apache.tools.ant.MagicNames +
    property for regular expression implementation. +
    RegexpFactory - Class in org.apache.tools.ant.util.regexp
    Regular expression factory, which will create Regexp objects.
    RegexpFactory() - +Constructor for class org.apache.tools.ant.util.regexp.RegexpFactory +
    Constructor for RegexpFactory +
    RegexpMatcher - Interface in org.apache.tools.ant.util.regexp
    Interface describing a regular expression matcher.
    RegexpMatcherFactory - Class in org.apache.tools.ant.util.regexp
    Simple Factory Class that produces an implementation of RegexpMatcher based on the system + property ant.regexp.regexpimpl and the classes available.
    RegexpMatcherFactory() - +Constructor for class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Constructor for RegexpMatcherFactory. +
    regexpMatcherPresent(Project) - +Static method in class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Checks if a RegExp-Matcher is available. +
    RegexpPatternMapper - Class in org.apache.tools.ant.util
    Implementation of FileNameMapper that does regular expression + replacements.
    RegexpPatternMapper() - +Constructor for class org.apache.tools.ant.util.RegexpPatternMapper +
    Constructor for RegexpPatternMapper. +
    RegexpUtil - Class in org.apache.tools.ant.util.regexp
    Regular expression utilities class which handles flag operations.
    RegexpUtil() - +Constructor for class org.apache.tools.ant.util.regexp.RegexpUtil +
      +
    register(Class) - +Static method in class org.apache.tools.zip.ExtraFieldUtils +
    Register a ZipExtraField implementation. +
    registerDTD(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Register a dtd with a location. +
    registerDTD(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    Registers the location of a local DTD file or resource. +
    registerKnownDTDs(DescriptorHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Register the locations of all known DTDs. +
    registerKnownDTDs(DescriptorHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Register the locations of all known DTDs.. +
    registerKnownDTDs(DescriptorHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Register the DTDs. +
    registerProjectHelper(String) - +Method in class org.apache.tools.ant.ProjectHelperRepository +
    Register the specified project helper into the repository. +
    registerProjectHelper(Class) - +Method in class org.apache.tools.ant.ProjectHelperRepository +
    Register the specified project helper into the repository. +
    registerThreadTask(Thread, Task) - +Method in class org.apache.tools.ant.Project +
    Register a task as the current task for a thread. +
    RegularExpression - Class in org.apache.tools.ant.types
    A regular expression datatype.
    RegularExpression() - +Constructor for class org.apache.tools.ant.types.RegularExpression +
    default constructor +
    remove() - +Method in class org.apache.tools.ant.types.resources.FileResourceIterator +
    Not implemented. +
    remove(Object) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    remove(Object) - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    remove(int) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    remove(Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeAll(Collection) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeAllElements() - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeAttribute(String) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Delete an attribute. +
    removeAttribute(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Remove the given attribute from the section +
    removeBuildListener(BuildListener) - +Method in class org.apache.tools.ant.Project +
    Remove a build listener from the list. +
    removeCommandline(Commandline) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    remove a particular command from a vector of command lines +
    removeDefaultExclude(String) - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Remove a string if it is a default exclude. +
    removeDir(File) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Delete a directory +
    removeElement(Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeElementAt(int) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeExtraField(ZipShort) - +Method in class org.apache.tools.zip.ZipEntry +
    Remove an extra field. +
    removeFiles(File, String[], String[]) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    remove an array of files in a directory, and a list of subdirectories + which will only be deleted if 'includeEmpty' is true +
    removeFlag(int, int) - +Static method in class org.apache.tools.ant.util.regexp.RegexpUtil +
    Remove a particular flag from an int value contains the option flags. +
    removeLeadingPath(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Removes a leading path from a second path. +
    removePrefix(String, String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Removes the prefix from a given string, if the string contains + that prefix. +
    removeRange(int, int) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    removeSuffix(String, String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Removes the suffix from a given string, if the string contains + that suffix. +
    removeTimeoutObserver(TimeoutObserver) - +Method in class org.apache.tools.ant.util.Watchdog +
    Remove a timeout observer. +
    removeUnparseableExtraFieldData() - +Method in class org.apache.tools.zip.ZipEntry +
    Removes unparseable extra field data. +
    removeWhitespace(String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    "Flattens" a string by removing all whitespace (space, tab, linefeed, + carriage return, and formfeed). +
    Rename - Class in org.apache.tools.ant.taskdefs
    Deprecated. The rename task is deprecated since Ant 1.2. Use move instead.
    Rename() - +Constructor for class org.apache.tools.ant.taskdefs.Rename +
    Deprecated.   +
    rename(File, File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Renames a file, even if that involves crossing file system boundaries. +
    RenameExtensions - Class in org.apache.tools.ant.taskdefs.optional
    Deprecated. since 1.5.x. + Use <move> instead
    RenameExtensions() - +Constructor for class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. Creates new RenameExtensions +
    renameFile(File, File, boolean, boolean) - +Method in class org.apache.tools.ant.taskdefs.Move +
    Attempts to rename a file from a source to a destination. +
    replace(String, Hashtable) - +Static method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Does replacement on text using the hashtable of keys. +
    Replace - Class in org.apache.tools.ant.taskdefs
    Replaces all occurrences of one or more string tokens with given + values in the indicated files.
    Replace() - +Constructor for class org.apache.tools.ant.taskdefs.Replace +
      +
    replace(String, String, String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Replace occurrences into a string. +
    Replace.NestedString - Class in org.apache.tools.ant.taskdefs
    An inline string to use as the replacement text.
    Replace.NestedString() - +Constructor for class org.apache.tools.ant.taskdefs.Replace.NestedString +
      +
    Replace.Replacefilter - Class in org.apache.tools.ant.taskdefs
    A filter to apply.
    Replace.Replacefilter() - +Constructor for class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
      +
    REPLACE_ALL - +Static variable in interface org.apache.tools.ant.util.regexp.Regexp +
    Replace all occurrences of the regular expression +
    REPLACE_FIRST - +Static variable in interface org.apache.tools.ant.util.regexp.Regexp +
    Replace only the first occurrence of the regular expression +
    replaceContextLoader() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Replace the current context classloader with the + script context classloader. +
    replaceProperties(String) - +Method in class org.apache.tools.ant.Project +
    Replace ${} style constructions in the given value with the + string value of the corresponding data types. +
    replaceProperties(Project, String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Deprecated. since 1.6.x. + Use project.replaceProperties(). +
    replaceProperties(Project, String, Hashtable) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Deprecated. since 1.6.x. + Use PropertyHelper. +
    replaceProperties(String, String, Hashtable) - +Method in class org.apache.tools.ant.PropertyHelper +
    Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types. +
    replaceProperties(String) - +Method in class org.apache.tools.ant.PropertyHelper +
    Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types. +
    replaceReferences(String) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Replace all backreferences in the to pattern with the matched + groups of the source. +
    ReplaceRegExp - Class in org.apache.tools.ant.taskdefs.optional
    Performs regular expression string replacements in a text + file.
    ReplaceRegExp() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Default Constructor +
    replaceString(String, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Replace occurances of a string with a replacement string. +
    ReplaceTokens - Class in org.apache.tools.ant.filters
    Replaces tokens in the original input with user-supplied values.
    ReplaceTokens() - +Constructor for class org.apache.tools.ant.filters.ReplaceTokens +
    Constructor for "dummy" instances. +
    ReplaceTokens(Reader) - +Constructor for class org.apache.tools.ant.filters.ReplaceTokens +
    Creates a new filtered reader. +
    replaceTokens(String) - +Method in class org.apache.tools.ant.types.FilterSet +
    Does replacement on the given string with token matching. +
    replaceTokens(String) - +Method in class org.apache.tools.ant.types.FilterSetCollection +
    Does replacement on the given string with token matching. +
    ReplaceTokens.Token - Class in org.apache.tools.ant.filters
    Holds a token
    ReplaceTokens.Token() - +Constructor for class org.apache.tools.ant.filters.ReplaceTokens.Token +
      +
    replyto(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the replyto address + This method may be + called multiple times. +
    replyToList - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    REPORT - +Static variable in class org.apache.tools.ant.taskdefs.Definer.OnError +
    Enumerated values +
    REPOSITORY_DIR_PROPERTY - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the property which can provide an override of the repository dir. +
    REPOSITORY_URL_PROPERTY - +Static variable in class org.apache.tools.ant.MagicNames +
    Name of the property which can provide an override of the repository URL. +
    REQUIRE_IMPLEMENTATION_CHANGE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Enum indicating that extension requires an upgrade + of implementation to be compatible with other Package Specification. +
    REQUIRE_IMPLEMENTATION_UPGRADE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Enum indicating that extension requires an upgrade + of implementation to be compatible with other extension. +
    REQUIRE_SPECIFICATION_UPGRADE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Enum indicating that extension requires an upgrade + of specification to be compatible with other extension. +
    REQUIRE_SPECIFICATION_UPGRADE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Enum indicating that extension requires an upgrade + of specification to be compatible with other Package Specification. +
    REQUIRE_VENDOR_SWITCH - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Enum indicating that extension requires a vendor + switch to be compatible with other extension. +
    REQUIRE_VENDOR_SWITCH - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Enum indicating that extension requires a vendor + switch to be compatible with other Package Specification. +
    reset() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Reset state to default. +
    reset() - +Method in class org.apache.tools.ant.taskdefs.Jar +
    reset to default values. +
    reset() - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Makes this instance reset all attributes to their default + values and forget all children. +
    reset() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Reset the dependency list. +
    reset() - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Reset the dependency list. +
    reset() - +Method in class org.apache.tools.ant.util.ReaderInputStream +
    Resets the Reader. +
    reset() - +Method in class org.apache.tools.tar.TarInputStream +
    Since we do not support marking just yet, we do nothing. +
    resetDefaultExcludes() - +Static method in class org.apache.tools.ant.DirectoryScanner +
    Go back to the hardwired default exclude patterns. +
    resetFileLists() - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Clear the list of files to be compiled and copied.. +
    resetFileLists() - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Clear the list of files to be compiled and copied.. +
    resetThreadContextLoader() - +Method in class org.apache.tools.ant.AntClassLoader +
    Resets the current thread's context loader to its original value. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo +
    Resolve this class info against the given constant pool. +
    resolve() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Resolve the entries in the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(ConstantPool) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo +
    Resolve this constant pool entry with respect to its dependents in + the constant pool. +
    resolve(Extension, Project) - +Method in interface org.apache.tools.ant.taskdefs.optional.extension.ExtensionResolver +
    Attempt to locate File that satisfies + extension via resolver. +
    resolve(Extension, Project) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
    Returns the resolved file +
    resolve(Extension, Project) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver +
    Returns the resolved file +
    resolve(Extension, Project) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
    Returns the file resolved from URL and directory +
    resolve(String, String) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Implements the URIResolver.resolve() interface method. +
    resolveAllProperties(Map) - +Method in class org.apache.tools.ant.property.ResolvePropertyMap +
    Deprecated. since Ant 1.8.2, use the three-arg method instead. +
    resolveAllProperties(Map, String) - +Method in class org.apache.tools.ant.property.ResolvePropertyMap +
    Deprecated. since Ant 1.8.2, use the three-arg method instead. +
    resolveAllProperties(Map, String, boolean) - +Method in class org.apache.tools.ant.property.ResolvePropertyMap +
    The action method - resolves all the properties in a map. +
    resolveBackSlash(String) - +Static method in class org.apache.tools.ant.filters.TokenFilter +
    xml does not do "c" like interpretation of strings. +
    resolveBackSlash(String) - +Static method in class org.apache.tools.ant.util.StringUtils +
    xml does not do "c" like interpretation of strings. +
    resolveEntity(String, String) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Resolves file: URIs relative to the build file. +
    resolveEntity(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    Resolve the entity. +
    resolveEntity(String, String) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Implements the EntityResolver.resolveEntity() interface method. +
    resolveExecutable(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    The method attempts to figure out where the executable is so that we can feed + the full path. +
    resolveFile(String, File) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    resolveFile(String) - +Method in class org.apache.tools.ant.Project +
    Return the canonical form of a filename. +
    resolveFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Correct a file path to correspond to the remote host requirements. +
    resolveFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Correct a file path to correspond to the remote host requirements. +
    resolveFile(File, String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Interpret the filename as a file relative to the given file + unless the filename already represents an absolute filename. +
    ResolvePropertyMap - Class in org.apache.tools.ant.property
    Class to resolve properties in a map.
    ResolvePropertyMap(Project, GetProperty, Collection) - +Constructor for class org.apache.tools.ant.property.ResolvePropertyMap +
    Constructor with a master getproperty and a collection of expanders. +
    resource - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    Resource - Class in org.apache.tools.ant.types
    Describes a "File-like" resource (File, ZipEntry, etc.).
    Resource() - +Constructor for class org.apache.tools.ant.types.Resource +
    Default constructor. +
    Resource(String) - +Constructor for class org.apache.tools.ant.types.Resource +
    Only sets the name. +
    Resource(String, boolean, long) - +Constructor for class org.apache.tools.ant.types.Resource +
    Sets the name, lastmodified flag, and exists flag. +
    Resource(String, boolean, long, boolean) - +Constructor for class org.apache.tools.ant.types.Resource +
    Sets the name, lastmodified flag, exists flag, and directory flag. +
    Resource(String, boolean, long, boolean, long) - +Constructor for class org.apache.tools.ant.types.Resource +
    Sets the name, lastmodified flag, exists flag, directory flag, and size. +
    ResourceCollection - Interface in org.apache.tools.ant.types
    Interface describing a collection of Resources.
    ResourceComparator - Class in org.apache.tools.ant.types.resources.comparators
    Abstract Resource Comparator.
    ResourceComparator() - +Constructor for class org.apache.tools.ant.types.resources.comparators.ResourceComparator +
      +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Content +
    Compare two Resources by content. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Date +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Exists +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.FileSystem +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Name +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.ResourceComparator +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Reverse +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Size +
    Compare two Resources. +
    resourceCompare(Resource, Resource) - +Method in class org.apache.tools.ant.types.resources.comparators.Type +
    Compare two Resources. +
    ResourceContains - Class in org.apache.tools.ant.taskdefs.condition
    <resourcecontains> + Is a string contained in a resource (file currently)?
    ResourceContains() - +Constructor for class org.apache.tools.ant.taskdefs.condition.ResourceContains +
      +
    ResourceCount - Class in org.apache.tools.ant.taskdefs
    Count resources from a ResourceCollection, storing to a property or + writing to the log.
    ResourceCount() - +Constructor for class org.apache.tools.ant.taskdefs.ResourceCount +
      +
    ResourceDecorator - Class in org.apache.tools.ant.types.resources
    Abstract class that delegates all reading methods of Resource to + its wrapped resource and deals with reference handling.
    ResourceDecorator() - +Constructor for class org.apache.tools.ant.types.resources.ResourceDecorator +
    no arg constructor +
    ResourceDecorator(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.ResourceDecorator +
    Constructor with another resource to wrap. +
    ResourceExists - Class in org.apache.tools.ant.taskdefs.condition
    Condition that checks whether a given resource exists.
    ResourceExists() - +Constructor for class org.apache.tools.ant.taskdefs.condition.ResourceExists +
      +
    ResourceFactory - Interface in org.apache.tools.ant.types
    this interface should be implemented by classes (Scanners) needing + to deliver information about resources.
    ResourceList - Class in org.apache.tools.ant.types.resources
    Reads a resource as text document and creates a resource for each + line.
    ResourceList() - +Constructor for class org.apache.tools.ant.types.resources.ResourceList +
      +
    ResourceLocation - Class in org.apache.tools.ant.types
    Helper class to handle the <dtd> and + <entity> nested elements.
    ResourceLocation() - +Constructor for class org.apache.tools.ant.types.ResourceLocation +
      +
    Resources - Class in org.apache.tools.ant.types.resources
    Generic ResourceCollection: Either stores nested ResourceCollections, + making no attempt to remove duplicates, or references another ResourceCollection.
    Resources() - +Constructor for class org.apache.tools.ant.types.resources.Resources +
    Create a new Resources. +
    Resources(Project) - +Constructor for class org.apache.tools.ant.types.resources.Resources +
    Create a new Resources. +
    ResourceSelector - Interface in org.apache.tools.ant.types.resources.selectors
    Interface for a Resource selector.
    ResourceSelectorContainer - Class in org.apache.tools.ant.types.resources.selectors
    ResourceSelector container.
    ResourceSelectorContainer() - +Constructor for class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Default constructor. +
    ResourceSelectorContainer(ResourceSelector[]) - +Constructor for class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Construct a new ResourceSelectorContainer with the specified array of selectors. +
    ResourcesMatch - Class in org.apache.tools.ant.taskdefs.condition
    Compares resources for equality based on size and content.
    ResourcesMatch() - +Constructor for class org.apache.tools.ant.taskdefs.condition.ResourcesMatch +
      +
    ResourceUtils - Class in org.apache.tools.ant.util
    This class provides utility methods to process Resources.
    ResourceUtils() - +Constructor for class org.apache.tools.ant.util.ResourceUtils +
      +
    ResourceUtils.ResourceSelectorProvider - Interface in org.apache.tools.ant.util
     
    respondsTo(Object, String) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    A method to test if an object responds to a given + message (method call) +
    restoreContextLoader(ClassLoader) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Restore the context loader with the original context classloader. +
    restoreSecurityManager() - +Method in class org.apache.tools.ant.types.Permissions +
    To be used by tasks that just finished executing the parts subject to these permissions. +
    restoreSystem() - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Restore the system properties to the cached value. +
    restoreSystemProperties() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Restore the cached system properties. +
    Restrict - Class in org.apache.tools.ant.types.resources
    ResourceCollection that allows a number of selectors to be + applied to a single ResourceCollection for the purposes of + restricting or narrowing results.
    Restrict() - +Constructor for class org.apache.tools.ant.types.resources.Restrict +
      +
    restrict(String[], File, File, FileNameMapper) - +Method in class org.apache.tools.ant.util.SourceFileScanner +
    Restrict the given set of files to those that are newer than + their corresponding target files. +
    restrict(String[], File, File, FileNameMapper, long) - +Method in class org.apache.tools.ant.util.SourceFileScanner +
    Restrict the given set of files to those that are newer than + their corresponding target files. +
    restrictAsFiles(String[], File, File, FileNameMapper) - +Method in class org.apache.tools.ant.util.SourceFileScanner +
    Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute). +
    restrictAsFiles(String[], File, File, FileNameMapper, long) - +Method in class org.apache.tools.ant.util.SourceFileScanner +
    Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute). +
    result - +Variable in class org.apache.tools.ant.util.RegexpPatternMapper +
      +
    retainAll(Collection) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    rethrowAnyBuildException() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Raise an exception if one was caught +
    retry() - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Indicates whether a retry was done. +
    Retry - Class in org.apache.tools.ant.taskdefs
    Retries the nested task a set number of times
    Retry() - +Constructor for class org.apache.tools.ant.taskdefs.Retry +
      +
    RETRY_FOREVER - +Static variable in interface org.apache.tools.ant.util.Retryable +
    The value to use to never give up. +
    Retryable - Interface in org.apache.tools.ant.util
    Simple interface for executing a piece of code.
    RetryHandler - Class in org.apache.tools.ant.util
    A simple utility class to take a piece of code (that implements + Retryable interface) and executes that with possibility to + retry the execution in case of IOException.
    RetryHandler(int, Task) - +Constructor for class org.apache.tools.ant.util.RetryHandler +
    Create a new RetryingHandler. +
    REUSE_LOADER_REF - +Static variable in class org.apache.tools.ant.util.ClasspathUtils +
    Name of the magic property that controls classloader reuse in Ant 1.4. +
    Reverse - Class in org.apache.tools.ant.types.resources.comparators
    Reverses another ResourceComparator.
    Reverse() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Reverse +
    Default constructor. +
    Reverse(ResourceComparator) - +Constructor for class org.apache.tools.ant.types.resources.comparators.Reverse +
    Construct a new Reverse, supplying the ResourceComparator to be reversed. +
    RExecTask - Class in org.apache.tools.ant.taskdefs.optional.net
    Automates the rexec protocol.
    RExecTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
      +
    RExecTask.AntRExecClient - Class in org.apache.tools.ant.taskdefs.optional.net
    This class handles the abstraction of the rexec protocol.
    RExecTask.AntRExecClient() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient +
      +
    RExecTask.RExecRead - Class in org.apache.tools.ant.taskdefs.optional.net
    Reads the output from the connected server + until the required string is found or we time out.
    RExecTask.RExecRead() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecRead +
      +
    RExecTask.RExecSubTask - Class in org.apache.tools.ant.taskdefs.optional.net
    This class is the parent of the Read and Write tasks.
    RExecTask.RExecSubTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask +
      +
    RExecTask.RExecWrite - Class in org.apache.tools.ant.taskdefs.optional.net
    Sends text to the connected server
    RExecTask.RExecWrite() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecWrite +
      +
    RM_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    RM_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    rmDir(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Delete a directory, if empty, from the remote host. +
    rmDir(FTPClient, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Delete a directory, if empty, from the remote host. +
    RMI_ORB - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    RMI ORB. +
    RMI_SKEL_SUFFIX - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    suffix denoting a skel file: "_Skel" +
    RMI_STUB_SUFFIX - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    suffix denoting a stub file: "_Stub" +
    RMI_TIE_SUFFIX - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    suffix denoting a tie file: "_Tie" +
    Rmic - Class in org.apache.tools.ant.taskdefs
    Runs the rmic compiler against classes.
    Rmic() - +Constructor for class org.apache.tools.ant.taskdefs.Rmic +
    Constructor for Rmic. +
    Rmic.ImplementationSpecificArgument - Class in org.apache.tools.ant.taskdefs
    Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation.
    Rmic.ImplementationSpecificArgument() - +Constructor for class org.apache.tools.ant.taskdefs.Rmic.ImplementationSpecificArgument +
      +
    RMIC_CLASSNAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    name of the class +
    RMIC_EXECUTABLE - +Static variable in class org.apache.tools.ant.taskdefs.rmic.SunRmic +
    name of the executable +
    RmicAdapter - Interface in org.apache.tools.ant.taskdefs.rmic
    The interface that all rmic adapters must adhere to.
    RmicAdapterFactory - Class in org.apache.tools.ant.taskdefs.rmic
    Creates the necessary rmic adapter, given basic criteria.
    rNums - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
    This array really shouldn't be here. +
    Rotate - Class in org.apache.tools.ant.types.optional.image
    ImageOperation to rotate an image by a certain degree
    Rotate() - +Constructor for class org.apache.tools.ant.types.optional.image.Rotate +
      +
    ROW - +Static variable in class org.apache.tools.ant.taskdefs.SQLExec.DelimiterType +
    The enumerated strings +
    Rpm - Class in org.apache.tools.ant.taskdefs.optional
    Invokes the rpm tool to build a Linux installation file.
    Rpm() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Rpm +
      +
    rtrimWildcardTokens(String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    removes from a pattern all tokens to the right containing wildcards +
    rtrimWildcardTokens() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Returns a new TokenizedPath where all tokens of this pattern to + the right containing wildcards have been removed +
    run(String) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Execute the command. +
    run() - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Run this ExecuteJava in a Thread. +
    run(String, Vector) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Executes the given classname with the given arguments as if it + were a command line application. +
    run(Commandline, ExecuteStreamHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Run the command. +
    run(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Run the command. +
    run(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Execute the given command are return success or failure +
    run(TestResult) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    run() - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Run the test. +
    run() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Run the test. +
    run(Commandline, ProjectComponent) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii +
    Executes the command. +
    run(Commandline, ProjectComponent) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii +
    Executes the command. +
    run(Commandline, ProjectComponent) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii +
    Executes the command. +
    run(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Execute the created command line. +
    run() - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    Copies data from the input stream to the output stream. +
    run() - +Method in class org.apache.tools.ant.util.Watchdog +
    The run method of the watch dog thread. +
    run() - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Run the task, which is skipped if null. +
    RUNA - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    RUNB - +Static variable in interface org.apache.tools.bzip2.BZip2Constants +
      +
    runCmd(Commandline, ExecuteStreamHandler) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Run the command. +
    runCommand(Commandline) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Sets up the environment for toExecute and then runs it. +
    runCommand(Task, String[]) - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    A utility method that runs an external command. +
    runCount() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Get the number of runs. +
    runExec(Execute) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Run the command using the given Execute instance. +
    runExec(Execute) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Run the specified Execute object. +
    runExecute(Execute) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    A Utility method for this classes and subclasses to run an + Execute instance (an external command). +
    runParallel(Execute, Vector, Vector) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Run the command in "parallel" mode, making sure that at most + maxParallel sourcefiles get passed on the command line. +
    runS(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Execute the given command, and return it's output +
    runStatements(Reader, PrintStream) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    read in lines and execute them +
    RuntimeConfigurable - Class in org.apache.tools.ant
    Wrapper class that holds the attributes of an element, its children, and + any text within it.
    RuntimeConfigurable(Object, String) - +Constructor for class org.apache.tools.ant.RuntimeConfigurable +
    Sole constructor creating a wrapper for the specified object. +
    +
    +

    +S

    +
    +
    safeReadFully(Reader) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Safe read fully - do not return a null for an empty reader. +
    sameDefinition(AntTypeDefinition, Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Equality method for this definition (assumes the names are the same). +
    sameDefinition(Object) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Equality method for this definition +
    sameDefinition(AntTypeDefinition, Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Equality method for this definition. +
    save() - +Method in interface org.apache.tools.ant.types.selectors.modifiedselector.Cache +
    Saves modification of the cache. +
    save() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Saves modification of the cache. +
    saveAs(File) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
    Save the properties to a file. +
    saveCache() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    save the cache file +
    saveProperties(Hashtable, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Send the key/value pairs in the hashtable to the given output stream. +
    Scale - Class in org.apache.tools.ant.types.optional.image
     
    Scale() - +Constructor for class org.apache.tools.ant.types.optional.image.Scale +
      +
    Scale.ProportionsAttribute - Class in org.apache.tools.ant.types.optional.image
    Enumerated class for proportions attribute.
    Scale.ProportionsAttribute() - +Constructor for class org.apache.tools.ant.types.optional.image.Scale.ProportionsAttribute +
      +
    scan() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Scan for files which match at least one include pattern and don't match + any exclude patterns. +
    scan() - +Method in interface org.apache.tools.ant.FileScanner +
    Scans the base directory for files which match at least one include + pattern and don't match any exclude patterns. +
    scan(File, File, String[], String[]) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Compares source files to destination files to see if they should be + copied. +
    scan(Resource[], File) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Compares source resources to destination files to see if they + should be copied. +
    scan() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
    scans the remote directory, + storing internally the included files, directories, ... +
    scan() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
    scans the remote directory, + storing internally the included files, directories, ... +
    scan(File, File, String[], String[]) - +Method in class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Compares source files to destination files to see if they should be + copied. +
    scan(Resource[], File) - +Method in class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Compares source resources to destination files to see if they + should be copied. +
    scan() - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Don't scan when we have no zipfile. +
    scan() - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Scans the base directory for files on which baseClass depends. +
    scandir(File, String, boolean) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Scan the given directory for files and directories. +
    scanDir(File, File, String[]) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Scans the directory looking for source files to be compiled. +
    scanDir(File, String[]) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Scans the directory looking for source files that are newer than + their class files. +
    scanDir(File, File, JspMangler, String[]) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Scans the directory looking for source files to be compiled. +
    scanDir(String[]) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Scan the array of files and add the jsp + files that need to be compiled to the filesToDo field. +
    scandir(String, String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner +
    scans a particular directory. +
    scandir(String, String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner +
    scans a particular directory. +
    scanDir(File, String[], FileNameMapper) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Scans the directory looking for class files to be compiled. +
    scanDir(File, String[]) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    Scan a directory for files to check for "up to date"ness +
    SCHEMA_DIR - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Schema directory +
    SchemaValidate - Class in org.apache.tools.ant.taskdefs.optional
    Validate XML Schema documents.
    SchemaValidate() - +Constructor for class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
      +
    SchemaValidate.SchemaLocation - Class in org.apache.tools.ant.taskdefs.optional
    representation of a schema location.
    SchemaValidate.SchemaLocation() - +Constructor for class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    No arg constructor +
    Scp - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Ant task for sending files to remote machine over ssh/scp.
    Scp() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
      +
    ScpFromMessage - Class in org.apache.tools.ant.taskdefs.optional.ssh
    A helper object representing an scp download.
    ScpFromMessage(Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Constructor for ScpFromMessage +
    ScpFromMessage(boolean, Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Constructor for ScpFromMessage +
    ScpFromMessage(boolean, Session, String, File, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Constructor for ScpFromMessage. +
    ScpFromMessage(Session, String, File, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Constructor for ScpFromMessage. +
    ScpFromMessage(boolean, Session, String, File, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage +
    Constructor for ScpFromMessage. +
    ScpFromMessageBySftp - Class in org.apache.tools.ant.taskdefs.optional.ssh
    A helper object representing an scp download.
    ScpFromMessageBySftp(boolean, Session, String, File, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp +
    Constructor for ScpFromMessageBySftp. +
    ScpFromMessageBySftp(Session, String, File, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp +
    Constructor for ScpFromMessageBySftp. +
    ScpFromMessageBySftp(boolean, Session, String, File, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp +
    Constructor for ScpFromMessageBySftp. +
    ScpToMessage - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Utility class to carry out an upload scp transfer.
    ScpToMessage(Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for ScpToMessage +
    ScpToMessage(boolean, Session) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for ScpToMessage +
    ScpToMessage(boolean, Session, File, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for a local file to remote. +
    ScpToMessage(boolean, Session, List, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for a local directories to remote. +
    ScpToMessage(Session, File, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for ScpToMessage. +
    ScpToMessage(Session, List, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage +
    Constructor for ScpToMessage. +
    ScpToMessageBySftp - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Utility class to carry out an upload by sftp.
    ScpToMessageBySftp(boolean, Session, File, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Constructor for a local file to remote. +
    ScpToMessageBySftp(boolean, Session, List, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Constructor for a local directories to remote. +
    ScpToMessageBySftp(Session, File, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Constructor for ScpToMessage. +
    ScpToMessageBySftp(Session, List, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp +
    Constructor for ScpToMessage. +
    Script - Class in org.apache.tools.ant.taskdefs.optional
    Executes a script.
    Script() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Script +
      +
    SCRIPT_REPOSITORY - +Static variable in class org.apache.tools.ant.MagicNames +
    The name of the script repository used by the script repo task. +
    ScriptCondition - Class in org.apache.tools.ant.types.optional
    A condition that lets you include script.
    ScriptCondition() - +Constructor for class org.apache.tools.ant.types.optional.ScriptCondition +
      +
    ScriptDef - Class in org.apache.tools.ant.taskdefs.optional.script
    Define a task using a script
    ScriptDef() - +Constructor for class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
      +
    ScriptDef.Attribute - Class in org.apache.tools.ant.taskdefs.optional.script
    Class representing an attribute definition
    ScriptDef.Attribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.Attribute +
      +
    ScriptDef.NestedElement - Class in org.apache.tools.ant.taskdefs.optional.script
    Class to represent a nested element definition
    ScriptDef.NestedElement() - +Constructor for class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement +
      +
    ScriptDefBase - Class in org.apache.tools.ant.taskdefs.optional.script
    The script execution class.
    ScriptDefBase() - +Constructor for class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
      +
    ScriptFilter - Class in org.apache.tools.ant.types.optional
    Most of this is CAP (Cut And Paste) from the Script task + ScriptFilter class, implements TokenFilter.Filter + for scripts to use.
    ScriptFilter() - +Constructor for class org.apache.tools.ant.types.optional.ScriptFilter +
      +
    ScriptFixBSFPath - Class in org.apache.tools.ant.util
    A class to modify a classloader to + support BSF language support.
    ScriptFixBSFPath() - +Constructor for class org.apache.tools.ant.util.ScriptFixBSFPath +
      +
    ScriptMapper - Class in org.apache.tools.ant.types.optional
    Script support at map time.
    ScriptMapper() - +Constructor for class org.apache.tools.ant.types.optional.ScriptMapper +
      +
    ScriptRunner - Class in org.apache.tools.ant.util.optional
    This class is used to run BSF scripts
    ScriptRunner() - +Constructor for class org.apache.tools.ant.util.optional.ScriptRunner +
      +
    ScriptRunner - Class in org.apache.tools.ant.util
    Deprecated. Implementation moved to another location. Use + that org.apache.tools.ant.types.optional.ScriptRunner instead.
    ScriptRunner() - +Constructor for class org.apache.tools.ant.util.ScriptRunner +
    Deprecated.   +
    ScriptRunnerBase - Class in org.apache.tools.ant.util
    This is a common abstract base case for script runners.
    ScriptRunnerBase() - +Constructor for class org.apache.tools.ant.util.ScriptRunnerBase +
      +
    ScriptRunnerCreator - Class in org.apache.tools.ant.util
    This is a helper class used by ScriptRunnerHelper to + create a ScriptRunner based on a classloader and on a language.
    ScriptRunnerCreator(Project) - +Constructor for class org.apache.tools.ant.util.ScriptRunnerCreator +
    Constructor for creator. +
    ScriptRunnerHelper - Class in org.apache.tools.ant.util
    A class to help in creating, setting and getting script runners.
    ScriptRunnerHelper() - +Constructor for class org.apache.tools.ant.util.ScriptRunnerHelper +
      +
    ScriptSelector - Class in org.apache.tools.ant.types.optional
    Selector that lets you run a script with selection logic inline
    ScriptSelector() - +Constructor for class org.apache.tools.ant.types.optional.ScriptSelector +
      +
    SECOND - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    second string +
    sectionsonly - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    sign sections only? +
    SecureInputHandler - Class in org.apache.tools.ant.input
    Prompts and requests input.
    SecureInputHandler() - +Constructor for class org.apache.tools.ant.input.SecureInputHandler +
    Default no-args constructor +
    selectDirectoryResources(Resource[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Drops all non-directory resources from the given array. +
    selectFileResources(Resource[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Drops all non-file resources from the given array. +
    selectionTest(File, File) - +Method in class org.apache.tools.ant.types.selectors.DependSelector +
    this test is our selection test that compared the file with the destfile +
    selectionTest(File, File) - +Method in class org.apache.tools.ant.types.selectors.DifferentSelector +
    this test is our selection test that compared the file with the destfile +
    selectionTest(File, File) - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    this test is our selection test that compared the file with the destfile +
    SelectorContainer - Interface in org.apache.tools.ant.types.selectors
    This is the interface for selectors that can contain other selectors.
    selectorCount() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Gives the count of the number of selectors in this container +
    selectorCount() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Gives the count of the number of selectors in this container. +
    selectorCount() - +Method in class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer +
    Get the count of nested selectors. +
    selectorCount() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Gives the count of the number of selectors in this container +
    selectorCount() - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Gives the count of the number of selectors in this container +
    selectorCount() - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    Gives the count of the number of selectors in this container +
    selectorCount() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Gives the count of the number of selectors in this container +
    selectorCreate() - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Instantiates the identified custom selector class. +
    selectorElements() - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Returns an enumerator for accessing the set of selectors. +
    selectorElements() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Returns an enumerator for accessing the set of selectors. +
    selectorElements() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Returns an enumerator for accessing the set of selectors. +
    selectorElements() - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Returns an enumerator for accessing the set of selectors. +
    selectorElements() - +Method in interface org.apache.tools.ant.types.selectors.SelectorContainer +
    Returns an enumerator for accessing the set of selectors. +
    selectorElements() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Returns an enumerator for accessing the set of selectors. +
    selectors - +Variable in class org.apache.tools.ant.DirectoryScanner +
    Selectors that will filter which files are in our candidate list. +
    SelectorScanner - Interface in org.apache.tools.ant.types.selectors
    An interface used to describe the actions required by any type of + directory scanner that supports Selecters.
    SelectorUtils - Class in org.apache.tools.ant.types.selectors
    This is a utility class used by selectors and DirectoryScanner.
    selectOutOfDateSources(ProjectComponent, Resource[], FileNameMapper, ResourceFactory) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Tells which source files should be reprocessed based on the + last modification date of target files. +
    selectOutOfDateSources(ProjectComponent, Resource[], FileNameMapper, ResourceFactory, long) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Tells which source files should be reprocessed based on the + last modification date of target files. +
    selectOutOfDateSources(ProjectComponent, ResourceCollection, FileNameMapper, ResourceFactory, long) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Tells which sources should be reprocessed based on the + last modification date of targets. +
    selectResources(Resource[], ResourceSelector) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Drops all resources from the given array that are not selected +
    SelectSelector - Class in org.apache.tools.ant.types.selectors
    This selector just holds one other selector and forwards all + requests to it.
    SelectSelector() - +Constructor for class org.apache.tools.ant.types.selectors.SelectSelector +
    Default constructor. +
    selectSources(ProjectComponent, ResourceCollection, FileNameMapper, ResourceFactory, ResourceUtils.ResourceSelectorProvider) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Tells which sources should be reprocessed because the given + selector selects at least one target. +
    send() - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Send the email. +
    send() - +Method in class org.apache.tools.ant.taskdefs.email.MimeMailer +
    Send the email. +
    SEND_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    SEND_FILES - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    sendAck(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Send an ack. +
    sendAndClose() - +Method in class org.apache.tools.mail.MailMessage +
    Sends the message and closes the connection to the server. +
    SendEmail - Class in org.apache.tools.ant.taskdefs
    A task to send SMTP email.
    SendEmail() - +Constructor for class org.apache.tools.ant.taskdefs.SendEmail +
      +
    sendFile(FTPClient, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sends a single file to the remote host. +
    sendFile(FTPClient, String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Sends a single file to the remote host. +
    sendString(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient +
    Write this string to the rexec session. +
    sendString(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient +
    Write this string to the telnet session. +
    Sequential - Class in org.apache.tools.ant.taskdefs
    Sequential is a container task - it can contain other Ant tasks.
    Sequential() - +Constructor for class org.apache.tools.ant.taskdefs.Sequential +
      +
    ServerDeploy - Class in org.apache.tools.ant.taskdefs.optional.j2ee
    Controls hot deployment tools for J2EE servers.
    ServerDeploy() - +Constructor for class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
      +
    Service - Class in org.apache.tools.ant.types.spi
    ANT Jar-Task SPI extension
    Service() - +Constructor for class org.apache.tools.ant.types.spi.Service +
      +
    SERVICE_ID - +Static variable in class org.apache.tools.ant.ProjectHelper +
    The service identifier in jars which provide Project Helper + implementations. +
    set(String, Object, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalProperties +
    Set a property. +
    set(String, Object, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Set a property. +
    set(String, Object, PropertyHelper) - +Method in interface org.apache.tools.ant.PropertyHelper.PropertySetter +
    Set a property. +
    set(int, Object) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    setAccess(Javadoc.AccessType) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the scope to be processed. +
    setAccount(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the login account to use on the specified server. +
    setAccount(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the login account to use on the specified server. +
    setAction(String) - +Method in class org.apache.tools.ant.dispatch.DispatchTask +
    Set the action. +
    setAction(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    The action to be performed, usually "deploy"; required. +
    setAction(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. +
    setAction(FTP.Action) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the FTP action to be taken. +
    setAction(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. +
    setAction(FTPTask.Action) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the FTP action to be taken. +
    setAction(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set the action to be performed. +
    setAction(Recorder.ActionChoices) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Sets the action for the associated recorder entry. +
    setActions(String) - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Set the actions. +
    setAdapter(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Set the class name of the adapter class. +
    setAdapterClass(Class) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the adapter class for this definition. +
    setAdapterClass(Class) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Set the adapter class. +
    setAdapterClass(Class) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Set the adapter class for this definition. +
    setAdaptTo(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Set the classname of the class that the definition + must be compatible with, either directly or + by use of the adapter class. +
    setAdaptToClass(Class) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the assignable class for this definition. +
    setAdaptToClass(Class) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Set the class for adaptToClass, to be + used by derived classes, used instead of + the adaptTo attribute. +
    setAdaptToClass(Class) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Set the assignable class for this definition. +
    setAdd(String) - +Method in class org.apache.tools.ant.taskdefs.DefaultExcludes +
    Pattern to add to the default excludes +
    setAdd(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view +
    setAddfiles(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Sets the files to be added into the output. +
    setAdditionalargs(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the additional arguments. +
    setAdditionalparam(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set an additional parameter on the command line +
    setAddproperty(String) - +Method in class org.apache.tools.ant.taskdefs.Input +
    Defines the name of a property to be created from input. +
    setAddress(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Sets the email address +
    setAddsourcefile(boolean) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    This is not allowed for Chmod. +
    setAddsourcefile(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether to send the source file name on the command line. +
    setAddsourcefile(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Prevent the use of the addsourcefile atribute. +
    setAddsourcefile(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Add source file. +
    setAdjust(Long) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Set the amount by which files' lengths should be adjusted. +
    setAgainst(Quantifier) - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Set the quantifier to be used. +
    setAlgorithm(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Specifies the algorithm to be used to compute the checksum. +
    setAlgorithm(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
    Specifies the algorithm to be used to compute the checksum. +
    setAlgorithm(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    Specifies the algorithm to be used to compute the checksum. +
    setAlgorithm(ModifiedSelector.AlgorithmName) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Set the algorithm type to use. +
    setAlgorithmClass(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Setter for algorithmClass. +
    setAlias(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    the alias to sign under; required +
    setAlias(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    The alias to add under. +
    setAllowtie(boolean) - +Method in class org.apache.tools.ant.types.resources.selectors.Majority +
    Set whether ties are allowed. +
    setAllowtie(boolean) - +Method in class org.apache.tools.ant.types.selectors.MajoritySelector +
    A attribute to specify what will happen if number + of yes votes is the same as the number of no votes + defaults to true +
    setAlwaysLog(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    If true, (error and non-error) output will be "teed", redirected as + specified while being sent to Ant's logging mechanism as if no + redirection had taken place. +
    setAlwaysLog(boolean) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    If true, (error and non-error) output will be "teed", redirected + as specified while being sent to Ant's logging mechanism as if no + redirection had taken place. +
    setAngle(String) - +Method in class org.apache.tools.ant.types.optional.image.Rotate +
    Sets the angle of rotation in degrees. +
    setAntfile(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    The build file to use. +
    setAntfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
    Sets the ant file +
    setAntfile(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    This method builds the file name to use in conjunction with directories. +
    setAntlib(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Antlib attribute, sets resource and uri. +
    setAntlibClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.taskdefs.AntlibDefinition +
    Set the class loader of the loading object +
    setAntRun(Project) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Set the name of the antRun script using the project's value. +
    setAppend(File) - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Sets append attribute. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Whether to append output/error when redirecting to a file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Sets the behavior when the destination exists. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    If true, append to existing file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.EchoXML +
    Set whether to append the output file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether output should be appended to or overwrite an existing file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    If true, append output to existing file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    Determines if the output is appended to the file given in + setOutput. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Whether or not the logger should append to a previous file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Whether output should be appended to or overwrite an existing file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    whether output should be appended to or overwrite + an existing file. +
    setAppend(boolean) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Whether output should be appended to or overwrite an existing file. +
    setAppendProperties(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    This Redirector's subordinate + PropertyOutputStreams will not set their respective + properties while (appendProperties && append). +
    setApplication(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    The name of the application being deployed; required. +
    setAppxml(File) - +Method in class org.apache.tools.ant.taskdefs.Ear +
    File to incorporate as application.xml. +
    setAptCommandlineSwitches(Commandline) - +Method in class org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter +
    using our front end task, set up the command line switches +
    setArch(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Os +
    Sets the desired OS architecture +
    setArcheight(int) - +Method in class org.apache.tools.ant.types.optional.image.Rectangle +
    Set the arc height. +
    setArchive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the Archive file attribute. +
    setArchive(File) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Set the archive that holds this Resource. +
    setArcwidth(int) - +Method in class org.apache.tools.ant.types.optional.image.Rectangle +
    Set the arc width. +
    setArg1(Object) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Set the first argument +
    setArg1(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Set the first string +
    setArg2(Object) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Set the second argument +
    setArg2(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Set the second string +
    setArgs(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Deprecated: use nested arg instead. +
    setArgs(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Any optional extra arguments pass to the weblogic.ejbc + tool. +
    setAs(String) - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    The prefix to use when prefixing the imported target names. +
    setAssertions(Assertions) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Add an assertion set to the command. +
    setAsText(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourcesMatch +
    Set whether to treat resources as if they were text files, + ignoring line endings. +
    setAtLeast(String) - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Set the atleast attribute. +
    setAttribute(Project, Object, String, Object) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Sets the named attribute in the given element, which is part of the + given project. +
    setAttribute(Project, Object, String, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Sets the named attribute in the given element, which is part of the + given project. +
    setAttribute(String, String) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Set an attribute to a given value. +
    setAttribute(String, Object) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set a custom attribute for the JAXP factory implementation. +
    setAttributes(AttributeList) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Deprecated. since 1.6.x. +
    setAuthor(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Sets the author of the CVSEntry +
    setAuthor(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Include the author tag in the generated documentation. +
    setAutocommit(boolean) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Auto commit flag for database connection; + optional, default false. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Autoresponce behaviour. +
    setAutoresponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL +
    Autoresponce behaviour. +
    setBackTrace(boolean) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Set the backTrace attribute. +
    setBackups(boolean) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    flag to create backups; optional, default=false +
    setBASdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Setter used to store the location of the borland DTD. +
    setBase(File) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets the location to store the compiled files; required +
    setBase(URL) - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    setBasedir(String) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set the base directory to be scanned. +
    setBasedir(File) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set the base directory to be scanned. +
    setBasedir(String) - +Method in interface org.apache.tools.ant.FileScanner +
    Sets the base directory to be scanned. +
    setBasedir(File) - +Method in interface org.apache.tools.ant.FileScanner +
    Sets the base directory to be scanned. +
    setBasedir(String) - +Method in class org.apache.tools.ant.Project +
    Set the base directory for the project, checking that + the given filename exists and is a directory. +
    setBaseDir(File) - +Method in class org.apache.tools.ant.Project +
    Set the base directory for the project, checking that + the given file exists and is a directory. +
    setBaseDir(File) - +Method in class org.apache.tools.ant.taskdefs.condition.IsFileSelected +
    The base directory to use. +
    setBasedir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Base directory to look in for files to CAB. +
    setBaseDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC.WebAppParameter +
    set directory; alternate syntax +
    setBasedir(File) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Sets 'basedir' attribute. +
    setBasedir(File) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    This is the base directory to look in for things to tar. +
    setBasedir(File) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the base directory; + optional, default is the project's basedir. +
    setBasedir(File) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Directory from which to archive files; optional. +
    setBaseDir(File) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Set the basedir for this FileResource. +
    setBasejarname(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the base name of the EJB JAR that is to be created if it is not + to be determined from the name of the deployment descriptor files. +
    setBaselineRootName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set baseline_root_name +
    setBasenameterminator(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    The string which terminates the bean name. +
    setBaseURL(URL) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Base URL which combined with the relativePath attribute defines + the URL. +
    setBccList(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand to set the "bcc" address element. +
    setBccList(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the bcc addresses. +
    setBeginToken(char) - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    Sets the "begin token" character. +
    setBeginToken(String) - +Method in class org.apache.tools.ant.types.FilterSet +
    Set the string used to id the beginning of a token. +
    setBinary(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Set the binary attribute. +
    setBinary(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    If true, uses binary mode, otherwise text mode (default is binary). +
    setBinary(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    If true, uses binary mode, otherwise text mode (default is binary). +
    setBinary(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether literals are treated as binary, rather than NetRexx types. +
    setBinary(boolean) - +Method in class org.apache.tools.ant.types.resources.comparators.Content +
    Set binary mode for this Content ResourceComparator. +
    setBold(boolean) - +Method in class org.apache.tools.ant.types.optional.image.Text +
      +
    setBootclasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Sets the bootclasspath that will be used to compile the classes + against. +
    setBootclasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the boot classpath to use. +
    setBootclasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    location of bootstrap class files. +
    setBootClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a reference to a classpath defined elsewhere. +
    setBootClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a reference to a CLASSPATH defined elsewhere. +
    setBootClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    To the bootstrap path, this adds a reference to a classpath defined elsewhere. +
    setBottom(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the text to be placed at the bottom of each output file. +
    setBranch(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Specify a branch to check out the file to. +
    setBranch(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the branch +
    setBreakiterator(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version. +
    setBufferDebug(boolean) - +Method in class org.apache.tools.tar.TarOutputStream +
    Sets the debugging flag in this stream's TarBuffer. +
    setBufferSize(int) - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Sets the buffer size to be used. +
    setBufferSize(int) - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    Set the size in bytes of the read buffer. +
    setBufferSize(int) - +Method in class org.apache.tools.ant.util.LeadPipeInputStream +
    Set the size of the buffer. +
    setBuildFile(File) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the build file to which the XML context belongs +
    setBuildFile(URL) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the build file to which the XML context belongs +
    setBuildnodefiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the BUILD_NODE_FILES grammar option. +
    setBuildparser(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the BUILD_PARSER grammar option. +
    setBuildpath(Path) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Set the buildpath to be used to find sub-projects. +
    setBuildpathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Buildpath to use, by reference. +
    setBuildtokenmanager(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the BUILD_TOKEN_MANAGER grammar option. +
    setBuiltin(PropertySet.BuiltinPropertySetName) - +Method in class org.apache.tools.ant.types.PropertySet.PropertyRef +
    Builtin property names - all, system or commandline. +
    setBundle(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets Family name of resource bundle; required. +
    setBundleCountry(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets locale specific country of resource bundle; optional. +
    setBundleEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets Resource Bundle file encoding scheme; optional. +
    setBundleLanguage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets locale specific language of resource bundle; optional. +
    setBundleVariant(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets locale specific variant of resource bundle; optional. +
    setByLine(boolean) - +Method in class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter +
    set whether to use filetokenizer or line tokenizer +
    setByLine(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Deprecated. since 1.6.x. + Use setByLine(boolean). +
    setByLine(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Process the file(s) one line at a time, executing the replacement + on one line at a time. +
    setCabfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    The name/location of where to create the .cab file. +
    setCache(File) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Sets the dependency cache file. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.Path +
    Whether to cache the current path. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Set whether to cache collections. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Set whether to cache collections. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Set whether to cache collections. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.resources.Resources +
    Set whether to cache collections. +
    setCache(boolean) - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Set whether to cache collections. +
    setCache(ModifiedSelector.CacheName) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Set the cache type to use. +
    setCacheClass(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Setter for cacheClass. +
    setCachefile(File) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Setter. +
    setCachetokens(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the CACHE_TOKENS grammar option. +
    setCaching(boolean) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Caching loaders / driver. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set whether or not include and exclude patterns are matched + in a case sensitive way. +
    setCaseSensitive(boolean) - +Method in interface org.apache.tools.ant.FileScanner +
    Sets whether or not the file system should be regarded as case sensitive. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Whether to match casesensitevly. +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Contains +
    Whether to search ignoring case or not. +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Should the comparison be case sensitive? +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    Whether to ignore case or not. +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Sets case sensitivity attribute. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets case sensitivity of the file system +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets case sensitivity of the file system +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets case sensitivity of the file system. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Set whether or not include and exclude patterns are matched + in a case sensitive way.. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.types.resources.Files +
    Set case-sensitivity of the Files collection. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Set whether the name comparisons are case-sensitive. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Whether to ignore case or not. +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Whether to ignore case in the string being searched. +
    setCasesensitive(boolean) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Whether to ignore case when checking filenames. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Attribute specifing whether to ignore the case difference + in the names. +
    setCaseSensitive(boolean) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Attribute specifing whether to ignore the case difference + in the names. +
    setCatalogPathRef(Reference) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Allows catalogpath reference. +
    setCcList(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand to set the "cc" address element. +
    setCcList(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the cc addresses. +
    setCcmAction(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Set the value of ccmAction. +
    setCcmDir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.Continuus +
    Set the directory where the ccm executable is located. +
    setCcmProject(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    Sets the ccm project on which the operation is applied. +
    setCentralDirectoryData(byte[]) - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Set the extra field data in central directory. +
    setCentralDirectoryExtra(byte[]) - +Method in class org.apache.tools.zip.ZipEntry +
    Sets the central directory part of extra fields. +
    setCertificates(boolean) - +Method in class org.apache.tools.ant.taskdefs.VerifyJar +
    Ask for certificate information to be printed +
    setChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Delete +
    An existing changelist number for the deletion; optional + but strongly recommended. +
    setChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Edit +
    An existing changelist number to assign files to; optional + but strongly recommended. +
    setChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    set the changelist number for the operation +
    setChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Revert +
    The changelist to revert; optional. +
    setChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
    set the change list number to submit +
    setChangelist(int) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Add +
    If specified the open files are associated with the + specified pending changelist number; otherwise the open files are + associated with the default changelist. +
    setChangelist(int) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
    Sets optionally a change list number. +
    setChangeProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
    property defining the change number if the change number gets renumbered +
    setChars(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.DeleteCharacters +
    Set the list of characters to delete +
    setCharset(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Sets the character set of mail message. +
    setCharset(String) - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Sets the character set of mail message. +
    setCharset(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Charset for cross-platform viewing of generated documentation. +
    setCheckdirs(boolean) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Set whether to check dates on directories. +
    setChecked(boolean) - +Method in class org.apache.tools.ant.types.DataType +
    Set the flag that is used to indicate that circular references have been checked. +
    setCheckEvery(long) - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Set the time between each check +
    setCheckEveryUnit(WaitFor.Unit) - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Set the check every time unit +
    setCheckExtension(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Check nested libraries for extensions +
    setCheckin(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    If true, checkin the element after creation +
    setChmod(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the file permission mode (Unix only) for files sent to the + server. +
    setChmod(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the file permission mode (Unix only) for files sent to the + server. +
    setChoiceambiguitycheck(int) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the CHOICE_AMBIGUITY_CHECK grammar option. +
    setClass(Class) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the class of the definition. +
    setClass(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    the fully-qualified name of the class (or classes, separated by commas). +
    setClass(Class) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Override so that it is not allowed. +
    setClass(String) - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    name the class to look for +
    setClass(String) - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    name a class +
    setClass(String) - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Set the class, mandatory. +
    setClass(Class) - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Set the class to compare against. +
    setClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the classloader to use to create an instance + of the definition. +
    setClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.taskdefs.Antlib +
    Set the class loader for this antlib. +
    setClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Set the classloader to use to create an instance + of the definition. +
    setClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Set the used ClassLoader. +
    setClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Used when called by scriptdef. +
    setClassName(String) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the classname of the definition. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set a classname of a class which must be available to set the given + property. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set the classname attribute. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    The full class name of the object being defined. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Set the InputHandler classname. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the Java class to execute. +
    setClassName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    The name of the class to execute to perfom + deployment; required. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set name of class to be used as the formatter. +
    setClassName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement +
    Set the classname of the class to be used for the nested element. +
    setClassName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Specify the class name of the SAX parser to be used. +
    setClassName(String) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Override so that it is not allowed. +
    setClassname(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets the class to run rmic against; + optional +
    setClassName(String) - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Set the className attribute. +
    setClassname(String) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Set the classname to execute. +
    setClassname(String) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the class name of the FileNameMapper to use. +
    setClassname(String) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet.ClassRoot +
    Set the root class name. +
    setClassname(String) - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Sets the classname of the custom selector. +
    setClassName(String) - +Method in class org.apache.tools.ant.types.spi.Provider +
    Set the provider classname. +
    setClassname(String) - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Delegate method handling the @classname attribute. +
    setClassPath(Path) - +Method in class org.apache.tools.ant.AntClassLoader +
    Set the classpath to search for classes to load. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Set the classpath to be used when searching for component being defined +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Set the classpath to be used when searching for component being defined. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Set the classpath to be used when running the Java class. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the classpath to be used when running the Java class. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the classpath to be used for this Javadoc run. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Sets the classpath for loading the driver. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the classpath to use when looking up a resource. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Set the classpath to be used for this dependency check. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Path to use for classpath. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the classpath to use when resolving classes for inclusion in the jar. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Sets the classpath to be used when compiling the EJB stubs and skeletons. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    The classpath to be passed to the JVM running the tool; + optional depending upon the tool. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    the classpath to use. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Set the classpath to be used for this compilation. +
    setClasspath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set the classpath used for NetRexx compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Specify the classpath to be searched to load the parser (optional) +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Property +
    The classpath to use when looking up a resource. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    Set the classpath to be used for this compilation. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the optional classpath to the XSL processor +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Set the classpath to load the FilterReader through (attribute). +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the classpath to load the FileNameMapper through (attribute). +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Set the classpath to be used when searching for classes and resources. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Set the classpath to use when looking up a resource. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Set the classpath to load the classname specified using an attribute. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Allows simple classpath string. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    This method is a Delegate method handling the @classpath attribute. +
    setClasspath(Path) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Set the classpath to be used when searching for classes and resources. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Specify which path will be used. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Set a reference to a classpath to use when loading the files. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the classpath to use by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a reference to a classpath defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a reference to a CLASSPATH defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Set the classpath for loading the driver + using the classpath reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Adds a reference to a classpath defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Reference to existing path, to use as a classpath. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Adds a reference to a classpath defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Adds a reference to a classpath defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Adds a reference to a classpath defined elsewhere +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Where to find the parser class; optional. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Property +
    the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Adds to the classpath a reference to + a <path> defined elsewhere. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    Set the classpath to use by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the reference to an optional classpath to the XSL processor +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Set the classpath to load the FilterReader through via + reference (attribute). +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the classpath to load the FileNameMapper through via + reference (attribute). +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Set the classpath by reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +
    setClasspathref(Reference) - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    Set the classpath to use for loading a custom selector by using + a reference. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Allows classpath reference. +
    setClasspathref(Reference) - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Delegate method handling the @classpathref attribute. +
    setClasspathRef(Reference) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Set the classpath by reference. +
    setCleanBuildDir(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Flag (optional, default=false) to remove + the generated files in the BUILD directory +
    setClearToolDir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Set the directory where the cleartool executable is located. +
    setClient(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    The p4 client spec to use; + optional, defaults to the current user +
    setClientjar(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Client JAR file name. +
    setClientVersionProperty(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    Set a property where to store the CVS client version +
    setCloneVm(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    If set, system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclaspath. +
    setCloneVm(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If set, system properties will be copied to the cloned VM - as + well as the bootclasspath unless you have explicitly specified + a bootclaspath. +
    setCloneVm(boolean) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Set whether system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclasspath. +
    setClosure(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    If true, transitive dependencies are followed until the + closure of the dependency set if reached. +
    setClosure(boolean) - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Set the closure flag. +
    setClosure(boolean) - +Method in interface org.apache.tools.ant.util.depend.DependencyAnalyzer +
    Set the closure flag. +
    setCmdopts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Set extra command options; only used on some + of the Perforce tasks. +
    setCmpversion(EjbJar.CMPVersion) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Sets the CMP version. +
    setCode(int) - +Method in class org.apache.tools.ant.taskdefs.condition.IsFailure +
    Set the return code to check. +
    setCodegen(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag, default false, to only generate the deployment + code, do not run RMIC or Javac +
    setCollapseAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    flag to treat attributes as nested elements; + optional, default false +
    setColor(String) - +Method in class org.apache.tools.ant.types.optional.image.Text +
    Set the color of the text. +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The CVS command to execute. +
    setCommand(Commandline) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Set the command. +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Set the command to exec. +
    setCommand(Commandline) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Sets a command line. +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Set the the comand to execute on the server; +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    What command to issue to the rpm build tool; optional. +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    Sets the command to execute on the remote host. +
    setCommand(Commandline) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Prevent the user from specifying a different command. +
    setCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the executable. +
    setCommandlength(int) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Add +
    Set the maximum length + of the commandline when calling Perforce to add the files. +
    setCommandline(String[]) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Sets the commandline of the subprocess to launch. +
    setCommandResource(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    Sets a commandResource from a file +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Specifies a comment. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specifies a comment. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Sets the comment string. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Sets the comment string. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Sets how comments should be written + for the event record(s) +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set comment string +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set comment string +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Sets the comment string. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Sets the comment string. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set comment string +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set comment string +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set comment string +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Sets how comments should be written + for the event record(s) +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile +
    optional header comment for the file +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin +
    The comment to apply to all files being labelled. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel +
    The comment to apply to all files being labelled. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Comment to apply to files added to SourceSafe. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Comment to apply to files checked-in to SourceSafe. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE +
    Comment to apply to the project created in SourceSafe. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL +
    Comment to apply to files labeled in SourceSafe. +
    setComment(String) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Comment to use for archive. +
    setComment(String) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Set the file comment. +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    Specifies a file containing a comment. +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Specifies a file containing a comment. +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set comment file +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set comment file +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    Specifies a file containing a comment. +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Specifies a file containing a comment. +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set comment file +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set comment file +
    setCommentFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set comment file +
    setComments(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether comments are passed through to the generated java source. +
    setCommonOptions(ExecTask) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    these are options common to signing and verifying +
    setCommontokenaction(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the COMMON_TOKEN_ACTION grammar option. +
    setCompact(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether error messages come out in compact or verbose format. +
    setComparator(Comparator) - +Method in class org.apache.tools.ant.filters.SortFilter +
    Set the comparator to be used as sorting criterium. +
    setComparator(ModifiedSelector.ComparatorName) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Set the comparator type to use. +
    setComparatorClass(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Setter for comparatorClass. +
    setCompile(boolean) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Set the compile option for the apt compiler. +
    setCompile(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether the NetRexx compiler should compile the generated java code. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Set the compiler. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Javac.ImplementationSpecificArgument +
      +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Choose the implementation for this particular task. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    The compiler (switch -compiler) to use; optional. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Class name of a JSP compiler adapter. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic.ImplementationSpecificArgument +
    Only pass the specified argument if the + chosen compiler implementation matches the + value of this attribute. +
    setCompiler(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets the compiler implementation to use; optional, + defaults to the value of the build.rmic property, + or failing that, default compiler for the current VM +
    setCompilerclasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the classpath to be used to find this compiler adapter +
    setComponent(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    the component string for the deployment targets; optional. +
    setCompress(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    If true, compress the files otherwise only store them. +
    setCompress(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Defines whether or not the output should be compacted. +
    setCompress(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether we want to compress the files or only store them; + optional, default=true; +
    setCompression(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    If true, this is the same as compressionlevel="3". +
    setCompression(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    Determines whether output will be compressed. +
    setCompression(Tar.TarCompressionMethod) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Set compression method. +
    setCompression(Untar.UntarCompressionMethod) - +Method in class org.apache.tools.ant.taskdefs.Untar +
    Set decompression algorithm to use; default=none. +
    setCompressionLevel(int) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    If set to a value 1-9 it adds -zN to the cvs command line, else + it disables compression. +
    setComprSize(long) - +Method in class org.apache.tools.zip.ZipEntry +
    Deprecated. since 1.7. + Use setCompressedSize directly. +
    setConfig(File) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Sets a configuration file other than the default to be used. +
    setConsole(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether or not compiler messages should be displayed on the 'console'. +
    setContains(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsString +
    the contains attribute +
    setContextClassLoader(ClassLoader) - +Static method in class org.apache.tools.ant.util.LoaderUtils +
    Set the context classloader +
    setCoreLoader(ClassLoader) - +Method in class org.apache.tools.ant.Project +
    Set the core classloader for the project. +
    setCount(int) - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Set the target count number for use as a Condition. +
    setCount(int) - +Method in class org.apache.tools.ant.types.resources.SizeLimitCollection +
    Set the number of resources to be included. +
    setCounts(long, long, long) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Set the number of runs, failures and errors. +
    setCr(FixCRLF.AddAsisRemove) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Deprecated. since 1.4.x. + Use setEol instead. +
    setCreate(boolean) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Set whether to create nonexistent files. +
    setCreateEmptyFiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Whether output and error files should be created even when empty. +
    setCreateEmptyFiles(boolean) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Whether output and error files should be created even when empty. +
    setCreateFile(boolean) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    If set the file is actually created, if not just a name is created. +
    setCreateUnicodeExtraFields(Zip.UnicodeExtraField) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether Unicode extra fields will be created. +
    setCreateUnicodeExtraFields(ZipOutputStream.UnicodeExtraFieldPolicy) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Whether to create Unicode Extra Fields. +
    setCrossref(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether variable cross references are generated. +
    setCsvColumnSeparator(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    The column separator used when printing the results. +
    setCsvQuoteCharacter(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    The character used to quote column values. +
    setCurpwd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    sets the current path of an AntFTPFile +
    setCurpwd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    sets the current path of an AntFTPFile +
    setCurrentExtraFields(ZipExtraField[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Sets the extra fields for the zip entry currently being + added to the archive - if any. +
    setCurrentPrefixSeparator(String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Sets the separator between the prefix and the target name. +
    setCurrentPriority(String) - +Method in class org.apache.tools.ant.taskdefs.Nice +
    The name of a property to set to the value of the current + thread priority. +
    setCurrentProjectName(String) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    set the name of the current project +
    setCurrentTarget(Target) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the current target +
    setCurrentTargetPrefix(String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Sets the prefix to prepend to imported target names. +
    setCurrentTargets(Map) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    Set the map of the targets in the current source file. +
    setCurrentTime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    If true, modification time should be written as the current time. +
    setCvsRoot(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The CVSROOT variable. +
    setCvsroot(String) - +Method in class org.apache.tools.ant.taskdefs.CVSPass +
    The CVS repository to add an entry for. +
    setCvsRsh(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The CVS_RSH variable. +
    setDate(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Use the most recent revision no later than the given date. +
    setDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Date to check-out. +
    setDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Date to get. +
    setDateFormat(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Format of dates in fromDatetoDate. +
    setDatetime(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM". +
    setDatetime(String) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM". +
    setDateTime(String) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Set the date and time as a String. +
    setDatetime(String) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Sets the date. +
    setDavidhost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Set the host for the David ORB; required if + ORB==david. +
    setDavidport(int) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Set the port for the David ORB; required if + ORB==david. +
    setDaysinpast(int) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the number of days worth of log entries to process. +
    setDbname(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Sets the name of the Database to create; optional. +
    setDbschema(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Sets the name of the schema to create; optional. +
    setDbvendor(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Sets the DB Vendor for the Entity Bean mapping ; optional. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Indicates whether source should be compiled + with debug information; defaults to off. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Sets a flag to enable ParseView debugging +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    set the debug mode for java2iiop (default false) +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    If true, turn on the debug mode for each of the Borland tools launched. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Sets whether or not debugging output will be generated when ejbc is + executed. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    If true, debugging output will be generated when ejbc is + executed. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    If set to true, additional information will be + printed during the deployment process; optional. +
    setDebug(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Generate debug info (passes -g to rmic); + optional, defaults to false +
    setDebug(boolean) - +Method in class org.apache.tools.tar.TarBuffer +
    Set the debugging flag for the buffer. +
    setDebug(boolean) - +Method in class org.apache.tools.tar.TarInputStream +
    Sets the debugging flag. +
    setDebug(boolean) - +Method in class org.apache.tools.tar.TarOutputStream +
    Sets the debugging flag. +
    setDebugLevel(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Keyword list to be appended to the -g command-line switch. +
    setDebuglookahead(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the DEBUG_LOOKAHEAD grammar option. +
    setDebugOutput(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    If true, enables debugging output when ejbc is executed. +
    setDebugparser(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the DEBUG_PARSER grammar option. +
    setDebugtokenmanager(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the DEBUG_TOKEN_MANAGER grammar option. +
    setDecimal(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set whether decimal arithmetic should be used for the netrexx code. +
    setDefault(String) - +Method in class org.apache.tools.ant.Project +
    Set the default target of the project. +
    setDefault(boolean) - +Method in class org.apache.tools.ant.taskdefs.DefaultExcludes +
    go back to standard default patterns +
    setDefault(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
    The default value to use if the parameter is not + used in the templated instance. +
    setDefault(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    setDefault(String) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    Initial value to set for a property if it is not + already defined in the property file. +
    setDefaultDateFormatConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the defaultDateFormatConfig attribute. +
    setDefaultDateFormatConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the defaultDateFormatConfig attribute. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Sets whether default exclusions should be used or not. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets whether default exclusions should be used or not. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Sets whether default exclusions should be used or not. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets whether default exclusions should be used or not. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets whether default exclusions should be used or not. +
    setDefaultexcludes(boolean) - +Method in class org.apache.tools.ant.types.resources.Files +
    Set whether default exclusions should be used or not. +
    setDefaultInputStream(InputStream) - +Method in class org.apache.tools.ant.Project +
    Set the default System input stream. +
    setDefaultTarget(String) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.5.x. + Use setDefault. +
    setDefaultTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecRead +
    Sets the default timeout if none has been set already +
    setDefaultTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetRead +
    Sets the default timeout if none has been set already +
    setDefaultValue(String) - +Method in class org.apache.tools.ant.input.InputRequest +
    Configures a default value. +
    setDefaultvalue(String) - +Method in class org.apache.tools.ant.taskdefs.Input +
    Defines the default value of the property to be created from input. +
    setDelayUpdate(boolean) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Setter for the delay update +
    setDelete(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view +
    setDeleteOnExit(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    If true, on failure to delete, note the error and set + the deleteonexit flag, and continue +
    setDeleteOnExit(boolean) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Set whether the tempfile created by this task should be set + for deletion on normal VM exit. +
    setDelimiter(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the delimiter that separates SQL statements. +
    setDelimiter(String) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Sets a new delimiter. +
    setDelimiterType(SQLExec.DelimiterType) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the delimiter type: "normal" or "row" (default "normal"). +
    setDelimOutput(String) - +Method in class org.apache.tools.ant.filters.TokenFilter +
    set the output delimiter. +
    setDelims(String) - +Method in class org.apache.tools.ant.util.StringTokenizer +
    attribute delims - the delimiter characters +
    setDelimsAreTokens(boolean) - +Method in class org.apache.tools.ant.util.StringTokenizer +
    attribute delimsaretokens - treat delimiters as + separate tokens. +
    setDepend(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Enables dependency-tracking for compilers + that support this (jikes and classic). +
    setDependency(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the analyzer to use when adding in dependencies to the JAR. +
    setDepends(String) - +Method in class org.apache.tools.ant.Target +
    Sets the list of targets this target is dependent on. +
    setDepends(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Set to true to transmit only files that are new or changed from their + remote counterparts. +
    setDepends(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Set to true to transmit only files that are new or changed from their + remote counterparts. +
    setDeprecation(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Indicates whether source should be + compiled with deprecation information; defaults to off. +
    setDesc(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
    Label Description; optional +
    setDescription(String) - +Method in class org.apache.tools.ant.Project +
    Set the project description. +
    setDescription(String) - +Method in class org.apache.tools.ant.ProjectComponent +
    Sets a description of the current action. +
    setDescription(String) - +Method in class org.apache.tools.ant.Target +
    Sets the description of this target. +
    setDescription(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
      +
    setDescription(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Sets a textual description of this element, + for build documentation purposes only. +
    setDescription(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
      +
    setDescription(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Change +
    Description for ChangeList;optional. +
    setDescriptordir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the descriptor directory. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The directory where the checked out files should be placed. +
    setDest(Resource) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Set the resource to write to. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. The dest attribute +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated. Set the destination file. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Specify the directory where target files are to be placed. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Set the destination directory. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Where to copy the source file. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Set the destination file. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Sets the destination directory where the EJB source classes must exist + and where the stubs and skeletons will be written. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Set the directory containing the source jsp's +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Set the destination directory to place converted files into. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Rename +
    Deprecated. Sets the new name of the file. +
    setDest(String) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Deprecated. since 1.5.x. + setDest(String) is deprecated and is replaced with + setDest(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +
    setDest(File) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    The destination file or directory; optional. +
    setDestDir(File) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. The dest dir attribute. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Set the destination where the fixed files should be placed. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the destination directory into which the Java source + files should be compiled. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the directory where the Javadoc output will be generated. +
    setDestDir(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Set the destination directory where the compiled Java files exist. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the destination directory. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Set the destination directory; required. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
    Sets the destination directory +
    setDestDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set the destination directory for manipulated images. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Set the destination directory into which the Java source + files should be compiled. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the destination directory into which the JSP source + files should be compiled. +
    setDestDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set the destination directory into which the NetRexx source files + should be copied and then compiled. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets the base directory to output the generated files. +
    setDestDir(File) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    Optionally sets the output directory to be used. +
    setDestDir(File) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Sets the destination directory. +
    setDestdir(File) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the destination directory into which the XSL result + files should be copied to; + required, unless in and out are + specified. +
    setDestEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets destination file encoding scheme; optional. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Sets the destination file, or uses the console if not specified. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the output file for the log. +
    setDestFile(File) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the output file for the diff. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Set a file to store the property output. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask +
    The location where generated manifest is placed. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
    Sets the destination file +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
    Sets the destination file +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    the required destination file. +
    setDestfile(File) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    The name of a file to send the output to, instead of patching + the file(s) in place; optional. +
    setDestFile(File) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Set is the name/location of where to create the tar file. +
    setDestFile(File) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    The file to create; required. +
    setDiag(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether diagnostic information about the compile is generated +
    setDiagnostic(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Sets a flag to emit diagnostic text +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    The directory to use as a base directory for the new Ant project. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    The directory which holds the files whose permissions must be changed. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the base dir for cvs. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Set the directory from which files are to be deleted +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Deltree +
    Deprecated. Set the directory to be deleted +
    setDir(String) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Set the directory. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the working directory of the process. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the working directory of the process. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Mkdir +
    the directory to create; required. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    The working directory of the process +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    The directory to invoke the VM in. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    The directory to invoke the VM in. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    The directory to run the patch command in, defaults to the + project's base directory. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    The base directory to use when replacing a token in multiple files; + required if file is not defined. +
    setDir(File) - +Method in class org.apache.tools.ant.taskdefs.Sync.SyncTarget +
    Override AbstractFileSet#setDir(File) to disallow + setting the directory. +
    setDir(File) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets the base-directory for this instance. +
    setDir(File) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Set the directory for the fileset. +
    setDir(File) - +Method in class org.apache.tools.ant.types.FileList +
    Set the dir attribute. +
    setDirectory(boolean) - +Method in class org.apache.tools.ant.types.Resource +
    Set the directory attribute. +
    setDirectory(boolean) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Override setDirectory. +
    setDirectory(boolean) - +Method in class org.apache.tools.zip.AsiExtraField +
    Indicate whether this entry is a directory. +
    setDirMode(String) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755 +
    setDirs(int) - +Method in class org.apache.tools.ant.types.mappers.CutDirsMapper +
    The number of leading directories to cut. +
    setDirSep(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set the default directory separator string; + defaults to current JVM File.separator. +
    setDisableDTD(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    flag to disable DTD support. +
    setDisplayname(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
    Set the user's fullname +
    setDisplayText(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Sets the display text presented in the splash window. +
    setDname(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    The distinguished name for entity. +
    setDocencoding(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Output file encoding name. +
    setDocFilesSubDirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Enables deep-copying of doc-files directories. +
    setDoclet(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the class that starts the doclet used in generating the + documentation. +
    setDocletPath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the classpath used to find the doclet class. +
    setDocletPathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the classpath used to find the doclet class by reference. +
    setDoctitle(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the title of the generated overview page. +
    setDocumentLocator(Locator) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Sets the locator in the project helper for future reference. +
    setDriver(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Class name of the JDBC driver; required. +
    setDump(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    If true, the dependency information will be written + to the debug level log. +
    setDuplicate(Zip.Duplicate) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Sets behavior for when a duplicate file is about to be added - + one of add, preserve or fail. +
    setDuration(Long) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Sets the duration in milliseconds the file should be played; optional. +
    setDynamic(boolean) - +Method in class org.apache.tools.ant.types.PropertySet +
    Set whether to reevaluate the set everytime the set is used. +
    setDynamicAttribute(String, String) - +Method in interface org.apache.tools.ant.DynamicAttribute +
    Set a named attribute to the given value +
    setDynamicAttribute(String, String, String, String) - +Method in interface org.apache.tools.ant.DynamicAttributeNS +
    Set a named attribute to the given value +
    setDynamicAttribute(String, String) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    A parameter name value pair as a xml attribute. +
    setDynamicAttribute(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase +
    Set a task attribute +
    setDynamicAttribute(String, String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute +
    Set an attribute. +
    setDynamicAttribute(String, String, String, String) - +Method in class org.apache.tools.ant.util.XMLFragment.Child +
    Sets the attribute +
    setEarfile(File) - +Method in class org.apache.tools.ant.taskdefs.Ear +
    Deprecated. since 1.5.x. + Use setDestFile(destfile) instead. +
    setEcho(boolean) - +Method in class org.apache.tools.ant.taskdefs.DefaultExcludes +
    If true, echo the default excludes. +
    setEcho(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecWrite +
    Whether or not the message should be echoed to the log. +
    setEcho(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetWrite +
    Whether or not the message should be echoed to the log. +
    setEjbcClass(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Set the classname of the ejbc compiler; optional + Normally ejbjar determines + the appropriate class based on the DTD used for the EJB. +
    setEjbdeploy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Decide, wether ejbdeploy should be called or not; + optional, default true. +
    setEjbdescriptor(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Sets the location of the standard XML EJB descriptor. +
    setEJBdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Deprecated. +
    setEJBdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Setter used to store the location of the Sun's Generic EJB DTD. +
    setEjbjar(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    EJB JAR file. +
    setElementAt(Object, int) - +Method in class org.apache.tools.ant.util.VectorSet +
      +
    setElementHandler(ProjectHelper2.AntHandler) - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Sets element handler +
    setElements(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    Set to true if the listener is to print events that occur + as each node is 'executed' in the stylesheet. +
    setElementTag(String) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Set the element tag. +
    setElse(Object) - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    The value for the property to set, if condition evaluates to false. +
    setElse(String) - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    The value for the property to set, if condition evaluates to false. +
    setEltype(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    Specifies the element type to use. +
    setEmacsMode(boolean) - +Method in interface org.apache.tools.ant.BuildLogger +
    Sets this logger to produce emacs (and other editor) friendly output. +
    setEmacsMode(boolean) - +Method in class org.apache.tools.ant.DefaultLogger +
    Sets this logger to produce emacs (and other editor) friendly output. +
    setEmacsMode(boolean) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Set emacs mode. +
    setEmacsMode(boolean) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Set emacs mode. +
    setEmacsMode(boolean) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Sets this logger to produce emacs (and other editor) friendly output.. +
    setEmacsMode(boolean) - +Method in class org.apache.tools.ant.XmlLogger +
    Ignore emacs mode, as it has no meaning in XML format +
    setEnableBaselessMerges(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the enablebaselessmerges flag +
    setEnabled(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.TagArgument +
    Sets whether or not the tag is enabled. +
    setEnableMultipleMappings(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set method of handling mappers that return multiple + mappings for a given source path. +
    setEnableMultipleMappings(boolean) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Set method of handling mappers that return multiple + mappings for a given source path. +
    setEnableRemoteVerification(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Whether to verify that data and control connections are + connected to the same remote host. +
    setEnableRemoteVerification(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Whether to verify that data and control connections are + connected to the same remote host. +
    setEnableStartTLS(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set whether to allow authentication to switch to a TLS + connection via STARTTLS. +
    setEnableStartTLS(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set whether to allow authentication to switch to a TLS + connection via STARTTLS. +
    setEnableSystemAssertions(Boolean) - +Method in class org.apache.tools.ant.types.Assertions +
    enable or disable system assertions. +
    setEnableTestListenerEvents(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Whether test listener events shall be generated. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Sets the character encoding +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    The encoding of the text element +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set the character encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Declare the encoding to use when outputting to a file; + Use "" for the platform's default encoding. +
    setEncoding(EmailTask.Encoding) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the preferred encoding method. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Sets the encoding to assume for file names and comments. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specifies the encoding Ant expects the files to be + in--defaults to the platforms default encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the Java source file encoding name. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the encoding name of the source files, +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Encoding to use for input, defaults to the platform's default + encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    Encoding to use for input, defaults to the platform's default + encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    The encoding to use for reading in an existing manifest file +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set the image encoding type. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Set the encoding to translate to/from. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Specifies the encoding Ant expects the files to be in - + defaults to the platforms default encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Set the file encoding to use on the files read and written by the task; + optional, defaults to default JVM encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the file encoding to use on the SQL files read in +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Untar +
    No encoding support in Untar. +
    setEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Encoding to use for filenames, defaults to the platform's + default encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Sets encoding of file names. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Encoding to use for input, defaults to the platform's default + encoding. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Set the encoding to be used for this StringResource. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.resources.Tokens +
    Set the encoding used to create the tokens. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Set the encoding to use with the zipfile. +
    setEncoding(String) - +Method in class org.apache.tools.ant.types.ZipFileSet +
    Set the encoding used for this ZipFileSet. +
    setEncoding(String) - +Method in class org.apache.tools.zip.ZipOutputStream +
    The encoding to use for filenames and the file comment. +
    setEnd(Date) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the date at which the changelog should stop. +
    setEndDate(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the end date. +
    setEndTag(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the tag at which the changelog should stop. +
    setEndTag(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the end tag. +
    setEndToken(char) - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    Sets the "end token" character. +
    setEndToken(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets ending token to identify keys; required. +
    setEndToken(String) - +Method in class org.apache.tools.ant.types.FilterSet +
    Set the string used to id the end of a token. +
    setEntityResolver(EntityResolver) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the class to resolve entities during the transformation. +
    setEnvironment(String[]) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Sets the environment variables for the subprocess to launch. +
    setEnvironment(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Prefix to use when retrieving environment variables. +
    setEof(FixCrLfFilter.AddAsisRemove) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Specify how DOS EOF (control-z) characters are to be handled. +
    setEof(FixCRLF.AddAsisRemove) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specify how DOS EOF (control-z) characters are to be handled. +
    setEol(FixCrLfFilter.CrLf) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Specify how end of line (EOL) characters are to be handled. +
    setEol(FixCRLF.CrLf) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Specify the end of line to find and to add if + not present at end of each input file. +
    setEol(FixCRLF.CrLf) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specify how EndOfLine characters are to be handled. +
    setError(File) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The file to direct standard error from the command. +
    setError(File) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the File to which the error stream of the process should be redirected. +
    setError(File) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the File to which the error stream of the process is redirected. +
    setError(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Optional file to save stderr to +
    setError(File) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the file to which standard error is to be redirected. +
    setError(File[]) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the files to which standard error is to be redirected. +
    setError(File) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the file to which standard error is to be redirected. +
    setError(String) - +Method in class org.apache.tools.ant.types.selectors.BaseSelector +
    Allows all selectors to indicate a setup error. +
    setErrorEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the error encoding. +
    setErrorEncoding(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the error encoding. +
    setErrorFilterChains(Vector) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the error FilterChains. +
    setErrorMessage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    sets the error message +
    setErrorOnMissingArchive(boolean) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Sets whether an error is thrown if an archive does not exist. +
    setErrorOnMissingArchive(boolean) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Sets whether an error is thrown if an archive does not exist. +
    setErrorOnMissingDir(boolean) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Sets whether or not a missing base directory is an error +
    setErrorOnMissingDir(boolean) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets whether an error is thrown if a directory does not exist. +
    setErrorPrintStream(PrintStream) - +Method in interface org.apache.tools.ant.BuildLogger +
    Sets the output stream to which this logger is to send error messages. +
    setErrorPrintStream(PrintStream) - +Method in class org.apache.tools.ant.DefaultLogger +
    Sets the output stream to which this logger is to send error messages. +
    setErrorPrintStream(PrintStream) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Set the error print stream. +
    setErrorPrintStream(PrintStream) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Sets the output stream to which this logger is to send error messages.. +
    setErrorPrintStream(PrintStream) - +Method in class org.apache.tools.ant.XmlLogger +
    Ignore error print stream. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Sets the name of the property whose value should be set to the error of + the process. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the property name whose value should be set to the error of + the process. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The property to set on compilation failure. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the name of the error property. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Property to set to "true" if there is a error in a test. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Property name whose value should be set to the error of the process. +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Property to set to "true" if a statement throws an error. +
    setErrorProperty() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
      +
    setErrorProperty(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Property name whose value should be set to the error of + the process. +
    setErrorreporting(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the ERROR_REPORTING grammar option. +
    setErrorsBeginAt(int) - +Method in class org.apache.tools.ant.taskdefs.condition.Http +
    Set the errorsBeginAt attribute +
    setErrorStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    sets a stream to which the stderr from the cvs exe should go +
    setEscapeProcessing(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set escape processing for statements. +
    setExactly(String) - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Set the exactly attribute. +
    setException(Throwable) - +Method in class org.apache.tools.ant.BuildEvent +
    Sets the exception associated with this event. +
    setExcludeDocFilesSubDir(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Colon-separated list of doc-files subdirectories + to skip if docFilesSubDirs is true. +
    setExcludePackageNames(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the list of packages to be excluded. +
    setExcludes(String[]) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set the list of exclude patterns to use. +
    setExcludes(String[]) - +Method in interface org.apache.tools.ant.FileScanner +
    Sets the list of exclude patterns to use. +
    setExcludes(String) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Sets the set of exclude patterns. +
    setExcludes(String) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets the set of exclude patterns. +
    setExcludes(String) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets the set of exclude patterns. +
    setExcludes(String) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Appends excludes to the current list of exclude + patterns. +
    setExcludes(String[]) - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Set the list of exclude patterns to use.. +
    setExcludes(String) - +Method in class org.apache.tools.ant.types.PatternSet +
    Appends excludes to the current list of exclude patterns. +
    setExcludes(String) - +Method in class org.apache.tools.ant.types.resources.Files +
    Append excludes to the current list of exclude + patterns. +
    setExcludesfile(File) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets the name of the file containing the includes patterns. +
    setExcludesfile(File) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets the name of the file containing the includes patterns. +
    setExcludesfile(File) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets the File containing the excludes patterns. +
    setExcludesfile(File) - +Method in class org.apache.tools.ant.types.PatternSet +
    Sets the name of the file containing the excludes patterns. +
    setExcludesfile(File) - +Method in class org.apache.tools.ant.types.resources.Files +
    Set the File containing the excludes patterns. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Sets the actual executable command to invoke, instead of the binary + jarsigner found in Ant's JDK. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Set the executable. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the name of the executable program. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Sets the name of the javac executable. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Sets the actual executable command to invoke, instead of the binary + javadoc found in Ant's JDK. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chgrp +
    We don't want to expose the executable atribute, so overide it. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chown +
    We don't want to expose the executable atribute, so overide it. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the executable. +
    setExecutable(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Name of the executable to use when forking. +
    setExecutable(String) - +Method in class org.apache.tools.ant.types.Commandline +
    Set the executable to run. +
    setExecuteStreamHandler(ExecuteStreamHandler) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    sets the handler +
    setExecutor(Executor) - +Method in class org.apache.tools.ant.Project +
    Set the Executor instance for this Project. +
    setExists(boolean) - +Method in class org.apache.tools.ant.types.Resource +
    Set the exists attribute. +
    setExists(boolean) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Set the exists attribute. +
    setExitValue(int) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Set the exit value. +
    setExpandProperties(boolean) - +Method in class org.apache.tools.ant.taskdefs.Replace.NestedString +
    Whether properties should be expanded in nested test. +
    setExpandProperties(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Enable property expansion inside nested text +
    setExplicit(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether variables must be declared explicitly before use. +
    setExpression(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    The parameter value + NOTE : was intended to be an XSL expression. +
    setExpression(String) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    The regular expression used to search the file. +
    setExpression(String) - +Method in class org.apache.tools.ant.types.Substitution +
    Set the pattern string for this regular expression substitution. +
    setExt(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Set the extension which converted files should have. +
    setExtdirs(Path) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Sets the extension directories that will be used during the + compilation. +
    setExtdirs(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Deprecated. since 1.5.x. + Use the Javadoc.setExtdirs(Path) version. +
    setExtdirs(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the location of the extensions directories. +
    setExtdirs(Path) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets the extension directories that will be used during the + compilation; optional. +
    setExtension(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    set the extension of the output files +
    setExtension(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set the extension to use for the report file. +
    setExtension(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the desired file extension to be used for the target; + optional, default is html. +
    setExtension(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    Set to true if the listener is to print information after + each extension event. +
    setExtensionName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the name of extension. +
    setExtensionPoint(String) - +Method in class org.apache.tools.ant.taskdefs.BindTargets +
      +
    setExternalAttributes(long) - +Method in class org.apache.tools.zip.ZipEntry +
    Sets the external file attributes. +
    setExtra(byte[]) - +Method in class org.apache.tools.zip.ZipEntry +
    Parses the given bytes as extra field data and consumes any + unparseable data as an UnparseableExtraFieldData + instance. +
    setExtra() - +Method in class org.apache.tools.zip.ZipEntry +
    Unfortunately java.util.zip.ZipOutputStream seems to access the extra data + directly, so overriding getExtra doesn't help - we need to + modify super's data directly. +
    setExtraFields(ZipExtraField[]) - +Method in class org.apache.tools.zip.ZipEntry +
    Replaces all currently attached extra fields with the new array. +
    setFactory(String) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Set the factory option for the apt compiler. +
    setFactory(String) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the factory name to use instead of JAXP default lookup. +
    setFactoryPathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Add a reference to a path to the factoryPath attribute. +
    setFailIfExecutionFails(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether to stop the build if program cannot be started. +
    setFailOnAny(boolean) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Control whether a failure in a nested task halts execution. +
    setFailOnConnectionError(boolean) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    whether the task should cause the build to fail if it cannot + connect to the database. +
    setFailOnEmptyArchive(boolean) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Whether try ing to expand an empty archive would be an error. +
    setFailOnErr(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    If true, command will throw an exception on failure. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Stop the build process if the command exits with + a return code other than 0. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set whether to fail when errors are encountered. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    If false, note errors but continue. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set whether BuildExceptions should be passed back to the core. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Set the failOnError attribute. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Fail if the command exits with a non-zero return code. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    If true, then fail if the command exits with a + returncode other than zero. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Indicates whether the build will continue + even if there are compilation errors; defaults to true. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Should the build process fail if Javadoc fails (as indicated by + a non zero return code)? +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    If true, fail on load error. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    If true, the task will fail if an error occurs writing the properties + file, otherwise errors are just logged. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    Set whether to fail if error. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set whether to fail on error. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Whether or not the build should halt if compilation fails. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    whether to stop the build (true, default) + or keep going if an error is returned from the p4 command +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    If true, stop the build process when the rpmbuild command + exits with an error status. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Set the failonerror flag. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set failonerror mode. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Indicates if the build should fail if the Sourcesafe command does. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Specify how parser error are to be handled. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    If true, stop the build process if the patch command + exits with an error status. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    flag controlling whether to break the build on an error. +
    setFailonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Sets whether to fail with a build exception on error, or go on. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    If false, note errors to the output but keep going. +
    setFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether any errors should make the build fail. +
    setFailOnNoReplacements(boolean) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Whether the build should fail if nothing has been replaced. +
    setFailOnNoResources(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether the build should fail if the nested resource collection is empty. +
    setFailOnTeardownErrors(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the failOnTeardownErrors attribute. +
    setFailOnTransformationError(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether transformation errors should make the build fail. +
    setFailureMessage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the failureMessage attribute. +
    setFailureProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the name of the failure property. +
    setFailureProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Property to set to "true" if there is a failure in a test. +
    setFailureProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the failureProperty attribute. +
    setFallBackToUTF8(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding. +
    setFallbackToUTF8(boolean) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Whether to fall back to UTF and the language encoding flag if + the file name cannot be encoded using the specified encoding. +
    setFamily(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Os +
    Sets the desired OS family type +
    setFeature(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Feature to probe for. +
    setFeature(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Set a feature on the parser. +
    setFeatureIfSupported(String, boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    set a feature if it is supported, log at verbose level if + not +
    setField(String) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set the name of the field. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the file which must be present in the file system to set the given + property. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Basename +
    file or directory to get base name from +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.BuildNumber +
    The file in which the build number is stored. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the file for which the checksum is to be calculated. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    The file or single directory of which the permissions must be changed. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    set the text using a file +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.condition.IsFileSelected +
    The file to check. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.condition.IsSigned +
    The jarfile that is to be tested for the presence + of a signature. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set a single source file to copy. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Name of the property file to load + ant name/classname pairs from. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Set the name of a single file to be removed. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Dirname +
    Path to take the dirname of. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    File to write to. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.EchoXML +
    Set the output file. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Set a single file to convert. +
    setFile(String) - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    the name of the file to import. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.SourceFile +
    Set the source file. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the single file for this task. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    the name of a file to be converted into a URL +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    The name of the manifest file to create/update. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Sets the path to the file that the command will operate on. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
    The JAR library to check. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask +
    The JAR library to display information for. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile +
    Location of the property file to be edited; required. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    file for which the regular expression should be replaced; + required unless a nested fileset is supplied. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    identify a file that contains this namespace's schema. +
    setFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin +
    The filename to act upon. +
    setFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout +
    The filename to act upon. +
    setFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
    The Filename to act upon. +
    setFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Sets the file to be transferred. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Set the file which should have its access attributes modified. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    A file to be attribed. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    specify the file to be checked; optional. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Filename of a property file to load. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Set the source file; required unless dir is set. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Sets a single source file to touch. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Set a single target File. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    The XML file to parse; required. +
    setFile(File) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +
    setFile(File) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Creates a single file fileset. +
    setFile(File) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set a single commandline argument to the absolute filename + of the given file. +
    setFile(File) - +Method in class org.apache.tools.ant.types.Environment.Variable +
    get the absolute path of a file and assign it to the value +
    setFile(File) - +Method in class org.apache.tools.ant.types.FilterSet.FiltersFile +
    Sets the file from which filters will be read. +
    setFile(File) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Set the File for this FileResource. +
    setFile(File) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Set the URL from a File. +
    setFile1(File) - +Method in class org.apache.tools.ant.taskdefs.condition.FilesMatch +
    Sets the File1 attribute +
    setFile2(File) - +Method in class org.apache.tools.ant.taskdefs.condition.FilesMatch +
    Sets the File2 attribute +
    setFileDirParameter(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Pass the directory name of the current processed file as a xsl parameter + to the transformation. +
    setFileext(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the file extension that is be to used to + create or identify destination file. +
    setFileLastModified(File, long) - +Method in class org.apache.tools.ant.Project +
    Deprecated. since 1.4.x +
    setFileLastModified(File, long) - +Method in class org.apache.tools.ant.util.FileUtils +
    Calls File.setLastModified(long time). +
    setFileMode(String) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 +
    setFilenameFormat(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    The format of the folder names; optional. +
    setFileNameParameter(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Pass the filename of the current processed file as a xsl parameter + to the transformation. +
    setFilepath(Path) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the path to use when looking for a file. +
    setFiles(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the list of files to be attached. +
    setFiles(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the files to attach. +
    setFiles(String) - +Method in class org.apache.tools.ant.types.FileList +
    Set the filenames attribute. +
    setFilesetmanifest(Jar.FilesetManifestConfig) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Behavior when a Manifest is found in a zipfileset or zipgroupfileset file. +
    setFilesonly(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    If true, emulate Sun's jar utility by not adding parent directories; + optional, defaults to false. +
    setFileTimeStamp(MSVSS.CurrentModUpdated) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Date and time stamp given to the local copy. +
    setFileTimeStamp(MSVSS.CurrentModUpdated) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Date and time stamp given to the local copy. +
    setFill(String) - +Method in class org.apache.tools.ant.types.optional.image.BasicShape +
    Set the fill attribute. +
    setFilterChains(Vector) - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Sets the collection of filter reader sets +
    setFiltering(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    whether to filter the text in this element + or not. +
    setFiltering(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set filtering mode. +
    setFiltering(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. The filtering attribute. +
    setFiltering(String) - +Method in class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated. The filtering attribute. +
    setFiltering(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets token filtering [optional], default=false +
    setFiltersfile(File) - +Method in class org.apache.tools.ant.taskdefs.Filter +
    The file from which the filters must be read. +
    setFiltersfile(File) - +Method in class org.apache.tools.ant.types.FilterSet +
    Set the file containing the filters for this filterset. +
    setFiltertrace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the filtertrace attribute. +
    setFiltertrace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, smartly filter the stack frames of + JUnit errors and failures before reporting them. +
    setFixlast(boolean) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Specify whether a missing EOL will be added to the final line of input. +
    setFixlast(boolean) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specify whether a missing EOL will be added + to the final line of a file. +
    setFixLastLine(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Append line.separator to files that do not end + with a line.separator, default false. +
    setFlags(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsRegex +
      +
    setFlags(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceRegex +
      +
    setFlags(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    The flags to use when matching the regular expression. +
    setFlatdestdir(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Controls whether the + destination JARs are written out in the destination directory with + the same hierarchical structure from which the deployment descriptors + have been read. +
    setFlatten(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set whether files copied from directory trees will be "flattened" + into a single directory. +
    setFlatten(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. The flattening attribute. +
    setFlattenAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Whether to flatten multi-valued attributes (i.e. +
    setFlattenAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Whether to flatten multi-valued attributes (i.e. +
    setFollowSymlinks(boolean) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set whether or not symbolic links should be followed. +
    setFollowSymlinks(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets whether or not symbolic links should be followed. +
    setFollowSymlinks(boolean) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets whether or not symbolic links should be followed. +
    setFollowSymlinks(boolean) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets whether or not symbolic links should be followed. +
    setFollowSymlinks(boolean) - +Method in class org.apache.tools.ant.types.resources.Files +
    Set whether or not symbolic links should be followed. +
    setFont(String) - +Method in class org.apache.tools.ant.types.optional.image.Text +
    Set the font to be used to draw the text. +
    setFooter(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the footer text to be placed at the bottom of each output file. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Deprecated. use #setOverwrite instead +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Whether read-only destinations will be overwritten. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Whether read-only destinations will be overwritten. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether to bypass timestamp comparisons for target files. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    If true, output files should always be written (JDK1.2 only). +
    setForce(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Sync +
    force a refresh of files, if this attribute is set; false by default. +
    setForce(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Specifies the value of the force argument; optional. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    Whether to force signing of a jar even it is already signed. +
    setForce(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set whether to check dependencies, or always generate; + optional, default is false. +
    setForceIntegrate(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the forceintegrate flag +
    setForcelacheck(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the FORCE_LA_CHECK grammar option. +
    setForceOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Whether or not to overwrite existing file irrespective of + whether it is newer than + the source file. +
    setForceoverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. The forceoverwrite attribute. +
    setForceoverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated. The forceoverwrite attribute. +
    setForceOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Whether or not to overwrite existing file irrespective of + whether it is newer than the source file as well as the + resource bundle file. +
    setForceReadOnly(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Whether read-only destinations will be overwritten. +
    setForcestring(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Set whether to force string comparisons for non-equal, non-string objects. +
    setForcetextmode(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    If set to true, attempts a textual merge, even for binary files +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Set the fork attribute. +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    If true, execute in a new VM. +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, forks the javac compiler. +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
      +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    If true, forks into a new JVM. +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the fork attribute. +
    setFork(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, JVM should be forked for each test. +
    setForkMode(JUnitTask.ForkMode) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Set the behavior when fork fork has been enabled. +
    setFormat(Checksum.FormatElement) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Select the in/output pattern via a well know format name. +
    setFormat(Definer.Format) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Sets the format of the file or resource +
    setFormat(EchoProperties.FormatAttribute) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Set the output format - xml or text. +
    setFormat(JDependTask.FormatAttribute) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    The format to write the output in, "xml" or "text". +
    setFormat(AggregateTransformer.Format) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    sets the format. +
    setFormat(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the generated java code is formatted nicely or left to match + NetRexx line numbers for call stack debugging. +
    setForwardslash(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether the source and target file names on Windows and OS/2 + must use the forward slash as file separator. +
    setFrom(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceString +
    the from attribute +
    setFrom(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand to set the from address element. +
    setFrom(EmailAddress) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the address to send from. +
    setFrom(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert.MapEntry +
    Set the "from" attribute of the map entry. +
    setFrom(String) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the argument to FileNameMapper.setFrom +
    setFrom(String) - +Method in class org.apache.tools.ant.types.mappers.CutDirsMapper +
    Empty implementation. +
    setFrom(String) - +Method in class org.apache.tools.ant.types.mappers.FilterMapper +
    From attribute not supported. +
    setFrom(String) - +Method in class org.apache.tools.ant.types.optional.ScriptMapper +
    Sets the from part of the transformation rule. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Empty implementation. +
    setFrom(String) - +Method in interface org.apache.tools.ant.util.FileNameMapper +
    Sets the from part of the transformation rule. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.FlatFileNameMapper +
    Ignored. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Sets the "from" pattern. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.IdentityMapper +
    Ignored. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.MergingMapper +
    Ignored. +
    setFrom(String) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Sets the "from" pattern. +
    setFromDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Date representing the 'start' of the range. +
    setFromExtension(String) - +Method in class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. The string that files must end in to be renamed +
    setFromfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the from file specification +
    setFromLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Label representing the 'start' of the range. +
    setFull(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set the full flag +
    setFullChecking(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    enable full schema checking. +
    setFullpath(String) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Set the full pathname of the single entry in this fileset. +
    setGc(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set whether to invoke Garbage Collection after each image processed. +
    setGenerateclient(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    setter used to store whether the task will include the generate client task. +
    setGeneration(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    Set to true if the listener is to print information after + each result-tree generation event. +
    setGenericAntfile(File) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    This method builds a file path to use in conjunction with directories. +
    setGenericjarsuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the suffix for the generated jar file. +
    setGenericJarSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Set the suffix for the generated jar file. +
    setGenericJarSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Since iAS doesn't generate a "generic" JAR as part of its processing, + this attribute is ignored and a warning message is displayed to the user. +
    setGetLocalCopy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Retrieve a local copy during a checkout. +
    setGid(int) - +Method in class org.apache.tools.ant.types.TarFileSet +
    The GID for the tar entry; optional, default="0" + This is not the same as the group name. +
    setGlib(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Deprecated. since ant 1.6 +
    setGlib(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Sets an optional super grammar file +
    setGlobal(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the global flag +
    setGlobalopts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Set global P4 options; Used on all + of the Perforce tasks. +
    setGranularity(long) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set the number of milliseconds leeway to give before deciding a + target is out of date. +
    setGranularity(long) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Set the number of milliseconds leeway to give before deciding a + target is out of date. +
    setGranularity(long) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    The number of milliseconds leeway to give before deciding a + target is out of date. +
    setGranularity(long) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Set the granularity to use for this ResourceSelector. +
    setGranularity(int) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Sets the number of milliseconds leeway we will give before we consider + a file not to have matched a date. +
    setGranularity(int) - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    Sets the number of milliseconds leeway we will give before we consider + a file out of date. +
    setGranularityMillis(long) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    setGraphical(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    If true, displays a graphical dialog during the update. +
    setGroup(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Group specified packages together in overview page. +
    setGroup(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chgrp +
    Set the group atribute. +
    setGroup(String) - +Method in class org.apache.tools.ant.types.TarFileSet +
    The groupname for the tar entry; optional, default="" + This is not the same as the GID. +
    setGroupId(int) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's group id. +
    setGroupId(int) - +Method in class org.apache.tools.zip.AsiExtraField +
    Set the group id. +
    setGroupName(String) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's group name. +
    setHaltonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Whether or not to halt on failure. +
    setHaltonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the haltonerror attribute. +
    setHaltonerror(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, stop the build process when there is an error in a test. +
    setHaltonfailure(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the haltonfailure attribute. +
    setHaltonfailure(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, stop the build process if a test fails + (errors are considered failures as well). +
    setHandleDirSep(boolean) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +
    setHandleDirSep(boolean) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +
    setHandleDirSep(boolean) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +
    setHeader(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the header text to be placed at the top of each output file. +
    setHeader(String, String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the named header to the given value. +
    setHeaderId(ZipShort) - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Set the header id. +
    setHeaders(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the generic headers to add to the email. +
    setHeight(int) - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Set the height. +
    setHeight(int) - +Method in class org.apache.tools.ant.types.optional.image.Ellipse +
    Set the height. +
    setHeight(int) - +Method in class org.apache.tools.ant.types.optional.image.Rectangle +
    Set the height. +
    setHeight(String) - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Sets the height of the image, either as an integer or a %. +
    setHelpfile(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Specifies the HTML help file to use. +
    setHidden(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the Hidden file attribute. +
    setHost(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Set the host to ping. +
    setHost(String) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the mail server. +
    setHost(String) - +Method in class org.apache.tools.ant.taskdefs.HostInfo +
    Set the host to be retrieved. +
    setHost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Remote host, either DNS name or IP. +
    setHours(int) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    hours to add to the sleep time. +
    setHref(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Set the href attribute. +
    setHtml(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    If true, emit html +
    setHttpUseCaches(boolean) - +Method in class org.apache.tools.ant.taskdefs.Get +
    HTTP connections only - control caching on the + HttpUrlConnection: httpConnection.setUseCaches(); if false, do + not allow caching on the HttpUrlConnection. +
    setIasdescriptor(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    Sets the location of the iAS-specific XML EJB descriptor. +
    setIashome(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Setter method used to store the "home" directory of the user's iAS + installation. +
    setIashome(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    May be used to specify the "home" directory for this iAS installation. +
    setIasHomeDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    May be used to specify the "home" directory for this iAS installation. +
    setIdentical(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    If true, allows the file to be checked in even + if it is identical to the original. +
    setIdentical(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set the identical flag +
    setIdl(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Indicates that IDL output should be + generated. +
    setIdlopts(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    pass additional arguments for IDL compile +
    setIds(int, int) - +Method in class org.apache.tools.tar.TarEntry +
    Convenience method to set this entry's group and user ids. +
    setIeplugin(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Java Plugin CLASSID for Internet Explorer +
    setIf(String) - +Method in class org.apache.tools.ant.Target +
    Sets the "if" condition to test on execution. +
    setIf(Object) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Only fail if the given expression evaluates to true or the name + of an existing property. +
    setIf(String) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Only fail if the given expression evaluates to true or the name + of an existing property. +
    setIf(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the if attribute. +
    setIf(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the if attribute. +
    setIf(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set whether this formatter should be used. +
    setIf(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set whether this formatter should be used. +
    setIf(Object) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set whether this param should be used. +
    setIf(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set whether this param should be used. +
    setIf(Object) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    Sets the if attribute. +
    setIf(String) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    Sets the if attribute. +
    setIf(Object) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files. +
    setIf(String) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files. +
    setIgnore(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set the ignore flag +
    setIgnorecase(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the IGNORE_CASE grammar option. +
    setIgnoreContents(boolean) - +Method in class org.apache.tools.ant.types.selectors.DifferentSelector +
    This flag tells the selector to ignore contents +
    setIgnoreEmpty(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Sets the behavior when no source resource files are available. +
    setIgnoreErrors(boolean) - +Method in class org.apache.tools.ant.taskdefs.Get +
    If true, log errors but do not treat as fatal. +
    setIgnoreErrors(boolean) - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Set whether this ConcatResourceInputStream ignores errors. +
    setIgnoreFileTimes(boolean) - +Method in class org.apache.tools.ant.types.selectors.DifferentSelector +
    This flag tells the selector to ignore file times in the comparison +
    setIgnoreInvalidRecipients(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail. +
    setIgnoreInvalidRecipients(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail. +
    setIgnoremissing(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether to ignore nonexistent files from filelists. +
    setIgnoreNoncriticalErrors(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    set the flag to skip errors on directory creation. +
    setIgnoreNoncriticalErrors(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    set the flag to skip errors on directory creation. +
    setIgnoreProjectTag(boolean) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the flag to ignore the project tag +
    setIgnoreRemoved(boolean) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the ignore removed indicator. +
    setIgnoreReturnCode(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    If set to true the return value from executing the pvcs + commands are ignored; optional, default false. +
    setIgnoresystemclasses(boolean) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set whether the search for classes should ignore the runtime classes and + just use the given classpath. +
    setIgnoreSystemClasses(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set whether to ignore system classes when looking for the class. +
    setIgnorewhitespace(boolean) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    flag to ignore whitespace differences; default=false +
    setIgnorewhitespace(boolean) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Whether to ignore whitespace in the string being searched. +
    setIiop(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Indicates that IIOP compatible stubs should + be generated; optional, defaults to false + if not set. +
    setIiopopts(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Set additional arguments for iiop +
    setImageURL(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    A URL pointing to an image to display; optional, default antlogo.gif + from the classpath. +
    setImplementation(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Choose the implementation for this particular task. +
    setImplementation(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Choose the implementation for this particular task. +
    setImplementation(String) - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Used for explicit user choices. +
    setImplementation(String) - +Method in class org.apache.tools.ant.util.facade.ImplementationSpecificArgument +
    Set the implementation this argument is for. +
    setImplementationUrl(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the implementationURL of extension. +
    setImplementationVendor(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the implementationVendor of extension. +
    setImplementationVendorId(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the implementationVendorID of extension. +
    setImplementationVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the implementationVersion of extension. +
    setImplicit(boolean) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Sets whether this element is implicit. +
    setImplicitTarget(Target) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the implicit target +
    setIn(File) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    specifies a single XML document to be styled. +
    setIncludeantruntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, includes Ant's own classpath in the classpath. +
    setIncludeantruntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, include ant.jar, optional.jar and junit.jar in the forked VM. +
    setIncludeantruntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Sets whether or not to include ant's own classpath in this task's + classpath. +
    setIncludeDelims(boolean) - +Method in class org.apache.tools.ant.util.LineTokenizer +
    attribute includedelims - whether to include + the line ending with the line, or to return + it in the posttoken + default false +
    setIncludeDelims(boolean) - +Method in class org.apache.tools.ant.util.StringTokenizer +
    attribute includedelims - treat delimiters as part + of the token. +
    setIncludeDestClasses(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    This property controls whether to include the + destination classes directory in the classpath + given to the compiler. +
    setIncludeEmptyDirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set whether to copy empty directories. +
    setIncludeEmptyDirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    If true, delete empty directories. +
    setIncludeEmptyDirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Used to copy empty directories. +
    setIncludefilenames(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set whether to include filenames. +
    setIncludeFileNames(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Indicate whether filenames should be listed in the body. +
    setIncludeImpl(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.LibFileSet +
    Flag indicating whether should include the + "Implementation-*" attributes in manifest. +
    setIncludejavaruntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, includes the Java runtime libraries in the classpath. +
    setIncludejavaruntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    task's classpath. +
    setIncludeNoSourcePackages(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    If set to true, Ant will also accept packages that only hold + package.html files but no Java sources. +
    setIncluderuntime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    If true, + include jdepend.jar in the forked VM. +
    setIncludes(String[]) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set the list of include patterns to use. +
    setIncludes(String[]) - +Method in interface org.apache.tools.ant.FileScanner +
    Sets the list of include patterns to use. +
    setIncludes(String) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Sets the set of include patterns. +
    setIncludes(String) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets the set of include patterns. +
    setIncludes(String) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets the set of include patterns. +
    setIncludes(String) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Appends includes to the current list of include + patterns. +
    setIncludes(String[]) - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Set the list of include patterns to use.. +
    setIncludes(String) - +Method in class org.apache.tools.ant.types.PatternSet +
    Appends includes to the current list of include patterns. +
    setIncludes(String) - +Method in class org.apache.tools.ant.types.resources.Files +
    Append includes to the current list of include + patterns. +
    setIncludeSemanticAttribute(boolean) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Include the semantic attribute name as part of the property name. +
    setIncludesfile(File) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets the name of the file containing the includes patterns. +
    setIncludesfile(File) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets the name of the file containing the includes patterns. +
    setIncludesfile(File) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Sets the File containing the includes patterns. +
    setIncludesfile(File) - +Method in class org.apache.tools.ant.types.PatternSet +
    Sets the name of the file containing the includes patterns. +
    setIncludesfile(File) - +Method in class org.apache.tools.ant.types.resources.Files +
    Set the File containing the includes patterns. +
    setIncludeUrl(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.LibFileSet +
    Flag indicating whether should include the + "Implementation-URL" attribute in manifest. +
    setIndex(boolean) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Set whether or not to create an index list for classes. +
    setIndexMetaInf(boolean) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Set whether or not to add META-INF and its children to the index. +
    setInError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    sets the error flag on the task +
    setInheritAll(boolean) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    If true, pass all properties to the new Ant project. +
    setInheritAll(boolean) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    If true, pass all properties to the new Ant project. +
    setInheritall(boolean) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + inheritall attribute. +
    setInheritedProperty(String, String) - +Method in class org.apache.tools.ant.Project +
    Set a user property, which cannot be overwritten by set/unset + property calls. +
    setInheritedProperty(String, String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    setInheritedProperty(String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Sets an inherited user property, which cannot be overwritten by set/unset + property calls. +
    setInheritRefs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    If true, pass all references to the new Ant project. +
    setInheritRefs(boolean) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    If true, pass all references to the new Ant project. +
    setInheritrefs(boolean) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + inheritrefs attribute. +
    setInIncludeMode(boolean) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Sets whether the current file should be read in include as + opposed to import mode. +
    setInitialCR(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    send a carriage return after connecting; optional, defaults to false. +
    setInitialCR(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    send a carriage return after connecting; optional, defaults to false. +
    setInitialized(boolean) - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Sets the initialized status. +
    setInitialSiteCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the initialSiteCommand attribute. +
    setInitialSiteCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the initialSiteCommand attribute. +
    setInput(String) - +Method in class org.apache.tools.ant.input.InputRequest +
    Sets the user provided input. +
    setInput(File) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the input file to use for the task. +
    setInput(File) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the input to use for the task. +
    setInput(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    If used, the content of the file is piped to the remote command +
    setInput(File) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the input to use for the task +
    setInput(File[]) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the input to use for the task +
    setInput(File) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the input to use for the task. +
    setInputEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the input encoding. +
    setInputEncoding(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the input encoding. +
    setInputFilterChains(Vector) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the input FilterChains. +
    setInputHandler(InputHandler) - +Method in class org.apache.tools.ant.Project +
    Set the input handler. +
    setInputProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    If used, the content of the property is piped to the remote command +
    setInputString(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the string to use as input. +
    setInputString(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the string to use as input. +
    setInputString(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the string to use as input +
    setInputString(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the string to use as input +
    setInternalAttributes(int) - +Method in class org.apache.tools.zip.ZipEntry +
    Sets the internal file attributes. +
    setInternalAutoResponse(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the auto response attribute. +
    setInternalComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Set the comment text. +
    setInternalComment(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the internal comment attribute. +
    setInternalDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the date attribute. +
    setInternalDateFormat(DateFormat) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the date format attribute. +
    setInternalFailOnError(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the failOnError attribute. +
    setInternalFilename(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Set the file name. +
    setInternalFileTimeStamp(MSVSS.CurrentModUpdated) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the timestamp attribute. +
    setInternalFromDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the from date attribute. +
    setInternalFromLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the from label attribute. +
    setInternalGetLocalCopy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the getLocalCopy attribute. +
    setInternalLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Set the label. +
    setInternalLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the label attribute. +
    setInternalLocalPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the local path comment attribute. +
    setInternalNumDays(int) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the num days attribute. +
    setInternalOutputFilename(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the outputFileName comment attribute. +
    setInternalQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the quiet attribute. +
    setInternalRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Set the recursive flag. +
    setInternalRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the recursive attribute. +
    setInternalsf(boolean) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    Flag to include the .SF file inside the signature; optional; default + false +
    setInternalStyle(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the style attribute. +
    setInternalToDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the to date attribute. +
    setInternalToLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the to label attribute. +
    setInternalUser(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the user attribute. +
    setInternalVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Set the version. +
    setInternalVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the version attribute. +
    setInternalWritable(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the writable attribute. +
    setInternalWritableFiles(MSVSS.WritableFiles) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Set the writableFiles attribute. +
    setIsolated(boolean) - +Method in class org.apache.tools.ant.AntClassLoader +
    Sets whether this classloader should run in isolated mode. +
    setItalic(boolean) - +Method in class org.apache.tools.ant.types.optional.image.Text +
      +
    setJar(File) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    the jar file to sign; required +
    setJar(File) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the location of the JAR file to execute. +
    setJar(String) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Set a jar file to execute via the -jar option. +
    setJarfile(File) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +
    setJarFile(File) - +Method in class org.apache.tools.ant.taskdefs.ManifestClassPath +
    The JAR file to contain the classpath attribute in its manifest. +
    setJarsuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the jar suffix. +
    setJava(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the generated java code is produced. +
    setJava2iiopParams(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    If filled, the params are added to the java2iiop command. +
    setJavac(Javac) - +Method in interface org.apache.tools.ant.taskdefs.compilers.CompilerAdapter +
    Sets the compiler attributes, which are stored in the Javac task. +
    setJavac(Javac) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Set the Javac instance which contains the configured compilation + attributes. +
    setJavac(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the java compiler to use. +
    setJavacchome(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    The directory containing the JavaCC distribution. +
    setJavacchome(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    The directory containing the JavaCC distribution. +
    setJavacchome(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    The directory containing the JavaCC distribution. +
    setJavaCommand(Commandline) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Set the Java "command" for this ExecuteJava. +
    setJavacopts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Set the options to pass to the java compiler. +
    setJavafiles(boolean) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Indicate whether this stream contains Java source. +
    setJavafiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Set to true if modifying Java source files. +
    setJavaunicodeescape(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the JAVA_UNICODE_ESCAPE grammar option. +
    setJavaVersionProperty() - +Method in class org.apache.tools.ant.Project +
    Set the ant.java.version property and tests for + unsupported JVM versions. +
    setJDKProperties(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile +
    optional flag to use original Java properties (as opposed to + layout preserving properties) +
    setJDKversion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the JDK_VERSION option. +
    setJonasroot(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Set the JOnAS root directory. +
    setJonasroot(File) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    set the jonas root directory (-Dinstall.root=). +
    setJspc(JspC) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter +
    set the owner +
    setJspc(JspC) - +Method in interface org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapter +
    Sets the compiler attributes, which are stored in the Jspc task. +
    setJvm(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the command used to start the VM (only if forking). +
    setJvm(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    The command used to invoke a forked Java Virtual Machine. +
    setJvm(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    The command used to invoke the Java Virtual Machine, + default is 'java'. +
    setJvmargs(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the command line arguments for the JVM. +
    setJvmargs(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Set any additional arguments to pass to the weblogic JVM; optional. +
    setJvmDebugLevel(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Sets the weblogic.StdoutSeverityLevel to use when running the JVM that + executes ejbc; optional. +
    setJVMVersion(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the JVM version. +
    setKeep(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether the generated java source file should be kept after + compilation. +
    setKeepCompression(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether the original compression of entries coming from a ZIP + archive should be kept (for example when updating an archive). +
    setKeepCopy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    If true, keeps a copy of the file with a .keep extension. +
    setKeepCopy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout +
    If true, keep a copy of the file with a .keep extension. +
    setKeepEngine(boolean) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Whether to keep the script engine between calls. +
    setKeepformat(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    whether or not format should be preserved. +
    setKeepgenerated(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Setter method used to specify whether the Java source files generated by + the ejbc utility should be saved or automatically deleted. +
    setKeepgenerated(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask +
    If true, the Java source files which are generated by ejbc will be saved . +
    setKeepgenerated(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the keepgenerated flag. +
    setKeepgenerated(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Controls whether weblogic will keep the generated Java + files used to build the class files added to the + jar. +
    setKeepgeneric(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the keepgeneric flag. +
    setKeepgeneric(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    controls whether the generic file used as input to + ejbc is retained; defaults to false +
    setKeepgeneric(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    This controls whether the generic file used as input to + ejbdeploy is retained; optional, default false. +
    setKeepGoingMode(boolean) - +Method in class org.apache.tools.ant.Project +
    Set "keep-going" mode. +
    setKeeplinecolumn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the KEEP_LINE_COLUMN grammar option. +
    setKeeproot(boolean) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    flag to include the xml root tag as a + first value in the property name; optional, + default is true +
    setKey(String) - +Method in class org.apache.tools.ant.filters.ReplaceTokens.Token +
    Sets the token key +
    setKey(String) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    Name of the property name/value pair +
    setKey(String) - +Method in class org.apache.tools.ant.types.Environment.Variable +
    set the key +
    setKeyalg(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    The method to use when generating name-value pair. +
    setKeyfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Sets the keyfile for the user. +
    setKeyfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Sets the keyfile. +
    setKeypass(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    password for private key (if different); optional +
    setKeypass(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Password for private key (if different). +
    setKeys(String) - +Method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Sets the keys. +
    setKeysize(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Indicates the size of key generated. +
    setKeystore(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    keystore location; required +
    setKeystore(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Keystore location. +
    setKnownhosts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Sets the path to the file that has the identities of + all known hosts. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Sync +
    Label to sync client to; optional. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Only files marked with this label are extracted; optional. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
    The labeled version to operate on in SourceSafe. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel +
    The label to apply the the files in SourceSafe. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Label to check-out. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Label to get. +
    setLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL +
    Label to apply in SourceSafe. +
    setLanguage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Defines the language (required). +
    setLanguage(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Defines the language (required). +
    setLastModified(long) - +Method in class org.apache.tools.ant.types.Resource +
    Set the last modification attribute. +
    setLastModified(long) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Override setLastModified. +
    setLastModified(Touchable, long) - +Static method in class org.apache.tools.ant.util.ResourceUtils +
    Set the last modified time of an object implementing + org.apache.tools.ant.types.resources.Touchable . +
    setLazy(boolean) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    flag to control whether the presence of a signature file means a JAR is + signed; optional, default false +
    setLeaveTargetRevision(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the leavetargetrevision flag +
    setLength(long) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the target count number for use as a Condition. +
    setLength(Long) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Set the length to which files should be set. +
    setLenient(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Specify whether the parser should be validating. +
    setLevel(Echo.EchoLevel) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Set the logging level. +
    setLevel(int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Set the compression level to use. +
    setLevel(int) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Sets the compression level for subsequent entries. +
    setLHost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    setLine(String) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set the line to split into several commandline arguments. +
    setLineBreaks(String) - +Method in class org.apache.tools.ant.filters.StripLineBreaks +
    Sets the line-breaking characters. +
    setLines(long) - +Method in class org.apache.tools.ant.filters.HeadFilter +
    Sets the number of lines to be returned in the filtered stream. +
    setLines(long) - +Method in class org.apache.tools.ant.filters.TailFilter +
    Sets the number of lines to be returned in the filtered stream. +
    setLineStart(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    What a valid return value from PVCS looks like + when it describes a file. +
    setLink(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Create links to Javadoc output at the given URL. +
    setLink(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set the name of the link. +
    setLinkedFile(String) - +Method in class org.apache.tools.zip.AsiExtraField +
    Indicate that this entry is a symbolic link to the given filename. +
    setLinkfilename(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set the name of the file to which links will be written. +
    setLinkoffline(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Link to docs at "url" using package list at "url2" + - separate the URLs by using a space character. +
    setLinksource(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version. +
    setListfiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, list the source files being handed off to the compiler. +
    setListfiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    If true, list the source files being handed off to the compiler. +
    setListing(File) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    The output file for the "list" action. +
    setListing(File) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    The output file for the "list" action. +
    setLoaderRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Use the reference to locate the loader. +
    setLoaderRef(Reference) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Use the reference to locate the loader. +
    setLoaderRef(Reference) - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Sets the loaderRef. +
    setLocale(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the local to use in documentation generation. +
    setLocale(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The locale used to create date/time string. +
    setLocalFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Similiar to setFile but explicitly states that + the file is a local file. +
    setLocalFileDataData(byte[]) - +Method in class org.apache.tools.zip.UnrecognizedExtraField +
    Set the extra field data in the local file data - + without Header-ID or length specifier. +
    setLocalPath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Override the working directory and get to the specified path. +
    setLocalpath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Override the project working directory. +
    setLocalpath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Override the project working directory. +
    setLocalpath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Override the project working directory. +
    setLocalpath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Override the project working directory. +
    setLocalTodir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Similiar to setTodir but explicitly states + that the directory is a local. +
    setLocalTofile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Changes the file name to the given name while receiving it, + only useful if receiving a single file. +
    setLocaltunnels(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    Changes the comma-delimited list of local tunnels to establish + on the connection. +
    setLocation(Location) - +Method in exception org.apache.tools.ant.BuildException +
    Sets the file location where the error occurred. +
    setLocation(Location) - +Method in class org.apache.tools.ant.ProjectComponent +
    Sets the file/location where this task was defined. +
    setLocation(Location) - +Method in class org.apache.tools.ant.Target +
    Sets the location of this target's definition. +
    setLocation(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver +
    Sets the location for this resolver +
    setLocation(File) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Sets the property to the absolute filename of the + given file. +
    setLocation(File) - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Set the location. +
    setLocation(File) - +Method in class org.apache.tools.ant.types.Path +
    Adds a element definition to the path. +
    setLocation(String) - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    setLocator(Locator) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    sets the locator +
    setLock(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
    when set to "locked", Perforce will lock the label once created; optional. +
    setLog(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    Sets the log file where cleartool records + the status of the command. +
    setLogError(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Controls whether error output of exec is logged. +
    setLogError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set whether error output of exec is logged. +
    setLogError(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Controls whether error output of exec is logged. +
    setLogError(boolean) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Controls whether error output of exec is logged. +
    setLogFailedTests(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, write a single "FAILED" line for failed tests to Ant's + log system. +
    setLogger(XSLTLogger) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set a logger. +
    setLogger(XSLTLogger) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLoggerAware +
    Set the logger for this class. +
    setLogin(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Login to use when accessing VSS, formatted as "username,password". +
    setLogInputString(boolean) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set whether to include the value of the input string in log messages. +
    setLogInputString(boolean) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set whether to include the value of the input string in log messages. +
    setLoglevel(Recorder.VerbosityLevelChoices) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Sets the level to which this recorder entry should log to. +
    setLogListener(LogListener) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Set a log listener. +
    setLogo(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the compiler text logo is displayed when compiling. +
    setLongfile(String) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + setLongFile(String) is deprecated and is replaced with + setLongFile(Tar.TarLongFileMode) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the mode in its own class. +
    setLongfile(Tar.TarLongFileMode) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Set how to handle long files, those with a path>100 chars. +
    setLongFileMode(int) - +Method in class org.apache.tools.tar.TarOutputStream +
    Set the long file mode. +
    setLookahead(int) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the LOOKAHEAD grammar option. +
    setLoops(int) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Sets the number of times the source file should be played; optional. +
    setLPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    setLPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    setMacroDef(MacroDef) - +Method in class org.apache.tools.ant.taskdefs.MacroInstance +
    Called from MacroDef.MyAntTypeDefinition#create() +
    setMagicValue(String) - +Method in class org.apache.tools.ant.util.facade.FacadeTaskHelper +
    Used to set the value of the magic property. +
    setMailhost(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the host. +
    setMailport(int) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the mail server port. +
    setMailport(Integer) - +Method in class org.apache.tools.ant.taskdefs.SendEmail +
    Deprecated. since 1.5.x. + Use EmailTask.setMailport(int) instead. +
    setMainHandler(ProjectHelper2.AntHandler) - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Sets main handler +
    setManager(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Defines the manager. +
    setManager(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Defines the manager. +
    setManager(String) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Defines the manager. +
    setManager(String) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Defines the manager. +
    setManager(String) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Defines the manager. +
    setManager(String) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Defines the script manager - defaults to "auto". +
    setManagingComponent(ProjectComponent) - +Method in class org.apache.tools.ant.util.ConcatFileInputStream +
    Set a managing Task for + this ConcatFileInputStream. +
    setManagingComponent(ProjectComponent) - +Method in class org.apache.tools.ant.util.ConcatResourceInputStream +
    Set a managing ProjectComponent for + this ConcatResourceInputStream. +
    setManagingComponent(ProjectComponent) - +Method in class org.apache.tools.ant.util.LeadPipeInputStream +
    Set a managing ProjectComponent for + this LeadPipeInputStream. +
    setManagingTask(Task) - +Method in class org.apache.tools.ant.util.ConcatFileInputStream +
    Set a managing Task for + this ConcatFileInputStream. +
    setManagingTask(Task) - +Method in class org.apache.tools.ant.util.LeadPipeInputStream +
    Set a managing Task for + this LeadPipeInputStream. +
    setManifest(File) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    The manifest file to use. +
    setManifest(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the Manifest file to use when jarring. +
    setManifestEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    The character encoding to use in the manifest file. +
    setMapped(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    If true, generate separate write() calls for each HTML line + in the JSP. +
    setMapper(String, String, String) - +Method in class org.apache.tools.ant.types.PropertySet +
    Set a mapper to change property names. +
    setMarkersforall(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    If set to true, puts in markers for all changes, conflicting or not +
    SETMASK - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    setMaster(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    If true, changes mastership of the main branch + to the current site +
    setMatch(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    the regular expression pattern to match in the file(s); + required if no nested <regexp> is used +
    setMax(int) - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
    The minimum depth below the basedir before a file is selected. +
    setMaxLevelsOfSymlinks(int) - +Method in class org.apache.tools.ant.DirectoryScanner +
    The maximum number of times a symbolic link may be followed + during a scan. +
    setMaxLevelsOfSymlinks(int) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    The maximum number of times a symbolic link may be followed + during a scan. +
    setMaxmemory(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Set the maximum memory to be used by the jarsigner process +
    setMaxmemory(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Corresponds to -mx or -Xmx depending on VM version. +
    setMaxmemory(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the maximum memory to be used by the javadoc process +
    setMaxmemory(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Set the maximum memory to be used by all forked JVMs. +
    setMaxmemory(String) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Specify max memory of the JVM. +
    setMaxParallel(int) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Limit the command line length by passing at maximum this many + sourcefiles at once to the command. +
    setMaxParallel(int) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set max parallel. +
    setMaxParentLevels(int) - +Method in class org.apache.tools.ant.taskdefs.ManifestClassPath +
    Sets the maximum parent directory levels allowed when computing + a relative path. +
    setMaxTime(long) - +Method in class org.apache.tools.ant.taskdefs.Get +
    The time in seconds the download is allowed to take before + being terminated. +
    setMaxWait(long) - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Set the maximum length of time to wait. +
    setMaxWaitUnit(WaitFor.Unit) - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Set the max wait time unit +
    setMemoryInitialSize(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The initial size of the memory for the underlying VM + if javac is run externally; ignored otherwise. +
    setMemoryMaximumSize(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The maximum size of the memory for the underlying VM + if javac is run externally; ignored otherwise. +
    setMergeClassPathAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Whether to merge Class-Path attributes. +
    setMergeClassPathAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Whether to merge Class-Path attributes. +
    setMergefiles(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    Sets the files to be merged into the output. +
    setMessage(String, int) - +Method in class org.apache.tools.ant.BuildEvent +
    Sets the message and priority associated with this event. +
    setMessage(String) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Message to write. +
    setMessage(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand method to set the message. +
    setMessage(Message) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the message. +
    setMessage(String) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    A message giving further information on why the build exited. +
    setMessage(String) - +Method in class org.apache.tools.ant.taskdefs.Input +
    Sets the Message which gets displayed to the user during the build run. +
    setMessageFile(File) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand method to set the message from a file. +
    setMessageMimeType(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand method to set type of the text message, text/plain by default + but text/html or text/xml is quite feasible. +
    setMessageOutputLevel(int) - +Method in interface org.apache.tools.ant.BuildLogger +
    Sets the highest level of message this logger should respond to. +
    setMessageOutputLevel(int) - +Method in class org.apache.tools.ant.DefaultLogger +
    Sets the highest level of message this logger should respond to. +
    setMessageOutputLevel(int) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Set the the output level. +
    setMessageOutputLevel(int) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Sets the highest level of message this logger should respond to.. +
    setMessageOutputLevel(int) - +Method in class org.apache.tools.ant.XmlLogger +
    Set the logging level when using this as a Logger +
    setMethod(String) - +Method in class org.apache.tools.ant.taskdefs.condition.HasMethod +
    Set the name of the method. +
    setMethod(int) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Sets the default compression method for subsequent entries. +
    setMethods(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Sets names of individual test methods to be executed. +
    setMillis(long) - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970. +
    setMillis(long) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970. +
    setMillis(long) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Set the date/time in milliseconds since 1970. +
    setMillis(long) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Set the time; for users who prefer to express time in ms since 1970. +
    setMilliseconds(int) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    milliseconds to add to the sleep time +
    setMimeType(String) - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Sets the content type for the message +
    setMin(int) - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
    The minimum depth below the basedir before a file is selected. +
    setMinutes(int) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    minutes to add to the sleep time +
    setMkdirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Set whether nonexistent parent directories should be created + when touching new files. +
    setMkdirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Truncate +
    Set whether, when creating nonexistent files, nonexistent directories + should also be created. +
    setMode(IsLastModified.CompareMode) - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    The type of comparison to test. +
    setMode(Length.FileMode) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the execution mode for working with files. +
    setMode(ManifestTask.Mode) - +Method in class org.apache.tools.ant.taskdefs.ManifestTask +
    Update policy: either "update" or "replace"; default is "replace". +
    setMode(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Command launching mode: java or fork. +
    setMode(String) - +Method in class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
    A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 +
    setMode(int) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Sets the file or dir mode for this resource. +
    setMode(int) - +Method in class org.apache.tools.tar.TarEntry +
    Set the mode for this entry +
    setMode(int) - +Method in class org.apache.tools.zip.AsiExtraField +
    File mode of this file. +
    setModified(int) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Setter for the modified count +
    setModTime(long) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's modification time. +
    setModTime(Date) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's modification time. +
    setMulti(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the MULTI grammar option. +
    setMultiline(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    Whether to match should be multiline. +
    setMultiLine(boolean) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Whether to match should be multiline. +
    setName(String) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the definition's name. +
    setName(String) - +Method in class org.apache.tools.ant.Project +
    Set the name of the project, also setting the user + property ant.project.name. +
    setName(String) - +Method in class org.apache.tools.ant.Target +
    Sets the name of this target. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask.Module +
      +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Ant.TargetElement +
    Set the name of this TargetElement. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Apt.Option +
    Set the name attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Name of the loader. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsSigned +
    The signature name to check jarfile for. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Os +
    Sets the desired OS name +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.condition.TypeFound +
    the task or other type to look for +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Name of the definition +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Sets the personal / display name of the address +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.email.Header +
    Set the name of this Header. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DnameParam +
    Set the name attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletParam +
    Set the name of the parameter. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Set the name of the extension +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.PackageName +
    Set the name of the package +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.TagArgument +
    Sets the name of the tag. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Local +
    Set the name attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Attribute +
    The name of the attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Name of the definition +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Sets the name of this element. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
    The name of the attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Set the Attribute's name; required +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    The name of the section; optional -default is the main section. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute +
    Set the name of the parameter. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah.ClassArgument +
    Set the name attribute. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Set the name of the test class. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    The name of the counter; required +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Label +
    The name of the label; optional, default "AntLabel" +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    The name of the label; optional, default "AntLabel" +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject +
    Set the name of the project +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.Attribute +
    Set the attribute name +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement +
    set the tag name for this nested element +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    set the name under which this script will be activated in a build + file +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Sets the name. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute +
    Set the feature name. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property +
    setter for the name of the property +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef +
    Set the name of this definition. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    The name of the property to set. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Sets the name of the file to log to, and the name of the recorder + entry. +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Factory +
    Set the name of the factory +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty +
    set the name for this property +
    setName(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set the parameter name. +
    setName(String) - +Method in class org.apache.tools.ant.types.FileList.FileName +
    The name attribute of the file element. +
    setName(String) - +Method in class org.apache.tools.ant.types.Parameter +
    Set the name attribute. +
    setName(String) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    Sets the name pattern. +
    setName(String) - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Set the name of the permission. +
    setName(String) - +Method in class org.apache.tools.ant.types.PropertySet.PropertyRef +
    Set the name. +
    setName(String) - +Method in class org.apache.tools.ant.types.Resource +
    Set the name of this Resource. +
    setName(String) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Overridden, not allowed to set the name of the resource. +
    setName(String) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Set the pattern to compare names against. +
    setName(String) - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Enforce String immutability. +
    setName(String) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    The name of the file, or the pattern for the name, that + should be used for selection. +
    setName(String) - +Method in class org.apache.tools.ant.types.selectors.SignedSelector +
    The signature name to check jarfile for. +
    setName(String) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's name. +
    setName(String) - +Method in class org.apache.tools.zip.ZipEntry +
    Set the name of the entry. +
    setNameCRC32(long) - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    setNames(String, String) - +Method in class org.apache.tools.tar.TarEntry +
    Convenience method to set this entry's group and user names. +
    setNamespace(String) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    set the namespace of this schema. +
    setNamespace(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Set the namespace of the XML element associated with this component. +
    setNamespacePolicy(EchoXML.NamespacePolicy) - +Method in class org.apache.tools.ant.taskdefs.EchoXML +
    Set the namespace policy for the xml file +
    setNaming(EjbJar.NamingScheme) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Set the naming scheme used to determine the name of the generated jars + from the deployment descriptor +
    setNeeded(String) - +Method in class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
    Set the amount of space required. +
    setNeedsResolveProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Submit +
    property defining the need to resolve the change list +
    setNeedxmlfile(boolean) - +Method in class org.apache.tools.ant.taskdefs.War +
    Set the policy on the web.xml file, that is, whether or not it is needed +
    setNegate(boolean) - +Method in class org.apache.tools.ant.filters.LineContains +
    Set the negation mode. +
    setNegate(boolean) - +Method in class org.apache.tools.ant.filters.LineContainsRegExp +
    Set the negation mode. +
    setNegate(boolean) - +Method in class org.apache.tools.ant.types.PropertySet +
    Set whether to negate results. +
    setNegate(boolean) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    You can optionally reverse the selection of this selector, + thereby emulating an <exclude> tag, by setting the attribute + negate to true. +
    setNew(String, Object, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalProperties +
    Set a *new" property. +
    setNew(String, Object, PropertyHelper) - +Method in class org.apache.tools.ant.property.LocalPropertyStack +
    Set a *new" property. +
    setNew(String, Object, PropertyHelper) - +Method in interface org.apache.tools.ant.PropertyHelper.PropertySetter +
    Set a *new" property. +
    setNewCMP(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    If this is set to true, the new method for locating + CMP descriptors will be used; optional, default false. +
    setNewCMP(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Set the value of the newCMP scheme. +
    setNewenvironment(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Do not propagate old environment when new environment variables are specified. +
    setNewenvironment(boolean) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Set whether to propagate the default environment or not. +
    setNewenvironment(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    If true, use a completely new environment. +
    setNewenvironment(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, use a new environment when forked. +
    setNewer(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    A synonym for depends. +
    setNewer(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    A synonym for depends. +
    setNewPriority(int) - +Method in class org.apache.tools.ant.taskdefs.Nice +
    the new priority, in the range 1-10. +
    setNewProperty(String, String) - +Method in class org.apache.tools.ant.Project +
    Set a property if no value currently exists. +
    setNewProperty(Project, String, Object) - +Static method in class org.apache.tools.ant.PropertyHelper +
    A helper static method to set a new property + from a particular project. +
    setNewProperty(String, String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    setNewProperty(String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Sets a property if no value currently exists. +
    setNext(ComponentHelper) - +Method in class org.apache.tools.ant.ComponentHelper +
    Set the next chained component helper. +
    setNext(PropertyHelper) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. use the delegate mechanism instead +
    setNlabel(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    Set the nlabel flag +
    setNoCache(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Flag to disable the cache when set. +
    setNoCheckout(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir +
    If true, do not checkout element after creation. +
    setNoCheckout(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    If true, do not checkout element after creation. +
    setNocompil(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the nocompil flag. +
    setNoCompress(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Flag to disable compression when set. +
    setNocopynewtargetfiles(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets nocopynewtargetfiles flag +
    setNoData(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    If true, checks out the file but does not create an + editable file containing its data. +
    setNodedefaultvoid(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_DEFAULT_VOID grammar option. +
    setNodefactory(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_FACTORY grammar option. +
    setNodepackage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_PACKAGE grammar option. +
    setNodeprecated(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control deprecation infromation +
    setNodeprecatedlist(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control deprecated list generation +
    setNodeprefix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_PREFIX grammar option. +
    setNodescopehook(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_SCOPE_HOOK grammar option. +
    setNodeusesparser(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the NODE_USES_PARSER grammar option. +
    setNoEJBC(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Do not EJBC the jar after it has been put together; + optional, default false +
    setNoexec(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    If true, report only and don't change any files. +
    setNogenic(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the nogenic flag. +
    setNohelp(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control generation of help link. +
    setNoindex(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control generation of index. +
    setNoinform(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag to disable informational messages; optional, default false. +
    setNoNamespaceFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    identify a file containing the default schema +
    setNoNamespaceURL(String) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate +
    identify the URL of the default schema +
    setNonavbar(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control generation of the navigation bar. +
    setNonProxyHosts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    A list of hosts to bypass the proxy on. +
    setNoqualifier(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Enables the -noqualifier switch, will be ignored if Javadoc is not + the 1.4 version. +
    setNotco(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    If true, checkout fails if the element is already checked out to the current view. +
    setNotree(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control class tree generation. +
    setNovalidate(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag to disable the validation steps; optional, default false. +
    setNovalidation(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the novalidation flag. +
    setNowarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, enables the -nowarn option. +
    setNoWarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    If true, suppress warning messages. +
    setNoWarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    If true, warning messages are suppressed. +
    setNoWarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl +
    /** + Set the nowarn flag +
    setNoWarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    If true, suppress warning messages. +
    setNowarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag to disable warning and informational messages; optional, default false. +
    setNumdays(int) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Number of days for comparison. +
    setNusers(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Sets the users who may continue to + edit the object while it is locked. +
    setObjSel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Sets the object(s) to be locked +
    setObjSel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Sets the object(s) to be locked +
    setObjselect(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Sets the object(s) to be locked +
    setObjselect(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Sets the object(s) to be locked +
    setObjSelect(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Set the object to operate on. +
    setObsolete(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    If true, mark object as obsolete. +
    setOffline(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Set the offline attribute. +
    setOffset(int) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The numeric offset to the current time. +
    setOld(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Indicate whether Javadoc should produce old style (JDK 1.1) + documentation. +
    setOld(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    If true, specifies that old JDK1.0-style header files should be + generated. +
    setOldCMP(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Set the value of the oldCMP scheme. +
    setOldCMP(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Set the value of the oldCMP scheme. +
    setOnError(Definer.OnError) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    What to do if there is an error in loading the class. +
    setOnerror(SQLExec.OnError) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Action to perform when statement fails: continue, stop, or abort + optional; default "abort" +
    setOnetable(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    Sets the ONE_TABLE documentation option. +
    setOnMissingExtensionPoint(String) - +Method in class org.apache.tools.ant.taskdefs.BindTargets +
      +
    setOnMissingExtensionPoint(ProjectHelper.OnMissingExtensionPoint) - +Method in class org.apache.tools.ant.taskdefs.BindTargets +
      +
    setOnMissingFiltersFile(FilterSet.OnMissing) - +Method in class org.apache.tools.ant.types.FilterSet +
    Set the behavior WRT missing filtersfiles. +
    setOperation(PropertyFile.Entry.Operation) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    operation to apply. +
    setOptimize(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, compiles with optimization enabled. +
    setOptimizetokenmanager(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the OPTIMIZE_TOKEN_MANAGER grammar option. +
    setOptional(boolean) - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    sets the optional attribute +
    setOptional(boolean) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.TemplateElement +
    Sets whether this element is optional. +
    setOptional(boolean) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
    The optional attribute of the text element. +
    setOptions(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    Sets additional cabarc options that are not supported directly. +
    setOrb(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the orb to construct classpath. +
    setOrb(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Choose your ORB : RMI, JEREMIE, DAVID, ...; optional. +
    setOrdinary(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the ordinary flag +
    setOriginalfile(File) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    The file to patch; optional if it can be inferred from + the diff file +
    setOs(String) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Set the Operating System that this exec is to run in. +
    setOs(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    List of operating systems on which the command may be executed. +
    setOsFamily(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Restrict this execution to a single OS Family +
    setOtherambiguityCheck(int) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the OTHER_AMBIGUITY_CHECK grammar option. +
    setOut(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    Creates a writable file under a different filename. +
    setOut(File) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Specifies the output name for the styled result from the + in attribute; required if in is set +
    setOutfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.jlink +
    The file that will be created by this instance of jlink. +
    setOutfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask +
    The output file for this run of jlink. +
    setOutfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Set the name of the output file. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The file to direct standard output from the command. +
    setOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Set the filename to write the output to. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.AntStructure +
    The output file. +
    setOutput(Resource) - +Method in class org.apache.tools.ant.taskdefs.Echo +
    Resource to write to. +
    setOutput(String) - +Method in class org.apache.tools.ant.taskdefs.Exec +
    Deprecated. Set the output filename. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    File the output of the process is redirected to. +
    setOutput(PrintStream) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Deprecated. since 1.4.x. + manage output at the task level. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the File to which the output of the process is redirected. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    Sets the stream the formatter is supposed to write its results to. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Sets the stream the formatter is supposed to write its results to. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set output stream for formatter to use. +
    setOutput(OutputStream) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +
    Sets the stream the formatter is supposed to write its results to. +
    setOutput(OutputStream) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitResultFormatterMirror +
    Set the output stream. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Sets the stream the formatter is supposed to write its results to.. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Sets the stream the formatter is supposed to write its results to.. +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    setOutput(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Sets the stream the formatter is supposed to write its results to.. +
    setOutput(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.perforce.P4Handler +
    set any data to be written to P4's stdin +
    setOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    set any data to be written to P4's stdin +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Optional file to save stdout to. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    If used, stores the output of the command to the given file. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Output file name for the history. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    File the output of the process is redirected to. +
    setOutput(File[]) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Files the output of the process is redirected to. +
    setOutput(File) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the output file; + optional, defaults to the Ant log. +
    setOutput(Resource) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the output Resource; + optional, defaults to the Ant log. +
    setOutput(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Corresponds to <ant>'s + output attribute. +
    setOutput(File) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    File the output of the process is redirected to. +
    setOutputDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    If set ejbc will use this directory as the output + destination rather than a jar file. +
    setOutputdirectory(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    The directory to write the generated files to. +
    setOutputdirectory(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    The directory to write the generated files to. +
    setOutputdirectory(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    The directory to write the generated JavaCC grammar and node files to. +
    setOutputEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Sets the character encoding for outputting +
    setOutputEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set the character encoding for output files. +
    setOutputEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specifies the encoding that the files are + to be written in--same as input encoding by default. +
    setOutputEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the output encoding. +
    setOutputEncoding(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Set the output encoding. +
    setOutputfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    The outputfile to write the generated BNF documentation file to. +
    setOutputfile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    The outputfile to write the generated JavaCC grammar file to. +
    setOutputFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    Concatenates the resulting header or source files for all + the classes listed into this file. +
    setOutputFile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    The output file name. +
    setOutputFilterChains(Vector) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Set the output FilterChains. +
    setOutputPrintStream(PrintStream) - +Method in interface org.apache.tools.ant.BuildLogger +
    Sets the output stream to which this logger is to send its output. +
    setOutputPrintStream(PrintStream) - +Method in class org.apache.tools.ant.DefaultLogger +
    Sets the output stream to which this logger is to send its output. +
    setOutputPrintStream(PrintStream) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Set the output print stream. +
    setOutputPrintStream(PrintStream) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Sets the output stream to which this logger is to send its output.. +
    setOutputPrintStream(PrintStream) - +Method in class org.apache.tools.ant.XmlLogger +
    Set the output stream to which logging output is sent when operating + as a logger. +
    setOutputproperty(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Sets the property name whose value should be set to the output of + the process. +
    setOutputproperty(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the property name whose value should be set to the output of + the process. +
    setOutputproperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    If set, the output of the command will be stored in the given property. +
    setOutputProperty(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the output property for the current transformer. +
    setOutputProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Property name whose value should be set to the output of the process. +
    setOutputProperty(String) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Property name whose value should be set to the output of + the process. +
    setOutputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    sets a stream to which the output from the cvs executable should be sent +
    setOutputToFormatters(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, send any output generated by tests to the formatters. +
    setOverview(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Specify the file containing the overview to be included in the generated + documentation. +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Force overwrite existing destination file +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set overwrite mode regarding existing destination file(s). +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Should we overwrite files in dest, even if they are newer than + the corresponding entries in the archive? +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    If true, overwrite hijacked files. +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set whether to overwrite a file if there is a naming conflict. +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set overwrite mode. +
    setOverwrite(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Overwrite any existing destination file(s). +
    setOwner(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Chown +
    Set the owner atribute. +
    setOwningTarget(Target) - +Method in class org.apache.tools.ant.Task +
    Sets the target container of this task. +
    setPackage(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The package/module to operate upon. +
    setPackage(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    The package/module to analyze. +
    setPackage(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Indicate whether only package, protected and public classes and + members are to be included in the scope processed +
    setPackage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the name of the package the compiled jsp files should be in. +
    setPackage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Set the package under which the compiled classes go +
    setPackage(String) - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    name a package +
    setPackageList(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    The name of a file containing the packages to process. +
    setPackagelistLoc(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Set the packetlist location attribute. +
    setPackagelistURL(URL) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Set the packetlist location attribute. +
    setPackagenames(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the package names to be processed. +
    setPackages(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Set the packages to Javadoc on. +
    setParallel(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether to execute in parallel mode. +
    setParallel(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set parallel. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.filters.BaseParamFilterReader +
    Sets the parameters used by this filter, and sets + the filter to an uninitialized status. +
    setParameters(Parameter[]) - +Method in interface org.apache.tools.ant.types.Parameterizable +
    Set the parameters +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.BaseExtendSelector +
    Set all the Parameters for this custom selector, collected by + the ExtendSelector class. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Defined in org.apache.tools.ant.types.Parameterizable. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    When using this as a custom selector, this method will be called. +
    setParameters(Parameter[]) - +Method in class org.apache.tools.ant.types.selectors.TypeSelector +
    When using this as a custom selector, this method will be called. +
    setParent(ClassLoader) - +Method in class org.apache.tools.ant.AntClassLoader +
    Set the parent for this class loader. +
    setParentFirst(boolean) - +Method in class org.apache.tools.ant.AntClassLoader +
    Control whether class lookup is delegated to the parent loader first + or after this loader. +
    setParentFirst(boolean) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Set reverse attribute. +
    setParentFirst(boolean) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Whether to consult the parent classloader first. +
    setParentName(String) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Set the name of the parent. +
    setPartition(String) - +Method in class org.apache.tools.ant.taskdefs.condition.HasFreeSpace +
    Set the partition name. +
    setPassfile(File) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Password file to read passwords from. +
    setPassfile(File) - +Method in class org.apache.tools.ant.taskdefs.CVSPass +
    Password file to add the entry to. +
    setPassive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Specifies whether to use passive mode. +
    setPassive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Specifies whether to use passive mode. +
    setPassphrase(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Sets the passphrase for the users key. +
    setPassphrase(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Sets the passphrase. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.CVSPass +
    Password to be added to the password file. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the password for SMTP auth; this requires JavaMail. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the password for smtp auth. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.Get +
    password for the basic authentication. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Sets the password; required. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    The password of the user; optional. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the login password for the given user id. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the login password for the given user id. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Set the the login password to use + required if userid is set. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Set the the login password to use + required if userid is set. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The SourceSafe password. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Proxy password; required if user is set. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Sets the password for the user. +
    setPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Sets the password. +
    setPatchfile(File) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    The file containing the diff output; required. +
    setPath(Path) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Set the path to be used when running the Java class. +
    setPath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Set the path to use when loading the component. +
    setPath(Path) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set a single commandline argument and treats it like a + PATH--ensuring the right separator for the local platform + is used. +
    setPath(Path) - +Method in class org.apache.tools.ant.types.Environment.Variable +
    stringify path and assign to the value. +
    setPath(String) - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Set the path. +
    setPath(String) - +Method in class org.apache.tools.ant.types.Path +
    Parses a path definition and creates single PathElements. +
    setPathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Set the path to use by reference. +
    setPathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo +
    Adds a reference to a CLASSPATH defined elsewhere. +
    setPathref(Reference) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set a single commandline argument from a reference to a + path--ensuring the right separator for the local platform + is used. +
    setPathSep(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set the default path separator string; defaults to current JVM + File.pathSeparator. +
    setPattern(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsRegex +
      +
    setPattern(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceRegex +
    the from attribute +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Specify the pattern to use as a MessageFormat pattern. +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    Set the format of the datetime attribute. +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    Set the regular expression to match against +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    For int and date type only. +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Set the format of the datetime attribute. +
    setPattern(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The date/time pattern to be used. +
    setPattern(String) - +Method in class org.apache.tools.ant.types.RegularExpression +
    sets the regular expression pattern +
    setPattern(String) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Set the optional pattern to use with the datetime attribute. +
    setPattern(String) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Sets the pattern to be used for the SimpleDateFormat. +
    setPattern(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroMatcher +
    Set the regexp pattern from the String description. +
    setPattern(String) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher +
    Set the regexp pattern from the String description. +
    setPattern(String) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher +
    Set the regexp pattern from the String description. +
    setPattern(String) - +Method in interface org.apache.tools.ant.util.regexp.RegexpMatcher +
    Set the regexp pattern from the String description. +
    setPbranch(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the pbranch flag +
    setPerm(String) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Set the new permissions. +
    setPermissions(Permissions) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Set the permissions for the application run. +
    setPermissions(Permissions) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    Permissions for the test run. +
    setPermissions(Permissions) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Permissions for the test run. +
    setPlatform(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specifies the target platform. +
    setPlatform(int) - +Method in class org.apache.tools.zip.ZipEntry +
    Set the platform (UNIX or FAT). +
    setPname(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    Sets the pathname to be locked +
    setPname(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock +
    Sets the pathname to be locked +
    setPoint(String) - +Method in class org.apache.tools.ant.types.optional.image.Text +
    Set the number of points to be used. +
    setPollInterval(int) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Interval to poll for completed threads when threadCount or + threadsPerProcessor is specified. +
    setPolyType(String) - +Method in class org.apache.tools.ant.IntrospectionHelper.Creator +
    Used to override the class used to create the object. +
    setPolyType(String) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Set the polymorphic type for this element. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    Port used by CVS to communicate with the server. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.condition.Socket +
    Set the port attribute +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the smtp port. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the FTP port used by the remote server. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the FTP port used by the remote server. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Set the tcp port to connect to; default is 23. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Set the tcp port to connect to; default is 23. +
    setPort(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    The p4d server and port to connect to; + optional, default "perforce:1666" +
    setPort(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Proxy port; optional, default 80. +
    setPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Changes the port used to connect to the remote host. +
    setPort(int) - +Method in class org.apache.tools.mail.MailMessage +
    Set the port to connect to the SMTP host. +
    setPortExplicitlySpecified(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Whether the port has been explicitly specified by the user. +
    setPrefix(String) - +Method in class org.apache.tools.ant.filters.PrefixLines +
    Sets the prefix to add at the start of each input line. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.HostInfo +
    Set a prefix for the properties. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the prefix to load these properties under. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    If the prefix is set, then only properties which start with this + prefix string will be recorded. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Prefix to apply to properties loaded using file + or resource. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Sets the optional prefix string for the temp file. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp +
    Set a prefix for the properties. +
    setPrefix(String) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    the prefix to prepend to each property +
    setPrefix(String) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Prepend this prefix to the path for each archive entry. +
    setPrefix(String) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set the prefix to be placed in front of every part of the + argument. +
    setPrefix(String) - +Method in class org.apache.tools.ant.types.Commandline.Marker +
    Set the prefix to be placed in front of the inserted argument. +
    setPrefix(String) - +Method in class org.apache.tools.ant.types.PropertySet.PropertyRef +
    Set the prefix to use. +
    setPrefixSeparator(String) - +Method in class org.apache.tools.ant.taskdefs.ImportTask +
    The separator to use between prefix and target name, default is + ".". +
    setPrefixValues(boolean) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +
    setPrefixValues(boolean) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +
    setPrepend(File) - +Method in class org.apache.tools.ant.filters.ConcatFilter +
    Sets prepend attribute. +
    setPreprocessDir(File) - +Method in class org.apache.tools.ant.taskdefs.Apt +
    Set the preprocessdir attribute. +
    setPresent(PresentSelector.FilePresence) - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    This sets whether to select a file if its dest file is present. +
    setPreserve0Permissions(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Assume 0 Unix mode is intentional. +
    setPreserveDuplicates(boolean) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set the preserveDuplicates. +
    setPreserveEmptyDirs(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sync.SyncTarget +
    Whether empty directories matched by this fileset should be + preserved. +
    setPreserveLastModified(String) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Deprecated. since 1.5.x. + setPreserveLastModified(String) has been deprecated and + replaced with setPreserveLastModified(boolean) to + consistently let the Introspection mechanism work. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Give the copied files the same last modified time as the original files. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Give the copied files the same last modified time as the original files. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Set whether to preserve the last modified time as the original files. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Set to true to preserve modification times for "gotten" files. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Set to true to preserve modification times for "gotten" files. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    Whether the file timestamp shall be preserved even if the file + is modified. +
    setPreservelastmodified(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Sets flag to determine if file timestamp from + remote system is to be preserved during copy. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Whether the file timestamp shall be preserved even if the file + is modified. +
    setPreserveLastModified(boolean) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    true to indicate that the signed jar modification date remains the same + as the original. +
    setPreserveLeadingSlashes(boolean) - +Method in class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
    Flag to indicates whether leading `/'s should + be preserved in the file names. +
    setPreserveTime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin +
    If true, preserve the modification time. +
    setPreserveTime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem +
    If true, preserve the modification time. +
    setPreserveTime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    If true, modification time should be preserved from the VOB time. +
    setPrimaryReader(Reader) - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Sets the primary reader +
    setPrint(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Print result sets from the statements; + optional, default false +
    setPrintsummary(JUnitTask.SummaryAttribute) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, print one-line statistics for each test, or "withOutAndErr" + to also show standard output and error. +
    setPrivate(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Indicate whether all classes and + members are to be included in the scope processed +
    setProceed(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
      +
    setProcessErrorStream(InputStream) - +Method in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler +
    Install a handler for the error stream of the subprocess. +
    setProcessErrorStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Ignore. +
    setProcessErrorStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
      +
    setProcessErrorStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Set the error stream of the process. +
    setProcessErrorStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    connects the handler to the stderr of the Perforce process +
    setProcessErrorStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Set the InputStream from which to read the + standard error of the process. +
    setProcessInputStream(OutputStream) - +Method in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler +
    Install a handler for the input stream of the subprocess. +
    setProcessInputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Ignore. +
    setProcessInputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
      +
    setProcessInputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Install a handler for the input stream of the subprocess.. +
    setProcessInputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    connects the handler to the input stream into Perforce + used indirectly by tasks requiring to send specific standard input + such as p4label, p4change +
    setProcessInputStream(OutputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Set the OutputStream by means of which + input can be sent to the process. +
    setProcessor(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Set the name of the XSL processor to use; optional, default trax. +
    setProcessOutputStream(InputStream) - +Method in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler +
    Install a handler for the output stream of the subprocess. +
    setProcessOutputStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Set the inputstream +
    setProcessOutputStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    read the output stream to retrieve the new task number. +
    setProcessOutputStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Set the output stream of the process. +
    setProcessOutputStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    connects the handler to the stdout of the Perforce process +
    setProcessOutputStream(InputStream) - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Set the InputStream from which to read the + standard output of the process. +
    setProgressRegExp(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Progress regular expression which is used to parse the output + and dig out current progress optional; if not provided, + progress is increased every action and log output line +
    setProject(Project) - +Method in class org.apache.tools.ant.AntClassLoader +
    Set the project associated with this class loader +
    setProject(Project) - +Method in class org.apache.tools.ant.ComponentHelper +
    Sets the project for this component helper. +
    setProject(Project) - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Sets the project to work with. +
    setProject(Project) - +Method in class org.apache.tools.ant.filters.util.ChainReaderHelper +
    Set the project to work with +
    setProject(Project) - +Method in class org.apache.tools.ant.ProjectComponent +
    Sets the project object of this component. +
    setProject(Project) - +Method in class org.apache.tools.ant.PropertyHelper +
    Set the project for which this helper is performing property resolution. +
    setProject(Project) - +Method in class org.apache.tools.ant.Target +
    Sets the project this target belongs to. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    Set the project of this task. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Set this condition's Project. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Sets the project object of this component.. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    This method is called by the Ant runtime by reflection. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Store the project reference for passing it to nested components. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Set the project. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Set the project. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Set the project associated with this recorder entry. +
    setProject(Project) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set the current project +
    setProject(Project) - +Method in interface org.apache.tools.ant.TypeAdapter +
    Sets the project +
    setProject(Project) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Set the project. +
    setProject(Project) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Set the project. +
    setProject(Project) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Set the project. +
    setProject(Project) - +Method in class org.apache.tools.ant.types.Reference +
    Set the associated project. +
    setProject(Project) - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Set the Project instance for this InstanceOf selector. +
    setProject(Project) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
      +
    setProject(Project) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Set the project for this runner. +
    setProjectComponent(ProjectComponent) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Set the project component associated with this helper. +
    setProjectHandler(ProjectHelper2.AntHandler) - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Sets project handler +
    setProjectPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The SourceSafe project path. +
    setProjectReference(Object) - +Method in class org.apache.tools.ant.Project +
    Set a reference to this Project on the parameterized object. +
    setPromotiongroup(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Specifies the name of the promotiongroup argument +
    setPropagatesourcefiletype(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets flag indicating if one wants to propagate the source file type +
    setProperties(Hashtable) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Set the properties to be used in the test. +
    setProperties() - +Method in class org.apache.tools.ant.taskdefs.Redirector +
    Notify the Redirector that it is now okay to set any output + and/or error properties. +
    setPropertiesResource(Resource) - +Method in class org.apache.tools.ant.filters.ReplaceTokens +
    A resource containing properties, each of which is interpreted + as a token/value pair. +
    setProperty(String, String) - +Method in class org.apache.tools.ant.Project +
    Set a property. +
    setProperty(Project, String, Object) - +Static method in class org.apache.tools.ant.PropertyHelper +
    A helper static method to set a property + from a particular project. +
    setProperty(String, String, Object, boolean) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    setProperty(String, Object, boolean) - +Method in class org.apache.tools.ant.PropertyHelper +
    Default implementation of setProperty. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the name of the property which will be set if the particular resource + is available. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Basename +
    Property to set base name to. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the property to hold the generated checksum. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.condition.AntVersion +
    Set the name of the property to hold the ant version. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsSet +
    Set the property attribute +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Property to probe for +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    The name of the property to set. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Dirname +
    The name of the property to set. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Length +
    The property in which the length will be stored. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    Property name to save to. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    set the name of a property to fill with the URL +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.ManifestClassPath +
    Sets the property name to hold the classpath value. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask +
    The name of property to set if extensions are available. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask +
    The name of the property in which the location of + library is stored. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    A property to be set with the value of the counter +
    setProperty(String, String) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Sets a property. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set the name of the property into which the converted path will be placed. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Set the name of the property whose value is to serve as + the replacement value; required if value is not set. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Set the name of the property to set in task mode. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Sets the property you wish to assign the temporary file to. +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The property to receive the date/time string in the given pattern +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    The property to set if the target file is more up-to-date than + (each of) the source file(s). +
    setProperty(String) - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    the property to fill with the URL of the resource or class +
    setProperty(String, String) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    setPropertyFile(File) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    The name of a property file from which properties specified using nested + <replacefilter> elements are drawn; required only if + the property attribute of <replacefilter> is used. +
    setPropertyHook(String, String, Object, boolean, boolean, boolean) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. PropertyHelper chaining is deprecated. +
    setPropertyResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    A resource from which properties specified using nested + <replacefilter> elements are drawn; required + only if the property attribute of + <replacefilter> is used. +
    setProportions(Scale.ProportionsAttribute) - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Sets the behaviour regarding the image proportions. +
    setProtected(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Indicate whether only protected and public classes and members are to + be included in the scope processed +
    setProvider(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the MessageDigest algorithm provider to be used + to calculate the checksum. +
    setProvider(String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    Sets the MessageDigest algorithm provider to be used + to calculate the checksum. +
    setProvider(String) - +Method in class org.apache.tools.ant.types.spi.Service +
    Set the provider classname. +
    setProxy(Object) - +Method in class org.apache.tools.ant.RuntimeConfigurable +
    Sets the element to configure. +
    setProxy(Object) - +Method in class org.apache.tools.ant.TaskAdapter +
    Sets the target object to proxy for. +
    setProxy(Object) - +Method in class org.apache.tools.ant.taskdefs.AugmentReference +
    Sets the proxy object, whose methods are going to be + invoked by ant. +
    SetProxy - Class in org.apache.tools.ant.taskdefs.optional.net
    Sets Java's web proxy properties, so that tasks and code run in + the same JVM can have through-the-firewall access to remote web sites, + and remote ftp sites.
    SetProxy() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
      +
    setProxy(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    name of proxy; optional. +
    setProxy(Object) - +Method in interface org.apache.tools.ant.TypeAdapter +
    Sets the proxy object, whose methods are going to be + invoked by ant. +
    setProxyHost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    the HTTP/ftp proxy host. +
    setProxyPassword(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    Set the password for the proxy. +
    setProxyPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    the HTTP/ftp proxy port number; default is 80 +
    setProxyUser(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    set the proxy user. +
    setPublic(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Indicate whether only public classes and members are to be included in + the scope processed +
    setPublicId(String) - +Method in class org.apache.tools.ant.types.ResourceLocation +
      +
    setPvcsbin(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Specifies the location of the PVCS bin directory; optional if on the PATH. +
    setPvcsproject(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    The project within the PVCS repository to extract files from; + optional, default "/" +
    setQName(String) - +Method in class org.apache.tools.ant.UnknownElement +
    Set the namespace qname of the XML element. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    If true, suppress informational messages. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    If true and the file does not exist, do not display a diagnostic + message or modify the exit status to reflect an error. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.LoadResource +
    If true, suppress the load error report and set the + the failonerror value to false. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag, default true, to only output error messages. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    If true, output from the RPM build command will only be logged to DEBUG. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE +
    Enable quiet mode. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Enable quiet mode. +
    setQuiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    Work silently unless an error occurs; optional, default=false +
    setRawBlobs(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set whether to print raw BLOBs rather than their string (hex) representations. +
    setRdbms(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Execute task only if the lower case product name + of the DB matches this +
    setReadBufferSize(int) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    The size of the read buffer to use. +
    setReadonly(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the ReadOnly file attribute. +
    setReallyquiet(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    If true, suppress all messages. +
    setRealThing(Object) - +Method in class org.apache.tools.ant.UnknownElement +
    Set the configured object +
    setRebuild(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbc; optional, default true. +
    setRebuild(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbdeploy; optional, default true. +
    setRecentDateFormatConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the recentDateFormatConfig attribute. +
    setRecentDateFormatConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the recentDateFormatConfig attribute. +
    setRecordState(Boolean) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Turns off or on this recorder. +
    setRecurse(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    If true, recurse on subproject (default false). +
    setRecurse(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set recurse flag +
    setRecurse(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set recurse flag +
    setRecurse(boolean) - +Method in class org.apache.tools.ant.types.FilterSet +
    Set whether recursive token expansion is enabled. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin +
    Flag to recursively apply the action. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout +
    Flag to recursively apply the action. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
    Flag to recursively apply the action. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Add files recursively. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Check-in files recursively. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Check-out files recursively. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Get files recursively. +
    setRecursive(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Retrieve history recursively. +
    setRedoall(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    set the redoall flag +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.condition.IsReference +
    Set the refid attribute. +
    setRefid(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Sets the refid to search; should indicate a resource directly + or by way of a single-element ResourceCollection. +
    setRefid(String) - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Specify that the handler is a reference on the project; + this allows the use of a custom inputhandler. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Makes this instance in effect a reference to another ExtensionAdapter + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
    Makes this instance in effect a reference to another ExtensionSet + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Sets a reference to an Ant datatype + declared elsewhere. +
    setRefid(String) - +Method in class org.apache.tools.ant.taskdefs.PropertyHelperTask.DelegateElement +
    Set the refid. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Set the ResourceCollection reference. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Makes this instance in effect a reference to another instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.AntFilterReader +
    Makes this instance in effect a reference to another AntFilterReader + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.Assertions +
    Set the value of the refid attribute. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.DataType +
    Set the value of the refid attribute. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.FileList +
    Makes this instance in effect a reference to another FileList + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.FilterChain +
    Makes this instance in effect a reference to another FilterChain + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.Mapper +
    Make this Mapper instance a reference to another Mapper. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.Path +
    Makes this instance in effect a reference to another Path instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.PatternSet +
    Makes this instance in effect a reference to another PatternSet + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.PropertySet +
    Sets the value of the refid attribute. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Make this instance in effect a reference to another instance. +
    setRefId(String) - +Method in class org.apache.tools.ant.types.Reference +
    Set the reference id. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.Resource +
    Overrides the base version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.AbstractClasspathResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.Archives +
    Overrides the base version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.Files +
    Make this instance in effect a reference to another instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.MappedResource +
    Not really supported since mapper is never null. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Overrides the base version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Overrides the base version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Makes this instance in effect a reference to another ResourceList + instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Overrides the super version. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.TarFileSet +
    Makes this instance in effect a reference to another instance. +
    setRefid(Reference) - +Method in class org.apache.tools.ant.types.XMLCatalog +
    Makes this instance in effect a reference to another XMLCatalog + instance. +
    setRegex(String) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    If the regex is set, then only properties whose names match it + will be recorded. +
    setRegex(String) - +Method in class org.apache.tools.ant.types.PropertySet.PropertyRef +
    Set the regular expression to use to filter the properties. +
    setRegex(String) - +Method in class org.apache.tools.ant.types.resources.selectors.Name +
    Set the regular expression to compare names against. +
    setRegex(String) - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    The regular expression the file name will be matched against. +
    setRelative(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether the filenames should be passed on the command line as + absolute or relative pathnames. +
    setRelative(boolean) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Sets 'relative' attribute. +
    setRelativePath(String) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Relative path which combined with the baseURL attribute defines + the URL. +
    setRelease(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specify the CCM release. +
    setReloading(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, force ant to re-classload all classes for each JUnit TestCase +
    setReloadStylesheet(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Controls whether the stylesheet is reloaded for every transform. +
    setRemote(boolean) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Whether to use rlog against a remote repository instead of log + in a working copy's directory. +
    setRemotedir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the remote directory where files will be placed. +
    setRemotedir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the remote directory where files will be placed. +
    setRemoteFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Similiar to setFile but explicitly states that + the file is a remote file. +
    setRemoteTodir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Similiar to setTodir but explicitly states + that the directory is a remote. +
    setRemoteTofile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Changes the file name to the given name while sending it, + only useful if sending a single file. +
    setRemotetunnels(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    Changes the comma-delimited list of remote tunnels to establish + on the connection. +
    setRemove(String) - +Method in class org.apache.tools.ant.taskdefs.DefaultExcludes +
    Pattern to remove from the default excludes. +
    setRemoveComments(boolean) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
    Sets the behaviour for comments accompanying properties that + are being removed. +
    setRemoveKeepExtension(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells wether the trailing .keep in nocompile-mode should be removed + so that the resulting java source really ends on .java. +
    setRemoveNotFollowedSymlinks(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    Sets whether the symbolic links that have not been followed + shall be removed (the links, not the locations they point at). +
    setRemoveSource(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Flag (optional, default=false) + to remove the sources after the build. +
    setRemoveSpec(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    Flag (optional, default=false) to remove the spec file from SPECS +
    setRename(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate +
    If true, hijacked files are renamed with a .keep extension. +
    setReplace(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ContainsRegex +
      +
    setReplace(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceRegex +
    the to attribute +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCLock +
    If true, replace an existing lock. +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set the replace flag +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set the replace flag +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the replace flag +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the generated .java file should be replaced when compiling. +
    setReplace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. store replace attribute - this determines whether the target file + should be overwritten if present +
    setReplace(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ReplaceRegExp +
    The substitution pattern to place in the file(s) in place + of the regular expression. +
    setReplace(String) - +Method in class org.apache.tools.ant.taskdefs.Rename +
    Deprecated. Sets whether an existing file should be replaced. +
    setReplaceFilterFile(File) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Sets the name of a property file containing filters; optional. +
    setReplaceFilterResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Sets the name of a resource containing filters; optional. +
    setReplyTo(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand to set the replyto address element. +
    setReplyToList(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the replyto addresses. +
    setRepository(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    The network name of the PVCS repository; required. +
    setRequestMethod(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Http +
    Sets the method to be used when issuing the HTTP request. +
    setReserved(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    If true, checks out the file as reserved. +
    setReset(boolean) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Reset the classloader, if it already exists. +
    setResolveExecutable(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether to attempt to resolve the executable to a file. +
    setResolveLink(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    Sets whether Ant should resolve the link attribute relative + to the current basedir. +
    setResolvemode(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    values for resolvemode + + automatic -am + force -af + safe -as + theirs -at + yours -ay + +
    setResolver(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specifies the resolver. +
    setResolver(ApacheCatalogResolver) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalog +
    Set the resolver object to callback. +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the name of a Java resource which is required to set the property. +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Sets the resource to search +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    Name of the property resource to load + ant name/classname pairs from. +
    setResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the single resource for this task. +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the resource name of a property file to load. +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Set the name of the resource to which a link should be created. +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    The resource name of a property file to load +
    setResource(String) - +Method in class org.apache.tools.ant.taskdefs.WhichResource +
    name the resource to look for +
    setRestoreDeletedRevisions(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the restoredeletedrevisions flag +
    setRestrict(boolean) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Set the restrict attribute. +
    setRestrict(boolean) - +Method in class org.apache.tools.ant.taskdefs.Definer +
    The restrict attribute. +
    setResultProperty(String) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Sets the name of a property in which the return code of the + command should be stored. +
    setResultProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the name of the property in which the return code of the + command should be stored. +
    setRetainSource(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc +
    If true, the Java source files which are generated by the + ejbc process are retained. +
    setRetries(int) - +Method in class org.apache.tools.ant.taskdefs.Get +
    The number of retries to attempt upon error, defaults to 3. +
    setRetriesAllowed(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Defines how many times to retry executing FTP command before giving up. +
    setRetriesAllowed(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Defines how many times to retry executing FTP command before giving up. +
    setRetryCount(int) - +Method in class org.apache.tools.ant.taskdefs.Retry +
    set the number of times to retry the task +
    setReverse(boolean) - +Method in class org.apache.tools.ant.filters.SortFilter +
    Sets the sorting process will be in ascendant (reverse=false) + or to descendant (reverse=true). +
    setReverse(boolean) - +Method in class org.apache.tools.ant.taskdefs.Classloader +
    Deprecated. use setParentFirst with a negated argument instead +
    setReverse(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Flag the conversion to run in the reverse sense, + that is Ascii to Native encoding. +
    setReverse(boolean) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    Assume patch was created with old and new files swapped; optional, + default=false +
    setReversebranchmappings(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the reversebranchmappings flag +
    setReverseLoader(boolean) - +Method in class org.apache.tools.ant.taskdefs.DefBase +
    Deprecated. since 1.6.x. + stop using this attribute +
    setReverseLoader(boolean) - +Method in class org.apache.tools.ant.util.ClasspathUtils.Delegate +
    Delegate method handling the @reverseLoader attribute. +
    setRevertOnlyUnchanged(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Revert +
    flag to revert only unchanged files (p4 revert -a); optional, default false. +
    setRevision(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Only files with this revision are extract; optional. +
    setRHost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    setRmAll(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set rmall flag +
    setRmic(Rmic) - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Sets Rmic attributes +
    setRmic(Rmic) - +Method in interface org.apache.tools.ant.taskdefs.rmic.RmicAdapter +
    Sets the rmic attributes, which are stored in the Rmic task. +
    setRmicoptions(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Set the rmic options. +
    setRmicopts(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Set the options to pass to the rmi compiler. +
    setRootClass(String) - +Method in class org.apache.tools.ant.types.optional.depend.ClassfileSet +
    Set the root class attribute. +
    setRootClasses(Vector) - +Method in class org.apache.tools.ant.types.optional.depend.DependScanner +
    Sets the root classes to be used to drive the scan. +
    setRootDirectory(File) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    The directory to use for resolving file references. +
    setRoundUp(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether the file modification times will be rounded up to the + next even number of seconds. +
    setRowCountProperty(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Sets a given property to the number of rows in the first + statement that returned a row count. +
    setRowCountProperty(int) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
      +
    setRpmBuildCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    The executable to run when building; optional. +
    setRPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    setRPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    setRunTime(long) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Set the runtime. +
    setRuntimeConfigurableWrapper(RuntimeConfigurable) - +Method in class org.apache.tools.ant.Task +
    Sets the wrapper to be used for runtime configuration. +
    setSanitycheck(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the SANITY_CHECK grammar option. +
    setSavelog(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether the compiler messages will be written to NetRexxC.log as + well as to the console. +
    setScanForUnicodeExtraFields(boolean) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Whether unicode extra fields will be used if present. +
    setScanForUnicodeExtraFields(boolean) - +Method in class org.apache.tools.ant.taskdefs.Untar +
    No unicode extra fields in tar. +
    setScanIncludedDirectories(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether to style all files in the included directories as well; + optional, default is true. +
    setScope(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.TagArgument +
    Sets the scope of the tag. +
    setScriptClassLoader(ClassLoader) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Set the script classloader. +
    setSearchParents(boolean) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the searchParents attribute. +
    setSearchPath(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether to search nested, then + system PATH environment variables for the executable. +
    setSeconds(int) - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    seconds to add to the sleep time +
    setSecpropag(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the secpropag flag. +
    setSectionsonly(boolean) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    flag to compute hash of entire manifest; optional, default false +
    setSecurityManager() - +Method in class org.apache.tools.ant.types.Permissions +
    To be used by tasks wishing to use this security model before executing the part to be + subject to these Permissions. +
    setSeldirs(boolean) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for seldirs attribute. +
    setSelected(boolean) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    set the selected state + Intended for script use, not as an Ant attribute +
    setSelection(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    Set to true if the listener is to print information after + each selection event. +
    setSelectors(FileSelector[]) - +Method in class org.apache.tools.ant.DirectoryScanner +
    Set the selectors that will select the filelist. +
    setSelectors(FileSelector[]) - +Method in interface org.apache.tools.ant.types.selectors.SelectorScanner +
    Sets the selectors the scanner should use. +
    setSelres(boolean) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for selres attribute. +
    setSemanticAttributes(boolean) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Attribute to enable special handling of attributes - see ant manual. +
    setSep(String) - +Method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Sets the separator between name=value arguments + in setKeys(). +
    setSeparator(String) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    set the separator for the multi-url option. +
    setSeparator(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the remote file separator character. +
    setSeparator(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the remote file separator character. +
    setSerialwarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Control warnings about serial tag. +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Socket +
    Set the server attribute +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    The address or URL for the server where the component will be deployed. +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the FTP server to send files to. +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the FTP server to send files to. +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Set the hostname or address of the remote server. +
    setServer(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Set the hostname or address of the remote server. +
    setServerLanguageCodeConfig(FTP.LanguageCode) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the serverLanguageCode attribute. +
    setServerLanguageCodeConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the serverLanguageCode attribute. +
    setServerpath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Directory where srssafe.ini resides. +
    setServerTimeZoneConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the serverTimeZoneConfig attribute. +
    setServerTimeZoneConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the serverTimeZoneConfig attribute. +
    setServerVersionProperty(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    Set a property where to store the CVS server version +
    setSetBeans(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Set the setbeans attribute. +
    setSetBeans(boolean) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Set the setbeans attribute. +
    setSetBeans(boolean) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Set the setbeans attribute. +
    setSetBeans(boolean) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Set the setbeans attribute. +
    setSetBeans(boolean) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Set the setbeans attribute. +
    setSetonempty(boolean) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set whether the specified property will be set if the result + is the empty string. +
    setSftp(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Setting this to true to use sftp protocol. +
    setShared(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the shared flag +
    setShortMonthNamesConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the shortMonthNamesConfig attribute +
    setShortMonthNamesConfig(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the shortMonthNamesConfig attribute +
    setShowduration(int) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    how long to show the splash screen in milliseconds, + optional; default 5000 ms. +
    setShowFilter(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat +
    Sets the filter that one wants applied. +
    setShowheaders(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Print headers for result sets from the + statements; optional, default true. +
    setShowOutput(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    If true, send any output generated by tests to Ant's logging system + as well as to the formatters. +
    setShowtrailers(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Print trailing info (rows affected) for the SQL + Addresses Bug/Request #27446 +
    setShowWarnings(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    whether to show SQLWarnings as WARN messages. +
    setShutdownTime(long) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the shutdownTime attribute. +
    setShutdownUnit(WaitFor.Unit) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the shutdownunit attribute. +
    setSigalg(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    The algorithm to use in signing. +
    setSigfile(String) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    name of .SF/.DSA file; optional +
    setSignedjar(File) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    name of signed JAR file; optional +
    setSimulationMode(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the simulationmode flag +
    setSimulationmode(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync +
    -n flag of p4 labelsync - display changes without actually doing them +
    setSimulationmode(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve +
    sets a flag +
    setSingleLine(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    Whether to treat input as singleline ('.' matches newline). +
    setSingleLine(boolean) - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Whether to treat input as singleline ('.' matches newline). +
    setSiteCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the siteCommand attribute. +
    setSiteCommand(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the siteCommand attribute. +
    setSize(long) - +Method in class org.apache.tools.ant.types.Resource +
    Set the size of this Resource. +
    setSize(long) - +Method in class org.apache.tools.ant.types.resources.ResourceDecorator +
    Override setSize. +
    setSize(long) - +Method in class org.apache.tools.ant.types.resources.selectors.Size +
    Set the size to compare against. +
    setSize(long) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's file size. +
    setSkip(long) - +Method in class org.apache.tools.ant.filters.HeadFilter +
    Sets the number of lines to be skipped in the filtered stream. +
    setSkip(long) - +Method in class org.apache.tools.ant.filters.TailFilter +
    Sets the number of lines to be skipped in the filtered stream. +
    setSkipEmptyFilesets(boolean) - +Method in class org.apache.tools.ant.taskdefs.Chmod +
    This is not allowed for Chmod. +
    setSkipEmptyFilesets(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether empty filesets will be skipped. +
    setSkipEmptyFilesets(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask +
    Prevent the skipping of empty filesets +
    setSkipEmptyFilesets(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set skip empty file sets. +
    setSkipExisting(boolean) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Skip files that already exist locally. +
    setSkipFailedTransfers(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred. +
    setSkipFailedTransfers(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred. +
    setSocksProxyHost(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    The name of a Socks server. +
    setSocksProxyPort(int) - +Method in class org.apache.tools.ant.taskdefs.optional.net.SetProxy +
    Set the ProxyPort for socks connections. +
    setSosCmd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The directory where soscmd(.exe) is located. +
    setSosHome(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Path to the SourceOffSite home directory. +
    setSosServerPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The address and port of SourceOffSite Server, + for example 192.168.0.1:8888. +
    setSource(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Value of the -source command-line switch; will be ignored by + all implementations except modern, jikes and gcj (gcj uses + -fsource). +
    setSource(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Enables the -source switch, will be ignored if Javadoc is not + the 1.4 version. +
    setSource(File) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy +
    The filename of the component to be deployed; optional + depending upon the tool and the action. +
    setSource(File) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
    Sets the location of the file to get the audio; required. +
    setSourceBase(File) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    optional directory to save generated source files to. +
    setSourcedir(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells the NetRexx compiler to store the class files in the same + directory as the source files. +
    setSourcefiles(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the list of source files to process. +
    setSourcepath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the sourcepath to be used for this compilation. +
    setSourcepath(Path) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Specify where to find source file +
    setSourcepathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Adds a reference to a source path defined elsewhere. +
    setSourcepathRef(Reference) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Adds a reference to a CLASSPATH defined elsewhere. +
    setSpawn(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether or not you want the process to be spawned. +
    setSpawn(boolean) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Deprecated.   +
    setSpawn(boolean) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set whether or not you want the process to be spawned; + default is not spawned. +
    setSpecFile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    The name of the spec File to use; required. +
    setSpecificationVendor(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the specificationVendor of extension. +
    setSpecificationVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    Set the specificationVersion of extension. +
    setSplitindex(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Generate a split index +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Copydir +
    Deprecated. The src attribute +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Copyfile +
    Deprecated. Set the source file. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.email.Message +
    Sets the source file of the message +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Set the path to zip-file. +
    setSrc(URL) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Set an URL to get. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.KeySubst +
    Deprecated. Set the source file. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
    Set the directory containing the source jsp's +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Native2Ascii +
    Set the source directory in which to find files to convert. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef +
    Load the script from an external file ; optional. +
    setSrc(String) - +Method in class org.apache.tools.ant.taskdefs.optional.Script +
    Load the script from an external file ; optional. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    the file to compress; required. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Rename +
    Deprecated. Sets the file to be renamed. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Set the name of the SQL file to be run. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.SQLExec.Transaction +
    Set the source file attribute. +
    setSrc(String) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Deprecated. since 1.5.x. + setSrc(String) is deprecated and is replaced with + setSrc(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +
    setSrc(File) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    The file to expand; required. +
    setSrc(File) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Set the source Archive file for the archivefileset. +
    setSrc(File) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Sets the srcFile for scanning. +
    setSrc(Resource) - +Method in class org.apache.tools.ant.types.ArchiveScanner +
    Sets the src for scanning. +
    setSrc(File) - +Method in class org.apache.tools.ant.types.optional.AbstractScriptComponent +
    Load the script from an external file ; optional. +
    setSrc(File) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    Load the script from an external file ; optional. +
    setSrc(File) - +Method in class org.apache.tools.ant.types.optional.ScriptSelector +
    Load the script from an external file ; optional. +
    setSrc(File) - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Load the script from an external file; optional. +
    setSrc(File) - +Method in class org.apache.tools.ant.util.ScriptRunnerHelper +
    Load the script from an external file ; optional. +
    setSrcdir(File) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Set the source dir to find the source text files. +
    setSrcdir(Path) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Set the source directories to find the source Java files. +
    setSrcdir(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Set the directories path to find the Java source files. +
    setSrcdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.EjbJar +
    Sets the source directory, which is the directory that + contains the classes that will be added to the EJB jar. +
    setSrcdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Set the source dir to find the image files. +
    setSrcDir(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the path for source JSP files. +
    setSrcDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Set the source dir to find the source Java files. +
    setSrcDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. Set the source dir to find the files to be renamed. +
    setSrcEncoding(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets source file encoding scheme; optional, + defaults to encoding of local system. +
    setSrcFile(File) - +Method in class org.apache.tools.ant.taskdefs.LoadFile +
    Sets the file to load. +
    setSrcFile(File) - +Method in class org.apache.tools.ant.taskdefs.LoadProperties +
    Set the file to load. +
    setSrcfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Sets the input file. +
    setSrcfile(File) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    The file that must be older than the target file + if the property is to be set. +
    setSrcResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    The resource to pack; required. +
    setSrcResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.SQLExec.Transaction +
    Set the source resource attribute. +
    setSrcResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    The resource to expand; required. +
    setSrcResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    The resource to pack; required. +
    setSrcResource(Resource) - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Set the source Archive file for the archivefileset. +
    setSsdir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    Directory where ss.exe resides. +
    setSSL(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set whether to send data over SSL. +
    setSSL(boolean) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set whether to send the mail through SSL. +
    setStart(Date) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the date at which the changelog should start. +
    setStart(int) - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Set the start of the arc. +
    setStartDate(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the start date. +
    setStartTag(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set the tag at which the changelog should start. +
    setStartTag(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff +
    Set the start tag. +
    setStartToken(String) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets starting token to identify keys; required. +
    setState(int) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF.OneLiner +
    Deprecated. Set the state. +
    setStatic(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the STATIC grammar option. +
    setStatic(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the STATIC grammar option. +
    setStatus(int) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Set the status code to associate with the thrown Exception. +
    setStop(int) - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Set the stop of the arc. +
    setStorepass(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    password for keystore integrity; required +
    setStorepass(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Password for keystore integrity. +
    setStoretype(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    keystore type; optional +
    setStoretype(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Keystore type. +
    setStreamHandler(ExecuteStreamHandler) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Set the stream handler to use. +
    setStrict(Jar.StrictMode) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Activate the strict mode. +
    setStrictargs(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells the NetRexx compiler that method calls always need parentheses, + even if no arguments are needed, e.g. +
    setStrictassign(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells the NetRexx compile that assignments must match exactly on type. +
    setStrictcase(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Specifies whether the NetRexx compiler should be case sensitive or not. +
    setStrictDelimiterMatching(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    If false, delimiters will be searched for in a case-insesitive + manner (i.e. +
    setStrictimport(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether classes need to be imported explicitly using an import + statement. +
    setStrictprops(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether local properties need to be qualified explicitly using + this. +
    setStrictsignal(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the compiler should force catching of exceptions by explicitly + named types. +
    setString(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Contains +
    The string to search in. +
    setString(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Matches +
    Set the string +
    setString(String) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the string whose length to get. +
    setString(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask +
    the message as an attribute +
    setString(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask +
    the message as an attribute +
    setString(String) - +Method in class org.apache.tools.ant.types.optional.image.Text +
    Set the string to be used as text. +
    setStrip(int) - +Method in class org.apache.tools.ant.taskdefs.Patch +
    Strip the smallest prefix containing num leading slashes + from filenames. +
    setStripAbsolutePathSpec(boolean) - +Method in class org.apache.tools.ant.taskdefs.Expand +
    Whether leading path separators should be stripped. +
    setStroke(String) - +Method in class org.apache.tools.ant.types.optional.image.BasicShape +
    Set the stroke attribute. +
    setStrokewidth(int) - +Method in class org.apache.tools.ant.types.optional.image.BasicShape +
    Set the stroke width attribute. +
    setStubs(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    If true, generate C declarations from the Java object file (used with old). +
    setStubVersion(String) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Specify the JDK version for the generated stub code. +
    setStyle(MSVSSHISTORY.BriefCodediffNofile) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Output style. +
    setStyle(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Name of the stylesheet to use - given either relative + to the project's basedir or as an absolute path; required. +
    setStyledir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    set the style directory. +
    setStylesheet(File) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the stylesheet file. +
    setStylesheet(Resource) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the stylesheet file. +
    setStylesheet(File) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLiaison +
    set the stylesheet to use for the transformation. +
    setStylesheet(Resource) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLiaison3 +
    sets the stylesheet to use as a resource +
    setStylesheetfile(File) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Specifies the CSS stylesheet file to use. +
    setSubject(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the subject line of the email. +
    setSubject(String) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the subject. +
    setSubject(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the subject of the mail message. +
    setSubstring(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Contains +
    The string to search for. +
    setSubstring(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceContains +
    Sets the substring to look for +
    setSubSystem(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specifies the subsystem. +
    setSuffix(String) - +Method in class org.apache.tools.ant.filters.SuffixLines +
    Sets the suffix to add at the end of each input line. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.Basename +
    Optional suffix to remove from base name. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Setter used to store the suffix for the generated borland jar file. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool +
    Setter method used to specify the filename suffix (for example, ".jar") + for the JAR files to be created. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
    Setter used to store the suffix for the generated JBoss jar file. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Setter used to store the suffix for the generated weblogic jar file. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    String value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file. +
    setSuffix(String) - +Method in class org.apache.tools.ant.taskdefs.TempFile +
    Sets the optional suffix string for the temp file. +
    setSuffix(String) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set the suffix to be placed at the end of every part of the + argument. +
    setSuffix(String) - +Method in class org.apache.tools.ant.types.Commandline.Marker +
    Set the suffix to be placed at the end of the inserted argument. +
    setSummary(boolean) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Indicates whether a summary of the replace operation should be + produced, detailing how many token occurrences and files were + processed; optional, default=false. +
    setSuppressDelims(boolean) - +Method in class org.apache.tools.ant.util.StringTokenizer +
    attribute suppressdelims - suppress delimiters. +
    setSuppressDeprecation(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells whether we should filter out any deprecation-messages + of the compiler out. +
    setSuppressExceptionNotSignalled(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the task should suppress the "FooException is in SIGNALS list + but is not signalled within the method", which is sometimes rather + useless. +
    setSuppressMethodArgumentNotUsed(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the task should suppress the "Method argument is not used" in + strictargs-Mode, which can not be suppressed by the compiler itself. +
    setSuppressPrivatePropertyNotUsed(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the task should suppress the "Private property is defined but + not used" in strictargs-Mode, which can be quite annoying while + developing. +
    setSuppressVariableNotUsed(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether the task should suppress the "Variable is set but not used" in + strictargs-Mode. +
    setSuppressWarnings(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether to suppress warning messages of the processor. +
    setSymbols(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Sets whether debug symbols should be generated into the class file. +
    setSystem(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.windows.Attrib +
    Set the System file attribute. +
    setSystem() - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Cache the system properties and set the system properties to the + new values. +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    This is what the test has written to System.err. +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + This is what the test has written to System.err +
    setSystemError(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +
    This is what the test has written to System.err +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    This is what the test has written to System.err. +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    This is what the test has written to System.err. +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    setSystemError(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    This is what the test has written to System.err. +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    This is what the test has written to System.out. +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + This is what the test has written to System.out +
    setSystemOutput(String) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +
    This is what the test has written to System.out +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    This is what the test has written to System.out. +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    This is what the test has written to System.out. +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    setSystemOutput(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    This is what the test has written to System.out. +
    setSystemProperties() - +Method in class org.apache.tools.ant.Project +
    Add all system properties which aren't already defined as + user properties to the project properties. +
    setSystemProperties(CommandlineJava.SysProperties) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Set the system properties to use when running the Java class. +
    setSystemProperties() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Cache current system properties and set them to those in this + Java command. +
    setSystemTypeKey(FTP.FTPSystemType) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the systemTypeKey attribute. +
    setSystemTypeKey(FTPTask.FTPSystemType) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the systemTypeKey attribute. +
    setTab(FixCrLfFilter.AddAsisRemove) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Specify how tab characters are to be handled. +
    setTab(FixCRLF.AddAsisRemove) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specify how tab characters are to be handled. +
    setTablength(int) - +Method in class org.apache.tools.ant.filters.FixCrLfFilter +
    Specify tab length in characters. +
    setTablength(int) - +Method in class org.apache.tools.ant.filters.TabsToSpaces +
    Sets the tab length. +
    setTablength(int) - +Method in class org.apache.tools.ant.taskdefs.FixCRLF +
    Specify tab length in characters. +
    setTag(String) - +Method in class org.apache.tools.ant.taskdefs.AbstractCvsTask +
    The tag of the package/module to operate upon. +
    setTarfile(File) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + For consistency with other tasks, please use setDestFile(). +
    setTarget(String) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    The target of the new Ant project to execute. +
    setTarget(String) - +Method in class org.apache.tools.ant.taskdefs.CallTarget +
    Set target to execute. +
    setTarget(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Sets the target VM that the classes will be compiled for. +
    setTarget(File) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    The grammar file to process. +
    setTarget(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
    Sets the target +
    setTarget(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    The grammar file to process. +
    setTarget(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    The javacc grammar file to process. +
    setTarget(File) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    The jjtree grammar file to process. +
    setTarget(String) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    The target to call on the different sub-builds. +
    setTargetdir(File) - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    The name of the file or directory which is checked for out-of-date + files. +
    setTargetdir(File) - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    The name of the file or directory which is checked for matching + files. +
    setTargetFile(File) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    The file which must be more up-to-date than (each of) the source file(s) + if the property is to be set. +
    setTargetHandler(ProjectHelper2.AntHandler) - +Static method in class org.apache.tools.ant.helper.ProjectHelper2 +
    Sets target handler +
    setTargetos(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Deprecated. since 1.5.x. + Use the method taking a TargetOs argument instead. +
    setTargetos(PathConvert.TargetOs) - +Method in class org.apache.tools.ant.taskdefs.PathConvert +
    Set targetos to a platform to one of + "windows", "unix", "netware", or "os/2"; + current platform settings are used by default. +
    setTargets(String) - +Method in class org.apache.tools.ant.taskdefs.BindTargets +
      +
    setTask(Task) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the owning task. +
    setTask(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck +
    Specifies the task number used to check + in the file (may use 'default'). +
    setTask(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
    Specifies the task number used to checkin + the file (may use 'default'). +
    setTask(Task) - +Method in interface org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool +
    Set the task which owns this tool +
    setTask(Task) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Set the task which owns this tool +
    setTask(ServerDeploy) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Sets the parent task. +
    setTask(ServerDeploy) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Sets the parent task. +
    setTask(ServerDeploy) - +Method in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    Sets the parent task. +
    setTaskName(String) - +Method in class org.apache.tools.ant.Task +
    Sets the name to use in logging messages. +
    setTaskName(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ConditionBase +
    Sets the name to use in logging messages. +
    setTaskType(String) - +Method in class org.apache.tools.ant.Task +
    Sets the name with which the task has been invoked. +
    setTempdir(File) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    Where Ant should place temporary files. +
    setTempdir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    The directory, where ejbdeploy will write temporary files; + optional, defaults to '_ejbdeploy_temp'. +
    setTempdir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Where Ant should place temporary files. +
    setTemplates(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
    Set to true if the listener is to print an event whenever a + template is invoked. +
    setText(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJDoc +
    Sets the TEXT BNF documentation option. +
    setText(String) - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    The string to search for within a file. +
    setTextfile(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.FilesMatch +
    Set whether to ignore line endings when comparing files. +
    setThreadContextLoader() - +Method in class org.apache.tools.ant.AntClassLoader +
    Sets the current thread's context loader to this classloader, storing + the current loader value for later resetting. +
    setThreadCount(int) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Statically determine the maximum number of tasks to execute + simultaneously. +
    setThreadsPerProcessor(int) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Dynamically generates the number of threads to execute based on the + number of available processors (via + java.lang.Runtime.availableProcessors()). +
    setTime(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Asks the NetRexx compiler to print compilation times to the console + Valid true values are "yes", "on" or "true". +
    setTimeDiffAuto(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    "true" to find out automatically the time difference + between local and remote machine. +
    setTimeDiffAuto(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    "true" to find out automatically the time difference + between local and remote machine. +
    setTimeDiffMillis(long) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    number of milliseconds to add to the time on the remote machine + to get the time on the local machine. +
    setTimeDiffMillis(long) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    number of milliseconds to add to the time on the remote machine + to get the time on the local machine. +
    setTimeout(int) - +Method in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Set the timeout for the reachability test in seconds. +
    setTimeout(Long) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the timeout in milliseconds after which the process will be killed. +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set the timeout in milliseconds after which the process will be killed. +
    setTimeout(Long) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Set the timeout for this ExecuteJava. +
    setTimeout(Long) - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set the timeout in milliseconds after which the process will be killed. +
    setTimeout(Long) - +Method in class org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask +
    Set the timeout value (in milliseconds). +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Set the timeout value (in milliseconds). +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecRead +
    a timeout value that overrides any task wide timeout. +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    set a default timeout in seconds to wait for a response, + zero means forever (the default) +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    set a default timeout in seconds to wait for a response, + zero means forever (the default) +
    setTimeout(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetRead +
    a timeout value that overrides any task wide timeout. +
    setTimeout(long) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    The connection can be dropped after a specified number of + milliseconds. +
    setTimeout(long) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
    The connection can be dropped after a specified number of + milliseconds. +
    setTimeout(long) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the timeout attribute. +
    setTimeout(long) - +Method in class org.apache.tools.ant.taskdefs.Parallel +
    Sets the timeout on this set of tasks. +
    setTimeout(long) - +Method in class org.apache.tools.ant.util.OutputStreamFunneler +
    Set the timeout for this OutputStreamFunneler. +
    setTimeoutProperty(String) - +Method in class org.apache.tools.ant.taskdefs.WaitFor +
    Name the property to set after a timeout. +
    setTimeoutUnit(WaitFor.Unit) - +Method in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Set the timeoutunit attribute. +
    setTimestampGranularity(FTP.Granularity) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the timestampGranularity attribute +
    setTimestampGranularity(FTPTask.Granularity) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the timestampGranularity attribute +
    setTimezone(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The timezone to use for displaying time. +
    setTitle(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.GroupArgument +
    Set the title attribute using a string. +
    setTo(String) - +Method in class org.apache.tools.ant.filters.TokenFilter.ReplaceString +
    the to attribute +
    setTo(String) - +Method in class org.apache.tools.ant.taskdefs.PathConvert.MapEntry +
    Set the replacement text to use when from is matched; required. +
    setTo(String) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the argument to FileNameMapper.setTo +
    setTo(String) - +Method in class org.apache.tools.ant.types.mappers.CutDirsMapper +
    Empty implementation. +
    setTo(String) - +Method in class org.apache.tools.ant.types.mappers.FilterMapper +
    From attribute not supported. +
    setTo(String) - +Method in class org.apache.tools.ant.types.optional.ScriptMapper +
    Sets the to part of the transformation rule. +
    setTo(String) - +Method in class org.apache.tools.ant.util.ContainerMapper +
    Empty implementation. +
    setTo(String) - +Method in interface org.apache.tools.ant.util.FileNameMapper +
    Sets the to part of the transformation rule. +
    setTo(String) - +Method in class org.apache.tools.ant.util.FlatFileNameMapper +
    Ignored. +
    setTo(String) - +Method in class org.apache.tools.ant.util.GlobPatternMapper +
    Sets the "to" pattern. +
    setTo(String) - +Method in class org.apache.tools.ant.util.IdentityMapper +
    Ignored. +
    setTo(String) - +Method in class org.apache.tools.ant.util.MergingMapper +
    Sets the name of the merged file. +
    setTo(String) - +Method in class org.apache.tools.ant.util.RegexpPatternMapper +
    Sets the "to" pattern. +
    setToChange(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen +
    The changelist to move files to; required. +
    setToDate(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Date representing the 'end' of the range. +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the root directory where checksum files will be + written/read +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set the destination directory. +
    setToDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
    Sets Destination directory; required. +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    set the destination directory. +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Sets the destination directory. +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Set the destination directory where the results should be written. +
    setTodir(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.Scp +
    Sets the location where files will be transferred to. +
    setTodir(File) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Sets the destination directory. +
    setToExtension(String) - +Method in class org.apache.tools.ant.taskdefs.optional.RenameExtensions +
    Deprecated. The string that renamed files will end with on + completion +
    setTofile(File) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set the destination file. +
    setTofile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Set the name of the aggregegated results file. +
    setTofile(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate +
    sets the to file specification +
    setToken(String) - +Method in class org.apache.tools.ant.taskdefs.Filter +
    The token string without @ delimiters. +
    setToken(String) - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Set the token to replace. +
    setToken(String) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Set the string token to replace; required unless a nested + replacetoken element or the + replacefilterresource attribute is used. +
    setToken(String) - +Method in class org.apache.tools.ant.types.FilterSet.Filter +
    Sets the Token attribute of the Filter object. +
    setToken(String) - +Method in class org.apache.tools.ant.types.optional.ScriptFilter +
    The current token +
    setToLabel(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Label representing the 'end' of the range. +
    setToList(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Shorthand to set the "to" address element. +
    setToList(Vector) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the to addresses. +
    setTopDir(File) - +Method in class org.apache.tools.ant.taskdefs.optional.Rpm +
    The directory which will have the expected + subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional. +
    setToplinkdescriptor(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
    Setter used to store the name of the toplink descriptor. +
    setToplinkdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
    Setter used to store the location of the toplink DTD file. +
    setToRefid(String) - +Method in class org.apache.tools.ant.taskdefs.Ant.Reference +
    Set the id that this reference to be stored under in the + new project. +
    setTotalproperty(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the property to hold the generated total checksum + for all files. +
    setTrace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    If true, enables all tracing. +
    setTrace(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag to enable internal tracing when set, optional, default false. +
    setTrace(NetRexxC.TraceAttr) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace". +
    setTrace(String) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace". +
    setTraceLexer(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    If true, enables lexer tracing. +
    setTraceParser(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    If true, enables parser tracing. +
    setTraceTreeWalker(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ANTLR +
    Sets a flag to allow the user to enable tree walker tracing +
    setTreatWarningsAsErrors(boolean) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Whether a warning is an error - in which case onError aplies. +
    setTrim(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    whether to call text.trim() +
    setTrim(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.Equals +
    Should we want to trim the arguments before comparing them? +
    setTrim(boolean) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set whether to trim in string mode. +
    setTrim(boolean) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.Text +
    The trim attribute of the text element. +
    setTrimLeading(boolean) - +Method in class org.apache.tools.ant.taskdefs.Concat.TextElement +
    s:^\s*:: on each line of input +
    setTrust(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Setting this to true trusts hosts whose identity is unknown. +
    setTrust(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Sets the trust. +
    setTsacert(String) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
    set the alias in the keystore of the TSA to use; +
    setTsaurl(String) - +Method in class org.apache.tools.ant.taskdefs.SignJar +
      +
    setType(String) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Deprecated. since 1.5.x. + setType(String) is deprecated and is replaced with + setType(Available.FileDir) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +
    setType(Available.FileDir) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set what type of file is required - either directory or file. +
    setType(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsReference +
    Set the type attribute. +
    setType(ExecuteOn.FileDirBoth) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether the command works only on files, directories or both. +
    setType(Input.HandlerType) - +Method in class org.apache.tools.ant.taskdefs.Input.Handler +
    Set the handler type. +
    setType(FormatterElement.TypeAttribute) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Quick way to use a standard formatter. +
    setType(PropertyFile.Entry.Type) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    Regard the value as : int, date or string (default) +
    setType(String) - +Method in class org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement +
    Set the type of this element. +
    setType(Mapper.MapperType) - +Method in class org.apache.tools.ant.types.Mapper +
    Set the type of FileNameMapper to use. +
    setType(String) - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Set the type of arc. +
    setType(String) - +Method in class org.apache.tools.ant.types.Parameter +
    Set the type attribute. +
    setType(String) - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Set the Ant type to compare against. +
    setType(Type.FileDir) - +Method in class org.apache.tools.ant.types.resources.selectors.Type +
    Set type; file|dir. +
    setType(TypeSelector.FileType) - +Method in class org.apache.tools.ant.types.selectors.TypeSelector +
    Set the type of file to require. +
    setType(String) - +Method in class org.apache.tools.ant.types.spi.Service +
    Set the service type. +
    setTypeKind(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set type-kind string +
    setTypeName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set the attribute type-name +
    setTypeName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set the type-name +
    setTypeName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set type-name string +
    setTypeName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set type-name string +
    setTypeValue(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set the attribute type-value +
    setUid(int) - +Method in class org.apache.tools.ant.types.TarFileSet +
    The uid for the tar entry + This is not the same as the User name. +
    setUmask(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the default mask for file creation on a unix server. +
    setUmask(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the default mask for file creation on a unix server. +
    setUnicodeinput(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the UNICODE_INPUT grammar option. +
    setUnicodeName(byte[]) - +Method in class org.apache.tools.zip.AbstractUnicodeExtraField +
      +
    setUnit(PropertyFile.Unit) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    The unit of the value to be applied to date +/- operations. +
    setUnit(String) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    Deprecated. since 1.5.x. + setUnit(String) is deprecated and is replaced with + setUnit(Tstamp.Unit) to make Ant's + Introspection mechanism do the work and also to + encapsulate operations on the unit in its own + class. +
    setUnit(Tstamp.Unit) - +Method in class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    The unit of the offset to be applied to the current time. +
    setUnits(SizeSelector.ByteUnits) - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    Sets the units to use for the comparison. +
    setUnixMode(int) - +Method in class org.apache.tools.zip.ZipEntry +
    Sets Unix permissions in a way that is understood by Info-Zip's + unzip command. +
    setUnless(String) - +Method in class org.apache.tools.ant.Target +
    Sets the "unless" condition to test on execution. +
    setUnless(Object) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Only fail if the given expression evaluates to false or tno + property of the given name exists. +
    setUnless(String) - +Method in class org.apache.tools.ant.taskdefs.Exit +
    Only fail if the given expression evaluates to false or tno + property of the given name exists. +
    setUnless(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the unless attribute. +
    setUnless(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
    Set the unless attribute. +
    setUnless(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set whether this formatter should NOT be used. +
    setUnless(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set whether this formatter should NOT be used. +
    setUnless(Object) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set whether this param should NOT be used. +
    setUnless(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Set whether this param should NOT be used. +
    setUnless(Object) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    Sets the unless attribute. +
    setUnless(String) - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
    Sets the unless attribute. +
    setUnless(Object) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files. +
    setUnless(String) - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files. +
    setup(Commandline, Native2Ascii) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii +
    Sets up the initial command line. +
    setup(Commandline, Native2Ascii) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii +
    Sets up the initial command line. +
    setup(Commandline, Native2Ascii) - +Method in class org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii +
    Sets up the initial command line. +
    setupCommandLineForVMS(Execute, String[]) - +Static method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    On VMS platform, we need to create a special java options file + containing the arguments and classpath for the java command. +
    setUpdate(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    If true, updates an existing file, otherwise overwrite + any existing one; optional defaults to false. +
    setUpdate(boolean) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for update attribute. +
    setUpdatedProperty(String) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    The property to set on compilation success. +
    setUpdateOnly(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    If set to true files are fetched only if + newer than existing local files; optional, default false. +
    setupDirectoryScanner(FileScanner) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Set up the specified directory scanner against this + AbstractFileSet's Project. +
    setupDirectoryScanner(FileScanner, Project) - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Set up the specified directory scanner against the specified project. +
    setupFTPDelegate() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    setupGCJCommand() - +Method in class org.apache.tools.ant.taskdefs.compilers.Gcj +
    Set up the gcj commandline. +
    setupJavacCommand() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Set up the command line. +
    setupJavacCommand(boolean) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Does the command line argument processing for classic and adds + the files to compile as well. +
    setupJavacCommandlineSwitches(Commandline) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Get the command line arguments for the switches. +
    setupJavacCommandlineSwitches(Commandline, boolean) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Does the command line argument processing common to classic and + modern. +
    setupJUnitDelegate() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
    Sets up the delegate that will actually run the tests. +
    setupKjcCommand() - +Method in class org.apache.tools.ant.taskdefs.compilers.Kjc +
    setup kjc command arguments. +
    setupModernJavacCommand() - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Does the command line argument processing for modern and adds + the files to compile as well. +
    setupModernJavacCommandlineSwitches(Commandline) - +Method in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
    Does the command line argument processing for modern. +
    setupRedirector() - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set up properties on the redirector that we needed to store locally. +
    setupRedirector() - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set up the I/O Redirector. +
    setupRedirector() - +Method in class org.apache.tools.ant.taskdefs.Java +
    Set up properties on the redirector that we needed to store locally. +
    setupRmicCommand() - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Setup rmic argument for rmic. +
    setupRmicCommand(String[]) - +Method in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    Setup rmic argument for rmic. +
    setupRmicCommand() - +Method in class org.apache.tools.ant.taskdefs.rmic.XNewRmic +
    Create a normal command line, then with -Xnew at the front +
    setURI(String) - +Method in class org.apache.tools.ant.taskdefs.Antlib +
    Set the URI for this antlib. +
    setURI(String) - +Method in class org.apache.tools.ant.taskdefs.AntlibDefinition +
    The URI for this definition. +
    setURI(String) - +Method in class org.apache.tools.ant.taskdefs.condition.TypeFound +
    The URI for this definition. +
    setURI(String) - +Method in class org.apache.tools.ant.types.resources.selectors.InstanceOf +
    Set the URI in which the Ant type, if specified, should be defined. +
    setUribase(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    The URI context of relative URI references in the JSP pages. +
    setURIResolver(URIResolver) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Set the class to resolve URIs during the transformation +
    setUriroot(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    The root directory that uri files should be resolved + against. +
    setUrl(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Http +
    Set the url attribute +
    setUrl(String) - +Method in class org.apache.tools.ant.taskdefs.condition.IsReachable +
    Set the URL from which to extract the hostname. +
    setUrl(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Sets the database connection URL; required. +
    setUrl(URL) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
    Sets the URL +
    setUrl(String) - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    identify a URL that hosts the schema. +
    setUrl(URL) - +Method in class org.apache.tools.ant.taskdefs.Property +
    The url from which to load properties. +
    setURL(URL) - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Set the URL for this URLResource. +
    setUrlBase(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.LibFileSet +
    Set the url base for fileset. +
    setUse(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Generate the "use" page for each package. +
    setUse35(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false. +
    setUseExternalFile(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Work around command line length limit by using an external file + for the sourcefiles. +
    setUseFile(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Set whether the formatter should log to file. +
    setUseImplicitFileset(boolean) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    Whether to use the implicit fileset. +
    setUseLanguageEncodingFlag(boolean) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Whether to set the language encoding flag. +
    setUseLanguageEncodingFlag(boolean) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Whether to set the language encoding flag if the file name + encoding is UTF-8. +
    setUseNativeBasedir(boolean) - +Method in class org.apache.tools.ant.taskdefs.Ant +
    Whether the basedir of the new project should be the same one + as it would be when running the build file directly - + independent of dir and/or inheritAll settings. +
    setUseproxy(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.taskdefs.optional.SetProxy +
    setUser(String) - +Method in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Set the user for SMTP auth; this requires JavaMail. +
    setUser(String) - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Set the user for smtp auth. +
    setUser(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    The p4 username; + optional, defaults to the current user +
    setUser(String) - +Method in class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
    Proxy user; optional, default =none. +
    setUser(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY +
    Name of the user whose change history is generated. +
    setUsercharstream(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the USER_CHAR_STREAM grammar option. +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
    Set the user's id +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Set the user name for the connection; required. +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sets the login user id to use on the specified server. +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Sets the login user id to use on the specified server. +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask +
    Set the the login id to use on the server; + required if password is set. +
    setUserid(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
    Set the the login id to use on the server; + required if password is set. +
    setUserId(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    User ID +
    setUserId(int) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's user id. +
    setUserId(int) - +Method in class org.apache.tools.zip.AsiExtraField +
    Set the user id. +
    setUsername(String) - +Method in class org.apache.tools.ant.taskdefs.Get +
    Username for basic auth. +
    setUserName(String) - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    The user with privileges to deploy applications to the server; optional. +
    setUsername(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The SourceSafe username. +
    setUsername(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Username known to remote host. +
    setUserName(String) - +Method in class org.apache.tools.ant.types.TarFileSet +
    The username for the tar entry + This is not the same as the UID. +
    setUserName(String) - +Method in class org.apache.tools.tar.TarEntry +
    Set this entry's user name. +
    setUserProperty(String, String) - +Method in class org.apache.tools.ant.Project +
    Set a user property, which cannot be overwritten by + set/unset property calls. +
    setUserProperty(String, String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Deprecated. namespaces are unnecessary. +
    setUserProperty(String, Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Sets a user property, which cannot be overwritten by + set/unset property calls. +
    setUserProperty(boolean) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Deprecated. since 1.5.x. + This was never a supported feature and has been + deprecated without replacement. +
    setUsersfile(File) - +Method in class org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask +
    Set a lookup list of user names & addresses +
    setUsertokenmanager(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
    Sets the USER_TOKEN_MANAGER grammar option. +
    setUseTimestamp(boolean) - +Method in class org.apache.tools.ant.taskdefs.Get +
    If true, conditionally download a file based on the timestamp + of the local copy. +
    setUtf8(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Tells the NetRexx compiler that the source is in UTF8. +
    setValidargs(String) - +Method in class org.apache.tools.ant.taskdefs.Input +
    Defines valid input parameters as comma separated strings. +
    setValidate(boolean) - +Method in class org.apache.tools.ant.taskdefs.MakeUrl +
    set this flag to trigger validation that every named file exists. +
    setValidate(boolean) - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    flag to validate the XML file; optional, default false +
    setValidity(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    Indicates how many days certificate is valid. +
    setValue(String) - +Method in class org.apache.tools.ant.filters.LineContains.Contains +
    Sets the contains string +
    setValue(String) - +Method in class org.apache.tools.ant.filters.ReplaceTokens.Token +
    Sets the token value +
    setValue(String) - +Method in class org.apache.tools.ant.filters.StripLineComments.Comment +
    Sets the prefix for this type of line comment. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Apt.Option +
    Set the value attribute. +
    setValue(Object) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the value to be given to the property if the desired resource is + available. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Available +
    Set the value to be given to the property if the desired resource is + available. +
    setValue(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.IsFalse +
    set the value to be tested; let ant eval it to true/false +
    setValue(boolean) - +Method in class org.apache.tools.ant.taskdefs.condition.IsTrue +
    set the value to be tested; let ant eval it to true/false +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.condition.ParserSupports +
    Optional value to set. +
    setValue(Object) - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    The value for the property to set, if condition evaluates to true. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.ConditionTask +
    The value for the property to set, if condition evaluates to true. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.email.Header +
    Set the value of this Header. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Filter +
    The string that should replace the token during filtered copies. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DnameParam +
    Set the value attribute. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc.DocletParam +
    Set the parameter value. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Set the Attribute's value; required +
    setValue(Object) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo +
    Set the constant value. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute +
    Set the value of the parameter. +
    setValue(int) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    The new value for the counter; optional. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry +
    Value to set (=), to add (+) or subtract (-) +
    setValue(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute +
    Set the feature value to true or false. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property +
    sets the value of the property +
    setValue(Object) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Set the value of the property. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Property +
    Set the value of the property as a String. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    The replacement string; required if property + is not set. +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Set the string value to use as token replacement; + optional, default is the empty string "". +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.UpToDate +
    The value to set the named property to if the target file is more + up-to-date than (each of) the source file(s). +
    setValue(String) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty +
    set the value for this property +
    setValue(String) - +Method in class org.apache.tools.ant.types.Commandline.Argument +
    Set a single commandline argument. +
    setValue(String) - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
    Invoked by IntrospectionHelper. +
    setValue(String) - +Method in class org.apache.tools.ant.types.Environment.Variable +
    set the value +
    setValue(String) - +Method in class org.apache.tools.ant.types.FilterSet.Filter +
    Sets the Value attribute of the Filter object. +
    setValue(boolean) - +Method in class org.apache.tools.ant.types.optional.ScriptCondition +
    set the value of the condition. +
    setValue(String) - +Method in class org.apache.tools.ant.types.Parameter +
    Set the value attribute. +
    setValue(String) - +Method in class org.apache.tools.ant.types.resources.StringResource +
    The value attribute is a semantically superior alias for the name attribute. +
    setValue(long) - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    A size selector needs to know what size to base its selecting on. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    Enable verbose output when signing ; optional: default false +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Set verbose mode. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Delete +
    If true, list all names of deleted files. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.DependSet +
    In verbose mode missing targets and sources as well as the + modification times of the newest source and latest target will + be logged as info. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Set whether to operate in verbose mode. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.GenerateKey +
    If true, verbose output when signing. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Get +
    If true, show verbose progress information. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javac +
    If true, asks the compiler for verbose output. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Run javadoc in verbose mode +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Cab +
    If true, display cabarc output. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure +
    If true, do a verbose reconfigure operation (default false). +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Sets the verbose flag. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.Javah +
    If true, causes Javah to print a message concerning + the status of the generated files. +
    setVerbose(int) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Set the verbose level of the compiler +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Set to true to receive notification about each file as it is + transferred. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
    Set to true to receive notification about each file as it is + transferred. +
    setVerbose(NetRexxC.VerboseAttr) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether lots of warnings and error messages should be generated +
    setVerbose(String) - +Method in class org.apache.tools.ant.taskdefs.optional.NetRexxC +
    Whether lots of warnings and error messages should be generated +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    Enable verbose output. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Set the verbose flag. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.SubAnt +
    Enable/ disable verbose log messages showing when each sub-build path is entered/ exited. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Sync +
    Used to force listing of all names of copied files. +
    setVerbose(boolean) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Set whether the touch task will report every file it creates; + defaults to true. +
    setVerify(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    set the verify mode for the produced jar (default true) +
    setVerify(boolean) - +Method in class org.apache.tools.ant.taskdefs.Rmic +
    Flag to enable verification so that the classes + found by the directory match are + checked to see if they implement java.rmi.Remote. +
    setVerifyArgs(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    sets some additional args to send to verify command +
    setVerifyproperty(String) - +Method in class org.apache.tools.ant.taskdefs.Checksum +
    Sets the verify property. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.condition.Os +
    Sets the desired OS version +
    setVersion(boolean) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Include the version tag in the generated documentation. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.JDBCTask +
    Sets the version string, execute task only if + rdbms version match; optional. +
    setVersion(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout +
    If true, allows checkout of a version other than main latest. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr +
    Set the version flag +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set the version flag +
    setVersion(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    setter used to store the borland appserver version [4 or 5] +
    setVersion(int) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient +
    Set the version attribute. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
    Set the version number to get - + only works with SOSGet on a file. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel +
    The version number to label. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Version to check-out. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Version to get. +
    setVersion(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL +
    Version to label. +
    setView(String) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    The client, branch or label view to operate upon; + optional default "//...". +
    setViewPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase +
    Set the path to the item in a ClearCase view to operate on. +
    setVisitor(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the VISITOR grammar option. +
    setVisitorException(String) - +Method in class org.apache.tools.ant.taskdefs.optional.javacc.JJTree +
    Sets the VISITOR_EXCEPTION grammar option. +
    setVm(String) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Set the executable used to start the new JVM. +
    setVMLauncher(boolean) - +Method in class org.apache.tools.ant.taskdefs.ExecTask +
    Set whether to launch new process with VM, otherwise use the OS's shell. +
    setVMLauncher(boolean) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Launch this execution through the VM, where possible, rather than through + the OS's shell. +
    setVmversion(String) - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Set the JVM version required. +
    setVOB(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel +
    Set the VOB name +
    setVOB(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype +
    Set the VOB name +
    setVOB(String) - +Method in class org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype +
    Set the VOB name +
    setVsspath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSS +
    SourceSafe path which specifies the project/file(s) you wish to perform + the action on. +
    setVssServerPath(String) - +Method in class org.apache.tools.ant.taskdefs.optional.sos.SOS +
    The path to the location of the ss.ini file. +
    setWarfile(File) - +Method in class org.apache.tools.ant.taskdefs.War +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead +
    setWarn(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    Specify how parser error are to be handled. +
    setWarningProperty(String) - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
    Property to set to "true" if a statement produces a warning. +
    setWarningProperty() - +Method in class org.apache.tools.ant.taskdefs.SQLExec +
      +
    setWarnOnRmiStubs(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.depend.Depend +
    Flag to set to true if you want dependency issues with RMI + stubs to appear at warning level. +
    setWASClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Set the websphere classpath. +
    setWebinc(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    output filename for the fraction of web.xml that lists + servlets. +
    setWeblogicdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Deprecated. +
    setWebxml(File) - +Method in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    Filename for web.xml. +
    setWebxml(File) - +Method in class org.apache.tools.ant.taskdefs.War +
    set the deployment descriptor to use (WEB-INF/web.xml); + required unless update=true +
    setWhen(Length.When) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the comparison for use as a Condition. +
    setWhen(Comparison) - +Method in class org.apache.tools.ant.taskdefs.Length +
    Set the comparison for use as a Condition. +
    setWhen(Comparison) - +Method in class org.apache.tools.ant.taskdefs.ResourceCount +
    Set the comparison for use as a Condition. +
    setWhen(Comparison) - +Method in class org.apache.tools.ant.types.resources.selectors.Compare +
    Set the comparison to be used. +
    setWhen(TimeComparison) - +Method in class org.apache.tools.ant.types.resources.selectors.Date +
    Set the comparison mode. +
    setWhen(Comparison) - +Method in class org.apache.tools.ant.types.resources.selectors.Size +
    Set the comparison mode. +
    setWhen(DateSelector.TimeComparisons) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Sets the type of comparison to be done on the file's last modified + date. +
    setWhen(TimeComparison) - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    Set the comparison type. +
    setWhen(SizeSelector.SizeComparisons) - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    This specifies when the file should be selected, whether it be + when the file matches a particular size, when it is smaller, + or whether it is larger. +
    setWhenempty(Zip.WhenEmpty) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Not used for jar files. +
    setWhenempty(Zip.WhenEmpty) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Sets behavior of the task when no files match. +
    setWhenmanifestonly(Zip.WhenEmpty) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Indicates if a jar file should be created when it would only contain a + manifest file. +
    setWidth(int) - +Method in class org.apache.tools.ant.types.optional.image.Arc +
    Set the width. +
    setWidth(int) - +Method in class org.apache.tools.ant.types.optional.image.Ellipse +
    Set the width. +
    setWidth(int) - +Method in class org.apache.tools.ant.types.optional.image.Rectangle +
    Set the width. +
    setWidth(String) - +Method in class org.apache.tools.ant.types.optional.image.Scale +
    Sets the width of the image, either as an integer or a %. +
    setWindowtitle(String) - +Method in class org.apache.tools.ant.taskdefs.Javadoc +
    Set the title to be placed in the HTML <title> tag of the + generated documentation. +
    setWithOutAndErr(boolean) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.SummaryJUnitResultFormatterMirror +
    Set where standard out and standard error should be included. +
    setWithOutAndErr(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Should the output to System.out and System.err be written to + the summary. +
    setWLClasspath(Path) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Optional classpath to WL6.0. +
    setWLdtd(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Deprecated. +
    setWorkingDirectory(File) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Sets the working directory of the process to execute. +
    setWorkspace(String) - +Method in class org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs +
    Workspace to use; optional. +
    setWritable(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD +
    Unset the READ-ONLY flag on local copies of files added to VSS. +
    setWritable(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN +
    Unset the READ-ONLY flag on local copies of files checked-in to VSS. +
    setWritable(boolean) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Unset the READ-ONLY flag on files retrieved from VSS. +
    setWritableFiles(MSVSS.WritableFiles) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT +
    Action taken when local files are writable. +
    setWritableFiles(MSVSS.WritableFiles) - +Method in class org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET +
    Action taken when local files are writable. +
    setWriter(Writer) - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Set the output writer. +
    setXloc(int) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Set the X location. +
    setXMLCatalog(XMLCatalog) - +Method in class org.apache.tools.ant.types.resolver.ApacheCatalogResolver +
    Set the XMLCatalog object to callback. +
    setXmlDocument(Document) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    sets the input document. +
    setXmlfile(File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    Set the xml file to be processed. +
    setXslResource(Resource) - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess +
    API method to set the XSL Resource. +
    setYloc(int) - +Method in class org.apache.tools.ant.types.optional.image.Draw +
    Set the Y location. +
    setZipfile(File) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    the required destination file. +
    setZipfile(File) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +
    setZipfile(File) - +Method in class org.apache.tools.ant.types.resources.ZipResource +
    Set the zipfile that holds this ZipResource. +
    shell - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    The OS shell to use (cmd.exe or /bin/sh) +
    shouldIgnoreInvalidRecipients() - +Method in class org.apache.tools.ant.taskdefs.email.Mailer +
    Whether invalid recipients should be ignored. +
    shouldResolveLink() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.LinkArgument +
    should Ant resolve the link attribute relative to the + current basedir? +
    shouldRun(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTest +
    Check if this test should run based on the if and unless + attributes. +
    shouldSetProperty - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    flag telling whether a property should be set +
    shouldSetValue - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    flag telling whether the value of the counter should be set +
    shouldUse(Task) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    Ensures that the selector passes the conditions placed + on it with if and unless properties. +
    shouldUse() - +Method in class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
    Ensures that the param passes the conditions placed + on it with if and unless properties. +
    showMessage(String) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Implement the UserInfo interface (noop). +
    SHUTDOWN_INTERRUPTED - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    "Shutdown interrupted" +
    sigalg - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    sigfile - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    name to a signature file +
    signedjar - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    name of a single jar +
    SignedSelector - Class in org.apache.tools.ant.types.selectors
    Selector that chooses files based on whether they are signed or not.
    SignedSelector() - +Constructor for class org.apache.tools.ant.types.selectors.SignedSelector +
      +
    SignJar - Class in org.apache.tools.ant.taskdefs
    Signs JAR or ZIP files with the javasign command line tool.
    SignJar() - +Constructor for class org.apache.tools.ant.taskdefs.SignJar +
      +
    similar(MacroDef.NestedSequential) - +Method in class org.apache.tools.ant.taskdefs.MacroDef.NestedSequential +
    A compare function to compare this with another + NestedSequential. +
    similar(Object) - +Method in class org.apache.tools.ant.taskdefs.MacroDef +
    Similar method for this definition +
    similar(Object) - +Method in class org.apache.tools.ant.UnknownElement +
    like contents equals, but ignores project +
    similarDefinition(AntTypeDefinition, Project) - +Method in class org.apache.tools.ant.AntTypeDefinition +
    Similar definition; + used to compare two definitions defined twice with the same + name and the same types. +
    similarDefinition(AntTypeDefinition, Project) - +Method in class org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition +
    Similar method for this definition. +
    SimpleBigProjectLogger - Class in org.apache.tools.ant.listener
    Displays subproject names like BigProjectLogger + but is otherwise as quiet as NoBannerLogger.
    SimpleBigProjectLogger() - +Constructor for class org.apache.tools.ant.listener.SimpleBigProjectLogger +
      +
    SimpleP4OutputHandler - Class in org.apache.tools.ant.taskdefs.optional.perforce
    simple implementation of P4HandlerAdapter used by tasks which are not + actually processing the output from Perforce
    SimpleP4OutputHandler(P4Base) - +Constructor for class org.apache.tools.ant.taskdefs.optional.perforce.SimpleP4OutputHandler +
    simple constructor +
    single() - +Method in class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
    Create a symlink. +
    SingleCheckExecutor - Class in org.apache.tools.ant.helper
    "Single-check" Target executor implementation.
    SingleCheckExecutor() - +Constructor for class org.apache.tools.ant.helper.SingleCheckExecutor +
      +
    SITE_CMD - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTP +
      +
    SITE_CMD - +Static variable in class org.apache.tools.ant.taskdefs.optional.net.FTPTask +
      +
    size() - +Method in class org.apache.tools.ant.taskdefs.Concat +
    Implement ResourceCollection. +
    size() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Get the size of the constant pool. +
    size() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.Assertions +
    how many assertions are made...will resolve references before returning +
    size() - +Method in class org.apache.tools.ant.types.Commandline +
    Size operator. +
    size() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Deprecated. since 1.7. + Please dont use this, it effectively creates the + entire command. +
    size() - +Method in class org.apache.tools.ant.types.CommandlineJava.SysProperties +
    Get the size of the sysproperties instance. +
    size() - +Method in class org.apache.tools.ant.types.DirSet +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.FileList +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.FileSet +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.Path.PathElement +
    Get the number of resources. +
    size() - +Method in class org.apache.tools.ant.types.Path +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.PropertySet +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.Resource +
    Fulfill the ResourceCollection contract. +
    size() - +Method in interface org.apache.tools.ant.types.ResourceCollection +
    Learn the number of contained Resources. +
    size() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.resources.Archives +
    Sums the sizes of nested archives. +
    size() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.resources.BCFileSet +
    Fulfill the ResourceCollection contract. +
    Size - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by size.
    Size() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Size +
      +
    size() - +Method in class org.apache.tools.ant.types.resources.Files +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.resources.MappedResourceCollection +
    Learn the number of contained Resources. +
    size() - +Method in class org.apache.tools.ant.types.resources.ResourceList +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.resources.Resources +
    Fulfill the ResourceCollection contract. +
    size() - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Fulfill the ResourceCollection contract. +
    Size - Class in org.apache.tools.ant.types.resources.selectors
    Size ResourceSelector.
    Size() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Size +
      +
    size() - +Method in class org.apache.tools.ant.types.resources.SizeLimitCollection +
    Efficient size implementation. +
    size() - +Method in class org.apache.tools.ant.util.LazyHashtable +
    Get the size of the table. +
    size() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    SIZE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.SizeSelector +
    Used for parameterized custom selector +
    SIZELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the size field in a header buffer. +
    SizeLimitCollection - Class in org.apache.tools.ant.types.resources
    ResourceCollection that imposes a size limit on another ResourceCollection.
    SizeLimitCollection() - +Constructor for class org.apache.tools.ant.types.resources.SizeLimitCollection +
      +
    SizeSelector - Class in org.apache.tools.ant.types.selectors
    Selector that filters files based on their size.
    SizeSelector() - +Constructor for class org.apache.tools.ant.types.selectors.SizeSelector +
    Creates a new SizeSelector instance. +
    SizeSelector.ByteUnits - Class in org.apache.tools.ant.types.selectors
    Enumerated attribute with the values for units.
    SizeSelector.ByteUnits() - +Constructor for class org.apache.tools.ant.types.selectors.SizeSelector.ByteUnits +
      +
    SizeSelector.SizeComparisons - Class in org.apache.tools.ant.types.selectors
    Enumerated attribute with the values for size comparison.
    SizeSelector.SizeComparisons() - +Constructor for class org.apache.tools.ant.types.selectors.SizeSelector.SizeComparisons +
      +
    Sj - Class in org.apache.tools.ant.taskdefs.compilers
    The implementation of the sj compiler.
    Sj() - +Constructor for class org.apache.tools.ant.taskdefs.compilers.Sj +
      +
    skip(long) - +Method in class org.apache.tools.ant.filters.BaseFilterReader +
    Skips characters. +
    skip(long) - +Method in class org.apache.tools.tar.TarInputStream +
    Skip bytes in the input buffer. +
    SKIP - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Skip the extra field entirely and don't make its data + available - effectively removing the extra field data. +
    SKIP_KEY - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Key for "skip" action. +
    SKIPPING_TESTS - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    "Condition failed -skipping tests" +
    skipRecord() - +Method in class org.apache.tools.tar.TarBuffer +
    Skip over a record on the input stream. +
    skipWriting - +Variable in class org.apache.tools.ant.taskdefs.Zip +
    whether the methods should just perform some sort of dry-run. +
    Sleep - Class in org.apache.tools.ant.taskdefs
    Sleep, or pause, for a period of time.
    Sleep() - +Constructor for class org.apache.tools.ant.taskdefs.Sleep +
    Creates new instance +
    slowScan() - +Method in class org.apache.tools.ant.DirectoryScanner +
    Top level invocation for a slow scan. +
    SMALL_THRESH - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    SmtpResponseReader - Class in org.apache.tools.mail
    A wrapper around the raw input from the SMTP server that assembles + multi line responses into a single String.
    SmtpResponseReader(InputStream) - +Constructor for class org.apache.tools.mail.SmtpResponseReader +
    Wrap this input stream. +
    Socket - Class in org.apache.tools.ant.taskdefs.condition
    Condition to wait for a TCP/IP socket to have a listener.
    Socket() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Socket +
      +
    SOCKS_PROXY_HOST - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the socks proxy host property +
    SOCKS_PROXY_PASSWORD - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the socks proxy password property +
    SOCKS_PROXY_PORT - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the socks proxy port property +
    SOCKS_PROXY_USERNAME - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    the socks proxy username property +
    Sort - Class in org.apache.tools.ant.types.resources
    ResourceCollection that sorts another ResourceCollection.
    Sort() - +Constructor for class org.apache.tools.ant.types.resources.Sort +
      +
    SortFilter - Class in org.apache.tools.ant.filters
    + Sort a file before and/or after the file.
    SortFilter() - +Constructor for class org.apache.tools.ant.filters.SortFilter +
    Constructor for "dummy" instances. +
    SortFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.SortFilter +
    Creates a new filtered reader. +
    SOS - Class in org.apache.tools.ant.taskdefs.optional.sos
    A base class for creating tasks for executing commands on SourceOffSite.
    SOS() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sos.SOS +
      +
    SOSCheckin - Class in org.apache.tools.ant.taskdefs.optional.sos
    Commits and unlocks files in Visual SourceSafe via a SourceOffSite server.
    SOSCheckin() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin +
      +
    SOSCheckout - Class in org.apache.tools.ant.taskdefs.optional.sos
    Retrieves and locks files in Visual SourceSafe via a SourceOffSite server.
    SOSCheckout() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout +
      +
    SOSCmd - Interface in org.apache.tools.ant.taskdefs.optional.sos
    Interface to hold constants used by the SOS tasks
    SOSGet - Class in org.apache.tools.ant.taskdefs.optional.sos
    Retrieves a read-only copy of the specified project or file + from Visual SourceSafe via a SourceOffSite server.
    SOSGet() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sos.SOSGet +
      +
    SOSLabel - Class in org.apache.tools.ant.taskdefs.optional.sos
    Labels Visual SourceSafe files via a SourceOffSite server.
    SOSLabel() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sos.SOSLabel +
      +
    SoundTask - Class in org.apache.tools.ant.taskdefs.optional.sound
    Plays a sound file at the end of the build, according to whether the build failed or succeeded.
    SoundTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sound.SoundTask +
    Constructor for SoundTask. +
    SoundTask.BuildAlert - Class in org.apache.tools.ant.taskdefs.optional.sound
    A class to be extended by any BuildAlert's that require the output + of sound.
    SoundTask.BuildAlert() - +Constructor for class org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert +
      +
    source - +Variable in class org.apache.tools.ant.taskdefs.Pack +
      +
    source - +Variable in class org.apache.tools.ant.taskdefs.Unpack +
      +
    SourceFileScanner - Class in org.apache.tools.ant.util
    Utility class that collects the functionality of the various + scanDir methods that have been scattered in several tasks before.
    SourceFileScanner(Task) - +Constructor for class org.apache.tools.ant.util.SourceFileScanner +
    Construct a new SourceFileScanner. +
    SPACER - +Static variable in class org.apache.tools.ant.listener.TimestampedLogger +
    what appears between the old message and the new +
    spawn() - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Starts a process defined by the command line. +
    Specification - Class in org.apache.tools.ant.taskdefs.optional.extension
    Utility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.
    Specification(String, String, String, String, String, String) - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    The constructor to create Package Specification object. +
    Specification(String, String, String, String, String, String, String[]) - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    The constructor to create Package Specification object. +
    SPECIFICATION_TITLE - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for SPECIFICATION_TITLE. +
    SPECIFICATION_VENDOR - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for SPECIFICATION_VENDOR. +
    SPECIFICATION_VENDOR - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for SPECIFICATION_VENDOR. +
    SPECIFICATION_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Manifest Attribute Name object for SPECIFICATION_VERSION. +
    SPECIFICATION_VERSION - +Static variable in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Manifest Attribute Name object for SPECIFICATION_VERSION. +
    SplashTask - Class in org.apache.tools.ant.taskdefs.optional.splash
    Creates a splash screen.
    SplashTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.splash.SplashTask +
      +
    split(String, int) - +Static method in class org.apache.tools.ant.util.StringUtils +
    Splits up a string where elements are separated by a specific + character and return all elements. +
    SplitClassLoader - Class in org.apache.tools.ant.util
    Specialized classloader for tasks that need finer grained control + over which classes are to be loaded via Ant's classloader and which + should not even if they are available.
    SplitClassLoader(ClassLoader, Path, Project, String[]) - +Constructor for class org.apache.tools.ant.util.SplitClassLoader +
      +
    SQLExec - Class in org.apache.tools.ant.taskdefs
    Executes a series of SQL statements on a database using JDBC.
    SQLExec() - +Constructor for class org.apache.tools.ant.taskdefs.SQLExec +
      +
    SQLExec.DelimiterType - Class in org.apache.tools.ant.taskdefs
    delimiters we support, "normal" and "row"
    SQLExec.DelimiterType() - +Constructor for class org.apache.tools.ant.taskdefs.SQLExec.DelimiterType +
      +
    SQLExec.OnError - Class in org.apache.tools.ant.taskdefs
    The action a task should perform on an error, + one of "continue", "stop" and "abort"
    SQLExec.OnError() - +Constructor for class org.apache.tools.ant.taskdefs.SQLExec.OnError +
      +
    SQLExec.Transaction - Class in org.apache.tools.ant.taskdefs
    Contains the definition of a new transaction element.
    SQLExec.Transaction() - +Constructor for class org.apache.tools.ant.taskdefs.SQLExec.Transaction +
      +
    src - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    srcDir - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    srcFile - +Variable in class org.apache.tools.ant.types.ArchiveScanner +
    The archive file which should be scanned. +
    srcFilePos - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    srcIsFirst - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
    Has <srcfile> been specified before <targetfile> +
    srcResource - +Variable in class org.apache.tools.ant.taskdefs.Unpack +
      +
    SS_EXE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    Constant for the thing to execute +
    SSHBase - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Base class for Ant tasks using jsch.
    SSHBase() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase +
    Constructor for SSHBase. +
    SSHExec - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Executes a command on a remote machine via ssh.
    SSHExec() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHExec +
    Constructor for SSHExecTask. +
    SSHSession - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Establishes an ssh session with a remote machine, optionally + establishing port forwarding, then executes any nested task(s) + before closing the session.
    SSHSession() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession +
      +
    SSHSession.LocalTunnel - Class in org.apache.tools.ant.taskdefs.optional.ssh
     
    SSHSession.LocalTunnel() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel +
      +
    SSHSession.NestedSequential - Class in org.apache.tools.ant.taskdefs.optional.ssh
    The class corresponding to the sequential nested element.
    SSHSession.NestedSequential() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.NestedSequential +
      +
    SSHSession.RemoteTunnel - Class in org.apache.tools.ant.taskdefs.optional.ssh
     
    SSHSession.RemoteTunnel() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel +
      +
    SSHUserInfo - Class in org.apache.tools.ant.taskdefs.optional.ssh
    Class containing information on an SSH user.
    SSHUserInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Constructor for SSHUserInfo. +
    SSHUserInfo(String, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo +
    Constructor for SSHUserInfo. +
    SSL - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    start(String[], Properties, ClassLoader) - +Static method in class org.apache.tools.ant.Main +
    Creates a new instance of this class using the + arguments specified, gives it any extra user properties which have been + specified, and then runs the build using the classloader provided. +
    start() - +Method in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler +
    Start handling of the streams. +
    start(Process) - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Watches the given process and terminates it, if it runs for too long. +
    start() - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Invokes parseOutput. +
    start() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
      +
    start() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Start handling of the streams.. +
    start() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    this routine gets called by the execute routine of the Execute class + it connects the PumpStreamHandler to the input/output/error streams of the process. +
    start() - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Start the Threads. +
    start - +Variable in class org.apache.tools.ant.types.optional.image.Arc +
      +
    start() - +Method in class org.apache.tools.ant.util.Watchdog +
    Start the watch dog. +
    startAnt(String[], Properties, ClassLoader) - +Method in interface org.apache.tools.ant.launch.AntMain +
    Start Ant. +
    startAnt(String[], Properties, ClassLoader) - +Method in class org.apache.tools.ant.Main +
    Start Ant +
    startDocument() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    SAX parser call-back method that is used to initialize the values of some + instance variables to ensure safe operation. +
    startElement(String, String, String, Attributes) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Handles the start of a project element. +
    startElement(String, AttributeList) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler +
    SAX parser call-back method that is invoked when a new element is entered + into. +
    startPrefixMapping(String, String) - +Method in class org.apache.tools.ant.helper.AntXMLContext +
    Called during parsing, stores the prefix to uri mapping. +
    startPrefixMapping(String, String) - +Method in class org.apache.tools.ant.helper.ProjectHelper2.RootHandler +
    Start a namespace prefix to uri mapping +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    A test started. +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner +
    Interface TestListener. +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    Interface TestListener. +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Empty +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    startTest(Test) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    Interface TestListener. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter +
    The whole testsuite started. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + The whole testsuite started. +
    startTestSuite(JUnitTest) - +Method in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitResultFormatter +
    The whole testsuite started. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter +
    The whole testsuite started. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    The testsuite started. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
    Records the suite's name to later determine the class to invoke + tearDown on. +
    startTestSuite(JUnitTest) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    The whole testsuite started. +
    stop() - +Method in interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler +
    Stop handling of the streams - will not be restarted. +
    stop() - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Stops the watcher. +
    stop() - +Method in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated. Ignore. +
    stop() - +Method in class org.apache.tools.ant.taskdefs.LogStreamHandler +
    Stop the log stream handler. +
    stop() - +Method in class org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask +
      +
    stop() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Stop handling of the streams - will not be restarted.. +
    stop() - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter +
    stops the processing of streams + called from P4Base#execP4Command(String command, P4Handler handler) +
    stop() - +Method in class org.apache.tools.ant.taskdefs.PumpStreamHandler +
    Stop pumping the streams. +
    stop - +Variable in class org.apache.tools.ant.types.optional.image.Arc +
      +
    stop() - +Method in class org.apache.tools.ant.util.Watchdog +
    Stop the watch dog. +
    store() - +Method in class org.apache.tools.ant.IntrospectionHelper.Creator +
    Stores the nested element object using a storage method determined by introspection. +
    store(OutputStream, String) - +Method in class org.apache.tools.ant.util.LayoutPreservingProperties +
      +
    storeChild(Project, Object, Object, String) - +Static method in class org.apache.tools.ant.ProjectHelper +
    Stores a configured child element within its parent object. +
    STORED - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    Compression method for stored entries. +
    storeElement(Project, Object, Object, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Stores a named nested element using a storage method determined + by the initial introspection. +
    storepass - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    password for the store +
    storepass - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    storetype - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    type of store,-storetype param +
    storetype - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    str_encoding - +Variable in class org.apache.tools.ant.taskdefs.optional.image.Image +
      +
    StreamPumper - Class in org.apache.tools.ant.taskdefs
    Copies all data from an input stream to an output stream.
    StreamPumper(InputStream, OutputStream, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.StreamPumper +
    Create a new StreamPumper. +
    StreamPumper(InputStream, OutputStream, boolean, boolean) - +Constructor for class org.apache.tools.ant.taskdefs.StreamPumper +
    Create a new StreamPumper. +
    StreamPumper(InputStream, OutputStream) - +Constructor for class org.apache.tools.ant.taskdefs.StreamPumper +
    Create a new StreamPumper. +
    STRING_TYPE - +Static variable in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
    string +
    StringCPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A String Constant Pool Entry.
    StringCPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo +
    Constructor. +
    StringInputStream - Class in org.apache.tools.ant.filters
    Wraps a String as an InputStream.
    StringInputStream(String) - +Constructor for class org.apache.tools.ant.filters.StringInputStream +
    Composes a stream from a String +
    StringInputStream(String, String) - +Constructor for class org.apache.tools.ant.filters.StringInputStream +
    Composes a stream from a String with the specified encoding +
    StringResource - Class in org.apache.tools.ant.types.resources
    Exposes a string as a Resource.
    StringResource() - +Constructor for class org.apache.tools.ant.types.resources.StringResource +
    Default constructor. +
    StringResource(String) - +Constructor for class org.apache.tools.ant.types.resources.StringResource +
    Construct a StringResource with the supplied value. +
    StringResource(Project, String) - +Constructor for class org.apache.tools.ant.types.resources.StringResource +
    Construct a StringResource with the supplied project and value, + doing property replacement against the project if non-null. +
    StringTokenizer - Class in org.apache.tools.ant.util
    Class to tokenize the input as areas separated + by white space, or by a specified list of + delim characters.
    StringTokenizer() - +Constructor for class org.apache.tools.ant.util.StringTokenizer +
      +
    StringUtils - Class in org.apache.tools.ant.util
    A set of helper methods related to string manipulation.
    StripJavaComments - Class in org.apache.tools.ant.filters
    This is a Java comment and string stripper reader that filters + those lexical tokens out for purposes of simple Java parsing.
    StripJavaComments() - +Constructor for class org.apache.tools.ant.filters.StripJavaComments +
    Constructor for "dummy" instances. +
    StripJavaComments(Reader) - +Constructor for class org.apache.tools.ant.filters.StripJavaComments +
    Creates a new filtered reader. +
    StripLineBreaks - Class in org.apache.tools.ant.filters
    Filter to flatten the stream to a single line.
    StripLineBreaks() - +Constructor for class org.apache.tools.ant.filters.StripLineBreaks +
    Constructor for "dummy" instances. +
    StripLineBreaks(Reader) - +Constructor for class org.apache.tools.ant.filters.StripLineBreaks +
    Creates a new filtered reader. +
    StripLineComments - Class in org.apache.tools.ant.filters
    This filter strips line comments.
    StripLineComments() - +Constructor for class org.apache.tools.ant.filters.StripLineComments +
    Constructor for "dummy" instances. +
    StripLineComments(Reader) - +Constructor for class org.apache.tools.ant.filters.StripLineComments +
    Creates a new filtered reader. +
    StripLineComments.Comment - Class in org.apache.tools.ant.filters
    The class that holds a comment representation.
    StripLineComments.Comment() - +Constructor for class org.apache.tools.ant.filters.StripLineComments.Comment +
      +
    stroke - +Variable in class org.apache.tools.ant.types.optional.image.BasicShape +
      +
    stroke_width - +Variable in class org.apache.tools.ant.types.optional.image.BasicShape +
      +
    STUB_1_1 - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    arg for 1.1: "-v1.1" +
    STUB_1_2 - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    arg for 1.2: "-v1.2" +
    STUB_COMPAT - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    arg for compat: "-vcompat" +
    STUB_OPTION_1_1 - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    option for stub 1.1 in the rmic task: "1.1" +
    STUB_OPTION_1_2 - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    option for stub 1.2 in the rmic task: "1.2" +
    STUB_OPTION_COMPAT - +Static variable in class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter +
    option for stub compat in the rmic task: "compat" +
    STYLE_BRIEF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The brief style flag +
    STYLE_CODEDIFF - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The codediff style flag +
    STYLE_DEFAULT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The default style flag +
    STYLE_NOFILE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The nofile style flag +
    styleDir - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    the style directory. +
    SubAnt - Class in org.apache.tools.ant.taskdefs
    Calls a given target for all defined sub-builds.
    SubAnt() - +Constructor for class org.apache.tools.ant.taskdefs.SubAnt +
      +
    subBuildFinished(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Cleans up any resources held by this classloader at the end of + a subbuild if it has been created for the subbuild's project + instance. +
    subBuildFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Signals that the last target has finished. +
    subBuildFinished(BuildEvent) - +Method in interface org.apache.tools.ant.SubBuildListener +
    Signals that the last target has finished. +
    subBuildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Cleans recorder registry, if this is the subbuild the task has + been created in. +
    subBuildFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Cleans up any resources held by this recorder entry at the end + of a subbuild if it has been created for the subbuild's project + instance. +
    SubBuildListener - Interface in org.apache.tools.ant
    Instances of classes that implement this interface can register + to be also notified when things happened during a subbuild.
    subBuildStarted(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    subBuildStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Signals that a subbuild has started. +
    subBuildStarted(BuildEvent) - +Method in interface org.apache.tools.ant.SubBuildListener +
    Signals that a subbuild has started. +
    subBuildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    subBuildStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Empty implementation to satisfy the BuildListener interface. +
    subject - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    substitute(String, String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaOroRegexp +
    Perform a substitution on the regular expression. +
    substitute(String, String, int) - +Method in class org.apache.tools.ant.util.regexp.JakartaRegexpRegexp +
    Perform a substitution on the regular expression. +
    substitute(String, String, int) - +Method in class org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp +
    Perform a substitution on the regular expression. +
    substitute(String, String, int) - +Method in interface org.apache.tools.ant.util.regexp.Regexp +
    Perform a substitution on the regular expression. +
    Substitution - Class in org.apache.tools.ant.types
    A regular expression substitution datatype.
    Substitution() - +Constructor for class org.apache.tools.ant.types.Substitution +
    Constructor for Substitution. +
    SUCCESS - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror +
    No problems with this test. +
    SuffixLines - Class in org.apache.tools.ant.filters
    Attaches a suffix to every line.
    SuffixLines() - +Constructor for class org.apache.tools.ant.filters.SuffixLines +
    Constructor for "dummy" instances. +
    SuffixLines(Reader) - +Constructor for class org.apache.tools.ant.filters.SuffixLines +
    Creates a new filtered reader. +
    SummaryJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Prints short summary output of the test to Ant's logging system.
    SummaryJUnitResultFormatter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter +
    Empty +
    SunJavah - Class in org.apache.tools.ant.taskdefs.optional.javah
    Adapter to com.sun.tools.javah.oldjavah.Main or com.sun.tools.javah.Main.
    SunJavah() - +Constructor for class org.apache.tools.ant.taskdefs.optional.javah.SunJavah +
      +
    SunNative2Ascii - Class in org.apache.tools.ant.taskdefs.optional.native2ascii
    Adapter to sun.tools.native2ascii.Main.
    SunNative2Ascii() - +Constructor for class org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii +
      +
    SunRmic - Class in org.apache.tools.ant.taskdefs.rmic
    The implementation of the rmic for SUN's JDK.
    SunRmic() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.SunRmic +
      +
    supportsCharacters() - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Returns whether or not the introspected class supports PCDATA. +
    supportsCvsLogWithSOption() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsVersion +
    Find out if the server version supports log with S option +
    supportsFileDependencies() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.AntAnalyzer +
    Indicate if this analyzer can determine dependent files. +
    supportsFileDependencies() - +Method in class org.apache.tools.ant.util.depend.AbstractAnalyzer +
    Indicate if the particular subclass supports file dependency + information. +
    supportsFileDependencies() - +Method in class org.apache.tools.ant.util.depend.bcel.AncestorAnalyzer +
    Indicate if this analyzer can determine dependent files. +
    supportsFileDependencies() - +Method in class org.apache.tools.ant.util.depend.bcel.FullAnalyzer +
    Indicate if this analyzer can determine dependent files. +
    supportsLanguage() - +Method in class org.apache.tools.ant.util.optional.JavaxScriptRunner +
    Check if a script engine can be created for + this language.. +
    supportsLanguage() - +Method in class org.apache.tools.ant.util.optional.ScriptRunner +
    Check if bsf supports the language. +
    supportsLanguage() - +Method in class org.apache.tools.ant.util.ScriptRunnerBase +
    Check if a script engine can be created for + this language. +
    supportsNestedElement(String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Indicates if this element supports a nested element of the + given name. +
    supportsNestedElement(String, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Indicate if this element supports a nested element of the + given name. +
    supportsNestedElement(String, String, Project, Object) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Indicate if this element supports a nested element of the + given name. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.BUnzip2 +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.BZip2 +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.GUnzip +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.GZip +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.Pack +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Yes, we can. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.Unpack +
    Whether this task can deal with non-file resources. +
    supportsNonFileResources() - +Method in class org.apache.tools.ant.taskdefs.XmlProperty +
    Whether this task can deal with non-file resources. +
    supportsReflectElement(String, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Check if this element supports a nested element from reflection. +
    SymbolicLinkUtils - Class in org.apache.tools.ant.util
    Contains methods related to symbolic links - or what Ant thinks is + a symbolic link based on the absent support for them in Java.
    SymbolicLinkUtils() - +Constructor for class org.apache.tools.ant.util.SymbolicLinkUtils +
    Empty constructor. +
    Symlink - Class in org.apache.tools.ant.taskdefs.optional.unix
    Creates, Deletes, Records and Restores Symlinks.
    Symlink() - +Constructor for class org.apache.tools.ant.taskdefs.optional.unix.Symlink +
      +
    Sync - Class in org.apache.tools.ant.taskdefs
    Synchronize a local target directory from the files defined + in one or more filesets.
    Sync() - +Constructor for class org.apache.tools.ant.taskdefs.Sync +
      +
    Sync.MyCopy - Class in org.apache.tools.ant.taskdefs
    Subclass Copy in order to access it's file/dir maps.
    Sync.MyCopy() - +Constructor for class org.apache.tools.ant.taskdefs.Sync.MyCopy +
    Constructor for MyCopy. +
    Sync.SyncTarget - Class in org.apache.tools.ant.taskdefs
    Inner class used to hold exclude patterns and selectors to save + stuff that happens to live in the target directory but should + not get removed.
    Sync.SyncTarget() - +Constructor for class org.apache.tools.ant.taskdefs.Sync.SyncTarget +
    Constructor for SyncTarget. +
    SYSTEM_ERR - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the system-err element +
    SYSTEM_LOADER_REF - +Static variable in class org.apache.tools.ant.MagicNames +
    The name of the reference to the System Class Loader. +
    SYSTEM_LOADER_REF - +Static variable in class org.apache.tools.ant.taskdefs.Classloader +
      +
    SYSTEM_OUT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the system-out element +
    systemBootClasspath - +Static variable in class org.apache.tools.ant.types.Path +
    The system bootclasspath as a Path object. +
    systemClasspath - +Static variable in class org.apache.tools.ant.types.Path +
    The system classpath as a Path object +
    +
    +

    +T

    +
    +
    TabsToSpaces - Class in org.apache.tools.ant.filters
    Converts tabs to spaces.
    TabsToSpaces() - +Constructor for class org.apache.tools.ant.filters.TabsToSpaces +
    Constructor for "dummy" instances. +
    TabsToSpaces(Reader) - +Constructor for class org.apache.tools.ant.filters.TabsToSpaces +
    Creates a new filtered reader. +
    TAG - +Static variable in class org.apache.tools.ant.taskdefs.Antlib +
    The name of this task +
    TailFilter - Class in org.apache.tools.ant.filters
    Reads the last n lines of a stream.
    TailFilter() - +Constructor for class org.apache.tools.ant.filters.TailFilter +
    Constructor for "dummy" instances. +
    TailFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.TailFilter +
    Creates a new filtered reader. +
    Tar - Class in org.apache.tools.ant.taskdefs
    Creates a tar archive.
    Tar() - +Constructor for class org.apache.tools.ant.taskdefs.Tar +
      +
    tar(ResourceCollection, TarOutputStream) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    Adds the resources contained in this collection to the archive. +
    Tar.TarCompressionMethod - Class in org.apache.tools.ant.taskdefs
    Valid Modes for Compression attribute to Tar Task
    Tar.TarCompressionMethod() - +Constructor for class org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod +
    Default constructor +
    Tar.TarFileSet - Class in org.apache.tools.ant.taskdefs
    This is a FileSet with the option to specify permissions + and other attributes.
    Tar.TarFileSet(FileSet) - +Constructor for class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
    Creates a new TarFileSet instance. +
    Tar.TarFileSet() - +Constructor for class org.apache.tools.ant.taskdefs.Tar.TarFileSet +
    Creates a new TarFileSet instance. +
    Tar.TarLongFileMode - Class in org.apache.tools.ant.taskdefs
    Set of options for long file handling in the task.
    Tar.TarLongFileMode() - +Constructor for class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    Constructor, defaults to "warn" +
    TarBuffer - Class in org.apache.tools.tar
    The TarBuffer class implements the tar archive concept + of a buffered input stream.
    TarBuffer(InputStream) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an input stream. +
    TarBuffer(InputStream, int) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an input stream. +
    TarBuffer(InputStream, int, int) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an input stream. +
    TarBuffer(OutputStream) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an output stream. +
    TarBuffer(OutputStream, int) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an output stream. +
    TarBuffer(OutputStream, int, int) - +Constructor for class org.apache.tools.tar.TarBuffer +
    Constructor for a TarBuffer on an output stream. +
    TarConstants - Interface in org.apache.tools.tar
    This interface contains all the definitions used in the package.
    TarEntry - Class in org.apache.tools.tar
    This class represents an entry in a Tar archive.
    TarEntry(String) - +Constructor for class org.apache.tools.tar.TarEntry +
    Construct an entry with only a name. +
    TarEntry(String, boolean) - +Constructor for class org.apache.tools.tar.TarEntry +
    Construct an entry with only a name. +
    TarEntry(String, byte) - +Constructor for class org.apache.tools.tar.TarEntry +
    Construct an entry with a name and a link flag. +
    TarEntry(File) - +Constructor for class org.apache.tools.tar.TarEntry +
    Construct an entry for a file. +
    TarEntry(byte[]) - +Constructor for class org.apache.tools.tar.TarEntry +
    Construct an entry from an archive's header bytes. +
    tarFile(File, TarOutputStream, String, Tar.TarFileSet) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    tar a file +
    TarFileSet - Class in org.apache.tools.ant.types
    A TarFileSet is a FileSet with extra attributes useful in the context of + Tar/Jar tasks.
    TarFileSet() - +Constructor for class org.apache.tools.ant.types.TarFileSet +
    Constructor for TarFileSet +
    TarFileSet(FileSet) - +Constructor for class org.apache.tools.ant.types.TarFileSet +
    Constructor using a fileset arguement. +
    TarFileSet(TarFileSet) - +Constructor for class org.apache.tools.ant.types.TarFileSet +
    Constructor using a tarfileset arguement. +
    Target - Class in org.apache.tools.ant
    Class to implement a target object with required parameters.
    Target() - +Constructor for class org.apache.tools.ant.Target +
    Default constructor. +
    Target(Target) - +Constructor for class org.apache.tools.ant.Target +
    Cloning constructor. +
    target - +Variable in class org.apache.tools.ant.Task +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getOwningTarget() method. +
    target - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    TARGET_LOG - +Static variable in class org.apache.tools.ant.listener.CommonsLoggingListener +
    name of the category under which target events are logged +
    targetdir - +Variable in class org.apache.tools.ant.types.selectors.MappingSelector +
      +
    targetFilePos - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    targetFinished(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that a target has finished. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    No-op implementation. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that a target has finished.. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that a target has finished.. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.ProfileLogger +
    Logs a message to say that the target has finished. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.NoBannerLogger +
    Resets the current target name to null. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals that a target has finished. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired when a target has finished. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that a target has finished.. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that a target has finished. +
    targetFinished(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when a target finishes building, this adds the time taken + and any error stacktrace to the appropriate target element in the log. +
    targetName - +Variable in class org.apache.tools.ant.NoBannerLogger +
    Name of the current target, if it should + be displayed on the next message. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    targetStarted(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that a target is starting. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    Logs a message to say that the target has started if this + logger allows information-level messages. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    Notes the name of the target so it can be logged + if it generates any messages. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that a target is starting.. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that a target is starting.. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.ProfileLogger +
    Logs a message to say that the target has started. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.NoBannerLogger +
    Notes the name of the target so it can be logged + if it generates any messages. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals that a target is starting. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired when a target is started. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that a target is starting.. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that a target is starting. +
    targetStarted(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when a target starts building, this pushes a timed element + for the target onto the stack of elements for the current thread, + remembering the current time and the name of the target. +
    TarInputStream - Class in org.apache.tools.tar
    The TarInputStream reads a UNIX tar archive as an InputStream.
    TarInputStream(InputStream) - +Constructor for class org.apache.tools.tar.TarInputStream +
    Constructor for TarInputStream. +
    TarInputStream(InputStream, int) - +Constructor for class org.apache.tools.tar.TarInputStream +
    Constructor for TarInputStream. +
    TarInputStream(InputStream, int, int) - +Constructor for class org.apache.tools.tar.TarInputStream +
    Constructor for TarInputStream. +
    TarOutputStream - Class in org.apache.tools.tar
    The TarOutputStream writes a UNIX tar archive as an OutputStream.
    TarOutputStream(OutputStream) - +Constructor for class org.apache.tools.tar.TarOutputStream +
    Constructor for TarInputStream. +
    TarOutputStream(OutputStream, int) - +Constructor for class org.apache.tools.tar.TarOutputStream +
    Constructor for TarInputStream. +
    TarOutputStream(OutputStream, int, int) - +Constructor for class org.apache.tools.tar.TarOutputStream +
    Constructor for TarInputStream. +
    tarResource(Resource, TarOutputStream, String, Tar.TarFileSet) - +Method in class org.apache.tools.ant.taskdefs.Tar +
    tar a resource +
    TarResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of an entry in a tar archive.
    TarResource() - +Constructor for class org.apache.tools.ant.types.resources.TarResource +
    Default constructor. +
    TarResource(File, TarEntry) - +Constructor for class org.apache.tools.ant.types.resources.TarResource +
    Construct a TarResource representing the specified + entry in the specified archive. +
    TarResource(Resource, TarEntry) - +Constructor for class org.apache.tools.ant.types.resources.TarResource +
    Construct a TarResource representing the specified + entry in the specified archive. +
    TarScanner - Class in org.apache.tools.ant.types
    Scans tar archives for resources.
    TarScanner() - +Constructor for class org.apache.tools.ant.types.TarScanner +
      +
    TarUtils - Class in org.apache.tools.tar
    This class provides static utility methods to work with byte streams.
    TarUtils() - +Constructor for class org.apache.tools.tar.TarUtils +
      +
    Task - Class in org.apache.tools.ant
    Base class for all tasks.
    Task() - +Constructor for class org.apache.tools.ant.Task +
    Sole constructor. +
    task - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    task - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    task - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    Task +
    task - +Variable in class org.apache.tools.ant.util.SourceFileScanner +
      +
    TaskAdapter - Class in org.apache.tools.ant
    Uses introspection to "adapt" an arbitrary Bean which doesn't + itself extend Task, but still contains an execute method and optionally + a setProject method.
    TaskAdapter() - +Constructor for class org.apache.tools.ant.TaskAdapter +
    No-arg constructor for reflection. +
    TaskAdapter(Object) - +Constructor for class org.apache.tools.ant.TaskAdapter +
    Constructor for given proxy. +
    TaskConfigurationChecker - Class in org.apache.tools.ant
    Helper class for the check of the configuration of a given task.
    TaskConfigurationChecker(Task) - +Constructor for class org.apache.tools.ant.TaskConfigurationChecker +
    Constructor. +
    TaskContainer - Interface in org.apache.tools.ant
    Interface for objects which can contain tasks.
    Taskdef - Class in org.apache.tools.ant.taskdefs
    Adds a task definition to the current project, such that this new task can be + used in the current project.
    Taskdef() - +Constructor for class org.apache.tools.ant.taskdefs.Taskdef +
    Default constructor. +
    TASKDEF_PROPERTIES_RESOURCE - +Static variable in class org.apache.tools.ant.MagicNames +
    name of the resource that taskdefs are stored under. +
    TASKDEF_TYPE_JAVACC - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    TASKDEF_TYPE_JJDOC - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    TASKDEF_TYPE_JJTREE - +Static variable in class org.apache.tools.ant.taskdefs.optional.javacc.JavaCC +
      +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    taskFinished(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that a task has finished. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    No-op implementation. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that a task has finished.. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that a task has finished.. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.listener.ProfileLogger +
    Logs a message to say that the task has finished. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    The task outside of this JUnitResultFormatter is the task. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired when a task has finished. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that a task has finished.. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that a task has finished. +
    taskFinished(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when a task finishes building, this adds the time taken + and any error stacktrace to the appropriate task element in the log. +
    TaskLogger - Class in org.apache.tools.ant.util
    A facade that makes logging nicer to use.
    TaskLogger(Task) - +Constructor for class org.apache.tools.ant.util.TaskLogger +
    Constructor for the TaskLogger +
    taskName - +Variable in class org.apache.tools.ant.Task +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getTaskName() method. +
    TaskOutputStream - Class in org.apache.tools.ant.taskdefs
    Deprecated. since 1.2.x. + Use LogOutputStream instead.
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.AntClassLoader +
    Empty implementation to satisfy the BuildListener interface. +
    taskStarted(BuildEvent) - +Method in interface org.apache.tools.ant.BuildListener +
    Signals that a task is starting. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.DefaultLogger +
    No-op implementation. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.BigProjectLogger +
    No-op implementation. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.CommonsLoggingListener +
    Signals that a task is starting.. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.Log4jListener +
    Signals that a task is starting.. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.listener.ProfileLogger +
    Logs a message to say that the task has started. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Not used + Signals that a task is starting. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    Fired when a task is started. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.Recorder +
    Empty implementation required by SubBuildListener interface. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.taskdefs.RecorderEntry +
    Signals that a task is starting.. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Signals that a task is starting. +
    taskStarted(BuildEvent) - +Method in class org.apache.tools.ant.XmlLogger +
    Fired when a task starts building, this pushes a timed element + for the task onto the stack of elements for the current thread, + remembering the current time and the name of the task. +
    taskString - +Variable in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask +
      +
    taskString - +Variable in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask +
      +
    taskType - +Variable in class org.apache.tools.ant.Task +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getTaskType() method. +
    TEARDOWN_EXCEPTION - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    Teardown exception : "Teardown Exception" +
    TearDownOnVmCrash - Class in org.apache.tools.ant.taskdefs.optional.junit
    Formatter that doesn't create any output but tries to invoke the + tearDown method on a testcase if that test was forked and caused a + timeout or VM crash.
    TearDownOnVmCrash() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash +
      +
    TeeOutputStream - Class in org.apache.tools.ant.util
    A simple T-piece to replicate an output stream into two separate streams
    TeeOutputStream(OutputStream, OutputStream) - +Constructor for class org.apache.tools.ant.util.TeeOutputStream +
    Constructor for TeeOutputStream. +
    TelnetTask - Class in org.apache.tools.ant.taskdefs.optional.net
    Automates the telnet protocol.
    TelnetTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.TelnetTask +
      +
    TelnetTask.AntTelnetClient - Class in org.apache.tools.ant.taskdefs.optional.net
    This class handles the abstraction of the telnet protocol.
    TelnetTask.AntTelnetClient() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient +
      +
    TelnetTask.TelnetRead - Class in org.apache.tools.ant.taskdefs.optional.net
    Reads the output from the connected server + until the required string is found or we time out.
    TelnetTask.TelnetRead() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetRead +
      +
    TelnetTask.TelnetSubTask - Class in org.apache.tools.ant.taskdefs.optional.net
    This class is the parent of the Read and Write tasks.
    TelnetTask.TelnetSubTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask +
      +
    TelnetTask.TelnetWrite - Class in org.apache.tools.ant.taskdefs.optional.net
    Sends text to the connected server
    TelnetTask.TelnetWrite() - +Constructor for class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetWrite +
      +
    TempFile - Class in org.apache.tools.ant.taskdefs
    This task sets a property to the name of a temporary file.
    TempFile() - +Constructor for class org.apache.tools.ant.taskdefs.TempFile +
      +
    testAvailability(String) - +Method in class org.apache.tools.ant.util.regexp.RegexpMatcherFactory +
    Test if a particular class is available to be used. +
    TESTCASE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the testcase element +
    testIfCondition(Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns true if the value is null or an empty string, can be + interpreted as a true value or cannot be interpreted as a false + value and a property of the value's name exists. +
    TESTLISTENER_PREFIX - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask +
      +
    TESTSUITE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the testsuite element +
    TESTSUITES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    the testsuites element for the aggregate document +
    testUnlessCondition(Object) - +Method in class org.apache.tools.ant.PropertyHelper +
    Returns true if the value is null or an empty string, can be + interpreted as a false value or cannot be interpreted as a true + value and a property of the value's name doesn't exist. +
    Text - Class in org.apache.tools.ant.types.optional.image
     
    Text() - +Constructor for class org.apache.tools.ant.types.optional.image.Text +
      +
    THROW - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Throw an exception if field cannot be parsed. +
    THROW_KEY - +Static variable in class org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField +
    Key for "throw an exception" action. +
    throwBuildException(Exception) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    A method to convert an invocationTargetException to + a buildexception and throw it. +
    throwNotSupported(Project, Object, String) - +Method in class org.apache.tools.ant.IntrospectionHelper +
    Utility method to throw a NotSupported exception +
    TIME_CURRENT - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for current (default) timestamp +
    TIME_MODIFIED - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for modified timestamp +
    TIME_UPDATED - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for updated timestamp +
    TimeComparison - Class in org.apache.tools.ant.types
    EnumeratedAttribute for time comparisons.
    TimeComparison() - +Constructor for class org.apache.tools.ant.types.TimeComparison +
    Default constructor. +
    TimeComparison(String) - +Constructor for class org.apache.tools.ant.types.TimeComparison +
    Construct a new TimeComparison with the specified value. +
    timedOut - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.TestResultHolder +
    true if the test timed out +
    TimeoutObserver - Interface in org.apache.tools.ant.util
    Interface for classes that want to be notified by Watchdog.
    timeoutOccured(Watchdog) - +Method in class org.apache.tools.ant.taskdefs.ExecuteJava +
    Mark timeout as having occurred. +
    timeoutOccured(Watchdog) - +Method in class org.apache.tools.ant.taskdefs.ExecuteWatchdog +
    Called after watchdog has finished. +
    timeoutOccured(Watchdog) - +Method in interface org.apache.tools.ant.util.TimeoutObserver +
    Called when the watchdow times out. +
    TIMESTAMP - +Static variable in interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants +
    timestamp of test cases +
    TimestampedLogger - Class in org.apache.tools.ant.listener
    Like a normal logger, except with timed outputs
    TimestampedLogger() - +Constructor for class org.apache.tools.ant.listener.TimestampedLogger +
      +
    TMAGIC - +Static variable in interface org.apache.tools.tar.TarConstants +
    The magic tag representing a POSIX tar archive. +
    to - +Variable in class org.apache.tools.ant.types.Mapper +
      +
    to - +Variable in class org.apache.tools.ant.util.RegexpPatternMapper +
      +
    to(String) - +Method in class org.apache.tools.mail.MailMessage +
    Sets the to address. +
    toBoolean(String) - +Static method in class org.apache.tools.ant.Project +
    Return the boolean equivalent of a string, which is considered + true if either "on", "true", + or "yes" is found, ignoring case. +
    toBoolean(Object) - +Static method in class org.apache.tools.ant.PropertyHelper +
    If the given object can be interpreted as a true/false value, + turn it into a matching Boolean - otherwise return null. +
    toBuildException(Exception) - +Static method in class org.apache.tools.ant.util.ReflectUtil +
    A method to convert an invocationTargetException to + a buildexception. +
    toCommand() - +Method in class org.apache.tools.ant.types.Assertions.BaseAssertion +
    create a full command string from this class +
    toDir - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    the destination directory, this is the root from where html should be generated +
    toDir - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    the directory to write the file to +
    toDosTime(Date) - +Static method in class org.apache.tools.zip.ZipOutputStream +
    Convert a Date object to a DOS date/time field. +
    toDosTime(long) - +Static method in class org.apache.tools.zip.ZipOutputStream +
    Convert a Date object to a DOS date/time field. +
    toExtensions(Project) - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
    Extract a set of Extension objects from the ExtensionSet. +
    toFile - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    the name of the result file +
    toFileArray(String[]) - +Method in class org.apache.tools.ant.types.RedirectorElement +
    Return a File[] from the specified set of filenames. +
    TOKEN_END - +Static variable in class org.apache.tools.ant.Project +
    Default filter end token. +
    TOKEN_START - +Static variable in class org.apache.tools.ant.Project +
    Default filter start token. +
    TokenFilter - Class in org.apache.tools.ant.filters
    This splits up input into tokens and passes + the tokens to a sequence of filters.
    TokenFilter() - +Constructor for class org.apache.tools.ant.filters.TokenFilter +
    Constructor for "dummy" instances. +
    TokenFilter(Reader) - +Constructor for class org.apache.tools.ant.filters.TokenFilter +
    Creates a new filtered reader. +
    TokenFilter.ChainableReaderFilter - Class in org.apache.tools.ant.filters
    Abstract class that converts derived filter classes into + ChainableReaderFilter's
    TokenFilter.ChainableReaderFilter() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter +
      +
    TokenFilter.ContainsRegex - Class in org.apache.tools.ant.filters
    filter to filter tokens matching regular expressions.
    TokenFilter.ContainsRegex() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.ContainsRegex +
      +
    TokenFilter.ContainsString - Class in org.apache.tools.ant.filters
    Simple filter to filter lines contains strings
    TokenFilter.ContainsString() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.ContainsString +
      +
    TokenFilter.DeleteCharacters - Class in org.apache.tools.ant.filters
    Filter to delete characters
    TokenFilter.DeleteCharacters() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.DeleteCharacters +
      +
    TokenFilter.FileTokenizer - Class in org.apache.tools.ant.filters
    class to read the complete input into a string
    TokenFilter.FileTokenizer() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.FileTokenizer +
      +
    TokenFilter.Filter - Interface in org.apache.tools.ant.filters
    string filters implement this interface
    TokenFilter.IgnoreBlank - Class in org.apache.tools.ant.filters
    Filter remove empty tokens
    TokenFilter.IgnoreBlank() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.IgnoreBlank +
      +
    TokenFilter.ReplaceRegex - Class in org.apache.tools.ant.filters
    filter to replace regex.
    TokenFilter.ReplaceRegex() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.ReplaceRegex +
      +
    TokenFilter.ReplaceString - Class in org.apache.tools.ant.filters
    Simple replace string filter.
    TokenFilter.ReplaceString() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.ReplaceString +
      +
    TokenFilter.StringTokenizer - Class in org.apache.tools.ant.filters
    class to tokenize the input as areas separated + by white space, or by a specified list of + delim characters.
    TokenFilter.StringTokenizer() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.StringTokenizer +
      +
    TokenFilter.Trim - Class in org.apache.tools.ant.filters
    Filter to trim white space
    TokenFilter.Trim() - +Constructor for class org.apache.tools.ant.filters.TokenFilter.Trim +
      +
    TokenizedPath - Class in org.apache.tools.ant.types.selectors
    Container for a path that has been split into its components.
    TokenizedPath(String) - +Constructor for class org.apache.tools.ant.types.selectors.TokenizedPath +
    Initialize the TokenizedPath by parsing it. +
    TokenizedPath(TokenizedPath, String) - +Constructor for class org.apache.tools.ant.types.selectors.TokenizedPath +
    Creates a new path as a child of another path. +
    TokenizedPattern - Class in org.apache.tools.ant.types.selectors
    Provides reusable path pattern matching.
    TokenizedPattern(String) - +Constructor for class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Initialize the PathPattern by parsing it. +
    tokenizePath(String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Breaks a path up into a Vector of path elements, tokenizing on + File.separator. +
    tokenizePath(String, String) - +Static method in class org.apache.tools.ant.types.selectors.SelectorUtils +
    Breaks a path up into a Vector of path elements, tokenizing on +
    Tokenizer - Interface in org.apache.tools.ant.util
    input stream tokenizers implement this interface
    Tokens - Class in org.apache.tools.ant.types.resources
    ResourceCollection consisting of StringResources gathered from tokenizing + another ResourceCollection with a Tokenizer implementation.
    Tokens() - +Constructor for class org.apache.tools.ant.types.resources.Tokens +
      +
    toList - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    toLongString() - +Method in class org.apache.tools.ant.types.Resource +
    Get a long String representation of this Resource. +
    tooManyAttributes() - +Method in class org.apache.tools.ant.types.DataType +
    Creates an exception that indicates that refid has to be the + only attribute if it is set. +
    toOperation(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation +
    Convert string to index. +
    toPattern() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
    Creates a TokenizedPattern from the same tokens that make up + this path. +
    topoSort(String, Hashtable) - +Method in class org.apache.tools.ant.Project +
    Topologically sort a set of targets. +
    topoSort(String, Hashtable, boolean) - +Method in class org.apache.tools.ant.Project +
    Topologically sort a set of targets. +
    topoSort(String[], Hashtable, boolean) - +Method in class org.apache.tools.ant.Project +
    Topologically sort a set of targets. +
    toPostfix - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Part of "to" pattern after the *. +
    toPrefix - +Variable in class org.apache.tools.ant.util.GlobPatternMapper +
    Part of "to" pattern before the *. +
    toString() - +Method in class org.apache.tools.ant.AntClassLoader +
    Returns a String representing this loader. +
    toString() - +Method in exception org.apache.tools.ant.BuildException +
    Returns the location of the error and the error message. +
    toString() - +Method in class org.apache.tools.ant.Location +
    Returns the file name, line number, a colon and a trailing space. +
    toString() - +Method in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
      +
    toString() - +Method in class org.apache.tools.ant.property.NullReturn +
    +
    toString() - +Method in class org.apache.tools.ant.Target +
    Returns the name of this target. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CVSEntry +
    Gets a String containing author, date, files and comment +
    toString() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry +
    Gets a String containing filename and difference from previous version +
    toString() - +Method in class org.apache.tools.ant.taskdefs.email.EmailAddress +
    Constructs a string "name <address>" or "address" +
    toString(ByteArrayOutputStream) - +Static method in class org.apache.tools.ant.taskdefs.Execute +
    ByteArrayOutputStream#toString doesn't seem to work reliably on + OS/390, at least not the way we use it in the execution + context. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName +
    Generate a string rep of this distinguished name. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.Javadoc.PackageName +
    Return a string rep for this object. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Convert the manifest to its string representation +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo +
    Generate a string readable version of this entry +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool +
    Dump the constant pool to a string. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.DoubleCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.FloatCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.IntegerCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.LongCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo +
    Print a readable version of the constant pool entry. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Compatability +
    Return name of compatability level. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Compatibility +
    Return name of compatibility level. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Extension +
    Return a String representation of this object. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter +
    a debug toString method. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet +
      +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver +
    Returns a string representation +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver +
    Returns a string representation of the Location +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
    Returns a string representation of the URL +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.Specification +
    Return a String representation of this object. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos +
    This String-Representation can directly be used for instantiation of + the JUnit testcase. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter +
      +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile +
    Get a string rep of this object. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile +
    Get a string rep of this object. +
    toString() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    Returns a string representation of the object for error messages + and the like +
    toString() - +Method in class org.apache.tools.ant.taskdefs.Property +
    get the value of this property +
    toString() - +Method in class org.apache.tools.ant.types.AbstractFileSet +
    Returns included files as a list of semicolon-separated filenames. +
    toString() - +Method in class org.apache.tools.ant.types.ArchiveFileSet +
    For file-based archivefilesets, return the same as for normal filesets; + else just return the path of the zip. +
    toString() - +Method in class org.apache.tools.ant.types.Commandline +
    Return the command line as a string. +
    toString(String[]) - +Static method in class org.apache.tools.ant.types.Commandline +
    Quote the parts of the given array in way that makes them + usable as command line arguments. +
    toString() - +Method in class org.apache.tools.ant.types.CommandlineJava +
    Get a string description. +
    toString() - +Method in class org.apache.tools.ant.types.DataType +
    Basic DataType toString(). +
    toString() - +Method in class org.apache.tools.ant.types.DirSet +
    Returns included directories as a list of semicolon-separated paths. +
    toString() - +Method in class org.apache.tools.ant.types.EnumeratedAttribute +
    Convert the value to its string form. +
    toString() - +Method in class org.apache.tools.ant.types.FlexInteger +
    Overridden method to return the decimal value for display +
    toString() - +Method in class org.apache.tools.ant.types.Path +
    Returns a textual representation of the path, which can be used as + CLASSPATH or PATH environment variable definition. +
    toString() - +Method in class org.apache.tools.ant.types.PatternSet.NameEntry +
      +
    toString() - +Method in class org.apache.tools.ant.types.PatternSet +
      +
    toString() - +Method in class org.apache.tools.ant.types.Permissions.Permission +
    Get a string description of the permissions. +
    toString() - +Method in class org.apache.tools.ant.types.PropertySet.PropertyRef +
    A debug toString(). +
    toString() - +Method in class org.apache.tools.ant.types.PropertySet +
    A debug toString. +
    toString() - +Method in class org.apache.tools.ant.types.Resource +
    Get the string representation of this Resource. +
    toString() - +Method in class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper +
    Format this BaseResourceCollectionWrapper as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.ArchiveResource +
    Format this Resource as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer +
    Format this BaseResourceCollectionContainer as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.CompressedResource +
    Get the string representation of this Resource. +
    toString() - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Get the string representation of this Resource. +
    toString() - +Method in class org.apache.tools.ant.types.resources.Files +
    Format this Files collection as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.PropertyResource +
    Get the string representation of this Resource. +
    toString() - +Method in class org.apache.tools.ant.types.resources.Resources +
    Format this Resources as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.Restrict +
    Format this Restrict collection as a String. +
    toString() - +Method in class org.apache.tools.ant.types.resources.StringResource +
    Get the string. +
    toString() - +Method in class org.apache.tools.ant.types.resources.URLResource +
    Return this URLResource formatted as a String. +
    toString() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    Convert the Selectors within this container to a string. +
    toString() - +Method in class org.apache.tools.ant.types.selectors.AndSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    Convert the Selectors within this container to a string. +
    toString() - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.DependSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.MajoritySelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.EqualComparator +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.HashvalueAlgorithm +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache +
    Override Object.toString(). +
    toString() - +Method in class org.apache.tools.ant.types.selectors.NoneSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.NotSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.OrSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    Returns a String object representing the specified + SizeSelector. +
    toString() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPath +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
      +
    toString() - +Method in class org.apache.tools.ant.types.selectors.TypeSelector +
      +
    toString() - +Method in class org.apache.tools.ant.util.DeweyDecimal +
    Return string representation of DeweyDecimal. +
    toString() - +Method in class org.apache.tools.ant.util.java15.ProxyDiagnostics +
    Get the diagnostics for proxy information. +
    toString() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    toString() - +Method in class org.apache.tools.zip.ZipOutputStream.UnicodeExtraFieldPolicy +
      +
    toType(String) - +Static method in class org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type +
    Convert string to index. +
    Touch - Class in org.apache.tools.ant.taskdefs
    Touch a file and/or fileset(s) and/or filelist(s); + corresponds to the Unix touch command.
    Touch() - +Constructor for class org.apache.tools.ant.taskdefs.Touch +
    Construct a new Touch task. +
    touch() - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Does the actual work; assumes everything has been checked by now. +
    touch(File) - +Method in class org.apache.tools.ant.taskdefs.Touch +
    Deprecated. since 1.6.x. +
    touch(long) - +Method in class org.apache.tools.ant.types.resources.FileResource +
    Implement the Touchable interface. +
    touch(long) - +Method in interface org.apache.tools.ant.types.resources.Touchable +
    Method called to "touch" the resource. +
    Touch.DateFormatFactory - Interface in org.apache.tools.ant.taskdefs
     
    Touchable - Interface in org.apache.tools.ant.types.resources
    Interface to be implemented by "touchable" resources; + that is, those whose modification time can be altered.
    toURI(String) - +Method in class org.apache.tools.ant.util.FileUtils +
    Constructs a file: URI that represents the + external form of the given pathname. +
    toVMSPath(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Returns a VMS String representation of a File object. +
    trackProgress(long, long, int) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Track progress every 10% if 100kb < filesize < 1mb. +
    transferFiles(FTPClient, FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    For each file in the fileset, do the appropriate action: send, get, + delete, or list. +
    transferFiles(FTPClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTP +
    Sends all files specified by the configured filesets to the remote + server. +
    transferFiles(FTPClient, FileSet) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    For each file in the fileset, do the appropriate action: send, get, + delete, or list. +
    transferFiles(FTPClient) - +Method in class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl +
    Sends all files specified by the configured filesets to the remote + server. +
    transform() - +Method in class org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer +
    transformation +
    transform(File, File) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Transform an input file. +
    Transform - Class in org.apache.tools.ant.taskdefs
    Has been merged into ExecuteOn, empty class for backwards compatibility.
    Transform() - +Constructor for class org.apache.tools.ant.taskdefs.Transform +
      +
    transform(File, File) - +Method in interface org.apache.tools.ant.taskdefs.XSLTLiaison +
    Perform the transformation of a file into another. +
    transformers - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
      +
    TransformOperation - Class in org.apache.tools.ant.types.optional.image
     
    TransformOperation() - +Constructor for class org.apache.tools.ant.types.optional.image.TransformOperation +
      +
    Translate - Class in org.apache.tools.ant.taskdefs.optional.i18n
    Translates text embedded in files using Resource Bundle files.
    Translate() - +Constructor for class org.apache.tools.ant.taskdefs.optional.i18n.Translate +
      +
    translateCommandline(String) - +Static method in class org.apache.tools.ant.types.Commandline +
    Crack a command line. +
    translateFile(String) - +Static method in class org.apache.tools.ant.types.Path +
    Returns its argument with all file separator characters + replaced so that they match the local OS conventions. +
    translateFileSep(StringBuffer, int) - +Static method in class org.apache.tools.ant.types.Path +
    Translates occurrences at a position of / or \ to correct separator of the + current platform and returns whether it had to do a + replacement. +
    translatePath(String) - +Static method in class org.apache.tools.ant.Project +
    Deprecated. since 1.7 + Use FileUtils.translatePath instead. +
    translatePath(Project, String) - +Static method in class org.apache.tools.ant.types.Path +
    Splits a PATH (with : or ; as separators) into its parts. +
    translatePath(String) - +Static method in class org.apache.tools.ant.util.FileUtils +
    Translate a path into its native (platform specific) format. +
    TraXLiaison - Class in org.apache.tools.ant.taskdefs.optional
    Concrete liaison for XSLT processor implementing TraX.
    TraXLiaison() - +Constructor for class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Constructor for TraXLiaison. +
    trimSeparator(String) - +Static method in class org.apache.tools.ant.types.ArchiveScanner +
    Remove trailing slash if present. +
    TRUNCATE - +Static variable in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    permissible values for longfile attribute +
    TRUNCATE - +Static variable in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + Tar.TRUNCATE is deprecated and is replaced with + Tar.TarLongFileMode.TRUNCATE +
    Truncate - Class in org.apache.tools.ant.taskdefs
    Set the length of one or more files, as the intermittently available + truncate Unix utility/function.
    Truncate() - +Constructor for class org.apache.tools.ant.taskdefs.Truncate +
      +
    tryHardToDelete(File) - +Method in class org.apache.tools.ant.util.FileUtils +
    Accommodate Windows bug encountered in both Sun and IBM JDKs. +
    tryToSetAParameter(Object, String, String) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Try to set a value on an object using reflection. +
    tsacert - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    alias for the TSA in the keystore +
    tsaurl - +Variable in class org.apache.tools.ant.taskdefs.SignJar +
    URL for a tsa; null implies no tsa support +
    Tstamp - Class in org.apache.tools.ant.taskdefs
    Sets properties to the current time, or offsets from the current time.
    Tstamp() - +Constructor for class org.apache.tools.ant.taskdefs.Tstamp +
      +
    Tstamp.CustomFormat - Class in org.apache.tools.ant.taskdefs
    This nested element that allows a property to be set + to the current date and time in a given format.
    Tstamp.CustomFormat() - +Constructor for class org.apache.tools.ant.taskdefs.Tstamp.CustomFormat +
    Create a format +
    Tstamp.Unit - Class in org.apache.tools.ant.taskdefs
    set of valid units to use for time offsets.
    Tstamp.Unit() - +Constructor for class org.apache.tools.ant.taskdefs.Tstamp.Unit +
    Constructor for Unit enumerated type. +
    type - +Variable in class org.apache.tools.ant.taskdefs.ExecuteOn +
      +
    type - +Variable in class org.apache.tools.ant.types.Mapper +
      +
    type - +Variable in class org.apache.tools.ant.types.optional.image.Arc +
      +
    Type - Class in org.apache.tools.ant.types.resources.comparators
    Compares Resources by is-directory status.
    Type() - +Constructor for class org.apache.tools.ant.types.resources.comparators.Type +
      +
    Type - Class in org.apache.tools.ant.types.resources.selectors
    Type file/dir ResourceSelector.
    Type() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Type +
    Default constructor. +
    Type(Type.FileDir) - +Constructor for class org.apache.tools.ant.types.resources.selectors.Type +
    Convenience constructor. +
    Type.FileDir - Class in org.apache.tools.ant.types.resources.selectors
    Implements the type attribute.
    Type.FileDir() - +Constructor for class org.apache.tools.ant.types.resources.selectors.Type.FileDir +
    Default constructor. +
    Type.FileDir(String) - +Constructor for class org.apache.tools.ant.types.resources.selectors.Type.FileDir +
    Convenience constructor. +
    TYPE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.TypeSelector +
    Key to used for parameterized custom selector +
    TypeAdapter - Interface in org.apache.tools.ant
    Used to wrap types.
    Typedef - Class in org.apache.tools.ant.taskdefs
    Adds a data type definition to the current project.
    Typedef() - +Constructor for class org.apache.tools.ant.taskdefs.Typedef +
      +
    TYPEDEFS_PROPERTIES_RESOURCE - +Static variable in class org.apache.tools.ant.MagicNames +
    name of the resource that typedefs are stored under. +
    TypeFound - Class in org.apache.tools.ant.taskdefs.condition
    looks for a task or other Ant type that exists.
    TypeFound() - +Constructor for class org.apache.tools.ant.taskdefs.condition.TypeFound +
      +
    TypeSelector - Class in org.apache.tools.ant.types.selectors
    Selector that selects a certain kind of file: directory or regular.
    TypeSelector() - +Constructor for class org.apache.tools.ant.types.selectors.TypeSelector +
    Creates a new TypeSelector instance. +
    TypeSelector.FileType - Class in org.apache.tools.ant.types.selectors
    Enumerated attribute with the values for types of file
    TypeSelector.FileType() - +Constructor for class org.apache.tools.ant.types.selectors.TypeSelector.FileType +
      +
    +
    +

    +U

    +
    +
    UCOM_ID - +Static variable in class org.apache.tools.zip.UnicodeCommentExtraField +
      +
    UFT8_NAMES_FLAG - +Static variable in class org.apache.tools.zip.ZipOutputStream +
    General purpose flag, which indicates that filenames are + written in utf-8. +
    UIDLEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the user id field in a header buffer. +
    UNAMELEN - +Static variable in interface org.apache.tools.tar.TarConstants +
    The length of the user name field in a header buffer. +
    UnicodeCommentExtraField - Class in org.apache.tools.zip
    Info-ZIP Unicode Comment Extra Field (0x6375):
    UnicodeCommentExtraField() - +Constructor for class org.apache.tools.zip.UnicodeCommentExtraField +
      +
    UnicodeCommentExtraField(String, byte[], int, int) - +Constructor for class org.apache.tools.zip.UnicodeCommentExtraField +
    Assemble as unicode comment extension from the name given as + text as well as the encoded bytes actually written to the archive. +
    UnicodeCommentExtraField(String, byte[]) - +Constructor for class org.apache.tools.zip.UnicodeCommentExtraField +
    Assemble as unicode comment extension from the comment given as + text as well as the bytes actually written to the archive. +
    UnicodePathExtraField - Class in org.apache.tools.zip
    Info-ZIP Unicode Path Extra Field (0x7075):
    UnicodePathExtraField() - +Constructor for class org.apache.tools.zip.UnicodePathExtraField +
      +
    UnicodePathExtraField(String, byte[], int, int) - +Constructor for class org.apache.tools.zip.UnicodePathExtraField +
    Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive. +
    UnicodePathExtraField(String, byte[]) - +Constructor for class org.apache.tools.zip.UnicodePathExtraField +
    Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive. +
    Union - Class in org.apache.tools.ant.types.resources
    ResourceCollection representing the union of multiple nested ResourceCollections.
    Union() - +Constructor for class org.apache.tools.ant.types.resources.Union +
    Default constructor. +
    Union(Project) - +Constructor for class org.apache.tools.ant.types.resources.Union +
    Create a new Union. +
    Union(ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.Union +
    Convenience constructor. +
    Union(Project, ResourceCollection) - +Constructor for class org.apache.tools.ant.types.resources.Union +
    Convenience constructor. +
    UniqFilter - Class in org.apache.tools.ant.filters
    Like the Unix uniq(1) command, only returns tokens that are + different from their ancestor token.
    UniqFilter() - +Constructor for class org.apache.tools.ant.filters.UniqFilter +
      +
    UNITS_KEY - +Static variable in class org.apache.tools.ant.types.selectors.SizeSelector +
    Used for parameterized custom selector +
    UNIX_FILE_TIMESTAMP_GRANULARITY - +Static variable in class org.apache.tools.ant.util.FileUtils +
    The granularity of timestamps under Unix. +
    UnixStat - Interface in org.apache.tools.zip
    Constants from stat.h on Unix systems.
    UNKNOWN_DATETIME - +Static variable in class org.apache.tools.ant.types.Resource +
    Constant unknown datetime for getLastModified +
    UNKNOWN_LOCATION - +Static variable in class org.apache.tools.ant.Location +
    Location to use when one is needed but no information is available +
    UNKNOWN_SIZE - +Static variable in class org.apache.tools.ant.types.Resource +
    Constant unknown size +
    UnknownElement - Class in org.apache.tools.ant
    Wrapper class that holds all the information necessary to create a task + or data type that did not exist when Ant started, or one which + has had its definition updated to use a different implementation class.
    UnknownElement(String) - +Constructor for class org.apache.tools.ant.UnknownElement +
    Creates an UnknownElement for the given element name. +
    unlessProperty - +Variable in class org.apache.tools.ant.taskdefs.optional.junit.BaseTest +
      +
    Unpack - Class in org.apache.tools.ant.taskdefs
    Abstract Base class for unpack tasks.
    Unpack() - +Constructor for class org.apache.tools.ant.taskdefs.Unpack +
      +
    UnPackageNameMapper - Class in org.apache.tools.ant.util
    Maps dotted package name matches to a directory name.
    UnPackageNameMapper() - +Constructor for class org.apache.tools.ant.util.UnPackageNameMapper +
      +
    UnparseableExtraFieldData - Class in org.apache.tools.zip
    Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
    UnparseableExtraFieldData() - +Constructor for class org.apache.tools.zip.UnparseableExtraFieldData +
      +
    UnrecognizedExtraField - Class in org.apache.tools.zip
    Simple placeholder for all those extra fields we don't want to deal + with.
    UnrecognizedExtraField() - +Constructor for class org.apache.tools.zip.UnrecognizedExtraField +
      +
    UNSUPPORTED_STUB_OPTION - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    upsupported error message +
    UnsupportedAttributeException - Exception in org.apache.tools.ant
    Used to report attempts to set an unsupported attribute
    UnsupportedAttributeException(String, String) - +Constructor for exception org.apache.tools.ant.UnsupportedAttributeException +
    Constructs an unsupported attribute exception. +
    UnsupportedElementException - Exception in org.apache.tools.ant
    Used to report attempts to set an unsupported element + When the attempt to set the element is made, + the code does not not know the name of the task/type + based on a mapping from the classname to the task/type.
    UnsupportedElementException(String, String) - +Constructor for exception org.apache.tools.ant.UnsupportedElementException +
    Constructs an unsupported element exception. +
    Untar - Class in org.apache.tools.ant.taskdefs
    Untar a file.
    Untar() - +Constructor for class org.apache.tools.ant.taskdefs.Untar +
      +
    Untar.UntarCompressionMethod - Class in org.apache.tools.ant.taskdefs
    Valid Modes for Compression attribute to Untar Task
    Untar.UntarCompressionMethod() - +Constructor for class org.apache.tools.ant.taskdefs.Untar.UntarCompressionMethod +
    Constructor +
    UPATH_ID - +Static variable in class org.apache.tools.zip.UnicodePathExtraField +
      +
    update(LineEvent) - +Method in class org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer +
    This is implemented to listen for any line events and closes the + clip if required. +
    UpToDate - Class in org.apache.tools.ant.taskdefs
    Sets the given property if the specified target has a timestamp + greater than all of the source files.
    UpToDate() - +Constructor for class org.apache.tools.ant.taskdefs.UpToDate +
      +
    URI_ENCODING - +Static variable in class org.apache.tools.ant.launch.Locator +
    encoding used to represent URIs +
    URI_XSD - +Static variable in class org.apache.tools.ant.util.XmlConstants +
    the namespace for XML schema +
    url - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    URLProvider - Interface in org.apache.tools.ant.types.resources
    This is an interface that resources that can provide an URL should implement.
    URLResolver - Class in org.apache.tools.ant.taskdefs.optional.extension.resolvers
    Resolver that just returns s specified location.
    URLResolver() - +Constructor for class org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver +
      +
    URLResource - Class in org.apache.tools.ant.types.resources
    Exposes a URL as a Resource.
    URLResource() - +Constructor for class org.apache.tools.ant.types.resources.URLResource +
    Default constructor. +
    URLResource(URL) - +Constructor for class org.apache.tools.ant.types.resources.URLResource +
    Convenience constructor. +
    URLResource(URLProvider) - +Constructor for class org.apache.tools.ant.types.resources.URLResource +
    Convenience constructor. +
    URLResource(File) - +Constructor for class org.apache.tools.ant.types.resources.URLResource +
    Convenience constructor. +
    URLResource(String) - +Constructor for class org.apache.tools.ant.types.resources.URLResource +
    String constructor for Ant attribute introspection. +
    USE_SYSTEM_PROXIES - +Static variable in class org.apache.tools.ant.util.ProxySetup +
    Java1.5 property that enables use of system proxies. +
    usedMatchingTask - +Variable in class org.apache.tools.ant.taskdefs.Delete +
      +
    useParameter(Parameter) - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Support for nested tags. +
    user - +Variable in class org.apache.tools.ant.taskdefs.email.Mailer +
      +
    USER_HOMEDIR - +Static variable in class org.apache.tools.ant.launch.Launcher +
    System property with user home directory. +
    USER_LIBDIR - +Static variable in class org.apache.tools.ant.launch.Launcher +
    The location of a per-user library directory. +
    userProperty - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    usingBaseJarName() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Indicate if this build is using the base jar name. +
    Utf8CPInfo - Class in org.apache.tools.ant.taskdefs.optional.depend.constantpool
    A UTF8 Constant Pool Entry.
    Utf8CPInfo() - +Constructor for class org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo +
    Constructor. +
    util - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Base +
    Perl5 regexp in Java - cool eh? +
    UU - +Static variable in class org.apache.tools.ant.taskdefs.email.EmailTask +
    Constant to allow the UU mailer to be requested +
    UUEncoder - Class in org.apache.tools.ant.util
    UUEncoding of an input stream placed into an outputstream.
    UUEncoder(String) - +Constructor for class org.apache.tools.ant.util.UUEncoder +
    Constructor specifing a name for the encoded buffer, begin + line will be: +
    +
    +

    +V

    +
    +
    VALID_ATTRIBUTE_CHARS - +Static variable in class org.apache.tools.ant.taskdefs.ManifestTask +
    Specifies the valid characters which can be used in attribute names. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.condition.IsFileSelected +
    validate the parameters. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.condition.IsLastModified +
    Argument validation. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.condition.ResourceExists +
    Argument validation. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.cvslib.CvsUser +
    Validate that this object is configured. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute +
    Make sure that neither the name or the value + is null. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.Replace.Replacefilter +
    Validate the filter's configuration. +
    validate() - +Method in class org.apache.tools.ant.taskdefs.Sleep +
    verify parameters +
    validate() - +Method in class org.apache.tools.ant.types.Environment.Variable +
    checks whether all required attributes have been specified. +
    validate() - +Method in class org.apache.tools.ant.types.selectors.AbstractSelectorContainer +
    + This validates each contained selector + provided that the selector implements the validate interface. +
    validate() - +Method in class org.apache.tools.ant.types.selectors.BaseSelector +
    Subclasses can use this to throw the requisite exception + in isSelected() in the case of an error condition. +
    validate() - +Method in class org.apache.tools.ant.types.selectors.BaseSelectorContainer +
    This implementation validates the container by calling + verifySettings() and then validates each contained selector + provided that the selector implements the validate interface. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.Copy +
    Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.CopyPath +
    Deprecated. Ensure we have a consistent and legal set of attributes, and set any + internal flags necessary based on different combinations of attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.Move +
    Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes.. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.image.Image +
    Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool +
    Validates the passed in attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool +
    Validates the passed in attributes. +
    validateAttributes() - +Method in interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool +
    Validates the passed in attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool +
    Validates the passed in attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
    Validates the passed in attributes. +
    validateAttributes() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Validate attributes provided for this task in .xml build file. +
    validateConfigured() - +Method in interface org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateConfigured() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateConfigured() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateConfigured() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateConfigured() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateConfigured() - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Called to validate that the tool parameters have been configured. +
    validateNamespace() - +Method in class org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation +
    assert that a namespace is valid +
    validateReplacefilters() - +Method in class org.apache.tools.ant.taskdefs.Replace +
    Validate nested elements. +
    validateVersion() - +Static method in class org.apache.tools.ant.Diagnostics +
    Deprecated. Obsolete since Ant 1.8.2 +
    validity - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    value - +Variable in class org.apache.tools.ant.taskdefs.optional.perforce.P4Counter +
    new value for the counter +
    value - +Variable in class org.apache.tools.ant.taskdefs.Property +
      +
    value - +Variable in class org.apache.tools.ant.types.EnumeratedAttribute +
    The selected value in this enumeration. +
    VALUE_FROMDATE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    ~d flag +
    VALUE_FROMLABEL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    ~L flag +
    VALUE_NO - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -N flag +
    VALUE_YES - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    -Y flag +
    valueOf(String) - +Static method in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
      +
    values() - +Method in class org.apache.tools.ant.util.LinkedHashtable +
      +
    variables - +Variable in class org.apache.tools.ant.types.Environment +
    a vector of type Enviromment.Variable +
    VectorSet - Class in org.apache.tools.ant.util
    Subclass of Vector that won't store duplicate entries and shows + HashSet's constant time performance characteristics for the + contains method.
    VectorSet() - +Constructor for class org.apache.tools.ant.util.VectorSet +
      +
    VectorSet(int) - +Constructor for class org.apache.tools.ant.util.VectorSet +
      +
    VectorSet(int, int) - +Constructor for class org.apache.tools.ant.util.VectorSet +
      +
    VectorSet(Collection) - +Constructor for class org.apache.tools.ant.util.VectorSet +
      +
    verbose - +Variable in class org.apache.tools.ant.taskdefs.AbstractJarSignerTask +
    verbose output +
    verbose - +Variable in class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter +
      +
    verbose - +Variable in class org.apache.tools.ant.taskdefs.GenerateKey +
      +
    verbose(String) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder +
    Logging facade in VERBOSE-mode. +
    VERBOSE - +Static variable in class org.apache.tools.ant.types.LogLevel +
    VERBOSE loglevel constant. +
    verbose(String) - +Method in class org.apache.tools.ant.util.TaskLogger +
    Log a message with MSG_VERBOSE priority +
    verbosity - +Variable in class org.apache.tools.ant.taskdefs.Copy +
      +
    VERIFY - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Verify class +
    VerifyJar - Class in org.apache.tools.ant.taskdefs
    JAR verification task.
    VerifyJar() - +Constructor for class org.apache.tools.ant.taskdefs.VerifyJar +
      +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.BaseSelector +
    Subclasses can override this method to provide checking of their + state. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.ContainsRegexpSelector +
    Checks that an expression was specified. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.DateSelector +
    This is a consistency check to ensure the selector's required + values have been set. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.DepthSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.ExtendSelector +
    These are errors specific to ExtendSelector only. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.FilenameSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.MappingSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector +
    Overrides BaseSelector.verifySettings(). +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.NotSelector +
    Makes sure that there is only one entry, sets an error message if + not. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.PresentSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.SelectSelector +
    Makes sure that there is only one entry, sets an error message if + not. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.SizeSelector +
    Checks to make sure all settings are kosher. +
    verifySettings() - +Method in class org.apache.tools.ant.types.selectors.TypeSelector +
    Checks to make sure all settings are kosher. +
    VERSION_1_0 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.0 +
    VERSION_1_1 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.1 +
    VERSION_1_2 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.2 +
    VERSION_1_3 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.3 +
    VERSION_1_4 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.4 +
    VERSION_1_5 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.5 +
    VERSION_1_6 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.6 +
    VERSION_1_7 - +Static variable in class org.apache.tools.ant.util.JavaEnvUtils +
    Number Version constant for Java 1.7 +
    visitConstantClass(ConstantClass) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit a class reference +
    visitConstantNameAndType(ConstantNameAndType) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit a name and type ref + + Look for class references in this +
    visitConstantPool(ConstantPool) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit the constant pool of a class +
    visitField(Field) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit a field of the class. +
    visitJavaClass(JavaClass) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit a Java class +
    visitMethod(Method) - +Method in class org.apache.tools.ant.util.depend.bcel.DependencyVisitor +
    Visit a method of the current class +
    +
    +

    +W

    +
    +
    waitFor(Process) - +Method in class org.apache.tools.ant.taskdefs.Execute +
    Wait for a given process. +
    waitFor() - +Method in class org.apache.tools.ant.taskdefs.StreamPumper +
    This method blocks until the StreamPumper finishes. +
    WaitFor - Class in org.apache.tools.ant.taskdefs
    Wait for an external event to occur.
    WaitFor() - +Constructor for class org.apache.tools.ant.taskdefs.WaitFor +
    Constructor, names this task "waitfor". +
    WaitFor(String) - +Constructor for class org.apache.tools.ant.taskdefs.WaitFor +
    Constructor that takes the name of the task in the task name. +
    WaitFor.Unit - Class in org.apache.tools.ant.taskdefs
    The enumeration of units: + millisecond, second, minute, hour, day, week
    WaitFor.Unit() - +Constructor for class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    Constructor the Unit enumerated type. +
    waitForAck(InputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage +
    Reads the response, throws a BuildException if the response + indicates an error. +
    waitForEOF(Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient +
    Read from the rexec session until the EOF is found or + the timeout has been reached +
    waitForString(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient +
    Read from the rexec session until the string we are + waiting for is found +
    waitForString(String, Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient +
    Read from the rexec session until the string we are + waiting for is found or the timeout has been reached +
    waitForString(String) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient +
    Read from the telnet session until the string we are + waiting for is found +
    waitForString(String, Integer) - +Method in class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient +
    Read from the telnet session until the string we are + waiting for is found or the timeout has been reached +
    waitUntilFinished(long) - +Method in class org.apache.tools.ant.util.WorkerAnt +
    Block on the notify object and so wait until the thread is finished. +
    War - Class in org.apache.tools.ant.taskdefs
    An extension of <jar> to create a WAR archive.
    War() - +Constructor for class org.apache.tools.ant.taskdefs.War +
    Constructor for the War Task. +
    WARN - +Static variable in class org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint +
    warn if the extension-point is not defined +
    warn - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    WARN - +Static variable in class org.apache.tools.ant.taskdefs.Tar.TarLongFileMode +
    permissible values for longfile attribute +
    WARN - +Static variable in class org.apache.tools.ant.taskdefs.Tar +
    Deprecated. since 1.5.x. + Tar.WARN is deprecated and is replaced with + Tar.TarLongFileMode.WARN +
    WARN - +Static variable in class org.apache.tools.ant.types.FilterSet.OnMissing +
    Warn value +
    WARN - +Static variable in class org.apache.tools.ant.types.LogLevel +
    WARN loglevel constant. +
    WARN_OVERRIDING - +Static variable in class org.apache.tools.ant.taskdefs.optional.testing.Funtest +
    "Overriding previous definition of " +
    warning(TransformerException) - +Method in class org.apache.tools.ant.taskdefs.optional.TraXLiaison +
    Log a warning. +
    warning(SAXParseException) - +Method in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
    receive notification of a warning +
    warning(String) - +Method in class org.apache.tools.ant.util.TaskLogger +
    Log a message with MSG_WARN priority +
    WARNING_IGNORING_FORK - +Static variable in class org.apache.tools.ant.taskdefs.Apt +
    exposed for debug messages +
    warnings - +Variable in class org.apache.tools.ant.taskdefs.JikesOutputParser +
    Deprecated.   +
    WAS_BND - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
      +
    WAS_CMP_MAP - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
      +
    WAS_CMP_SCHEMA - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
      +
    WAS_EXT - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
      +
    Watchdog - Class in org.apache.tools.ant.util
    Generalization of ExecuteWatchdog
    Watchdog(long) - +Constructor for class org.apache.tools.ant.util.Watchdog +
    Constructor for Watchdog. +
    WeakishReference - Class in org.apache.tools.ant.util
    Deprecated. deprecated 1.7; will be removed in Ant1.8 + Just use WeakReference directly.
    WeakishReference.HardReference - Class in org.apache.tools.ant.util
    Deprecated. since 1.7. + Hopefully nobody is using this.
    WeakishReference.HardReference(Object) - +Constructor for class org.apache.tools.ant.util.WeakishReference.HardReference +
    Deprecated. constructor. +
    WeakishReference12 - Class in org.apache.tools.ant.util.optional
    Deprecated. since 1.7. + Just use WeakReference directly. + Note that in ant1.7 is parent was changed to extend HardReference. + This is because the latter has access to the (package scoped) + WeakishReference(Object) constructor, and both that and this are thin + facades on the underlying no-longer-abstract base class.
    WeakishReference12(Object) - +Constructor for class org.apache.tools.ant.util.optional.WeakishReference12 +
    Deprecated. create a new soft reference, which is bound to a + Weak reference inside +
    webApp - +Variable in class org.apache.tools.ant.taskdefs.optional.jsp.JspC +
    web apps +
    WeblogicDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    The weblogic element is used to control the weblogic.ejbc compiler for + generating weblogic EJB jars.
    WeblogicDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    WebLogicHotDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.j2ee
    An Ant wrapper task for the weblogic.deploy tool.
    WebLogicHotDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool +
      +
    WeblogicTOPLinkDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Deployment tool for Weblogic TOPLink.
    WeblogicTOPLinkDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool +
      +
    WebsphereDeploymentTool - Class in org.apache.tools.ant.taskdefs.optional.ejb
    Websphere deployment tool that augments the ejbjar task.
    WebsphereDeploymentTool() - +Constructor for class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
      +
    WEEK - +Static variable in class org.apache.tools.ant.taskdefs.WaitFor.Unit +
    week string +
    WHEN_KEY - +Static variable in class org.apache.tools.ant.types.selectors.DateSelector +
    Key to used for parameterized custom selector +
    WHEN_KEY - +Static variable in class org.apache.tools.ant.types.selectors.SizeSelector +
    Used for parameterized custom selector +
    WhichResource - Class in org.apache.tools.ant.taskdefs
    Find a class or resource on the supplied classpath, or the + system classpath if none is supplied.
    WhichResource() - +Constructor for class org.apache.tools.ant.taskdefs.WhichResource +
      +
    WHITESPACE_KEY - +Static variable in class org.apache.tools.ant.types.selectors.ContainsSelector +
    Used for parameterized custom selector +
    width - +Variable in class org.apache.tools.ant.types.optional.image.Arc +
      +
    width - +Variable in class org.apache.tools.ant.types.optional.image.Ellipse +
      +
    width - +Variable in class org.apache.tools.ant.types.optional.image.Rectangle +
      +
    withoutLastToken() - +Method in class org.apache.tools.ant.types.selectors.TokenizedPattern +
    Returns a new pattern without the last token of this pattern. +
    WL_CMP_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    WL_DD - +Static variable in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
      +
    WL_RMI_SKEL_SUFFIX - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    The skeleton suffix +
    WL_RMI_STUB_SUFFIX - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    The stub suffix +
    WLJspc - Class in org.apache.tools.ant.taskdefs.optional.jsp
    Precompiles JSP's using WebLogic's JSP compiler (weblogic.jspc).
    WLJspc() - +Constructor for class org.apache.tools.ant.taskdefs.optional.jsp.WLJspc +
      +
    WLRmic - Class in org.apache.tools.ant.taskdefs.rmic
    The implementation of the rmic for WebLogic
    WLRmic() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.WLRmic +
      +
    WLRMIC_CLASSNAME - +Static variable in class org.apache.tools.ant.taskdefs.rmic.WLRmic +
    The classname of the weblogic rmic +
    WORK_FACTOR - +Static variable in class org.apache.tools.bzip2.CBZip2OutputStream +
    This constant is accessible by subclasses for historical + purposes. +
    WorkerAnt - Class in org.apache.tools.ant.util
    A worker ant executes a single task in a background thread.
    WorkerAnt(Task, Object) - +Constructor for class org.apache.tools.ant.util.WorkerAnt +
    Create the worker. +
    WorkerAnt(Task) - +Constructor for class org.apache.tools.ant.util.WorkerAnt +
    Create the worker, using the worker as the notification point. +
    wrapper - +Variable in class org.apache.tools.ant.Task +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the Task.getWrapper() method. +
    wrapStream(InputStream) - +Method in class org.apache.tools.ant.types.resources.BZip2Resource +
    Decompress on the fly using CBZip2InputStream. +
    wrapStream(OutputStream) - +Method in class org.apache.tools.ant.types.resources.BZip2Resource +
    Compress on the fly using CBZip2OutputStream. +
    wrapStream(InputStream) - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Get a content-filtering/transforming InputStream. +
    wrapStream(OutputStream) - +Method in class org.apache.tools.ant.types.resources.ContentTransformingResource +
    Get a content-filtering/transforming OutputStream. +
    wrapStream(InputStream) - +Method in class org.apache.tools.ant.types.resources.GZipResource +
    Decompress on the fly using java.util.zip.GZIPInputStream. +
    wrapStream(OutputStream) - +Method in class org.apache.tools.ant.types.resources.GZipResource +
    Compress on the fly using java.util.zip.GZIPOutStream. +
    wrapSystemErr() - +Static method in class org.apache.tools.ant.util.KeepAliveOutputStream +
    Convenience factory method that returns a non-closing + PrintStream around System.err. +
    wrapSystemIn() - +Static method in class org.apache.tools.ant.util.KeepAliveInputStream +
    Convenience factory method that returns a non-closing + InputStream around System.in. +
    wrapSystemOut() - +Static method in class org.apache.tools.ant.util.KeepAliveOutputStream +
    Convenience factory method that returns a non-closing + PrintStream around System.out. +
    WRITABLE_FAIL - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for failing on writable files +
    WRITABLE_REPLACE - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for replacing writable files +
    WRITABLE_SKIP - +Static variable in interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants +
    The text for skiping writable files +
    WritableSelector - Class in org.apache.tools.ant.types.selectors
    A selector that selects writable files.
    WritableSelector() - +Constructor for class org.apache.tools.ant.types.selectors.WritableSelector +
      +
    write(int) - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Writes the data to the buffer and flushes the buffer if a line + separator is detected or if the buffer has reached its maximum size. +
    write(byte[], int, int) - +Method in class org.apache.tools.ant.DemuxOutputStream +
    Write a block of characters to the output stream +
    write(PrintWriter) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Write the attribute out to a print writer without + flattening multi-values attributes (i.e. +
    write(PrintWriter, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Attribute +
    Write the attribute out to a print writer. +
    write(PrintWriter) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Write the section out to a print writer without flattening + multi-values attributes (i.e. +
    write(PrintWriter, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest.Section +
    Write the section out to a print writer. +
    write(PrintWriter) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Write the manifest out to a print writer without flattening + multi-values attributes (i.e. +
    write(PrintWriter, boolean) - +Method in class org.apache.tools.ant.taskdefs.Manifest +
    Write the manifest out to a print writer. +
    write(int) - +Method in class org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream +
    Write the data to the buffer and flush the buffer, if a line + separator is detected. +
    write(int) - +Method in class org.apache.tools.ant.taskdefs.TaskOutputStream +
    Deprecated. Write a character to the output stream. +
    write(Element, OutputStream) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes a DOM tree to a stream in UTF8 encoding. +
    write(Element, Writer, int, String) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes a DOM tree to a stream. +
    write(byte[]) - +Method in class org.apache.tools.ant.util.LazyFileOutputStream +
    Delegates to the three-arg version. +
    write(byte[], int, int) - +Method in class org.apache.tools.ant.util.LazyFileOutputStream +
    Write part of a byte array. +
    write(int) - +Method in class org.apache.tools.ant.util.LazyFileOutputStream +
    Write a byte. +
    write(int) - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Write the data to the buffer and flush the buffer, if a line + separator is detected. +
    write(byte[], int, int) - +Method in class org.apache.tools.ant.util.LineOrientedOutputStream +
    Write a block of characters to the output stream +
    write(byte[]) - +Method in class org.apache.tools.ant.util.TeeOutputStream +
    Write a byte array to both output streams. +
    write(byte[], int, int) - +Method in class org.apache.tools.ant.util.TeeOutputStream +
    Write a byte array to both output streams. +
    write(int) - +Method in class org.apache.tools.ant.util.TeeOutputStream +
    Write a byte to both output streams. +
    write(int) - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
      +
    write(byte[], int, int) - +Method in class org.apache.tools.bzip2.CBZip2OutputStream +
      +
    write(int) - +Method in class org.apache.tools.tar.TarOutputStream +
    Writes a byte to the current tar archive entry. +
    write(byte[]) - +Method in class org.apache.tools.tar.TarOutputStream +
    Writes bytes to the current tar archive entry. +
    write(byte[], int, int) - +Method in class org.apache.tools.tar.TarOutputStream +
    Writes bytes to the current tar archive entry. +
    write(byte[], int, int) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes bytes to ZIP entry. +
    write(int) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes a single byte to ZIP entry. +
    writeCentralDirectoryEnd() - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes the "End of central dir record". +
    writeCentralFileHeader(ZipEntry) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes the central file header entry. +
    writeDataDescriptor(ZipEntry) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes the data descriptor entry. +
    writeDOMTree(Document, File) - +Method in class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
    Write the DOM tree to a file. +
    writeEntryHeader(byte[]) - +Method in class org.apache.tools.tar.TarEntry +
    Write an entry's header information to a header buffer. +
    writeIndexLikeList(List, List, PrintWriter) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Writes the directory entries from the first and the filenames + from the second list to the given writer, one entry per line. +
    writeJar(String, File, Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool +
    Method used to encapsulate the writing of the JAR file. +
    writeJar(String, File, Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool +
    Method used to encapsulate the writing of the JAR file. +
    writeJar(String, File, Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool +
    Method used to encapsulate the writing of the JAR file.. +
    writeJar(String, File, Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool +
    Method used to encapsulate the writing of the JAR file. +
    writeJar(String, File, Hashtable, String) - +Method in class org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool +
    Method used to encapsulate the writing of the JAR file.. +
    writeLocalFileHeader(ZipEntry) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Writes the local file header entry +
    writeOut(byte[]) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Write bytes to output or random access file. +
    writeOut(byte[], int, int) - +Method in class org.apache.tools.zip.ZipOutputStream +
    Write bytes to output or random access file. +
    writeRecord(byte[]) - +Method in class org.apache.tools.tar.TarBuffer +
    Write an archive record to the archive. +
    writeRecord(byte[], int) - +Method in class org.apache.tools.tar.TarBuffer +
    Write an archive record to the archive, where the record may be + inside of a larger array buffer. +
    writeXMLDeclaration(Writer) - +Method in class org.apache.tools.ant.util.DOMElementWriter +
    Writes the XML declaration if xmlDeclaration is true. +
    +
    +

    +X

    +
    +
    Xalan2TraceSupport - Class in org.apache.tools.ant.taskdefs.optional
    Sets up trace support for a given transformer.
    Xalan2TraceSupport() - +Constructor for class org.apache.tools.ant.taskdefs.optional.Xalan2TraceSupport +
      +
    xloc - +Variable in class org.apache.tools.ant.types.optional.image.Draw +
      +
    XML - +Static variable in class org.apache.tools.ant.taskdefs.Definer.Format +
    Enumerated values +
    XML_FORMATTER_CLASS_NAME - +Static variable in class org.apache.tools.ant.taskdefs.optional.junit.FormatterElement +
    xml formatter class +
    XMLCatalog - Class in org.apache.tools.ant.types
    This data type provides a catalog of resource locations (such as + DTDs and XML entities), based on the + OASIS "Open Catalog" standard.
    XMLCatalog() - +Constructor for class org.apache.tools.ant.types.XMLCatalog +
    Default constructor +
    XMLConstants - Interface in org.apache.tools.ant.taskdefs.optional.junit
    Interface groups XML constants.
    XmlConstants - Class in org.apache.tools.ant.util
    XML Parser constants, all kept in one place for ease of reuse
    XmlConstants() - +Constructor for class org.apache.tools.ant.util.XmlConstants +
      +
    XMLFragment - Class in org.apache.tools.ant.util
    Use this class as a nested element if you want to get a literal DOM + fragment of something nested into your task/type.
    XMLFragment() - +Constructor for class org.apache.tools.ant.util.XMLFragment +
    Constructor for XMLFragment object. +
    XMLFragment.Child - Class in org.apache.tools.ant.util
    An object to handle (recursively) nested elements.
    XMLJUnitResultFormatter - Class in org.apache.tools.ant.taskdefs.optional.junit
    Prints XML output of the test to a specified Writer.
    XMLJUnitResultFormatter() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter +
    No arg constructor. +
    XmlLogger - Class in org.apache.tools.ant
    Generates a file in the current directory with + an XML description of what happened during a build.
    XmlLogger() - +Constructor for class org.apache.tools.ant.XmlLogger +
    Constructs a new BuildListener that logs build events to an XML file. +
    XmlProperty - Class in org.apache.tools.ant.taskdefs
    Loads property values from a valid XML file, generating the + property names from the file's element and attribute names.
    XmlProperty() - +Constructor for class org.apache.tools.ant.taskdefs.XmlProperty +
    Constructor. +
    xmlReader - +Variable in class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
    the parser is viewed as a SAX2 XMLReader. +
    XMLResultAggregator - Class in org.apache.tools.ant.taskdefs.optional.junit
    Aggregates all <junit> XML formatter testsuite data under + a specific directory and transforms the results via XSLT.
    XMLResultAggregator() - +Constructor for class org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator +
      +
    xmlSaveProperties(Properties, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.optional.EchoProperties +
    Output the properties as xml output. +
    XMLValidateTask - Class in org.apache.tools.ant.taskdefs.optional
    Checks XML files are valid (or only well formed).
    XMLValidateTask() - +Constructor for class org.apache.tools.ant.taskdefs.optional.XMLValidateTask +
      +
    XMLValidateTask.Attribute - Class in org.apache.tools.ant.taskdefs.optional
    The class to create to set a feature of the parser.
    XMLValidateTask.Attribute() - +Constructor for class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute +
      +
    XMLValidateTask.Property - Class in org.apache.tools.ant.taskdefs.optional
    A Parser property.
    XMLValidateTask.Property() - +Constructor for class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property +
      +
    XMLValidateTask.ValidatorErrorHandler - Class in org.apache.tools.ant.taskdefs.optional
    ValidatorErrorHandler role : + + log SAX parse exceptions, + remember if an error occurred +
    XMLValidateTask.ValidatorErrorHandler() - +Constructor for class org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler +
      +
    XNewRmic - Class in org.apache.tools.ant.taskdefs.rmic
    Run rmic in a new process with -Xnew set.
    XNewRmic() - +Constructor for class org.apache.tools.ant.taskdefs.rmic.XNewRmic +
    No-arg constructor. +
    Xor - Class in org.apache.tools.ant.taskdefs.condition
    The Xor condition type to exclusive or operations.
    Xor() - +Constructor for class org.apache.tools.ant.taskdefs.condition.Xor +
      +
    XsetIgnore(String) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    List of filenames and directory names to not include. +
    XsetItems(String) - +Method in class org.apache.tools.ant.taskdefs.MatchingTask +
    Set this to be the items in the base directory that you want to be + included. +
    XSLTLiaison - Interface in org.apache.tools.ant.taskdefs
    Proxy interface for XSLT processors.
    XSLTLiaison2 - Interface in org.apache.tools.ant.taskdefs
    Extended Proxy interface for XSLT processors.
    XSLTLiaison3 - Interface in org.apache.tools.ant.taskdefs
    Extends Proxy interface for XSLT processors.
    XSLTLogger - Interface in org.apache.tools.ant.taskdefs
    Interface to log messages for XSLT
    XSLTLoggerAware - Interface in org.apache.tools.ant.taskdefs
    Interface for a class that one can set an XSLTLogger on.
    XSLTProcess - Class in org.apache.tools.ant.taskdefs
    Processes a set of XML documents via XSLT.
    XSLTProcess() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess +
    Creates a new XSLTProcess Task. +
    XSLTProcess.Factory - Class in org.apache.tools.ant.taskdefs
    The factory element to configure a transformer factory
    XSLTProcess.Factory() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess.Factory +
      +
    XSLTProcess.Factory.Attribute - Class in org.apache.tools.ant.taskdefs
    A JAXP factory attribute.
    XSLTProcess.Factory.Attribute() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute +
      +
    XSLTProcess.OutputProperty - Class in org.apache.tools.ant.taskdefs
    Specify how the result tree should be output as specified + in the + specification.
    XSLTProcess.OutputProperty() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty +
      +
    XSLTProcess.Param - Class in org.apache.tools.ant.taskdefs
    The Param inner class used to store XSL parameters
    XSLTProcess.Param() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess.Param +
      +
    XSLTProcess.TraceConfiguration - Class in org.apache.tools.ant.taskdefs
    Configuration for Xalan2 traces.
    XSLTProcess.TraceConfiguration() - +Constructor for class org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration +
      +
    XSLTTraceSupport - Interface in org.apache.tools.ant.taskdefs.optional
    Sets up trace support for a given transformer.
    +
    +

    +Y

    +
    +
    yloc - +Variable in class org.apache.tools.ant.types.optional.image.Draw +
      +
    +
    +

    +Z

    +
    +
    Zip - Class in org.apache.tools.ant.taskdefs
    Create a Zip file.
    Zip() - +Constructor for class org.apache.tools.ant.taskdefs.Zip +
      +
    Zip.ArchiveState - Class in org.apache.tools.ant.taskdefs
    Holds the up-to-date status and the out-of-date resources of + the original archive.
    Zip.Duplicate - Class in org.apache.tools.ant.taskdefs
    Possible behaviors when a duplicate file is added: + "add", "preserve" or "fail"
    Zip.Duplicate() - +Constructor for class org.apache.tools.ant.taskdefs.Zip.Duplicate +
      +
    Zip.UnicodeExtraField - Class in org.apache.tools.ant.taskdefs
    Policiy for creation of Unicode extra fields: never, always or + not-encodeable.
    Zip.UnicodeExtraField() - +Constructor for class org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField +
      +
    Zip.WhenEmpty - Class in org.apache.tools.ant.taskdefs
    Possible behaviors when there are no matching files for the task: + "fail", "skip", or "create".
    Zip.WhenEmpty() - +Constructor for class org.apache.tools.ant.taskdefs.Zip.WhenEmpty +
      +
    zipDir(File, ZipOutputStream, String, int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add a directory to the zip stream. +
    zipDir(File, ZipOutputStream, String, int, ZipExtraField[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add a directory to the zip stream. +
    zipDir(Resource, ZipOutputStream, String, int, ZipExtraField[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Add a directory to the zip stream. +
    ZipEntry - Class in org.apache.tools.zip
    Extension that adds better handling of extra fields and provides + access to the internal and external file attributes.
    ZipEntry(String) - +Constructor for class org.apache.tools.zip.ZipEntry +
    Creates a new zip entry with the specified name. +
    ZipEntry(ZipEntry) - +Constructor for class org.apache.tools.zip.ZipEntry +
    Creates a new zip entry with fields taken from the specified zip entry. +
    ZipEntry(ZipEntry) - +Constructor for class org.apache.tools.zip.ZipEntry +
    Creates a new zip entry with fields taken from the specified zip entry. +
    ZipEntry() - +Constructor for class org.apache.tools.zip.ZipEntry +
      +
    ZipExtraField - Interface in org.apache.tools.zip
    General format of extra field data.
    zipFile(File, ZipOutputStream, String, int) - +Method in class org.apache.tools.ant.taskdefs.Ear +
    Overridden from Zip class to deal with application.xml +
    zipFile(InputStream, ZipOutputStream, String, long, File, int) - +Method in class org.apache.tools.ant.taskdefs.Jar +
    Overridden from Zip class to deal with manifests and index lists. +
    zipFile - +Variable in class org.apache.tools.ant.taskdefs.Pack +
      +
    zipFile(File, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    zip a file to an output stream +
    zipFile(File, ZipOutputStream, String, int) - +Method in class org.apache.tools.ant.taskdefs.War +
    Overridden from Zip class to deal with web.xml + + Here are cases that can arise + -not a web.xml file : add + -first web.xml : add, remember we added it + -same web.xml again: skip + -alternate web.xml : warn and skip +
    zipFile - +Variable in class org.apache.tools.ant.taskdefs.Zip +
      +
    zipFile(InputStream, ZipOutputStream, String, long, File, int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Adds a new entry to the archive, takes care of duplicates as well. +
    zipFile(InputStream, ZipOutputStream, String, long, File, int, ZipExtraField[]) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Adds a new entry to the archive, takes care of duplicates as well. +
    zipFile(File, ZipOutputStream, String, int) - +Method in class org.apache.tools.ant.taskdefs.Zip +
    Method that gets called when adding from java.io.File instances. +
    ZipFile - Class in org.apache.tools.zip
    Replacement for java.util.ZipFile.
    ZipFile(File) - +Constructor for class org.apache.tools.zip.ZipFile +
    Opens the given file for reading, assuming the platform's + native encoding for file names. +
    ZipFile(String) - +Constructor for class org.apache.tools.zip.ZipFile +
    Opens the given file for reading, assuming the platform's + native encoding for file names. +
    ZipFile(String, String) - +Constructor for class org.apache.tools.zip.ZipFile +
    Opens the given file for reading, assuming the specified + encoding for file names, scanning unicode extra fields. +
    ZipFile(File, String) - +Constructor for class org.apache.tools.zip.ZipFile +
    Opens the given file for reading, assuming the specified + encoding for file names and scanning for unicode extra fields. +
    ZipFile(File, String, boolean) - +Constructor for class org.apache.tools.zip.ZipFile +
    Opens the given file for reading, assuming the specified + encoding for file names. +
    ZipFileSet - Class in org.apache.tools.ant.types
    A ZipFileSet is a FileSet with extra attributes useful in the context of + Zip/Jar tasks.
    ZipFileSet() - +Constructor for class org.apache.tools.ant.types.ZipFileSet +
    Constructor for ZipFileSet +
    ZipFileSet(FileSet) - +Constructor for class org.apache.tools.ant.types.ZipFileSet +
    Constructor using a fileset arguement. +
    ZipFileSet(ZipFileSet) - +Constructor for class org.apache.tools.ant.types.ZipFileSet +
    Constructor using a zipfileset arguement. +
    ZipLong - Class in org.apache.tools.zip
    Utility class that represents a four byte integer with conversion + rules for the big endian byte order of ZIP files.
    ZipLong(long) - +Constructor for class org.apache.tools.zip.ZipLong +
    Create instance from a number. +
    ZipLong(byte[]) - +Constructor for class org.apache.tools.zip.ZipLong +
    Create instance from bytes. +
    ZipLong(byte[], int) - +Constructor for class org.apache.tools.zip.ZipLong +
    Create instance from the four bytes starting at offset. +
    ZipOutputStream - Class in org.apache.tools.zip
    Reimplementation of java.util.zip.ZipOutputStream that does handle the extended + functionality of this package, especially internal/external file + attributes and extra fields with different layouts for local file + data and central directory entries.
    ZipOutputStream(OutputStream) - +Constructor for class org.apache.tools.zip.ZipOutputStream +
    Creates a new ZIP OutputStream filtering the underlying stream. +
    ZipOutputStream(File) - +Constructor for class org.apache.tools.zip.ZipOutputStream +
    Creates a new ZIP OutputStream writing to a File. +
    ZipOutputStream.UnicodeExtraFieldPolicy - Class in org.apache.tools.zip
    enum that represents the possible policies for creating Unicode + extra fields.
    zipResource(Resource, OutputStream) - +Method in class org.apache.tools.ant.taskdefs.Pack +
    zip a resource to an output stream +
    ZipResource - Class in org.apache.tools.ant.types.resources
    A Resource representation of an entry in a zipfile.
    ZipResource() - +Constructor for class org.apache.tools.ant.types.resources.ZipResource +
    Default constructor. +
    ZipResource(File, String, ZipEntry) - +Constructor for class org.apache.tools.ant.types.resources.ZipResource +
    Construct a ZipResource representing the specified + entry in the specified zipfile. +
    ZipScanner - Class in org.apache.tools.ant.types
    Scans zip archives for resources.
    ZipScanner() - +Constructor for class org.apache.tools.ant.types.ZipScanner +
      +
    ZipShort - Class in org.apache.tools.zip
    Utility class that represents a two byte integer with conversion + rules for the big endian byte order of ZIP files.
    ZipShort(int) - +Constructor for class org.apache.tools.zip.ZipShort +
    Create instance from a number. +
    ZipShort(byte[]) - +Constructor for class org.apache.tools.zip.ZipShort +
    Create instance from bytes. +
    ZipShort(byte[], int) - +Constructor for class org.apache.tools.zip.ZipShort +
    Create instance from the two bytes starting at offset. +
    ZipUtil - Class in org.apache.tools.zip
    Utility class for handling DOS and Java time conversions.
    ZipUtil() - +Constructor for class org.apache.tools.zip.ZipUtil +
      +
    +
    +A B C D E F G H I J K L M N O P Q R S T U V W X Y Z + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/index.html b/tools/apache-ant-1.8.2/docs/manual/api/index.html new file mode 100644 index 000000000..ef252878f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/index.html @@ -0,0 +1,39 @@ + + + + + + +Apache Ant API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntClassLoader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntClassLoader.html new file mode 100644 index 000000000..38a33aed8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntClassLoader.html @@ -0,0 +1,1620 @@ + + + + + + +AntClassLoader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class AntClassLoader

    +
    +java.lang.Object
+  extended by java.lang.ClassLoader
+      extended by org.apache.tools.ant.AntClassLoader
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, SubBuildListener
    +
    +
    +
    Direct Known Subclasses:
    AntClassLoader2, AntClassLoader5, SplitClassLoader
    +
    +
    +
    +
    public class AntClassLoader
    extends java.lang.ClassLoader
    implements SubBuildListener
    + + +

    +Used to load classes within ant with a different classpath from + that used to start ant. Note that it is possible to force a class + into this loader even when that class is on the system classpath by + using the forceLoadClass method. Any subsequent classes loaded by that + class will then use this loader rather than the system class loader. + +

    + Note that this classloader has a feature to allow loading + in reverse order and for "isolation". + Due to the fact that a number of + methods in java.lang.ClassLoader are final (at least + in java 1.4 getResources) this means that the + class has to fake the given parent. +

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    AntClassLoader() + +
    +          Create an Ant Class Loader
    AntClassLoader(java.lang.ClassLoader parent, + boolean parentFirst) + +
    +          Creates an empty class loader.
    AntClassLoader(java.lang.ClassLoader parent, + Project project, + Path classpath) + +
    +          Create an Ant ClassLoader for a given project, with + a parent classloader and an initial classpath.
    AntClassLoader(java.lang.ClassLoader parent, + Project project, + Path classpath, + boolean parentFirst) + +
    +          Creates a classloader for the given project using the classpath given.
    AntClassLoader(Project project, + Path classpath) + +
    +          Creates a classloader for the given project using the classpath given.
    AntClassLoader(Project project, + Path classpath, + boolean parentFirst) + +
    +          Creates a classloader for the given project using the classpath given.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddJavaLibraries() + +
    +          add any libraries that come with different java versions + here
    + voidaddLoaderPackageRoot(java.lang.String packageRoot) + +
    +          Adds a package root to the list of packages which must be loaded using + this loader.
    + voidaddPathComponent(java.io.File file) + +
    +          Add a path component.
    + voidaddPathElement(java.lang.String pathElement) + +
    +          Adds an element to the classpath to be searched.
    +protected  voidaddPathFile(java.io.File pathComponent) + +
    +          Add a file to the path.
    + voidaddSystemPackageRoot(java.lang.String packageRoot) + +
    +          Adds a package root to the list of packages which must be loaded on the + parent loader.
    + voidbuildFinished(BuildEvent event) + +
    +          Cleans up any resources held by this classloader at the end + of a build.
    + voidbuildStarted(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidcleanup() + +
    +          Cleans up any resources held by this classloader.
    +protected  java.lang.ClassdefineClassFromData(java.io.File container, + byte[] classData, + java.lang.String classname) + +
    +          Define a class given its bytes
    +protected  voiddefinePackage(java.io.File container, + java.lang.String className) + +
    +          Define the package information associated with a class.
    +protected  voiddefinePackage(java.io.File container, + java.lang.String packageName, + java.util.jar.Manifest manifest) + +
    +          Define the package information when the class comes from a + jar with a manifest
    + java.lang.ClassfindClass(java.lang.String name) + +
    +          Searches for and load a class on the classpath of this class loader.
    +protected  java.util.EnumerationfindResources(java.lang.String name) + +
    +          Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath.
    +protected  java.util.EnumerationfindResources(java.lang.String name, + boolean parentHasBeenSearched) + +
    +          Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath.
    + java.lang.ClassforceLoadClass(java.lang.String classname) + +
    +          Loads a class through this class loader even if that class is available + on the parent classpath.
    + java.lang.ClassforceLoadSystemClass(java.lang.String classname) + +
    +          Loads a class through this class loader but defer to the parent class + loader.
    + java.lang.StringgetClasspath() + +
    +          Returns the classpath this classloader will consult.
    + java.lang.ClassLoadergetConfiguredParent() + +
    +          Gets the parent as has been specified in the constructor or via + setParent.
    + java.util.EnumerationgetNamedResources(java.lang.String name) + +
    +          Finds all the resources with the given name.
    + java.net.URLgetResource(java.lang.String name) + +
    +          Finds the resource with the given name.
    + java.io.InputStreamgetResourceAsStream(java.lang.String name) + +
    +          Returns a stream to read the requested resource name.
    +protected  java.net.URLgetResourceURL(java.io.File file, + java.lang.String resourceName) + +
    +          Returns the URL of a given resource in the given file which may + either be a directory or a zip file.
    +static voidinitializeClass(java.lang.Class theClass) + +
    +          Deprecated. since 1.6.x. + Use Class.forName with initialize=true instead.
    +protected  booleanisInPath(java.io.File component) + +
    +          Indicate if the given file is in this loader's path
    +protected  java.lang.ClassloadClass(java.lang.String classname, + boolean resolve) + +
    +          Loads a class with this class loader.
    +protected  voidlog(java.lang.String message, + int priority) + +
    +          Logs a message through the project object if one has been provided.
    + voidmessageLogged(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    +static AntClassLoadernewAntClassLoader(java.lang.ClassLoader parent, + Project project, + Path path, + boolean parentFirst) + +
    +          Factory method
    + voidresetThreadContextLoader() + +
    +          Resets the current thread's context loader to its original value.
    + voidsetClassPath(Path classpath) + +
    +          Set the classpath to search for classes to load.
    + voidsetIsolated(boolean isolated) + +
    +          Sets whether this classloader should run in isolated mode.
    + voidsetParent(java.lang.ClassLoader parent) + +
    +          Set the parent for this class loader.
    + voidsetParentFirst(boolean parentFirst) + +
    +          Control whether class lookup is delegated to the parent loader first + or after this loader.
    + voidsetProject(Project project) + +
    +          Set the project associated with this class loader
    + voidsetThreadContextLoader() + +
    +          Sets the current thread's context loader to this classloader, storing + the current loader value for later resetting.
    + voidsubBuildFinished(BuildEvent event) + +
    +          Cleans up any resources held by this classloader at the end of + a subbuild if it has been created for the subbuild's project + instance.
    + voidsubBuildStarted(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidtargetFinished(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidtargetStarted(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidtaskFinished(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidtaskStarted(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + java.lang.StringtoString() + +
    +          Returns a String representing this loader.
    +  + + + + + + + +
    Methods inherited from class java.lang.ClassLoader
    clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findResource, findSystemClass, getPackage, getPackages, getParent, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntClassLoader

    +
    +public AntClassLoader(java.lang.ClassLoader parent,
+                      Project project,
+                      Path classpath)
    +
    +
    Create an Ant ClassLoader for a given project, with + a parent classloader and an initial classpath. +

    +

    +
    Parameters:
    parent - the parent for this classloader.
    project - The project to which this classloader is to + belong.
    classpath - The classpath to use to load classes.
    Since:
    +
    Ant 1.7.
    +
    +
    +
    + +

    +AntClassLoader

    +
    +public AntClassLoader()
    +
    +
    Create an Ant Class Loader +

    +

    +
    + +

    +AntClassLoader

    +
    +public AntClassLoader(Project project,
+                      Path classpath)
    +
    +
    Creates a classloader for the given project using the classpath given. +

    +

    +
    Parameters:
    project - The project to which this classloader is to belong. + Must not be null.
    classpath - The classpath to use to load the classes. This + is combined with the system classpath in a manner + determined by the value of ${build.sysclasspath}. + May be null, in which case no path + elements are set up to start with.
    +
    +
    + +

    +AntClassLoader

    +
    +public AntClassLoader(java.lang.ClassLoader parent,
+                      Project project,
+                      Path classpath,
+                      boolean parentFirst)
    +
    +
    Creates a classloader for the given project using the classpath given. +

    +

    +
    Parameters:
    parent - The parent classloader to which unsatisfied loading + attempts are delegated. May be null, + in which case the classloader which loaded this + class is used as the parent.
    project - The project to which this classloader is to belong. + Must not be null.
    classpath - the classpath to use to load the classes. + May be null, in which case no path + elements are set up to start with.
    parentFirst - If true, indicates that the parent + classloader should be consulted before trying to + load the a class through this loader.
    +
    +
    + +

    +AntClassLoader

    +
    +public AntClassLoader(Project project,
+                      Path classpath,
+                      boolean parentFirst)
    +
    +
    Creates a classloader for the given project using the classpath given. +

    +

    +
    Parameters:
    project - The project to which this classloader is to belong. + Must not be null.
    classpath - The classpath to use to load the classes. May be + null, in which case no path + elements are set up to start with.
    parentFirst - If true, indicates that the parent + classloader should be consulted before trying to + load the a class through this loader.
    +
    +
    + +

    +AntClassLoader

    +
    +public AntClassLoader(java.lang.ClassLoader parent,
+                      boolean parentFirst)
    +
    +
    Creates an empty class loader. The classloader should be configured + with path elements to specify where the loader is to look for + classes. +

    +

    +
    Parameters:
    parent - The parent classloader to which unsatisfied loading + attempts are delegated. May be null, + in which case the classloader which loaded this + class is used as the parent.
    parentFirst - If true, indicates that the parent + classloader should be consulted before trying to + load the a class through this loader.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set the project associated with this class loader +

    +

    +
    +
    +
    +
    Parameters:
    project - the project instance
    +
    +
    +
    + +

    +setClassPath

    +
    +public void setClassPath(Path classpath)
    +
    +
    Set the classpath to search for classes to load. This should not be + changed once the classloader starts to server classes +

    +

    +
    +
    +
    +
    Parameters:
    classpath - the search classpath consisting of directories and + jar/zip files.
    +
    +
    +
    + +

    +setParent

    +
    +public void setParent(java.lang.ClassLoader parent)
    +
    +
    Set the parent for this class loader. This is the class loader to which + this class loader will delegate to load classes +

    +

    +
    +
    +
    +
    Parameters:
    parent - the parent class loader.
    +
    +
    +
    + +

    +setParentFirst

    +
    +public void setParentFirst(boolean parentFirst)
    +
    +
    Control whether class lookup is delegated to the parent loader first + or after this loader. Use with extreme caution. Setting this to + false violates the class loader hierarchy and can lead to Linkage errors +

    +

    +
    +
    +
    +
    Parameters:
    parentFirst - if true, delegate initial class search to the parent + classloader.
    +
    +
    +
    + +

    +log

    +
    +protected void log(java.lang.String message,
+                   int priority)
    +
    +
    Logs a message through the project object if one has been provided. +

    +

    +
    +
    +
    +
    Parameters:
    message - The message to log. + Should not be null.
    priority - The logging priority of the message.
    +
    +
    +
    + +

    +setThreadContextLoader

    +
    +public void setThreadContextLoader()
    +
    +
    Sets the current thread's context loader to this classloader, storing + the current loader value for later resetting. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +resetThreadContextLoader

    +
    +public void resetThreadContextLoader()
    +
    +
    Resets the current thread's context loader to its original value. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +addPathElement

    +
    +public void addPathElement(java.lang.String pathElement)
+                    throws BuildException
    +
    +
    Adds an element to the classpath to be searched. +

    +

    +
    +
    +
    +
    Parameters:
    pathElement - The path element to add. Must not be + null. +
    Throws: +
    BuildException - if the given path element cannot be resolved + against the project.
    +
    +
    +
    + +

    +addPathComponent

    +
    +public void addPathComponent(java.io.File file)
    +
    +
    Add a path component. + This simply adds the file, unlike addPathElement + it does not open jar files and load files from + their CLASSPATH entry in the manifest file. +

    +

    +
    +
    +
    +
    Parameters:
    file - the jar file or directory to add.
    +
    +
    +
    + +

    +addPathFile

    +
    +protected void addPathFile(java.io.File pathComponent)
+                    throws java.io.IOException
    +
    +
    Add a file to the path. + Reads the manifest, if available, and adds any additional class path jars + specified in the manifest. +

    +

    +
    +
    +
    +
    Parameters:
    pathComponent - the file which is to be added to the path for + this class loader +
    Throws: +
    java.io.IOException - if data needed from the file cannot be read.
    +
    +
    +
    + +

    +getClasspath

    +
    +public java.lang.String getClasspath()
    +
    +
    Returns the classpath this classloader will consult. +

    +

    +
    +
    +
    + +
    Returns:
    the classpath used for this classloader, with elements + separated by the path separator for the system.
    +
    +
    +
    + +

    +setIsolated

    +
    +public void setIsolated(boolean isolated)
    +
    +
    Sets whether this classloader should run in isolated mode. In + isolated mode, classes not found on the given classpath will + not be referred to the parent class loader but will cause a + ClassNotFoundException. +

    +

    +
    +
    +
    +
    Parameters:
    isolated - Whether or not this classloader should run in + isolated mode.
    +
    +
    +
    + +

    +initializeClass

    +
    +public static void initializeClass(java.lang.Class theClass)
    +
    +
    Deprecated. since 1.6.x. + Use Class.forName with initialize=true instead. +

    +

    Forces initialization of a class in a JDK 1.1 compatible, albeit hacky + way. +

    +

    +
    +
    +
    +
    Parameters:
    theClass - The class to initialize. + Must not be null.
    +
    +
    +
    + +

    +addSystemPackageRoot

    +
    +public void addSystemPackageRoot(java.lang.String packageRoot)
    +
    +
    Adds a package root to the list of packages which must be loaded on the + parent loader. + + All subpackages are also included. +

    +

    +
    +
    +
    +
    Parameters:
    packageRoot - The root of all packages to be included. + Should not be null.
    +
    +
    +
    + +

    +addLoaderPackageRoot

    +
    +public void addLoaderPackageRoot(java.lang.String packageRoot)
    +
    +
    Adds a package root to the list of packages which must be loaded using + this loader. + + All subpackages are also included. +

    +

    +
    +
    +
    +
    Parameters:
    packageRoot - The root of all packages to be included. + Should not be null.
    +
    +
    +
    + +

    +forceLoadClass

    +
    +public java.lang.Class forceLoadClass(java.lang.String classname)
+                               throws java.lang.ClassNotFoundException
    +
    +
    Loads a class through this class loader even if that class is available + on the parent classpath. + + This ensures that any classes which are loaded by the returned class + will use this classloader. +

    +

    +
    +
    +
    +
    Parameters:
    classname - The name of the class to be loaded. + Must not be null. +
    Returns:
    the required Class object +
    Throws: +
    java.lang.ClassNotFoundException - if the requested class does not exist + on this loader's classpath.
    +
    +
    +
    + +

    +forceLoadSystemClass

    +
    +public java.lang.Class forceLoadSystemClass(java.lang.String classname)
+                                     throws java.lang.ClassNotFoundException
    +
    +
    Loads a class through this class loader but defer to the parent class + loader. + + This ensures that instances of the returned class will be compatible + with instances which have already been loaded on the parent + loader. +

    +

    +
    +
    +
    +
    Parameters:
    classname - The name of the class to be loaded. + Must not be null. +
    Returns:
    the required Class object +
    Throws: +
    java.lang.ClassNotFoundException - if the requested class does not exist + on this loader's classpath.
    +
    +
    +
    + +

    +getResourceAsStream

    +
    +public java.io.InputStream getResourceAsStream(java.lang.String name)
    +
    +
    Returns a stream to read the requested resource name. +

    +

    +
    Overrides:
    getResourceAsStream in class java.lang.ClassLoader
    +
    +
    +
    Parameters:
    name - The name of the resource for which a stream is required. + Must not be null. +
    Returns:
    a stream to the required resource or null if the + resource cannot be found on the loader's classpath.
    +
    +
    +
    + +

    +getResource

    +
    +public java.net.URL getResource(java.lang.String name)
    +
    +
    Finds the resource with the given name. A resource is + some data (images, audio, text, etc) that can be accessed by class + code in a way that is independent of the location of the code. +

    +

    +
    Overrides:
    getResource in class java.lang.ClassLoader
    +
    +
    +
    Parameters:
    name - The name of the resource for which a stream is required. + Must not be null. +
    Returns:
    a URL for reading the resource, or null if the + resource could not be found or the caller doesn't have + adequate privileges to get the resource.
    +
    +
    +
    + +

    +getNamedResources

    +
    +public java.util.Enumeration getNamedResources(java.lang.String name)
+                                        throws java.io.IOException
    +
    +
    Finds all the resources with the given name. A resource is some + data (images, audio, text, etc) that can be accessed by class + code in a way that is independent of the location of the code. + +

    Would override getResources if that wasn't final in Java + 1.4.

    +

    +

    +
    +
    +
    + +
    Throws: +
    java.io.IOException
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +findResources

    +
    +protected java.util.Enumeration findResources(java.lang.String name)
+                                       throws java.io.IOException
    +
    +
    Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath. +

    +

    +
    Overrides:
    findResources in class java.lang.ClassLoader
    +
    +
    +
    Parameters:
    name - The resource name to search for. + Must not be null. +
    Returns:
    an enumeration of URLs for the resources +
    Throws: +
    java.io.IOException - if I/O errors occurs (can't happen)
    +
    +
    +
    + +

    +findResources

    +
    +protected java.util.Enumeration findResources(java.lang.String name,
+                                              boolean parentHasBeenSearched)
+                                       throws java.io.IOException
    +
    +
    Returns an enumeration of URLs representing all the resources with the + given name by searching the class loader's classpath. +

    +

    +
    +
    +
    +
    Parameters:
    name - The resource name to search for. + Must not be null.
    parentHasBeenSearched - whether ClassLoader.this.parent + has been searched - will be true if the method is (indirectly) + called from ClassLoader.getResources +
    Returns:
    an enumeration of URLs for the resources +
    Throws: +
    java.io.IOException - if I/O errors occurs (can't happen)
    +
    +
    +
    + +

    +getResourceURL

    +
    +protected java.net.URL getResourceURL(java.io.File file,
+                                      java.lang.String resourceName)
    +
    +
    Returns the URL of a given resource in the given file which may + either be a directory or a zip file. +

    +

    +
    +
    +
    +
    Parameters:
    file - The file (directory or jar) in which to search for + the resource. Must not be null.
    resourceName - The name of the resource for which a stream + is required. Must not be null. +
    Returns:
    a stream to the required resource or null if the + resource cannot be found in the given file object.
    +
    +
    +
    + +

    +loadClass

    +
    +protected java.lang.Class loadClass(java.lang.String classname,
+                                    boolean resolve)
+                             throws java.lang.ClassNotFoundException
    +
    +
    Loads a class with this class loader. + + This class attempts to load the class in an order determined by whether + or not the class matches the system/loader package lists, with the + loader package list taking priority. If the classloader is in isolated + mode, failure to load the class in this loader will result in a + ClassNotFoundException. +

    +

    +
    Overrides:
    loadClass in class java.lang.ClassLoader
    +
    +
    +
    Parameters:
    classname - The name of the class to be loaded. + Must not be null.
    resolve - true if all classes upon which this class + depends are to be loaded. +
    Returns:
    the required Class object +
    Throws: +
    java.lang.ClassNotFoundException - if the requested class does not exist + on the system classpath (when not in isolated mode) or this loader's + classpath.
    +
    +
    +
    + +

    +defineClassFromData

    +
    +protected java.lang.Class defineClassFromData(java.io.File container,
+                                              byte[] classData,
+                                              java.lang.String classname)
+                                       throws java.io.IOException
    +
    +
    Define a class given its bytes +

    +

    +
    +
    +
    +
    Parameters:
    container - the container from which the class data has been read + may be a directory or a jar/zip file.
    classData - the bytecode data for the class
    classname - the name of the class +
    Returns:
    the Class instance created from the given data +
    Throws: +
    java.io.IOException - if the class data cannot be read.
    +
    +
    +
    + +

    +definePackage

    +
    +protected void definePackage(java.io.File container,
+                             java.lang.String className)
+                      throws java.io.IOException
    +
    +
    Define the package information associated with a class. +

    +

    +
    +
    +
    +
    Parameters:
    container - the file containing the class definition.
    className - the class name of for which the package information + is to be determined. +
    Throws: +
    java.io.IOException - if the package information cannot be read from the + container.
    +
    +
    +
    + +

    +definePackage

    +
    +protected void definePackage(java.io.File container,
+                             java.lang.String packageName,
+                             java.util.jar.Manifest manifest)
    +
    +
    Define the package information when the class comes from a + jar with a manifest +

    +

    +
    +
    +
    +
    Parameters:
    container - the jar file containing the manifest
    packageName - the name of the package being defined.
    manifest - the jar's manifest
    +
    +
    +
    + +

    +findClass

    +
    +public java.lang.Class findClass(java.lang.String name)
+                          throws java.lang.ClassNotFoundException
    +
    +
    Searches for and load a class on the classpath of this class loader. +

    +

    +
    Overrides:
    findClass in class java.lang.ClassLoader
    +
    +
    +
    Parameters:
    name - The name of the class to be loaded. Must not be + null. +
    Returns:
    the required Class object +
    Throws: +
    java.lang.ClassNotFoundException - if the requested class does not exist + on this loader's classpath.
    +
    +
    +
    + +

    +isInPath

    +
    +protected boolean isInPath(java.io.File component)
    +
    +
    Indicate if the given file is in this loader's path +

    +

    +
    +
    +
    +
    Parameters:
    component - the file which is to be checked +
    Returns:
    true if the file is in the class path
    +
    +
    +
    + +

    +cleanup

    +
    +public void cleanup()
    +
    +
    Cleans up any resources held by this classloader. Any open archive + files are closed. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +getConfiguredParent

    +
    +public java.lang.ClassLoader getConfiguredParent()
    +
    +
    Gets the parent as has been specified in the constructor or via + setParent. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - the buildStarted event
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Cleans up any resources held by this classloader at the end + of a build. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - the buildFinished event
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +subBuildFinished

    +
    +public void subBuildFinished(BuildEvent event)
    +
    +
    Cleans up any resources held by this classloader at the end of + a subbuild if it has been created for the subbuild's project + instance. +

    +

    +
    Specified by:
    subBuildFinished in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - the buildFinished event
    Since:
    +
    Ant 1.6.2
    +
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +subBuildStarted

    +
    +public void subBuildStarted(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    subBuildStarted in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - the buildStarted event
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - the targetStarted event
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - the targetFinished event
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - the taskStarted event
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - the taskFinished event
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - the messageLogged event
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +addJavaLibraries

    +
    +public void addJavaLibraries()
    +
    +
    add any libraries that come with different java versions + here +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Returns a String representing this loader. +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    the path that this classloader has.
    +
    +
    +
    + +

    +newAntClassLoader

    +
    +public static AntClassLoader newAntClassLoader(java.lang.ClassLoader parent,
+                                               Project project,
+                                               Path path,
+                                               boolean parentFirst)
    +
    +
    Factory method +

    +

    +
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntTypeDefinition.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntTypeDefinition.html new file mode 100644 index 000000000..dd12d69c9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/AntTypeDefinition.html @@ -0,0 +1,696 @@ + + + + + + +AntTypeDefinition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class AntTypeDefinition

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.AntTypeDefinition
+
    +
    +
    Direct Known Subclasses:
    PreSetDef.PreSetDefinition
    +
    +
    +
    +
    public class AntTypeDefinition
    extends java.lang.Object
    + + +

    +This class contains all the information + on a particular ant type, + the classname, adaptor and the class + it should be assignable from. + This type replaces the task/datatype split + of pre ant 1.6. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AntTypeDefinition() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckClass(Project project) + +
    +          Checks if the attributes are correct.
    + java.lang.Objectcreate(Project project) + +
    +          Create an instance of the definition.
    + java.lang.ClassLoadergetClassLoader() + +
    +          Get the classloader for this definition.
    + java.lang.StringgetClassName() + +
    +          Get the classname of the definition.
    + java.lang.ClassgetExposedClass(Project project) + +
    +          Get the exposed class for this + definition.
    + java.lang.StringgetName() + +
    +          Return the definition's name.
    + java.lang.ClassgetTypeClass(Project project) + +
    +          Get the definition class.
    + java.lang.ObjectinnerCreateAndSet(java.lang.Class newclass, + Project project) + +
    +          Inner implementation of the createAndSet(Project, Class) logic, with no + exception catching
    + java.lang.ClassinnerGetTypeClass() + +
    +          Try and load a class, with no attempt to catch any fault.
    + booleanisRestrict() + +
    +          Get the restrict attribute.
    + booleansameDefinition(AntTypeDefinition other, + Project project) + +
    +          Equality method for this definition (assumes the names are the same).
    + voidsetAdapterClass(java.lang.Class adapterClass) + +
    +          Set the adapter class for this definition.
    + voidsetAdaptToClass(java.lang.Class adaptToClass) + +
    +          Set the assignable class for this definition.
    + voidsetClass(java.lang.Class clazz) + +
    +          Set the class of the definition.
    + voidsetClassLoader(java.lang.ClassLoader classLoader) + +
    +          Set the classloader to use to create an instance + of the definition.
    + voidsetClassName(java.lang.String className) + +
    +          Set the classname of the definition.
    + voidsetName(java.lang.String name) + +
    +          Set the definition's name.
    + voidsetRestrict(boolean restrict) + +
    +          Set the restrict attribute.
    + booleansimilarDefinition(AntTypeDefinition other, + Project project) + +
    +          Similar definition; + used to compare two definitions defined twice with the same + name and the same types.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntTypeDefinition

    +
    +public AntTypeDefinition()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setRestrict

    +
    +public void setRestrict(boolean restrict)
    +
    +
    Set the restrict attribute. +

    +

    +
    Parameters:
    restrict - the value to set.
    +
    +
    +
    + +

    +isRestrict

    +
    +public boolean isRestrict()
    +
    +
    Get the restrict attribute. +

    +

    + +
    Returns:
    the restrict attribute.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the definition's name. +

    +

    +
    Parameters:
    name - the name of the definition.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Return the definition's name. +

    +

    + +
    Returns:
    the name of the definition.
    +
    +
    +
    + +

    +setClass

    +
    +public void setClass(java.lang.Class clazz)
    +
    +
    Set the class of the definition. + As a side-effect may set the classloader and classname. +

    +

    +
    Parameters:
    clazz - the class of this definition.
    +
    +
    +
    + +

    +setClassName

    +
    +public void setClassName(java.lang.String className)
    +
    +
    Set the classname of the definition. +

    +

    +
    Parameters:
    className - the classname of this definition.
    +
    +
    +
    + +

    +getClassName

    +
    +public java.lang.String getClassName()
    +
    +
    Get the classname of the definition. +

    +

    + +
    Returns:
    the name of the class of this definition.
    +
    +
    +
    + +

    +setAdapterClass

    +
    +public void setAdapterClass(java.lang.Class adapterClass)
    +
    +
    Set the adapter class for this definition. + This class is used to adapt the definitions class if + required. +

    +

    +
    Parameters:
    adapterClass - the adapterClass.
    +
    +
    +
    + +

    +setAdaptToClass

    +
    +public void setAdaptToClass(java.lang.Class adaptToClass)
    +
    +
    Set the assignable class for this definition. +

    +

    +
    Parameters:
    adaptToClass - the assignable class.
    +
    +
    +
    + +

    +setClassLoader

    +
    +public void setClassLoader(java.lang.ClassLoader classLoader)
    +
    +
    Set the classloader to use to create an instance + of the definition. +

    +

    +
    Parameters:
    classLoader - the ClassLoader.
    +
    +
    +
    + +

    +getClassLoader

    +
    +public java.lang.ClassLoader getClassLoader()
    +
    +
    Get the classloader for this definition. +

    +

    + +
    Returns:
    the classloader for this definition.
    +
    +
    +
    + +

    +getExposedClass

    +
    +public java.lang.Class getExposedClass(Project project)
    +
    +
    Get the exposed class for this + definition. This will be a proxy class + (adapted class) if there is an adapter + class and the definition class is not + assignable from the assignable class. +

    +

    +
    Parameters:
    project - the current project. +
    Returns:
    the exposed class - may return null if unable to load the class
    +
    +
    +
    + +

    +getTypeClass

    +
    +public java.lang.Class getTypeClass(Project project)
    +
    +
    Get the definition class. +

    +

    +
    Parameters:
    project - the current project. +
    Returns:
    the type of the definition.
    +
    +
    +
    + +

    +innerGetTypeClass

    +
    +public java.lang.Class innerGetTypeClass()
+                                  throws java.lang.ClassNotFoundException
    +
    +
    Try and load a class, with no attempt to catch any fault. +

    +

    + +
    Returns:
    the class that implements this component +
    Throws: +
    java.lang.ClassNotFoundException - if the class cannot be found. +
    java.lang.NoClassDefFoundError - if the there is an error + finding the class.
    +
    +
    +
    + +

    +create

    +
    +public java.lang.Object create(Project project)
    +
    +
    Create an instance of the definition. + The instance may be wrapped in a proxy class. +

    +

    +
    Parameters:
    project - the current project. +
    Returns:
    the created object.
    +
    +
    +
    + +

    +checkClass

    +
    +public void checkClass(Project project)
    +
    +
    Checks if the attributes are correct. +
    +
  • if the class can be created.
    • +
  • if an adapter class can be created
    • +
  • if the type is assignable from adapto
    • +
  • if the type can be used with the adapter class
    • +
    +

    +

    +
    Parameters:
    project - the current project.
    +
    +
    +
    + +

    +innerCreateAndSet

    +
    +public java.lang.Object innerCreateAndSet(java.lang.Class newclass,
+                                          Project project)
+                                   throws java.lang.NoSuchMethodException,
+                                          java.lang.InstantiationException,
+                                          java.lang.IllegalAccessException,
+                                          java.lang.reflect.InvocationTargetException
    +
    +
    Inner implementation of the createAndSet(Project, Class) logic, with no + exception catching +

    +

    +
    Parameters:
    newclass - class to create
    project - the project to use +
    Returns:
    a newly constructed and bound instance. +
    Throws: +
    java.lang.NoSuchMethodException - no good construtor. +
    java.lang.InstantiationException - cannot initialize the object. +
    java.lang.IllegalAccessException - cannot access the object. +
    java.lang.reflect.InvocationTargetException - error in invocation.
    +
    +
    +
    + +

    +sameDefinition

    +
    +public boolean sameDefinition(AntTypeDefinition other,
+                              Project project)
    +
    +
    Equality method for this definition (assumes the names are the same). +

    +

    +
    Parameters:
    other - another definition.
    project - the project the definition. +
    Returns:
    true if the definitions are the same.
    +
    +
    +
    + +

    +similarDefinition

    +
    +public boolean similarDefinition(AntTypeDefinition other,
+                                 Project project)
    +
    +
    Similar definition; + used to compare two definitions defined twice with the same + name and the same types. + The classloader may be different but have the same + path so #sameDefinition cannot + be used. +

    +

    +
    Parameters:
    other - the definition to compare to.
    project - the current project. +
    Returns:
    true if the definitions are the same.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildEvent.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildEvent.html new file mode 100644 index 000000000..0d1ac7470 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildEvent.html @@ -0,0 +1,513 @@ + + + + + + +BuildEvent (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class BuildEvent

    +
    +java.lang.Object
+  extended by java.util.EventObject
+      extended by org.apache.tools.ant.BuildEvent
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class BuildEvent
    extends java.util.EventObject
    + + +

    +Class representing an event occurring during a build. An + event is built by specifying either a project, a task or a target. + A project level event will only have a project reference; + a target level event will have project and target references; + a task level event will have project, target and task references. +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.util.EventObject
    source
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    BuildEvent(Project project) + +
    +          Construct a BuildEvent for a project level event.
    BuildEvent(Target target) + +
    +          Construct a BuildEvent for a target level event.
    BuildEvent(Task task) + +
    +          Construct a BuildEvent for a task level event.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ThrowablegetException() + +
    +          Returns the exception that was thrown, if any.
    + java.lang.StringgetMessage() + +
    +          Returns the logging message.
    + intgetPriority() + +
    +          Returns the priority of the logging message.
    + ProjectgetProject() + +
    +          Returns the project that fired this event.
    + TargetgetTarget() + +
    +          Returns the target that fired this event.
    + TaskgetTask() + +
    +          Returns the task that fired this event.
    + voidsetException(java.lang.Throwable exception) + +
    +          Sets the exception associated with this event.
    + voidsetMessage(java.lang.String message, + int priority) + +
    +          Sets the message and priority associated with this event.
    +  + + + + + + + +
    Methods inherited from class java.util.EventObject
    getSource, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BuildEvent

    +
    +public BuildEvent(Project project)
    +
    +
    Construct a BuildEvent for a project level event. +

    +

    +
    Parameters:
    project - the project that emitted the event. + Should not be null.
    +
    +
    + +

    +BuildEvent

    +
    +public BuildEvent(Target target)
    +
    +
    Construct a BuildEvent for a target level event. + The project associated with the event is derived + from the given target. +

    +

    +
    Parameters:
    target - the target that emitted the event. + Must not be null.
    +
    +
    + +

    +BuildEvent

    +
    +public BuildEvent(Task task)
    +
    +
    Construct a BuildEvent for a task level event. + The project and target associated with the event + are derived from the given task. +

    +

    +
    Parameters:
    task - the task that emitted the event. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMessage

    +
    +public void setMessage(java.lang.String message,
+                       int priority)
    +
    +
    Sets the message and priority associated with this event. + This is used for "messageLogged" events. +

    +

    +
    Parameters:
    message - the message to be associated with this event. + Should not be null.
    priority - the priority to be associated with this event, + as defined in the Project class.
    See Also:
    BuildListener.messageLogged(BuildEvent)
    +
    +
    +
    + +

    +setException

    +
    +public void setException(java.lang.Throwable exception)
    +
    +
    Sets the exception associated with this event. This is used + for "messageLogged", "taskFinished", "targetFinished", and "buildFinished" + events. +

    +

    +
    Parameters:
    exception - The exception to be associated with this event. + May be null.
    See Also:
    BuildListener.messageLogged(BuildEvent), +BuildListener.taskFinished(BuildEvent), +BuildListener.targetFinished(BuildEvent), +BuildListener.buildFinished(BuildEvent)
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Returns the project that fired this event. +

    +

    + +
    Returns:
    the project that fired this event
    +
    +
    +
    + +

    +getTarget

    +
    +public Target getTarget()
    +
    +
    Returns the target that fired this event. +

    +

    + +
    Returns:
    the project that fired this event, or null + if this event is a project level event.
    +
    +
    +
    + +

    +getTask

    +
    +public Task getTask()
    +
    +
    Returns the task that fired this event. +

    +

    + +
    Returns:
    the task that fired this event, or null + if this event is a project or target level event.
    +
    +
    +
    + +

    +getMessage

    +
    +public java.lang.String getMessage()
    +
    +
    Returns the logging message. This field will only be set + for "messageLogged" events. +

    +

    + +
    Returns:
    the message associated with this event, or null + if no message has been set.
    See Also:
    BuildListener.messageLogged(BuildEvent)
    +
    +
    +
    + +

    +getPriority

    +
    +public int getPriority()
    +
    +
    Returns the priority of the logging message. This field will only + be set for "messageLogged" events. The meaning of this priority + is as specified by the constants in the Project class. +

    +

    + +
    Returns:
    the priority associated with this event.
    See Also:
    BuildListener.messageLogged(BuildEvent)
    +
    +
    +
    + +

    +getException

    +
    +public java.lang.Throwable getException()
    +
    +
    Returns the exception that was thrown, if any. This field will only + be set for "messageLogged", "taskFinished", "targetFinished", and "buildFinished" + events. +

    +

    + +
    Returns:
    the exception associated with this exception, or + null if no exception has been set.
    See Also:
    BuildListener.messageLogged(BuildEvent), +BuildListener.taskFinished(BuildEvent), +BuildListener.targetFinished(BuildEvent), +BuildListener.buildFinished(BuildEvent)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildException.html new file mode 100644 index 000000000..dde842b2a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildException.html @@ -0,0 +1,485 @@ + + + + + + +BuildException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class BuildException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.apache.tools.ant.BuildException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    Direct Known Subclasses:
    BuildTimeoutException, ExitStatusException, UnsupportedAttributeException, UnsupportedElementException
    +
    +
    +
    +
    public class BuildException
    extends java.lang.RuntimeException
    + + +

    +Signals an error condition during a build +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    BuildException() + +
    +          Constructs a build exception with no descriptive information.
    BuildException(java.lang.String message) + +
    +          Constructs an exception with the given descriptive message.
    BuildException(java.lang.String message, + Location location) + +
    +          Constructs an exception with the given descriptive message and a + location in a file.
    BuildException(java.lang.String message, + java.lang.Throwable cause) + +
    +          Constructs an exception with the given message and exception as + a root cause.
    BuildException(java.lang.String msg, + java.lang.Throwable cause, + Location location) + +
    +          Constructs an exception with the given message and exception as + a root cause and a location in a file.
    BuildException(java.lang.Throwable cause) + +
    +          Constructs an exception with the given exception as a root cause.
    BuildException(java.lang.Throwable cause, + Location location) + +
    +          Constructs an exception with the given exception as + a root cause and a location in a file.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ThrowablegetException() + +
    +          Deprecated. Use Throwable.getCause() instead.
    + LocationgetLocation() + +
    +          Returns the file location where the error occurred.
    + voidsetLocation(Location location) + +
    +          Sets the file location where the error occurred.
    + java.lang.StringtoString() + +
    +          Returns the location of the error and the error message.
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BuildException

    +
    +public BuildException()
    +
    +
    Constructs a build exception with no descriptive information. +

    +

    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.String message)
    +
    +
    Constructs an exception with the given descriptive message. +

    +

    +
    Parameters:
    message - A description of or information about the exception. + Should not be null.
    +
    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.String message,
+                      java.lang.Throwable cause)
    +
    +
    Constructs an exception with the given message and exception as + a root cause. +

    +

    +
    Parameters:
    message - A description of or information about the exception. + Should not be null unless a cause is specified.
    cause - The exception that might have caused this one. + May be null.
    +
    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.String msg,
+                      java.lang.Throwable cause,
+                      Location location)
    +
    +
    Constructs an exception with the given message and exception as + a root cause and a location in a file. +

    +

    +
    Parameters:
    msg - A description of or information about the exception. + Should not be null unless a cause is specified.
    cause - The exception that might have caused this one. + May be null.
    location - The location in the project file where the error + occurred. Must not be null.
    +
    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.Throwable cause)
    +
    +
    Constructs an exception with the given exception as a root cause. +

    +

    +
    Parameters:
    cause - The exception that might have caused this one. + Should not be null.
    +
    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.String message,
+                      Location location)
    +
    +
    Constructs an exception with the given descriptive message and a + location in a file. +

    +

    +
    Parameters:
    message - A description of or information about the exception. + Should not be null.
    location - The location in the project file where the error + occurred. Must not be null.
    +
    +
    + +

    +BuildException

    +
    +public BuildException(java.lang.Throwable cause,
+                      Location location)
    +
    +
    Constructs an exception with the given exception as + a root cause and a location in a file. +

    +

    +
    Parameters:
    cause - The exception that might have caused this one. + Should not be null.
    location - The location in the project file where the error + occurred. Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getException

    +
    +public java.lang.Throwable getException()
    +
    +
    Deprecated. Use Throwable.getCause() instead. +

    +

    Returns the nested exception, if any. +

    +

    + +
    Returns:
    the nested exception, or null if no + exception is associated with this one
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Returns the location of the error and the error message. +

    +

    +
    Overrides:
    toString in class java.lang.Throwable
    +
    +
    + +
    Returns:
    the location of the error and the error message
    +
    +
    +
    + +

    +setLocation

    +
    +public void setLocation(Location location)
    +
    +
    Sets the file location where the error occurred. +

    +

    +
    Parameters:
    location - The file location where the error occurred. + Must not be null.
    +
    +
    +
    + +

    +getLocation

    +
    +public Location getLocation()
    +
    +
    Returns the file location where the error occurred. +

    +

    + +
    Returns:
    the file location where the error occurred.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildListener.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildListener.html new file mode 100644 index 000000000..10f94aab5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildListener.html @@ -0,0 +1,384 @@ + + + + + + +BuildListener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface BuildListener

    +
    +
    All Superinterfaces:
    java.util.EventListener
    +
    +
    +
    All Known Subinterfaces:
    BuildLogger, SubBuildListener
    +
    +
    +
    All Known Implementing Classes:
    AnsiColorLogger, AntClassLoader, AntClassLoader2, AntClassLoader5, AntSoundPlayer, BigProjectLogger, CommonsLoggingListener, DefaultLogger, FailureRecorder, Log4jListener, MailLogger, ModifiedSelector, NoBannerLogger, ProfileLogger, Recorder, RecorderEntry, SimpleBigProjectLogger, SplitClassLoader, TimestampedLogger, XmlLogger
    +
    +
    +
    +
    public interface BuildListener
    extends java.util.EventListener
    + + +

    +Instances of classes that implement this interface can register + to be notified when things happened during a build. +

    + +

    +

    +
    See Also:
    BuildEvent, +Project.addBuildListener(BuildListener)
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished.
    + voidbuildStarted(BuildEvent event) + +
    +          Signals that a build has started.
    + voidmessageLogged(BuildEvent event) + +
    +          Signals a message logging event.
    + voidtargetFinished(BuildEvent event) + +
    +          Signals that a target has finished.
    + voidtargetStarted(BuildEvent event) + +
    +          Signals that a target is starting.
    + voidtaskFinished(BuildEvent event) + +
    +          Signals that a task has finished.
    + voidtaskStarted(BuildEvent event) + +
    +          Signals that a task is starting.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +buildStarted

    +
    +void buildStarted(BuildEvent event)
    +
    +
    Signals that a build has started. This event + is fired before any targets have started. + +

    This event is fired before the project instance is fully + configured. In particular no properties have been set and the + project may not know its name or default target, yet.

    +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    +
    +
    +
    + +

    +buildFinished

    +
    +void buildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +targetStarted

    +
    +void targetStarted(BuildEvent event)
    +
    +
    Signals that a target is starting. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +void targetFinished(BuildEvent event)
    +
    +
    Signals that a target has finished. This event will + still be fired if an error occurred during the build. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +void taskStarted(BuildEvent event)
    +
    +
    Signals that a task is starting. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +void taskFinished(BuildEvent event)
    +
    +
    Signals that a task has finished. This event will still + be fired if an error occurred during the build. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +void messageLogged(BuildEvent event)
    +
    +
    Signals a message logging event. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildLogger.html new file mode 100644 index 000000000..27e925a6d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/BuildLogger.html @@ -0,0 +1,313 @@ + + + + + + +BuildLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface BuildLogger

    +
    +
    All Superinterfaces:
    BuildListener, java.util.EventListener
    +
    +
    +
    All Known Implementing Classes:
    AnsiColorLogger, BigProjectLogger, CommonsLoggingListener, DefaultLogger, MailLogger, NoBannerLogger, ProfileLogger, RecorderEntry, SimpleBigProjectLogger, TimestampedLogger, XmlLogger
    +
    +
    +
    +
    public interface BuildLogger
    extends BuildListener
    + + +

    +Interface used by Ant to log the build output. + + A build logger is a build listener which has the 'right' to send output to + the ant log, which is usually System.out unless redirected by + the -logfile option. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Sets this logger to produce emacs (and other editor) friendly output.
    + voidsetErrorPrintStream(java.io.PrintStream err) + +
    +          Sets the output stream to which this logger is to send error messages.
    + voidsetMessageOutputLevel(int level) + +
    +          Sets the highest level of message this logger should respond to.
    + voidsetOutputPrintStream(java.io.PrintStream output) + +
    +          Sets the output stream to which this logger is to send its output.
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.BuildListener
    buildFinished, buildStarted, messageLogged, targetFinished, targetStarted, taskFinished, taskStarted
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setMessageOutputLevel

    +
    +void setMessageOutputLevel(int level)
    +
    +
    Sets the highest level of message this logger should respond to. + + Only messages with a message level lower than or equal to the + given level should be written to the log. +

    + Constants for the message levels are in the + Project class. The order of the levels, from least + to most verbose, is MSG_ERR, MSG_WARN, + MSG_INFO, MSG_VERBOSE, + MSG_DEBUG. +

    +

    +
    +
    +
    +
    Parameters:
    level - the logging level for the logger.
    +
    +
    +
    + +

    +setOutputPrintStream

    +
    +void setOutputPrintStream(java.io.PrintStream output)
    +
    +
    Sets the output stream to which this logger is to send its output. +

    +

    +
    +
    +
    +
    Parameters:
    output - The output stream for the logger. + Must not be null.
    +
    +
    +
    + +

    +setEmacsMode

    +
    +void setEmacsMode(boolean emacsMode)
    +
    +
    Sets this logger to produce emacs (and other editor) friendly output. +

    +

    +
    +
    +
    +
    Parameters:
    emacsMode - true if output is to be unadorned so that + emacs and other editors can parse files names, etc.
    +
    +
    +
    + +

    +setErrorPrintStream

    +
    +void setErrorPrintStream(java.io.PrintStream err)
    +
    +
    Sets the output stream to which this logger is to send error messages. +

    +

    +
    +
    +
    +
    Parameters:
    err - The error stream for the logger. + Must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ComponentHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ComponentHelper.html new file mode 100644 index 000000000..cdd3fcb19 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ComponentHelper.html @@ -0,0 +1,991 @@ + + + + + + +ComponentHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ComponentHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ComponentHelper
+
    +
    +
    +
    public class ComponentHelper
    extends java.lang.Object
    + + +

    +Component creation and configuration. + + The class is based around handing component + definitions in an AntTypeTable. + + The old task/type methods have been kept + for backward compatibly. + Project will just delegate its calls to this class. + + A very simple hook mechanism is provided that allows users to plug + in custom code. It is also possible to replace the default behavior + ( for example in an app embedding ant ) +

    + +

    +

    +
    Since:
    +
    Ant1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringCOMPONENT_HELPER_REFERENCE + +
    +          reference under which we register ourselves with a project -"ant.ComponentHelper"
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected ComponentHelper() + +
    +          Creates a new ComponentHelper instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddDataTypeDefinition(AntTypeDefinition def) + +
    +          Describe addDataTypeDefinition method here.
    + voidaddDataTypeDefinition(java.lang.String typeName, + java.lang.Class typeClass) + +
    +          Adds a new datatype definition.
    + voidaddTaskDefinition(java.lang.String taskName, + java.lang.Class taskClass) + +
    +          Adds a new task definition to the project.
    + voidcheckTaskClass(java.lang.Class taskClass) + +
    +          Checks whether or not a class is suitable for serving as Ant task.
    + java.lang.ObjectcreateComponent(java.lang.String componentName) + +
    +          Create an object for a component.
    + java.lang.ObjectcreateComponent(UnknownElement ue, + java.lang.String ns, + java.lang.String componentType) + +
    +          Factory method to create the components.
    + java.lang.ObjectcreateDataType(java.lang.String typeName) + +
    +          Creates a new instance of a data type.
    + TaskcreateTask(java.lang.String taskType) + +
    +          Creates a new instance of a task.
    + java.lang.StringdiagnoseCreationFailure(java.lang.String componentName, + java.lang.String type) + +
    +          Handler called to do decent diagnosis on instantiation failure.
    + voidenterAntLib(java.lang.String uri) + +
    +          Called at the start of processing an antlib.
    + voidexitAntLib() + +
    +          Called at the end of processing an antlib.
    + java.util.HashtablegetAntTypeTable() + +
    +          Returns the current datatype definition hashtable.
    + java.lang.ClassgetComponentClass(java.lang.String componentName) + +
    +          Return the class of the component name.
    +static ComponentHelpergetComponentHelper(Project project) + +
    +          Find a project component for a specific project, creating + it if it does not exist.
    + java.lang.StringgetCurrentAntlibUri() + +
    +           
    + java.util.HashtablegetDataTypeDefinitions() + +
    +          Returns the current type definition hashtable.
    + AntTypeDefinitiongetDefinition(java.lang.String componentName) + +
    +          Return the antTypeDefinition for a componentName.
    + java.lang.StringgetElementName(java.lang.Object element) + +
    +          Returns a description of the type of the given element.
    + java.lang.StringgetElementName(java.lang.Object o, + boolean brief) + +
    +          Returns a description of the type of the given element.
    +static java.lang.StringgetElementName(Project p, + java.lang.Object o, + boolean brief) + +
    +          Convenient way to get some element name even when you may not have a + Project context.
    + ComponentHelpergetNext() + +
    +          Get the next chained component helper.
    + ProjectgetProject() + +
    +          Get the project.
    + java.util.ListgetRestrictedDefinitions(java.lang.String componentName) + +
    +          This returns a list of restricted definitions for a name.
    + java.util.HashtablegetTaskDefinitions() + +
    +          Returns the current task definition hashtable.
    + voidinitDefaultDefinitions() + +
    +          This method is initialization code implementing the original ant component + loading from /org/apache/tools/ant/taskdefs/default.properties + and /org/apache/tools/ant/types/default.properties.
    + voidinitSubProject(ComponentHelper helper) + +
    +          Used with creating child projects.
    + voidsetNext(ComponentHelper next) + +
    +          Set the next chained component helper.
    + voidsetProject(Project project) + +
    +          Sets the project for this component helper.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +COMPONENT_HELPER_REFERENCE

    +
    +public static final java.lang.String COMPONENT_HELPER_REFERENCE
    +
    +
    reference under which we register ourselves with a project -"ant.ComponentHelper" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ComponentHelper

    +
    +protected ComponentHelper()
    +
    +
    Creates a new ComponentHelper instance. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get the project. +

    +

    + +
    Returns:
    the project owner of this helper.
    +
    +
    +
    + +

    +getComponentHelper

    +
    +public static ComponentHelper getComponentHelper(Project project)
    +
    +
    Find a project component for a specific project, creating + it if it does not exist. +

    +

    +
    Parameters:
    project - the project. +
    Returns:
    the project component for a specific project.
    +
    +
    +
    + +

    +setNext

    +
    +public void setNext(ComponentHelper next)
    +
    +
    Set the next chained component helper. +

    +

    +
    Parameters:
    next - the next chained component helper.
    +
    +
    +
    + +

    +getNext

    +
    +public ComponentHelper getNext()
    +
    +
    Get the next chained component helper. +

    +

    + +
    Returns:
    the next chained component helper.
    +
    +
    +
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Sets the project for this component helper. +

    +

    +
    Parameters:
    project - the project for this helper.
    +
    +
    +
    + +

    +initSubProject

    +
    +public void initSubProject(ComponentHelper helper)
    +
    +
    Used with creating child projects. Each child + project inherits the component definitions + from its parent. +

    +

    +
    Parameters:
    helper - the component helper of the parent project.
    +
    +
    +
    + +

    +createComponent

    +
    +public java.lang.Object createComponent(UnknownElement ue,
+                                        java.lang.String ns,
+                                        java.lang.String componentType)
+                                 throws BuildException
    +
    +
    Factory method to create the components. + + This should be called by UnknownElement. +

    +

    +
    Parameters:
    ue - The Unknown Element creating this component.
    ns - Namespace URI. Also available as ue.getNamespace().
    componentType - The component type, + Also available as ue.getComponentName(). +
    Returns:
    the created component. +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +createComponent

    +
    +public java.lang.Object createComponent(java.lang.String componentName)
    +
    +
    Create an object for a component. +

    +

    +
    Parameters:
    componentName - the name of the component, if + the component is in a namespace, the + name is prefixed with the namespace uri and ":". +
    Returns:
    the class if found or null if not.
    +
    +
    +
    + +

    +getComponentClass

    +
    +public java.lang.Class getComponentClass(java.lang.String componentName)
    +
    +
    Return the class of the component name. +

    +

    +
    Parameters:
    componentName - the name of the component, if + the component is in a namespace, the + name is prefixed with the namespace uri and ":". +
    Returns:
    the class if found or null if not.
    +
    +
    +
    + +

    +getDefinition

    +
    +public AntTypeDefinition getDefinition(java.lang.String componentName)
    +
    +
    Return the antTypeDefinition for a componentName. +

    +

    +
    Parameters:
    componentName - the name of the component. +
    Returns:
    the ant definition or null if not present.
    +
    +
    +
    + +

    +initDefaultDefinitions

    +
    +public void initDefaultDefinitions()
    +
    +
    This method is initialization code implementing the original ant component + loading from /org/apache/tools/ant/taskdefs/default.properties + and /org/apache/tools/ant/types/default.properties. +

    +

    +
    +
    +
    +
    + +

    +addTaskDefinition

    +
    +public void addTaskDefinition(java.lang.String taskName,
+                              java.lang.Class taskClass)
    +
    +
    Adds a new task definition to the project. + Attempting to override an existing definition with an + equivalent one (i.e. with the same classname) results in + a verbose log message. Attempting to override an existing definition + with a different one results in a warning log message. +

    +

    +
    Parameters:
    taskName - The name of the task to add. + Must not be null.
    taskClass - The full name of the class implementing the task. + Must not be null. +
    Throws: +
    BuildException - if the class is unsuitable for being an Ant + task. An error level message is logged before + this exception is thrown.
    See Also:
    checkTaskClass(Class)
    +
    +
    +
    + +

    +checkTaskClass

    +
    +public void checkTaskClass(java.lang.Class taskClass)
+                    throws BuildException
    +
    +
    Checks whether or not a class is suitable for serving as Ant task. + Ant task implementation classes must be public, concrete, and have + a no-arg constructor. +

    +

    +
    Parameters:
    taskClass - The class to be checked. + Must not be null. +
    Throws: +
    BuildException - if the class is unsuitable for being an Ant + task. An error level message is logged before + this exception is thrown.
    +
    +
    +
    + +

    +getTaskDefinitions

    +
    +public java.util.Hashtable getTaskDefinitions()
    +
    +
    Returns the current task definition hashtable. The returned hashtable is + "live" and so should not be modified. Also, the returned table may be + modifed asynchronously. +

    +

    + +
    Returns:
    a map of from task name to implementing class + (String to Class).
    +
    +
    +
    + +

    +getDataTypeDefinitions

    +
    +public java.util.Hashtable getDataTypeDefinitions()
    +
    +
    Returns the current type definition hashtable. The returned hashtable is + "live" and so should not be modified. +

    +

    + +
    Returns:
    a map of from type name to implementing class + (String to Class).
    +
    +
    +
    + +

    +getRestrictedDefinitions

    +
    +public java.util.List getRestrictedDefinitions(java.lang.String componentName)
    +
    +
    This returns a list of restricted definitions for a name. + The returned List is "live" and so should not be modified. + Also, the returned list may be modifed asynchronously. + Any access must be guarded with a lock on the list itself. +

    +

    +
    Parameters:
    componentName - the name to use. +
    Returns:
    the list of restricted definitions for a particular name.
    +
    +
    +
    + +

    +addDataTypeDefinition

    +
    +public void addDataTypeDefinition(java.lang.String typeName,
+                                  java.lang.Class typeClass)
    +
    +
    Adds a new datatype definition. + Attempting to override an existing definition with an + equivalent one (i.e. with the same classname) results in + a verbose log message. Attempting to override an existing definition + with a different one results in a warning log message, but the + definition is changed. +

    +

    +
    Parameters:
    typeName - The name of the datatype. + Must not be null.
    typeClass - The full name of the class implementing the datatype. + Must not be null.
    +
    +
    +
    + +

    +addDataTypeDefinition

    +
    +public void addDataTypeDefinition(AntTypeDefinition def)
    +
    +
    Describe addDataTypeDefinition method here. +

    +

    +
    Parameters:
    def - an AntTypeDefinition value.
    +
    +
    +
    + +

    +getAntTypeTable

    +
    +public java.util.Hashtable getAntTypeTable()
    +
    +
    Returns the current datatype definition hashtable. The returned + hashtable is "live" and so should not be modified. +

    +

    + +
    Returns:
    a map of from datatype name to implementing class + (String to Class).
    +
    +
    +
    + +

    +createTask

    +
    +public Task createTask(java.lang.String taskType)
+                throws BuildException
    +
    +
    Creates a new instance of a task. + + Called from Project.createTask(), which can be called by tasks. +

    +

    +
    Parameters:
    taskType - The name of the task to create an instance of. + Must not be null. +
    Returns:
    an instance of the specified task, or null if + the task name is not recognised. +
    Throws: +
    BuildException - if the task name is recognised but task + creation fails.
    +
    +
    +
    + +

    +createDataType

    +
    +public java.lang.Object createDataType(java.lang.String typeName)
+                                throws BuildException
    +
    +
    Creates a new instance of a data type. +

    +

    +
    Parameters:
    typeName - The name of the data type to create an instance of. + Must not be null. +
    Returns:
    an instance of the specified data type, or null if + the data type name is not recognised. +
    Throws: +
    BuildException - if the data type name is recognised but + instance creation fails.
    +
    +
    +
    + +

    +getElementName

    +
    +public java.lang.String getElementName(java.lang.Object element)
    +
    +
    Returns a description of the type of the given element. +

    + This is useful for logging purposes. +

    +

    +
    Parameters:
    element - The element to describe. + Must not be null. +
    Returns:
    a description of the element type.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getElementName

    +
    +public java.lang.String getElementName(java.lang.Object o,
+                                       boolean brief)
    +
    +
    Returns a description of the type of the given element. +

    + This is useful for logging purposes. +

    +

    +
    Parameters:
    o - The element to describe. + Must not be null.
    brief - whether to use a brief description. +
    Returns:
    a description of the element type.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getElementName

    +
    +public static java.lang.String getElementName(Project p,
+                                              java.lang.Object o,
+                                              boolean brief)
    +
    +
    Convenient way to get some element name even when you may not have a + Project context. +

    +

    +
    Parameters:
    p - The optional Project instance.
    o - The element to describe. + Must not be null.
    brief - whether to use a brief description. +
    Returns:
    a description of the element type.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +enterAntLib

    +
    +public void enterAntLib(java.lang.String uri)
    +
    +
    Called at the start of processing an antlib. +

    +

    +
    Parameters:
    uri - the uri that is associated with this antlib.
    +
    +
    +
    + +

    +getCurrentAntlibUri

    +
    +public java.lang.String getCurrentAntlibUri()
    +
    +
    + +
    Returns:
    the current antlib uri.
    +
    +
    +
    + +

    +exitAntLib

    +
    +public void exitAntLib()
    +
    +
    Called at the end of processing an antlib. +

    +

    +
    +
    +
    +
    + +

    +diagnoseCreationFailure

    +
    +public java.lang.String diagnoseCreationFailure(java.lang.String componentName,
+                                                java.lang.String type)
    +
    +
    Handler called to do decent diagnosis on instantiation failure. +

    +

    +
    Parameters:
    componentName - component name.
    type - component type, used in error messages +
    Returns:
    a string containing as much diagnostics info as possible.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DefaultLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DefaultLogger.html new file mode 100644 index 000000000..b8d4fac12 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DefaultLogger.html @@ -0,0 +1,860 @@ + + + + + + +DefaultLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class DefaultLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    Direct Known Subclasses:
    AnsiColorLogger, MailLogger, NoBannerLogger, ProfileLogger, TimestampedLogger
    +
    +
    +
    +
    public class DefaultLogger
    extends java.lang.Object
    implements BuildLogger
    + + +

    +Writes build events to a PrintStream. Currently, it + only writes which targets are being executed, and + any messages that get logged. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  booleanemacsMode + +
    +          Whether or not to use emacs-style output
    +protected  java.io.PrintStreamerr + +
    +          PrintStream to write error messages to
    +static intLEFT_COLUMN_SIZE + +
    +          Size of left-hand column for right-justified task name.
    +protected static java.lang.StringlSep + +
    +          Line separator
    +protected  intmsgOutputLevel + +
    +          Lowest level of message to write out
    +protected  java.io.PrintStreamout + +
    +          PrintStream to write non-error messages to
    +  + + + + + + + + + + +
    +Constructor Summary
    DefaultLogger() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took.
    + voidbuildStarted(BuildEvent event) + +
    +          Responds to a build being started by just remembering the current time.
    +protected  java.lang.StringextractProjectName(BuildEvent event) + +
    +          Get the project name or null
    +protected static java.lang.StringformatTime(long millis) + +
    +          Convenience method to format a specified length of time.
    +protected  java.lang.StringgetBuildFailedMessage() + +
    +          This is an override point: the message that indicates whether a build failed.
    +protected  java.lang.StringgetBuildSuccessfulMessage() + +
    +          This is an override point: the message that indicates that a build succeeded.
    +protected  java.lang.StringgetTimestamp() + +
    +          Get the current time.
    +protected  voidlog(java.lang.String message) + +
    +          Empty implementation which allows subclasses to receive the + same output that is generated here.
    + voidmessageLogged(BuildEvent event) + +
    +          Logs a message, if the priority is suitable.
    +protected  voidprintMessage(java.lang.String message, + java.io.PrintStream stream, + int priority) + +
    +          Prints a message to a PrintStream.
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Sets this logger to produce emacs (and other editor) friendly output.
    + voidsetErrorPrintStream(java.io.PrintStream err) + +
    +          Sets the output stream to which this logger is to send error messages.
    + voidsetMessageOutputLevel(int level) + +
    +          Sets the highest level of message this logger should respond to.
    + voidsetOutputPrintStream(java.io.PrintStream output) + +
    +          Sets the output stream to which this logger is to send its output.
    + voidtargetFinished(BuildEvent event) + +
    +          No-op implementation.
    + voidtargetStarted(BuildEvent event) + +
    +          Logs a message to say that the target has started if this + logger allows information-level messages.
    + voidtaskFinished(BuildEvent event) + +
    +          No-op implementation.
    + voidtaskStarted(BuildEvent event) + +
    +          No-op implementation.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +LEFT_COLUMN_SIZE

    +
    +public static final int LEFT_COLUMN_SIZE
    +
    +
    Size of left-hand column for right-justified task name. +

    +

    +
    See Also:
    messageLogged(BuildEvent), +Constant Field Values
    +
    +
    + +

    +out

    +
    +protected java.io.PrintStream out
    +
    +
    PrintStream to write non-error messages to +

    +

    +
    +
    +
    + +

    +err

    +
    +protected java.io.PrintStream err
    +
    +
    PrintStream to write error messages to +

    +

    +
    +
    +
    + +

    +msgOutputLevel

    +
    +protected int msgOutputLevel
    +
    +
    Lowest level of message to write out +

    +

    +
    +
    +
    + +

    +lSep

    +
    +protected static final java.lang.String lSep
    +
    +
    Line separator +

    +

    +
    +
    +
    + +

    +emacsMode

    +
    +protected boolean emacsMode
    +
    +
    Whether or not to use emacs-style output +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultLogger

    +
    +public DefaultLogger()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setMessageOutputLevel

    +
    +public void setMessageOutputLevel(int level)
    +
    +
    Sets the highest level of message this logger should respond to. + + Only messages with a message level lower than or equal to the + given level should be written to the log. +

    + Constants for the message levels are in the + Project class. The order of the levels, from least + to most verbose, is MSG_ERR, MSG_WARN, + MSG_INFO, MSG_VERBOSE, + MSG_DEBUG. +

    + The default message level for DefaultLogger is Project.MSG_ERR. +

    +

    +
    Specified by:
    setMessageOutputLevel in interface BuildLogger
    +
    +
    +
    Parameters:
    level - the logging level for the logger.
    +
    +
    +
    + +

    +setOutputPrintStream

    +
    +public void setOutputPrintStream(java.io.PrintStream output)
    +
    +
    Sets the output stream to which this logger is to send its output. +

    +

    +
    Specified by:
    setOutputPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    output - The output stream for the logger. + Must not be null.
    +
    +
    +
    + +

    +setErrorPrintStream

    +
    +public void setErrorPrintStream(java.io.PrintStream err)
    +
    +
    Sets the output stream to which this logger is to send error messages. +

    +

    +
    Specified by:
    setErrorPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    err - The error stream for the logger. + Must not be null.
    +
    +
    +
    + +

    +setEmacsMode

    +
    +public void setEmacsMode(boolean emacsMode)
    +
    +
    Sets this logger to produce emacs (and other editor) friendly output. +

    +

    +
    Specified by:
    setEmacsMode in interface BuildLogger
    +
    +
    +
    Parameters:
    emacsMode - true if output is to be unadorned so that + emacs and other editors can parse files names, etc.
    +
    +
    +
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Responds to a build being started by just remembering the current time. +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - Ignored.
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +getBuildFailedMessage

    +
    +protected java.lang.String getBuildFailedMessage()
    +
    +
    This is an override point: the message that indicates whether a build failed. + Subclasses can change/enhance the message. +

    +

    +
    +
    +
    + +
    Returns:
    The classic "BUILD FAILED"
    +
    +
    +
    + +

    +getBuildSuccessfulMessage

    +
    +protected java.lang.String getBuildSuccessfulMessage()
    +
    +
    This is an override point: the message that indicates that a build succeeded. + Subclasses can change/enhance the message. +

    +

    +
    +
    +
    + +
    Returns:
    The classic "BUILD SUCCESSFUL"
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Logs a message to say that the target has started if this + logger allows information-level messages. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    No-op implementation. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - Ignored.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    No-op implementation. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - Ignored.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    No-op implementation. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - Ignored.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Logs a message, if the priority is suitable. + In non-emacs mode, task level messages are prefixed by the + task name which is right-justified. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - A BuildEvent containing message information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +formatTime

    +
    +protected static java.lang.String formatTime(long millis)
    +
    +
    Convenience method to format a specified length of time. +

    +

    +
    +
    +
    +
    Parameters:
    millis - Length of time to format, in milliseconds. +
    Returns:
    the time as a formatted string.
    See Also:
    DateUtils.formatElapsedTime(long)
    +
    +
    +
    + +

    +printMessage

    +
    +protected void printMessage(java.lang.String message,
+                            java.io.PrintStream stream,
+                            int priority)
    +
    +
    Prints a message to a PrintStream. +

    +

    +
    +
    +
    +
    Parameters:
    message - The message to print. + Should not be null.
    stream - A PrintStream to print the message to. + Must not be null.
    priority - The priority of the message. + (Ignored in this implementation.)
    +
    +
    +
    + +

    +log

    +
    +protected void log(java.lang.String message)
    +
    +
    Empty implementation which allows subclasses to receive the + same output that is generated here. +

    +

    +
    +
    +
    +
    Parameters:
    message - Message being logged. Should not be null.
    +
    +
    +
    + +

    +getTimestamp

    +
    +protected java.lang.String getTimestamp()
    +
    +
    Get the current time. +

    +

    +
    +
    +
    + +
    Returns:
    the current time as a formatted string.
    Since:
    +
    Ant1.7.1
    +
    +
    +
    +
    + +

    +extractProjectName

    +
    +protected java.lang.String extractProjectName(BuildEvent event)
    +
    +
    Get the project name or null +

    +

    +
    +
    +
    +
    Parameters:
    event - the event +
    Returns:
    the project that raised this event
    Since:
    +
    Ant1.7.1
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxInputStream.html new file mode 100644 index 000000000..7511dd2a7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxInputStream.html @@ -0,0 +1,314 @@ + + + + + + +DemuxInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class DemuxInputStream

    +
    +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.ant.DemuxInputStream
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable
    +
    +
    +
    +
    public class DemuxInputStream
    extends java.io.InputStream
    + + +

    +Passes input requests to the project object for demuxing into + individual tasks and threads. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DemuxInputStream(Project project) + +
    +          Create a DemuxInputStream for the given project
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + intread() + +
    +          Read a byte from the project's demuxed input.
    + intread(byte[] buffer, + int offset, + int length) + +
    +          Read bytes from the project's demuxed input.
    +  + + + + + + + +
    Methods inherited from class java.io.InputStream
    available, close, mark, markSupported, read, reset, skip
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DemuxInputStream

    +
    +public DemuxInputStream(Project project)
    +
    +
    Create a DemuxInputStream for the given project +

    +

    +
    Parameters:
    project - the project instance
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Read a byte from the project's demuxed input. +

    +

    +
    Specified by:
    read in class java.io.InputStream
    +
    +
    + +
    Returns:
    the next byte +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +read

    +
    +public int read(byte[] buffer,
+                int offset,
+                int length)
+         throws java.io.IOException
    +
    +
    Read bytes from the project's demuxed input. +

    +

    +
    Overrides:
    read in class java.io.InputStream
    +
    +
    +
    Parameters:
    buffer - an array of bytes to read into
    offset - the offset in the array of bytes
    length - the number of bytes in the array +
    Returns:
    the number of bytes read +
    Throws: +
    java.io.IOException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxOutputStream.html new file mode 100644 index 000000000..8e9e005f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DemuxOutputStream.html @@ -0,0 +1,421 @@ + + + + + + +DemuxOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class DemuxOutputStream

    +
    +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.DemuxOutputStream
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable
    +
    +
    +
    +
    public class DemuxOutputStream
    extends java.io.OutputStream
    + + +

    +Logs content written by a thread and forwards the buffers onto the + project object which will forward the content to the appropriate + task. +

    + +

    +

    +
    Since:
    +
    1.4
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DemuxOutputStream(Project project, + boolean isErrorStream) + +
    +          Creates a new instance of this class.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidclose() + +
    +          Equivalent to flushing the stream.
    + voidflush() + +
    +          Writes all remaining data in the buffer associated + with the current thread to the project.
    +protected  voidprocessBuffer(java.io.ByteArrayOutputStream buffer) + +
    +          Converts the buffer to a string and sends it to the project.
    +protected  voidprocessFlush(java.io.ByteArrayOutputStream buffer) + +
    +          Converts the buffer to a string and sends it to the project.
    + voidwrite(byte[] b, + int off, + int len) + +
    +          Write a block of characters to the output stream
    + voidwrite(int cc) + +
    +          Writes the data to the buffer and flushes the buffer if a line + separator is detected or if the buffer has reached its maximum size.
    +  + + + + + + + +
    Methods inherited from class java.io.OutputStream
    write
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DemuxOutputStream

    +
    +public DemuxOutputStream(Project project,
+                         boolean isErrorStream)
    +
    +
    Creates a new instance of this class. +

    +

    +
    Parameters:
    project - The project instance for which output is being + demultiplexed. Must not be null.
    isErrorStream - true if this is the error string, + otherwise a normal output stream. This is + passed to the project so it knows + which stream it is receiving.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +write

    +
    +public void write(int cc)
+           throws java.io.IOException
    +
    +
    Writes the data to the buffer and flushes the buffer if a line + separator is detected or if the buffer has reached its maximum size. +

    +

    +
    Specified by:
    write in class java.io.OutputStream
    +
    +
    +
    Parameters:
    cc - data to log (byte). +
    Throws: +
    java.io.IOException - if the data cannot be written to the stream
    +
    +
    +
    + +

    +processBuffer

    +
    +protected void processBuffer(java.io.ByteArrayOutputStream buffer)
    +
    +
    Converts the buffer to a string and sends it to the project. +

    +

    +
    Parameters:
    buffer - the ByteArrayOutputStream used to collect the output + until a line separator is seen.
    See Also:
    Project.demuxOutput(String,boolean)
    +
    +
    +
    + +

    +processFlush

    +
    +protected void processFlush(java.io.ByteArrayOutputStream buffer)
    +
    +
    Converts the buffer to a string and sends it to the project. +

    +

    +
    Parameters:
    buffer - the ByteArrayOutputStream used to collect the output + until a line separator is seen.
    See Also:
    Project.demuxOutput(String,boolean)
    +
    +
    +
    + +

    +close

    +
    +public void close()
+           throws java.io.IOException
    +
    +
    Equivalent to flushing the stream. +

    +

    +
    Specified by:
    close in interface java.io.Closeable
    Overrides:
    close in class java.io.OutputStream
    +
    +
    + +
    Throws: +
    java.io.IOException - if there is a problem closing the stream.
    See Also:
    flush()
    +
    +
    +
    + +

    +flush

    +
    +public void flush()
+           throws java.io.IOException
    +
    +
    Writes all remaining data in the buffer associated + with the current thread to the project. +

    +

    +
    Specified by:
    flush in interface java.io.Flushable
    Overrides:
    flush in class java.io.OutputStream
    +
    +
    + +
    Throws: +
    java.io.IOException - if there is a problem flushing the stream.
    +
    +
    +
    + +

    +write

    +
    +public void write(byte[] b,
+                  int off,
+                  int len)
+           throws java.io.IOException
    +
    +
    Write a block of characters to the output stream +

    +

    +
    Overrides:
    write in class java.io.OutputStream
    +
    +
    +
    Parameters:
    b - the array containing the data
    off - the offset into the array where data starts
    len - the length of block +
    Throws: +
    java.io.IOException - if the data cannot be written into the stream.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Diagnostics.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Diagnostics.html new file mode 100644 index 000000000..498d14d76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Diagnostics.html @@ -0,0 +1,385 @@ + + + + + + +Diagnostics (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Diagnostics

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Diagnostics
+
    +
    +
    +
    public final class Diagnostics
    extends java.lang.Object
    + + +

    +A little diagnostic helper that output some information that may help + in support. It should quickly give correct information about the + jar existing in ant.home/lib and the jar versions... +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected static java.lang.StringERROR_PROPERTY_ACCESS_BLOCKED + +
    +          The error text when a security manager blocks access to a property.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voiddoReport(java.io.PrintStream out) + +
    +          Print a report to the given stream.
    +static voiddoReport(java.io.PrintStream out, + int logLevel) + +
    +          Print a report to the given stream.
    +static booleanisOptionalAvailable() + +
    +          Deprecated. Obsolete since Ant 1.8.2
    +static java.io.File[]listLibraries() + +
    +          return the list of jar files existing in ANT_HOME/lib + and that must have been picked up by Ant script.
    +static voidmain(java.lang.String[] args) + +
    +          main entry point for command line
    +static voidvalidateVersion() + +
    +          Deprecated. Obsolete since Ant 1.8.2
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_PROPERTY_ACCESS_BLOCKED

    +
    +protected static final java.lang.String ERROR_PROPERTY_ACCESS_BLOCKED
    +
    +
    The error text when a security manager blocks access to a property. + "Access to this property blocked by a security manager" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Method Detail
    + +

    +isOptionalAvailable

    +
    +public static boolean isOptionalAvailable()
    +
    +
    Deprecated. Obsolete since Ant 1.8.2 +

    +

    Doesn't do anything. +

    +

    + +
    Returns:
    true
    +
    +
    +
    + +

    +validateVersion

    +
    +public static void validateVersion()
+                            throws BuildException
    +
    +
    Deprecated. Obsolete since Ant 1.8.2 +

    +

    Doesn't do anything. +

    +

    + +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +listLibraries

    +
    +public static java.io.File[] listLibraries()
    +
    +
    return the list of jar files existing in ANT_HOME/lib + and that must have been picked up by Ant script. +

    +

    + +
    Returns:
    the list of jar files existing in ant.home/lib or + null if an error occurs.
    +
    +
    +
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    main entry point for command line +

    +

    +
    Parameters:
    args - command line arguments.
    +
    +
    +
    + +

    +doReport

    +
    +public static void doReport(java.io.PrintStream out)
    +
    +
    Print a report to the given stream. +

    +

    +
    Parameters:
    out - the stream to print the report to.
    +
    +
    +
    + +

    +doReport

    +
    +public static void doReport(java.io.PrintStream out,
+                            int logLevel)
    +
    +
    Print a report to the given stream. +

    +

    +
    Parameters:
    out - the stream to print the report to.
    logLevel - denotes the level of detail requested as one of + Project's MSG_* constants.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DirectoryScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DirectoryScanner.html new file mode 100644 index 000000000..0eb922c2a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DirectoryScanner.html @@ -0,0 +1,2063 @@ + + + + + + +DirectoryScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class DirectoryScanner

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+
    +
    +
    All Implemented Interfaces:
    FileScanner, ResourceFactory, SelectorScanner
    +
    +
    +
    Direct Known Subclasses:
    ArchiveScanner, DependScanner, FTP.FTPDirectoryScanner, FTPTaskMirrorImpl.FTPDirectoryScanner
    +
    +
    +
    +
    public class DirectoryScanner
    extends java.lang.Object
    implements FileScanner, SelectorScanner, ResourceFactory
    + + +

    +Class for scanning a directory for files/directories which match certain + criteria. +

    + These criteria consist of selectors and patterns which have been specified. + With the selectors you can select which files you want to have included. + Files which are not selected are excluded. With patterns you can include + or exclude files based on their filename. +

    + The idea is simple. A given directory is recursively scanned for all files + and directories. Each file/directory is matched against a set of selectors, + including special support for matching against filenames with include and + and exclude patterns. Only files/directories which match at least one + pattern of the include pattern list or other file selector, and don't match + any pattern of the exclude pattern list or fail to match against a required + selector will be placed in the list of files/directories found. +

    + When no list of include patterns is supplied, "**" will be used, which + means that everything will be matched. When no list of exclude patterns is + supplied, an empty list is used, such that nothing will be excluded. When + no selectors are supplied, none are applied. +

    + The filename pattern matching is done as follows: + The name to be matched is split up in path segments. A path segment is the + name of a directory or file, which is bounded by + File.separator ('/' under UNIX, '\' under Windows). + For example, "abc/def/ghi/xyz.java" is split up in the segments "abc", + "def","ghi" and "xyz.java". + The same is done for the pattern against which should be matched. +

    + The segments of the name and the pattern are then matched against each + other. When '**' is used for a path segment in the pattern, it matches + zero or more path segments of the name. +

    + There is a special case regarding the use of File.separators + at the beginning of the pattern and the string to match:
    + When a pattern starts with a File.separator, the string + to match must also start with a File.separator. + When a pattern does not start with a File.separator, the + string to match may not start with a File.separator. + When one of these rules is not obeyed, the string will not + match. +

    + When a name path segment is matched against a pattern path segment, the + following special characters can be used:
    + '*' matches zero or more characters
    + '?' matches one character. +

    + Examples: +

    + "**\*.class" matches all .class files/dirs in a directory tree. +

    + "test\a??.java" matches all files/dirs which start with an 'a', then two + more characters and then ".java", in a directory called test. +

    + "**" matches everything in a directory tree. +

    + "**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where + there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123"). +

    + Case sensitivity may be turned off if necessary. By default, it is + turned on. +

    + Example of usage: + 

    +   String[] includes = {"*\*\*.class"};
+   String[] excludes = {"modules\\\*\**"};
+   ds.setIncludes(includes);
+   ds.setExcludes(excludes);
+   ds.setBasedir(new File("test"));
+   ds.setCaseSensitive(true);
+   ds.scan();
+
+   System.out.println("FILES:");
+   String[] files = ds.getIncludedFiles();
+   for (int i = 0; i < files.length; i++) {
+     System.out.println(files[i]);
+   }
+
    + This will scan a directory called test for .class files, but excludes all + files in all proper subdirectories of a directory called "modules" +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.Filebasedir + +
    +          The base directory to be scanned.
    +protected static java.lang.String[]DEFAULTEXCLUDES + +
    +          Deprecated. since 1.6.x. + Use the getDefaultExcludes + method instead.
    +protected  java.util.VectordirsDeselected + +
    +          The directories which matched at least one include and no excludes + but which a selector discarded.
    +protected  java.util.VectordirsExcluded + +
    +          The directories which matched at least one include and at least one + exclude.
    +protected  java.util.VectordirsIncluded + +
    +          The directories which matched at least one include and no excludes + and were selected.
    +protected  java.util.VectordirsNotIncluded + +
    +          The directories which were found and did not match any includes.
    +static java.lang.StringDOES_NOT_EXIST_POSTFIX + +
    +          The end of the exception message if something that should be + there doesn't exist.
    +protected  booleanerrorOnMissingDir + +
    +          Whether a missing base directory is an error.
    +protected  booleaneverythingIncluded + +
    +          Whether or not everything tested so far has been included.
    +protected  java.lang.String[]excludes + +
    +          The patterns for the files to be excluded.
    +protected  java.util.VectorfilesDeselected + +
    +          The files which matched at least one include and no excludes and + which a selector discarded.
    +protected  java.util.VectorfilesExcluded + +
    +          The files which matched at least one include and at least + one exclude.
    +protected  java.util.VectorfilesIncluded + +
    +          The files which matched at least one include and no excludes + and were selected.
    +protected  java.util.VectorfilesNotIncluded + +
    +          The files which did not match any includes or selectors.
    +protected  booleanhaveSlowResults + +
    +          Whether or not our results were built by a slow scan.
    +protected  java.lang.String[]includes + +
    +          The patterns for the files to be included.
    +protected  booleanisCaseSensitive + +
    +          Whether or not the file system should be treated as a case sensitive + one.
    +static intMAX_LEVELS_OF_SYMLINKS + +
    +          default value for maxLevelsOfSymlinks
    +protected  FileSelector[]selectors + +
    +          Selectors that will filter which files are in our candidate list.
    +  + + + + + + + + + + +
    +Constructor Summary
    DirectoryScanner() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static booleanaddDefaultExclude(java.lang.String s) + +
    +          Add a pattern to the default excludes unless it is already a + default exclude.
    + voidaddDefaultExcludes() + +
    +          Add default exclusions to the current exclusions set.
    + voidaddExcludes(java.lang.String[] excludes) + +
    +          Add to the list of exclude patterns to use.
    +protected  voidclearResults() + +
    +          Clear the result caches for a scan.
    +protected  booleancouldHoldIncluded(java.lang.String name) + +
    +          Test whether or not a name matches the start of at least one include + pattern.
    + java.io.FilegetBasedir() + +
    +          Return the base directory to be scanned.
    +static java.lang.String[]getDefaultExcludes() + +
    +          Get the list of patterns that should be excluded by default.
    + java.lang.String[]getDeselectedDirectories() + +
    +          Return the names of the directories which were selected out and + therefore not ultimately included.
    + java.lang.String[]getDeselectedFiles() + +
    +          Return the names of the files which were selected out and + therefore not ultimately included.
    + java.lang.String[]getExcludedDirectories() + +
    +          Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.
    + java.lang.String[]getExcludedFiles() + +
    +          Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.
    + java.lang.String[]getIncludedDirectories() + +
    +          Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
    + intgetIncludedDirsCount() + +
    +          Return the count of included directories.
    + java.lang.String[]getIncludedFiles() + +
    +          Return the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
    + intgetIncludedFilesCount() + +
    +          Return the count of included files.
    + java.lang.String[]getNotFollowedSymlinks() + +
    +          Absolute paths of all symbolic links that haven't been followed + but would have been followed had followsymlinks been true or + maxLevelsOfSymlinks been bigger.
    + java.lang.String[]getNotIncludedDirectories() + +
    +          Return the names of the directories which matched none of the include + patterns.
    + java.lang.String[]getNotIncludedFiles() + +
    +          Return the names of the files which matched none of the include + patterns.
    + ResourcegetResource(java.lang.String name) + +
    +          Get the named resource.
    + booleanisCaseSensitive() + +
    +          Find out whether include exclude patterns are matched in a + case sensitive way.
    + booleanisEverythingIncluded() + +
    +          Return whether or not the scanner has included all the files or + directories it has come across so far.
    +protected  booleanisExcluded(java.lang.String name) + +
    +          Test whether or not a name matches against at least one exclude + pattern.
    + booleanisFollowSymlinks() + +
    +          Get whether or not a DirectoryScanner follows symbolic links.
    +protected  booleanisIncluded(java.lang.String name) + +
    +          Test whether or not a name matches against at least one include + pattern.
    +protected  booleanisSelected(java.lang.String name, + java.io.File file) + +
    +          Test whether a file should be selected.
    +static booleanmatch(java.lang.String pattern, + java.lang.String str) + +
    +          Test whether or not a string matches against a pattern.
    +protected static booleanmatch(java.lang.String pattern, + java.lang.String str, + boolean isCaseSensitive) + +
    +          Test whether or not a string matches against a pattern.
    +protected static booleanmatchPath(java.lang.String pattern, + java.lang.String str) + +
    +          Test whether or not a given path matches a given pattern.
    +protected static booleanmatchPath(java.lang.String pattern, + java.lang.String str, + boolean isCaseSensitive) + +
    +          Test whether or not a given path matches a given pattern.
    +protected static booleanmatchPatternStart(java.lang.String pattern, + java.lang.String str) + +
    +          Test whether or not a given path matches the start of a given + pattern up to the first "**".
    +protected static booleanmatchPatternStart(java.lang.String pattern, + java.lang.String str, + boolean isCaseSensitive) + +
    +          Test whether or not a given path matches the start of a given + pattern up to the first "**".
    +static booleanremoveDefaultExclude(java.lang.String s) + +
    +          Remove a string if it is a default exclude.
    +static voidresetDefaultExcludes() + +
    +          Go back to the hardwired default exclude patterns.
    + voidscan() + +
    +          Scan for files which match at least one include pattern and don't match + any exclude patterns.
    +protected  voidscandir(java.io.File dir, + java.lang.String vpath, + boolean fast) + +
    +          Scan the given directory for files and directories.
    + voidsetBasedir(java.io.File basedir) + +
    +          Set the base directory to be scanned.
    + voidsetBasedir(java.lang.String basedir) + +
    +          Set the base directory to be scanned.
    + voidsetCaseSensitive(boolean isCaseSensitive) + +
    +          Set whether or not include and exclude patterns are matched + in a case sensitive way.
    + voidsetErrorOnMissingDir(boolean errorOnMissingDir) + +
    +          Sets whether or not a missing base directory is an error
    + voidsetExcludes(java.lang.String[] excludes) + +
    +          Set the list of exclude patterns to use.
    + voidsetFollowSymlinks(boolean followSymlinks) + +
    +          Set whether or not symbolic links should be followed.
    + voidsetIncludes(java.lang.String[] includes) + +
    +          Set the list of include patterns to use.
    + voidsetMaxLevelsOfSymlinks(int max) + +
    +          The maximum number of times a symbolic link may be followed + during a scan.
    + voidsetSelectors(FileSelector[] selectors) + +
    +          Set the selectors that will select the filelist.
    +protected  voidslowScan() + +
    +          Top level invocation for a slow scan.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULTEXCLUDES

    +
    +protected static final java.lang.String[] DEFAULTEXCLUDES
    +
    +
    Deprecated. since 1.6.x. + Use the getDefaultExcludes + method instead.
    Patterns which should be excluded by default. + +

    Note that you can now add patterns to the list of default + excludes. Added patterns will not become part of this array + that has only been kept around for backwards compatibility + reasons.

    +

    +

    +
    +
    +
    + +

    +MAX_LEVELS_OF_SYMLINKS

    +
    +public static final int MAX_LEVELS_OF_SYMLINKS
    +
    +
    default value for maxLevelsOfSymlinks +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DOES_NOT_EXIST_POSTFIX

    +
    +public static final java.lang.String DOES_NOT_EXIST_POSTFIX
    +
    +
    The end of the exception message if something that should be + there doesn't exist. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +basedir

    +
    +protected java.io.File basedir
    +
    +
    The base directory to be scanned. +

    +

    +
    +
    +
    + +

    +includes

    +
    +protected java.lang.String[] includes
    +
    +
    The patterns for the files to be included. +

    +

    +
    +
    +
    + +

    +excludes

    +
    +protected java.lang.String[] excludes
    +
    +
    The patterns for the files to be excluded. +

    +

    +
    +
    +
    + +

    +selectors

    +
    +protected FileSelector[] selectors
    +
    +
    Selectors that will filter which files are in our candidate list. +

    +

    +
    +
    +
    + +

    +filesIncluded

    +
    +protected java.util.Vector filesIncluded
    +
    +
    The files which matched at least one include and no excludes + and were selected. +

    +

    +
    +
    +
    + +

    +filesNotIncluded

    +
    +protected java.util.Vector filesNotIncluded
    +
    +
    The files which did not match any includes or selectors. +

    +

    +
    +
    +
    + +

    +filesExcluded

    +
    +protected java.util.Vector filesExcluded
    +
    +
    The files which matched at least one include and at least + one exclude. +

    +

    +
    +
    +
    + +

    +dirsIncluded

    +
    +protected java.util.Vector dirsIncluded
    +
    +
    The directories which matched at least one include and no excludes + and were selected. +

    +

    +
    +
    +
    + +

    +dirsNotIncluded

    +
    +protected java.util.Vector dirsNotIncluded
    +
    +
    The directories which were found and did not match any includes. +

    +

    +
    +
    +
    + +

    +dirsExcluded

    +
    +protected java.util.Vector dirsExcluded
    +
    +
    The directories which matched at least one include and at least one + exclude. +

    +

    +
    +
    +
    + +

    +filesDeselected

    +
    +protected java.util.Vector filesDeselected
    +
    +
    The files which matched at least one include and no excludes and + which a selector discarded. +

    +

    +
    +
    +
    + +

    +dirsDeselected

    +
    +protected java.util.Vector dirsDeselected
    +
    +
    The directories which matched at least one include and no excludes + but which a selector discarded. +

    +

    +
    +
    +
    + +

    +haveSlowResults

    +
    +protected boolean haveSlowResults
    +
    +
    Whether or not our results were built by a slow scan. +

    +

    +
    +
    +
    + +

    +isCaseSensitive

    +
    +protected boolean isCaseSensitive
    +
    +
    Whether or not the file system should be treated as a case sensitive + one. +

    +

    +
    +
    +
    + +

    +errorOnMissingDir

    +
    +protected boolean errorOnMissingDir
    +
    +
    Whether a missing base directory is an error. +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    + +

    +everythingIncluded

    +
    +protected boolean everythingIncluded
    +
    +
    Whether or not everything tested so far has been included. +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +DirectoryScanner

    +
    +public DirectoryScanner()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +matchPatternStart

    +
    +protected static boolean matchPatternStart(java.lang.String pattern,
+                                           java.lang.String str)
    +
    +
    Test whether or not a given path matches the start of a given + pattern up to the first "**". +

    + This is not a general purpose test and should only be used if you + can live with false positives. For example, pattern=**\a + and str=b will yield true. +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. Must not be + null.
    str - The path to match, as a String. Must not be + null. +
    Returns:
    whether or not a given path matches the start of a given + pattern up to the first "**".
    +
    +
    +
    + +

    +matchPatternStart

    +
    +protected static boolean matchPatternStart(java.lang.String pattern,
+                                           java.lang.String str,
+                                           boolean isCaseSensitive)
    +
    +
    Test whether or not a given path matches the start of a given + pattern up to the first "**". +

    + This is not a general purpose test and should only be used if you + can live with false positives. For example, pattern=**\a + and str=b will yield true. +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. Must not be + null.
    str - The path to match, as a String. Must not be + null.
    isCaseSensitive - Whether or not matching should be performed + case sensitively. +
    Returns:
    whether or not a given path matches the start of a given + pattern up to the first "**".
    +
    +
    +
    + +

    +matchPath

    +
    +protected static boolean matchPath(java.lang.String pattern,
+                                   java.lang.String str)
    +
    +
    Test whether or not a given path matches a given pattern. +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. Must not be + null.
    str - The path to match, as a String. Must not be + null. +
    Returns:
    true if the pattern matches against the string, + or false otherwise.
    +
    +
    +
    + +

    +matchPath

    +
    +protected static boolean matchPath(java.lang.String pattern,
+                                   java.lang.String str,
+                                   boolean isCaseSensitive)
    +
    +
    Test whether or not a given path matches a given pattern. +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. Must not be + null.
    str - The path to match, as a String. Must not be + null.
    isCaseSensitive - Whether or not matching should be performed + case sensitively. +
    Returns:
    true if the pattern matches against the string, + or false otherwise.
    +
    +
    +
    + +

    +match

    +
    +public static boolean match(java.lang.String pattern,
+                            java.lang.String str)
    +
    +
    Test whether or not a string matches against a pattern. + The pattern may contain two special characters:
    + '*' means zero or more characters
    + '?' means one and only one character +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. + Must not be null.
    str - The string which must be matched against the pattern. + Must not be null. +
    Returns:
    true if the string matches against the pattern, + or false otherwise.
    +
    +
    +
    + +

    +match

    +
    +protected static boolean match(java.lang.String pattern,
+                               java.lang.String str,
+                               boolean isCaseSensitive)
    +
    +
    Test whether or not a string matches against a pattern. + The pattern may contain two special characters:
    + '*' means zero or more characters
    + '?' means one and only one character +

    +

    +
    +
    +
    +
    Parameters:
    pattern - The pattern to match against. + Must not be null.
    str - The string which must be matched against the pattern. + Must not be null.
    isCaseSensitive - Whether or not matching should be performed + case sensitively. +
    Returns:
    true if the string matches against the pattern, + or false otherwise.
    +
    +
    +
    + +

    +getDefaultExcludes

    +
    +public static java.lang.String[] getDefaultExcludes()
    +
    +
    Get the list of patterns that should be excluded by default. +

    +

    +
    +
    +
    + +
    Returns:
    An array of String based on the current + contents of the defaultExcludes + Set.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addDefaultExclude

    +
    +public static boolean addDefaultExclude(java.lang.String s)
    +
    +
    Add a pattern to the default excludes unless it is already a + default exclude. +

    +

    +
    +
    +
    +
    Parameters:
    s - A string to add as an exclude pattern. +
    Returns:
    true if the string was added; + false if it already existed.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +removeDefaultExclude

    +
    +public static boolean removeDefaultExclude(java.lang.String s)
    +
    +
    Remove a string if it is a default exclude. +

    +

    +
    +
    +
    +
    Parameters:
    s - The string to attempt to remove. +
    Returns:
    true if s was a default + exclude (and thus was removed); + false if s was not + in the default excludes list to begin with.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +resetDefaultExcludes

    +
    +public static void resetDefaultExcludes()
    +
    +
    Go back to the hardwired default exclude patterns. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.lang.String basedir)
    +
    +
    Set the base directory to be scanned. This is the directory which is + scanned recursively. All '/' and '\' characters are replaced by + File.separatorChar, so the separator used need not match + File.separatorChar. +

    +

    +
    Specified by:
    setBasedir in interface FileScanner
    +
    +
    +
    Parameters:
    basedir - The base directory to scan.
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File basedir)
    +
    +
    Set the base directory to be scanned. This is the directory which is + scanned recursively. +

    +

    +
    Specified by:
    setBasedir in interface FileScanner
    +
    +
    +
    Parameters:
    basedir - The base directory for scanning.
    +
    +
    +
    + +

    +getBasedir

    +
    +public java.io.File getBasedir()
    +
    +
    Return the base directory to be scanned. + This is the directory which is scanned recursively. +

    +

    +
    Specified by:
    getBasedir in interface FileScanner
    +
    +
    + +
    Returns:
    the base directory to be scanned.
    +
    +
    +
    + +

    +isCaseSensitive

    +
    +public boolean isCaseSensitive()
    +
    +
    Find out whether include exclude patterns are matched in a + case sensitive way. +

    +

    +
    +
    +
    + +
    Returns:
    whether or not the scanning is case sensitive.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setCaseSensitive

    +
    +public void setCaseSensitive(boolean isCaseSensitive)
    +
    +
    Set whether or not include and exclude patterns are matched + in a case sensitive way. +

    +

    +
    Specified by:
    setCaseSensitive in interface FileScanner
    +
    +
    +
    Parameters:
    isCaseSensitive - whether or not the file system should be + regarded as a case sensitive one.
    +
    +
    +
    + +

    +setErrorOnMissingDir

    +
    +public void setErrorOnMissingDir(boolean errorOnMissingDir)
    +
    +
    Sets whether or not a missing base directory is an error +

    +

    +
    +
    +
    +
    Parameters:
    errorOnMissingDir - whether or not a missing base directory + is an error
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    +
    + +

    +isFollowSymlinks

    +
    +public boolean isFollowSymlinks()
    +
    +
    Get whether or not a DirectoryScanner follows symbolic links. +

    +

    +
    +
    +
    + +
    Returns:
    flag indicating whether symbolic links should be followed.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setFollowSymlinks

    +
    +public void setFollowSymlinks(boolean followSymlinks)
    +
    +
    Set whether or not symbolic links should be followed. +

    +

    +
    +
    +
    +
    Parameters:
    followSymlinks - whether or not symbolic links should be followed.
    +
    +
    +
    + +

    +setMaxLevelsOfSymlinks

    +
    +public void setMaxLevelsOfSymlinks(int max)
    +
    +
    The maximum number of times a symbolic link may be followed + during a scan. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setIncludes

    +
    +public void setIncludes(java.lang.String[] includes)
    +
    +
    Set the list of include patterns to use. All '/' and '\' characters + are replaced by File.separatorChar, so the separator used + need not match File.separatorChar. +

    + When a pattern ends with a '/' or '\', "**" is appended. +

    +

    +
    Specified by:
    setIncludes in interface FileScanner
    +
    +
    +
    Parameters:
    includes - A list of include patterns. + May be null, indicating that all files + should be included. If a non-null + list is given, all elements must be + non-null.
    +
    +
    +
    + +

    +setExcludes

    +
    +public void setExcludes(java.lang.String[] excludes)
    +
    +
    Set the list of exclude patterns to use. All '/' and '\' characters + are replaced by File.separatorChar, so the separator used + need not match File.separatorChar. +

    + When a pattern ends with a '/' or '\', "**" is appended. +

    +

    +
    Specified by:
    setExcludes in interface FileScanner
    +
    +
    +
    Parameters:
    excludes - A list of exclude patterns. + May be null, indicating that no files + should be excluded. If a non-null list is + given, all elements must be non-null.
    +
    +
    +
    + +

    +addExcludes

    +
    +public void addExcludes(java.lang.String[] excludes)
    +
    +
    Add to the list of exclude patterns to use. All '/' and '\' + characters are replaced by File.separatorChar, so + the separator used need not match File.separatorChar. +

    + When a pattern ends with a '/' or '\', "**" is appended. +

    +

    +
    +
    +
    +
    Parameters:
    excludes - A list of exclude patterns. + May be null, in which case the + exclude patterns don't get changed at all.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setSelectors

    +
    +public void setSelectors(FileSelector[] selectors)
    +
    +
    Set the selectors that will select the filelist. +

    +

    +
    Specified by:
    setSelectors in interface SelectorScanner
    +
    +
    +
    Parameters:
    selectors - specifies the selectors to be invoked on a scan.
    +
    +
    +
    + +

    +isEverythingIncluded

    +
    +public boolean isEverythingIncluded()
    +
    +
    Return whether or not the scanner has included all the files or + directories it has come across so far. +

    +

    +
    +
    +
    + +
    Returns:
    true if all files and directories which have + been found so far have been included.
    +
    +
    +
    + +

    +scan

    +
    +public void scan()
+          throws java.lang.IllegalStateException
    +
    +
    Scan for files which match at least one include pattern and don't match + any exclude patterns. If there are selectors then the files must pass + muster there, as well. Scans under basedir, if set; otherwise the + include patterns without leading wildcards specify the absolute paths of + the files that may be included. +

    +

    +
    Specified by:
    scan in interface FileScanner
    +
    +
    + +
    Throws: +
    java.lang.IllegalStateException - if the base directory was set + incorrectly (i.e. if it doesn't exist or isn't a directory).
    +
    +
    +
    + +

    +clearResults

    +
    +protected void clearResults()
    +
    +
    Clear the result caches for a scan. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +slowScan

    +
    +protected void slowScan()
    +
    +
    Top level invocation for a slow scan. A slow scan builds up a full + list of excluded/included files/directories, whereas a fast scan + will only have full results for included files, as it ignores + directories which can't possibly hold any included files/directories. +

    + Returns immediately if a slow scan has already been completed. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +scandir

    +
    +protected void scandir(java.io.File dir,
+                       java.lang.String vpath,
+                       boolean fast)
    +
    +
    Scan the given directory for files and directories. Found files and + directories are placed in their respective collections, based on the + matching of includes, excludes, and the selectors. When a directory + is found, it is scanned recursively. +

    +

    +
    +
    +
    +
    Parameters:
    dir - The directory to scan. Must not be null.
    vpath - The path relative to the base directory (needed to + prevent problems with an absolute path when using + dir). Must not be null.
    fast - Whether or not this call is part of a fast scan.
    See Also:
    filesIncluded, +filesNotIncluded, +filesExcluded, +dirsIncluded, +dirsNotIncluded, +dirsExcluded, +slowScan()
    +
    +
    +
    + +

    +isIncluded

    +
    +protected boolean isIncluded(java.lang.String name)
    +
    +
    Test whether or not a name matches against at least one include + pattern. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name to match. Must not be null. +
    Returns:
    true when the name matches against at least one + include pattern, or false otherwise.
    +
    +
    +
    + +

    +couldHoldIncluded

    +
    +protected boolean couldHoldIncluded(java.lang.String name)
    +
    +
    Test whether or not a name matches the start of at least one include + pattern. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name to match. Must not be null. +
    Returns:
    true when the name matches against the start of at + least one include pattern, or false otherwise.
    +
    +
    +
    + +

    +isExcluded

    +
    +protected boolean isExcluded(java.lang.String name)
    +
    +
    Test whether or not a name matches against at least one exclude + pattern. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name to match. Must not be null. +
    Returns:
    true when the name matches against at least one + exclude pattern, or false otherwise.
    +
    +
    +
    + +

    +isSelected

    +
    +protected boolean isSelected(java.lang.String name,
+                             java.io.File file)
    +
    +
    Test whether a file should be selected. +

    +

    +
    +
    +
    +
    Parameters:
    name - the filename to check for selecting.
    file - the java.io.File object for this filename. +
    Returns:
    false when the selectors says that the file + should not be selected, true otherwise.
    +
    +
    +
    + +

    +getIncludedFiles

    +
    +public java.lang.String[] getIncludedFiles()
    +
    +
    Return the names of the files which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

    +

    +
    Specified by:
    getIncludedFiles in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
    +
    +
    +
    + +

    +getIncludedFilesCount

    +
    +public int getIncludedFilesCount()
    +
    +
    Return the count of included files. +

    +

    +
    +
    +
    + +
    Returns:
    int.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getNotIncludedFiles

    +
    +public java.lang.String[] getNotIncludedFiles()
    +
    +
    Return the names of the files which matched none of the include + patterns. The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed. +

    +

    +
    Specified by:
    getNotIncludedFiles in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the files which matched none of the include + patterns.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getExcludedFiles

    +
    +public java.lang.String[] getExcludedFiles()
    +
    +
    Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed. +

    +

    +
    Specified by:
    getExcludedFiles in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getDeselectedFiles

    +
    +public java.lang.String[] getDeselectedFiles()
    +
    +

    Return the names of the files which were selected out and + therefore not ultimately included.

    + +

    The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.

    +

    +

    +
    Specified by:
    getDeselectedFiles in interface SelectorScanner
    +
    +
    + +
    Returns:
    the names of the files which were deselected.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getIncludedDirectories

    +
    +public java.lang.String[] getIncludedDirectories()
    +
    +
    Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

    +

    +
    Specified by:
    getIncludedDirectories in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
    +
    +
    +
    + +

    +getIncludedDirsCount

    +
    +public int getIncludedDirsCount()
    +
    +
    Return the count of included directories. +

    +

    +
    +
    +
    + +
    Returns:
    int.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getNotIncludedDirectories

    +
    +public java.lang.String[] getNotIncludedDirectories()
    +
    +
    Return the names of the directories which matched none of the include + patterns. The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed. +

    +

    +
    Specified by:
    getNotIncludedDirectories in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the directories which matched none of the include + patterns.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getExcludedDirectories

    +
    +public java.lang.String[] getExcludedDirectories()
    +
    +
    Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed. +

    +

    +
    Specified by:
    getExcludedDirectories in interface FileScanner
    +
    +
    + +
    Returns:
    the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getDeselectedDirectories

    +
    +public java.lang.String[] getDeselectedDirectories()
    +
    +

    Return the names of the directories which were selected out and + therefore not ultimately included.

    + +

    The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.

    +

    +

    +
    Specified by:
    getDeselectedDirectories in interface SelectorScanner
    +
    +
    + +
    Returns:
    the names of the directories which were deselected.
    See Also:
    slowScan()
    +
    +
    +
    + +

    +getNotFollowedSymlinks

    +
    +public java.lang.String[] getNotFollowedSymlinks()
    +
    +
    Absolute paths of all symbolic links that haven't been followed + but would have been followed had followsymlinks been true or + maxLevelsOfSymlinks been bigger. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addDefaultExcludes

    +
    +public void addDefaultExcludes()
    +
    +
    Add default exclusions to the current exclusions set. +

    +

    +
    Specified by:
    addDefaultExcludes in interface FileScanner
    +
    +
    +
    +
    +
    +
    + +

    +getResource

    +
    +public Resource getResource(java.lang.String name)
    +
    +
    Get the named resource. +

    +

    +
    Specified by:
    getResource in interface ResourceFactory
    +
    +
    +
    Parameters:
    name - path name of the file relative to the dir attribute. +
    Returns:
    the resource with the given name.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttribute.html new file mode 100644 index 000000000..56156ed33 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttribute.html @@ -0,0 +1,222 @@ + + + + + + +DynamicAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicAttribute

    +
    +
    All Known Subinterfaces:
    DynamicConfigurator
    +
    +
    +
    All Known Implementing Classes:
    MacroInstance, ScriptDefBase, XSLTProcess.Factory.Attribute
    +
    +
    +
    +
    public interface DynamicAttribute
    + + +

    +Enables a task to control unknown attributes +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidsetDynamicAttribute(java.lang.String name, + java.lang.String value) + +
    +          Set a named attribute to the given value
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setDynamicAttribute

    +
    +void setDynamicAttribute(java.lang.String name,
+                         java.lang.String value)
+                         throws BuildException
    +
    +
    Set a named attribute to the given value +

    +

    +
    Parameters:
    name - the name of the attribute
    value - the new value of the attribute +
    Throws: +
    BuildException - when any error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttributeNS.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttributeNS.html new file mode 100644 index 000000000..2ea630e0f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicAttributeNS.html @@ -0,0 +1,227 @@ + + + + + + +DynamicAttributeNS (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicAttributeNS

    +
    +
    All Known Subinterfaces:
    DynamicConfiguratorNS
    +
    +
    +
    All Known Implementing Classes:
    XMLFragment.Child
    +
    +
    +
    +
    public interface DynamicAttributeNS
    + + +

    +Enables a task to control unknown attributes. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidsetDynamicAttribute(java.lang.String uri, + java.lang.String localName, + java.lang.String qName, + java.lang.String value) + +
    +          Set a named attribute to the given value
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setDynamicAttribute

    +
    +void setDynamicAttribute(java.lang.String uri,
+                         java.lang.String localName,
+                         java.lang.String qName,
+                         java.lang.String value)
+                         throws BuildException
    +
    +
    Set a named attribute to the given value +

    +

    +
    Parameters:
    uri - The namespace uri for this attribute, "" is + used if there is no namespace uri.
    localName - The localname of this attribute.
    qName - The qualified name for this attribute
    value - The value of this attribute. +
    Throws: +
    BuildException - when any error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfigurator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfigurator.html new file mode 100644 index 000000000..1c6c79d45 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfigurator.html @@ -0,0 +1,205 @@ + + + + + + +DynamicConfigurator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicConfigurator

    +
    +
    All Superinterfaces:
    DynamicAttribute, DynamicElement
    +
    +
    +
    All Known Implementing Classes:
    ScriptDefBase, XSLTProcess.Factory.Attribute
    +
    +
    +
    +
    public interface DynamicConfigurator
    extends DynamicAttribute, DynamicElement
    + + +

    +Enables a task to control unknown attributes and elements. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.DynamicAttribute
    setDynamicAttribute
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.DynamicElement
    createDynamicElement
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfiguratorNS.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfiguratorNS.html new file mode 100644 index 000000000..b239c6395 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicConfiguratorNS.html @@ -0,0 +1,205 @@ + + + + + + +DynamicConfiguratorNS (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicConfiguratorNS

    +
    +
    All Superinterfaces:
    DynamicAttributeNS, DynamicElementNS
    +
    +
    +
    All Known Implementing Classes:
    XMLFragment.Child
    +
    +
    +
    +
    public interface DynamicConfiguratorNS
    extends DynamicAttributeNS, DynamicElementNS
    + + +

    +Enables a task to control unknown attributes and elements. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.DynamicAttributeNS
    setDynamicAttribute
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.DynamicElementNS
    createDynamicElement
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElement.html new file mode 100644 index 000000000..1de115273 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElement.html @@ -0,0 +1,221 @@ + + + + + + +DynamicElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicElement

    +
    +
    All Known Subinterfaces:
    DynamicConfigurator
    +
    +
    +
    All Known Implementing Classes:
    ScriptDefBase, XSLTProcess.Factory.Attribute
    +
    +
    +
    +
    public interface DynamicElement
    + + +

    +Enables a task to control unknown elements. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectcreateDynamicElement(java.lang.String name) + +
    +          Create an element with the given name
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +createDynamicElement

    +
    +java.lang.Object createDynamicElement(java.lang.String name)
+                                      throws BuildException
    +
    +
    Create an element with the given name +

    +

    +
    Parameters:
    name - the element name +
    Returns:
    the element created +
    Throws: +
    BuildException - when any error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElementNS.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElementNS.html new file mode 100644 index 000000000..6f08bbc6e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/DynamicElementNS.html @@ -0,0 +1,225 @@ + + + + + + +DynamicElementNS (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface DynamicElementNS

    +
    +
    All Known Subinterfaces:
    DynamicConfiguratorNS
    +
    +
    +
    All Known Implementing Classes:
    EchoXML, XMLFragment, XMLFragment.Child
    +
    +
    +
    +
    public interface DynamicElementNS
    + + +

    +Enables a task to control unknown elements. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectcreateDynamicElement(java.lang.String uri, + java.lang.String localName, + java.lang.String qName) + +
    +          Create an element with the given name
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +createDynamicElement

    +
    +java.lang.Object createDynamicElement(java.lang.String uri,
+                                      java.lang.String localName,
+                                      java.lang.String qName)
+                                      throws BuildException
    +
    +
    Create an element with the given name +

    +

    +
    Parameters:
    uri - The namespace uri for this attribute.
    localName - The localname of this attribute.
    qName - The qualified name for this element. +
    Returns:
    the element created for this element. +
    Throws: +
    BuildException - when any error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Executor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Executor.html new file mode 100644 index 000000000..dbc0d624c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Executor.html @@ -0,0 +1,246 @@ + + + + + + +Executor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface Executor

    +
    +
    All Known Implementing Classes:
    DefaultExecutor, IgnoreDependenciesExecutor, SingleCheckExecutor
    +
    +
    +
    +
    public interface Executor
    + + +

    +Target executor abstraction. +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecuteTargets(Project project, + java.lang.String[] targetNames) + +
    +          Execute the specified Targets for the specified Project.
    + ExecutorgetSubProjectExecutor() + +
    +          Get the appropriate subproject Executor instance.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +executeTargets

    +
    +void executeTargets(Project project,
+                    java.lang.String[] targetNames)
+                    throws BuildException
    +
    +
    Execute the specified Targets for the specified Project. +

    +

    +
    Parameters:
    project - the Ant Project.
    targetNames - String[] of Target names as specified on the command line. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getSubProjectExecutor

    +
    +Executor getSubProjectExecutor()
    +
    +
    Get the appropriate subproject Executor instance. + + This allows the top executor to control what type of executor is used to execute + subprojects via // and task that extend these. + All bundled Executors return a SingleCheckExecutor (running a merged set of + depended targets for all targets called) to run sub-builds. +

    +

    + +
    Returns:
    an Executor instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitException.html new file mode 100644 index 000000000..1a1d9742f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitException.html @@ -0,0 +1,298 @@ + + + + + + +ExitException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ExitException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by java.lang.SecurityException
+                  extended by org.apache.tools.ant.ExitException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class ExitException
    extends java.lang.SecurityException
    + + +

    +Used to report exit status of classes which call System.exit(). +

    + +

    +

    +
    See Also:
    NoExitSecurityManager, +Permissions, +Serialized Form
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    ExitException(int status) + +
    +          Constructs an exit exception.
    ExitException(java.lang.String msg, + int status) + +
    +          Constructs an exit exception.
    +  + + + + + + + + + + + +
    +Method Summary
    + intgetStatus() + +
    +          The status code returned by System.exit()
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExitException

    +
    +public ExitException(int status)
    +
    +
    Constructs an exit exception. +

    +

    +
    Parameters:
    status - the status code returned via System.exit()
    +
    +
    + +

    +ExitException

    +
    +public ExitException(java.lang.String msg,
+                     int status)
    +
    +
    Constructs an exit exception. +

    +

    +
    Parameters:
    msg - the message to be displayed.
    status - the status code returned via System.exit()
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getStatus

    +
    +public int getStatus()
    +
    +
    The status code returned by System.exit() +

    +

    + +
    Returns:
    the status code returned by System.exit()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitStatusException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitStatusException.html new file mode 100644 index 000000000..182e4bd4f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExitStatusException.html @@ -0,0 +1,329 @@ + + + + + + +ExitStatusException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ExitStatusException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.apache.tools.ant.BuildException
+                  extended by org.apache.tools.ant.ExitStatusException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class ExitStatusException
    extends BuildException
    + + +

    +BuildException + exit status. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    ExitStatusException(int status) + +
    +          Constructs an ExitStatusException.
    ExitStatusException(java.lang.String msg, + int status) + +
    +          Constructs an ExitStatusException.
    ExitStatusException(java.lang.String message, + int status, + Location location) + +
    +          Construct an exit status exception with location information too
    +  + + + + + + + + + + + +
    +Method Summary
    + intgetStatus() + +
    +          Get the status code.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.BuildException
    getException, getLocation, setLocation, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExitStatusException

    +
    +public ExitStatusException(int status)
    +
    +
    Constructs an ExitStatusException. +

    +

    +
    Parameters:
    status - the associated status code
    +
    +
    + +

    +ExitStatusException

    +
    +public ExitStatusException(java.lang.String msg,
+                           int status)
    +
    +
    Constructs an ExitStatusException. +

    +

    +
    Parameters:
    msg - the associated message
    status - the associated status code
    +
    +
    + +

    +ExitStatusException

    +
    +public ExitStatusException(java.lang.String message,
+                           int status,
+                           Location location)
    +
    +
    Construct an exit status exception with location information too +

    +

    +
    Parameters:
    message - error message
    status - exit status
    location - exit location
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getStatus

    +
    +public int getStatus()
    +
    +
    Get the status code. +

    +

    + +
    Returns:
    int
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExtensionPoint.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExtensionPoint.html new file mode 100644 index 000000000..345a284bf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ExtensionPoint.html @@ -0,0 +1,299 @@ + + + + + + +ExtensionPoint (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ExtensionPoint

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Target
+      extended by org.apache.tools.ant.ExtensionPoint
+
    +
    +
    All Implemented Interfaces:
    TaskContainer
    +
    +
    +
    +
    public class ExtensionPoint
    extends Target
    + + +

    +An extension point build files can provide as a place where other + build files can add new dependencies. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ExtensionPoint() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddDataType(RuntimeConfigurable r) + +
    +          Throws an exception.
    + voidaddTask(Task task) + +
    +          Throws an exception.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Target
    addDependency, dependsOn, execute, getDependencies, getDescription, getIf, getLocation, getName, getProject, getTasks, getUnless, parseDepends, performTasks, setDepends, setDescription, setIf, setLocation, setName, setProject, setUnless, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExtensionPoint

    +
    +public ExtensionPoint()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public final void addTask(Task task)
    +
    +
    Throws an exception. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    Overrides:
    addTask in class Target
    +
    +
    +
    Parameters:
    task - The task to be added. Must not be null.
    +
    +
    +
    + +

    +addDataType

    +
    +public final void addDataType(RuntimeConfigurable r)
    +
    +
    Throws an exception. +

    +

    +
    Overrides:
    addDataType in class Target
    +
    +
    +
    Parameters:
    r - The wrapper for the data type element to be added. + Must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/FileScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/FileScanner.html new file mode 100644 index 000000000..f950b0e76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/FileScanner.html @@ -0,0 +1,535 @@ + + + + + + +FileScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface FileScanner

    +
    +
    All Known Implementing Classes:
    ArchiveScanner, DependScanner, DirectoryScanner, FTP.FTPDirectoryScanner, FTPTaskMirrorImpl.FTPDirectoryScanner, TarScanner, ZipScanner
    +
    +
    +
    +
    public interface FileScanner
    + + +

    +An interface used to describe the actions required of any type of + directory scanner. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddDefaultExcludes() + +
    +          Adds default exclusions to the current exclusions set.
    + java.io.FilegetBasedir() + +
    +          Returns the base directory to be scanned.
    + java.lang.String[]getExcludedDirectories() + +
    +          Returns the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.
    + java.lang.String[]getExcludedFiles() + +
    +          Returns the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.
    + java.lang.String[]getIncludedDirectories() + +
    +          Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
    + java.lang.String[]getIncludedFiles() + +
    +          Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
    + java.lang.String[]getNotIncludedDirectories() + +
    +          Returns the names of the directories which matched none of the include + patterns.
    + java.lang.String[]getNotIncludedFiles() + +
    +          Returns the names of the files which matched none of the include + patterns.
    + voidscan() + +
    +          Scans the base directory for files which match at least one include + pattern and don't match any exclude patterns.
    + voidsetBasedir(java.io.File basedir) + +
    +          Sets the base directory to be scanned.
    + voidsetBasedir(java.lang.String basedir) + +
    +          Sets the base directory to be scanned.
    + voidsetCaseSensitive(boolean isCaseSensitive) + +
    +          Sets whether or not the file system should be regarded as case sensitive.
    + voidsetExcludes(java.lang.String[] excludes) + +
    +          Sets the list of exclude patterns to use.
    + voidsetIncludes(java.lang.String[] includes) + +
    +          Sets the list of include patterns to use.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +addDefaultExcludes

    +
    +void addDefaultExcludes()
    +
    +
    Adds default exclusions to the current exclusions set. +

    +

    +
    +
    +
    +
    + +

    +getBasedir

    +
    +java.io.File getBasedir()
    +
    +
    Returns the base directory to be scanned. + This is the directory which is scanned recursively. +

    +

    + +
    Returns:
    the base directory to be scanned
    +
    +
    +
    + +

    +getExcludedDirectories

    +
    +java.lang.String[] getExcludedDirectories()
    +
    +
    Returns the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.
    +
    +
    +
    + +

    +getExcludedFiles

    +
    +java.lang.String[] getExcludedFiles()
    +
    +
    Returns the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.
    +
    +
    +
    + +

    +getIncludedDirectories

    +
    +java.lang.String[] getIncludedDirectories()
    +
    +
    Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
    +
    +
    +
    + +

    +getIncludedFiles

    +
    +java.lang.String[] getIncludedFiles()
    +
    +
    Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
    +
    +
    +
    + +

    +getNotIncludedDirectories

    +
    +java.lang.String[] getNotIncludedDirectories()
    +
    +
    Returns the names of the directories which matched none of the include + patterns. The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the directories which matched none of the include + patterns.
    +
    +
    +
    + +

    +getNotIncludedFiles

    +
    +java.lang.String[] getNotIncludedFiles()
    +
    +
    Returns the names of the files which matched none of the include + patterns. The names are relative to the base directory. +

    +

    + +
    Returns:
    the names of the files which matched none of the include + patterns.
    +
    +
    +
    + +

    +scan

    +
    +void scan()
+          throws java.lang.IllegalStateException
    +
    +
    Scans the base directory for files which match at least one include + pattern and don't match any exclude patterns. +

    +

    + +
    Throws: +
    java.lang.IllegalStateException - if the base directory was set + incorrectly (i.e. if it is null, doesn't exist, + or isn't a directory).
    +
    +
    +
    + +

    +setBasedir

    +
    +void setBasedir(java.lang.String basedir)
    +
    +
    Sets the base directory to be scanned. This is the directory which is + scanned recursively. All '/' and '\' characters should be replaced by + File.separatorChar, so the separator used need not match + File.separatorChar. +

    +

    +
    Parameters:
    basedir - The base directory to scan. + Must not be null.
    +
    +
    +
    + +

    +setBasedir

    +
    +void setBasedir(java.io.File basedir)
    +
    +
    Sets the base directory to be scanned. This is the directory which is + scanned recursively. +

    +

    +
    Parameters:
    basedir - The base directory for scanning. + Should not be null.
    +
    +
    +
    + +

    +setExcludes

    +
    +void setExcludes(java.lang.String[] excludes)
    +
    +
    Sets the list of exclude patterns to use. +

    +

    +
    Parameters:
    excludes - A list of exclude patterns. + May be null, indicating that no files + should be excluded. If a non-null list is + given, all elements must be non-null.
    +
    +
    +
    + +

    +setIncludes

    +
    +void setIncludes(java.lang.String[] includes)
    +
    +
    Sets the list of include patterns to use. +

    +

    +
    Parameters:
    includes - A list of include patterns. + May be null, indicating that all files + should be included. If a non-null + list is given, all elements must be + non-null.
    +
    +
    +
    + +

    +setCaseSensitive

    +
    +void setCaseSensitive(boolean isCaseSensitive)
    +
    +
    Sets whether or not the file system should be regarded as case sensitive. +

    +

    +
    Parameters:
    isCaseSensitive - whether or not the file system should be + regarded as a case sensitive one
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.Creator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.Creator.html new file mode 100644 index 000000000..06f5be6f8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.Creator.html @@ -0,0 +1,288 @@ + + + + + + +IntrospectionHelper.Creator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class IntrospectionHelper.Creator

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.IntrospectionHelper.Creator
+
    +
    +
    Enclosing class:
    IntrospectionHelper
    +
    +
    +
    +
    public static final class IntrospectionHelper.Creator
    extends java.lang.Object
    + + +

    +creator - allows use of create/store external + to IntrospectionHelper. + The class is final as it has a private constructor. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Objectcreate() + +
    +          Create an object using this creator, which is determined by introspection.
    + java.lang.ObjectgetRealObject() + +
    +           
    + voidsetPolyType(java.lang.String polyType) + +
    +          Used to override the class used to create the object.
    + voidstore() + +
    +          Stores the nested element object using a storage method determined by introspection.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setPolyType

    +
    +public void setPolyType(java.lang.String polyType)
    +
    +
    Used to override the class used to create the object. +

    +

    +
    Parameters:
    polyType - a ant component type name
    +
    +
    +
    + +

    +create

    +
    +public java.lang.Object create()
    +
    +
    Create an object using this creator, which is determined by introspection. +

    +

    + +
    Returns:
    the created object
    +
    +
    +
    + +

    +getRealObject

    +
    +public java.lang.Object getRealObject()
    +
    +
    + +
    Returns:
    the real object (used currently only for presetdef).
    +
    +
    +
    + +

    +store

    +
    +public void store()
    +
    +
    Stores the nested element object using a storage method determined by introspection. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.html new file mode 100644 index 000000000..cf2af2726 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/IntrospectionHelper.html @@ -0,0 +1,1105 @@ + + + + + + +IntrospectionHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class IntrospectionHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.IntrospectionHelper
+
    +
    +
    +
    public final class IntrospectionHelper
    extends java.lang.Object
    + + +

    +Helper class that collects the methods a task or nested element + holds to set attributes, create nested elements or hold PCDATA + elements. + + It contains hashtables containing classes that use introspection + to handle all the invocation of the project-component specific methods. + + This class is somewhat complex, as it implements the O/X mapping between + Ant XML and Java class instances. This is not the best place for someone new + to Ant to start contributing to the codebase, as a change here can break the + entire system in interesting ways. Always run a full test of Ant before checking + in/submitting changes to this file. + + The class is final and has a private constructor. + To get an instance for a specific (class,project) combination, + use getHelper(Project,Class). + This may return an existing version, or a new one + ...do not make any assumptions about its uniqueness, or its validity after the Project + instance has finished its build. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classIntrospectionHelper.Creator + +
    +          creator - allows use of create/store external + to IntrospectionHelper.
    +  + + + + + + + + + + + + + + +
    +Field Summary
    +protected static java.lang.StringNOT_SUPPORTED_CHILD_POSTFIX + +
    +          part of the error message created by throwNotSupported.
    +protected static java.lang.StringNOT_SUPPORTED_CHILD_PREFIX + +
    +          part of the error message created by throwNotSupported.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(Project project, + java.lang.Object element, + java.lang.String text) + +
    +          Adds PCDATA to an element, using the element's + void addText(String) method, if it has one.
    +static voidclearCache() + +
    +          Clears the static cache of on build finished.
    + java.lang.ObjectcreateElement(Project project, + java.lang.Object parent, + java.lang.String elementName) + +
    +          Deprecated. since 1.6.x. + This is not a namespace aware method.
    + java.lang.reflect.MethodgetAddTextMethod() + +
    +          Returns the addText method when the introspected + class supports nested text.
    + java.util.MapgetAttributeMap() + +
    +          Returns a read-only map of attributes supported by the introspected class.
    + java.lang.reflect.MethodgetAttributeMethod(java.lang.String attributeName) + +
    +          Returns the setter method of a named attribute.
    + java.util.EnumerationgetAttributes() + +
    +          Returns an enumeration of the names of the attributes supported by the introspected class.
    + java.lang.ClassgetAttributeType(java.lang.String attributeName) + +
    +          Returns the type of a named attribute.
    + IntrospectionHelper.CreatorgetElementCreator(Project project, + java.lang.String parentUri, + java.lang.Object parent, + java.lang.String elementName, + UnknownElement ue) + +
    +          returns an object that creates and stores an object + for an element of a parent.
    + java.lang.reflect.MethodgetElementMethod(java.lang.String elementName) + +
    +          Returns the adder or creator method of a named nested element.
    + java.lang.ClassgetElementType(java.lang.String elementName) + +
    +          Returns the type of a named nested element.
    + java.util.ListgetExtensionPoints() + +
    +          Returns a read-only list of extension points supported + by the introspected class.
    +static IntrospectionHelpergetHelper(java.lang.Class c) + +
    +          Returns a helper for the given class, either from the cache + or by creating a new instance.
    +static IntrospectionHelpergetHelper(Project p, + java.lang.Class c) + +
    +          Returns a helper for the given class, either from the cache + or by creating a new instance.
    + java.util.MapgetNestedElementMap() + +
    +          Returns a read-only map of nested elements supported + by the introspected class.
    + java.util.EnumerationgetNestedElements() + +
    +          Returns an enumeration of the names of the nested elements supported + by the introspected class.
    + booleanisContainer() + +
    +          Indicates whether the introspected class is a task container, + supporting arbitrary nested tasks/types.
    + booleanisDynamic() + +
    +          Indicates whether the introspected class is a dynamic one, + supporting arbitrary nested elements and/or attributes.
    + voidsetAttribute(Project p, + java.lang.Object element, + java.lang.String attributeName, + java.lang.Object value) + +
    +          Sets the named attribute in the given element, which is part of the + given project.
    + voidsetAttribute(Project p, + java.lang.Object element, + java.lang.String attributeName, + java.lang.String value) + +
    +          Sets the named attribute in the given element, which is part of the + given project.
    + voidstoreElement(Project project, + java.lang.Object parent, + java.lang.Object child, + java.lang.String elementName) + +
    +          Stores a named nested element using a storage method determined + by the initial introspection.
    + booleansupportsCharacters() + +
    +          Returns whether or not the introspected class supports PCDATA.
    + booleansupportsNestedElement(java.lang.String elementName) + +
    +          Indicates if this element supports a nested element of the + given name.
    + booleansupportsNestedElement(java.lang.String parentUri, + java.lang.String elementName) + +
    +          Indicate if this element supports a nested element of the + given name.
    + booleansupportsNestedElement(java.lang.String parentUri, + java.lang.String elementName, + Project project, + java.lang.Object parent) + +
    +          Indicate if this element supports a nested element of the + given name.
    + booleansupportsReflectElement(java.lang.String parentUri, + java.lang.String elementName) + +
    +          Check if this element supports a nested element from reflection.
    + voidthrowNotSupported(Project project, + java.lang.Object parent, + java.lang.String elementName) + +
    +          Utility method to throw a NotSupported exception
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NOT_SUPPORTED_CHILD_PREFIX

    +
    +protected static final java.lang.String NOT_SUPPORTED_CHILD_PREFIX
    +
    +
    part of the error message created by throwNotSupported. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NOT_SUPPORTED_CHILD_POSTFIX

    +
    +protected static final java.lang.String NOT_SUPPORTED_CHILD_POSTFIX
    +
    +
    part of the error message created by throwNotSupported. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getHelper

    +
    +public static IntrospectionHelper getHelper(java.lang.Class c)
    +
    +
    Returns a helper for the given class, either from the cache + or by creating a new instance. +

    +

    +
    Parameters:
    c - The class for which a helper is required. + Must not be null. +
    Returns:
    a helper for the specified class
    +
    +
    +
    + +

    +getHelper

    +
    +public static IntrospectionHelper getHelper(Project p,
+                                            java.lang.Class c)
    +
    +
    Returns a helper for the given class, either from the cache + or by creating a new instance. + + The method will make sure the helper will be cleaned up at the end of + the project, and only one instance will be created for each class. +

    +

    +
    Parameters:
    p - the project instance. Can be null, in which case the helper is not cached.
    c - The class for which a helper is required. + Must not be null. +
    Returns:
    a helper for the specified class
    +
    +
    +
    + +

    +setAttribute

    +
    +public void setAttribute(Project p,
+                         java.lang.Object element,
+                         java.lang.String attributeName,
+                         java.lang.Object value)
+                  throws BuildException
    +
    +
    Sets the named attribute in the given element, which is part of the + given project. +

    +

    +
    Parameters:
    p - The project containing the element. This is used when files + need to be resolved. Must not be null.
    element - The element to set the attribute in. Must not be + null.
    attributeName - The name of the attribute to set. Must not be + null.
    value - The value to set the attribute to. This may be interpreted + or converted to the necessary type if the setter method + doesn't accept an object of the supplied type. +
    Throws: +
    BuildException - if the introspected class doesn't support + the given attribute, or if the setting + method fails.
    +
    +
    +
    + +

    +setAttribute

    +
    +public void setAttribute(Project p,
+                         java.lang.Object element,
+                         java.lang.String attributeName,
+                         java.lang.String value)
+                  throws BuildException
    +
    +
    Sets the named attribute in the given element, which is part of the + given project. +

    +

    +
    Parameters:
    p - The project containing the element. This is used when files + need to be resolved. Must not be null.
    element - The element to set the attribute in. Must not be + null.
    attributeName - The name of the attribute to set. Must not be + null.
    value - The value to set the attribute to. This may be interpreted + or converted to the necessary type if the setter method + doesn't just take a string. Must not be null. +
    Throws: +
    BuildException - if the introspected class doesn't support + the given attribute, or if the setting + method fails.
    +
    +
    +
    + +

    +addText

    +
    +public void addText(Project project,
+                    java.lang.Object element,
+                    java.lang.String text)
+             throws BuildException
    +
    +
    Adds PCDATA to an element, using the element's + void addText(String) method, if it has one. If no + such method is present, a BuildException is thrown if the + given text contains non-whitespace. +

    +

    +
    Parameters:
    project - The project which the element is part of. + Must not be null.
    element - The element to add the text to. + Must not be null.
    text - The text to add. + Must not be null. +
    Throws: +
    BuildException - if non-whitespace text is provided and no + method is available to handle it, or if + the handling method fails.
    +
    +
    +
    + +

    +throwNotSupported

    +
    +public void throwNotSupported(Project project,
+                              java.lang.Object parent,
+                              java.lang.String elementName)
    +
    +
    Utility method to throw a NotSupported exception +

    +

    +
    Parameters:
    project - the Project instance.
    parent - the object which doesn't support a requested element
    elementName - the name of the Element which is trying to be created.
    +
    +
    +
    + +

    +createElement

    +
    +public java.lang.Object createElement(Project project,
+                                      java.lang.Object parent,
+                                      java.lang.String elementName)
+                               throws BuildException
    +
    +
    Deprecated. since 1.6.x. + This is not a namespace aware method. +

    +

    Creates a named nested element. Depending on the results of the + initial introspection, either a method in the given parent instance + or a simple no-arg constructor is used to create an instance of the + specified element type. +

    +

    +
    Parameters:
    project - Project to which the parent object belongs. + Must not be null. If the resulting + object is an instance of ProjectComponent, its + Project reference is set to this parameter value.
    parent - Parent object used to create the instance. + Must not be null.
    elementName - Name of the element to create an instance of. + Must not be null. +
    Returns:
    an instance of the specified element type +
    Throws: +
    BuildException - if no method is available to create the + element instance, or if the creating method fails.
    +
    +
    +
    + +

    +getElementCreator

    +
    +public IntrospectionHelper.Creator getElementCreator(Project project,
+                                                     java.lang.String parentUri,
+                                                     java.lang.Object parent,
+                                                     java.lang.String elementName,
+                                                     UnknownElement ue)
    +
    +
    returns an object that creates and stores an object + for an element of a parent. +

    +

    +
    Parameters:
    project - Project to which the parent object belongs.
    parentUri - The namespace uri of the parent object.
    parent - Parent object used to create the creator object to + create and store and instance of a subelement.
    elementName - Name of the element to create an instance of.
    ue - The unknown element associated with the element. +
    Returns:
    a creator object to create and store the element instance.
    +
    +
    +
    + +

    +isDynamic

    +
    +public boolean isDynamic()
    +
    +
    Indicates whether the introspected class is a dynamic one, + supporting arbitrary nested elements and/or attributes. +

    +

    + +
    Returns:
    true if the introspected class is dynamic; + false otherwise.
    Since:
    +
    Ant 1.6.3
    +
    See Also:
    DynamicElement, +DynamicElementNS
    +
    +
    +
    + +

    +isContainer

    +
    +public boolean isContainer()
    +
    +
    Indicates whether the introspected class is a task container, + supporting arbitrary nested tasks/types. +

    +

    + +
    Returns:
    true if the introspected class is a container; + false otherwise.
    Since:
    +
    Ant 1.6.3
    +
    See Also:
    TaskContainer
    +
    +
    +
    + +

    +supportsNestedElement

    +
    +public boolean supportsNestedElement(java.lang.String elementName)
    +
    +
    Indicates if this element supports a nested element of the + given name. +

    +

    +
    Parameters:
    elementName - the name of the nested element being checked +
    Returns:
    true if the given nested element is supported
    +
    +
    +
    + +

    +supportsNestedElement

    +
    +public boolean supportsNestedElement(java.lang.String parentUri,
+                                     java.lang.String elementName)
    +
    +
    Indicate if this element supports a nested element of the + given name. + +

    Note that this method will always return true if the + introspected class is dynamic or contains a + method named "add" with void return type and a single argument. + To ge a more thorough answer, use the four-arg version of this + method instead.

    +

    +

    +
    Parameters:
    parentUri - the uri of the parent
    elementName - the name of the nested element being checked +
    Returns:
    true if the given nested element is supported
    +
    +
    +
    + +

    +supportsNestedElement

    +
    +public boolean supportsNestedElement(java.lang.String parentUri,
+                                     java.lang.String elementName,
+                                     Project project,
+                                     java.lang.Object parent)
    +
    +
    Indicate if this element supports a nested element of the + given name. + +

    Note that this method will always return true if the + introspected class is dynamic, so be + prepared to catch an exception about unsupported children when + calling getElementCreator.

    +

    +

    +
    Parameters:
    parentUri - the uri of the parent
    elementName - the name of the nested element being checked
    project - currently executing project instance
    parent - the parent element +
    Returns:
    true if the given nested element is supported
    Since:
    +
    Ant 1.8.0.
    +
    +
    +
    +
    + +

    +supportsReflectElement

    +
    +public boolean supportsReflectElement(java.lang.String parentUri,
+                                      java.lang.String elementName)
    +
    +
    Check if this element supports a nested element from reflection. +

    +

    +
    Parameters:
    parentUri - the uri of the parent
    elementName - the name of the nested element being checked +
    Returns:
    true if the given nested element is supported
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +storeElement

    +
    +public void storeElement(Project project,
+                         java.lang.Object parent,
+                         java.lang.Object child,
+                         java.lang.String elementName)
+                  throws BuildException
    +
    +
    Stores a named nested element using a storage method determined + by the initial introspection. If no appropriate storage method + is available, this method returns immediately. +

    +

    +
    Parameters:
    project - Ignored in this implementation. + May be null.
    parent - Parent instance to store the child in. + Must not be null.
    child - Child instance to store in the parent. + Should not be null.
    elementName - Name of the child element to store. + May be null, in which case + this method returns immediately. +
    Throws: +
    BuildException - if the storage method fails.
    +
    +
    +
    + +

    +getElementType

    +
    +public java.lang.Class getElementType(java.lang.String elementName)
+                               throws BuildException
    +
    +
    Returns the type of a named nested element. +

    +

    +
    Parameters:
    elementName - The name of the element to find the type of. + Must not be null. +
    Returns:
    the type of the nested element with the specified name. + This will never be null. +
    Throws: +
    BuildException - if the introspected class does not + support the named nested element.
    +
    +
    +
    + +

    +getAttributeType

    +
    +public java.lang.Class getAttributeType(java.lang.String attributeName)
+                                 throws BuildException
    +
    +
    Returns the type of a named attribute. +

    +

    +
    Parameters:
    attributeName - The name of the attribute to find the type of. + Must not be null. +
    Returns:
    the type of the attribute with the specified name. + This will never be null. +
    Throws: +
    BuildException - if the introspected class does not + support the named attribute.
    +
    +
    +
    + +

    +getAddTextMethod

    +
    +public java.lang.reflect.Method getAddTextMethod()
+                                          throws BuildException
    +
    +
    Returns the addText method when the introspected + class supports nested text. +

    +

    + +
    Returns:
    the method on this introspected class that adds nested text. + Cannot be null. +
    Throws: +
    BuildException - if the introspected class does not + support the nested text.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getElementMethod

    +
    +public java.lang.reflect.Method getElementMethod(java.lang.String elementName)
+                                          throws BuildException
    +
    +
    Returns the adder or creator method of a named nested element. +

    +

    +
    Parameters:
    elementName - The name of the attribute to find the setter + method of. Must not be null. +
    Returns:
    the method on this introspected class that adds or creates this + nested element. Can be null when the introspected + class is a dynamic configurator! +
    Throws: +
    BuildException - if the introspected class does not + support the named nested element.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getAttributeMethod

    +
    +public java.lang.reflect.Method getAttributeMethod(java.lang.String attributeName)
+                                            throws BuildException
    +
    +
    Returns the setter method of a named attribute. +

    +

    +
    Parameters:
    attributeName - The name of the attribute to find the setter + method of. Must not be null. +
    Returns:
    the method on this introspected class that sets this attribute. + This will never be null. +
    Throws: +
    BuildException - if the introspected class does not + support the named attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +supportsCharacters

    +
    +public boolean supportsCharacters()
    +
    +
    Returns whether or not the introspected class supports PCDATA. +

    +

    + +
    Returns:
    whether or not the introspected class supports PCDATA.
    +
    +
    +
    + +

    +getAttributes

    +
    +public java.util.Enumeration getAttributes()
    +
    +
    Returns an enumeration of the names of the attributes supported by the introspected class. +

    +

    + +
    Returns:
    an enumeration of the names of the attributes supported by the introspected class.
    See Also:
    getAttributeMap()
    +
    +
    +
    + +

    +getAttributeMap

    +
    +public java.util.Map getAttributeMap()
    +
    +
    Returns a read-only map of attributes supported by the introspected class. +

    +

    + +
    Returns:
    an attribute name to attribute Class + unmodifiable map. Can be empty, but never null.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getNestedElements

    +
    +public java.util.Enumeration getNestedElements()
    +
    +
    Returns an enumeration of the names of the nested elements supported + by the introspected class. +

    +

    + +
    Returns:
    an enumeration of the names of the nested elements supported + by the introspected class.
    See Also:
    getNestedElementMap()
    +
    +
    +
    + +

    +getNestedElementMap

    +
    +public java.util.Map getNestedElementMap()
    +
    +
    Returns a read-only map of nested elements supported + by the introspected class. +

    +

    + +
    Returns:
    a nested-element name to nested-element Class + unmodifiable map. Can be empty, but never null.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getExtensionPoints

    +
    +public java.util.List getExtensionPoints()
    +
    +
    Returns a read-only list of extension points supported + by the introspected class. +

    + A task/type or nested element with void methods named add() + or addConfigured(), taking a single class or interface + argument, supports extensions point. This method returns the list of + all these void add[Configured](type) methods. +

    +

    + +
    Returns:
    a list of void, single argument add() or addConfigured() + Methods of all supported extension points. + These methods are sorted such that if the argument type of a + method derives from another type also an argument of a method + of this list, the method with the most derived argument will + always appear first. Can be empty, but never null.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +clearCache

    +
    +public static void clearCache()
    +
    +
    Clears the static cache of on build finished. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Location.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Location.html new file mode 100644 index 000000000..f103e31ab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Location.html @@ -0,0 +1,494 @@ + + + + + + +Location (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Location

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Location
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class Location
    extends java.lang.Object
    implements java.io.Serializable
    + + +

    +Stores the location of a piece of text within a file (file name, + line number and column number). Note that the column number is + currently ignored. +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static LocationUNKNOWN_LOCATION + +
    +          Location to use when one is needed but no information is available
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    Location(org.xml.sax.Locator loc) + +
    +          Creates a location from the SAX locator using the system ID as + the filename.
    Location(java.lang.String fileName) + +
    +          Creates a location consisting of a file name but no line number or + column number.
    Location(java.lang.String fileName, + int lineNumber, + int columnNumber) + +
    +          Creates a location consisting of a file name, line number and + column number.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object other) + +
    +          Equality operation.
    + intgetColumnNumber() + +
    +           
    + java.lang.StringgetFileName() + +
    +           
    + intgetLineNumber() + +
    +           
    + inthashCode() + +
    +          Hash operation.
    + java.lang.StringtoString() + +
    +          Returns the file name, line number, a colon and a trailing space.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +UNKNOWN_LOCATION

    +
    +public static final Location UNKNOWN_LOCATION
    +
    +
    Location to use when one is needed but no information is available +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Location

    +
    +public Location(java.lang.String fileName)
    +
    +
    Creates a location consisting of a file name but no line number or + column number. +

    +

    +
    Parameters:
    fileName - The name of the file. May be null, + in which case the location is equivalent to + UNKNOWN_LOCATION.
    +
    +
    + +

    +Location

    +
    +public Location(org.xml.sax.Locator loc)
    +
    +
    Creates a location from the SAX locator using the system ID as + the filename. +

    +

    +
    Parameters:
    loc - Must not be null.
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +

    +Location

    +
    +public Location(java.lang.String fileName,
+                int lineNumber,
+                int columnNumber)
    +
    +
    Creates a location consisting of a file name, line number and + column number. +

    +

    +
    Parameters:
    fileName - The name of the file. May be null, + in which case the location is equivalent to + UNKNOWN_LOCATION.
    lineNumber - Line number within the file. Use 0 for unknown + positions within a file.
    columnNumber - Column number within the line.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getFileName

    +
    +public java.lang.String getFileName()
    +
    +
    +
    +
    +
    + +
    Returns:
    the filename portion of the location
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getLineNumber

    +
    +public int getLineNumber()
    +
    +
    +
    +
    +
    + +
    Returns:
    the line number
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getColumnNumber

    +
    +public int getColumnNumber()
    +
    +
    +
    +
    +
    + +
    Returns:
    the column number
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Returns the file name, line number, a colon and a trailing space. + An error message can be appended easily. For unknown locations, an + empty string is returned. +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a String of the form "fileName:lineNumber: " + if both file name and line number are known, + "fileName: " if only the file name is known, + and the empty string for unknown locations.
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object other)
    +
    +
    Equality operation. +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    other - the object to compare to. +
    Returns:
    true if the other object contains the same information + as this object.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    Hash operation. +

    +

    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hash code value for this location.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/MagicNames.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/MagicNames.html new file mode 100644 index 000000000..d5e93158a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/MagicNames.html @@ -0,0 +1,928 @@ + + + + + + +MagicNames (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class MagicNames

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.MagicNames
+
    +
    +
    +
    public final class MagicNames
    extends java.lang.Object
    + + +

    +Magic names used within Ant. + + Not all magic names are here yet. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringANT_EXECUTOR_CLASSNAME + +
    +          Property defining the classname of an executor.
    +static java.lang.StringANT_EXECUTOR_REFERENCE + +
    +          Reference to the current Ant executor.
    +static java.lang.StringANT_FILE + +
    +          property for ant file name.
    +static java.lang.StringANT_FILE_TYPE + +
    +          property for type of ant build file (either file or url) + Value: "ant.file.type"
    +static java.lang.StringANT_FILE_TYPE_FILE + +
    +          ant build file of type file + Value: "file"
    +static java.lang.StringANT_FILE_TYPE_URL + +
    +          ant build file of type url + Value: "url"
    +static java.lang.StringANT_HOME + +
    +          Property used to store the location of ant.
    +static java.lang.StringANT_JAVA_VERSION + +
    +          Property used to store the java version ant is running in.
    +static java.lang.StringANT_LIB + +
    +          Property used to store the location of the ant library (typically the ant.jar file.) + Value: "ant.core.lib"
    +static java.lang.StringANT_VERSION + +
    +          Ant version property.
    +static java.lang.StringANTLIB_PREFIX + +
    +          prefix for antlib URIs: + "antlib:"
    +static java.lang.StringBUILD_JAVAC_SOURCE + +
    +          property that provides the default value for javac's and + javadoc's source attribute.
    +static java.lang.StringBUILD_JAVAC_TARGET + +
    +          property that provides the default value for javac's target attribute.
    +static java.lang.StringBUILD_SYSCLASSPATH + +
    +          System classpath policy.
    +static java.lang.StringPROJECT_BASEDIR + +
    +          property name for basedir of the project.
    +static java.lang.StringPROJECT_DEFAULT_TARGET + +
    +          Name of the property holding the default target of the + currently executing project, if one has been specified.
    +static java.lang.StringPROJECT_HELPER_CLASS + +
    +          Name of JVM system property which provides the name of the ProjectHelper class to use.
    +static java.lang.StringPROJECT_HELPER_SERVICE + +
    +          The service identifier in jars which provide ProjectHelper implementations.
    +static java.lang.StringPROJECT_INVOKED_TARGETS + +
    +          Name of the property holding a comma separated list of targets + that have been invoked (from the command line).
    +static java.lang.StringPROJECT_NAME + +
    +          Name of the property holding the name of the currently + executing project, if one has been specified.
    +static java.lang.StringREFID_CLASSPATH_LOADER_PREFIX + +
    +          Prefix used to store classloader references.
    +static java.lang.StringREFID_CLASSPATH_REUSE_LOADER + +
    +          Name of the magic property that controls classloader reuse.
    +static java.lang.StringREFID_LOCAL_PROPERTIES + +
    +          Reference used to store the local properties.
    +static java.lang.StringREFID_PROJECT_HELPER + +
    +          Name of ProjectHelper reference that we add to a project.
    +static java.lang.StringREFID_PROPERTY_HELPER + +
    +          Reference used to store the property helper.
    +static java.lang.StringREGEXP_IMPL + +
    +          property for regular expression implementation.
    +static java.lang.StringREPOSITORY_DIR_PROPERTY + +
    +          Name of the property which can provide an override of the repository dir.
    +static java.lang.StringREPOSITORY_URL_PROPERTY + +
    +          Name of the property which can provide an override of the repository URL.
    +static java.lang.StringSCRIPT_REPOSITORY + +
    +          The name of the script repository used by the script repo task.
    +static java.lang.StringSYSTEM_LOADER_REF + +
    +          The name of the reference to the System Class Loader.
    +static java.lang.StringTASKDEF_PROPERTIES_RESOURCE + +
    +          name of the resource that taskdefs are stored under.
    +static java.lang.StringTYPEDEFS_PROPERTIES_RESOURCE + +
    +          name of the resource that typedefs are stored under.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ANTLIB_PREFIX

    +
    +public static final java.lang.String ANTLIB_PREFIX
    +
    +
    prefix for antlib URIs: + "antlib:" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_VERSION

    +
    +public static final java.lang.String ANT_VERSION
    +
    +
    Ant version property. + Value: "ant.version" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +BUILD_SYSCLASSPATH

    +
    +public static final java.lang.String BUILD_SYSCLASSPATH
    +
    +
    System classpath policy. + Value: "build.sysclasspath" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +SCRIPT_REPOSITORY

    +
    +public static final java.lang.String SCRIPT_REPOSITORY
    +
    +
    The name of the script repository used by the script repo task. + Value "org.apache.ant.scriptrepo" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +SYSTEM_LOADER_REF

    +
    +public static final java.lang.String SYSTEM_LOADER_REF
    +
    +
    The name of the reference to the System Class Loader. + Value "ant.coreLoader" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REPOSITORY_DIR_PROPERTY

    +
    +public static final java.lang.String REPOSITORY_DIR_PROPERTY
    +
    +
    Name of the property which can provide an override of the repository dir. + for the libraries task + Value "ant.maven.repository.dir" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REPOSITORY_URL_PROPERTY

    +
    +public static final java.lang.String REPOSITORY_URL_PROPERTY
    +
    +
    Name of the property which can provide an override of the repository URL. + for the libraries task + Value "ant.maven.repository.url" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TASKDEF_PROPERTIES_RESOURCE

    +
    +public static final java.lang.String TASKDEF_PROPERTIES_RESOURCE
    +
    +
    name of the resource that taskdefs are stored under. + Value: "/org/apache/tools/ant/taskdefs/defaults.properties" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TYPEDEFS_PROPERTIES_RESOURCE

    +
    +public static final java.lang.String TYPEDEFS_PROPERTIES_RESOURCE
    +
    +
    name of the resource that typedefs are stored under. + Value: "/org/apache/tools/ant/types/defaults.properties" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_EXECUTOR_REFERENCE

    +
    +public static final java.lang.String ANT_EXECUTOR_REFERENCE
    +
    +
    Reference to the current Ant executor. + Value: "ant.executor" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_EXECUTOR_CLASSNAME

    +
    +public static final java.lang.String ANT_EXECUTOR_CLASSNAME
    +
    +
    Property defining the classname of an executor. + Value: "ant.executor.class" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_BASEDIR

    +
    +public static final java.lang.String PROJECT_BASEDIR
    +
    +
    property name for basedir of the project. + Value: "basedir" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_FILE

    +
    +public static final java.lang.String ANT_FILE
    +
    +
    property for ant file name. + Value: "ant.file" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_FILE_TYPE

    +
    +public static final java.lang.String ANT_FILE_TYPE
    +
    +
    property for type of ant build file (either file or url) + Value: "ant.file.type" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_FILE_TYPE_FILE

    +
    +public static final java.lang.String ANT_FILE_TYPE_FILE
    +
    +
    ant build file of type file + Value: "file" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_FILE_TYPE_URL

    +
    +public static final java.lang.String ANT_FILE_TYPE_URL
    +
    +
    ant build file of type url + Value: "url" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_JAVA_VERSION

    +
    +public static final java.lang.String ANT_JAVA_VERSION
    +
    +
    Property used to store the java version ant is running in. + Value: "ant.java.version" +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_HOME

    +
    +public static final java.lang.String ANT_HOME
    +
    +
    Property used to store the location of ant. + Value: "ant.home" +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_LIB

    +
    +public static final java.lang.String ANT_LIB
    +
    +
    Property used to store the location of the ant library (typically the ant.jar file.) + Value: "ant.core.lib" +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REGEXP_IMPL

    +
    +public static final java.lang.String REGEXP_IMPL
    +
    +
    property for regular expression implementation. + Value: "ant.regexp.regexpimpl" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +BUILD_JAVAC_SOURCE

    +
    +public static final java.lang.String BUILD_JAVAC_SOURCE
    +
    +
    property that provides the default value for javac's and + javadoc's source attribute. + Value: "ant.build.javac.source" +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +BUILD_JAVAC_TARGET

    +
    +public static final java.lang.String BUILD_JAVAC_TARGET
    +
    +
    property that provides the default value for javac's target attribute. + Value: "ant.build.javac.target" +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFID_CLASSPATH_REUSE_LOADER

    +
    +public static final java.lang.String REFID_CLASSPATH_REUSE_LOADER
    +
    +
    Name of the magic property that controls classloader reuse. + Value: "ant.reuse.loader" +

    +

    +
    Since:
    +
    Ant 1.4.
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFID_CLASSPATH_LOADER_PREFIX

    +
    +public static final java.lang.String REFID_CLASSPATH_LOADER_PREFIX
    +
    +
    Prefix used to store classloader references. + Value: "ant.loader." +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFID_PROPERTY_HELPER

    +
    +public static final java.lang.String REFID_PROPERTY_HELPER
    +
    +
    Reference used to store the property helper. + Value: "ant.PropertyHelper" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFID_LOCAL_PROPERTIES

    +
    +public static final java.lang.String REFID_LOCAL_PROPERTIES
    +
    +
    Reference used to store the local properties. + Value: "ant.LocalProperties" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_HELPER_CLASS

    +
    +public static final java.lang.String PROJECT_HELPER_CLASS
    +
    +
    Name of JVM system property which provides the name of the ProjectHelper class to use. + Value: "org.apache.tools.ant.ProjectHelper" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_HELPER_SERVICE

    +
    +public static final java.lang.String PROJECT_HELPER_SERVICE
    +
    +
    The service identifier in jars which provide ProjectHelper implementations. + Value: "META-INF/services/org.apache.tools.ant.ProjectHelper" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFID_PROJECT_HELPER

    +
    +public static final java.lang.String REFID_PROJECT_HELPER
    +
    +
    Name of ProjectHelper reference that we add to a project. + Value: "ant.projectHelper" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_NAME

    +
    +public static final java.lang.String PROJECT_NAME
    +
    +
    Name of the property holding the name of the currently + executing project, if one has been specified. + + Value: "ant.project.name" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_DEFAULT_TARGET

    +
    +public static final java.lang.String PROJECT_DEFAULT_TARGET
    +
    +
    Name of the property holding the default target of the + currently executing project, if one has been specified. + + Value: "ant.project.default-target" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_INVOKED_TARGETS

    +
    +public static final java.lang.String PROJECT_INVOKED_TARGETS
    +
    +
    Name of the property holding a comma separated list of targets + that have been invoked (from the command line). + + Value: "ant.project.invoked-targets" +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    Constant Field Values
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Main.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Main.html new file mode 100644 index 000000000..9c7acbf74 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Main.html @@ -0,0 +1,490 @@ + + + + + + +Main (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Main

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Main
+
    +
    +
    All Implemented Interfaces:
    AntMain
    +
    +
    +
    +
    public class Main
    extends java.lang.Object
    implements AntMain
    + + +

    +Command line entry point into Ant. This class is entered via the + canonical `public static void main` entry point and reads the + command line arguments. It then assembles and executes an Ant + project. +

    + If you integrating Ant into some other tool, this is not the class + to use as an entry point. Please see the source code of this + class to see how it manipulates the Ant project classes. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDEFAULT_BUILD_FILENAME + +
    +          The default build file name.
    +  + + + + + + + + + + + + + + + +
    +Constructor Summary
    + Main() + +
    +          Constructor used when creating Main for later arg processing + and startup
    +protected Main(java.lang.String[] args) + +
    +          Deprecated. since 1.6.x
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidaddBuildListeners(Project project) + +
    +          Adds the listeners specified in the command line arguments, + along with the default listener, to the specified project.
    +protected  voidexit(int exitCode) + +
    +          This operation is expected to call System.exit(int), which + is what the base version does.
    +static java.lang.StringgetAntVersion() + +
    +          Returns the Ant version information, if available.
    +static voidmain(java.lang.String[] args) + +
    +          Command line entry point.
    +static voidstart(java.lang.String[] args, + java.util.Properties additionalUserProperties, + java.lang.ClassLoader coreLoader) + +
    +          Creates a new instance of this class using the + arguments specified, gives it any extra user properties which have been + specified, and then runs the build using the classloader provided.
    + voidstartAnt(java.lang.String[] args, + java.util.Properties additionalUserProperties, + java.lang.ClassLoader coreLoader) + +
    +          Start Ant
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_BUILD_FILENAME

    +
    +public static final java.lang.String DEFAULT_BUILD_FILENAME
    +
    +
    The default build file name. "build.xml" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Main

    +
    +public Main()
    +
    +
    Constructor used when creating Main for later arg processing + and startup +

    +

    +
    + +

    +Main

    +
    +protected Main(java.lang.String[] args)
+        throws BuildException
    +
    +
    Deprecated. since 1.6.x +

    +

    Sole constructor, which parses and deals with command line + arguments. +

    +

    +
    Parameters:
    args - Command line arguments. Must not be null. +
    Throws: +
    BuildException - if the specified build file doesn't exist + or is a directory.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +start

    +
    +public static void start(java.lang.String[] args,
+                         java.util.Properties additionalUserProperties,
+                         java.lang.ClassLoader coreLoader)
    +
    +
    Creates a new instance of this class using the + arguments specified, gives it any extra user properties which have been + specified, and then runs the build using the classloader provided. +

    +

    +
    +
    +
    +
    Parameters:
    args - Command line arguments. Must not be null.
    additionalUserProperties - Any extra properties to use in this + build. May be null, which is the equivalent to + passing in an empty set of properties.
    coreLoader - Classloader used for core classes. May be + null in which case the system classloader is used.
    +
    +
    +
    + +

    +startAnt

    +
    +public void startAnt(java.lang.String[] args,
+                     java.util.Properties additionalUserProperties,
+                     java.lang.ClassLoader coreLoader)
    +
    +
    Start Ant +

    +

    +
    Specified by:
    startAnt in interface AntMain
    +
    +
    +
    Parameters:
    args - command line args
    additionalUserProperties - properties to set beyond those that + may be specified on the args list
    coreLoader - - not used
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +exit

    +
    +protected void exit(int exitCode)
    +
    +
    This operation is expected to call System.exit(int), which + is what the base version does. + However, it is possible to do something else. +

    +

    +
    +
    +
    +
    Parameters:
    exitCode - code to exit with
    +
    +
    +
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    Command line entry point. This method kicks off the building + of a project object and executes a build using either a given + target or the default target. +

    +

    +
    +
    +
    +
    Parameters:
    args - Command line arguments. Must not be null.
    +
    +
    +
    + +

    +addBuildListeners

    +
    +protected void addBuildListeners(Project project)
    +
    +
    Adds the listeners specified in the command line arguments, + along with the default listener, to the specified project. +

    +

    +
    +
    +
    +
    Parameters:
    project - The project to add listeners to. + Must not be null.
    +
    +
    +
    + +

    +getAntVersion

    +
    +public static java.lang.String getAntVersion()
+                                      throws BuildException
    +
    +
    Returns the Ant version information, if available. Once the information + has been loaded once, it's cached and returned from the cache on future + calls. +

    +

    +
    +
    +
    + +
    Returns:
    the Ant version information as a String + (always non-null) +
    Throws: +
    BuildException - if the version information is unavailable
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/NoBannerLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/NoBannerLogger.html new file mode 100644 index 000000000..590a128f5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/NoBannerLogger.html @@ -0,0 +1,410 @@ + + + + + + +NoBannerLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class NoBannerLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.NoBannerLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    Direct Known Subclasses:
    SimpleBigProjectLogger
    +
    +
    +
    +
    public class NoBannerLogger
    extends DefaultLogger
    + + +

    +Extends DefaultLogger to strip out empty targets. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.StringtargetName + +
    +          Name of the current target, if it should + be displayed on the next message.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    NoBannerLogger() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  java.lang.StringextractTargetName(BuildEvent event) + +
    +          Override point, extract the target name
    + voidmessageLogged(BuildEvent event) + +
    +          Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target.
    + voidtargetFinished(BuildEvent event) + +
    +          Resets the current target name to null.
    + voidtargetStarted(BuildEvent event) + +
    +          Notes the name of the target so it can be logged + if it generates any messages.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildFinished, buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, log, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, taskFinished, taskStarted
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +targetName

    +
    +protected java.lang.String targetName
    +
    +
    Name of the current target, if it should + be displayed on the next message. This is + set when a target starts building, and reset + to null after the first message for + the target is logged. +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +NoBannerLogger

    +
    +public NoBannerLogger()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Notes the name of the target so it can be logged + if it generates any messages. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    Overrides:
    targetStarted in class DefaultLogger
    +
    +
    +
    Parameters:
    event - A BuildEvent containing target information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +extractTargetName

    +
    +protected java.lang.String extractTargetName(BuildEvent event)
    +
    +
    Override point, extract the target name +

    +

    +
    Parameters:
    event - the event to work on +
    Returns:
    the target name to print
    Since:
    +
    Ant1.7.1
    +
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Resets the current target name to null. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    Overrides:
    targetFinished in class DefaultLogger
    +
    +
    +
    Parameters:
    event - Ignored in this implementation.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    Overrides:
    messageLogged in class DefaultLogger
    +
    +
    +
    Parameters:
    event - A BuildEvent containing message information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PathTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PathTokenizer.html new file mode 100644 index 000000000..c0d415696 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PathTokenizer.html @@ -0,0 +1,292 @@ + + + + + + +PathTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class PathTokenizer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.PathTokenizer
+
    +
    +
    +
    public class PathTokenizer
    extends java.lang.Object
    + + +

    +A Path tokenizer takes a path and returns the components that make up + that path. + + The path can use path separators of either ':' or ';' and file separators + of either '/' or '\'. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    PathTokenizer(java.lang.String path) + +
    +          Constructs a path tokenizer for the specified path.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanhasMoreTokens() + +
    +          Tests if there are more path elements available from this tokenizer's + path.
    + java.lang.StringnextToken() + +
    +          Returns the next path element from this tokenizer.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PathTokenizer

    +
    +public PathTokenizer(java.lang.String path)
    +
    +
    Constructs a path tokenizer for the specified path. +

    +

    +
    Parameters:
    path - The path to tokenize. Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +hasMoreTokens

    +
    +public boolean hasMoreTokens()
    +
    +
    Tests if there are more path elements available from this tokenizer's + path. If this method returns true, then a subsequent call + to nextToken will successfully return a token. +

    +

    + +
    Returns:
    true if and only if there is at least one token + in the string after the current position; false otherwise.
    +
    +
    +
    + +

    +nextToken

    +
    +public java.lang.String nextToken()
+                           throws java.util.NoSuchElementException
    +
    +
    Returns the next path element from this tokenizer. +

    +

    + +
    Returns:
    the next path element from this tokenizer. +
    Throws: +
    java.util.NoSuchElementException - if there are no more elements in this + tokenizer's path.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Project.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Project.html new file mode 100644 index 000000000..9cb33589e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Project.html @@ -0,0 +1,4081 @@ + + + + + + +Project (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Project

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Project
+
    +
    +
    All Implemented Interfaces:
    ResourceFactory
    +
    +
    +
    +
    public class Project
    extends java.lang.Object
    implements ResourceFactory
    + + +

    +Central representation of an Ant project. This class defines an + Ant project with all of its targets, tasks and various other + properties. It also provides the mechanism to kick off a build using + a particular target name. +

    + This class also encapsulates methods which allow files to be referred + to using abstract path names which are translated to native system + file paths at runtime. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringJAVA_1_0 + +
    +          Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_0 instead.
    +static java.lang.StringJAVA_1_1 + +
    +          Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_1 instead.
    +static java.lang.StringJAVA_1_2 + +
    +          Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_2 instead.
    +static java.lang.StringJAVA_1_3 + +
    +          Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_3 instead.
    +static java.lang.StringJAVA_1_4 + +
    +          Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_4 instead.
    +static intMSG_DEBUG + +
    +          Message priority of "debug".
    +static intMSG_ERR + +
    +          Message priority of "error".
    +static intMSG_INFO + +
    +          Message priority of "information".
    +static intMSG_VERBOSE + +
    +          Message priority of "verbose".
    +static intMSG_WARN + +
    +          Message priority of "warning".
    +static java.lang.StringTOKEN_END + +
    +          Default filter end token.
    +static java.lang.StringTOKEN_START + +
    +          Default filter start token.
    +  + + + + + + + + + + +
    +Constructor Summary
    Project() + +
    +          Create a new Ant project.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddBuildListener(BuildListener listener) + +
    +          Add a build listener to the list.
    + voidaddDataTypeDefinition(java.lang.String typeName, + java.lang.Class typeClass) + +
    +          Add a new datatype definition.
    + voidaddFilter(java.lang.String token, + java.lang.String value) + +
    +          Deprecated. since 1.4.x. + Use getGlobalFilterSet().addFilter(token,value)
    + voidaddIdReference(java.lang.String id, + java.lang.Object value) + +
    +          Add an id reference.
    + voidaddOrReplaceTarget(java.lang.String targetName, + Target target) + +
    +          Add a target to the project, or replaces one with the same + name.
    + voidaddOrReplaceTarget(Target target) + +
    +          Add a target to the project, or replaces one with the same + name.
    + voidaddReference(java.lang.String referenceName, + java.lang.Object value) + +
    +          Add a reference to the project.
    + voidaddTarget(java.lang.String targetName, + Target target) + +
    +          Add a new target to the project.
    + voidaddTarget(Target target) + +
    +          Add a new target to the project.
    + voidaddTaskDefinition(java.lang.String taskName, + java.lang.Class taskClass) + +
    +          Add a new task definition to the project.
    + voidcheckTaskClass(java.lang.Class taskClass) + +
    +          Check whether or not a class is suitable for serving as Ant task.
    + voidcopyFile(java.io.File sourceFile, + java.io.File destFile) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + boolean filtering) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + boolean filtering, + boolean overwrite) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + boolean filtering, + boolean overwrite, + boolean preserveLastModified) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + boolean filtering) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + boolean filtering, + boolean overwrite) + +
    +          Deprecated. since 1.4.x
    + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + boolean filtering, + boolean overwrite, + boolean preserveLastModified) + +
    +          Deprecated. since 1.4.x
    + voidcopyInheritedProperties(Project other) + +
    +          Copy all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument.
    + voidcopyUserProperties(Project other) + +
    +          Copy all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument.
    + AntClassLoadercreateClassLoader(java.lang.ClassLoader parent, + Path path) + +
    +          Factory method to create a class loader for loading classes from + a given path.
    + AntClassLoadercreateClassLoader(Path path) + +
    +          Factory method to create a class loader for loading classes from + a given path.
    + java.lang.ObjectcreateDataType(java.lang.String typeName) + +
    +          Create a new instance of a data type.
    + ProjectcreateSubProject() + +
    +          Create and initialize a subproject.
    + TaskcreateTask(java.lang.String taskType) + +
    +          Create a new instance of a task, adding it to a list of + created tasks for later invalidation.
    + intdefaultInput(byte[] buffer, + int offset, + int length) + +
    +          Read data from the default input stream.
    + voiddemuxFlush(java.lang.String output, + boolean isError) + +
    +          Demultiplex flush operations so that each task receives the appropriate + messages.
    + intdemuxInput(byte[] buffer, + int offset, + int length) + +
    +          Demux an input request to the correct task.
    + voiddemuxOutput(java.lang.String output, + boolean isWarning) + +
    +          Demultiplex output so that each task receives the appropriate + messages.
    + voidexecuteSortedTargets(java.util.Vector sortedTargets) + +
    +          Execute a Vector of sorted targets.
    + voidexecuteTarget(java.lang.String targetName) + +
    +          Execute the specified target and any targets it depends on.
    + voidexecuteTargets(java.util.Vector names) + +
    +          Execute the specified sequence of targets, and the targets + they depend on.
    + voidfireBuildFinished(java.lang.Throwable exception) + +
    +          Send a "build finished" event to the build listeners + for this project.
    + voidfireBuildStarted() + +
    +          Send a "build started" event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Project project, + java.lang.String message, + int priority) + +
    +          Send a "message logged" project level event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Project project, + java.lang.String message, + java.lang.Throwable throwable, + int priority) + +
    +          Send a "message logged" project level event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Target target, + java.lang.String message, + int priority) + +
    +          Send a "message logged" target level event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Target target, + java.lang.String message, + java.lang.Throwable throwable, + int priority) + +
    +          Send a "message logged" target level event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Task task, + java.lang.String message, + int priority) + +
    +          Send a "message logged" task level event + to the build listeners for this project.
    +protected  voidfireMessageLogged(Task task, + java.lang.String message, + java.lang.Throwable throwable, + int priority) + +
    +          Send a "message logged" task level event + to the build listeners for this project.
    + voidfireSubBuildFinished(java.lang.Throwable exception) + +
    +          Send a "subbuild finished" event to the build listeners for + this project.
    + voidfireSubBuildStarted() + +
    +          Send a "subbuild started" event to the build listeners for + this project.
    +protected  voidfireTargetFinished(Target target, + java.lang.Throwable exception) + +
    +          Send a "target finished" event to the build listeners + for this project.
    +protected  voidfireTargetStarted(Target target) + +
    +          Send a "target started" event to the build listeners + for this project.
    +protected  voidfireTaskFinished(Task task, + java.lang.Throwable exception) + +
    +          Send a "task finished" event to the build listeners for this + project.
    +protected  voidfireTaskStarted(Task task) + +
    +          Send a "task started" event to the build listeners + for this project.
    + java.io.FilegetBaseDir() + +
    +          Return the base directory of the project as a file object.
    + java.util.VectorgetBuildListeners() + +
    +          Return a copy of the list of build listeners for the project.
    + java.util.MapgetCopyOfDataTypeDefinitions() + +
    +          Return the current datatype definition map.
    + java.util.MapgetCopyOfReferences() + +
    +          Return a map of the references in the project (String to + Object).
    + java.util.MapgetCopyOfTargets() + +
    +          Return the map of targets.
    + java.util.MapgetCopyOfTaskDefinitions() + +
    +          Return the current task definition map.
    + java.lang.ClassLoadergetCoreLoader() + +
    +          Return the core classloader to use for this project.
    + java.util.HashtablegetDataTypeDefinitions() + +
    +          Return the current datatype definition hashtable.
    + java.io.InputStreamgetDefaultInputStream() + +
    +          Get this project's input stream.
    + java.lang.StringgetDefaultTarget() + +
    +          Return the name of the default target of the project.
    + java.lang.StringgetDescription() + +
    +          Return the project description, if one has been set.
    + java.lang.StringgetElementName(java.lang.Object element) + +
    +          Return a description of the type of the given element, with + special handling for instances of tasks and data types.
    + ExecutorgetExecutor() + +
    +          Get this Project's Executor (setting it if necessary).
    + java.util.HashtablegetFilters() + +
    +          Deprecated. since 1.4.x + Use getGlobalFilterSet().getFilterHash().
    + FilterSetgetGlobalFilterSet() + +
    +          Return the set of global filters.
    + java.util.HashtablegetInheritedProperties() + +
    +          Return a copy of the inherited property hashtable.
    + InputHandlergetInputHandler() + +
    +          Retrieve the current input handler.
    +static java.lang.StringgetJavaVersion() + +
    +          Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JavaEnvUtils instead.
    + java.lang.StringgetName() + +
    +          Return the project name, if one has been set.
    +static ProjectgetProject(java.lang.Object o) + +
    +          Get the Project instance associated with the specified object.
    + java.util.HashtablegetProperties() + +
    +          Return a copy of the properties table.
    + java.lang.StringgetProperty(java.lang.String propertyName) + +
    +          Return the value of a property, if it is set.
    + java.lang.ObjectgetReference(java.lang.String key) + +
    +          Look up a reference by its key (ID).
    + java.util.HashtablegetReferences() + +
    +          Return a map of the references in the project (String to Object).
    + ResourcegetResource(java.lang.String name) + +
    +          Resolve the file relative to the project's basedir and return it as a + FileResource.
    + java.util.HashtablegetTargets() + +
    +          Return the hashtable of targets.
    + java.util.HashtablegetTaskDefinitions() + +
    +          Return the current task definition hashtable.
    + TaskgetThreadTask(java.lang.Thread thread) + +
    +          Get the current task associated with a thread, if any.
    + java.util.HashtablegetUserProperties() + +
    +          Return a copy of the user property hashtable.
    + java.lang.StringgetUserProperty(java.lang.String propertyName) + +
    +          Return the value of a user property, if it is set.
    + booleanhasReference(java.lang.String key) + +
    +          Does the project know this reference?
    + voidinheritIDReferences(Project parent) + +
    +          Inherit the id references.
    + voidinit() + +
    +          Initialise the project.
    + voidinitProperties() + +
    +          Initializes the properties.
    + voidinitSubProject(Project subProject) + +
    +          Initialize a subproject.
    + booleanisKeepGoingMode() + +
    +          Return the keep-going mode.
    + voidlog(java.lang.String message) + +
    +          Write a message to the log with the default log level + of MSG_INFO .
    + voidlog(java.lang.String message, + int msgLevel) + +
    +          Write a project level message to the log with the given log level.
    + voidlog(java.lang.String message, + java.lang.Throwable throwable, + int msgLevel) + +
    +          Write a project level message to the log with the given log level.
    + voidlog(Target target, + java.lang.String message, + int msgLevel) + +
    +          Write a target level message to the log with the given log level.
    + voidlog(Target target, + java.lang.String message, + java.lang.Throwable throwable, + int msgLevel) + +
    +          Write a target level message to the log with the given log level.
    + voidlog(Task task, + java.lang.String message, + int msgLevel) + +
    +          Write a task level message to the log with the given log level.
    + voidlog(Task task, + java.lang.String message, + java.lang.Throwable throwable, + int msgLevel) + +
    +          Write a task level message to the log with the given log level.
    + voidregisterThreadTask(java.lang.Thread thread, + Task task) + +
    +          Register a task as the current task for a thread.
    + voidremoveBuildListener(BuildListener listener) + +
    +          Remove a build listener from the list.
    + java.lang.StringreplaceProperties(java.lang.String value) + +
    +          Replace ${} style constructions in the given value with the + string value of the corresponding data types.
    + java.io.FileresolveFile(java.lang.String fileName) + +
    +          Return the canonical form of a filename.
    + java.io.FileresolveFile(java.lang.String fileName, + java.io.File rootDir) + +
    +          Deprecated. since 1.4.x
    + voidsetBaseDir(java.io.File baseDir) + +
    +          Set the base directory for the project, checking that + the given file exists and is a directory.
    + voidsetBasedir(java.lang.String baseD) + +
    +          Set the base directory for the project, checking that + the given filename exists and is a directory.
    + voidsetCoreLoader(java.lang.ClassLoader coreLoader) + +
    +          Set the core classloader for the project.
    + voidsetDefault(java.lang.String defaultTarget) + +
    +          Set the default target of the project.
    + voidsetDefaultInputStream(java.io.InputStream defaultInputStream) + +
    +          Set the default System input stream.
    + voidsetDefaultTarget(java.lang.String defaultTarget) + +
    +          Deprecated. since 1.5.x. + Use setDefault.
    + voidsetDescription(java.lang.String description) + +
    +          Set the project description.
    + voidsetExecutor(Executor e) + +
    +          Set the Executor instance for this Project.
    + voidsetFileLastModified(java.io.File file, + long time) + +
    +          Deprecated. since 1.4.x
    + voidsetInheritedProperty(java.lang.String name, + java.lang.String value) + +
    +          Set a user property, which cannot be overwritten by set/unset + property calls.
    + voidsetInputHandler(InputHandler handler) + +
    +          Set the input handler.
    + voidsetJavaVersionProperty() + +
    +          Set the ant.java.version property and tests for + unsupported JVM versions.
    + voidsetKeepGoingMode(boolean keepGoingMode) + +
    +          Set "keep-going" mode.
    + voidsetName(java.lang.String name) + +
    +          Set the name of the project, also setting the user + property ant.project.name.
    + voidsetNewProperty(java.lang.String name, + java.lang.String value) + +
    +          Set a property if no value currently exists.
    + voidsetProjectReference(java.lang.Object obj) + +
    +          Set a reference to this Project on the parameterized object.
    + voidsetProperty(java.lang.String name, + java.lang.String value) + +
    +          Set a property.
    + voidsetSystemProperties() + +
    +          Add all system properties which aren't already defined as + user properties to the project properties.
    + voidsetUserProperty(java.lang.String name, + java.lang.String value) + +
    +          Set a user property, which cannot be overwritten by + set/unset property calls.
    +static booleantoBoolean(java.lang.String s) + +
    +          Return the boolean equivalent of a string, which is considered + true if either "on", "true", + or "yes" is found, ignoring case.
    + java.util.VectortopoSort(java.lang.String[] root, + java.util.Hashtable targetTable, + boolean returnAll) + +
    +          Topologically sort a set of targets.
    + java.util.VectortopoSort(java.lang.String root, + java.util.Hashtable targetTable) + +
    +          Topologically sort a set of targets.
    + java.util.VectortopoSort(java.lang.String root, + java.util.Hashtable targetTable, + boolean returnAll) + +
    +          Topologically sort a set of targets.
    +static java.lang.StringtranslatePath(java.lang.String toProcess) + +
    +          Deprecated. since 1.7 + Use FileUtils.translatePath instead.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +MSG_ERR

    +
    +public static final int MSG_ERR
    +
    +
    Message priority of "error". +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MSG_WARN

    +
    +public static final int MSG_WARN
    +
    +
    Message priority of "warning". +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MSG_INFO

    +
    +public static final int MSG_INFO
    +
    +
    Message priority of "information". +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MSG_VERBOSE

    +
    +public static final int MSG_VERBOSE
    +
    +
    Message priority of "verbose". +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MSG_DEBUG

    +
    +public static final int MSG_DEBUG
    +
    +
    Message priority of "debug". +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAVA_1_0

    +
    +public static final java.lang.String JAVA_1_0
    +
    +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_0 instead.
    Version constant for Java 1.0 . +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAVA_1_1

    +
    +public static final java.lang.String JAVA_1_1
    +
    +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_1 instead.
    Version constant for Java 1.1 . +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAVA_1_2

    +
    +public static final java.lang.String JAVA_1_2
    +
    +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_2 instead.
    Version constant for Java 1.2 . +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAVA_1_3

    +
    +public static final java.lang.String JAVA_1_3
    +
    +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_3 instead.
    Version constant for Java 1.3 . +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAVA_1_4

    +
    +public static final java.lang.String JAVA_1_4
    +
    +
    Deprecated. since 1.5.x. + Use JavaEnvUtils.JAVA_1_4 instead.
    Version constant for Java 1.4 . +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TOKEN_START

    +
    +public static final java.lang.String TOKEN_START
    +
    +
    Default filter start token. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TOKEN_END

    +
    +public static final java.lang.String TOKEN_END
    +
    +
    Default filter end token. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Project

    +
    +public Project()
    +
    +
    Create a new Ant project. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setInputHandler

    +
    +public void setInputHandler(InputHandler handler)
    +
    +
    Set the input handler. +

    +

    +
    +
    +
    +
    Parameters:
    handler - the InputHandler instance to use for gathering input.
    +
    +
    +
    + +

    +setDefaultInputStream

    +
    +public void setDefaultInputStream(java.io.InputStream defaultInputStream)
    +
    +
    Set the default System input stream. Normally this stream is set to + System.in. This inputStream is used when no task input redirection is + being performed. +

    +

    +
    +
    +
    +
    Parameters:
    defaultInputStream - the default input stream to use when input + is requested.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getDefaultInputStream

    +
    +public java.io.InputStream getDefaultInputStream()
    +
    +
    Get this project's input stream. +

    +

    +
    +
    +
    + +
    Returns:
    the InputStream instance in use by this Project instance to + read input.
    +
    +
    +
    + +

    +getInputHandler

    +
    +public InputHandler getInputHandler()
    +
    +
    Retrieve the current input handler. +

    +

    +
    +
    +
    + +
    Returns:
    the InputHandler instance currently in place for the project + instance.
    +
    +
    +
    + +

    +createSubProject

    +
    +public Project createSubProject()
    +
    +
    Create and initialize a subproject. By default the subproject will be of + the same type as its parent. If a no-arg constructor is unavailable, the + Project class will be used. +

    +

    +
    +
    +
    + +
    Returns:
    a Project instance configured as a subproject of this Project.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +initSubProject

    +
    +public void initSubProject(Project subProject)
    +
    +
    Initialize a subproject. +

    +

    +
    +
    +
    +
    Parameters:
    subProject - the subproject to initialize.
    +
    +
    +
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Initialise the project. + + This involves setting the default task definitions and loading the + system properties. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - if the default task list cannot be loaded.
    +
    +
    +
    + +

    +initProperties

    +
    +public void initProperties()
+                    throws BuildException
    +
    +
    Initializes the properties. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - if an vital property could not be set.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createClassLoader

    +
    +public AntClassLoader createClassLoader(Path path)
    +
    +
    Factory method to create a class loader for loading classes from + a given path. +

    +

    +
    +
    +
    +
    Parameters:
    path - the path from which classes are to be loaded. +
    Returns:
    an appropriate classloader.
    +
    +
    +
    + +

    +createClassLoader

    +
    +public AntClassLoader createClassLoader(java.lang.ClassLoader parent,
+                                        Path path)
    +
    +
    Factory method to create a class loader for loading classes from + a given path. +

    +

    +
    +
    +
    +
    Parameters:
    parent - the parent classloader for the new loader.
    path - the path from which classes are to be loaded. +
    Returns:
    an appropriate classloader.
    +
    +
    +
    + +

    +setCoreLoader

    +
    +public void setCoreLoader(java.lang.ClassLoader coreLoader)
    +
    +
    Set the core classloader for the project. If a null + classloader is specified, the parent classloader should be used. +

    +

    +
    +
    +
    +
    Parameters:
    coreLoader - The classloader to use for the project. + May be null.
    +
    +
    +
    + +

    +getCoreLoader

    +
    +public java.lang.ClassLoader getCoreLoader()
    +
    +
    Return the core classloader to use for this project. + This may be null, indicating that + the parent classloader should be used. +

    +

    +
    +
    +
    + +
    Returns:
    the core classloader to use for this project.
    +
    +
    +
    + +

    +addBuildListener

    +
    +public void addBuildListener(BuildListener listener)
    +
    +
    Add a build listener to the list. This listener will + be notified of build events for this project. +

    +

    +
    +
    +
    +
    Parameters:
    listener - The listener to add to the list. + Must not be null.
    +
    +
    +
    + +

    +removeBuildListener

    +
    +public void removeBuildListener(BuildListener listener)
    +
    +
    Remove a build listener from the list. This listener + will no longer be notified of build events for this project. +

    +

    +
    +
    +
    +
    Parameters:
    listener - The listener to remove from the list. + Should not be null.
    +
    +
    +
    + +

    +getBuildListeners

    +
    +public java.util.Vector getBuildListeners()
    +
    +
    Return a copy of the list of build listeners for the project. +

    +

    +
    +
    +
    + +
    Returns:
    a list of build listeners for the project
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String message)
    +
    +
    Write a message to the log with the default log level + of MSG_INFO . +

    +

    +
    +
    +
    +
    Parameters:
    message - The text to log. Should not be null.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String message,
+                int msgLevel)
    +
    +
    Write a project level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    message - The text to log. Should not be null.
    msgLevel - The log priority level to use.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String message,
+                java.lang.Throwable throwable,
+                int msgLevel)
    +
    +
    Write a project level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    message - The text to log. Should not be null.
    throwable - The exception causing this log, may be null.
    msgLevel - The log priority level to use.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +log

    +
    +public void log(Task task,
+                java.lang.String message,
+                int msgLevel)
    +
    +
    Write a task level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    task - The task to use in the log. Must not be null.
    message - The text to log. Should not be null.
    msgLevel - The log priority level to use.
    +
    +
    +
    + +

    +log

    +
    +public void log(Task task,
+                java.lang.String message,
+                java.lang.Throwable throwable,
+                int msgLevel)
    +
    +
    Write a task level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    task - The task to use in the log. Must not be null.
    message - The text to log. Should not be null.
    throwable - The exception causing this log, may be null.
    msgLevel - The log priority level to use.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +log

    +
    +public void log(Target target,
+                java.lang.String message,
+                int msgLevel)
    +
    +
    Write a target level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target to use in the log. + Must not be null.
    message - The text to log. Should not be null.
    msgLevel - The log priority level to use.
    +
    +
    +
    + +

    +log

    +
    +public void log(Target target,
+                java.lang.String message,
+                java.lang.Throwable throwable,
+                int msgLevel)
    +
    +
    Write a target level message to the log with the given log level. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target to use in the log. + Must not be null.
    message - The text to log. Should not be null.
    throwable - The exception causing this log, may be null.
    msgLevel - The log priority level to use.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +getGlobalFilterSet

    +
    +public FilterSet getGlobalFilterSet()
    +
    +
    Return the set of global filters. +

    +

    +
    +
    +
    + +
    Returns:
    the set of global filters.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String name,
+                        java.lang.String value)
    +
    +
    Set a property. Any existing property of the same name + is overwritten, unless it is a user property. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    +
    +
    +
    + +

    +setNewProperty

    +
    +public void setNewProperty(java.lang.String name,
+                           java.lang.String value)
    +
    +
    Set a property if no value currently exists. If the property + exists already, a message is logged and the method returns with + no other effect. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    Since:
    +
    1.5
    +
    +
    +
    +
    + +

    +setUserProperty

    +
    +public void setUserProperty(java.lang.String name,
+                            java.lang.String value)
    +
    +
    Set a user property, which cannot be overwritten by + set/unset property calls. Any previous value is overwritten. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    See Also:
    setProperty(String,String)
    +
    +
    +
    + +

    +setInheritedProperty

    +
    +public void setInheritedProperty(java.lang.String name,
+                                 java.lang.String value)
    +
    +
    Set a user property, which cannot be overwritten by set/unset + property calls. Any previous value is overwritten. Also marks + these properties as properties that have not come from the + command line. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    See Also:
    setProperty(String,String)
    +
    +
    +
    + +

    +getProperty

    +
    +public java.lang.String getProperty(java.lang.String propertyName)
    +
    +
    Return the value of a property, if it is set. +

    +

    +
    +
    +
    +
    Parameters:
    propertyName - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +replaceProperties

    +
    +public java.lang.String replaceProperties(java.lang.String value)
+                                   throws BuildException
    +
    +
    Replace ${} style constructions in the given value with the + string value of the corresponding data types. +

    +

    +
    +
    +
    +
    Parameters:
    value - The string to be scanned for property references. + May be null. +
    Returns:
    the given string with embedded property names replaced + by values, or null if the given string is + null. +
    Throws: +
    BuildException - if the given value has an unclosed + property name, e.g. ${xxx.
    +
    +
    +
    + +

    +getUserProperty

    +
    +public java.lang.String getUserProperty(java.lang.String propertyName)
    +
    +
    Return the value of a user property, if it is set. +

    +

    +
    +
    +
    +
    Parameters:
    propertyName - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +getProperties

    +
    +public java.util.Hashtable getProperties()
    +
    +
    Return a copy of the properties table. +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing all properties + (including user properties).
    +
    +
    +
    + +

    +getUserProperties

    +
    +public java.util.Hashtable getUserProperties()
    +
    +
    Return a copy of the user property hashtable. +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing just the user properties.
    +
    +
    +
    + +

    +getInheritedProperties

    +
    +public java.util.Hashtable getInheritedProperties()
    +
    +
    Return a copy of the inherited property hashtable. +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing just the inherited properties.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +copyUserProperties

    +
    +public void copyUserProperties(Project other)
    +
    +
    Copy all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument. + +

    To copy all "user" properties, you will also have to call + copyInheritedProperties.

    +

    +

    +
    +
    +
    +
    Parameters:
    other - the project to copy the properties to. Must not be null.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +copyInheritedProperties

    +
    +public void copyInheritedProperties(Project other)
    +
    +
    Copy all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument. + +

    To copy all "user" properties, you will also have to call + copyUserProperties.

    +

    +

    +
    +
    +
    +
    Parameters:
    other - the project to copy the properties to. Must not be null.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setDefaultTarget

    +
    +public void setDefaultTarget(java.lang.String defaultTarget)
    +
    +
    Deprecated. since 1.5.x. + Use setDefault. +

    +

    Set the default target of the project. +

    +

    +
    +
    +
    +
    Parameters:
    defaultTarget - The name of the default target for this project. + May be null, indicating that there is + no default target.
    See Also:
    setDefault(String)
    +
    +
    +
    + +

    +getDefaultTarget

    +
    +public java.lang.String getDefaultTarget()
    +
    +
    Return the name of the default target of the project. +

    +

    +
    +
    +
    + +
    Returns:
    name of the default target or + null if no default has been set.
    +
    +
    +
    + +

    +setDefault

    +
    +public void setDefault(java.lang.String defaultTarget)
    +
    +
    Set the default target of the project. +

    +

    +
    +
    +
    +
    Parameters:
    defaultTarget - The name of the default target for this project. + May be null, indicating that there is + no default target.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of the project, also setting the user + property ant.project.name. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of the project. + Must not be null.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Return the project name, if one has been set. +

    +

    +
    +
    +
    + +
    Returns:
    the project name, or null if it hasn't been set.
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String description)
    +
    +
    Set the project description. +

    +

    +
    +
    +
    +
    Parameters:
    description - The description of the project. + May be null.
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    Return the project description, if one has been set. +

    +

    +
    +
    +
    + +
    Returns:
    the project description, or null if it hasn't + been set.
    +
    +
    +
    + +

    +addFilter

    +
    +public void addFilter(java.lang.String token,
+                      java.lang.String value)
    +
    +
    Deprecated. since 1.4.x. + Use getGlobalFilterSet().addFilter(token,value) +

    +

    Add a filter to the set of global filters. +

    +

    +
    +
    +
    +
    Parameters:
    token - The token to filter. + Must not be null.
    value - The replacement value. + Must not be null.
    See Also:
    getGlobalFilterSet(), +FilterSet.addFilter(String,String)
    +
    +
    +
    + +

    +getFilters

    +
    +public java.util.Hashtable getFilters()
    +
    +
    Deprecated. since 1.4.x + Use getGlobalFilterSet().getFilterHash(). +

    +

    Return a hashtable of global filters, mapping tokens to values. +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable of global filters, mapping tokens to values + (String to String).
    See Also:
    getGlobalFilterSet(), +FilterSet.getFilterHash()
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.lang.String baseD)
+                throws BuildException
    +
    +
    Set the base directory for the project, checking that + the given filename exists and is a directory. +

    +

    +
    +
    +
    +
    Parameters:
    baseD - The project base directory. + Must not be null. +
    Throws: +
    BuildException - if the directory if invalid.
    +
    +
    +
    + +

    +setBaseDir

    +
    +public void setBaseDir(java.io.File baseDir)
+                throws BuildException
    +
    +
    Set the base directory for the project, checking that + the given file exists and is a directory. +

    +

    +
    +
    +
    +
    Parameters:
    baseDir - The project base directory. + Must not be null. +
    Throws: +
    BuildException - if the specified file doesn't exist or + isn't a directory.
    +
    +
    +
    + +

    +getBaseDir

    +
    +public java.io.File getBaseDir()
    +
    +
    Return the base directory of the project as a file object. +

    +

    +
    +
    +
    + +
    Returns:
    the project base directory, or null if the + base directory has not been successfully set to a valid value.
    +
    +
    +
    + +

    +setKeepGoingMode

    +
    +public void setKeepGoingMode(boolean keepGoingMode)
    +
    +
    Set "keep-going" mode. In this mode Ant will try to execute + as many targets as possible. All targets that do not depend + on failed target(s) will be executed. If the keepGoing settor/getter + methods are used in conjunction with the ant.executor.class + property, they will have no effect. +

    +

    +
    +
    +
    +
    Parameters:
    keepGoingMode - "keep-going" mode
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +isKeepGoingMode

    +
    +public boolean isKeepGoingMode()
    +
    +
    Return the keep-going mode. If the keepGoing settor/getter + methods are used in conjunction with the ant.executor.class + property, they will have no effect. +

    +

    +
    +
    +
    + +
    Returns:
    "keep-going" mode
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getJavaVersion

    +
    +public static java.lang.String getJavaVersion()
    +
    +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JavaEnvUtils instead. +

    +

    Return the version of Java this class is running under. +

    +

    +
    +
    +
    + +
    Returns:
    the version of Java as a String, e.g. "1.1" .
    See Also:
    JavaEnvUtils.getJavaVersion()
    +
    +
    +
    + +

    +setJavaVersionProperty

    +
    +public void setJavaVersionProperty()
+                            throws BuildException
    +
    +
    Set the ant.java.version property and tests for + unsupported JVM versions. If the version is supported, + verbose log messages are generated to record the Java version + and operating system name. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - if this Java version is not supported.
    See Also:
    JavaEnvUtils.getJavaVersion()
    +
    +
    +
    + +

    +setSystemProperties

    +
    +public void setSystemProperties()
    +
    +
    Add all system properties which aren't already defined as + user properties to the project properties. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +addTaskDefinition

    +
    +public void addTaskDefinition(java.lang.String taskName,
+                              java.lang.Class taskClass)
+                       throws BuildException
    +
    +
    Add a new task definition to the project. + Attempting to override an existing definition with an + equivalent one (i.e. with the same classname) results in + a verbose log message. Attempting to override an existing definition + with a different one results in a warning log message and + invalidates any tasks which have already been created with the + old definition. +

    +

    +
    +
    +
    +
    Parameters:
    taskName - The name of the task to add. + Must not be null.
    taskClass - The full name of the class implementing the task. + Must not be null. +
    Throws: +
    BuildException - if the class is unsuitable for being an Ant + task. An error level message is logged before + this exception is thrown.
    See Also:
    checkTaskClass(Class)
    +
    +
    +
    + +

    +checkTaskClass

    +
    +public void checkTaskClass(java.lang.Class taskClass)
+                    throws BuildException
    +
    +
    Check whether or not a class is suitable for serving as Ant task. + Ant task implementation classes must be public, concrete, and have + a no-arg constructor. +

    +

    +
    +
    +
    +
    Parameters:
    taskClass - The class to be checked. + Must not be null. +
    Throws: +
    BuildException - if the class is unsuitable for being an Ant + task. An error level message is logged before + this exception is thrown.
    +
    +
    +
    + +

    +getTaskDefinitions

    +
    +public java.util.Hashtable getTaskDefinitions()
    +
    +
    Return the current task definition hashtable. The returned hashtable is + "live" and so should not be modified. +

    +

    +
    +
    +
    + +
    Returns:
    a map of from task name to implementing class + (String to Class).
    +
    +
    +
    + +

    +getCopyOfTaskDefinitions

    +
    +public java.util.Map getCopyOfTaskDefinitions()
    +
    +
    Return the current task definition map. The returned map is a + copy of the "live" definitions. +

    +

    +
    +
    +
    + +
    Returns:
    a map of from task name to implementing class + (String to Class).
    Since:
    +
    Ant 1.8.1
    +
    +
    +
    +
    + +

    +addDataTypeDefinition

    +
    +public void addDataTypeDefinition(java.lang.String typeName,
+                                  java.lang.Class typeClass)
    +
    +
    Add a new datatype definition. + Attempting to override an existing definition with an + equivalent one (i.e. with the same classname) results in + a verbose log message. Attempting to override an existing definition + with a different one results in a warning log message, but the + definition is changed. +

    +

    +
    +
    +
    +
    Parameters:
    typeName - The name of the datatype. + Must not be null.
    typeClass - The full name of the class implementing the datatype. + Must not be null.
    +
    +
    +
    + +

    +getDataTypeDefinitions

    +
    +public java.util.Hashtable getDataTypeDefinitions()
    +
    +
    Return the current datatype definition hashtable. The returned + hashtable is "live" and so should not be modified. +

    +

    +
    +
    +
    + +
    Returns:
    a map of from datatype name to implementing class + (String to Class).
    +
    +
    +
    + +

    +getCopyOfDataTypeDefinitions

    +
    +public java.util.Map getCopyOfDataTypeDefinitions()
    +
    +
    Return the current datatype definition map. The returned + map is a copy pf the "live" definitions. +

    +

    +
    +
    +
    + +
    Returns:
    a map of from datatype name to implementing class + (String to Class).
    Since:
    +
    Ant 1.8.1
    +
    +
    +
    +
    + +

    +addTarget

    +
    +public void addTarget(Target target)
+               throws BuildException
    +
    +
    Add a new target to the project. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target to be added to the project. + Must not be null. +
    Throws: +
    BuildException - if the target already exists in the project
    See Also:
    addOrReplaceTarget(Target)
    +
    +
    +
    + +

    +addTarget

    +
    +public void addTarget(java.lang.String targetName,
+                      Target target)
+               throws BuildException
    +
    +
    Add a new target to the project. +

    +

    +
    +
    +
    +
    Parameters:
    targetName - The name to use for the target. + Must not be null.
    target - The target to be added to the project. + Must not be null. +
    Throws: +
    BuildException - if the target already exists in the project.
    See Also:
    addOrReplaceTarget(String, Target)
    +
    +
    +
    + +

    +addOrReplaceTarget

    +
    +public void addOrReplaceTarget(Target target)
    +
    +
    Add a target to the project, or replaces one with the same + name. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target to be added or replaced in the project. + Must not be null.
    +
    +
    +
    + +

    +addOrReplaceTarget

    +
    +public void addOrReplaceTarget(java.lang.String targetName,
+                               Target target)
    +
    +
    Add a target to the project, or replaces one with the same + name. +

    +

    +
    +
    +
    +
    Parameters:
    targetName - The name to use for the target. + Must not be null.
    target - The target to be added or replaced in the project. + Must not be null.
    +
    +
    +
    + +

    +getTargets

    +
    +public java.util.Hashtable getTargets()
    +
    +
    Return the hashtable of targets. The returned hashtable + is "live" and so should not be modified. +

    +

    +
    +
    +
    + +
    Returns:
    a map from name to target (String to Target).
    +
    +
    +
    + +

    +getCopyOfTargets

    +
    +public java.util.Map getCopyOfTargets()
    +
    +
    Return the map of targets. The returned map + is a copy of the "live" targets. +

    +

    +
    +
    +
    + +
    Returns:
    a map from name to target (String to Target).
    Since:
    +
    Ant 1.8.1
    +
    +
    +
    +
    + +

    +createTask

    +
    +public Task createTask(java.lang.String taskType)
+                throws BuildException
    +
    +
    Create a new instance of a task, adding it to a list of + created tasks for later invalidation. This causes all tasks + to be remembered until the containing project is removed +

    +

    +
    +
    +
    +
    Parameters:
    taskType - The name of the task to create an instance of. + Must not be null. +
    Returns:
    an instance of the specified task, or null if + the task name is not recognised. +
    Throws: +
    BuildException - if the task name is recognised but task + creation fails.
    +
    +
    +
    + +

    +createDataType

    +
    +public java.lang.Object createDataType(java.lang.String typeName)
+                                throws BuildException
    +
    +
    Create a new instance of a data type. +

    +

    +
    +
    +
    +
    Parameters:
    typeName - The name of the data type to create an instance of. + Must not be null. +
    Returns:
    an instance of the specified data type, or null if + the data type name is not recognised. +
    Throws: +
    BuildException - if the data type name is recognised but + instance creation fails.
    +
    +
    +
    + +

    +setExecutor

    +
    +public void setExecutor(Executor e)
    +
    +
    Set the Executor instance for this Project. +

    +

    +
    +
    +
    +
    Parameters:
    e - the Executor to use.
    +
    +
    +
    + +

    +getExecutor

    +
    +public Executor getExecutor()
    +
    +
    Get this Project's Executor (setting it if necessary). +

    +

    +
    +
    +
    + +
    Returns:
    an Executor instance.
    +
    +
    +
    + +

    +executeTargets

    +
    +public void executeTargets(java.util.Vector names)
+                    throws BuildException
    +
    +
    Execute the specified sequence of targets, and the targets + they depend on. +

    +

    +
    +
    +
    +
    Parameters:
    names - A vector of target name strings to execute. + Must not be null. +
    Throws: +
    BuildException - if the build failed.
    +
    +
    +
    + +

    +demuxOutput

    +
    +public void demuxOutput(java.lang.String output,
+                        boolean isWarning)
    +
    +
    Demultiplex output so that each task receives the appropriate + messages. If the current thread is not currently executing a task, + the message is logged directly. +

    +

    +
    +
    +
    +
    Parameters:
    output - Message to handle. Should not be null.
    isWarning - Whether the text represents an warning (true) + or information (false).
    +
    +
    +
    + +

    +defaultInput

    +
    +public int defaultInput(byte[] buffer,
+                        int offset,
+                        int length)
+                 throws java.io.IOException
    +
    +
    Read data from the default input stream. If no default has been + specified, System.in is used. +

    +

    +
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +demuxInput

    +
    +public int demuxInput(byte[] buffer,
+                      int offset,
+                      int length)
+               throws java.io.IOException
    +
    +
    Demux an input request to the correct task. +

    +

    +
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +demuxFlush

    +
    +public void demuxFlush(java.lang.String output,
+                       boolean isError)
    +
    +
    Demultiplex flush operations so that each task receives the appropriate + messages. If the current thread is not currently executing a task, + the message is logged directly. +

    +

    +
    +
    +
    +
    Parameters:
    output - Message to handle. Should not be null.
    isError - Whether the text represents an error (true) + or information (false).
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +executeTarget

    +
    +public void executeTarget(java.lang.String targetName)
+                   throws BuildException
    +
    +
    Execute the specified target and any targets it depends on. +

    +

    +
    +
    +
    +
    Parameters:
    targetName - The name of the target to execute. + Must not be null. +
    Throws: +
    BuildException - if the build failed.
    +
    +
    +
    + +

    +executeSortedTargets

    +
    +public void executeSortedTargets(java.util.Vector sortedTargets)
+                          throws BuildException
    +
    +
    Execute a Vector of sorted targets. +

    +

    +
    +
    +
    +
    Parameters:
    sortedTargets - the aforementioned Vector. +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +resolveFile

    +
    +public java.io.File resolveFile(java.lang.String fileName,
+                                java.io.File rootDir)
    +
    +
    Deprecated. since 1.4.x +

    +

    Return the canonical form of a filename. +

    + If the specified file name is relative it is resolved + with respect to the given root directory. +

    +

    +
    +
    +
    +
    Parameters:
    fileName - The name of the file to resolve. + Must not be null.
    rootDir - The directory respective to which relative file names + are resolved. May be null, in which case + the current directory is used. +
    Returns:
    the resolved File.
    +
    +
    +
    + +

    +resolveFile

    +
    +public java.io.File resolveFile(java.lang.String fileName)
    +
    +
    Return the canonical form of a filename. +

    + If the specified file name is relative it is resolved + with respect to the project's base directory. +

    +

    +
    +
    +
    +
    Parameters:
    fileName - The name of the file to resolve. + Must not be null. +
    Returns:
    the resolved File.
    +
    +
    +
    + +

    +translatePath

    +
    +public static java.lang.String translatePath(java.lang.String toProcess)
    +
    +
    Deprecated. since 1.7 + Use FileUtils.translatePath instead. +

    +

    Translate a path into its native (platform specific) format. +

    + This method uses PathTokenizer to separate the input path + into its components. This handles DOS style paths in a relatively + sensible way. The file separators are then converted to their platform + specific versions. +

    +

    +
    +
    +
    +
    Parameters:
    toProcess - The path to be translated. + May be null. +
    Returns:
    the native version of the specified path or + an empty string if the path is null or empty.
    See Also:
    PathTokenizer
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a destination. + No filtering is performed. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - Name of file to copy from. + Must not be null.
    destFile - Name of file to copy to. + Must not be null. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     boolean filtering)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a destination + specifying if token filtering should be used. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - Name of file to copy from. + Must not be null.
    destFile - Name of file to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     boolean filtering,
+                     boolean overwrite)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a + destination specifying if token filtering should be used and if + source files may overwrite newer destination files. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - Name of file to copy from. + Must not be null.
    destFile - Name of file to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy.
    overwrite - Whether or not the destination file should be + overwritten if it already exists. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     boolean filtering,
+                     boolean overwrite,
+                     boolean preserveLastModified)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a + destination specifying if token filtering should be used, if + source files may overwrite newer destination files, and if the + last modified time of the resulting file should be set to + that of the source file. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - Name of file to copy from. + Must not be null.
    destFile - Name of file to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy.
    overwrite - Whether or not the destination file should be + overwritten if it already exists.
    preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a destination. + No filtering is performed. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - File to copy from. + Must not be null.
    destFile - File to copy to. + Must not be null. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     boolean filtering)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a destination + specifying if token filtering should be used. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - File to copy from. + Must not be null.
    destFile - File to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy. +
    Throws: +
    java.io.IOException - if the copying fails.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     boolean filtering,
+                     boolean overwrite)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a + destination specifying if token filtering should be used and if + source files may overwrite newer destination files. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - File to copy from. + Must not be null.
    destFile - File to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy.
    overwrite - Whether or not the destination file should be + overwritten if it already exists. +
    Throws: +
    java.io.IOException - if the file cannot be copied.
    +
    +
    +
    + +

    +copyFile

    +
    +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     boolean filtering,
+                     boolean overwrite,
+                     boolean preserveLastModified)
+              throws java.io.IOException
    +
    +
    Deprecated. since 1.4.x +

    +

    Convenience method to copy a file from a source to a + destination specifying if token filtering should be used, if + source files may overwrite newer destination files, and if the + last modified time of the resulting file should be set to + that of the source file. +

    +

    +
    +
    +
    +
    Parameters:
    sourceFile - File to copy from. + Must not be null.
    destFile - File to copy to. + Must not be null.
    filtering - Whether or not token filtering should be used during + the copy.
    overwrite - Whether or not the destination file should be + overwritten if it already exists.
    preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file. +
    Throws: +
    java.io.IOException - if the file cannot be copied.
    +
    +
    +
    + +

    +setFileLastModified

    +
    +public void setFileLastModified(java.io.File file,
+                                long time)
+                         throws BuildException
    +
    +
    Deprecated. since 1.4.x +

    +

    Call File.setLastModified(long time) on Java above 1.1, and logs + a warning on Java 1.1. +

    +

    +
    +
    +
    +
    Parameters:
    file - The file to set the last modified time on. + Must not be null.
    time - the required modification time. +
    Throws: +
    BuildException - if the last modified time cannot be set + despite running on a platform with a version + above 1.1.
    +
    +
    +
    + +

    +toBoolean

    +
    +public static boolean toBoolean(java.lang.String s)
    +
    +
    Return the boolean equivalent of a string, which is considered + true if either "on", "true", + or "yes" is found, ignoring case. +

    +

    +
    +
    +
    +
    Parameters:
    s - The string to convert to a boolean value. +
    Returns:
    true if the given string is "on", + "true" or "yes", or + false otherwise.
    +
    +
    +
    + +

    +getProject

    +
    +public static Project getProject(java.lang.Object o)
    +
    +
    Get the Project instance associated with the specified object. +

    +

    +
    +
    +
    +
    Parameters:
    o - the object to query. +
    Returns:
    Project instance, if any.
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    +
    + +

    +topoSort

    +
    +public final java.util.Vector topoSort(java.lang.String root,
+                                       java.util.Hashtable targetTable)
+                                throws BuildException
    +
    +
    Topologically sort a set of targets. Equivalent to calling + topoSort(new String[] {root}, targets, true). +

    +

    +
    +
    +
    +
    Parameters:
    root - The name of the root target. The sort is created in such + a way that the sequence of Targets up to the root + target is the minimum possible such sequence. + Must not be null.
    targetTable - A Hashtable mapping names to Targets. + Must not be null. +
    Returns:
    a Vector of ALL Target objects in sorted order. +
    Throws: +
    BuildException - if there is a cyclic dependency among the + targets, or if a named target does not exist.
    +
    +
    +
    + +

    +topoSort

    +
    +public final java.util.Vector topoSort(java.lang.String root,
+                                       java.util.Hashtable targetTable,
+                                       boolean returnAll)
+                                throws BuildException
    +
    +
    Topologically sort a set of targets. Equivalent to calling + topoSort(new String[] {root}, targets, returnAll). +

    +

    +
    +
    +
    +
    Parameters:
    root - The name of the root target. The sort is created in such + a way that the sequence of Targets up to the root + target is the minimum possible such sequence. + Must not be null.
    targetTable - A Hashtable mapping names to Targets. + Must not be null.
    returnAll - boolean indicating whether to return all + targets, or the execution sequence only. +
    Returns:
    a Vector of Target objects in sorted order. +
    Throws: +
    BuildException - if there is a cyclic dependency among the + targets, or if a named target does not exist.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +topoSort

    +
    +public final java.util.Vector topoSort(java.lang.String[] root,
+                                       java.util.Hashtable targetTable,
+                                       boolean returnAll)
+                                throws BuildException
    +
    +
    Topologically sort a set of targets. +

    +

    +
    +
    +
    +
    Parameters:
    root - String[] containing the names of the root targets. + The sort is created in such a way that the ordered sequence of + Targets is the minimum possible such sequence to the specified + root targets. + Must not be null.
    targetTable - A map of names to targets (String to Target). + Must not be null.
    returnAll - boolean indicating whether to return all + targets, or the execution sequence only. +
    Returns:
    a Vector of Target objects in sorted order. +
    Throws: +
    BuildException - if there is a cyclic dependency among the + targets, or if a named target does not exist.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +inheritIDReferences

    +
    +public void inheritIDReferences(Project parent)
    +
    +
    Inherit the id references. +

    +

    +
    +
    +
    +
    Parameters:
    parent - the parent project of this project.
    +
    +
    +
    + +

    +addIdReference

    +
    +public void addIdReference(java.lang.String id,
+                           java.lang.Object value)
    +
    +
    Add an id reference. + Used for broken build files. +

    +

    +
    +
    +
    +
    Parameters:
    id - the id to set.
    value - the value to set it to (Unknown element in this case.
    +
    +
    +
    + +

    +addReference

    +
    +public void addReference(java.lang.String referenceName,
+                         java.lang.Object value)
    +
    +
    Add a reference to the project. +

    +

    +
    +
    +
    +
    Parameters:
    referenceName - The name of the reference. Must not be null.
    value - The value of the reference.
    +
    +
    +
    + +

    +getReferences

    +
    +public java.util.Hashtable getReferences()
    +
    +
    Return a map of the references in the project (String to Object). + The returned hashtable is "live" and so must not be modified. +

    +

    +
    +
    +
    + +
    Returns:
    a map of the references in the project (String to Object).
    +
    +
    +
    + +

    +hasReference

    +
    +public boolean hasReference(java.lang.String key)
    +
    +
    Does the project know this reference? +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getCopyOfReferences

    +
    +public java.util.Map getCopyOfReferences()
    +
    +
    Return a map of the references in the project (String to + Object). The returned hashtable is a copy of the + "live" references. +

    +

    +
    +
    +
    + +
    Returns:
    a map of the references in the project (String to Object).
    Since:
    +
    Ant 1.8.1
    +
    +
    +
    +
    + +

    +getReference

    +
    +public java.lang.Object getReference(java.lang.String key)
    +
    +
    Look up a reference by its key (ID). +

    +

    +
    +
    +
    +
    Parameters:
    key - The key for the desired reference. + Must not be null. +
    Returns:
    the reference with the specified ID, or null if + there is no such reference in the project.
    +
    +
    +
    + +

    +getElementName

    +
    +public java.lang.String getElementName(java.lang.Object element)
    +
    +
    Return a description of the type of the given element, with + special handling for instances of tasks and data types. +

    + This is useful for logging purposes. +

    +

    +
    +
    +
    +
    Parameters:
    element - The element to describe. + Must not be null. +
    Returns:
    a description of the element type.
    Since:
    +
    1.95, Ant 1.5
    +
    +
    +
    +
    + +

    +fireBuildStarted

    +
    +public void fireBuildStarted()
    +
    +
    Send a "build started" event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +fireBuildFinished

    +
    +public void fireBuildFinished(java.lang.Throwable exception)
    +
    +
    Send a "build finished" event to the build listeners + for this project. +

    +

    +
    +
    +
    +
    Parameters:
    exception - an exception indicating a reason for a build + failure. May be null, indicating + a successful build.
    +
    +
    +
    + +

    +fireSubBuildStarted

    +
    +public void fireSubBuildStarted()
    +
    +
    Send a "subbuild started" event to the build listeners for + this project. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +fireSubBuildFinished

    +
    +public void fireSubBuildFinished(java.lang.Throwable exception)
    +
    +
    Send a "subbuild finished" event to the build listeners for + this project. +

    +

    +
    +
    +
    +
    Parameters:
    exception - an exception indicating a reason for a build + failure. May be null, indicating + a successful build.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +fireTargetStarted

    +
    +protected void fireTargetStarted(Target target)
    +
    +
    Send a "target started" event to the build listeners + for this project. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target which is starting to build. + Must not be null.
    +
    +
    +
    + +

    +fireTargetFinished

    +
    +protected void fireTargetFinished(Target target,
+                                  java.lang.Throwable exception)
    +
    +
    Send a "target finished" event to the build listeners + for this project. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target which has finished building. + Must not be null.
    exception - an exception indicating a reason for a build + failure. May be null, indicating + a successful build.
    +
    +
    +
    + +

    +fireTaskStarted

    +
    +protected void fireTaskStarted(Task task)
    +
    +
    Send a "task started" event to the build listeners + for this project. +

    +

    +
    +
    +
    +
    Parameters:
    task - The target which is starting to execute. + Must not be null.
    +
    +
    +
    + +

    +fireTaskFinished

    +
    +protected void fireTaskFinished(Task task,
+                                java.lang.Throwable exception)
    +
    +
    Send a "task finished" event to the build listeners for this + project. +

    +

    +
    +
    +
    +
    Parameters:
    task - The task which has finished executing. + Must not be null.
    exception - an exception indicating a reason for a build + failure. May be null, indicating + a successful build.
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Project project,
+                                 java.lang.String message,
+                                 int priority)
    +
    +
    Send a "message logged" project level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    project - The project generating the event. + Should not be null.
    message - The message to send. Should not be null.
    priority - The priority of the message.
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Project project,
+                                 java.lang.String message,
+                                 java.lang.Throwable throwable,
+                                 int priority)
    +
    +
    Send a "message logged" project level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    project - The project generating the event. + Should not be null.
    message - The message to send. Should not be null.
    throwable - The exception that caused this message. May be null.
    priority - The priority of the message.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Target target,
+                                 java.lang.String message,
+                                 int priority)
    +
    +
    Send a "message logged" target level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target generating the event. + Must not be null.
    message - The message to send. Should not be null.
    priority - The priority of the message.
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Target target,
+                                 java.lang.String message,
+                                 java.lang.Throwable throwable,
+                                 int priority)
    +
    +
    Send a "message logged" target level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    target - The target generating the event. + Must not be null.
    message - The message to send. Should not be null.
    throwable - The exception that caused this message. May be null.
    priority - The priority of the message.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Task task,
+                                 java.lang.String message,
+                                 int priority)
    +
    +
    Send a "message logged" task level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    task - The task generating the event. + Must not be null.
    message - The message to send. Should not be null.
    priority - The priority of the message.
    +
    +
    +
    + +

    +fireMessageLogged

    +
    +protected void fireMessageLogged(Task task,
+                                 java.lang.String message,
+                                 java.lang.Throwable throwable,
+                                 int priority)
    +
    +
    Send a "message logged" task level event + to the build listeners for this project. +

    +

    +
    +
    +
    +
    Parameters:
    task - The task generating the event. + Must not be null.
    message - The message to send. Should not be null.
    throwable - The exception that caused this message. May be null.
    priority - The priority of the message.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +registerThreadTask

    +
    +public void registerThreadTask(java.lang.Thread thread,
+                               Task task)
    +
    +
    Register a task as the current task for a thread. + If the task is null, the thread's entry is removed. +

    +

    +
    +
    +
    +
    Parameters:
    thread - the thread on which the task is registered.
    task - the task to be registered.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getThreadTask

    +
    +public Task getThreadTask(java.lang.Thread thread)
    +
    +
    Get the current task associated with a thread, if any. +

    +

    +
    +
    +
    +
    Parameters:
    thread - the thread for which the task is required. +
    Returns:
    the task which is currently registered for the given thread or + null if no task is registered.
    +
    +
    +
    + +

    +setProjectReference

    +
    +public final void setProjectReference(java.lang.Object obj)
    +
    +
    Set a reference to this Project on the parameterized object. + Need to set the project before other set/add elements + are called. +

    +

    +
    +
    +
    +
    Parameters:
    obj - the object to invoke setProject(this) on.
    +
    +
    +
    + +

    +getResource

    +
    +public Resource getResource(java.lang.String name)
    +
    +
    Resolve the file relative to the project's basedir and return it as a + FileResource. +

    +

    +
    Specified by:
    getResource in interface ResourceFactory
    +
    +
    +
    Parameters:
    name - the name of the file to resolve. +
    Returns:
    the file resource.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectComponent.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectComponent.html new file mode 100644 index 000000000..9eec2e00e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectComponent.html @@ -0,0 +1,570 @@ + + + + + + +ProjectComponent (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ProjectComponent

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    AbstractScriptComponent, Commandline.Argument, Concat.TextElement, ConditionBase, DataType, FailureRecorder, FileTokenizer, HasMethod, Http, IsFalse, IsLastModified, IsReachable, IsReference, IsSet, IsTrue, Javadoc.ExtensionInfo, LineTokenizer, Matches, Message, ParserSupports, Provider, ResourceExists, Service, Socket, StringTokenizer, Task, TokenFilter.ChainableReaderFilter, TokenFilter.ContainsString, TokenFilter.DeleteCharacters, TypeFound, XMLFragment
    +
    +
    +
    +
    public abstract class ProjectComponent
    extends java.lang.Object
    implements java.lang.Cloneable
    + + +

    +Base class for components of a project, including tasks and data types. + Provides common facilities. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.Stringdescription + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly.
    +protected  Locationlocation + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getLocation() method.
    +protected  Projectproject + +
    +          Deprecated. since 1.6.x. + You should not be directly accessing this variable directly. + You should access project object via the getProject() + or setProject() accessor/mutators.
    +  + + + + + + + + + + +
    +Constructor Summary
    ProjectComponent() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Objectclone() + +
    +           
    + java.lang.StringgetDescription() + +
    +          Returns the description of the current action.
    + LocationgetLocation() + +
    +          Returns the file/location where this task was defined.
    + ProjectgetProject() + +
    +          Returns the project to which this component belongs.
    + voidlog(java.lang.String msg) + +
    +          Logs a message with the default (INFO) priority.
    + voidlog(java.lang.String msg, + int msgLevel) + +
    +          Logs a message with the given priority.
    + voidsetDescription(java.lang.String desc) + +
    +          Sets a description of the current action.
    + voidsetLocation(Location location) + +
    +          Sets the file/location where this task was defined.
    + voidsetProject(Project project) + +
    +          Sets the project object of this component.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +project

    +
    +protected Project project
    +
    +
    Deprecated. since 1.6.x. + You should not be directly accessing this variable directly. + You should access project object via the getProject() + or setProject() accessor/mutators.
    Project object of this component. +

    +

    +
    +
    +
    + +

    +location

    +
    +protected Location location
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getLocation() method.
    Location within the build file of this task definition. +

    +

    +
    +
    +
    + +

    +description

    +
    +protected java.lang.String description
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly.
    Description of this component, if any. +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectComponent

    +
    +public ProjectComponent()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Sets the project object of this component. This method is used by + Project when a component is added to it so that the component has + access to the functions of the project. It should not be used + for any other purpose. +

    +

    +
    +
    +
    +
    Parameters:
    project - Project in whose scope this component belongs. + Must not be null.
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Returns the project to which this component belongs. +

    +

    +
    +
    +
    + +
    Returns:
    the components's project.
    +
    +
    +
    + +

    +getLocation

    +
    +public Location getLocation()
    +
    +
    Returns the file/location where this task was defined. +

    +

    +
    +
    +
    + +
    Returns:
    the file/location where this task was defined. + Should not return null. Location.UNKNOWN_LOCATION + is used for unknown locations.
    See Also:
    Location.UNKNOWN_LOCATION
    +
    +
    +
    + +

    +setLocation

    +
    +public void setLocation(Location location)
    +
    +
    Sets the file/location where this task was defined. +

    +

    +
    +
    +
    +
    Parameters:
    location - The file/location where this task was defined. + Should not be null--use + Location.UNKNOWN_LOCATION if the location isn't known.
    See Also:
    Location.UNKNOWN_LOCATION
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String desc)
    +
    +
    Sets a description of the current action. This may be used for logging + purposes. +

    +

    +
    +
    +
    +
    Parameters:
    desc - Description of the current action. + May be null, indicating that no description is + available.
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    Returns the description of the current action. +

    +

    +
    +
    +
    + +
    Returns:
    the description of the current action, or null if + no description is available.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String msg)
    +
    +
    Logs a message with the default (INFO) priority. +

    +

    +
    +
    +
    +
    Parameters:
    msg - The message to be logged. Should not be null.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String msg,
+                int msgLevel)
    +
    +
    Logs a message with the given priority. +

    +

    +
    +
    +
    +
    Parameters:
    msg - The message to be logged. Should not be null.
    msgLevel - the message priority at which this message is + to be logged.
    +
    +
    +
    + +

    +clone

    +
    +public java.lang.Object clone()
+                       throws java.lang.CloneNotSupportedException
    +
    +
    +
    Overrides:
    clone in class java.lang.Object
    +
    +
    + +
    Returns:
    a shallow copy of this projectcomponent. +
    Throws: +
    java.lang.CloneNotSupportedException - does not happen, + but is declared to allow subclasses to do so.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.OnMissingExtensionPoint.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.OnMissingExtensionPoint.html new file mode 100644 index 000000000..b1e003501 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.OnMissingExtensionPoint.html @@ -0,0 +1,347 @@ + + + + + + +ProjectHelper.OnMissingExtensionPoint (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ProjectHelper.OnMissingExtensionPoint

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectHelper.OnMissingExtensionPoint
+
    +
    +
    Enclosing class:
    ProjectHelper
    +
    +
    +
    +
    public static final class ProjectHelper.OnMissingExtensionPoint
    extends java.lang.Object
    + + +

    +Possible value for target's onMissingExtensionPoint attribute. It determines how to deal with + targets that want to extend missing extension-points. +

    + This class behaves like a Java 1.5 Enum class. +

    + +

    +

    +
    Since:
    +
    1.8.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static ProjectHelper.OnMissingExtensionPointFAIL + +
    +          fail if the extension-point is not defined
    +static ProjectHelper.OnMissingExtensionPointIGNORE + +
    +          ignore the extensionOf attribute if the extension-point is not defined
    +static ProjectHelper.OnMissingExtensionPointWARN + +
    +          warn if the extension-point is not defined
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringname() + +
    +           
    + java.lang.StringtoString() + +
    +           
    +static ProjectHelper.OnMissingExtensionPointvalueOf(java.lang.String name) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FAIL

    +
    +public static final ProjectHelper.OnMissingExtensionPoint FAIL
    +
    +
    fail if the extension-point is not defined +

    +

    +
    +
    +
    + +

    +WARN

    +
    +public static final ProjectHelper.OnMissingExtensionPoint WARN
    +
    +
    warn if the extension-point is not defined +

    +

    +
    +
    +
    + +

    +IGNORE

    +
    +public static final ProjectHelper.OnMissingExtensionPoint IGNORE
    +
    +
    ignore the extensionOf attribute if the extension-point is not defined +

    +

    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +name

    +
    +public java.lang.String name()
    +
    +
    +
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    +
    +
    +
    +
    + +

    +valueOf

    +
    +public static ProjectHelper.OnMissingExtensionPoint valueOf(java.lang.String name)
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.html new file mode 100644 index 000000000..ccf497233 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelper.html @@ -0,0 +1,1202 @@ + + + + + + +ProjectHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ProjectHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectHelper
+
    +
    +
    Direct Known Subclasses:
    ProjectHelper2, ProjectHelperImpl
    +
    +
    +
    +
    public class ProjectHelper
    extends java.lang.Object
    + + +

    +Configures a Project (complete with Targets and Tasks) based on + a build file. It'll rely on a plugin to do the actual processing + of the file. +

    + This class also provide static wrappers for common introspection. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classProjectHelper.OnMissingExtensionPoint + +
    +          Possible value for target's onMissingExtensionPoint attribute.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringANT_CORE_URI + +
    +          The URI for ant name space
    +static java.lang.StringANT_CURRENT_URI + +
    +          The URI for antlib current definitions
    +static java.lang.StringANT_TYPE + +
    +          Polymorphic attribute
    +static java.lang.StringANTLIB_URI + +
    +          The URI for defined types/tasks - the format is antlib:
    +static java.lang.StringHELPER_PROPERTY + +
    +          Name of JVM system property which provides the name of the + ProjectHelper class to use.
    +static java.lang.StringPROJECTHELPER_REFERENCE + +
    +          name of project helper reference that we add to a project
    +static java.lang.StringSERVICE_ID + +
    +          The service identifier in jars which provide Project Helper + implementations.
    +  + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper() + +
    +          Default constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static BuildExceptionaddLocationToBuildException(BuildException ex, + Location newLocation) + +
    +          Add location to build exception.
    +static voidaddText(Project project, + java.lang.Object target, + char[] buf, + int start, + int count) + +
    +          Adds the content of #PCDATA sections to an element.
    +static voidaddText(Project project, + java.lang.Object target, + java.lang.String text) + +
    +          Adds the content of #PCDATA sections to an element.
    + booleancanParseAntlibDescriptor(Resource r) + +
    +          Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task.
    + booleancanParseBuildFile(Resource buildFile) + +
    +          Check if the helper supports the kind of file.
    +static voidconfigure(java.lang.Object target, + org.xml.sax.AttributeList attrs, + Project project) + +
    +          Deprecated. since 1.6.x. + Use IntrospectionHelper for each property.
    +static voidconfigureProject(Project project, + java.io.File buildFile) + +
    +          Configures the project with the contents of the specified build file.
    +static java.lang.StringextractNameFromComponentName(java.lang.String componentName) + +
    +          extract the element name from a component name
    +static java.lang.StringextractUriFromComponentName(java.lang.String componentName) + +
    +          extract a uri from a component name
    +static java.lang.StringgenComponentName(java.lang.String uri, + java.lang.String name) + +
    +          Map a namespaced {uri,name} to an internal string format.
    +static java.lang.ClassLoadergetContextClassLoader() + +
    +          Deprecated. since 1.6.x. + Use LoaderUtils.getContextClassLoader()
    +static java.lang.StringgetCurrentPrefixSeparator() + +
    +          The separator between the prefix and the target name.
    +static java.lang.StringgetCurrentTargetPrefix() + +
    +          The prefix to prepend to imported target names.
    + java.lang.StringgetDefaultBuildFile() + +
    +          The file name of the build script to be parsed if none specified on the command line
    + java.util.ListgetExtensionStack() + +
    +          Extension stack.
    + java.util.VectorgetImportStack() + +
    +          Import stack.
    +static ProjectHelpergetProjectHelper() + +
    +          Get the first project helper found in the classpath
    +static booleanisInIncludeMode() + +
    +          Whether the current file should be read in include as opposed + to import mode.
    + voidparse(Project project, + java.lang.Object source) + +
    +          Parses the project file, configuring the project as it goes.
    + UnknownElementparseAntlibDescriptor(Project containingProject, + Resource source) + +
    +          Parse the given URL as an antlib descriptor and return the + content as something that can be turned into an Antlib task.
    +static voidparsePropertyString(java.lang.String value, + java.util.Vector fragments, + java.util.Vector propertyRefs) + +
    +          Deprecated. since 1.6.x. + Use PropertyHelper.
    +static java.lang.StringreplaceProperties(Project project, + java.lang.String value) + +
    +          Deprecated. since 1.6.x. + Use project.replaceProperties().
    +static java.lang.StringreplaceProperties(Project project, + java.lang.String value, + java.util.Hashtable keys) + +
    +          Deprecated. since 1.6.x. + Use PropertyHelper.
    +static voidsetCurrentPrefixSeparator(java.lang.String sep) + +
    +          Sets the separator between the prefix and the target name.
    +static voidsetCurrentTargetPrefix(java.lang.String prefix) + +
    +          Sets the prefix to prepend to imported target names.
    +static voidsetInIncludeMode(boolean includeMode) + +
    +          Sets whether the current file should be read in include as + opposed to import mode.
    +static voidstoreChild(Project project, + java.lang.Object parent, + java.lang.Object child, + java.lang.String tag) + +
    +          Stores a configured child element within its parent object.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ANT_CORE_URI

    +
    +public static final java.lang.String ANT_CORE_URI
    +
    +
    The URI for ant name space +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_CURRENT_URI

    +
    +public static final java.lang.String ANT_CURRENT_URI
    +
    +
    The URI for antlib current definitions +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANTLIB_URI

    +
    +public static final java.lang.String ANTLIB_URI
    +
    +
    The URI for defined types/tasks - the format is antlib: +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_TYPE

    +
    +public static final java.lang.String ANT_TYPE
    +
    +
    Polymorphic attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +HELPER_PROPERTY

    +
    +public static final java.lang.String HELPER_PROPERTY
    +
    +
    Name of JVM system property which provides the name of the + ProjectHelper class to use. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +SERVICE_ID

    +
    +public static final java.lang.String SERVICE_ID
    +
    +
    The service identifier in jars which provide Project Helper + implementations. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECTHELPER_REFERENCE

    +
    +public static final java.lang.String PROJECTHELPER_REFERENCE
    +
    +
    name of project helper reference that we add to a project +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper

    +
    +public ProjectHelper()
    +
    +
    Default constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +configureProject

    +
    +public static void configureProject(Project project,
+                                    java.io.File buildFile)
+                             throws BuildException
    +
    +
    Configures the project with the contents of the specified build file. +

    +

    +
    Parameters:
    project - The project to configure. Must not be null.
    buildFile - A build file giving the project's configuration. + Must not be null. +
    Throws: +
    BuildException - if the configuration is invalid or cannot be read
    +
    +
    +
    + +

    +getImportStack

    +
    +public java.util.Vector getImportStack()
    +
    +
    Import stack. + Used to keep track of imported files. Error reporting should + display the import path. +

    +

    + +
    Returns:
    the stack of import source objects.
    +
    +
    +
    + +

    +getExtensionStack

    +
    +public java.util.List getExtensionStack()
    +
    +
    Extension stack. + Used to keep track of targets that extend extension points. +

    +

    + +
    Returns:
    a list of three element string arrays where the first + element is the name of the extensionpoint, the second the name + of the target and the third the name of the enum like class + ProjectHelper.OnMissingExtensionPoint.
    +
    +
    +
    + +

    +getCurrentTargetPrefix

    +
    +public static java.lang.String getCurrentTargetPrefix()
    +
    +
    The prefix to prepend to imported target names. + +

    May be set by <import>'s as attribute.

    +

    +

    + +
    Returns:
    the configured prefix or null
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCurrentTargetPrefix

    +
    +public static void setCurrentTargetPrefix(java.lang.String prefix)
    +
    +
    Sets the prefix to prepend to imported target names. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getCurrentPrefixSeparator

    +
    +public static java.lang.String getCurrentPrefixSeparator()
    +
    +
    The separator between the prefix and the target name. + +

    May be set by <import>'s prefixSeperator attribute.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCurrentPrefixSeparator

    +
    +public static void setCurrentPrefixSeparator(java.lang.String sep)
    +
    +
    Sets the separator between the prefix and the target name. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +isInIncludeMode

    +
    +public static boolean isInIncludeMode()
    +
    +
    Whether the current file should be read in include as opposed + to import mode. + +

    In include mode included targets are only known by their + prefixed names and their depends lists get rewritten so that + all dependencies get the prefix as well.

    + +

    In import mode imported targets are known by an adorned as + well as a prefixed name and the unadorned target may be + overwritten in the importing build file. The depends list of + the imported targets is not modified at all.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setInIncludeMode

    +
    +public static void setInIncludeMode(boolean includeMode)
    +
    +
    Sets whether the current file should be read in include as + opposed to import mode. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +parse

    +
    +public void parse(Project project,
+                  java.lang.Object source)
+           throws BuildException
    +
    +
    Parses the project file, configuring the project as it goes. +

    +

    +
    Parameters:
    project - The project for the resulting ProjectHelper to configure. + Must not be null.
    source - The source for XML configuration. A helper must support + at least File, for backward compatibility. Helpers may + support URL, InputStream, etc or specialized types. +
    Throws: +
    BuildException - if the configuration is invalid or cannot + be read
    Since:
    +
    Ant1.5
    +
    +
    +
    +
    + +

    +getProjectHelper

    +
    +public static ProjectHelper getProjectHelper()
    +
    +
    Get the first project helper found in the classpath +

    +

    + +
    Returns:
    an project helper, never null
    See Also:
    ProjectHelperRepository.getHelpers()
    +
    +
    +
    + +

    +getContextClassLoader

    +
    +public static java.lang.ClassLoader getContextClassLoader()
    +
    +
    Deprecated. since 1.6.x. + Use LoaderUtils.getContextClassLoader() +

    +

    JDK1.1 compatible access to the context class loader. Cut & paste from JAXP. +

    +

    + +
    Returns:
    the current context class loader, or null + if the context class loader is unavailable.
    +
    +
    +
    + +

    +configure

    +
    +public static void configure(java.lang.Object target,
+                             org.xml.sax.AttributeList attrs,
+                             Project project)
+                      throws BuildException
    +
    +
    Deprecated. since 1.6.x. + Use IntrospectionHelper for each property. +

    +

    Configures an object using an introspection handler. +

    +

    +
    Parameters:
    target - The target object to be configured. + Must not be null.
    attrs - A list of attributes to configure within the target. + Must not be null.
    project - The project containing the target. + Must not be null. +
    Throws: +
    BuildException - if any of the attributes can't be handled by + the target
    +
    +
    +
    + +

    +addText

    +
    +public static void addText(Project project,
+                           java.lang.Object target,
+                           char[] buf,
+                           int start,
+                           int count)
+                    throws BuildException
    +
    +
    Adds the content of #PCDATA sections to an element. +

    +

    +
    Parameters:
    project - The project containing the target. + Must not be null.
    target - The target object to be configured. + Must not be null.
    buf - A character array of the text within the element. + Will not be null.
    start - The start element in the array.
    count - The number of characters to read from the array. +
    Throws: +
    BuildException - if the target object doesn't accept text
    +
    +
    +
    + +

    +addText

    +
    +public static void addText(Project project,
+                           java.lang.Object target,
+                           java.lang.String text)
+                    throws BuildException
    +
    +
    Adds the content of #PCDATA sections to an element. +

    +

    +
    Parameters:
    project - The project containing the target. + Must not be null.
    target - The target object to be configured. + Must not be null.
    text - Text to add to the target. + May be null, in which case this + method call is a no-op. +
    Throws: +
    BuildException - if the target object doesn't accept text
    +
    +
    +
    + +

    +storeChild

    +
    +public static void storeChild(Project project,
+                              java.lang.Object parent,
+                              java.lang.Object child,
+                              java.lang.String tag)
    +
    +
    Stores a configured child element within its parent object. +

    +

    +
    Parameters:
    project - Project containing the objects. + May be null.
    parent - Parent object to add child to. + Must not be null.
    child - Child object to store in parent. + Should not be null.
    tag - Name of element which generated the child. + May be null, in which case + the child is not stored.
    +
    +
    +
    + +

    +replaceProperties

    +
    +public static java.lang.String replaceProperties(Project project,
+                                                 java.lang.String value)
+                                          throws BuildException
    +
    +
    Deprecated. since 1.6.x. + Use project.replaceProperties(). +

    +

    Replaces ${xxx} style constructions in the given value with + the string value of the corresponding properties. +

    +

    +
    Parameters:
    project - The project containing the properties to replace. + Must not be null.
    value - The string to be scanned for property references. + May be null. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    Since:
    +
    1.5
    +
    +
    +
    +
    + +

    +replaceProperties

    +
    +public static java.lang.String replaceProperties(Project project,
+                                                 java.lang.String value,
+                                                 java.util.Hashtable keys)
+                                          throws BuildException
    +
    +
    Deprecated. since 1.6.x. + Use PropertyHelper. +

    +

    Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types. +

    +

    +
    Parameters:
    project - The container project. This is used solely for + logging purposes. Must not be null.
    value - The string to be scanned for property references. + May be null, in which case this + method returns immediately with no effect.
    keys - Mapping (String to String) of property names to their + values. Must not be null. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    +
    +
    +
    + +

    +parsePropertyString

    +
    +public static void parsePropertyString(java.lang.String value,
+                                       java.util.Vector fragments,
+                                       java.util.Vector propertyRefs)
+                                throws BuildException
    +
    +
    Deprecated. since 1.6.x. + Use PropertyHelper. +

    +

    Parses a string containing ${xxx} style property + references into two lists. The first list is a collection + of text fragments, while the other is a set of string property names. + null entries in the first list indicate a property + reference from the second list. + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself.

    +

    +

    +
    Parameters:
    value - Text to parse. Must not be null.
    fragments - List to add text fragments to. + Must not be null.
    propertyRefs - List to add property names to. + Must not be null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing }
    +
    +
    +
    + +

    +genComponentName

    +
    +public static java.lang.String genComponentName(java.lang.String uri,
+                                                java.lang.String name)
    +
    +
    Map a namespaced {uri,name} to an internal string format. + For BC purposes the names from the ant core uri will be + mapped to "name", other names will be mapped to + uri + ":" + name. +

    +

    +
    Parameters:
    uri - The namepace URI
    name - The localname +
    Returns:
    The stringified form of the ns name
    +
    +
    +
    + +

    +extractUriFromComponentName

    +
    +public static java.lang.String extractUriFromComponentName(java.lang.String componentName)
    +
    +
    extract a uri from a component name +

    +

    +
    Parameters:
    componentName - The stringified form for {uri, name} +
    Returns:
    The uri or "" if not present
    +
    +
    +
    + +

    +extractNameFromComponentName

    +
    +public static java.lang.String extractNameFromComponentName(java.lang.String componentName)
    +
    +
    extract the element name from a component name +

    +

    +
    Parameters:
    componentName - The stringified form for {uri, name} +
    Returns:
    The element name of the component
    +
    +
    +
    + +

    +addLocationToBuildException

    +
    +public static BuildException addLocationToBuildException(BuildException ex,
+                                                         Location newLocation)
    +
    +
    Add location to build exception. +

    +

    +
    Parameters:
    ex - the build exception, if the build exception + does not include
    newLocation - the location of the calling task (may be null) +
    Returns:
    a new build exception based in the build exception with + location set to newLocation. If the original exception + did not have a location, just return the build exception
    +
    +
    +
    + +

    +canParseAntlibDescriptor

    +
    +public boolean canParseAntlibDescriptor(Resource r)
    +
    +
    Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task. + +

    This method should not try to parse the content of the + descriptor, the URL is only given as an argument to allow + subclasses to decide whether they can support a given URL + scheme or not.

    + +

    Subclasses that return true in this method must also + override parseAntlibDescriptor.

    + +

    This implementation returns false.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +parseAntlibDescriptor

    +
    +public UnknownElement parseAntlibDescriptor(Project containingProject,
+                                            Resource source)
    +
    +
    Parse the given URL as an antlib descriptor and return the + content as something that can be turned into an Antlib task. +

    +

    +
    Since:
    +
    ant 1.8.0
    +
    +
    +
    +
    + +

    +canParseBuildFile

    +
    +public boolean canParseBuildFile(Resource buildFile)
    +
    +
    Check if the helper supports the kind of file. Some basic check on the + extension's file should be done here. +

    +

    +
    Parameters:
    buildFile - the file expected to be parsed (never null) +
    Returns:
    true if the helper supports it
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getDefaultBuildFile

    +
    +public java.lang.String getDefaultBuildFile()
    +
    +
    The file name of the build script to be parsed if none specified on the command line +

    +

    + +
    Returns:
    the name of the default file (never null)
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelperRepository.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelperRepository.html new file mode 100644 index 000000000..d2028a676 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/ProjectHelperRepository.html @@ -0,0 +1,360 @@ + + + + + + +ProjectHelperRepository (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class ProjectHelperRepository

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectHelperRepository
+
    +
    +
    +
    public class ProjectHelperRepository
    extends java.lang.Object
    + + +

    +Repository of ProjectHelper found in the classpath or via + some System properties. + +

    See the ProjectHelper documentation in the manual.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.util.IteratorgetHelpers() + +
    +          Get an iterator on the list of project helpers configured.
    +static ProjectHelperRepositorygetInstance() + +
    +           
    + ProjectHelpergetProjectHelperForAntlib(Resource antlib) + +
    +          Get the helper that will be able to parse the specified antlib.
    + ProjectHelpergetProjectHelperForBuildFile(Resource buildFile) + +
    +          Get the helper that will be able to parse the specified build file.
    + voidregisterProjectHelper(java.lang.Class helperClass) + +
    +          Register the specified project helper into the repository.
    + voidregisterProjectHelper(java.lang.String helperClassName) + +
    +          Register the specified project helper into the repository.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getInstance

    +
    +public static ProjectHelperRepository getInstance()
    +
    +
    +
    +
    +
    +
    + +

    +registerProjectHelper

    +
    +public void registerProjectHelper(java.lang.String helperClassName)
+                           throws BuildException
    +
    +
    Register the specified project helper into the repository. +

    + The helper will be added after all the already registered helpers, but + before the default one (ProjectHelper2) +

    +

    +
    Parameters:
    helperClassName - the fully qualified name of the helper +
    Throws: +
    BuildException - if the class cannot be loaded or if there is no constructor + with no argument
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +registerProjectHelper

    +
    +public void registerProjectHelper(java.lang.Class helperClass)
+                           throws BuildException
    +
    +
    Register the specified project helper into the repository. +

    + The helper will be added after all the already registered helpers, but + before the default one (ProjectHelper2) +

    +

    +
    Parameters:
    helperClass - the class of the helper +
    Throws: +
    BuildException - if there is no constructor with no argument
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +getProjectHelperForBuildFile

    +
    +public ProjectHelper getProjectHelperForBuildFile(Resource buildFile)
+                                           throws BuildException
    +
    +
    Get the helper that will be able to parse the specified build file. The helper + will be chosen among the ones found in the classpath +

    +

    + +
    Returns:
    the first ProjectHelper that fit the requirement (never null). +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +getProjectHelperForAntlib

    +
    +public ProjectHelper getProjectHelperForAntlib(Resource antlib)
+                                        throws BuildException
    +
    +
    Get the helper that will be able to parse the specified antlib. The helper + will be chosen among the ones found in the classpath +

    +

    + +
    Returns:
    the first ProjectHelper that fit the requirement (never null). +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +getHelpers

    +
    +public java.util.Iterator getHelpers()
    +
    +
    Get an iterator on the list of project helpers configured. The iterator + will always return at least one element as there will always be the + default project helper configured. +

    +

    + +
    Returns:
    an iterator of ProjectHelper
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.Delegate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.Delegate.html new file mode 100644 index 000000000..934a3ba97 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.Delegate.html @@ -0,0 +1,180 @@ + + + + + + +PropertyHelper.Delegate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface PropertyHelper.Delegate

    +
    +
    All Known Subinterfaces:
    PropertyExpander, PropertyHelper.PropertyEvaluator, PropertyHelper.PropertySetter
    +
    +
    +
    All Known Implementing Classes:
    LocalProperties
    +
    +
    +
    Enclosing class:
    PropertyHelper
    +
    +
    +
    +
    public static interface PropertyHelper.Delegate
    + + +

    +Marker interface for a PropertyHelper delegate. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertyEvaluator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertyEvaluator.html new file mode 100644 index 000000000..a4720de09 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertyEvaluator.html @@ -0,0 +1,234 @@ + + + + + + +PropertyHelper.PropertyEvaluator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface PropertyHelper.PropertyEvaluator

    +
    +
    All Superinterfaces:
    PropertyHelper.Delegate
    +
    +
    +
    All Known Implementing Classes:
    LocalProperties
    +
    +
    +
    Enclosing class:
    PropertyHelper
    +
    +
    +
    +
    public static interface PropertyHelper.PropertyEvaluator
    extends PropertyHelper.Delegate
    + + +

    +Looks up a property's value based on its name. + +

    Can be used to look up properties in a different storage + than the project instance (like local properties for example) + or to implement custom "protocols" like Ant's + ${toString:refid} syntax.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Objectevaluate(java.lang.String property, + PropertyHelper propertyHelper) + +
    +          Evaluate a property.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +evaluate

    +
    +java.lang.Object evaluate(java.lang.String property,
+                          PropertyHelper propertyHelper)
    +
    +
    Evaluate a property. +

    +

    +
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    null if the property name could not be found, an + instance of NullReturn to indicate a property with a name that can be + matched but a value of null and the property's + value otherwise.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertySetter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertySetter.html new file mode 100644 index 000000000..d43a0d155 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.PropertySetter.html @@ -0,0 +1,264 @@ + + + + + + +PropertyHelper.PropertySetter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface PropertyHelper.PropertySetter

    +
    +
    All Superinterfaces:
    PropertyHelper.Delegate
    +
    +
    +
    All Known Implementing Classes:
    LocalProperties
    +
    +
    +
    Enclosing class:
    PropertyHelper
    +
    +
    +
    +
    public static interface PropertyHelper.PropertySetter
    extends PropertyHelper.Delegate
    + + +

    +Sets or overrides a property. + +

    Can be used to store properties in a different storage than + the project instance (like local properties for example).

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanset(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a property.
    + booleansetNew(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a *new" property.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setNew

    +
    +boolean setNew(java.lang.String property,
+               java.lang.Object value,
+               PropertyHelper propertyHelper)
    +
    +
    Set a *new" property. + +

    Should not replace the value of an existing property.

    +

    +

    +
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    +
    + +

    +set

    +
    +boolean set(java.lang.String property,
+            java.lang.Object value,
+            PropertyHelper propertyHelper)
    +
    +
    Set a property. + +

    May replace the value of an existing property.

    +

    +

    +
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.html new file mode 100644 index 000000000..5e5e19e99 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/PropertyHelper.html @@ -0,0 +1,1646 @@ + + + + + + +PropertyHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class PropertyHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.PropertyHelper
+
    +
    +
    All Implemented Interfaces:
    GetProperty
    +
    +
    +
    +
    public class PropertyHelper
    extends java.lang.Object
    implements GetProperty
    + + +

    +Deals with properties - substitution, dynamic properties, etc. + +

    This code has been heavily restructured for Ant 1.8.0. It is + expected that custom PropertyHelper implementation that used the + older chaining mechanism of Ant 1.6 won't work in all cases, and + its usage is deprecated. The preferred way to customize Ant's + property handling is by adding delegates of the appropriate subinterface + and have this implementation use them.

    + +

    When expanding a string that may contain + properties this class will delegate the actual parsing to parseProperties inside the ParseProperties class which in turn + uses the PropertyExpander delegates to find properties inside the string + and this class to expand the propertiy names found into the + corresponding values.

    + +

    When looking up a property value this class + will first consult all PropertyEvaluator delegates and fall back to an internal map of + "project properties" if no evaluator matched the property name.

    + +

    When setting a property value this class + will first consult all PropertySetter delegates and fall back to an internal map of + "project properties" if no setter matched the property name.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfacePropertyHelper.Delegate + +
    +          Marker interface for a PropertyHelper delegate.
    +static interfacePropertyHelper.PropertyEvaluator + +
    +          Looks up a property's value based on its name.
    +static interfacePropertyHelper.PropertySetter + +
    +          Sets or overrides a property.
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected PropertyHelper() + +
    +          Default constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(PropertyHelper.Delegate delegate) + +
    +          Add the specified delegate object to this PropertyHelper.
    + booleancontainsProperties(java.lang.String value) + +
    +          Learn whether a String contains replaceable properties.
    + voidcopyInheritedProperties(Project other) + +
    +          Copies all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument.
    + voidcopyUserProperties(Project other) + +
    +          Copies all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument.
    +protected static java.util.SetgetDelegateInterfaces(PropertyHelper.Delegate d) + +
    +          Get all Delegate interfaces (excluding Delegate itself) from the specified Delegate.
    +protected  java.util.ListgetDelegates(java.lang.Class type) + +
    +          Get the Collection of delegates of the specified type.
    + java.util.CollectiongetExpanders() + +
    +          Get the expanders.
    + java.util.HashtablegetInheritedProperties() + +
    +          Returns a copy of the inherited property hashtable
    +protected  java.util.HashtablegetInternalInheritedProperties() + +
    +          special back door for subclasses, internal access to the hashtables
    +protected  java.util.HashtablegetInternalProperties() + +
    +          special back door for subclasses, internal access to the hashtables
    +protected  java.util.HashtablegetInternalUserProperties() + +
    +          special back door for subclasses, internal access to the hashtables
    + PropertyHelpergetNext() + +
    +          Deprecated. use the delegate mechanism instead
    + ProjectgetProject() + +
    +          Get this PropertyHelper's Project.
    + java.util.HashtablegetProperties() + +
    +          Returns a copy of the properties table.
    +static java.lang.ObjectgetProperty(Project project, + java.lang.String name) + +
    +          A helper static method to get a property + from a particular project.
    + java.lang.ObjectgetProperty(java.lang.String name) + +
    +          Returns the value of a property, if it is set.
    + java.lang.ObjectgetProperty(java.lang.String ns, + java.lang.String name) + +
    +          Deprecated. namespaces are unnecessary.
    +static PropertyHelpergetPropertyHelper(Project project) + +
    +          Factory method to create a property processor.
    + java.lang.ObjectgetPropertyHook(java.lang.String ns, + java.lang.String name, + boolean user) + +
    +          Deprecated. PropertyHelper chaining is deprecated.
    + java.util.HashtablegetUserProperties() + +
    +          Returns a copy of the user property hashtable
    + java.lang.ObjectgetUserProperty(java.lang.String name) + +
    +          Returns the value of a user property, if it is set.
    + java.lang.ObjectgetUserProperty(java.lang.String ns, + java.lang.String name) + +
    +          Deprecated. namespaces are unnecessary.
    + java.lang.ObjectparseProperties(java.lang.String value) + +
    +          Decode properties from a String representation.
    + voidparsePropertyString(java.lang.String value, + java.util.Vector fragments, + java.util.Vector propertyRefs) + +
    +          Deprecated. use the other mechanisms of this class instead
    + java.lang.StringreplaceProperties(java.lang.String value) + +
    +          Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types.
    + java.lang.StringreplaceProperties(java.lang.String ns, + java.lang.String value, + java.util.Hashtable keys) + +
    +          Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types.
    + voidsetInheritedProperty(java.lang.String name, + java.lang.Object value) + +
    +          Sets an inherited user property, which cannot be overwritten by set/unset + property calls.
    + voidsetInheritedProperty(java.lang.String ns, + java.lang.String name, + java.lang.Object value) + +
    +          Deprecated. namespaces are unnecessary.
    +static voidsetNewProperty(Project project, + java.lang.String name, + java.lang.Object value) + +
    +          A helper static method to set a new property + from a particular project.
    + voidsetNewProperty(java.lang.String name, + java.lang.Object value) + +
    +          Sets a property if no value currently exists.
    + voidsetNewProperty(java.lang.String ns, + java.lang.String name, + java.lang.Object value) + +
    +          Deprecated. namespaces are unnecessary.
    + voidsetNext(PropertyHelper next) + +
    +          Deprecated. use the delegate mechanism instead
    + voidsetProject(Project p) + +
    +          Set the project for which this helper is performing property resolution.
    +static voidsetProperty(Project project, + java.lang.String name, + java.lang.Object value) + +
    +          A helper static method to set a property + from a particular project.
    + booleansetProperty(java.lang.String name, + java.lang.Object value, + boolean verbose) + +
    +          Default implementation of setProperty.
    + booleansetProperty(java.lang.String ns, + java.lang.String name, + java.lang.Object value, + boolean verbose) + +
    +          Deprecated. namespaces are unnecessary.
    + booleansetPropertyHook(java.lang.String ns, + java.lang.String name, + java.lang.Object value, + boolean inherited, + boolean user, + boolean isNew) + +
    +          Deprecated. PropertyHelper chaining is deprecated.
    + voidsetUserProperty(java.lang.String name, + java.lang.Object value) + +
    +          Sets a user property, which cannot be overwritten by + set/unset property calls.
    + voidsetUserProperty(java.lang.String ns, + java.lang.String name, + java.lang.Object value) + +
    +          Deprecated. namespaces are unnecessary.
    + booleantestIfCondition(java.lang.Object value) + +
    +          Returns true if the value is null or an empty string, can be + interpreted as a true value or cannot be interpreted as a false + value and a property of the value's name exists.
    + booleantestUnlessCondition(java.lang.Object value) + +
    +          Returns true if the value is null or an empty string, can be + interpreted as a false value or cannot be interpreted as a true + value and a property of the value's name doesn't exist.
    +static java.lang.BooleantoBoolean(java.lang.Object value) + +
    +          If the given object can be interpreted as a true/false value, + turn it into a matching Boolean - otherwise return null.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyHelper

    +
    +protected PropertyHelper()
    +
    +
    Default constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getProperty

    +
    +public static java.lang.Object getProperty(Project project,
+                                           java.lang.String name)
    +
    +
    A helper static method to get a property + from a particular project. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project in question.
    name - the property name +
    Returns:
    the value of the property if present, null otherwise.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setProperty

    +
    +public static void setProperty(Project project,
+                               java.lang.String name,
+                               java.lang.Object value)
    +
    +
    A helper static method to set a property + from a particular project. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project in question.
    name - the property name
    value - the value to use.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setNewProperty

    +
    +public static void setNewProperty(Project project,
+                                  java.lang.String name,
+                                  java.lang.Object value)
    +
    +
    A helper static method to set a new property + from a particular project. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project in question.
    name - the property name
    value - the value to use.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setProject

    +
    +public void setProject(Project p)
    +
    +
    Set the project for which this helper is performing property resolution. +

    +

    +
    +
    +
    +
    Parameters:
    p - the project instance.
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get this PropertyHelper's Project. +

    +

    +
    +
    +
    + +
    Returns:
    Project
    +
    +
    +
    + +

    +setNext

    +
    +public void setNext(PropertyHelper next)
    +
    +
    Deprecated. use the delegate mechanism instead +

    +

    Prior to Ant 1.8.0 there have been 2 ways to hook into property handling: + + - you can replace the main PropertyHelper. The replacement is required + to support the same semantics (of course :-) + + - you can chain a property helper capable of storing some properties. + Again, you are required to respect the immutability semantics (at + least for non-dynamic properties) + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself.

    +

    +

    +
    +
    +
    +
    Parameters:
    next - the next property helper in the chain.
    +
    +
    +
    + +

    +getNext

    +
    +public PropertyHelper getNext()
    +
    +
    Deprecated. use the delegate mechanism instead +

    +

    Get the next property helper in the chain. + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself except the setPropertyHook and getPropertyHook + methods in this class.

    +

    +

    +
    +
    +
    + +
    Returns:
    the next property helper.
    +
    +
    +
    + +

    +getPropertyHelper

    +
    +public static PropertyHelper getPropertyHelper(Project project)
    +
    +
    Factory method to create a property processor. + Users can provide their own or replace it using "ant.PropertyHelper" + reference. User tasks can also add themselves to the chain, and provide + dynamic properties. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project for which the property helper is required. +
    Returns:
    the project's property helper.
    +
    +
    +
    + +

    +getExpanders

    +
    +public java.util.Collection getExpanders()
    +
    +
    Get the expanders. +

    +

    +
    +
    +
    + +
    Returns:
    the expanders.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setPropertyHook

    +
    +public boolean setPropertyHook(java.lang.String ns,
+                               java.lang.String name,
+                               java.lang.Object value,
+                               boolean inherited,
+                               boolean user,
+                               boolean isNew)
    +
    +
    Deprecated. PropertyHelper chaining is deprecated. +

    +

    Sets a property. Any existing property of the same name + is overwritten, unless it is a user property. + + If all helpers return false, the property will be saved in + the default properties table by setProperty. + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace that the property is in (currently + not used.
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    inherited - True if this property is inherited (an [sub]ant[call] property).
    user - True if this property is a user property.
    isNew - True is this is a new property. +
    Returns:
    true if this helper has stored the property, false if it + couldn't. Each helper should delegate to the next one (unless it + has a good reason not to).
    +
    +
    +
    + +

    +getPropertyHook

    +
    +public java.lang.Object getPropertyHook(java.lang.String ns,
+                                        java.lang.String name,
+                                        boolean user)
    +
    +
    Deprecated. PropertyHelper chaining is deprecated. +

    +

    Get a property. If all hooks return null, the default + tables will be used. + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - namespace of the sought property.
    name - name of the sought property.
    user - True if this is a user property. +
    Returns:
    The property, if returned by a hook, or null if none.
    +
    +
    +
    + +

    +parsePropertyString

    +
    +public void parsePropertyString(java.lang.String value,
+                                java.util.Vector fragments,
+                                java.util.Vector propertyRefs)
+                         throws BuildException
    +
    +
    Deprecated. use the other mechanisms of this class instead +

    +

    Parses a string containing ${xxx} style property + references into two lists. The first list is a collection + of text fragments, while the other is a set of string property names. + null entries in the first list indicate a property + reference from the second list. + +

    Delegates to parsePropertyStringDefault.

    + +

    As of Ant 1.8.0 this method is never invoked by any code + inside of Ant itself except {ProjectHelper#parsePropertyString + ProjectHelper.parsePropertyString}.

    +

    +

    +
    +
    +
    +
    Parameters:
    value - Text to parse. Must not be null.
    fragments - List to add text fragments to. + Must not be null.
    propertyRefs - List to add property names to. + Must not be null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    +
    +
    +
    + +

    +replaceProperties

    +
    +public java.lang.String replaceProperties(java.lang.String ns,
+                                          java.lang.String value,
+                                          java.util.Hashtable keys)
+                                   throws BuildException
    +
    +
    Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types. + +

    Delegates to the one-arg version, completely ignoring the ns + and keys parameters.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property.
    value - The string to be scanned for property references. + May be null, in which case this + method returns immediately with no effect.
    keys - Mapping (String to String) of property names to their + values. If null, only project properties will + be used. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    +
    +
    +
    + +

    +replaceProperties

    +
    +public java.lang.String replaceProperties(java.lang.String value)
+                                   throws BuildException
    +
    +
    Replaces ${xxx} style constructions in the given value + with the string value of the corresponding data types. +

    +

    +
    +
    +
    +
    Parameters:
    value - The string to be scanned for property references. + May be null, in which case this + method returns immediately with no effect. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    +
    +
    +
    + +

    +parseProperties

    +
    +public java.lang.Object parseProperties(java.lang.String value)
+                                 throws BuildException
    +
    +
    Decode properties from a String representation. If the entire + contents of the String resolve to a single property, that value + is returned. Otherwise a String is returned. +

    +

    +
    +
    +
    +
    Parameters:
    value - The string to be scanned for property references. + May be null, in which case this + method returns immediately with no effect. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null. +
    Throws: +
    BuildException - if the string contains an opening + ${ without a closing + }
    +
    +
    +
    + +

    +containsProperties

    +
    +public boolean containsProperties(java.lang.String value)
    +
    +
    Learn whether a String contains replaceable properties. +

    +

    +
    +
    +
    +
    Parameters:
    value - the String to check. +
    Returns:
    true if value contains property notation.
    +
    +
    +
    + +

    +setProperty

    +
    +public boolean setProperty(java.lang.String ns,
+                           java.lang.String name,
+                           java.lang.Object value,
+                           boolean verbose)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Default implementation of setProperty. Will be called from Project. + This is the original 1.5 implementation, with calls to the hook + added. + +

    Delegates to the three-arg version, completely ignoring the + ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of the property.
    value - The value to set the property to.
    verbose - If this is true output extra log messages. +
    Returns:
    true if the property is set.
    +
    +
    +
    + +

    +setProperty

    +
    +public boolean setProperty(java.lang.String name,
+                           java.lang.Object value,
+                           boolean verbose)
    +
    +
    Default implementation of setProperty. Will be called from Project. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of the property.
    value - The value to set the property to.
    verbose - If this is true output extra log messages. +
    Returns:
    true if the property is set.
    +
    +
    +
    + +

    +setNewProperty

    +
    +public void setNewProperty(java.lang.String ns,
+                           java.lang.String name,
+                           java.lang.Object value)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Sets a property if no value currently exists. If the property + exists already, a message is logged and the method returns with + no other effect. + +

    Delegates to the two-arg version, completely ignoring the + ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setNewProperty

    +
    +public void setNewProperty(java.lang.String name,
+                           java.lang.Object value)
    +
    +
    Sets a property if no value currently exists. If the property + exists already, a message is logged and the method returns with + no other effect. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setUserProperty

    +
    +public void setUserProperty(java.lang.String ns,
+                            java.lang.String name,
+                            java.lang.Object value)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Sets a user property, which cannot be overwritten by + set/unset property calls. Any previous value is overwritten. + +

    Delegates to the two-arg version, completely ignoring the + ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    +
    +
    +
    + +

    +setUserProperty

    +
    +public void setUserProperty(java.lang.String name,
+                            java.lang.Object value)
    +
    +
    Sets a user property, which cannot be overwritten by + set/unset property calls. Any previous value is overwritten. + +

    Does not consult any delegates.

    +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    +
    +
    +
    + +

    +setInheritedProperty

    +
    +public void setInheritedProperty(java.lang.String ns,
+                                 java.lang.String name,
+                                 java.lang.Object value)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Sets an inherited user property, which cannot be overwritten by set/unset + property calls. Any previous value is overwritten. Also marks + these properties as properties that have not come from the + command line. + +

    Delegates to the two-arg version, completely ignoring the + ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    +
    +
    +
    + +

    +setInheritedProperty

    +
    +public void setInheritedProperty(java.lang.String name,
+                                 java.lang.Object value)
    +
    +
    Sets an inherited user property, which cannot be overwritten by set/unset + property calls. Any previous value is overwritten. Also marks + these properties as properties that have not come from the + command line. + +

    Does not consult any delegates.

    +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of property to set. + Must not be null.
    value - The new value of the property. + Must not be null.
    +
    +
    +
    + +

    +getProperty

    +
    +public java.lang.Object getProperty(java.lang.String ns,
+                                    java.lang.String name)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Returns the value of a property, if it is set. You can override + this method in order to plug your own storage. + +

    Delegates to the one-arg version ignoring the ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +getProperty

    +
    +public java.lang.Object getProperty(java.lang.String name)
    +
    +
    Returns the value of a property, if it is set. + +

    This is the method that is invoked by {Project#getProperty + Project.getProperty}.

    + +

    You can override this method in order to plug your own + storage but the recommended approach is to add your own + implementation of PropertyEvaluator + instead.

    +

    +

    +
    Specified by:
    getProperty in interface GetProperty
    +
    +
    +
    Parameters:
    name - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +getUserProperty

    +
    +public java.lang.Object getUserProperty(java.lang.String ns,
+                                        java.lang.String name)
    +
    +
    Deprecated. namespaces are unnecessary. +

    +

    Returns the value of a user property, if it is set. + +

    Delegates to the one-arg version ignoring the ns parameter.

    +

    +

    +
    +
    +
    +
    Parameters:
    ns - The namespace for the property (currently not used).
    name - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +getUserProperty

    +
    +public java.lang.Object getUserProperty(java.lang.String name)
    +
    +
    Returns the value of a user property, if it is set. + +

    Does not consult any delegates.

    +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of the property. + May be null, in which case + the return value is also null. +
    Returns:
    the property value, or null for no match + or if a null name is provided.
    +
    +
    +
    + +

    +getProperties

    +
    +public java.util.Hashtable getProperties()
    +
    +
    Returns a copy of the properties table. + +

    Does not contain properties held by implementations of + delegates (like local properties).

    +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing all properties (including user properties).
    +
    +
    +
    + +

    +getUserProperties

    +
    +public java.util.Hashtable getUserProperties()
    +
    +
    Returns a copy of the user property hashtable + +

    Does not contain properties held by implementations of + delegates (like local properties).

    +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing just the user properties
    +
    +
    +
    + +

    +getInheritedProperties

    +
    +public java.util.Hashtable getInheritedProperties()
    +
    +
    Returns a copy of the inherited property hashtable + +

    Does not contain properties held by implementations of + delegates (like local properties).

    +

    +

    +
    +
    +
    + +
    Returns:
    a hashtable containing just the inherited properties
    +
    +
    +
    + +

    +getInternalProperties

    +
    +protected java.util.Hashtable getInternalProperties()
    +
    +
    special back door for subclasses, internal access to the hashtables +

    +

    +
    +
    +
    + +
    Returns:
    the live hashtable of all properties
    +
    +
    +
    + +

    +getInternalUserProperties

    +
    +protected java.util.Hashtable getInternalUserProperties()
    +
    +
    special back door for subclasses, internal access to the hashtables +

    +

    +
    +
    +
    + +
    Returns:
    the live hashtable of user properties
    +
    +
    +
    + +

    +getInternalInheritedProperties

    +
    +protected java.util.Hashtable getInternalInheritedProperties()
    +
    +
    special back door for subclasses, internal access to the hashtables +

    +

    +
    +
    +
    + +
    Returns:
    the live hashtable inherited properties
    +
    +
    +
    + +

    +copyInheritedProperties

    +
    +public void copyInheritedProperties(Project other)
    +
    +
    Copies all user properties that have not been set on the + command line or a GUI tool from this instance to the Project + instance given as the argument. + +

    To copy all "user" properties, you will also have to call + copyUserProperties.

    + +

    Does not copy properties held by implementations of + delegates (like local properties).

    +

    +

    +
    +
    +
    +
    Parameters:
    other - the project to copy the properties to. Must not be null.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +copyUserProperties

    +
    +public void copyUserProperties(Project other)
    +
    +
    Copies all user properties that have been set on the command + line or a GUI tool from this instance to the Project instance + given as the argument. + +

    To copy all "user" properties, you will also have to call + copyInheritedProperties.

    + +

    Does not copy properties held by implementations of + delegates (like local properties).

    +

    +

    +
    +
    +
    +
    Parameters:
    other - the project to copy the properties to. Must not be null.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(PropertyHelper.Delegate delegate)
    +
    +
    Add the specified delegate object to this PropertyHelper. + Delegates are processed in LIFO order. +

    +

    +
    +
    +
    +
    Parameters:
    delegate - the delegate to add.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getDelegates

    +
    +protected java.util.List getDelegates(java.lang.Class type)
    +
    +
    Get the Collection of delegates of the specified type. +

    +

    +
    +
    +
    +
    Parameters:
    type - delegate type. +
    Returns:
    Collection.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getDelegateInterfaces

    +
    +protected static java.util.Set getDelegateInterfaces(PropertyHelper.Delegate d)
    +
    +
    Get all Delegate interfaces (excluding Delegate itself) from the specified Delegate. +

    +

    +
    +
    +
    +
    Parameters:
    d - the Delegate to inspect. +
    Returns:
    Set
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +toBoolean

    +
    +public static java.lang.Boolean toBoolean(java.lang.Object value)
    +
    +
    If the given object can be interpreted as a true/false value, + turn it into a matching Boolean - otherwise return null. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +testIfCondition

    +
    +public boolean testIfCondition(java.lang.Object value)
    +
    +
    Returns true if the value is null or an empty string, can be + interpreted as a true value or cannot be interpreted as a false + value and a property of the value's name exists. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +testUnlessCondition

    +
    +public boolean testUnlessCondition(java.lang.Object value)
    +
    +
    Returns true if the value is null or an empty string, can be + interpreted as a false value or cannot be interpreted as a true + value and a property of the value's name doesn't exist. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/RuntimeConfigurable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/RuntimeConfigurable.html new file mode 100644 index 000000000..bbc99c5b7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/RuntimeConfigurable.html @@ -0,0 +1,810 @@ + + + + + + +RuntimeConfigurable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class RuntimeConfigurable

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.RuntimeConfigurable
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class RuntimeConfigurable
    extends java.lang.Object
    implements java.io.Serializable
    + + +

    +Wrapper class that holds the attributes of an element, its children, and + any text within it. It then takes care of configuring that element at + runtime. +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    RuntimeConfigurable(java.lang.Object proxy, + java.lang.String elementTag) + +
    +          Sole constructor creating a wrapper for the specified object.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddChild(RuntimeConfigurable child) + +
    +          Adds a child element to the wrapped element.
    + voidaddText(char[] buf, + int start, + int count) + +
    +          Adds characters from #PCDATA areas to the wrapped element.
    + voidaddText(java.lang.String data) + +
    +          Adds characters from #PCDATA areas to the wrapped element.
    + voidapplyPreSet(RuntimeConfigurable r) + +
    +          Apply presets, attributes and text are set if not currently set.
    + java.util.HashtablegetAttributeMap() + +
    +          Return the attribute map.
    + org.xml.sax.AttributeListgetAttributes() + +
    +          Deprecated. Deprecated since Ant 1.6 in favor of getAttributeMap().
    + java.util.EnumerationgetChildren() + +
    +          Returns an enumeration of all child wrappers.
    + java.lang.StringgetElementTag() + +
    +          Returns the tag name of the wrapped element.
    + java.lang.StringgetId() + +
    +          Returns the id for this element.
    + java.lang.StringgetPolyType() + +
    +          Get the polymorphic type for this element.
    + java.lang.ObjectgetProxy() + +
    +          Get the object for which this RuntimeConfigurable holds the configuration + information.
    + java.lang.StringBuffergetText() + +
    +          Get the text content of this element.
    + voidmaybeConfigure(Project p) + +
    +          Configures the wrapped element and all its children.
    + voidmaybeConfigure(Project p, + boolean configureChildren) + +
    +          Configures the wrapped element.
    + voidreconfigure(Project p) + +
    +          Reconfigure the element, even if it has already been configured.
    + voidremoveAttribute(java.lang.String name) + +
    +          Delete an attribute.
    + voidsetAttribute(java.lang.String name, + java.lang.String value) + +
    +          Set an attribute to a given value.
    + voidsetAttributes(org.xml.sax.AttributeList attributes) + +
    +          Deprecated. since 1.6.x.
    + voidsetElementTag(java.lang.String elementTag) + +
    +          Set the element tag.
    + voidsetPolyType(java.lang.String polyType) + +
    +          Set the polymorphic type for this element.
    + voidsetProxy(java.lang.Object proxy) + +
    +          Sets the element to configure.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +RuntimeConfigurable

    +
    +public RuntimeConfigurable(java.lang.Object proxy,
+                           java.lang.String elementTag)
    +
    +
    Sole constructor creating a wrapper for the specified object. +

    +

    +
    Parameters:
    proxy - The element to configure. Must not be null.
    elementTag - The tag name generating this element.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProxy

    +
    +public void setProxy(java.lang.Object proxy)
    +
    +
    Sets the element to configure. +

    +

    +
    +
    +
    +
    Parameters:
    proxy - The element to configure. Must not be null.
    +
    +
    +
    + +

    +getProxy

    +
    +public java.lang.Object getProxy()
    +
    +
    Get the object for which this RuntimeConfigurable holds the configuration + information. +

    +

    +
    +
    +
    + +
    Returns:
    the object whose configure is held by this instance.
    +
    +
    +
    + +

    +getId

    +
    +public java.lang.String getId()
    +
    +
    Returns the id for this element. +

    +

    +
    +
    +
    + +
    Returns:
    the id.
    +
    +
    +
    + +

    +getPolyType

    +
    +public java.lang.String getPolyType()
    +
    +
    Get the polymorphic type for this element. +

    +

    +
    +
    +
    + +
    Returns:
    the ant component type name, null if not set.
    +
    +
    +
    + +

    +setPolyType

    +
    +public void setPolyType(java.lang.String polyType)
    +
    +
    Set the polymorphic type for this element. +

    +

    +
    +
    +
    +
    Parameters:
    polyType - the ant component type name, null if not set.
    +
    +
    +
    + +

    +setAttributes

    +
    +public void setAttributes(org.xml.sax.AttributeList attributes)
    +
    +
    Deprecated. since 1.6.x. +

    +

    Sets the attributes for the wrapped element. +

    +

    +
    +
    +
    +
    Parameters:
    attributes - List of attributes defined in the XML for this + element. May be null.
    +
    +
    +
    + +

    +setAttribute

    +
    +public void setAttribute(java.lang.String name,
+                         java.lang.String value)
    +
    +
    Set an attribute to a given value. +

    +

    +
    +
    +
    +
    Parameters:
    name - the name of the attribute.
    value - the attribute's value.
    +
    +
    +
    + +

    +removeAttribute

    +
    +public void removeAttribute(java.lang.String name)
    +
    +
    Delete an attribute. Not for the faint of heart. +

    +

    +
    +
    +
    +
    Parameters:
    name - the name of the attribute to be removed.
    +
    +
    +
    + +

    +getAttributeMap

    +
    +public java.util.Hashtable getAttributeMap()
    +
    +
    Return the attribute map. +

    +

    +
    +
    +
    + +
    Returns:
    Attribute name to attribute value map.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getAttributes

    +
    +public org.xml.sax.AttributeList getAttributes()
    +
    +
    Deprecated. Deprecated since Ant 1.6 in favor of getAttributeMap(). +

    +

    Returns the list of attributes for the wrapped element. +

    +

    +
    +
    +
    + +
    Returns:
    An AttributeList representing the attributes defined in the + XML for this element. May be null.
    +
    +
    +
    + +

    +addChild

    +
    +public void addChild(RuntimeConfigurable child)
    +
    +
    Adds a child element to the wrapped element. +

    +

    +
    +
    +
    +
    Parameters:
    child - The child element wrapper to add to this one. + Must not be null.
    +
    +
    +
    + +

    +getChildren

    +
    +public java.util.Enumeration getChildren()
    +
    +
    Returns an enumeration of all child wrappers. +

    +

    +
    +
    +
    + +
    Returns:
    an enumeration of the child wrappers.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String data)
    +
    +
    Adds characters from #PCDATA areas to the wrapped element. +

    +

    +
    +
    +
    +
    Parameters:
    data - Text to add to the wrapped element. + Should not be null.
    +
    +
    +
    + +

    +addText

    +
    +public void addText(char[] buf,
+                    int start,
+                    int count)
    +
    +
    Adds characters from #PCDATA areas to the wrapped element. +

    +

    +
    +
    +
    +
    Parameters:
    buf - A character array of the text within the element. + Must not be null.
    start - The start element in the array.
    count - The number of characters to read from the array.
    +
    +
    +
    + +

    +getText

    +
    +public java.lang.StringBuffer getText()
    +
    +
    Get the text content of this element. Various text chunks are + concatenated, there is no way ( currently ) of keeping track of + multiple fragments. +

    +

    +
    +
    +
    + +
    Returns:
    the text content of this element.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setElementTag

    +
    +public void setElementTag(java.lang.String elementTag)
    +
    +
    Set the element tag. +

    +

    +
    +
    +
    +
    Parameters:
    elementTag - The tag name generating this element.
    +
    +
    +
    + +

    +getElementTag

    +
    +public java.lang.String getElementTag()
    +
    +
    Returns the tag name of the wrapped element. +

    +

    +
    +
    +
    + +
    Returns:
    The tag name of the wrapped element. This is unlikely + to be null, but may be.
    +
    +
    +
    + +

    +maybeConfigure

    +
    +public void maybeConfigure(Project p)
+                    throws BuildException
    +
    +
    Configures the wrapped element and all its children. + The attributes and text for the wrapped element are configured, + and then each child is configured and added. Each time the + wrapper is configured, the attributes and text for it are + reset. + + If the element has an id attribute, a reference + is added to the project as well. +

    +

    +
    +
    +
    +
    Parameters:
    p - The project containing the wrapped element. + Must not be null. +
    Throws: +
    BuildException - if the configuration fails, for instance due + to invalid attributes or children, or text being added to + an element which doesn't accept it.
    +
    +
    +
    + +

    +maybeConfigure

    +
    +public void maybeConfigure(Project p,
+                           boolean configureChildren)
+                    throws BuildException
    +
    +
    Configures the wrapped element. The attributes and text for + the wrapped element are configured. Each time the wrapper is + configured, the attributes and text for it are reset. + + If the element has an id attribute, a reference + is added to the project as well. +

    +

    +
    +
    +
    +
    Parameters:
    p - The project containing the wrapped element. + Must not be null.
    configureChildren - ignored. +
    Throws: +
    BuildException - if the configuration fails, for instance due + to invalid attributes , or text being added to + an element which doesn't accept it.
    +
    +
    +
    + +

    +reconfigure

    +
    +public void reconfigure(Project p)
    +
    +
    Reconfigure the element, even if it has already been configured. +

    +

    +
    +
    +
    +
    Parameters:
    p - the project instance for this configuration.
    +
    +
    +
    + +

    +applyPreSet

    +
    +public void applyPreSet(RuntimeConfigurable r)
    +
    +
    Apply presets, attributes and text are set if not currently set. + Nested elements are prepended. +

    +

    +
    +
    +
    +
    Parameters:
    r - a RuntimeConfigurable value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/SubBuildListener.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/SubBuildListener.html new file mode 100644 index 000000000..2c2739023 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/SubBuildListener.html @@ -0,0 +1,266 @@ + + + + + + +SubBuildListener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface SubBuildListener

    +
    +
    All Superinterfaces:
    BuildListener, java.util.EventListener
    +
    +
    +
    All Known Implementing Classes:
    AntClassLoader, AntClassLoader2, AntClassLoader5, BigProjectLogger, Recorder, RecorderEntry, SplitClassLoader
    +
    +
    +
    +
    public interface SubBuildListener
    extends BuildListener
    + + +

    +Instances of classes that implement this interface can register + to be also notified when things happened during a subbuild. + +

    A subbuild is a separate project instance created by the + <ant> task family. These project instances will + never fire the buildStarted and buildFinished events, but they will + fire subBuildStarted/ and subBuildFinished. The main project + instance - the one created by running Ant in the first place - will + never invoke one of the methods of this interface.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.6.2
    +
    See Also:
    BuildEvent, +Project.addBuildListener(BuildListener)
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidsubBuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished.
    + voidsubBuildStarted(BuildEvent event) + +
    +          Signals that a subbuild has started.
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.BuildListener
    buildFinished, buildStarted, messageLogged, targetFinished, targetStarted, taskFinished, taskStarted
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +subBuildStarted

    +
    +void subBuildStarted(BuildEvent event)
    +
    +
    Signals that a subbuild has started. This event + is fired before any targets have started. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    +
    +
    +
    + +

    +subBuildFinished

    +
    +void subBuildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build. +

    +

    +
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Target.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Target.html new file mode 100644 index 000000000..02644ccea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Target.html @@ -0,0 +1,882 @@ + + + + + + +Target (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Target

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.Target
+
    +
    +
    All Implemented Interfaces:
    TaskContainer
    +
    +
    +
    Direct Known Subclasses:
    ExtensionPoint
    +
    +
    +
    +
    public class Target
    extends java.lang.Object
    implements TaskContainer
    + + +

    +Class to implement a target object with required parameters. + +

    If you are creating Targets programmatically, make sure you set + the Location to a useful value. In particular all targets should + have different location values.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    Target() + +
    +          Default constructor.
    Target(Target other) + +
    +          Cloning constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddDataType(RuntimeConfigurable r) + +
    +          Adds the wrapper for a data type element to this target.
    + voidaddDependency(java.lang.String dependency) + +
    +          Adds a dependency to this target.
    + voidaddTask(Task task) + +
    +          Adds a task to this target.
    + booleandependsOn(java.lang.String other) + +
    +          Does this target depend on the named target?
    + voidexecute() + +
    +          Executes the target if the "if" and "unless" conditions are + satisfied.
    + java.util.EnumerationgetDependencies() + +
    +          Returns an enumeration of the dependencies of this target.
    + java.lang.StringgetDescription() + +
    +          Returns the description of this target.
    + java.lang.StringgetIf() + +
    +          Returns the "if" property condition of this target.
    + LocationgetLocation() + +
    +          Get the location of this target's definition.
    + java.lang.StringgetName() + +
    +          Returns the name of this target.
    + ProjectgetProject() + +
    +          Returns the project this target belongs to.
    + Task[]getTasks() + +
    +          Returns the current set of tasks to be executed by this target.
    + java.lang.StringgetUnless() + +
    +          Returns the "unless" property condition of this target.
    +static java.util.ListparseDepends(java.lang.String depends, + java.lang.String targetName, + java.lang.String attributeName) + +
    +           
    + voidperformTasks() + +
    +          Performs the tasks within this target (if the conditions are met), + firing target started/target finished messages around a call to + execute.
    + voidsetDepends(java.lang.String depS) + +
    +          Sets the list of targets this target is dependent on.
    + voidsetDescription(java.lang.String description) + +
    +          Sets the description of this target.
    + voidsetIf(java.lang.String property) + +
    +          Sets the "if" condition to test on execution.
    + voidsetLocation(Location location) + +
    +          Sets the location of this target's definition.
    + voidsetName(java.lang.String name) + +
    +          Sets the name of this target.
    + voidsetProject(Project project) + +
    +          Sets the project this target belongs to.
    + voidsetUnless(java.lang.String property) + +
    +          Sets the "unless" condition to test on execution.
    + java.lang.StringtoString() + +
    +          Returns the name of this target.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Target

    +
    +public Target()
    +
    +
    Default constructor. +

    +

    +
    + +

    +Target

    +
    +public Target(Target other)
    +
    +
    Cloning constructor. +

    +

    +
    Parameters:
    other - the Target to clone.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Sets the project this target belongs to. +

    +

    +
    +
    +
    +
    Parameters:
    project - The project this target belongs to. + Must not be null.
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Returns the project this target belongs to. +

    +

    +
    +
    +
    + +
    Returns:
    The project this target belongs to, or null if + the project has not been set yet.
    +
    +
    +
    + +

    +setLocation

    +
    +public void setLocation(Location location)
    +
    +
    Sets the location of this target's definition. +

    +

    +
    +
    +
    +
    Parameters:
    location - Location
    Since:
    +
    1.6.2
    +
    +
    +
    +
    + +

    +getLocation

    +
    +public Location getLocation()
    +
    +
    Get the location of this target's definition. +

    +

    +
    +
    +
    + +
    Returns:
    Location
    Since:
    +
    1.6.2
    +
    +
    +
    +
    + +

    +setDepends

    +
    +public void setDepends(java.lang.String depS)
    +
    +
    Sets the list of targets this target is dependent on. + The targets themselves are not resolved at this time. +

    +

    +
    +
    +
    +
    Parameters:
    depS - A comma-separated list of targets this target + depends on. Must not be null.
    +
    +
    +
    + +

    +parseDepends

    +
    +public static java.util.List parseDepends(java.lang.String depends,
+                                          java.lang.String targetName,
+                                          java.lang.String attributeName)
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Sets the name of this target. +

    +

    +
    +
    +
    +
    Parameters:
    name - The name of this target. Should not be null.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Returns the name of this target. +

    +

    +
    +
    +
    + +
    Returns:
    the name of this target, or null if the + name has not been set yet.
    +
    +
    +
    + +

    +addTask

    +
    +public void addTask(Task task)
    +
    +
    Adds a task to this target. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    task - The task to be added. Must not be null.
    +
    +
    +
    + +

    +addDataType

    +
    +public void addDataType(RuntimeConfigurable r)
    +
    +
    Adds the wrapper for a data type element to this target. +

    +

    +
    +
    +
    +
    Parameters:
    r - The wrapper for the data type element to be added. + Must not be null.
    +
    +
    +
    + +

    +getTasks

    +
    +public Task[] getTasks()
    +
    +
    Returns the current set of tasks to be executed by this target. +

    +

    +
    +
    +
    + +
    Returns:
    an array of the tasks currently within this target
    +
    +
    +
    + +

    +addDependency

    +
    +public void addDependency(java.lang.String dependency)
    +
    +
    Adds a dependency to this target. +

    +

    +
    +
    +
    +
    Parameters:
    dependency - The name of a target this target is dependent on. + Must not be null.
    +
    +
    +
    + +

    +getDependencies

    +
    +public java.util.Enumeration getDependencies()
    +
    +
    Returns an enumeration of the dependencies of this target. +

    +

    +
    +
    +
    + +
    Returns:
    an enumeration of the dependencies of this target (enumeration of String)
    +
    +
    +
    + +

    +dependsOn

    +
    +public boolean dependsOn(java.lang.String other)
    +
    +
    Does this target depend on the named target? +

    +

    +
    +
    +
    +
    Parameters:
    other - the other named target. +
    Returns:
    true if the target does depend on the named target
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setIf

    +
    +public void setIf(java.lang.String property)
    +
    +
    Sets the "if" condition to test on execution. This is the + name of a property to test for existence - if the property + is not set, the task will not execute. The property goes + through property substitution once before testing, so if + property foo has value bar, setting + the "if" condition to ${foo}_x will mean that the + task will only execute if property bar_x is set. +

    +

    +
    +
    +
    +
    Parameters:
    property - The property condition to test on execution. + May be null, in which case + no "if" test is performed.
    +
    +
    +
    + +

    +getIf

    +
    +public java.lang.String getIf()
    +
    +
    Returns the "if" property condition of this target. +

    +

    +
    +
    +
    + +
    Returns:
    the "if" property condition or null if no + "if" condition had been defined.
    Since:
    +
    1.6.2
    +
    +
    +
    +
    + +

    +setUnless

    +
    +public void setUnless(java.lang.String property)
    +
    +
    Sets the "unless" condition to test on execution. This is the + name of a property to test for existence - if the property + is set, the task will not execute. The property goes + through property substitution once before testing, so if + property foo has value bar, setting + the "unless" condition to ${foo}_x will mean that the + task will only execute if property bar_x isn't set. +

    +

    +
    +
    +
    +
    Parameters:
    property - The property condition to test on execution. + May be null, in which case + no "unless" test is performed.
    +
    +
    +
    + +

    +getUnless

    +
    +public java.lang.String getUnless()
    +
    +
    Returns the "unless" property condition of this target. +

    +

    +
    +
    +
    + +
    Returns:
    the "unless" property condition or null + if no "unless" condition had been defined.
    Since:
    +
    1.6.2
    +
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String description)
    +
    +
    Sets the description of this target. +

    +

    +
    +
    +
    +
    Parameters:
    description - The description for this target. + May be null, indicating that no + description is available.
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    Returns the description of this target. +

    +

    +
    +
    +
    + +
    Returns:
    the description of this target, or null if no + description is available.
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Returns the name of this target. +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    the name of this target, or null if the + name has not been set yet.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the target if the "if" and "unless" conditions are + satisfied. Dependency checking should be done before calling this + method, as it does no checking of its own. If either the "if" + or "unless" test prevents this target from being executed, a verbose + message is logged giving the reason. It is recommended that clients + of this class call performTasks rather than this method so that + appropriate build events are fired. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - if any of the tasks fail or if a data type + configuration fails.
    See Also:
    performTasks(), +setIf(String), +setUnless(String)
    +
    +
    +
    + +

    +performTasks

    +
    +public final void performTasks()
    +
    +
    Performs the tasks within this target (if the conditions are met), + firing target started/target finished messages around a call to + execute. +

    +

    +
    +
    +
    +
    See Also:
    execute()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Task.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Task.html new file mode 100644 index 000000000..0d600a659 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/Task.html @@ -0,0 +1,1000 @@ + + + + + + +Task (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class Task

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    AbstractCvsTask, AbstractJarSignerTask, Ant, Antlib, AntlibDefinition, ANTLR, AntStructure, AntVersion, AugmentReference, Available, Basename, BindTargets, BorlandGenerateClient, BuildNumber, CallTarget, Classloader, ClearCase, CloseResources, Concat, Continuus, Copy, Copyfile, CopyPath, CVSPass, DefaultExcludes, Deltree, DiagnosticsTask, Dirname, DispatchTask, Echo, EchoProperties, EmailTask, Exec, ExecTask, Exit, Expand, Filter, FTP, FTPTask, Funtest, GenerateKey, Get, HostInfo, ImportTask, Input, IPlanetEjbcTask, JarLibAvailableTask, JarLibDisplayTask, JarLibManifestTask, JarLibResolveTask, Java, JavaCC, Javadoc, Javah, JDBCTask, JDependTask, JJDoc, JJTree, JUnitTask, KeySubst, Length, LoadProperties, LoadResource, Local, MacroInstance, MakeUrl, ManifestClassPath, ManifestTask, MatchingTask, Mkdir, MSVSS, Nice, P4Base, Pack, Parallel, Patch, PathConvert, ProjectHelperTask, Property, PropertyFile, PropertyHelperTask, Pvcs, Recorder, Rename, ReplaceRegExp, ResourceCount, Retry, RExecTask, Rpm, Script, ScriptDefBase, Sequential, ServerDeploy, SetProxy, Sleep, SOS, SoundTask, SplashTask, SSHBase, SubAnt, Sync, TaskAdapter, TelnetTask, TempFile, Touch, Truncate, Tstamp, UnknownElement, Unpack, UpToDate, WhichResource, XmlProperty, XMLResultAggregator, XMLValidateTask
    +
    +
    +
    +
    public abstract class Task
    extends ProjectComponent
    + + +

    +Base class for all tasks. + + Use Project.createTask to create a new task instance rather than + using this class directly for construction. +

    + +

    +

    +
    See Also:
    Project.createTask(java.lang.String)
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  Targettarget + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getOwningTarget() method.
    +protected  java.lang.StringtaskName + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getTaskName() method.
    +protected  java.lang.StringtaskType + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getTaskType() method.
    +protected  RuntimeConfigurablewrapper + +
    +          Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getWrapper() method.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Task() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbindToOwner(Task owner) + +
    +          Bind a task to another; use this when configuring a newly created + task to do work on behalf of another.
    + voidexecute() + +
    +          Called by the project to let the task do its work.
    + TargetgetOwningTarget() + +
    +          Returns the container target of this task.
    + RuntimeConfigurablegetRuntimeConfigurableWrapper() + +
    +          Returns the wrapper used for runtime configuration.
    + java.lang.StringgetTaskName() + +
    +          Returns the name to use in logging messages.
    + java.lang.StringgetTaskType() + +
    +          Return the type of task.
    +protected  RuntimeConfigurablegetWrapper() + +
    +          Return the runtime configurable structure for this task.
    +protected  voidhandleErrorFlush(java.lang.String output) + +
    +          Handles an error line by logging it with the WARN priority.
    +protected  voidhandleErrorOutput(java.lang.String output) + +
    +          Handles an error output by logging it with the WARN priority.
    +protected  voidhandleFlush(java.lang.String output) + +
    +          Handles output by logging it with the INFO priority.
    +protected  inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Handle an input request by this task.
    +protected  voidhandleOutput(java.lang.String output) + +
    +          Handles output by logging it with the INFO priority.
    + voidinit() + +
    +          Called by the project to let the task initialize properly.
    +protected  booleanisInvalid() + +
    +          Has this task been marked invalid?
    + voidlog(java.lang.String msg) + +
    +          Logs a message with the default (INFO) priority.
    + voidlog(java.lang.String msg, + int msgLevel) + +
    +          Logs a message with the given priority.
    + voidlog(java.lang.String msg, + java.lang.Throwable t, + int msgLevel) + +
    +          Logs a message with the given priority.
    + voidlog(java.lang.Throwable t, + int msgLevel) + +
    +          Logs a message with the given priority.
    + voidmaybeConfigure() + +
    +          Configures this task - if it hasn't been done already.
    + voidperform() + +
    +          Performs this task if it's still valid, or gets a replacement + version and performs that otherwise.
    + voidreconfigure() + +
    +          Force the task to be reconfigured from its RuntimeConfigurable.
    + voidsetOwningTarget(Target target) + +
    +          Sets the target container of this task.
    + voidsetRuntimeConfigurableWrapper(RuntimeConfigurable wrapper) + +
    +          Sets the wrapper to be used for runtime configuration.
    + voidsetTaskName(java.lang.String name) + +
    +          Sets the name to use in logging messages.
    + voidsetTaskType(java.lang.String type) + +
    +          Sets the name with which the task has been invoked.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +target

    +
    +protected Target target
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getOwningTarget() method.
    Target this task belongs to, if any. +

    +

    +
    +
    +
    + +

    +taskName

    +
    +protected java.lang.String taskName
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getTaskName() method.
    Name of this task to be used for logging purposes. + This defaults to the same as the type, but may be + overridden by the user. For instance, the name "java" + isn't terribly descriptive for a task used within + another task - the outer task code can probably + provide a better one. +

    +

    +
    +
    +
    + +

    +taskType

    +
    +protected java.lang.String taskType
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getTaskType() method.
    Type of this task. +

    +

    +
    +
    +
    + +

    +wrapper

    +
    +protected RuntimeConfigurable wrapper
    +
    +
    Deprecated. since 1.6.x. + You should not be accessing this variable directly. + Please use the getWrapper() method.
    Wrapper for this object, used to configure it at runtime. +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Task

    +
    +public Task()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setOwningTarget

    +
    +public void setOwningTarget(Target target)
    +
    +
    Sets the target container of this task. +

    +

    +
    Parameters:
    target - Target in whose scope this task belongs. + May be null, indicating a top-level task.
    +
    +
    +
    + +

    +getOwningTarget

    +
    +public Target getOwningTarget()
    +
    +
    Returns the container target of this task. +

    +

    + +
    Returns:
    The target containing this task, or null if + this task is a top-level task.
    +
    +
    +
    + +

    +setTaskName

    +
    +public void setTaskName(java.lang.String name)
    +
    +
    Sets the name to use in logging messages. +

    +

    +
    Parameters:
    name - The name to use in logging messages. + Should not be null.
    +
    +
    +
    + +

    +getTaskName

    +
    +public java.lang.String getTaskName()
    +
    +
    Returns the name to use in logging messages. +

    +

    + +
    Returns:
    the name to use in logging messages.
    +
    +
    +
    + +

    +setTaskType

    +
    +public void setTaskType(java.lang.String type)
    +
    +
    Sets the name with which the task has been invoked. +

    +

    +
    Parameters:
    type - The name the task has been invoked as. + Should not be null.
    +
    +
    +
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Called by the project to let the task initialize properly. + The default implementation is a no-op. +

    +

    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

    +

    + +
    Throws: +
    BuildException - if something goes wrong with the build.
    +
    +
    +
    + +

    +getRuntimeConfigurableWrapper

    +
    +public RuntimeConfigurable getRuntimeConfigurableWrapper()
    +
    +
    Returns the wrapper used for runtime configuration. +

    +

    + +
    Returns:
    the wrapper used for runtime configuration. This + method will generate a new wrapper (and cache it) + if one isn't set already.
    +
    +
    +
    + +

    +setRuntimeConfigurableWrapper

    +
    +public void setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)
    +
    +
    Sets the wrapper to be used for runtime configuration. + + This method should be used only by the ProjectHelper and Ant internals. + It is public to allow helper plugins to operate on tasks, normal tasks + should never use it. +

    +

    +
    Parameters:
    wrapper - The wrapper to be used for runtime configuration. + May be null, in which case the next call + to getRuntimeConfigurableWrapper will generate a new + wrapper.
    +
    +
    +
    + +

    +maybeConfigure

    +
    +public void maybeConfigure()
+                    throws BuildException
    +
    +
    Configures this task - if it hasn't been done already. + If the task has been invalidated, it is replaced with an + UnknownElement task which uses the new definition in the project. +

    +

    + +
    Throws: +
    BuildException - if the task cannot be configured.
    +
    +
    +
    + +

    +reconfigure

    +
    +public void reconfigure()
    +
    +
    Force the task to be reconfigured from its RuntimeConfigurable. +

    +

    +
    +
    +
    +
    + +

    +handleOutput

    +
    +protected void handleOutput(java.lang.String output)
    +
    +
    Handles output by logging it with the INFO priority. +

    +

    +
    Parameters:
    output - The output to log. Should not be null.
    +
    +
    +
    + +

    +handleFlush

    +
    +protected void handleFlush(java.lang.String output)
    +
    +
    Handles output by logging it with the INFO priority. +

    +

    +
    Parameters:
    output - The output to log. Should not be null.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +handleInput

    +
    +protected int handleInput(byte[] buffer,
+                          int offset,
+                          int length)
+                   throws java.io.IOException
    +
    +
    Handle an input request by this task. +

    +

    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +protected void handleErrorOutput(java.lang.String output)
    +
    +
    Handles an error output by logging it with the WARN priority. +

    +

    +
    Parameters:
    output - The error output to log. Should not be null.
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +protected void handleErrorFlush(java.lang.String output)
    +
    +
    Handles an error line by logging it with the WARN priority. +

    +

    +
    Parameters:
    output - The error output to log. Should not be null.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String msg)
    +
    +
    Logs a message with the default (INFO) priority. +

    +

    +
    Overrides:
    log in class ProjectComponent
    +
    +
    +
    Parameters:
    msg - The message to be logged. Should not be null.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String msg,
+                int msgLevel)
    +
    +
    Logs a message with the given priority. This delegates + the actual logging to the project. +

    +

    +
    Overrides:
    log in class ProjectComponent
    +
    +
    +
    Parameters:
    msg - The message to be logged. Should not be null.
    msgLevel - The message priority at which this message is to + be logged.
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.Throwable t,
+                int msgLevel)
    +
    +
    Logs a message with the given priority. This delegates + the actual logging to the project. +

    +

    +
    Parameters:
    t - The exception to be logged. Should not be null.
    msgLevel - The message priority at which this message is to + be logged.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +log

    +
    +public void log(java.lang.String msg,
+                java.lang.Throwable t,
+                int msgLevel)
    +
    +
    Logs a message with the given priority. This delegates + the actual logging to the project. +

    +

    +
    Parameters:
    msg - The message to be logged. Should not be null.
    t - The exception to be logged. May be null.
    msgLevel - The message priority at which this message is to + be logged.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +perform

    +
    +public final void perform()
    +
    +
    Performs this task if it's still valid, or gets a replacement + version and performs that otherwise. + + Performing a task consists of firing a task started event, + configuring the task, executing it, and then firing task finished + event. If a runtime exception is thrown, the task finished event + is still fired, but with the exception as the cause. +

    +

    +
    +
    +
    +
    + +

    +isInvalid

    +
    +protected final boolean isInvalid()
    +
    +
    Has this task been marked invalid? +

    +

    + +
    Returns:
    true if this task is no longer valid. A new task should be + configured in this case.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getTaskType

    +
    +public java.lang.String getTaskType()
    +
    +
    Return the type of task. +

    +

    + +
    Returns:
    the type of task.
    +
    +
    +
    + +

    +getWrapper

    +
    +protected RuntimeConfigurable getWrapper()
    +
    +
    Return the runtime configurable structure for this task. +

    +

    + +
    Returns:
    the runtime structure for this task.
    +
    +
    +
    + +

    +bindToOwner

    +
    +public final void bindToOwner(Task owner)
    +
    +
    Bind a task to another; use this when configuring a newly created + task to do work on behalf of another. + Project, OwningTarget, TaskName, Location and Description are all copied + + Important: this method does not call init(). + If you are creating a task to delegate work to, call init() + to initialize it. +

    +

    +
    Parameters:
    owner - owning target
    Since:
    +
    Ant1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskAdapter.html new file mode 100644 index 000000000..6beb59bfa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskAdapter.html @@ -0,0 +1,460 @@ + + + + + + +TaskAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class TaskAdapter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.TaskAdapter
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TypeAdapter
    +
    +
    +
    +
    public class TaskAdapter
    extends Task
    implements TypeAdapter
    + + +

    +Uses introspection to "adapt" an arbitrary Bean which doesn't + itself extend Task, but still contains an execute method and optionally + a setProject method. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    TaskAdapter() + +
    +          No-arg constructor for reflection.
    TaskAdapter(java.lang.Object proxy) + +
    +          Constructor for given proxy.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckProxyClass(java.lang.Class proxyClass) + +
    +          Check if the proxy class is a valid class to use + with this adapter.
    +static voidcheckTaskClass(java.lang.Class taskClass, + Project project) + +
    +          Checks whether or not a class is suitable to be adapted by TaskAdapter.
    + voidexecute() + +
    +          Executes the proxied task.
    + java.lang.ObjectgetProxy() + +
    +          Returns the target object being proxied.
    + voidsetProxy(java.lang.Object o) + +
    +          Sets the target object to proxy for.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.TypeAdapter
    getProject, setProject
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TaskAdapter

    +
    +public TaskAdapter()
    +
    +
    No-arg constructor for reflection. +

    +

    +
    + +

    +TaskAdapter

    +
    +public TaskAdapter(java.lang.Object proxy)
    +
    +
    Constructor for given proxy. + So you could write easier code + 
    + myTaskContainer.addTask( new TaskAdapter(myProxy) );
+
    +

    +

    +
    Parameters:
    proxy - The object which Ant should use as task.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +checkTaskClass

    +
    +public static void checkTaskClass(java.lang.Class taskClass,
+                                  Project project)
    +
    +
    Checks whether or not a class is suitable to be adapted by TaskAdapter. + If the class is of type Dispatchable, the check is not performed because + the method that will be executed will be determined only at runtime of + the actual task and not during parse time. + + This only checks conditions which are additionally required for + tasks adapted by TaskAdapter. Thus, this method should be called by + Project.checkTaskClass. + + Throws a BuildException and logs as Project.MSG_ERR for + conditions that will cause the task execution to fail. + Logs other suspicious conditions with Project.MSG_WARN. +

    +

    +
    +
    +
    +
    Parameters:
    taskClass - Class to test for suitability. + Must not be null.
    project - Project to log warnings/errors to. + Must not be null.
    See Also:
    Project.checkTaskClass(Class)
    +
    +
    +
    + +

    +checkProxyClass

    +
    +public void checkProxyClass(java.lang.Class proxyClass)
    +
    +
    Check if the proxy class is a valid class to use + with this adapter. + The class must have a public no-arg "execute()" method. +

    +

    +
    Specified by:
    checkProxyClass in interface TypeAdapter
    +
    +
    +
    Parameters:
    proxyClass - the class to check.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the proxied task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the project could not be set + or the method could not be executed.
    +
    +
    +
    + +

    +setProxy

    +
    +public void setProxy(java.lang.Object o)
    +
    +
    Sets the target object to proxy for. +

    +

    +
    Specified by:
    setProxy in interface TypeAdapter
    +
    +
    +
    Parameters:
    o - The target object. Must not be null.
    +
    +
    +
    + +

    +getProxy

    +
    +public java.lang.Object getProxy()
    +
    +
    Returns the target object being proxied. +

    +

    +
    Specified by:
    getProxy in interface TypeAdapter
    +
    +
    + +
    Returns:
    the target proxy object.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskConfigurationChecker.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskConfigurationChecker.html new file mode 100644 index 000000000..d01f3f27c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskConfigurationChecker.html @@ -0,0 +1,335 @@ + + + + + + +TaskConfigurationChecker (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class TaskConfigurationChecker

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.TaskConfigurationChecker
+
    +
    +
    +
    public class TaskConfigurationChecker
    extends java.lang.Object
    + + +

    +

    Helper class for the check of the configuration of a given task. + This class provides methods for making assumptions about the task configuration. + After collecting all violations with assert* and fail + methods the checkErrors will throw a BuildException with all collected + messages or does nothing if there wasn't any error.

    + +

    Example:

    + + 
    +     public class MyTask extends Task {
+         ...
+         public void execute() {
+             TaskConfigurationChecker checker = TaskConfigurationChecker(this);
+             checker.assertConfig(
+                 srcdir != null,
+                 "Attribute 'srcdir' must be set.
+             );
+             checker.assertConfig(
+                 srcdir.exists(),
+                 "Srcdir (" + srcdir + ") must exist."
+             );
+             if (someComplexCondition()) {
+                 fail("Complex condition failed.");
+             }
+             checker.checkErrors();
+         }
+     }
+
    +

    + +

    +

    +
    See Also:
    Notification Pattern
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    TaskConfigurationChecker(Task task) + +
    +          Constructor.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidassertConfig(boolean condition, + java.lang.String errormessage) + +
    +          Asserts that a condition is true.
    + voidcheckErrors() + +
    +          Checks if there are any collected errors and throws a BuildException + with all messages if there was one or more.
    + voidfail(java.lang.String errormessage) + +
    +          Registers an error.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TaskConfigurationChecker

    +
    +public TaskConfigurationChecker(Task task)
    +
    +
    Constructor. +

    +

    +
    Parameters:
    task - which task should be checked
    +
    + + + + + + + + +
    +Method Detail
    + +

    +assertConfig

    +
    +public void assertConfig(boolean condition,
+                         java.lang.String errormessage)
    +
    +
    Asserts that a condition is true. +

    +

    +
    Parameters:
    condition - which condition to check
    errormessage - errormessage to throw if a condition failed
    +
    +
    +
    + +

    +fail

    +
    +public void fail(java.lang.String errormessage)
    +
    +
    Registers an error. +

    +

    +
    Parameters:
    errormessage - the message for the registered error
    +
    +
    +
    + +

    +checkErrors

    +
    +public void checkErrors()
+                 throws BuildException
    +
    +
    Checks if there are any collected errors and throws a BuildException + with all messages if there was one or more. +

    +

    + +
    Throws: +
    BuildException - if one or more errors were registered
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskContainer.html new file mode 100644 index 000000000..1e052ef84 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TaskContainer.html @@ -0,0 +1,219 @@ + + + + + + +TaskContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface TaskContainer

    +
    +
    All Known Implementing Classes:
    Antlib, ExtensionPoint, MacroDef.NestedSequential, MacroInstance, MacroInstance.Element, Parallel, Parallel.TaskList, PreSetDef, Retry, Sequential, SSHSession.NestedSequential, Target
    +
    +
    +
    +
    public interface TaskContainer
    + + +

    +Interface for objects which can contain tasks. +

    + It is recommended that implementations call perform rather than + execute for the tasks they contain, as this method ensures that the + appropriate BuildEvents will be generated. +

    + +

    +

    +
    See Also:
    Task.perform(), +Task.execute(), +BuildEvent
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task task) + +
    +          Adds a task to this task container
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +void addTask(Task task)
    +
    +
    Adds a task to this task container +

    +

    +
    Parameters:
    task - The task to be added to this container. + Must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TypeAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TypeAdapter.html new file mode 100644 index 000000000..de9150d01 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/TypeAdapter.html @@ -0,0 +1,302 @@ + + + + + + +TypeAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Interface TypeAdapter

    +
    +
    All Known Implementing Classes:
    AugmentReference, TaskAdapter
    +
    +
    +
    +
    public interface TypeAdapter
    + + +

    +Used to wrap types. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckProxyClass(java.lang.Class proxyClass) + +
    +          Check if the proxy class is compatible with this adapter - i.e.
    + ProjectgetProject() + +
    +          Gets the project
    + java.lang.ObjectgetProxy() + +
    +          Returns the proxy object.
    + voidsetProject(Project p) + +
    +          Sets the project
    + voidsetProxy(java.lang.Object o) + +
    +          Sets the proxy object, whose methods are going to be + invoked by ant.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +void setProject(Project p)
    +
    +
    Sets the project +

    +

    +
    Parameters:
    p - the project instance.
    +
    +
    +
    + +

    +getProject

    +
    +Project getProject()
    +
    +
    Gets the project +

    +

    + +
    Returns:
    the project instance.
    +
    +
    +
    + +

    +setProxy

    +
    +void setProxy(java.lang.Object o)
    +
    +
    Sets the proxy object, whose methods are going to be + invoked by ant. + A proxy object is normally the object defined by + a <typedef/> task that is adapted by the "adapter" + attribute. +

    +

    +
    Parameters:
    o - The target object. Must not be null.
    +
    +
    +
    + +

    +getProxy

    +
    +java.lang.Object getProxy()
    +
    +
    Returns the proxy object. +

    +

    + +
    Returns:
    the target proxy object
    +
    +
    +
    + +

    +checkProxyClass

    +
    +void checkProxyClass(java.lang.Class proxyClass)
    +
    +
    Check if the proxy class is compatible with this adapter - i.e. + the adapter will be able to adapt instances of the give class. +

    +

    +
    Parameters:
    proxyClass - the class to be checked.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnknownElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnknownElement.html new file mode 100644 index 000000000..f05944584 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnknownElement.html @@ -0,0 +1,974 @@ + + + + + + +UnknownElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class UnknownElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.UnknownElement
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class UnknownElement
    extends Task
    + + +

    +Wrapper class that holds all the information necessary to create a task + or data type that did not exist when Ant started, or one which + has had its definition updated to use a different implementation class. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    UnknownElement(java.lang.String elementName) + +
    +          Creates an UnknownElement for the given element name.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddChild(UnknownElement child) + +
    +          Adds a child element to this element.
    + voidapplyPreSet(UnknownElement u) + +
    +          This is used then the realobject of the UE is a PreSetDefinition.
    + voidconfigure(java.lang.Object realObject) + +
    +          Configure the given object from this UnknownElement
    + UnknownElementcopy(Project newProject) + +
    +          Make a copy of the unknown element and set it in the new project.
    + voidexecute() + +
    +          Executes the real object if it's a task.
    + java.util.ListgetChildren() + +
    +           
    +protected  java.lang.StringgetComponentName() + +
    +           
    + java.lang.StringgetNamespace() + +
    +          Return the namespace of the XML element associated with this component.
    +protected  BuildExceptiongetNotFoundException(java.lang.String what, + java.lang.String name) + +
    +          Returns a very verbose exception for when a task/data type cannot + be found.
    + java.lang.StringgetQName() + +
    +          Return the qname of the XML element associated with this component.
    + java.lang.ObjectgetRealThing() + +
    +          Return the configured object
    + java.lang.StringgetTag() + +
    +          Returns the name of the XML element which generated this unknown + element.
    + TaskgetTask() + +
    +          Returns the task instance after it has been created and if it is a task.
    + java.lang.StringgetTaskName() + +
    +          Returns the name to use in logging messages.
    + RuntimeConfigurablegetWrapper() + +
    +          Get the RuntimeConfigurable instance for this UnknownElement, containing + the configuration information.
    +protected  voidhandleChildren(java.lang.Object parent, + RuntimeConfigurable parentWrapper) + +
    +          Creates child elements, creates children of the children + (recursively), and sets attributes of the child elements.
    +protected  voidhandleErrorFlush(java.lang.String output) + +
    +          Handles error output sent to System.err by this task or its real task.
    +protected  voidhandleErrorOutput(java.lang.String output) + +
    +          Handles error output sent to System.err by this task or its real task.
    +protected  voidhandleFlush(java.lang.String output) + +
    +          Handles output sent to System.out by this task or its real task.
    +protected  inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Delegate to realThing if present and if it as task.
    +protected  voidhandleOutput(java.lang.String output) + +
    +          Handles output sent to System.out by this task or its real task.
    +protected  java.lang.ObjectmakeObject(UnknownElement ue, + RuntimeConfigurable w) + +
    +          Creates a named task or data type.
    +protected  TaskmakeTask(UnknownElement ue, + RuntimeConfigurable w) + +
    +          Creates a named task and configures it up to the init() stage.
    + voidmaybeConfigure() + +
    +          Creates the real object instance and child elements, then configures + the attributes and text of the real object.
    + voidsetNamespace(java.lang.String namespace) + +
    +          Set the namespace of the XML element associated with this component.
    + voidsetQName(java.lang.String qname) + +
    +          Set the namespace qname of the XML element.
    + voidsetRealThing(java.lang.Object realThing) + +
    +          Set the configured object
    + booleansimilar(java.lang.Object obj) + +
    +          like contents equals, but ignores project
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskType, init, isInvalid, log, log, log, log, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +UnknownElement

    +
    +public UnknownElement(java.lang.String elementName)
    +
    +
    Creates an UnknownElement for the given element name. +

    +

    +
    Parameters:
    elementName - The name of the unknown element. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getChildren

    +
    +public java.util.List getChildren()
    +
    +
    + +
    Returns:
    the list of nested UnknownElements for this UnknownElement.
    +
    +
    +
    + +

    +getTag

    +
    +public java.lang.String getTag()
    +
    +
    Returns the name of the XML element which generated this unknown + element. +

    +

    + +
    Returns:
    the name of the XML element which generated this unknown + element.
    +
    +
    +
    + +

    +getNamespace

    +
    +public java.lang.String getNamespace()
    +
    +
    Return the namespace of the XML element associated with this component. +

    +

    + +
    Returns:
    Namespace URI used in the xmlns declaration.
    +
    +
    +
    + +

    +setNamespace

    +
    +public void setNamespace(java.lang.String namespace)
    +
    +
    Set the namespace of the XML element associated with this component. + This method is typically called by the XML processor. + If the namespace is "ant:current", the component helper + is used to get the current antlib uri. +

    +

    +
    Parameters:
    namespace - URI used in the xmlns declaration.
    +
    +
    +
    + +

    +getQName

    +
    +public java.lang.String getQName()
    +
    +
    Return the qname of the XML element associated with this component. +

    +

    + +
    Returns:
    namespace Qname used in the element declaration.
    +
    +
    +
    + +

    +setQName

    +
    +public void setQName(java.lang.String qname)
    +
    +
    Set the namespace qname of the XML element. + This method is typically called by the XML processor. +

    +

    +
    Parameters:
    qname - the qualified name of the element
    +
    +
    +
    + +

    +getWrapper

    +
    +public RuntimeConfigurable getWrapper()
    +
    +
    Get the RuntimeConfigurable instance for this UnknownElement, containing + the configuration information. +

    +

    +
    Overrides:
    getWrapper in class Task
    +
    +
    + +
    Returns:
    the configuration info.
    +
    +
    +
    + +

    +maybeConfigure

    +
    +public void maybeConfigure()
+                    throws BuildException
    +
    +
    Creates the real object instance and child elements, then configures + the attributes and text of the real object. This unknown element + is then replaced with the real object in the containing target's list + of children. +

    +

    +
    Overrides:
    maybeConfigure in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the configuration fails
    +
    +
    +
    + +

    +configure

    +
    +public void configure(java.lang.Object realObject)
    +
    +
    Configure the given object from this UnknownElement +

    +

    +
    Parameters:
    realObject - the real object this UnknownElement is representing.
    +
    +
    +
    + +

    +handleOutput

    +
    +protected void handleOutput(java.lang.String output)
    +
    +
    Handles output sent to System.out by this task or its real task. +

    +

    +
    Overrides:
    handleOutput in class Task
    +
    +
    +
    Parameters:
    output - The output to log. Should not be null.
    +
    +
    +
    + +

    +handleInput

    +
    +protected int handleInput(byte[] buffer,
+                          int offset,
+                          int length)
+                   throws java.io.IOException
    +
    +
    Delegate to realThing if present and if it as task. +

    +

    +
    Overrides:
    handleInput in class Task
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    See Also:
    Task.handleInput(byte[], int, int)
    +
    +
    +
    + +

    +handleFlush

    +
    +protected void handleFlush(java.lang.String output)
    +
    +
    Handles output sent to System.out by this task or its real task. +

    +

    +
    Overrides:
    handleFlush in class Task
    +
    +
    +
    Parameters:
    output - The output to log. Should not be null.
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +protected void handleErrorOutput(java.lang.String output)
    +
    +
    Handles error output sent to System.err by this task or its real task. +

    +

    +
    Overrides:
    handleErrorOutput in class Task
    +
    +
    +
    Parameters:
    output - The error output to log. Should not be null.
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +protected void handleErrorFlush(java.lang.String output)
    +
    +
    Handles error output sent to System.err by this task or its real task. +

    +

    +
    Overrides:
    handleErrorFlush in class Task
    +
    +
    +
    Parameters:
    output - The error output to log. Should not be null.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Executes the real object if it's a task. If it's not a task + (e.g. a data type) then this method does nothing. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +addChild

    +
    +public void addChild(UnknownElement child)
    +
    +
    Adds a child element to this element. +

    +

    +
    Parameters:
    child - The child element to add. Must not be null.
    +
    +
    +
    + +

    +handleChildren

    +
    +protected void handleChildren(java.lang.Object parent,
+                              RuntimeConfigurable parentWrapper)
+                       throws BuildException
    +
    +
    Creates child elements, creates children of the children + (recursively), and sets attributes of the child elements. +

    +

    +
    Parameters:
    parent - The configured object for the parent. + Must not be null.
    parentWrapper - The wrapper containing child wrappers + to be configured. Must not be null + if there are any children. +
    Throws: +
    BuildException - if the children cannot be configured.
    +
    +
    +
    + +

    +getComponentName

    +
    +protected java.lang.String getComponentName()
    +
    +
    + +
    Returns:
    the component name - uses ProjectHelper#genComponentName()
    +
    +
    +
    + +

    +applyPreSet

    +
    +public void applyPreSet(UnknownElement u)
    +
    +
    This is used then the realobject of the UE is a PreSetDefinition. + This is also used when a presetdef is used on a presetdef + The attributes, elements and text are applied to this + UE. +

    +

    +
    Parameters:
    u - an UnknownElement containing the attributes, elements and text
    +
    +
    +
    + +

    +makeObject

    +
    +protected java.lang.Object makeObject(UnknownElement ue,
+                                      RuntimeConfigurable w)
    +
    +
    Creates a named task or data type. If the real object is a task, + it is configured up to the init() stage. +

    +

    +
    Parameters:
    ue - The unknown element to create the real object for. + Must not be null.
    w - Ignored in this implementation. +
    Returns:
    the task or data type represented by the given unknown element.
    +
    +
    +
    + +

    +makeTask

    +
    +protected Task makeTask(UnknownElement ue,
+                        RuntimeConfigurable w)
    +
    +
    Creates a named task and configures it up to the init() stage. +

    +

    +
    Parameters:
    ue - The UnknownElement to create the real task for. + Must not be null.
    w - Ignored. +
    Returns:
    the task specified by the given unknown element, or + null if the task name is not recognised.
    +
    +
    +
    + +

    +getNotFoundException

    +
    +protected BuildException getNotFoundException(java.lang.String what,
+                                              java.lang.String name)
    +
    +
    Returns a very verbose exception for when a task/data type cannot + be found. +

    +

    +
    Parameters:
    what - The kind of thing being created. For example, when + a task name could not be found, this would be + "task". Should not be null.
    name - The name of the element which could not be found. + Should not be null. +
    Returns:
    a detailed description of what might have caused the problem.
    +
    +
    +
    + +

    +getTaskName

    +
    +public java.lang.String getTaskName()
    +
    +
    Returns the name to use in logging messages. +

    +

    +
    Overrides:
    getTaskName in class Task
    +
    +
    + +
    Returns:
    the name to use in logging messages.
    +
    +
    +
    + +

    +getTask

    +
    +public Task getTask()
    +
    +
    Returns the task instance after it has been created and if it is a task. +

    +

    + +
    Returns:
    a task instance or null if the real object is not + a task.
    +
    +
    +
    + +

    +getRealThing

    +
    +public java.lang.Object getRealThing()
    +
    +
    Return the configured object +

    +

    + +
    Returns:
    the real thing whatever it is
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +setRealThing

    +
    +public void setRealThing(java.lang.Object realThing)
    +
    +
    Set the configured object +

    +

    +
    Parameters:
    realThing - the configured object
    Since:
    +
    ant 1.7
    +
    +
    +
    +
    + +

    +similar

    +
    +public boolean similar(java.lang.Object obj)
    +
    +
    like contents equals, but ignores project +

    +

    +
    Parameters:
    obj - the object to check against +
    Returns:
    true if this unknownelement has the same contents the other
    +
    +
    +
    + +

    +copy

    +
    +public UnknownElement copy(Project newProject)
    +
    +
    Make a copy of the unknown element and set it in the new project. +

    +

    +
    Parameters:
    newProject - the project to create the UE in. +
    Returns:
    the copied UE.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedAttributeException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedAttributeException.html new file mode 100644 index 000000000..daa38a3f7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedAttributeException.html @@ -0,0 +1,289 @@ + + + + + + +UnsupportedAttributeException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class UnsupportedAttributeException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.apache.tools.ant.BuildException
+                  extended by org.apache.tools.ant.UnsupportedAttributeException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class UnsupportedAttributeException
    extends BuildException
    + + +

    +Used to report attempts to set an unsupported attribute +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    UnsupportedAttributeException(java.lang.String msg, + java.lang.String attribute) + +
    +          Constructs an unsupported attribute exception.
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetAttribute() + +
    +          Get the attribute that is wrong.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.BuildException
    getException, getLocation, setLocation, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +UnsupportedAttributeException

    +
    +public UnsupportedAttributeException(java.lang.String msg,
+                                     java.lang.String attribute)
    +
    +
    Constructs an unsupported attribute exception. +

    +

    +
    Parameters:
    msg - The string containing the message.
    attribute - The unsupported attribute.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getAttribute

    +
    +public java.lang.String getAttribute()
    +
    +
    Get the attribute that is wrong. +

    +

    + +
    Returns:
    the attribute name.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedElementException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedElementException.html new file mode 100644 index 000000000..bdc7b2ebd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/UnsupportedElementException.html @@ -0,0 +1,298 @@ + + + + + + +UnsupportedElementException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class UnsupportedElementException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.apache.tools.ant.BuildException
+                  extended by org.apache.tools.ant.UnsupportedElementException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class UnsupportedElementException
    extends BuildException
    + + +

    +Used to report attempts to set an unsupported element + When the attempt to set the element is made, + the code does not not know the name of the task/type + based on a mapping from the classname to the task/type. + However one class may be used by a lot of task/types. + This exception may be caught by code that does know + the task/type and it will reset the message to the + correct message. + This will be done once (in the case of a recursive + call to handlechildren). +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    UnsupportedElementException(java.lang.String msg, + java.lang.String element) + +
    +          Constructs an unsupported element exception.
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetElement() + +
    +          Get the element that is wrong.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.BuildException
    getException, getLocation, setLocation, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +UnsupportedElementException

    +
    +public UnsupportedElementException(java.lang.String msg,
+                                   java.lang.String element)
    +
    +
    Constructs an unsupported element exception. +

    +

    +
    Parameters:
    msg - The string containing the message.
    element - The name of the incorrect element.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getElement

    +
    +public java.lang.String getElement()
    +
    +
    Get the element that is wrong. +

    +

    + +
    Returns:
    the element name.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/XmlLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/XmlLogger.html new file mode 100644 index 000000000..b0f68d726 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/XmlLogger.html @@ -0,0 +1,547 @@ + + + + + + +XmlLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant +
    +Class XmlLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.XmlLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class XmlLogger
    extends java.lang.Object
    implements BuildLogger
    + + +

    +Generates a file in the current directory with + an XML description of what happened during a build. + The default filename is "log.xml", but this can be overridden + with the property XmlLogger.file. + + This implementation assumes in its sanity checking that only one + thread runs a particular target/task at a time. This is enforced + by the way that parallel builds and antcalls are done - and + indeed all but the simplest of tasks could run into problems + if executed in parallel. +

    + +

    +

    +
    See Also:
    Project.addBuildListener(BuildListener)
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    XmlLogger() + +
    +          Constructs a new BuildListener that logs build events to an XML file.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Fired when the build finishes, this adds the time taken and any + error stacktrace to the build element and writes the document to disk.
    + voidbuildStarted(BuildEvent event) + +
    +          Fired when the build starts, this builds the top-level element for the + document and remembers the time of the start of the build.
    + voidmessageLogged(BuildEvent event) + +
    +          Fired when a message is logged, this adds a message element to the + most appropriate parent element (task, target or build) and records + the priority and text of the message.
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Ignore emacs mode, as it has no meaning in XML format
    + voidsetErrorPrintStream(java.io.PrintStream err) + +
    +          Ignore error print stream.
    + voidsetMessageOutputLevel(int level) + +
    +          Set the logging level when using this as a Logger
    + voidsetOutputPrintStream(java.io.PrintStream output) + +
    +          Set the output stream to which logging output is sent when operating + as a logger.
    + voidtargetFinished(BuildEvent event) + +
    +          Fired when a target finishes building, this adds the time taken + and any error stacktrace to the appropriate target element in the log.
    + voidtargetStarted(BuildEvent event) + +
    +          Fired when a target starts building, this pushes a timed element + for the target onto the stack of elements for the current thread, + remembering the current time and the name of the target.
    + voidtaskFinished(BuildEvent event) + +
    +          Fired when a task finishes building, this adds the time taken + and any error stacktrace to the appropriate task element in the log.
    + voidtaskStarted(BuildEvent event) + +
    +          Fired when a task starts building, this pushes a timed element + for the task onto the stack of elements for the current thread, + remembering the current time and the name of the task.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XmlLogger

    +
    +public XmlLogger()
    +
    +
    Constructs a new BuildListener that logs build events to an XML file. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Fired when the build starts, this builds the top-level element for the + document and remembers the time of the start of the build. +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - Ignored.
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Fired when the build finishes, this adds the time taken and any + error stacktrace to the build element and writes the document to disk. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Fired when a target starts building, this pushes a timed element + for the target onto the stack of elements for the current thread, + remembering the current time and the name of the target. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Fired when a target finishes building, this adds the time taken + and any error stacktrace to the appropriate target element in the log. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Fired when a task starts building, this pushes a timed element + for the task onto the stack of elements for the current thread, + remembering the current time and the name of the task. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Fired when a task finishes building, this adds the time taken + and any error stacktrace to the appropriate task element in the log. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Fired when a message is logged, this adds a message element to the + most appropriate parent element (task, target or build) and records + the priority and text of the message. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Will not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +setMessageOutputLevel

    +
    +public void setMessageOutputLevel(int level)
    +
    +
    Set the logging level when using this as a Logger +

    +

    +
    Specified by:
    setMessageOutputLevel in interface BuildLogger
    +
    +
    +
    Parameters:
    level - the logging level - + see Project + class for level definitions
    +
    +
    +
    + +

    +setOutputPrintStream

    +
    +public void setOutputPrintStream(java.io.PrintStream output)
    +
    +
    Set the output stream to which logging output is sent when operating + as a logger. +

    +

    +
    Specified by:
    setOutputPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    output - the output PrintStream.
    +
    +
    +
    + +

    +setEmacsMode

    +
    +public void setEmacsMode(boolean emacsMode)
    +
    +
    Ignore emacs mode, as it has no meaning in XML format +

    +

    +
    Specified by:
    setEmacsMode in interface BuildLogger
    +
    +
    +
    Parameters:
    emacsMode - true if logger should produce emacs compatible + output
    +
    +
    +
    + +

    +setErrorPrintStream

    +
    +public void setErrorPrintStream(java.io.PrintStream err)
    +
    +
    Ignore error print stream. All output will be written to + either the XML log file or the PrintStream provided to + setOutputPrintStream +

    +

    +
    Specified by:
    setErrorPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    err - the stream we are going to ignore.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchTask.html new file mode 100644 index 000000000..7ad166a46 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchTask.html @@ -0,0 +1,367 @@ + + + + + + +DispatchTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.dispatch +
    +Class DispatchTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.dispatch.DispatchTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Dispatchable
    +
    +
    +
    Direct Known Subclasses:
    Symlink
    +
    +
    +
    +
    public abstract class DispatchTask
    extends Task
    implements Dispatchable
    + + +

    +Tasks extending this class may contain multiple actions. + The method that is invoked for execution depends upon the + value of the action attribute of the task. +
    + Example:
    + <mytask action="list"/> will invoke the method + with the signature public void list() in mytask's class. + If the action attribute is not defined in the task or is empty, + the execute() method will be called. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    DispatchTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetAction() + +
    +          Get the action.
    + java.lang.StringgetActionParameterName() + +
    +          Get the action parameter name.
    + voidsetAction(java.lang.String action) + +
    +          Set the action.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DispatchTask

    +
    +public DispatchTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getActionParameterName

    +
    +public java.lang.String getActionParameterName()
    +
    +
    Get the action parameter name. +

    +

    +
    Specified by:
    getActionParameterName in interface Dispatchable
    +
    +
    + +
    Returns:
    the String "action" by default (can be overridden).
    +
    +
    +
    + +

    +setAction

    +
    +public void setAction(java.lang.String action)
    +
    +
    Set the action. +

    +

    +
    +
    +
    +
    Parameters:
    action - the method name.
    +
    +
    +
    + +

    +getAction

    +
    +public java.lang.String getAction()
    +
    +
    Get the action. +

    +

    +
    +
    +
    + +
    Returns:
    the action.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchUtils.html new file mode 100644 index 000000000..1cdd31a47 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/DispatchUtils.html @@ -0,0 +1,256 @@ + + + + + + +DispatchUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.dispatch +
    +Class DispatchUtils

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.dispatch.DispatchUtils
+
    +
    +
    +
    public class DispatchUtils
    extends java.lang.Object
    + + +

    +Determines and Executes the action method for the task. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DispatchUtils() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static voidexecute(java.lang.Object task) + +
    +          Determines and Executes the action method for the task.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DispatchUtils

    +
    +public DispatchUtils()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public static final void execute(java.lang.Object task)
+                          throws BuildException
    +
    +
    Determines and Executes the action method for the task. +

    +

    +
    Parameters:
    task - the task to execute. +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/Dispatchable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/Dispatchable.html new file mode 100644 index 000000000..797862b31 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/Dispatchable.html @@ -0,0 +1,213 @@ + + + + + + +Dispatchable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.dispatch +
    +Interface Dispatchable

    +
    +
    All Known Implementing Classes:
    DispatchTask, Symlink
    +
    +
    +
    +
    public interface Dispatchable
    + + +

    +Classes implementing this interface specify the + name of the parameter that contains the name + of the task's method to execute. +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetActionParameterName() + +
    +          Get the name of the parameter.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getActionParameterName

    +
    +java.lang.String getActionParameterName()
    +
    +
    Get the name of the parameter. +

    +

    + +
    Returns:
    the name of the parameter that contains the name of the method.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-frame.html new file mode 100644 index 000000000..e56b45c51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +org.apache.tools.ant.dispatch (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.dispatch + + + + +
    +Interfaces  + +
    +Dispatchable
    + + + + + + +
    +Classes  + +
    +DispatchTask +
    +DispatchUtils
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-summary.html new file mode 100644 index 000000000..078aa463f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-summary.html @@ -0,0 +1,172 @@ + + + + + + +org.apache.tools.ant.dispatch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.dispatch +

    + + + + + + + + + +
    +Interface Summary
    DispatchableClasses implementing this interface specify the + name of the parameter that contains the name + of the task's method to execute.
    +  + +

    + + + + + + + + + + + + + +
    +Class Summary
    DispatchTaskTasks extending this class may contain multiple actions.
    DispatchUtilsDetermines and Executes the action method for the task.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-tree.html new file mode 100644 index 000000000..8f771bf86 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/dispatch/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +org.apache.tools.ant.dispatch Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.dispatch +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseFilterReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseFilterReader.html new file mode 100644 index 000000000..93fa40e4a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseFilterReader.html @@ -0,0 +1,519 @@ + + + + + + +BaseFilterReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class BaseFilterReader

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable
    +
    +
    +
    Direct Known Subclasses:
    BaseParamFilterReader, ClassConstants, ExpandProperties, StripJavaComments, TokenFilter
    +
    +
    +
    +
    public abstract class BaseFilterReader
    extends java.io.FilterReader
    + + +

    +Base class for core filter readers. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    BaseFilterReader() + +
    +          Constructor used by Ant's introspection mechanism.
    BaseFilterReader(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  booleangetInitialized() + +
    +          Returns the initialized status.
    +protected  ProjectgetProject() + +
    +          Returns the project this filter is part of.
    + intread(char[] cbuf, + int off, + int len) + +
    +          Reads characters into a portion of an array.
    +protected  java.lang.StringreadFully() + +
    +          Reads to the end of the stream, returning the contents as a String.
    +protected  java.lang.StringreadLine() + +
    +          Reads a line of text ending with '\n' (or until the end of the stream).
    +protected  voidsetInitialized(boolean initialized) + +
    +          Sets the initialized status.
    + voidsetProject(Project project) + +
    +          Sets the project to work with.
    + longskip(long n) + +
    +          Skips characters.
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, read, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BaseFilterReader

    +
    +public BaseFilterReader()
    +
    +
    Constructor used by Ant's introspection mechanism. + The original filter reader is only used for chaining + purposes, never for filtering purposes (and indeed + it would be useless for filtering purposes, as it has + no real data to filter). ChainedReaderHelper uses + this placeholder instance to create a chain of real filters. +

    +

    +
    + +

    +BaseFilterReader

    +
    +public BaseFilterReader(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public final int read(char[] cbuf,
+                      int off,
+                      int len)
+               throws java.io.IOException
    +
    +
    Reads characters into a portion of an array. This method will block + until some input is available, an I/O error occurs, or the end of the + stream is reached. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    +
    Parameters:
    cbuf - Destination buffer to write characters to. + Must not be null.
    off - Offset at which to start storing characters.
    len - Maximum number of characters to read. +
    Returns:
    the number of characters read, or -1 if the end of the + stream has been reached +
    Throws: +
    java.io.IOException - If an I/O error occurs
    +
    +
    +
    + +

    +skip

    +
    +public final long skip(long n)
+                throws java.io.IOException,
+                       java.lang.IllegalArgumentException
    +
    +
    Skips characters. This method will block until some characters are + available, an I/O error occurs, or the end of the stream is reached. +

    +

    +
    Overrides:
    skip in class java.io.FilterReader
    +
    +
    +
    Parameters:
    n - The number of characters to skip +
    Returns:
    the number of characters actually skipped +
    Throws: +
    java.lang.IllegalArgumentException - If n is negative. +
    java.io.IOException - If an I/O error occurs
    +
    +
    +
    + +

    +setInitialized

    +
    +protected final void setInitialized(boolean initialized)
    +
    +
    Sets the initialized status. +

    +

    +
    Parameters:
    initialized - Whether or not the filter is initialized.
    +
    +
    +
    + +

    +getInitialized

    +
    +protected final boolean getInitialized()
    +
    +
    Returns the initialized status. +

    +

    + +
    Returns:
    whether or not the filter is initialized
    +
    +
    +
    + +

    +setProject

    +
    +public final void setProject(Project project)
    +
    +
    Sets the project to work with. +

    +

    +
    Parameters:
    project - The project this filter is part of. + Should not be null.
    +
    +
    +
    + +

    +getProject

    +
    +protected final Project getProject()
    +
    +
    Returns the project this filter is part of. +

    +

    + +
    Returns:
    the project this filter is part of
    +
    +
    +
    + +

    +readLine

    +
    +protected final java.lang.String readLine()
+                                   throws java.io.IOException
    +
    +
    Reads a line of text ending with '\n' (or until the end of the stream). + The returned String retains the '\n'. +

    +

    + +
    Returns:
    the line read, or null if the end of the stream + has already been reached +
    Throws: +
    java.io.IOException - if the underlying reader throws one during + reading
    +
    +
    +
    + +

    +readFully

    +
    +protected final java.lang.String readFully()
+                                    throws java.io.IOException
    +
    +
    Reads to the end of the stream, returning the contents as a String. +

    +

    + +
    Returns:
    the remaining contents of the reader, as a String +
    Throws: +
    java.io.IOException - if the underlying reader throws one during + reading
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseParamFilterReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseParamFilterReader.html new file mode 100644 index 000000000..e1b36801b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/BaseParamFilterReader.html @@ -0,0 +1,370 @@ + + + + + + +BaseParamFilterReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class BaseParamFilterReader

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, Parameterizable
    +
    +
    +
    Direct Known Subclasses:
    ConcatFilter, EscapeUnicode, FixCrLfFilter, HeadFilter, LineContains, LineContainsRegExp, PrefixLines, ReplaceTokens, SortFilter, StripLineBreaks, StripLineComments, SuffixLines, TabsToSpaces, TailFilter
    +
    +
    +
    +
    public abstract class BaseParamFilterReader
    extends BaseFilterReader
    implements Parameterizable
    + + +

    +Parameterized base class for core filter readers. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    BaseParamFilterReader() + +
    +          Constructor for "dummy" instances.
    BaseParamFilterReader(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  Parameter[]getParameters() + +
    +          Returns the parameters to be used by this filter.
    + voidsetParameters(Parameter[] parameters) + +
    +          Sets the parameters used by this filter, and sets + the filter to an uninitialized status.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, read, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BaseParamFilterReader

    +
    +public BaseParamFilterReader()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +BaseParamFilterReader

    +
    +public BaseParamFilterReader(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setParameters

    +
    +public final void setParameters(Parameter[] parameters)
    +
    +
    Sets the parameters used by this filter, and sets + the filter to an uninitialized status. +

    +

    +
    Specified by:
    setParameters in interface Parameterizable
    +
    +
    +
    Parameters:
    parameters - The parameters to be used by this filter. + Should not be null.
    +
    +
    +
    + +

    +getParameters

    +
    +protected final Parameter[] getParameters()
    +
    +
    Returns the parameters to be used by this filter. +

    +

    +
    +
    +
    + +
    Returns:
    the parameters to be used by this filter
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ChainableReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ChainableReader.html new file mode 100644 index 000000000..bd95a04a2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ChainableReader.html @@ -0,0 +1,214 @@ + + + + + + +ChainableReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Interface ChainableReader

    +
    +
    All Known Implementing Classes:
    ClassConstants, ConcatFilter, EscapeUnicode, ExpandProperties, FixCRLF, FixCrLfFilter, HeadFilter, LineContains, LineContainsRegExp, PrefixLines, ReplaceTokens, ScriptFilter, SortFilter, StripJavaComments, StripLineBreaks, StripLineComments, SuffixLines, TabsToSpaces, TailFilter, TokenFilter, TokenFilter.ChainableReaderFilter, TokenFilter.ContainsRegex, TokenFilter.DeleteCharacters, TokenFilter.IgnoreBlank, TokenFilter.ReplaceRegex, TokenFilter.ReplaceString, TokenFilter.Trim, UniqFilter
    +
    +
    +
    +
    public interface ChainableReader
    + + +

    +Interface indicating that a reader may be chained to another one. +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Returns a reader with the same configuration as this one, + but filtering input from the specified reader.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +chain

    +
    +java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Returns a reader with the same configuration as this one, + but filtering input from the specified reader. +

    +

    +
    Parameters:
    rdr - the reader which the returned reader should be filtering +
    Returns:
    a reader with the same configuration as this one, but + filtering input from the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ClassConstants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ClassConstants.html new file mode 100644 index 000000000..0b8829734 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ClassConstants.html @@ -0,0 +1,394 @@ + + + + + + +ClassConstants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class ClassConstants

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.ClassConstants
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader
    +
    +
    +
    +
    public final class ClassConstants
    extends BaseFilterReader
    implements ChainableReader
    + + +

    +Assembles the constants declared in a Java class in + key1=value1(line separator)key2=value2 + format. +

    + Notes: +

      +
    1. This filter uses the BCEL external toolkit. +
    2. This assembles only those constants that are not created + using the syntax new whatever() +
    3. This assembles constants declared using the basic datatypes + and String only.
      4. +
    4. The access modifiers of the declared constants do not matter.
      5. +
    + Example:
    + 
    <classconstants/>
    + Or: + 
    <filterreader
+    classname="org.apache.tools.ant.filters.ClassConstants"/>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    ClassConstants() + +
    +          Constructor for "dummy" instances.
    ClassConstants(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new ClassConstants using the passed in + Reader for instantiation.
    + intread() + +
    +          Reads and assembles the constants declared in a class file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ClassConstants

    +
    +public ClassConstants()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +ClassConstants

    +
    +public ClassConstants(java.io.Reader in)
    +
    +
    Creates a new filtered reader. The contents of the passed-in reader + are expected to be the name of the class from which to produce a + list of constants. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Reads and assembles the constants declared in a class file. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the list of constants, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading, or if the constants for the specified class cannot + be read (for example due to the class not being found).
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new ClassConstants using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ConcatFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ConcatFilter.html new file mode 100644 index 000000000..96acc1c75 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ConcatFilter.html @@ -0,0 +1,503 @@ + + + + + + +ConcatFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class ConcatFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.ConcatFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class ConcatFilter
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Concats a file before and/or after the file. + +

    Example:

    + 
+     
+     
+         
+     
+ 
+
    + Copies all java sources from src to build and adds the + content of apache-license-java.txt add the beginning of each + file.

    +

    + +

    +

    +
    Since:
    +
    1.6
    +
    Version:
    +
    2003-09-23
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    ConcatFilter() + +
    +          Constructor for "dummy" instances.
    ConcatFilter(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new ConcatReader using the passed in + Reader for instantiation.
    + java.io.FilegetAppend() + +
    +          Returns append attribute.
    + java.io.FilegetPrepend() + +
    +          Returns prepend attribute.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetAppend(java.io.File append) + +
    +          Sets append attribute.
    + voidsetPrepend(java.io.File prepend) + +
    +          Sets prepend attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ConcatFilter

    +
    +public ConcatFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +ConcatFilter

    +
    +public ConcatFilter(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. If the desired + number of lines have already been read, the resulting stream is + effectively at an end. Otherwise, the next character from the + underlying stream is read and returned. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setPrepend

    +
    +public void setPrepend(java.io.File prepend)
    +
    +
    Sets prepend attribute. +

    +

    +
    +
    +
    +
    Parameters:
    prepend - new value
    +
    +
    +
    + +

    +getPrepend

    +
    +public java.io.File getPrepend()
    +
    +
    Returns prepend attribute. +

    +

    +
    +
    +
    + +
    Returns:
    prepend attribute
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(java.io.File append)
    +
    +
    Sets append attribute. +

    +

    +
    +
    +
    +
    Parameters:
    append - new value
    +
    +
    +
    + +

    +getAppend

    +
    +public java.io.File getAppend()
    +
    +
    Returns append attribute. +

    +

    +
    +
    +
    + +
    Returns:
    append attribute
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new ConcatReader using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/EscapeUnicode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/EscapeUnicode.html new file mode 100644 index 000000000..a4ae2a6c4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/EscapeUnicode.html @@ -0,0 +1,400 @@ + + + + + + +EscapeUnicode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class EscapeUnicode

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.EscapeUnicode
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public class EscapeUnicode
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +This method converts non-latin characters to unicode escapes. + Useful to load properties containing non latin + Example: + + 

    <escapeunicode>
    + + Or: + + 
    <filterreader
+        classname="org.apache.tools.ant.filters.EscapeUnicode"/>
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    EscapeUnicode() + +
    +          Constructor for "dummy" instances.
    EscapeUnicode(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new EscapeUnicode using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, converting non latin + characters to unicode escapes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EscapeUnicode

    +
    +public EscapeUnicode()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +EscapeUnicode

    +
    +public EscapeUnicode(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public final int read()
+               throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, converting non latin + characters to unicode escapes. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws + an IOException during reading
    +
    +
    +
    + +

    +chain

    +
    +public final java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new EscapeUnicode using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ExpandProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ExpandProperties.html new file mode 100644 index 000000000..4c3333fc1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ExpandProperties.html @@ -0,0 +1,383 @@ + + + + + + +ExpandProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class ExpandProperties

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.ExpandProperties
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader
    +
    +
    +
    +
    public final class ExpandProperties
    extends BaseFilterReader
    implements ChainableReader
    + + +

    +Expands Ant properties, if any, in the data. +

    + Example:
    + 

    <expandproperties/>
    + Or: + 
    <filterreader
+    classname="org.apache.tools.ant.filters.ExpandProperties"/>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    ExpandProperties() + +
    +          Constructor for "dummy" instances.
    ExpandProperties(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new ExpandProperties filter using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExpandProperties

    +
    +public ExpandProperties()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +ExpandProperties

    +
    +public ExpandProperties(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. The original + stream is first read in fully, and the Ant properties are expanded. + The results of this expansion are then queued so they can be read + character-by-character. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new ExpandProperties filter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.AddAsisRemove.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.AddAsisRemove.html new file mode 100644 index 000000000..a0321f9d4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.AddAsisRemove.html @@ -0,0 +1,362 @@ + + + + + + +FixCrLfFilter.AddAsisRemove (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class FixCrLfFilter.AddAsisRemove

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.filters.FixCrLfFilter.AddAsisRemove
+
    +
    +
    Enclosing class:
    FixCrLfFilter
    +
    +
    +
    +
    public static class FixCrLfFilter.AddAsisRemove
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "asis", "add" and "remove". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    FixCrLfFilter.AddAsisRemove() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object other) + +
    +          Equality depending in the index.
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    + inthashCode() + +
    +          Hashcode depending on the index.
    +static FixCrLfFilter.AddAsisRemovenewInstance(java.lang.String value) + +
    +          Create an instance of this enumerated value based on the string value.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCrLfFilter.AddAsisRemove

    +
    +public FixCrLfFilter.AddAsisRemove()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object other)
    +
    +
    Equality depending in the index. +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    other - the object to test equality against. +
    Returns:
    true if the object has the same index as this.
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    Hashcode depending on the index. +

    +

    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    the index as the hashcode.
    +
    +
    +
    + +

    +newInstance

    +
    +public static FixCrLfFilter.AddAsisRemove newInstance(java.lang.String value)
    +
    +
    Create an instance of this enumerated value based on the string value. +

    +

    +
    Parameters:
    value - the value to use. +
    Returns:
    an enumerated instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.CrLf.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.CrLf.html new file mode 100644 index 000000000..2ab077789 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.CrLf.html @@ -0,0 +1,362 @@ + + + + + + +FixCrLfFilter.CrLf (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class FixCrLfFilter.CrLf

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.filters.FixCrLfFilter.CrLf
+
    +
    +
    Enclosing class:
    FixCrLfFilter
    +
    +
    +
    +
    public static class FixCrLfFilter.CrLf
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "asis", "cr", "lf" and "crlf". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    FixCrLfFilter.CrLf() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object other) + +
    +          Equality depending in the index.
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    + inthashCode() + +
    +          Hashcode depending on the index.
    +static FixCrLfFilter.CrLfnewInstance(java.lang.String value) + +
    +          Create an instance of this enumerated value based on the string value.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCrLfFilter.CrLf

    +
    +public FixCrLfFilter.CrLf()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object other)
    +
    +
    Equality depending in the index. +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    other - the object to test equality against. +
    Returns:
    true if the object has the same index as this.
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    Hashcode depending on the index. +

    +

    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    the index as the hashcode.
    +
    +
    +
    + +

    +newInstance

    +
    +public static FixCrLfFilter.CrLf newInstance(java.lang.String value)
    +
    +
    Create an instance of this enumerated value based on the string value. +

    +

    +
    Parameters:
    value - the value to use. +
    Returns:
    an enumerated instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.html new file mode 100644 index 000000000..3182b9862 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/FixCrLfFilter.html @@ -0,0 +1,795 @@ + + + + + + +FixCrLfFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class FixCrLfFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.FixCrLfFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class FixCrLfFilter
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Converts text to local OS formatting conventions, as well as repair text + damaged by misconfigured or misguided editors or file transfer programs. +

    + This filter can take the following arguments: +

      +
    • eof +
    • eol +
    • fixlast +
    • javafiles +
    • tab +
    • tablength +
    + None of which are required. +

    + This version generalises the handling of EOL characters, and allows for + CR-only line endings (the standard on Mac systems prior to OS X). Tab + handling has also been generalised to accommodate any tabwidth from 2 to 80, + inclusive. Importantly, it can leave untouched any literal TAB characters + embedded within Java string or character constants. +

    + Caution: run with care on carefully formatted files. This may + sound obvious, but if you don't specify asis, presume that your files are + going to be modified. If "tabs" is "add" or "remove", whitespace characters + may be added or removed as necessary. Similarly, for EOLs, eol="asis" + actually means convert to your native O/S EOL convention while eol="crlf" or + cr="add" can result in CR characters being removed in one special case + accommodated, i.e., CRCRLF is regarded as a single EOL to handle cases where + other programs have converted CRLF into CRCRLF. + +

    + Example: + + 

    + <<fixcrlf tab="add" eol="crlf" eof="asis"/>
+
    + + Or: + + 
    + <filterreader classname="org.apache.tools.ant.filters.FixCrLfFilter">
+   <param eol="crlf" tab="asis"/>
+  </filterreader>
+
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classFixCrLfFilter.AddAsisRemove + +
    +          Enumerated attribute with the values "asis", "add" and "remove".
    +static classFixCrLfFilter.CrLf + +
    +          Enumerated attribute with the values "asis", "cr", "lf" and "crlf".
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    FixCrLfFilter() + +
    +          Constructor for "dummy" instances.
    FixCrLfFilter(java.io.Reader in) + +
    +          Create a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Create a new FixCrLfFilter using the passed in Reader for instantiation.
    + FixCrLfFilter.AddAsisRemovegetEof() + +
    +          Get how DOS EOF (control-z) characters are being handled.
    + FixCrLfFilter.CrLfgetEol() + +
    +          Get how EndOfLine characters are being handled.
    + booleangetFixlast() + +
    +          Get whether a missing EOL be added to the final line of the stream.
    + booleangetJavafiles() + +
    +          Get whether the stream is to be treated as though it contains Java + source.
    + FixCrLfFilter.AddAsisRemovegetTab() + +
    +          Return how tab characters are being handled.
    + intgetTablength() + +
    +          Get the tab length to use.
    + intread() + +
    +          Return the next character in the filtered stream.
    + voidsetEof(FixCrLfFilter.AddAsisRemove attr) + +
    +          Specify how DOS EOF (control-z) characters are to be handled.
    + voidsetEol(FixCrLfFilter.CrLf attr) + +
    +          Specify how end of line (EOL) characters are to be handled.
    + voidsetFixlast(boolean fixlast) + +
    +          Specify whether a missing EOL will be added to the final line of input.
    + voidsetJavafiles(boolean javafiles) + +
    +          Indicate whether this stream contains Java source.
    + voidsetTab(FixCrLfFilter.AddAsisRemove attr) + +
    +          Specify how tab characters are to be handled.
    + voidsetTablength(int tabLength) + +
    +          Specify tab length in characters.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCrLfFilter

    +
    +public FixCrLfFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +FixCrLfFilter

    +
    +public FixCrLfFilter(java.io.Reader in)
+              throws java.io.IOException
    +
    +
    Create a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. Must not be + null. +
    Throws: +
    java.io.IOException - on error.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Create a new FixCrLfFilter using the passed in Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. Must not be + null. +
    Returns:
    a new filter based on this configuration, but filtering the + specified reader.
    +
    +
    +
    + +

    +getEof

    +
    +public FixCrLfFilter.AddAsisRemove getEof()
    +
    +
    Get how DOS EOF (control-z) characters are being handled. +

    +

    +
    +
    +
    + +
    Returns:
    values: +
      +
    • add: ensure that there is an eof at the end of the file +
    • asis: leave eof characters alone +
    • remove: remove any eof character found at the end +
    +
    +
    +
    + +

    +getEol

    +
    +public FixCrLfFilter.CrLf getEol()
    +
    +
    Get how EndOfLine characters are being handled. +

    +

    +
    +
    +
    + +
    Returns:
    values: +
      +
    • asis: convert line endings to your O/S convention +
    • cr: convert line endings to CR +
    • lf: convert line endings to LF +
    • crlf: convert line endings to CRLF +
    +
    +
    +
    + +

    +getFixlast

    +
    +public boolean getFixlast()
    +
    +
    Get whether a missing EOL be added to the final line of the stream. +

    +

    +
    +
    +
    + +
    Returns:
    true if a filtered file will always end with an EOL
    +
    +
    +
    + +

    +getJavafiles

    +
    +public boolean getJavafiles()
    +
    +
    Get whether the stream is to be treated as though it contains Java + source. +

    + This attribute is only used in assocation with the "tab" + attribute. Tabs found in Java literals are protected from changes by this + filter. +

    +

    +
    +
    +
    + +
    Returns:
    true if whitespace in Java character and string literals is + ignored.
    +
    +
    +
    + +

    +getTab

    +
    +public FixCrLfFilter.AddAsisRemove getTab()
    +
    +
    Return how tab characters are being handled. +

    +

    +
    +
    +
    + +
    Returns:
    values: +
      +
    • add: convert sequences of spaces which span a tab stop to + tabs +
    • asis: leave tab and space characters alone +
    • remove: convert tabs to spaces +
    +
    +
    +
    + +

    +getTablength

    +
    +public int getTablength()
    +
    +
    Get the tab length to use. +

    +

    +
    +
    +
    + +
    Returns:
    the length of tab in spaces
    +
    +
    +
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Return the next character in the filtered stream. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 if the end of + the resulting stream has been reached. +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException during + reading.
    +
    +
    +
    + +

    +setEof

    +
    +public void setEof(FixCrLfFilter.AddAsisRemove attr)
    +
    +
    Specify how DOS EOF (control-z) characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • add: ensure that there is an eof at the end of the file +
    • asis: leave eof characters alone +
    • remove: remove any eof character found at the end +
    +
    +
    +
    + +

    +setEol

    +
    +public void setEol(FixCrLfFilter.CrLf attr)
    +
    +
    Specify how end of line (EOL) characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • asis: convert line endings to your O/S convention +
    • cr: convert line endings to CR +
    • lf: convert line endings to LF +
    • crlf: convert line endings to CRLF +
    +
    +
    +
    + +

    +setFixlast

    +
    +public void setFixlast(boolean fixlast)
    +
    +
    Specify whether a missing EOL will be added to the final line of input. +

    +

    +
    +
    +
    +
    Parameters:
    fixlast - if true a missing EOL will be appended.
    +
    +
    +
    + +

    +setJavafiles

    +
    +public void setJavafiles(boolean javafiles)
    +
    +
    Indicate whether this stream contains Java source. + + This attribute is only used in assocation with the "tab" + attribute. +

    +

    +
    +
    +
    +
    Parameters:
    javafiles - set to true to prevent this filter from changing tabs found in + Java literals.
    +
    +
    +
    + +

    +setTab

    +
    +public void setTab(FixCrLfFilter.AddAsisRemove attr)
    +
    +
    Specify how tab characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • add: convert sequences of spaces which span a tab stop to + tabs +
    • asis: leave tab and space characters alone +
    • remove: convert tabs to spaces +
    +
    +
    +
    + +

    +setTablength

    +
    +public void setTablength(int tabLength)
+                  throws java.io.IOException
    +
    +
    Specify tab length in characters. +

    +

    +
    +
    +
    +
    Parameters:
    tabLength - specify the length of tab in spaces. Valid values are between + 2 and 80 inclusive. The default for this parameter is 8. +
    Throws: +
    java.io.IOException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/HeadFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/HeadFilter.html new file mode 100644 index 000000000..4c4d150ba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/HeadFilter.html @@ -0,0 +1,443 @@ + + + + + + +HeadFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class HeadFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.HeadFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class HeadFilter
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Reads the first n lines of a stream. + (Default is first 10 lines.) +

    + Example: + 

    <headfilter lines="3"/>
    + Or: + 
    <filterreader classname="org.apache.tools.ant.filters.HeadFilter">
+    <param name="lines" value="3"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    HeadFilter() + +
    +          Constructor for "dummy" instances.
    HeadFilter(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new HeadFilter using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetLines(long lines) + +
    +          Sets the number of lines to be returned in the filtered stream.
    + voidsetSkip(long skip) + +
    +          Sets the number of lines to be skipped in the filtered stream.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HeadFilter

    +
    +public HeadFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +HeadFilter

    +
    +public HeadFilter(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. If the desired + number of lines have already been read, the resulting stream is + effectively at an end. Otherwise, the next character from the + underlying stream is read and returned. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setLines

    +
    +public void setLines(long lines)
    +
    +
    Sets the number of lines to be returned in the filtered stream. +

    +

    +
    +
    +
    +
    Parameters:
    lines - the number of lines to be returned in the filtered stream
    +
    +
    +
    + +

    +setSkip

    +
    +public void setSkip(long skip)
    +
    +
    Sets the number of lines to be skipped in the filtered stream. +

    +

    +
    +
    +
    +
    Parameters:
    skip - the number of lines to be skipped in the filtered stream
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new HeadFilter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.Contains.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.Contains.html new file mode 100644 index 000000000..f089e6f15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.Contains.html @@ -0,0 +1,279 @@ + + + + + + +LineContains.Contains (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class LineContains.Contains

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.filters.LineContains.Contains
+
    +
    +
    Enclosing class:
    LineContains
    +
    +
    +
    +
    public static class LineContains.Contains
    extends java.lang.Object
    + + +

    +Holds a contains element +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LineContains.Contains() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetValue() + +
    +          Returns the contains string.
    + voidsetValue(java.lang.String contains) + +
    +          Sets the contains string
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LineContains.Contains

    +
    +public LineContains.Contains()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setValue

    +
    +public final void setValue(java.lang.String contains)
    +
    +
    Sets the contains string +

    +

    +
    Parameters:
    contains - The contains string to set. + Must not be null.
    +
    +
    +
    + +

    +getValue

    +
    +public final java.lang.String getValue()
    +
    +
    Returns the contains string. +

    +

    + +
    Returns:
    the contains string for this element
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.html new file mode 100644 index 000000000..fa095eb86 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContains.html @@ -0,0 +1,495 @@ + + + + + + +LineContains (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class LineContains

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.LineContains
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class LineContains
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Filter which includes only those lines that contain all the user-specified + strings. + + Example: + + 

    <linecontains>
+   <contains value="foo">
+   <contains value="bar">
+ </linecontains>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.LineContains">
+    <param type="contains" value="foo"/>
+    <param type="contains" value="bar"/>
+ </filterreader>
    + + This will include only those lines that contain foo and + bar. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classLineContains.Contains + +
    +          Holds a contains element
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    LineContains() + +
    +          Constructor for "dummy" instances.
    LineContains(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredContains(LineContains.Contains contains) + +
    +          Adds a contains element.
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new LineContains using the passed in + Reader for instantiation.
    + booleanisNegated() + +
    +          Find out whether we have been negated.
    + intread() + +
    +          Returns the next character in the filtered stream, only including + lines from the original stream which contain all of the specified words.
    + voidsetNegate(boolean b) + +
    +          Set the negation mode.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LineContains

    +
    +public LineContains()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +LineContains

    +
    +public LineContains(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, only including + lines from the original stream which contain all of the specified words. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +addConfiguredContains

    +
    +public void addConfiguredContains(LineContains.Contains contains)
    +
    +
    Adds a contains element. +

    +

    +
    +
    +
    +
    Parameters:
    contains - The contains element to add. + Must not be null.
    +
    +
    +
    + +

    +setNegate

    +
    +public void setNegate(boolean b)
    +
    +
    Set the negation mode. Default false (no negation). +

    +

    +
    +
    +
    +
    Parameters:
    b - the boolean negation mode to set.
    +
    +
    +
    + +

    +isNegated

    +
    +public boolean isNegated()
    +
    +
    Find out whether we have been negated. +

    +

    +
    +
    +
    + +
    Returns:
    boolean negation flag.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new LineContains using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContainsRegExp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContainsRegExp.html new file mode 100644 index 000000000..163fcc254 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/LineContainsRegExp.html @@ -0,0 +1,502 @@ + + + + + + +LineContainsRegExp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class LineContainsRegExp

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.LineContainsRegExp
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class LineContainsRegExp
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Filter which includes only those lines that contain the user-specified + regular expression matching strings. + + Example: + 

    <linecontainsregexp>
+   <regexp pattern="foo*">
+ </linecontainsregexp>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.LineContainsRegExp">
+    <param type="regexp" value="foo*"/>
+ </filterreader>
    + + This will fetch all those lines that contain the pattern foo +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    LineContainsRegExp() + +
    +          Constructor for "dummy" instances.
    LineContainsRegExp(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredRegexp(RegularExpression regExp) + +
    +          Adds a regexp element.
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new LineContainsRegExp using the passed in + Reader for instantiation.
    + booleanisNegated() + +
    +          Find out whether we have been negated.
    + intread() + +
    +          Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions.
    + voidsetCaseSensitive(boolean b) + +
    +          Whether to match casesensitevly.
    + voidsetNegate(boolean b) + +
    +          Set the negation mode.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LineContainsRegExp

    +
    +public LineContainsRegExp()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +LineContainsRegExp

    +
    +public LineContainsRegExp(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +addConfiguredRegexp

    +
    +public void addConfiguredRegexp(RegularExpression regExp)
    +
    +
    Adds a regexp element. +

    +

    +
    +
    +
    +
    Parameters:
    regExp - The regexp element to add. + Must not be null.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new LineContainsRegExp using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    +
    + +

    +setNegate

    +
    +public void setNegate(boolean b)
    +
    +
    Set the negation mode. Default false (no negation). +

    +

    +
    +
    +
    +
    Parameters:
    b - the boolean negation mode to set.
    +
    +
    +
    + +

    +setCaseSensitive

    +
    +public void setCaseSensitive(boolean b)
    +
    +
    Whether to match casesensitevly. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +isNegated

    +
    +public boolean isNegated()
    +
    +
    Find out whether we have been negated. +

    +

    +
    +
    +
    + +
    Returns:
    boolean negation flag.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/PrefixLines.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/PrefixLines.html new file mode 100644 index 000000000..56ece04be --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/PrefixLines.html @@ -0,0 +1,422 @@ + + + + + + +PrefixLines (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class PrefixLines

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.PrefixLines
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class PrefixLines
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Attaches a prefix to every line. + + Example: + 

    <prefixlines prefix="Foo"/>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.PrefixLines">
+  <param name="prefix" value="Foo"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    PrefixLines() + +
    +          Constructor for "dummy" instances.
    PrefixLines(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new PrefixLines filter using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetPrefix(java.lang.String prefix) + +
    +          Sets the prefix to add at the start of each input line.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PrefixLines

    +
    +public PrefixLines()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +PrefixLines

    +
    +public PrefixLines(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. One line is read + from the original input, and the prefix added. The resulting + line is then used until it ends, at which point the next original line + is read, etc. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    Sets the prefix to add at the start of each input line. +

    +

    +
    +
    +
    +
    Parameters:
    prefix - The prefix to add at the start of each input line. + May be null, in which case no prefix + is added.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new PrefixLines filter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.Token.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.Token.html new file mode 100644 index 000000000..d4e475b82 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.Token.html @@ -0,0 +1,321 @@ + + + + + + +ReplaceTokens.Token (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class ReplaceTokens.Token

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.filters.ReplaceTokens.Token
+
    +
    +
    Enclosing class:
    ReplaceTokens
    +
    +
    +
    +
    public static class ReplaceTokens.Token
    extends java.lang.Object
    + + +

    +Holds a token +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ReplaceTokens.Token() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetKey() + +
    +          Returns the key for this token.
    + java.lang.StringgetValue() + +
    +          Returns the value for this token.
    + voidsetKey(java.lang.String key) + +
    +          Sets the token key
    + voidsetValue(java.lang.String value) + +
    +          Sets the token value
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ReplaceTokens.Token

    +
    +public ReplaceTokens.Token()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setKey

    +
    +public final void setKey(java.lang.String key)
    +
    +
    Sets the token key +

    +

    +
    Parameters:
    key - The key for this token. Must not be null.
    +
    +
    +
    + +

    +setValue

    +
    +public final void setValue(java.lang.String value)
    +
    +
    Sets the token value +

    +

    +
    Parameters:
    value - The value for this token. Must not be null.
    +
    +
    +
    + +

    +getKey

    +
    +public final java.lang.String getKey()
    +
    +
    Returns the key for this token. +

    +

    + +
    Returns:
    the key for this token
    +
    +
    +
    + +

    +getValue

    +
    +public final java.lang.String getValue()
    +
    +
    Returns the value for this token. +

    +

    + +
    Returns:
    the value for this token
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.html new file mode 100644 index 000000000..08bf7aca0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/ReplaceTokens.html @@ -0,0 +1,518 @@ + + + + + + +ReplaceTokens (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class ReplaceTokens

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.ReplaceTokens
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class ReplaceTokens
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Replaces tokens in the original input with user-supplied values. + + Example: + + 

    <replacetokens begintoken="#" endtoken="#">
+   <token key="DATE" value="${TODAY}"/>
+ </replacetokens>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.ReplaceTokens">
+   <param type="tokenchar" name="begintoken" value="#"/>
+   <param type="tokenchar" name="endtoken" value="#"/>
+   <param type="token" name="DATE" value="${TODAY}"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classReplaceTokens.Token + +
    +          Holds a token
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    ReplaceTokens() + +
    +          Constructor for "dummy" instances.
    ReplaceTokens(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredToken(ReplaceTokens.Token token) + +
    +          Adds a token element to the map of tokens to replace.
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new ReplaceTokens using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, replacing tokens + from the original stream.
    + voidsetBeginToken(char beginToken) + +
    +          Sets the "begin token" character.
    + voidsetEndToken(char endToken) + +
    +          Sets the "end token" character.
    + voidsetPropertiesResource(Resource r) + +
    +          A resource containing properties, each of which is interpreted + as a token/value pair.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ReplaceTokens

    +
    +public ReplaceTokens()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +ReplaceTokens

    +
    +public ReplaceTokens(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, replacing tokens + from the original stream. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setBeginToken

    +
    +public void setBeginToken(char beginToken)
    +
    +
    Sets the "begin token" character. +

    +

    +
    +
    +
    +
    Parameters:
    beginToken - the character used to denote the beginning of a token
    +
    +
    +
    + +

    +setEndToken

    +
    +public void setEndToken(char endToken)
    +
    +
    Sets the "end token" character. +

    +

    +
    +
    +
    +
    Parameters:
    endToken - the character used to denote the end of a token
    +
    +
    +
    + +

    +setPropertiesResource

    +
    +public void setPropertiesResource(Resource r)
    +
    +
    A resource containing properties, each of which is interpreted + as a token/value pair. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addConfiguredToken

    +
    +public void addConfiguredToken(ReplaceTokens.Token token)
    +
    +
    Adds a token element to the map of tokens to replace. +

    +

    +
    +
    +
    +
    Parameters:
    token - The token to add to the map of replacements. + Must not be null.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new ReplaceTokens using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SortFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SortFilter.html new file mode 100644 index 000000000..291ea342f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SortFilter.html @@ -0,0 +1,603 @@ + + + + + + +SortFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class SortFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.SortFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class SortFilter
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +

    + Sort a file before and/or after the file. +

    + +

    + Examples: +

    + + 
    +   <copy todir="build">
+       <fileset dir="input" includes="*.txt"/>
+       <filterchain>
+           <sortfilter/>
+       </filterchain>
+   </copy>
+
    + +

    + Sort all files *.txt from src location and copy + them into build location. The lines of each file are sorted + in ascendant order comparing the lines via the + String.compareTo(Object o) method. +

    + + 
    +   <copy todir="build">
+       <fileset dir="input" includes="*.txt"/>
+       <filterchain>
+           <sortfilter reverse="true"/>
+       </filterchain>
+   </copy>
+
    + +

    + Sort all files *.txt from src location into reverse + order and copy them into build location. If reverse parameter has + value true (default value), then the output line of the files + will be in ascendant order. +

    + + 
    +   <copy todir="build">
+       <fileset dir="input" includes="*.txt"/>
+       <filterchain>
+           <filterreader classname="org.apache.tools.ant.filters.SortFilter">
+             <param name="comparator" value="org.apache.tools.ant.filters.EvenFirstCmp"/>
+           </filterreader>
+       </filterchain>
+   </copy>
+
    + +

    + Sort all files *.txt from src location using as + sorting criterium EvenFirstCmp class, that sorts the file + lines putting even lines first then odd lines for example. The modified files + are copied into build location. The EventFirstCmp, + has to an instanciable class via Class.newInstance(), + therefore in case of inner class has to be static. It also has to + implement java.util.Comparator interface, for example: +

    + + 
    +         package org.apache.tools.ant.filters;
+         ...(omitted)
+           public final class EvenFirstCmp implements <b>Comparator</b> {
+             public int compare(Object o1, Object o2) {
+             ...(omitted)
+             }
+           }
+
    + +

    The example above is equivalent to:

    + + 
    +   <componentdef name="evenfirst"
+                 classname="org.apache.tools.ant.filters.EvenFirstCmp"/>
+   <copy todir="build">
+       <fileset dir="input" includes="*.txt"/>
+       <filterchain>
+           <sortfilter>
+               <evenfirst/>
+           </sortfilter>
+       </filterchain>
+   </copy>
+
    + +

    If parameter comparator is present, then + reverse parameter will not be taken into account.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    SortFilter() + +
    +          Constructor for "dummy" instances.
    SortFilter(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(java.util.Comparator comparator) + +
    +          Set the comparator to be used as sorting criterium as nested element.
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new SortReader using the passed in Reader for instantiation.
    + java.util.ComparatorgetComparator() + +
    +          Returns the comparator to be used for sorting.
    + booleanisReverse() + +
    +          Returns true if the sorting process will be in reverse + order, otherwise the sorting process will be in ascendant order.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetComparator(java.util.Comparator comparator) + +
    +          Set the comparator to be used as sorting criterium.
    + voidsetReverse(boolean reverse) + +
    +          Sets the sorting process will be in ascendant (reverse=false) + or to descendant (reverse=true).
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SortFilter

    +
    +public SortFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +SortFilter

    +
    +public SortFilter(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. Must not be + null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. If the desired number + of lines have already been read, the resulting stream is effectively at + an end. Otherwise, the next character from the underlying stream is read + and returned. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 if the end of + the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException during + reading
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new SortReader using the passed in Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. Must not be + null. +
    Returns:
    a new filter based on this configuration, but filtering the + specified reader
    +
    +
    +
    + +

    +isReverse

    +
    +public boolean isReverse()
    +
    +
    Returns true if the sorting process will be in reverse + order, otherwise the sorting process will be in ascendant order. +

    +

    +
    +
    +
    + +
    Returns:
    true if the sorting process will be in reverse + order, otherwise the sorting process will be in ascendant order.
    +
    +
    +
    + +

    +setReverse

    +
    +public void setReverse(boolean reverse)
    +
    +
    Sets the sorting process will be in ascendant (reverse=false) + or to descendant (reverse=true). +

    +

    +
    +
    +
    +
    Parameters:
    reverse - Boolean representing reverse ordering process.
    +
    +
    +
    + +

    +getComparator

    +
    +public java.util.Comparator getComparator()
    +
    +
    Returns the comparator to be used for sorting. +

    +

    +
    +
    +
    + +
    Returns:
    the comparator
    +
    +
    +
    + +

    +setComparator

    +
    +public void setComparator(java.util.Comparator comparator)
    +
    +
    Set the comparator to be used as sorting criterium. +

    +

    +
    +
    +
    +
    Parameters:
    comparator - the comparator to set
    +
    +
    +
    + +

    +add

    +
    +public void add(java.util.Comparator comparator)
    +
    +
    Set the comparator to be used as sorting criterium as nested element. +

    +

    +
    +
    +
    +
    Parameters:
    comparator - the comparator to set
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StringInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StringInputStream.html new file mode 100644 index 000000000..c7e0caec7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StringInputStream.html @@ -0,0 +1,270 @@ + + + + + + +StringInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class StringInputStream

    +
    +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.ant.util.ReaderInputStream
+          extended by org.apache.tools.ant.filters.StringInputStream
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable
    +
    +
    +
    +
    public class StringInputStream
    extends ReaderInputStream
    + + +

    +Wraps a String as an InputStream. +

    + +

    +

    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    StringInputStream(java.lang.String source) + +
    +          Composes a stream from a String
    StringInputStream(java.lang.String source, + java.lang.String encoding) + +
    +          Composes a stream from a String with the specified encoding
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.ReaderInputStream
    available, close, mark, markSupported, read, read, reset
    +  + + + + + + + +
    Methods inherited from class java.io.InputStream
    read, skip
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StringInputStream

    +
    +public StringInputStream(java.lang.String source)
    +
    +
    Composes a stream from a String +

    +

    +
    Parameters:
    source - The string to read from. Must not be null.
    +
    +
    + +

    +StringInputStream

    +
    +public StringInputStream(java.lang.String source,
+                         java.lang.String encoding)
    +
    +
    Composes a stream from a String with the specified encoding +

    +

    +
    Parameters:
    source - The string to read from. Must not be null.
    encoding - The encoding scheme. Also must not be null.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripJavaComments.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripJavaComments.html new file mode 100644 index 000000000..58c59b127 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripJavaComments.html @@ -0,0 +1,380 @@ + + + + + + +StripJavaComments (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class StripJavaComments

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.StripJavaComments
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader
    +
    +
    +
    +
    public final class StripJavaComments
    extends BaseFilterReader
    implements ChainableReader
    + + +

    +This is a Java comment and string stripper reader that filters + those lexical tokens out for purposes of simple Java parsing. + (if you have more complex Java parsing needs, use a real lexer). + Since this class heavily relies on the single char read function, + you are recommended to make it work on top of a buffered reader. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    StripJavaComments() + +
    +          Constructor for "dummy" instances.
    StripJavaComments(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new StripJavaComments using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, not including + Java comments.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StripJavaComments

    +
    +public StripJavaComments()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +StripJavaComments

    +
    +public StripJavaComments(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, not including + Java comments. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new StripJavaComments using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineBreaks.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineBreaks.html new file mode 100644 index 000000000..11c12a8ce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineBreaks.html @@ -0,0 +1,420 @@ + + + + + + +StripLineBreaks (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class StripLineBreaks

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.StripLineBreaks
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class StripLineBreaks
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Filter to flatten the stream to a single line. + + Example: + + 

    <striplinebreaks/>
    + + Or: + + 
    <filterreader
+   classname="org.apache.tools.ant.filters.StripLineBreaks"/>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    StripLineBreaks() + +
    +          Constructor for "dummy" instances.
    StripLineBreaks(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new StripLineBreaks using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, only including + characters not in the set of line-breaking characters.
    + voidsetLineBreaks(java.lang.String lineBreaks) + +
    +          Sets the line-breaking characters.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StripLineBreaks

    +
    +public StripLineBreaks()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +StripLineBreaks

    +
    +public StripLineBreaks(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, only including + characters not in the set of line-breaking characters. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setLineBreaks

    +
    +public void setLineBreaks(java.lang.String lineBreaks)
    +
    +
    Sets the line-breaking characters. +

    +

    +
    +
    +
    +
    Parameters:
    lineBreaks - A String containing all the characters to be + considered as line-breaking.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new StripLineBreaks using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.Comment.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.Comment.html new file mode 100644 index 000000000..de5c75fbe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.Comment.html @@ -0,0 +1,301 @@ + + + + + + +StripLineComments.Comment (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class StripLineComments.Comment

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.filters.StripLineComments.Comment
+
    +
    +
    Enclosing class:
    StripLineComments
    +
    +
    +
    +
    public static class StripLineComments.Comment
    extends java.lang.Object
    + + +

    +The class that holds a comment representation. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    StripLineComments.Comment() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String comment) + +
    +          Alt.
    + java.lang.StringgetValue() + +
    +          Returns the prefix for this type of line comment.
    + voidsetValue(java.lang.String comment) + +
    +          Sets the prefix for this type of line comment.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StripLineComments.Comment

    +
    +public StripLineComments.Comment()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setValue

    +
    +public final void setValue(java.lang.String comment)
    +
    +
    Sets the prefix for this type of line comment. +

    +

    +
    Parameters:
    comment - The prefix for a line comment of this type. + Must not be null.
    +
    +
    +
    + +

    +getValue

    +
    +public final java.lang.String getValue()
    +
    +
    Returns the prefix for this type of line comment. +

    +

    + +
    Returns:
    the prefix for this type of line comment.
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String comment)
    +
    +
    Alt. syntax to set the prefix for this type of line comment. +

    +

    +
    Parameters:
    comment - The prefix for a line comment of this type. + Must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.html new file mode 100644 index 000000000..bbd1658b4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/StripLineComments.html @@ -0,0 +1,451 @@ + + + + + + +StripLineComments (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class StripLineComments

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.StripLineComments
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class StripLineComments
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +This filter strips line comments. + + Example: + + 

    <striplinecomments>
+   <comment value="#"/>
+   <comment value="--"/>
+   <comment value="REM "/>
+   <comment value="rem "/>
+   <comment value="//"/>
+ </striplinecomments>
    + + Or: + + 
    <filterreader
+      classname="org.apache.tools.ant.filters.StripLineComments">
+   <param type="comment" value="#"/>
+   <param type="comment" value="--"/>
+   <param type="comment" value="REM "/>
+   <param type="comment" value="rem "/>
+   <param type="comment" value="//"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classStripLineComments.Comment + +
    +          The class that holds a comment representation.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    StripLineComments() + +
    +          Constructor for "dummy" instances.
    StripLineComments(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredComment(StripLineComments.Comment comment) + +
    +          Adds a comment element to the list of prefixes.
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new StripLineComments using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, only including + lines from the original stream which don't start with any of the + specified comment prefixes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StripLineComments

    +
    +public StripLineComments()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +StripLineComments

    +
    +public StripLineComments(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, only including + lines from the original stream which don't start with any of the + specified comment prefixes. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +addConfiguredComment

    +
    +public void addConfiguredComment(StripLineComments.Comment comment)
    +
    +
    Adds a comment element to the list of prefixes. +

    +

    +
    +
    +
    +
    Parameters:
    comment - The comment element to add to the + list of comment prefixes to strip. Must not be null.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new StripLineComments using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SuffixLines.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SuffixLines.html new file mode 100644 index 000000000..a2bb81b4a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/SuffixLines.html @@ -0,0 +1,426 @@ + + + + + + +SuffixLines (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class SuffixLines

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.SuffixLines
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class SuffixLines
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Attaches a suffix to every line. + + Example: + 

    <suffixlines suffix="Foo"/>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.SuffixLines">
+  <param name="suffix" value="Foo"/>
+ </filterreader>
    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    SuffixLines() + +
    +          Constructor for "dummy" instances.
    SuffixLines(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new SuffixLines filter using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetSuffix(java.lang.String suffix) + +
    +          Sets the suffix to add at the end of each input line.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SuffixLines

    +
    +public SuffixLines()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +SuffixLines

    +
    +public SuffixLines(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. One line is read + from the original input, and the suffix added. The resulting + line is then used until it ends, at which point the next original line + is read, etc. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setSuffix

    +
    +public void setSuffix(java.lang.String suffix)
    +
    +
    Sets the suffix to add at the end of each input line. +

    +

    +
    +
    +
    +
    Parameters:
    suffix - The suffix to add at the end of each input line. + May be null, in which case no suffix + is added.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new SuffixLines filter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TabsToSpaces.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TabsToSpaces.html new file mode 100644 index 000000000..1a964ece4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TabsToSpaces.html @@ -0,0 +1,420 @@ + + + + + + +TabsToSpaces (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TabsToSpaces

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.TabsToSpaces
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class TabsToSpaces
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Converts tabs to spaces. + + Example: + + 

    <tabtospaces tablength="8"/>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.TabsToSpaces">
+   <param name="tablength" value="8"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    TabsToSpaces() + +
    +          Constructor for "dummy" instances.
    TabsToSpaces(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new TabsToSpaces using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream, converting tabs + to the specified number of spaces.
    + voidsetTablength(int tabLength) + +
    +          Sets the tab length.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TabsToSpaces

    +
    +public TabsToSpaces()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +TabsToSpaces

    +
    +public TabsToSpaces(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, converting tabs + to the specified number of spaces. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setTablength

    +
    +public void setTablength(int tabLength)
    +
    +
    Sets the tab length. +

    +

    +
    +
    +
    +
    Parameters:
    tabLength - the number of spaces to be used when converting a tab.
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new TabsToSpaces using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TailFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TailFilter.html new file mode 100644 index 000000000..f20b642f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TailFilter.html @@ -0,0 +1,446 @@ + + + + + + +TailFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TailFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.BaseParamFilterReader
+                  extended by org.apache.tools.ant.filters.TailFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader, Parameterizable
    +
    +
    +
    +
    public final class TailFilter
    extends BaseParamFilterReader
    implements ChainableReader
    + + +

    +Reads the last n lines of a stream. (Default is last10 lines.) + + Example: + + 

    <tailfilter lines="3"/>
    + + Or: + + 
    <filterreader classname="org.apache.tools.ant.filters.TailFilter">
+   <param name="lines" value="3"/>
+ </filterreader>
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    TailFilter() + +
    +          Constructor for "dummy" instances.
    TailFilter(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Creates a new TailFilter using the passed in + Reader for instantiation.
    + intread() + +
    +          Returns the next character in the filtered stream.
    + voidsetLines(long lines) + +
    +          Sets the number of lines to be returned in the filtered stream.
    + voidsetSkip(long skip) + +
    +          Sets the number of lines to be skipped in the filtered stream.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseParamFilterReader
    getParameters, setParameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TailFilter

    +
    +public TailFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +TailFilter

    +
    +public TailFilter(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream. If the read-ahead + has been completed, the next character in the buffer is returned. + Otherwise, the stream is read to the end and buffered (with the buffer + growing as necessary), then the appropriate position in the buffer is + set to read from. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +setLines

    +
    +public void setLines(long lines)
    +
    +
    Sets the number of lines to be returned in the filtered stream. +

    +

    +
    +
    +
    +
    Parameters:
    lines - the number of lines to be returned in the filtered stream
    +
    +
    +
    + +

    +setSkip

    +
    +public void setSkip(long skip)
    +
    +
    Sets the number of lines to be skipped in the filtered stream. +

    +

    +
    +
    +
    +
    Parameters:
    skip - the number of lines to be skipped in the filtered stream
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Creates a new TailFilter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - A Reader object providing the underlying stream. + Must not be null. +
    Returns:
    a new filter based on this configuration, but filtering + the specified reader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html new file mode 100644 index 000000000..781b368d2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ChainableReaderFilter.html @@ -0,0 +1,329 @@ + + + + + + +TokenFilter.ChainableReaderFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.ChainableReaderFilter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Direct Known Subclasses:
    ScriptFilter, TokenFilter.ContainsRegex, TokenFilter.IgnoreBlank, TokenFilter.ReplaceRegex, TokenFilter.ReplaceString, TokenFilter.Trim, UniqFilter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public abstract static class TokenFilter.ChainableReaderFilter
    extends ProjectComponent
    implements ChainableReader, TokenFilter.Filter
    + + +

    +Abstract class that converts derived filter classes into + ChainableReaderFilter's +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.ChainableReaderFilter() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader reader) + +
    +          Chain a tokenfilter reader to a reader,
    + voidsetByLine(boolean byLine) + +
    +          set whether to use filetokenizer or line tokenizer
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.filters.TokenFilter.Filter
    filter
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.ChainableReaderFilter

    +
    +public TokenFilter.ChainableReaderFilter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setByLine

    +
    +public void setByLine(boolean byLine)
    +
    +
    set whether to use filetokenizer or line tokenizer +

    +

    +
    +
    +
    +
    Parameters:
    byLine - if true use a linetokenizer (default) otherwise + use a filetokenizer
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader reader)
    +
    +
    Chain a tokenfilter reader to a reader, +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    reader - the input reader object +
    Returns:
    the chained reader object
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsRegex.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsRegex.html new file mode 100644 index 000000000..c555d409e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsRegex.html @@ -0,0 +1,355 @@ + + + + + + +TokenFilter.ContainsRegex (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.ContainsRegex

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.TokenFilter.ContainsRegex
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.ContainsRegex
    extends TokenFilter.ChainableReaderFilter
    + + +

    +filter to filter tokens matching regular expressions. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.ContainsRegex() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String string) + +
    +          apply regex and substitution on a string
    + voidsetFlags(java.lang.String flags) + +
    +           
    + voidsetPattern(java.lang.String from) + +
    +           
    + voidsetReplace(java.lang.String to) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.ContainsRegex

    +
    +public TokenFilter.ContainsRegex()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String from)
    +
    +
    +
    Parameters:
    from - the regex pattern
    +
    +
    +
    + +

    +setReplace

    +
    +public void setReplace(java.lang.String to)
    +
    +
    +
    Parameters:
    to - the replacement string
    +
    +
    +
    + +

    +setFlags

    +
    +public void setFlags(java.lang.String flags)
    +
    +
    +
    Parameters:
    flags - the regex flags
    +
    +
    +
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String string)
    +
    +
    apply regex and substitution on a string +

    +

    +
    Parameters:
    string - the string to apply filter on +
    Returns:
    the filtered string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsString.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsString.html new file mode 100644 index 000000000..fcd01473b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ContainsString.html @@ -0,0 +1,316 @@ + + + + + + +TokenFilter.ContainsString (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.ContainsString

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ContainsString
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.ContainsString
    extends ProjectComponent
    implements TokenFilter.Filter
    + + +

    +Simple filter to filter lines contains strings +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.ContainsString() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String string) + +
    +          Filter strings that contain the contains attribute
    + voidsetContains(java.lang.String contains) + +
    +          the contains attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.ContainsString

    +
    +public TokenFilter.ContainsString()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setContains

    +
    +public void setContains(java.lang.String contains)
    +
    +
    the contains attribute +

    +

    +
    +
    +
    +
    Parameters:
    contains - the string that the token should contain
    +
    +
    +
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String string)
    +
    +
    Filter strings that contain the contains attribute +

    +

    +
    Specified by:
    filter in interface TokenFilter.Filter
    +
    +
    +
    Parameters:
    string - the string to be filtered +
    Returns:
    null if the string does not contain "contains", + string otherwise
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.DeleteCharacters.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.DeleteCharacters.html new file mode 100644 index 000000000..ea1d6e605 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.DeleteCharacters.html @@ -0,0 +1,344 @@ + + + + + + +TokenFilter.DeleteCharacters (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.DeleteCharacters

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.DeleteCharacters
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.DeleteCharacters
    extends ProjectComponent
    implements TokenFilter.Filter, ChainableReader
    + + +

    +Filter to delete characters +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.DeleteCharacters() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader reader) + +
    +          factory method to provide a reader that removes + the characters from a reader as part of a filter + chain
    + java.lang.Stringfilter(java.lang.String string) + +
    +          remove characters from a string
    + voidsetChars(java.lang.String deleteChars) + +
    +          Set the list of characters to delete
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.DeleteCharacters

    +
    +public TokenFilter.DeleteCharacters()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setChars

    +
    +public void setChars(java.lang.String deleteChars)
    +
    +
    Set the list of characters to delete +

    +

    +
    +
    +
    +
    Parameters:
    deleteChars - the list of characters
    +
    +
    +
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String string)
    +
    +
    remove characters from a string +

    +

    +
    Specified by:
    filter in interface TokenFilter.Filter
    +
    +
    +
    Parameters:
    string - the string to remove the characters from +
    Returns:
    the converted string
    +
    +
    +
    + +

    +chain

    +
    +public java.io.Reader chain(java.io.Reader reader)
    +
    +
    factory method to provide a reader that removes + the characters from a reader as part of a filter + chain +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    reader - the reader object +
    Returns:
    the chained reader object
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.FileTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.FileTokenizer.html new file mode 100644 index 000000000..8574391d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.FileTokenizer.html @@ -0,0 +1,267 @@ + + + + + + +TokenFilter.FileTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.FileTokenizer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.FileTokenizer
+          extended by org.apache.tools.ant.filters.TokenFilter.FileTokenizer
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Tokenizer
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.FileTokenizer
    extends FileTokenizer
    + + +

    +class to read the complete input into a string +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.FileTokenizer() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.FileTokenizer
    getPostToken, getToken
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.FileTokenizer

    +
    +public TokenFilter.FileTokenizer()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Filter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Filter.html new file mode 100644 index 000000000..b4c48f0b8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Filter.html @@ -0,0 +1,215 @@ + + + + + + +TokenFilter.Filter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Interface TokenFilter.Filter

    +
    +
    All Known Implementing Classes:
    ScriptFilter, TokenFilter.ChainableReaderFilter, TokenFilter.ContainsRegex, TokenFilter.ContainsString, TokenFilter.DeleteCharacters, TokenFilter.IgnoreBlank, TokenFilter.ReplaceRegex, TokenFilter.ReplaceString, TokenFilter.Trim, UniqFilter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static interface TokenFilter.Filter
    + + +

    +string filters implement this interface +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String string) + +
    +          filter and/of modify a string
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +filter

    +
    +java.lang.String filter(java.lang.String string)
    +
    +
    filter and/of modify a string +

    +

    +
    Parameters:
    string - the string to filter +
    Returns:
    the modified string or null if the + string did not pass the filter
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.IgnoreBlank.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.IgnoreBlank.html new file mode 100644 index 000000000..53e1f6c7f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.IgnoreBlank.html @@ -0,0 +1,299 @@ + + + + + + +TokenFilter.IgnoreBlank (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.IgnoreBlank

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.TokenFilter.IgnoreBlank
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.IgnoreBlank
    extends TokenFilter.ChainableReaderFilter
    + + +

    +Filter remove empty tokens +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.IgnoreBlank() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String line) + +
    +          filter and/of modify a string
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.IgnoreBlank

    +
    +public TokenFilter.IgnoreBlank()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String line)
    +
    +
    Description copied from interface: TokenFilter.Filter
    +
    filter and/of modify a string +

    +

    +
    Parameters:
    line - the line to modify +
    Returns:
    the trimmed line
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceRegex.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceRegex.html new file mode 100644 index 000000000..92f0e1cce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceRegex.html @@ -0,0 +1,360 @@ + + + + + + +TokenFilter.ReplaceRegex (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.ReplaceRegex

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.TokenFilter.ReplaceRegex
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.ReplaceRegex
    extends TokenFilter.ChainableReaderFilter
    + + +

    +filter to replace regex. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.ReplaceRegex() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String line) + +
    +          filter and/of modify a string
    + voidsetFlags(java.lang.String flags) + +
    +           
    + voidsetPattern(java.lang.String from) + +
    +          the from attribute
    + voidsetReplace(java.lang.String to) + +
    +          the to attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.ReplaceRegex

    +
    +public TokenFilter.ReplaceRegex()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String from)
    +
    +
    the from attribute +

    +

    +
    Parameters:
    from - the regex string
    +
    +
    +
    + +

    +setReplace

    +
    +public void setReplace(java.lang.String to)
    +
    +
    the to attribute +

    +

    +
    Parameters:
    to - the replacement string
    +
    +
    +
    + +

    +setFlags

    +
    +public void setFlags(java.lang.String flags)
    +
    +
    +
    Parameters:
    flags - the regex flags
    +
    +
    +
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String line)
    +
    +
    Description copied from interface: TokenFilter.Filter
    +
    filter and/of modify a string +

    +

    +
    Parameters:
    line - the string to modify +
    Returns:
    the modified string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceString.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceString.html new file mode 100644 index 000000000..a3f4e7312 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.ReplaceString.html @@ -0,0 +1,342 @@ + + + + + + +TokenFilter.ReplaceString (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.ReplaceString

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.TokenFilter.ReplaceString
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.ReplaceString
    extends TokenFilter.ChainableReaderFilter
    + + +

    +Simple replace string filter. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.ReplaceString() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String line) + +
    +          Filter a string 'line' replacing from with to + (C&P from the Replace task)
    + voidsetFrom(java.lang.String from) + +
    +          the from attribute
    + voidsetTo(java.lang.String to) + +
    +          the to attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.ReplaceString

    +
    +public TokenFilter.ReplaceString()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFrom

    +
    +public void setFrom(java.lang.String from)
    +
    +
    the from attribute +

    +

    +
    Parameters:
    from - the string to replace
    +
    +
    +
    + +

    +setTo

    +
    +public void setTo(java.lang.String to)
    +
    +
    the to attribute +

    +

    +
    Parameters:
    to - the string to replace 'from' with
    +
    +
    +
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String line)
    +
    +
    Filter a string 'line' replacing from with to + (C&P from the Replace task) +

    +

    +
    Parameters:
    line - the string to be filtered +
    Returns:
    the filtered line
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.StringTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.StringTokenizer.html new file mode 100644 index 000000000..353ea97c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.StringTokenizer.html @@ -0,0 +1,272 @@ + + + + + + +TokenFilter.StringTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.StringTokenizer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.StringTokenizer
+          extended by org.apache.tools.ant.filters.TokenFilter.StringTokenizer
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Tokenizer
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.StringTokenizer
    extends StringTokenizer
    + + +

    +class to tokenize the input as areas separated + by white space, or by a specified list of + delim characters. Behaves like java.util.StringTokenizer. + if the stream starts with delim characters, the first + token will be an empty string (unless the treat delims + as tokens flag is set). +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.StringTokenizer() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.StringTokenizer
    getPostToken, getToken, setDelims, setDelimsAreTokens, setIncludeDelims, setSuppressDelims
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.StringTokenizer

    +
    +public TokenFilter.StringTokenizer()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Trim.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Trim.html new file mode 100644 index 000000000..cd7df34c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.Trim.html @@ -0,0 +1,299 @@ + + + + + + +TokenFilter.Trim (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter.Trim

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.TokenFilter.Trim
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    Enclosing class:
    TokenFilter
    +
    +
    +
    +
    public static class TokenFilter.Trim
    extends TokenFilter.ChainableReaderFilter
    + + +

    +Filter to trim white space +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TokenFilter.Trim() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String line) + +
    +          filter and/of modify a string
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter.Trim

    +
    +public TokenFilter.Trim()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String line)
    +
    +
    Description copied from interface: TokenFilter.Filter
    +
    filter and/of modify a string +

    +

    +
    Parameters:
    line - the string to be trimmed +
    Returns:
    the trimmed string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.html new file mode 100644 index 000000000..39f5c2205 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/TokenFilter.html @@ -0,0 +1,862 @@ + + + + + + +TokenFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class TokenFilter

    +
    +java.lang.Object
+  extended by java.io.Reader
+      extended by java.io.FilterReader
+          extended by org.apache.tools.ant.filters.BaseFilterReader
+              extended by org.apache.tools.ant.filters.TokenFilter
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.lang.Readable, ChainableReader
    +
    +
    +
    +
    public class TokenFilter
    extends BaseFilterReader
    implements ChainableReader
    + + +

    +This splits up input into tokens and passes + the tokens to a sequence of filters. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    See Also:
    BaseFilterReader, +ChainableReader, +DynamicConfigurator
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classTokenFilter.ChainableReaderFilter + +
    +          Abstract class that converts derived filter classes into + ChainableReaderFilter's
    +static classTokenFilter.ContainsRegex + +
    +          filter to filter tokens matching regular expressions.
    +static classTokenFilter.ContainsString + +
    +          Simple filter to filter lines contains strings
    +static classTokenFilter.DeleteCharacters + +
    +          Filter to delete characters
    +static classTokenFilter.FileTokenizer + +
    +          class to read the complete input into a string
    +static interfaceTokenFilter.Filter + +
    +          string filters implement this interface
    +static classTokenFilter.IgnoreBlank + +
    +          Filter remove empty tokens
    +static classTokenFilter.ReplaceRegex + +
    +          filter to replace regex.
    +static classTokenFilter.ReplaceString + +
    +          Simple replace string filter.
    +static classTokenFilter.StringTokenizer + +
    +          class to tokenize the input as areas separated + by white space, or by a specified list of + delim characters.
    +static classTokenFilter.Trim + +
    +          Filter to trim white space
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.io.FilterReader
    in
    +  + + + + + + + +
    Fields inherited from class java.io.Reader
    lock
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    TokenFilter() + +
    +          Constructor for "dummy" instances.
    TokenFilter(java.io.Reader in) + +
    +          Creates a new filtered reader.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(TokenFilter.Filter filter) + +
    +          Add an arbitrary filter
    + voidadd(Tokenizer tokenizer) + +
    +          add an arbitrary tokenizer
    + voidaddContainsRegex(TokenFilter.ContainsRegex filter) + +
    +          contains regex filter
    + voidaddContainsString(TokenFilter.ContainsString filter) + +
    +          contains string filter
    + voidaddDeleteCharacters(TokenFilter.DeleteCharacters filter) + +
    +          delete chars
    + voidaddFileTokenizer(TokenFilter.FileTokenizer tokenizer) + +
    +          add a file tokenizer
    + voidaddIgnoreBlank(TokenFilter.IgnoreBlank filter) + +
    +          ignore blank filter
    + voidaddLineTokenizer(LineTokenizer tokenizer) + +
    +          add a line tokenizer - this is the default.
    + voidaddReplaceRegex(TokenFilter.ReplaceRegex filter) + +
    +          replace regex filter
    + voidaddReplaceString(TokenFilter.ReplaceString filter) + +
    +          replace string filter
    + voidaddStringTokenizer(TokenFilter.StringTokenizer tokenizer) + +
    +          add a string tokenizer
    + voidaddTrim(TokenFilter.Trim filter) + +
    +          trim filter
    + java.io.Readerchain(java.io.Reader reader) + +
    +          Creates a new TokenFilter using the passed in + Reader for instantiation.
    +static intconvertRegexOptions(java.lang.String flags) + +
    +          convert regex option flag characters to regex options + + g - Regexp.REPLACE_ALL + i - Regexp.MATCH_CASE_INSENSITIVE + m - Regexp.MATCH_MULTILINE + s - Regexp.MATCH_SINGLELINE +
    + intread() + +
    +          Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions.
    +static java.lang.StringresolveBackSlash(java.lang.String input) + +
    +          xml does not do "c" like interpretation of strings.
    + voidsetDelimOutput(java.lang.String delimOutput) + +
    +          set the output delimiter.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.BaseFilterReader
    getInitialized, getProject, read, readFully, readLine, setInitialized, setProject, skip
    +  + + + + + + + +
    Methods inherited from class java.io.FilterReader
    close, mark, markSupported, ready, reset
    +  + + + + + + + +
    Methods inherited from class java.io.Reader
    read, read
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TokenFilter

    +
    +public TokenFilter()
    +
    +
    Constructor for "dummy" instances. +

    +

    +
    See Also:
    BaseFilterReader.BaseFilterReader()
    +
    +
    + +

    +TokenFilter

    +
    +public TokenFilter(java.io.Reader in)
    +
    +
    Creates a new filtered reader. +

    +

    +
    Parameters:
    in - A Reader object providing the underlying stream. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +read

    +
    +public int read()
+         throws java.io.IOException
    +
    +
    Returns the next character in the filtered stream, only including + lines from the original stream which match all of the specified + regular expressions. +

    +

    +
    Overrides:
    read in class java.io.FilterReader
    +
    +
    + +
    Returns:
    the next character in the resulting stream, or -1 + if the end of the resulting stream has been reached +
    Throws: +
    java.io.IOException - if the underlying stream throws an IOException + during reading
    +
    +
    +
    + +

    +chain

    +
    +public final java.io.Reader chain(java.io.Reader reader)
    +
    +
    Creates a new TokenFilter using the passed in + Reader for instantiation. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    reader - A Reader object providing the underlying stream. +
    Returns:
    a new filter based on this configuration
    +
    +
    +
    + +

    +setDelimOutput

    +
    +public void setDelimOutput(java.lang.String delimOutput)
    +
    +
    set the output delimiter. +

    +

    +
    +
    +
    +
    Parameters:
    delimOutput - replaces the delim string returned by the + tokenizer, if present.
    +
    +
    +
    + +

    +addLineTokenizer

    +
    +public void addLineTokenizer(LineTokenizer tokenizer)
    +
    +
    add a line tokenizer - this is the default. +

    +

    +
    +
    +
    +
    Parameters:
    tokenizer - the line tokenizer
    +
    +
    +
    + +

    +addStringTokenizer

    +
    +public void addStringTokenizer(TokenFilter.StringTokenizer tokenizer)
    +
    +
    add a string tokenizer +

    +

    +
    +
    +
    +
    Parameters:
    tokenizer - the string tokenizer
    +
    +
    +
    + +

    +addFileTokenizer

    +
    +public void addFileTokenizer(TokenFilter.FileTokenizer tokenizer)
    +
    +
    add a file tokenizer +

    +

    +
    +
    +
    +
    Parameters:
    tokenizer - the file tokenizer
    +
    +
    +
    + +

    +add

    +
    +public void add(Tokenizer tokenizer)
    +
    +
    add an arbitrary tokenizer +

    +

    +
    +
    +
    +
    Parameters:
    tokenizer - the tokenizer to all, only one allowed
    +
    +
    +
    + +

    +addReplaceString

    +
    +public void addReplaceString(TokenFilter.ReplaceString filter)
    +
    +
    replace string filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the replace string filter
    +
    +
    +
    + +

    +addContainsString

    +
    +public void addContainsString(TokenFilter.ContainsString filter)
    +
    +
    contains string filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the contains string filter
    +
    +
    +
    + +

    +addReplaceRegex

    +
    +public void addReplaceRegex(TokenFilter.ReplaceRegex filter)
    +
    +
    replace regex filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the replace regex filter
    +
    +
    +
    + +

    +addContainsRegex

    +
    +public void addContainsRegex(TokenFilter.ContainsRegex filter)
    +
    +
    contains regex filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the contains regex filter
    +
    +
    +
    + +

    +addTrim

    +
    +public void addTrim(TokenFilter.Trim filter)
    +
    +
    trim filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the trim filter
    +
    +
    +
    + +

    +addIgnoreBlank

    +
    +public void addIgnoreBlank(TokenFilter.IgnoreBlank filter)
    +
    +
    ignore blank filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the ignore blank filter
    +
    +
    +
    + +

    +addDeleteCharacters

    +
    +public void addDeleteCharacters(TokenFilter.DeleteCharacters filter)
    +
    +
    delete chars +

    +

    +
    +
    +
    +
    Parameters:
    filter - the delete characters filter
    +
    +
    +
    + +

    +add

    +
    +public void add(TokenFilter.Filter filter)
    +
    +
    Add an arbitrary filter +

    +

    +
    +
    +
    +
    Parameters:
    filter - the filter to add
    +
    +
    +
    + +

    +resolveBackSlash

    +
    +public static java.lang.String resolveBackSlash(java.lang.String input)
    +
    +
    xml does not do "c" like interpretation of strings. + i.e. \n\r\t etc. + this method processes \n, \r, \t, \f, \\ + also subs \s -> " \n\r\t\f" + a trailing '\' will be ignored +

    +

    +
    +
    +
    +
    Parameters:
    input - raw string with possible embedded '\'s +
    Returns:
    converted string
    +
    +
    +
    + +

    +convertRegexOptions

    +
    +public static int convertRegexOptions(java.lang.String flags)
    +
    +
    convert regex option flag characters to regex options +
    +
  • g - Regexp.REPLACE_ALL
    • +
  • i - Regexp.MATCH_CASE_INSENSITIVE
    • +
  • m - Regexp.MATCH_MULTILINE
    • +
  • s - Regexp.MATCH_SINGLELINE
    • +
    +

    +

    +
    +
    +
    +
    Parameters:
    flags - the string containing the flags +
    Returns:
    the Regexp option bits
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/UniqFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/UniqFilter.html new file mode 100644 index 000000000..ada2fe58e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/UniqFilter.html @@ -0,0 +1,305 @@ + + + + + + +UniqFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters +
    +Class UniqFilter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.filters.UniqFilter
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, TokenFilter.Filter
    +
    +
    +
    +
    public class UniqFilter
    extends TokenFilter.ChainableReaderFilter
    + + +

    +Like the Unix uniq(1) command, only returns tokens that are + different from their ancestor token. + +

    This filter is probably most useful if used together with a + sortfilter.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    UniqFilter() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringfilter(java.lang.String string) + +
    +          filter and/of modify a string
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
    chain, setByLine
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +UniqFilter

    +
    +public UniqFilter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +filter

    +
    +public java.lang.String filter(java.lang.String string)
    +
    +
    Description copied from interface: TokenFilter.Filter
    +
    filter and/of modify a string +

    +

    +
    Parameters:
    string - the string to filter +
    Returns:
    the modified string or null if the + string did not pass the filter
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-frame.html new file mode 100644 index 000000000..ff63945be --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-frame.html @@ -0,0 +1,117 @@ + + + + + + +org.apache.tools.ant.filters (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.filters + + + + +
    +Interfaces  + +
    +ChainableReader +
    +TokenFilter.Filter
    + + + + + + +
    +Classes  + +
    +BaseFilterReader +
    +BaseParamFilterReader +
    +ClassConstants +
    +ConcatFilter +
    +EscapeUnicode +
    +ExpandProperties +
    +FixCrLfFilter +
    +FixCrLfFilter.AddAsisRemove +
    +FixCrLfFilter.CrLf +
    +HeadFilter +
    +LineContains +
    +LineContains.Contains +
    +LineContainsRegExp +
    +PrefixLines +
    +ReplaceTokens +
    +ReplaceTokens.Token +
    +SortFilter +
    +StringInputStream +
    +StripJavaComments +
    +StripLineBreaks +
    +StripLineComments +
    +StripLineComments.Comment +
    +SuffixLines +
    +TabsToSpaces +
    +TailFilter +
    +TokenFilter +
    +TokenFilter.ChainableReaderFilter +
    +TokenFilter.ContainsRegex +
    +TokenFilter.ContainsString +
    +TokenFilter.DeleteCharacters +
    +TokenFilter.FileTokenizer +
    +TokenFilter.IgnoreBlank +
    +TokenFilter.ReplaceRegex +
    +TokenFilter.ReplaceString +
    +TokenFilter.StringTokenizer +
    +TokenFilter.Trim +
    +UniqFilter
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-summary.html new file mode 100644 index 000000000..94cef3776 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-summary.html @@ -0,0 +1,326 @@ + + + + + + +org.apache.tools.ant.filters (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.filters +

    + + + + + + + + + + + + + +
    +Interface Summary
    ChainableReaderInterface indicating that a reader may be chained to another one.
    TokenFilter.Filterstring filters implement this interface
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    BaseFilterReaderBase class for core filter readers.
    BaseParamFilterReaderParameterized base class for core filter readers.
    ClassConstantsAssembles the constants declared in a Java class in + key1=value1(line separator)key2=value2 + format.
    ConcatFilterConcats a file before and/or after the file.
    EscapeUnicodeThis method converts non-latin characters to unicode escapes.
    ExpandPropertiesExpands Ant properties, if any, in the data.
    FixCrLfFilterConverts text to local OS formatting conventions, as well as repair text + damaged by misconfigured or misguided editors or file transfer programs.
    FixCrLfFilter.AddAsisRemoveEnumerated attribute with the values "asis", "add" and "remove".
    FixCrLfFilter.CrLfEnumerated attribute with the values "asis", "cr", "lf" and "crlf".
    HeadFilterReads the first n lines of a stream.
    LineContainsFilter which includes only those lines that contain all the user-specified + strings.
    LineContains.ContainsHolds a contains element
    LineContainsRegExpFilter which includes only those lines that contain the user-specified + regular expression matching strings.
    PrefixLinesAttaches a prefix to every line.
    ReplaceTokensReplaces tokens in the original input with user-supplied values.
    ReplaceTokens.TokenHolds a token
    SortFilter + Sort a file before and/or after the file.
    StringInputStreamWraps a String as an InputStream.
    StripJavaCommentsThis is a Java comment and string stripper reader that filters + those lexical tokens out for purposes of simple Java parsing.
    StripLineBreaksFilter to flatten the stream to a single line.
    StripLineCommentsThis filter strips line comments.
    StripLineComments.CommentThe class that holds a comment representation.
    SuffixLinesAttaches a suffix to every line.
    TabsToSpacesConverts tabs to spaces.
    TailFilterReads the last n lines of a stream.
    TokenFilterThis splits up input into tokens and passes + the tokens to a sequence of filters.
    TokenFilter.ChainableReaderFilterAbstract class that converts derived filter classes into + ChainableReaderFilter's
    TokenFilter.ContainsRegexfilter to filter tokens matching regular expressions.
    TokenFilter.ContainsStringSimple filter to filter lines contains strings
    TokenFilter.DeleteCharactersFilter to delete characters
    TokenFilter.FileTokenizerclass to read the complete input into a string
    TokenFilter.IgnoreBlankFilter remove empty tokens
    TokenFilter.ReplaceRegexfilter to replace regex.
    TokenFilter.ReplaceStringSimple replace string filter.
    TokenFilter.StringTokenizerclass to tokenize the input as areas separated + by white space, or by a specified list of + delim characters.
    TokenFilter.TrimFilter to trim white space
    UniqFilterLike the Unix uniq(1) command, only returns tokens that are + different from their ancestor token.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-tree.html new file mode 100644 index 000000000..9f532bc51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/package-tree.html @@ -0,0 +1,201 @@ + + + + + + +org.apache.tools.ant.filters Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.filters +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/ChainReaderHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/ChainReaderHelper.html new file mode 100644 index 000000000..3f741727b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/ChainReaderHelper.html @@ -0,0 +1,469 @@ + + + + + + +ChainReaderHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters.util +
    +Class ChainReaderHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.filters.util.ChainReaderHelper
+
    +
    +
    +
    public final class ChainReaderHelper
    extends java.lang.Object
    + + +

    +Process a FilterReader chain. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    + intbufferSize + +
    +          The size of the buffer to be used.
    + java.util.VectorfilterChains + +
    +          Chain of filters
    + java.io.ReaderprimaryReader + +
    +          The primary reader to which the reader chain is to be attached.
    +  + + + + + + + + + + +
    +Constructor Summary
    ChainReaderHelper() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.ReadergetAssembledReader() + +
    +          Assemble the reader
    + ProjectgetProject() + +
    +          Get the project
    + java.lang.StringreadFully(java.io.Reader rdr) + +
    +          Read data from the reader and return the + contents as a string.
    + voidsetBufferSize(int size) + +
    +          Sets the buffer size to be used.
    + voidsetFilterChains(java.util.Vector fchain) + +
    +          Sets the collection of filter reader sets
    + voidsetPrimaryReader(java.io.Reader rdr) + +
    +          Sets the primary reader
    + voidsetProject(Project project) + +
    +          Set the project to work with
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +primaryReader

    +
    +public java.io.Reader primaryReader
    +
    +
    The primary reader to which the reader chain is to be attached. +

    +

    +
    +
    +
    + +

    +bufferSize

    +
    +public int bufferSize
    +
    +
    The size of the buffer to be used. +

    +

    +
    +
    +
    + +

    +filterChains

    +
    +public java.util.Vector filterChains
    +
    +
    Chain of filters +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ChainReaderHelper

    +
    +public ChainReaderHelper()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPrimaryReader

    +
    +public void setPrimaryReader(java.io.Reader rdr)
    +
    +
    Sets the primary reader +

    +

    +
    Parameters:
    rdr - the reader object
    +
    +
    +
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set the project to work with +

    +

    +
    Parameters:
    project - the current project
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get the project +

    +

    + +
    Returns:
    the current project
    +
    +
    +
    + +

    +setBufferSize

    +
    +public void setBufferSize(int size)
    +
    +
    Sets the buffer size to be used. Defaults to 8192, + if this method is not invoked. +

    +

    +
    Parameters:
    size - the buffer size to use
    +
    +
    +
    + +

    +setFilterChains

    +
    +public void setFilterChains(java.util.Vector fchain)
    +
    +
    Sets the collection of filter reader sets +

    +

    +
    Parameters:
    fchain - the filter chains collection
    +
    +
    +
    + +

    +getAssembledReader

    +
    +public java.io.Reader getAssembledReader()
+                                  throws BuildException
    +
    +
    Assemble the reader +

    +

    + +
    Returns:
    the assembled reader +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +readFully

    +
    +public java.lang.String readFully(java.io.Reader rdr)
+                           throws java.io.IOException
    +
    +
    Read data from the reader and return the + contents as a string. +

    +

    +
    Parameters:
    rdr - the reader object +
    Returns:
    the contents of the file as a string +
    Throws: +
    java.io.IOException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/JavaClassHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/JavaClassHelper.html new file mode 100644 index 000000000..10b777ce8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/JavaClassHelper.html @@ -0,0 +1,257 @@ + + + + + + +JavaClassHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.filters.util +
    +Class JavaClassHelper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.filters.util.JavaClassHelper
+
    +
    +
    +
    public final class JavaClassHelper
    extends java.lang.Object
    + + +

    +Helper class that filters constants from a Java Class +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    JavaClassHelper() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static java.lang.StringBuffergetConstants(byte[] bytes) + +
    +          Get the constants declared in a file as name=value
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +JavaClassHelper

    +
    +public JavaClassHelper()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getConstants

    +
    +public static java.lang.StringBuffer getConstants(byte[] bytes)
+                                           throws java.io.IOException
    +
    +
    Get the constants declared in a file as name=value +

    +

    +
    Parameters:
    bytes - the class as a array of bytes +
    Returns:
    a StringBuffer contains the name=value pairs +
    Throws: +
    java.io.IOException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-frame.html new file mode 100644 index 000000000..b6fb7815b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.filters.util (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.filters.util + + + + +
    +Classes  + +
    +ChainReaderHelper +
    +JavaClassHelper
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-summary.html new file mode 100644 index 000000000..51285ca09 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-summary.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.filters.util (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.filters.util +

    + + + + + + + + + + + + + +
    +Class Summary
    ChainReaderHelperProcess a FilterReader chain.
    JavaClassHelperHelper class that filters constants from a Java Class
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-tree.html new file mode 100644 index 000000000..46816d81a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/filters/util/package-tree.html @@ -0,0 +1,147 @@ + + + + + + +org.apache.tools.ant.filters.util Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.filters.util +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/AntXMLContext.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/AntXMLContext.html new file mode 100644 index 000000000..438e3d923 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/AntXMLContext.html @@ -0,0 +1,906 @@ + + + + + + +AntXMLContext (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class AntXMLContext

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.AntXMLContext
+
    +
    +
    +
    public class AntXMLContext
    extends java.lang.Object
    + + +

    +Context information for the ant processing. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AntXMLContext(Project project) + +
    +          constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTarget(Target target) + +
    +          add a new target
    + voidconfigureId(java.lang.Object element, + org.xml.sax.Attributes attr) + +
    +          Scans an attribute list for the id attribute and + stores a reference to the target object in the project if an + id is found.
    + RuntimeConfigurablecurrentWrapper() + +
    +          get the current runtime configurable wrapper + can return null
    + voidendPrefixMapping(java.lang.String prefix) + +
    +          End of prefix to uri mapping.
    + java.io.FilegetBuildFile() + +
    +          find out the build file
    + java.io.FilegetBuildFileParent() + +
    +          find out the parent build file of this build file
    + java.net.URLgetBuildFileParentURL() + +
    +          find out the parent build file of this build file
    + java.net.URLgetBuildFileURL() + +
    +          find out the build file
    + java.lang.StringgetCurrentProjectName() + +
    +          find out the current project name
    + TargetgetCurrentTarget() + +
    +          get the current target
    + java.util.MapgetCurrentTargets() + +
    +          Get the targets in the current source file.
    + TargetgetImplicitTarget() + +
    +          get the implicit target
    + org.xml.sax.LocatorgetLocator() + +
    +          access the locator
    + java.lang.StringgetPrefixMapping(java.lang.String prefix) + +
    +          prefix to namespace uri mapping
    + ProjectgetProject() + +
    +          find out the project to which this antxml context belongs
    + java.util.VectorgetTargets() + +
    +          access the vector of targets
    + java.util.VectorgetWrapperStack() + +
    +          access the stack of wrappers
    + booleanisIgnoringProjectTag() + +
    +          tells whether the project tag is being ignored
    + RuntimeConfigurableparentWrapper() + +
    +          get the runtime configurable wrapper of the parent project + can return null
    + voidpopWrapper() + +
    +          remove a runtime configurable wrapper from the stack
    + voidpushWrapper(RuntimeConfigurable wrapper) + +
    +          add a runtime configurable wrapper to the internal stack
    + voidsetBuildFile(java.io.File buildFile) + +
    +          sets the build file to which the XML context belongs
    + voidsetBuildFile(java.net.URL buildFile) + +
    +          sets the build file to which the XML context belongs
    + voidsetCurrentProjectName(java.lang.String name) + +
    +          set the name of the current project
    + voidsetCurrentTarget(Target target) + +
    +          sets the current target
    + voidsetCurrentTargets(java.util.Map currentTargets) + +
    +          Set the map of the targets in the current source file.
    + voidsetIgnoreProjectTag(boolean flag) + +
    +          sets the flag to ignore the project tag
    + voidsetImplicitTarget(Target target) + +
    +          sets the implicit target
    + voidsetLocator(org.xml.sax.Locator locator) + +
    +          sets the locator
    + voidstartPrefixMapping(java.lang.String prefix, + java.lang.String uri) + +
    +          Called during parsing, stores the prefix to uri mapping.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntXMLContext

    +
    +public AntXMLContext(Project project)
    +
    +
    constructor +

    +

    +
    Parameters:
    project - the project to which this antxml context belongs to
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setBuildFile

    +
    +public void setBuildFile(java.io.File buildFile)
    +
    +
    sets the build file to which the XML context belongs +

    +

    +
    Parameters:
    buildFile - ant build file
    +
    +
    +
    + +

    +setBuildFile

    +
    +public void setBuildFile(java.net.URL buildFile)
+                  throws java.net.MalformedURLException
    +
    +
    sets the build file to which the XML context belongs +

    +

    +
    Parameters:
    buildFile - ant build file +
    Throws: +
    java.net.MalformedURLException
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getBuildFile

    +
    +public java.io.File getBuildFile()
    +
    +
    find out the build file +

    +

    + +
    Returns:
    the build file to which the xml context belongs
    +
    +
    +
    + +

    +getBuildFileParent

    +
    +public java.io.File getBuildFileParent()
    +
    +
    find out the parent build file of this build file +

    +

    + +
    Returns:
    the parent build file of this build file
    +
    +
    +
    + +

    +getBuildFileURL

    +
    +public java.net.URL getBuildFileURL()
    +
    +
    find out the build file +

    +

    + +
    Returns:
    the build file to which the xml context belongs
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getBuildFileParentURL

    +
    +public java.net.URL getBuildFileParentURL()
    +
    +
    find out the parent build file of this build file +

    +

    + +
    Returns:
    the parent build file of this build file
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    find out the project to which this antxml context belongs +

    +

    + +
    Returns:
    project
    +
    +
    +
    + +

    +getCurrentProjectName

    +
    +public java.lang.String getCurrentProjectName()
    +
    +
    find out the current project name +

    +

    + +
    Returns:
    current project name
    +
    +
    +
    + +

    +setCurrentProjectName

    +
    +public void setCurrentProjectName(java.lang.String name)
    +
    +
    set the name of the current project +

    +

    +
    Parameters:
    name - name of the current project
    +
    +
    +
    + +

    +currentWrapper

    +
    +public RuntimeConfigurable currentWrapper()
    +
    +
    get the current runtime configurable wrapper + can return null +

    +

    + +
    Returns:
    runtime configurable wrapper
    +
    +
    +
    + +

    +parentWrapper

    +
    +public RuntimeConfigurable parentWrapper()
    +
    +
    get the runtime configurable wrapper of the parent project + can return null +

    +

    + +
    Returns:
    runtime configurable wrapper of the parent project
    +
    +
    +
    + +

    +pushWrapper

    +
    +public void pushWrapper(RuntimeConfigurable wrapper)
    +
    +
    add a runtime configurable wrapper to the internal stack +

    +

    +
    Parameters:
    wrapper - runtime configurable wrapper
    +
    +
    +
    + +

    +popWrapper

    +
    +public void popWrapper()
    +
    +
    remove a runtime configurable wrapper from the stack +

    +

    +
    +
    +
    +
    + +

    +getWrapperStack

    +
    +public java.util.Vector getWrapperStack()
    +
    +
    access the stack of wrappers +

    +

    + +
    Returns:
    the stack of wrappers
    +
    +
    +
    + +

    +addTarget

    +
    +public void addTarget(Target target)
    +
    +
    add a new target +

    +

    +
    Parameters:
    target - target to add
    +
    +
    +
    + +

    +getCurrentTarget

    +
    +public Target getCurrentTarget()
    +
    +
    get the current target +

    +

    + +
    Returns:
    current target
    +
    +
    +
    + +

    +getImplicitTarget

    +
    +public Target getImplicitTarget()
    +
    +
    get the implicit target +

    +

    + +
    Returns:
    implicit target
    +
    +
    +
    + +

    +setCurrentTarget

    +
    +public void setCurrentTarget(Target target)
    +
    +
    sets the current target +

    +

    +
    Parameters:
    target - current target
    +
    +
    +
    + +

    +setImplicitTarget

    +
    +public void setImplicitTarget(Target target)
    +
    +
    sets the implicit target +

    +

    +
    Parameters:
    target - the implicit target
    +
    +
    +
    + +

    +getTargets

    +
    +public java.util.Vector getTargets()
    +
    +
    access the vector of targets +

    +

    + +
    Returns:
    vector of targets
    +
    +
    +
    + +

    +configureId

    +
    +public void configureId(java.lang.Object element,
+                        org.xml.sax.Attributes attr)
    +
    +
    Scans an attribute list for the id attribute and + stores a reference to the target object in the project if an + id is found. +

    + This method was moved out of the configure method to allow + it to be executed at parse time. +

    +

    +
    Parameters:
    element - the current element
    attr - attributes of the current element
    +
    +
    +
    + +

    +getLocator

    +
    +public org.xml.sax.Locator getLocator()
    +
    +
    access the locator +

    +

    + +
    Returns:
    locator
    +
    +
    +
    + +

    +setLocator

    +
    +public void setLocator(org.xml.sax.Locator locator)
    +
    +
    sets the locator +

    +

    +
    Parameters:
    locator - locator
    +
    +
    +
    + +

    +isIgnoringProjectTag

    +
    +public boolean isIgnoringProjectTag()
    +
    +
    tells whether the project tag is being ignored +

    +

    + +
    Returns:
    whether the project tag is being ignored
    +
    +
    +
    + +

    +setIgnoreProjectTag

    +
    +public void setIgnoreProjectTag(boolean flag)
    +
    +
    sets the flag to ignore the project tag +

    +

    +
    Parameters:
    flag - to ignore the project tag
    +
    +
    +
    + +

    +startPrefixMapping

    +
    +public void startPrefixMapping(java.lang.String prefix,
+                               java.lang.String uri)
    +
    +
    Called during parsing, stores the prefix to uri mapping. +

    +

    +
    Parameters:
    prefix - a namespace prefix
    uri - a namespace uri
    +
    +
    +
    + +

    +endPrefixMapping

    +
    +public void endPrefixMapping(java.lang.String prefix)
    +
    +
    End of prefix to uri mapping. +

    +

    +
    Parameters:
    prefix - the namespace prefix
    +
    +
    +
    + +

    +getPrefixMapping

    +
    +public java.lang.String getPrefixMapping(java.lang.String prefix)
    +
    +
    prefix to namespace uri mapping +

    +

    +
    Parameters:
    prefix - the prefix to map +
    Returns:
    the uri for this prefix, null if not present
    +
    +
    +
    + +

    +getCurrentTargets

    +
    +public java.util.Map getCurrentTargets()
    +
    +
    Get the targets in the current source file. +

    +

    + +
    Returns:
    the current targets.
    +
    +
    +
    + +

    +setCurrentTargets

    +
    +public void setCurrentTargets(java.util.Map currentTargets)
    +
    +
    Set the map of the targets in the current source file. +

    +

    +
    Parameters:
    currentTargets - a map of targets.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/DefaultExecutor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/DefaultExecutor.html new file mode 100644 index 000000000..860c14fb8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/DefaultExecutor.html @@ -0,0 +1,300 @@ + + + + + + +DefaultExecutor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class DefaultExecutor

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.DefaultExecutor
+
    +
    +
    All Implemented Interfaces:
    Executor
    +
    +
    +
    +
    public class DefaultExecutor
    extends java.lang.Object
    implements Executor
    + + +

    +Default Target executor implementation. Runs each target individually + (including all of its dependencies). If an error occurs, behavior is + determined by the Project's "keep-going" mode. +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DefaultExecutor() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecuteTargets(Project project, + java.lang.String[] targetNames) + +
    +          Execute the specified Targets for the specified Project..
    + ExecutorgetSubProjectExecutor() + +
    +          Get the appropriate subproject Executor instance..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultExecutor

    +
    +public DefaultExecutor()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +executeTargets

    +
    +public void executeTargets(Project project,
+                           java.lang.String[] targetNames)
+                    throws BuildException
    +
    +
    Execute the specified Targets for the specified Project.. +

    +

    +
    Specified by:
    executeTargets in interface Executor
    +
    +
    +
    Parameters:
    project - the Ant Project.
    targetNames - String[] of Target names as specified on the command line. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getSubProjectExecutor

    +
    +public Executor getSubProjectExecutor()
    +
    +
    Get the appropriate subproject Executor instance. + + This allows the top executor to control what type of executor is used to execute + subprojects via // and task that extend these. + All bundled Executors return a SingleCheckExecutor (running a merged set of + depended targets for all targets called) to run sub-builds.. +

    +

    +
    Specified by:
    getSubProjectExecutor in interface Executor
    +
    +
    + +
    Returns:
    an Executor instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/IgnoreDependenciesExecutor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/IgnoreDependenciesExecutor.html new file mode 100644 index 000000000..068b97769 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/IgnoreDependenciesExecutor.html @@ -0,0 +1,301 @@ + + + + + + +IgnoreDependenciesExecutor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class IgnoreDependenciesExecutor

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.IgnoreDependenciesExecutor
+
    +
    +
    All Implemented Interfaces:
    Executor
    +
    +
    +
    +
    public class IgnoreDependenciesExecutor
    extends java.lang.Object
    implements Executor
    + + +

    +Target executor implementation that ignores dependencies. Runs each + target by calling target.performTasks() directly. If an + error occurs, behavior is determined by the Project's "keep-going" mode. + To be used when you know what you're doing. +

    + +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    IgnoreDependenciesExecutor() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecuteTargets(Project project, + java.lang.String[] targetNames) + +
    +          Execute the specified Targets for the specified Project..
    + ExecutorgetSubProjectExecutor() + +
    +          Get the appropriate subproject Executor instance..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IgnoreDependenciesExecutor

    +
    +public IgnoreDependenciesExecutor()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +executeTargets

    +
    +public void executeTargets(Project project,
+                           java.lang.String[] targetNames)
+                    throws BuildException
    +
    +
    Execute the specified Targets for the specified Project.. +

    +

    +
    Specified by:
    executeTargets in interface Executor
    +
    +
    +
    Parameters:
    project - the Ant Project.
    targetNames - String[] of Target names as specified on the command line. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getSubProjectExecutor

    +
    +public Executor getSubProjectExecutor()
    +
    +
    Get the appropriate subproject Executor instance. + + This allows the top executor to control what type of executor is used to execute + subprojects via // and task that extend these. + All bundled Executors return a SingleCheckExecutor (running a merged set of + depended targets for all targets called) to run sub-builds.. +

    +

    +
    Specified by:
    getSubProjectExecutor in interface Executor
    +
    +
    + +
    Returns:
    an Executor instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.AntHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.AntHandler.html new file mode 100644 index 000000000..7cf04b70b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.AntHandler.html @@ -0,0 +1,429 @@ + + + + + + +ProjectHelper2.AntHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.AntHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.ProjectHelper2.AntHandler
+
    +
    +
    Direct Known Subclasses:
    ProjectHelper2.ElementHandler, ProjectHelper2.MainHandler, ProjectHelper2.ProjectHandler, ProjectHelper2.TargetHandler
    +
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.AntHandler
    extends java.lang.Object
    + + +

    +The common superclass for all SAX event handlers used to parse + the configuration file. + + The context will hold all state information. At each time + there is one active handler for the current element. It can + use onStartChild() to set an alternate handler for the child. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.AntHandler() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcharacters(char[] buf, + int start, + int count, + AntXMLContext context) + +
    +          Handles text within an element.
    +protected  voidcheckNamespace(java.lang.String uri) + +
    +          Will be called every time a namespace is reached.
    + voidonEndChild(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + AntXMLContext context) + +
    +          Handle the end of a element.
    + voidonEndElement(java.lang.String uri, + java.lang.String tag, + AntXMLContext context) + +
    +          This method is called when this element and all elements nested into it have been + handled.
    + ProjectHelper2.AntHandleronStartChild(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handles the start of an element.
    + voidonStartElement(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handles the start of an element.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.AntHandler

    +
    +public ProjectHelper2.AntHandler()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +onStartElement

    +
    +public void onStartElement(java.lang.String uri,
+                           java.lang.String tag,
+                           java.lang.String qname,
+                           org.xml.sax.Attributes attrs,
+                           AntXMLContext context)
+                    throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of an element. This base implementation does + nothing. +

    +

    +
    Parameters:
    uri - the namespace URI for the tag
    tag - The name of the element being started. + Will not be null.
    qname - The qualified name of the element.
    attrs - Attributes of the element being started. + Will not be null.
    context - The context that this element is in. +
    Throws: +
    org.xml.sax.SAXParseException - if this method is not overridden, or in + case of error in an overridden version
    +
    +
    +
    + +

    +onStartChild

    +
    +public ProjectHelper2.AntHandler onStartChild(java.lang.String uri,
+                                              java.lang.String tag,
+                                              java.lang.String qname,
+                                              org.xml.sax.Attributes attrs,
+                                              AntXMLContext context)
+                                       throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of an element. This base implementation just + throws an exception - you must override this method if you expect + child elements. +

    +

    +
    Parameters:
    uri - The namespace uri for this element.
    tag - The name of the element being started. + Will not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element being started. + Will not be null.
    context - The current context. +
    Returns:
    a handler (in the derived classes) +
    Throws: +
    org.xml.sax.SAXParseException - if this method is not overridden, or in + case of error in an overridden version
    +
    +
    +
    + +

    +onEndChild

    +
    +public void onEndChild(java.lang.String uri,
+                       java.lang.String tag,
+                       java.lang.String qname,
+                       AntXMLContext context)
+                throws org.xml.sax.SAXParseException
    +
    +
    Handle the end of a element. +

    +

    +
    Parameters:
    uri - the namespace uri of the element
    tag - the tag of the element
    qname - the qualified name of the element
    context - the current context +
    Throws: +
    org.xml.sax.SAXParseException - if an error occurs
    +
    +
    +
    + +

    +onEndElement

    +
    +public void onEndElement(java.lang.String uri,
+                         java.lang.String tag,
+                         AntXMLContext context)
    +
    +
    This method is called when this element and all elements nested into it have been + handled. I.e., this happens at the </end_tag_of_the_element>. +

    +

    +
    Parameters:
    uri - the namespace uri for this element
    tag - the element name
    context - the current context
    +
    +
    +
    + +

    +characters

    +
    +public void characters(char[] buf,
+                       int start,
+                       int count,
+                       AntXMLContext context)
+                throws org.xml.sax.SAXParseException
    +
    +
    Handles text within an element. This base implementation just + throws an exception, you must override it if you expect content. +

    +

    +
    Parameters:
    buf - A character array of the text within the element. + Will not be null.
    start - The start element in the array.
    count - The number of characters to read from the array.
    context - The current context. +
    Throws: +
    org.xml.sax.SAXParseException - if this method is not overridden, or in + case of error in an overridden version
    +
    +
    +
    + +

    +checkNamespace

    +
    +protected void checkNamespace(java.lang.String uri)
    +
    +
    Will be called every time a namespace is reached. + It'll verify if the ns was processed, and if not load the task definitions. +

    +

    +
    Parameters:
    uri - The namespace uri.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ElementHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ElementHandler.html new file mode 100644 index 000000000..c27fa9d99 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ElementHandler.html @@ -0,0 +1,394 @@ + + + + + + +ProjectHelper2.ElementHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.ElementHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.ProjectHelper2.AntHandler
+      extended by org.apache.tools.ant.helper.ProjectHelper2.ElementHandler
+
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.ElementHandler
    extends ProjectHelper2.AntHandler
    + + +

    +Handler for all project elements ( tasks, data types ) +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.ElementHandler() + +
    +          Constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcharacters(char[] buf, + int start, + int count, + AntXMLContext context) + +
    +          Adds text to the task, using the wrapper
    + voidonEndElement(java.lang.String uri, + java.lang.String tag, + AntXMLContext context) + +
    +          Handles the end of the element.
    + ProjectHelper2.AntHandleronStartChild(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handles the start of an element within a target.
    + voidonStartElement(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Initialisation routine called after handler creation + with the element name and attributes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.helper.ProjectHelper2.AntHandler
    checkNamespace, onEndChild
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.ElementHandler

    +
    +public ProjectHelper2.ElementHandler()
    +
    +
    Constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +onStartElement

    +
    +public void onStartElement(java.lang.String uri,
+                           java.lang.String tag,
+                           java.lang.String qname,
+                           org.xml.sax.Attributes attrs,
+                           AntXMLContext context)
+                    throws org.xml.sax.SAXParseException
    +
    +
    Initialisation routine called after handler creation + with the element name and attributes. This configures + the element with its attributes and sets it up with + its parent container (if any). Nested elements are then + added later as the parser encounters them. +

    +

    +
    Overrides:
    onStartElement in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    tag - Name of the element which caused this handler + to be created. Must not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element which caused this + handler to be created. Must not be null.
    context - The current context. +
    Throws: +
    org.xml.sax.SAXParseException - in case of error (not thrown in + this implementation)
    +
    +
    +
    + +

    +characters

    +
    +public void characters(char[] buf,
+                       int start,
+                       int count,
+                       AntXMLContext context)
+                throws org.xml.sax.SAXParseException
    +
    +
    Adds text to the task, using the wrapper +

    +

    +
    Overrides:
    characters in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    buf - A character array of the text within the element. + Will not be null.
    start - The start element in the array.
    count - The number of characters to read from the array.
    context - The current context. +
    Throws: +
    org.xml.sax.SAXParseException - if the element doesn't support text
    See Also:
    ProjectHelper.addText(Project,java.lang.Object,char[],int,int)
    +
    +
    +
    + +

    +onStartChild

    +
    +public ProjectHelper2.AntHandler onStartChild(java.lang.String uri,
+                                              java.lang.String tag,
+                                              java.lang.String qname,
+                                              org.xml.sax.Attributes attrs,
+                                              AntXMLContext context)
+                                       throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of an element within a target. Task containers + will always use another task handler, and all other tasks + will always use a nested element handler. +

    +

    +
    Overrides:
    onStartChild in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    tag - The name of the element being started. + Will not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element being started. + Will not be null.
    context - The current context. +
    Returns:
    The handler for elements. +
    Throws: +
    org.xml.sax.SAXParseException - if an error occurs when initialising + the appropriate child handler
    +
    +
    +
    + +

    +onEndElement

    +
    +public void onEndElement(java.lang.String uri,
+                         java.lang.String tag,
+                         AntXMLContext context)
    +
    +
    Handles the end of the element. This pops the wrapper from + the context. +

    +

    +
    Overrides:
    onEndElement in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for the element.
    tag - The name of the element.
    context - The current context.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.MainHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.MainHandler.html new file mode 100644 index 000000000..4e70dd30d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.MainHandler.html @@ -0,0 +1,283 @@ + + + + + + +ProjectHelper2.MainHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.MainHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.ProjectHelper2.AntHandler
+      extended by org.apache.tools.ant.helper.ProjectHelper2.MainHandler
+
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.MainHandler
    extends ProjectHelper2.AntHandler
    + + +

    +The main handler - it handles the <project> tag. +

    + +

    +

    +
    See Also:
    ProjectHelper2.AntHandler
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.MainHandler() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + ProjectHelper2.AntHandleronStartChild(java.lang.String uri, + java.lang.String name, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handle the project tag
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.helper.ProjectHelper2.AntHandler
    characters, checkNamespace, onEndChild, onEndElement, onStartElement
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.MainHandler

    +
    +public ProjectHelper2.MainHandler()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +onStartChild

    +
    +public ProjectHelper2.AntHandler onStartChild(java.lang.String uri,
+                                              java.lang.String name,
+                                              java.lang.String qname,
+                                              org.xml.sax.Attributes attrs,
+                                              AntXMLContext context)
+                                       throws org.xml.sax.SAXParseException
    +
    +
    Handle the project tag +

    +

    +
    Overrides:
    onStartChild in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace uri.
    name - The element tag.
    qname - The element qualified name.
    attrs - The attributes of the element.
    context - The current context. +
    Returns:
    The project handler that handles subelements of project +
    Throws: +
    org.xml.sax.SAXParseException - if the qualified name is not "project".
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ProjectHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ProjectHandler.html new file mode 100644 index 000000000..e91a16a88 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.ProjectHandler.html @@ -0,0 +1,333 @@ + + + + + + +ProjectHelper2.ProjectHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.ProjectHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.ProjectHelper2.AntHandler
+      extended by org.apache.tools.ant.helper.ProjectHelper2.ProjectHandler
+
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.ProjectHandler
    extends ProjectHelper2.AntHandler
    + + +

    +Handler for the top level "project" element. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.ProjectHandler() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + ProjectHelper2.AntHandleronStartChild(java.lang.String uri, + java.lang.String name, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handles the start of a top-level element within the project.
    + voidonStartElement(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Initialisation routine called after handler creation + with the element name and attributes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.helper.ProjectHelper2.AntHandler
    characters, checkNamespace, onEndChild, onEndElement
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.ProjectHandler

    +
    +public ProjectHelper2.ProjectHandler()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +onStartElement

    +
    +public void onStartElement(java.lang.String uri,
+                           java.lang.String tag,
+                           java.lang.String qname,
+                           org.xml.sax.Attributes attrs,
+                           AntXMLContext context)
+                    throws org.xml.sax.SAXParseException
    +
    +
    Initialisation routine called after handler creation + with the element name and attributes. The attributes which + this handler can deal with are: "default", + "name", "id" and "basedir". +

    +

    +
    Overrides:
    onStartElement in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    tag - Name of the element which caused this handler + to be created. Should not be null. + Ignored in this implementation.
    qname - The qualified name for this element.
    attrs - Attributes of the element which caused this + handler to be created. Must not be null.
    context - The current context. +
    Throws: +
    org.xml.sax.SAXParseException - if an unexpected attribute is + encountered or if the "default" attribute + is missing.
    +
    +
    +
    + +

    +onStartChild

    +
    +public ProjectHelper2.AntHandler onStartChild(java.lang.String uri,
+                                              java.lang.String name,
+                                              java.lang.String qname,
+                                              org.xml.sax.Attributes attrs,
+                                              AntXMLContext context)
+                                       throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of a top-level element within the project. An + appropriate handler is created and initialised with the details + of the element. +

    +

    +
    Overrides:
    onStartChild in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    name - The name of the element being started. + Will not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element being started. + Will not be null.
    context - The context for this element. +
    Returns:
    a target or an element handler. +
    Throws: +
    org.xml.sax.SAXParseException - if the tag given is not + "taskdef", "typedef", + "property", "target", + "extension-point" + or a data type definition
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.RootHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.RootHandler.html new file mode 100644 index 000000000..5c517c5e1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.RootHandler.html @@ -0,0 +1,484 @@ + + + + + + +ProjectHelper2.RootHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.RootHandler

    +
    +java.lang.Object
+  extended by org.xml.sax.helpers.DefaultHandler
+      extended by org.apache.tools.ant.helper.ProjectHelper2.RootHandler
+
    +
    +
    All Implemented Interfaces:
    org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
    +
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.RootHandler
    extends org.xml.sax.helpers.DefaultHandler
    + + +

    +Handler for ant processing. Uses a stack of AntHandlers to + implement each element ( the original parser used a recursive behavior, + with the implicit execution stack ) +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.RootHandler(AntXMLContext context, + ProjectHelper2.AntHandler rootHandler) + +
    +          Creates a new RootHandler instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcharacters(char[] buf, + int start, + int count) + +
    +          Handle text within an element, calls currentHandler.characters.
    + voidendElement(java.lang.String uri, + java.lang.String name, + java.lang.String qName) + +
    +          Handles the end of an element.
    + voidendPrefixMapping(java.lang.String prefix) + +
    +          End a namepace prefix to uri mapping
    + ProjectHelper2.AntHandlergetCurrentAntHandler() + +
    +          Returns the current ant handler object.
    + org.xml.sax.InputSourceresolveEntity(java.lang.String publicId, + java.lang.String systemId) + +
    +          Resolves file: URIs relative to the build file.
    + voidsetDocumentLocator(org.xml.sax.Locator locator) + +
    +          Sets the locator in the project helper for future reference.
    + voidstartElement(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs) + +
    +          Handles the start of a project element.
    + voidstartPrefixMapping(java.lang.String prefix, + java.lang.String uri) + +
    +          Start a namespace prefix to uri mapping
    +  + + + + + + + +
    Methods inherited from class org.xml.sax.helpers.DefaultHandler
    endDocument, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, startDocument, unparsedEntityDecl, warning
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.RootHandler

    +
    +public ProjectHelper2.RootHandler(AntXMLContext context,
+                                  ProjectHelper2.AntHandler rootHandler)
    +
    +
    Creates a new RootHandler instance. +

    +

    +
    Parameters:
    context - The context for the handler.
    rootHandler - The handler for the root element.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getCurrentAntHandler

    +
    +public ProjectHelper2.AntHandler getCurrentAntHandler()
    +
    +
    Returns the current ant handler object. +

    +

    + +
    Returns:
    the current ant handler.
    +
    +
    +
    + +

    +resolveEntity

    +
    +public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
+                                             java.lang.String systemId)
    +
    +
    Resolves file: URIs relative to the build file. +

    +

    +
    Specified by:
    resolveEntity in interface org.xml.sax.EntityResolver
    Overrides:
    resolveEntity in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    publicId - The public identifier, or null + if none is available. Ignored in this + implementation.
    systemId - The system identifier provided in the XML + document. Will not be null. +
    Returns:
    an inputsource for this identifier
    +
    +
    +
    + +

    +startElement

    +
    +public void startElement(java.lang.String uri,
+                         java.lang.String tag,
+                         java.lang.String qname,
+                         org.xml.sax.Attributes attrs)
+                  throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of a project element. A project handler is created + and initialised with the element name and attributes. +

    +

    +
    Specified by:
    startElement in interface org.xml.sax.ContentHandler
    Overrides:
    startElement in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    uri - The namespace uri for this element.
    tag - The name of the element being started. + Will not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element being started. + Will not be null. +
    Throws: +
    org.xml.sax.SAXParseException - if the tag given is not + "project"
    +
    +
    +
    + +

    +setDocumentLocator

    +
    +public void setDocumentLocator(org.xml.sax.Locator locator)
    +
    +
    Sets the locator in the project helper for future reference. +

    +

    +
    Specified by:
    setDocumentLocator in interface org.xml.sax.ContentHandler
    Overrides:
    setDocumentLocator in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    locator - The locator used by the parser. + Will not be null.
    +
    +
    +
    + +

    +endElement

    +
    +public void endElement(java.lang.String uri,
+                       java.lang.String name,
+                       java.lang.String qName)
+                throws org.xml.sax.SAXException
    +
    +
    Handles the end of an element. Any required clean-up is performed + by the onEndElement() method and then the original handler is restored to the parser. +

    +

    +
    Specified by:
    endElement in interface org.xml.sax.ContentHandler
    Overrides:
    endElement in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    name - The name of the element which is ending. + Will not be null.
    qName - The qualified name for this element. +
    Throws: +
    org.xml.sax.SAXException - in case of error (not thrown in this implementation)
    +
    +
    +
    + +

    +characters

    +
    +public void characters(char[] buf,
+                       int start,
+                       int count)
+                throws org.xml.sax.SAXParseException
    +
    +
    Handle text within an element, calls currentHandler.characters. +

    +

    +
    Specified by:
    characters in interface org.xml.sax.ContentHandler
    Overrides:
    characters in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    buf - A character array of the test.
    start - The start offset in the array.
    count - The number of characters to read. +
    Throws: +
    org.xml.sax.SAXParseException - if an error occurs
    +
    +
    +
    + +

    +startPrefixMapping

    +
    +public void startPrefixMapping(java.lang.String prefix,
+                               java.lang.String uri)
    +
    +
    Start a namespace prefix to uri mapping +

    +

    +
    Specified by:
    startPrefixMapping in interface org.xml.sax.ContentHandler
    Overrides:
    startPrefixMapping in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    prefix - the namespace prefix
    uri - the namespace uri
    +
    +
    +
    + +

    +endPrefixMapping

    +
    +public void endPrefixMapping(java.lang.String prefix)
    +
    +
    End a namepace prefix to uri mapping +

    +

    +
    Specified by:
    endPrefixMapping in interface org.xml.sax.ContentHandler
    Overrides:
    endPrefixMapping in class org.xml.sax.helpers.DefaultHandler
    +
    +
    +
    Parameters:
    prefix - the prefix that is not mapped anymore
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.TargetHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.TargetHandler.html new file mode 100644 index 000000000..945ac566e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.TargetHandler.html @@ -0,0 +1,359 @@ + + + + + + +ProjectHelper2.TargetHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2.TargetHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.ProjectHelper2.AntHandler
+      extended by org.apache.tools.ant.helper.ProjectHelper2.TargetHandler
+
    +
    +
    Enclosing class:
    ProjectHelper2
    +
    +
    +
    +
    public static class ProjectHelper2.TargetHandler
    extends ProjectHelper2.AntHandler
    + + +

    +Handler for "target" and "extension-point" elements. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2.TargetHandler() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidonEndElement(java.lang.String uri, + java.lang.String tag, + AntXMLContext context) + +
    +          Handle the end of the project, sets the current target of the + context to be the implicit target.
    + ProjectHelper2.AntHandleronStartChild(java.lang.String uri, + java.lang.String name, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Handles the start of an element within a target.
    + voidonStartElement(java.lang.String uri, + java.lang.String tag, + java.lang.String qname, + org.xml.sax.Attributes attrs, + AntXMLContext context) + +
    +          Initialisation routine called after handler creation + with the element name and attributes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.helper.ProjectHelper2.AntHandler
    characters, checkNamespace, onEndChild
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2.TargetHandler

    +
    +public ProjectHelper2.TargetHandler()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +onStartElement

    +
    +public void onStartElement(java.lang.String uri,
+                           java.lang.String tag,
+                           java.lang.String qname,
+                           org.xml.sax.Attributes attrs,
+                           AntXMLContext context)
+                    throws org.xml.sax.SAXParseException
    +
    +
    Initialisation routine called after handler creation + with the element name and attributes. The attributes which + this handler can deal with are: "name", + "depends", "if", + "unless", "id" and + "description". +

    +

    +
    Overrides:
    onStartElement in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    tag - Name of the element which caused this handler + to be created. Should not be null. + Ignored in this implementation.
    qname - The qualified name for this element.
    attrs - Attributes of the element which caused this + handler to be created. Must not be null.
    context - The current context. +
    Throws: +
    org.xml.sax.SAXParseException - if an unexpected attribute is encountered + or if the "name" attribute is missing.
    +
    +
    +
    + +

    +onStartChild

    +
    +public ProjectHelper2.AntHandler onStartChild(java.lang.String uri,
+                                              java.lang.String name,
+                                              java.lang.String qname,
+                                              org.xml.sax.Attributes attrs,
+                                              AntXMLContext context)
+                                       throws org.xml.sax.SAXParseException
    +
    +
    Handles the start of an element within a target. +

    +

    +
    Overrides:
    onStartChild in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI for this element.
    name - The name of the element being started. + Will not be null.
    qname - The qualified name for this element.
    attrs - Attributes of the element being started. + Will not be null.
    context - The current context. +
    Returns:
    an element handler. +
    Throws: +
    org.xml.sax.SAXParseException - if an error occurs when initialising + the appropriate child handler
    +
    +
    +
    + +

    +onEndElement

    +
    +public void onEndElement(java.lang.String uri,
+                         java.lang.String tag,
+                         AntXMLContext context)
    +
    +
    Handle the end of the project, sets the current target of the + context to be the implicit target. +

    +

    +
    Overrides:
    onEndElement in class ProjectHelper2.AntHandler
    +
    +
    +
    Parameters:
    uri - The namespace URI of the element.
    tag - The name of the element.
    context - The current context.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.html new file mode 100644 index 000000000..188b579bc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelper2.html @@ -0,0 +1,679 @@ + + + + + + +ProjectHelper2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelper2

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectHelper
+      extended by org.apache.tools.ant.helper.ProjectHelper2
+
    +
    +
    +
    public class ProjectHelper2
    extends ProjectHelper
    + + +

    +Sax2 based project reader +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classProjectHelper2.AntHandler + +
    +          The common superclass for all SAX event handlers used to parse + the configuration file.
    +static classProjectHelper2.ElementHandler + +
    +          Handler for all project elements ( tasks, data types )
    +static classProjectHelper2.MainHandler + +
    +          The main handler - it handles the <project> tag.
    +static classProjectHelper2.ProjectHandler + +
    +          Handler for the top level "project" element.
    +static classProjectHelper2.RootHandler + +
    +          Handler for ant processing.
    +static classProjectHelper2.TargetHandler + +
    +          Handler for "target" and "extension-point" elements.
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.ProjectHelper
    ProjectHelper.OnMissingExtensionPoint
    +  + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringREFID_TARGETS + +
    +          Reference holding the (ordered) target Vector
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectHelper
    ANT_CORE_URI, ANT_CURRENT_URI, ANT_TYPE, ANTLIB_URI, HELPER_PROPERTY, PROJECTHELPER_REFERENCE, SERVICE_ID
    +  + + + + + + + + + + +
    +Constructor Summary
    ProjectHelper2() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleancanParseAntlibDescriptor(Resource resource) + +
    +          Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task.
    +protected static ProjectHelper2.AntHandlergetElementHandler() + +
    +          Returns element handler
    +protected static ProjectHelper2.AntHandlergetMainHandler() + +
    +          Returns main handler
    +protected static ProjectHelper2.AntHandlergetProjectHandler() + +
    +          Returns project handler
    +protected static ProjectHelper2.AntHandlergetTargetHandler() + +
    +          Returns target handler
    + voidparse(Project project, + java.lang.Object source) + +
    +          Parse a source xml input.
    + voidparse(Project project, + java.lang.Object source, + ProjectHelper2.RootHandler handler) + +
    +          Parses the project file, configuring the project as it goes.
    + UnknownElementparseAntlibDescriptor(Project containingProject, + Resource resource) + +
    +          Parse the given URL as an antlib descriptor an return the + content as something that can be turned into an Antlib task.
    + UnknownElementparseUnknownElement(Project project, + java.net.URL source) + +
    +          Parse an unknown element from a url
    +protected static voidsetElementHandler(ProjectHelper2.AntHandler handler) + +
    +          Sets element handler
    +protected static voidsetMainHandler(ProjectHelper2.AntHandler handler) + +
    +          Sets main handler
    +protected static voidsetProjectHandler(ProjectHelper2.AntHandler handler) + +
    +          Sets project handler
    +protected static voidsetTargetHandler(ProjectHelper2.AntHandler handler) + +
    +          Sets target handler
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectHelper
    addLocationToBuildException, addText, addText, canParseBuildFile, configure, configureProject, extractNameFromComponentName, extractUriFromComponentName, genComponentName, getContextClassLoader, getCurrentPrefixSeparator, getCurrentTargetPrefix, getDefaultBuildFile, getExtensionStack, getImportStack, getProjectHelper, isInIncludeMode, parsePropertyString, replaceProperties, replaceProperties, setCurrentPrefixSeparator, setCurrentTargetPrefix, setInIncludeMode, storeChild
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +REFID_TARGETS

    +
    +public static final java.lang.String REFID_TARGETS
    +
    +
    Reference holding the (ordered) target Vector +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelper2

    +
    +public ProjectHelper2()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +canParseAntlibDescriptor

    +
    +public boolean canParseAntlibDescriptor(Resource resource)
    +
    +
    Whether this instance of ProjectHelper can parse an Antlib + descriptor given by the URL and return its content as an + UnknownElement ready to be turned into an Antlib task. + +

    This implementation returns true.

    +

    +

    +
    Overrides:
    canParseAntlibDescriptor in class ProjectHelper
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +parseAntlibDescriptor

    +
    +public UnknownElement parseAntlibDescriptor(Project containingProject,
+                                            Resource resource)
    +
    +
    Parse the given URL as an antlib descriptor an return the + content as something that can be turned into an Antlib task. + +

    simply delegates to parseUnknownElement if the resource provides an URL and throws + an exceptipn otherwise.

    +

    +

    +
    Overrides:
    parseAntlibDescriptor in class ProjectHelper
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +parseUnknownElement

    +
    +public UnknownElement parseUnknownElement(Project project,
+                                          java.net.URL source)
+                                   throws BuildException
    +
    +
    Parse an unknown element from a url +

    +

    +
    Parameters:
    project - the current project
    source - the url containing the task +
    Returns:
    a configured task +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +parse

    +
    +public void parse(Project project,
+                  java.lang.Object source)
+           throws BuildException
    +
    +
    Parse a source xml input. +

    +

    +
    Overrides:
    parse in class ProjectHelper
    +
    +
    +
    Parameters:
    project - the current project
    source - the xml source +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +parse

    +
    +public void parse(Project project,
+                  java.lang.Object source,
+                  ProjectHelper2.RootHandler handler)
+           throws BuildException
    +
    +
    Parses the project file, configuring the project as it goes. +

    +

    +
    Parameters:
    project - the current project
    source - the xml source
    handler - the root handler to use (contains the current context) +
    Throws: +
    BuildException - if the configuration is invalid or cannot + be read
    +
    +
    +
    + +

    +getMainHandler

    +
    +protected static ProjectHelper2.AntHandler getMainHandler()
    +
    +
    Returns main handler +

    +

    + +
    Returns:
    main handler
    +
    +
    +
    + +

    +setMainHandler

    +
    +protected static void setMainHandler(ProjectHelper2.AntHandler handler)
    +
    +
    Sets main handler +

    +

    +
    Parameters:
    handler - new main handler
    +
    +
    +
    + +

    +getProjectHandler

    +
    +protected static ProjectHelper2.AntHandler getProjectHandler()
    +
    +
    Returns project handler +

    +

    + +
    Returns:
    project handler
    +
    +
    +
    + +

    +setProjectHandler

    +
    +protected static void setProjectHandler(ProjectHelper2.AntHandler handler)
    +
    +
    Sets project handler +

    +

    +
    Parameters:
    handler - new project handler
    +
    +
    +
    + +

    +getTargetHandler

    +
    +protected static ProjectHelper2.AntHandler getTargetHandler()
    +
    +
    Returns target handler +

    +

    + +
    Returns:
    target handler
    +
    +
    +
    + +

    +setTargetHandler

    +
    +protected static void setTargetHandler(ProjectHelper2.AntHandler handler)
    +
    +
    Sets target handler +

    +

    +
    Parameters:
    handler - new target handler
    +
    +
    +
    + +

    +getElementHandler

    +
    +protected static ProjectHelper2.AntHandler getElementHandler()
    +
    +
    Returns element handler +

    +

    + +
    Returns:
    element handler
    +
    +
    +
    + +

    +setElementHandler

    +
    +protected static void setElementHandler(ProjectHelper2.AntHandler handler)
    +
    +
    Sets element handler +

    +

    +
    Parameters:
    handler - new element handler
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelperImpl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelperImpl.html new file mode 100644 index 000000000..780e3ddba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/ProjectHelperImpl.html @@ -0,0 +1,311 @@ + + + + + + +ProjectHelperImpl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class ProjectHelperImpl

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectHelper
+      extended by org.apache.tools.ant.helper.ProjectHelperImpl
+
    +
    +
    +
    public class ProjectHelperImpl
    extends ProjectHelper
    + + +

    +Original helper. +

    + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.ProjectHelper
    ProjectHelper.OnMissingExtensionPoint
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectHelper
    ANT_CORE_URI, ANT_CURRENT_URI, ANT_TYPE, ANTLIB_URI, HELPER_PROPERTY, PROJECTHELPER_REFERENCE, SERVICE_ID
    +  + + + + + + + + + + +
    +Constructor Summary
    ProjectHelperImpl() + +
    +          default constructor
    +  + + + + + + + + + + + +
    +Method Summary
    + voidparse(Project project, + java.lang.Object source) + +
    +          Parses the project file, configuring the project as it goes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectHelper
    addLocationToBuildException, addText, addText, canParseAntlibDescriptor, canParseBuildFile, configure, configureProject, extractNameFromComponentName, extractUriFromComponentName, genComponentName, getContextClassLoader, getCurrentPrefixSeparator, getCurrentTargetPrefix, getDefaultBuildFile, getExtensionStack, getImportStack, getProjectHelper, isInIncludeMode, parseAntlibDescriptor, parsePropertyString, replaceProperties, replaceProperties, setCurrentPrefixSeparator, setCurrentTargetPrefix, setInIncludeMode, storeChild
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelperImpl

    +
    +public ProjectHelperImpl()
    +
    +
    default constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +parse

    +
    +public void parse(Project project,
+                  java.lang.Object source)
+           throws BuildException
    +
    +
    Parses the project file, configuring the project as it goes. +

    +

    +
    Overrides:
    parse in class ProjectHelper
    +
    +
    +
    Parameters:
    project - project instance to be configured.
    source - the source from which the project is read. +
    Throws: +
    BuildException - if the configuration is invalid or cannot + be read.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/SingleCheckExecutor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/SingleCheckExecutor.html new file mode 100644 index 000000000..737452fa3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/SingleCheckExecutor.html @@ -0,0 +1,300 @@ + + + + + + +SingleCheckExecutor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.helper +
    +Class SingleCheckExecutor

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.helper.SingleCheckExecutor
+
    +
    +
    All Implemented Interfaces:
    Executor
    +
    +
    +
    +
    public class SingleCheckExecutor
    extends java.lang.Object
    implements Executor
    + + +

    +"Single-check" Target executor implementation. + Differs from DefaultExecutor in that the dependencies for all + targets are computed together, so that shared dependencies are run just once. +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    SingleCheckExecutor() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecuteTargets(Project project, + java.lang.String[] targetNames) + +
    +          Execute the specified Targets for the specified Project..
    + ExecutorgetSubProjectExecutor() + +
    +          Get the appropriate subproject Executor instance..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SingleCheckExecutor

    +
    +public SingleCheckExecutor()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +executeTargets

    +
    +public void executeTargets(Project project,
+                           java.lang.String[] targetNames)
+                    throws BuildException
    +
    +
    Execute the specified Targets for the specified Project.. +

    +

    +
    Specified by:
    executeTargets in interface Executor
    +
    +
    +
    Parameters:
    project - the Ant Project.
    targetNames - String[] of Target names as specified on the command line. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getSubProjectExecutor

    +
    +public Executor getSubProjectExecutor()
    +
    +
    Get the appropriate subproject Executor instance. + + This allows the top executor to control what type of executor is used to execute + subprojects via // and task that extend these. + All bundled Executors return a SingleCheckExecutor (running a merged set of + depended targets for all targets called) to run sub-builds.. +

    +

    +
    Specified by:
    getSubProjectExecutor in interface Executor
    +
    +
    + +
    Returns:
    an Executor instance.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-frame.html new file mode 100644 index 000000000..7577d57d6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-frame.html @@ -0,0 +1,54 @@ + + + + + + +org.apache.tools.ant.helper (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.helper + + + + +
    +Classes  + +
    +AntXMLContext +
    +DefaultExecutor +
    +IgnoreDependenciesExecutor +
    +ProjectHelper2 +
    +ProjectHelper2.AntHandler +
    +ProjectHelper2.ElementHandler +
    +ProjectHelper2.MainHandler +
    +ProjectHelper2.ProjectHandler +
    +ProjectHelper2.RootHandler +
    +ProjectHelper2.TargetHandler +
    +ProjectHelperImpl +
    +SingleCheckExecutor
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-summary.html new file mode 100644 index 000000000..6b28738d8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-summary.html @@ -0,0 +1,197 @@ + + + + + + +org.apache.tools.ant.helper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.helper +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    AntXMLContextContext information for the ant processing.
    DefaultExecutorDefault Target executor implementation.
    IgnoreDependenciesExecutorTarget executor implementation that ignores dependencies.
    ProjectHelper2Sax2 based project reader
    ProjectHelper2.AntHandlerThe common superclass for all SAX event handlers used to parse + the configuration file.
    ProjectHelper2.ElementHandlerHandler for all project elements ( tasks, data types )
    ProjectHelper2.MainHandlerThe main handler - it handles the <project> tag.
    ProjectHelper2.ProjectHandlerHandler for the top level "project" element.
    ProjectHelper2.RootHandlerHandler for ant processing.
    ProjectHelper2.TargetHandlerHandler for "target" and "extension-point" elements.
    ProjectHelperImplOriginal helper.
    SingleCheckExecutor"Single-check" Target executor implementation.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-tree.html new file mode 100644 index 000000000..d767ce290 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/helper/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.helper Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.helper +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/DefaultInputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/DefaultInputHandler.html new file mode 100644 index 000000000..91b5cdcd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/DefaultInputHandler.html @@ -0,0 +1,326 @@ + + + + + + +DefaultInputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class DefaultInputHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.DefaultInputHandler
+
    +
    +
    All Implemented Interfaces:
    InputHandler
    +
    +
    +
    Direct Known Subclasses:
    GreedyInputHandler, SecureInputHandler
    +
    +
    +
    +
    public class DefaultInputHandler
    extends java.lang.Object
    implements InputHandler
    + + +

    +Prompts on System.err, reads input from System.in +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    DefaultInputHandler() + +
    +          Empty no-arg constructor
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  java.io.InputStreamgetInputStream() + +
    +          Returns the input stream from which the user input should be read.
    +protected  java.lang.StringgetPrompt(InputRequest request) + +
    +          Constructs user prompt from a request.
    + voidhandleInput(InputRequest request) + +
    +          Prompts and requests input.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultInputHandler

    +
    +public DefaultInputHandler()
    +
    +
    Empty no-arg constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +handleInput

    +
    +public void handleInput(InputRequest request)
+                 throws BuildException
    +
    +
    Prompts and requests input. May loop until a valid input has + been entered. +

    +

    +
    Specified by:
    handleInput in interface InputHandler
    +
    +
    +
    Parameters:
    request - the request to handle +
    Throws: +
    BuildException - if not possible to read from console
    +
    +
    +
    + +

    +getPrompt

    +
    +protected java.lang.String getPrompt(InputRequest request)
    +
    +
    Constructs user prompt from a request. + +

    This implementation adds (choice1,choice2,choice3,...) to the + prompt for MultipleChoiceInputRequests.

    +

    +

    +
    +
    +
    +
    Parameters:
    request - the request to construct the prompt for. + Must not be null. +
    Returns:
    the prompt to ask the user
    +
    +
    +
    + +

    +getInputStream

    +
    +protected java.io.InputStream getInputStream()
    +
    +
    Returns the input stream from which the user input should be read. +

    +

    +
    +
    +
    + +
    Returns:
    the input stream from which the user input should be read.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/GreedyInputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/GreedyInputHandler.html new file mode 100644 index 000000000..5eab589c3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/GreedyInputHandler.html @@ -0,0 +1,279 @@ + + + + + + +GreedyInputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class GreedyInputHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.DefaultInputHandler
+      extended by org.apache.tools.ant.input.GreedyInputHandler
+
    +
    +
    All Implemented Interfaces:
    InputHandler
    +
    +
    +
    +
    public class GreedyInputHandler
    extends DefaultInputHandler
    + + +

    +Prompts on System.err, reads input from System.in until EOF +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    GreedyInputHandler() + +
    +          Empty no-arg constructor
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandleInput(InputRequest request) + +
    +          Prompts and requests input.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.input.DefaultInputHandler
    getInputStream, getPrompt
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +GreedyInputHandler

    +
    +public GreedyInputHandler()
    +
    +
    Empty no-arg constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +handleInput

    +
    +public void handleInput(InputRequest request)
+                 throws BuildException
    +
    +
    Prompts and requests input. +

    +

    +
    Specified by:
    handleInput in interface InputHandler
    Overrides:
    handleInput in class DefaultInputHandler
    +
    +
    +
    Parameters:
    request - the request to handle +
    Throws: +
    BuildException - if not possible to read from console, + or if input is invalid.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputHandler.html new file mode 100644 index 000000000..0a09fc359 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputHandler.html @@ -0,0 +1,223 @@ + + + + + + +InputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Interface InputHandler

    +
    +
    All Known Implementing Classes:
    DefaultInputHandler, GreedyInputHandler, PropertyFileInputHandler, SecureInputHandler
    +
    +
    +
    +
    public interface InputHandler
    + + +

    +Plugin to Ant to handle requests for user input. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidhandleInput(InputRequest request) + +
    +          Handle the request encapsulated in the argument.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +handleInput

    +
    +void handleInput(InputRequest request)
+                 throws BuildException
    +
    +
    Handle the request encapsulated in the argument. + +

    Precondition: the request.getPrompt will return a non-null + value.

    + +

    Postcondition: request.getInput will return a non-null + value, request.isInputValid will return true.

    +

    +

    +
    Parameters:
    request - the request to be processed +
    Throws: +
    BuildException - if the input cannot be read from the console
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputRequest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputRequest.html new file mode 100644 index 000000000..a86d816b6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/InputRequest.html @@ -0,0 +1,377 @@ + + + + + + +InputRequest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class InputRequest

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.InputRequest
+
    +
    +
    Direct Known Subclasses:
    MultipleChoiceInputRequest
    +
    +
    +
    +
    public class InputRequest
    extends java.lang.Object
    + + +

    +Encapsulates an input request. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    InputRequest(java.lang.String prompt) + +
    +          Construct an InputRequest.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetDefaultValue() + +
    +          Gets a configured default value.
    + java.lang.StringgetInput() + +
    +          Retrieves the user input.
    + java.lang.StringgetPrompt() + +
    +          Retrieves the prompt text.
    + booleanisInputValid() + +
    +          Is the user input valid?
    + voidsetDefaultValue(java.lang.String d) + +
    +          Configures a default value.
    + voidsetInput(java.lang.String input) + +
    +          Sets the user provided input.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +InputRequest

    +
    +public InputRequest(java.lang.String prompt)
    +
    +
    Construct an InputRequest. +

    +

    +
    Parameters:
    prompt - The prompt to show to the user. Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getPrompt

    +
    +public java.lang.String getPrompt()
    +
    +
    Retrieves the prompt text. +

    +

    + +
    Returns:
    the prompt.
    +
    +
    +
    + +

    +setInput

    +
    +public void setInput(java.lang.String input)
    +
    +
    Sets the user provided input. +

    +

    +
    Parameters:
    input - the string to be used for input.
    +
    +
    +
    + +

    +isInputValid

    +
    +public boolean isInputValid()
    +
    +
    Is the user input valid? +

    +

    + +
    Returns:
    true if it is.
    +
    +
    +
    + +

    +getInput

    +
    +public java.lang.String getInput()
    +
    +
    Retrieves the user input. +

    +

    + +
    Returns:
    the user input.
    +
    +
    +
    + +

    +getDefaultValue

    +
    +public java.lang.String getDefaultValue()
    +
    +
    Gets a configured default value. +

    +

    + +
    Returns:
    the default value.
    Since:
    +
    Ant 1.7.0
    +
    +
    +
    +
    + +

    +setDefaultValue

    +
    +public void setDefaultValue(java.lang.String d)
    +
    +
    Configures a default value. +

    +

    +
    Parameters:
    d - the value to set.
    Since:
    +
    Ant 1.7.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/MultipleChoiceInputRequest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/MultipleChoiceInputRequest.html new file mode 100644 index 000000000..c091b7d1a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/MultipleChoiceInputRequest.html @@ -0,0 +1,297 @@ + + + + + + +MultipleChoiceInputRequest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class MultipleChoiceInputRequest

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.InputRequest
+      extended by org.apache.tools.ant.input.MultipleChoiceInputRequest
+
    +
    +
    +
    public class MultipleChoiceInputRequest
    extends InputRequest
    + + +

    +Encapsulates an input request. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MultipleChoiceInputRequest(java.lang.String prompt, + java.util.Vector choices) + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.util.VectorgetChoices() + +
    +           
    + booleanisInputValid() + +
    +          Is the user input valid?
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.input.InputRequest
    getDefaultValue, getInput, getPrompt, setDefaultValue, setInput
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MultipleChoiceInputRequest

    +
    +public MultipleChoiceInputRequest(java.lang.String prompt,
+                                  java.util.Vector choices)
    +
    +
    +
    Parameters:
    prompt - The prompt to show to the user. Must not be null.
    choices - holds all input values that are allowed. + Must not be null.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getChoices

    +
    +public java.util.Vector getChoices()
    +
    +
    + +
    Returns:
    The possible values.
    +
    +
    +
    + +

    +isInputValid

    +
    +public boolean isInputValid()
    +
    +
    Description copied from class: InputRequest
    +
    Is the user input valid? +

    +

    +
    Overrides:
    isInputValid in class InputRequest
    +
    +
    + +
    Returns:
    true if the input is one of the allowed values.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/PropertyFileInputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/PropertyFileInputHandler.html new file mode 100644 index 000000000..c3202c1b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/PropertyFileInputHandler.html @@ -0,0 +1,309 @@ + + + + + + +PropertyFileInputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class PropertyFileInputHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.PropertyFileInputHandler
+
    +
    +
    All Implemented Interfaces:
    InputHandler
    +
    +
    +
    +
    public class PropertyFileInputHandler
    extends java.lang.Object
    implements InputHandler
    + + +

    +Reads input from a property file, the file name is read from the + system property ant.input.properties, the prompt is the key for input. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFILE_NAME_KEY + +
    +          Name of the system property we expect to hold the file name.
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyFileInputHandler() + +
    +          Empty no-arg constructor.
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandleInput(InputRequest request) + +
    +          Picks up the input from a property, using the prompt as the + name of the property.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FILE_NAME_KEY

    +
    +public static final java.lang.String FILE_NAME_KEY
    +
    +
    Name of the system property we expect to hold the file name. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyFileInputHandler

    +
    +public PropertyFileInputHandler()
    +
    +
    Empty no-arg constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +handleInput

    +
    +public void handleInput(InputRequest request)
+                 throws BuildException
    +
    +
    Picks up the input from a property, using the prompt as the + name of the property. +

    +

    +
    Specified by:
    handleInput in interface InputHandler
    +
    +
    +
    Parameters:
    request - an input request. +
    Throws: +
    BuildException - if no property of that name can be found.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/SecureInputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/SecureInputHandler.html new file mode 100644 index 000000000..1fe7da1f7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/SecureInputHandler.html @@ -0,0 +1,280 @@ + + + + + + +SecureInputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.input +
    +Class SecureInputHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.input.DefaultInputHandler
+      extended by org.apache.tools.ant.input.SecureInputHandler
+
    +
    +
    All Implemented Interfaces:
    InputHandler
    +
    +
    +
    +
    public class SecureInputHandler
    extends DefaultInputHandler
    + + +

    +Prompts and requests input. May loop until a valid input has + been entered. Doesn't echo input (requires Java6). If Java6 is not + available, falls back to the DefaultHandler (insecure). +

    + +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    SecureInputHandler() + +
    +          Default no-args constructor
    +  + + + + + + + + + + + +
    +Method Summary
    + voidhandleInput(InputRequest request) + +
    +          Handle the input
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.input.DefaultInputHandler
    getInputStream, getPrompt
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SecureInputHandler

    +
    +public SecureInputHandler()
    +
    +
    Default no-args constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +handleInput

    +
    +public void handleInput(InputRequest request)
+                 throws BuildException
    +
    +
    Handle the input +

    +

    +
    Specified by:
    handleInput in interface InputHandler
    Overrides:
    handleInput in class DefaultInputHandler
    +
    +
    +
    Parameters:
    request - the request to handle +
    Throws: +
    BuildException - if not possible to read from console
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-frame.html new file mode 100644 index 000000000..ff2a58b85 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-frame.html @@ -0,0 +1,53 @@ + + + + + + +org.apache.tools.ant.input (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.input + + + + +
    +Interfaces  + +
    +InputHandler
    + + + + + + +
    +Classes  + +
    +DefaultInputHandler +
    +GreedyInputHandler +
    +InputRequest +
    +MultipleChoiceInputRequest +
    +PropertyFileInputHandler +
    +SecureInputHandler
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-summary.html new file mode 100644 index 000000000..6e2be3ad2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +org.apache.tools.ant.input (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.input +

    + + + + + + + + + +
    +Interface Summary
    InputHandlerPlugin to Ant to handle requests for user input.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    DefaultInputHandlerPrompts on System.err, reads input from System.in
    GreedyInputHandlerPrompts on System.err, reads input from System.in until EOF
    InputRequestEncapsulates an input request.
    MultipleChoiceInputRequestEncapsulates an input request.
    PropertyFileInputHandlerReads input from a property file, the file name is read from the + system property ant.input.properties, the prompt is the key for input.
    SecureInputHandlerPrompts and requests input.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-tree.html new file mode 100644 index 000000000..6b39af930 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/input/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +org.apache.tools.ant.input Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.input +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/AntMain.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/AntMain.html new file mode 100644 index 000000000..20560dc42 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/AntMain.html @@ -0,0 +1,222 @@ + + + + + + +AntMain (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.launch +
    +Interface AntMain

    +
    +
    All Known Implementing Classes:
    Main
    +
    +
    +
    +
    public interface AntMain
    + + +

    +Interface used to bridge to the actual Main class without any + messy reflection +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidstartAnt(java.lang.String[] args, + java.util.Properties additionalUserProperties, + java.lang.ClassLoader coreLoader) + +
    +          Start Ant.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +startAnt

    +
    +void startAnt(java.lang.String[] args,
+              java.util.Properties additionalUserProperties,
+              java.lang.ClassLoader coreLoader)
    +
    +
    Start Ant. +

    +

    +
    Parameters:
    args - command line args
    additionalUserProperties - properties to set beyond those that + may be specified on the args list
    coreLoader - - not used
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/LaunchException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/LaunchException.html new file mode 100644 index 000000000..01532785a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/LaunchException.html @@ -0,0 +1,246 @@ + + + + + + +LaunchException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.launch +
    +Class LaunchException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.apache.tools.ant.launch.LaunchException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class LaunchException
    extends java.lang.Exception
    + + +

    +Signals an error condition during launching +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LaunchException(java.lang.String message) + +
    +          Constructs an exception with the given descriptive message.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LaunchException

    +
    +public LaunchException(java.lang.String message)
    +
    +
    Constructs an exception with the given descriptive message. +

    +

    +
    Parameters:
    message - A description of or information about the exception. + Should not be null.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Launcher.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Launcher.html new file mode 100644 index 000000000..940ff20d2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Launcher.html @@ -0,0 +1,465 @@ + + + + + + +Launcher (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.launch +
    +Class Launcher

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.launch.Launcher
+
    +
    +
    +
    public class Launcher
    extends java.lang.Object
    + + +

    +This is a launcher for Ant. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringANT_PRIVATEDIR + +
    +          The directory name of the per-user ant directory.
    +static java.lang.StringANT_PRIVATELIB + +
    +          The name of a per-user library directory.
    +static java.lang.StringANTHOME_PROPERTY + +
    +          The Ant Home (installation) Directory property.
    +static java.lang.StringANTLIBDIR_PROPERTY + +
    +          The Ant Library Directory property.
    +protected static intEXIT_CODE_ERROR + +
    +          Exit code on trouble
    +static booleanlaunchDiag + +
    +          launch diagnostics flag; for debugging trouble at launch time.
    +static java.lang.StringMAIN_CLASS + +
    +          The startup class that is to be run.
    +static java.lang.StringUSER_HOMEDIR + +
    +          System property with user home directory.
    +static java.lang.StringUSER_LIBDIR + +
    +          The location of a per-user library directory.
    +  + + + + + + + + + + +
    +Constructor Summary
    Launcher() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +static voidmain(java.lang.String[] args) + +
    +          Entry point for starting command line Ant.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ANTHOME_PROPERTY

    +
    +public static final java.lang.String ANTHOME_PROPERTY
    +
    +
    The Ant Home (installation) Directory property. + "ant.home" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANTLIBDIR_PROPERTY

    +
    +public static final java.lang.String ANTLIBDIR_PROPERTY
    +
    +
    The Ant Library Directory property. + "ant.library.dir" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_PRIVATEDIR

    +
    +public static final java.lang.String ANT_PRIVATEDIR
    +
    +
    The directory name of the per-user ant directory. + ".ant" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ANT_PRIVATELIB

    +
    +public static final java.lang.String ANT_PRIVATELIB
    +
    +
    The name of a per-user library directory. + "lib" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +launchDiag

    +
    +public static boolean launchDiag
    +
    +
    launch diagnostics flag; for debugging trouble at launch time. +

    +

    +
    +
    +
    + +

    +USER_LIBDIR

    +
    +public static final java.lang.String USER_LIBDIR
    +
    +
    The location of a per-user library directory. +

    + It's value is the concatenation of ANT_PRIVATEDIR + with ANT_PRIVATELIB, with an appropriate file separator + in between. For example, on Unix, it's .ant/lib. +

    +

    +
    +
    +
    + +

    +MAIN_CLASS

    +
    +public static final java.lang.String MAIN_CLASS
    +
    +
    The startup class that is to be run. + "org.apache.tools.ant.Main" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +USER_HOMEDIR

    +
    +public static final java.lang.String USER_HOMEDIR
    +
    +
    System property with user home directory. + "user.home" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +EXIT_CODE_ERROR

    +
    +protected static final int EXIT_CODE_ERROR
    +
    +
    Exit code on trouble +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Launcher

    +
    +public Launcher()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    Entry point for starting command line Ant. +

    +

    +
    Parameters:
    args - commandline arguments
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Locator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Locator.html new file mode 100644 index 000000000..60f0c6d71 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/Locator.html @@ -0,0 +1,561 @@ + + + + + + +Locator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.launch +
    +Class Locator

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.launch.Locator
+
    +
    +
    +
    public final class Locator
    extends java.lang.Object
    + + +

    +The Locator is a utility class which is used to find certain items + in the environment. + + It is used at boot time in the launcher, and cannot make use of any of Ant's other classes. + + This is a surprisingly brittle piece of code, and has had lots of bugs filed against it. + running ant off a network share can cause Ant to fail + use File.toURI().toURL().toExternalForm() + Locator implementation not encoding URI strings properly: spaces in paths + It also breaks Eclipse 3.3 Betas + Exception if installation path has spaces + + Be very careful when making changes to this class, as a break will upset a lot of people. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_NOT_FILE_URI + +
    +          Error string used when an invalid uri is seen
    +static java.lang.StringURI_ENCODING + +
    +          encoding used to represent URIs
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static java.lang.StringdecodeUri(java.lang.String uri) + +
    +          Decodes an Uri with % characters.
    +static java.lang.StringencodeURI(java.lang.String path) + +
    +          Encodes an Uri with % characters.
    +static java.net.URLfileToURL(java.io.File file) + +
    +          Convert a File to a URL.
    +static java.lang.StringfromJarURI(java.lang.String uri) + +
    +          Crack a JAR URI.
    +static java.lang.StringfromURI(java.lang.String uri) + +
    +          Constructs a file path from a file: URI.
    +static java.io.FilegetClassSource(java.lang.Class c) + +
    +          Find the directory or jar file the class has been loaded from.
    +static java.net.URL[]getLocationURLs(java.io.File location) + +
    +          Get an array of URLs representing all of the jar files in the + given location.
    +static java.net.URL[]getLocationURLs(java.io.File location, + java.lang.String[] extensions) + +
    +          Get an array of URLs representing all of the files of a given set of + extensions in the given location.
    +static java.io.FilegetResourceSource(java.lang.ClassLoader c, + java.lang.String resource) + +
    +          Find the directory or jar a given resource has been loaded from.
    +static java.io.FilegetToolsJar() + +
    +          Get the File necessary to load the Sun compiler tools.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +URI_ENCODING

    +
    +public static final java.lang.String URI_ENCODING
    +
    +
    encoding used to represent URIs +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NOT_FILE_URI

    +
    +public static final java.lang.String ERROR_NOT_FILE_URI
    +
    +
    Error string used when an invalid uri is seen +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getClassSource

    +
    +public static java.io.File getClassSource(java.lang.Class c)
    +
    +
    Find the directory or jar file the class has been loaded from. +

    +

    +
    Parameters:
    c - the class whose location is required. +
    Returns:
    the file or jar with the class or null if we cannot + determine the location.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getResourceSource

    +
    +public static java.io.File getResourceSource(java.lang.ClassLoader c,
+                                             java.lang.String resource)
    +
    +
    Find the directory or jar a given resource has been loaded from. +

    +

    +
    Parameters:
    c - the classloader to be consulted for the source.
    resource - the resource whose location is required. +
    Returns:
    the file with the resource source or null if + we cannot determine the location.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +fromURI

    +
    +public static java.lang.String fromURI(java.lang.String uri)
    +
    +
    Constructs a file path from a file: URI. + +

    Will be an absolute path if the given URI is absolute.

    + +

    Prior to Java 1.4, + swallows '%' that are not followed by two characters.

    + + See dt-sysid + which makes some mention of how + characters not supported by URI Reference syntax should be escaped. +

    +

    +
    Parameters:
    uri - the URI designating a file in the local filesystem. +
    Returns:
    the local file system path for the file. +
    Throws: +
    java.lang.IllegalArgumentException - if the URI is malformed or not a legal file: URL
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +fromJarURI

    +
    +public static java.lang.String fromJarURI(java.lang.String uri)
    +
    +
    Crack a JAR URI. + This method is public for testing; we may delete it without any warning -it is not part of Ant's stable API. +

    +

    +
    Parameters:
    uri - uri to expand; contains jar: somewhere in it +
    Returns:
    the decoded URI
    Since:
    +
    Ant1.7.1
    +
    +
    +
    +
    + +

    +decodeUri

    +
    +public static java.lang.String decodeUri(java.lang.String uri)
+                                  throws java.io.UnsupportedEncodingException
    +
    +
    Decodes an Uri with % characters. + The URI is escaped +

    +

    +
    Parameters:
    uri - String with the uri possibly containing % characters. +
    Returns:
    The decoded Uri +
    Throws: +
    java.io.UnsupportedEncodingException - if UTF-8 is not available
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +encodeURI

    +
    +public static java.lang.String encodeURI(java.lang.String path)
+                                  throws java.io.UnsupportedEncodingException
    +
    +
    Encodes an Uri with % characters. + The URI is escaped +

    +

    +
    Parameters:
    path - String to encode. +
    Returns:
    The encoded string, according to URI norms +
    Throws: +
    java.io.UnsupportedEncodingException - if UTF-8 is not available
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +fileToURL

    +
    +public static java.net.URL fileToURL(java.io.File file)
+                              throws java.net.MalformedURLException
    +
    +
    Convert a File to a URL. + File.toURL() does not encode characters like #. + File.toURI() has been introduced in java 1.4, so + Ant cannot use it (except by reflection) + FileUtils.toURI() cannot be used by Locator.java + Implemented this way. + File.toURL() adds file: and changes '\' to '/' for dos OSes + encodeURI converts characters like ' ' and '#' to %DD +

    +

    +
    Parameters:
    file - the file to convert +
    Returns:
    URL the converted File +
    Throws: +
    java.net.MalformedURLException - on error
    +
    +
    +
    + +

    +getToolsJar

    +
    +public static java.io.File getToolsJar()
    +
    +
    Get the File necessary to load the Sun compiler tools. If the classes + are available to this class, then no additional URL is required and + null is returned. This may be because the classes are explicitly in the + class path or provided by the JVM directly. +

    +

    + +
    Returns:
    the tools jar as a File if required, null otherwise.
    +
    +
    +
    + +

    +getLocationURLs

    +
    +public static java.net.URL[] getLocationURLs(java.io.File location)
+                                      throws java.net.MalformedURLException
    +
    +
    Get an array of URLs representing all of the jar files in the + given location. If the location is a file, it is returned as the only + element of the array. If the location is a directory, it is scanned for + jar files. +

    +

    +
    Parameters:
    location - the location to scan for Jars. +
    Returns:
    an array of URLs for all jars in the given location. +
    Throws: +
    java.net.MalformedURLException - if the URLs for the jars cannot be + formed.
    +
    +
    +
    + +

    +getLocationURLs

    +
    +public static java.net.URL[] getLocationURLs(java.io.File location,
+                                             java.lang.String[] extensions)
+                                      throws java.net.MalformedURLException
    +
    +
    Get an array of URLs representing all of the files of a given set of + extensions in the given location. If the location is a file, it is + returned as the only element of the array. If the location is a + directory, it is scanned for matching files. +

    +

    +
    Parameters:
    location - the location to scan for files.
    extensions - an array of extension that are to match in the + directory search. +
    Returns:
    an array of URLs of matching files. +
    Throws: +
    java.net.MalformedURLException - if the URLs for the files cannot be + formed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-frame.html new file mode 100644 index 000000000..56cf5e38a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-frame.html @@ -0,0 +1,56 @@ + + + + + + +org.apache.tools.ant.launch (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.launch + + + + +
    +Interfaces  + +
    +AntMain
    + + + + + + +
    +Classes  + +
    +Launcher +
    +Locator
    + + + + + + +
    +Exceptions  + +
    +LaunchException
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-summary.html new file mode 100644 index 000000000..89637f639 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-summary.html @@ -0,0 +1,186 @@ + + + + + + +org.apache.tools.ant.launch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.launch +

    + + + + + + + + + +
    +Interface Summary
    AntMainInterface used to bridge to the actual Main class without any + messy reflection
    +  + +

    + + + + + + + + + + + + + +
    +Class Summary
    LauncherThis is a launcher for Ant.
    LocatorThe Locator is a utility class which is used to find certain items + in the environment.
    +  + +

    + + + + + + + + + +
    +Exception Summary
    LaunchExceptionSignals an error condition during launching
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-tree.html new file mode 100644 index 000000000..a657c26ae --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/launch/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.launch Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.launch +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object
        +
      • org.apache.tools.ant.launch.Launcher
      • org.apache.tools.ant.launch.Locator
      • java.lang.Throwable (implements java.io.Serializable) + +
      +
    +

    +Interface Hierarchy +

    +
      +
    • org.apache.tools.ant.launch.AntMain
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/AnsiColorLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/AnsiColorLogger.html new file mode 100644 index 000000000..39120a9dd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/AnsiColorLogger.html @@ -0,0 +1,361 @@ + + + + + + +AnsiColorLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class AnsiColorLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.listener.AnsiColorLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class AnsiColorLogger
    extends DefaultLogger
    + + +

    +Uses ANSI Color Code Sequences to colorize messages + sent to the console. + + If used with the -logfile option, the output file + will contain all the necessary escape codes to + display the text in colorized mode when displayed + in the console using applications like cat, more, + etc. + + This is designed to work on terminals that support ANSI + color codes. It works on XTerm, ETerm, Mindterm, etc. + It also works on Win9x (with ANSI.SYS loaded.) + + NOTE: + It doesn't work on WinNT's COMMAND.COM even with + ANSI.SYS loaded. + + The default colors used for differentiating + the message levels can be changed by editing the + /org/apache/tools/ant/listener/defaults.properties + file. + This file contains 5 key/value pairs: + AnsiColorLogger.ERROR_COLOR=2;31 + AnsiColorLogger.WARNING_COLOR=2;35 + AnsiColorLogger.INFO_COLOR=2;36 + AnsiColorLogger.VERBOSE_COLOR=2;32 + AnsiColorLogger.DEBUG_COLOR=2;34 + + Another option is to pass a system variable named + ant.logger.defaults, with value set to the path of + the file that contains user defined Ansi Color + Codes, to the java command using -D option. + + To change these colors use the following chart: + + ANSI COLOR LOGGER CONFIGURATION + + Format for AnsiColorLogger.*= + Attribute;Foreground;Background + + Attribute is one of the following: + 0 -> Reset All Attributes (return to normal mode) + 1 -> Bright (Usually turns on BOLD) + 2 -> Dim + 3 -> Underline + 5 -> link + 7 -> Reverse + 8 -> Hidden + + Foreground is one of the following: + 30 -> Black + 31 -> Red + 32 -> Green + 33 -> Yellow + 34 -> Blue + 35 -> Magenta + 36 -> Cyan + 37 -> White + + Background is one of the following: + 40 -> Black + 41 -> Red + 42 -> Green + 43 -> Yellow + 44 -> Blue + 45 -> Magenta + 46 -> Cyan + 47 -> White +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    AnsiColorLogger() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +protected  voidprintMessage(java.lang.String message, + java.io.PrintStream stream, + int priority) + +
    +          Prints a message to a PrintStream..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildFinished, buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, log, messageLogged, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, targetFinished, targetStarted, taskFinished, taskStarted
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AnsiColorLogger

    +
    +public AnsiColorLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +printMessage

    +
    +protected void printMessage(java.lang.String message,
+                            java.io.PrintStream stream,
+                            int priority)
    +
    +
    Prints a message to a PrintStream.. +

    +

    +
    Overrides:
    printMessage in class DefaultLogger
    +
    +
    +
    Parameters:
    message - The message to print. + Should not be null.
    stream - A PrintStream to print the message to. + Must not be null.
    priority - The priority of the message. + (Ignored in this implementation.)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/BigProjectLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/BigProjectLogger.html new file mode 100644 index 000000000..10f5f40a0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/BigProjectLogger.html @@ -0,0 +1,650 @@ + + + + + + +BigProjectLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class BigProjectLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.NoBannerLogger
+          extended by org.apache.tools.ant.listener.SimpleBigProjectLogger
+              extended by org.apache.tools.ant.listener.BigProjectLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger, SubBuildListener
    +
    +
    +
    +
    public class BigProjectLogger
    extends SimpleBigProjectLogger
    implements SubBuildListener
    + + +

    +This is a special logger that is designed to make it easier to work + with big projects, those that use imports and + subant to build complex systems. +

    + +

    +

    +
    Since:
    +
    Ant1.7.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFOOTER + +
    +          Footer string for the log.
    +static java.lang.StringHEADER + +
    +          Header string for the log.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.NoBannerLogger
    targetName
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    BigProjectLogger() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took.
    +protected  java.lang.StringextractNameOrDefault(BuildEvent event) + +
    +          Get the name of an event
    +protected  java.lang.StringgetBuildFailedMessage() + +
    +          This is an override point: the message that indicates whether + a build failed.
    +protected  java.lang.StringgetBuildSuccessfulMessage() + +
    +          This is an override point: the message that indicates that + a build succeeded.
    +protected  java.lang.StringgetFooter() + +
    +          Override point: return the footer string for the entry/exit message
    +protected  java.lang.StringgetHeader() + +
    +          Override point: return the header string for the entry/exit message
    + voidmessageLogged(BuildEvent event) + +
    +          Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target.
    + voidsubBuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished.
    + voidsubBuildStarted(BuildEvent event) + +
    +          Signals that a subbuild has started.
    + voidtargetStarted(BuildEvent event) + +
    +          Notes the name of the target so it can be logged + if it generates any messages.
    + voidtaskStarted(BuildEvent event) + +
    +          No-op implementation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.listener.SimpleBigProjectLogger
    extractTargetName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.NoBannerLogger
    targetFinished
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildStarted, extractProjectName, formatTime, getTimestamp, log, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, taskFinished
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.BuildListener
    buildStarted, targetFinished, taskFinished
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +HEADER

    +
    +public static final java.lang.String HEADER
    +
    +
    Header string for the log. + "======================================================================" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FOOTER

    +
    +public static final java.lang.String FOOTER
    +
    +
    Footer string for the log. + "======================================================================" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +BigProjectLogger

    +
    +public BigProjectLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getBuildFailedMessage

    +
    +protected java.lang.String getBuildFailedMessage()
    +
    +
    This is an override point: the message that indicates whether + a build failed. Subclasses can change/enhance the + message. +

    +

    +
    Overrides:
    getBuildFailedMessage in class DefaultLogger
    +
    +
    + +
    Returns:
    The classic "BUILD FAILED" plus a timestamp
    +
    +
    +
    + +

    +getBuildSuccessfulMessage

    +
    +protected java.lang.String getBuildSuccessfulMessage()
    +
    +
    This is an override point: the message that indicates that + a build succeeded. Subclasses can change/enhance the + message. +

    +

    +
    Overrides:
    getBuildSuccessfulMessage in class DefaultLogger
    +
    +
    + +
    Returns:
    The classic "BUILD SUCCESSFUL" plus a timestamp
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Notes the name of the target so it can be logged + if it generates any messages. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    Overrides:
    targetStarted in class NoBannerLogger
    +
    +
    +
    Parameters:
    event -
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    No-op implementation. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    Overrides:
    taskStarted in class DefaultLogger
    +
    +
    +
    Parameters:
    event -
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Prints whether the build succeeded or failed, + any errors the occurred during the build, and + how long the build took. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    Overrides:
    buildFinished in class DefaultLogger
    +
    +
    +
    Parameters:
    event -
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Logs a message for a target if it is of an appropriate + priority, also logging the name of the target if this + is the first message which needs to be logged for the + target. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    Overrides:
    messageLogged in class NoBannerLogger
    +
    +
    +
    Parameters:
    event -
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +subBuildStarted

    +
    +public void subBuildStarted(BuildEvent event)
    +
    +
    Signals that a subbuild has started. This event + is fired before any targets have started. +

    +

    +
    Specified by:
    subBuildStarted in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. Must not be null.
    +
    +
    +
    + +

    +extractNameOrDefault

    +
    +protected java.lang.String extractNameOrDefault(BuildEvent event)
    +
    +
    Get the name of an event +

    +

    +
    +
    +
    +
    Parameters:
    event - the event name +
    Returns:
    the name or a default string
    +
    +
    +
    + +

    +subBuildFinished

    +
    +public void subBuildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build. +

    +

    +
    Specified by:
    subBuildFinished in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +getHeader

    +
    +protected java.lang.String getHeader()
    +
    +
    Override point: return the header string for the entry/exit message +

    +

    +
    +
    +
    + +
    Returns:
    the header string
    +
    +
    +
    + +

    +getFooter

    +
    +protected java.lang.String getFooter()
    +
    +
    Override point: return the footer string for the entry/exit message +

    +

    +
    +
    +
    + +
    Returns:
    the footer string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/CommonsLoggingListener.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/CommonsLoggingListener.html new file mode 100644 index 000000000..6994f6757 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/CommonsLoggingListener.html @@ -0,0 +1,599 @@ + + + + + + +CommonsLoggingListener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class CommonsLoggingListener

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.listener.CommonsLoggingListener
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class CommonsLoggingListener
    extends java.lang.Object
    implements BuildListener, BuildLogger
    + + +

    +Jakarta Commons Logging listener. + Note: do not use the SimpleLog as your logger implementation as it + causes an infinite loop since it writes to System.err, which Ant traps + and reroutes to the logger/listener layer. + + The following names are used for the log: + org.apache.tools.ant.Project.PROJECT_NAME - for project events + org.apache.tools.ant.Target.TARGET_NAME - for target events + TASK_CLASS_NAME.TARGET_NAME - for events in individual targets. + + In all target and project names we replace "." and " " with "-". + + TODO: we should use the advanced context logging features (and expose them + in c-l first :-) + TODO: this is _very_ inefficient. Switching the out and tracking the logs + can be optimized a lot - but may require few more changes to the core. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringPROJECT_LOG + +
    +          name of the category under which project events are logged
    +static java.lang.StringTARGET_LOG + +
    +          name of the category under which target events are logged
    +  + + + + + + + + + + +
    +Constructor Summary
    CommonsLoggingListener() + +
    +          Construct the listener and make sure that a LogFactory + can be obtained.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished..
    + voidbuildStarted(BuildEvent event) + +
    +          Signals that a build has started..
    + voidmessageLogged(BuildEvent event) + +
    +          Signals a message logging event..
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Set emacs mode.
    + voidsetErrorPrintStream(java.io.PrintStream err) + +
    +          Set the error print stream.
    + voidsetMessageOutputLevel(int level) + +
    +          Set the the output level.
    + voidsetOutputPrintStream(java.io.PrintStream output) + +
    +          Set the output print stream.
    + voidtargetFinished(BuildEvent event) + +
    +          Signals that a target has finished..
    + voidtargetStarted(BuildEvent event) + +
    +          Signals that a target is starting..
    + voidtaskFinished(BuildEvent event) + +
    +          Signals that a task has finished..
    + voidtaskStarted(BuildEvent event) + +
    +          Signals that a task is starting..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +TARGET_LOG

    +
    +public static final java.lang.String TARGET_LOG
    +
    +
    name of the category under which target events are logged +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROJECT_LOG

    +
    +public static final java.lang.String PROJECT_LOG
    +
    +
    name of the category under which project events are logged +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +CommonsLoggingListener

    +
    +public CommonsLoggingListener()
    +
    +
    Construct the listener and make sure that a LogFactory + can be obtained. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Signals that a build has started. This event + is fired before any targets have started. + +

    This event is fired before the project instance is fully + configured. In particular no properties have been set and the + project may not know its name or default target, yet.

    . +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Signals that a target is starting.. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Signals that a target has finished. This event will + still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Signals that a task is starting.. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Signals that a task has finished. This event will still + be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Signals a message logging event.. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +setMessageOutputLevel

    +
    +public void setMessageOutputLevel(int level)
    +
    +
    Set the the output level. + This is not used, the logger config is used instead. +

    +

    +
    Specified by:
    setMessageOutputLevel in interface BuildLogger
    +
    +
    +
    Parameters:
    level - ignored
    +
    +
    +
    + +

    +setOutputPrintStream

    +
    +public void setOutputPrintStream(java.io.PrintStream output)
    +
    +
    Set the output print stream. +

    +

    +
    Specified by:
    setOutputPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    output - the output stream
    +
    +
    +
    + +

    +setEmacsMode

    +
    +public void setEmacsMode(boolean emacsMode)
    +
    +
    Set emacs mode. + This is ignored. +

    +

    +
    Specified by:
    setEmacsMode in interface BuildLogger
    +
    +
    +
    Parameters:
    emacsMode - ignored
    +
    +
    +
    + +

    +setErrorPrintStream

    +
    +public void setErrorPrintStream(java.io.PrintStream err)
    +
    +
    Set the error print stream. +

    +

    +
    Specified by:
    setErrorPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    err - the error stream
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/Log4jListener.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/Log4jListener.html new file mode 100644 index 000000000..933b418cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/Log4jListener.html @@ -0,0 +1,460 @@ + + + + + + +Log4jListener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class Log4jListener

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.listener.Log4jListener
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener
    +
    +
    +
    +
    public class Log4jListener
    extends java.lang.Object
    implements BuildListener
    + + +

    +Listener which sends events to Log4j logging system +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringLOG_ANT + +
    +          log category we log into
    +  + + + + + + + + + + +
    +Constructor Summary
    Log4jListener() + +
    +          Construct the listener and make sure there is a valid appender.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished..
    + voidbuildStarted(BuildEvent event) + +
    +          Signals that a build has started..
    + voidmessageLogged(BuildEvent event) + +
    +          Signals a message logging event..
    + voidtargetFinished(BuildEvent event) + +
    +          Signals that a target has finished..
    + voidtargetStarted(BuildEvent event) + +
    +          Signals that a target is starting..
    + voidtaskFinished(BuildEvent event) + +
    +          Signals that a task has finished..
    + voidtaskStarted(BuildEvent event) + +
    +          Signals that a task is starting..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +LOG_ANT

    +
    +public static final java.lang.String LOG_ANT
    +
    +
    log category we log into +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Log4jListener

    +
    +public Log4jListener()
    +
    +
    Construct the listener and make sure there is a valid appender. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Signals that a build has started. This event + is fired before any targets have started. + +

    This event is fired before the project instance is fully + configured. In particular no properties have been set and the + project may not know its name or default target, yet.

    . +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Signals that a target is starting.. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Signals that a target has finished. This event will + still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Signals that a task is starting.. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Signals that a task has finished. This event will still + be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Signals a message logging event.. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/MailLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/MailLogger.html new file mode 100644 index 000000000..fd8f4226f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/MailLogger.html @@ -0,0 +1,352 @@ + + + + + + +MailLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class MailLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.listener.MailLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class MailLogger
    extends DefaultLogger
    + + +

    +Buffers log messages from DefaultLogger, and sends an e-mail with the + results. The following Project properties are used to send the mail. +

      +
    • MailLogger.mailhost [default: localhost] - Mail server to use
      • +
    • MailLogger.port [default: 25] - Default port for SMTP
      • +
    • Maillogger.user [no default] - user name for SMPT auth + (requires JavaMail)
      • +
    • Maillogger.password [no default] - password for SMPT auth + (requires JavaMail)
      • +
    • Maillogger.ssl [default: false] - on or true if ssl is + needed (requires JavaMail)
      • +
    • MailLogger.from [required] - Mail "from" address
      • +
    • MailLogger.from [no default] - Mail "replyto" address(es), + comma-separated
      • +
    • MailLogger.failure.notify [default: true] - Send build failure + e-mails?
      • +
    • MailLogger.success.notify [default: true] - Send build success + e-mails?
      • +
    • MailLogger.failure.to [required if failure mail to be sent] - Address + to send failure messages to
      • +
    • MailLogger.success.to [required if success mail to be sent] - Address + to send success messages to
      • +
    • MailLogger.failure.subject [default: "Build Failure"] - Subject of + failed build
      • +
    • MailLogger.success.subject [default: "Build Success"] - Subject of + successful build
      • +
    • MailLogger.failure.body [default: none] - fixed text of + mail body for a failed build, default is to send the logfile
      • +
    • MailLogger.success.body [default: none] - fixed text of + mail body for a successful build, default is to send the logfile
      • +
    • MailLogger.mimeType [default: text/plain] - MIME-Type of email
      • +
    • MailLogger.charset [no default] - character set of email
      • +
    • Maillogger.starttls.enable [default: false] - on or true if + STARTTLS should be supported (requires JavaMail)
      • +
    • MailLogger.properties.file [no default] - Filename of + properties file that will override other values.
      • +
    + These properties are set using standard Ant property setting mechanisms + (<property>, command-line -D, etc). Ant properties can be overridden + by specifying the filename of a properties file in the + MailLogger.properties.file property . Any properties defined in that + file will override Ant properties. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    MailLogger() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Sends an e-mail with the log results.
    +protected  voidlog(java.lang.String message) + +
    +          Receives and buffers log messages.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, messageLogged, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, targetFinished, targetStarted, taskFinished, taskStarted
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MailLogger

    +
    +public MailLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Sends an e-mail with the log results. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    Overrides:
    buildFinished in class DefaultLogger
    +
    +
    +
    Parameters:
    event - the build finished event
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +log

    +
    +protected void log(java.lang.String message)
    +
    +
    Receives and buffers log messages. +

    +

    +
    Overrides:
    log in class DefaultLogger
    +
    +
    +
    Parameters:
    message - the message being logger
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/ProfileLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/ProfileLogger.html new file mode 100644 index 000000000..1836adede --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/ProfileLogger.html @@ -0,0 +1,367 @@ + + + + + + +ProfileLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class ProfileLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.listener.ProfileLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class ProfileLogger
    extends DefaultLogger
    + + +

    +This is a special logger that is designed to profile builds. +

    + +

    +

    +
    Since:
    +
    Ant1.8
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    ProfileLogger() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidtargetFinished(BuildEvent event) + +
    +          Logs a message to say that the target has finished.
    + voidtargetStarted(BuildEvent event) + +
    +          Logs a message to say that the target has started.
    + voidtaskFinished(BuildEvent event) + +
    +          Logs a message to say that the task has finished.
    + voidtaskStarted(BuildEvent event) + +
    +          Logs a message to say that the task has started.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildFinished, buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, log, messageLogged, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProfileLogger

    +
    +public ProfileLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Logs a message to say that the target has started. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    Overrides:
    targetStarted in class DefaultLogger
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. Must not be + null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Logs a message to say that the target has finished. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    Overrides:
    targetFinished in class DefaultLogger
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. Must not be + null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Logs a message to say that the task has started. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    Overrides:
    taskStarted in class DefaultLogger
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. Must not be + null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Logs a message to say that the task has finished. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    Overrides:
    taskFinished in class DefaultLogger
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. Must not be + null.
    See Also:
    BuildEvent.getException()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/SimpleBigProjectLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/SimpleBigProjectLogger.html new file mode 100644 index 000000000..b84124baf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/SimpleBigProjectLogger.html @@ -0,0 +1,315 @@ + + + + + + +SimpleBigProjectLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class SimpleBigProjectLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.NoBannerLogger
+          extended by org.apache.tools.ant.listener.SimpleBigProjectLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    Direct Known Subclasses:
    BigProjectLogger
    +
    +
    +
    +
    public class SimpleBigProjectLogger
    extends NoBannerLogger
    + + +

    +Displays subproject names like BigProjectLogger + but is otherwise as quiet as NoBannerLogger. +

    + +

    +

    +
    Since:
    +
    Ant1.8.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.NoBannerLogger
    targetName
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    SimpleBigProjectLogger() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +protected  java.lang.StringextractTargetName(BuildEvent event) + +
    +          Override point, extract the target name
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.NoBannerLogger
    messageLogged, targetFinished, targetStarted
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildFinished, buildStarted, extractProjectName, formatTime, getBuildFailedMessage, getBuildSuccessfulMessage, getTimestamp, log, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, taskFinished, taskStarted
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SimpleBigProjectLogger

    +
    +public SimpleBigProjectLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +extractTargetName

    +
    +protected java.lang.String extractTargetName(BuildEvent event)
    +
    +
    Override point, extract the target name +

    +

    +
    Overrides:
    extractTargetName in class NoBannerLogger
    +
    +
    +
    Parameters:
    event - the event to work on +
    Returns:
    the target name -including the owning project name (if non-null)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/TimestampedLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/TimestampedLogger.html new file mode 100644 index 000000000..45df4e3f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/TimestampedLogger.html @@ -0,0 +1,344 @@ + + + + + + +TimestampedLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.listener +
    +Class TimestampedLogger

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.DefaultLogger
+      extended by org.apache.tools.ant.listener.TimestampedLogger
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger
    +
    +
    +
    +
    public class TimestampedLogger
    extends DefaultLogger
    + + +

    +Like a normal logger, except with timed outputs +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringSPACER + +
    +          what appears between the old message and the new
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.DefaultLogger
    emacsMode, err, LEFT_COLUMN_SIZE, lSep, msgOutputLevel, out
    +  + + + + + + + + + + +
    +Constructor Summary
    TimestampedLogger() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  java.lang.StringgetBuildFailedMessage() + +
    +          This is an override point: the message that indicates whether a build failed.
    +protected  java.lang.StringgetBuildSuccessfulMessage() + +
    +          This is an override point: the message that indicates that a build succeeded.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.DefaultLogger
    buildFinished, buildStarted, extractProjectName, formatTime, getTimestamp, log, messageLogged, printMessage, setEmacsMode, setErrorPrintStream, setMessageOutputLevel, setOutputPrintStream, targetFinished, targetStarted, taskFinished, taskStarted
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +SPACER

    +
    +public static final java.lang.String SPACER
    +
    +
    what appears between the old message and the new +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +TimestampedLogger

    +
    +public TimestampedLogger()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getBuildFailedMessage

    +
    +protected java.lang.String getBuildFailedMessage()
    +
    +
    This is an override point: the message that indicates whether a build failed. + Subclasses can change/enhance the message. +

    +

    +
    Overrides:
    getBuildFailedMessage in class DefaultLogger
    +
    +
    + +
    Returns:
    The classic "BUILD FAILED" plus a timestamp
    +
    +
    +
    + +

    +getBuildSuccessfulMessage

    +
    +protected java.lang.String getBuildSuccessfulMessage()
    +
    +
    This is an override point: the message that indicates that a build succeeded. + Subclasses can change/enhance the message. +

    +

    +
    Overrides:
    getBuildSuccessfulMessage in class DefaultLogger
    +
    +
    + +
    Returns:
    The classic "BUILD SUCCESSFUL" plus a timestamp
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-frame.html new file mode 100644 index 000000000..6263c5878 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-frame.html @@ -0,0 +1,46 @@ + + + + + + +org.apache.tools.ant.listener (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.listener + + + + +
    +Classes  + +
    +AnsiColorLogger +
    +BigProjectLogger +
    +CommonsLoggingListener +
    +Log4jListener +
    +MailLogger +
    +ProfileLogger +
    +SimpleBigProjectLogger +
    +TimestampedLogger
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-summary.html new file mode 100644 index 000000000..6fa94305d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-summary.html @@ -0,0 +1,185 @@ + + + + + + +org.apache.tools.ant.listener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.listener +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    AnsiColorLoggerUses ANSI Color Code Sequences to colorize messages + sent to the console.
    BigProjectLoggerThis is a special logger that is designed to make it easier to work + with big projects, those that use imports and + subant to build complex systems.
    CommonsLoggingListenerJakarta Commons Logging listener.
    Log4jListenerListener which sends events to Log4j logging system
    MailLoggerBuffers log messages from DefaultLogger, and sends an e-mail with the + results.
    ProfileLoggerThis is a special logger that is designed to profile builds.
    SimpleBigProjectLoggerDisplays subproject names like BigProjectLogger + but is otherwise as quiet as NoBannerLogger.
    TimestampedLoggerLike a normal logger, except with timed outputs
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-tree.html new file mode 100644 index 000000000..fdca0fe97 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/listener/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.listener Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.listener +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader2.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader2.html new file mode 100644 index 000000000..bdefbafed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader2.html @@ -0,0 +1,247 @@ + + + + + + +AntClassLoader2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.loader +
    +Class AntClassLoader2

    +
    +java.lang.Object
+  extended by java.lang.ClassLoader
+      extended by org.apache.tools.ant.AntClassLoader
+          extended by org.apache.tools.ant.loader.AntClassLoader2
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, SubBuildListener
    +
    +
    +Deprecated. since 1.7 + Just use AntClassLoader itself. +

    +

    +
    public class AntClassLoader2
    extends AntClassLoader
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AntClassLoader2() + +
    +          Deprecated. No args constructor.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.AntClassLoader
    addJavaLibraries, addLoaderPackageRoot, addPathComponent, addPathElement, addPathFile, addSystemPackageRoot, buildFinished, buildStarted, cleanup, defineClassFromData, definePackage, definePackage, findClass, findResources, findResources, forceLoadClass, forceLoadSystemClass, getClasspath, getConfiguredParent, getNamedResources, getResource, getResourceAsStream, getResourceURL, initializeClass, isInPath, loadClass, log, messageLogged, newAntClassLoader, resetThreadContextLoader, setClassPath, setIsolated, setParent, setParentFirst, setProject, setThreadContextLoader, subBuildFinished, subBuildStarted, targetFinished, targetStarted, taskFinished, taskStarted, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.ClassLoader
    clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findResource, findSystemClass, getPackage, getPackages, getParent, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntClassLoader2

    +
    +public AntClassLoader2()
    +
    +
    Deprecated. 
    No args constructor. +

    +

    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader5.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader5.html new file mode 100644 index 000000000..a44f3edae --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/AntClassLoader5.html @@ -0,0 +1,325 @@ + + + + + + +AntClassLoader5 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.loader +
    +Class AntClassLoader5

    +
    +java.lang.Object
+  extended by java.lang.ClassLoader
+      extended by org.apache.tools.ant.AntClassLoader
+          extended by org.apache.tools.ant.loader.AntClassLoader5
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.util.EventListener, BuildListener, SubBuildListener
    +
    +
    +
    +
    public class AntClassLoader5
    extends AntClassLoader
    implements java.io.Closeable
    + + +

    +Overrides getResources which became non-final in Java5 and + implements Closeable +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AntClassLoader5(java.lang.ClassLoader parent, + Project project, + Path classpath, + boolean parentFirst) + +
    +          Creates a classloader for the given project using the classpath given.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidclose() + +
    +          
    + java.util.EnumerationgetResources(java.lang.String name) + +
    +          
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.AntClassLoader
    addJavaLibraries, addLoaderPackageRoot, addPathComponent, addPathElement, addPathFile, addSystemPackageRoot, buildFinished, buildStarted, cleanup, defineClassFromData, definePackage, definePackage, findClass, findResources, findResources, forceLoadClass, forceLoadSystemClass, getClasspath, getConfiguredParent, getNamedResources, getResource, getResourceAsStream, getResourceURL, initializeClass, isInPath, loadClass, log, messageLogged, newAntClassLoader, resetThreadContextLoader, setClassPath, setIsolated, setParent, setParentFirst, setProject, setThreadContextLoader, subBuildFinished, subBuildStarted, targetFinished, targetStarted, taskFinished, taskStarted, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.ClassLoader
    clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findResource, findSystemClass, getPackage, getPackages, getParent, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntClassLoader5

    +
    +public AntClassLoader5(java.lang.ClassLoader parent,
+                       Project project,
+                       Path classpath,
+                       boolean parentFirst)
    +
    +
    Creates a classloader for the given project using the classpath given. +

    +

    +
    Parameters:
    parent - The parent classloader to which unsatisfied loading + attempts are delegated. May be null, + in which case the classloader which loaded this + class is used as the parent.
    project - The project to which this classloader is to belong. + Must not be null.
    classpath - the classpath to use to load the classes. + May be null, in which case no path + elements are set up to start with.
    parentFirst - If true, indicates that the parent + classloader should be consulted before trying to + load the a class through this loader.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getResources

    +
    +public java.util.Enumeration getResources(java.lang.String name)
+                                   throws java.io.IOException
    +
    +
    +

    +

    +
    Overrides:
    getResources in class java.lang.ClassLoader
    +
    +
    + +
    Throws: +
    java.io.IOException
    +
    +
    +
    + +

    +close

    +
    +public void close()
    +
    +
    +

    +

    +
    Specified by:
    close in interface java.io.Closeable
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-frame.html new file mode 100644 index 000000000..316c00cf4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.loader (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.loader + + + + +
    +Classes  + +
    +AntClassLoader2 +
    +AntClassLoader5
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-summary.html new file mode 100644 index 000000000..0f317db84 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-summary.html @@ -0,0 +1,158 @@ + + + + + + +org.apache.tools.ant.loader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.loader +

    + + + + + + + + + + + + + +
    +Class Summary
    AntClassLoader2Deprecated. since 1.7 + Just use AntClassLoader itself.
    AntClassLoader5Overrides getResources which became non-final in Java5 and + implements Closeable
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-tree.html new file mode 100644 index 000000000..020c9828d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/loader/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +org.apache.tools.ant.loader Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.loader +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-frame.html new file mode 100644 index 000000000..f73872228 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-frame.html @@ -0,0 +1,150 @@ + + + + + + +org.apache.tools.ant (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant + + + + +
    +Interfaces  + +
    +BuildListener +
    +BuildLogger +
    +DynamicAttribute +
    +DynamicAttributeNS +
    +DynamicConfigurator +
    +DynamicConfiguratorNS +
    +DynamicElement +
    +DynamicElementNS +
    +Executor +
    +FileScanner +
    +PropertyHelper.Delegate +
    +PropertyHelper.PropertyEvaluator +
    +PropertyHelper.PropertySetter +
    +SubBuildListener +
    +TaskContainer +
    +TypeAdapter
    + + + + + + +
    +Classes  + +
    +AntClassLoader +
    +AntTypeDefinition +
    +BuildEvent +
    +ComponentHelper +
    +DefaultLogger +
    +DemuxInputStream +
    +DemuxOutputStream +
    +Diagnostics +
    +DirectoryScanner +
    +ExtensionPoint +
    +IntrospectionHelper +
    +IntrospectionHelper.Creator +
    +Location +
    +MagicNames +
    +Main +
    +NoBannerLogger +
    +PathTokenizer +
    +Project +
    +ProjectComponent +
    +ProjectHelper +
    +ProjectHelper.OnMissingExtensionPoint +
    +ProjectHelperRepository +
    +PropertyHelper +
    +RuntimeConfigurable +
    +Target +
    +Task +
    +TaskAdapter +
    +TaskConfigurationChecker +
    +UnknownElement +
    +XmlLogger
    + + + + + + +
    +Exceptions  + +
    +BuildException +
    +ExitException +
    +ExitStatusException +
    +UnsupportedAttributeException +
    +UnsupportedElementException
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-summary.html new file mode 100644 index 000000000..fe7e19d81 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-summary.html @@ -0,0 +1,401 @@ + + + + + + +org.apache.tools.ant (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Interface Summary
    BuildListenerInstances of classes that implement this interface can register + to be notified when things happened during a build.
    BuildLoggerInterface used by Ant to log the build output.
    DynamicAttributeEnables a task to control unknown attributes
    DynamicAttributeNSEnables a task to control unknown attributes.
    DynamicConfiguratorEnables a task to control unknown attributes and elements.
    DynamicConfiguratorNSEnables a task to control unknown attributes and elements.
    DynamicElementEnables a task to control unknown elements.
    DynamicElementNSEnables a task to control unknown elements.
    ExecutorTarget executor abstraction.
    FileScannerAn interface used to describe the actions required of any type of + directory scanner.
    PropertyHelper.DelegateMarker interface for a PropertyHelper delegate.
    PropertyHelper.PropertyEvaluatorLooks up a property's value based on its name.
    PropertyHelper.PropertySetterSets or overrides a property.
    SubBuildListenerInstances of classes that implement this interface can register + to be also notified when things happened during a subbuild.
    TaskContainerInterface for objects which can contain tasks.
    TypeAdapterUsed to wrap types.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    AntClassLoaderUsed to load classes within ant with a different classpath from + that used to start ant.
    AntTypeDefinitionThis class contains all the information + on a particular ant type, + the classname, adaptor and the class + it should be assignable from.
    BuildEventClass representing an event occurring during a build.
    ComponentHelperComponent creation and configuration.
    DefaultLoggerWrites build events to a PrintStream.
    DemuxInputStreamPasses input requests to the project object for demuxing into + individual tasks and threads.
    DemuxOutputStreamLogs content written by a thread and forwards the buffers onto the + project object which will forward the content to the appropriate + task.
    DiagnosticsA little diagnostic helper that output some information that may help + in support.
    DirectoryScannerClass for scanning a directory for files/directories which match certain + criteria.
    ExtensionPointAn extension point build files can provide as a place where other + build files can add new dependencies.
    IntrospectionHelperHelper class that collects the methods a task or nested element + holds to set attributes, create nested elements or hold PCDATA + elements.
    IntrospectionHelper.Creatorcreator - allows use of create/store external + to IntrospectionHelper.
    LocationStores the location of a piece of text within a file (file name, + line number and column number).
    MagicNamesMagic names used within Ant.
    MainCommand line entry point into Ant.
    NoBannerLoggerExtends DefaultLogger to strip out empty targets.
    PathTokenizerA Path tokenizer takes a path and returns the components that make up + that path.
    ProjectCentral representation of an Ant project.
    ProjectComponentBase class for components of a project, including tasks and data types.
    ProjectHelperConfigures a Project (complete with Targets and Tasks) based on + a build file.
    ProjectHelper.OnMissingExtensionPointPossible value for target's onMissingExtensionPoint attribute.
    ProjectHelperRepositoryRepository of ProjectHelper found in the classpath or via + some System properties.
    PropertyHelperDeals with properties - substitution, dynamic properties, etc.
    RuntimeConfigurableWrapper class that holds the attributes of an element, its children, and + any text within it.
    TargetClass to implement a target object with required parameters.
    TaskBase class for all tasks.
    TaskAdapterUses introspection to "adapt" an arbitrary Bean which doesn't + itself extend Task, but still contains an execute method and optionally + a setProject method.
    TaskConfigurationCheckerHelper class for the check of the configuration of a given task.
    UnknownElementWrapper class that holds all the information necessary to create a task + or data type that did not exist when Ant started, or one which + has had its definition updated to use a different implementation class.
    XmlLoggerGenerates a file in the current directory with + an XML description of what happened during a build.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Exception Summary
    BuildExceptionSignals an error condition during a build
    ExitExceptionUsed to report exit status of classes which call System.exit().
    ExitStatusExceptionBuildException + exit status.
    UnsupportedAttributeExceptionUsed to report attempts to set an unsupported attribute
    UnsupportedElementExceptionUsed to report attempts to set an unsupported element + When the attempt to set the element is made, + the code does not not know the name of the task/type + based on a mapping from the classname to the task/type.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-tree.html new file mode 100644 index 000000000..43b5e164d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/package-tree.html @@ -0,0 +1,212 @@ + + + + + + +org.apache.tools.ant Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/GetProperty.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/GetProperty.html new file mode 100644 index 000000000..ec375d563 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/GetProperty.html @@ -0,0 +1,215 @@ + + + + + + +GetProperty (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Interface GetProperty

    +
    +
    All Known Implementing Classes:
    PropertyHelper, ResolvePropertyMap
    +
    +
    +
    +
    public interface GetProperty
    + + +

    +Interface to a class (normally PropertyHelper) to get a property. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectgetProperty(java.lang.String name) + +
    +          Returns the value of a property if it is set.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getProperty

    +
    +java.lang.Object getProperty(java.lang.String name)
    +
    +
    Returns the value of a property if it is set. +

    +

    +
    Parameters:
    name - name of the property. +
    Returns:
    the property value, or null for no match or for name being null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalProperties.html new file mode 100644 index 000000000..277ad4624 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalProperties.html @@ -0,0 +1,458 @@ + + + + + + +LocalProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Class LocalProperties

    +
    +java.lang.Object
+  extended by java.lang.ThreadLocal<T>
+      extended by java.lang.InheritableThreadLocal
+          extended by org.apache.tools.ant.property.LocalProperties
+
    +
    +
    All Implemented Interfaces:
    PropertyHelper.Delegate, PropertyHelper.PropertyEvaluator, PropertyHelper.PropertySetter
    +
    +
    +
    +
    public class LocalProperties
    extends java.lang.InheritableThreadLocal
    implements PropertyHelper.PropertyEvaluator, PropertyHelper.PropertySetter
    + + +

    +Thread local class containing local properties. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddLocal(java.lang.String property) + +
    +          Add a local property to the current scope.
    + voidcopy() + +
    +          Copy the stack for a parallel thread.
    + voidenterScope() + +
    +          enter the scope
    + java.lang.Objectevaluate(java.lang.String property, + PropertyHelper helper) + +
    +          Evaluate a property.
    + voidexitScope() + +
    +          exit the scope
    +static LocalPropertiesget(Project project) + +
    +          Get a localproperties for the given project.
    +protected  java.lang.ObjectinitialValue() + +
    +          Get the initial value.
    + booleanset(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a property.
    + booleansetNew(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a *new" property.
    +  + + + + + + + +
    Methods inherited from class java.lang.InheritableThreadLocal
    childValue
    +  + + + + + + + +
    Methods inherited from class java.lang.ThreadLocal
    get, remove, set
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +get

    +
    +public static LocalProperties get(Project project)
    +
    +
    Get a localproperties for the given project. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project to retieve the localproperties for. +
    Returns:
    the localproperties.
    +
    +
    +
    + +

    +initialValue

    +
    +protected java.lang.Object initialValue()
    +
    +
    Get the initial value. +

    +

    +
    Overrides:
    initialValue in class java.lang.ThreadLocal
    +
    +
    + +
    Returns:
    a new localproperties stack.
    +
    +
    +
    + +

    +addLocal

    +
    +public void addLocal(java.lang.String property)
    +
    +
    Add a local property to the current scope. +

    +

    +
    +
    +
    +
    Parameters:
    property - the property name to add.
    +
    +
    +
    + +

    +enterScope

    +
    +public void enterScope()
    +
    +
    enter the scope +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +exitScope

    +
    +public void exitScope()
    +
    +
    exit the scope +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +copy

    +
    +public void copy()
    +
    +
    Copy the stack for a parallel thread. + To be called from the parallel thread itself. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +evaluate

    +
    +public java.lang.Object evaluate(java.lang.String property,
+                                 PropertyHelper helper)
    +
    +
    Evaluate a property. +

    +

    +
    Specified by:
    evaluate in interface PropertyHelper.PropertyEvaluator
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    helper - the invoking PropertyHelper. +
    Returns:
    Object value.
    +
    +
    +
    + +

    +setNew

    +
    +public boolean setNew(java.lang.String property,
+                      java.lang.Object value,
+                      PropertyHelper propertyHelper)
    +
    +
    Set a *new" property. +

    +

    +
    Specified by:
    setNew in interface PropertyHelper.PropertySetter
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    +
    + +

    +set

    +
    +public boolean set(java.lang.String property,
+                   java.lang.Object value,
+                   PropertyHelper propertyHelper)
    +
    +
    Set a property. +

    +

    +
    Specified by:
    set in interface PropertyHelper.PropertySetter
    +
    +
    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalPropertyStack.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalPropertyStack.html new file mode 100644 index 000000000..2c0d6c1c3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/LocalPropertyStack.html @@ -0,0 +1,398 @@ + + + + + + +LocalPropertyStack (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Class LocalPropertyStack

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.property.LocalPropertyStack
+
    +
    +
    +
    public class LocalPropertyStack
    extends java.lang.Object
    + + +

    +A stack of local property maps. + There is a map for each scope (target, sequential, macro). +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    LocalPropertyStack() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddLocal(java.lang.String property) + +
    +          Add a local property.
    + LocalPropertyStackcopy() + +
    +          Copy the stack for a parallel thread.
    + voidenterScope() + +
    +          Enter the local scope.
    + java.lang.Objectevaluate(java.lang.String property, + PropertyHelper helper) + +
    +          Evaluate a property.
    + voidexitScope() + +
    +          Exit the local scope.
    + booleanset(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a property.
    + booleansetNew(java.lang.String property, + java.lang.Object value, + PropertyHelper propertyHelper) + +
    +          Set a *new" property.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LocalPropertyStack

    +
    +public LocalPropertyStack()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addLocal

    +
    +public void addLocal(java.lang.String property)
    +
    +
    Add a local property. +

    +

    +
    Parameters:
    property - the name of the local proeprty.
    +
    +
    +
    + +

    +enterScope

    +
    +public void enterScope()
    +
    +
    Enter the local scope. +

    +

    +
    +
    +
    +
    + +

    +exitScope

    +
    +public void exitScope()
    +
    +
    Exit the local scope. +

    +

    +
    +
    +
    +
    + +

    +copy

    +
    +public LocalPropertyStack copy()
    +
    +
    Copy the stack for a parallel thread. +

    +

    + +
    Returns:
    a copy.
    +
    +
    +
    + +

    +evaluate

    +
    +public java.lang.Object evaluate(java.lang.String property,
+                                 PropertyHelper helper)
    +
    +
    Evaluate a property. +

    +

    +
    Parameters:
    property - the property's String "identifier".
    helper - the invoking PropertyHelper. +
    Returns:
    Object value.
    +
    +
    +
    + +

    +setNew

    +
    +public boolean setNew(java.lang.String property,
+                      java.lang.Object value,
+                      PropertyHelper propertyHelper)
    +
    +
    Set a *new" property. +

    +

    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    +
    + +

    +set

    +
    +public boolean set(java.lang.String property,
+                   java.lang.Object value,
+                   PropertyHelper propertyHelper)
    +
    +
    Set a property. +

    +

    +
    Parameters:
    property - the property's String "identifier".
    value - the value to set.
    propertyHelper - the invoking PropertyHelper. +
    Returns:
    true if this entity 'owns' the property.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/NullReturn.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/NullReturn.html new file mode 100644 index 000000000..d845ee2e4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/NullReturn.html @@ -0,0 +1,265 @@ + + + + + + +NullReturn (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Class NullReturn

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.property.NullReturn
+
    +
    +
    +
    public final class NullReturn
    extends java.lang.Object
    + + +

    +Class to represent a null and to stop the chain of lookups. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static NullReturnNULL + +
    +          a value to use in a property helper to stop looking properties
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringtoString() + +
    +          
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NULL

    +
    +public static final NullReturn NULL
    +
    +
    a value to use in a property helper to stop looking properties +

    +

    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseNextProperty.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseNextProperty.html new file mode 100644 index 000000000..a2f415175 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseNextProperty.html @@ -0,0 +1,242 @@ + + + + + + +ParseNextProperty (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Interface ParseNextProperty

    +
    +
    All Known Implementing Classes:
    ParseProperties
    +
    +
    +
    +
    public interface ParseNextProperty
    + + +

    +Helper for PropertyExpander that can be + used to expand property references to values. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + ProjectgetProject() + +
    +          Get the current project.
    + java.lang.ObjectparseNextProperty(java.lang.String value, + java.text.ParsePosition pos) + +
    +          Return any property that can be parsed from the specified position + in the specified String.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getProject

    +
    +Project getProject()
    +
    +
    Get the current project. +

    +

    + +
    Returns:
    the current ant project.
    +
    +
    +
    + +

    +parseNextProperty

    +
    +java.lang.Object parseNextProperty(java.lang.String value,
+                                   java.text.ParsePosition pos)
    +
    +
    Return any property that can be parsed from the specified position + in the specified String. +

    +

    +
    Parameters:
    value - String to parse
    pos - ParsePosition +
    Returns:
    Object or null if no property is at the current location.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseProperties.html new file mode 100644 index 000000000..79f3e25f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ParseProperties.html @@ -0,0 +1,389 @@ + + + + + + +ParseProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Class ParseProperties

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.property.ParseProperties
+
    +
    +
    All Implemented Interfaces:
    ParseNextProperty
    +
    +
    +
    +
    public class ParseProperties
    extends java.lang.Object
    implements ParseNextProperty
    + + +

    +Parse properties using a collection of expanders. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ParseProperties(Project project, + java.util.Collection expanders, + GetProperty getProperty) + +
    +          Constructor with a getProperty.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleancontainsProperties(java.lang.String value) + +
    +          Learn whether a String contains replaceable properties.
    + ProjectgetProject() + +
    +          Get the project.
    + java.lang.ObjectparseNextProperty(java.lang.String value, + java.text.ParsePosition pos) + +
    +          Return any property that can be parsed from the specified position + in the specified String.
    + java.lang.ObjectparseProperties(java.lang.String value) + +
    +          Decode properties from a String representation.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ParseProperties

    +
    +public ParseProperties(Project project,
+                       java.util.Collection expanders,
+                       GetProperty getProperty)
    +
    +
    Constructor with a getProperty. +

    +

    +
    Parameters:
    project - the current ant project.
    expanders - a sequence of exapanders
    getProperty - property resolver.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get the project. +

    +

    +
    Specified by:
    getProject in interface ParseNextProperty
    +
    +
    + +
    Returns:
    the current ant project.
    +
    +
    +
    + +

    +parseProperties

    +
    +public java.lang.Object parseProperties(java.lang.String value)
    +
    +
    Decode properties from a String representation. + +
      + +
    • This implementation starts parsing the value + parameter (unsurprisingly) at the beginning and asks each + PropertyExpander whether there is a + property reference at that point. PropertyExpanders return + the name of a property they may find and may advance the parse + position.
      • + +
    • If the PropertyExpander returns null the + method continues with the next PropertyExpander, otherwise it + tries to look up the property's value using the configured + GetProperty instance.
      • + +
    • Once all PropertyExpanders have been consulted, the parse + position is advanced by one character and the process repeated + until value is exhausted.
      • + +
    + +

    If the entire contents of value resolves to a + single property, the looked up property value is returned. + Otherwise a String is returned that concatenates the + non-property parts of value and the expanded + values of the properties that have been found.

    +

    +

    +
    +
    +
    +
    Parameters:
    value - The string to be scanned for property references. + May be null, in which case this + method returns immediately with no effect. +
    Returns:
    the original string with the properties replaced, or + null if the original string is null.
    +
    +
    +
    + +

    +containsProperties

    +
    +public boolean containsProperties(java.lang.String value)
    +
    +
    Learn whether a String contains replaceable properties. + +

    Uses the configured PropertyExpanders and scans through the string. Returns true + as soon as any expander finds a property.

    +

    +

    +
    +
    +
    +
    Parameters:
    value - the String to check. +
    Returns:
    true if value contains property notation.
    +
    +
    +
    + +

    +parseNextProperty

    +
    +public java.lang.Object parseNextProperty(java.lang.String value,
+                                          java.text.ParsePosition pos)
    +
    +
    Return any property that can be parsed from the specified position + in the specified String. + +

    Uses the configured PropertyExpanders and GetProperty + instance .

    +

    +

    +
    Specified by:
    parseNextProperty in interface ParseNextProperty
    +
    +
    +
    Parameters:
    value - String to parse
    pos - ParsePosition +
    Returns:
    Object or null if no property is at the current + location. If a property reference has been found but the + property doesn't expand to a value, the property's name is + returned.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/PropertyExpander.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/PropertyExpander.html new file mode 100644 index 000000000..b80c7d8db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/PropertyExpander.html @@ -0,0 +1,233 @@ + + + + + + +PropertyExpander (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Interface PropertyExpander

    +
    +
    All Superinterfaces:
    PropertyHelper.Delegate
    +
    +
    +
    +
    public interface PropertyExpander
    extends PropertyHelper.Delegate
    + + +

    +Responsible for locating a property reference inside a String. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringparsePropertyName(java.lang.String s, + java.text.ParsePosition pos, + ParseNextProperty parseNextProperty) + +
    +          Determine whether there is a property reference at the current + ParsePosition and return its name (or null if there is none).
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +parsePropertyName

    +
    +java.lang.String parsePropertyName(java.lang.String s,
+                                   java.text.ParsePosition pos,
+                                   ParseNextProperty parseNextProperty)
    +
    +
    Determine whether there is a property reference at the current + ParsePosition and return its name (or null if there is none). + +

    Implementations should advance the ParsePosition to the last + character that makes up the property reference. E.g. the + default implementation would return "foo" for + ${foo} and advance the ParsePosition to the + } character.

    +

    +

    +
    +
    +
    +
    Parameters:
    s - the String to parse.
    pos - the ParsePosition in use, the location is expected + to be modified if a property reference has been found (and may + even be modified if no reference has been found).
    parseNextProperty - provides access to the Project and may + be used to look up property values. +
    Returns:
    property name if any, else null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ResolvePropertyMap.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ResolvePropertyMap.html new file mode 100644 index 000000000..c6e7649de --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/ResolvePropertyMap.html @@ -0,0 +1,357 @@ + + + + + + +ResolvePropertyMap (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.property +
    +Class ResolvePropertyMap

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.property.ResolvePropertyMap
+
    +
    +
    All Implemented Interfaces:
    GetProperty
    +
    +
    +
    +
    public class ResolvePropertyMap
    extends java.lang.Object
    implements GetProperty
    + + +

    +Class to resolve properties in a map. This class is explicitly not threadsafe. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ResolvePropertyMap(Project project, + GetProperty master, + java.util.Collection expanders) + +
    +          Constructor with a master getproperty and a collection of expanders.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectgetProperty(java.lang.String name) + +
    +          Returns the value of a property if it is set.
    + voidresolveAllProperties(java.util.Map map) + +
    +          Deprecated. since Ant 1.8.2, use the three-arg method instead.
    + voidresolveAllProperties(java.util.Map map, + java.lang.String prefix) + +
    +          Deprecated. since Ant 1.8.2, use the three-arg method instead.
    + voidresolveAllProperties(java.util.Map map, + java.lang.String prefix, + boolean prefixValues) + +
    +          The action method - resolves all the properties in a map.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ResolvePropertyMap

    +
    +public ResolvePropertyMap(Project project,
+                          GetProperty master,
+                          java.util.Collection expanders)
    +
    +
    Constructor with a master getproperty and a collection of expanders. +

    +

    +
    Parameters:
    project - the current ant project.
    master - the master property holder (usually PropertyHelper)
    expanders - a collection of expanders (usually from PropertyHelper).
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getProperty

    +
    +public java.lang.Object getProperty(java.lang.String name)
    +
    +
    Returns the value of a property if it is set. +

    +

    +
    Specified by:
    getProperty in interface GetProperty
    +
    +
    +
    Parameters:
    name - name of the property. +
    Returns:
    the property value, or null for no match or for name being null.
    +
    +
    +
    + +

    +resolveAllProperties

    +
    +public void resolveAllProperties(java.util.Map map)
    +
    +
    Deprecated. since Ant 1.8.2, use the three-arg method instead. +

    +

    The action method - resolves all the properties in a map. +

    +

    +
    +
    +
    +
    Parameters:
    map - the map to resolve properties in.
    +
    +
    +
    + +

    +resolveAllProperties

    +
    +public void resolveAllProperties(java.util.Map map,
+                                 java.lang.String prefix)
    +
    +
    Deprecated. since Ant 1.8.2, use the three-arg method instead. +

    +

    The action method - resolves all the properties in a map. +

    +

    +
    +
    +
    +
    Parameters:
    map - the map to resolve properties in.
    prefix - the prefix the properties defined inside the map + will finally receive - may be null.
    +
    +
    +
    + +

    +resolveAllProperties

    +
    +public void resolveAllProperties(java.util.Map map,
+                                 java.lang.String prefix,
+                                 boolean prefixValues)
    +
    +
    The action method - resolves all the properties in a map. +

    +

    +
    +
    +
    +
    Parameters:
    map - the map to resolve properties in.
    prefix - the prefix the properties defined inside the map + will finally receive - may be null.
    prefixValues - - whether the prefix will be applied + to properties on the value side of the map as well.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-frame.html new file mode 100644 index 000000000..8401e0de9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-frame.html @@ -0,0 +1,55 @@ + + + + + + +org.apache.tools.ant.property (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.property + + + + +
    +Interfaces  + +
    +GetProperty +
    +ParseNextProperty +
    +PropertyExpander
    + + + + + + +
    +Classes  + +
    +LocalProperties +
    +LocalPropertyStack +
    +NullReturn +
    +ParseProperties +
    +ResolvePropertyMap
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-summary.html new file mode 100644 index 000000000..4d35b6b9c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-summary.html @@ -0,0 +1,206 @@ + + + + + + +org.apache.tools.ant.property (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.property +

    +Contains helper classes for ant properties. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + + + + + +
    +Interface Summary
    GetPropertyInterface to a class (normally PropertyHelper) to get a property.
    ParseNextPropertyHelper for PropertyExpander that can be + used to expand property references to values.
    PropertyExpanderResponsible for locating a property reference inside a String.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    LocalPropertiesThread local class containing local properties.
    LocalPropertyStackA stack of local property maps.
    NullReturnClass to represent a null and to stop the chain of lookups.
    ParsePropertiesParse properties using a collection of expanders.
    ResolvePropertyMapClass to resolve properties in a map.
    +  + +

    +

    +Package org.apache.tools.ant.property Description +

    + +

    +Contains helper classes for ant properties. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-tree.html new file mode 100644 index 000000000..a4c7ed3e9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/property/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +org.apache.tools.ant.property Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.property +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.Module.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.Module.html new file mode 100644 index 000000000..fb8a2ac8a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.Module.html @@ -0,0 +1,269 @@ + + + + + + +AbstractCvsTask.Module (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AbstractCvsTask.Module

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.AbstractCvsTask.Module
+
    +
    +
    Enclosing class:
    AbstractCvsTask
    +
    +
    +
    +
    public static final class AbstractCvsTask.Module
    extends java.lang.Object
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    AbstractCvsTask.Module() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +           
    + voidsetName(java.lang.String s) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AbstractCvsTask.Module

    +
    +public AbstractCvsTask.Module()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String s)
    +
    +
    +
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.html new file mode 100644 index 000000000..f640b6665 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractCvsTask.html @@ -0,0 +1,1313 @@ + + + + + + +AbstractCvsTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AbstractCvsTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractCvsTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    ChangeLogTask, Cvs, CvsTagDiff, CvsVersion
    +
    +
    +
    +
    public abstract class AbstractCvsTask
    extends Task
    + + +

    +original Cvs.java 1.20 + + NOTE: This implementation has been moved here from Cvs.java with + the addition of some accessors for extensibility. Another task + can extend this with some customized output processing. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classAbstractCvsTask.Module + +
    +           
    +  + + + + + + + + + + +
    +Field Summary
    +static intDEFAULT_COMPRESSION_LEVEL + +
    +          Default compression level to use, if compression is enabled via + setCompression( true ).
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AbstractCvsTask() + +
    +          empty no-arg constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddCommandArgument(Commandline c, + java.lang.String arg) + +
    +          This method adds a command line argument to an external command.
    + voidaddCommandArgument(java.lang.String arg) + +
    +          This needs to be public to allow configuration + of commands externally.
    + voidaddConfiguredCommandline(Commandline c) + +
    +          Adds direct command-line to execute.
    + voidaddConfiguredCommandline(Commandline c, + boolean insertAtStart) + +
    +          Configures and adds the given Commandline.
    + voidaddModule(AbstractCvsTask.Module m) + +
    +          add a named module/package.
    +protected  voidconfigureCommandline(Commandline c) + +
    +          Configure a commandline element for things like cvsRoot, quiet, etc.
    + voidexecute() + +
    +          do the work
    + java.lang.StringgetCommand() + +
    +          accessor to a command line as string + + This should be deprecated + AntoineLL July 23d 2003
    + java.lang.StringgetCvsRoot() + +
    +          access the CVSROOT variable
    + java.lang.StringgetCvsRsh() + +
    +          access the CVS_RSH variable
    + java.io.FilegetDest() + +
    +          get the file where the checked out files should be placed
    +protected  java.io.OutputStreamgetErrorStream() + +
    +          access the stream to which the stderr from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute error + has been set, the output stream will go to the file denoted by the error attribute + otherwise the stderr output will go to ant's logging system
    +protected  ExecuteStreamHandlergetExecuteStreamHandler() + +
    +          find the handler and instantiate it if it does not exist yet
    +protected  java.util.ListgetModules() + +
    +           
    +protected  java.io.OutputStreamgetOutputStream() + +
    +          access the stream to which the stdout from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute output + has been set, the output stream will go to the output file + otherwise the output will go to ant's logging system
    + java.lang.StringgetPackage() + +
    +          access the package or module to operate upon
    + java.io.FilegetPassFile() + +
    +          find the password file
    + intgetPort() + +
    +          access the port of CVS
    + java.lang.StringgetTag() + +
    +          tag or branch
    +protected  voidremoveCommandline(Commandline c) + +
    +          remove a particular command from a vector of command lines
    +protected  voidrunCommand(Commandline toExecute) + +
    +          Sets up the environment for toExecute and then runs it.
    + voidsetAppend(boolean value) + +
    +          Whether to append output/error when redirecting to a file.
    + voidsetCommand(java.lang.String c) + +
    +          The CVS command to execute.
    + voidsetCompression(boolean usecomp) + +
    +          If true, this is the same as compressionlevel="3".
    + voidsetCompressionLevel(int level) + +
    +          If set to a value 1-9 it adds -zN to the cvs command line, else + it disables compression.
    + voidsetCvsRoot(java.lang.String root) + +
    +          The CVSROOT variable.
    + voidsetCvsRsh(java.lang.String rsh) + +
    +          The CVS_RSH variable.
    + voidsetDate(java.lang.String p) + +
    +          Use the most recent revision no later than the given date.
    + voidsetDest(java.io.File dest) + +
    +          The directory where the checked out files should be placed.
    + voidsetError(java.io.File error) + +
    +          The file to direct standard error from the command.
    +protected  voidsetErrorStream(java.io.OutputStream errorStream) + +
    +          sets a stream to which the stderr from the cvs exe should go
    + voidsetExecuteStreamHandler(ExecuteStreamHandler handler) + +
    +          sets the handler
    + voidsetFailOnError(boolean failOnError) + +
    +          Stop the build process if the command exits with + a return code other than 0.
    + voidsetNoexec(boolean ne) + +
    +          If true, report only and don't change any files.
    + voidsetOutput(java.io.File output) + +
    +          The file to direct standard output from the command.
    +protected  voidsetOutputStream(java.io.OutputStream outputStream) + +
    +          sets a stream to which the output from the cvs executable should be sent
    + voidsetPackage(java.lang.String p) + +
    +          The package/module to operate upon.
    + voidsetPassfile(java.io.File passFile) + +
    +          Password file to read passwords from.
    + voidsetPort(int port) + +
    +          Port used by CVS to communicate with the server.
    + voidsetQuiet(boolean q) + +
    +          If true, suppress informational messages.
    + voidsetReallyquiet(boolean q) + +
    +          If true, suppress all messages.
    + voidsetTag(java.lang.String p) + +
    +          The tag of the package/module to operate upon.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_COMPRESSION_LEVEL

    +
    +public static final int DEFAULT_COMPRESSION_LEVEL
    +
    +
    Default compression level to use, if compression is enabled via + setCompression( true ). +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +AbstractCvsTask

    +
    +public AbstractCvsTask()
    +
    +
    empty no-arg constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setExecuteStreamHandler

    +
    +public void setExecuteStreamHandler(ExecuteStreamHandler handler)
    +
    +
    sets the handler +

    +

    +
    Parameters:
    handler - a handler able of processing the output and error streams from the cvs exe
    +
    +
    +
    + +

    +getExecuteStreamHandler

    +
    +protected ExecuteStreamHandler getExecuteStreamHandler()
    +
    +
    find the handler and instantiate it if it does not exist yet +

    +

    + +
    Returns:
    handler for output and error streams
    +
    +
    +
    + +

    +setOutputStream

    +
    +protected void setOutputStream(java.io.OutputStream outputStream)
    +
    +
    sets a stream to which the output from the cvs executable should be sent +

    +

    +
    Parameters:
    outputStream - stream to which the stdout from cvs should go
    +
    +
    +
    + +

    +getOutputStream

    +
    +protected java.io.OutputStream getOutputStream()
    +
    +
    access the stream to which the stdout from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute output + has been set, the output stream will go to the output file + otherwise the output will go to ant's logging system +

    +

    + +
    Returns:
    output stream to which cvs' stdout should go to
    +
    +
    +
    + +

    +setErrorStream

    +
    +protected void setErrorStream(java.io.OutputStream errorStream)
    +
    +
    sets a stream to which the stderr from the cvs exe should go +

    +

    +
    Parameters:
    errorStream - an output stream willing to process stderr
    +
    +
    +
    + +

    +getErrorStream

    +
    +protected java.io.OutputStream getErrorStream()
    +
    +
    access the stream to which the stderr from cvs should go + if this stream has already been set, it will be returned + if the stream has not yet been set, if the attribute error + has been set, the output stream will go to the file denoted by the error attribute + otherwise the stderr output will go to ant's logging system +

    +

    + +
    Returns:
    output stream to which cvs' stderr should go to
    +
    +
    +
    + +

    +runCommand

    +
    +protected void runCommand(Commandline toExecute)
+                   throws BuildException
    +
    +
    Sets up the environment for toExecute and then runs it. +

    +

    +
    Parameters:
    toExecute - the command line to execute +
    Throws: +
    BuildException - if failonError is set to true and the cvs command fails
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    do the work +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if failonerror is set to true and the + cvs command fails.
    +
    +
    +
    + +

    +setCvsRoot

    +
    +public void setCvsRoot(java.lang.String root)
    +
    +
    The CVSROOT variable. +

    +

    +
    Parameters:
    root - the CVSROOT variable
    +
    +
    +
    + +

    +getCvsRoot

    +
    +public java.lang.String getCvsRoot()
    +
    +
    access the CVSROOT variable +

    +

    + +
    Returns:
    CVSROOT
    +
    +
    +
    + +

    +setCvsRsh

    +
    +public void setCvsRsh(java.lang.String rsh)
    +
    +
    The CVS_RSH variable. +

    +

    +
    Parameters:
    rsh - the CVS_RSH variable
    +
    +
    +
    + +

    +getCvsRsh

    +
    +public java.lang.String getCvsRsh()
    +
    +
    access the CVS_RSH variable +

    +

    + +
    Returns:
    the CVS_RSH variable
    +
    +
    +
    + +

    +setPort

    +
    +public void setPort(int port)
    +
    +
    Port used by CVS to communicate with the server. +

    +

    +
    Parameters:
    port - port of CVS
    +
    +
    +
    + +

    +getPort

    +
    +public int getPort()
    +
    +
    access the port of CVS +

    +

    + +
    Returns:
    the port of CVS
    +
    +
    +
    + +

    +setPassfile

    +
    +public void setPassfile(java.io.File passFile)
    +
    +
    Password file to read passwords from. +

    +

    +
    Parameters:
    passFile - password file to read passwords from
    +
    +
    +
    + +

    +getPassFile

    +
    +public java.io.File getPassFile()
    +
    +
    find the password file +

    +

    + +
    Returns:
    password file
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    The directory where the checked out files should be placed. + +

    Note that this is different from CVS's -d command line + switch as Ant will never shorten pathnames to avoid empty + directories.

    +

    +

    +
    Parameters:
    dest - directory where the checked out files should be placed
    +
    +
    +
    + +

    +getDest

    +
    +public java.io.File getDest()
    +
    +
    get the file where the checked out files should be placed +

    +

    + +
    Returns:
    directory where the checked out files should be placed
    +
    +
    +
    + +

    +setPackage

    +
    +public void setPackage(java.lang.String p)
    +
    +
    The package/module to operate upon. +

    +

    +
    Parameters:
    p - package or module to operate upon
    +
    +
    +
    + +

    +getPackage

    +
    +public java.lang.String getPackage()
    +
    +
    access the package or module to operate upon +

    +

    + +
    Returns:
    package/module
    +
    +
    +
    + +

    +getTag

    +
    +public java.lang.String getTag()
    +
    +
    tag or branch +

    +

    + +
    Returns:
    tag or branch
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +setTag

    +
    +public void setTag(java.lang.String p)
    +
    +
    The tag of the package/module to operate upon. +

    +

    +
    Parameters:
    p - tag
    +
    +
    +
    + +

    +addCommandArgument

    +
    +public void addCommandArgument(java.lang.String arg)
    +
    +
    This needs to be public to allow configuration + of commands externally. +

    +

    +
    Parameters:
    arg - command argument
    +
    +
    +
    + +

    +addCommandArgument

    +
    +public void addCommandArgument(Commandline c,
+                               java.lang.String arg)
    +
    +
    This method adds a command line argument to an external command. + + I do not understand what this method does in this class ??? + particularly not why it is public ???? + AntoineLL July 23d 2003 +

    +

    +
    Parameters:
    c - command line to which one argument should be added
    arg - argument to add
    +
    +
    +
    + +

    +setDate

    +
    +public void setDate(java.lang.String p)
    +
    +
    Use the most recent revision no later than the given date. +

    +

    +
    Parameters:
    p - a date as string in a format that the CVS executable + can understand see man cvs
    +
    +
    +
    + +

    +setCommand

    +
    +public void setCommand(java.lang.String c)
    +
    +
    The CVS command to execute. + + This should be deprecated, it is better to use the Commandline class ? + AntoineLL July 23d 2003 +

    +

    +
    Parameters:
    c - a command as string
    +
    +
    +
    + +

    +getCommand

    +
    +public java.lang.String getCommand()
    +
    +
    accessor to a command line as string + + This should be deprecated + AntoineLL July 23d 2003 +

    +

    + +
    Returns:
    command line as string
    +
    +
    +
    + +

    +setQuiet

    +
    +public void setQuiet(boolean q)
    +
    +
    If true, suppress informational messages. +

    +

    +
    Parameters:
    q - if true, suppress informational messages
    +
    +
    +
    + +

    +setReallyquiet

    +
    +public void setReallyquiet(boolean q)
    +
    +
    If true, suppress all messages. +

    +

    +
    Parameters:
    q - if true, suppress all messages
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setNoexec

    +
    +public void setNoexec(boolean ne)
    +
    +
    If true, report only and don't change any files. +

    +

    +
    Parameters:
    ne - if true, report only and do not change any files.
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File output)
    +
    +
    The file to direct standard output from the command. +

    +

    +
    Parameters:
    output - a file to which stdout should go
    +
    +
    +
    + +

    +setError

    +
    +public void setError(java.io.File error)
    +
    +
    The file to direct standard error from the command. +

    +

    +
    Parameters:
    error - a file to which stderr should go
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean value)
    +
    +
    Whether to append output/error when redirecting to a file. +

    +

    +
    Parameters:
    value - true indicated you want to append
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failOnError)
    +
    +
    Stop the build process if the command exits with + a return code other than 0. + Defaults to false. +

    +

    +
    Parameters:
    failOnError - stop the build process if the command exits with + a return code other than 0
    +
    +
    +
    + +

    +configureCommandline

    +
    +protected void configureCommandline(Commandline c)
    +
    +
    Configure a commandline element for things like cvsRoot, quiet, etc. +

    +

    +
    Parameters:
    c - the command line which will be configured + if the commandline is initially null, the function is a noop + otherwise the function append to the commandline arguments concerning +
      +
    • + cvs package +
      • +
    • + compression +
      • +
    • + quiet or reallyquiet +
      • +
    • cvsroot
      • +
    • noexec
      • +
    +
    +
    +
    + +

    +removeCommandline

    +
    +protected void removeCommandline(Commandline c)
    +
    +
    remove a particular command from a vector of command lines +

    +

    +
    Parameters:
    c - command line which should be removed
    +
    +
    +
    + +

    +addConfiguredCommandline

    +
    +public void addConfiguredCommandline(Commandline c)
    +
    +
    Adds direct command-line to execute. +

    +

    +
    Parameters:
    c - command line to execute
    +
    +
    +
    + +

    +addConfiguredCommandline

    +
    +public void addConfiguredCommandline(Commandline c,
+                                     boolean insertAtStart)
    +
    +
    Configures and adds the given Commandline. +

    +

    +
    Parameters:
    c - commandline to insert
    insertAtStart - If true, c is + inserted at the beginning of the vector of command lines
    +
    +
    +
    + +

    +setCompressionLevel

    +
    +public void setCompressionLevel(int level)
    +
    +
    If set to a value 1-9 it adds -zN to the cvs command line, else + it disables compression. +

    +

    +
    Parameters:
    level - compression level 1 to 9
    +
    +
    +
    + +

    +setCompression

    +
    +public void setCompression(boolean usecomp)
    +
    +
    If true, this is the same as compressionlevel="3". +

    +

    +
    Parameters:
    usecomp - If true, turns on compression using default + level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.
    +
    +
    +
    + +

    +addModule

    +
    +public void addModule(AbstractCvsTask.Module m)
    +
    +
    add a named module/package. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getModules

    +
    +protected java.util.List getModules()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.html new file mode 100644 index 000000000..3017efbc3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AbstractJarSignerTask.html @@ -0,0 +1,1030 @@ + + + + + + +AbstractJarSignerTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AbstractJarSignerTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractJarSignerTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    SignJar, VerifyJar
    +
    +
    +
    +
    public abstract class AbstractJarSignerTask
    extends Task
    + + +

    +This is factored out from SignJar; a base class that can be used + for both signing and verifying JAR files using jarsigner +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.Stringalias + +
    +          The alias of signer.
    +static java.lang.StringERROR_NO_SOURCE + +
    +          error string for unit test verification: "jar must be set through jar attribute or nested filesets"
    +protected  java.util.Vectorfilesets + +
    +          the filesets of the jars to sign
    +protected  java.io.Filejar + +
    +          The name of the jar file.
    +protected static java.lang.StringJARSIGNER_COMMAND + +
    +          name of JDK program we are looking for
    +protected  java.lang.Stringkeypass + +
    +          password for the key in the store
    +protected  java.lang.Stringkeystore + +
    +          The url or path of keystore file.
    +protected  java.lang.StringmaxMemory + +
    +          The maximum amount of memory to use for Jar signer
    +protected  java.lang.Stringstorepass + +
    +          password for the store
    +protected  java.lang.Stringstoretype + +
    +          type of store,-storetype param
    +protected  booleanverbose + +
    +          verbose output
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AbstractJarSignerTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files to sign
    + voidaddSysproperty(Environment.Variable sysp) + +
    +          Add a system property.
    +protected  voidaddValue(ExecTask cmd, + java.lang.String value) + +
    +          add a value argument to a command
    +protected  voidbeginExecution() + +
    +          init processing logic; this is retained through our execution(s)
    +protected  voidbindToKeystore(ExecTask cmd) + +
    +          bind to a keystore if the attributes are there
    +protected  ExecTaskcreateJarSigner() + +
    +          create the jarsigner executable task
    + PathcreatePath() + +
    +          Adds a path of files to sign.
    +protected  PathcreateUnifiedSourcePath() + +
    +          clone our path and add all explicitly specified FileSets as + well, patch in the jar attribute as a new fileset if it is + defined.
    +protected  java.util.VectorcreateUnifiedSources() + +
    +          clone our filesets vector, and patch in the jar attribute as a new + fileset, if is defined
    +protected  voiddeclareSysProperty(ExecTask cmd, + Environment.Variable property) + +
    +           
    +protected  voidendExecution() + +
    +          any cleanup logic
    + RedirectorElementgetRedirector() + +
    +          get the redirector.
    +protected  booleanhasResources() + +
    +          Has either a path or a fileset been specified?
    + voidsetAlias(java.lang.String alias) + +
    +          the alias to sign under; required
    +protected  voidsetCommonOptions(ExecTask cmd) + +
    +          these are options common to signing and verifying
    + voidsetExecutable(java.lang.String executable) + +
    +          Sets the actual executable command to invoke, instead of the binary + jarsigner found in Ant's JDK.
    + voidsetJar(java.io.File jar) + +
    +          the jar file to sign; required
    + voidsetKeypass(java.lang.String keypass) + +
    +          password for private key (if different); optional
    + voidsetKeystore(java.lang.String keystore) + +
    +          keystore location; required
    + voidsetMaxmemory(java.lang.String max) + +
    +          Set the maximum memory to be used by the jarsigner process
    + voidsetStorepass(java.lang.String storepass) + +
    +          password for keystore integrity; required
    + voidsetStoretype(java.lang.String storetype) + +
    +          keystore type; optional
    + voidsetVerbose(boolean verbose) + +
    +          Enable verbose output when signing ; optional: default false
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +jar

    +
    +protected java.io.File jar
    +
    +
    The name of the jar file. +

    +

    +
    +
    +
    + +

    +alias

    +
    +protected java.lang.String alias
    +
    +
    The alias of signer. +

    +

    +
    +
    +
    + +

    +keystore

    +
    +protected java.lang.String keystore
    +
    +
    The url or path of keystore file. +

    +

    +
    +
    +
    + +

    +storepass

    +
    +protected java.lang.String storepass
    +
    +
    password for the store +

    +

    +
    +
    +
    + +

    +storetype

    +
    +protected java.lang.String storetype
    +
    +
    type of store,-storetype param +

    +

    +
    +
    +
    + +

    +keypass

    +
    +protected java.lang.String keypass
    +
    +
    password for the key in the store +

    +

    +
    +
    +
    + +

    +verbose

    +
    +protected boolean verbose
    +
    +
    verbose output +

    +

    +
    +
    +
    + +

    +maxMemory

    +
    +protected java.lang.String maxMemory
    +
    +
    The maximum amount of memory to use for Jar signer +

    +

    +
    +
    +
    + +

    +filesets

    +
    +protected java.util.Vector filesets
    +
    +
    the filesets of the jars to sign +

    +

    +
    +
    +
    + +

    +JARSIGNER_COMMAND

    +
    +protected static final java.lang.String JARSIGNER_COMMAND
    +
    +
    name of JDK program we are looking for +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_SOURCE

    +
    +public static final java.lang.String ERROR_NO_SOURCE
    +
    +
    error string for unit test verification: "jar must be set through jar attribute or nested filesets" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +AbstractJarSignerTask

    +
    +public AbstractJarSignerTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMaxmemory

    +
    +public void setMaxmemory(java.lang.String max)
    +
    +
    Set the maximum memory to be used by the jarsigner process +

    +

    +
    Parameters:
    max - a string indicating the maximum memory according to the JVM + conventions (e.g. 128m is 128 Megabytes)
    +
    +
    +
    + +

    +setJar

    +
    +public void setJar(java.io.File jar)
    +
    +
    the jar file to sign; required +

    +

    +
    Parameters:
    jar - the jar file to sign
    +
    +
    +
    + +

    +setAlias

    +
    +public void setAlias(java.lang.String alias)
    +
    +
    the alias to sign under; required +

    +

    +
    Parameters:
    alias - the alias to sign under
    +
    +
    +
    + +

    +setKeystore

    +
    +public void setKeystore(java.lang.String keystore)
    +
    +
    keystore location; required +

    +

    +
    Parameters:
    keystore - the keystore location
    +
    +
    +
    + +

    +setStorepass

    +
    +public void setStorepass(java.lang.String storepass)
    +
    +
    password for keystore integrity; required +

    +

    +
    Parameters:
    storepass - the password for the keystore
    +
    +
    +
    + +

    +setStoretype

    +
    +public void setStoretype(java.lang.String storetype)
    +
    +
    keystore type; optional +

    +

    +
    Parameters:
    storetype - the keystore type
    +
    +
    +
    + +

    +setKeypass

    +
    +public void setKeypass(java.lang.String keypass)
    +
    +
    password for private key (if different); optional +

    +

    +
    Parameters:
    keypass - the password for the key (if different)
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    Enable verbose output when signing ; optional: default false +

    +

    +
    Parameters:
    verbose - if true enable verbose output
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files to sign +

    +

    +
    Parameters:
    set - a set of files to sign
    Since:
    +
    Ant 1.4
    +
    +
    +
    +
    + +

    +addSysproperty

    +
    +public void addSysproperty(Environment.Variable sysp)
    +
    +
    Add a system property. +

    +

    +
    Parameters:
    sysp - system property.
    +
    +
    +
    + +

    +createPath

    +
    +public Path createPath()
    +
    +
    Adds a path of files to sign. +

    +

    + +
    Returns:
    a path of files to sign.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +beginExecution

    +
    +protected void beginExecution()
    +
    +
    init processing logic; this is retained through our execution(s) +

    +

    +
    +
    +
    +
    + +

    +endExecution

    +
    +protected void endExecution()
    +
    +
    any cleanup logic +

    +

    +
    +
    +
    +
    + +

    +getRedirector

    +
    +public RedirectorElement getRedirector()
    +
    +
    get the redirector. Non-null between invocations of + beginExecution() and endExecution() +

    +

    + +
    Returns:
    a redirector or null
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String executable)
    +
    +
    Sets the actual executable command to invoke, instead of the binary + jarsigner found in Ant's JDK. +

    +

    +
    Parameters:
    executable - the command to invoke.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCommonOptions

    +
    +protected void setCommonOptions(ExecTask cmd)
    +
    +
    these are options common to signing and verifying +

    +

    +
    Parameters:
    cmd - command to configure
    +
    +
    +
    + +

    +declareSysProperty

    +
    +protected void declareSysProperty(ExecTask cmd,
+                                  Environment.Variable property)
+                           throws BuildException
    +
    +
    +
    Parameters:
    cmd - command to configure
    property - property to set +
    Throws: +
    BuildException - if the property is not correctly defined.
    +
    +
    +
    + +

    +bindToKeystore

    +
    +protected void bindToKeystore(ExecTask cmd)
    +
    +
    bind to a keystore if the attributes are there +

    +

    +
    Parameters:
    cmd - command to configure
    +
    +
    +
    + +

    +createJarSigner

    +
    +protected ExecTask createJarSigner()
    +
    +
    create the jarsigner executable task +

    +

    + +
    Returns:
    a task set up with the executable of jarsigner, failonerror=true + and bound to our redirector
    +
    +
    +
    + +

    +createUnifiedSources

    +
    +protected java.util.Vector createUnifiedSources()
    +
    +
    clone our filesets vector, and patch in the jar attribute as a new + fileset, if is defined +

    +

    + +
    Returns:
    a vector of FileSet instances
    +
    +
    +
    + +

    +createUnifiedSourcePath

    +
    +protected Path createUnifiedSourcePath()
    +
    +
    clone our path and add all explicitly specified FileSets as + well, patch in the jar attribute as a new fileset if it is + defined. +

    +

    + +
    Returns:
    a path that contains all files to sign
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +hasResources

    +
    +protected boolean hasResources()
    +
    +
    Has either a path or a fileset been specified? +

    +

    + +
    Returns:
    true if a path or fileset has been specified.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addValue

    +
    +protected void addValue(ExecTask cmd,
+                        java.lang.String value)
    +
    +
    add a value argument to a command +

    +

    +
    Parameters:
    cmd - command to manipulate
    value - value to add
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.Reference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.Reference.html new file mode 100644 index 000000000..3e985fcff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.Reference.html @@ -0,0 +1,296 @@ + + + + + + +Ant.Reference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Ant.Reference

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.Reference
+      extended by org.apache.tools.ant.taskdefs.Ant.Reference
+
    +
    +
    Enclosing class:
    Ant
    +
    +
    +
    +
    public static class Ant.Reference
    extends Reference
    + + +

    +Helper class that implements the nested <reference> + element of <ant> and <antcall>. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Ant.Reference() + +
    +          Creates a reference to be configured by Ant.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetToRefid() + +
    +          Get the id under which this reference will be stored in the new + project.
    + voidsetToRefid(java.lang.String targetid) + +
    +          Set the id that this reference to be stored under in the + new project.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.Reference
    getProject, getReferencedObject, getReferencedObject, getRefId, setProject, setRefId
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Ant.Reference

    +
    +public Ant.Reference()
    +
    +
    Creates a reference to be configured by Ant. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setToRefid

    +
    +public void setToRefid(java.lang.String targetid)
    +
    +
    Set the id that this reference to be stored under in the + new project. +

    +

    +
    Parameters:
    targetid - the id under which this reference will be passed to + the new project.
    +
    +
    +
    + +

    +getToRefid

    +
    +public java.lang.String getToRefid()
    +
    +
    Get the id under which this reference will be stored in the new + project. +

    +

    + +
    Returns:
    the id of the reference in the new project.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.TargetElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.TargetElement.html new file mode 100644 index 000000000..f88e9bdc6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.TargetElement.html @@ -0,0 +1,285 @@ + + + + + + +Ant.TargetElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Ant.TargetElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Ant.TargetElement
+
    +
    +
    Enclosing class:
    Ant
    +
    +
    +
    +
    public static class Ant.TargetElement
    extends java.lang.Object
    + + +

    +Helper class that implements the nested <target> + element of <ant> and <antcall>. +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Ant.TargetElement() + +
    +          Default constructor.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the name of this TargetElement.
    + voidsetName(java.lang.String name) + +
    +          Set the name of this TargetElement.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Ant.TargetElement

    +
    +public Ant.TargetElement()
    +
    +
    Default constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of this TargetElement. +

    +

    +
    Parameters:
    name - the String target name.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name of this TargetElement. +

    +

    + +
    Returns:
    String.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.html new file mode 100644 index 000000000..4995e9bdb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ant.html @@ -0,0 +1,851 @@ + + + + + + +Ant (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Ant

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Ant
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Ant
    extends Task
    + + +

    +Build a sub-project. + + 

    +  <target name="foo" depends="init">
+    <ant antfile="build.xml" target="bar" >
+      <property name="property1" value="aaaaa" />
+      <property name="foo" value="baz" />
+    </ant>
+  </target>
+
+  <target name="bar" depends="init">
+    <echo message="prop is ${property1} ${foo}" />
+  </target>
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classAnt.Reference + +
    +          Helper class that implements the nested <reference> + element of <ant> and <antcall>.
    +static classAnt.TargetElement + +
    +          Helper class that implements the nested <target> + element of <ant> and <antcall>.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Ant() + +
    +          simple constructor
    Ant(Task owner) + +
    +          create a task bound to its creator
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredTarget(Ant.TargetElement t) + +
    +          Add a target to this Ant invocation.
    + voidaddPropertyset(PropertySet ps) + +
    +          Add a set of properties to pass to the new project.
    + voidaddReference(Ant.Reference ref) + +
    +          Add a Reference element identifying a data type to carry + over to the new project.
    + PropertycreateProperty() + +
    +          Property to pass to the new project.
    + voidexecute() + +
    +          Do the execution.
    +protected  java.lang.StringgetDefaultBuildFile() + +
    +          Get the default build file name to use when launching the task.
    +protected  ProjectgetNewProject() + +
    +          Get the (sub)-Project instance currently in use.
    + voidhandleErrorFlush(java.lang.String errorOutputToFlush) + +
    +          Handle error output.
    + voidhandleErrorOutput(java.lang.String errorOutputToHandle) + +
    +          Handle error output.
    + voidhandleFlush(java.lang.String toFlush) + +
    +          Handles output.
    + inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Handles input.
    + voidhandleOutput(java.lang.String outputToHandle) + +
    +          Handles output.
    + voidinit() + +
    +          Creates a Project instance for the project to call.
    + voidsetAntfile(java.lang.String antFile) + +
    +          The build file to use.
    + voidsetDir(java.io.File dir) + +
    +          The directory to use as a base directory for the new Ant project.
    + voidsetInheritAll(boolean value) + +
    +          If true, pass all properties to the new Ant project.
    + voidsetInheritRefs(boolean value) + +
    +          If true, pass all references to the new Ant project.
    + voidsetOutput(java.lang.String outputFile) + +
    +          Set the filename to write the output to.
    + voidsetTarget(java.lang.String targetToAdd) + +
    +          The target of the new Ant project to execute.
    + voidsetUseNativeBasedir(boolean b) + +
    +          Whether the basedir of the new project should be the same one + as it would be when running the build file directly - + independent of dir and/or inheritAll settings.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Ant

    +
    +public Ant()
    +
    +
    simple constructor +

    +

    +
    + +

    +Ant

    +
    +public Ant(Task owner)
    +
    +
    create a task bound to its creator +

    +

    +
    Parameters:
    owner - owning task
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setUseNativeBasedir

    +
    +public void setUseNativeBasedir(boolean b)
    +
    +
    Whether the basedir of the new project should be the same one + as it would be when running the build file directly - + independent of dir and/or inheritAll settings. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setInheritAll

    +
    +public void setInheritAll(boolean value)
    +
    +
    If true, pass all properties to the new Ant project. + Defaults to true. +

    +

    +
    Parameters:
    value - if true pass all properties to the new Ant project.
    +
    +
    +
    + +

    +setInheritRefs

    +
    +public void setInheritRefs(boolean value)
    +
    +
    If true, pass all references to the new Ant project. + Defaults to false. +

    +

    +
    Parameters:
    value - if true, pass all references to the new Ant project
    +
    +
    +
    + +

    +init

    +
    +public void init()
    +
    +
    Creates a Project instance for the project to call. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    +
    +
    +
    +
    + +

    +handleOutput

    +
    +public void handleOutput(java.lang.String outputToHandle)
    +
    +
    Handles output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleOutput in class Task
    +
    +
    +
    Parameters:
    outputToHandle - The string output to output.
    Since:
    +
    Ant 1.5
    +
    See Also:
    Task.handleOutput(String)
    +
    +
    +
    + +

    +handleInput

    +
    +public int handleInput(byte[] buffer,
+                       int offset,
+                       int length)
+                throws java.io.IOException
    +
    +
    Handles input. + Deleate to the created project, if present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleInput in class Task
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    See Also:
    Task.handleInput(byte[], int, int)
    +
    +
    +
    + +

    +handleFlush

    +
    +public void handleFlush(java.lang.String toFlush)
    +
    +
    Handles output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleFlush in class Task
    +
    +
    +
    Parameters:
    toFlush - The string to output.
    Since:
    +
    Ant 1.5.2
    +
    See Also:
    Task.handleFlush(String)
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +public void handleErrorOutput(java.lang.String errorOutputToHandle)
    +
    +
    Handle error output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleErrorOutput in class Task
    +
    +
    +
    Parameters:
    errorOutputToHandle - The string to output.
    Since:
    +
    Ant 1.5
    +
    See Also:
    Task.handleErrorOutput(String)
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +public void handleErrorFlush(java.lang.String errorOutputToFlush)
    +
    +
    Handle error output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleErrorFlush in class Task
    +
    +
    +
    Parameters:
    errorOutputToFlush - The string to output.
    Since:
    +
    Ant 1.5.2
    +
    See Also:
    Task.handleErrorFlush(String)
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if a target tries to call itself; + probably also if a BuildException is thrown by the new project.
    +
    +
    +
    + +

    +getDefaultBuildFile

    +
    +protected java.lang.String getDefaultBuildFile()
    +
    +
    Get the default build file name to use when launching the task. +

    + This function may be overrided by providers of custom ProjectHelper so they can implement easily their sub + launcher. +

    +

    + +
    Returns:
    the name of the default file
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
    +
    +
    The directory to use as a base directory for the new Ant project. + Defaults to the current project's basedir, unless inheritall + has been set to false, in which case it doesn't have a default + value. This will override the basedir setting of the called project. +

    +

    +
    Parameters:
    dir - new directory as File.
    +
    +
    +
    + +

    +setAntfile

    +
    +public void setAntfile(java.lang.String antFile)
    +
    +
    The build file to use. Defaults to "build.xml". This file is expected + to be a filename relative to the dir attribute given. +

    +

    +
    Parameters:
    antFile - the String build file name.
    +
    +
    +
    + +

    +setTarget

    +
    +public void setTarget(java.lang.String targetToAdd)
    +
    +
    The target of the new Ant project to execute. + Defaults to the new project's default target. +

    +

    +
    Parameters:
    targetToAdd - the name of the target to invoke.
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.lang.String outputFile)
    +
    +
    Set the filename to write the output to. This is relative to the value + of the dir attribute if it has been set or to the base directory of the + current project otherwise. +

    +

    +
    Parameters:
    outputFile - the name of the file to which the output should go.
    +
    +
    +
    + +

    +createProperty

    +
    +public Property createProperty()
    +
    +
    Property to pass to the new project. + The property is passed as a 'user property'. +

    +

    + +
    Returns:
    the created Property object.
    +
    +
    +
    + +

    +addReference

    +
    +public void addReference(Ant.Reference ref)
    +
    +
    Add a Reference element identifying a data type to carry + over to the new project. +

    +

    +
    Parameters:
    ref - Reference to add.
    +
    +
    +
    + +

    +addConfiguredTarget

    +
    +public void addConfiguredTarget(Ant.TargetElement t)
    +
    +
    Add a target to this Ant invocation. +

    +

    +
    Parameters:
    t - the TargetElement to add.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +addPropertyset

    +
    +public void addPropertyset(PropertySet ps)
    +
    +
    Add a set of properties to pass to the new project. +

    +

    +
    Parameters:
    ps - PropertySet to add.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getNewProject

    +
    +protected Project getNewProject()
    +
    +
    Get the (sub)-Project instance currently in use. +

    +

    + +
    Returns:
    Project
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.StructurePrinter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.StructurePrinter.html new file mode 100644 index 000000000..648640a14 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.StructurePrinter.html @@ -0,0 +1,290 @@ + + + + + + +AntStructure.StructurePrinter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface AntStructure.StructurePrinter

    +
    +
    Enclosing class:
    AntStructure
    +
    +
    +
    +
    public static interface AntStructure.StructurePrinter
    + + +

    +Writes the actual structure information. + +

    printHead(java.io.PrintWriter, org.apache.tools.ant.Project, java.util.Hashtable, java.util.Hashtable), printTargetDecl(java.io.PrintWriter) and printTail(java.io.PrintWriter) + are called exactly once, printElementDecl(java.io.PrintWriter, org.apache.tools.ant.Project, java.lang.String, java.lang.Class) once for + each declared task and type.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidprintElementDecl(java.io.PrintWriter out, + Project p, + java.lang.String name, + java.lang.Class element) + +
    +          Print the definition for a given element.
    + voidprintHead(java.io.PrintWriter out, + Project p, + java.util.Hashtable tasks, + java.util.Hashtable types) + +
    +          Prints the header of the generated output.
    + voidprintTail(java.io.PrintWriter out) + +
    +          Prints the trailer.
    + voidprintTargetDecl(java.io.PrintWriter out) + +
    +          Prints the definition for the target element.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +printHead

    +
    +void printHead(java.io.PrintWriter out,
+               Project p,
+               java.util.Hashtable tasks,
+               java.util.Hashtable types)
    +
    +
    Prints the header of the generated output. +

    +

    +
    Parameters:
    out - PrintWriter to write to.
    p - Project instance for the current task
    tasks - map (name to implementing class)
    types - map (name to implementing class) + data types.
    +
    +
    +
    + +

    +printTargetDecl

    +
    +void printTargetDecl(java.io.PrintWriter out)
    +
    +
    Prints the definition for the target element. +

    +

    +
    Parameters:
    out - PrintWriter to write to.
    +
    +
    +
    + +

    +printElementDecl

    +
    +void printElementDecl(java.io.PrintWriter out,
+                      Project p,
+                      java.lang.String name,
+                      java.lang.Class element)
    +
    +
    Print the definition for a given element. +

    +

    +
    Parameters:
    out - PrintWriter to write to.
    p - Project instance for the current task
    name - element name.
    element - class of the defined element.
    +
    +
    +
    + +

    +printTail

    +
    +void printTail(java.io.PrintWriter out)
    +
    +
    Prints the trailer. +

    +

    +
    Parameters:
    out - PrintWriter to write to.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.html new file mode 100644 index 000000000..e36b18264 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntStructure.html @@ -0,0 +1,421 @@ + + + + + + +AntStructure (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AntStructure

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntStructure
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class AntStructure
    extends Task
    + + +

    +Creates a partial DTD for Ant from the currently known tasks. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceAntStructure.StructurePrinter + +
    +          Writes the actual structure information.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AntStructure() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(AntStructure.StructurePrinter p) + +
    +          The StructurePrinter to use.
    +protected  booleanareNmtokens(java.lang.String[] s) + +
    +          Do the Strings all match the XML-NMTOKEN production?
    + voidexecute() + +
    +          Build the antstructure DTD.
    +protected  booleanisNmtoken(java.lang.String s) + +
    +          Does this String match the XML-NMTOKEN production?
    + voidsetOutput(java.io.File output) + +
    +          The output file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntStructure

    +
    +public AntStructure()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setOutput

    +
    +public void setOutput(java.io.File output)
    +
    +
    The output file. +

    +

    +
    Parameters:
    output - the output file
    +
    +
    +
    + +

    +add

    +
    +public void add(AntStructure.StructurePrinter p)
    +
    +
    The StructurePrinter to use. +

    +

    +
    Parameters:
    p - the printer to use.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Build the antstructure DTD. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the DTD cannot be written.
    +
    +
    +
    + +

    +isNmtoken

    +
    +protected boolean isNmtoken(java.lang.String s)
    +
    +
    Does this String match the XML-NMTOKEN production? +

    +

    +
    Parameters:
    s - the string to test +
    Returns:
    true if the string matches the XML-NMTOKEN
    +
    +
    +
    + +

    +areNmtokens

    +
    +protected boolean areNmtokens(java.lang.String[] s)
    +
    +
    Do the Strings all match the XML-NMTOKEN production? + +

    Otherwise they are not suitable as an enumerated attribute, + for example.

    +

    +

    +
    Parameters:
    s - the array of string to test +
    Returns:
    true if all the strings in the array math XML-NMTOKEN
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Antlib.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Antlib.html new file mode 100644 index 000000000..3a92c4252 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Antlib.html @@ -0,0 +1,448 @@ + + + + + + +Antlib (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Antlib

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Antlib
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TaskContainer
    +
    +
    +
    +
    public class Antlib
    extends Task
    implements TaskContainer
    + + +

    +Antlib task. It does not + occur in an ant build file. It is the root element + an antlib xml file. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringTAG + +
    +          The name of this task
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Antlib() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          add a task to the list of tasks
    +static AntlibcreateAntlib(Project project, + java.net.URL antlibUrl, + java.lang.String uri) + +
    +          Static method to read an ant lib definition from + a url.
    + voidexecute() + +
    +          Execute the nested tasks, setting the classloader for + any tasks that derive from Definer.
    +protected  voidsetClassLoader(java.lang.ClassLoader classLoader) + +
    +          Set the class loader for this antlib.
    +protected  voidsetURI(java.lang.String uri) + +
    +          Set the URI for this antlib.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +TAG

    +
    +public static final java.lang.String TAG
    +
    +
    The name of this task +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Antlib

    +
    +public Antlib()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createAntlib

    +
    +public static Antlib createAntlib(Project project,
+                                  java.net.URL antlibUrl,
+                                  java.lang.String uri)
    +
    +
    Static method to read an ant lib definition from + a url. +

    +

    +
    +
    +
    +
    Parameters:
    project - the current project
    antlibUrl - the url to read the definitions from
    uri - the uri that the antlib is to be placed in +
    Returns:
    the ant lib task
    +
    +
    +
    + +

    +setClassLoader

    +
    +protected void setClassLoader(java.lang.ClassLoader classLoader)
    +
    +
    Set the class loader for this antlib. + This class loader is used for any tasks that + derive from Definer. +

    +

    +
    +
    +
    +
    Parameters:
    classLoader - the class loader
    +
    +
    +
    + +

    +setURI

    +
    +protected void setURI(java.lang.String uri)
    +
    +
    Set the URI for this antlib. +

    +

    +
    +
    +
    +
    Parameters:
    uri - the namespace uri
    +
    +
    +
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    add a task to the list of tasks +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - Nested task to execute in antlib
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute the nested tasks, setting the classloader for + any tasks that derive from Definer. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntlibDefinition.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntlibDefinition.html new file mode 100644 index 000000000..74c6664be --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AntlibDefinition.html @@ -0,0 +1,385 @@ + + + + + + +AntlibDefinition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AntlibDefinition

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    DefBase, MacroDef, PreSetDef
    +
    +
    +
    +
    public class AntlibDefinition
    extends Task
    + + +

    +Base class for tasks that that can be used in antlibs. + For handling uri and class loading. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AntlibDefinition() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ClassLoadergetAntlibClassLoader() + +
    +          The current antlib classloader
    + java.lang.StringgetURI() + +
    +          The URI for this definition.
    + voidsetAntlibClassLoader(java.lang.ClassLoader classLoader) + +
    +          Set the class loader of the loading object
    + voidsetURI(java.lang.String uri) + +
    +          The URI for this definition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntlibDefinition

    +
    +public AntlibDefinition()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setURI

    +
    +public void setURI(java.lang.String uri)
+            throws BuildException
    +
    +
    The URI for this definition. + If the URI is "antlib:org.apache.tools.ant", + (this is the default uri) + the uri will be set to "". + URIs that start with "ant:" are reserved + and are not allowed in this context. +

    +

    +
    Parameters:
    uri - the namespace URI +
    Throws: +
    BuildException - if a reserved URI is used
    +
    +
    +
    + +

    +getURI

    +
    +public java.lang.String getURI()
    +
    +
    The URI for this definition. +

    +

    + +
    Returns:
    The URI for this defintion.
    +
    +
    +
    + +

    +setAntlibClassLoader

    +
    +public void setAntlibClassLoader(java.lang.ClassLoader classLoader)
    +
    +
    Set the class loader of the loading object +

    +

    +
    Parameters:
    classLoader - a ClassLoader value
    +
    +
    +
    + +

    +getAntlibClassLoader

    +
    +public java.lang.ClassLoader getAntlibClassLoader()
    +
    +
    The current antlib classloader +

    +

    + +
    Returns:
    the antlib classloader for the definition, this + is null if the definition is not used in an antlib.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.Option.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.Option.html new file mode 100644 index 000000000..9dc8b998f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.Option.html @@ -0,0 +1,323 @@ + + + + + + +Apt.Option (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Apt.Option

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Apt.Option
+
    +
    +
    Enclosing class:
    Apt
    +
    +
    +
    +
    public static final class Apt.Option
    extends java.lang.Object
    + + +

    +The nested option element. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Apt.Option() + +
    +          Constructor for Option
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the name attribute.
    + java.lang.StringgetValue() + +
    +          Get the value attribute.
    + voidsetName(java.lang.String name) + +
    +          Set the name attribute.
    + voidsetValue(java.lang.String value) + +
    +          Set the value attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Apt.Option

    +
    +public Apt.Option()
    +
    +
    Constructor for Option +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name attribute. +

    +

    + +
    Returns:
    the name attribute.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name attribute. +

    +

    +
    Parameters:
    name - the name of the option.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the value attribute. +

    +

    + +
    Returns:
    the value attribute.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the value attribute. +

    +

    +
    Parameters:
    value - the value of the option.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.html new file mode 100644 index 000000000..bd3de94b0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Apt.html @@ -0,0 +1,818 @@ + + + + + + +Apt (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Apt

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Javac
+                  extended by org.apache.tools.ant.taskdefs.Apt
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Apt
    extends Javac
    + + +

    +Apt Task for running the Annotation processing tool for JDK 1.5. It derives + from the existing Javac task, and forces the compiler based on whether we're + executing internally, or externally. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classApt.Option + +
    +          The nested option element.
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Javac
    Javac.ImplementationSpecificArgument
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_IGNORING_COMPILER_OPTION + +
    +          An warning message when ignoring compiler attribute.
    +static java.lang.StringERROR_WRONG_JAVA_VERSION + +
    +          A warning message if used with java < 1.5.
    +static java.lang.StringEXECUTABLE_NAME + +
    +          The name of the apt tool.
    +static java.lang.StringWARNING_IGNORING_FORK + +
    +          exposed for debug messages
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Javac
    compileList, failOnError, listFiles
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Apt() + +
    +          Construtor for Apt task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateFactoryPath() + +
    +          Add a path to the factoryPath attribute.
    + Apt.OptioncreateOption() + +
    +          Create a nested option.
    + voidexecute() + +
    +          Do the compilation.
    + java.lang.StringgetAptExecutable() + +
    +          Get the name of the apt executable.
    + java.lang.StringgetCompiler() + +
    +          Get the compiler class name.
    + java.lang.StringgetFactory() + +
    +          Get the factory option for the apt compiler.
    + PathgetFactoryPath() + +
    +          Get the factory path attribute.
    + java.util.VectorgetOptions() + +
    +          Get the options to the compiler.
    + java.io.FilegetPreprocessDir() + +
    +          Get the preprocessdir attribute.
    + booleanisCompile() + +
    +          Get the compile option for the apt compiler.
    + voidsetCompile(boolean compile) + +
    +          Set the compile option for the apt compiler.
    + voidsetCompiler(java.lang.String compiler) + +
    +          Set the compiler.
    + voidsetFactory(java.lang.String factory) + +
    +          Set the factory option for the apt compiler.
    + voidsetFactoryPathRef(Reference ref) + +
    +          Add a reference to a path to the factoryPath attribute.
    + voidsetFork(boolean fork) + +
    +          Set the fork attribute.
    + voidsetPreprocessDir(java.io.File preprocessDir) + +
    +          Set the preprocessdir attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Javac
    add, checkParameters, compile, createBootclasspath, createClasspath, createCompilerArg, createCompilerClasspath, createExtdirs, createSourcepath, createSrc, getBootclasspath, getClasspath, getCompilerVersion, getCurrentCompilerArgs, getDebug, getDebugLevel, getDepend, getDeprecation, getDestdir, getEncoding, getExecutable, getExtdirs, getFailonerror, getFileList, getIncludeantruntime, getIncludejavaruntime, getJavacExecutable, getListfiles, getMemoryInitialSize, getMemoryMaximumSize, getNowarn, getOptimize, getSource, getSourcepath, getSrcdir, getSystemJavac, getTarget, getTaskSuccess, getTempdir, getVerbose, isForkedJavac, isIncludeDestClasses, isJdkCompiler, recreateSrc, resetFileLists, scanDir, setBootclasspath, setBootClasspathRef, setClasspath, setClasspathRef, setDebug, setDebugLevel, setDepend, setDeprecation, setDestdir, setEncoding, setErrorProperty, setExecutable, setExtdirs, setFailonerror, setIncludeantruntime, setIncludeDestClasses, setIncludejavaruntime, setListfiles, setMemoryInitialSize, setMemoryMaximumSize, setNowarn, setOptimize, setProceed, setSource, setSourcepath, setSourcepathRef, setSrcdir, setTarget, setTempdir, setUpdatedProperty, setVerbose
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +EXECUTABLE_NAME

    +
    +public static final java.lang.String EXECUTABLE_NAME
    +
    +
    The name of the apt tool. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_IGNORING_COMPILER_OPTION

    +
    +public static final java.lang.String ERROR_IGNORING_COMPILER_OPTION
    +
    +
    An warning message when ignoring compiler attribute. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_WRONG_JAVA_VERSION

    +
    +public static final java.lang.String ERROR_WRONG_JAVA_VERSION
    +
    +
    A warning message if used with java < 1.5. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +WARNING_IGNORING_FORK

    +
    +public static final java.lang.String WARNING_IGNORING_FORK
    +
    +
    exposed for debug messages +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Apt

    +
    +public Apt()
    +
    +
    Construtor for Apt task. + This sets the apt compiler adapter as the compiler in the super class. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getAptExecutable

    +
    +public java.lang.String getAptExecutable()
    +
    +
    Get the name of the apt executable. +

    +

    + +
    Returns:
    the name of the executable.
    +
    +
    +
    + +

    +setCompiler

    +
    +public void setCompiler(java.lang.String compiler)
    +
    +
    Set the compiler. + This is not allowed and a warning log message is made. +

    +

    +
    Overrides:
    setCompiler in class Javac
    +
    +
    +
    Parameters:
    compiler - not used.
    +
    +
    +
    + +

    +setFork

    +
    +public void setFork(boolean fork)
    +
    +
    Set the fork attribute. + Non-forking APT is highly classpath dependent and appears to be too + brittle to work. The sole reason this attribute is retained + is the superclass does it +

    +

    +
    Overrides:
    setFork in class Javac
    +
    +
    +
    Parameters:
    fork - if false; warn the option is ignored.
    +
    +
    +
    + +

    +getCompiler

    +
    +public java.lang.String getCompiler()
    +
    +
    Get the compiler class name. +

    +

    +
    Overrides:
    getCompiler in class Javac
    +
    +
    + +
    Returns:
    the compiler class name.
    See Also:
    Javac.getCompilerVersion()
    +
    +
    +
    + +

    +isCompile

    +
    +public boolean isCompile()
    +
    +
    Get the compile option for the apt compiler. + If this is false the "-nocompile" argument will be used. +

    +

    + +
    Returns:
    the value of the compile option.
    +
    +
    +
    + +

    +setCompile

    +
    +public void setCompile(boolean compile)
    +
    +
    Set the compile option for the apt compiler. + Default value is true. +

    +

    +
    Parameters:
    compile - if true set the compile option.
    +
    +
    +
    + +

    +getFactory

    +
    +public java.lang.String getFactory()
    +
    +
    Get the factory option for the apt compiler. + If this is non-null the "-factory" argument will be used. +

    +

    + +
    Returns:
    the value of the factory option.
    +
    +
    +
    + +

    +setFactory

    +
    +public void setFactory(java.lang.String factory)
    +
    +
    Set the factory option for the apt compiler. + Default value is null. +

    +

    +
    Parameters:
    factory - the classname of the factory.
    +
    +
    +
    + +

    +setFactoryPathRef

    +
    +public void setFactoryPathRef(Reference ref)
    +
    +
    Add a reference to a path to the factoryPath attribute. +

    +

    +
    Parameters:
    ref - a reference to a path.
    +
    +
    +
    + +

    +createFactoryPath

    +
    +public Path createFactoryPath()
    +
    +
    Add a path to the factoryPath attribute. +

    +

    + +
    Returns:
    a path to be configured.
    +
    +
    +
    + +

    +getFactoryPath

    +
    +public Path getFactoryPath()
    +
    +
    Get the factory path attribute. + If this is not null, the "-factorypath" argument will be used. + The default value is null. +

    +

    + +
    Returns:
    the factory path attribute.
    +
    +
    +
    + +

    +createOption

    +
    +public Apt.Option createOption()
    +
    +
    Create a nested option. +

    +

    + +
    Returns:
    an option to be configured.
    +
    +
    +
    + +

    +getOptions

    +
    +public java.util.Vector getOptions()
    +
    +
    Get the options to the compiler. + Each option will use '"-E" name ["=" value]' argument. +

    +

    + +
    Returns:
    the options.
    +
    +
    +
    + +

    +getPreprocessDir

    +
    +public java.io.File getPreprocessDir()
    +
    +
    Get the preprocessdir attribute. + This corresponds to the "-s" argument. + The default value is null. +

    +

    + +
    Returns:
    the preprocessdir attribute.
    +
    +
    +
    + +

    +setPreprocessDir

    +
    +public void setPreprocessDir(java.io.File preprocessDir)
    +
    +
    Set the preprocessdir attribute. +

    +

    +
    Parameters:
    preprocessDir - where to place processor generated source files.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the compilation. +

    +

    +
    Overrides:
    execute in class Javac
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AugmentReference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AugmentReference.html new file mode 100644 index 000000000..d42d5cbfb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/AugmentReference.html @@ -0,0 +1,374 @@ + + + + + + +AugmentReference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class AugmentReference

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AugmentReference
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TypeAdapter
    +
    +
    +
    +
    public class AugmentReference
    extends Task
    implements TypeAdapter
    + + +

    +Ant task to dynamically augment a previously declared reference. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AugmentReference() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckProxyClass(java.lang.Class proxyClass) + +
    +          Check if the proxy class is compatible with this adapter - i.e.
    + java.lang.ObjectgetProxy() + +
    +          Returns the proxy object.
    + voidsetProxy(java.lang.Object o) + +
    +          Sets the proxy object, whose methods are going to be + invoked by ant.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.TypeAdapter
    getProject, setProject
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AugmentReference

    +
    +public AugmentReference()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +checkProxyClass

    +
    +public void checkProxyClass(java.lang.Class proxyClass)
    +
    +
    Check if the proxy class is compatible with this adapter - i.e. + the adapter will be able to adapt instances of the give class. +

    +

    +
    Specified by:
    checkProxyClass in interface TypeAdapter
    +
    +
    +
    Parameters:
    proxyClass - the class to be checked.
    +
    +
    +
    + +

    +getProxy

    +
    +public java.lang.Object getProxy()
    +
    +
    Returns the proxy object. +

    +

    +
    Specified by:
    getProxy in interface TypeAdapter
    +
    +
    + +
    Returns:
    the target proxy object
    +
    +
    +
    + +

    +setProxy

    +
    +public void setProxy(java.lang.Object o)
    +
    +
    Sets the proxy object, whose methods are going to be + invoked by ant. + A proxy object is normally the object defined by + a <typedef/> task that is adapted by the "adapter" + attribute. +

    +

    +
    Specified by:
    setProxy in interface TypeAdapter
    +
    +
    +
    Parameters:
    o - The target object. Must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.FileDir.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.FileDir.html new file mode 100644 index 000000000..12dbbfa55 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.FileDir.html @@ -0,0 +1,335 @@ + + + + + + +Available.FileDir (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Available.FileDir

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Available.FileDir
+
    +
    +
    Enclosing class:
    Available
    +
    +
    +
    +
    public static class Available.FileDir
    extends EnumeratedAttribute
    + + +

    +EnumeratedAttribute covering the file types to be checked for, either + file or dir. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Available.FileDir() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    + booleanisDir() + +
    +          Indicate if the value specifies a directory.
    + booleanisFile() + +
    +          Indicate if the value specifies a file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Available.FileDir

    +
    +public Available.FileDir()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +isDir

    +
    +public boolean isDir()
    +
    +
    Indicate if the value specifies a directory. +

    +

    + +
    Returns:
    true if the value specifies a directory.
    +
    +
    +
    + +

    +isFile

    +
    +public boolean isFile()
    +
    +
    Indicate if the value specifies a file. +

    +

    + +
    Returns:
    true if the value specifies a file.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.html new file mode 100644 index 000000000..4de0a8a16 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Available.html @@ -0,0 +1,750 @@ + + + + + + +Available (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Available

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Available
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Available
    extends Task
    implements Condition
    + + +

    +Will set the given property if the requested resource is available at + runtime. This task may also be used as a condition by the condition task. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classAvailable.FileDir + +
    +          EnumeratedAttribute covering the file types to be checked for, either + file or dir.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Available() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateClasspath() + +
    +          Classpath to be used when searching for classes and resources.
    + PathcreateFilepath() + +
    +          Path to search for file resources.
    + booleaneval() + +
    +          Evaluate the availability of a resource.
    + voidexecute() + +
    +          Entry point when operating as a task.
    + voidsetClassname(java.lang.String classname) + +
    +          Set a classname of a class which must be available to set the given + property.
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used when searching for classes and resources.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath by reference.
    + voidsetFile(java.io.File file) + +
    +          Set the file which must be present in the file system to set the given + property.
    + voidsetFilepath(Path filepath) + +
    +          Set the path to use when looking for a file.
    + voidsetIgnoresystemclasses(boolean ignore) + +
    +          Set whether the search for classes should ignore the runtime classes and + just use the given classpath.
    + voidsetProperty(java.lang.String property) + +
    +          Set the name of the property which will be set if the particular resource + is available.
    + voidsetResource(java.lang.String resource) + +
    +          Set the name of a Java resource which is required to set the property.
    + voidsetSearchParents(boolean searchParents) + +
    +          Set the searchParents attribute.
    + voidsetType(Available.FileDir type) + +
    +          Set what type of file is required - either directory or file.
    + voidsetType(java.lang.String type) + +
    +          Deprecated. since 1.5.x. + setType(String) is deprecated and is replaced with + setType(Available.FileDir) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class.
    + voidsetValue(java.lang.Object value) + +
    +          Set the value to be given to the property if the desired resource is + available.
    + voidsetValue(java.lang.String value) + +
    +          Set the value to be given to the property if the desired resource is + available.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Available

    +
    +public Available()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSearchParents

    +
    +public void setSearchParents(boolean searchParents)
    +
    +
    Set the searchParents attribute. + This controls the behaviour of the the "file" type. + If true, the path, parent path and grandparent path are + searched for the file. If false, only the path is seached. + The default value is false. +

    +

    +
    +
    +
    +
    Parameters:
    searchParents - the value to set.
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used when searching for classes and resources. +

    +

    +
    +
    +
    +
    Parameters:
    classpath - an Ant Path object containing the search path.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Classpath to be used when searching for classes and resources. +

    +

    +
    +
    +
    + +
    Returns:
    an empty Path instance to be configured by Ant.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath by reference. +

    +

    +
    +
    +
    +
    Parameters:
    r - a Reference to a Path instance to be used as the classpath + value.
    +
    +
    +
    + +

    +setFilepath

    +
    +public void setFilepath(Path filepath)
    +
    +
    Set the path to use when looking for a file. +

    +

    +
    +
    +
    +
    Parameters:
    filepath - a Path instance containing the search path for files.
    +
    +
    +
    + +

    +createFilepath

    +
    +public Path createFilepath()
    +
    +
    Path to search for file resources. +

    +

    +
    +
    +
    + +
    Returns:
    a new Path instance which Ant will configure with a file search + path.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Set the name of the property which will be set if the particular resource + is available. +

    +

    +
    +
    +
    +
    Parameters:
    property - the name of the property to set.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.Object value)
    +
    +
    Set the value to be given to the property if the desired resource is + available. +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to be given.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the value to be given to the property if the desired resource is + available. +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to be given.
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String classname)
    +
    +
    Set a classname of a class which must be available to set the given + property. +

    +

    +
    +
    +
    +
    Parameters:
    classname - the name of the class required.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set the file which must be present in the file system to set the given + property. +

    +

    +
    +
    +
    +
    Parameters:
    file - the name of the file which is required.
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String resource)
    +
    +
    Set the name of a Java resource which is required to set the property. +

    +

    +
    +
    +
    +
    Parameters:
    resource - the name of a resource which is required to be available.
    +
    +
    +
    + +

    +setType

    +
    +public void setType(java.lang.String type)
    +
    +
    Deprecated. since 1.5.x. + setType(String) is deprecated and is replaced with + setType(Available.FileDir) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +

    +

    +
    +
    +
    +
    Parameters:
    type - the type of resource
    +
    +
    +
    + +

    +setType

    +
    +public void setType(Available.FileDir type)
    +
    +
    Set what type of file is required - either directory or file. +

    +

    +
    +
    +
    +
    Parameters:
    type - an instance of the FileDir enumeratedAttribute indicating + whether the file required is to be a directory or a plain + file.
    +
    +
    +
    + +

    +setIgnoresystemclasses

    +
    +public void setIgnoresystemclasses(boolean ignore)
    +
    +
    Set whether the search for classes should ignore the runtime classes and + just use the given classpath. +

    +

    +
    +
    +
    +
    Parameters:
    ignore - true if system classes are to be ignored.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Entry point when operating as a task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the task is not configured correctly.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluate the availability of a resource. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    boolean is the resource is available. +
    Throws: +
    BuildException - if the condition is not configured correctly
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BUnzip2.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BUnzip2.html new file mode 100644 index 000000000..79515d64e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BUnzip2.html @@ -0,0 +1,389 @@ + + + + + + +BUnzip2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class BUnzip2

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Unpack
+              extended by org.apache.tools.ant.taskdefs.BUnzip2
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class BUnzip2
    extends Unpack
    + + +

    +Expands a file that has been compressed with the BZIP2 + algorithm. Normally used to compress non-compressed archives such + as TAR files. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Unpack
    dest, source, srcResource
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    BUnzip2() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidextract() + +
    +          Do the unbzipping.
    +protected  java.lang.StringgetDefaultExtension() + +
    +          Get the default extension.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Unpack
    addConfigured, execute, setDest, setDest, setSrc, setSrc, setSrcResource
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BUnzip2

    +
    +public BUnzip2()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getDefaultExtension

    +
    +protected java.lang.String getDefaultExtension()
    +
    +
    Get the default extension. +

    +

    +
    Specified by:
    getDefaultExtension in class Unpack
    +
    +
    + +
    Returns:
    the string ".bz2"
    +
    +
    +
    + +

    +extract

    +
    +protected void extract()
    +
    +
    Do the unbzipping. +

    +

    +
    Specified by:
    extract in class Unpack
    +
    +
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <gunzip>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    +
    Overrides:
    supportsNonFileResources in class Unpack
    +
    +
    + +
    Returns:
    true if this class supports non file resources.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BZip2.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BZip2.html new file mode 100644 index 000000000..d995bf01f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BZip2.html @@ -0,0 +1,363 @@ + + + + + + +BZip2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class BZip2

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Pack
+              extended by org.apache.tools.ant.taskdefs.BZip2
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class BZip2
    extends Pack
    + + +

    +Compresses a file with the BZIP2 algorithm. Normally used to compress + non-compressed archives such as TAR files. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Pack
    source, zipFile
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    BZip2() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidpack() + +
    +          Compress the zipFile.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Pack
    addConfigured, execute, getSrcResource, setDestfile, setSrc, setSrcResource, setZipfile, zipFile, zipResource
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BZip2

    +
    +public BZip2()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +pack

    +
    +protected void pack()
    +
    +
    Compress the zipFile. +

    +

    +
    Specified by:
    pack in class Pack
    +
    +
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <bzip2>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    +
    Overrides:
    supportsNonFileResources in class Pack
    +
    +
    + +
    Returns:
    true if this task support non file resources.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Basename.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Basename.html new file mode 100644 index 000000000..b9d4f8606 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Basename.html @@ -0,0 +1,396 @@ + + + + + + +Basename (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Basename

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Basename
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Basename
    extends Task
    + + +

    +Sets a property to the base name of a specified file, optionally minus a + suffix. + + This task can accept the following attributes: +

      +
    • file +
    • property +
    • suffix +
    + The file and property attributes are required. The + suffix attribute can be specified either with or without + the ".", and the result will be the same (ie., the + returned file name will be minus the .suffix). +

    + When this task executes, it will set the specified property to the + value of the last element in the specified file. If file is a + directory, the basename will be the last directory element. If file + is a full-path filename, the basename will be the simple file name. + If a suffix is specified, and the specified file ends in that suffix, + the basename will be the simple file name without the suffix. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Basename() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          do the work
    + voidsetFile(java.io.File file) + +
    +          file or directory to get base name from
    + voidsetProperty(java.lang.String property) + +
    +          Property to set base name to.
    + voidsetSuffix(java.lang.String suffix) + +
    +          Optional suffix to remove from base name.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Basename

    +
    +public Basename()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    file or directory to get base name from +

    +

    +
    Parameters:
    file - file or directory to get base name from
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Property to set base name to. +

    +

    +
    Parameters:
    property - name of property
    +
    +
    +
    + +

    +setSuffix

    +
    +public void setSuffix(java.lang.String suffix)
    +
    +
    Optional suffix to remove from base name. +

    +

    +
    Parameters:
    suffix - suffix to remove from base name
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    do the work +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if required attributes are not supplied + property and attribute are required attributes
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BindTargets.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BindTargets.html new file mode 100644 index 000000000..6c36ef343 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BindTargets.html @@ -0,0 +1,390 @@ + + + + + + +BindTargets (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class BindTargets

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.BindTargets
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class BindTargets
    extends Task
    + + +

    +Simple task which bind some targets to some defined extension point +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    BindTargets() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Called by the project to let the task do its work.
    + voidsetExtensionPoint(java.lang.String extensionPoint) + +
    +           
    + voidsetOnMissingExtensionPoint(ProjectHelper.OnMissingExtensionPoint onMissingExtensionPoint) + +
    +           
    + voidsetOnMissingExtensionPoint(java.lang.String onMissingExtensionPoint) + +
    +           
    + voidsetTargets(java.lang.String target) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BindTargets

    +
    +public BindTargets()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setExtensionPoint

    +
    +public void setExtensionPoint(java.lang.String extensionPoint)
    +
    +
    +
    +
    +
    +
    + +

    +setOnMissingExtensionPoint

    +
    +public void setOnMissingExtensionPoint(java.lang.String onMissingExtensionPoint)
    +
    +
    +
    +
    +
    +
    + +

    +setOnMissingExtensionPoint

    +
    +public void setOnMissingExtensionPoint(ProjectHelper.OnMissingExtensionPoint onMissingExtensionPoint)
    +
    +
    +
    +
    +
    +
    + +

    +setTargets

    +
    +public void setTargets(java.lang.String target)
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Description copied from class: Task
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BuildNumber.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BuildNumber.html new file mode 100644 index 000000000..401e4bf31 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/BuildNumber.html @@ -0,0 +1,340 @@ + + + + + + +BuildNumber (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class BuildNumber

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.BuildNumber
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class BuildNumber
    extends Task
    + + +

    +Read, increment, and write a build number in a file + It will first + attempt to read a build number from a file, then set the property + "build.number" to the value that was read in (or 0 if no such value). Then + it will increment the build number by one and write it back out into the + file. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    BuildNumber() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Run task.
    + voidsetFile(java.io.File file) + +
    +          The file in which the build number is stored.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +BuildNumber

    +
    +public BuildNumber()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    The file in which the build number is stored. Defaults to + "build.number" if not specified. +

    +

    +
    Parameters:
    file - the file in which build number is stored.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Run task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CVSPass.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CVSPass.html new file mode 100644 index 000000000..90f509833 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CVSPass.html @@ -0,0 +1,378 @@ + + + + + + +CVSPass (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class CVSPass

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.CVSPass
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class CVSPass
    extends Task
    + + +

    +Adds an new entry to a CVS password file. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CVSPass() + +
    +          Create a CVS task using the default cvspass file location.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Does the work.
    + voidsetCvsroot(java.lang.String cvsRoot) + +
    +          The CVS repository to add an entry for.
    + voidsetPassfile(java.io.File passFile) + +
    +          Password file to add the entry to.
    + voidsetPassword(java.lang.String password) + +
    +          Password to be added to the password file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CVSPass

    +
    +public CVSPass()
    +
    +
    Create a CVS task using the default cvspass file location. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public final void execute()
+                   throws BuildException
    +
    +
    Does the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +setCvsroot

    +
    +public void setCvsroot(java.lang.String cvsRoot)
    +
    +
    The CVS repository to add an entry for. +

    +

    +
    Parameters:
    cvsRoot - the CVS repository
    +
    +
    +
    + +

    +setPassfile

    +
    +public void setPassfile(java.io.File passFile)
    +
    +
    Password file to add the entry to. +

    +

    +
    Parameters:
    passFile - the password file.
    +
    +
    +
    + +

    +setPassword

    +
    +public void setPassword(java.lang.String password)
    +
    +
    Password to be added to the password file. +

    +

    +
    Parameters:
    password - the password.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CallTarget.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CallTarget.html new file mode 100644 index 000000000..d1a82e9f8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CallTarget.html @@ -0,0 +1,662 @@ + + + + + + +CallTarget (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class CallTarget

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.CallTarget
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class CallTarget
    extends Task
    + + +

    +Call another target in the same project. + + 

    +    <target name="foo">
+      <antcall target="bar">
+        <param name="property1" value="aaaaa" />
+        <param name="foo" value="baz" />
+       </antcall>
+    </target>
+
+    <target name="bar" depends="init">
+      <echo message="prop is ${property1} ${foo}" />
+    </target>
+
    + +

    This only works as expected if neither property1 nor foo are + defined in the project itself. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CallTarget() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredTarget(Ant.TargetElement t) + +
    +          Add a target to the list of targets to invoke.
    + voidaddPropertyset(PropertySet ps) + +
    +          Set of properties to pass to the new project.
    + voidaddReference(Ant.Reference r) + +
    +          Reference element identifying a data type to carry + over to the invoked target.
    + PropertycreateParam() + +
    +          Create a new Property to pass to the invoked target(s).
    + voidexecute() + +
    +          Delegate the work to the ant task instance, after setting it up.
    + voidhandleErrorFlush(java.lang.String output) + +
    +          Handle error output.
    + voidhandleErrorOutput(java.lang.String output) + +
    +          Handle error output.
    + voidhandleFlush(java.lang.String output) + +
    +          Handles output.
    + inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Handles input.
    + voidhandleOutput(java.lang.String output) + +
    +          Handles output.
    + voidinit() + +
    +          Initialize this task by creating new instance of the ant task and + configuring it by calling its own init method.
    + voidsetInheritAll(boolean inherit) + +
    +          If true, pass all properties to the new Ant project.
    + voidsetInheritRefs(boolean inheritRefs) + +
    +          If true, pass all references to the new Ant project.
    + voidsetTarget(java.lang.String target) + +
    +          Set target to execute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CallTarget

    +
    +public CallTarget()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setInheritAll

    +
    +public void setInheritAll(boolean inherit)
    +
    +
    If true, pass all properties to the new Ant project. + Defaults to true. +

    +

    +
    Parameters:
    inherit - boolean flag.
    +
    +
    +
    + +

    +setInheritRefs

    +
    +public void setInheritRefs(boolean inheritRefs)
    +
    +
    If true, pass all references to the new Ant project. + Defaults to false. +

    +

    +
    Parameters:
    inheritRefs - boolean flag.
    +
    +
    +
    + +

    +init

    +
    +public void init()
    +
    +
    Initialize this task by creating new instance of the ant task and + configuring it by calling its own init method. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Delegate the work to the ant task instance, after setting it up. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on validation failure or if the target didn't + execute.
    +
    +
    +
    + +

    +createParam

    +
    +public Property createParam()
    +
    +
    Create a new Property to pass to the invoked target(s). +

    +

    + +
    Returns:
    a Property object.
    +
    +
    +
    + +

    +addReference

    +
    +public void addReference(Ant.Reference r)
    +
    +
    Reference element identifying a data type to carry + over to the invoked target. +

    +

    +
    Parameters:
    r - the specified Ant.Reference.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addPropertyset

    +
    +public void addPropertyset(PropertySet ps)
    +
    +
    Set of properties to pass to the new project. +

    +

    +
    Parameters:
    ps - the PropertySet to pass.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setTarget

    +
    +public void setTarget(java.lang.String target)
    +
    +
    Set target to execute. +

    +

    +
    Parameters:
    target - the name of the target to execute.
    +
    +
    +
    + +

    +addConfiguredTarget

    +
    +public void addConfiguredTarget(Ant.TargetElement t)
    +
    +
    Add a target to the list of targets to invoke. +

    +

    +
    Parameters:
    t - Ant.TargetElement representing the target.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +handleOutput

    +
    +public void handleOutput(java.lang.String output)
    +
    +
    Handles output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleOutput in class Task
    +
    +
    +
    Parameters:
    output - The string output to output.
    Since:
    +
    Ant 1.5
    +
    See Also:
    Task.handleOutput(String)
    +
    +
    +
    + +

    +handleInput

    +
    +public int handleInput(byte[] buffer,
+                       int offset,
+                       int length)
+                throws java.io.IOException
    +
    +
    Handles input. + Deleate to the created project, if present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleInput in class Task
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    See Also:
    Task.handleInput(byte[], int, int)
    +
    +
    +
    + +

    +handleFlush

    +
    +public void handleFlush(java.lang.String output)
    +
    +
    Handles output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleFlush in class Task
    +
    +
    +
    Parameters:
    output - The string to output.
    Since:
    +
    Ant 1.5.2
    +
    See Also:
    Task.handleFlush(String)
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +public void handleErrorOutput(java.lang.String output)
    +
    +
    Handle error output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleErrorOutput in class Task
    +
    +
    +
    Parameters:
    output - The string to output.
    Since:
    +
    Ant 1.5
    +
    See Also:
    Task.handleErrorOutput(String)
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +public void handleErrorFlush(java.lang.String output)
    +
    +
    Handle error output. + Send it the the new project if is present, otherwise + call the super class. +

    +

    +
    Overrides:
    handleErrorFlush in class Task
    +
    +
    +
    Parameters:
    output - The string to output.
    Since:
    +
    Ant 1.5.2
    +
    See Also:
    Task.handleErrorFlush(String)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.FormatElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.FormatElement.html new file mode 100644 index 000000000..57293c00b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.FormatElement.html @@ -0,0 +1,338 @@ + + + + + + +Checksum.FormatElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Checksum.FormatElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Checksum.FormatElement
+
    +
    +
    Enclosing class:
    Checksum
    +
    +
    +
    +
    public static class Checksum.FormatElement
    extends EnumeratedAttribute
    + + +

    +Helper class for the format attribute. +

    + +

    +

    +
    Since:
    +
    1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Checksum.FormatElement() + +
    +          Constructor for FormatElement
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static Checksum.FormatElementgetDefault() + +
    +          Get the default value - CHECKSUM.
    + java.text.MessageFormatgetFormat() + +
    +          Convert this enumerated type to a MessageFormat.
    + java.lang.String[]getValues() + +
    +          Get the valid values.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Checksum.FormatElement

    +
    +public Checksum.FormatElement()
    +
    +
    Constructor for FormatElement +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getDefault

    +
    +public static Checksum.FormatElement getDefault()
    +
    +
    Get the default value - CHECKSUM. +

    +

    + +
    Returns:
    the defaul value.
    +
    +
    +
    + +

    +getFormat

    +
    +public java.text.MessageFormat getFormat()
    +
    +
    Convert this enumerated type to a MessageFormat. +

    +

    + +
    Returns:
    a MessageFormat object.
    +
    +
    +
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get the valid values. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array of values.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.html new file mode 100644 index 000000000..b20ad563c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Checksum.html @@ -0,0 +1,773 @@ + + + + + + +Checksum (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Checksum

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Checksum
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition, SelectorContainer
    +
    +
    +
    +
    public class Checksum
    extends MatchingTask
    implements Condition
    + + +

    +Used to create or verify file checksums. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classChecksum.FormatElement + +
    +          Helper class for the format attribute.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Checksum() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Add a resource collection.
    + voidaddFileset(FileSet set) + +
    +          Files to generate checksums for.
    +static byte[]decodeHex(char[] data) + +
    +          Converts an array of characters representing hexadecimal values into an + array of bytes of those same values.
    + booleaneval() + +
    +          Calculate the checksum(s)
    + voidexecute() + +
    +          Calculate the checksum(s).
    + voidsetAlgorithm(java.lang.String algorithm) + +
    +          Specifies the algorithm to be used to compute the checksum.
    + voidsetFile(java.io.File file) + +
    +          Sets the file for which the checksum is to be calculated.
    + voidsetFileext(java.lang.String fileext) + +
    +          Sets the file extension that is be to used to + create or identify destination file.
    + voidsetForceOverwrite(boolean forceOverwrite) + +
    +          Whether or not to overwrite existing file irrespective of + whether it is newer than + the source file.
    + voidsetFormat(Checksum.FormatElement e) + +
    +          Select the in/output pattern via a well know format name.
    + voidsetPattern(java.lang.String p) + +
    +          Specify the pattern to use as a MessageFormat pattern.
    + voidsetProperty(java.lang.String property) + +
    +          Sets the property to hold the generated checksum.
    + voidsetProvider(java.lang.String provider) + +
    +          Sets the MessageDigest algorithm provider to be used + to calculate the checksum.
    + voidsetReadBufferSize(int size) + +
    +          The size of the read buffer to use.
    + voidsetTodir(java.io.File todir) + +
    +          Sets the root directory where checksum files will be + written/read
    + voidsetTotalproperty(java.lang.String totalproperty) + +
    +          Sets the property to hold the generated total checksum + for all files.
    + voidsetVerifyproperty(java.lang.String verifyProperty) + +
    +          Sets the verify property.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Checksum

    +
    +public Checksum()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Sets the file for which the checksum is to be calculated. +

    +

    +
    +
    +
    +
    Parameters:
    file - a File value
    +
    +
    +
    + +

    +setTodir

    +
    +public void setTodir(java.io.File todir)
    +
    +
    Sets the root directory where checksum files will be + written/read +

    +

    +
    +
    +
    +
    Parameters:
    todir - the directory to write to
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setAlgorithm

    +
    +public void setAlgorithm(java.lang.String algorithm)
    +
    +
    Specifies the algorithm to be used to compute the checksum. + Defaults to "MD5". Other popular algorithms like "SHA" may be used as well. +

    +

    +
    +
    +
    +
    Parameters:
    algorithm - a String value
    +
    +
    +
    + +

    +setProvider

    +
    +public void setProvider(java.lang.String provider)
    +
    +
    Sets the MessageDigest algorithm provider to be used + to calculate the checksum. +

    +

    +
    +
    +
    +
    Parameters:
    provider - a String value
    +
    +
    +
    + +

    +setFileext

    +
    +public void setFileext(java.lang.String fileext)
    +
    +
    Sets the file extension that is be to used to + create or identify destination file. +

    +

    +
    +
    +
    +
    Parameters:
    fileext - a String value
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Sets the property to hold the generated checksum. +

    +

    +
    +
    +
    +
    Parameters:
    property - a String value
    +
    +
    +
    + +

    +setTotalproperty

    +
    +public void setTotalproperty(java.lang.String totalproperty)
    +
    +
    Sets the property to hold the generated total checksum + for all files. +

    +

    +
    +
    +
    +
    Parameters:
    totalproperty - a String value
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setVerifyproperty

    +
    +public void setVerifyproperty(java.lang.String verifyProperty)
    +
    +
    Sets the verify property. This project property holds + the result of a checksum verification - "true" or "false" +

    +

    +
    +
    +
    +
    Parameters:
    verifyProperty - a String value
    +
    +
    +
    + +

    +setForceOverwrite

    +
    +public void setForceOverwrite(boolean forceOverwrite)
    +
    +
    Whether or not to overwrite existing file irrespective of + whether it is newer than + the source file. Defaults to false. +

    +

    +
    +
    +
    +
    Parameters:
    forceOverwrite - a boolean value
    +
    +
    +
    + +

    +setReadBufferSize

    +
    +public void setReadBufferSize(int size)
    +
    +
    The size of the read buffer to use. +

    +

    +
    +
    +
    +
    Parameters:
    size - an int value
    +
    +
    +
    + +

    +setFormat

    +
    +public void setFormat(Checksum.FormatElement e)
    +
    +
    Select the in/output pattern via a well know format name. +

    +

    +
    +
    +
    +
    Parameters:
    e - an enumerated value
    Since:
    +
    1.7.0
    +
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String p)
    +
    +
    Specify the pattern to use as a MessageFormat pattern. + +

    {0} gets replaced by the checksum, {1} by the filename.

    +

    +

    +
    +
    +
    +
    Parameters:
    p - a String value
    Since:
    +
    1.7.0
    +
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Files to generate checksums for. +

    +

    +
    +
    +
    +
    Parameters:
    set - a fileset of files to generate checksums for.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a resource collection. +

    +

    +
    +
    +
    +
    Parameters:
    rc - the ResourceCollection to add.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Calculate the checksum(s). +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Calculate the checksum(s) +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    Returns true if the checksum verification test passed, + false otherwise. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +decodeHex

    +
    +public static byte[] decodeHex(char[] data)
+                        throws BuildException
    +
    +
    Converts an array of characters representing hexadecimal values into an + array of bytes of those same values. The returned array will be half the + length of the passed array, as it takes two characters to represent any + given byte. An exception is thrown if the passed char array has an odd + number of elements. + + NOTE: This code is copied from jakarta-commons codec. +

    +

    +
    +
    +
    +
    Parameters:
    data - an array of characters representing hexadecimal values +
    Returns:
    the converted array of bytes +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Chmod.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Chmod.html new file mode 100644 index 000000000..55dd5b049 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Chmod.html @@ -0,0 +1,755 @@ + + + + + + +Chmod (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Chmod

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.Chmod
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Chmod
    extends ExecuteOn
    + + +

    +Chmod equivalent for unix-like environments. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    To do:
    +
    Refactor so it does not extend from ExecuteOn and then turn around + and unsupport several attributes.
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    ExecuteOn.FileDirBoth
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
    cmdl, failOnError, newEnvironment, redirector, redirectorElement
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Chmod() + +
    +          Chmod task for setting file and directory permissions.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidcheckConfiguration() + +
    +          Check the attributes and nested elements.
    + PatternSet.NameEntrycreateExclude() + +
    +          Add a name entry on the exclude list.
    + PatternSet.NameEntrycreateInclude() + +
    +          Add a name entry on the include list.
    + PatternSetcreatePatternSet() + +
    +          Add a set of patterns.
    + voidexecute() + +
    +          Carry out the chmoding.
    +protected  booleanisValidOs() + +
    +          Check if the os is valid.
    + voidsetAddsourcefile(boolean b) + +
    +          This is not allowed for Chmod.
    + voidsetCommand(Commandline cmdl) + +
    +          Set the command.
    + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
    +          Sets whether default exclusions should be used or not.
    + voidsetDir(java.io.File src) + +
    +          The directory which holds the files whose permissions must be changed.
    + voidsetExcludes(java.lang.String excludes) + +
    +          Sets the set of exclude patterns.
    + voidsetExecutable(java.lang.String e) + +
    +          Set the executable.
    + voidsetFile(java.io.File src) + +
    +          The file or single directory of which the permissions must be changed.
    + voidsetIncludes(java.lang.String includes) + +
    +          Sets the set of include patterns.
    + voidsetPerm(java.lang.String perm) + +
    +          Set the new permissions.
    + voidsetProject(Project project) + +
    +          Set the project of this task.
    + voidsetSkipEmptyFilesets(boolean skip) + +
    +          This is not allowed for Chmod.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    add, add, addDirset, addFilelist, addFileset, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setType, setupRedirector, setVerbose
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
    addConfiguredRedirector, addEnv, createArg, createWatchdog, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setError, setErrorProperty, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Chmod

    +
    +public Chmod()
    +
    +
    Chmod task for setting file and directory permissions. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set the project of this task. + Calls the super class and sets the project on dhe default FileSet. +

    +

    +
    Overrides:
    setProject in class ProjectComponent
    +
    +
    +
    Parameters:
    project - the project for this task.
    See Also:
    ProjectComponent.setProject(org.apache.tools.ant.Project)
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File src)
    +
    +
    The file or single directory of which the permissions must be changed. +

    +

    +
    Parameters:
    src - the source file or directory.
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File src)
    +
    +
    The directory which holds the files whose permissions must be changed. +

    +

    +
    Overrides:
    setDir in class ExecTask
    +
    +
    +
    Parameters:
    src - the directory.
    +
    +
    +
    + +

    +setPerm

    +
    +public void setPerm(java.lang.String perm)
    +
    +
    Set the new permissions. +

    +

    +
    Parameters:
    perm - the new permissions.
    +
    +
    +
    + +

    +createInclude

    +
    +public PatternSet.NameEntry createInclude()
    +
    +
    Add a name entry on the include list. +

    +

    + +
    Returns:
    a NameEntry to be configured.
    +
    +
    +
    + +

    +createExclude

    +
    +public PatternSet.NameEntry createExclude()
    +
    +
    Add a name entry on the exclude list. +

    +

    + +
    Returns:
    a nameentry to be configured.
    +
    +
    +
    + +

    +createPatternSet

    +
    +public PatternSet createPatternSet()
    +
    +
    Add a set of patterns. +

    +

    + +
    Returns:
    a patternset to be configured.
    +
    +
    +
    + +

    +setIncludes

    +
    +public void setIncludes(java.lang.String includes)
    +
    +
    Sets the set of include patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    Parameters:
    includes - the string containing the include patterns.
    +
    +
    +
    + +

    +setExcludes

    +
    +public void setExcludes(java.lang.String excludes)
    +
    +
    Sets the set of exclude patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    Parameters:
    excludes - the string containing the exclude patterns.
    +
    +
    +
    + +

    +setDefaultexcludes

    +
    +public void setDefaultexcludes(boolean useDefaultExcludes)
    +
    +
    Sets whether default exclusions should be used or not. +

    +

    +
    Parameters:
    useDefaultExcludes - "true"|"on"|"yes" when default exclusions + should be used, "false"|"off"|"no" when they + shouldn't be used.
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
    +
    +
    Check the attributes and nested elements. +

    +

    +
    Overrides:
    checkConfiguration in class ExecuteOn
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Carry out the chmoding. +

    +

    +
    Overrides:
    execute in class ExecTask
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String e)
    +
    +
    Set the executable. + This is not allowed for Chmod. +

    +

    +
    Overrides:
    setExecutable in class ExecTask
    +
    +
    +
    Parameters:
    e - ignored. +
    Throws: +
    BuildException - always.
    +
    +
    +
    + +

    +setCommand

    +
    +public void setCommand(Commandline cmdl)
    +
    +
    Set the command. + This is not allowed for Chmod. +

    +

    +
    Overrides:
    setCommand in class ExecTask
    +
    +
    +
    Parameters:
    cmdl - ignored. +
    Throws: +
    BuildException - always.
    +
    +
    +
    + +

    +setSkipEmptyFilesets

    +
    +public void setSkipEmptyFilesets(boolean skip)
    +
    +
    This is not allowed for Chmod. +

    +

    +
    Overrides:
    setSkipEmptyFilesets in class ExecuteOn
    +
    +
    +
    Parameters:
    skip - ignored. +
    Throws: +
    BuildException - always.
    +
    +
    +
    + +

    +setAddsourcefile

    +
    +public void setAddsourcefile(boolean b)
    +
    +
    This is not allowed for Chmod. +

    +

    +
    Overrides:
    setAddsourcefile in class ExecuteOn
    +
    +
    +
    Parameters:
    b - ignored. +
    Throws: +
    BuildException - always.
    +
    +
    +
    + +

    +isValidOs

    +
    +protected boolean isValidOs()
    +
    +
    Check if the os is valid. + Always include unix. +

    +

    +
    Overrides:
    isValidOs in class ExecTask
    +
    +
    + +
    Returns:
    true if the os is valid.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Classloader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Classloader.html new file mode 100644 index 000000000..36792f6dc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Classloader.html @@ -0,0 +1,542 @@ + + + + + + +Classloader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Classloader

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Classloader
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Classloader
    extends Task
    + + +

    +EXPERIMENTAL + Create or modifies ClassLoader. The required pathRef parameter + will be used to add classpath elements. + + The classpath is a regular path. Currently only file components are + supported (future extensions may allow URLs). + + You can modify the core loader by not specifying any name or using + "ant.coreLoader". (the core loader is used to load system ant + tasks and for taskdefs that don't specify an explicit path). + + Taskdef and typedef can use the loader you create if the name follows + the "ant.loader.NAME" pattern. NAME will be used as a pathref when + calling taskdef. + + This tasks will not modify the core loader if "build.sysclasspath=only" + + The typical use is: + 

    +  <path id="ant.deps" >
+     <fileset dir="myDir" >
+        <include name="junit.jar, bsf.jar, js.jar, etc"/>
+     </fileset>
+  </path>
+
+  <classloader pathRef="ant.deps" />
+
+
    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringSYSTEM_LOADER_REF + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Classloader() + +
    +          Default constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateClasspath() + +
    +          Create a classpath.
    + voidexecute() + +
    +          do the classloader manipulation.
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used when searching for component being defined
    + voidsetClasspathRef(Reference pathRef) + +
    +          Specify which path will be used.
    + voidsetName(java.lang.String name) + +
    +          Name of the loader.
    + voidsetParentFirst(boolean b) + +
    +          Set reverse attribute.
    + voidsetParentName(java.lang.String name) + +
    +          Set the name of the parent.
    + voidsetReset(boolean b) + +
    +          Reset the classloader, if it already exists.
    + voidsetReverse(boolean b) + +
    +          Deprecated. use setParentFirst with a negated argument instead
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +SYSTEM_LOADER_REF

    +
    +public static final java.lang.String SYSTEM_LOADER_REF
    +
    +
    +
    See Also:
    MagicNames.SYSTEM_LOADER_REF, +Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Classloader

    +
    +public Classloader()
    +
    +
    Default constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Name of the loader. If none, the default loader will be modified +

    +

    +
    Parameters:
    name - the name of this loader
    +
    +
    +
    + +

    +setReset

    +
    +public void setReset(boolean b)
    +
    +
    Reset the classloader, if it already exists. A new loader will + be created and all the references to the old one will be removed. + (it is not possible to remove paths from a loader). The new + path will be used. +

    +

    +
    Parameters:
    b - true if the loader is to be reset.
    +
    +
    +
    + +

    +setReverse

    +
    +public void setReverse(boolean b)
    +
    +
    Deprecated. use setParentFirst with a negated argument instead +

    +

    Set reverse attribute. +

    +

    +
    Parameters:
    b - if true reverse the normal classloader lookup.
    +
    +
    +
    + +

    +setParentFirst

    +
    +public void setParentFirst(boolean b)
    +
    +
    Set reverse attribute. +

    +

    +
    Parameters:
    b - if true reverse the normal classloader lookup.
    +
    +
    +
    + +

    +setParentName

    +
    +public void setParentName(java.lang.String name)
    +
    +
    Set the name of the parent. +

    +

    +
    Parameters:
    name - the parent name.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference pathRef)
+                     throws BuildException
    +
    +
    Specify which path will be used. If the loader already exists + and is an AntClassLoader (or any other loader we can extend), + the path will be added to the loader. +

    +

    +
    Parameters:
    pathRef - a reference to a path. +
    Throws: +
    BuildException - if there is a problem.
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used when searching for component being defined +

    +

    +
    Parameters:
    classpath - an Ant Path object containing the classpath.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Create a classpath. +

    +

    + +
    Returns:
    a path for configuration.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    do the classloader manipulation. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CloseResources.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CloseResources.html new file mode 100644 index 000000000..7b5b49438 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CloseResources.html @@ -0,0 +1,335 @@ + + + + + + +CloseResources (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class CloseResources

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.CloseResources
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class CloseResources
    extends Task
    + + +

    +Not a real task but used during tests. + + Closes the resources associated with an URL. In particular this is + going to close the jars associated with a jar:file: URL - and it + does so in a way that the Java VM still thinks it is open, so use + it at your own risk. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CloseResources() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +           
    + voidexecute() + +
    +          Called by the project to let the task do its work.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CloseResources

    +
    +public CloseResources()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Description copied from class: Task
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Componentdef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Componentdef.html new file mode 100644 index 000000000..40e362a75 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Componentdef.html @@ -0,0 +1,334 @@ + + + + + + +Componentdef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Componentdef

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.Definer
+                      extended by org.apache.tools.ant.taskdefs.Componentdef
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Componentdef
    extends Definer
    + + +

    +Adds a compenent definition to the current project. + used in the current project. Two attributes are needed, the name that identifies + this compenent uniquely, and the full name of the class ( + including the packages) that + implements this component.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.8
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Definer
    Definer.Format, Definer.OnError
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Componentdef() + +
    +          Default constructor.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Definer
    addDefinition, execute, getClassname, getFile, getName, getResource, loadProperties, makeResourceFromURI, setAdapter, setAdapterClass, setAdaptTo, setAdaptToClass, setAntlib, setClassname, setFile, setFormat, setName, setOnError, setResource, setRestrict
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
    createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Componentdef

    +
    +public Componentdef()
    +
    +
    Default constructor. + Creates a new ComponentDef instance. + Sets the restrict attribute to true. +

    +

    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.TextElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.TextElement.html new file mode 100644 index 000000000..5569018db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.TextElement.html @@ -0,0 +1,419 @@ + + + + + + +Concat.TextElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Concat.TextElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.Concat.TextElement
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Concat
    +
    +
    +
    +
    public static class Concat.TextElement
    extends ProjectComponent
    + + +

    +sub element points to a file or contains text +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Concat.TextElement() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String value) + +
    +          set the text using inline
    + java.lang.StringgetValue() + +
    +           
    + voidsetEncoding(java.lang.String encoding) + +
    +          The encoding of the text element
    + voidsetFile(java.io.File file) + +
    +          set the text using a file
    + voidsetFiltering(boolean filtering) + +
    +          whether to filter the text in this element + or not.
    + voidsetTrim(boolean trim) + +
    +          whether to call text.trim()
    + voidsetTrimLeading(boolean strip) + +
    +          s:^\s*:: on each line of input
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Concat.TextElement

    +
    +public Concat.TextElement()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFiltering

    +
    +public void setFiltering(boolean filtering)
    +
    +
    whether to filter the text in this element + or not. +

    +

    +
    Parameters:
    filtering - true if the text should be filtered. + the default value is true.
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    The encoding of the text element +

    +

    +
    Parameters:
    encoding - the name of the charset used to encode
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
+             throws BuildException
    +
    +
    set the text using a file +

    +

    +
    Parameters:
    file - the file to use +
    Throws: +
    BuildException - if the file does not exist, or cannot be + read
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String value)
    +
    +
    set the text using inline +

    +

    +
    Parameters:
    value - the text to place inline
    +
    +
    +
    + +

    +setTrimLeading

    +
    +public void setTrimLeading(boolean strip)
    +
    +
    s:^\s*:: on each line of input +

    +

    +
    Parameters:
    strip - if true do the trim
    +
    +
    +
    + +

    +setTrim

    +
    +public void setTrim(boolean trim)
    +
    +
    whether to call text.trim() +

    +

    +
    Parameters:
    trim - if true trim the text
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    + +
    Returns:
    the text, after possible trimming
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.html new file mode 100644 index 000000000..ccaf33068 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Concat.html @@ -0,0 +1,996 @@ + + + + + + +Concat (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Concat

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Concat
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ResourceCollection
    +
    +
    +
    +
    public class Concat
    extends Task
    implements ResourceCollection
    + + +

    +This class contains the 'concat' task, used to concatenate a series + of files into a single stream. The destination of this stream may + be the system console, or a file. The following is a sample + invocation: + + 

    + <concat destfile="${build.dir}/index.xml"
+   append="false">
+
+   <fileset dir="${xml.root.dir}"
+     includes="*.xml" />
+
+ </concat>
+
    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classConcat.TextElement + +
    +          sub element points to a file or contains text
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Concat() + +
    +          Construct a new Concat task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection c) + +
    +          Add an arbitrary ResourceCollection.
    + voidaddFilelist(FileList list) + +
    +          List of files to concatenate.
    + voidaddFileset(FileSet set) + +
    +          Set of files to concatenate.
    + voidaddFilterChain(FilterChain filterChain) + +
    +          Adds a FilterChain.
    + voidaddFooter(Concat.TextElement footerToAdd) + +
    +          Add a footer to the concatenated output
    + voidaddHeader(Concat.TextElement headerToAdd) + +
    +          Add a header to the concatenated output
    + voidaddText(java.lang.String text) + +
    +          This method adds text which appears in the 'concat' element.
    + PathcreatePath() + +
    +          Path of files to concatenate.
    + voidexecute() + +
    +          Execute the concat task.
    + booleanisFilesystemOnly() + +
    +          Implement ResourceCollection.
    + java.util.Iteratoriterator() + +
    +          Implement ResourceCollection.
    + voidreset() + +
    +          Reset state to default.
    + voidsetAppend(boolean append) + +
    +          Sets the behavior when the destination exists.
    + voidsetBinary(boolean binary) + +
    +          Set the binary attribute.
    + voidsetDest(Resource dest) + +
    +          Set the resource to write to.
    + voidsetDestfile(java.io.File destinationFile) + +
    +          Sets the destination file, or uses the console if not specified.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Sets the character encoding
    + voidsetEol(FixCRLF.CrLf crlf) + +
    +          Specify the end of line to find and to add if + not present at end of each input file.
    + voidsetFixLastLine(boolean fixLastLine) + +
    +          Append line.separator to files that do not end + with a line.separator, default false.
    + voidsetForce(boolean forceOverwrite) + +
    +          Deprecated. use #setOverwrite instead
    + voidsetForceReadOnly(boolean f) + +
    +          Whether read-only destinations will be overwritten.
    + voidsetIgnoreEmpty(boolean ignoreEmpty) + +
    +          Sets the behavior when no source resource files are available.
    + voidsetOutputEncoding(java.lang.String outputEncoding) + +
    +          Sets the character encoding for outputting
    + voidsetOverwrite(boolean forceOverwrite) + +
    +          Force overwrite existing destination file
    + voidsetWriter(java.io.Writer outputWriter) + +
    +          Set the output writer.
    + intsize() + +
    +          Implement ResourceCollection.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Concat

    +
    +public Concat()
    +
    +
    Construct a new Concat task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +reset

    +
    +public void reset()
    +
    +
    Reset state to default. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +setDestfile

    +
    +public void setDestfile(java.io.File destinationFile)
    +
    +
    Sets the destination file, or uses the console if not specified. +

    +

    +
    +
    +
    +
    Parameters:
    destinationFile - the destination file
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(Resource dest)
    +
    +
    Set the resource to write to. +

    +

    +
    +
    +
    +
    Parameters:
    dest - the Resource to write to.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    Sets the behavior when the destination exists. If set to + true the task will append the stream data an + Appendable resource; otherwise existing content will be + overwritten. Defaults to false. +

    +

    +
    +
    +
    +
    Parameters:
    append - if true append output.
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Sets the character encoding +

    +

    +
    +
    +
    +
    Parameters:
    encoding - the encoding of the input stream and unless + outputencoding is set, the outputstream.
    +
    +
    +
    + +

    +setOutputEncoding

    +
    +public void setOutputEncoding(java.lang.String outputEncoding)
    +
    +
    Sets the character encoding for outputting +

    +

    +
    +
    +
    +
    Parameters:
    outputEncoding - the encoding for the output file
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean forceOverwrite)
    +
    +
    Deprecated. use #setOverwrite instead +

    +

    Force overwrite existing destination file +

    +

    +
    +
    +
    +
    Parameters:
    forceOverwrite - if true always overwrite, otherwise only + overwrite if the output file is older any of the + input files.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setOverwrite

    +
    +public void setOverwrite(boolean forceOverwrite)
    +
    +
    Force overwrite existing destination file +

    +

    +
    +
    +
    +
    Parameters:
    forceOverwrite - if true always overwrite, otherwise only + overwrite if the output file is older any of the + input files.
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +setForceReadOnly

    +
    +public void setForceReadOnly(boolean f)
    +
    +
    Whether read-only destinations will be overwritten. + +

    Defaults to false

    +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +setIgnoreEmpty

    +
    +public void setIgnoreEmpty(boolean ignoreEmpty)
    +
    +
    Sets the behavior when no source resource files are available. If set to + false the destination file will always be created. + Defaults to true. +

    +

    +
    +
    +
    +
    Parameters:
    ignoreEmpty - if false honour destinationfile creation.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createPath

    +
    +public Path createPath()
    +
    +
    Path of files to concatenate. +

    +

    +
    +
    +
    + +
    Returns:
    the path used for concatenating
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Set of files to concatenate. +

    +

    +
    +
    +
    +
    Parameters:
    set - the set of files
    +
    +
    +
    + +

    +addFilelist

    +
    +public void addFilelist(FileList list)
    +
    +
    List of files to concatenate. +

    +

    +
    +
    +
    +
    Parameters:
    list - the list of files
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection c)
    +
    +
    Add an arbitrary ResourceCollection. +

    +

    +
    +
    +
    +
    Parameters:
    c - the ResourceCollection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addFilterChain

    +
    +public void addFilterChain(FilterChain filterChain)
    +
    +
    Adds a FilterChain. +

    +

    +
    +
    +
    +
    Parameters:
    filterChain - a filterchain to filter the concatenated input
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String text)
    +
    +
    This method adds text which appears in the 'concat' element. +

    +

    +
    +
    +
    +
    Parameters:
    text - the text to be concated.
    +
    +
    +
    + +

    +addHeader

    +
    +public void addHeader(Concat.TextElement headerToAdd)
    +
    +
    Add a header to the concatenated output +

    +

    +
    +
    +
    +
    Parameters:
    headerToAdd - the header
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addFooter

    +
    +public void addFooter(Concat.TextElement footerToAdd)
    +
    +
    Add a footer to the concatenated output +

    +

    +
    +
    +
    +
    Parameters:
    footerToAdd - the footer
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setFixLastLine

    +
    +public void setFixLastLine(boolean fixLastLine)
    +
    +
    Append line.separator to files that do not end + with a line.separator, default false. +

    +

    +
    +
    +
    +
    Parameters:
    fixLastLine - if true make sure each input file has + new line on the concatenated stream
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setEol

    +
    +public void setEol(FixCRLF.CrLf crlf)
    +
    +
    Specify the end of line to find and to add if + not present at end of each input file. This attribute + is used in conjunction with fixlastline. +

    +

    +
    +
    +
    +
    Parameters:
    crlf - the type of new line to add - + cr, mac, lf, unix, crlf, or dos
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setWriter

    +
    +public void setWriter(java.io.Writer outputWriter)
    +
    +
    Set the output writer. This is to allow + concat to be used as a nested element. +

    +

    +
    +
    +
    +
    Parameters:
    outputWriter - the output writer.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setBinary

    +
    +public void setBinary(boolean binary)
    +
    +
    Set the binary attribute. If true, concat will concatenate the files + byte for byte. This mode does not allow any filtering or other + modifications to the input streams. The default value is false. +

    +

    +
    +
    +
    +
    Parameters:
    binary - if true, enable binary mode.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute the concat task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +iterator

    +
    +public java.util.Iterator iterator()
    +
    +
    Implement ResourceCollection. +

    +

    +
    Specified by:
    iterator in interface ResourceCollection
    +
    +
    + +
    Returns:
    Iterator.
    +
    +
    +
    + +

    +size

    +
    +public int size()
    +
    +
    Implement ResourceCollection. +

    +

    +
    Specified by:
    size in interface ResourceCollection
    +
    +
    + +
    Returns:
    1.
    +
    +
    +
    + +

    +isFilesystemOnly

    +
    +public boolean isFilesystemOnly()
    +
    +
    Implement ResourceCollection. +

    +

    +
    Specified by:
    isFilesystemOnly in interface ResourceCollection
    +
    +
    + +
    Returns:
    false.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ConditionTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ConditionTask.html new file mode 100644 index 000000000..a2ba716c9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ConditionTask.html @@ -0,0 +1,431 @@ + + + + + + +ConditionTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ConditionTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.ConditionTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ConditionTask
    extends ConditionBase
    + + +

    +Task to set a property conditionally using <uptodate>, <available>, + and many other supported conditions. + +

    This task supports boolean logic as well as pluggable conditions + to decide, whether a property should be set.

    + +

    This task does not extend Task to take advantage of + ConditionBase.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ConditionTask() + +
    +          Constructor, names this task "condition".
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          See whether our nested condition holds and set the property.
    + voidsetElse(java.lang.Object alt) + +
    +          The value for the property to set, if condition evaluates to false.
    + voidsetElse(java.lang.String e) + +
    +          The value for the property to set, if condition evaluates to false.
    + voidsetProperty(java.lang.String p) + +
    +          The name of the property to set.
    + voidsetValue(java.lang.Object value) + +
    +          The value for the property to set, if condition evaluates to true.
    + voidsetValue(java.lang.String v) + +
    +          The value for the property to set, if condition evaluates to true.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ConditionTask

    +
    +public ConditionTask()
    +
    +
    Constructor, names this task "condition". +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String p)
    +
    +
    The name of the property to set. Required. +

    +

    +
    Parameters:
    p - the name of the property
    Since:
    +
    Ant 1.4
    +
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.Object value)
    +
    +
    The value for the property to set, if condition evaluates to true. + Defaults to "true". +

    +

    +
    Parameters:
    value - the (Object) value of the property
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String v)
    +
    +
    The value for the property to set, if condition evaluates to true. + Defaults to "true". +

    +

    +
    Parameters:
    v - the value of the property
    Since:
    +
    Ant 1.4
    +
    +
    +
    +
    + +

    +setElse

    +
    +public void setElse(java.lang.Object alt)
    +
    +
    The value for the property to set, if condition evaluates to false. + If this attribute is not specified, the property will not be set. +

    +

    +
    Parameters:
    alt - the alternate value of the property.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setElse

    +
    +public void setElse(java.lang.String e)
    +
    +
    The value for the property to set, if condition evaluates to false. + If this attribute is not specified, the property will not be set. +

    +

    +
    Parameters:
    e - the alternate value of the property.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    See whether our nested condition holds and set the property. +

    +

    + +
    Throws: +
    BuildException - if an error occurs
    Since:
    +
    Ant 1.4
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copy.html new file mode 100644 index 000000000..8da18f65a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copy.html @@ -0,0 +1,1563 @@ + + + + + + +Copy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Copy

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Copy
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Move, Sync.MyCopy
    +
    +
    +
    +
    public class Copy
    extends Task
    + + +

    +Copies a file or directory to a new file + or directory. Files are only copied if the source file is newer + than the destination file, or when the destination file does not + exist. It is possible to explicitly overwrite existing files.

    + +

    This implementation is based on Arnout Kuiper's initial design + document, the following mailing list discussions, and the + copyfile/copydir tasks.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.util.HashtablecompleteDirMap + +
    +           
    +protected  java.io.FiledestDir + +
    +           
    +protected  java.io.FiledestFile + +
    +           
    +protected  java.util.HashtabledirCopyMap + +
    +           
    +protected  booleanfailonerror + +
    +           
    +protected  java.io.Filefile + +
    +           
    +protected  java.util.HashtablefileCopyMap + +
    +           
    +protected  java.util.Vectorfilesets + +
    +           
    +protected  FileUtilsfileUtils + +
    +           
    +protected  booleanfiltering + +
    +           
    +protected  booleanflatten + +
    +           
    +protected  booleanforceOverwrite + +
    +           
    +protected  booleanincludeEmpty + +
    +           
    +protected  MappermapperElement + +
    +           
    +protected  booleanpreserveLastModified + +
    +           
    +protected  java.util.Vectorrcs + +
    +           
    +protected  intverbosity + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Copy() + +
    +          Copy task constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Add a nested filenamemapper.
    + voidadd(ResourceCollection res) + +
    +          Add a collection of files to copy.
    + voidaddFileset(FileSet set) + +
    +          Add a set of files to copy.
    +protected  voidbuildMap(java.io.File fromDir, + java.io.File toDir, + java.lang.String[] names, + FileNameMapper mapper, + java.util.Hashtable map) + +
    +          Add to a map of files/directories to copy.
    +protected  java.util.MapbuildMap(Resource[] fromResources, + java.io.File toDir, + FileNameMapper mapper) + +
    +          Create a map of resources to copy.
    + FilterChaincreateFilterChain() + +
    +          Add a FilterChain.
    + FilterSetcreateFilterSet() + +
    +          Add a filterset.
    + MappercreateMapper() + +
    +          Define the mapper to map source to destination files.
    +protected  voiddoFileOperations() + +
    +          Actually does the file (and possibly empty directory) copies.
    +protected  voiddoResourceOperations(java.util.Map map) + +
    +          Actually does the resource copies.
    + voidexecute() + +
    +          Perform the copy operation.
    + java.lang.StringgetEncoding() + +
    +          Get the character encoding to be used.
    +protected  FileUtilsgetFileUtils() + +
    +          Get the FileUtils for this task.
    +protected  java.util.VectorgetFilterChains() + +
    +          Get the filterchains being applied to this operation.
    +protected  java.util.VectorgetFilterSets() + +
    +          Get the filtersets being applied to this operation.
    + booleangetForce() + +
    +          Whether read-only destinations will be overwritten.
    + java.lang.StringgetOutputEncoding() + +
    +          Get the character encoding for output files.
    + booleangetPreserveLastModified() + +
    +          Get whether to give the copied files the same last modified time as + the original files.
    + booleanisEnableMultipleMapping() + +
    +          Get whether multiple mapping is enabled.
    +protected  voidscan(java.io.File fromDir, + java.io.File toDir, + java.lang.String[] files, + java.lang.String[] dirs) + +
    +          Compares source files to destination files to see if they should be + copied.
    +protected  java.util.Mapscan(Resource[] fromResources, + java.io.File toDir) + +
    +          Compares source resources to destination files to see if they + should be copied.
    + voidsetEnableMultipleMappings(boolean enableMultipleMappings) + +
    +          Set method of handling mappers that return multiple + mappings for a given source path.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Set the character encoding.
    + voidsetFailOnError(boolean failonerror) + +
    +          Set whether to fail when errors are encountered.
    + voidsetFile(java.io.File file) + +
    +          Set a single source file to copy.
    + voidsetFiltering(boolean filtering) + +
    +          Set filtering mode.
    + voidsetFlatten(boolean flatten) + +
    +          Set whether files copied from directory trees will be "flattened" + into a single directory.
    + voidsetForce(boolean f) + +
    +          Whether read-only destinations will be overwritten.
    + voidsetGranularity(long granularity) + +
    +          Set the number of milliseconds leeway to give before deciding a + target is out of date.
    + voidsetIncludeEmptyDirs(boolean includeEmpty) + +
    +          Set whether to copy empty directories.
    + voidsetOutputEncoding(java.lang.String encoding) + +
    +          Set the character encoding for output files.
    + voidsetOverwrite(boolean overwrite) + +
    +          Set overwrite mode regarding existing destination file(s).
    + voidsetPreserveLastModified(boolean preserve) + +
    +          Give the copied files the same last modified time as the original files.
    + voidsetPreserveLastModified(java.lang.String preserve) + +
    +          Deprecated. since 1.5.x. + setPreserveLastModified(String) has been deprecated and + replaced with setPreserveLastModified(boolean) to + consistently let the Introspection mechanism work.
    + voidsetTodir(java.io.File destDir) + +
    +          Set the destination directory.
    + voidsetTofile(java.io.File destFile) + +
    +          Set the destination file.
    + voidsetVerbose(boolean verbose) + +
    +          Set verbose mode.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +protected  voidvalidateAttributes() + +
    +          Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +file

    +
    +protected java.io.File file
    +
    +
    +
    +
    +
    + +

    +destFile

    +
    +protected java.io.File destFile
    +
    +
    +
    +
    +
    + +

    +destDir

    +
    +protected java.io.File destDir
    +
    +
    +
    +
    +
    + +

    +rcs

    +
    +protected java.util.Vector rcs
    +
    +
    +
    +
    +
    + +

    +filesets

    +
    +protected java.util.Vector filesets
    +
    +
    +
    +
    +
    + +

    +filtering

    +
    +protected boolean filtering
    +
    +
    +
    +
    +
    + +

    +preserveLastModified

    +
    +protected boolean preserveLastModified
    +
    +
    +
    +
    +
    + +

    +forceOverwrite

    +
    +protected boolean forceOverwrite
    +
    +
    +
    +
    +
    + +

    +flatten

    +
    +protected boolean flatten
    +
    +
    +
    +
    +
    + +

    +verbosity

    +
    +protected int verbosity
    +
    +
    +
    +
    +
    + +

    +includeEmpty

    +
    +protected boolean includeEmpty
    +
    +
    +
    +
    +
    + +

    +failonerror

    +
    +protected boolean failonerror
    +
    +
    +
    +
    +
    + +

    +fileCopyMap

    +
    +protected java.util.Hashtable fileCopyMap
    +
    +
    +
    +
    +
    + +

    +dirCopyMap

    +
    +protected java.util.Hashtable dirCopyMap
    +
    +
    +
    +
    +
    + +

    +completeDirMap

    +
    +protected java.util.Hashtable completeDirMap
    +
    +
    +
    +
    +
    + +

    +mapperElement

    +
    +protected Mapper mapperElement
    +
    +
    +
    +
    +
    + +

    +fileUtils

    +
    +protected FileUtils fileUtils
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Copy

    +
    +public Copy()
    +
    +
    Copy task constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getFileUtils

    +
    +protected FileUtils getFileUtils()
    +
    +
    Get the FileUtils for this task. +

    +

    + +
    Returns:
    the fileutils object.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set a single source file to copy. +

    +

    +
    Parameters:
    file - the file to copy.
    +
    +
    +
    + +

    +setTofile

    +
    +public void setTofile(java.io.File destFile)
    +
    +
    Set the destination file. +

    +

    +
    Parameters:
    destFile - the file to copy to.
    +
    +
    +
    + +

    +setTodir

    +
    +public void setTodir(java.io.File destDir)
    +
    +
    Set the destination directory. +

    +

    +
    Parameters:
    destDir - the destination directory.
    +
    +
    +
    + +

    +createFilterChain

    +
    +public FilterChain createFilterChain()
    +
    +
    Add a FilterChain. +

    +

    + +
    Returns:
    a filter chain object.
    +
    +
    +
    + +

    +createFilterSet

    +
    +public FilterSet createFilterSet()
    +
    +
    Add a filterset. +

    +

    + +
    Returns:
    a filter set object.
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(java.lang.String preserve)
    +
    +
    Deprecated. since 1.5.x. + setPreserveLastModified(String) has been deprecated and + replaced with setPreserveLastModified(boolean) to + consistently let the Introspection mechanism work. +

    +

    Give the copied files the same last modified time as the original files. +

    +

    +
    Parameters:
    preserve - a boolean string.
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(boolean preserve)
    +
    +
    Give the copied files the same last modified time as the original files. +

    +

    +
    Parameters:
    preserve - if true preserve the modified time; default is false.
    +
    +
    +
    + +

    +getPreserveLastModified

    +
    +public boolean getPreserveLastModified()
    +
    +
    Get whether to give the copied files the same last modified time as + the original files. +

    +

    + +
    Returns:
    the whether destination files will inherit the modification + times of the corresponding source files.
    Since:
    +
    1.32, Ant 1.5
    +
    +
    +
    +
    + +

    +getFilterSets

    +
    +protected java.util.Vector getFilterSets()
    +
    +
    Get the filtersets being applied to this operation. +

    +

    + +
    Returns:
    a vector of FilterSet objects.
    +
    +
    +
    + +

    +getFilterChains

    +
    +protected java.util.Vector getFilterChains()
    +
    +
    Get the filterchains being applied to this operation. +

    +

    + +
    Returns:
    a vector of FilterChain objects.
    +
    +
    +
    + +

    +setFiltering

    +
    +public void setFiltering(boolean filtering)
    +
    +
    Set filtering mode. +

    +

    +
    Parameters:
    filtering - if true enable filtering; default is false.
    +
    +
    +
    + +

    +setOverwrite

    +
    +public void setOverwrite(boolean overwrite)
    +
    +
    Set overwrite mode regarding existing destination file(s). +

    +

    +
    Parameters:
    overwrite - if true force overwriting of destination file(s) + even if the destination file(s) are younger than + the corresponding source file. Default is false.
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean f)
    +
    +
    Whether read-only destinations will be overwritten. + +

    Defaults to false

    +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +getForce

    +
    +public boolean getForce()
    +
    +
    Whether read-only destinations will be overwritten. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +setFlatten

    +
    +public void setFlatten(boolean flatten)
    +
    +
    Set whether files copied from directory trees will be "flattened" + into a single directory. If there are multiple files with + the same name in the source directory tree, only the first + file will be copied into the "flattened" directory, unless + the forceoverwrite attribute is true. +

    +

    +
    Parameters:
    flatten - if true flatten the destination directory. Default + is false.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    Set verbose mode. Used to force listing of all names of copied files. +

    +

    +
    Parameters:
    verbose - whether to output the names of copied files. + Default is false.
    +
    +
    +
    + +

    +setIncludeEmptyDirs

    +
    +public void setIncludeEmptyDirs(boolean includeEmpty)
    +
    +
    Set whether to copy empty directories. +

    +

    +
    Parameters:
    includeEmpty - if true copy empty directories. Default is true.
    +
    +
    +
    + +

    +setEnableMultipleMappings

    +
    +public void setEnableMultipleMappings(boolean enableMultipleMappings)
    +
    +
    Set method of handling mappers that return multiple + mappings for a given source path. +

    +

    +
    Parameters:
    enableMultipleMappings - If true the task will + copy to all the mappings for a given source path, if + false, only the first file or directory is + processed. + By default, this setting is false to provide backward + compatibility with earlier releases.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +isEnableMultipleMapping

    +
    +public boolean isEnableMultipleMapping()
    +
    +
    Get whether multiple mapping is enabled. +

    +

    + +
    Returns:
    true if multiple mapping is enabled; false otherwise.
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failonerror)
    +
    +
    Set whether to fail when errors are encountered. If false, note errors + to the output but keep going. Default is true. +

    +

    +
    Parameters:
    failonerror - true or false.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Add a set of files to copy. +

    +

    +
    Parameters:
    set - a set of files to copy.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection res)
    +
    +
    Add a collection of files to copy. +

    +

    +
    Parameters:
    res - a resource collection to copy.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Define the mapper to map source to destination files. +

    +

    + +
    Returns:
    a mapper to be configured. +
    Throws: +
    BuildException - if more than one mapper is defined.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    Add a nested filenamemapper. +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Set the character encoding. +

    +

    +
    Parameters:
    encoding - the character encoding.
    Since:
    +
    1.32, Ant 1.5
    +
    +
    +
    +
    + +

    +getEncoding

    +
    +public java.lang.String getEncoding()
    +
    +
    Get the character encoding to be used. +

    +

    + +
    Returns:
    the character encoding, null if not set.
    Since:
    +
    1.32, Ant 1.5
    +
    +
    +
    +
    + +

    +setOutputEncoding

    +
    +public void setOutputEncoding(java.lang.String encoding)
    +
    +
    Set the character encoding for output files. +

    +

    +
    Parameters:
    encoding - the output character encoding.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getOutputEncoding

    +
    +public java.lang.String getOutputEncoding()
    +
    +
    Get the character encoding for output files. +

    +

    + +
    Returns:
    the character encoding for output files, + null if not set.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setGranularity

    +
    +public void setGranularity(long granularity)
    +
    +
    Set the number of milliseconds leeway to give before deciding a + target is out of date. + +

    Default is 1 second, or 2 seconds on DOS systems.

    +

    +

    +
    Parameters:
    granularity - the granularity used to decide if a target is out of + date.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Perform the copy operation. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +validateAttributes

    +
    +protected void validateAttributes()
+                           throws BuildException
    +
    +
    Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes. +

    +

    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +scan

    +
    +protected void scan(java.io.File fromDir,
+                    java.io.File toDir,
+                    java.lang.String[] files,
+                    java.lang.String[] dirs)
    +
    +
    Compares source files to destination files to see if they should be + copied. +

    +

    +
    Parameters:
    fromDir - The source directory.
    toDir - The destination directory.
    files - A list of files to copy.
    dirs - A list of directories to copy.
    +
    +
    +
    + +

    +scan

    +
    +protected java.util.Map scan(Resource[] fromResources,
+                             java.io.File toDir)
    +
    +
    Compares source resources to destination files to see if they + should be copied. +

    +

    +
    Parameters:
    fromResources - The source resources.
    toDir - The destination directory. +
    Returns:
    a Map with the out-of-date resources as keys and an + array of target file names as values.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +buildMap

    +
    +protected void buildMap(java.io.File fromDir,
+                        java.io.File toDir,
+                        java.lang.String[] names,
+                        FileNameMapper mapper,
+                        java.util.Hashtable map)
    +
    +
    Add to a map of files/directories to copy. +

    +

    +
    Parameters:
    fromDir - the source directory.
    toDir - the destination directory.
    names - a list of filenames.
    mapper - a FileNameMapper value.
    map - a map of source file to array of destination files.
    +
    +
    +
    + +

    +buildMap

    +
    +protected java.util.Map buildMap(Resource[] fromResources,
+                                 java.io.File toDir,
+                                 FileNameMapper mapper)
    +
    +
    Create a map of resources to copy. +

    +

    +
    Parameters:
    fromResources - The source resources.
    toDir - the destination directory.
    mapper - a FileNameMapper value. +
    Returns:
    a map of source resource to array of destination files.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +doFileOperations

    +
    +protected void doFileOperations()
    +
    +
    Actually does the file (and possibly empty directory) copies. + This is a good method for subclasses to override. +

    +

    +
    +
    +
    +
    + +

    +doResourceOperations

    +
    +protected void doResourceOperations(java.util.Map map)
    +
    +
    Actually does the resource copies. + This is a good method for subclasses to override. +

    +

    +
    Parameters:
    map - a map of source resource to array of destination files.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    <copy> can while <move> can't since we don't + know how to remove non-file resources.

    + +

    This implementation returns true only if this task is + <copy>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    + +
    Returns:
    true if this task supports non file resources.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CopyPath.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CopyPath.html new file mode 100644 index 000000000..8d615ca7a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/CopyPath.html @@ -0,0 +1,565 @@ + + + + + + +CopyPath (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class CopyPath

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.CopyPath
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. this task should have never been released and was + obsoleted by ResourceCollection support in Copy available since Ant + 1.7.0. Don't use it. +

    +

    +
    public class CopyPath
    extends Task
    + + +

    +Copy the contents of a path to a destination, using the mapper of choice +

    + +

    +

    +
    Since:
    +
    Ant 1.7.0
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_NO_DESTDIR + +
    +          Deprecated. No destdir attribute
    +static java.lang.StringERROR_NO_MAPPER + +
    +          Deprecated. No mapper
    +static java.lang.StringERROR_NO_PATH + +
    +          Deprecated. No path
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CopyPath() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper newmapper) + +
    +          Deprecated. add a mapper
    + PathcreatePath() + +
    +          Deprecated. Create a path.
    + voidexecute() + +
    +          Deprecated. This is a very minimal derivative of the nomal copy logic.
    + voidsetDestDir(java.io.File destDir) + +
    +          Deprecated. The dest dir attribute.
    + voidsetGranularity(long granularity) + +
    +          Deprecated. Set the number of milliseconds leeway to give before deciding a + target is out of date.
    + voidsetPath(Path s) + +
    +          Deprecated. Set the path to be used when running the Java class.
    + voidsetPathRef(Reference r) + +
    +          Deprecated. Set the path to use by reference.
    + voidsetPreserveLastModified(boolean preserveLastModified) + +
    +          Deprecated. Give the copied files the same last modified time as the original files.
    +protected  voidvalidateAttributes() + +
    +          Deprecated. Ensure we have a consistent and legal set of attributes, and set any + internal flags necessary based on different combinations of attributes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_NO_DESTDIR

    +
    +public static final java.lang.String ERROR_NO_DESTDIR
    +
    +
    Deprecated. 
    No destdir attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_PATH

    +
    +public static final java.lang.String ERROR_NO_PATH
    +
    +
    Deprecated. 
    No path +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_MAPPER

    +
    +public static final java.lang.String ERROR_NO_MAPPER
    +
    +
    Deprecated. 
    No mapper +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +CopyPath

    +
    +public CopyPath()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +setDestDir

    +
    +public void setDestDir(java.io.File destDir)
    +
    +
    Deprecated. 
    The dest dir attribute. +

    +

    +
    Parameters:
    destDir - the value of the destdir attribute.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper newmapper)
    +
    +
    Deprecated. 
    add a mapper +

    +

    +
    Parameters:
    newmapper - the mapper to add.
    +
    +
    +
    + +

    +setPath

    +
    +public void setPath(Path s)
    +
    +
    Deprecated. 
    Set the path to be used when running the Java class. +

    +

    +
    Parameters:
    s - an Ant Path object containing the path.
    +
    +
    +
    + +

    +setPathRef

    +
    +public void setPathRef(Reference r)
    +
    +
    Deprecated. 
    Set the path to use by reference. +

    +

    +
    Parameters:
    r - a reference to an existing path.
    +
    +
    +
    + +

    +createPath

    +
    +public Path createPath()
    +
    +
    Deprecated. 
    Create a path. +

    +

    + +
    Returns:
    a path to be configured.
    +
    +
    +
    + +

    +setGranularity

    +
    +public void setGranularity(long granularity)
    +
    +
    Deprecated. 
    Set the number of milliseconds leeway to give before deciding a + target is out of date. + TODO: This is not yet used. +

    +

    +
    Parameters:
    granularity - the granularity used to decide if a target is out of + date.
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(boolean preserveLastModified)
    +
    +
    Deprecated. 
    Give the copied files the same last modified time as the original files. +

    +

    +
    Parameters:
    preserveLastModified - if true preserve the modified time; + default is false.
    +
    +
    +
    + +

    +validateAttributes

    +
    +protected void validateAttributes()
+                           throws BuildException
    +
    +
    Deprecated. 
    Ensure we have a consistent and legal set of attributes, and set any + internal flags necessary based on different combinations of attributes. +

    +

    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    This is a very minimal derivative of the nomal copy logic. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copydir.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copydir.html new file mode 100644 index 000000000..dd2d75abc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copydir.html @@ -0,0 +1,443 @@ + + + + + + +Copydir (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Copydir

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Copydir
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +Deprecated. The copydir task is deprecated since Ant 1.2. Use copy instead. +

    +

    +
    public class Copydir
    extends MatchingTask
    + + +

    +Copies a directory. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Copydir() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Execute the task.
    + voidsetDest(java.io.File dest) + +
    +          Deprecated. The dest attribute
    + voidsetFiltering(boolean filter) + +
    +          Deprecated. The filtering attribute.
    + voidsetFlatten(boolean flatten) + +
    +          Deprecated. The flattening attribute.
    + voidsetForceoverwrite(boolean force) + +
    +          Deprecated. The forceoverwrite attribute.
    + voidsetSrc(java.io.File src) + +
    +          Deprecated. The src attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Copydir

    +
    +public Copydir()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    Deprecated. 
    The src attribute +

    +

    +
    Parameters:
    src - the source file
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    Deprecated. 
    The dest attribute +

    +

    +
    Parameters:
    dest - the destination file
    +
    +
    +
    + +

    +setFiltering

    +
    +public void setFiltering(boolean filter)
    +
    +
    Deprecated. 
    The filtering attribute. + Default is false. +

    +

    +
    Parameters:
    filter - if true use filtering
    +
    +
    +
    + +

    +setFlatten

    +
    +public void setFlatten(boolean flatten)
    +
    +
    Deprecated. 
    The flattening attribute. + Default is false. +

    +

    +
    Parameters:
    flatten - if true use flattening
    +
    +
    +
    + +

    +setForceoverwrite

    +
    +public void setForceoverwrite(boolean force)
    +
    +
    Deprecated. 
    The forceoverwrite attribute. + Default is false. +

    +

    +
    Parameters:
    force - if true overwrite even if the destination file + is newer that the source file
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copyfile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copyfile.html new file mode 100644 index 000000000..c37e5ec61 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Copyfile.html @@ -0,0 +1,403 @@ + + + + + + +Copyfile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Copyfile

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Copyfile
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. The copyfile task is deprecated since Ant 1.2. Use + copy instead. +

    +

    +
    public class Copyfile
    extends Task
    + + +

    +Copies a file. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Copyfile() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Execute the task.
    + voidsetDest(java.io.File dest) + +
    +          Deprecated. Set the destination file.
    + voidsetFiltering(java.lang.String filter) + +
    +          Deprecated. The filtering attribute.
    + voidsetForceoverwrite(boolean force) + +
    +          Deprecated. The forceoverwrite attribute.
    + voidsetSrc(java.io.File src) + +
    +          Deprecated. Set the source file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Copyfile

    +
    +public Copyfile()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    Deprecated. 
    Set the source file. +

    +

    +
    Parameters:
    src - the source file.
    +
    +
    +
    + +

    +setForceoverwrite

    +
    +public void setForceoverwrite(boolean force)
    +
    +
    Deprecated. 
    The forceoverwrite attribute. + Default is false. +

    +

    +
    Parameters:
    force - if true overwrite even if the destination file + is newer that the source file
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    Deprecated. 
    Set the destination file. +

    +

    +
    Parameters:
    dest - the destination file.
    +
    +
    +
    + +

    +setFiltering

    +
    +public void setFiltering(java.lang.String filter)
    +
    +
    Deprecated. 
    The filtering attribute. + Default is false. +

    +

    +
    Parameters:
    filter - if true use filtering
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Cvs.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Cvs.html new file mode 100644 index 000000000..da79c2553 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Cvs.html @@ -0,0 +1,322 @@ + + + + + + +Cvs (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Cvs

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractCvsTask
+              extended by org.apache.tools.ant.taskdefs.Cvs
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Cvs
    extends AbstractCvsTask
    + + +

    +Performs operations on a CVS repository. + + original 1.20 + + NOTE: This implementation has been moved to AbstractCvsTask with + the addition of some accessors for extensibility. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    AbstractCvsTask.Module
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    DEFAULT_COMPRESSION_LEVEL
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Cvs() + +
    +          CVS Task - now implemented by the Abstract CVS Task base class
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    addCommandArgument, addCommandArgument, addConfiguredCommandline, addConfiguredCommandline, addModule, configureCommandline, execute, getCommand, getCvsRoot, getCvsRsh, getDest, getErrorStream, getExecuteStreamHandler, getModules, getOutputStream, getPackage, getPassFile, getPort, getTag, removeCommandline, runCommand, setAppend, setCommand, setCompression, setCompressionLevel, setCvsRoot, setCvsRsh, setDate, setDest, setError, setErrorStream, setExecuteStreamHandler, setFailOnError, setNoexec, setOutput, setOutputStream, setPackage, setPassfile, setPort, setQuiet, setReallyquiet, setTag
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Cvs

    +
    +public Cvs()
    +
    +
    CVS Task - now implemented by the Abstract CVS Task base class +

    +

    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefBase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefBase.html new file mode 100644 index 000000000..87fbb3b01 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefBase.html @@ -0,0 +1,580 @@ + + + + + + +DefBase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class DefBase

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Definer, Input.Handler, ScriptDef
    +
    +
    +
    +
    public abstract class DefBase
    extends AntlibDefinition
    + + +

    +Base class for Definitions handling uri and class loading. + (This was part of Definer) +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    DefBase() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateClasspath() + +
    +          Create the classpath to be used when searching for component being + defined.
    +protected  java.lang.ClassLoadercreateLoader() + +
    +          create a classloader for this definition
    + PathgetClasspath() + +
    +           
    + java.lang.StringgetClasspathId() + +
    +          Returns the class path id of the class path delegate.
    + java.lang.StringgetLoaderId() + +
    +          Returns the loader id of the class path Delegate.
    +protected  booleanhasCpDelegate() + +
    +          Check if classpath attributes have been set.
    + voidinit() + +
    +          Called by the project to let the task initialize properly.
    + booleanisReverseLoader() + +
    +           
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used when searching for component being defined.
    + voidsetClasspathRef(Reference r) + +
    +          Set a reference to a classpath to use when loading the files.
    + voidsetLoaderRef(Reference r) + +
    +          Use the reference to locate the loader.
    + voidsetReverseLoader(boolean reverseLoader) + +
    +          Deprecated. since 1.6.x. + stop using this attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DefBase

    +
    +public DefBase()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +hasCpDelegate

    +
    +protected boolean hasCpDelegate()
    +
    +
    Check if classpath attributes have been set. + (to be called before getCpDelegate() is used. +

    +

    + +
    Returns:
    true if cpDelegate has been created.
    +
    +
    +
    + +

    +setReverseLoader

    +
    +public void setReverseLoader(boolean reverseLoader)
    +
    +
    Deprecated. since 1.6.x. + stop using this attribute +

    +

    +
    Parameters:
    reverseLoader - if true a delegated loader will take precedence over + the parent
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    + +
    Returns:
    the classpath for this definition
    +
    +
    +
    + +

    +isReverseLoader

    +
    +public boolean isReverseLoader()
    +
    +
    + +
    Returns:
    the reverse loader attribute of the classpath delegate.
    +
    +
    +
    + +

    +getLoaderId

    +
    +public java.lang.String getLoaderId()
    +
    +
    Returns the loader id of the class path Delegate. +

    +

    + +
    Returns:
    the loader id
    +
    +
    +
    + +

    +getClasspathId

    +
    +public java.lang.String getClasspathId()
    +
    +
    Returns the class path id of the class path delegate. +

    +

    + +
    Returns:
    the class path id
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used when searching for component being defined. +

    +

    +
    Parameters:
    classpath - an Ant Path object containing the classpath.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Create the classpath to be used when searching for component being + defined. +

    +

    + +
    Returns:
    the classpath of the this definition
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set a reference to a classpath to use when loading the files. + To actually share the same loader, set loaderref as well +

    +

    +
    Parameters:
    r - the reference to the classpath
    +
    +
    +
    + +

    +setLoaderRef

    +
    +public void setLoaderRef(Reference r)
    +
    +
    Use the reference to locate the loader. If the loader is not + found, the specified classpath will be used and registered + with the specified name. + + This allows multiple taskdef/typedef to use the same class loader, + so they can be used together, eliminating the need to + put them in the CLASSPATH. +

    +

    +
    Parameters:
    r - the reference to locate the loader.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +createLoader

    +
    +protected java.lang.ClassLoader createLoader()
    +
    +
    create a classloader for this definition +

    +

    + +
    Returns:
    the classloader from the cpDelegate
    +
    +
    +
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Description copied from class: Task
    +
    Called by the project to let the task initialize properly. + The default implementation is a no-op. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    Since:
    +
    Ant 1.6
    +
    See Also:
    Task.init()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefaultExcludes.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefaultExcludes.html new file mode 100644 index 000000000..c5808d406 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DefaultExcludes.html @@ -0,0 +1,399 @@ + + + + + + +DefaultExcludes (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class DefaultExcludes

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.DefaultExcludes
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class DefaultExcludes
    extends Task
    + + +

    +Alters the default excludes for the entire build.. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    DefaultExcludes() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Does the work.
    + voidsetAdd(java.lang.String add) + +
    +          Pattern to add to the default excludes
    + voidsetDefault(boolean def) + +
    +          go back to standard default patterns
    + voidsetEcho(boolean echo) + +
    +          If true, echo the default excludes.
    + voidsetRemove(java.lang.String remove) + +
    +          Pattern to remove from the default excludes.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultExcludes

    +
    +public DefaultExcludes()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Does the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +setDefault

    +
    +public void setDefault(boolean def)
    +
    +
    go back to standard default patterns +

    +

    +
    Parameters:
    def - if true go back to default patterns
    +
    +
    +
    + +

    +setAdd

    +
    +public void setAdd(java.lang.String add)
    +
    +
    Pattern to add to the default excludes +

    +

    +
    Parameters:
    add - Sets the value for the pattern to exclude.
    +
    +
    +
    + +

    +setRemove

    +
    +public void setRemove(java.lang.String remove)
    +
    +
    Pattern to remove from the default excludes. +

    +

    +
    Parameters:
    remove - Sets the value for the pattern that + should no longer be excluded.
    +
    +
    +
    + +

    +setEcho

    +
    +public void setEcho(boolean echo)
    +
    +
    If true, echo the default excludes. +

    +

    +
    Parameters:
    echo - whether or not to echo the contents of + the default excludes.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.Format.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.Format.html new file mode 100644 index 000000000..76713a58b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.Format.html @@ -0,0 +1,339 @@ + + + + + + +Definer.Format (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Definer.Format

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Definer.Format
+
    +
    +
    Enclosing class:
    Definer
    +
    +
    +
    +
    public static class Definer.Format
    extends EnumeratedAttribute
    + + +

    +Enumerated type for format attribute +

    + +

    +

    +
    See Also:
    EnumeratedAttribute
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static intPROPERTIES + +
    +          Enumerated values
    +static intXML + +
    +          Enumerated values
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Definer.Format() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          get the values
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +PROPERTIES

    +
    +public static final int PROPERTIES
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +XML

    +
    +public static final int XML
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Definer.Format

    +
    +public Definer.Format()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    get the values +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array of the allowed values for this attribute.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.OnError.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.OnError.html new file mode 100644 index 000000000..0b54b1906 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.OnError.html @@ -0,0 +1,479 @@ + + + + + + +Definer.OnError (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Definer.OnError

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Definer.OnError
+
    +
    +
    Enclosing class:
    Definer
    +
    +
    +
    +
    public static class Definer.OnError
    extends EnumeratedAttribute
    + + +

    +Enumerated type for onError attribute +

    + +

    +

    +
    See Also:
    EnumeratedAttribute
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static intFAIL + +
    +          Enumerated values
    +static intFAIL_ALL + +
    +          Enumerated values
    +static intIGNORE + +
    +          Enumerated values
    +static java.lang.StringPOLICY_FAIL + +
    +          text value of onerror option "fail"
    +static java.lang.StringPOLICY_FAILALL + +
    +          text value of onerror option "failall"
    +static java.lang.StringPOLICY_IGNORE + +
    +          text value of onerror option "ignore"
    +static java.lang.StringPOLICY_REPORT + +
    +          text value of onerror option "report"
    +static intREPORT + +
    +          Enumerated values
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Definer.OnError() + +
    +          Constructor
    Definer.OnError(java.lang.String value) + +
    +          Constructor using a string.
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          get the values
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FAIL

    +
    +public static final int FAIL
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REPORT

    +
    +public static final int REPORT
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +IGNORE

    +
    +public static final int IGNORE
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAIL_ALL

    +
    +public static final int FAIL_ALL
    +
    +
    Enumerated values +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +POLICY_FAIL

    +
    +public static final java.lang.String POLICY_FAIL
    +
    +
    text value of onerror option "fail" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +POLICY_REPORT

    +
    +public static final java.lang.String POLICY_REPORT
    +
    +
    text value of onerror option "report" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +POLICY_IGNORE

    +
    +public static final java.lang.String POLICY_IGNORE
    +
    +
    text value of onerror option "ignore" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +POLICY_FAILALL

    +
    +public static final java.lang.String POLICY_FAILALL
    +
    +
    text value of onerror option "failall" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Definer.OnError

    +
    +public Definer.OnError()
    +
    +
    Constructor +

    +

    +
    + +

    +Definer.OnError

    +
    +public Definer.OnError(java.lang.String value)
    +
    +
    Constructor using a string. +

    +

    +
    Parameters:
    value - the value of the attribute
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    get the values +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array of the allowed values for this attribute.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.html new file mode 100644 index 000000000..31f5f6abc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Definer.html @@ -0,0 +1,804 @@ + + + + + + +Definer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Definer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.Definer
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Componentdef, Typedef
    +
    +
    +
    +
    public abstract class Definer
    extends DefBase
    + + +

    +Base class for Taskdef and Typedef - handles all + the attributes for Typedef. The uri and class + handling is handled by DefBase +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classDefiner.Format + +
    +          Enumerated type for format attribute
    +static classDefiner.OnError + +
    +          Enumerated type for onError attribute
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Definer() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidaddDefinition(java.lang.ClassLoader al, + java.lang.String name, + java.lang.String classname) + +
    +          Add a definition using the attributes of Definer
    + voidexecute() + +
    +          Run the definition.
    + java.lang.StringgetClassname() + +
    +          Returns the classname of the object we are defining.
    + java.io.FilegetFile() + +
    +           
    + java.lang.StringgetName() + +
    +           
    + java.lang.StringgetResource() + +
    +           
    +protected  voidloadProperties(java.lang.ClassLoader al, + java.net.URL url) + +
    +          Load type definitions as properties from a URL.
    +static java.lang.StringmakeResourceFromURI(java.lang.String uri) + +
    +          This is where the logic to map from a URI to an antlib resource + is kept.
    + voidsetAdapter(java.lang.String adapter) + +
    +          Set the class name of the adapter class.
    +protected  voidsetAdapterClass(java.lang.Class adapterClass) + +
    +          Set the adapter class.
    + voidsetAdaptTo(java.lang.String adaptTo) + +
    +          Set the classname of the class that the definition + must be compatible with, either directly or + by use of the adapter class.
    +protected  voidsetAdaptToClass(java.lang.Class adaptToClass) + +
    +          Set the class for adaptToClass, to be + used by derived classes, used instead of + the adaptTo attribute.
    + voidsetAntlib(java.lang.String antlib) + +
    +          Antlib attribute, sets resource and uri.
    + voidsetClassname(java.lang.String classname) + +
    +          The full class name of the object being defined.
    + voidsetFile(java.io.File file) + +
    +          Name of the property file to load + ant name/classname pairs from.
    + voidsetFormat(Definer.Format format) + +
    +          Sets the format of the file or resource
    + voidsetName(java.lang.String name) + +
    +          Name of the definition
    + voidsetOnError(Definer.OnError onError) + +
    +          What to do if there is an error in loading the class.
    + voidsetResource(java.lang.String res) + +
    +          Name of the property resource to load + ant name/classname pairs from.
    +protected  voidsetRestrict(boolean restrict) + +
    +          The restrict attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
    createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Definer

    +
    +public Definer()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setRestrict

    +
    +protected void setRestrict(boolean restrict)
    +
    +
    The restrict attribute. + If this is true, only use this definition in add(X). +

    +

    +
    Parameters:
    restrict - the value to set.
    +
    +
    +
    + +

    +setOnError

    +
    +public void setOnError(Definer.OnError onError)
    +
    +
    What to do if there is an error in loading the class. +
    +
  • error - throw build exception
    • +
  • report - output at warning level
    • +
  • ignore - output at debug level
    • +
    +

    +

    +
    Parameters:
    onError - an OnError value
    +
    +
    +
    + +

    +setFormat

    +
    +public void setFormat(Definer.Format format)
    +
    +
    Sets the format of the file or resource +

    +

    +
    Parameters:
    format - the enumerated value - xml or properties
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    + +
    Returns:
    the name for this definition
    +
    +
    +
    + +

    +getFile

    +
    +public java.io.File getFile()
    +
    +
    + +
    Returns:
    the file containing definitions
    +
    +
    +
    + +

    +getResource

    +
    +public java.lang.String getResource()
    +
    +
    + +
    Returns:
    the resource containing definitions
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Run the definition. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +makeResourceFromURI

    +
    +public static java.lang.String makeResourceFromURI(java.lang.String uri)
    +
    +
    This is where the logic to map from a URI to an antlib resource + is kept. +

    +

    +
    Parameters:
    uri - the xml namespace uri that to convert. +
    Returns:
    the name of a resource. It may not exist
    +
    +
    +
    + +

    +loadProperties

    +
    +protected void loadProperties(java.lang.ClassLoader al,
+                              java.net.URL url)
    +
    +
    Load type definitions as properties from a URL. +

    +

    +
    Parameters:
    al - the classloader to use
    url - the url to get the definitions from
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Name of the property file to load + ant name/classname pairs from. +

    +

    +
    Parameters:
    file - the file
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String res)
    +
    +
    Name of the property resource to load + ant name/classname pairs from. +

    +

    +
    Parameters:
    res - the resource to use
    +
    +
    +
    + +

    +setAntlib

    +
    +public void setAntlib(java.lang.String antlib)
    +
    +
    Antlib attribute, sets resource and uri. + uri is set the antlib value and, resource is set + to the antlib.xml resource in the classpath. + For example antlib="antlib:org.acme.bland.cola" + corresponds to uri="antlib:org.acme.bland.cola" + resource="org/acme/bland/cola/antlib.xml". + ASF Bugzilla Bug 31999 +

    +

    +
    Parameters:
    antlib - the value to set.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Name of the definition +

    +

    +
    Parameters:
    name - the name of the definition
    +
    +
    +
    + +

    +getClassname

    +
    +public java.lang.String getClassname()
    +
    +
    Returns the classname of the object we are defining. + May be null. +

    +

    + +
    Returns:
    the class name
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String classname)
    +
    +
    The full class name of the object being defined. + Required, unless file or resource have + been specified. +

    +

    +
    Parameters:
    classname - the name of the class
    +
    +
    +
    + +

    +setAdapter

    +
    +public void setAdapter(java.lang.String adapter)
    +
    +
    Set the class name of the adapter class. + An adapter class is used to proxy the + definition class. It is used if the + definition class is not assignable to + the adaptto class, or if the adaptto + class is not present. +

    +

    +
    Parameters:
    adapter - the name of the adapter class
    +
    +
    +
    + +

    +setAdapterClass

    +
    +protected void setAdapterClass(java.lang.Class adapterClass)
    +
    +
    Set the adapter class. +

    +

    +
    Parameters:
    adapterClass - the class to use to adapt the definition class
    +
    +
    +
    + +

    +setAdaptTo

    +
    +public void setAdaptTo(java.lang.String adaptTo)
    +
    +
    Set the classname of the class that the definition + must be compatible with, either directly or + by use of the adapter class. +

    +

    +
    Parameters:
    adaptTo - the name of the adaptto class
    +
    +
    +
    + +

    +setAdaptToClass

    +
    +protected void setAdaptToClass(java.lang.Class adaptToClass)
    +
    +
    Set the class for adaptToClass, to be + used by derived classes, used instead of + the adaptTo attribute. +

    +

    +
    Parameters:
    adaptToClass - the class for adapto.
    +
    +
    +
    + +

    +addDefinition

    +
    +protected void addDefinition(java.lang.ClassLoader al,
+                             java.lang.String name,
+                             java.lang.String classname)
+                      throws BuildException
    +
    +
    Add a definition using the attributes of Definer +

    +

    +
    Parameters:
    al - the ClassLoader to use
    name - the name of the definition
    classname - the classname of the definition +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Delete.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Delete.html new file mode 100644 index 000000000..e9e581094 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Delete.html @@ -0,0 +1,1421 @@ + + + + + + +Delete (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Delete

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Delete
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Delete
    extends MatchingTask
    + + +

    +Deletes a file or directory, or set of files defined by a fileset. + The original delete task would delete a file, or a set of files + using the include/exclude syntax. The deltree task would delete a + directory tree. This task combines the functionality of these two + originally distinct tasks. +

    Currently Delete extends MatchingTask. This is intended only + to provide backwards compatibility for a release. The future position + is to use nested filesets exclusively.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.Filedir + +
    +           
    +protected  java.io.Filefile + +
    +           
    +protected  java.util.Vectorfilesets + +
    +           
    +protected  booleanincludeEmpty + +
    +           
    +protected  booleanusedMatchingTask + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Delete() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileSelector selector) + +
    +          add an arbitrary selector
    + voidadd(ResourceCollection rc) + +
    +          Add an arbitrary ResourceCollection to be deleted.
    + voidaddAnd(AndSelector selector) + +
    +          add an "And" selector entry on the selector list
    + voidaddContains(ContainsSelector selector) + +
    +          add a contains selector entry on the selector list
    + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
    +          add a regular expression selector entry on the selector list
    + voidaddCustom(ExtendSelector selector) + +
    +          add an extended selector entry on the selector list
    + voidaddDate(DateSelector selector) + +
    +          add a selector date entry on the selector list
    + voidaddDepend(DependSelector selector) + +
    +          add a depends selector entry on the selector list
    + voidaddDepth(DepthSelector selector) + +
    +          add a depth selector entry on the selector list
    + voidaddFilename(FilenameSelector selector) + +
    +          add a selector filename entry on the selector list
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files to be deleted.
    + voidaddMajority(MajoritySelector selector) + +
    +          add a majority selector entry on the selector list
    + voidaddModified(ModifiedSelector selector) + +
    +          add the modified selector
    + voidaddNone(NoneSelector selector) + +
    +          add a "None" selector entry on the selector list
    + voidaddNot(NotSelector selector) + +
    +          add a "Not" selector entry on the selector list
    + voidaddOr(OrSelector selector) + +
    +          add an "Or" selector entry on the selector list
    + voidaddPresent(PresentSelector selector) + +
    +          add a present selector entry on the selector list
    + voidaddSelector(SelectSelector selector) + +
    +          add a "Select" selector entry on the selector list
    + voidaddSize(SizeSelector selector) + +
    +          add a selector size entry on the selector list
    + PatternSet.NameEntrycreateExclude() + +
    +          add a name entry on the exclude list
    + PatternSet.NameEntrycreateExcludesFile() + +
    +          add a name entry on the include files list
    + PatternSet.NameEntrycreateInclude() + +
    +          add a name entry on the include list
    + PatternSet.NameEntrycreateIncludesFile() + +
    +          add a name entry on the include files list
    + PatternSetcreatePatternSet() + +
    +          add a set of patterns
    + voidexecute() + +
    +          Delete the file(s).
    +protected  voidremoveDir(java.io.File d) + +
    +          Delete a directory
    +protected  voidremoveFiles(java.io.File d, + java.lang.String[] files, + java.lang.String[] dirs) + +
    +          remove an array of files in a directory, and a list of subdirectories + which will only be deleted if 'includeEmpty' is true
    + voidsetCaseSensitive(boolean isCaseSensitive) + +
    +          Sets case sensitivity of the file system
    + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
    +          Sets whether default exclusions should be used or not.
    + voidsetDeleteOnExit(boolean deleteOnExit) + +
    +          If true, on failure to delete, note the error and set + the deleteonexit flag, and continue
    + voidsetDir(java.io.File dir) + +
    +          Set the directory from which files are to be deleted
    + voidsetExcludes(java.lang.String excludes) + +
    +          Sets the set of exclude patterns.
    + voidsetExcludesfile(java.io.File excludesfile) + +
    +          Sets the name of the file containing the includes patterns.
    + voidsetFailOnError(boolean failonerror) + +
    +          If false, note errors but continue.
    + voidsetFile(java.io.File file) + +
    +          Set the name of a single file to be removed.
    + voidsetFollowSymlinks(boolean followSymlinks) + +
    +          Sets whether or not symbolic links should be followed.
    + voidsetIncludeEmptyDirs(boolean includeEmpty) + +
    +          If true, delete empty directories.
    + voidsetIncludes(java.lang.String includes) + +
    +          Sets the set of include patterns.
    + voidsetIncludesfile(java.io.File includesfile) + +
    +          Sets the name of the file containing the includes patterns.
    + voidsetQuiet(boolean quiet) + +
    +          If true and the file does not exist, do not display a diagnostic + message or modify the exit status to reflect an error.
    + voidsetRemoveNotFollowedSymlinks(boolean b) + +
    +          Sets whether the symbolic links that have not been followed + shall be removed (the links, not the locations they point at).
    + voidsetVerbose(boolean verbose) + +
    +          If true, list all names of deleted files.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    addDifferent, addType, appendSelector, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +file

    +
    +protected java.io.File file
    +
    +
    +
    +
    +
    + +

    +dir

    +
    +protected java.io.File dir
    +
    +
    +
    +
    +
    + +

    +filesets

    +
    +protected java.util.Vector filesets
    +
    +
    +
    +
    +
    + +

    +usedMatchingTask

    +
    +protected boolean usedMatchingTask
    +
    +
    +
    +
    +
    + +

    +includeEmpty

    +
    +protected boolean includeEmpty
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Delete

    +
    +public Delete()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set the name of a single file to be removed. +

    +

    +
    Parameters:
    file - the file to be deleted
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
    +
    +
    Set the directory from which files are to be deleted +

    +

    +
    Parameters:
    dir - the directory path.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    If true, list all names of deleted files. +

    +

    +
    Parameters:
    verbose - "true" or "on"
    +
    +
    +
    + +

    +setQuiet

    +
    +public void setQuiet(boolean quiet)
    +
    +
    If true and the file does not exist, do not display a diagnostic + message or modify the exit status to reflect an error. + This means that if a file or directory cannot be deleted, + then no error is reported. This setting emulates the + -f option to the Unix "rm" command. + Default is false meaning things are "noisy" +

    +

    +
    Parameters:
    quiet - "true" or "on"
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failonerror)
    +
    +
    If false, note errors but continue. +

    +

    +
    Parameters:
    failonerror - true or false
    +
    +
    +
    + +

    +setDeleteOnExit

    +
    +public void setDeleteOnExit(boolean deleteOnExit)
    +
    +
    If true, on failure to delete, note the error and set + the deleteonexit flag, and continue +

    +

    +
    Parameters:
    deleteOnExit - true or false
    +
    +
    +
    + +

    +setIncludeEmptyDirs

    +
    +public void setIncludeEmptyDirs(boolean includeEmpty)
    +
    +
    If true, delete empty directories. +

    +

    +
    Parameters:
    includeEmpty - if true delete empty directories (only + for filesets). Default is false.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files to be deleted. +

    +

    +
    Parameters:
    set - the set of files to be deleted
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add an arbitrary ResourceCollection to be deleted. +

    +

    +
    Parameters:
    rc - the filesystem-only ResourceCollection.
    +
    +
    +
    + +

    +createInclude

    +
    +public PatternSet.NameEntry createInclude()
    +
    +
    add a name entry on the include list +

    +

    +
    Overrides:
    createInclude in class MatchingTask
    +
    +
    + +
    Returns:
    a NameEntry object to be configured
    +
    +
    +
    + +

    +createIncludesFile

    +
    +public PatternSet.NameEntry createIncludesFile()
    +
    +
    add a name entry on the include files list +

    +

    +
    Overrides:
    createIncludesFile in class MatchingTask
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createExclude

    +
    +public PatternSet.NameEntry createExclude()
    +
    +
    add a name entry on the exclude list +

    +

    +
    Overrides:
    createExclude in class MatchingTask
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createExcludesFile

    +
    +public PatternSet.NameEntry createExcludesFile()
    +
    +
    add a name entry on the include files list +

    +

    +
    Overrides:
    createExcludesFile in class MatchingTask
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createPatternSet

    +
    +public PatternSet createPatternSet()
    +
    +
    add a set of patterns +

    +

    +
    Overrides:
    createPatternSet in class MatchingTask
    +
    +
    + +
    Returns:
    PatternSet object to be configured
    +
    +
    +
    + +

    +setIncludes

    +
    +public void setIncludes(java.lang.String includes)
    +
    +
    Sets the set of include patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    Overrides:
    setIncludes in class MatchingTask
    +
    +
    +
    Parameters:
    includes - the string containing the include patterns
    +
    +
    +
    + +

    +setExcludes

    +
    +public void setExcludes(java.lang.String excludes)
    +
    +
    Sets the set of exclude patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    Overrides:
    setExcludes in class MatchingTask
    +
    +
    +
    Parameters:
    excludes - the string containing the exclude patterns
    +
    +
    +
    + +

    +setDefaultexcludes

    +
    +public void setDefaultexcludes(boolean useDefaultExcludes)
    +
    +
    Sets whether default exclusions should be used or not. +

    +

    +
    Overrides:
    setDefaultexcludes in class MatchingTask
    +
    +
    +
    Parameters:
    useDefaultExcludes - "true"|"on"|"yes" when default exclusions + should be used, "false"|"off"|"no" when they + shouldn't be used.
    +
    +
    +
    + +

    +setIncludesfile

    +
    +public void setIncludesfile(java.io.File includesfile)
    +
    +
    Sets the name of the file containing the includes patterns. +

    +

    +
    Overrides:
    setIncludesfile in class MatchingTask
    +
    +
    +
    Parameters:
    includesfile - A string containing the filename to fetch + the include patterns from.
    +
    +
    +
    + +

    +setExcludesfile

    +
    +public void setExcludesfile(java.io.File excludesfile)
    +
    +
    Sets the name of the file containing the includes patterns. +

    +

    +
    Overrides:
    setExcludesfile in class MatchingTask
    +
    +
    +
    Parameters:
    excludesfile - A string containing the filename to fetch + the include patterns from.
    +
    +
    +
    + +

    +setCaseSensitive

    +
    +public void setCaseSensitive(boolean isCaseSensitive)
    +
    +
    Sets case sensitivity of the file system +

    +

    +
    Overrides:
    setCaseSensitive in class MatchingTask
    +
    +
    +
    Parameters:
    isCaseSensitive - "true"|"on"|"yes" if file system is case + sensitive, "false"|"off"|"no" when not.
    +
    +
    +
    + +

    +setFollowSymlinks

    +
    +public void setFollowSymlinks(boolean followSymlinks)
    +
    +
    Sets whether or not symbolic links should be followed. +

    +

    +
    Overrides:
    setFollowSymlinks in class MatchingTask
    +
    +
    +
    Parameters:
    followSymlinks - whether or not symbolic links should be followed
    +
    +
    +
    + +

    +setRemoveNotFollowedSymlinks

    +
    +public void setRemoveNotFollowedSymlinks(boolean b)
    +
    +
    Sets whether the symbolic links that have not been followed + shall be removed (the links, not the locations they point at). +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addSelector

    +
    +public void addSelector(SelectSelector selector)
    +
    +
    add a "Select" selector entry on the selector list +

    +

    +
    Specified by:
    addSelector in interface SelectorContainer
    Overrides:
    addSelector in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addAnd

    +
    +public void addAnd(AndSelector selector)
    +
    +
    add an "And" selector entry on the selector list +

    +

    +
    Specified by:
    addAnd in interface SelectorContainer
    Overrides:
    addAnd in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addOr

    +
    +public void addOr(OrSelector selector)
    +
    +
    add an "Or" selector entry on the selector list +

    +

    +
    Specified by:
    addOr in interface SelectorContainer
    Overrides:
    addOr in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addNot

    +
    +public void addNot(NotSelector selector)
    +
    +
    add a "Not" selector entry on the selector list +

    +

    +
    Specified by:
    addNot in interface SelectorContainer
    Overrides:
    addNot in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addNone

    +
    +public void addNone(NoneSelector selector)
    +
    +
    add a "None" selector entry on the selector list +

    +

    +
    Specified by:
    addNone in interface SelectorContainer
    Overrides:
    addNone in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addMajority

    +
    +public void addMajority(MajoritySelector selector)
    +
    +
    add a majority selector entry on the selector list +

    +

    +
    Specified by:
    addMajority in interface SelectorContainer
    Overrides:
    addMajority in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addDate

    +
    +public void addDate(DateSelector selector)
    +
    +
    add a selector date entry on the selector list +

    +

    +
    Specified by:
    addDate in interface SelectorContainer
    Overrides:
    addDate in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addSize

    +
    +public void addSize(SizeSelector selector)
    +
    +
    add a selector size entry on the selector list +

    +

    +
    Specified by:
    addSize in interface SelectorContainer
    Overrides:
    addSize in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addFilename

    +
    +public void addFilename(FilenameSelector selector)
    +
    +
    add a selector filename entry on the selector list +

    +

    +
    Specified by:
    addFilename in interface SelectorContainer
    Overrides:
    addFilename in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addCustom

    +
    +public void addCustom(ExtendSelector selector)
    +
    +
    add an extended selector entry on the selector list +

    +

    +
    Specified by:
    addCustom in interface SelectorContainer
    Overrides:
    addCustom in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addContains

    +
    +public void addContains(ContainsSelector selector)
    +
    +
    add a contains selector entry on the selector list +

    +

    +
    Specified by:
    addContains in interface SelectorContainer
    Overrides:
    addContains in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addPresent

    +
    +public void addPresent(PresentSelector selector)
    +
    +
    add a present selector entry on the selector list +

    +

    +
    Specified by:
    addPresent in interface SelectorContainer
    Overrides:
    addPresent in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addDepth

    +
    +public void addDepth(DepthSelector selector)
    +
    +
    add a depth selector entry on the selector list +

    +

    +
    Specified by:
    addDepth in interface SelectorContainer
    Overrides:
    addDepth in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addDepend

    +
    +public void addDepend(DependSelector selector)
    +
    +
    add a depends selector entry on the selector list +

    +

    +
    Specified by:
    addDepend in interface SelectorContainer
    Overrides:
    addDepend in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addContainsRegexp

    +
    +public void addContainsRegexp(ContainsRegexpSelector selector)
    +
    +
    add a regular expression selector entry on the selector list +

    +

    +
    Specified by:
    addContainsRegexp in interface SelectorContainer
    Overrides:
    addContainsRegexp in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    +
    +
    +
    + +

    +addModified

    +
    +public void addModified(ModifiedSelector selector)
    +
    +
    add the modified selector +

    +

    +
    Specified by:
    addModified in interface SelectorContainer
    Overrides:
    addModified in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to add
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileSelector selector)
    +
    +
    add an arbitrary selector +

    +

    +
    Specified by:
    add in interface SelectorContainer
    Overrides:
    add in class MatchingTask
    +
    +
    +
    Parameters:
    selector - the selector to be added
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Delete the file(s). +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +removeDir

    +
    +protected void removeDir(java.io.File d)
    +
    +
    Delete a directory +

    +

    +
    Parameters:
    d - the directory to delete
    +
    +
    +
    + +

    +removeFiles

    +
    +protected void removeFiles(java.io.File d,
+                           java.lang.String[] files,
+                           java.lang.String[] dirs)
    +
    +
    remove an array of files in a directory, and a list of subdirectories + which will only be deleted if 'includeEmpty' is true +

    +

    +
    Parameters:
    d - directory to work from
    files - array of files to delete; can be of zero length
    dirs - array of directories to delete; can of zero length
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Deltree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Deltree.html new file mode 100644 index 000000000..1f23ed92a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Deltree.html @@ -0,0 +1,334 @@ + + + + + + +Deltree (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Deltree

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Deltree
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. The deltree task is deprecated since Ant 1.2. Use + delete instead. +

    +

    +
    public class Deltree
    extends Task
    + + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Deltree() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Do the work.
    + voidsetDir(java.io.File dir) + +
    +          Deprecated. Set the directory to be deleted
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Deltree

    +
    +public Deltree()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
    +
    +
    Deprecated. 
    Set the directory to be deleted +

    +

    +
    Parameters:
    dir - the root of the tree to be removed.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Do the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the task is not configured correctly or + the tree cannot be removed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DependSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DependSet.html new file mode 100644 index 000000000..af1690f3a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DependSet.html @@ -0,0 +1,525 @@ + + + + + + +DependSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class DependSet

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.DependSet
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class DependSet
    extends MatchingTask
    + + +

    +Examines and removes out of date target files. If any of the target files + are out of date with respect to any of the source files, all target + files are removed. This is useful where dependencies cannot be + computed (for example, dynamically interpreted parameters or files + that need to stay in synch but are not directly linked) or where + the ant task in question could compute them but does not (for + example, the linked DTD for an XML file using the XSLT task). + + nested arguments: +

      +
    • sources (resource union describing the source resources to examine) +
    • srcfileset (fileset describing the source files to examine) +
    • srcfilelist (filelist describing the source files to examine) +
    • targets (path describing the target files to examine) +
    • targetfileset (fileset describing the target files to examine) +
    • targetfilelist (filelist describing the target files to examine) +
    + At least one of both source and target entities is required. +

    + This task will examine each of the sources against each of the target files. If + any target files are out of date with respect to any of the sources, all targets + are removed. If any sources or targets do not exist, all targets are removed. + Hint: If missing files should be ignored, specify them as include patterns + in filesets, rather than using filelists. +

    + This task attempts to optimize speed of dependency checking + by comparing only the dates of the oldest target file and the newest source. +

    + Example uses: +

    • + Record the fact that an XML file must be up to date with respect to its XSD + (Schema file), even though the XML file itself includes no reference to its XSD. +
    • + Record the fact that an XSL stylesheet includes other sub-stylesheets +
    • + Record the fact that java files must be recompiled if the ant build file changes +
    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    DependSet() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddSrcfilelist(FileList fl) + +
    +          Add a list of source files.
    + voidaddSrcfileset(FileSet fs) + +
    +          Add a set of source files.
    + voidaddTargetfilelist(FileList fl) + +
    +          Add a list of target files.
    + voidaddTargetfileset(FileSet fs) + +
    +          Add a set of target files.
    + UnioncreateSources() + +
    +          Create a nested sources element.
    + PathcreateTargets() + +
    +          Create a nested targets element.
    + voidexecute() + +
    +          Execute the task.
    + voidsetVerbose(boolean b) + +
    +          In verbose mode missing targets and sources as well as the + modification times of the newest source and latest target will + be logged as info.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DependSet

    +
    +public DependSet()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createSources

    +
    +public Union createSources()
    +
    +
    Create a nested sources element. +

    +

    + +
    Returns:
    a Union instance.
    +
    +
    +
    + +

    +addSrcfileset

    +
    +public void addSrcfileset(FileSet fs)
    +
    +
    Add a set of source files. +

    +

    +
    Parameters:
    fs - the FileSet to add.
    +
    +
    +
    + +

    +addSrcfilelist

    +
    +public void addSrcfilelist(FileList fl)
    +
    +
    Add a list of source files. +

    +

    +
    Parameters:
    fl - the FileList to add.
    +
    +
    +
    + +

    +createTargets

    +
    +public Path createTargets()
    +
    +
    Create a nested targets element. +

    +

    + +
    Returns:
    a Union instance.
    +
    +
    +
    + +

    +addTargetfileset

    +
    +public void addTargetfileset(FileSet fs)
    +
    +
    Add a set of target files. +

    +

    +
    Parameters:
    fs - the FileSet to add.
    +
    +
    +
    + +

    +addTargetfilelist

    +
    +public void addTargetfilelist(FileList fl)
    +
    +
    Add a list of target files. +

    +

    +
    Parameters:
    fl - the FileList to add.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean b)
    +
    +
    In verbose mode missing targets and sources as well as the + modification times of the newest source and latest target will + be logged as info. + +

    All deleted files will be logged as well.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if errors occur.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DiagnosticsTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DiagnosticsTask.html new file mode 100644 index 000000000..8d1788ddc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/DiagnosticsTask.html @@ -0,0 +1,311 @@ + + + + + + +DiagnosticsTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class DiagnosticsTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.DiagnosticsTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class DiagnosticsTask
    extends Task
    + + +

    +This is a task that hands off work to the Diagnostics module. + It lets you run diagnostics in an IDE. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    DiagnosticsTask() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute the task.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +DiagnosticsTask

    +
    +public DiagnosticsTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. + This delegates to the Diagnostics class. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Dirname.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Dirname.html new file mode 100644 index 000000000..2e9d16438 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Dirname.html @@ -0,0 +1,367 @@ + + + + + + +Dirname (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Dirname

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Dirname
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Dirname
    extends Task
    + + +

    +Determines the directory name of the specified file. + + This task can accept the following attributes: +

      +
    • file +
    • property +
    + Both file and property are required. +

    + When this task executes, it will set the specified property to the + value of the specified file up to, but not including, the last path + element. If file is a file, the directory will be the current + directory. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Dirname() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute this task.
    + voidsetFile(java.io.File file) + +
    +          Path to take the dirname of.
    + voidsetProperty(java.lang.String property) + +
    +          The name of the property to set.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Dirname

    +
    +public Dirname()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Path to take the dirname of. +

    +

    +
    Parameters:
    file - a File value
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    The name of the property to set. +

    +

    +
    Parameters:
    property - the name of the property
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute this task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ear.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ear.html new file mode 100644 index 000000000..3a86c497f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Ear.html @@ -0,0 +1,520 @@ + + + + + + +Ear (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Ear

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Zip
+                  extended by org.apache.tools.ant.taskdefs.Jar
+                      extended by org.apache.tools.ant.taskdefs.Ear
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Ear
    extends Jar
    + + +

    +Creates a EAR archive. Based on WAR task +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Jar
    Jar.FilesetManifestConfig, Jar.StrictMode
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Zip
    Zip.ArchiveState, Zip.Duplicate, Zip.UnicodeExtraField, Zip.WhenEmpty
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Zip
    addedDirs, archiveType, doubleFilePass, duplicate, emptyBehavior, entries, skipWriting, zipFile
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Ear() + +
    +          Create an Ear task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddArchives(ZipFileSet fs) + +
    +          Adds zipfileset.
    +protected  voidcleanUp() + +
    +          Make sure we don't think we already have a application.xml next + time this task gets executed.
    +protected  voidinitZipOutputStream(ZipOutputStream zOut) + +
    +          Initialize the output stream.
    + voidsetAppxml(java.io.File descr) + +
    +          File to incorporate as application.xml.
    + voidsetEarfile(java.io.File earFile) + +
    +          Deprecated. since 1.5.x. + Use setDestFile(destfile) instead.
    +protected  voidzipFile(java.io.File file, + ZipOutputStream zOut, + java.lang.String vPath, + int mode) + +
    +          Overridden from Zip class to deal with application.xml
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Jar
    addConfiguredIndexJars, addConfiguredManifest, addConfiguredService, addMetainf, createEmptyZip, finalizeZipOutputStream, findJarName, getResourcesToAdd, grabFilesAndDirs, reset, setFilesetmanifest, setFlattenAttributes, setIndex, setIndexMetaInf, setJarfile, setManifest, setManifestEncoding, setMergeClassPathAttributes, setStrict, setWhenempty, setWhenmanifestonly, writeIndexLikeList, zipFile
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Zip
    add, addFileset, addParentDirs, addResources, addResources, addZipfileset, addZipGroupFileset, execute, executeMain, getComment, getCreateUnicodeExtraFields, getCurrentExtraFields, getDestFile, getEncoding, getFallBackToUTF8, getLevel, getNonFileSetResourcesToAdd, getPreserve0Permissions, getResourcesToAdd, getUseLanguageEnodingFlag, grabNonFileSetResources, grabResources, hasUpdatedFile, isAddingNewFiles, isCompress, isEmpty, isFirstPass, isInUpdateMode, logWhenWriting, selectDirectoryResources, selectFileResources, selectResources, setBasedir, setComment, setCompress, setCreateUnicodeExtraFields, setCurrentExtraFields, setDestFile, setDuplicate, setEncoding, setFallBackToUTF8, setFile, setFilesonly, setKeepCompression, setLevel, setPreserve0Permissions, setRoundUp, setUpdate, setUseLanguageEncodingFlag, setZipfile, zipDir, zipDir, zipDir, zipFile
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Ear

    +
    +public Ear()
    +
    +
    Create an Ear task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setEarfile

    +
    +public void setEarfile(java.io.File earFile)
    +
    +
    Deprecated. since 1.5.x. + Use setDestFile(destfile) instead. +

    +

    Set the destination file. +

    +

    +
    Parameters:
    earFile - the destination file
    +
    +
    +
    + +

    +setAppxml

    +
    +public void setAppxml(java.io.File descr)
    +
    +
    File to incorporate as application.xml. +

    +

    +
    Parameters:
    descr - the descriptor file
    +
    +
    +
    + +

    +addArchives

    +
    +public void addArchives(ZipFileSet fs)
    +
    +
    Adds zipfileset. +

    +

    +
    Parameters:
    fs - zipfileset to add
    +
    +
    +
    + +

    +initZipOutputStream

    +
    +protected void initZipOutputStream(ZipOutputStream zOut)
+                            throws java.io.IOException,
+                                   BuildException
    +
    +
    Initialize the output stream. +

    +

    +
    Overrides:
    initZipOutputStream in class Jar
    +
    +
    +
    Parameters:
    zOut - the zip output stream. +
    Throws: +
    java.io.IOException - on I/O errors +
    BuildException - on other errors
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.File file,
+                       ZipOutputStream zOut,
+                       java.lang.String vPath,
+                       int mode)
+                throws java.io.IOException
    +
    +
    Overridden from Zip class to deal with application.xml +

    +

    +
    Overrides:
    zipFile in class Zip
    +
    +
    +
    Parameters:
    file - the file to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +cleanUp

    +
    +protected void cleanUp()
    +
    +
    Make sure we don't think we already have a application.xml next + time this task gets executed. +

    +

    +
    Overrides:
    cleanUp in class Jar
    +
    +
    +
    See Also:
    Zip.cleanUp()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.EchoLevel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.EchoLevel.html new file mode 100644 index 000000000..6a2495ca7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.EchoLevel.html @@ -0,0 +1,273 @@ + + + + + + +Echo.EchoLevel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Echo.EchoLevel

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.LogLevel
+          extended by org.apache.tools.ant.taskdefs.Echo.EchoLevel
+
    +
    +
    Enclosing class:
    Echo
    +
    +
    +
    +
    public static class Echo.EchoLevel
    extends LogLevel
    + + +

    +The enumerated values for the level attribute. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.LogLevel
    DEBUG, ERR, INFO, VERBOSE, WARN
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Echo.EchoLevel() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.LogLevel
    getLevel, getValues
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Echo.EchoLevel

    +
    +public Echo.EchoLevel()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.html new file mode 100644 index 000000000..209e50c04 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Echo.html @@ -0,0 +1,600 @@ + + + + + + +Echo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Echo

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Echo
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Echo
    extends Task
    + + +

    +Writes a message to the Ant logging facilities. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classEcho.EchoLevel + +
    +          The enumerated values for the level attribute.
    +  + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  booleanappend + +
    +           
    +protected  java.io.Filefile + +
    +           
    +protected  intlogLevel + +
    +           
    +protected  java.lang.Stringmessage + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Echo() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String msg) + +
    +          Set a multiline message.
    + voidexecute() + +
    +          Does the work.
    + voidsetAppend(boolean append) + +
    +          If true, append to existing file.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Declare the encoding to use when outputting to a file; + Use "" for the platform's default encoding.
    + voidsetFile(java.io.File file) + +
    +          File to write to.
    + voidsetForce(boolean f) + +
    +          Whether read-only destinations will be overwritten.
    + voidsetLevel(Echo.EchoLevel echoLevel) + +
    +          Set the logging level.
    + voidsetMessage(java.lang.String msg) + +
    +          Message to write.
    + voidsetOutput(Resource output) + +
    +          Resource to write to.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +message

    +
    +protected java.lang.String message
    +
    +
    +
    +
    +
    + +

    +file

    +
    +protected java.io.File file
    +
    +
    +
    +
    +
    + +

    +append

    +
    +protected boolean append
    +
    +
    +
    +
    +
    + +

    +logLevel

    +
    +protected int logLevel
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Echo

    +
    +public Echo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Does the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +setMessage

    +
    +public void setMessage(java.lang.String msg)
    +
    +
    Message to write. +

    +

    +
    Parameters:
    msg - Sets the value for the message variable.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    File to write to. +

    +

    +
    Parameters:
    file - the file to write to, if not set, echo to + standard output
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(Resource output)
    +
    +
    Resource to write to. +

    +

    +
    Parameters:
    output - the Resource to write to.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    If true, append to existing file. +

    +

    +
    Parameters:
    append - if true, append to existing file, default + is false.
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String msg)
    +
    +
    Set a multiline message. +

    +

    +
    Parameters:
    msg - the CDATA text to append to the output text
    +
    +
    +
    + +

    +setLevel

    +
    +public void setLevel(Echo.EchoLevel echoLevel)
    +
    +
    Set the logging level. Level should be one of +
      +
    • error
      • +
    • warning
      • +
    • info
      • +
    • verbose
      • +
    • debug
      • +
    +

    The default is "warning" to ensure that messages are + displayed by default when using the -quiet command line option.

    +

    +

    +
    Parameters:
    echoLevel - the logging level
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Declare the encoding to use when outputting to a file; + Use "" for the platform's default encoding. +

    +

    +
    Parameters:
    encoding - the character encoding to use.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean f)
    +
    +
    Whether read-only destinations will be overwritten. + +

    Defaults to false

    +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.NamespacePolicy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.NamespacePolicy.html new file mode 100644 index 000000000..6315d4ec3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.NamespacePolicy.html @@ -0,0 +1,346 @@ + + + + + + +EchoXML.NamespacePolicy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class EchoXML.NamespacePolicy

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.EchoXML.NamespacePolicy
+
    +
    +
    Enclosing class:
    EchoXML
    +
    +
    +
    +
    public static class EchoXML.NamespacePolicy
    extends EnumeratedAttribute
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static EchoXML.NamespacePolicyDEFAULT + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    EchoXML.NamespacePolicy() + +
    +           
    EchoXML.NamespacePolicy(java.lang.String s) + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + DOMElementWriter.XmlNamespacePolicygetPolicy() + +
    +           
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT

    +
    +public static final EchoXML.NamespacePolicy DEFAULT
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +EchoXML.NamespacePolicy

    +
    +public EchoXML.NamespacePolicy()
    +
    +
    +
    + +

    +EchoXML.NamespacePolicy

    +
    +public EchoXML.NamespacePolicy(java.lang.String s)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +getPolicy

    +
    +public DOMElementWriter.XmlNamespacePolicy getPolicy()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.html new file mode 100644 index 000000000..9736392b6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/EchoXML.html @@ -0,0 +1,394 @@ + + + + + + +EchoXML (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class EchoXML

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.XMLFragment
+          extended by org.apache.tools.ant.taskdefs.EchoXML
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, DynamicElementNS
    +
    +
    +
    +
    public class EchoXML
    extends XMLFragment
    + + +

    +Echo XML. + + Known limitations: +

      +
    1. Processing Instructions get ignored
      2. +
    2. Encoding is always UTF-8
      3. +
    +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classEchoXML.NamespacePolicy + +
    +           
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.util.XMLFragment
    XMLFragment.Child
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    EchoXML() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute the task.
    + voidsetAppend(boolean b) + +
    +          Set whether to append the output file.
    + voidsetFile(java.io.File f) + +
    +          Set the output file.
    + voidsetNamespacePolicy(EchoXML.NamespacePolicy n) + +
    +          Set the namespace policy for the xml file
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.XMLFragment
    addText, createDynamicElement, getFragment
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EchoXML

    +
    +public EchoXML()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File f)
    +
    +
    Set the output file. +

    +

    +
    Parameters:
    f - the output file.
    +
    +
    +
    + +

    +setNamespacePolicy

    +
    +public void setNamespacePolicy(EchoXML.NamespacePolicy n)
    +
    +
    Set the namespace policy for the xml file +

    +

    +
    Parameters:
    n - namespace policy: "ignore," "elementsOnly," or "all"
    See Also:
    DOMElementWriter.XmlNamespacePolicy
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean b)
    +
    +
    Set whether to append the output file. +

    +

    +
    Parameters:
    b - boolean append flag.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute the task. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exec.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exec.html new file mode 100644 index 000000000..c8136101c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exec.html @@ -0,0 +1,524 @@ + + + + + + +Exec (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Exec

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Exec
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. since 1.2. + delegate to Execute + instead. +

    +

    +
    public class Exec
    extends Task
    + + +

    +Executes a given command if the os platform is appropriate. + +

    As of Ant 1.2, this class is no longer the + implementation of Ant's <exec> task - it is considered to be + dead code by the Ant developers and is unmaintained. Don't use + it.

    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.PrintWriterfos + +
    +          Deprecated.  
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Exec() + +
    +          Deprecated. Constructor for Exec.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Execute the task.
    +protected  voidlogFlush() + +
    +          Deprecated. Close output.
    +protected  voidoutputLog(java.lang.String line, + int messageLevel) + +
    +          Deprecated. Log an output message.
    +protected  intrun(java.lang.String command) + +
    +          Deprecated. Execute the command.
    + voidsetCommand(java.lang.String command) + +
    +          Deprecated. Set the command to exec.
    + voidsetDir(java.lang.String d) + +
    +          Deprecated. Set the directory.
    + voidsetFailonerror(boolean fail) + +
    +          Deprecated. Set the failOnError attribute.
    + voidsetOs(java.lang.String os) + +
    +          Deprecated. Set the Operating System that this exec is to run in.
    + voidsetOutput(java.lang.String out) + +
    +          Deprecated. Set the output filename.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +fos

    +
    +protected java.io.PrintWriter fos
    +
    +
    Deprecated. 
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Exec

    +
    +public Exec()
    +
    +
    Deprecated. 
    Constructor for Exec. + Prints a warning message to std error. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +run

    +
    +protected int run(java.lang.String command)
+           throws BuildException
    +
    +
    Deprecated. 
    Execute the command. +

    +

    +
    Parameters:
    command - the command to exec +
    Returns:
    the exit value of the command +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.lang.String d)
    +
    +
    Deprecated. 
    Set the directory. +

    +

    +
    Parameters:
    d - a String value
    +
    +
    +
    + +

    +setOs

    +
    +public void setOs(java.lang.String os)
    +
    +
    Deprecated. 
    Set the Operating System that this exec is to run in. +

    +

    +
    Parameters:
    os - a String value
    +
    +
    +
    + +

    +setCommand

    +
    +public void setCommand(java.lang.String command)
    +
    +
    Deprecated. 
    Set the command to exec. +

    +

    +
    Parameters:
    command - a String value
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.lang.String out)
    +
    +
    Deprecated. 
    Set the output filename. +

    +

    +
    Parameters:
    out - a String value
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean fail)
    +
    +
    Deprecated. 
    Set the failOnError attribute. + Default is false. +

    +

    +
    Parameters:
    fail - a boolean value
    +
    +
    +
    + +

    +outputLog

    +
    +protected void outputLog(java.lang.String line,
+                         int messageLevel)
    +
    +
    Deprecated. 
    Log an output message. +

    +

    +
    Parameters:
    line - the line to putput
    messageLevel - the level of logging - ignored + if output is going to a file
    +
    +
    +
    + +

    +logFlush

    +
    +protected void logFlush()
    +
    +
    Deprecated. 
    Close output. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecTask.html new file mode 100644 index 000000000..91e9946a0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecTask.html @@ -0,0 +1,1377 @@ + + + + + + +ExecTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ExecTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    ExecuteOn
    +
    +
    +
    +
    public class ExecTask
    extends Task
    + + +

    +Executes a given command if the os platform is appropriate. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  Commandlinecmdl + +
    +           
    +protected  booleanfailOnError + +
    +           
    +protected  booleannewEnvironment + +
    +           
    +protected  Redirectorredirector + +
    +           
    +protected  RedirectorElementredirectorElement + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    ExecTask() + +
    +          Create an instance.
    ExecTask(Task owner) + +
    +          create an instance that is helping another task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredRedirector(RedirectorElement redirectorElement) + +
    +          Add a RedirectorElement to this task.
    + voidaddEnv(Environment.Variable var) + +
    +          Add an environment variable to the launched process.
    +protected  voidcheckConfiguration() + +
    +          Has the user set all necessary attributes?
    + Commandline.ArgumentcreateArg() + +
    +          Adds a command-line argument.
    +protected  ExecuteStreamHandlercreateHandler() + +
    +          Create the StreamHandler to use with our Execute instance.
    +protected  ExecuteWatchdogcreateWatchdog() + +
    +          Create the Watchdog to kill a runaway process.
    + voidexecute() + +
    +          Do the work.
    + java.lang.StringgetOs() + +
    +          List of operating systems on which the command may be executed.
    + java.lang.StringgetOsFamily() + +
    +          Restrict this execution to a single OS Family
    + booleangetResolveExecutable() + +
    +          Indicates whether to attempt to resolve the executable to a + file.
    +protected  booleanisValidOs() + +
    +          Is this the OS the user wanted?
    +protected  voidlogFlush() + +
    +          Flush the output stream - if there is one.
    +protected  voidmaybeSetResultPropertyValue(int result) + +
    +          Helper method to set result property to the + passed in value if appropriate.
    +protected  ExecuteprepareExec() + +
    +          Create an Execute instance with the correct working directory set.
    +protected  java.lang.StringresolveExecutable(java.lang.String exec, + boolean mustSearchPath) + +
    +          The method attempts to figure out where the executable is so that we can feed + the full path.
    +protected  voidrunExec(Execute exe) + +
    +          Run the command using the given Execute instance.
    +protected  voidrunExecute(Execute exe) + +
    +          A Utility method for this classes and subclasses to run an + Execute instance (an external command).
    + voidsetAppend(boolean append) + +
    +          Set whether output should be appended to or overwrite an existing file.
    + voidsetCommand(Commandline cmdl) + +
    +          Sets a command line.
    + voidsetDir(java.io.File d) + +
    +          Set the working directory of the process.
    + voidsetError(java.io.File error) + +
    +          Set the File to which the error stream of the process should be redirected.
    + voidsetErrorProperty(java.lang.String errorProperty) + +
    +          Sets the name of the property whose value should be set to the error of + the process.
    + voidsetExecutable(java.lang.String value) + +
    +          Set the name of the executable program.
    + voidsetFailIfExecutionFails(boolean flag) + +
    +          Set whether to stop the build if program cannot be started.
    + voidsetFailonerror(boolean fail) + +
    +          Fail if the command exits with a non-zero return code.
    + voidsetInput(java.io.File input) + +
    +          Set the input file to use for the task.
    + voidsetInputString(java.lang.String inputString) + +
    +          Set the string to use as input.
    + voidsetLogError(boolean logError) + +
    +          Controls whether error output of exec is logged.
    + voidsetNewenvironment(boolean newenv) + +
    +          Do not propagate old environment when new environment variables are specified.
    + voidsetOs(java.lang.String os) + +
    +          List of operating systems on which the command may be executed.
    + voidsetOsFamily(java.lang.String osFamily) + +
    +          Restrict this execution to a single OS Family
    + voidsetOutput(java.io.File out) + +
    +          File the output of the process is redirected to.
    + voidsetOutputproperty(java.lang.String outputProp) + +
    +          Sets the property name whose value should be set to the output of + the process.
    + voidsetResolveExecutable(boolean resolveExecutable) + +
    +          Set whether to attempt to resolve the executable to a file.
    + voidsetResultProperty(java.lang.String resultProperty) + +
    +          Sets the name of a property in which the return code of the + command should be stored.
    + voidsetSearchPath(boolean searchPath) + +
    +          Set whether to search nested, then + system PATH environment variables for the executable.
    + voidsetSpawn(boolean spawn) + +
    +          Set whether or not you want the process to be spawned.
    + voidsetTimeout(java.lang.Integer value) + +
    +          Set the timeout in milliseconds after which the process will be killed.
    + voidsetTimeout(java.lang.Long value) + +
    +          Set the timeout in milliseconds after which the process will be killed.
    +protected  voidsetupRedirector() + +
    +          Set up properties on the redirector that we needed to store locally.
    + voidsetVMLauncher(boolean vmLauncher) + +
    +          Set whether to launch new process with VM, otherwise use the OS's shell.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +failOnError

    +
    +protected boolean failOnError
    +
    +
    +
    +
    +
    + +

    +newEnvironment

    +
    +protected boolean newEnvironment
    +
    +
    +
    +
    +
    + +

    +cmdl

    +
    +protected Commandline cmdl
    +
    +
    +
    +
    +
    + +

    +redirector

    +
    +protected Redirector redirector
    +
    +
    +
    +
    +
    + +

    +redirectorElement

    +
    +protected RedirectorElement redirectorElement
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ExecTask

    +
    +public ExecTask()
    +
    +
    Create an instance. + Needs to be configured by binding to a project. +

    +

    +
    + +

    +ExecTask

    +
    +public ExecTask(Task owner)
    +
    +
    create an instance that is helping another task. + Project, OwningTarget, TaskName and description are all + pulled out +

    +

    +
    Parameters:
    owner - task that we belong to
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSpawn

    +
    +public void setSpawn(boolean spawn)
    +
    +
    Set whether or not you want the process to be spawned. + Default is false. +

    +

    +
    Parameters:
    spawn - if true you do not want Ant to wait for the end of the process.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(java.lang.Long value)
    +
    +
    Set the timeout in milliseconds after which the process will be killed. +

    +

    +
    Parameters:
    value - timeout in milliseconds.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(java.lang.Integer value)
    +
    +
    Set the timeout in milliseconds after which the process will be killed. +

    +

    +
    Parameters:
    value - timeout in milliseconds.
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String value)
    +
    +
    Set the name of the executable program. +

    +

    +
    Parameters:
    value - the name of the executable program.
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File d)
    +
    +
    Set the working directory of the process. +

    +

    +
    Parameters:
    d - the working directory of the process.
    +
    +
    +
    + +

    +setOs

    +
    +public void setOs(java.lang.String os)
    +
    +
    List of operating systems on which the command may be executed. +

    +

    +
    Parameters:
    os - list of operating systems on which the command may be executed.
    +
    +
    +
    + +

    +getOs

    +
    +public final java.lang.String getOs()
    +
    +
    List of operating systems on which the command may be executed. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCommand

    +
    +public void setCommand(Commandline cmdl)
    +
    +
    Sets a command line. +

    +

    +
    Parameters:
    cmdl - command line.
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File out)
    +
    +
    File the output of the process is redirected to. If error is not + redirected, it too will appear in the output. +

    +

    +
    Parameters:
    out - name of a file to which output should be sent.
    +
    +
    +
    + +

    +setInput

    +
    +public void setInput(java.io.File input)
    +
    +
    Set the input file to use for the task. +

    +

    +
    Parameters:
    input - name of a file from which to get input.
    +
    +
    +
    + +

    +setInputString

    +
    +public void setInputString(java.lang.String inputString)
    +
    +
    Set the string to use as input. +

    +

    +
    Parameters:
    inputString - the string which is used as the input source.
    +
    +
    +
    + +

    +setLogError

    +
    +public void setLogError(boolean logError)
    +
    +
    Controls whether error output of exec is logged. This is only useful when + output is being redirected and error output is desired in the Ant log. +

    +

    +
    Parameters:
    logError - set to true to log error output in the normal ant log.
    +
    +
    +
    + +

    +setError

    +
    +public void setError(java.io.File error)
    +
    +
    Set the File to which the error stream of the process should be redirected. +

    +

    +
    Parameters:
    error - a file to which stderr should be sent.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setOutputproperty

    +
    +public void setOutputproperty(java.lang.String outputProp)
    +
    +
    Sets the property name whose value should be set to the output of + the process. +

    +

    +
    Parameters:
    outputProp - name of property.
    +
    +
    +
    + +

    +setErrorProperty

    +
    +public void setErrorProperty(java.lang.String errorProperty)
    +
    +
    Sets the name of the property whose value should be set to the error of + the process. +

    +

    +
    Parameters:
    errorProperty - name of property.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean fail)
    +
    +
    Fail if the command exits with a non-zero return code. +

    +

    +
    Parameters:
    fail - if true fail the command on non-zero return code.
    +
    +
    +
    + +

    +setNewenvironment

    +
    +public void setNewenvironment(boolean newenv)
    +
    +
    Do not propagate old environment when new environment variables are specified. +

    +

    +
    Parameters:
    newenv - if true, do not propagate old environment + when new environment variables are specified.
    +
    +
    +
    + +

    +setResolveExecutable

    +
    +public void setResolveExecutable(boolean resolveExecutable)
    +
    +
    Set whether to attempt to resolve the executable to a file. +

    +

    +
    Parameters:
    resolveExecutable - if true, attempt to resolve the + path of the executable.
    +
    +
    +
    + +

    +setSearchPath

    +
    +public void setSearchPath(boolean searchPath)
    +
    +
    Set whether to search nested, then + system PATH environment variables for the executable. +

    +

    +
    Parameters:
    searchPath - if true, search PATHs.
    +
    +
    +
    + +

    +getResolveExecutable

    +
    +public boolean getResolveExecutable()
    +
    +
    Indicates whether to attempt to resolve the executable to a + file. +

    +

    + +
    Returns:
    the resolveExecutable flag
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addEnv

    +
    +public void addEnv(Environment.Variable var)
    +
    +
    Add an environment variable to the launched process. +

    +

    +
    Parameters:
    var - new environment variable.
    +
    +
    +
    + +

    +createArg

    +
    +public Commandline.Argument createArg()
    +
    +
    Adds a command-line argument. +

    +

    + +
    Returns:
    new command line argument created.
    +
    +
    +
    + +

    +setResultProperty

    +
    +public void setResultProperty(java.lang.String resultProperty)
    +
    +
    Sets the name of a property in which the return code of the + command should be stored. Only of interest if failonerror=false. +

    +

    +
    Parameters:
    resultProperty - name of property.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +maybeSetResultPropertyValue

    +
    +protected void maybeSetResultPropertyValue(int result)
    +
    +
    Helper method to set result property to the + passed in value if appropriate. +

    +

    +
    Parameters:
    result - value desired for the result property value.
    +
    +
    +
    + +

    +setFailIfExecutionFails

    +
    +public void setFailIfExecutionFails(boolean flag)
    +
    +
    Set whether to stop the build if program cannot be started. + Defaults to true. +

    +

    +
    Parameters:
    flag - stop the build if program cannot be started.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    Set whether output should be appended to or overwrite an existing file. + Defaults to false. +

    +

    +
    Parameters:
    append - if true append is desired.
    Since:
    +
    1.30, Ant 1.5
    +
    +
    +
    +
    + +

    +addConfiguredRedirector

    +
    +public void addConfiguredRedirector(RedirectorElement redirectorElement)
    +
    +
    Add a RedirectorElement to this task. +

    +

    +
    Parameters:
    redirectorElement - RedirectorElement.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +setOsFamily

    +
    +public void setOsFamily(java.lang.String osFamily)
    +
    +
    Restrict this execution to a single OS Family +

    +

    +
    Parameters:
    osFamily - the family to restrict to.
    +
    +
    +
    + +

    +getOsFamily

    +
    +public final java.lang.String getOsFamily()
    +
    +
    Restrict this execution to a single OS Family +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +resolveExecutable

    +
    +protected java.lang.String resolveExecutable(java.lang.String exec,
+                                             boolean mustSearchPath)
    +
    +
    The method attempts to figure out where the executable is so that we can feed + the full path. We first try basedir, then the exec dir, and then + fallback to the straight executable name (i.e. on the path). +

    +

    +
    Parameters:
    exec - the name of the executable.
    mustSearchPath - if true, the executable will be looked up in + the PATH environment and the absolute path is returned. +
    Returns:
    the executable as a full path if it can be determined.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - in a number of circumstances: +
      +
    • if failIfExecFails is set to true and the process cannot be started
      • +
    • the java13command launcher can send build exceptions
      • +
    • this list is not exhaustive or limitative
      • +
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
+                           throws BuildException
    +
    +
    Has the user set all necessary attributes? +

    +

    + +
    Throws: +
    BuildException - if there are missing required parameters.
    +
    +
    +
    + +

    +setupRedirector

    +
    +protected void setupRedirector()
    +
    +
    Set up properties on the redirector that we needed to store locally. +

    +

    +
    +
    +
    +
    + +

    +isValidOs

    +
    +protected boolean isValidOs()
    +
    +
    Is this the OS the user wanted? +

    +

    + +
    Returns:
    boolean. +
      +
    • +
    • true if the os and osfamily attributes are null.
      • +
    • true if osfamily is set, and the os family and must match + that of the current OS, according to the logic of + Os.isOs(String, String, String, String), and the result of the + os attribute must also evaluate true. +
      • +
    • + true if os is set, and the system.property os.name + is found in the os attribute,
      • +
    • false otherwise.
      • +
    +
    +
    +
    + +

    +setVMLauncher

    +
    +public void setVMLauncher(boolean vmLauncher)
    +
    +
    Set whether to launch new process with VM, otherwise use the OS's shell. + Default value is true. +

    +

    +
    Parameters:
    vmLauncher - true if we want to launch new process with VM, + false if we want to use the OS's shell.
    +
    +
    +
    + +

    +prepareExec

    +
    +protected Execute prepareExec()
+                       throws BuildException
    +
    +
    Create an Execute instance with the correct working directory set. +

    +

    + +
    Returns:
    an instance of the Execute class. +
    Throws: +
    BuildException - under unknown circumstances.
    +
    +
    +
    + +

    +runExecute

    +
    +protected final void runExecute(Execute exe)
+                         throws java.io.IOException
    +
    +
    A Utility method for this classes and subclasses to run an + Execute instance (an external command). +

    +

    +
    Parameters:
    exe - instance of the execute class. +
    Throws: +
    java.io.IOException - in case of problem to attach to the stdin/stdout/stderr + streams of the process.
    +
    +
    +
    + +

    +runExec

    +
    +protected void runExec(Execute exe)
+                throws BuildException
    +
    +
    Run the command using the given Execute instance. This may be + overridden by subclasses. +

    +

    +
    Parameters:
    exe - instance of Execute to run. +
    Throws: +
    BuildException - if the new process could not be started + only if failIfExecFails is set to true (the default).
    +
    +
    +
    + +

    +createHandler

    +
    +protected ExecuteStreamHandler createHandler()
+                                      throws BuildException
    +
    +
    Create the StreamHandler to use with our Execute instance. +

    +

    + +
    Returns:
    instance of ExecuteStreamHandler. +
    Throws: +
    BuildException - under unknown circumstances.
    +
    +
    +
    + +

    +createWatchdog

    +
    +protected ExecuteWatchdog createWatchdog()
+                                  throws BuildException
    +
    +
    Create the Watchdog to kill a runaway process. +

    +

    + +
    Returns:
    instance of ExecuteWatchdog. +
    Throws: +
    BuildException - under unknown circumstances.
    +
    +
    +
    + +

    +logFlush

    +
    +protected void logFlush()
    +
    +
    Flush the output stream - if there is one. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Execute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Execute.html new file mode 100644 index 000000000..3e4bd18ce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Execute.html @@ -0,0 +1,942 @@ + + + + + + +Execute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Execute

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Execute
+
    +
    +
    +
    public class Execute
    extends java.lang.Object
    + + +

    +Runs an external program. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static intINVALID + +
    +          Invalid exit code.
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    Execute() + +
    +          Creates a new execute object using PumpStreamHandler for + stream handling.
    Execute(ExecuteStreamHandler streamHandler) + +
    +          Creates a new execute object.
    Execute(ExecuteStreamHandler streamHandler, + ExecuteWatchdog watchdog) + +
    +          Creates a new execute object.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voidcloseStreams(java.lang.Process process) + +
    +          Close the streams belonging to the given Process.
    + intexecute() + +
    +          Runs a process defined by the command line and returns its exit status.
    + java.lang.String[]getCommandline() + +
    +          Returns the commandline used to create a subprocess.
    + java.lang.String[]getEnvironment() + +
    +          Returns the environment used to create a subprocess.
    +static java.util.MapgetEnvironmentVariables() + +
    +          Find the list of environment variables for this process.
    + intgetExitValue() + +
    +          Query the exit value of the process.
    +static java.util.VectorgetProcEnvironment() + +
    +          Deprecated. use #getEnvironmentVariables instead
    + java.io.FilegetWorkingDirectory() + +
    +          Return the working directory.
    + booleanisFailure() + +
    +          Did this execute return in a failure.
    +static booleanisFailure(int exitValue) + +
    +          Checks whether exitValue signals a failure on the current + system (OS specific).
    + booleankilledProcess() + +
    +          Test for an untimely death of the process.
    +static java.lang.Processlaunch(Project project, + java.lang.String[] command, + java.lang.String[] env, + java.io.File dir, + boolean useVM) + +
    +          Creates a process that runs a command.
    +static voidrunCommand(Task task, + java.lang.String[] cmdline) + +
    +          A utility method that runs an external command.
    + voidsetAntRun(Project project) + +
    +          Set the name of the antRun script using the project's value.
    + voidsetCommandline(java.lang.String[] commandline) + +
    +          Sets the commandline of the subprocess to launch.
    + voidsetEnvironment(java.lang.String[] env) + +
    +          Sets the environment variables for the subprocess to launch.
    +protected  voidsetExitValue(int value) + +
    +          Set the exit value.
    + voidsetNewenvironment(boolean newenv) + +
    +          Set whether to propagate the default environment or not.
    + voidsetSpawn(boolean spawn) + +
    +          Deprecated.  
    + voidsetStreamHandler(ExecuteStreamHandler streamHandler) + +
    +          Set the stream handler to use.
    + voidsetVMLauncher(boolean useVMLauncher) + +
    +          Launch this execution through the VM, where possible, rather than through + the OS's shell.
    + voidsetWorkingDirectory(java.io.File wd) + +
    +          Sets the working directory of the process to execute.
    + voidspawn() + +
    +          Starts a process defined by the command line.
    +static java.lang.StringtoString(java.io.ByteArrayOutputStream bos) + +
    +          ByteArrayOutputStream#toString doesn't seem to work reliably on + OS/390, at least not the way we use it in the execution + context.
    +protected  voidwaitFor(java.lang.Process process) + +
    +          Wait for a given process.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +INVALID

    +
    +public static final int INVALID
    +
    +
    Invalid exit code. + set to Integer.MAX_VALUE +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Execute

    +
    +public Execute()
    +
    +
    Creates a new execute object using PumpStreamHandler for + stream handling. +

    +

    +
    + +

    +Execute

    +
    +public Execute(ExecuteStreamHandler streamHandler)
    +
    +
    Creates a new execute object. +

    +

    +
    Parameters:
    streamHandler - the stream handler used to handle the input and + output streams of the subprocess.
    +
    +
    + +

    +Execute

    +
    +public Execute(ExecuteStreamHandler streamHandler,
+               ExecuteWatchdog watchdog)
    +
    +
    Creates a new execute object. +

    +

    +
    Parameters:
    streamHandler - the stream handler used to handle the input and + output streams of the subprocess.
    watchdog - a watchdog for the subprocess or null to + to disable a timeout for the subprocess.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSpawn

    +
    +public void setSpawn(boolean spawn)
    +
    +
    Deprecated.  +

    +

    Set whether or not you want the process to be spawned. + Default is not spawned. +

    +

    +
    Parameters:
    spawn - if true you do not want Ant + to wait for the end of the process. + Has no influence in here, the calling task contains + and acts accordingly
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getEnvironmentVariables

    +
    +public static java.util.Map getEnvironmentVariables()
    +
    +
    Find the list of environment variables for this process. +

    +

    + +
    Returns:
    a map containing the environment variables.
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +getProcEnvironment

    +
    +public static java.util.Vector getProcEnvironment()
    +
    +
    Deprecated. use #getEnvironmentVariables instead +

    +

    Find the list of environment variables for this process. +

    +

    + +
    Returns:
    a vector containing the environment variables. + The vector elements are strings formatted like variable = value.
    +
    +
    +
    + +

    +toString

    +
    +public static java.lang.String toString(java.io.ByteArrayOutputStream bos)
    +
    +
    ByteArrayOutputStream#toString doesn't seem to work reliably on + OS/390, at least not the way we use it in the execution + context. +

    +

    +
    Parameters:
    bos - the output stream that one wants to read. +
    Returns:
    the output stream as a string, read with + special encodings in the case of z/os and os/400.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setStreamHandler

    +
    +public void setStreamHandler(ExecuteStreamHandler streamHandler)
    +
    +
    Set the stream handler to use. +

    +

    +
    Parameters:
    streamHandler - ExecuteStreamHandler.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getCommandline

    +
    +public java.lang.String[] getCommandline()
    +
    +
    Returns the commandline used to create a subprocess. +

    +

    + +
    Returns:
    the commandline used to create a subprocess.
    +
    +
    +
    + +

    +setCommandline

    +
    +public void setCommandline(java.lang.String[] commandline)
    +
    +
    Sets the commandline of the subprocess to launch. +

    +

    +
    Parameters:
    commandline - the commandline of the subprocess to launch.
    +
    +
    +
    + +

    +setNewenvironment

    +
    +public void setNewenvironment(boolean newenv)
    +
    +
    Set whether to propagate the default environment or not. +

    +

    +
    Parameters:
    newenv - whether to propagate the process environment.
    +
    +
    +
    + +

    +getEnvironment

    +
    +public java.lang.String[] getEnvironment()
    +
    +
    Returns the environment used to create a subprocess. +

    +

    + +
    Returns:
    the environment used to create a subprocess.
    +
    +
    +
    + +

    +setEnvironment

    +
    +public void setEnvironment(java.lang.String[] env)
    +
    +
    Sets the environment variables for the subprocess to launch. +

    +

    +
    Parameters:
    env - array of Strings, each element of which has + an environment variable settings in format key=value.
    +
    +
    +
    + +

    +setWorkingDirectory

    +
    +public void setWorkingDirectory(java.io.File wd)
    +
    +
    Sets the working directory of the process to execute. + +

    This is emulated using the antRun scripts unless the OS is + Windows NT in which case a cmd.exe is spawned, + or MRJ and setting user.dir works, or JDK 1.3 and there is + official support in java.lang.Runtime. +

    +

    +
    Parameters:
    wd - the working directory of the process.
    +
    +
    +
    + +

    +getWorkingDirectory

    +
    +public java.io.File getWorkingDirectory()
    +
    +
    Return the working directory. +

    +

    + +
    Returns:
    the directory as a File.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setAntRun

    +
    +public void setAntRun(Project project)
+               throws BuildException
    +
    +
    Set the name of the antRun script using the project's value. +

    +

    +
    Parameters:
    project - the current project. +
    Throws: +
    BuildException - not clear when it is going to throw an exception, but + it is the method's signature.
    +
    +
    +
    + +

    +setVMLauncher

    +
    +public void setVMLauncher(boolean useVMLauncher)
    +
    +
    Launch this execution through the VM, where possible, rather than through + the OS's shell. In some cases and operating systems using the shell will + allow the shell to perform additional processing such as associating an + executable with a script, etc. +

    +

    +
    Parameters:
    useVMLauncher - true if exec should launch through the VM, + false if the shell should be used to launch the + command.
    +
    +
    +
    + +

    +launch

    +
    +public static java.lang.Process launch(Project project,
+                                       java.lang.String[] command,
+                                       java.lang.String[] env,
+                                       java.io.File dir,
+                                       boolean useVM)
+                                throws java.io.IOException
    +
    +
    Creates a process that runs a command. +

    +

    +
    Parameters:
    project - the Project, only used for logging purposes, may be null.
    command - the command to run.
    env - the environment for the command.
    dir - the working directory for the command.
    useVM - use the built-in exec command for JDK 1.3 if available. +
    Returns:
    the process started. +
    Throws: +
    java.io.IOException - forwarded from the particular launcher used.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +execute

    +
    +public int execute()
+            throws java.io.IOException
    +
    +
    Runs a process defined by the command line and returns its exit status. +

    +

    + +
    Returns:
    the exit status of the subprocess or INVALID. +
    Throws: +
    java.io.IOException - The exception is thrown, if launching + of the subprocess failed.
    +
    +
    +
    + +

    +spawn

    +
    +public void spawn()
+           throws java.io.IOException
    +
    +
    Starts a process defined by the command line. + Ant will not wait for this process, nor log its output. +

    +

    + +
    Throws: +
    java.io.IOException - The exception is thrown, if launching + of the subprocess failed.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +waitFor

    +
    +protected void waitFor(java.lang.Process process)
    +
    +
    Wait for a given process. +

    +

    +
    Parameters:
    process - the process one wants to wait for.
    +
    +
    +
    + +

    +setExitValue

    +
    +protected void setExitValue(int value)
    +
    +
    Set the exit value. +

    +

    +
    Parameters:
    value - exit value of the process.
    +
    +
    +
    + +

    +getExitValue

    +
    +public int getExitValue()
    +
    +
    Query the exit value of the process. +

    +

    + +
    Returns:
    the exit value or Execute.INVALID if no exit value has + been received.
    +
    +
    +
    + +

    +isFailure

    +
    +public static boolean isFailure(int exitValue)
    +
    +
    Checks whether exitValue signals a failure on the current + system (OS specific). + +

    Note that this method relies on the conventions of + the OS, it will return false results if the application you are + running doesn't follow these conventions. One notable + exception is the Java VM provided by HP for OpenVMS - it will + return 0 if successful (like on any other platform), but this + signals a failure on OpenVMS. So if you execute a new Java VM + on OpenVMS, you cannot trust this method.

    +

    +

    +
    Parameters:
    exitValue - the exit value (return code) to be checked. +
    Returns:
    true if exitValue signals a failure.
    +
    +
    +
    + +

    +isFailure

    +
    +public boolean isFailure()
    +
    +
    Did this execute return in a failure. +

    +

    + +
    Returns:
    true if and only if the exit code is interpreted as a failure
    Since:
    +
    Ant1.7
    +
    See Also:
    isFailure(int)
    +
    +
    +
    + +

    +killedProcess

    +
    +public boolean killedProcess()
    +
    +
    Test for an untimely death of the process. +

    +

    + +
    Returns:
    true if a watchdog had to kill the process.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +runCommand

    +
    +public static void runCommand(Task task,
+                              java.lang.String[] cmdline)
+                       throws BuildException
    +
    +
    A utility method that runs an external command. Writes the output and + error streams of the command to the project log. +

    +

    +
    Parameters:
    task - The task that the command is part of. Used for logging
    cmdline - The command to execute. +
    Throws: +
    BuildException - if the command does not exit successfully.
    +
    +
    +
    + +

    +closeStreams

    +
    +public static void closeStreams(java.lang.Process process)
    +
    +
    Close the streams belonging to the given Process. +

    +

    +
    Parameters:
    process - the Process.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteJava.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteJava.html new file mode 100644 index 000000000..5424dda11 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteJava.html @@ -0,0 +1,561 @@ + + + + + + +ExecuteJava (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ExecuteJava

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.ExecuteJava
+
    +
    +
    All Implemented Interfaces:
    java.lang.Runnable, TimeoutObserver
    +
    +
    +
    +
    public class ExecuteJava
    extends java.lang.Object
    implements java.lang.Runnable, TimeoutObserver
    + + +

    +Execute a Java class. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ExecuteJava() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute(Project project) + +
    +          Execute the Java class against the specified Ant Project.
    + intfork(ProjectComponent pc) + +
    +          Run the Java command in a separate VM, this does not give you + the full flexibility of the Java task, but may be enough for + simple needs.
    + booleankilledProcess() + +
    +          Get whether the process was killed.
    + voidrun() + +
    +          Run this ExecuteJava in a Thread.
    + voidsetClasspath(Path p) + +
    +          Set the classpath to be used when running the Java class.
    + voidsetJavaCommand(Commandline javaCommand) + +
    +          Set the Java "command" for this ExecuteJava.
    + voidsetOutput(java.io.PrintStream out) + +
    +          Deprecated. since 1.4.x. + manage output at the task level.
    + voidsetPermissions(Permissions permissions) + +
    +          Set the permissions for the application run.
    + voidsetSystemProperties(CommandlineJava.SysProperties s) + +
    +          Set the system properties to use when running the Java class.
    + voidsetTimeout(java.lang.Long timeout) + +
    +          Set the timeout for this ExecuteJava.
    +static voidsetupCommandLineForVMS(Execute exe, + java.lang.String[] command) + +
    +          On VMS platform, we need to create a special java options file + containing the arguments and classpath for the java command.
    + voidtimeoutOccured(Watchdog w) + +
    +          Mark timeout as having occurred.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExecuteJava

    +
    +public ExecuteJava()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setJavaCommand

    +
    +public void setJavaCommand(Commandline javaCommand)
    +
    +
    Set the Java "command" for this ExecuteJava. +

    +

    +
    +
    +
    +
    Parameters:
    javaCommand - the classname and arguments in a Commandline.
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path p)
    +
    +
    Set the classpath to be used when running the Java class. +

    +

    +
    +
    +
    +
    Parameters:
    p - an Ant Path object containing the classpath.
    +
    +
    +
    + +

    +setSystemProperties

    +
    +public void setSystemProperties(CommandlineJava.SysProperties s)
    +
    +
    Set the system properties to use when running the Java class. +

    +

    +
    +
    +
    +
    Parameters:
    s - CommandlineJava system properties.
    +
    +
    +
    + +

    +setPermissions

    +
    +public void setPermissions(Permissions permissions)
    +
    +
    Set the permissions for the application run. +

    +

    +
    +
    +
    +
    Parameters:
    permissions - the Permissions to use.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.PrintStream out)
    +
    +
    Deprecated. since 1.4.x. + manage output at the task level. +

    +

    Set the stream to which all output (System.out as well as System.err) + will be written. +

    +

    +
    +
    +
    +
    Parameters:
    out - the PrintStream where output should be sent.
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(java.lang.Long timeout)
    +
    +
    Set the timeout for this ExecuteJava. +

    +

    +
    +
    +
    +
    Parameters:
    timeout - timeout as Long.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute(Project project)
+             throws BuildException
    +
    +
    Execute the Java class against the specified Ant Project. +

    +

    +
    +
    +
    +
    Parameters:
    project - the Project to use. +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +run

    +
    +public void run()
    +
    +
    Run this ExecuteJava in a Thread. +

    +

    +
    Specified by:
    run in interface java.lang.Runnable
    +
    +
    +
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +timeoutOccured

    +
    +public void timeoutOccured(Watchdog w)
    +
    +
    Mark timeout as having occurred. +

    +

    +
    Specified by:
    timeoutOccured in interface TimeoutObserver
    +
    +
    +
    Parameters:
    w - the responsible Watchdog.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +killedProcess

    +
    +public boolean killedProcess()
    +
    +
    Get whether the process was killed. +

    +

    +
    +
    +
    + +
    Returns:
    true if the process was killed, false otherwise.
    Since:
    +
    1.19, Ant 1.5
    +
    +
    +
    +
    + +

    +fork

    +
    +public int fork(ProjectComponent pc)
+         throws BuildException
    +
    +
    Run the Java command in a separate VM, this does not give you + the full flexibility of the Java task, but may be enough for + simple needs. +

    +

    +
    +
    +
    +
    Parameters:
    pc - the ProjectComponent to use for logging, etc. +
    Returns:
    the exit status of the subprocess. +
    Throws: +
    BuildException - on error.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setupCommandLineForVMS

    +
    +public static void setupCommandLineForVMS(Execute exe,
+                                          java.lang.String[] command)
    +
    +
    On VMS platform, we need to create a special java options file + containing the arguments and classpath for the java command. + The special file is supported by the "-V" switch on the VMS JVM. +

    +

    +
    +
    +
    +
    Parameters:
    exe - the Execute instance to alter.
    command - the command-line.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.FileDirBoth.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.FileDirBoth.html new file mode 100644 index 000000000..05b44253f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.FileDirBoth.html @@ -0,0 +1,340 @@ + + + + + + +ExecuteOn.FileDirBoth (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ExecuteOn.FileDirBoth

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.ExecuteOn.FileDirBoth
+
    +
    +
    Enclosing class:
    ExecuteOn
    +
    +
    +
    +
    public static class ExecuteOn.FileDirBoth
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "file", "dir" and "both" + for the type attribute. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDIR + +
    +          Dir value
    +static java.lang.StringFILE + +
    +          File value
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    ExecuteOn.FileDirBoth() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FILE

    +
    +public static final java.lang.String FILE
    +
    +
    File value +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DIR

    +
    +public static final java.lang.String DIR
    +
    +
    Dir value +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ExecuteOn.FileDirBoth

    +
    +public ExecuteOn.FileDirBoth()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.html new file mode 100644 index 000000000..abfef6d87 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteOn.html @@ -0,0 +1,1191 @@ + + + + + + +ExecuteOn (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ExecuteOn

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    AbstractAccessTask, Attrib, Chmod, Transform
    +
    +
    +
    +
    public class ExecuteOn
    extends ExecTask
    + + +

    +Executes a given command, supplying a set of files as arguments. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classExecuteOn.FileDirBoth + +
    +          Enumerated attribute with the values "file", "dir" and "both" + for the type attribute.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.FiledestDir + +
    +           
    +protected  java.util.Vectorfilesets + +
    +           
    +protected  FileNameMappermapper + +
    +           
    +protected  MappermapperElement + +
    +           
    +protected  Commandline.MarkersrcFilePos + +
    +           
    +protected  booleansrcIsFirst + +
    +          Has <srcfile> been specified before <targetfile>
    +protected  Commandline.MarkertargetFilePos + +
    +           
    +protected  java.lang.Stringtype + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
    cmdl, failOnError, newEnvironment, redirector, redirectorElement
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ExecuteOn() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Add a nested FileNameMapper.
    + voidadd(ResourceCollection rc) + +
    +          Add a collection of resources upon which to operate.
    + voidaddDirset(DirSet set) + +
    +          Add a set of directories upon which to operate.
    + voidaddFilelist(FileList list) + +
    +          Add a list of source files upon which to operate.
    + voidaddFileset(FileSet set) + +
    +          Add a set of files upon which to operate.
    +protected  voidcheckConfiguration() + +
    +          Check the configuration of this ExecuteOn instance.
    +protected  ExecuteStreamHandlercreateHandler() + +
    +          Create the ExecuteStreamHandler instance that will be used + during execution.
    + MappercreateMapper() + +
    +          Create a nested Mapper element to use for mapping + source files to target files.
    + Commandline.MarkercreateSrcfile() + +
    +          Create a placeholder indicating where on the command line + the name of the source file should be inserted.
    + Commandline.MarkercreateTargetfile() + +
    +          Create a placeholder indicating where on the command line + the name of the target file should be inserted.
    +protected  java.lang.String[]getCommandline(java.lang.String[] srcFiles, + java.io.File[] baseDirs) + +
    +          Construct the command line for parallel execution.
    +protected  java.lang.String[]getCommandline(java.lang.String srcFile, + java.io.File baseDir) + +
    +          Construct the command line for serial execution.
    +protected  java.lang.String[]getDirs(java.io.File baseDir, + DirectoryScanner ds) + +
    +          Return the list of Directories from this DirectoryScanner that + should be included on the command line.
    +protected  java.lang.String[]getFiles(java.io.File baseDir, + DirectoryScanner ds) + +
    +          Return the list of files from this DirectoryScanner that should + be included on the command line.
    +protected  java.lang.String[]getFilesAndDirs(FileList list) + +
    +          Return the list of files or directories from this FileList that + should be included on the command line.
    +protected  voidrunExec(Execute exe) + +
    +          Run the specified Execute object.
    +protected  voidrunParallel(Execute exe, + java.util.Vector fileNames, + java.util.Vector baseDirs) + +
    +          Run the command in "parallel" mode, making sure that at most + maxParallel sourcefiles get passed on the command line.
    + voidsetAddsourcefile(boolean b) + +
    +          Set whether to send the source file name on the command line.
    + voidsetDest(java.io.File destDir) + +
    +          Specify the directory where target files are to be placed.
    + voidsetForce(boolean b) + +
    +          Set whether to bypass timestamp comparisons for target files.
    + voidsetForwardslash(boolean forwardSlash) + +
    +          Set whether the source and target file names on Windows and OS/2 + must use the forward slash as file separator.
    + voidsetIgnoremissing(boolean b) + +
    +          Set whether to ignore nonexistent files from filelists.
    + voidsetMaxParallel(int max) + +
    +          Limit the command line length by passing at maximum this many + sourcefiles at once to the command.
    + voidsetParallel(boolean parallel) + +
    +          Set whether to execute in parallel mode.
    + voidsetRelative(boolean relative) + +
    +          Set whether the filenames should be passed on the command line as + absolute or relative pathnames.
    + voidsetSkipEmptyFilesets(boolean skip) + +
    +          Set whether empty filesets will be skipped.
    + voidsetType(ExecuteOn.FileDirBoth type) + +
    +          Set whether the command works only on files, directories or both.
    +protected  voidsetupRedirector() + +
    +          Set up the I/O Redirector.
    + voidsetVerbose(boolean b) + +
    +          Set whether to operate in verbose mode.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
    addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, isValidOs, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setCommand, setDir, setError, setErrorProperty, setExecutable, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +filesets

    +
    +protected java.util.Vector filesets
    +
    +
    +
    +
    +
    + +

    +type

    +
    +protected java.lang.String type
    +
    +
    +
    +
    +
    + +

    +srcFilePos

    +
    +protected Commandline.Marker srcFilePos
    +
    +
    +
    +
    +
    + +

    +targetFilePos

    +
    +protected Commandline.Marker targetFilePos
    +
    +
    +
    +
    +
    + +

    +mapperElement

    +
    +protected Mapper mapperElement
    +
    +
    +
    +
    +
    + +

    +mapper

    +
    +protected FileNameMapper mapper
    +
    +
    +
    +
    +
    + +

    +destDir

    +
    +protected java.io.File destDir
    +
    +
    +
    +
    +
    + +

    +srcIsFirst

    +
    +protected boolean srcIsFirst
    +
    +
    Has <srcfile> been specified before <targetfile> +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ExecuteOn

    +
    +public ExecuteOn()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Add a set of files upon which to operate. +

    +

    +
    Parameters:
    set - the FileSet to add.
    +
    +
    +
    + +

    +addDirset

    +
    +public void addDirset(DirSet set)
    +
    +
    Add a set of directories upon which to operate. +

    +

    +
    Parameters:
    set - the DirSet to add.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addFilelist

    +
    +public void addFilelist(FileList list)
    +
    +
    Add a list of source files upon which to operate. +

    +

    +
    Parameters:
    list - the FileList to add.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a collection of resources upon which to operate. +

    +

    +
    Parameters:
    rc - resource collection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setRelative

    +
    +public void setRelative(boolean relative)
    +
    +
    Set whether the filenames should be passed on the command line as + absolute or relative pathnames. Paths are relative to the base + directory of the corresponding fileset for source files or the + dest attribute for target files. +

    +

    +
    Parameters:
    relative - whether to pass relative pathnames.
    +
    +
    +
    + +

    +setParallel

    +
    +public void setParallel(boolean parallel)
    +
    +
    Set whether to execute in parallel mode. + If true, run the command only once, appending all files as arguments. + If false, command will be executed once for every file. Defaults to false. +

    +

    +
    Parameters:
    parallel - whether to run in parallel.
    +
    +
    +
    + +

    +setType

    +
    +public void setType(ExecuteOn.FileDirBoth type)
    +
    +
    Set whether the command works only on files, directories or both. +

    +

    +
    Parameters:
    type - a FileDirBoth EnumeratedAttribute.
    +
    +
    +
    + +

    +setSkipEmptyFilesets

    +
    +public void setSkipEmptyFilesets(boolean skip)
    +
    +
    Set whether empty filesets will be skipped. If true and + no source files have been found or are newer than their + corresponding target files, the command will not be run. +

    +

    +
    Parameters:
    skip - whether to skip empty filesets.
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File destDir)
    +
    +
    Specify the directory where target files are to be placed. +

    +

    +
    Parameters:
    destDir - the File object representing the destination directory.
    +
    +
    +
    + +

    +setForwardslash

    +
    +public void setForwardslash(boolean forwardSlash)
    +
    +
    Set whether the source and target file names on Windows and OS/2 + must use the forward slash as file separator. +

    +

    +
    Parameters:
    forwardSlash - whether the forward slash will be forced.
    +
    +
    +
    + +

    +setMaxParallel

    +
    +public void setMaxParallel(int max)
    +
    +
    Limit the command line length by passing at maximum this many + sourcefiles at once to the command. + +

    Set to <= 0 for unlimited - this is the default.

    +

    +

    +
    Parameters:
    max - int maximum number of sourcefiles + passed to the executable.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setAddsourcefile

    +
    +public void setAddsourcefile(boolean b)
    +
    +
    Set whether to send the source file name on the command line. + +

    Defaults to true. +

    +

    +
    Parameters:
    b - whether to add the source file to the command line.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean b)
    +
    +
    Set whether to operate in verbose mode. + If true, a verbose summary will be printed after execution. +

    +

    +
    Parameters:
    b - whether to operate in verbose mode.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setIgnoremissing

    +
    +public void setIgnoremissing(boolean b)
    +
    +
    Set whether to ignore nonexistent files from filelists. +

    +

    +
    Parameters:
    b - whether to ignore missing files.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean b)
    +
    +
    Set whether to bypass timestamp comparisons for target files. +

    +

    +
    Parameters:
    b - whether to bypass timestamp comparisons.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createSrcfile

    +
    +public Commandline.Marker createSrcfile()
    +
    +
    Create a placeholder indicating where on the command line + the name of the source file should be inserted. +

    +

    + +
    Returns:
    Commandline.Marker.
    +
    +
    +
    + +

    +createTargetfile

    +
    +public Commandline.Marker createTargetfile()
    +
    +
    Create a placeholder indicating where on the command line + the name of the target file should be inserted. +

    +

    + +
    Returns:
    Commandline.Marker.
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Create a nested Mapper element to use for mapping + source files to target files. +

    +

    + +
    Returns:
    Mapper. +
    Throws: +
    BuildException - if more than one mapper is defined.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    Add a nested FileNameMapper. +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
    +
    +
    Check the configuration of this ExecuteOn instance. +

    +

    +
    Overrides:
    checkConfiguration in class ExecTask
    +
    +
    +
    +
    +
    +
    + +

    +createHandler

    +
    +protected ExecuteStreamHandler createHandler()
+                                      throws BuildException
    +
    +
    Create the ExecuteStreamHandler instance that will be used + during execution. +

    +

    +
    Overrides:
    createHandler in class ExecTask
    +
    +
    + +
    Returns:
    ExecuteStreamHandler. +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +setupRedirector

    +
    +protected void setupRedirector()
    +
    +
    Set up the I/O Redirector. +

    +

    +
    Overrides:
    setupRedirector in class ExecTask
    +
    +
    +
    +
    +
    +
    + +

    +runExec

    +
    +protected void runExec(Execute exe)
+                throws BuildException
    +
    +
    Run the specified Execute object. +

    +

    +
    Overrides:
    runExec in class ExecTask
    +
    +
    +
    Parameters:
    exe - the Execute instance representing the external process. +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getCommandline

    +
    +protected java.lang.String[] getCommandline(java.lang.String[] srcFiles,
+                                            java.io.File[] baseDirs)
    +
    +
    Construct the command line for parallel execution. +

    +

    +
    Parameters:
    srcFiles - The filenames to add to the commandline.
    baseDirs - filenames are relative to this dir. +
    Returns:
    the command line in the form of a String[].
    +
    +
    +
    + +

    +getCommandline

    +
    +protected java.lang.String[] getCommandline(java.lang.String srcFile,
+                                            java.io.File baseDir)
    +
    +
    Construct the command line for serial execution. +

    +

    +
    Parameters:
    srcFile - The filename to add to the commandline.
    baseDir - filename is relative to this dir. +
    Returns:
    the command line in the form of a String[].
    +
    +
    +
    + +

    +getFiles

    +
    +protected java.lang.String[] getFiles(java.io.File baseDir,
+                                      DirectoryScanner ds)
    +
    +
    Return the list of files from this DirectoryScanner that should + be included on the command line. +

    +

    +
    Parameters:
    baseDir - the File base directory.
    ds - the DirectoryScanner to use for file scanning. +
    Returns:
    a String[] containing the filenames.
    +
    +
    +
    + +

    +getDirs

    +
    +protected java.lang.String[] getDirs(java.io.File baseDir,
+                                     DirectoryScanner ds)
    +
    +
    Return the list of Directories from this DirectoryScanner that + should be included on the command line. +

    +

    +
    Parameters:
    baseDir - the File base directory.
    ds - the DirectoryScanner to use for file scanning. +
    Returns:
    a String[] containing the directory names.
    +
    +
    +
    + +

    +getFilesAndDirs

    +
    +protected java.lang.String[] getFilesAndDirs(FileList list)
    +
    +
    Return the list of files or directories from this FileList that + should be included on the command line. +

    +

    +
    Parameters:
    list - the FileList to check. +
    Returns:
    a String[] containing the directory names.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +runParallel

    +
    +protected void runParallel(Execute exe,
+                           java.util.Vector fileNames,
+                           java.util.Vector baseDirs)
+                    throws java.io.IOException,
+                           BuildException
    +
    +
    Run the command in "parallel" mode, making sure that at most + maxParallel sourcefiles get passed on the command line. +

    +

    +
    Parameters:
    exe - the Executable to use.
    fileNames - the Vector of filenames.
    baseDirs - the Vector of base directories corresponding to fileNames. +
    Throws: +
    java.io.IOException - on I/O errors. +
    BuildException - on other errors.
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html new file mode 100644 index 000000000..f303a14b4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteStreamHandler.html @@ -0,0 +1,315 @@ + + + + + + +ExecuteStreamHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface ExecuteStreamHandler

    +
    +
    All Known Subinterfaces:
    P4Handler
    +
    +
    +
    All Known Implementing Classes:
    BorlandDeploymentTool, CCMCreateTask, JikesOutputParser, JUnitTask.JUnitLogStreamHandler, LogStreamHandler, P4HandlerAdapter, P4Submit.P4SubmitAdapter, PumpStreamHandler, SimpleP4OutputHandler
    +
    +
    +
    +
    public interface ExecuteStreamHandler
    + + +

    +Used by Execute to handle input and output stream of + subprocesses. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidsetProcessErrorStream(java.io.InputStream is) + +
    +          Install a handler for the error stream of the subprocess.
    + voidsetProcessInputStream(java.io.OutputStream os) + +
    +          Install a handler for the input stream of the subprocess.
    + voidsetProcessOutputStream(java.io.InputStream is) + +
    +          Install a handler for the output stream of the subprocess.
    + voidstart() + +
    +          Start handling of the streams.
    + voidstop() + +
    +          Stop handling of the streams - will not be restarted.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setProcessInputStream

    +
    +void setProcessInputStream(java.io.OutputStream os)
+                           throws java.io.IOException
    +
    +
    Install a handler for the input stream of the subprocess. +

    +

    +
    Parameters:
    os - output stream to write to the standard input stream of the + subprocess +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +setProcessErrorStream

    +
    +void setProcessErrorStream(java.io.InputStream is)
+                           throws java.io.IOException
    +
    +
    Install a handler for the error stream of the subprocess. +

    +

    +
    Parameters:
    is - input stream to read from the error stream from the subprocess +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +setProcessOutputStream

    +
    +void setProcessOutputStream(java.io.InputStream is)
+                            throws java.io.IOException
    +
    +
    Install a handler for the output stream of the subprocess. +

    +

    +
    Parameters:
    is - input stream to read from the error stream from the subprocess +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +start

    +
    +void start()
+           throws java.io.IOException
    +
    +
    Start handling of the streams. +

    +

    + +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +stop

    +
    +void stop()
    +
    +
    Stop handling of the streams - will not be restarted. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteWatchdog.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteWatchdog.html new file mode 100644 index 000000000..31b6d9ed9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ExecuteWatchdog.html @@ -0,0 +1,462 @@ + + + + + + +ExecuteWatchdog (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ExecuteWatchdog

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.ExecuteWatchdog
+
    +
    +
    All Implemented Interfaces:
    TimeoutObserver
    +
    +
    +
    +
    public class ExecuteWatchdog
    extends java.lang.Object
    implements TimeoutObserver
    + + +

    +Destroys a process running for too long. + For example: + 

    + ExecuteWatchdog watchdog = new ExecuteWatchdog(30000);
+ Execute exec = new Execute(myloghandler, watchdog);
+ exec.setCommandLine(mycmdline);
+ int exitvalue = exec.execute();
+ if (Execute.isFailure(exitvalue) && watchdog.killedProcess()) {
+              // it was killed on purpose by the watchdog
+ }
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    See Also:
    Execute, +Watchdog
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    ExecuteWatchdog(int timeout) + +
    +          Deprecated. since 1.5.x. + Use constructor with a long type instead. + (1.4.x compatibility)
    ExecuteWatchdog(long timeout) + +
    +          Creates a new watchdog with a given timeout.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckException() + +
    +          This method will rethrow the exception that was possibly caught during + the run of the process.
    +protected  voidcleanUp() + +
    +          reset the monitor flag and the process.
    + booleanisWatching() + +
    +          Indicates whether or not the watchdog is still monitoring the process.
    + booleankilledProcess() + +
    +          Indicates whether the last process run was killed on timeout or not.
    + voidstart(java.lang.Process process) + +
    +          Watches the given process and terminates it, if it runs for too long.
    + voidstop() + +
    +          Stops the watcher.
    + voidtimeoutOccured(Watchdog w) + +
    +          Called after watchdog has finished.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ExecuteWatchdog

    +
    +public ExecuteWatchdog(long timeout)
    +
    +
    Creates a new watchdog with a given timeout. +

    +

    +
    Parameters:
    timeout - the timeout for the process in milliseconds. + It must be greater than 0.
    +
    +
    + +

    +ExecuteWatchdog

    +
    +public ExecuteWatchdog(int timeout)
    +
    +
    Deprecated. since 1.5.x. + Use constructor with a long type instead. + (1.4.x compatibility) +

    +

    +
    Parameters:
    timeout - the timeout value to use in milliseconds.
    See Also:
    ExecuteWatchdog(long)
    +
    + + + + + + + + +
    +Method Detail
    + +

    +start

    +
    +public void start(java.lang.Process process)
    +
    +
    Watches the given process and terminates it, if it runs for too long. + All information from the previous run are reset. +

    +

    +
    +
    +
    +
    Parameters:
    process - the process to monitor. It cannot be null +
    Throws: +
    java.lang.IllegalStateException - if a process is still being monitored.
    +
    +
    +
    + +

    +stop

    +
    +public void stop()
    +
    +
    Stops the watcher. It will notify all threads possibly waiting + on this object. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +timeoutOccured

    +
    +public void timeoutOccured(Watchdog w)
    +
    +
    Called after watchdog has finished. + This can be called in the watchdog thread +

    +

    +
    Specified by:
    timeoutOccured in interface TimeoutObserver
    +
    +
    +
    Parameters:
    w - the watchdog
    +
    +
    +
    + +

    +cleanUp

    +
    +protected void cleanUp()
    +
    +
    reset the monitor flag and the process. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +checkException

    +
    +public void checkException()
+                    throws BuildException
    +
    +
    This method will rethrow the exception that was possibly caught during + the run of the process. It will only remains valid once the process has + been terminated either by 'error', timeout or manual intervention. + Information will be discarded once a new process is ran. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - a wrapped exception over the one that was + silently swallowed and stored during the process run.
    +
    +
    +
    + +

    +isWatching

    +
    +public boolean isWatching()
    +
    +
    Indicates whether or not the watchdog is still monitoring the process. +

    +

    +
    +
    +
    + +
    Returns:
    true if the process is still running, otherwise + false.
    +
    +
    +
    + +

    +killedProcess

    +
    +public boolean killedProcess()
    +
    +
    Indicates whether the last process run was killed on timeout or not. +

    +

    +
    +
    +
    + +
    Returns:
    true if the process was killed otherwise + false.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exit.html new file mode 100644 index 000000000..27367b1f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Exit.html @@ -0,0 +1,518 @@ + + + + + + +Exit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Exit

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Exit
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Exit
    extends Task
    + + +

    +Exits the active build, giving an additional message + if available. + + The if and unless attributes make the + failure conditional -both probe for the named property being defined. + The if tests for the property being defined, the + unless for a property being undefined. + + If both attributes are set, then the test fails only if both tests + are true. i.e. + 

    fail := defined(ifProperty) && !defined(unlessProperty)
    + + A single nested<condition> element can be specified + instead of using if/unless (a combined + effect can be achieved using isset conditions). +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Exit() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String msg) + +
    +          Set a multiline message.
    + ConditionBasecreateCondition() + +
    +          Add a condition element.
    + voidexecute() + +
    +          Throw a BuildException to exit (fail) the build.
    + voidsetIf(java.lang.Object c) + +
    +          Only fail if the given expression evaluates to true or the name + of an existing property.
    + voidsetIf(java.lang.String c) + +
    +          Only fail if the given expression evaluates to true or the name + of an existing property.
    + voidsetMessage(java.lang.String value) + +
    +          A message giving further information on why the build exited.
    + voidsetStatus(int i) + +
    +          Set the status code to associate with the thrown Exception.
    + voidsetUnless(java.lang.Object c) + +
    +          Only fail if the given expression evaluates to false or tno + property of the given name exists.
    + voidsetUnless(java.lang.String c) + +
    +          Only fail if the given expression evaluates to false or tno + property of the given name exists.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Exit

    +
    +public Exit()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMessage

    +
    +public void setMessage(java.lang.String value)
    +
    +
    A message giving further information on why the build exited. +

    +

    +
    Parameters:
    value - message to output
    +
    +
    +
    + +

    +setIf

    +
    +public void setIf(java.lang.Object c)
    +
    +
    Only fail if the given expression evaluates to true or the name + of an existing property. +

    +

    +
    Parameters:
    c - property name or evaluated expression
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setIf

    +
    +public void setIf(java.lang.String c)
    +
    +
    Only fail if the given expression evaluates to true or the name + of an existing property. +

    +

    +
    Parameters:
    c - property name or evaluated expression
    +
    +
    +
    + +

    +setUnless

    +
    +public void setUnless(java.lang.Object c)
    +
    +
    Only fail if the given expression evaluates to false or tno + property of the given name exists. +

    +

    +
    Parameters:
    c - property name or evaluated expression
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setUnless

    +
    +public void setUnless(java.lang.String c)
    +
    +
    Only fail if the given expression evaluates to false or tno + property of the given name exists. +

    +

    +
    Parameters:
    c - property name or evaluated expression
    +
    +
    +
    + +

    +setStatus

    +
    +public void setStatus(int i)
    +
    +
    Set the status code to associate with the thrown Exception. +

    +

    +
    Parameters:
    i - the int status
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Throw a BuildException to exit (fail) the build. + If specified, evaluate conditions: + A single nested condition is accepted, but requires that the + if/unless attributes be omitted. + If the nested condition evaluates to true, or the + ifCondition is true or unlessCondition is false, the build will exit. + The error message is constructed from the text fields, from + the nested condition (if specified), or finally from + the if and unless parameters (if present). +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String msg)
    +
    +
    Set a multiline message. +

    +

    +
    Parameters:
    msg - the message to display
    +
    +
    +
    + +

    +createCondition

    +
    +public ConditionBase createCondition()
    +
    +
    Add a condition element. +

    +

    + +
    Returns:
    ConditionBase.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Expand.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Expand.html new file mode 100644 index 000000000..134f934f0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Expand.html @@ -0,0 +1,864 @@ + + + + + + +Expand (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Expand

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Expand
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Untar
    +
    +
    +
    +
    public class Expand
    extends Task
    + + +

    +Unzip a file. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_MULTIPLE_MAPPERS + +
    +          Error message when more that one mapper is defined
    +static java.lang.StringNATIVE_ENCODING + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Expand() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          A nested filenamemapper
    + voidadd(ResourceCollection rc) + +
    +          Add a resource collection.
    + voidaddFileset(FileSet set) + +
    +          Add a fileset
    + voidaddPatternset(PatternSet set) + +
    +          Add a patternset.
    + MappercreateMapper() + +
    +          Defines the mapper to map source entries to destination files.
    + voidexecute() + +
    +          Do the work.
    +protected  voidexpandFile(FileUtils fileUtils, + java.io.File srcF, + java.io.File dir) + +
    +          This method is to be overridden by extending unarchival tasks.
    +protected  voidexpandResource(Resource srcR, + java.io.File dir) + +
    +          This method is to be overridden by extending unarchival tasks.
    +protected  voidextractFile(FileUtils fileUtils, + java.io.File srcF, + java.io.File dir, + java.io.InputStream compressedInputStream, + java.lang.String entryName, + java.util.Date entryDate, + boolean isDirectory, + FileNameMapper mapper) + +
    +          extract a file to a directory
    + java.lang.StringgetEncoding() + +
    +           
    + booleangetFailOnEmptyArchive() + +
    +          Whether try ing to expand an empty archive would be an error.
    +protected  FileNameMappergetMapper() + +
    +          get a mapper for a file
    + booleangetScanForUnicodeExtraFields() + +
    +           
    +protected  voidinternalSetEncoding(java.lang.String encoding) + +
    +          Supports grand-children that want to support the attribute + where the child-class doesn't (i.e.
    +protected  voidinternalSetScanForUnicodeExtraFields(boolean b) + +
    +          Supports grand-children that want to support the attribute + where the child-class doesn't (i.e.
    + voidsetDest(java.io.File d) + +
    +          Set the destination directory.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Sets the encoding to assume for file names and comments.
    + voidsetFailOnEmptyArchive(boolean b) + +
    +          Whether try ing to expand an empty archive would be an error.
    + voidsetOverwrite(boolean b) + +
    +          Should we overwrite files in dest, even if they are newer than + the corresponding entries in the archive?
    + voidsetScanForUnicodeExtraFields(boolean b) + +
    +          Whether unicode extra fields will be used if present.
    + voidsetSrc(java.io.File s) + +
    +          Set the path to zip-file.
    + voidsetStripAbsolutePathSpec(boolean b) + +
    +          Whether leading path separators should be stripped.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NATIVE_ENCODING

    +
    +public static final java.lang.String NATIVE_ENCODING
    +
    +
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_MULTIPLE_MAPPERS

    +
    +public static final java.lang.String ERROR_MULTIPLE_MAPPERS
    +
    +
    Error message when more that one mapper is defined +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Expand

    +
    +public Expand()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFailOnEmptyArchive

    +
    +public void setFailOnEmptyArchive(boolean b)
    +
    +
    Whether try ing to expand an empty archive would be an error. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getFailOnEmptyArchive

    +
    +public boolean getFailOnEmptyArchive()
    +
    +
    Whether try ing to expand an empty archive would be an error. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - Thrown in unrecoverable error.
    +
    +
    +
    + +

    +expandFile

    +
    +protected void expandFile(FileUtils fileUtils,
+                          java.io.File srcF,
+                          java.io.File dir)
    +
    +
    This method is to be overridden by extending unarchival tasks. +

    +

    +
    Parameters:
    fileUtils - the fileUtils
    srcF - the source file
    dir - the destination directory
    +
    +
    +
    + +

    +expandResource

    +
    +protected void expandResource(Resource srcR,
+                              java.io.File dir)
    +
    +
    This method is to be overridden by extending unarchival tasks. +

    +

    +
    Parameters:
    srcR - the source resource
    dir - the destination directory
    +
    +
    +
    + +

    +getMapper

    +
    +protected FileNameMapper getMapper()
    +
    +
    get a mapper for a file +

    +

    + +
    Returns:
    a filenamemapper for a file
    +
    +
    +
    + +

    +extractFile

    +
    +protected void extractFile(FileUtils fileUtils,
+                           java.io.File srcF,
+                           java.io.File dir,
+                           java.io.InputStream compressedInputStream,
+                           java.lang.String entryName,
+                           java.util.Date entryDate,
+                           boolean isDirectory,
+                           FileNameMapper mapper)
+                    throws java.io.IOException
    +
    +
    extract a file to a directory +

    +

    +
    Parameters:
    fileUtils - a fileUtils object
    srcF - the source file
    dir - the destination directory
    compressedInputStream - the input stream
    entryName - the name of the entry
    entryDate - the date of the entry
    isDirectory - if this is true the entry is a directory
    mapper - the filename mapper to use +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File d)
    +
    +
    Set the destination directory. File will be unzipped into the + destination directory. +

    +

    +
    Parameters:
    d - Path to the directory.
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File s)
    +
    +
    Set the path to zip-file. +

    +

    +
    Parameters:
    s - Path to zip-file.
    +
    +
    +
    + +

    +setOverwrite

    +
    +public void setOverwrite(boolean b)
    +
    +
    Should we overwrite files in dest, even if they are newer than + the corresponding entries in the archive? +

    +

    +
    Parameters:
    b - a boolean value
    +
    +
    +
    + +

    +addPatternset

    +
    +public void addPatternset(PatternSet set)
    +
    +
    Add a patternset. +

    +

    +
    Parameters:
    set - a pattern set
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Add a fileset +

    +

    +
    Parameters:
    set - a file set
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a resource collection. +

    +

    +
    Parameters:
    rc - a resource collection.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Defines the mapper to map source entries to destination files. +

    +

    + +
    Returns:
    a mapper to be configured +
    Throws: +
    BuildException - if more than one mapper is defined
    Since:
    +
    Ant1.7
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    A nested filenamemapper +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Sets the encoding to assume for file names and comments. + +

    Set to native-encoding if you want your + platform's native encoding, defaults to UTF8.

    +

    +

    +
    Parameters:
    encoding - the name of the character encoding
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +internalSetEncoding

    +
    +protected void internalSetEncoding(java.lang.String encoding)
    +
    +
    Supports grand-children that want to support the attribute + where the child-class doesn't (i.e. Unzip in the compress + Antlib). +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getEncoding

    +
    +public java.lang.String getEncoding()
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setStripAbsolutePathSpec

    +
    +public void setStripAbsolutePathSpec(boolean b)
    +
    +
    Whether leading path separators should be stripped. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setScanForUnicodeExtraFields

    +
    +public void setScanForUnicodeExtraFields(boolean b)
    +
    +
    Whether unicode extra fields will be used if present. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +internalSetScanForUnicodeExtraFields

    +
    +protected void internalSetScanForUnicodeExtraFields(boolean b)
    +
    +
    Supports grand-children that want to support the attribute + where the child-class doesn't (i.e. Unzip in the compress + Antlib). +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getScanForUnicodeExtraFields

    +
    +public boolean getScanForUnicodeExtraFields()
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Filter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Filter.html new file mode 100644 index 000000000..703d7535a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Filter.html @@ -0,0 +1,403 @@ + + + + + + +Filter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Filter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Filter
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Filter
    extends Task
    + + +

    +Sets a token filter that is used by the file copy tasks + to do token substitution. Sets multiple tokens by + reading these from a file. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Filter() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute the task.
    +protected  voidreadFilters() + +
    +          Read the filters.
    + voidsetFiltersfile(java.io.File filtersFile) + +
    +          The file from which the filters must be read.
    + voidsetToken(java.lang.String token) + +
    +          The token string without @ delimiters.
    + voidsetValue(java.lang.String value) + +
    +          The string that should replace the token during filtered copies.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Filter

    +
    +public Filter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setToken

    +
    +public void setToken(java.lang.String token)
    +
    +
    The token string without @ delimiters. +

    +

    +
    Parameters:
    token - token to set
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    The string that should replace the token during filtered copies. +

    +

    +
    Parameters:
    value - token replace value
    +
    +
    +
    + +

    +setFiltersfile

    +
    +public void setFiltersfile(java.io.File filtersFile)
    +
    +
    The file from which the filters must be read. + This file must be a formatted as a property file. +

    +

    +
    Parameters:
    filtersFile - filter file
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +readFilters

    +
    +protected void readFilters()
+                    throws BuildException
    +
    +
    Read the filters. +

    +

    + +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.AddAsisRemove.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.AddAsisRemove.html new file mode 100644 index 000000000..071c75552 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.AddAsisRemove.html @@ -0,0 +1,290 @@ + + + + + + +FixCRLF.AddAsisRemove (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class FixCRLF.AddAsisRemove

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.FixCRLF.AddAsisRemove
+
    +
    +
    Enclosing class:
    FixCRLF
    +
    +
    +
    +
    public static class FixCRLF.AddAsisRemove
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "asis", "add" and "remove". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    FixCRLF.AddAsisRemove() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCRLF.AddAsisRemove

    +
    +public FixCRLF.AddAsisRemove()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html new file mode 100644 index 000000000..c88481de1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.CrLf.html @@ -0,0 +1,290 @@ + + + + + + +FixCRLF.CrLf (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class FixCRLF.CrLf

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.FixCRLF.CrLf
+
    +
    +
    Enclosing class:
    FixCRLF
    +
    +
    +
    +
    public static class FixCRLF.CrLf
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "asis", "cr", "lf" and "crlf". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    FixCRLF.CrLf() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCRLF.CrLf

    +
    +public FixCRLF.CrLf()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.OneLiner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.OneLiner.html new file mode 100644 index 000000000..b2ffc9122 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.OneLiner.html @@ -0,0 +1,426 @@ + + + + + + +FixCRLF.OneLiner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class FixCRLF.OneLiner

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.FixCRLF.OneLiner
+
    +
    +
    All Implemented Interfaces:
    java.util.Enumeration
    +
    +
    +
    Enclosing class:
    FixCRLF
    +
    +
    +Deprecated. since 1.7.0. +

    +

    +
    protected class FixCRLF.OneLiner
    extends java.lang.Object
    implements java.util.Enumeration
    + + +

    +Deprecated, the functionality has been moved to filters.FixCrLfFilter. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    FixCRLF.OneLiner(java.io.File srcFile) + +
    +          Deprecated. Constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidclose() + +
    +          Deprecated. Close the reader.
    + java.lang.StringgetEofStr() + +
    +          Deprecated. get the eof string.
    + intgetState() + +
    +          Deprecated. get the state.
    + booleanhasMoreElements() + +
    +          Deprecated.  
    + java.lang.ObjectnextElement() + +
    +          Deprecated. get the next element.
    +protected  voidnextLine() + +
    +          Deprecated. Move to the next line.
    + voidsetState(int state) + +
    +          Deprecated. Set the state.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCRLF.OneLiner

    +
    +public FixCRLF.OneLiner(java.io.File srcFile)
+                 throws BuildException
    +
    +
    Deprecated. 
    Constructor. +

    +

    +
    Parameters:
    srcFile - the file to read. +
    Throws: +
    BuildException - if there is an error.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +nextLine

    +
    +protected void nextLine()
+                 throws BuildException
    +
    +
    Deprecated. 
    Move to the next line. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException - if there is an error.
    +
    +
    +
    + +

    +getEofStr

    +
    +public java.lang.String getEofStr()
    +
    +
    Deprecated. 
    get the eof string. +

    +

    +
    +
    +
    + +
    Returns:
    the eof string.
    +
    +
    +
    + +

    +getState

    +
    +public int getState()
    +
    +
    Deprecated. 
    get the state. +

    +

    +
    +
    +
    + +
    Returns:
    the state.
    +
    +
    +
    + +

    +setState

    +
    +public void setState(int state)
    +
    +
    Deprecated. 
    Set the state. +

    +

    +
    +
    +
    +
    Parameters:
    state - the value to use.
    +
    +
    +
    + +

    +hasMoreElements

    +
    +public boolean hasMoreElements()
    +
    +
    Deprecated. 
    +
    Specified by:
    hasMoreElements in interface java.util.Enumeration
    +
    +
    + +
    Returns:
    true if there is more elements.
    +
    +
    +
    + +

    +nextElement

    +
    +public java.lang.Object nextElement()
+                             throws java.util.NoSuchElementException
    +
    +
    Deprecated. 
    get the next element. +

    +

    +
    Specified by:
    nextElement in interface java.util.Enumeration
    +
    +
    + +
    Returns:
    the next element. +
    Throws: +
    java.util.NoSuchElementException - if there is no more.
    +
    +
    +
    + +

    +close

    +
    +public void close()
+           throws java.io.IOException
    +
    +
    Deprecated. 
    Close the reader. +

    +

    +
    +
    +
    + +
    Throws: +
    java.io.IOException - if there is an error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.html new file mode 100644 index 000000000..259c04d5f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/FixCRLF.html @@ -0,0 +1,808 @@ + + + + + + +FixCRLF (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class FixCRLF

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.FixCRLF
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ChainableReader, SelectorContainer
    +
    +
    +
    +
    public class FixCRLF
    extends MatchingTask
    implements ChainableReader
    + + +

    +Converts text source files to local OS formatting conventions, as + well as repair text files damaged by misconfigured or misguided editors or + file transfer programs. +

    + This task can take the following arguments: +

      +
    • srcdir +
    • destdir +
    • include +
    • exclude +
    • cr +
    • eol +
    • tab +
    • eof +
    • encoding +
    • targetencoding +
    + Of these arguments, only sourcedir is required. +

    + When this task executes, it will scan the srcdir based on the include + and exclude properties. +

    + This version generalises the handling of EOL characters, and allows + for CR-only line endings (the standard on Mac systems prior to OS X). + Tab handling has also been generalised to accommodate any tabwidth + from 2 to 80, inclusive. Importantly, it will leave untouched any + literal TAB characters embedded within string or character constants. +

    + Warning: do not run on binary files. + Caution: run with care on carefully formatted files. + This may sound obvious, but if you don't specify asis, presume that + your files are going to be modified. If "tabs" is "add" or "remove", + whitespace characters may be added or removed as necessary. Similarly, + for CR's - in fact "eol"="crlf" or cr="add" can result in cr + characters being removed in one special case accommodated, i.e., + CRCRLF is regarded as a single EOL to handle cases where other + programs have converted CRLF into CRCRLF. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classFixCRLF.AddAsisRemove + +
    +          Enumerated attribute with the values "asis", "add" and "remove".
    +static classFixCRLF.CrLf + +
    +          Enumerated attribute with the values "asis", "cr", "lf" and "crlf".
    +protected  classFixCRLF.OneLiner + +
    +          Deprecated. since 1.7.0.
    +  + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_FILE_AND_SRCDIR + +
    +          error string for using srcdir and file
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    FixCRLF() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.Readerchain(java.io.Reader rdr) + +
    +          Chain this task as a reader.
    + voidexecute() + +
    +          Executes the task.
    + voidsetCr(FixCRLF.AddAsisRemove attr) + +
    +          Deprecated. since 1.4.x. + Use setEol instead.
    + voidsetDestdir(java.io.File destDir) + +
    +          Set the destination where the fixed files should be placed.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Specifies the encoding Ant expects the files to be + in--defaults to the platforms default encoding.
    + voidsetEof(FixCRLF.AddAsisRemove attr) + +
    +          Specify how DOS EOF (control-z) characters are to be handled.
    + voidsetEol(FixCRLF.CrLf attr) + +
    +          Specify how EndOfLine characters are to be handled.
    + voidsetFile(java.io.File file) + +
    +          Set a single file to convert.
    + voidsetFixlast(boolean fixlast) + +
    +          Specify whether a missing EOL will be added + to the final line of a file.
    + voidsetJavafiles(boolean javafiles) + +
    +          Set to true if modifying Java source files.
    + voidsetOutputEncoding(java.lang.String outputEncoding) + +
    +          Specifies the encoding that the files are + to be written in--same as input encoding by default.
    + voidsetPreserveLastModified(boolean preserve) + +
    +          Set whether to preserve the last modified time as the original files.
    + voidsetSrcdir(java.io.File srcDir) + +
    +          Set the source dir to find the source text files.
    + voidsetTab(FixCRLF.AddAsisRemove attr) + +
    +          Specify how tab characters are to be handled.
    + voidsetTablength(int tlength) + +
    +          Specify tab length in characters.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_FILE_AND_SRCDIR

    +
    +public static final java.lang.String ERROR_FILE_AND_SRCDIR
    +
    +
    error string for using srcdir and file +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +FixCRLF

    +
    +public FixCRLF()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +chain

    +
    +public final java.io.Reader chain(java.io.Reader rdr)
    +
    +
    Chain this task as a reader. +

    +

    +
    Specified by:
    chain in interface ChainableReader
    +
    +
    +
    Parameters:
    rdr - Reader to chain. +
    Returns:
    a Reader.
    Since:
    +
    Ant 1.7?
    +
    +
    +
    +
    + +

    +setSrcdir

    +
    +public void setSrcdir(java.io.File srcDir)
    +
    +
    Set the source dir to find the source text files. +

    +

    +
    +
    +
    +
    Parameters:
    srcDir - the source directory.
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File destDir)
    +
    +
    Set the destination where the fixed files should be placed. + Default is to replace the original file. +

    +

    +
    +
    +
    +
    Parameters:
    destDir - the destination directory.
    +
    +
    +
    + +

    +setJavafiles

    +
    +public void setJavafiles(boolean javafiles)
    +
    +
    Set to true if modifying Java source files. +

    +

    +
    +
    +
    +
    Parameters:
    javafiles - whether modifying Java files.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set a single file to convert. +

    +

    +
    +
    +
    +
    Parameters:
    file - the file to convert.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setEol

    +
    +public void setEol(FixCRLF.CrLf attr)
    +
    +
    Specify how EndOfLine characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • asis: leave line endings alone +
    • cr: convert line endings to CR +
    • lf: convert line endings to LF +
    • crlf: convert line endings to CRLF +
    +
    +
    +
    + +

    +setCr

    +
    +public void setCr(FixCRLF.AddAsisRemove attr)
    +
    +
    Deprecated. since 1.4.x. + Use setEol instead. +

    +

    Specify how carriage return (CR) characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • add: ensure that there is a CR before every LF +
    • asis: leave CR characters alone +
    • remove: remove all CR characters +
    +
    +
    +
    + +

    +setTab

    +
    +public void setTab(FixCRLF.AddAsisRemove attr)
    +
    +
    Specify how tab characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • add: convert sequences of spaces which span a tab stop to tabs +
    • asis: leave tab and space characters alone +
    • remove: convert tabs to spaces +
    +
    +
    +
    + +

    +setTablength

    +
    +public void setTablength(int tlength)
+                  throws BuildException
    +
    +
    Specify tab length in characters. +

    +

    +
    +
    +
    +
    Parameters:
    tlength - specify the length of tab in spaces. +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +setEof

    +
    +public void setEof(FixCRLF.AddAsisRemove attr)
    +
    +
    Specify how DOS EOF (control-z) characters are to be handled. +

    +

    +
    +
    +
    +
    Parameters:
    attr - valid values: +
      +
    • add: ensure that there is an eof at the end of the file +
    • asis: leave eof characters alone +
    • remove: remove any eof character found at the end +
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Specifies the encoding Ant expects the files to be + in--defaults to the platforms default encoding. +

    +

    +
    +
    +
    +
    Parameters:
    encoding - String encoding name.
    +
    +
    +
    + +

    +setOutputEncoding

    +
    +public void setOutputEncoding(java.lang.String outputEncoding)
    +
    +
    Specifies the encoding that the files are + to be written in--same as input encoding by default. +

    +

    +
    +
    +
    +
    Parameters:
    outputEncoding - String outputEncoding name.
    +
    +
    +
    + +

    +setFixlast

    +
    +public void setFixlast(boolean fixlast)
    +
    +
    Specify whether a missing EOL will be added + to the final line of a file. +

    +

    +
    +
    +
    +
    Parameters:
    fixlast - whether to fix the last line.
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(boolean preserve)
    +
    +
    Set whether to preserve the last modified time as the original files. +

    +

    +
    +
    +
    +
    Parameters:
    preserve - true if timestamps should be preserved.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GUnzip.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GUnzip.html new file mode 100644 index 000000000..7e29bf729 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GUnzip.html @@ -0,0 +1,389 @@ + + + + + + +GUnzip (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class GUnzip

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Unpack
+              extended by org.apache.tools.ant.taskdefs.GUnzip
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class GUnzip
    extends Unpack
    + + +

    +Expands a file that has been compressed with the GZIP + algorithm. Normally used to compress non-compressed archives such + as TAR files. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Unpack
    dest, source, srcResource
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    GUnzip() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidextract() + +
    +          Implement the gunzipping.
    +protected  java.lang.StringgetDefaultExtension() + +
    +          Get the default extension.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Unpack
    addConfigured, execute, setDest, setDest, setSrc, setSrc, setSrcResource
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +GUnzip

    +
    +public GUnzip()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getDefaultExtension

    +
    +protected java.lang.String getDefaultExtension()
    +
    +
    Get the default extension. +

    +

    +
    Specified by:
    getDefaultExtension in class Unpack
    +
    +
    + +
    Returns:
    the value ".gz"
    +
    +
    +
    + +

    +extract

    +
    +protected void extract()
    +
    +
    Implement the gunzipping. +

    +

    +
    Specified by:
    extract in class Unpack
    +
    +
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <gunzip>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    +
    Overrides:
    supportsNonFileResources in class Unpack
    +
    +
    + +
    Returns:
    true if this task supports non file resources.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GZip.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GZip.html new file mode 100644 index 000000000..90dea2c58 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GZip.html @@ -0,0 +1,363 @@ + + + + + + +GZip (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class GZip

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Pack
+              extended by org.apache.tools.ant.taskdefs.GZip
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class GZip
    extends Pack
    + + +

    +Compresses a file with the GZIP algorithm. Normally used to compress + non-compressed archives such as TAR files. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Pack
    source, zipFile
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    GZip() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidpack() + +
    +          perform the GZip compression operation.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Pack
    addConfigured, execute, getSrcResource, setDestfile, setSrc, setSrcResource, setZipfile, zipFile, zipResource
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +GZip

    +
    +public GZip()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +pack

    +
    +protected void pack()
    +
    +
    perform the GZip compression operation. +

    +

    +
    Specified by:
    pack in class Pack
    +
    +
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <gzip>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    +
    Overrides:
    supportsNonFileResources in class Pack
    +
    +
    + +
    Returns:
    true if this case supports non file resources.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DistinguishedName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DistinguishedName.html new file mode 100644 index 000000000..7f1313b70 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DistinguishedName.html @@ -0,0 +1,331 @@ + + + + + + +GenerateKey.DistinguishedName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class GenerateKey.DistinguishedName

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.GenerateKey.DistinguishedName
+
    +
    +
    Enclosing class:
    GenerateKey
    +
    +
    +
    +
    public static class GenerateKey.DistinguishedName
    extends java.lang.Object
    + + +

    +A class corresponding to the dname nested element. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    GenerateKey.DistinguishedName() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectcreateParam() + +
    +          Create a param nested element.
    + java.lang.Stringencode(java.lang.String string) + +
    +          Encode a name or value.
    + java.util.EnumerationgetParams() + +
    +          Get the nested parameters.
    + java.lang.StringtoString() + +
    +          Generate a string rep of this distinguished name.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +GenerateKey.DistinguishedName

    +
    +public GenerateKey.DistinguishedName()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createParam

    +
    +public java.lang.Object createParam()
    +
    +
    Create a param nested element. +

    +

    + +
    Returns:
    a DnameParam object to be configured.
    +
    +
    +
    + +

    +getParams

    +
    +public java.util.Enumeration getParams()
    +
    +
    Get the nested parameters. +

    +

    + +
    Returns:
    an enumeration of the nested parameters.
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Generate a string rep of this distinguished name. + The format is each of the parameters (name = value) + separated by ','. + This is used on the command line. +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a string rep of this name
    +
    +
    +
    + +

    +encode

    +
    +public java.lang.String encode(java.lang.String string)
    +
    +
    Encode a name or value. + The encoded result is the same as the input string + except that each ',' is replaced by a '\,'. +

    +

    +
    Parameters:
    string - the value to be encoded +
    Returns:
    the encoded value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DnameParam.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DnameParam.html new file mode 100644 index 000000000..580153850 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.DnameParam.html @@ -0,0 +1,322 @@ + + + + + + +GenerateKey.DnameParam (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class GenerateKey.DnameParam

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.GenerateKey.DnameParam
+
    +
    +
    Enclosing class:
    GenerateKey
    +
    +
    +
    +
    public static class GenerateKey.DnameParam
    extends java.lang.Object
    + + +

    +A DistinguishedName parameter. + This is a nested element in a dname nested element. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    GenerateKey.DnameParam() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the name attribute.
    + java.lang.StringgetValue() + +
    +          Get the value attribute.
    + voidsetName(java.lang.String name) + +
    +          Set the name attribute.
    + voidsetValue(java.lang.String value) + +
    +          Set the value attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +GenerateKey.DnameParam

    +
    +public GenerateKey.DnameParam()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name attribute. +

    +

    +
    Parameters:
    name - a String value
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name attribute. +

    +

    + +
    Returns:
    the name.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the value attribute. +

    +

    +
    Parameters:
    value - a String value
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the value attribute. +

    +

    + +
    Returns:
    the value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.html new file mode 100644 index 000000000..5d76b1f96 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/GenerateKey.html @@ -0,0 +1,833 @@ + + + + + + +GenerateKey (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class GenerateKey

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.GenerateKey
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class GenerateKey
    extends Task
    + + +

    +Generates a key in a keystore. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classGenerateKey.DistinguishedName + +
    +          A class corresponding to the dname nested element.
    +static classGenerateKey.DnameParam + +
    +          A DistinguishedName parameter.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.Stringalias + +
    +          The alias of signer.
    +protected  java.lang.Stringdname + +
    +           
    +protected  GenerateKey.DistinguishedNameexpandedDname + +
    +           
    +protected  java.lang.Stringkeyalg + +
    +           
    +protected  java.lang.Stringkeypass + +
    +           
    +protected  intkeysize + +
    +           
    +protected  java.lang.Stringkeystore + +
    +          The name of keystore file.
    +protected  java.lang.Stringsigalg + +
    +           
    +protected  java.lang.Stringstorepass + +
    +           
    +protected  java.lang.Stringstoretype + +
    +           
    +protected  intvalidity + +
    +           
    +protected  booleanverbose + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    GenerateKey() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + GenerateKey.DistinguishedNamecreateDname() + +
    +          Distinguished name list.
    + voidexecute() + +
    +          Execute the task.
    + voidsetAlias(java.lang.String alias) + +
    +          The alias to add under.
    + voidsetDname(java.lang.String dname) + +
    +          The distinguished name for entity.
    + voidsetKeyalg(java.lang.String keyalg) + +
    +          The method to use when generating name-value pair.
    + voidsetKeypass(java.lang.String keypass) + +
    +          Password for private key (if different).
    + voidsetKeysize(java.lang.String keysize) + +
    +          Indicates the size of key generated.
    + voidsetKeystore(java.lang.String keystore) + +
    +          Keystore location.
    + voidsetSigalg(java.lang.String sigalg) + +
    +          The algorithm to use in signing.
    + voidsetStorepass(java.lang.String storepass) + +
    +          Password for keystore integrity.
    + voidsetStoretype(java.lang.String storetype) + +
    +          Keystore type.
    + voidsetValidity(java.lang.String validity) + +
    +          Indicates how many days certificate is valid.
    + voidsetVerbose(boolean verbose) + +
    +          If true, verbose output when signing.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +alias

    +
    +protected java.lang.String alias
    +
    +
    The alias of signer. +

    +

    +
    +
    +
    + +

    +keystore

    +
    +protected java.lang.String keystore
    +
    +
    The name of keystore file. +

    +

    +
    +
    +
    + +

    +storepass

    +
    +protected java.lang.String storepass
    +
    +
    +
    +
    +
    + +

    +storetype

    +
    +protected java.lang.String storetype
    +
    +
    +
    +
    +
    + +

    +keypass

    +
    +protected java.lang.String keypass
    +
    +
    +
    +
    +
    + +

    +sigalg

    +
    +protected java.lang.String sigalg
    +
    +
    +
    +
    +
    + +

    +keyalg

    +
    +protected java.lang.String keyalg
    +
    +
    +
    +
    +
    + +

    +dname

    +
    +protected java.lang.String dname
    +
    +
    +
    +
    +
    + +

    +expandedDname

    +
    +protected GenerateKey.DistinguishedName expandedDname
    +
    +
    +
    +
    +
    + +

    +keysize

    +
    +protected int keysize
    +
    +
    +
    +
    +
    + +

    +validity

    +
    +protected int validity
    +
    +
    +
    +
    +
    + +

    +verbose

    +
    +protected boolean verbose
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +GenerateKey

    +
    +public GenerateKey()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createDname

    +
    +public GenerateKey.DistinguishedName createDname()
+                                          throws BuildException
    +
    +
    Distinguished name list. +

    +

    + +
    Returns:
    Distinguished name container. +
    Throws: +
    BuildException - If specified more than once or dname + attribute is used.
    +
    +
    +
    + +

    +setDname

    +
    +public void setDname(java.lang.String dname)
    +
    +
    The distinguished name for entity. +

    +

    +
    Parameters:
    dname - distinguished name
    +
    +
    +
    + +

    +setAlias

    +
    +public void setAlias(java.lang.String alias)
    +
    +
    The alias to add under. +

    +

    +
    Parameters:
    alias - alias to add under
    +
    +
    +
    + +

    +setKeystore

    +
    +public void setKeystore(java.lang.String keystore)
    +
    +
    Keystore location. +

    +

    +
    Parameters:
    keystore - location
    +
    +
    +
    + +

    +setStorepass

    +
    +public void setStorepass(java.lang.String storepass)
    +
    +
    Password for keystore integrity. + Must be at least 6 characters long. +

    +

    +
    Parameters:
    storepass - password
    +
    +
    +
    + +

    +setStoretype

    +
    +public void setStoretype(java.lang.String storetype)
    +
    +
    Keystore type. +

    +

    +
    Parameters:
    storetype - type
    +
    +
    +
    + +

    +setKeypass

    +
    +public void setKeypass(java.lang.String keypass)
    +
    +
    Password for private key (if different). +

    +

    +
    Parameters:
    keypass - password
    +
    +
    +
    + +

    +setSigalg

    +
    +public void setSigalg(java.lang.String sigalg)
    +
    +
    The algorithm to use in signing. +

    +

    +
    Parameters:
    sigalg - algorithm
    +
    +
    +
    + +

    +setKeyalg

    +
    +public void setKeyalg(java.lang.String keyalg)
    +
    +
    The method to use when generating name-value pair. +

    +

    +
    Parameters:
    keyalg - algorithm
    +
    +
    +
    + +

    +setKeysize

    +
    +public void setKeysize(java.lang.String keysize)
+                throws BuildException
    +
    +
    Indicates the size of key generated. +

    +

    +
    Parameters:
    keysize - size of key +
    Throws: +
    BuildException - If not an Integer
    To do:
    +
    Could convert this to a plain Integer setter.
    +
    +
    +
    +
    + +

    +setValidity

    +
    +public void setValidity(java.lang.String validity)
+                 throws BuildException
    +
    +
    Indicates how many days certificate is valid. +

    +

    +
    Parameters:
    validity - days valid +
    Throws: +
    BuildException - If not an Integer
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    If true, verbose output when signing. +

    +

    +
    Parameters:
    verbose - verbose or not
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.Base64Converter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.Base64Converter.html new file mode 100644 index 000000000..95f783760 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.Base64Converter.html @@ -0,0 +1,256 @@ + + + + + + +Get.Base64Converter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Get.Base64Converter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.util.Base64Converter
+      extended by org.apache.tools.ant.taskdefs.Get.Base64Converter
+
    +
    +
    Enclosing class:
    Get
    +
    +
    +
    +
    protected static class Get.Base64Converter
    extends Base64Converter
    + + +

    +Provide this for Backward Compatibility. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.util.Base64Converter
    alphabet
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected Get.Base64Converter() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.Base64Converter
    encode, encode
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Get.Base64Converter

    +
    +protected Get.Base64Converter()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.DownloadProgress.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.DownloadProgress.html new file mode 100644 index 000000000..3a248e4c0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.DownloadProgress.html @@ -0,0 +1,256 @@ + + + + + + +Get.DownloadProgress (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface Get.DownloadProgress

    +
    +
    All Known Implementing Classes:
    Get.NullProgress, Get.VerboseProgress
    +
    +
    +
    Enclosing class:
    Get
    +
    +
    +
    +
    public static interface Get.DownloadProgress
    + + +

    +Interface implemented for reporting + progess of downloading. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbeginDownload() + +
    +          begin a download
    + voidendDownload() + +
    +          end a download
    + voidonTick() + +
    +          tick handler
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +beginDownload

    +
    +void beginDownload()
    +
    +
    begin a download +

    +

    +
    +
    +
    +
    + +

    +onTick

    +
    +void onTick()
    +
    +
    tick handler +

    +

    +
    +
    +
    +
    + +

    +endDownload

    +
    +void endDownload()
    +
    +
    end a download +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.NullProgress.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.NullProgress.html new file mode 100644 index 000000000..841a259b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.NullProgress.html @@ -0,0 +1,310 @@ + + + + + + +Get.NullProgress (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Get.NullProgress

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Get.NullProgress
+
    +
    +
    All Implemented Interfaces:
    Get.DownloadProgress
    +
    +
    +
    Enclosing class:
    Get
    +
    +
    +
    +
    public static class Get.NullProgress
    extends java.lang.Object
    implements Get.DownloadProgress
    + + +

    +do nothing with progress info +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Get.NullProgress() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbeginDownload() + +
    +          begin a download
    + voidendDownload() + +
    +          end a download
    + voidonTick() + +
    +          tick handler
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Get.NullProgress

    +
    +public Get.NullProgress()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +beginDownload

    +
    +public void beginDownload()
    +
    +
    begin a download +

    +

    +
    Specified by:
    beginDownload in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    +
    + +

    +onTick

    +
    +public void onTick()
    +
    +
    tick handler +

    +

    +
    Specified by:
    onTick in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    +
    + +

    +endDownload

    +
    +public void endDownload()
    +
    +
    end a download +

    +

    +
    Specified by:
    endDownload in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.VerboseProgress.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.VerboseProgress.html new file mode 100644 index 000000000..df17f1a15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.VerboseProgress.html @@ -0,0 +1,314 @@ + + + + + + +Get.VerboseProgress (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Get.VerboseProgress

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Get.VerboseProgress
+
    +
    +
    All Implemented Interfaces:
    Get.DownloadProgress
    +
    +
    +
    Enclosing class:
    Get
    +
    +
    +
    +
    public static class Get.VerboseProgress
    extends java.lang.Object
    implements Get.DownloadProgress
    + + +

    +verbose progress system prints to some output stream +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Get.VerboseProgress(java.io.PrintStream out) + +
    +          Construct a verbose progress reporter.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbeginDownload() + +
    +          begin a download
    + voidendDownload() + +
    +          end a download
    + voidonTick() + +
    +          tick handler
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Get.VerboseProgress

    +
    +public Get.VerboseProgress(java.io.PrintStream out)
    +
    +
    Construct a verbose progress reporter. +

    +

    +
    Parameters:
    out - the output stream.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +beginDownload

    +
    +public void beginDownload()
    +
    +
    begin a download +

    +

    +
    Specified by:
    beginDownload in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    +
    + +

    +onTick

    +
    +public void onTick()
    +
    +
    tick handler +

    +

    +
    Specified by:
    onTick in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    +
    + +

    +endDownload

    +
    +public void endDownload()
    +
    +
    end a download +

    +

    +
    Specified by:
    endDownload in interface Get.DownloadProgress
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.html new file mode 100644 index 000000000..5f0da9b4d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Get.html @@ -0,0 +1,769 @@ + + + + + + +Get (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Get

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Get
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Get
    extends Task
    + + +

    +Gets a particular file from a URL source. + Options include verbose reporting, timestamp based fetches and controlling + actions on failures. NB: access through a firewall only works if the whole + Java runtime is correctly configured. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +protected static classGet.Base64Converter + +
    +          Provide this for Backward Compatibility.
    +static interfaceGet.DownloadProgress + +
    +          Interface implemented for reporting + progess of downloading.
    +static classGet.NullProgress + +
    +          do nothing with progress info
    +static classGet.VerboseProgress + +
    +          verbose progress system prints to some output stream
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Get() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Add a nested filenamemapper.
    + voidadd(ResourceCollection rc) + +
    +          Adds URLs to get.
    + MappercreateMapper() + +
    +          Define the mapper to map source to destination files.
    + booleandoGet(int logLevel, + Get.DownloadProgress progress) + +
    +          Deprecated. only gets the first configured resource
    + booleandoGet(java.net.URL source, + java.io.File dest, + int logLevel, + Get.DownloadProgress progress) + +
    +          make a get request, with the supplied progress and logging info.
    + voidexecute() + +
    +          Does the work.
    + voidsetDest(java.io.File dest) + +
    +          Where to copy the source file.
    + voidsetHttpUseCaches(boolean httpUseCache) + +
    +          HTTP connections only - control caching on the + HttpUrlConnection: httpConnection.setUseCaches(); if false, do + not allow caching on the HttpUrlConnection.
    + voidsetIgnoreErrors(boolean v) + +
    +          If true, log errors but do not treat as fatal.
    + voidsetMaxTime(long maxTime) + +
    +          The time in seconds the download is allowed to take before + being terminated.
    + voidsetPassword(java.lang.String p) + +
    +          password for the basic authentication.
    + voidsetRetries(int r) + +
    +          The number of retries to attempt upon error, defaults to 3.
    + voidsetSkipExisting(boolean s) + +
    +          Skip files that already exist locally.
    + voidsetSrc(java.net.URL u) + +
    +          Set an URL to get.
    + voidsetUsername(java.lang.String u) + +
    +          Username for basic auth.
    + voidsetUseTimestamp(boolean v) + +
    +          If true, conditionally download a file based on the timestamp + of the local copy.
    + voidsetVerbose(boolean v) + +
    +          If true, show verbose progress information.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Get

    +
    +public Get()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Does the work. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - Thrown in unrecoverable error.
    +
    +
    +
    + +

    +doGet

    +
    +public boolean doGet(int logLevel,
+                     Get.DownloadProgress progress)
+              throws java.io.IOException
    +
    +
    Deprecated. only gets the first configured resource +

    +

    make a get request, with the supplied progress and logging info. + All the other config parameters are set at the task level, + source, dest, ignoreErrors, etc. +

    +

    +
    Parameters:
    logLevel - level to log at, see Project.log(String, int)
    progress - progress callback; null for no-callbacks +
    Returns:
    true for a successful download, false otherwise. + The return value is only relevant when ignoreErrors is true, as + when false all failures raise BuildExceptions. +
    Throws: +
    java.io.IOException - for network trouble +
    BuildException - for argument errors, or other trouble when ignoreErrors + is false.
    +
    +
    +
    + +

    +doGet

    +
    +public boolean doGet(java.net.URL source,
+                     java.io.File dest,
+                     int logLevel,
+                     Get.DownloadProgress progress)
+              throws java.io.IOException
    +
    +
    make a get request, with the supplied progress and logging info. + + All the other config parameters like ignoreErrors are set at + the task level. +

    +

    +
    Parameters:
    source - the URL to get
    dest - the target file
    logLevel - level to log at, see Project.log(String, int)
    progress - progress callback; null for no-callbacks +
    Returns:
    true for a successful download, false otherwise. + The return value is only relevant when ignoreErrors is true, as + when false all failures raise BuildExceptions. +
    Throws: +
    java.io.IOException - for network trouble +
    BuildException - for argument errors, or other trouble when ignoreErrors + is false.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.net.URL u)
    +
    +
    Set an URL to get. +

    +

    +
    Parameters:
    u - URL for the file.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Adds URLs to get. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    Where to copy the source file. +

    +

    +
    Parameters:
    dest - Path to file.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean v)
    +
    +
    If true, show verbose progress information. +

    +

    +
    Parameters:
    v - if "true" then be verbose
    +
    +
    +
    + +

    +setIgnoreErrors

    +
    +public void setIgnoreErrors(boolean v)
    +
    +
    If true, log errors but do not treat as fatal. +

    +

    +
    Parameters:
    v - if "true" then don't report download errors up to ant
    +
    +
    +
    + +

    +setUseTimestamp

    +
    +public void setUseTimestamp(boolean v)
    +
    +
    If true, conditionally download a file based on the timestamp + of the local copy. + +

    In this situation, the if-modified-since header is set so + that the file is only fetched if it is newer than the local + file (or there is no local file) This flag is only valid on + HTTP connections, it is ignored in other cases. When the flag + is set, the local copy of the downloaded file will also have + its timestamp set to the remote file time.

    + +

    Note that remote files of date 1/1/1970 (GMT) are treated as + 'no timestamp', and web servers often serve files with a + timestamp in the future by replacing their timestamp with that + of the current time. Also, inter-computer clock differences can + cause no end of grief.

    +

    +

    +
    Parameters:
    v - "true" to enable file time fetching
    +
    +
    +
    + +

    +setUsername

    +
    +public void setUsername(java.lang.String u)
    +
    +
    Username for basic auth. +

    +

    +
    Parameters:
    u - username for authentication
    +
    +
    +
    + +

    +setPassword

    +
    +public void setPassword(java.lang.String p)
    +
    +
    password for the basic authentication. +

    +

    +
    Parameters:
    p - password for authentication
    +
    +
    +
    + +

    +setMaxTime

    +
    +public void setMaxTime(long maxTime)
    +
    +
    The time in seconds the download is allowed to take before + being terminated. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setRetries

    +
    +public void setRetries(int r)
    +
    +
    The number of retries to attempt upon error, defaults to 3. +

    +

    +
    Parameters:
    r - retry count
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setSkipExisting

    +
    +public void setSkipExisting(boolean s)
    +
    +
    Skip files that already exist locally. +

    +

    +
    Parameters:
    s - "true" to skip existing destination files
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setHttpUseCaches

    +
    +public void setHttpUseCaches(boolean httpUseCache)
    +
    +
    HTTP connections only - control caching on the + HttpUrlConnection: httpConnection.setUseCaches(); if false, do + not allow caching on the HttpUrlConnection. + +

    Defaults to true (allow caching, which is also the + HttpUrlConnection default value.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Define the mapper to map source to destination files. +

    +

    + +
    Returns:
    a mapper to be configured. +
    Throws: +
    BuildException - if more than one mapper is defined.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    Add a nested filenamemapper. +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/HostInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/HostInfo.html new file mode 100644 index 000000000..0f8bc883e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/HostInfo.html @@ -0,0 +1,362 @@ + + + + + + +HostInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class HostInfo

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.HostInfo
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class HostInfo
    extends Task
    + + +

    +Sets properties to the host provided, or localhost if no information is + provided. The default properties are NAME, FQDN, ADDR4, ADDR6; +

    + +

    +

    +
    Since:
    +
    Ant 1.8
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    HostInfo() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          set the properties.
    + voidsetHost(java.lang.String aHost) + +
    +          Set the host to be retrieved.
    + voidsetPrefix(java.lang.String aPrefix) + +
    +          Set a prefix for the properties.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HostInfo

    +
    +public HostInfo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String aPrefix)
    +
    +
    Set a prefix for the properties. If the prefix does not end with a "." + one is automatically added. +

    +

    +
    Parameters:
    aPrefix - the prefix to use.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setHost

    +
    +public void setHost(java.lang.String aHost)
    +
    +
    Set the host to be retrieved. +

    +

    +
    Parameters:
    aHost - the name or the address of the host, data for the local host + will be retrieved if ommited.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    set the properties. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ImportTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ImportTask.html new file mode 100644 index 000000000..8c8867a9a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ImportTask.html @@ -0,0 +1,481 @@ + + + + + + +ImportTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ImportTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ImportTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ImportTask
    extends Task
    + + +

    +Task to import another build file into the current project. +

    + It must be 'top level'. On execution it will read another Ant file + into the same Project. +

    +

    + Important: Trying to understand how relative file references + resolved in deep/complex build hierarchies - such as what happens + when an imported file imports another file can be difficult. Use absolute references for + enhanced build file stability, especially in the imported files. +

    +

    Examples:

    + 
    + <import file="../common-targets.xml"/>
+
    +

    Import targets from a file in a parent directory.

    + 
    + <import file="${deploy-platform}.xml"/>
+
    +

    Import the project defined by the property deploy-platform.

    +

    + +

    +

    +
    Since:
    +
    Ant1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ImportTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection r) + +
    +          The resource to import.
    + voidexecute() + +
    +          Called by the project to let the task do its work.
    +protected  booleanisInIncludeMode() + +
    +          Whether the task is in include (as opposed to import) mode.
    + voidsetAs(java.lang.String prefix) + +
    +          The prefix to use when prefixing the imported target names.
    + voidsetFile(java.lang.String file) + +
    +          the name of the file to import.
    + voidsetOptional(boolean optional) + +
    +          sets the optional attribute
    + voidsetPrefixSeparator(java.lang.String s) + +
    +          The separator to use between prefix and target name, default is + ".".
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ImportTask

    +
    +public ImportTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setOptional

    +
    +public void setOptional(boolean optional)
    +
    +
    sets the optional attribute +

    +

    +
    Parameters:
    optional - if true ignore files that are not present, + default is false
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.lang.String file)
    +
    +
    the name of the file to import. How relative paths are resolved is still + in flux: use absolute paths for safety. +

    +

    +
    Parameters:
    file - the name of the file
    +
    +
    +
    + +

    +setAs

    +
    +public void setAs(java.lang.String prefix)
    +
    +
    The prefix to use when prefixing the imported target names. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setPrefixSeparator

    +
    +public void setPrefixSeparator(java.lang.String s)
    +
    +
    The separator to use between prefix and target name, default is + ".". +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection r)
    +
    +
    The resource to import. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Description copied from class: Task
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +isInIncludeMode

    +
    +protected final boolean isInIncludeMode()
    +
    +
    Whether the task is in include (as opposed to import) mode. + +

    In include mode included targets are only known by their + prefixed names and their depends lists get rewritten so that + all dependencies get the prefix as well.

    + +

    In import mode imported targets are known by an adorned as + well as a prefixed name and the unadorned target may be + overwritten in the importing build file. The depends list of + the imported targets is not modified at all.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.Handler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.Handler.html new file mode 100644 index 000000000..1b2fcc273 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.Handler.html @@ -0,0 +1,436 @@ + + + + + + +Input.Handler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Input.Handler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.Input.Handler
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Input
    +
    +
    +
    +
    public class Input.Handler
    extends DefBase
    + + +

    +Represents an InputHandler. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Input.Handler() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetClassname() + +
    +          Get the classname of the InputHandler.
    + java.lang.StringgetRefid() + +
    +          Get the refid of this Handler.
    + Input.HandlerTypegetType() + +
    +          Get the handler type.
    + voidsetClassname(java.lang.String classname) + +
    +          Set the InputHandler classname.
    + voidsetRefid(java.lang.String refid) + +
    +          Specify that the handler is a reference on the project; + this allows the use of a custom inputhandler.
    + voidsetType(Input.HandlerType type) + +
    +          Set the handler type.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
    createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Input.Handler

    +
    +public Input.Handler()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setRefid

    +
    +public void setRefid(java.lang.String refid)
    +
    +
    Specify that the handler is a reference on the project; + this allows the use of a custom inputhandler. +

    +

    +
    Parameters:
    refid - the String refid.
    +
    +
    +
    + +

    +getRefid

    +
    +public java.lang.String getRefid()
    +
    +
    Get the refid of this Handler. +

    +

    + +
    Returns:
    String refid.
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String classname)
    +
    +
    Set the InputHandler classname. +

    +

    +
    Parameters:
    classname - the String classname.
    +
    +
    +
    + +

    +getClassname

    +
    +public java.lang.String getClassname()
    +
    +
    Get the classname of the InputHandler. +

    +

    + +
    Returns:
    String classname.
    +
    +
    +
    + +

    +setType

    +
    +public void setType(Input.HandlerType type)
    +
    +
    Set the handler type. +

    +

    +
    Parameters:
    type - a HandlerType.
    +
    +
    +
    + +

    +getType

    +
    +public Input.HandlerType getType()
    +
    +
    Get the handler type. +

    +

    + +
    Returns:
    a HandlerType object.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.HandlerType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.HandlerType.html new file mode 100644 index 000000000..5ca88f79b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.HandlerType.html @@ -0,0 +1,291 @@ + + + + + + +Input.HandlerType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Input.HandlerType

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Input.HandlerType
+
    +
    +
    Enclosing class:
    Input
    +
    +
    +
    +
    public static class Input.HandlerType
    extends EnumeratedAttribute
    + + +

    +EnumeratedAttribute representing the built-in input handler types: + "default", "propertyfile", "greedy", "secure" (since Ant 1.8). +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Input.HandlerType() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Input.HandlerType

    +
    +public Input.HandlerType()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.html new file mode 100644 index 000000000..13ded02c2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Input.html @@ -0,0 +1,475 @@ + + + + + + +Input (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Input

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Input
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Input
    extends Task
    + + +

    +Reads an input line from the console. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    + classInput.Handler + +
    +          Represents an InputHandler.
    +static classInput.HandlerType + +
    +          EnumeratedAttribute representing the built-in input handler types: + "default", "propertyfile", "greedy", "secure" (since Ant 1.8).
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Input() + +
    +          No arg constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String msg) + +
    +          Set a multiline message.
    + Input.HandlercreateHandler() + +
    +          Create a nested handler element.
    + voidexecute() + +
    +          Actual method executed by ant.
    + voidsetAddproperty(java.lang.String addproperty) + +
    +          Defines the name of a property to be created from input.
    + voidsetDefaultvalue(java.lang.String defaultvalue) + +
    +          Defines the default value of the property to be created from input.
    + voidsetMessage(java.lang.String message) + +
    +          Sets the Message which gets displayed to the user during the build run.
    + voidsetValidargs(java.lang.String validargs) + +
    +          Defines valid input parameters as comma separated strings.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Input

    +
    +public Input()
    +
    +
    No arg constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setValidargs

    +
    +public void setValidargs(java.lang.String validargs)
    +
    +
    Defines valid input parameters as comma separated strings. If set, input + task will reject any input not defined as accepted and requires the user + to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to + be accepted you need to define both values as accepted arguments. +

    +

    +
    Parameters:
    validargs - A comma separated String defining valid input args.
    +
    +
    +
    + +

    +setAddproperty

    +
    +public void setAddproperty(java.lang.String addproperty)
    +
    +
    Defines the name of a property to be created from input. Behaviour is + according to property task which means that existing properties + cannot be overridden. +

    +

    +
    Parameters:
    addproperty - Name for the property to be created from input
    +
    +
    +
    + +

    +setMessage

    +
    +public void setMessage(java.lang.String message)
    +
    +
    Sets the Message which gets displayed to the user during the build run. +

    +

    +
    Parameters:
    message - The message to be displayed.
    +
    +
    +
    + +

    +setDefaultvalue

    +
    +public void setDefaultvalue(java.lang.String defaultvalue)
    +
    +
    Defines the default value of the property to be created from input. + Property value will be set to default if not input is received. +

    +

    +
    Parameters:
    defaultvalue - Default value for the property if no input + is received
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String msg)
    +
    +
    Set a multiline message. +

    +

    +
    Parameters:
    msg - The message to be displayed.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Actual method executed by ant. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +createHandler

    +
    +public Input.Handler createHandler()
    +
    +
    Create a nested handler element. +

    +

    + +
    Returns:
    a Handler for this Input task.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JDBCTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JDBCTask.html new file mode 100644 index 000000000..d7733b722 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JDBCTask.html @@ -0,0 +1,900 @@ + + + + + + +JDBCTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class JDBCTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.JDBCTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    SQLExec
    +
    +
    +
    +
    public abstract class JDBCTask
    extends Task
    + + +

    +Handles JDBC configuration needed by SQL type tasks. +

    + The following example class prints the contents of the first column of each row in TableName. +

    +
    +package examples;
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.taskdefs.JDBCTask;
+
+public class SQLExampleTask extends JDBCTask {
+
+    private String tableName;
+
+    public void execute() throws BuildException {
+        Connection conn = getConnection();
+        Statement stmt=null;
+        try {
+            if (tableName == null) {
+                throw new BuildException("TableName must be specified",location);
+            }
+            String sql = "SELECT * FROM "+tableName;
+            stmt= conn.createStatement();
+            ResultSet rs = stmt.executeQuery(sql);
+            while (rs.next()) {
+                log(rs.getObject(1).toString());
+            }
+        } catch (SQLException e) {
+
+        } finally {
+            if (stmt != null) {
+                try {stmt.close();}catch (SQLException ingore) {}
+            }
+            if (conn != null) {
+                try {conn.close();}catch (SQLException ingore) {}
+            }
+        }
+    }
+    public void setTableName(String tableName) {
+        this.tableName = tableName;
+    }
+
+}
+
+
+
     +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    JDBCTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConnectionProperty(Property var) + +
    +          Additional properties to put into the JDBC connection string.
    + PathcreateClasspath() + +
    +          Add a path to the classpath for loading the driver.
    + PathgetClasspath() + +
    +          Gets the classpath.
    +protected  java.sql.ConnectiongetConnection() + +
    +          Creates a new Connection as using the driver, url, userid and password + specified.
    +protected  AntClassLoadergetLoader() + +
    +          Get the classloader used to create a driver.
    +protected static java.util.HashtablegetLoaderMap() + +
    +          Get the cache of loaders and drivers.
    + java.lang.StringgetPassword() + +
    +          Gets the password.
    + java.lang.StringgetRdbms() + +
    +          Gets the rdbms.
    + java.lang.StringgetUrl() + +
    +          Gets the url.
    + java.lang.StringgetUserId() + +
    +          Gets the userId.
    + java.lang.StringgetVersion() + +
    +          Gets the version.
    + booleanisAutocommit() + +
    +          Gets the autocommit.
    + voidisCaching(boolean value) + +
    +          Set the caching attribute.
    +protected  booleanisValidRdbms(java.sql.Connection conn) + +
    +          Verify we are connected to the correct RDBMS
    + voidsetAutocommit(boolean autocommit) + +
    +          Auto commit flag for database connection; + optional, default false.
    + voidsetCaching(boolean enable) + +
    +          Caching loaders / driver.
    + voidsetClasspath(Path classpath) + +
    +          Sets the classpath for loading the driver.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath for loading the driver + using the classpath reference.
    + voidsetDriver(java.lang.String driver) + +
    +          Class name of the JDBC driver; required.
    + voidsetFailOnConnectionError(boolean b) + +
    +          whether the task should cause the build to fail if it cannot + connect to the database.
    + voidsetPassword(java.lang.String password) + +
    +          Sets the password; required.
    + voidsetRdbms(java.lang.String rdbms) + +
    +          Execute task only if the lower case product name + of the DB matches this
    + voidsetUrl(java.lang.String url) + +
    +          Sets the database connection URL; required.
    + voidsetUserid(java.lang.String userId) + +
    +          Set the user name for the connection; required.
    + voidsetVersion(java.lang.String version) + +
    +          Sets the version string, execute task only if + rdbms version match; optional.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +JDBCTask

    +
    +public JDBCTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Sets the classpath for loading the driver. +

    +

    +
    Parameters:
    classpath - The classpath to set
    +
    +
    +
    + +

    +setCaching

    +
    +public void setCaching(boolean enable)
    +
    +
    Caching loaders / driver. This is to avoid + getting an OutOfMemoryError when calling this task + multiple times in a row; default: true +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Add a path to the classpath for loading the driver. +

    +

    + +
    Returns:
    a path to be configured
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath for loading the driver + using the classpath reference. +

    +

    +
    Parameters:
    r - a reference to a classpath
    +
    +
    +
    + +

    +setDriver

    +
    +public void setDriver(java.lang.String driver)
    +
    +
    Class name of the JDBC driver; required. +

    +

    +
    Parameters:
    driver - The driver to set
    +
    +
    +
    + +

    +setUrl

    +
    +public void setUrl(java.lang.String url)
    +
    +
    Sets the database connection URL; required. +

    +

    +
    Parameters:
    url - The url to set
    +
    +
    +
    + +

    +setPassword

    +
    +public void setPassword(java.lang.String password)
    +
    +
    Sets the password; required. +

    +

    +
    Parameters:
    password - The password to set
    +
    +
    +
    + +

    +setAutocommit

    +
    +public void setAutocommit(boolean autocommit)
    +
    +
    Auto commit flag for database connection; + optional, default false. +

    +

    +
    Parameters:
    autocommit - The autocommit to set
    +
    +
    +
    + +

    +setRdbms

    +
    +public void setRdbms(java.lang.String rdbms)
    +
    +
    Execute task only if the lower case product name + of the DB matches this +

    +

    +
    Parameters:
    rdbms - The rdbms to set
    +
    +
    +
    + +

    +setVersion

    +
    +public void setVersion(java.lang.String version)
    +
    +
    Sets the version string, execute task only if + rdbms version match; optional. +

    +

    +
    Parameters:
    version - The version to set
    +
    +
    +
    + +

    +setFailOnConnectionError

    +
    +public void setFailOnConnectionError(boolean b)
    +
    +
    whether the task should cause the build to fail if it cannot + connect to the database. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +isValidRdbms

    +
    +protected boolean isValidRdbms(java.sql.Connection conn)
    +
    +
    Verify we are connected to the correct RDBMS +

    +

    +
    Parameters:
    conn - the jdbc connection +
    Returns:
    true if we are connected to the correct RDBMS
    +
    +
    +
    + +

    +getLoaderMap

    +
    +protected static java.util.Hashtable getLoaderMap()
    +
    +
    Get the cache of loaders and drivers. +

    +

    + +
    Returns:
    a hashtable
    +
    +
    +
    + +

    +getLoader

    +
    +protected AntClassLoader getLoader()
    +
    +
    Get the classloader used to create a driver. +

    +

    + +
    Returns:
    the classloader
    +
    +
    +
    + +

    +addConnectionProperty

    +
    +public void addConnectionProperty(Property var)
    +
    +
    Additional properties to put into the JDBC connection string. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getConnection

    +
    +protected java.sql.Connection getConnection()
+                                     throws BuildException
    +
    +
    Creates a new Connection as using the driver, url, userid and password + specified. + + The calling method is responsible for closing the connection. +

    +

    + +
    Returns:
    Connection the newly created connection or null if the + connection failed and failOnConnectionError is false. +
    Throws: +
    BuildException - if the UserId/Password/Url is not set or there + is no suitable driver or the driver fails to load.
    +
    +
    +
    + +

    +isCaching

    +
    +public void isCaching(boolean value)
    +
    +
    Set the caching attribute. +

    +

    +
    Parameters:
    value - a boolean value
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    Gets the classpath. +

    +

    + +
    Returns:
    Returns a Path
    +
    +
    +
    + +

    +isAutocommit

    +
    +public boolean isAutocommit()
    +
    +
    Gets the autocommit. +

    +

    + +
    Returns:
    Returns a boolean
    +
    +
    +
    + +

    +getUrl

    +
    +public java.lang.String getUrl()
    +
    +
    Gets the url. +

    +

    + +
    Returns:
    Returns a String
    +
    +
    +
    + +

    +getUserId

    +
    +public java.lang.String getUserId()
    +
    +
    Gets the userId. +

    +

    + +
    Returns:
    Returns a String
    +
    +
    +
    + +

    +setUserid

    +
    +public void setUserid(java.lang.String userId)
    +
    +
    Set the user name for the connection; required. +

    +

    +
    Parameters:
    userId - The userId to set
    +
    +
    +
    + +

    +getPassword

    +
    +public java.lang.String getPassword()
    +
    +
    Gets the password. +

    +

    + +
    Returns:
    Returns a String
    +
    +
    +
    + +

    +getRdbms

    +
    +public java.lang.String getRdbms()
    +
    +
    Gets the rdbms. +

    +

    + +
    Returns:
    Returns a String
    +
    +
    +
    + +

    +getVersion

    +
    +public java.lang.String getVersion()
    +
    +
    Gets the version. +

    +

    + +
    Returns:
    Returns a String
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.FilesetManifestConfig.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.FilesetManifestConfig.html new file mode 100644 index 000000000..510e1b702 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.FilesetManifestConfig.html @@ -0,0 +1,288 @@ + + + + + + +Jar.FilesetManifestConfig (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Jar.FilesetManifestConfig

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Jar.FilesetManifestConfig
+
    +
    +
    Enclosing class:
    Jar
    +
    +
    +
    +
    public static class Jar.FilesetManifestConfig
    extends EnumeratedAttribute
    + + +

    +The manifest config enumerated type. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Jar.FilesetManifestConfig() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          Get the list of valid strings.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Jar.FilesetManifestConfig

    +
    +public Jar.FilesetManifestConfig()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get the list of valid strings. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the list of values - "skip", "merge" and "mergewithoutmain"
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.StrictMode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.StrictMode.html new file mode 100644 index 000000000..45476cbac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.StrictMode.html @@ -0,0 +1,328 @@ + + + + + + +Jar.StrictMode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Jar.StrictMode

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Jar.StrictMode
+
    +
    +
    Enclosing class:
    Jar
    +
    +
    +
    +
    public static class Jar.StrictMode
    extends EnumeratedAttribute
    + + +

    +The strict enumerated type. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Jar.StrictMode() + +
    +          Public no arg constructor.
    Jar.StrictMode(java.lang.String value) + +
    +          Constructor with an arg.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetLogLevel() + +
    +           
    + java.lang.String[]getValues() + +
    +          Get List of valid strings.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Jar.StrictMode

    +
    +public Jar.StrictMode()
    +
    +
    Public no arg constructor. +

    +

    +
    + +

    +Jar.StrictMode

    +
    +public Jar.StrictMode(java.lang.String value)
    +
    +
    Constructor with an arg. +

    +

    +
    Parameters:
    value - the enumerated value as a string.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get List of valid strings. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the list of values.
    +
    +
    +
    + +

    +getLogLevel

    +
    +public int getLogLevel()
    +
    +
    + +
    Returns:
    The log level according to the strict mode.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.html new file mode 100644 index 000000000..666116d27 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jar.html @@ -0,0 +1,1057 @@ + + + + + + +Jar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Jar

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Zip
+                  extended by org.apache.tools.ant.taskdefs.Jar
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    Direct Known Subclasses:
    Ear, War
    +
    +
    +
    +
    public class Jar
    extends Zip
    + + +

    +Creates a JAR archive. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classJar.FilesetManifestConfig + +
    +          The manifest config enumerated type.
    +static classJar.StrictMode + +
    +          The strict enumerated type.
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Zip
    Zip.ArchiveState, Zip.Duplicate, Zip.UnicodeExtraField, Zip.WhenEmpty
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Zip
    addedDirs, archiveType, doubleFilePass, duplicate, emptyBehavior, entries, skipWriting, zipFile
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Jar() + +
    +          constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredIndexJars(Path p) + +
    +          Add a path to index jars.
    + voidaddConfiguredManifest(Manifest newManifest) + +
    +          Allows the manifest for the archive file to be provided inline + in the build file rather than in an external file.
    + voidaddConfiguredService(Service service) + +
    +          A nested SPI service element.
    + voidaddMetainf(ZipFileSet fs) + +
    +          Adds a zipfileset to include in the META-INF directory.
    +protected  voidcleanUp() + +
    +          Make sure we don't think we already have a MANIFEST next time this task + gets executed.
    +protected  booleancreateEmptyZip(java.io.File zipFile) + +
    +          Create an empty jar file.
    +protected  voidfinalizeZipOutputStream(ZipOutputStream zOut) + +
    +          Finalize the zip output stream.
    +protected static java.lang.StringfindJarName(java.lang.String fileName, + java.lang.String[] classpath) + +
    +          try to guess the name of the given file.
    +protected  Zip.ArchiveStategetResourcesToAdd(ResourceCollection[] rcs, + java.io.File zipFile, + boolean needsUpdate) + +
    +          Collect the resources that are newer than the corresponding + entries (or missing) in the original archive.
    +protected static voidgrabFilesAndDirs(java.lang.String file, + java.util.List dirs, + java.util.List files) + +
    +          Grab lists of all root-level files and all directories + contained in the given archive.
    +protected  voidinitZipOutputStream(ZipOutputStream zOut) + +
    +          Initialize the zip output stream.
    + voidreset() + +
    +          reset to default values.
    + voidsetFilesetmanifest(Jar.FilesetManifestConfig config) + +
    +          Behavior when a Manifest is found in a zipfileset or zipgroupfileset file.
    + voidsetFlattenAttributes(boolean b) + +
    +          Whether to flatten multi-valued attributes (i.e.
    + voidsetIndex(boolean flag) + +
    +          Set whether or not to create an index list for classes.
    + voidsetIndexMetaInf(boolean flag) + +
    +          Set whether or not to add META-INF and its children to the index.
    + voidsetJarfile(java.io.File jarFile) + +
    +          Deprecated. since 1.5.x. + Use setDestFile(File) instead.
    + voidsetManifest(java.io.File manifestFile) + +
    +          The manifest file to use.
    + voidsetManifestEncoding(java.lang.String manifestEncoding) + +
    +          The character encoding to use in the manifest file.
    + voidsetMergeClassPathAttributes(boolean b) + +
    +          Whether to merge Class-Path attributes.
    + voidsetStrict(Jar.StrictMode strict) + +
    +          Activate the strict mode.
    + voidsetWhenempty(Zip.WhenEmpty we) + +
    +          Not used for jar files.
    + voidsetWhenmanifestonly(Zip.WhenEmpty we) + +
    +          Indicates if a jar file should be created when it would only contain a + manifest file.
    +protected  voidwriteIndexLikeList(java.util.List dirs, + java.util.List files, + java.io.PrintWriter writer) + +
    +          Writes the directory entries from the first and the filenames + from the second list to the given writer, one entry per line.
    +protected  voidzipFile(java.io.InputStream is, + ZipOutputStream zOut, + java.lang.String vPath, + long lastModified, + java.io.File fromArchive, + int mode) + +
    +          Overridden from Zip class to deal with manifests and index lists.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Zip
    add, addFileset, addParentDirs, addResources, addResources, addZipfileset, addZipGroupFileset, execute, executeMain, getComment, getCreateUnicodeExtraFields, getCurrentExtraFields, getDestFile, getEncoding, getFallBackToUTF8, getLevel, getNonFileSetResourcesToAdd, getPreserve0Permissions, getResourcesToAdd, getUseLanguageEnodingFlag, grabNonFileSetResources, grabResources, hasUpdatedFile, isAddingNewFiles, isCompress, isEmpty, isFirstPass, isInUpdateMode, logWhenWriting, selectDirectoryResources, selectFileResources, selectResources, setBasedir, setComment, setCompress, setCreateUnicodeExtraFields, setCurrentExtraFields, setDestFile, setDuplicate, setEncoding, setFallBackToUTF8, setFile, setFilesonly, setKeepCompression, setLevel, setPreserve0Permissions, setRoundUp, setUpdate, setUseLanguageEncodingFlag, setZipfile, zipDir, zipDir, zipDir, zipFile, zipFile
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Jar

    +
    +public Jar()
    +
    +
    constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setWhenempty

    +
    +public void setWhenempty(Zip.WhenEmpty we)
    +
    +
    Not used for jar files. +

    +

    +
    Overrides:
    setWhenempty in class Zip
    +
    +
    +
    Parameters:
    we - not used
    +
    +
    +
    + +

    +setWhenmanifestonly

    +
    +public void setWhenmanifestonly(Zip.WhenEmpty we)
    +
    +
    Indicates if a jar file should be created when it would only contain a + manifest file. + Possible values are: fail (throw an exception + and halt the build); skip (do not create + any archive, but issue a warning); create + (make an archive with only a manifest file). + Default is create; +

    +

    +
    Parameters:
    we - a WhenEmpty enumerated value
    +
    +
    +
    + +

    +setStrict

    +
    +public void setStrict(Jar.StrictMode strict)
    +
    +
    Activate the strict mode. When set to true a BuildException + will be thrown if the Jar-Packaging specification was broken. +

    +

    +
    Parameters:
    strict - New value of the strict mode.
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    +
    + +

    +setJarfile

    +
    +public void setJarfile(java.io.File jarFile)
    +
    +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +

    +

    Set the destination file. +

    +

    +
    Parameters:
    jarFile - the destination file
    +
    +
    +
    + +

    +setIndex

    +
    +public void setIndex(boolean flag)
    +
    +
    Set whether or not to create an index list for classes. + This may speed up classloading in some cases. +

    +

    +
    Parameters:
    flag - a boolean value
    +
    +
    +
    + +

    +setIndexMetaInf

    +
    +public void setIndexMetaInf(boolean flag)
    +
    +
    Set whether or not to add META-INF and its children to the index. + +

    Doesn't have any effect if index is false.

    + +

    Sun's jar implementation used to skip the META-INF directory + and Ant followed that example. The behavior has been changed + with Java 5. In order to avoid problems with Ant generated + jars on Java 1.4 or earlier Ant will not include META-INF + unless explicitly asked to.

    +

    +

    +
    Parameters:
    flag - a boolean value, defaults to false
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    + jar -i omits service providers in index.list
    +
    +
    +
    + +

    +setManifestEncoding

    +
    +public void setManifestEncoding(java.lang.String manifestEncoding)
    +
    +
    The character encoding to use in the manifest file. +

    +

    +
    Parameters:
    manifestEncoding - the character encoding
    +
    +
    +
    + +

    +addConfiguredManifest

    +
    +public void addConfiguredManifest(Manifest newManifest)
+                           throws ManifestException
    +
    +
    Allows the manifest for the archive file to be provided inline + in the build file rather than in an external file. +

    +

    +
    Parameters:
    newManifest - an embedded manifest element +
    Throws: +
    ManifestException - on error
    +
    +
    +
    + +

    +setManifest

    +
    +public void setManifest(java.io.File manifestFile)
    +
    +
    The manifest file to use. This can be either the location of a manifest, + or the name of a jar added through a fileset. If its the name of an added + jar, the task expects the manifest to be in the jar at META-INF/MANIFEST.MF. +

    +

    +
    Parameters:
    manifestFile - the manifest file to use.
    +
    +
    +
    + +

    +setFilesetmanifest

    +
    +public void setFilesetmanifest(Jar.FilesetManifestConfig config)
    +
    +
    Behavior when a Manifest is found in a zipfileset or zipgroupfileset file. + Valid values are "skip", "merge", and "mergewithoutmain". + "merge" will merge all of manifests together, and merge this into any + other specified manifests. + "mergewithoutmain" merges everything but the Main section of the manifests. + Default value is "skip". + + Note: if this attribute's value is not "skip", the created jar will not + be readable by using java.util.jar.JarInputStream +

    +

    +
    Parameters:
    config - setting for found manifest behavior.
    +
    +
    +
    + +

    +addMetainf

    +
    +public void addMetainf(ZipFileSet fs)
    +
    +
    Adds a zipfileset to include in the META-INF directory. +

    +

    +
    Parameters:
    fs - zipfileset to add
    +
    +
    +
    + +

    +addConfiguredIndexJars

    +
    +public void addConfiguredIndexJars(Path p)
    +
    +
    Add a path to index jars. +

    +

    +
    Parameters:
    p - a path
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +addConfiguredService

    +
    +public void addConfiguredService(Service service)
    +
    +
    A nested SPI service element. +

    +

    +
    Parameters:
    service - the nested element.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setMergeClassPathAttributes

    +
    +public void setMergeClassPathAttributes(boolean b)
    +
    +
    Whether to merge Class-Path attributes. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFlattenAttributes

    +
    +public void setFlattenAttributes(boolean b)
    +
    +
    Whether to flatten multi-valued attributes (i.e. Class-Path) + into a single one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +initZipOutputStream

    +
    +protected void initZipOutputStream(ZipOutputStream zOut)
+                            throws java.io.IOException,
+                                   BuildException
    +
    +
    Initialize the zip output stream. +

    +

    +
    Overrides:
    initZipOutputStream in class Zip
    +
    +
    +
    Parameters:
    zOut - the zip output stream +
    Throws: +
    java.io.IOException - on I/O errors +
    BuildException - on other errors
    +
    +
    +
    + +

    +finalizeZipOutputStream

    +
    +protected void finalizeZipOutputStream(ZipOutputStream zOut)
+                                throws java.io.IOException,
+                                       BuildException
    +
    +
    Finalize the zip output stream. + This creates an index list if the index attribute is true. +

    +

    +
    Overrides:
    finalizeZipOutputStream in class Zip
    +
    +
    +
    Parameters:
    zOut - the zip output stream +
    Throws: +
    java.io.IOException - on I/O errors +
    BuildException - on other errors
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.InputStream is,
+                       ZipOutputStream zOut,
+                       java.lang.String vPath,
+                       long lastModified,
+                       java.io.File fromArchive,
+                       int mode)
+                throws java.io.IOException
    +
    +
    Overridden from Zip class to deal with manifests and index lists. +

    +

    +
    Overrides:
    zipFile in class Zip
    +
    +
    +
    Parameters:
    is - the stream to read data for the entry from. The + caller of the method is responsible for closing the stream.
    zOut - the zip output stream
    vPath - the name this entry shall have in the archive
    lastModified - last modification time for the entry.
    fromArchive - the original archive we are copying this + entry from, will be null if we are not copying from an archive.
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +getResourcesToAdd

    +
    +protected Zip.ArchiveState getResourcesToAdd(ResourceCollection[] rcs,
+                                             java.io.File zipFile,
+                                             boolean needsUpdate)
+                                      throws BuildException
    +
    +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. + +

    If we are going to recreate the archive instead of updating + it, all resources should be considered as new, if a single one + is. Because of this, subclasses overriding this method must + call super.getResourcesToAdd and indicate with the + third arg if they already know that the archive is + out-of-date.

    +

    +

    +
    Overrides:
    getResourcesToAdd in class Zip
    +
    +
    +
    Parameters:
    rcs - The resource collections to grab resources from
    zipFile - intended archive file (may or may not exist)
    needsUpdate - whether we already know that the archive is + out-of-date. Subclasses overriding this method are supposed to + set this value correctly in their call to + super.getResourcesToAdd. +
    Returns:
    an array of resources to add for each fileset passed in as well + as a flag that indicates whether the archive is uptodate. +
    Throws: +
    BuildException - if it likes
    +
    +
    +
    + +

    +createEmptyZip

    +
    +protected boolean createEmptyZip(java.io.File zipFile)
+                          throws BuildException
    +
    +
    Create an empty jar file. +

    +

    +
    Overrides:
    createEmptyZip in class Zip
    +
    +
    +
    Parameters:
    zipFile - the file to create +
    Returns:
    true for historic reasons +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +cleanUp

    +
    +protected void cleanUp()
    +
    +
    Make sure we don't think we already have a MANIFEST next time this task + gets executed. +

    +

    +
    Overrides:
    cleanUp in class Zip
    +
    +
    +
    See Also:
    Zip.cleanUp()
    +
    +
    +
    + +

    +reset

    +
    +public void reset()
    +
    +
    reset to default values. +

    +

    +
    Overrides:
    reset in class Zip
    +
    +
    +
    Since:
    +
    1.44, Ant 1.5
    +
    See Also:
    Zip.reset()
    +
    +
    +
    + +

    +writeIndexLikeList

    +
    +protected final void writeIndexLikeList(java.util.List dirs,
+                                        java.util.List files,
+                                        java.io.PrintWriter writer)
+                                 throws java.io.IOException
    +
    +
    Writes the directory entries from the first and the filenames + from the second list to the given writer, one entry per line. +

    +

    +
    Parameters:
    dirs - a list of directories
    files - a list of files
    writer - the writer to write to +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +findJarName

    +
    +protected static java.lang.String findJarName(java.lang.String fileName,
+                                              java.lang.String[] classpath)
    +
    +
    try to guess the name of the given file. + +

    If this jar has a classpath attribute in its manifest, we + can assume that it will only require an index of jars listed + there. try to find which classpath entry is most likely the + one the given file name points to.

    + +

    In the absence of a classpath attribute, assume the other + files will be placed inside the same directory as this jar and + use their basename.

    + +

    if there is a classpath and the given file doesn't match any + of its entries, return null.

    +

    +

    +
    Parameters:
    fileName - the name to look for
    classpath - the classpath to look in (may be null) +
    Returns:
    the matching entry, or null if the file is not found
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +grabFilesAndDirs

    +
    +protected static void grabFilesAndDirs(java.lang.String file,
+                                       java.util.List dirs,
+                                       java.util.List files)
+                                throws java.io.IOException
    +
    +
    Grab lists of all root-level files and all directories + contained in the given archive. +

    +

    +
    Parameters:
    file - the zip file to examine
    dirs - where to place the directories found
    files - where to place the files found +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Java.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Java.html new file mode 100644 index 000000000..7f23e2c22 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Java.html @@ -0,0 +1,1557 @@ + + + + + + +Java (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Java

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Java
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Java
    extends Task
    + + +

    +Launcher for Java applications. Allows use of + the same JVM for the called application thus resulting in much + faster operation. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  Redirectorredirector + +
    +           
    +protected  RedirectorElementredirectorElement + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Java() + +
    +          Normal constructor
    Java(Task owner) + +
    +          create a bound task
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddAssertions(Assertions asserts) + +
    +          Add assertions to enable in this program (if fork=true).
    + voidaddConfiguredRedirector(RedirectorElement redirectorElement) + +
    +          Add a RedirectorElement to this task.
    + voidaddEnv(Environment.Variable var) + +
    +          Add an environment variable.
    + voidaddSysproperty(Environment.Variable sysp) + +
    +          Add a system property.
    + voidaddSyspropertyset(PropertySet sysp) + +
    +          Add a set of properties as system properties.
    +protected  voidcheckConfiguration() + +
    +          Check configuration.
    + voidclearArgs() + +
    +          Clear out the arguments to this java task.
    + Commandline.ArgumentcreateArg() + +
    +          Add a command-line argument.
    + PathcreateBootclasspath() + +
    +          Add a path to the bootclasspath.
    + PathcreateClasspath() + +
    +          Add a path to the classpath.
    + Commandline.ArgumentcreateJvmarg() + +
    +          Adds a JVM argument.
    + PermissionscreatePermissions() + +
    +          Set the permissions for the application run inside the same JVM.
    +protected  ExecuteWatchdogcreateWatchdog() + +
    +          Create the Watchdog to kill a runaway process.
    + voidexecute() + +
    +          Do the execution.
    + intexecuteJava() + +
    +          Do the execution and return a return code.
    +protected  intexecuteJava(CommandlineJava commandLine) + +
    +          Execute the specified CommandlineJava.
    + CommandlineJavagetCommandLine() + +
    +          Accessor to the command line.
    + CommandlineJava.SysPropertiesgetSysProperties() + +
    +          Get the system properties of the command line.
    +protected  voidhandleErrorFlush(java.lang.String output) + +
    +          Handle output sent to System.err and flush the stream.
    +protected  voidhandleErrorOutput(java.lang.String output) + +
    +          Handle output sent to System.err.
    +protected  voidhandleFlush(java.lang.String output) + +
    +          Pass output sent to System.out to specified output file.
    + inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Handle an input request by this task.
    +protected  voidhandleOutput(java.lang.String output) + +
    +          Pass output sent to System.out to specified output file.
    +protected  voidmaybeSetResultPropertyValue(int result) + +
    +          Helper method to set result property to the + passed in value if appropriate.
    +protected  voidrun(java.lang.String classname, + java.util.Vector args) + +
    +          Executes the given classname with the given arguments as if it + were a command line application.
    + voidsetAppend(boolean append) + +
    +          If true, append output to existing file.
    + voidsetArgs(java.lang.String s) + +
    +          Deprecated: use nested arg instead.
    + voidsetClassname(java.lang.String s) + +
    +          Set the Java class to execute.
    + voidsetClasspath(Path s) + +
    +          Set the classpath to be used when running the Java class.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath to use by reference.
    + voidsetCloneVm(boolean cloneVm) + +
    +          If set, system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclaspath.
    + voidsetDir(java.io.File d) + +
    +          Set the working directory of the process.
    + voidsetError(java.io.File error) + +
    +          Set the File to which the error stream of the process is redirected.
    + voidsetErrorProperty(java.lang.String errorProperty) + +
    +          Set the property name whose value should be set to the error of + the process.
    + voidsetFailonerror(boolean fail) + +
    +          If true, then fail if the command exits with a + returncode other than zero.
    + voidsetFork(boolean s) + +
    +          If true, execute in a new VM.
    + voidsetInput(java.io.File input) + +
    +          Set the input to use for the task.
    + voidsetInputString(java.lang.String inputString) + +
    +          Set the string to use as input.
    + voidsetJar(java.io.File jarfile) + +
    +          Set the location of the JAR file to execute.
    + voidsetJvm(java.lang.String s) + +
    +          Set the command used to start the VM (only if forking).
    + voidsetJvmargs(java.lang.String s) + +
    +          Set the command line arguments for the JVM.
    + voidsetJVMVersion(java.lang.String value) + +
    +          Set the JVM version.
    + voidsetLogError(boolean logError) + +
    +          Set whether error output of exec is logged.
    + voidsetMaxmemory(java.lang.String max) + +
    +          Corresponds to -mx or -Xmx depending on VM version.
    + voidsetNewenvironment(boolean newenv) + +
    +          If true, use a completely new environment.
    + voidsetOutput(java.io.File out) + +
    +          Set the File to which the output of the process is redirected.
    + voidsetOutputproperty(java.lang.String outputProp) + +
    +          Set the property name whose value should be set to the output of + the process.
    + voidsetResultProperty(java.lang.String resultProperty) + +
    +          Set the name of the property in which the return code of the + command should be stored.
    + voidsetSpawn(boolean spawn) + +
    +          Set whether or not you want the process to be spawned; + default is not spawned.
    + voidsetTimeout(java.lang.Long value) + +
    +          Set the timeout in milliseconds after which the process will be killed.
    +protected  voidsetupRedirector() + +
    +          Set up properties on the redirector that we needed to store locally.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +redirector

    +
    +protected Redirector redirector
    +
    +
    +
    +
    +
    + +

    +redirectorElement

    +
    +protected RedirectorElement redirectorElement
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Java

    +
    +public Java()
    +
    +
    Normal constructor +

    +

    +
    + +

    +Java

    +
    +public Java(Task owner)
    +
    +
    create a bound task +

    +

    +
    Parameters:
    owner - owner
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if failOnError is set to true and the application + returns a nonzero result code.
    +
    +
    +
    + +

    +executeJava

    +
    +public int executeJava()
+                throws BuildException
    +
    +
    Do the execution and return a return code. +

    +

    + +
    Returns:
    the return code from the execute java class if it was + executed in a separate VM (fork = "yes") or a security manager was + installed that prohibits ExitVM (default). +
    Throws: +
    BuildException - if required parameters are missing.
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
+                           throws BuildException
    +
    +
    Check configuration. +

    +

    + +
    Throws: +
    BuildException - if required parameters are missing.
    +
    +
    +
    + +

    +executeJava

    +
    +protected int executeJava(CommandlineJava commandLine)
    +
    +
    Execute the specified CommandlineJava. +

    +

    +
    Parameters:
    commandLine - CommandLineJava instance. +
    Returns:
    the exit value of the process if forked, 0 otherwise.
    +
    +
    +
    + +

    +setSpawn

    +
    +public void setSpawn(boolean spawn)
    +
    +
    Set whether or not you want the process to be spawned; + default is not spawned. +

    +

    +
    Parameters:
    spawn - if true you do not want Ant to wait for the end of the process.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path s)
    +
    +
    Set the classpath to be used when running the Java class. +

    +

    +
    Parameters:
    s - an Ant Path object containing the classpath.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Add a path to the classpath. +

    +

    + +
    Returns:
    created classpath.
    +
    +
    +
    + +

    +createBootclasspath

    +
    +public Path createBootclasspath()
    +
    +
    Add a path to the bootclasspath. +

    +

    + +
    Returns:
    created bootclasspath.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +createPermissions

    +
    +public Permissions createPermissions()
    +
    +
    Set the permissions for the application run inside the same JVM. +

    +

    + +
    Returns:
    Permissions.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath to use by reference. +

    +

    +
    Parameters:
    r - a reference to an existing classpath.
    +
    +
    +
    + +

    +setJar

    +
    +public void setJar(java.io.File jarfile)
+            throws BuildException
    +
    +
    Set the location of the JAR file to execute. +

    +

    +
    Parameters:
    jarfile - the jarfile to execute. +
    Throws: +
    BuildException - if there is also a main class specified.
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String s)
+                  throws BuildException
    +
    +
    Set the Java class to execute. +

    +

    +
    Parameters:
    s - the name of the main class. +
    Throws: +
    BuildException - if the jar attribute has been set.
    +
    +
    +
    + +

    +setArgs

    +
    +public void setArgs(java.lang.String s)
    +
    +
    Deprecated: use nested arg instead. + Set the command line arguments for the class. +

    +

    +
    Parameters:
    s - arguments.
    +
    +
    +
    + +

    +setCloneVm

    +
    +public void setCloneVm(boolean cloneVm)
    +
    +
    If set, system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclaspath. + +

    Doesn't have any effect unless fork is true.

    +

    +

    +
    Parameters:
    cloneVm - if true copy system properties.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createArg

    +
    +public Commandline.Argument createArg()
    +
    +
    Add a command-line argument. +

    +

    + +
    Returns:
    created argument.
    +
    +
    +
    + +

    +setResultProperty

    +
    +public void setResultProperty(java.lang.String resultProperty)
    +
    +
    Set the name of the property in which the return code of the + command should be stored. Only of interest if failonerror=false. +

    +

    +
    Parameters:
    resultProperty - name of property.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +maybeSetResultPropertyValue

    +
    +protected void maybeSetResultPropertyValue(int result)
    +
    +
    Helper method to set result property to the + passed in value if appropriate. +

    +

    +
    Parameters:
    result - the exit code
    +
    +
    +
    + +

    +setFork

    +
    +public void setFork(boolean s)
    +
    +
    If true, execute in a new VM. +

    +

    +
    Parameters:
    s - do you want to run Java in a new VM.
    +
    +
    +
    + +

    +setJvmargs

    +
    +public void setJvmargs(java.lang.String s)
    +
    +
    Set the command line arguments for the JVM. +

    +

    +
    Parameters:
    s - jvmargs.
    +
    +
    +
    + +

    +createJvmarg

    +
    +public Commandline.Argument createJvmarg()
    +
    +
    Adds a JVM argument. +

    +

    + +
    Returns:
    JVM argument created.
    +
    +
    +
    + +

    +setJvm

    +
    +public void setJvm(java.lang.String s)
    +
    +
    Set the command used to start the VM (only if forking). +

    +

    +
    Parameters:
    s - command to start the VM.
    +
    +
    +
    + +

    +addSysproperty

    +
    +public void addSysproperty(Environment.Variable sysp)
    +
    +
    Add a system property. +

    +

    +
    Parameters:
    sysp - system property.
    +
    +
    +
    + +

    +addSyspropertyset

    +
    +public void addSyspropertyset(PropertySet sysp)
    +
    +
    Add a set of properties as system properties. +

    +

    +
    Parameters:
    sysp - set of properties to add.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean fail)
    +
    +
    If true, then fail if the command exits with a + returncode other than zero. +

    +

    +
    Parameters:
    fail - if true fail the build when the command exits with a + nonzero returncode.
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File d)
    +
    +
    Set the working directory of the process. +

    +

    +
    Parameters:
    d - working directory.
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File out)
    +
    +
    Set the File to which the output of the process is redirected. +

    +

    +
    Parameters:
    out - the output File.
    +
    +
    +
    + +

    +setInput

    +
    +public void setInput(java.io.File input)
    +
    +
    Set the input to use for the task. +

    +

    +
    Parameters:
    input - name of the input file.
    +
    +
    +
    + +

    +setInputString

    +
    +public void setInputString(java.lang.String inputString)
    +
    +
    Set the string to use as input. +

    +

    +
    Parameters:
    inputString - the string which is used as the input source.
    +
    +
    +
    + +

    +setLogError

    +
    +public void setLogError(boolean logError)
    +
    +
    Set whether error output of exec is logged. This is only useful + when output is being redirected and error output is desired in the + Ant log. +

    +

    +
    Parameters:
    logError - get in the ant log the messages coming from stderr + in the case that fork = true.
    +
    +
    +
    + +

    +setError

    +
    +public void setError(java.io.File error)
    +
    +
    Set the File to which the error stream of the process is redirected. +

    +

    +
    Parameters:
    error - file getting the error stream.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setOutputproperty

    +
    +public void setOutputproperty(java.lang.String outputProp)
    +
    +
    Set the property name whose value should be set to the output of + the process. +

    +

    +
    Parameters:
    outputProp - property name.
    +
    +
    +
    + +

    +setErrorProperty

    +
    +public void setErrorProperty(java.lang.String errorProperty)
    +
    +
    Set the property name whose value should be set to the error of + the process. +

    +

    +
    Parameters:
    errorProperty - property name.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setMaxmemory

    +
    +public void setMaxmemory(java.lang.String max)
    +
    +
    Corresponds to -mx or -Xmx depending on VM version. +

    +

    +
    Parameters:
    max - max memory parameter.
    +
    +
    +
    + +

    +setJVMVersion

    +
    +public void setJVMVersion(java.lang.String value)
    +
    +
    Set the JVM version. +

    +

    +
    Parameters:
    value - JVM version.
    +
    +
    +
    + +

    +addEnv

    +
    +public void addEnv(Environment.Variable var)
    +
    +
    Add an environment variable. + +

    Will be ignored if we are not forking a new VM. +

    +

    +
    Parameters:
    var - new environment variable.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setNewenvironment

    +
    +public void setNewenvironment(boolean newenv)
    +
    +
    If true, use a completely new environment. + +

    Will be ignored if we are not forking a new VM. +

    +

    +
    Parameters:
    newenv - if true, use a completely new environment.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    If true, append output to existing file. +

    +

    +
    Parameters:
    append - if true, append output to existing file.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(java.lang.Long value)
    +
    +
    Set the timeout in milliseconds after which the process will be killed. +

    +

    +
    Parameters:
    value - timeout in milliseconds.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addAssertions

    +
    +public void addAssertions(Assertions asserts)
    +
    +
    Add assertions to enable in this program (if fork=true). +

    +

    +
    Parameters:
    asserts - assertion set.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addConfiguredRedirector

    +
    +public void addConfiguredRedirector(RedirectorElement redirectorElement)
    +
    +
    Add a RedirectorElement to this task. +

    +

    +
    Parameters:
    redirectorElement - RedirectorElement.
    +
    +
    +
    + +

    +handleOutput

    +
    +protected void handleOutput(java.lang.String output)
    +
    +
    Pass output sent to System.out to specified output file. +

    +

    +
    Overrides:
    handleOutput in class Task
    +
    +
    +
    Parameters:
    output - a string of output on its way to the handlers.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +handleInput

    +
    +public int handleInput(byte[] buffer,
+                       int offset,
+                       int length)
+                throws java.io.IOException
    +
    +
    Handle an input request by this task. +

    +

    +
    Overrides:
    handleInput in class Task
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read. +
    Returns:
    the number of bytes read. +
    Throws: +
    java.io.IOException - if the data cannot be read.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +handleFlush

    +
    +protected void handleFlush(java.lang.String output)
    +
    +
    Pass output sent to System.out to specified output file. +

    +

    +
    Overrides:
    handleFlush in class Task
    +
    +
    +
    Parameters:
    output - string of output on its way to its handlers.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +protected void handleErrorOutput(java.lang.String output)
    +
    +
    Handle output sent to System.err. +

    +

    +
    Overrides:
    handleErrorOutput in class Task
    +
    +
    +
    Parameters:
    output - string of stderr.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +protected void handleErrorFlush(java.lang.String output)
    +
    +
    Handle output sent to System.err and flush the stream. +

    +

    +
    Overrides:
    handleErrorFlush in class Task
    +
    +
    +
    Parameters:
    output - string of stderr.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +setupRedirector

    +
    +protected void setupRedirector()
    +
    +
    Set up properties on the redirector that we needed to store locally. +

    +

    +
    +
    +
    +
    + +

    +run

    +
    +protected void run(java.lang.String classname,
+                   java.util.Vector args)
+            throws BuildException
    +
    +
    Executes the given classname with the given arguments as if it + were a command line application. +

    +

    +
    Parameters:
    classname - the name of the class to run.
    args - arguments for the class. +
    Throws: +
    BuildException - in case of IOException in the execution.
    +
    +
    +
    + +

    +clearArgs

    +
    +public void clearArgs()
    +
    +
    Clear out the arguments to this java task. +

    +

    +
    +
    +
    +
    + +

    +createWatchdog

    +
    +protected ExecuteWatchdog createWatchdog()
+                                  throws BuildException
    +
    +
    Create the Watchdog to kill a runaway process. +

    +

    + +
    Returns:
    new watchdog. +
    Throws: +
    BuildException - under unknown circumstances.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getCommandLine

    +
    +public CommandlineJava getCommandLine()
    +
    +
    Accessor to the command line. +

    +

    + +
    Returns:
    the current command line.
    Since:
    +
    1.6.3
    +
    +
    +
    +
    + +

    +getSysProperties

    +
    +public CommandlineJava.SysProperties getSysProperties()
    +
    +
    Get the system properties of the command line. +

    +

    + +
    Returns:
    the current properties of this java invocation.
    Since:
    +
    1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.ImplementationSpecificArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.ImplementationSpecificArgument.html new file mode 100644 index 000000000..86f9dfc74 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.ImplementationSpecificArgument.html @@ -0,0 +1,307 @@ + + + + + + +Javac.ImplementationSpecificArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javac.ImplementationSpecificArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.Commandline.Argument
+          extended by org.apache.tools.ant.util.facade.ImplementationSpecificArgument
+              extended by org.apache.tools.ant.taskdefs.Javac.ImplementationSpecificArgument
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Javac
    +
    +
    +
    +
    public class Javac.ImplementationSpecificArgument
    extends ImplementationSpecificArgument
    + + +

    +Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javac.ImplementationSpecificArgument() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsetCompiler(java.lang.String impl) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.facade.ImplementationSpecificArgument
    getParts, setImplementation
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.Commandline.Argument
    getParts, setFile, setLine, setPath, setPathref, setPrefix, setSuffix, setValue
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javac.ImplementationSpecificArgument

    +
    +public Javac.ImplementationSpecificArgument()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCompiler

    +
    +public void setCompiler(java.lang.String impl)
    +
    +
    +
    Parameters:
    impl - the name of the compiler
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.html new file mode 100644 index 000000000..2c58760c7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javac.html @@ -0,0 +1,2283 @@ + + + + + + +Javac (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javac

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Javac
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    Direct Known Subclasses:
    Apt
    +
    +
    +
    +
    public class Javac
    extends MatchingTask
    + + +

    +Compiles Java source files. This task can take the following + arguments: +

      +
    • sourcedir +
    • destdir +
    • deprecation +
    • classpath +
    • bootclasspath +
    • extdirs +
    • optimize +
    • debug +
    • encoding +
    • target +
    • depend +
    • verbose +
    • failonerror +
    • includeantruntime +
    • includejavaruntime +
    • source +
    • compiler +
    + Of these arguments, the sourcedir and destdir are required. +

    + When this task executes, it will recursively scan the sourcedir and + destdir looking for Java source files to compile. This task makes its + compile decision based on timestamp. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    + classJavac.ImplementationSpecificArgument + +
    +          Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation.
    +  + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.File[]compileList + +
    +           
    +protected  booleanfailOnError + +
    +           
    +protected  booleanlistFiles + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javac() + +
    +          Javac task for compilation of Java files.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(CompilerAdapter adapter) + +
    +          Set the compiler adapter explicitly.
    +protected  voidcheckParameters() + +
    +          Check that all required attributes have been set and nothing + silly has been entered.
    +protected  voidcompile() + +
    +          Perform the compilation.
    + PathcreateBootclasspath() + +
    +          Adds a path to the bootclasspath.
    + PathcreateClasspath() + +
    +          Adds a path to the classpath.
    + Javac.ImplementationSpecificArgumentcreateCompilerArg() + +
    +          Adds an implementation specific command-line argument.
    + PathcreateCompilerClasspath() + +
    +          The classpath to use when loading the compiler implementation + if it is not a built-in one.
    + PathcreateExtdirs() + +
    +          Adds a path to extdirs.
    + PathcreateSourcepath() + +
    +          Adds a path to sourcepath.
    + PathcreateSrc() + +
    +          Adds a path for source compilation.
    + voidexecute() + +
    +          Executes the task.
    + PathgetBootclasspath() + +
    +          Gets the bootclasspath that will be used to compile the classes + against.
    + PathgetClasspath() + +
    +          Gets the classpath to be used for this compilation.
    + java.lang.StringgetCompiler() + +
    +          The implementation for this particular task.
    + java.lang.StringgetCompilerVersion() + +
    +          The implementation for this particular task.
    + java.lang.String[]getCurrentCompilerArgs() + +
    +          Get the additional implementation specific command line arguments.
    + booleangetDebug() + +
    +          Gets the debug flag.
    + java.lang.StringgetDebugLevel() + +
    +          Get the value of debugLevel.
    + booleangetDepend() + +
    +          Gets the depend flag.
    + booleangetDeprecation() + +
    +          Gets the deprecation flag.
    + java.io.FilegetDestdir() + +
    +          Gets the destination directory into which the java source files + should be compiled.
    + java.lang.StringgetEncoding() + +
    +          Gets the java source file encoding name.
    + java.lang.StringgetExecutable() + +
    +          The value of the executable attribute, if any.
    + PathgetExtdirs() + +
    +          Gets the extension directories that will be used during the + compilation.
    + booleangetFailonerror() + +
    +          Gets the failonerror flag.
    + java.io.File[]getFileList() + +
    +          Gets the list of files to be compiled.
    + booleangetIncludeantruntime() + +
    +          Gets whether or not the ant classpath is to be included in the classpath.
    + booleangetIncludejavaruntime() + +
    +          Gets whether or not the java runtime should be included in this + task's classpath.
    + java.lang.StringgetJavacExecutable() + +
    +          The name of the javac executable to use in fork-mode.
    + booleangetListfiles() + +
    +          Get the listfiles flag.
    + java.lang.StringgetMemoryInitialSize() + +
    +          Gets the memoryInitialSize flag.
    + java.lang.StringgetMemoryMaximumSize() + +
    +          Gets the memoryMaximumSize flag.
    + booleangetNowarn() + +
    +          Should the -nowarn option be used.
    + booleangetOptimize() + +
    +          Gets the optimize flag.
    + java.lang.StringgetSource() + +
    +          Get the value of source.
    + PathgetSourcepath() + +
    +          Gets the sourcepath to be used for this compilation.
    + PathgetSrcdir() + +
    +          Gets the source dirs to find the source java files.
    +protected  java.lang.StringgetSystemJavac() + +
    +           
    + java.lang.StringgetTarget() + +
    +          Gets the target VM that the classes will be compiled for.
    + booleangetTaskSuccess() + +
    +          Get the result of the javac task (success or failure).
    + java.io.FilegetTempdir() + +
    +          Where Ant should place temporary files.
    + booleangetVerbose() + +
    +          Gets the verbose flag.
    + booleanisForkedJavac() + +
    +          Is this a forked invocation of JDK's javac?
    + booleanisIncludeDestClasses() + +
    +          Get the value of the includeDestClasses property.
    +protected  booleanisJdkCompiler(java.lang.String compilerImpl) + +
    +          Is the compiler implementation a jdk compiler
    +protected  PathrecreateSrc() + +
    +          Recreate src.
    +protected  voidresetFileLists() + +
    +          Clear the list of files to be compiled and copied..
    +protected  voidscanDir(java.io.File srcDir, + java.io.File destDir, + java.lang.String[] files) + +
    +          Scans the directory looking for source files to be compiled.
    + voidsetBootclasspath(Path bootclasspath) + +
    +          Sets the bootclasspath that will be used to compile the classes + against.
    + voidsetBootClasspathRef(Reference r) + +
    +          Adds a reference to a classpath defined elsewhere.
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used for this compilation.
    + voidsetClasspathRef(Reference r) + +
    +          Adds a reference to a classpath defined elsewhere.
    + voidsetCompiler(java.lang.String compiler) + +
    +          Choose the implementation for this particular task.
    + voidsetDebug(boolean debug) + +
    +          Indicates whether source should be compiled + with debug information; defaults to off.
    + voidsetDebugLevel(java.lang.String v) + +
    +          Keyword list to be appended to the -g command-line switch.
    + voidsetDepend(boolean depend) + +
    +          Enables dependency-tracking for compilers + that support this (jikes and classic).
    + voidsetDeprecation(boolean deprecation) + +
    +          Indicates whether source should be + compiled with deprecation information; defaults to off.
    + voidsetDestdir(java.io.File destDir) + +
    +          Set the destination directory into which the Java source + files should be compiled.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Set the Java source file encoding name.
    + voidsetErrorProperty(java.lang.String errorProperty) + +
    +          The property to set on compilation failure.
    + voidsetExecutable(java.lang.String forkExec) + +
    +          Sets the name of the javac executable.
    + voidsetExtdirs(Path extdirs) + +
    +          Sets the extension directories that will be used during the + compilation.
    + voidsetFailonerror(boolean fail) + +
    +          Indicates whether the build will continue + even if there are compilation errors; defaults to true.
    + voidsetFork(boolean f) + +
    +          If true, forks the javac compiler.
    + voidsetIncludeantruntime(boolean include) + +
    +          If true, includes Ant's own classpath in the classpath.
    + voidsetIncludeDestClasses(boolean includeDestClasses) + +
    +          This property controls whether to include the + destination classes directory in the classpath + given to the compiler.
    + voidsetIncludejavaruntime(boolean include) + +
    +          If true, includes the Java runtime libraries in the classpath.
    + voidsetListfiles(boolean list) + +
    +          If true, list the source files being handed off to the compiler.
    + voidsetMemoryInitialSize(java.lang.String memoryInitialSize) + +
    +          The initial size of the memory for the underlying VM + if javac is run externally; ignored otherwise.
    + voidsetMemoryMaximumSize(java.lang.String memoryMaximumSize) + +
    +          The maximum size of the memory for the underlying VM + if javac is run externally; ignored otherwise.
    + voidsetNowarn(boolean flag) + +
    +          If true, enables the -nowarn option.
    + voidsetOptimize(boolean optimize) + +
    +          If true, compiles with optimization enabled.
    + voidsetProceed(boolean proceed) + +
    +           
    + voidsetSource(java.lang.String v) + +
    +          Value of the -source command-line switch; will be ignored by + all implementations except modern, jikes and gcj (gcj uses + -fsource).
    + voidsetSourcepath(Path sourcepath) + +
    +          Set the sourcepath to be used for this compilation.
    + voidsetSourcepathRef(Reference r) + +
    +          Adds a reference to a source path defined elsewhere.
    + voidsetSrcdir(Path srcDir) + +
    +          Set the source directories to find the source Java files.
    + voidsetTarget(java.lang.String target) + +
    +          Sets the target VM that the classes will be compiled for.
    + voidsetTempdir(java.io.File tmpDir) + +
    +          Where Ant should place temporary files.
    + voidsetUpdatedProperty(java.lang.String updatedProperty) + +
    +          The property to set on compilation success.
    + voidsetVerbose(boolean verbose) + +
    +          If true, asks the compiler for verbose output.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +failOnError

    +
    +protected boolean failOnError
    +
    +
    +
    +
    +
    + +

    +listFiles

    +
    +protected boolean listFiles
    +
    +
    +
    +
    +
    + +

    +compileList

    +
    +protected java.io.File[] compileList
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Javac

    +
    +public Javac()
    +
    +
    Javac task for compilation of Java files. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getDebugLevel

    +
    +public java.lang.String getDebugLevel()
    +
    +
    Get the value of debugLevel. +

    +

    + +
    Returns:
    value of debugLevel.
    +
    +
    +
    + +

    +setDebugLevel

    +
    +public void setDebugLevel(java.lang.String v)
    +
    +
    Keyword list to be appended to the -g command-line switch. + + This will be ignored by all implementations except modern + and classic(ver >= 1.2). Legal values are none or a + comma-separated list of the following keywords: lines, vars, + and source. If debuglevel is not specified, by default, :none + will be appended to -g. If debug is not turned on, this attribute + will be ignored. +

    +

    +
    Parameters:
    v - Value to assign to debugLevel.
    +
    +
    +
    + +

    +getSource

    +
    +public java.lang.String getSource()
    +
    +
    Get the value of source. +

    +

    + +
    Returns:
    value of source.
    +
    +
    +
    + +

    +setSource

    +
    +public void setSource(java.lang.String v)
    +
    +
    Value of the -source command-line switch; will be ignored by + all implementations except modern, jikes and gcj (gcj uses + -fsource). + +

    If you use this attribute together with jikes or gcj, you + must make sure that your version of jikes supports the -source + switch.

    + +

    Legal values are 1.3, 1.4, 1.5, and 5 - by default, no + -source argument will be used at all.

    +

    +

    +
    Parameters:
    v - Value to assign to source.
    +
    +
    +
    + +

    +createSrc

    +
    +public Path createSrc()
    +
    +
    Adds a path for source compilation. +

    +

    + +
    Returns:
    a nested src element.
    +
    +
    +
    + +

    +recreateSrc

    +
    +protected Path recreateSrc()
    +
    +
    Recreate src. +

    +

    + +
    Returns:
    a nested src element.
    +
    +
    +
    + +

    +setSrcdir

    +
    +public void setSrcdir(Path srcDir)
    +
    +
    Set the source directories to find the source Java files. +

    +

    +
    Parameters:
    srcDir - the source directories as a path
    +
    +
    +
    + +

    +getSrcdir

    +
    +public Path getSrcdir()
    +
    +
    Gets the source dirs to find the source java files. +

    +

    + +
    Returns:
    the source directories as a path
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File destDir)
    +
    +
    Set the destination directory into which the Java source + files should be compiled. +

    +

    +
    Parameters:
    destDir - the destination director
    +
    +
    +
    + +

    +getDestdir

    +
    +public java.io.File getDestdir()
    +
    +
    Gets the destination directory into which the java source files + should be compiled. +

    +

    + +
    Returns:
    the destination directory
    +
    +
    +
    + +

    +setSourcepath

    +
    +public void setSourcepath(Path sourcepath)
    +
    +
    Set the sourcepath to be used for this compilation. +

    +

    +
    Parameters:
    sourcepath - the source path
    +
    +
    +
    + +

    +getSourcepath

    +
    +public Path getSourcepath()
    +
    +
    Gets the sourcepath to be used for this compilation. +

    +

    + +
    Returns:
    the source path
    +
    +
    +
    + +

    +createSourcepath

    +
    +public Path createSourcepath()
    +
    +
    Adds a path to sourcepath. +

    +

    + +
    Returns:
    a sourcepath to be configured
    +
    +
    +
    + +

    +setSourcepathRef

    +
    +public void setSourcepathRef(Reference r)
    +
    +
    Adds a reference to a source path defined elsewhere. +

    +

    +
    Parameters:
    r - a reference to a source path
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used for this compilation. +

    +

    +
    Parameters:
    classpath - an Ant Path object containing the compilation classpath.
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    Gets the classpath to be used for this compilation. +

    +

    + +
    Returns:
    the class path
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Adds a path to the classpath. +

    +

    + +
    Returns:
    a class path to be configured
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Adds a reference to a classpath defined elsewhere. +

    +

    +
    Parameters:
    r - a reference to a classpath
    +
    +
    +
    + +

    +setBootclasspath

    +
    +public void setBootclasspath(Path bootclasspath)
    +
    +
    Sets the bootclasspath that will be used to compile the classes + against. +

    +

    +
    Parameters:
    bootclasspath - a path to use as a boot class path (may be more + than one)
    +
    +
    +
    + +

    +getBootclasspath

    +
    +public Path getBootclasspath()
    +
    +
    Gets the bootclasspath that will be used to compile the classes + against. +

    +

    + +
    Returns:
    the boot path
    +
    +
    +
    + +

    +createBootclasspath

    +
    +public Path createBootclasspath()
    +
    +
    Adds a path to the bootclasspath. +

    +

    + +
    Returns:
    a path to be configured
    +
    +
    +
    + +

    +setBootClasspathRef

    +
    +public void setBootClasspathRef(Reference r)
    +
    +
    Adds a reference to a classpath defined elsewhere. +

    +

    +
    Parameters:
    r - a reference to a classpath
    +
    +
    +
    + +

    +setExtdirs

    +
    +public void setExtdirs(Path extdirs)
    +
    +
    Sets the extension directories that will be used during the + compilation. +

    +

    +
    Parameters:
    extdirs - a path
    +
    +
    +
    + +

    +getExtdirs

    +
    +public Path getExtdirs()
    +
    +
    Gets the extension directories that will be used during the + compilation. +

    +

    + +
    Returns:
    the extension directories as a path
    +
    +
    +
    + +

    +createExtdirs

    +
    +public Path createExtdirs()
    +
    +
    Adds a path to extdirs. +

    +

    + +
    Returns:
    a path to be configured
    +
    +
    +
    + +

    +setListfiles

    +
    +public void setListfiles(boolean list)
    +
    +
    If true, list the source files being handed off to the compiler. +

    +

    +
    Parameters:
    list - if true list the source files
    +
    +
    +
    + +

    +getListfiles

    +
    +public boolean getListfiles()
    +
    +
    Get the listfiles flag. +

    +

    + +
    Returns:
    the listfiles flag
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean fail)
    +
    +
    Indicates whether the build will continue + even if there are compilation errors; defaults to true. +

    +

    +
    Parameters:
    fail - if true halt the build on failure
    +
    +
    +
    + +

    +setProceed

    +
    +public void setProceed(boolean proceed)
    +
    +
    +
    Parameters:
    proceed - inverse of failoferror
    +
    +
    +
    + +

    +getFailonerror

    +
    +public boolean getFailonerror()
    +
    +
    Gets the failonerror flag. +

    +

    + +
    Returns:
    the failonerror flag
    +
    +
    +
    + +

    +setDeprecation

    +
    +public void setDeprecation(boolean deprecation)
    +
    +
    Indicates whether source should be + compiled with deprecation information; defaults to off. +

    +

    +
    Parameters:
    deprecation - if true turn on deprecation information
    +
    +
    +
    + +

    +getDeprecation

    +
    +public boolean getDeprecation()
    +
    +
    Gets the deprecation flag. +

    +

    + +
    Returns:
    the deprecation flag
    +
    +
    +
    + +

    +setMemoryInitialSize

    +
    +public void setMemoryInitialSize(java.lang.String memoryInitialSize)
    +
    +
    The initial size of the memory for the underlying VM + if javac is run externally; ignored otherwise. + Defaults to the standard VM memory setting. + (Examples: 83886080, 81920k, or 80m) +

    +

    +
    Parameters:
    memoryInitialSize - string to pass to VM
    +
    +
    +
    + +

    +getMemoryInitialSize

    +
    +public java.lang.String getMemoryInitialSize()
    +
    +
    Gets the memoryInitialSize flag. +

    +

    + +
    Returns:
    the memoryInitialSize flag
    +
    +
    +
    + +

    +setMemoryMaximumSize

    +
    +public void setMemoryMaximumSize(java.lang.String memoryMaximumSize)
    +
    +
    The maximum size of the memory for the underlying VM + if javac is run externally; ignored otherwise. + Defaults to the standard VM memory setting. + (Examples: 83886080, 81920k, or 80m) +

    +

    +
    Parameters:
    memoryMaximumSize - string to pass to VM
    +
    +
    +
    + +

    +getMemoryMaximumSize

    +
    +public java.lang.String getMemoryMaximumSize()
    +
    +
    Gets the memoryMaximumSize flag. +

    +

    + +
    Returns:
    the memoryMaximumSize flag
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Set the Java source file encoding name. +

    +

    +
    Parameters:
    encoding - the source file encoding
    +
    +
    +
    + +

    +getEncoding

    +
    +public java.lang.String getEncoding()
    +
    +
    Gets the java source file encoding name. +

    +

    + +
    Returns:
    the source file encoding name
    +
    +
    +
    + +

    +setDebug

    +
    +public void setDebug(boolean debug)
    +
    +
    Indicates whether source should be compiled + with debug information; defaults to off. +

    +

    +
    Parameters:
    debug - if true compile with debug information
    +
    +
    +
    + +

    +getDebug

    +
    +public boolean getDebug()
    +
    +
    Gets the debug flag. +

    +

    + +
    Returns:
    the debug flag
    +
    +
    +
    + +

    +setOptimize

    +
    +public void setOptimize(boolean optimize)
    +
    +
    If true, compiles with optimization enabled. +

    +

    +
    Parameters:
    optimize - if true compile with optimization enabled
    +
    +
    +
    + +

    +getOptimize

    +
    +public boolean getOptimize()
    +
    +
    Gets the optimize flag. +

    +

    + +
    Returns:
    the optimize flag
    +
    +
    +
    + +

    +setDepend

    +
    +public void setDepend(boolean depend)
    +
    +
    Enables dependency-tracking for compilers + that support this (jikes and classic). +

    +

    +
    Parameters:
    depend - if true enable dependency-tracking
    +
    +
    +
    + +

    +getDepend

    +
    +public boolean getDepend()
    +
    +
    Gets the depend flag. +

    +

    + +
    Returns:
    the depend flag
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    If true, asks the compiler for verbose output. +

    +

    +
    Parameters:
    verbose - if true, asks the compiler for verbose output
    +
    +
    +
    + +

    +getVerbose

    +
    +public boolean getVerbose()
    +
    +
    Gets the verbose flag. +

    +

    + +
    Returns:
    the verbose flag
    +
    +
    +
    + +

    +setTarget

    +
    +public void setTarget(java.lang.String target)
    +
    +
    Sets the target VM that the classes will be compiled for. Valid + values depend on the compiler, for jdk 1.4 the valid values are + "1.1", "1.2", "1.3", "1.4", "1.5", "1.6", "1.7", "5", "6" and "7". +

    +

    +
    Parameters:
    target - the target VM
    +
    +
    +
    + +

    +getTarget

    +
    +public java.lang.String getTarget()
    +
    +
    Gets the target VM that the classes will be compiled for. +

    +

    + +
    Returns:
    the target VM
    +
    +
    +
    + +

    +setIncludeantruntime

    +
    +public void setIncludeantruntime(boolean include)
    +
    +
    If true, includes Ant's own classpath in the classpath. +

    +

    +
    Parameters:
    include - if true, includes Ant's own classpath in the classpath
    +
    +
    +
    + +

    +getIncludeantruntime

    +
    +public boolean getIncludeantruntime()
    +
    +
    Gets whether or not the ant classpath is to be included in the classpath. +

    +

    + +
    Returns:
    whether or not the ant classpath is to be included in the classpath
    +
    +
    +
    + +

    +setIncludejavaruntime

    +
    +public void setIncludejavaruntime(boolean include)
    +
    +
    If true, includes the Java runtime libraries in the classpath. +

    +

    +
    Parameters:
    include - if true, includes the Java runtime libraries in the classpath
    +
    +
    +
    + +

    +getIncludejavaruntime

    +
    +public boolean getIncludejavaruntime()
    +
    +
    Gets whether or not the java runtime should be included in this + task's classpath. +

    +

    + +
    Returns:
    the includejavaruntime attribute
    +
    +
    +
    + +

    +setFork

    +
    +public void setFork(boolean f)
    +
    +
    If true, forks the javac compiler. +

    +

    +
    Parameters:
    f - "true|false|on|off|yes|no"
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String forkExec)
    +
    +
    Sets the name of the javac executable. + +

    Ignored unless fork is true or extJavac has been specified + as the compiler.

    +

    +

    +
    Parameters:
    forkExec - the name of the executable
    +
    +
    +
    + +

    +getExecutable

    +
    +public java.lang.String getExecutable()
    +
    +
    The value of the executable attribute, if any. +

    +

    + +
    Returns:
    the name of the java executable
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +isForkedJavac

    +
    +public boolean isForkedJavac()
    +
    +
    Is this a forked invocation of JDK's javac? +

    +

    + +
    Returns:
    true if this is a forked invocation
    +
    +
    +
    + +

    +getJavacExecutable

    +
    +public java.lang.String getJavacExecutable()
    +
    +
    The name of the javac executable to use in fork-mode. + +

    This is either the name specified with the executable + attribute or the full path of the javac compiler of the VM Ant + is currently running in - guessed by Ant.

    + +

    You should not invoke this method if you + want to get the value of the executable command - use getExecutable for this.

    +

    +

    + +
    Returns:
    the name of the javac executable
    +
    +
    +
    + +

    +setNowarn

    +
    +public void setNowarn(boolean flag)
    +
    +
    If true, enables the -nowarn option. +

    +

    +
    Parameters:
    flag - if true, enable the -nowarn option
    +
    +
    +
    + +

    +getNowarn

    +
    +public boolean getNowarn()
    +
    +
    Should the -nowarn option be used. +

    +

    + +
    Returns:
    true if the -nowarn option should be used
    +
    +
    +
    + +

    +createCompilerArg

    +
    +public Javac.ImplementationSpecificArgument createCompilerArg()
    +
    +
    Adds an implementation specific command-line argument. +

    +

    + +
    Returns:
    a ImplementationSpecificArgument to be configured
    +
    +
    +
    + +

    +getCurrentCompilerArgs

    +
    +public java.lang.String[] getCurrentCompilerArgs()
    +
    +
    Get the additional implementation specific command line arguments. +

    +

    + +
    Returns:
    array of command line arguments, guaranteed to be non-null.
    +
    +
    +
    + +

    +setTempdir

    +
    +public void setTempdir(java.io.File tmpDir)
    +
    +
    Where Ant should place temporary files. +

    +

    +
    Parameters:
    tmpDir - the temporary directory
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getTempdir

    +
    +public java.io.File getTempdir()
    +
    +
    Where Ant should place temporary files. +

    +

    + +
    Returns:
    the temporary directory
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setUpdatedProperty

    +
    +public void setUpdatedProperty(java.lang.String updatedProperty)
    +
    +
    The property to set on compilation success. + This property will not be set if the compilation + fails, or if there are no files to compile. +

    +

    +
    Parameters:
    updatedProperty - the property name to use.
    Since:
    +
    Ant 1.7.1.
    +
    +
    +
    +
    + +

    +setErrorProperty

    +
    +public void setErrorProperty(java.lang.String errorProperty)
    +
    +
    The property to set on compilation failure. + This property will be set if the compilation + fails. +

    +

    +
    Parameters:
    errorProperty - the property name to use.
    Since:
    +
    Ant 1.7.1.
    +
    +
    +
    +
    + +

    +setIncludeDestClasses

    +
    +public void setIncludeDestClasses(boolean includeDestClasses)
    +
    +
    This property controls whether to include the + destination classes directory in the classpath + given to the compiler. + The default value is "true". +

    +

    +
    Parameters:
    includeDestClasses - the value to use.
    +
    +
    +
    + +

    +isIncludeDestClasses

    +
    +public boolean isIncludeDestClasses()
    +
    +
    Get the value of the includeDestClasses property. +

    +

    + +
    Returns:
    the value.
    +
    +
    +
    + +

    +getTaskSuccess

    +
    +public boolean getTaskSuccess()
    +
    +
    Get the result of the javac task (success or failure). +

    +

    + +
    Returns:
    true if compilation succeeded, or + was not neccessary, false if the compilation failed.
    +
    +
    +
    + +

    +createCompilerClasspath

    +
    +public Path createCompilerClasspath()
    +
    +
    The classpath to use when loading the compiler implementation + if it is not a built-in one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(CompilerAdapter adapter)
    +
    +
    Set the compiler adapter explicitly. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +resetFileLists

    +
    +protected void resetFileLists()
    +
    +
    Clear the list of files to be compiled and copied.. +

    +

    +
    +
    +
    +
    + +

    +scanDir

    +
    +protected void scanDir(java.io.File srcDir,
+                       java.io.File destDir,
+                       java.lang.String[] files)
    +
    +
    Scans the directory looking for source files to be compiled. + The results are returned in the class variable compileList +

    +

    +
    Parameters:
    srcDir - The source directory
    destDir - The destination directory
    files - An array of filenames
    +
    +
    +
    + +

    +getFileList

    +
    +public java.io.File[] getFileList()
    +
    +
    Gets the list of files to be compiled. +

    +

    + +
    Returns:
    the list of files as an array
    +
    +
    +
    + +

    +isJdkCompiler

    +
    +protected boolean isJdkCompiler(java.lang.String compilerImpl)
    +
    +
    Is the compiler implementation a jdk compiler +

    +

    +
    Parameters:
    compilerImpl - the name of the compiler implementation +
    Returns:
    true if compilerImpl is "modern", "classic", + "javac1.1", "javac1.2", "javac1.3", "javac1.4", "javac1.5" or + "javac1.6".
    +
    +
    +
    + +

    +getSystemJavac

    +
    +protected java.lang.String getSystemJavac()
    +
    +
    + +
    Returns:
    the executable name of the java compiler
    +
    +
    +
    + +

    +setCompiler

    +
    +public void setCompiler(java.lang.String compiler)
    +
    +
    Choose the implementation for this particular task. +

    +

    +
    Parameters:
    compiler - the name of the compiler
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getCompiler

    +
    +public java.lang.String getCompiler()
    +
    +
    The implementation for this particular task. + +

    Defaults to the build.compiler property but can be overridden + via the compiler and fork attributes.

    + +

    If fork has been set to true, the result will be extJavac + and not classic or java1.2 - no matter what the compiler + attribute looks like.

    +

    +

    + +
    Returns:
    the compiler.
    Since:
    +
    Ant 1.5
    +
    See Also:
    getCompilerVersion()
    +
    +
    +
    + +

    +getCompilerVersion

    +
    +public java.lang.String getCompilerVersion()
    +
    +
    The implementation for this particular task. + +

    Defaults to the build.compiler property but can be overridden + via the compiler attribute.

    + +

    This method does not take the fork attribute into + account.

    +

    +

    + +
    Returns:
    the compiler.
    Since:
    +
    Ant 1.5
    +
    See Also:
    getCompiler()
    +
    +
    +
    + +

    +checkParameters

    +
    +protected void checkParameters()
+                        throws BuildException
    +
    +
    Check that all required attributes have been set and nothing + silly has been entered. +

    +

    + +
    Throws: +
    BuildException - if an error occurs
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +compile

    +
    +protected void compile()
    +
    +
    Perform the compilation. +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.AccessType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.AccessType.html new file mode 100644 index 000000000..30a51f4cc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.AccessType.html @@ -0,0 +1,290 @@ + + + + + + +Javadoc.AccessType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.AccessType

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Javadoc.AccessType
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public static class Javadoc.AccessType
    extends EnumeratedAttribute
    + + +

    +EnumeratedAttribute implementation supporting the Javadoc scoping + values. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Javadoc.AccessType() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.AccessType

    +
    +public Javadoc.AccessType()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the allowed values for the access type.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html new file mode 100644 index 000000000..695e6b2f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html @@ -0,0 +1,320 @@ + + + + + + +Javadoc.DocletInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.DocletInfo

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo
+          extended by org.apache.tools.ant.taskdefs.Javadoc.DocletInfo
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.DocletInfo
    extends Javadoc.ExtensionInfo
    + + +

    +This class stores info about doclets. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javadoc.DocletInfo() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + Javadoc.DocletParamcreateParam() + +
    +          Create a doclet parameter to be configured by Ant.
    + java.util.EnumerationgetParams() + +
    +          Get the doclet's parameters.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo
    createPath, getName, getPath, setName, setPath, setPathRef
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.DocletInfo

    +
    +public Javadoc.DocletInfo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createParam

    +
    +public Javadoc.DocletParam createParam()
    +
    +
    Create a doclet parameter to be configured by Ant. +

    +

    + +
    Returns:
    a new DocletParam instance to be configured.
    +
    +
    +
    + +

    +getParams

    +
    +public java.util.Enumeration getParams()
    +
    +
    Get the doclet's parameters. +

    +

    + +
    Returns:
    an Enumeration of DocletParam instances.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletParam.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletParam.html new file mode 100644 index 000000000..84b34b956 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.DocletParam.html @@ -0,0 +1,324 @@ + + + + + + +Javadoc.DocletParam (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.DocletParam

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.DocletParam
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.DocletParam
    extends java.lang.Object
    + + +

    +Inner class used to manage doclet parameters. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.DocletParam() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the parameter name.
    + java.lang.StringgetValue() + +
    +          Get the parameter value.
    + voidsetName(java.lang.String name) + +
    +          Set the name of the parameter.
    + voidsetValue(java.lang.String value) + +
    +          Set the parameter value.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.DocletParam

    +
    +public Javadoc.DocletParam()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of the parameter. +

    +

    +
    Parameters:
    name - the name of the doclet parameter
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the parameter name. +

    +

    + +
    Returns:
    the parameter's name.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the parameter value. + + Note that only string values are supported. No resolution of file + paths is performed. +

    +

    +
    Parameters:
    value - the parameter value.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the parameter value. +

    +

    + +
    Returns:
    the parameter value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html new file mode 100644 index 000000000..6cf9a0f52 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html @@ -0,0 +1,402 @@ + + + + + + +Javadoc.ExtensionInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.ExtensionInfo

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Javadoc.DocletInfo
    +
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public static class Javadoc.ExtensionInfo
    extends ProjectComponent
    + + +

    +A project aware class used for Javadoc extensions which take a name + and a path such as doclet and taglet arguments. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javadoc.ExtensionInfo() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreatePath() + +
    +          Create an empty nested path to be configured by Ant with the + classpath for the extension.
    + java.lang.StringgetName() + +
    +          Get the name of the extension.
    + PathgetPath() + +
    +          Get the extension's path.
    + voidsetName(java.lang.String name) + +
    +          Set the name of the extension
    + voidsetPath(Path path) + +
    +          Set the path to use when loading the component.
    + voidsetPathRef(Reference r) + +
    +          Adds a reference to a CLASSPATH defined elsewhere.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.ExtensionInfo

    +
    +public Javadoc.ExtensionInfo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of the extension +

    +

    +
    Parameters:
    name - the extension's name.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name of the extension. +

    +

    + +
    Returns:
    the extension's name.
    +
    +
    +
    + +

    +setPath

    +
    +public void setPath(Path path)
    +
    +
    Set the path to use when loading the component. +

    +

    +
    Parameters:
    path - a Path instance containing the classpath to use.
    +
    +
    +
    + +

    +getPath

    +
    +public Path getPath()
    +
    +
    Get the extension's path. +

    +

    + +
    Returns:
    the path to be used to load the extension. + May be null
    +
    +
    +
    + +

    +createPath

    +
    +public Path createPath()
    +
    +
    Create an empty nested path to be configured by Ant with the + classpath for the extension. +

    +

    + +
    Returns:
    a new Path instance to be configured.
    +
    +
    +
    + +

    +setPathRef

    +
    +public void setPathRef(Reference r)
    +
    +
    Adds a reference to a CLASSPATH defined elsewhere. +

    +

    +
    Parameters:
    r - the reference containing the path.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html new file mode 100644 index 000000000..a19726379 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html @@ -0,0 +1,365 @@ + + + + + + +Javadoc.GroupArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.GroupArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.GroupArgument
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.GroupArgument
    extends java.lang.Object
    + + +

    +A class corresponding to the group nested element. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.GroupArgument() + +
    +          Constructor for GroupArgument
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddPackage(Javadoc.PackageName pn) + +
    +          Add a package nested element.
    + voidaddTitle(Javadoc.Html text) + +
    +          Set the title attribute using a nested Html value.
    + java.lang.StringgetPackages() + +
    +          Get the packages as a collon separated list.
    + java.lang.StringgetTitle() + +
    +          Get the title.
    + voidsetPackages(java.lang.String src) + +
    +          Set the packages to Javadoc on.
    + voidsetTitle(java.lang.String src) + +
    +          Set the title attribute using a string.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.GroupArgument

    +
    +public Javadoc.GroupArgument()
    +
    +
    Constructor for GroupArgument +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setTitle

    +
    +public void setTitle(java.lang.String src)
    +
    +
    Set the title attribute using a string. +

    +

    +
    Parameters:
    src - a String value
    +
    +
    +
    + +

    +addTitle

    +
    +public void addTitle(Javadoc.Html text)
    +
    +
    Set the title attribute using a nested Html value. +

    +

    +
    Parameters:
    text - a Html value
    +
    +
    +
    + +

    +getTitle

    +
    +public java.lang.String getTitle()
    +
    +
    Get the title. +

    +

    + +
    Returns:
    the title
    +
    +
    +
    + +

    +setPackages

    +
    +public void setPackages(java.lang.String src)
    +
    +
    Set the packages to Javadoc on. +

    +

    +
    Parameters:
    src - a comma separated list of packages
    +
    +
    +
    + +

    +addPackage

    +
    +public void addPackage(Javadoc.PackageName pn)
    +
    +
    Add a package nested element. +

    +

    +
    Parameters:
    pn - a nested element specifing the package.
    +
    +
    +
    + +

    +getPackages

    +
    +public java.lang.String getPackages()
    +
    +
    Get the packages as a collon separated list. +

    +

    + +
    Returns:
    the packages as a string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.Html.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.Html.html new file mode 100644 index 000000000..4eea2998d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.Html.html @@ -0,0 +1,281 @@ + + + + + + +Javadoc.Html (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.Html

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.Html
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public static class Javadoc.Html
    extends java.lang.Object
    + + +

    +An HTML element in the Javadoc. + + This class is used for those Javadoc elements which contain HTML such as + footers, headers, etc. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.Html() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String t) + +
    +          Add text to the element.
    + java.lang.StringgetText() + +
    +          Get the current text for the element.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.Html

    +
    +public Javadoc.Html()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addText

    +
    +public void addText(java.lang.String t)
    +
    +
    Add text to the element. +

    +

    +
    Parameters:
    t - the text to be added.
    +
    +
    +
    + +

    +getText

    +
    +public java.lang.String getText()
    +
    +
    Get the current text for the element. +

    +

    + +
    Returns:
    the current text.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html new file mode 100644 index 000000000..2d8002e45 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html @@ -0,0 +1,457 @@ + + + + + + +Javadoc.LinkArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.LinkArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.LinkArgument
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.LinkArgument
    extends java.lang.Object
    + + +

    +Represents a link triplet (href, whether link is offline, + location of the package list if off line) +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.LinkArgument() + +
    +          Constructor for LinkArguement
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetHref() + +
    +          Get the href attribute.
    + java.io.FilegetPackagelistLoc() + +
    +          Get the packetList location attribute.
    + java.net.URLgetPackagelistURL() + +
    +          Get the packetList location attribute.
    + booleanisLinkOffline() + +
    +          Get the linkOffline attribute.
    + voidsetHref(java.lang.String hr) + +
    +          Set the href attribute.
    + voidsetOffline(boolean offline) + +
    +          Set the offline attribute.
    + voidsetPackagelistLoc(java.io.File src) + +
    +          Set the packetlist location attribute.
    + voidsetPackagelistURL(java.net.URL src) + +
    +          Set the packetlist location attribute.
    + voidsetResolveLink(boolean resolve) + +
    +          Sets whether Ant should resolve the link attribute relative + to the current basedir.
    + booleanshouldResolveLink() + +
    +          should Ant resolve the link attribute relative to the + current basedir?
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.LinkArgument

    +
    +public Javadoc.LinkArgument()
    +
    +
    Constructor for LinkArguement +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setHref

    +
    +public void setHref(java.lang.String hr)
    +
    +
    Set the href attribute. +

    +

    +
    Parameters:
    hr - a String value
    +
    +
    +
    + +

    +getHref

    +
    +public java.lang.String getHref()
    +
    +
    Get the href attribute. +

    +

    + +
    Returns:
    the href attribute.
    +
    +
    +
    + +

    +setPackagelistLoc

    +
    +public void setPackagelistLoc(java.io.File src)
    +
    +
    Set the packetlist location attribute. +

    +

    +
    Parameters:
    src - a File value
    +
    +
    +
    + +

    +getPackagelistLoc

    +
    +public java.io.File getPackagelistLoc()
    +
    +
    Get the packetList location attribute. +

    +

    + +
    Returns:
    the packetList location attribute.
    +
    +
    +
    + +

    +setPackagelistURL

    +
    +public void setPackagelistURL(java.net.URL src)
    +
    +
    Set the packetlist location attribute. +

    +

    +
    Parameters:
    src - an URL value
    +
    +
    +
    + +

    +getPackagelistURL

    +
    +public java.net.URL getPackagelistURL()
    +
    +
    Get the packetList location attribute. +

    +

    + +
    Returns:
    the packetList location attribute.
    +
    +
    +
    + +

    +setOffline

    +
    +public void setOffline(boolean offline)
    +
    +
    Set the offline attribute. +

    +

    +
    Parameters:
    offline - a boolean value
    +
    +
    +
    + +

    +isLinkOffline

    +
    +public boolean isLinkOffline()
    +
    +
    Get the linkOffline attribute. +

    +

    + +
    Returns:
    the linkOffline attribute.
    +
    +
    +
    + +

    +setResolveLink

    +
    +public void setResolveLink(boolean resolve)
    +
    +
    Sets whether Ant should resolve the link attribute relative + to the current basedir. +

    +

    +
    Parameters:
    resolve - a boolean value
    +
    +
    +
    + +

    +shouldResolveLink

    +
    +public boolean shouldResolveLink()
    +
    +
    should Ant resolve the link attribute relative to the + current basedir? +

    +

    + +
    Returns:
    the resolveLink attribute.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.PackageName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.PackageName.html new file mode 100644 index 000000000..483cd0f63 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.PackageName.html @@ -0,0 +1,303 @@ + + + + + + +Javadoc.PackageName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.PackageName

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.PackageName
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public static class Javadoc.PackageName
    extends java.lang.Object
    + + +

    +Used to track info about the packages to be javadoc'd +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.PackageName() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the package name.
    + voidsetName(java.lang.String name) + +
    +          Set the name of the package
    + java.lang.StringtoString() + +
    +          Return a string rep for this object.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.PackageName

    +
    +public Javadoc.PackageName()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of the package +

    +

    +
    Parameters:
    name - the package name.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the package name. +

    +

    + +
    Returns:
    the package's name.
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Return a string rep for this object. +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    the package name.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ResourceCollectionContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ResourceCollectionContainer.html new file mode 100644 index 000000000..8137cc498 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.ResourceCollectionContainer.html @@ -0,0 +1,260 @@ + + + + + + +Javadoc.ResourceCollectionContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.ResourceCollectionContainer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.ResourceCollectionContainer
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.ResourceCollectionContainer
    extends java.lang.Object
    + + +

    +Holds a collection of ResourceCollections. + +

    A separate kind of container is needed since this task + contains special handling for FileSets that has to occur at + task runtime.

    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.ResourceCollectionContainer() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Add a resource collection to the container.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.ResourceCollectionContainer

    +
    +public Javadoc.ResourceCollectionContainer()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a resource collection to the container. +

    +

    +
    Parameters:
    rc - the collection to add.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html new file mode 100644 index 000000000..74488d3cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html @@ -0,0 +1,298 @@ + + + + + + +Javadoc.SourceFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.SourceFile

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Javadoc.SourceFile
+
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public static class Javadoc.SourceFile
    extends java.lang.Object
    + + +

    +This class is used to manage the source files to be processed. +

    + +

    +

    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    Javadoc.SourceFile() + +
    +          Default constructor
    Javadoc.SourceFile(java.io.File file) + +
    +          Constructor specifying the source file directly
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.FilegetFile() + +
    +          Get the source file.
    + voidsetFile(java.io.File file) + +
    +          Set the source file.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.SourceFile

    +
    +public Javadoc.SourceFile()
    +
    +
    Default constructor +

    +

    +
    + +

    +Javadoc.SourceFile

    +
    +public Javadoc.SourceFile(java.io.File file)
    +
    +
    Constructor specifying the source file directly +

    +

    +
    Parameters:
    file - the source file
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set the source file. +

    +

    +
    Parameters:
    file - the source file.
    +
    +
    +
    + +

    +getFile

    +
    +public java.io.File getFile()
    +
    +
    Get the source file. +

    +

    + +
    Returns:
    the source file.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html new file mode 100644 index 000000000..5846ba01f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html @@ -0,0 +1,409 @@ + + + + + + +Javadoc.TagArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc.TagArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.taskdefs.Javadoc.TagArgument
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ResourceCollection, SelectorContainer
    +
    +
    +
    Enclosing class:
    Javadoc
    +
    +
    +
    +
    public class Javadoc.TagArgument
    extends FileSet
    + + +

    +Class representing a -tag argument. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.DataType
    checked, ref
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javadoc.TagArgument() + +
    +          Sole constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetParameter() + +
    +          Returns the -tag parameter this argument represented.
    + voidsetEnabled(boolean enabled) + +
    +          Sets whether or not the tag is enabled.
    + voidsetName(java.lang.String name) + +
    +          Sets the name of the tag.
    + voidsetScope(java.lang.String verboseScope) + +
    +          Sets the scope of the tag.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.FileSet
    clone, isFilesystemOnly, iterator, size
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.DataType
    checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc.TagArgument

    +
    +public Javadoc.TagArgument()
    +
    +
    Sole constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Sets the name of the tag. +

    +

    +
    Parameters:
    name - The name of the tag. + Must not be null or empty.
    +
    +
    +
    + +

    +setScope

    +
    +public void setScope(java.lang.String verboseScope)
+              throws BuildException
    +
    +
    Sets the scope of the tag. This is in comma-separated + form, with each element being one of "all" (the default), + "overview", "packages", "types", "constructors", "methods", + "fields". The elements are treated in a case-insensitive + manner. +

    +

    +
    Parameters:
    verboseScope - The scope of the tag. + Must not be null, + should not be empty. +
    Throws: +
    BuildException - if all is specified along with + other elements, if any elements are repeated, if no + elements are specified, or if any unrecognised elements are + specified.
    +
    +
    +
    + +

    +setEnabled

    +
    +public void setEnabled(boolean enabled)
    +
    +
    Sets whether or not the tag is enabled. +

    +

    +
    Parameters:
    enabled - Whether or not this tag is enabled.
    +
    +
    +
    + +

    +getParameter

    +
    +public java.lang.String getParameter()
+                              throws BuildException
    +
    +
    Returns the -tag parameter this argument represented. +

    +

    + +
    Returns:
    the -tag parameter as a string +
    Throws: +
    BuildException - if either the name or description + is null or empty.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.html new file mode 100644 index 000000000..1bfe4ba09 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Javadoc.html @@ -0,0 +1,2260 @@ + + + + + + +Javadoc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Javadoc

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Javadoc
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Javadoc
    extends Task
    + + +

    +Generates Javadoc documentation for a collection + of source code. + +

    Current known limitations are: + +

      +
    • patterns must be of the form "xxx.*", every other pattern doesn't + work. +
    • there is no control on arguments sanity since they are left + to the Javadoc implementation. +
    + +

    If no doclet is set, then the version and + author are by default "yes". + +

    Note: This task is run on another VM because the Javadoc code calls + System.exit() which would break Ant functionality. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classJavadoc.AccessType + +
    +          EnumeratedAttribute implementation supporting the Javadoc scoping + values.
    + classJavadoc.DocletInfo + +
    +          This class stores info about doclets.
    + classJavadoc.DocletParam + +
    +          Inner class used to manage doclet parameters.
    +static classJavadoc.ExtensionInfo + +
    +          A project aware class used for Javadoc extensions which take a name + and a path such as doclet and taglet arguments.
    + classJavadoc.GroupArgument + +
    +          A class corresponding to the group nested element.
    +static classJavadoc.Html + +
    +          An HTML element in the Javadoc.
    + classJavadoc.LinkArgument + +
    +          Represents a link triplet (href, whether link is offline, + location of the package list if off line)
    +static classJavadoc.PackageName + +
    +          Used to track info about the packages to be javadoc'd
    + classJavadoc.ResourceCollectionContainer + +
    +          Holds a collection of ResourceCollections.
    +static classJavadoc.SourceFile + +
    +          This class is used to manage the source files to be processed.
    + classJavadoc.TagArgument + +
    +          Class representing a -tag argument.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javadoc() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddBottom(Javadoc.Html text) + +
    +          Set the text to be placed at the bottom of each output file.
    + voidaddDoctitle(Javadoc.Html text) + +
    +          Add a document title to use for the overview page.
    + voidaddExcludePackage(Javadoc.PackageName pn) + +
    +          Add a package to be excluded from the Javadoc run.
    + voidaddFileset(FileSet fs) + +
    +          Adds a fileset.
    + voidaddFooter(Javadoc.Html text) + +
    +          Set the footer text to be placed at the bottom of each output file.
    + voidaddHeader(Javadoc.Html text) + +
    +          Set the header text to be placed at the top of each output file.
    + voidaddPackage(Javadoc.PackageName pn) + +
    +          Add a single package to be processed.
    + voidaddPackageset(DirSet packageSet) + +
    +          Adds a packageset.
    + voidaddSource(Javadoc.SourceFile sf) + +
    +          Add a single source file.
    + voidaddTaglet(Javadoc.ExtensionInfo tagletInfo) + +
    +          Add a taglet
    + Commandline.ArgumentcreateArg() + +
    +          Adds a command-line argument.
    + PathcreateBootclasspath() + +
    +          Create a Path to be configured with the boot classpath
    + PathcreateClasspath() + +
    +          Create a Path to be configured with the classpath to use
    + Javadoc.DocletInfocreateDoclet() + +
    +          Create a doclet to be used in the documentation generation.
    + Javadoc.GroupArgumentcreateGroup() + +
    +          Separates packages on the overview page into whatever + groups you specify, one group per table.
    + Javadoc.LinkArgumentcreateLink() + +
    +          Create link to Javadoc output at the given URL.
    + Javadoc.ResourceCollectionContainercreateSourceFiles() + +
    +          Adds a container for resource collections.
    + PathcreateSourcepath() + +
    +          Create a path to be configured with the locations of the source + files.
    + Javadoc.TagArgumentcreateTag() + +
    +          Creates and adds a -tag argument.
    + voidexecute() + +
    +          Execute the task.
    +protected  java.lang.Stringexpand(java.lang.String content) + +
    +          Convenience method to expand properties.
    + voidsetAccess(Javadoc.AccessType at) + +
    +          Set the scope to be processed.
    + voidsetAdditionalparam(java.lang.String add) + +
    +          Set an additional parameter on the command line
    + voidsetAuthor(boolean b) + +
    +          Include the author tag in the generated documentation.
    + voidsetBootclasspath(Path path) + +
    +          Set the boot classpath to use.
    + voidsetBootClasspathRef(Reference r) + +
    +          Adds a reference to a CLASSPATH defined elsewhere.
    + voidsetBottom(java.lang.String bottom) + +
    +          Set the text to be placed at the bottom of each output file.
    + voidsetBreakiterator(boolean b) + +
    +          Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version.
    + voidsetCharset(java.lang.String src) + +
    +          Charset for cross-platform viewing of generated documentation.
    + voidsetClasspath(Path path) + +
    +          Set the classpath to be used for this Javadoc run.
    + voidsetClasspathRef(Reference r) + +
    +          Adds a reference to a CLASSPATH defined elsewhere.
    + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
    +          Sets whether default exclusions should be used or not.
    + voidsetDestdir(java.io.File dir) + +
    +          Set the directory where the Javadoc output will be generated.
    + voidsetDocencoding(java.lang.String enc) + +
    +          Output file encoding name.
    + voidsetDocFilesSubDirs(boolean b) + +
    +          Enables deep-copying of doc-files directories.
    + voidsetDoclet(java.lang.String docletName) + +
    +          Set the class that starts the doclet used in generating the + documentation.
    + voidsetDocletPath(Path docletPath) + +
    +          Set the classpath used to find the doclet class.
    + voidsetDocletPathRef(Reference r) + +
    +          Set the classpath used to find the doclet class by reference.
    + voidsetDoctitle(java.lang.String doctitle) + +
    +          Set the title of the generated overview page.
    + voidsetEncoding(java.lang.String enc) + +
    +          Set the encoding name of the source files,
    + voidsetExcludeDocFilesSubDir(java.lang.String s) + +
    +          Colon-separated list of doc-files subdirectories + to skip if docFilesSubDirs is true.
    + voidsetExcludePackageNames(java.lang.String packages) + +
    +          Set the list of packages to be excluded.
    + voidsetExecutable(java.lang.String executable) + +
    +          Sets the actual executable command to invoke, instead of the binary + javadoc found in Ant's JDK.
    + voidsetExtdirs(Path path) + +
    +          Set the location of the extensions directories.
    + voidsetExtdirs(java.lang.String path) + +
    +          Deprecated. since 1.5.x. + Use the setExtdirs(Path) version.
    + voidsetFailonerror(boolean b) + +
    +          Should the build process fail if Javadoc fails (as indicated by + a non zero return code)?
    + voidsetFooter(java.lang.String footer) + +
    +          Set the footer text to be placed at the bottom of each output file.
    + voidsetGroup(java.lang.String src) + +
    +          Group specified packages together in overview page.
    + voidsetHeader(java.lang.String header) + +
    +          Set the header text to be placed at the top of each output file.
    + voidsetHelpfile(java.io.File f) + +
    +          Specifies the HTML help file to use.
    + voidsetIncludeNoSourcePackages(boolean b) + +
    +          If set to true, Ant will also accept packages that only hold + package.html files but no Java sources.
    + voidsetLink(java.lang.String src) + +
    +          Create links to Javadoc output at the given URL.
    + voidsetLinkoffline(java.lang.String src) + +
    +          Link to docs at "url" using package list at "url2" + - separate the URLs by using a space character.
    + voidsetLinksource(boolean b) + +
    +          Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version.
    + voidsetLocale(java.lang.String locale) + +
    +          Set the local to use in documentation generation.
    + voidsetMaxmemory(java.lang.String max) + +
    +          Set the maximum memory to be used by the javadoc process
    + voidsetNodeprecated(boolean b) + +
    +          Control deprecation infromation
    + voidsetNodeprecatedlist(boolean b) + +
    +          Control deprecated list generation
    + voidsetNohelp(boolean b) + +
    +          Control generation of help link.
    + voidsetNoindex(boolean b) + +
    +          Control generation of index.
    + voidsetNonavbar(boolean b) + +
    +          Control generation of the navigation bar.
    + voidsetNoqualifier(java.lang.String noqualifier) + +
    +          Enables the -noqualifier switch, will be ignored if Javadoc is not + the 1.4 version.
    + voidsetNotree(boolean b) + +
    +          Control class tree generation.
    + voidsetOld(boolean b) + +
    +          Indicate whether Javadoc should produce old style (JDK 1.1) + documentation.
    + voidsetOverview(java.io.File f) + +
    +          Specify the file containing the overview to be included in the generated + documentation.
    + voidsetPackage(boolean b) + +
    +          Indicate whether only package, protected and public classes and + members are to be included in the scope processed
    + voidsetPackageList(java.lang.String src) + +
    +          The name of a file containing the packages to process.
    + voidsetPackagenames(java.lang.String packages) + +
    +          Set the package names to be processed.
    + voidsetPrivate(boolean b) + +
    +          Indicate whether all classes and + members are to be included in the scope processed
    + voidsetProtected(boolean b) + +
    +          Indicate whether only protected and public classes and members are to + be included in the scope processed
    + voidsetPublic(boolean b) + +
    +          Indicate whether only public classes and members are to be included in + the scope processed
    + voidsetSerialwarn(boolean b) + +
    +          Control warnings about serial tag.
    + voidsetSource(java.lang.String source) + +
    +          Enables the -source switch, will be ignored if Javadoc is not + the 1.4 version.
    + voidsetSourcefiles(java.lang.String src) + +
    +          Set the list of source files to process.
    + voidsetSourcepath(Path src) + +
    +          Specify where to find source file
    + voidsetSourcepathRef(Reference r) + +
    +          Adds a reference to a CLASSPATH defined elsewhere.
    + voidsetSplitindex(boolean b) + +
    +          Generate a split index
    + voidsetStylesheetfile(java.io.File f) + +
    +          Specifies the CSS stylesheet file to use.
    + voidsetUse(boolean b) + +
    +          Generate the "use" page for each package.
    + voidsetUseExternalFile(boolean b) + +
    +          Work around command line length limit by using an external file + for the sourcefiles.
    + voidsetVerbose(boolean b) + +
    +          Run javadoc in verbose mode
    + voidsetVersion(boolean b) + +
    +          Include the version tag in the generated documentation.
    + voidsetWindowtitle(java.lang.String title) + +
    +          Set the title to be placed in the HTML <title> tag of the + generated documentation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javadoc

    +
    +public Javadoc()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setUseExternalFile

    +
    +public void setUseExternalFile(boolean b)
    +
    +
    Work around command line length limit by using an external file + for the sourcefiles. +

    +

    +
    Parameters:
    b - true if an external file is to be used.
    +
    +
    +
    + +

    +setDefaultexcludes

    +
    +public void setDefaultexcludes(boolean useDefaultExcludes)
    +
    +
    Sets whether default exclusions should be used or not. +

    +

    +
    Parameters:
    useDefaultExcludes - "true"|"on"|"yes" when default exclusions + should be used, "false"|"off"|"no" when they + shouldn't be used.
    +
    +
    +
    + +

    +setMaxmemory

    +
    +public void setMaxmemory(java.lang.String max)
    +
    +
    Set the maximum memory to be used by the javadoc process +

    +

    +
    Parameters:
    max - a string indicating the maximum memory according to the + JVM conventions (e.g. 128m is 128 Megabytes)
    +
    +
    +
    + +

    +setAdditionalparam

    +
    +public void setAdditionalparam(java.lang.String add)
    +
    +
    Set an additional parameter on the command line +

    +

    +
    Parameters:
    add - the additional command line parameter for the javadoc task.
    +
    +
    +
    + +

    +createArg

    +
    +public Commandline.Argument createArg()
    +
    +
    Adds a command-line argument. +

    +

    + +
    Returns:
    a command-line argument to configure
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setSourcepath

    +
    +public void setSourcepath(Path src)
    +
    +
    Specify where to find source file +

    +

    +
    Parameters:
    src - a Path instance containing the various source directories.
    +
    +
    +
    + +

    +createSourcepath

    +
    +public Path createSourcepath()
    +
    +
    Create a path to be configured with the locations of the source + files. +

    +

    + +
    Returns:
    a new Path instance to be configured by the Ant core.
    +
    +
    +
    + +

    +setSourcepathRef

    +
    +public void setSourcepathRef(Reference r)
    +
    +
    Adds a reference to a CLASSPATH defined elsewhere. +

    +

    +
    Parameters:
    r - the reference containing the source path definition.
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File dir)
    +
    +
    Set the directory where the Javadoc output will be generated. +

    +

    +
    Parameters:
    dir - the destination directory.
    +
    +
    +
    + +

    +setSourcefiles

    +
    +public void setSourcefiles(java.lang.String src)
    +
    +
    Set the list of source files to process. +

    +

    +
    Parameters:
    src - a comma separated list of source files.
    +
    +
    +
    + +

    +addSource

    +
    +public void addSource(Javadoc.SourceFile sf)
    +
    +
    Add a single source file. +

    +

    +
    Parameters:
    sf - the source file to be processed.
    +
    +
    +
    + +

    +setPackagenames

    +
    +public void setPackagenames(java.lang.String packages)
    +
    +
    Set the package names to be processed. +

    +

    +
    Parameters:
    packages - a comma separated list of packages specs + (may be wildcarded).
    See Also:
    for wildcard information.
    +
    +
    +
    + +

    +addPackage

    +
    +public void addPackage(Javadoc.PackageName pn)
    +
    +
    Add a single package to be processed. + + If the package name ends with ".*" the Javadoc task + will find and process all subpackages. +

    +

    +
    Parameters:
    pn - the package name, possibly wildcarded.
    +
    +
    +
    + +

    +setExcludePackageNames

    +
    +public void setExcludePackageNames(java.lang.String packages)
    +
    +
    Set the list of packages to be excluded. +

    +

    +
    Parameters:
    packages - a comma separated list of packages to be excluded. + This may not include wildcards.
    +
    +
    +
    + +

    +addExcludePackage

    +
    +public void addExcludePackage(Javadoc.PackageName pn)
    +
    +
    Add a package to be excluded from the Javadoc run. +

    +

    +
    Parameters:
    pn - the name of the package (wildcards are not permitted).
    +
    +
    +
    + +

    +setOverview

    +
    +public void setOverview(java.io.File f)
    +
    +
    Specify the file containing the overview to be included in the generated + documentation. +

    +

    +
    Parameters:
    f - the file containing the overview.
    +
    +
    +
    + +

    +setPublic

    +
    +public void setPublic(boolean b)
    +
    +
    Indicate whether only public classes and members are to be included in + the scope processed +

    +

    +
    Parameters:
    b - true if scope is to be public.
    +
    +
    +
    + +

    +setProtected

    +
    +public void setProtected(boolean b)
    +
    +
    Indicate whether only protected and public classes and members are to + be included in the scope processed +

    +

    +
    Parameters:
    b - true if scope is to be protected.
    +
    +
    +
    + +

    +setPackage

    +
    +public void setPackage(boolean b)
    +
    +
    Indicate whether only package, protected and public classes and + members are to be included in the scope processed +

    +

    +
    Parameters:
    b - true if scope is to be package level.
    +
    +
    +
    + +

    +setPrivate

    +
    +public void setPrivate(boolean b)
    +
    +
    Indicate whether all classes and + members are to be included in the scope processed +

    +

    +
    Parameters:
    b - true if scope is to be private level.
    +
    +
    +
    + +

    +setAccess

    +
    +public void setAccess(Javadoc.AccessType at)
    +
    +
    Set the scope to be processed. This is an alternative to the + use of the setPublic, setPrivate, etc methods. It gives better build + file control over what scope is processed. +

    +

    +
    Parameters:
    at - the scope to be processed.
    +
    +
    +
    + +

    +setDoclet

    +
    +public void setDoclet(java.lang.String docletName)
    +
    +
    Set the class that starts the doclet used in generating the + documentation. +

    +

    +
    Parameters:
    docletName - the name of the doclet class.
    +
    +
    +
    + +

    +setDocletPath

    +
    +public void setDocletPath(Path docletPath)
    +
    +
    Set the classpath used to find the doclet class. +

    +

    +
    Parameters:
    docletPath - the doclet classpath.
    +
    +
    +
    + +

    +setDocletPathRef

    +
    +public void setDocletPathRef(Reference r)
    +
    +
    Set the classpath used to find the doclet class by reference. +

    +

    +
    Parameters:
    r - the reference to the Path instance to use as the doclet + classpath.
    +
    +
    +
    + +

    +createDoclet

    +
    +public Javadoc.DocletInfo createDoclet()
    +
    +
    Create a doclet to be used in the documentation generation. +

    +

    + +
    Returns:
    a new DocletInfo instance to be configured.
    +
    +
    +
    + +

    +addTaglet

    +
    +public void addTaglet(Javadoc.ExtensionInfo tagletInfo)
    +
    +
    Add a taglet +

    +

    +
    Parameters:
    tagletInfo - information about the taglet.
    +
    +
    +
    + +

    +setOld

    +
    +public void setOld(boolean b)
    +
    +
    Indicate whether Javadoc should produce old style (JDK 1.1) + documentation. + + This is not supported by JDK 1.1 and has been phased out in JDK 1.4 +

    +

    +
    Parameters:
    b - if true attempt to generate old style documentation.
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path path)
    +
    +
    Set the classpath to be used for this Javadoc run. +

    +

    +
    Parameters:
    path - an Ant Path object containing the compilation + classpath.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Create a Path to be configured with the classpath to use +

    +

    + +
    Returns:
    a new Path instance to be configured with the classpath.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Adds a reference to a CLASSPATH defined elsewhere. +

    +

    +
    Parameters:
    r - the reference to an instance defining the classpath.
    +
    +
    +
    + +

    +setBootclasspath

    +
    +public void setBootclasspath(Path path)
    +
    +
    Set the boot classpath to use. +

    +

    +
    Parameters:
    path - the boot classpath.
    +
    +
    +
    + +

    +createBootclasspath

    +
    +public Path createBootclasspath()
    +
    +
    Create a Path to be configured with the boot classpath +

    +

    + +
    Returns:
    a new Path instance to be configured with the boot classpath.
    +
    +
    +
    + +

    +setBootClasspathRef

    +
    +public void setBootClasspathRef(Reference r)
    +
    +
    Adds a reference to a CLASSPATH defined elsewhere. +

    +

    +
    Parameters:
    r - the reference to an instance defining the bootclasspath.
    +
    +
    +
    + +

    +setExtdirs

    +
    +public void setExtdirs(java.lang.String path)
    +
    +
    Deprecated. since 1.5.x. + Use the setExtdirs(Path) version. +

    +

    Set the location of the extensions directories. +

    +

    +
    Parameters:
    path - the string version of the path.
    +
    +
    +
    + +

    +setExtdirs

    +
    +public void setExtdirs(Path path)
    +
    +
    Set the location of the extensions directories. +

    +

    +
    Parameters:
    path - a path containing the extension directories.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean b)
    +
    +
    Run javadoc in verbose mode +

    +

    +
    Parameters:
    b - true if operation is to be verbose.
    +
    +
    +
    + +

    +setLocale

    +
    +public void setLocale(java.lang.String locale)
    +
    +
    Set the local to use in documentation generation. +

    +

    +
    Parameters:
    locale - the locale to use.
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String enc)
    +
    +
    Set the encoding name of the source files, +

    +

    +
    Parameters:
    enc - the name of the encoding for the source files.
    +
    +
    +
    + +

    +setVersion

    +
    +public void setVersion(boolean b)
    +
    +
    Include the version tag in the generated documentation. +

    +

    +
    Parameters:
    b - true if the version tag should be included.
    +
    +
    +
    + +

    +setUse

    +
    +public void setUse(boolean b)
    +
    +
    Generate the "use" page for each package. +

    +

    +
    Parameters:
    b - true if the use page should be generated.
    +
    +
    +
    + +

    +setAuthor

    +
    +public void setAuthor(boolean b)
    +
    +
    Include the author tag in the generated documentation. +

    +

    +
    Parameters:
    b - true if the author tag should be included.
    +
    +
    +
    + +

    +setSplitindex

    +
    +public void setSplitindex(boolean b)
    +
    +
    Generate a split index +

    +

    +
    Parameters:
    b - true if the index should be split into a file per letter.
    +
    +
    +
    + +

    +setWindowtitle

    +
    +public void setWindowtitle(java.lang.String title)
    +
    +
    Set the title to be placed in the HTML <title> tag of the + generated documentation. +

    +

    +
    Parameters:
    title - the window title to use.
    +
    +
    +
    + +

    +setDoctitle

    +
    +public void setDoctitle(java.lang.String doctitle)
    +
    +
    Set the title of the generated overview page. +

    +

    +
    Parameters:
    doctitle - the Document title.
    +
    +
    +
    + +

    +addDoctitle

    +
    +public void addDoctitle(Javadoc.Html text)
    +
    +
    Add a document title to use for the overview page. +

    +

    +
    Parameters:
    text - the HTML element containing the document title.
    +
    +
    +
    + +

    +setHeader

    +
    +public void setHeader(java.lang.String header)
    +
    +
    Set the header text to be placed at the top of each output file. +

    +

    +
    Parameters:
    header - the header text
    +
    +
    +
    + +

    +addHeader

    +
    +public void addHeader(Javadoc.Html text)
    +
    +
    Set the header text to be placed at the top of each output file. +

    +

    +
    Parameters:
    text - the header text
    +
    +
    +
    + +

    +setFooter

    +
    +public void setFooter(java.lang.String footer)
    +
    +
    Set the footer text to be placed at the bottom of each output file. +

    +

    +
    Parameters:
    footer - the footer text.
    +
    +
    +
    + +

    +addFooter

    +
    +public void addFooter(Javadoc.Html text)
    +
    +
    Set the footer text to be placed at the bottom of each output file. +

    +

    +
    Parameters:
    text - the footer text.
    +
    +
    +
    + +

    +setBottom

    +
    +public void setBottom(java.lang.String bottom)
    +
    +
    Set the text to be placed at the bottom of each output file. +

    +

    +
    Parameters:
    bottom - the bottom text.
    +
    +
    +
    + +

    +addBottom

    +
    +public void addBottom(Javadoc.Html text)
    +
    +
    Set the text to be placed at the bottom of each output file. +

    +

    +
    Parameters:
    text - the bottom text.
    +
    +
    +
    + +

    +setLinkoffline

    +
    +public void setLinkoffline(java.lang.String src)
    +
    +
    Link to docs at "url" using package list at "url2" + - separate the URLs by using a space character. +

    +

    +
    Parameters:
    src - the offline link specification (url and package list)
    +
    +
    +
    + +

    +setGroup

    +
    +public void setGroup(java.lang.String src)
    +
    +
    Group specified packages together in overview page. +

    +

    +
    Parameters:
    src - the group packages - a command separated list of group specs, + each one being a group name and package specification separated + by a space.
    +
    +
    +
    + +

    +setLink

    +
    +public void setLink(java.lang.String src)
    +
    +
    Create links to Javadoc output at the given URL. +

    +

    +
    Parameters:
    src - the URL to link to
    +
    +
    +
    + +

    +setNodeprecated

    +
    +public void setNodeprecated(boolean b)
    +
    +
    Control deprecation infromation +

    +

    +
    Parameters:
    b - If true, do not include deprecated information.
    +
    +
    +
    + +

    +setNodeprecatedlist

    +
    +public void setNodeprecatedlist(boolean b)
    +
    +
    Control deprecated list generation +

    +

    +
    Parameters:
    b - if true, do not generate deprecated list.
    +
    +
    +
    + +

    +setNotree

    +
    +public void setNotree(boolean b)
    +
    +
    Control class tree generation. +

    +

    +
    Parameters:
    b - if true, do not generate class hierarchy.
    +
    +
    +
    + +

    +setNoindex

    +
    +public void setNoindex(boolean b)
    +
    +
    Control generation of index. +

    +

    +
    Parameters:
    b - if true, do not generate index.
    +
    +
    +
    + +

    +setNohelp

    +
    +public void setNohelp(boolean b)
    +
    +
    Control generation of help link. +

    +

    +
    Parameters:
    b - if true, do not generate help link
    +
    +
    +
    + +

    +setNonavbar

    +
    +public void setNonavbar(boolean b)
    +
    +
    Control generation of the navigation bar. +

    +

    +
    Parameters:
    b - if true, do not generate navigation bar.
    +
    +
    +
    + +

    +setSerialwarn

    +
    +public void setSerialwarn(boolean b)
    +
    +
    Control warnings about serial tag. +

    +

    +
    Parameters:
    b - if true, generate warning about the serial tag.
    +
    +
    +
    + +

    +setStylesheetfile

    +
    +public void setStylesheetfile(java.io.File f)
    +
    +
    Specifies the CSS stylesheet file to use. +

    +

    +
    Parameters:
    f - the file with the CSS to use.
    +
    +
    +
    + +

    +setHelpfile

    +
    +public void setHelpfile(java.io.File f)
    +
    +
    Specifies the HTML help file to use. +

    +

    +
    Parameters:
    f - the file containing help content.
    +
    +
    +
    + +

    +setDocencoding

    +
    +public void setDocencoding(java.lang.String enc)
    +
    +
    Output file encoding name. +

    +

    +
    Parameters:
    enc - name of the encoding to use.
    +
    +
    +
    + +

    +setPackageList

    +
    +public void setPackageList(java.lang.String src)
    +
    +
    The name of a file containing the packages to process. +

    +

    +
    Parameters:
    src - the file containing the package list.
    +
    +
    +
    + +

    +createLink

    +
    +public Javadoc.LinkArgument createLink()
    +
    +
    Create link to Javadoc output at the given URL. +

    +

    + +
    Returns:
    link argument to configure
    +
    +
    +
    + +

    +createTag

    +
    +public Javadoc.TagArgument createTag()
    +
    +
    Creates and adds a -tag argument. This is used to specify + custom tags. This argument is only available for Javadoc 1.4, + and will generate a verbose message (and then be ignored) + when run on Java versions below 1.4. +

    +

    + +
    Returns:
    tag argument to be configured
    +
    +
    +
    + +

    +createGroup

    +
    +public Javadoc.GroupArgument createGroup()
    +
    +
    Separates packages on the overview page into whatever + groups you specify, one group per table. +

    +

    + +
    Returns:
    a group argument to be configured
    +
    +
    +
    + +

    +setCharset

    +
    +public void setCharset(java.lang.String src)
    +
    +
    Charset for cross-platform viewing of generated documentation. +

    +

    +
    Parameters:
    src - the name of the charset
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean b)
    +
    +
    Should the build process fail if Javadoc fails (as indicated by + a non zero return code)? + +

    Default is false.

    +

    +

    +
    Parameters:
    b - a boolean value
    +
    +
    +
    + +

    +setSource

    +
    +public void setSource(java.lang.String source)
    +
    +
    Enables the -source switch, will be ignored if Javadoc is not + the 1.4 version. +

    +

    +
    Parameters:
    source - a String value
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String executable)
    +
    +
    Sets the actual executable command to invoke, instead of the binary + javadoc found in Ant's JDK. +

    +

    +
    Parameters:
    executable - the command to invoke.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +addPackageset

    +
    +public void addPackageset(DirSet packageSet)
    +
    +
    Adds a packageset. + +

    All included directories will be translated into package + names be converting the directory separator into dots.

    +

    +

    +
    Parameters:
    packageSet - a directory set
    Since:
    +
    1.5
    +
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet fs)
    +
    +
    Adds a fileset. + +

    All included files will be added as sourcefiles. The task + will automatically add + includes="**/*.java" to the + fileset.

    +

    +

    +
    Parameters:
    fs - a file set
    Since:
    +
    1.5
    +
    +
    +
    +
    + +

    +createSourceFiles

    +
    +public Javadoc.ResourceCollectionContainer createSourceFiles()
    +
    +
    Adds a container for resource collections. + +

    All included files will be added as sourcefiles.

    +

    +

    + +
    Returns:
    the source files to configure.
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +setLinksource

    +
    +public void setLinksource(boolean b)
    +
    +
    Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version. Default is false +

    +

    +
    Parameters:
    b - a String value
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setBreakiterator

    +
    +public void setBreakiterator(boolean b)
    +
    +
    Enables the -linksource switch, will be ignored if Javadoc is not + the 1.4 version. Default is false +

    +

    +
    Parameters:
    b - a String value
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setNoqualifier

    +
    +public void setNoqualifier(java.lang.String noqualifier)
    +
    +
    Enables the -noqualifier switch, will be ignored if Javadoc is not + the 1.4 version. +

    +

    +
    Parameters:
    noqualifier - the parameter to the -noqualifier switch
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setIncludeNoSourcePackages

    +
    +public void setIncludeNoSourcePackages(boolean b)
    +
    +
    If set to true, Ant will also accept packages that only hold + package.html files but no Java sources. +

    +

    +
    Parameters:
    b - a boolean value.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setDocFilesSubDirs

    +
    +public void setDocFilesSubDirs(boolean b)
    +
    +
    Enables deep-copying of doc-files directories. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setExcludeDocFilesSubDir

    +
    +public void setExcludeDocFilesSubDir(java.lang.String s)
    +
    +
    Colon-separated list of doc-files subdirectories + to skip if docFilesSubDirs is true. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +expand

    +
    +protected java.lang.String expand(java.lang.String content)
    +
    +
    Convenience method to expand properties. +

    +

    +
    Parameters:
    content - the string to expand +
    Returns:
    the converted string
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jikes.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jikes.html new file mode 100644 index 000000000..72245ec44 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Jikes.html @@ -0,0 +1,343 @@ + + + + + + +Jikes (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Jikes

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Jikes
+
    +
    +Deprecated. since 1.2. + Merged into the class Javac. +

    +

    +
    public class Jikes
    extends java.lang.Object
    + + +

    +Encapsulates a Jikes compiler, by directly executing an external + process. + +

    As of Ant 1.2, this class is considered to be dead code + by the Ant developers and is unmaintained. Don't use + it.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.Stringcommand + +
    +          Deprecated.  
    +protected  JikesOutputParserjop + +
    +          Deprecated.  
    +protected  Projectproject + +
    +          Deprecated.  
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected Jikes(JikesOutputParser jop, + java.lang.String command, + Project project) + +
    +          Deprecated. Constructs a new Jikes object.
    +  + + + + + + + + + + + +
    +Method Summary
    +protected  voidcompile(java.lang.String[] args) + +
    +          Deprecated. Do the compile with the specified arguments.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +jop

    +
    +protected JikesOutputParser jop
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +command

    +
    +protected java.lang.String command
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +project

    +
    +protected Project project
    +
    +
    Deprecated. 
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Jikes

    +
    +protected Jikes(JikesOutputParser jop,
+                java.lang.String command,
+                Project project)
    +
    +
    Deprecated. 
    Constructs a new Jikes object. +

    +

    +
    Parameters:
    jop - Parser to send jike's output to
    command - name of jikes executable
    project - the current project
    +
    + + + + + + + + +
    +Method Detail
    + +

    +compile

    +
    +protected void compile(java.lang.String[] args)
    +
    +
    Deprecated. 
    Do the compile with the specified arguments. +

    +

    +
    Parameters:
    args - - arguments to pass to process on command line
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JikesOutputParser.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JikesOutputParser.html new file mode 100644 index 000000000..24ea9e11c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/JikesOutputParser.html @@ -0,0 +1,574 @@ + + + + + + +JikesOutputParser (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class JikesOutputParser

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.JikesOutputParser
+
    +
    +
    All Implemented Interfaces:
    ExecuteStreamHandler
    +
    +
    +Deprecated. since 1.2. + Use Jikes' exit value to detect compilation failure. +

    +

    +
    public class JikesOutputParser
    extends java.lang.Object
    implements ExecuteStreamHandler
    + + +

    +Parses output from jikes and + passes errors and warnings + into the right logging channels of Project. + +

    As of Ant 1.2, this class is considered to be dead code + by the Ant developers and is unmaintained. Don't use + it.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.BufferedReaderbr + +
    +          Deprecated.  
    +protected  booleanemacsMode + +
    +          Deprecated.  
    +protected  booleanerror + +
    +          Deprecated.  
    +protected  booleanerrorFlag + +
    +          Deprecated.  
    +protected  interrors + +
    +          Deprecated.  
    +protected  Tasktask + +
    +          Deprecated.  
    +protected  intwarnings + +
    +          Deprecated.  
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected JikesOutputParser(Task task, + boolean emacsMode) + +
    +          Deprecated. Construct a new Parser object
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  booleangetErrorFlag() + +
    +          Deprecated. Indicate if there were errors during the compile
    +protected  voidparseOutput(java.io.BufferedReader reader) + +
    +          Deprecated. Parse the output of a jikes compiler
    + voidsetProcessErrorStream(java.io.InputStream is) + +
    +          Deprecated. Ignore.
    + voidsetProcessInputStream(java.io.OutputStream os) + +
    +          Deprecated. Ignore.
    + voidsetProcessOutputStream(java.io.InputStream is) + +
    +          Deprecated. Set the inputstream
    + voidstart() + +
    +          Deprecated. Invokes parseOutput.
    + voidstop() + +
    +          Deprecated. Ignore.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +task

    +
    +protected Task task
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +errorFlag

    +
    +protected boolean errorFlag
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +errors

    +
    +protected int errors
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +warnings

    +
    +protected int warnings
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +error

    +
    +protected boolean error
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +emacsMode

    +
    +protected boolean emacsMode
    +
    +
    Deprecated. 
    +
    +
    +
    + +

    +br

    +
    +protected java.io.BufferedReader br
    +
    +
    Deprecated. 
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +JikesOutputParser

    +
    +protected JikesOutputParser(Task task,
+                            boolean emacsMode)
    +
    +
    Deprecated. 
    Construct a new Parser object +

    +

    +
    Parameters:
    task - task in which context we are called
    emacsMode - if true output in emacs mode
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProcessInputStream

    +
    +public void setProcessInputStream(java.io.OutputStream os)
    +
    +
    Deprecated. 
    Ignore. +

    +

    +
    Specified by:
    setProcessInputStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    os - ignored
    +
    +
    +
    + +

    +setProcessErrorStream

    +
    +public void setProcessErrorStream(java.io.InputStream is)
    +
    +
    Deprecated. 
    Ignore. +

    +

    +
    Specified by:
    setProcessErrorStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    is - ignored
    +
    +
    +
    + +

    +setProcessOutputStream

    +
    +public void setProcessOutputStream(java.io.InputStream is)
+                            throws java.io.IOException
    +
    +
    Deprecated. 
    Set the inputstream +

    +

    +
    Specified by:
    setProcessOutputStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    is - the input stream +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +start

    +
    +public void start()
+           throws java.io.IOException
    +
    +
    Deprecated. 
    Invokes parseOutput. +

    +

    +
    Specified by:
    start in interface ExecuteStreamHandler
    +
    +
    + +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +stop

    +
    +public void stop()
    +
    +
    Deprecated. 
    Ignore. +

    +

    +
    Specified by:
    stop in interface ExecuteStreamHandler
    +
    +
    +
    +
    +
    +
    + +

    +parseOutput

    +
    +protected void parseOutput(java.io.BufferedReader reader)
+                    throws java.io.IOException
    +
    +
    Deprecated. 
    Parse the output of a jikes compiler +

    +

    +
    +
    +
    +
    Parameters:
    reader - - Reader used to read jikes's output +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +getErrorFlag

    +
    +protected boolean getErrorFlag()
    +
    +
    Deprecated. 
    Indicate if there were errors during the compile +

    +

    +
    +
    +
    + +
    Returns:
    if errors occurred
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/KeySubst.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/KeySubst.html new file mode 100644 index 000000000..1ecfa23c4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/KeySubst.html @@ -0,0 +1,462 @@ + + + + + + +KeySubst (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class KeySubst

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.KeySubst
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. KeySubst is deprecated since Ant 1.1. Use Filter + Copy + instead. +

    +

    +
    public class KeySubst
    extends Task
    + + +

    +Keyword substitution. Input file is written to output file. + Do not make input file same as output file. + Keywords in input files look like this: @foo@. See the docs for the + setKeys method to understand how to do the substitutions. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    KeySubst() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Do the execution.
    +static voidmain(java.lang.String[] args) + +
    +          Deprecated. A test method.
    +static java.lang.Stringreplace(java.lang.String origString, + java.util.Hashtable keys) + +
    +          Deprecated. Does replacement on text using the hashtable of keys.
    + voidsetDest(java.io.File dest) + +
    +          Deprecated. Set the destination file.
    + voidsetKeys(java.lang.String keys) + +
    +          Deprecated. Sets the keys.
    + voidsetSep(java.lang.String sep) + +
    +          Deprecated. Sets the separator between name=value arguments + in setKeys().
    + voidsetSrc(java.io.File s) + +
    +          Deprecated. Set the source file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +KeySubst

    +
    +public KeySubst()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Do the execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File s)
    +
    +
    Deprecated. 
    Set the source file. +

    +

    +
    Parameters:
    s - the source file
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    Deprecated. 
    Set the destination file. +

    +

    +
    Parameters:
    dest - the destination file
    +
    +
    +
    + +

    +setSep

    +
    +public void setSep(java.lang.String sep)
    +
    +
    Deprecated. 
    Sets the separator between name=value arguments + in setKeys(). By default it is "*". +

    +

    +
    Parameters:
    sep - the separator string
    +
    +
    +
    + +

    +setKeys

    +
    +public void setKeys(java.lang.String keys)
    +
    +
    Deprecated. 
    Sets the keys. + + Format string is like this: +

    + name=value*name2=value +

    + Names are case sensitive. +

    + Use the setSep() method to change the * to something else + if you need to use * as a name or value. +

    +

    +
    Parameters:
    keys - a String value
    +
    +
    +
    + +

    +main

    +
    +public static void main(java.lang.String[] args)
    +
    +
    Deprecated. 
    A test method. +

    +

    +
    Parameters:
    args - not used
    +
    +
    +
    + +

    +replace

    +
    +public static java.lang.String replace(java.lang.String origString,
+                                       java.util.Hashtable keys)
+                                throws BuildException
    +
    +
    Deprecated. 
    Does replacement on text using the hashtable of keys. +

    +

    +
    Parameters:
    origString - an input string
    keys - mapping of keys to values +
    Returns:
    the string with the replacements in it. +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.FileMode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.FileMode.html new file mode 100644 index 000000000..a8e0d189d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.FileMode.html @@ -0,0 +1,288 @@ + + + + + + +Length.FileMode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Length.FileMode

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Length.FileMode
+
    +
    +
    Enclosing class:
    Length
    +
    +
    +
    +
    public static class Length.FileMode
    extends EnumeratedAttribute
    + + +

    +EnumeratedAttribute operation mode +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Length.FileMode() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          Return the possible values for FileMode.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Length.FileMode

    +
    +public Length.FileMode()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Return the possible values for FileMode. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    String[].
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.When.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.When.html new file mode 100644 index 000000000..0800beca9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.When.html @@ -0,0 +1,273 @@ + + + + + + +Length.When (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Length.When

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.Comparison
+          extended by org.apache.tools.ant.taskdefs.Length.When
+
    +
    +
    Enclosing class:
    Length
    +
    +
    +
    +
    public static class Length.When
    extends Comparison
    + + +

    +EnumeratedAttribute for the when attribute. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.Comparison
    EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL, NOT_EQUAL
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Length.When() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.Comparison
    evaluate, getValues
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Length.When

    +
    +public Length.When()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.html new file mode 100644 index 000000000..a98b969b8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Length.html @@ -0,0 +1,656 @@ + + + + + + +Length (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Length

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Length
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Length
    extends Task
    implements Condition
    + + +

    +Gets lengths: of files/resources, byte size; of strings, length (optionally trimmed). + The task is overloaded in this way for semantic reasons, much like Available. +

    + +

    +

    +
    Since:
    +
    Ant 1.6.3
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classLength.FileMode + +
    +          EnumeratedAttribute operation mode
    +static classLength.When + +
    +          EnumeratedAttribute for the when attribute.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Length() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileSet fs) + +
    +          Add a FileSet.
    + voidadd(ResourceCollection c) + +
    +          Add a ResourceCollection.
    + booleaneval() + +
    +          Fulfill the condition contract.
    + voidexecute() + +
    +          Execute the length task.
    + booleangetTrim() + +
    +          Learn whether strings will be trimmed.
    + voidsetFile(java.io.File file) + +
    +          Set the single file for this task.
    + voidsetLength(long ell) + +
    +          Set the target count number for use as a Condition.
    + voidsetMode(Length.FileMode m) + +
    +          Set the execution mode for working with files.
    + voidsetProperty(java.lang.String property) + +
    +          The property in which the length will be stored.
    + voidsetResource(Resource resource) + +
    +          Set the single resource for this task.
    + voidsetString(java.lang.String string) + +
    +          Set the string whose length to get.
    + voidsetTrim(boolean trim) + +
    +          Set whether to trim in string mode.
    + voidsetWhen(Comparison c) + +
    +          Set the comparison for use as a Condition.
    + voidsetWhen(Length.When w) + +
    +          Set the comparison for use as a Condition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Length

    +
    +public Length()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    The property in which the length will be stored. +

    +

    +
    +
    +
    +
    Parameters:
    property - the String property key.
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(Resource resource)
    +
    +
    Set the single resource for this task. +

    +

    +
    +
    +
    +
    Parameters:
    resource - the Resource whose length to retrieve.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set the single file for this task. +

    +

    +
    +
    +
    +
    Parameters:
    file - the File whose length to retrieve.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileSet fs)
    +
    +
    Add a FileSet. +

    +

    +
    +
    +
    +
    Parameters:
    fs - the FileSet to add.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection c)
    +
    +
    Add a ResourceCollection. +

    +

    +
    +
    +
    +
    Parameters:
    c - the ResourceCollection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setLength

    +
    +public void setLength(long ell)
    +
    +
    Set the target count number for use as a Condition. +

    +

    +
    +
    +
    +
    Parameters:
    ell - the long length to compare with.
    +
    +
    +
    + +

    +setWhen

    +
    +public void setWhen(Length.When w)
    +
    +
    Set the comparison for use as a Condition. +

    +

    +
    +
    +
    +
    Parameters:
    w - EnumeratedAttribute When.
    See Also:
    Comparison
    +
    +
    +
    + +

    +setWhen

    +
    +public void setWhen(Comparison c)
    +
    +
    Set the comparison for use as a Condition. +

    +

    +
    +
    +
    +
    Parameters:
    c - Comparison.
    Since:
    +
    Ant 1.7
    +
    See Also:
    Comparison
    +
    +
    +
    + +

    +setMode

    +
    +public void setMode(Length.FileMode m)
    +
    +
    Set the execution mode for working with files. +

    +

    +
    +
    +
    +
    Parameters:
    m - the FileMode to use.
    +
    +
    +
    + +

    +setString

    +
    +public void setString(java.lang.String string)
    +
    +
    Set the string whose length to get. +

    +

    +
    +
    +
    +
    Parameters:
    string - String.
    +
    +
    +
    + +

    +setTrim

    +
    +public void setTrim(boolean trim)
    +
    +
    Set whether to trim in string mode. Default false. +

    +

    +
    +
    +
    +
    Parameters:
    trim - boolean.
    +
    +
    +
    + +

    +getTrim

    +
    +public boolean getTrim()
    +
    +
    Learn whether strings will be trimmed. Default false. +

    +

    +
    +
    +
    + +
    Returns:
    boolean trim setting.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute the length task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Fulfill the condition contract. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true. +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadFile.html new file mode 100644 index 000000000..7d72127c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadFile.html @@ -0,0 +1,317 @@ + + + + + + +LoadFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class LoadFile

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.LoadResource
+              extended by org.apache.tools.ant.taskdefs.LoadFile
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class LoadFile
    extends LoadResource
    + + +

    +Load a file into a property +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    LoadFile() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsetSrcFile(java.io.File srcFile) + +
    +          Sets the file to load.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.LoadResource
    addConfigured, addFilterChain, execute, setEncoding, setFailonerror, setProperty, setQuiet
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LoadFile

    +
    +public LoadFile()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrcFile

    +
    +public final void setSrcFile(java.io.File srcFile)
    +
    +
    Sets the file to load. +

    +

    +
    Parameters:
    srcFile - The new SrcFile value
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadProperties.html new file mode 100644 index 000000000..79aa731bc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadProperties.html @@ -0,0 +1,561 @@ + + + + + + +LoadProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class LoadProperties

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.LoadProperties
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class LoadProperties
    extends Task
    + + +

    +Load a file's contents as Ant properties. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    LoadProperties() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source resource.
    + voidaddFilterChain(FilterChain filter) + +
    +          Adds a FilterChain.
    + PathcreateClasspath() + +
    +          Add a classpath to use when looking up a resource.
    + voidexecute() + +
    +          load Ant properties from the source file or resource
    + PathgetClasspath() + +
    +          get the classpath used by this LoadProperties.
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to use when looking up a resource.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere
    + voidsetEncoding(java.lang.String encoding) + +
    +          Encoding to use for input, defaults to the platform's default + encoding.
    + voidsetPrefix(java.lang.String prefix) + +
    +          Set the prefix to load these properties under.
    + voidsetPrefixValues(boolean b) + +
    +          Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well.
    + voidsetResource(java.lang.String resource) + +
    +          Set the resource name of a property file to load.
    + voidsetSrcFile(java.io.File srcFile) + +
    +          Set the file to load.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LoadProperties

    +
    +public LoadProperties()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrcFile

    +
    +public final void setSrcFile(java.io.File srcFile)
    +
    +
    Set the file to load. +

    +

    +
    Parameters:
    srcFile - The new SrcFile value
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String resource)
    +
    +
    Set the resource name of a property file to load. +

    +

    +
    Parameters:
    resource - resource on classpath
    +
    +
    +
    + +

    +setEncoding

    +
    +public final void setEncoding(java.lang.String encoding)
    +
    +
    Encoding to use for input, defaults to the platform's default + encoding.

    + + For a list of possible values see + + http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html + .

    +

    +

    +
    Parameters:
    encoding - The new Encoding value
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to use when looking up a resource. +

    +

    +
    Parameters:
    classpath - to add to any existing classpath
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Add a classpath to use when looking up a resource. +

    +

    + +
    Returns:
    The classpath to be configured
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +

    +

    +
    Parameters:
    r - The reference value
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    get the classpath used by this LoadProperties. +

    +

    + +
    Returns:
    The classpath
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    Set the prefix to load these properties under. +

    +

    +
    Parameters:
    prefix - to set
    +
    +
    +
    + +

    +setPrefixValues

    +
    +public void setPrefixValues(boolean b)
    +
    +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +execute

    +
    +public final void execute()
+                   throws BuildException
    +
    +
    load Ant properties from the source file or resource +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +addFilterChain

    +
    +public final void addFilterChain(FilterChain filter)
    +
    +
    Adds a FilterChain. +

    +

    +
    Parameters:
    filter - the filter to add
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source resource. +

    +

    +
    Parameters:
    a - the resource to load as a single element Resource collection.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadResource.html new file mode 100644 index 000000000..2da51e835 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LoadResource.html @@ -0,0 +1,451 @@ + + + + + + +LoadResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class LoadResource

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.LoadResource
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    LoadFile
    +
    +
    +
    +
    public class LoadResource
    extends Task
    + + +

    +Load a resource into a property +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    LoadResource() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source resource.
    + voidaddFilterChain(FilterChain filter) + +
    +          Add the FilterChain element.
    + voidexecute() + +
    +          read in a source file to a property
    + voidsetEncoding(java.lang.String encoding) + +
    +          Encoding to use for input, defaults to the platform's default + encoding.
    + voidsetFailonerror(boolean fail) + +
    +          If true, fail on load error.
    + voidsetProperty(java.lang.String property) + +
    +          Property name to save to.
    + voidsetQuiet(boolean quiet) + +
    +          If true, suppress the load error report and set the + the failonerror value to false.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LoadResource

    +
    +public LoadResource()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setEncoding

    +
    +public final void setEncoding(java.lang.String encoding)
    +
    +
    Encoding to use for input, defaults to the platform's default + encoding.

    + + For a list of possible values see + + http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html + .

    +

    +

    +
    Parameters:
    encoding - The new Encoding value
    +
    +
    +
    + +

    +setProperty

    +
    +public final void setProperty(java.lang.String property)
    +
    +
    Property name to save to. +

    +

    +
    Parameters:
    property - The new Property value
    +
    +
    +
    + +

    +setFailonerror

    +
    +public final void setFailonerror(boolean fail)
    +
    +
    If true, fail on load error. +

    +

    +
    Parameters:
    fail - The new Failonerror value
    +
    +
    +
    + +

    +setQuiet

    +
    +public void setQuiet(boolean quiet)
    +
    +
    If true, suppress the load error report and set the + the failonerror value to false. +

    +

    +
    Parameters:
    quiet - The new Quiet value
    +
    +
    +
    + +

    +execute

    +
    +public final void execute()
+                   throws BuildException
    +
    +
    read in a source file to a property +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +addFilterChain

    +
    +public final void addFilterChain(FilterChain filter)
    +
    +
    Add the FilterChain element. +

    +

    +
    Parameters:
    filter - the filter to add
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source resource. +

    +

    +
    Parameters:
    a - the resource to load as a single element Resource collection.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Local.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Local.html new file mode 100644 index 000000000..c4724b7d6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Local.html @@ -0,0 +1,327 @@ + + + + + + +Local (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Local

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Local
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Local
    extends Task
    + + +

    +Task to create a local property in the current scope. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Local() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Run the task.
    + voidsetName(java.lang.String name) + +
    +          Set the name attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Local

    +
    +public Local()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name attribute. +

    +

    +
    Parameters:
    name - the name of the local property.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Run the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogOutputStream.html new file mode 100644 index 000000000..07f25250f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogOutputStream.html @@ -0,0 +1,405 @@ + + + + + + +LogOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class LogOutputStream

    +
    +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.util.LineOrientedOutputStream
+          extended by org.apache.tools.ant.taskdefs.LogOutputStream
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable
    +
    +
    +
    Direct Known Subclasses:
    JUnitTask.JUnitLogOutputStream
    +
    +
    +
    +
    public class LogOutputStream
    extends LineOrientedOutputStream
    + + +

    +Logs each line written to this stream to the log system of ant. + + Tries to be smart about line separators.
    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    LogOutputStream(ProjectComponent pc) + +
    +          Create a new LogOutputStream for the specified ProjectComponent.
    LogOutputStream(ProjectComponent pc, + int level) + +
    +          Creates a new instance of this class.
    LogOutputStream(Task task, + int level) + +
    +          Creates a new instance of this class.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetMessageLevel() + +
    +          Get the level.
    +protected  voidprocessBuffer() + +
    +          Converts the buffer to a string and sends it to processLine
    +protected  voidprocessLine(java.lang.String line) + +
    +          Logs a line to the log system of ant.
    +protected  voidprocessLine(java.lang.String line, + int level) + +
    +          Logs a line to the log system of ant.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.LineOrientedOutputStream
    close, flush, write, write
    +  + + + + + + + +
    Methods inherited from class java.io.OutputStream
    write
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LogOutputStream

    +
    +public LogOutputStream(ProjectComponent pc)
    +
    +
    Create a new LogOutputStream for the specified ProjectComponent. +

    +

    +
    Parameters:
    pc - the project component for whom to log
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    + +

    +LogOutputStream

    +
    +public LogOutputStream(Task task,
+                       int level)
    +
    +
    Creates a new instance of this class. +

    +

    +
    Parameters:
    task - the task for whom to log
    level - loglevel used to log data written to this stream.
    +
    +
    + +

    +LogOutputStream

    +
    +public LogOutputStream(ProjectComponent pc,
+                       int level)
    +
    +
    Creates a new instance of this class. +

    +

    +
    Parameters:
    pc - the project component for whom to log
    level - loglevel used to log data written to this stream.
    Since:
    +
    Ant 1.6.3
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +processBuffer

    +
    +protected void processBuffer()
    +
    +
    Converts the buffer to a string and sends it to processLine +

    +

    +
    Overrides:
    processBuffer in class LineOrientedOutputStream
    +
    +
    +
    +
    +
    +
    + +

    +processLine

    +
    +protected void processLine(java.lang.String line)
    +
    +
    Logs a line to the log system of ant. +

    +

    +
    Specified by:
    processLine in class LineOrientedOutputStream
    +
    +
    +
    Parameters:
    line - the line to log.
    +
    +
    +
    + +

    +processLine

    +
    +protected void processLine(java.lang.String line,
+                           int level)
    +
    +
    Logs a line to the log system of ant. +

    +

    +
    Parameters:
    line - the line to log.
    level - the logging level to use.
    +
    +
    +
    + +

    +getMessageLevel

    +
    +public int getMessageLevel()
    +
    +
    Get the level. +

    +

    + +
    Returns:
    the log level.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogStreamHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogStreamHandler.html new file mode 100644 index 000000000..b733a01b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/LogStreamHandler.html @@ -0,0 +1,322 @@ + + + + + + +LogStreamHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class LogStreamHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.PumpStreamHandler
+      extended by org.apache.tools.ant.taskdefs.LogStreamHandler
+
    +
    +
    All Implemented Interfaces:
    ExecuteStreamHandler
    +
    +
    +
    +
    public class LogStreamHandler
    extends PumpStreamHandler
    + + +

    +Logs standard output and error of a subprocess to the log system of ant. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.PumpStreamHandler
    PumpStreamHandler.ThreadWithPumper
    +  + + + + + + + + + + + + + + +
    +Constructor Summary
    LogStreamHandler(ProjectComponent pc, + int outlevel, + int errlevel) + +
    +          Creates log stream handler
    LogStreamHandler(Task task, + int outlevel, + int errlevel) + +
    +          Creates log stream handler
    +  + + + + + + + + + + + +
    +Method Summary
    + voidstop() + +
    +          Stop the log stream handler.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.PumpStreamHandler
    createProcessErrorPump, createProcessOutputPump, createPump, createPump, createPump, finish, getErr, getOut, setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +LogStreamHandler

    +
    +public LogStreamHandler(Task task,
+                        int outlevel,
+                        int errlevel)
    +
    +
    Creates log stream handler +

    +

    +
    Parameters:
    task - the task for whom to log
    outlevel - the loglevel used to log standard output
    errlevel - the loglevel used to log standard error
    +
    +
    + +

    +LogStreamHandler

    +
    +public LogStreamHandler(ProjectComponent pc,
+                        int outlevel,
+                        int errlevel)
    +
    +
    Creates log stream handler +

    +

    +
    Parameters:
    pc - the project component for whom to log
    outlevel - the loglevel used to log standard output
    errlevel - the loglevel used to log standard error
    +
    + + + + + + + + +
    +Method Detail
    + +

    +stop

    +
    +public void stop()
    +
    +
    Stop the log stream handler. +

    +

    +
    Specified by:
    stop in interface ExecuteStreamHandler
    Overrides:
    stop in class PumpStreamHandler
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Attribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Attribute.html new file mode 100644 index 000000000..7264f8414 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Attribute.html @@ -0,0 +1,411 @@ + + + + + + +MacroDef.Attribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroDef.Attribute

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.MacroDef.Attribute
+
    +
    +
    Enclosing class:
    MacroDef
    +
    +
    +
    +
    public static class MacroDef.Attribute
    extends java.lang.Object
    + + +

    +An attribute for the MacroDef task. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MacroDef.Attribute() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object obj) + +
    +          equality method
    + java.lang.StringgetDefault() + +
    +           
    + java.lang.StringgetDescription() + +
    +           
    + java.lang.StringgetName() + +
    +           
    + inthashCode() + +
    +           
    + voidsetDefault(java.lang.String defaultValue) + +
    +          The default value to use if the parameter is not + used in the templated instance.
    + voidsetDescription(java.lang.String desc) + +
    +           
    + voidsetName(java.lang.String name) + +
    +          The name of the attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroDef.Attribute

    +
    +public MacroDef.Attribute()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    The name of the attribute. +

    +

    +
    Parameters:
    name - the name of the attribute
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    + +
    Returns:
    the name of the attribute
    +
    +
    +
    + +

    +setDefault

    +
    +public void setDefault(java.lang.String defaultValue)
    +
    +
    The default value to use if the parameter is not + used in the templated instance. +

    +

    +
    Parameters:
    defaultValue - the default value
    +
    +
    +
    + +

    +getDefault

    +
    +public java.lang.String getDefault()
    +
    +
    + +
    Returns:
    the default value, null if not set
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String desc)
    +
    +
    +
    Parameters:
    desc - Description of the element.
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    + +
    Returns:
    the description of the element, or null if + no description is available.
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object obj)
    +
    +
    equality method +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    obj - an Object value +
    Returns:
    a boolean value
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hash code value for this object.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.NestedSequential.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.NestedSequential.html new file mode 100644 index 000000000..5967025d5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.NestedSequential.html @@ -0,0 +1,314 @@ + + + + + + +MacroDef.NestedSequential (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroDef.NestedSequential

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.MacroDef.NestedSequential
+
    +
    +
    All Implemented Interfaces:
    TaskContainer
    +
    +
    +
    Enclosing class:
    MacroDef
    +
    +
    +
    +
    public static class MacroDef.NestedSequential
    extends java.lang.Object
    implements TaskContainer
    + + +

    +The class corresponding to the sequential nested element. + This is a simple task container. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MacroDef.NestedSequential() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task task) + +
    +          Add a task or type to the container.
    + java.util.ListgetNested() + +
    +           
    + booleansimilar(MacroDef.NestedSequential other) + +
    +          A compare function to compare this with another + NestedSequential.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroDef.NestedSequential

    +
    +public MacroDef.NestedSequential()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public void addTask(Task task)
    +
    +
    Add a task or type to the container. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    task - an unknown element.
    +
    +
    +
    + +

    +getNested

    +
    +public java.util.List getNested()
    +
    +
    +
    +
    +
    + +
    Returns:
    the list of unknown elements
    +
    +
    +
    + +

    +similar

    +
    +public boolean similar(MacroDef.NestedSequential other)
    +
    +
    A compare function to compare this with another + NestedSequential. + It calls similar on the nested unknown elements. +

    +

    +
    +
    +
    +
    Parameters:
    other - the nested sequential to compare with. +
    Returns:
    true if they are similar, false otherwise
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.TemplateElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.TemplateElement.html new file mode 100644 index 000000000..a9a216d3d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.TemplateElement.html @@ -0,0 +1,464 @@ + + + + + + +MacroDef.TemplateElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroDef.TemplateElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.MacroDef.TemplateElement
+
    +
    +
    Enclosing class:
    MacroDef
    +
    +
    +
    +
    public static class MacroDef.TemplateElement
    extends java.lang.Object
    + + +

    +A nested element for the MacroDef task. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MacroDef.TemplateElement() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object obj) + +
    +          equality method.
    + java.lang.StringgetDescription() + +
    +          Gets the description of this element.
    + java.lang.StringgetName() + +
    +          Gets the name of this element.
    + inthashCode() + +
    +           
    + booleanisImplicit() + +
    +          Gets whether this element is implicit.
    + booleanisOptional() + +
    +          Gets whether this element is optional.
    + voidsetDescription(java.lang.String desc) + +
    +          Sets a textual description of this element, + for build documentation purposes only.
    + voidsetImplicit(boolean implicit) + +
    +          Sets whether this element is implicit.
    + voidsetName(java.lang.String name) + +
    +          Sets the name of this element.
    + voidsetOptional(boolean optional) + +
    +          Sets whether this element is optional.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroDef.TemplateElement

    +
    +public MacroDef.TemplateElement()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Sets the name of this element. +

    +

    +
    Parameters:
    name - the name of the element
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Gets the name of this element. +

    +

    + +
    Returns:
    the name of the element.
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String desc)
    +
    +
    Sets a textual description of this element, + for build documentation purposes only. +

    +

    +
    Parameters:
    desc - Description of the element.
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    Gets the description of this element. +

    +

    + +
    Returns:
    the description of the element, or null if + no description is available.
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +setOptional

    +
    +public void setOptional(boolean optional)
    +
    +
    Sets whether this element is optional. +

    +

    +
    Parameters:
    optional - if true this element may be left out, default + is false.
    +
    +
    +
    + +

    +isOptional

    +
    +public boolean isOptional()
    +
    +
    Gets whether this element is optional. +

    +

    + +
    Returns:
    the optional attribute
    +
    +
    +
    + +

    +setImplicit

    +
    +public void setImplicit(boolean implicit)
    +
    +
    Sets whether this element is implicit. +

    +

    +
    Parameters:
    implicit - if true this element may be left out, default + is false.
    +
    +
    +
    + +

    +isImplicit

    +
    +public boolean isImplicit()
    +
    +
    Gets whether this element is implicit. +

    +

    + +
    Returns:
    the implicit attribute
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object obj)
    +
    +
    equality method. +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    obj - an Object value +
    Returns:
    a boolean value
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hash code value for this object.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Text.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Text.html new file mode 100644 index 000000000..d60b2974d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.Text.html @@ -0,0 +1,490 @@ + + + + + + +MacroDef.Text (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroDef.Text

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.MacroDef.Text
+
    +
    +
    Enclosing class:
    MacroDef
    +
    +
    +
    +
    public static class MacroDef.Text
    extends java.lang.Object
    + + +

    +A nested text element for the MacroDef task. +

    + +

    +

    +
    Since:
    +
    ant 1.6.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MacroDef.Text() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanequals(java.lang.Object obj) + +
    +          equality method
    + java.lang.StringgetDefault() + +
    +           
    + java.lang.StringgetDescription() + +
    +           
    + java.lang.StringgetName() + +
    +           
    + booleangetOptional() + +
    +           
    + booleangetTrim() + +
    +           
    + inthashCode() + +
    +           
    + voidsetDefault(java.lang.String defaultString) + +
    +           
    + voidsetDescription(java.lang.String desc) + +
    +           
    + voidsetName(java.lang.String name) + +
    +          The name of the attribute.
    + voidsetOptional(boolean optional) + +
    +          The optional attribute of the text element.
    + voidsetTrim(boolean trim) + +
    +          The trim attribute of the text element.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroDef.Text

    +
    +public MacroDef.Text()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    The name of the attribute. +

    +

    +
    Parameters:
    name - the name of the attribute
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    + +
    Returns:
    the name of the attribute
    +
    +
    +
    + +

    +setOptional

    +
    +public void setOptional(boolean optional)
    +
    +
    The optional attribute of the text element. +

    +

    +
    Parameters:
    optional - if true this is optional
    +
    +
    +
    + +

    +getOptional

    +
    +public boolean getOptional()
    +
    +
    + +
    Returns:
    true if the text is optional
    +
    +
    +
    + +

    +setTrim

    +
    +public void setTrim(boolean trim)
    +
    +
    The trim attribute of the text element. +

    +

    +
    Parameters:
    trim - if true this String.trim() is called on + the contents of the text element.
    +
    +
    +
    + +

    +getTrim

    +
    +public boolean getTrim()
    +
    +
    + +
    Returns:
    true if the text is trim
    +
    +
    +
    + +

    +setDescription

    +
    +public void setDescription(java.lang.String desc)
    +
    +
    +
    Parameters:
    desc - Description of the text.
    +
    +
    +
    + +

    +getDescription

    +
    +public java.lang.String getDescription()
    +
    +
    + +
    Returns:
    the description of the text, or null if + no description is available.
    +
    +
    +
    + +

    +setDefault

    +
    +public void setDefault(java.lang.String defaultString)
    +
    +
    +
    Parameters:
    defaultString - default text for the string.
    +
    +
    +
    + +

    +getDefault

    +
    +public java.lang.String getDefault()
    +
    +
    + +
    Returns:
    the default text if set, null otherwise.
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object obj)
    +
    +
    equality method +

    +

    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    obj - an Object value +
    Returns:
    a boolean value
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hash code value for this object.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.html new file mode 100644 index 000000000..10d08d774 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroDef.html @@ -0,0 +1,676 @@ + + + + + + +MacroDef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroDef

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.MacroDef
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class MacroDef
    extends AntlibDefinition
    + + +

    +Describe class MacroDef here. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classMacroDef.Attribute + +
    +          An attribute for the MacroDef task.
    +static classMacroDef.NestedSequential + +
    +          The class corresponding to the sequential nested element.
    +static classMacroDef.TemplateElement + +
    +          A nested element for the MacroDef task.
    +static classMacroDef.Text + +
    +          A nested text element for the MacroDef task.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    MacroDef() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredAttribute(MacroDef.Attribute attribute) + +
    +          Add an attribute element.
    + voidaddConfiguredElement(MacroDef.TemplateElement element) + +
    +          Add an element element.
    + voidaddConfiguredText(MacroDef.Text text) + +
    +          Add the text element.
    + MacroDef.NestedSequentialcreateSequential() + +
    +          This is the sequential nested element of the macrodef.
    + voidexecute() + +
    +          Create a new ant type based on the embedded tasks and types.
    + java.util.ListgetAttributes() + +
    +          Gets this macro's attribute (and define?) list.
    + booleangetBackTrace() + +
    +           
    + java.util.MapgetElements() + +
    +          Gets this macro's elements.
    + UnknownElementgetNestedTask() + +
    +          Convert the nested sequential to an unknown element
    + MacroDef.TextgetText() + +
    +           
    +static booleanisValidNameCharacter(char c) + +
    +          Check if a character is a valid character for an element or + attribute name.
    + booleansameDefinition(java.lang.Object obj) + +
    +          Equality method for this definition
    + voidsetBackTrace(boolean backTrace) + +
    +          Set the backTrace attribute.
    + voidsetName(java.lang.String name) + +
    +          Name of the definition
    + booleansimilar(java.lang.Object obj) + +
    +          Similar method for this definition
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroDef

    +
    +public MacroDef()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Name of the definition +

    +

    +
    Parameters:
    name - the name of the definition
    +
    +
    +
    + +

    +addConfiguredText

    +
    +public void addConfiguredText(MacroDef.Text text)
    +
    +
    Add the text element. +

    +

    +
    Parameters:
    text - the nested text element to add
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +getText

    +
    +public MacroDef.Text getText()
    +
    +
    + +
    Returns:
    the nested text element
    Since:
    +
    ant 1.6.1
    +
    +
    +
    +
    + +

    +setBackTrace

    +
    +public void setBackTrace(boolean backTrace)
    +
    +
    Set the backTrace attribute. +

    +

    +
    Parameters:
    backTrace - if true and the macro instance generates + an error, a backtrace of the location within + the macro and call to the macro will be output. + if false, only the location of the call to the + macro will be shown. Default is true.
    Since:
    +
    ant 1.7
    +
    +
    +
    +
    + +

    +getBackTrace

    +
    +public boolean getBackTrace()
    +
    +
    + +
    Returns:
    the backTrace attribute.
    Since:
    +
    ant 1.7
    +
    +
    +
    +
    + +

    +createSequential

    +
    +public MacroDef.NestedSequential createSequential()
    +
    +
    This is the sequential nested element of the macrodef. +

    +

    + +
    Returns:
    a sequential element to be configured.
    +
    +
    +
    + +

    +getNestedTask

    +
    +public UnknownElement getNestedTask()
    +
    +
    Convert the nested sequential to an unknown element +

    +

    + +
    Returns:
    the nested sequential as an unknown element.
    +
    +
    +
    + +

    +getAttributes

    +
    +public java.util.List getAttributes()
    +
    +
    Gets this macro's attribute (and define?) list. +

    +

    + +
    Returns:
    the nested Attributes
    +
    +
    +
    + +

    +getElements

    +
    +public java.util.Map getElements()
    +
    +
    Gets this macro's elements. +

    +

    + +
    Returns:
    the map nested elements, keyed by element name, with + MacroDef.TemplateElement values.
    +
    +
    +
    + +

    +isValidNameCharacter

    +
    +public static boolean isValidNameCharacter(char c)
    +
    +
    Check if a character is a valid character for an element or + attribute name. +

    +

    +
    Parameters:
    c - the character to check +
    Returns:
    true if the character is a letter or digit or '.' or '-' + attribute name
    +
    +
    +
    + +

    +addConfiguredAttribute

    +
    +public void addConfiguredAttribute(MacroDef.Attribute attribute)
    +
    +
    Add an attribute element. +

    +

    +
    Parameters:
    attribute - an attribute nested element.
    +
    +
    +
    + +

    +addConfiguredElement

    +
    +public void addConfiguredElement(MacroDef.TemplateElement element)
    +
    +
    Add an element element. +

    +

    +
    Parameters:
    element - an element nested element.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Create a new ant type based on the embedded tasks and types. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +similar

    +
    +public boolean similar(java.lang.Object obj)
    +
    +
    Similar method for this definition +

    +

    +
    Parameters:
    obj - another definition +
    Returns:
    true if the definitions are similar
    +
    +
    +
    + +

    +sameDefinition

    +
    +public boolean sameDefinition(java.lang.Object obj)
    +
    +
    Equality method for this definition +

    +

    +
    Parameters:
    obj - another definition +
    Returns:
    true if the definitions are the same
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.Element.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.Element.html new file mode 100644 index 000000000..aed0dad4d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.Element.html @@ -0,0 +1,285 @@ + + + + + + +MacroInstance.Element (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroInstance.Element

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.MacroInstance.Element
+
    +
    +
    All Implemented Interfaces:
    TaskContainer
    +
    +
    +
    Enclosing class:
    MacroInstance
    +
    +
    +
    +
    public static class MacroInstance.Element
    extends java.lang.Object
    implements TaskContainer
    + + +

    +Embedded element in macro instance +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    MacroInstance.Element() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          Add an unknown element (to be snipped into the macroDef instance)
    + java.util.ListgetUnknownElements() + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroInstance.Element

    +
    +public MacroInstance.Element()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add an unknown element (to be snipped into the macroDef instance) +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - an unknown element
    +
    +
    +
    + +

    +getUnknownElements

    +
    +public java.util.List getUnknownElements()
    +
    +
    +
    +
    +
    + +
    Returns:
    the list of unknown elements
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.html new file mode 100644 index 000000000..06b26d482 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MacroInstance.html @@ -0,0 +1,483 @@ + + + + + + +MacroInstance (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MacroInstance

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MacroInstance
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, DynamicAttribute, TaskContainer
    +
    +
    +
    +
    public class MacroInstance
    extends Task
    implements DynamicAttribute, TaskContainer
    + + +

    +The class to be placed in the ant type definition. + It is given a pointer to the template definition, + and makes a copy of the unknown element, substituting + the parameter values in attributes and text. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classMacroInstance.Element + +
    +          Embedded element in macro instance
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    MacroInstance() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          Add a unknownElement for the macro instances nested elements.
    + voidaddText(java.lang.String text) + +
    +          Set the text contents for the macro.
    + java.lang.ObjectcreateDynamicElement(java.lang.String name) + +
    +          Deprecated. since 1.6.x.
    + voidexecute() + +
    +          Execute the templates instance.
    + MacroDefgetMacroDef() + +
    +           
    + voidsetDynamicAttribute(java.lang.String name, + java.lang.String value) + +
    +          A parameter name value pair as a xml attribute.
    + voidsetMacroDef(MacroDef macroDef) + +
    +          Called from MacroDef.MyAntTypeDefinition#create()
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MacroInstance

    +
    +public MacroInstance()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMacroDef

    +
    +public void setMacroDef(MacroDef macroDef)
    +
    +
    Called from MacroDef.MyAntTypeDefinition#create() +

    +

    +
    +
    +
    +
    Parameters:
    macroDef - a MacroDef value
    +
    +
    +
    + +

    +getMacroDef

    +
    +public MacroDef getMacroDef()
    +
    +
    +
    +
    +
    + +
    Returns:
    the macro definition object for this macro instance.
    +
    +
    +
    + +

    +setDynamicAttribute

    +
    +public void setDynamicAttribute(java.lang.String name,
+                                java.lang.String value)
    +
    +
    A parameter name value pair as a xml attribute. +

    +

    +
    Specified by:
    setDynamicAttribute in interface DynamicAttribute
    +
    +
    +
    Parameters:
    name - the name of the attribute
    value - the value of the attribute
    +
    +
    +
    + +

    +createDynamicElement

    +
    +public java.lang.Object createDynamicElement(java.lang.String name)
+                                      throws BuildException
    +
    +
    Deprecated. since 1.6.x. +

    +

    Method present for BC purposes. +

    +

    +
    +
    +
    +
    Parameters:
    name - not used +
    Returns:
    nothing +
    Throws: +
    BuildException - always
    +
    +
    +
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add a unknownElement for the macro instances nested elements. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - a nested element.
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String text)
    +
    +
    Set the text contents for the macro. +

    +

    +
    +
    +
    +
    Parameters:
    text - the text to be added to the macro.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute the templates instance. + Copies the unknown element, substitutes the attributes, + and calls perform on the unknown element. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MakeUrl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MakeUrl.html new file mode 100644 index 000000000..ea08b1c05 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MakeUrl.html @@ -0,0 +1,512 @@ + + + + + + +MakeUrl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MakeUrl

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MakeUrl
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class MakeUrl
    extends Task
    + + +

    +This task takes file and turns them into a URL, which it then assigns + to a property. Use when for setting up RMI codebases. +

    + nested filesets are supported; if present, these are turned into the + url with the given separator between them (default = " "). +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_MISSING_FILE + +
    +          Missing file
    +static java.lang.StringERROR_NO_FILES + +
    +          No files defined
    +static java.lang.StringERROR_NO_PROPERTY + +
    +          No property defined
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    MakeUrl() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddFileSet(FileSet fileset) + +
    +          a fileset of jar files to include in the URL, each + separated by the separator
    + voidaddPath(Path path) + +
    +          add a path to the URL.
    + voidexecute() + +
    +          Create the url
    + voidsetFile(java.io.File file) + +
    +          the name of a file to be converted into a URL
    + voidsetProperty(java.lang.String property) + +
    +          set the name of a property to fill with the URL
    + voidsetSeparator(java.lang.String separator) + +
    +          set the separator for the multi-url option.
    + voidsetValidate(boolean validate) + +
    +          set this flag to trigger validation that every named file exists.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_MISSING_FILE

    +
    +public static final java.lang.String ERROR_MISSING_FILE
    +
    +
    Missing file +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_PROPERTY

    +
    +public static final java.lang.String ERROR_NO_PROPERTY
    +
    +
    No property defined +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_FILES

    +
    +public static final java.lang.String ERROR_NO_FILES
    +
    +
    No files defined +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +MakeUrl

    +
    +public MakeUrl()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    set the name of a property to fill with the URL +

    +

    +
    Parameters:
    property - the name of the property.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    the name of a file to be converted into a URL +

    +

    +
    Parameters:
    file - the file to be converted.
    +
    +
    +
    + +

    +addFileSet

    +
    +public void addFileSet(FileSet fileset)
    +
    +
    a fileset of jar files to include in the URL, each + separated by the separator +

    +

    +
    Parameters:
    fileset - the fileset to be added.
    +
    +
    +
    + +

    +setSeparator

    +
    +public void setSeparator(java.lang.String separator)
    +
    +
    set the separator for the multi-url option. +

    +

    +
    Parameters:
    separator - the separator to use.
    +
    +
    +
    + +

    +setValidate

    +
    +public void setValidate(boolean validate)
    +
    +
    set this flag to trigger validation that every named file exists. + Optional: default=true +

    +

    +
    Parameters:
    validate - a boolean value.
    +
    +
    +
    + +

    +addPath

    +
    +public void addPath(Path path)
    +
    +
    add a path to the URL. All elements in the path + will be converted to individual URL entries +

    +

    +
    Parameters:
    path - a path value.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Create the url +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Attribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Attribute.html new file mode 100644 index 000000000..8262b5940 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Attribute.html @@ -0,0 +1,582 @@ + + + + + + +Manifest.Attribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Manifest.Attribute

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Manifest.Attribute
+
    +
    +
    Enclosing class:
    Manifest
    +
    +
    +
    +
    public static class Manifest.Attribute
    extends java.lang.Object
    + + +

    +An attribute for the manifest. + Those attributes that are not nested into a section will be added to the "Main" section. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    Manifest.Attribute() + +
    +          Construct an empty attribute
    Manifest.Attribute(java.lang.String line) + +
    +          Construct an attribute by parsing a line from the Manifest
    Manifest.Attribute(java.lang.String name, + java.lang.String value) + +
    +          Construct a manifest by specifying its name and value
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddContinuation(java.lang.String line) + +
    +          Add a continuation line from the Manifest file.
    + voidaddValue(java.lang.String value) + +
    +          Add a new value to this attribute - making it multivalued.
    + booleanequals(java.lang.Object rhs) + +
    +           
    + java.lang.StringgetKey() + +
    +          Get the attribute's Key - its name in lower case.
    + java.lang.StringgetName() + +
    +          Get the Attribute's name
    + java.lang.StringgetValue() + +
    +          Get the Attribute's value.
    + java.util.EnumerationgetValues() + +
    +          Get all the attribute's values.
    + inthashCode() + +
    +           
    + voidparse(java.lang.String line) + +
    +          Parse a line into name and value pairs
    + voidsetName(java.lang.String name) + +
    +          Set the Attribute's name; required
    + voidsetValue(java.lang.String value) + +
    +          Set the Attribute's value; required
    + voidwrite(java.io.PrintWriter writer) + +
    +          Write the attribute out to a print writer without + flattening multi-values attributes (i.e.
    + voidwrite(java.io.PrintWriter writer, + boolean flatten) + +
    +          Write the attribute out to a print writer.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Manifest.Attribute

    +
    +public Manifest.Attribute()
    +
    +
    Construct an empty attribute +

    +

    +
    + +

    +Manifest.Attribute

    +
    +public Manifest.Attribute(java.lang.String line)
+                   throws ManifestException
    +
    +
    Construct an attribute by parsing a line from the Manifest +

    +

    +
    Parameters:
    line - the line containing the attribute name and value +
    Throws: +
    ManifestException - if the line is not valid
    +
    +
    + +

    +Manifest.Attribute

    +
    +public Manifest.Attribute(java.lang.String name,
+                          java.lang.String value)
    +
    +
    Construct a manifest by specifying its name and value +

    +

    +
    Parameters:
    name - the attribute's name
    value - the Attribute's value
    +
    + + + + + + + + +
    +Method Detail
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hashcode based on the key and values.
    See Also:
    Object.hashCode()
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object rhs)
    +
    +
    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    rhs - the object to check for equality. +
    Returns:
    true if the key and values are the same.
    See Also:
    Object.equals(java.lang.Object)
    +
    +
    +
    + +

    +parse

    +
    +public void parse(java.lang.String line)
+           throws ManifestException
    +
    +
    Parse a line into name and value pairs +

    +

    +
    Parameters:
    line - the line to be parsed +
    Throws: +
    ManifestException - if the line does not contain a colon + separating the name and value
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the Attribute's name; required +

    +

    +
    Parameters:
    name - the attribute's name
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the Attribute's name +

    +

    + +
    Returns:
    the attribute's name.
    +
    +
    +
    + +

    +getKey

    +
    +public java.lang.String getKey()
    +
    +
    Get the attribute's Key - its name in lower case. +

    +

    + +
    Returns:
    the attribute's key.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the Attribute's value; required +

    +

    +
    Parameters:
    value - the attribute's value
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the Attribute's value. +

    +

    + +
    Returns:
    the attribute's value.
    +
    +
    +
    + +

    +addValue

    +
    +public void addValue(java.lang.String value)
    +
    +
    Add a new value to this attribute - making it multivalued. +

    +

    +
    Parameters:
    value - the attribute's additional value
    +
    +
    +
    + +

    +getValues

    +
    +public java.util.Enumeration getValues()
    +
    +
    Get all the attribute's values. +

    +

    + +
    Returns:
    an enumeration of the attributes values
    +
    +
    +
    + +

    +addContinuation

    +
    +public void addContinuation(java.lang.String line)
    +
    +
    Add a continuation line from the Manifest file. + + When lines are too long in a manifest, they are continued on the + next line by starting with a space. This method adds the continuation + data to the attribute value by skipping the first character. +

    +

    +
    Parameters:
    line - the continuation line.
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer)
+           throws java.io.IOException
    +
    +
    Write the attribute out to a print writer without + flattening multi-values attributes (i.e. Class-Path). +

    +

    +
    Parameters:
    writer - the Writer to which the attribute is written +
    Throws: +
    java.io.IOException - if the attribute value cannot be written
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer,
+                  boolean flatten)
+           throws java.io.IOException
    +
    +
    Write the attribute out to a print writer. +

    +

    +
    Parameters:
    writer - the Writer to which the attribute is written
    flatten - whether to collapse multi-valued attributes + (i.e. potentially Class-Path) Class-Path into a + single attribute. +
    Throws: +
    java.io.IOException - if the attribute value cannot be written
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Section.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Section.html new file mode 100644 index 000000000..ccaa61407 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.Section.html @@ -0,0 +1,654 @@ + + + + + + +Manifest.Section (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Manifest.Section

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Manifest.Section
+
    +
    +
    Enclosing class:
    Manifest
    +
    +
    +
    +
    public static class Manifest.Section
    extends java.lang.Object
    + + +

    +A manifest section - you can nest attribute elements into sections. + A section consists of a set of attribute values, + separated from other sections by a blank line. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Manifest.Section() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringaddAttributeAndCheck(Manifest.Attribute attribute) + +
    +          Add an attribute to the section
    + voidaddConfiguredAttribute(Manifest.Attribute attribute) + +
    +          Add an attribute to the section.
    + java.lang.Objectclone() + +
    +          Clone this section
    + booleanequals(java.lang.Object rhs) + +
    +           
    + Manifest.AttributegetAttribute(java.lang.String attributeName) + +
    +          Get a attribute of the section
    + java.util.EnumerationgetAttributeKeys() + +
    +          Get the attribute keys.
    + java.lang.StringgetAttributeValue(java.lang.String attributeName) + +
    +          Get the value of the attribute with the name given.
    + java.lang.StringgetName() + +
    +          Get the Section's name.
    + java.util.EnumerationgetWarnings() + +
    +          Get the warnings for this section.
    + inthashCode() + +
    +           
    + voidmerge(Manifest.Section section) + +
    +          Merge in another section without merging Class-Path attributes.
    + voidmerge(Manifest.Section section, + boolean mergeClassPaths) + +
    +          Merge in another section
    + java.lang.Stringread(java.io.BufferedReader reader) + +
    +          Read a section through a reader.
    + voidremoveAttribute(java.lang.String attributeName) + +
    +          Remove the given attribute from the section
    + voidsetName(java.lang.String name) + +
    +          The name of the section; optional -default is the main section.
    + voidwrite(java.io.PrintWriter writer) + +
    +          Write the section out to a print writer without flattening + multi-values attributes (i.e.
    + voidwrite(java.io.PrintWriter writer, + boolean flatten) + +
    +          Write the section out to a print writer.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Manifest.Section

    +
    +public Manifest.Section()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    The name of the section; optional -default is the main section. +

    +

    +
    Parameters:
    name - the section's name
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the Section's name. +

    +

    + +
    Returns:
    the section's name.
    +
    +
    +
    + +

    +read

    +
    +public java.lang.String read(java.io.BufferedReader reader)
+                      throws ManifestException,
+                             java.io.IOException
    +
    +
    Read a section through a reader. +

    +

    +
    Parameters:
    reader - the reader from which the section is read +
    Returns:
    the name of the next section if it has been read as + part of this section - This only happens if the + Manifest is malformed. +
    Throws: +
    ManifestException - if the section is not valid according + to the JAR spec +
    java.io.IOException - if the section cannot be read from the reader.
    +
    +
    +
    + +

    +merge

    +
    +public void merge(Manifest.Section section)
+           throws ManifestException
    +
    +
    Merge in another section without merging Class-Path attributes. +

    +

    +
    Parameters:
    section - the section to be merged with this one. +
    Throws: +
    ManifestException - if the sections cannot be merged.
    +
    +
    +
    + +

    +merge

    +
    +public void merge(Manifest.Section section,
+                  boolean mergeClassPaths)
+           throws ManifestException
    +
    +
    Merge in another section +

    +

    +
    Parameters:
    section - the section to be merged with this one.
    mergeClassPaths - whether Class-Path attributes should + be merged. +
    Throws: +
    ManifestException - if the sections cannot be merged.
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer)
+           throws java.io.IOException
    +
    +
    Write the section out to a print writer without flattening + multi-values attributes (i.e. Class-Path). +

    +

    +
    Parameters:
    writer - the Writer to which the section is written +
    Throws: +
    java.io.IOException - if the section cannot be written
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer,
+                  boolean flatten)
+           throws java.io.IOException
    +
    +
    Write the section out to a print writer. +

    +

    +
    Parameters:
    writer - the Writer to which the section is written
    flatten - whether to collapse multi-valued attributes + (i.e. potentially Class-Path) Class-Path into a + single attribute. +
    Throws: +
    java.io.IOException - if the section cannot be written
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getAttribute

    +
    +public Manifest.Attribute getAttribute(java.lang.String attributeName)
    +
    +
    Get a attribute of the section +

    +

    +
    Parameters:
    attributeName - the name of the attribute +
    Returns:
    a Manifest.Attribute instance if the attribute is + single-valued, otherwise a Vector of Manifest.Attribute + instances.
    +
    +
    +
    + +

    +getAttributeKeys

    +
    +public java.util.Enumeration getAttributeKeys()
    +
    +
    Get the attribute keys. +

    +

    + +
    Returns:
    an Enumeration of Strings, each string being the lower case + key of an attribute of the section.
    +
    +
    +
    + +

    +getAttributeValue

    +
    +public java.lang.String getAttributeValue(java.lang.String attributeName)
    +
    +
    Get the value of the attribute with the name given. +

    +

    +
    Parameters:
    attributeName - the name of the attribute to be returned. +
    Returns:
    the attribute's value or null if the attribute does not exist + in the section
    +
    +
    +
    + +

    +removeAttribute

    +
    +public void removeAttribute(java.lang.String attributeName)
    +
    +
    Remove the given attribute from the section +

    +

    +
    Parameters:
    attributeName - the name of the attribute to be removed.
    +
    +
    +
    + +

    +addConfiguredAttribute

    +
    +public void addConfiguredAttribute(Manifest.Attribute attribute)
+                            throws ManifestException
    +
    +
    Add an attribute to the section. +

    +

    +
    Parameters:
    attribute - the attribute to be added to the section +
    Throws: +
    ManifestException - if the attribute is not valid.
    +
    +
    +
    + +

    +addAttributeAndCheck

    +
    +public java.lang.String addAttributeAndCheck(Manifest.Attribute attribute)
+                                      throws ManifestException
    +
    +
    Add an attribute to the section +

    +

    +
    Parameters:
    attribute - the attribute to be added. +
    Returns:
    the value of the attribute if it is a name + attribute - null other wise +
    Throws: +
    ManifestException - if the attribute already + exists in this section.
    +
    +
    +
    + +

    +clone

    +
    +public java.lang.Object clone()
    +
    +
    Clone this section +

    +

    +
    Overrides:
    clone in class java.lang.Object
    +
    +
    + +
    Returns:
    the cloned Section
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +getWarnings

    +
    +public java.util.Enumeration getWarnings()
    +
    +
    Get the warnings for this section. +

    +

    + +
    Returns:
    an Enumeration of warning strings.
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hash value based on the attributes.
    See Also:
    Object.hashCode()
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object rhs)
    +
    +
    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    rhs - the object to check for equality. +
    Returns:
    true if the attributes are the same.
    See Also:
    Object.equals(java.lang.Object)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.html new file mode 100644 index 000000000..2f55e617b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Manifest.html @@ -0,0 +1,939 @@ + + + + + + +Manifest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Manifest

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Manifest
+
    +
    +
    +
    public class Manifest
    extends java.lang.Object
    + + +

    +Holds the data of a jar manifest. + + Manifests are processed according to the + Jar + file specification.. + Specifically, a manifest element consists of + a set of attributes and sections. These sections in turn may contain + attributes. Note in particular that this may result in manifest lines + greater than 72 bytes being wrapped and continued on the next + line. If an application can not handle the continuation mechanism, it + is a defect in the application, not this task. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classManifest.Attribute + +
    +          An attribute for the manifest.
    +static classManifest.Section + +
    +          A manifest section - you can nest attribute elements into sections.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringATTRIBUTE_CLASSPATH + +
    +          The Class-Path Header is special - it can be duplicated
    +static java.lang.StringATTRIBUTE_FROM + +
    +          The From Header is disallowed in a Manifest
    +static java.lang.StringATTRIBUTE_MANIFEST_VERSION + +
    +          The standard manifest version header
    +static java.lang.StringATTRIBUTE_NAME + +
    +          The Name Attribute is the first in a named section
    +static java.lang.StringATTRIBUTE_SIGNATURE_VERSION + +
    +          The standard Signature Version header
    +static java.lang.StringDEFAULT_MANIFEST_VERSION + +
    +          Default Manifest version if one is not specified
    +static java.lang.StringEOL + +
    +          The End-Of-Line marker in manifests
    +static java.lang.StringERROR_FROM_FORBIDDEN + +
    +          Error for attributes
    +static java.lang.StringJAR_ENCODING + +
    +          Encoding to be used for JAR files.
    +static intMAX_LINE_LENGTH + +
    +          The max length of a line in a Manifest
    +static intMAX_SECTION_LENGTH + +
    +          Max length of a line section which is continued.
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Manifest() + +
    +          Construct an empty manifest
    Manifest(java.io.Reader r) + +
    +          Read a manifest file from the given reader
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredAttribute(Manifest.Attribute attribute) + +
    +          Add an attribute to the manifest - it is added to the main section.
    + voidaddConfiguredSection(Manifest.Section section) + +
    +          Add a section to the manifest
    + booleanequals(java.lang.Object rhs) + +
    +           
    +static ManifestgetDefaultManifest() + +
    +          Construct a manifest from Ant's default manifest file.
    + Manifest.SectiongetMainSection() + +
    +          Get the main section of the manifest
    + java.lang.StringgetManifestVersion() + +
    +          Get the version of the manifest
    + Manifest.SectiongetSection(java.lang.String name) + +
    +          Get a particular section from the manifest
    + java.util.EnumerationgetSectionNames() + +
    +          Get the section names in this manifest.
    + java.util.EnumerationgetWarnings() + +
    +          Get the warnings for this manifest.
    + inthashCode() + +
    +           
    + voidmerge(Manifest other) + +
    +          Merge the contents of the given manifest into this manifest + without merging Class-Path attributes.
    + voidmerge(Manifest other, + boolean overwriteMain) + +
    +          Merge the contents of the given manifest into this manifest + without merging Class-Path attributes.
    + voidmerge(Manifest other, + boolean overwriteMain, + boolean mergeClassPaths) + +
    +          Merge the contents of the given manifest into this manifest
    + java.lang.StringtoString() + +
    +          Convert the manifest to its string representation
    + voidwrite(java.io.PrintWriter writer) + +
    +          Write the manifest out to a print writer without flattening + multi-values attributes (i.e.
    + voidwrite(java.io.PrintWriter writer, + boolean flatten) + +
    +          Write the manifest out to a print writer.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ATTRIBUTE_MANIFEST_VERSION

    +
    +public static final java.lang.String ATTRIBUTE_MANIFEST_VERSION
    +
    +
    The standard manifest version header +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ATTRIBUTE_SIGNATURE_VERSION

    +
    +public static final java.lang.String ATTRIBUTE_SIGNATURE_VERSION
    +
    +
    The standard Signature Version header +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ATTRIBUTE_NAME

    +
    +public static final java.lang.String ATTRIBUTE_NAME
    +
    +
    The Name Attribute is the first in a named section +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ATTRIBUTE_FROM

    +
    +public static final java.lang.String ATTRIBUTE_FROM
    +
    +
    The From Header is disallowed in a Manifest +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ATTRIBUTE_CLASSPATH

    +
    +public static final java.lang.String ATTRIBUTE_CLASSPATH
    +
    +
    The Class-Path Header is special - it can be duplicated +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DEFAULT_MANIFEST_VERSION

    +
    +public static final java.lang.String DEFAULT_MANIFEST_VERSION
    +
    +
    Default Manifest version if one is not specified +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MAX_LINE_LENGTH

    +
    +public static final int MAX_LINE_LENGTH
    +
    +
    The max length of a line in a Manifest +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MAX_SECTION_LENGTH

    +
    +public static final int MAX_SECTION_LENGTH
    +
    +
    Max length of a line section which is continued. Need to allow + for the CRLF. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +EOL

    +
    +public static final java.lang.String EOL
    +
    +
    The End-Of-Line marker in manifests +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_FROM_FORBIDDEN

    +
    +public static final java.lang.String ERROR_FROM_FORBIDDEN
    +
    +
    Error for attributes +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +JAR_ENCODING

    +
    +public static final java.lang.String JAR_ENCODING
    +
    +
    Encoding to be used for JAR files. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Manifest

    +
    +public Manifest()
    +
    +
    Construct an empty manifest +

    +

    +
    + +

    +Manifest

    +
    +public Manifest(java.io.Reader r)
+         throws ManifestException,
+                java.io.IOException
    +
    +
    Read a manifest file from the given reader +

    +

    +
    Parameters:
    r - is the reader from which the Manifest is read +
    Throws: +
    ManifestException - if the manifest is not valid according + to the JAR spec +
    java.io.IOException - if the manifest cannot be read from the reader.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getDefaultManifest

    +
    +public static Manifest getDefaultManifest()
+                                   throws BuildException
    +
    +
    Construct a manifest from Ant's default manifest file. +

    +

    + +
    Returns:
    the default manifest. +
    Throws: +
    BuildException - if there is a problem loading the + default manifest
    +
    +
    +
    + +

    +addConfiguredSection

    +
    +public void addConfiguredSection(Manifest.Section section)
+                          throws ManifestException
    +
    +
    Add a section to the manifest +

    +

    +
    Parameters:
    section - the manifest section to be added +
    Throws: +
    ManifestException - if the secti0on is not valid.
    +
    +
    +
    + +

    +addConfiguredAttribute

    +
    +public void addConfiguredAttribute(Manifest.Attribute attribute)
+                            throws ManifestException
    +
    +
    Add an attribute to the manifest - it is added to the main section. +

    +

    +
    Parameters:
    attribute - the attribute to be added. +
    Throws: +
    ManifestException - if the attribute is not valid.
    +
    +
    +
    + +

    +merge

    +
    +public void merge(Manifest other)
+           throws ManifestException
    +
    +
    Merge the contents of the given manifest into this manifest + without merging Class-Path attributes. +

    +

    +
    Parameters:
    other - the Manifest to be merged with this one. +
    Throws: +
    ManifestException - if there is a problem merging the + manifest according to the Manifest spec.
    +
    +
    +
    + +

    +merge

    +
    +public void merge(Manifest other,
+                  boolean overwriteMain)
+           throws ManifestException
    +
    +
    Merge the contents of the given manifest into this manifest + without merging Class-Path attributes. +

    +

    +
    Parameters:
    other - the Manifest to be merged with this one.
    overwriteMain - whether to overwrite the main section + of the current manifest +
    Throws: +
    ManifestException - if there is a problem merging the + manifest according to the Manifest spec.
    +
    +
    +
    + +

    +merge

    +
    +public void merge(Manifest other,
+                  boolean overwriteMain,
+                  boolean mergeClassPaths)
+           throws ManifestException
    +
    +
    Merge the contents of the given manifest into this manifest +

    +

    +
    Parameters:
    other - the Manifest to be merged with this one.
    overwriteMain - whether to overwrite the main section + of the current manifest
    mergeClassPaths - whether Class-Path attributes should be + merged. +
    Throws: +
    ManifestException - if there is a problem merging the + manifest according to the Manifest spec.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer)
+           throws java.io.IOException
    +
    +
    Write the manifest out to a print writer without flattening + multi-values attributes (i.e. Class-Path). +

    +

    +
    Parameters:
    writer - the Writer to which the manifest is written +
    Throws: +
    java.io.IOException - if the manifest cannot be written
    +
    +
    +
    + +

    +write

    +
    +public void write(java.io.PrintWriter writer,
+                  boolean flatten)
+           throws java.io.IOException
    +
    +
    Write the manifest out to a print writer. +

    +

    +
    Parameters:
    writer - the Writer to which the manifest is written
    flatten - whether to collapse multi-valued attributes + (i.e. potentially Class-Path) Class-Path into a single + attribute. +
    Throws: +
    java.io.IOException - if the manifest cannot be written
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Convert the manifest to its string representation +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a multiline string with the Manifest as it + appears in a Manifest file.
    +
    +
    +
    + +

    +getWarnings

    +
    +public java.util.Enumeration getWarnings()
    +
    +
    Get the warnings for this manifest. +

    +

    + +
    Returns:
    an enumeration of warning strings
    +
    +
    +
    + +

    +hashCode

    +
    +public int hashCode()
    +
    +
    +
    Overrides:
    hashCode in class java.lang.Object
    +
    +
    + +
    Returns:
    a hashcode based on the version, main and sections.
    See Also:
    Object.hashCode()
    +
    +
    +
    + +

    +equals

    +
    +public boolean equals(java.lang.Object rhs)
    +
    +
    +
    Overrides:
    equals in class java.lang.Object
    +
    +
    +
    Parameters:
    rhs - the object to check for equality. +
    Returns:
    true if the version, main and sections are the same.
    See Also:
    Object.equals(java.lang.Object)
    +
    +
    +
    + +

    +getManifestVersion

    +
    +public java.lang.String getManifestVersion()
    +
    +
    Get the version of the manifest +

    +

    + +
    Returns:
    the manifest's version string
    +
    +
    +
    + +

    +getMainSection

    +
    +public Manifest.Section getMainSection()
    +
    +
    Get the main section of the manifest +

    +

    + +
    Returns:
    the main section of the manifest
    +
    +
    +
    + +

    +getSection

    +
    +public Manifest.Section getSection(java.lang.String name)
    +
    +
    Get a particular section from the manifest +

    +

    +
    Parameters:
    name - the name of the section desired. +
    Returns:
    the specified section or null if that section + does not exist in the manifest
    +
    +
    +
    + +

    +getSectionNames

    +
    +public java.util.Enumeration getSectionNames()
    +
    +
    Get the section names in this manifest. +

    +

    + +
    Returns:
    an Enumeration of section names
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestClassPath.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestClassPath.html new file mode 100644 index 000000000..3309fe250 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestClassPath.html @@ -0,0 +1,401 @@ + + + + + + +ManifestClassPath (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ManifestClassPath

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ManifestClassPath
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ManifestClassPath
    extends Task
    + + +

    +Converts a Path into a property suitable as a Manifest classpath. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ManifestClassPath() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddClassPath(Path path) + +
    +          Adds the classpath to convert.
    + voidexecute() + +
    +          Sets a property, which must not already exist, with a space + separated list of files and directories relative to the jar + file's parent directory.
    + voidsetJarFile(java.io.File jarfile) + +
    +          The JAR file to contain the classpath attribute in its manifest.
    + voidsetMaxParentLevels(int levels) + +
    +          Sets the maximum parent directory levels allowed when computing + a relative path.
    + voidsetProperty(java.lang.String name) + +
    +          Sets the property name to hold the classpath value.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ManifestClassPath

    +
    +public ManifestClassPath()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
    +
    +
    Sets a property, which must not already exist, with a space + separated list of files and directories relative to the jar + file's parent directory. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String name)
    +
    +
    Sets the property name to hold the classpath value. +

    +

    +
    Parameters:
    name - the property name
    +
    +
    +
    + +

    +setJarFile

    +
    +public void setJarFile(java.io.File jarfile)
    +
    +
    The JAR file to contain the classpath attribute in its manifest. +

    +

    +
    Parameters:
    jarfile - the JAR file. Need not exist yet, but its parent + directory must exist on the other hand.
    +
    +
    +
    + +

    +setMaxParentLevels

    +
    +public void setMaxParentLevels(int levels)
    +
    +
    Sets the maximum parent directory levels allowed when computing + a relative path. +

    +

    +
    Parameters:
    levels - the max level. Defaults to 2.
    +
    +
    +
    + +

    +addClassPath

    +
    +public void addClassPath(Path path)
    +
    +
    Adds the classpath to convert. +

    +

    +
    Parameters:
    path - the classpath to convert.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestException.html new file mode 100644 index 000000000..d1a068c06 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestException.html @@ -0,0 +1,245 @@ + + + + + + +ManifestException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ManifestException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.apache.tools.ant.taskdefs.ManifestException
+
    +
    +
    All Implemented Interfaces:
    java.io.Serializable
    +
    +
    +
    +
    public class ManifestException
    extends java.lang.Exception
    + + +

    +Exception thrown indicating problems in a JAR Manifest +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ManifestException(java.lang.String msg) + +
    +          Constructs an exception with the given descriptive message.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ManifestException

    +
    +public ManifestException(java.lang.String msg)
    +
    +
    Constructs an exception with the given descriptive message. +

    +

    +
    Parameters:
    msg - Description of or information about the exception.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.Mode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.Mode.html new file mode 100644 index 000000000..413d0cba9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.Mode.html @@ -0,0 +1,288 @@ + + + + + + +ManifestTask.Mode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ManifestTask.Mode

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.ManifestTask.Mode
+
    +
    +
    Enclosing class:
    ManifestTask
    +
    +
    +
    +
    public static class ManifestTask.Mode
    extends EnumeratedAttribute
    + + +

    +Helper class for Manifest's mode attribute. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    ManifestTask.Mode() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          Get Allowed values for the mode attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ManifestTask.Mode

    +
    +public ManifestTask.Mode()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get Allowed values for the mode attribute. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    a String array of the allowed values.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.html new file mode 100644 index 000000000..91f300fc7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ManifestTask.html @@ -0,0 +1,523 @@ + + + + + + +ManifestTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ManifestTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ManifestTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ManifestTask
    extends Task
    + + +

    +Creates a manifest file for inclusion in a JAR, Ant task wrapper + around Manifest. This task can be used to write a + Manifest file, optionally replacing or updating an existing file. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classManifestTask.Mode + +
    +          Helper class for Manifest's mode attribute.
    +  + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringVALID_ATTRIBUTE_CHARS + +
    +          Specifies the valid characters which can be used in attribute names.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ManifestTask() + +
    +          Default constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfiguredAttribute(Manifest.Attribute attribute) + +
    +          Add an attribute to the manifest - it is added to the main section.
    + voidaddConfiguredSection(Manifest.Section section) + +
    +          Add a section to the manifest
    + voidexecute() + +
    +          Create or update the Manifest when used as a task.
    + voidsetEncoding(java.lang.String encoding) + +
    +          The encoding to use for reading in an existing manifest file
    + voidsetFile(java.io.File f) + +
    +          The name of the manifest file to create/update.
    + voidsetFlattenAttributes(boolean b) + +
    +          Whether to flatten multi-valued attributes (i.e.
    + voidsetMergeClassPathAttributes(boolean b) + +
    +          Whether to merge Class-Path attributes.
    + voidsetMode(ManifestTask.Mode m) + +
    +          Update policy: either "update" or "replace"; default is "replace".
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +VALID_ATTRIBUTE_CHARS

    +
    +public static final java.lang.String VALID_ATTRIBUTE_CHARS
    +
    +
    Specifies the valid characters which can be used in attribute names. + "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ManifestTask

    +
    +public ManifestTask()
    +
    +
    Default constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +addConfiguredSection

    +
    +public void addConfiguredSection(Manifest.Section section)
+                          throws ManifestException
    +
    +
    Add a section to the manifest +

    +

    +
    Parameters:
    section - the manifest section to be added +
    Throws: +
    ManifestException - if the section is not valid.
    +
    +
    +
    + +

    +addConfiguredAttribute

    +
    +public void addConfiguredAttribute(Manifest.Attribute attribute)
+                            throws ManifestException
    +
    +
    Add an attribute to the manifest - it is added to the main section. +

    +

    +
    Parameters:
    attribute - the attribute to be added. +
    Throws: +
    ManifestException - if the attribute is not valid.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File f)
    +
    +
    The name of the manifest file to create/update. + Required if used as a task. +

    +

    +
    Parameters:
    f - the Manifest file to be written
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    The encoding to use for reading in an existing manifest file +

    +

    +
    Parameters:
    encoding - the manifest file encoding.
    +
    +
    +
    + +

    +setMode

    +
    +public void setMode(ManifestTask.Mode m)
    +
    +
    Update policy: either "update" or "replace"; default is "replace". +

    +

    +
    Parameters:
    m - the mode value - update or replace.
    +
    +
    +
    + +

    +setMergeClassPathAttributes

    +
    +public void setMergeClassPathAttributes(boolean b)
    +
    +
    Whether to merge Class-Path attributes. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFlattenAttributes

    +
    +public void setFlattenAttributes(boolean b)
    +
    +
    Whether to flatten multi-valued attributes (i.e. Class-Path) + into a single one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Create or update the Manifest when used as a task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if the manifest cannot be written.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MatchingTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MatchingTask.html new file mode 100644 index 000000000..e227d8d70 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/MatchingTask.html @@ -0,0 +1,1337 @@ + + + + + + +MatchingTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class MatchingTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    Direct Known Subclasses:
    Cab, Checksum, Copydir, Delete, Depend, DependSet, EjbJar, FixCRLF, Image, Javac, JlinkTask, JspC, Native2Ascii, NetRexxC, RenameExtensions, Replace, Rmic, Tar, Translate, WLJspc, XSLTProcess, Zip
    +
    +
    +
    +
    public abstract class MatchingTask
    extends Task
    implements SelectorContainer
    + + +

    +This is an abstract task that should be used by all those tasks that + require to include or exclude files based on pattern matching. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected  FileSetfileset + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    MatchingTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileSelector selector) + +
    +          add an arbitary selector
    + voidaddAnd(AndSelector selector) + +
    +          add an "And" selector entry on the selector list
    + voidaddContains(ContainsSelector selector) + +
    +          add a contains selector entry on the selector list
    + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
    +          add a regular expression selector entry on the selector list
    + voidaddCustom(ExtendSelector selector) + +
    +          add an extended selector entry on the selector list
    + voidaddDate(DateSelector selector) + +
    +          add a selector date entry on the selector list
    + voidaddDepend(DependSelector selector) + +
    +          add a depends selector entry on the selector list
    + voidaddDepth(DepthSelector selector) + +
    +          add a depth selector entry on the selector list
    + voidaddDifferent(DifferentSelector selector) + +
    +          add a type selector entry on the type list
    + voidaddFilename(FilenameSelector selector) + +
    +          add a selector filename entry on the selector list
    + voidaddMajority(MajoritySelector selector) + +
    +          add a majority selector entry on the selector list
    + voidaddModified(ModifiedSelector selector) + +
    +          add the modified selector
    + voidaddNone(NoneSelector selector) + +
    +          add a "None" selector entry on the selector list
    + voidaddNot(NotSelector selector) + +
    +          add a "Not" selector entry on the selector list
    + voidaddOr(OrSelector selector) + +
    +          add an "Or" selector entry on the selector list
    + voidaddPresent(PresentSelector selector) + +
    +          add a present selector entry on the selector list
    + voidaddSelector(SelectSelector selector) + +
    +          add a "Select" selector entry on the selector list
    + voidaddSize(SizeSelector selector) + +
    +          add a selector size entry on the selector list
    + voidaddType(TypeSelector selector) + +
    +          add a type selector entry on the type list
    + voidappendSelector(FileSelector selector) + +
    +          Add a new selector into this container.
    + PatternSet.NameEntrycreateExclude() + +
    +          add a name entry on the exclude list
    + PatternSet.NameEntrycreateExcludesFile() + +
    +          add a name entry on the include files list
    + PatternSet.NameEntrycreateInclude() + +
    +          add a name entry on the include list
    + PatternSet.NameEntrycreateIncludesFile() + +
    +          add a name entry on the include files list
    + PatternSetcreatePatternSet() + +
    +          add a set of patterns
    +protected  DirectoryScannergetDirectoryScanner(java.io.File baseDir) + +
    +          Returns the directory scanner needed to access the files to process.
    +protected  FileSetgetImplicitFileSet() + +
    +          Accessor for the implicit fileset.
    + FileSelector[]getSelectors(Project p) + +
    +          Returns the set of selectors as an array.
    + booleanhasSelectors() + +
    +          Indicates whether there are any selectors here.
    + intselectorCount() + +
    +          Gives the count of the number of selectors in this container
    + java.util.EnumerationselectorElements() + +
    +          Returns an enumerator for accessing the set of selectors.
    + voidsetCaseSensitive(boolean isCaseSensitive) + +
    +          Sets case sensitivity of the file system
    + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
    +          Sets whether default exclusions should be used or not.
    + voidsetExcludes(java.lang.String excludes) + +
    +          Sets the set of exclude patterns.
    + voidsetExcludesfile(java.io.File excludesfile) + +
    +          Sets the name of the file containing the includes patterns.
    + voidsetFollowSymlinks(boolean followSymlinks) + +
    +          Sets whether or not symbolic links should be followed.
    + voidsetIncludes(java.lang.String includes) + +
    +          Sets the set of include patterns.
    + voidsetIncludesfile(java.io.File includesfile) + +
    +          Sets the name of the file containing the includes patterns.
    + voidsetProject(Project project) + +
    +          Sets the project object of this component..
    + voidXsetIgnore(java.lang.String ignoreString) + +
    +          List of filenames and directory names to not include.
    + voidXsetItems(java.lang.String itemString) + +
    +          Set this to be the items in the base directory that you want to be + included.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +fileset

    +
    +protected FileSet fileset
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +MatchingTask

    +
    +public MatchingTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Sets the project object of this component. This method is used by + Project when a component is added to it so that the component has + access to the functions of the project. It should not be used + for any other purpose.. +

    +

    +
    Overrides:
    setProject in class ProjectComponent
    +
    +
    +
    Parameters:
    project - Project in whose scope this component belongs. + Must not be null.
    +
    +
    +
    + +

    +createInclude

    +
    +public PatternSet.NameEntry createInclude()
    +
    +
    add a name entry on the include list +

    +

    +
    +
    +
    + +
    Returns:
    a NameEntry object to be configured
    +
    +
    +
    + +

    +createIncludesFile

    +
    +public PatternSet.NameEntry createIncludesFile()
    +
    +
    add a name entry on the include files list +

    +

    +
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createExclude

    +
    +public PatternSet.NameEntry createExclude()
    +
    +
    add a name entry on the exclude list +

    +

    +
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createExcludesFile

    +
    +public PatternSet.NameEntry createExcludesFile()
    +
    +
    add a name entry on the include files list +

    +

    +
    +
    +
    + +
    Returns:
    an NameEntry object to be configured
    +
    +
    +
    + +

    +createPatternSet

    +
    +public PatternSet createPatternSet()
    +
    +
    add a set of patterns +

    +

    +
    +
    +
    + +
    Returns:
    PatternSet object to be configured
    +
    +
    +
    + +

    +setIncludes

    +
    +public void setIncludes(java.lang.String includes)
    +
    +
    Sets the set of include patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    +
    +
    +
    Parameters:
    includes - the string containing the include patterns
    +
    +
    +
    + +

    +XsetItems

    +
    +public void XsetItems(java.lang.String itemString)
    +
    +
    Set this to be the items in the base directory that you want to be + included. You can also specify "*" for the items (ie: items="*") + and it will include all the items in the base directory. +

    +

    +
    +
    +
    +
    Parameters:
    itemString - the string containing the files to include.
    +
    +
    +
    + +

    +setExcludes

    +
    +public void setExcludes(java.lang.String excludes)
    +
    +
    Sets the set of exclude patterns. Patterns may be separated by a comma + or a space. +

    +

    +
    +
    +
    +
    Parameters:
    excludes - the string containing the exclude patterns
    +
    +
    +
    + +

    +XsetIgnore

    +
    +public void XsetIgnore(java.lang.String ignoreString)
    +
    +
    List of filenames and directory names to not include. They should be + either , or " " (space) separated. The ignored files will be logged. +

    +

    +
    +
    +
    +
    Parameters:
    ignoreString - the string containing the files to ignore.
    +
    +
    +
    + +

    +setDefaultexcludes

    +
    +public void setDefaultexcludes(boolean useDefaultExcludes)
    +
    +
    Sets whether default exclusions should be used or not. +

    +

    +
    +
    +
    +
    Parameters:
    useDefaultExcludes - "true"|"on"|"yes" when default exclusions + should be used, "false"|"off"|"no" when they + shouldn't be used.
    +
    +
    +
    + +

    +getDirectoryScanner

    +
    +protected DirectoryScanner getDirectoryScanner(java.io.File baseDir)
    +
    +
    Returns the directory scanner needed to access the files to process. +

    +

    +
    +
    +
    +
    Parameters:
    baseDir - the base directory to use with the fileset +
    Returns:
    a directory scanner
    +
    +
    +
    + +

    +setIncludesfile

    +
    +public void setIncludesfile(java.io.File includesfile)
    +
    +
    Sets the name of the file containing the includes patterns. +

    +

    +
    +
    +
    +
    Parameters:
    includesfile - A string containing the filename to fetch + the include patterns from.
    +
    +
    +
    + +

    +setExcludesfile

    +
    +public void setExcludesfile(java.io.File excludesfile)
    +
    +
    Sets the name of the file containing the includes patterns. +

    +

    +
    +
    +
    +
    Parameters:
    excludesfile - A string containing the filename to fetch + the include patterns from.
    +
    +
    +
    + +

    +setCaseSensitive

    +
    +public void setCaseSensitive(boolean isCaseSensitive)
    +
    +
    Sets case sensitivity of the file system +

    +

    +
    +
    +
    +
    Parameters:
    isCaseSensitive - "true"|"on"|"yes" if file system is case + sensitive, "false"|"off"|"no" when not.
    +
    +
    +
    + +

    +setFollowSymlinks

    +
    +public void setFollowSymlinks(boolean followSymlinks)
    +
    +
    Sets whether or not symbolic links should be followed. +

    +

    +
    +
    +
    +
    Parameters:
    followSymlinks - whether or not symbolic links should be followed
    +
    +
    +
    + +

    +hasSelectors

    +
    +public boolean hasSelectors()
    +
    +
    Indicates whether there are any selectors here. +

    +

    +
    Specified by:
    hasSelectors in interface SelectorContainer
    +
    +
    + +
    Returns:
    whether any selectors are in this container
    +
    +
    +
    + +

    +selectorCount

    +
    +public int selectorCount()
    +
    +
    Gives the count of the number of selectors in this container +

    +

    +
    Specified by:
    selectorCount in interface SelectorContainer
    +
    +
    + +
    Returns:
    the number of selectors in this container
    +
    +
    +
    + +

    +getSelectors

    +
    +public FileSelector[] getSelectors(Project p)
    +
    +
    Returns the set of selectors as an array. +

    +

    +
    Specified by:
    getSelectors in interface SelectorContainer
    +
    +
    +
    Parameters:
    p - the current project +
    Returns:
    an array of selectors in this container
    +
    +
    +
    + +

    +selectorElements

    +
    +public java.util.Enumeration selectorElements()
    +
    +
    Returns an enumerator for accessing the set of selectors. +

    +

    +
    Specified by:
    selectorElements in interface SelectorContainer
    +
    +
    + +
    Returns:
    an enumerator that goes through each of the selectors
    +
    +
    +
    + +

    +appendSelector

    +
    +public void appendSelector(FileSelector selector)
    +
    +
    Add a new selector into this container. +

    +

    +
    Specified by:
    appendSelector in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the new selector to add
    +
    +
    +
    + +

    +addSelector

    +
    +public void addSelector(SelectSelector selector)
    +
    +
    add a "Select" selector entry on the selector list +

    +

    +
    Specified by:
    addSelector in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addAnd

    +
    +public void addAnd(AndSelector selector)
    +
    +
    add an "And" selector entry on the selector list +

    +

    +
    Specified by:
    addAnd in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addOr

    +
    +public void addOr(OrSelector selector)
    +
    +
    add an "Or" selector entry on the selector list +

    +

    +
    Specified by:
    addOr in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addNot

    +
    +public void addNot(NotSelector selector)
    +
    +
    add a "Not" selector entry on the selector list +

    +

    +
    Specified by:
    addNot in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addNone

    +
    +public void addNone(NoneSelector selector)
    +
    +
    add a "None" selector entry on the selector list +

    +

    +
    Specified by:
    addNone in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addMajority

    +
    +public void addMajority(MajoritySelector selector)
    +
    +
    add a majority selector entry on the selector list +

    +

    +
    Specified by:
    addMajority in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addDate

    +
    +public void addDate(DateSelector selector)
    +
    +
    add a selector date entry on the selector list +

    +

    +
    Specified by:
    addDate in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addSize

    +
    +public void addSize(SizeSelector selector)
    +
    +
    add a selector size entry on the selector list +

    +

    +
    Specified by:
    addSize in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addFilename

    +
    +public void addFilename(FilenameSelector selector)
    +
    +
    add a selector filename entry on the selector list +

    +

    +
    Specified by:
    addFilename in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addCustom

    +
    +public void addCustom(ExtendSelector selector)
    +
    +
    add an extended selector entry on the selector list +

    +

    +
    Specified by:
    addCustom in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addContains

    +
    +public void addContains(ContainsSelector selector)
    +
    +
    add a contains selector entry on the selector list +

    +

    +
    Specified by:
    addContains in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addPresent

    +
    +public void addPresent(PresentSelector selector)
    +
    +
    add a present selector entry on the selector list +

    +

    +
    Specified by:
    addPresent in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addDepth

    +
    +public void addDepth(DepthSelector selector)
    +
    +
    add a depth selector entry on the selector list +

    +

    +
    Specified by:
    addDepth in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addDepend

    +
    +public void addDepend(DependSelector selector)
    +
    +
    add a depends selector entry on the selector list +

    +

    +
    Specified by:
    addDepend in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addContainsRegexp

    +
    +public void addContainsRegexp(ContainsRegexpSelector selector)
    +
    +
    add a regular expression selector entry on the selector list +

    +

    +
    Specified by:
    addContainsRegexp in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    +
    +
    +
    + +

    +addDifferent

    +
    +public void addDifferent(DifferentSelector selector)
    +
    +
    add a type selector entry on the type list +

    +

    +
    Specified by:
    addDifferent in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +addType

    +
    +public void addType(TypeSelector selector)
    +
    +
    add a type selector entry on the type list +

    +

    +
    Specified by:
    addType in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +addModified

    +
    +public void addModified(ModifiedSelector selector)
    +
    +
    add the modified selector +

    +

    +
    Specified by:
    addModified in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileSelector selector)
    +
    +
    add an arbitary selector +

    +

    +
    Specified by:
    add in interface SelectorContainer
    +
    +
    +
    Parameters:
    selector - the selector to add
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getImplicitFileSet

    +
    +protected final FileSet getImplicitFileSet()
    +
    +
    Accessor for the implicit fileset. +

    +

    +
    +
    +
    + +
    Returns:
    the implicit fileset
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Mkdir.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Mkdir.html new file mode 100644 index 000000000..cc7d0e1ad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Mkdir.html @@ -0,0 +1,336 @@ + + + + + + +Mkdir (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Mkdir

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Mkdir
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Mkdir
    extends Task
    + + +

    +Creates a given directory. + Creates a directory and any non-existent parent directories, when + necessary +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Mkdir() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          create the directory and all parents
    + voidsetDir(java.io.File dir) + +
    +          the directory to create; required.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Mkdir

    +
    +public Mkdir()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    create the directory and all parents +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if dir is somehow invalid, or creation failed.
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
    +
    +
    the directory to create; required. +

    +

    +
    Parameters:
    dir - the directory to be made.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Move.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Move.html new file mode 100644 index 000000000..b4781db50 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Move.html @@ -0,0 +1,484 @@ + + + + + + +Move (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Move

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Copy
+              extended by org.apache.tools.ant.taskdefs.Move
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Move
    extends Copy
    + + +

    +Moves a file or directory to a new file or directory. + By default, the + destination file is overwritten if it already exists. + When overwrite is + turned off, then files are only moved if the source file is + newer than the destination file, or when the destination file does + not exist. + +

    Source files and directories are only deleted when the file or + directory has been copied to the destination successfully. Filtering + also works.

    + +

    This implementation is based on Arnout Kuiper's initial design + document, the following mailing list discussions, and the + copyfile/copydir tasks.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Copy
    completeDirMap, destDir, destFile, dirCopyMap, failonerror, file, fileCopyMap, filesets, fileUtils, filtering, flatten, forceOverwrite, includeEmpty, mapperElement, preserveLastModified, rcs, verbosity
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Move() + +
    +          Constructor of object.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voiddeleteDir(java.io.File d) + +
    +          Go and delete the directory tree.
    +protected  voiddeleteDir(java.io.File d, + boolean deleteFiles) + +
    +          Go and delete the directory tree.
    +protected  voiddoFileOperations() + +
    +          Override copy's doFileOperations to move the files instead of copying them.
    +protected  booleanokToDelete(java.io.File d) + +
    +          Its only ok to delete a directory tree if there are no files in it.
    +protected  booleanrenameFile(java.io.File sourceFile, + java.io.File destFile, + boolean filtering, + boolean overwrite) + +
    +          Attempts to rename a file from a source to a destination.
    +protected  voidvalidateAttributes() + +
    +          Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Copy
    add, add, addFileset, buildMap, buildMap, createFilterChain, createFilterSet, createMapper, doResourceOperations, execute, getEncoding, getFileUtils, getFilterChains, getFilterSets, getForce, getOutputEncoding, getPreserveLastModified, isEnableMultipleMapping, scan, scan, setEnableMultipleMappings, setEncoding, setFailOnError, setFile, setFiltering, setFlatten, setForce, setGranularity, setIncludeEmptyDirs, setOutputEncoding, setOverwrite, setPreserveLastModified, setPreserveLastModified, setTodir, setTofile, setVerbose, supportsNonFileResources
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Move

    +
    +public Move()
    +
    +
    Constructor of object. + This sets the forceOverwrite attribute of the Copy parent class + to true. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +validateAttributes

    +
    +protected void validateAttributes()
+                           throws BuildException
    +
    +
    Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes.. +

    +

    +
    Overrides:
    validateAttributes in class Copy
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +doFileOperations

    +
    +protected void doFileOperations()
    +
    +
    Override copy's doFileOperations to move the files instead of copying them. +

    +

    +
    Overrides:
    doFileOperations in class Copy
    +
    +
    +
    +
    +
    +
    + +

    +okToDelete

    +
    +protected boolean okToDelete(java.io.File d)
    +
    +
    Its only ok to delete a directory tree if there are no files in it. +

    +

    +
    Parameters:
    d - the directory to check +
    Returns:
    true if a deletion can go ahead
    +
    +
    +
    + +

    +deleteDir

    +
    +protected void deleteDir(java.io.File d)
    +
    +
    Go and delete the directory tree. +

    +

    +
    Parameters:
    d - the directory to delete
    +
    +
    +
    + +

    +deleteDir

    +
    +protected void deleteDir(java.io.File d,
+                         boolean deleteFiles)
    +
    +
    Go and delete the directory tree. +

    +

    +
    Parameters:
    d - the directory to delete
    deleteFiles - whether to delete files
    +
    +
    +
    + +

    +renameFile

    +
    +protected boolean renameFile(java.io.File sourceFile,
+                             java.io.File destFile,
+                             boolean filtering,
+                             boolean overwrite)
+                      throws java.io.IOException,
+                             BuildException
    +
    +
    Attempts to rename a file from a source to a destination. + If overwrite is set to true, this method overwrites existing file + even if the destination file is newer. Otherwise, the source file is + renamed only if the destination file is older than it. + Method then checks if token filtering is used. If it is, this method + returns false assuming it is the responsibility to the copyFile method. +

    +

    +
    Parameters:
    sourceFile - the file to rename
    destFile - the destination file
    filtering - if true, filtering is in operation, file will + be copied/deleted instead of renamed
    overwrite - if true force overwrite even if destination file + is newer than source file +
    Returns:
    true if the file was renamed +
    Throws: +
    java.io.IOException - if an error occurs +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Nice.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Nice.html new file mode 100644 index 000000000..c7808433c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Nice.html @@ -0,0 +1,362 @@ + + + + + + +Nice (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Nice

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Nice
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Nice
    extends Task
    + + +

    +A task to provide "nice-ness" to the current thread, and/or to + query the current value. + Examples: + 

     <nice currentPriority="current.value" >

    + Set currentPriority to the current priority + 

     <nice newPriority="10" >

    + Raise the priority of the build process (But not forked programs) + 

     <nice currentPriority="old" newPriority="3" >

    + Lower the priority of the build process (But not forked programs), and save + the old value to the property old. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Nice() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute the task
    + voidsetCurrentPriority(java.lang.String currentPriority) + +
    +          The name of a property to set to the value of the current + thread priority.
    + voidsetNewPriority(int newPriority) + +
    +          the new priority, in the range 1-10.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Nice

    +
    +public Nice()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    +
    + +

    +setCurrentPriority

    +
    +public void setCurrentPriority(java.lang.String currentPriority)
    +
    +
    The name of a property to set to the value of the current + thread priority. Optional +

    +

    +
    Parameters:
    currentPriority - the property name.
    +
    +
    +
    + +

    +setNewPriority

    +
    +public void setNewPriority(int newPriority)
    +
    +
    the new priority, in the range 1-10. +

    +

    +
    Parameters:
    newPriority - the new priority value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Pack.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Pack.html new file mode 100644 index 000000000..11fae6754 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Pack.html @@ -0,0 +1,589 @@ + + + + + + +Pack (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Pack

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Pack
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    BZip2, GZip
    +
    +
    +
    +
    public abstract class Pack
    extends Task
    + + +

    +Abstract Base class for pack tasks. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.Filesource + +
    +           
    +protected  java.io.FilezipFile + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Pack() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source resource.
    + voidexecute() + +
    +          validate, then hand off to the subclass
    + ResourcegetSrcResource() + +
    +          The source resource.
    +protected abstract  voidpack() + +
    +          subclasses must implement this method to do their compression
    + voidsetDestfile(java.io.File zipFile) + +
    +          the required destination file.
    + voidsetSrc(java.io.File src) + +
    +          the file to compress; required.
    + voidsetSrcResource(Resource src) + +
    +          The resource to pack; required.
    + voidsetZipfile(java.io.File zipFile) + +
    +          the required destination file.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +protected  voidzipFile(java.io.File file, + java.io.OutputStream zOut) + +
    +          zip a file to an output stream
    +protected  voidzipResource(Resource resource, + java.io.OutputStream zOut) + +
    +          zip a resource to an output stream
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +zipFile

    +
    +protected java.io.File zipFile
    +
    +
    +
    +
    +
    + +

    +source

    +
    +protected java.io.File source
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Pack

    +
    +public Pack()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setZipfile

    +
    +public void setZipfile(java.io.File zipFile)
    +
    +
    the required destination file. +

    +

    +
    Parameters:
    zipFile - the destination file
    +
    +
    +
    + +

    +setDestfile

    +
    +public void setDestfile(java.io.File zipFile)
    +
    +
    the required destination file. +

    +

    +
    Parameters:
    zipFile - the destination file
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    the file to compress; required. +

    +

    +
    Parameters:
    src - the source file
    +
    +
    +
    + +

    +setSrcResource

    +
    +public void setSrcResource(Resource src)
    +
    +
    The resource to pack; required. +

    +

    +
    Parameters:
    src - resource to expand
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source resource. +

    +

    +
    Parameters:
    a - the resource to pack as a single element Resource collection.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    validate, then hand off to the subclass +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.File file,
+                       java.io.OutputStream zOut)
+                throws java.io.IOException
    +
    +
    zip a file to an output stream +

    +

    +
    Parameters:
    file - the file to zip
    zOut - the output stream +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +zipResource

    +
    +protected void zipResource(Resource resource,
+                           java.io.OutputStream zOut)
+                    throws java.io.IOException
    +
    +
    zip a resource to an output stream +

    +

    +
    Parameters:
    resource - the resource to zip
    zOut - the output stream +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +pack

    +
    +protected abstract void pack()
    +
    +
    subclasses must implement this method to do their compression +

    +

    +
    +
    +
    +
    + +

    +getSrcResource

    +
    +public Resource getSrcResource()
    +
    +
    The source resource. +

    +

    + +
    Returns:
    the source.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns false.

    +

    +

    + +
    Returns:
    false.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.TaskList.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.TaskList.html new file mode 100644 index 000000000..dea8c58a1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.TaskList.html @@ -0,0 +1,264 @@ + + + + + + +Parallel.TaskList (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Parallel.TaskList

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Parallel.TaskList
+
    +
    +
    All Implemented Interfaces:
    TaskContainer
    +
    +
    +
    Enclosing class:
    Parallel
    +
    +
    +
    +
    public static class Parallel.TaskList
    extends java.lang.Object
    implements TaskContainer
    + + +

    +Class which holds a list of tasks to execute +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Parallel.TaskList() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          Add a nested task to execute parallel (asynchron).
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Parallel.TaskList

    +
    +public Parallel.TaskList()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add a nested task to execute parallel (asynchron). +

    +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - Nested task to be executed in parallel. + must not be null.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.html new file mode 100644 index 000000000..2ef6f5223 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Parallel.html @@ -0,0 +1,531 @@ + + + + + + +Parallel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Parallel

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Parallel
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TaskContainer
    +
    +
    +
    +
    public class Parallel
    extends Task
    implements TaskContainer
    + + +

    +Executes the contained tasks in separate threads, continuing + once all are completed. +

    + New behavior allows for the ant script to specify a maximum number of + threads that will be executed in parallel. One should be very careful about + using the waitFor task when specifying threadCount + as it can cause deadlocks if the number of threads is too small or if one of + the nested tasks fails to execute completely. The task selection algorithm + will insure that the tasks listed before a task have started before that + task is started, but it will not insure a successful completion of those + tasks or that those tasks will finish first (i.e. it's a classic race + condition). +

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classParallel.TaskList + +
    +          Class which holds a list of tasks to execute
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Parallel() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddDaemons(Parallel.TaskList daemonTasks) + +
    +          Add a group of daemon threads
    + voidaddTask(Task nestedTask) + +
    +          Add a nested task to execute in parallel.
    + voidexecute() + +
    +          Execute the parallel tasks
    + voidsetFailOnAny(boolean failOnAny) + +
    +          Control whether a failure in a nested task halts execution.
    + voidsetPollInterval(int pollInterval) + +
    +          Interval to poll for completed threads when threadCount or + threadsPerProcessor is specified.
    + voidsetThreadCount(int numThreads) + +
    +          Statically determine the maximum number of tasks to execute + simultaneously.
    + voidsetThreadsPerProcessor(int numThreadsPerProcessor) + +
    +          Dynamically generates the number of threads to execute based on the + number of available processors (via + java.lang.Runtime.availableProcessors()).
    + voidsetTimeout(long timeout) + +
    +          Sets the timeout on this set of tasks.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Parallel

    +
    +public Parallel()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addDaemons

    +
    +public void addDaemons(Parallel.TaskList daemonTasks)
    +
    +
    Add a group of daemon threads +

    +

    +
    +
    +
    +
    Parameters:
    daemonTasks - The tasks to be executed as daemon.
    +
    +
    +
    + +

    +setPollInterval

    +
    +public void setPollInterval(int pollInterval)
    +
    +
    Interval to poll for completed threads when threadCount or + threadsPerProcessor is specified. Integer in milliseconds.; optional +

    +

    +
    +
    +
    +
    Parameters:
    pollInterval - New value of property pollInterval.
    +
    +
    +
    + +

    +setFailOnAny

    +
    +public void setFailOnAny(boolean failOnAny)
    +
    +
    Control whether a failure in a nested task halts execution. Note that + the task will complete but existing threads will continue to run - they + are not stopped +

    +

    +
    +
    +
    +
    Parameters:
    failOnAny - if true any nested task failure causes parallel to + complete.
    +
    +
    +
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add a nested task to execute in parallel. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - Nested task to be executed in parallel
    +
    +
    +
    + +

    +setThreadsPerProcessor

    +
    +public void setThreadsPerProcessor(int numThreadsPerProcessor)
    +
    +
    Dynamically generates the number of threads to execute based on the + number of available processors (via + java.lang.Runtime.availableProcessors()). + Will overwrite the value set in threadCount; optional +

    +

    +
    +
    +
    +
    Parameters:
    numThreadsPerProcessor - Number of threads to create per available + processor.
    +
    +
    +
    + +

    +setThreadCount

    +
    +public void setThreadCount(int numThreads)
    +
    +
    Statically determine the maximum number of tasks to execute + simultaneously. If there are less tasks than threads then all will be + executed at once, if there are more then only threadCount + tasks will be executed at one time. If threadsPerProcessor + is set then this value is + ignored.; optional +

    +

    +
    +
    +
    +
    Parameters:
    numThreads - total number of threads.
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(long timeout)
    +
    +
    Sets the timeout on this set of tasks. If the timeout is reached + before the other threads complete, the execution of this + task completes with an exception. + + Note that existing threads continue to run. +

    +

    +
    +
    +
    +
    Parameters:
    timeout - timeout in milliseconds.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the parallel tasks +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if any of the threads failed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Patch.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Patch.html new file mode 100644 index 000000000..de372e3a7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Patch.html @@ -0,0 +1,548 @@ + + + + + + +Patch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Patch

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Patch
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Patch
    extends Task
    + + +

    +Patches a file by applying a 'diff' file to it; requires "patch" to be + on the execution path. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Patch() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          execute patch
    + voidsetBackups(boolean backups) + +
    +          flag to create backups; optional, default=false
    + voidsetDestfile(java.io.File file) + +
    +          The name of a file to send the output to, instead of patching + the file(s) in place; optional.
    + voidsetDir(java.io.File directory) + +
    +          The directory to run the patch command in, defaults to the + project's base directory.
    + voidsetFailOnError(boolean value) + +
    +          If true, stop the build process if the patch command + exits with an error status.
    + voidsetIgnorewhitespace(boolean ignore) + +
    +          flag to ignore whitespace differences; default=false
    + voidsetOriginalfile(java.io.File file) + +
    +          The file to patch; optional if it can be inferred from + the diff file
    + voidsetPatchfile(java.io.File file) + +
    +          The file containing the diff output; required.
    + voidsetQuiet(boolean q) + +
    +          Work silently unless an error occurs; optional, default=false
    + voidsetReverse(boolean r) + +
    +          Assume patch was created with old and new files swapped; optional, + default=false
    + voidsetStrip(int num) + +
    +          Strip the smallest prefix containing num leading slashes + from filenames.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Patch

    +
    +public Patch()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setOriginalfile

    +
    +public void setOriginalfile(java.io.File file)
    +
    +
    The file to patch; optional if it can be inferred from + the diff file +

    +

    +
    Parameters:
    file - the file to patch
    +
    +
    +
    + +

    +setDestfile

    +
    +public void setDestfile(java.io.File file)
    +
    +
    The name of a file to send the output to, instead of patching + the file(s) in place; optional. +

    +

    +
    Parameters:
    file - the file to send the output to
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setPatchfile

    +
    +public void setPatchfile(java.io.File file)
    +
    +
    The file containing the diff output; required. +

    +

    +
    Parameters:
    file - the file containing the diff output
    +
    +
    +
    + +

    +setBackups

    +
    +public void setBackups(boolean backups)
    +
    +
    flag to create backups; optional, default=false +

    +

    +
    Parameters:
    backups - if true create backups
    +
    +
    +
    + +

    +setIgnorewhitespace

    +
    +public void setIgnorewhitespace(boolean ignore)
    +
    +
    flag to ignore whitespace differences; default=false +

    +

    +
    Parameters:
    ignore - if true ignore whitespace differences
    +
    +
    +
    + +

    +setStrip

    +
    +public void setStrip(int num)
+              throws BuildException
    +
    +
    Strip the smallest prefix containing num leading slashes + from filenames. + +

    patch's -p option. +

    +

    +
    Parameters:
    num - number of lines to strip +
    Throws: +
    BuildException - if num is < 0, or other errors
    +
    +
    +
    + +

    +setQuiet

    +
    +public void setQuiet(boolean q)
    +
    +
    Work silently unless an error occurs; optional, default=false +

    +

    +
    Parameters:
    q - if true suppress set the -s option on the patch command
    +
    +
    +
    + +

    +setReverse

    +
    +public void setReverse(boolean r)
    +
    +
    Assume patch was created with old and new files swapped; optional, + default=false +

    +

    +
    Parameters:
    r - if true set the -R option on the patch command
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File directory)
    +
    +
    The directory to run the patch command in, defaults to the + project's base directory. +

    +

    +
    Parameters:
    directory - the directory to run the patch command in
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean value)
    +
    +
    If true, stop the build process if the patch command + exits with an error status. +

    +

    +
    Parameters:
    value - true if it should halt, otherwise + false. The default is false.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    execute patch +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - when it all goes a bit pear shaped
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html new file mode 100644 index 000000000..21ca6b11f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.MapEntry.html @@ -0,0 +1,306 @@ + + + + + + +PathConvert.MapEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PathConvert.MapEntry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.PathConvert.MapEntry
+
    +
    +
    Enclosing class:
    PathConvert
    +
    +
    +
    +
    public class PathConvert.MapEntry
    extends java.lang.Object
    + + +

    +Helper class, holds the nested <map> values. Elements will look like + this: <map from="d:" to="/foo"/> + + When running on windows, the prefix comparison will be case + insensitive. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    PathConvert.MapEntry() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.Stringapply(java.lang.String elem) + +
    +          Apply this map entry to a given path element.
    + voidsetFrom(java.lang.String from) + +
    +          Set the "from" attribute of the map entry.
    + voidsetTo(java.lang.String to) + +
    +          Set the replacement text to use when from is matched; required.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PathConvert.MapEntry

    +
    +public PathConvert.MapEntry()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFrom

    +
    +public void setFrom(java.lang.String from)
    +
    +
    Set the "from" attribute of the map entry. +

    +

    +
    Parameters:
    from - the prefix string to search for; required. + Note that this value is case-insensitive when the build is + running on a Windows platform and case-sensitive when running on + a Unix platform.
    +
    +
    +
    + +

    +setTo

    +
    +public void setTo(java.lang.String to)
    +
    +
    Set the replacement text to use when from is matched; required. +

    +

    +
    Parameters:
    to - new prefix.
    +
    +
    +
    + +

    +apply

    +
    +public java.lang.String apply(java.lang.String elem)
    +
    +
    Apply this map entry to a given path element. +

    +

    +
    Parameters:
    elem - Path element to process. +
    Returns:
    String Updated path element after mapping.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html new file mode 100644 index 000000000..b45be016a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.TargetOs.html @@ -0,0 +1,290 @@ + + + + + + +PathConvert.TargetOs (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PathConvert.TargetOs

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.PathConvert.TargetOs
+
    +
    +
    Enclosing class:
    PathConvert
    +
    +
    +
    +
    public static class PathConvert.TargetOs
    extends EnumeratedAttribute
    + + +

    +An enumeration of supported targets: + "windows", "unix", "netware", and "os/2". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    PathConvert.TargetOs() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PathConvert.TargetOs

    +
    +public PathConvert.TargetOs()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the list of values for this enumerated attribute.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.html new file mode 100644 index 000000000..ce3a5bbe4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PathConvert.html @@ -0,0 +1,689 @@ + + + + + + +PathConvert (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PathConvert

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.PathConvert
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class PathConvert
    extends Task
    + + +

    +Converts path and classpath information to a specific target OS + format. The resulting formatted path is placed into the specified property. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    + classPathConvert.MapEntry + +
    +          Helper class, holds the nested <map> values.
    +static classPathConvert.TargetOs + +
    +          An enumeration of supported targets: + "windows", "unix", "netware", and "os/2".
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    PathConvert() + +
    +          Construct a new instance of the PathConvert task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Add a nested filenamemapper.
    + voidadd(ResourceCollection rc) + +
    +          Add an arbitrary ResourceCollection.
    + voidaddMapper(Mapper mapper) + +
    +          Add a mapper to convert the file names.
    + PathConvert.MapEntrycreateMap() + +
    +          Create a nested MAP element.
    + PathcreatePath() + +
    +          Create a nested path element.
    + voidexecute() + +
    +          Do the execution.
    + booleanisPreserveDuplicates() + +
    +          Get the preserveDuplicates.
    + booleanisReference() + +
    +          Learn whether the refid attribute of this element been set.
    + voidsetDirSep(java.lang.String sep) + +
    +          Set the default directory separator string; + defaults to current JVM File.separator.
    + voidsetPathSep(java.lang.String sep) + +
    +          Set the default path separator string; defaults to current JVM + File.pathSeparator.
    + voidsetPreserveDuplicates(boolean preserveDuplicates) + +
    +          Set the preserveDuplicates.
    + voidsetProperty(java.lang.String p) + +
    +          Set the name of the property into which the converted path will be placed.
    + voidsetRefid(Reference r) + +
    +          Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
    + voidsetSetonempty(boolean setonempty) + +
    +          Set whether the specified property will be set if the result + is the empty string.
    + voidsetTargetos(PathConvert.TargetOs target) + +
    +          Set targetos to a platform to one of + "windows", "unix", "netware", or "os/2"; + current platform settings are used by default.
    + voidsetTargetos(java.lang.String target) + +
    +          Deprecated. since 1.5.x. + Use the method taking a TargetOs argument instead.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PathConvert

    +
    +public PathConvert()
    +
    +
    Construct a new instance of the PathConvert task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +createPath

    +
    +public Path createPath()
    +
    +
    Create a nested path element. +

    +

    + +
    Returns:
    a Path to be used by Ant reflection.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add an arbitrary ResourceCollection. +

    +

    +
    Parameters:
    rc - the ResourceCollection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createMap

    +
    +public PathConvert.MapEntry createMap()
    +
    +
    Create a nested MAP element. +

    +

    + +
    Returns:
    a Map to configure.
    +
    +
    +
    + +

    +setTargetos

    +
    +public void setTargetos(java.lang.String target)
    +
    +
    Deprecated. since 1.5.x. + Use the method taking a TargetOs argument instead. +

    +

    Set targetos to a platform to one of + "windows", "unix", "netware", or "os/2"; + current platform settings are used by default. +

    +

    +
    Parameters:
    target - the target os.
    See Also:
    setTargetos(PathConvert.TargetOs)
    +
    +
    +
    + +

    +setTargetos

    +
    +public void setTargetos(PathConvert.TargetOs target)
    +
    +
    Set targetos to a platform to one of + "windows", "unix", "netware", or "os/2"; + current platform settings are used by default. +

    +

    +
    Parameters:
    target - the target os
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setSetonempty

    +
    +public void setSetonempty(boolean setonempty)
    +
    +
    Set whether the specified property will be set if the result + is the empty string. +

    +

    +
    Parameters:
    setonempty - true or false.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String p)
    +
    +
    Set the name of the property into which the converted path will be placed. +

    +

    +
    Parameters:
    p - the property name.
    +
    +
    +
    + +

    +setRefid

    +
    +public void setRefid(Reference r)
    +
    +
    Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere. +

    +

    +
    Parameters:
    r - the reference to a path, fileset, dirset or filelist.
    +
    +
    +
    + +

    +setPathSep

    +
    +public void setPathSep(java.lang.String sep)
    +
    +
    Set the default path separator string; defaults to current JVM + File.pathSeparator. +

    +

    +
    Parameters:
    sep - path separator string.
    +
    +
    +
    + +

    +setDirSep

    +
    +public void setDirSep(java.lang.String sep)
    +
    +
    Set the default directory separator string; + defaults to current JVM File.separator. +

    +

    +
    Parameters:
    sep - directory separator string.
    +
    +
    +
    + +

    +setPreserveDuplicates

    +
    +public void setPreserveDuplicates(boolean preserveDuplicates)
    +
    +
    Set the preserveDuplicates. +

    +

    +
    Parameters:
    preserveDuplicates - the boolean to set
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +isPreserveDuplicates

    +
    +public boolean isPreserveDuplicates()
    +
    +
    Get the preserveDuplicates. +

    +

    + +
    Returns:
    boolean
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +isReference

    +
    +public boolean isReference()
    +
    +
    Learn whether the refid attribute of this element been set. +

    +

    + +
    Returns:
    true if refid is valid.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something is invalid.
    +
    +
    +
    + +

    +addMapper

    +
    +public void addMapper(Mapper mapper)
    +
    +
    Add a mapper to convert the file names. +

    +

    +
    Parameters:
    mapper - a Mapper value.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    Add a nested filenamemapper. +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.PreSetDefinition.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.PreSetDefinition.html new file mode 100644 index 000000000..84204ae37 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.PreSetDefinition.html @@ -0,0 +1,631 @@ + + + + + + +PreSetDef.PreSetDefinition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PreSetDef.PreSetDefinition

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.AntTypeDefinition
+      extended by org.apache.tools.ant.taskdefs.PreSetDef.PreSetDefinition
+
    +
    +
    Enclosing class:
    PreSetDef
    +
    +
    +
    +
    public static class PreSetDef.PreSetDefinition
    extends AntTypeDefinition
    + + +

    +This class contains the unknown element and the object + that is predefined. +

    + +

    +

    +
    See Also:
    AntTypeDefinition
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    PreSetDef.PreSetDefinition(AntTypeDefinition parent, + UnknownElement el) + +
    +          Creates a new PresetDefinition instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcheckClass(Project project) + +
    +          Check if the attributes are correct.
    + java.lang.Objectcreate(Project project) + +
    +          Fake create an object, used by IntrospectionHelper and UnknownElement + to see that this is a predefined object.
    + java.lang.ObjectcreateObject(Project project) + +
    +          Create an instance of the definition.
    + java.lang.ClassLoadergetClassLoader() + +
    +          Get the classloader for this definition.
    + java.lang.StringgetClassName() + +
    +          Get the classname of the definition.
    + java.lang.ClassgetExposedClass(Project project) + +
    +          Get the exposed class for this definition.
    + UnknownElementgetPreSets() + +
    +          Get the preset values.
    + java.lang.ClassgetTypeClass(Project project) + +
    +          Get the definition class.
    + booleansameDefinition(AntTypeDefinition other, + Project project) + +
    +          Equality method for this definition.
    + voidsetAdapterClass(java.lang.Class adapterClass) + +
    +          Set the adapter class for this definition.
    + voidsetAdaptToClass(java.lang.Class adaptToClass) + +
    +          Set the assignable class for this definition.
    + voidsetClass(java.lang.Class clazz) + +
    +          Override so that it is not allowed.
    + voidsetClassLoader(java.lang.ClassLoader classLoader) + +
    +          Set the classloader to use to create an instance + of the definition.
    + voidsetClassName(java.lang.String className) + +
    +          Override so that it is not allowed.
    + booleansimilarDefinition(AntTypeDefinition other, + Project project) + +
    +          Similar method for this definition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.AntTypeDefinition
    getName, innerCreateAndSet, innerGetTypeClass, isRestrict, setName, setRestrict
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PreSetDef.PreSetDefinition

    +
    +public PreSetDef.PreSetDefinition(AntTypeDefinition parent,
+                                  UnknownElement el)
    +
    +
    Creates a new PresetDefinition instance. +

    +

    +
    Parameters:
    parent - The parent of this predefinition.
    el - The predefined attributes, nested elements and text.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setClass

    +
    +public void setClass(java.lang.Class clazz)
    +
    +
    Override so that it is not allowed. +

    +

    +
    Overrides:
    setClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    clazz - a Class value.
    +
    +
    +
    + +

    +setClassName

    +
    +public void setClassName(java.lang.String className)
    +
    +
    Override so that it is not allowed. +

    +

    +
    Overrides:
    setClassName in class AntTypeDefinition
    +
    +
    +
    Parameters:
    className - a String value.
    +
    +
    +
    + +

    +getClassName

    +
    +public java.lang.String getClassName()
    +
    +
    Get the classname of the definition. +

    +

    +
    Overrides:
    getClassName in class AntTypeDefinition
    +
    +
    + +
    Returns:
    the name of the class of this definition.
    +
    +
    +
    + +

    +setAdapterClass

    +
    +public void setAdapterClass(java.lang.Class adapterClass)
    +
    +
    Set the adapter class for this definition. + NOT Supported +

    +

    +
    Overrides:
    setAdapterClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    adapterClass - the adapterClass.
    +
    +
    +
    + +

    +setAdaptToClass

    +
    +public void setAdaptToClass(java.lang.Class adaptToClass)
    +
    +
    Set the assignable class for this definition. + NOT SUPPORTED +

    +

    +
    Overrides:
    setAdaptToClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    adaptToClass - the assignable class.
    +
    +
    +
    + +

    +setClassLoader

    +
    +public void setClassLoader(java.lang.ClassLoader classLoader)
    +
    +
    Set the classloader to use to create an instance + of the definition. + NOT SUPPORTED +

    +

    +
    Overrides:
    setClassLoader in class AntTypeDefinition
    +
    +
    +
    Parameters:
    classLoader - the classLoader.
    +
    +
    +
    + +

    +getClassLoader

    +
    +public java.lang.ClassLoader getClassLoader()
    +
    +
    Get the classloader for this definition. +

    +

    +
    Overrides:
    getClassLoader in class AntTypeDefinition
    +
    +
    + +
    Returns:
    the classloader for this definition.
    +
    +
    +
    + +

    +getExposedClass

    +
    +public java.lang.Class getExposedClass(Project project)
    +
    +
    Get the exposed class for this definition. +

    +

    +
    Overrides:
    getExposedClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    project - the current project. +
    Returns:
    the exposed class.
    +
    +
    +
    + +

    +getTypeClass

    +
    +public java.lang.Class getTypeClass(Project project)
    +
    +
    Get the definition class. +

    +

    +
    Overrides:
    getTypeClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    project - the current project. +
    Returns:
    the type of the definition.
    +
    +
    +
    + +

    +checkClass

    +
    +public void checkClass(Project project)
    +
    +
    Check if the attributes are correct. +

    +

    +
    Overrides:
    checkClass in class AntTypeDefinition
    +
    +
    +
    Parameters:
    project - the current project.
    +
    +
    +
    + +

    +createObject

    +
    +public java.lang.Object createObject(Project project)
    +
    +
    Create an instance of the definition. The instance may be wrapped + in a proxy class. This is a special version of create for + IntrospectionHelper and UnknownElement. +

    +

    +
    Parameters:
    project - the current project. +
    Returns:
    the created object.
    +
    +
    +
    + +

    +getPreSets

    +
    +public UnknownElement getPreSets()
    +
    +
    Get the preset values. +

    +

    + +
    Returns:
    the predefined attributes, elements and text as + an UnknownElement.
    +
    +
    +
    + +

    +create

    +
    +public java.lang.Object create(Project project)
    +
    +
    Fake create an object, used by IntrospectionHelper and UnknownElement + to see that this is a predefined object. +

    +

    +
    Overrides:
    create in class AntTypeDefinition
    +
    +
    +
    Parameters:
    project - the current project. +
    Returns:
    this object.
    +
    +
    +
    + +

    +sameDefinition

    +
    +public boolean sameDefinition(AntTypeDefinition other,
+                              Project project)
    +
    +
    Equality method for this definition. +

    +

    +
    Overrides:
    sameDefinition in class AntTypeDefinition
    +
    +
    +
    Parameters:
    other - another definition.
    project - the current project. +
    Returns:
    true if the definitions are the same.
    +
    +
    +
    + +

    +similarDefinition

    +
    +public boolean similarDefinition(AntTypeDefinition other,
+                                 Project project)
    +
    +
    Similar method for this definition. +

    +

    +
    Overrides:
    similarDefinition in class AntTypeDefinition
    +
    +
    +
    Parameters:
    other - another definition.
    project - the current project. +
    Returns:
    true if the definitions are similar.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.html new file mode 100644 index 000000000..802f1ae7c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PreSetDef.html @@ -0,0 +1,394 @@ + + + + + + +PreSetDef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PreSetDef

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.PreSetDef
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TaskContainer
    +
    +
    +
    +
    public class PreSetDef
    extends AntlibDefinition
    implements TaskContainer
    + + +

    +The preset definition task generates a new definition + based on a current definition with some attributes or + elements preset. + 

    + <presetdef name="my.javac">
+   <javac deprecation="${deprecation}" debug="${debug}"/>
+ </presetdef>
+ <my.javac srcdir="src" destdir="classes"/>
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classPreSetDef.PreSetDefinition + +
    +          This class contains the unknown element and the object + that is predefined.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    PreSetDef() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          Add a nested task to predefine attributes and elements on.
    + voidexecute() + +
    +          Make a new definition.
    + voidsetName(java.lang.String name) + +
    +          Set the name of this definition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PreSetDef

    +
    +public PreSetDef()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of this definition. +

    +

    +
    +
    +
    +
    Parameters:
    name - the name of the definition.
    +
    +
    +
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add a nested task to predefine attributes and elements on. +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - Nested task/type to extend.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Make a new definition. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ProjectHelperTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ProjectHelperTask.html new file mode 100644 index 000000000..edb8259fc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ProjectHelperTask.html @@ -0,0 +1,337 @@ + + + + + + +ProjectHelperTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ProjectHelperTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ProjectHelperTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ProjectHelperTask
    extends Task
    + + +

    +Task to install project helper into Ant's runtime +

    + +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ProjectHelperTask() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ProjectHelper projectHelper) + +
    +           
    + voidexecute() + +
    +          Called by the project to let the task do its work.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ProjectHelperTask

    +
    +public ProjectHelperTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addConfigured

    +
    +public void addConfigured(ProjectHelper projectHelper)
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Description copied from class: Task
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Property.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Property.html new file mode 100644 index 000000000..c973cf049 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Property.html @@ -0,0 +1,1421 @@ + + + + + + +Property (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Property

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Property
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Property
    extends Task
    + + +

    +Sets a property by name, or set of properties (from file or + resource) in the project.

    + Properties are immutable: whoever sets a property first freezes it for the + rest of the build; they are most definitely not variable. +

    There are seven ways to set properties:

    +
      +
    • By supplying both the name and value attribute.
      • +
    • By supplying the name and nested text.
      • +
    • By supplying both the name and refid attribute.
      • +
    • By setting the file attribute with the filename of the property + file to load. This property file has the format as defined by the file used + in the class java.util.Properties.
      • +
    • By setting the url attribute with the url from which to load the + properties. This url must be directed to a file that has the format as defined + by the file used in the class java.util.Properties.
      • +
    • By setting the resource attribute with the resource name of the + property file to load. This property file has the format as defined by the + file used in the class java.util.Properties.
      • +
    • By setting the environment attribute with a prefix to use. + Properties will be defined for every environment variable by + prefixing the supplied name and a period to the name of the variable.
      • +
    +

    Although combinations of these ways are possible, only one should be used + at a time. Problems might occur with the order in which properties are set, for + instance.

    +

    The value part of the properties being set, might contain references to other + properties. These references are resolved at the time these properties are set. + This also holds for properties loaded from a property file.

    + Properties are case sensitive. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  Pathclasspath + +
    +           
    +protected  java.lang.Stringenv + +
    +           
    +protected  java.io.Filefile + +
    +           
    +protected  java.lang.Stringname + +
    +           
    +protected  java.lang.Stringprefix + +
    +           
    +protected  Referenceref + +
    +           
    +protected  java.lang.Stringresource + +
    +           
    +protected  java.net.URLurl + +
    +           
    +protected  booleanuserProperty + +
    +           
    +protected  java.lang.Stringvalue + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    + Property() + +
    +          Constructor for Property.
    +protected Property(boolean userProperty) + +
    +          Constructor for Property.
    +protected Property(boolean userProperty, + Project fallback) + +
    +          Constructor for Property.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidaddProperties(java.util.Properties props) + +
    +          iterate through a set of properties, + resolve them then assign them
    +protected  voidaddProperty(java.lang.String n, + java.lang.Object v) + +
    +          add a name value pair to the project property set
    +protected  voidaddProperty(java.lang.String n, + java.lang.String v) + +
    +          add a name value pair to the project property set
    + voidaddText(java.lang.String msg) + +
    +          Set a (multiline) property as nested text.
    + PathcreateClasspath() + +
    +          The classpath to use when looking up a resource.
    + voidexecute() + +
    +          set the property in the project to the value.
    + PathgetClasspath() + +
    +          Get the classpath used when looking up a resource.
    + java.lang.StringgetEnvironment() + +
    +          Get the environment attribute.
    + java.io.FilegetFile() + +
    +          Get the file attribute.
    + java.lang.StringgetName() + +
    +          Get the property name.
    + java.lang.StringgetPrefix() + +
    +          Get the prefix attribute.
    + booleangetPrefixValues() + +
    +          Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well.
    + ReferencegetRefid() + +
    +          Get the refid attribute.
    + java.lang.StringgetResource() + +
    +          Get the resource attribute.
    + java.net.URLgetUrl() + +
    +          Get the url attribute.
    + java.lang.StringgetValue() + +
    +          Get the property value.
    +protected  voidloadEnvironment(java.lang.String prefix) + +
    +          load the environment values
    +protected  voidloadFile(java.io.File file) + +
    +          load properties from a file
    +protected  voidloadResource(java.lang.String name) + +
    +          load properties from a resource in the current classpath
    +protected  voidloadUrl(java.net.URL url) + +
    +          load properties from a url
    + voidsetBasedir(java.io.File basedir) + +
    +          Sets 'basedir' attribute.
    + voidsetClasspath(Path classpath) + +
    +          The classpath to use when looking up a resource.
    + voidsetClasspathRef(Reference r) + +
    +          the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere
    + voidsetEnvironment(java.lang.String env) + +
    +          Prefix to use when retrieving environment variables.
    + voidsetFile(java.io.File file) + +
    +          Filename of a property file to load.
    + voidsetLocation(java.io.File location) + +
    +          Sets the property to the absolute filename of the + given file.
    + voidsetName(java.lang.String name) + +
    +          The name of the property to set.
    + voidsetPrefix(java.lang.String prefix) + +
    +          Prefix to apply to properties loaded using file + or resource.
    + voidsetPrefixValues(boolean b) + +
    +          Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well.
    + voidsetRefid(Reference ref) + +
    +          Sets a reference to an Ant datatype + declared elsewhere.
    + voidsetRelative(boolean relative) + +
    +          Sets 'relative' attribute.
    + voidsetResource(java.lang.String resource) + +
    +          The resource name of a property file to load
    + voidsetUrl(java.net.URL url) + +
    +          The url from which to load properties.
    + voidsetUserProperty(boolean userProperty) + +
    +          Deprecated. since 1.5.x. + This was never a supported feature and has been + deprecated without replacement.
    + voidsetValue(java.lang.Object value) + +
    +          Set the value of the property.
    + voidsetValue(java.lang.String value) + +
    +          Set the value of the property as a String.
    + java.lang.StringtoString() + +
    +          get the value of this property
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +name

    +
    +protected java.lang.String name
    +
    +
    +
    +
    +
    + +

    +value

    +
    +protected java.lang.String value
    +
    +
    +
    +
    +
    + +

    +file

    +
    +protected java.io.File file
    +
    +
    +
    +
    +
    + +

    +url

    +
    +protected java.net.URL url
    +
    +
    +
    +
    +
    + +

    +resource

    +
    +protected java.lang.String resource
    +
    +
    +
    +
    +
    + +

    +classpath

    +
    +protected Path classpath
    +
    +
    +
    +
    +
    + +

    +env

    +
    +protected java.lang.String env
    +
    +
    +
    +
    +
    + +

    +ref

    +
    +protected Reference ref
    +
    +
    +
    +
    +
    + +

    +prefix

    +
    +protected java.lang.String prefix
    +
    +
    +
    +
    +
    + +

    +userProperty

    +
    +protected boolean userProperty
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Property

    +
    +public Property()
    +
    +
    Constructor for Property. +

    +

    +
    + +

    +Property

    +
    +protected Property(boolean userProperty)
    +
    +
    Constructor for Property. +

    +

    +
    Parameters:
    userProperty - if true this is a user property
    Since:
    +
    Ant 1.5
    +
    +
    +
    + +

    +Property

    +
    +protected Property(boolean userProperty,
+                   Project fallback)
    +
    +
    Constructor for Property. +

    +

    +
    Parameters:
    userProperty - if true this is a user property
    fallback - a project to use to look for references if the reference is + not in the current project
    Since:
    +
    Ant 1.5
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setRelative

    +
    +public void setRelative(boolean relative)
    +
    +
    Sets 'relative' attribute. +

    +

    +
    Parameters:
    relative - new value
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File basedir)
    +
    +
    Sets 'basedir' attribute. +

    +

    +
    Parameters:
    basedir - new value
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    The name of the property to set. +

    +

    +
    Parameters:
    name - property name
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the property name. +

    +

    + +
    Returns:
    the property name
    +
    +
    +
    + +

    +setLocation

    +
    +public void setLocation(java.io.File location)
    +
    +
    Sets the property to the absolute filename of the + given file. If the value of this attribute is an absolute path, it + is left unchanged (with / and \ characters converted to the + current platforms conventions). Otherwise it is taken as a path + relative to the project's basedir and expanded. +

    +

    +
    Parameters:
    location - path to set
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.Object value)
    +
    +
    Set the value of the property. +

    +

    +
    Parameters:
    value - the value to use.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the value of the property as a String. +

    +

    +
    Parameters:
    value - value to assign
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String msg)
    +
    +
    Set a (multiline) property as nested text. +

    +

    +
    Parameters:
    msg - the text to append to the output text
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the property value. +

    +

    + +
    Returns:
    the property value
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Filename of a property file to load. +

    +

    +
    Parameters:
    file - filename
    +
    +
    +
    + +

    +getFile

    +
    +public java.io.File getFile()
    +
    +
    Get the file attribute. +

    +

    + +
    Returns:
    the file attribute
    +
    +
    +
    + +

    +setUrl

    +
    +public void setUrl(java.net.URL url)
    +
    +
    The url from which to load properties. +

    +

    +
    Parameters:
    url - url string
    +
    +
    +
    + +

    +getUrl

    +
    +public java.net.URL getUrl()
    +
    +
    Get the url attribute. +

    +

    + +
    Returns:
    the url attribute
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    Prefix to apply to properties loaded using file + or resource. + A "." is appended to the prefix if not specified. +

    +

    +
    Parameters:
    prefix - prefix string
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getPrefix

    +
    +public java.lang.String getPrefix()
    +
    +
    Get the prefix attribute. +

    +

    + +
    Returns:
    the prefix attribute
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setPrefixValues

    +
    +public void setPrefixValues(boolean b)
    +
    +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +getPrefixValues

    +
    +public boolean getPrefixValues()
    +
    +
    Whether to apply the prefix when expanding properties on the + right hand side of a properties file as well. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +setRefid

    +
    +public void setRefid(Reference ref)
    +
    +
    Sets a reference to an Ant datatype + declared elsewhere. + Only yields reasonable results for references + PATH like structures or properties. +

    +

    +
    Parameters:
    ref - reference
    +
    +
    +
    + +

    +getRefid

    +
    +public Reference getRefid()
    +
    +
    Get the refid attribute. +

    +

    + +
    Returns:
    the refid attribute
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String resource)
    +
    +
    The resource name of a property file to load +

    +

    +
    Parameters:
    resource - resource on classpath
    +
    +
    +
    + +

    +getResource

    +
    +public java.lang.String getResource()
    +
    +
    Get the resource attribute. +

    +

    + +
    Returns:
    the resource attribute
    +
    +
    +
    + +

    +setEnvironment

    +
    +public void setEnvironment(java.lang.String env)
    +
    +
    Prefix to use when retrieving environment variables. + Thus if you specify environment="myenv" + you will be able to access OS-specific + environment variables via property names "myenv.PATH" or + "myenv.TERM". +

    + Note that if you supply a property name with a final + "." it will not be doubled. ie environment="myenv." will still + allow access of environment variables through "myenv.PATH" and + "myenv.TERM". This functionality is currently only implemented + on select platforms. Feel free to send patches to increase the number of platforms + this functionality is supported on ;).
    + Note also that properties are case sensitive, even if the + environment variables on your operating system are not, e.g. it + will be ${env.Path} not ${env.PATH} on Windows 2000. +

    +

    +
    Parameters:
    env - prefix
    +
    +
    +
    + +

    +getEnvironment

    +
    +public java.lang.String getEnvironment()
    +
    +
    Get the environment attribute. +

    +

    + +
    Returns:
    the environment attribute
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    The classpath to use when looking up a resource. +

    +

    +
    Parameters:
    classpath - to add to any existing classpath
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    The classpath to use when looking up a resource. +

    +

    + +
    Returns:
    a path to be configured
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +

    +

    +
    Parameters:
    r - a reference to a classpath
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    Get the classpath used when looking up a resource. +

    +

    + +
    Returns:
    the classpath
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setUserProperty

    +
    +public void setUserProperty(boolean userProperty)
    +
    +
    Deprecated. since 1.5.x. + This was never a supported feature and has been + deprecated without replacement. +

    +

    +
    Parameters:
    userProperty - ignored
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    get the value of this property +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    the current value or the empty string
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    set the property in the project to the value. + if the task was give a file, resource or env attribute + here is where it is loaded +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +loadUrl

    +
    +protected void loadUrl(java.net.URL url)
+                throws BuildException
    +
    +
    load properties from a url +

    +

    +
    Parameters:
    url - url to load from +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +loadFile

    +
    +protected void loadFile(java.io.File file)
+                 throws BuildException
    +
    +
    load properties from a file +

    +

    +
    Parameters:
    file - file to load +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +loadResource

    +
    +protected void loadResource(java.lang.String name)
    +
    +
    load properties from a resource in the current classpath +

    +

    +
    Parameters:
    name - name of resource to load
    +
    +
    +
    + +

    +loadEnvironment

    +
    +protected void loadEnvironment(java.lang.String prefix)
    +
    +
    load the environment values +

    +

    +
    Parameters:
    prefix - prefix to place before them
    +
    +
    +
    + +

    +addProperties

    +
    +protected void addProperties(java.util.Properties props)
    +
    +
    iterate through a set of properties, + resolve them then assign them +

    +

    +
    Parameters:
    props - the properties to iterate over
    +
    +
    +
    + +

    +addProperty

    +
    +protected void addProperty(java.lang.String n,
+                           java.lang.String v)
    +
    +
    add a name value pair to the project property set +

    +

    +
    Parameters:
    n - name of property
    v - value to set
    +
    +
    +
    + +

    +addProperty

    +
    +protected void addProperty(java.lang.String n,
+                           java.lang.Object v)
    +
    +
    add a name value pair to the project property set +

    +

    +
    Parameters:
    n - name of property
    v - value to set
    Since:
    +
    Ant 1.8
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.DelegateElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.DelegateElement.html new file mode 100644 index 000000000..db03c011f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.DelegateElement.html @@ -0,0 +1,245 @@ + + + + + + +PropertyHelperTask.DelegateElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PropertyHelperTask.DelegateElement

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.PropertyHelperTask.DelegateElement
+
    +
    +
    Enclosing class:
    PropertyHelperTask
    +
    +
    +
    +
    public final class PropertyHelperTask.DelegateElement
    extends java.lang.Object
    + + +

    +Nested delegate for refid usage. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetRefid() + +
    +          Get the refid.
    + voidsetRefid(java.lang.String refid) + +
    +          Set the refid.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getRefid

    +
    +public java.lang.String getRefid()
    +
    +
    Get the refid. +

    +

    + +
    Returns:
    String
    +
    +
    +
    + +

    +setRefid

    +
    +public void setRefid(java.lang.String refid)
    +
    +
    Set the refid. +

    +

    +
    Parameters:
    refid - the String to set
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.html new file mode 100644 index 000000000..bb796d7e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PropertyHelperTask.html @@ -0,0 +1,397 @@ + + + + + + +PropertyHelperTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PropertyHelperTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.PropertyHelperTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class PropertyHelperTask
    extends Task
    + + +

    +This task is designed to allow the user to install a different + PropertyHelper on the current Project. This task also allows the + installation of PropertyHelper delegates on either the newly installed + or existing PropertyHelper. +

    + +

    +

    +
    Since:
    +
    Ant 1.8
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    + classPropertyHelperTask.DelegateElement + +
    +          Nested delegate for refid usage.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyHelperTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(PropertyHelper.Delegate delegate) + +
    +          Add a PropertyHelper delegate to the existing or new PropertyHelper.
    + voidaddConfigured(PropertyHelper propertyHelper) + +
    +          Add a new PropertyHelper to be set on the Project.
    + PropertyHelperTask.DelegateElementcreateDelegate() + +
    +          Add a nested <delegate refid="foo" /> element.
    + voidexecute() + +
    +          Execute the task.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyHelperTask

    +
    +public PropertyHelperTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addConfigured

    +
    +public void addConfigured(PropertyHelper propertyHelper)
    +
    +
    Add a new PropertyHelper to be set on the Project. +

    +

    +
    Parameters:
    propertyHelper - the PropertyHelper to set.
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(PropertyHelper.Delegate delegate)
    +
    +
    Add a PropertyHelper delegate to the existing or new PropertyHelper. +

    +

    +
    Parameters:
    delegate - the delegate to add.
    +
    +
    +
    + +

    +createDelegate

    +
    +public PropertyHelperTask.DelegateElement createDelegate()
    +
    +
    Add a nested <delegate refid="foo" /> element. +

    +

    + +
    Returns:
    DelegateElement
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.ThreadWithPumper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.ThreadWithPumper.html new file mode 100644 index 000000000..5477c4e45 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.ThreadWithPumper.html @@ -0,0 +1,308 @@ + + + + + + +PumpStreamHandler.ThreadWithPumper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PumpStreamHandler.ThreadWithPumper

    +
    +java.lang.Object
+  extended by java.lang.Thread
+      extended by org.apache.tools.ant.taskdefs.PumpStreamHandler.ThreadWithPumper
+
    +
    +
    All Implemented Interfaces:
    java.lang.Runnable
    +
    +
    +
    Enclosing class:
    PumpStreamHandler
    +
    +
    +
    +
    protected static class PumpStreamHandler.ThreadWithPumper
    extends java.lang.Thread
    + + +

    +Specialized subclass that allows access to the running StreamPumper. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class java.lang.Thread
    java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class java.lang.Thread
    MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
    +  + + + + + + + + + + +
    +Constructor Summary
    PumpStreamHandler.ThreadWithPumper(StreamPumper p) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    +protected  StreamPumpergetPumper() + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Thread
    activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PumpStreamHandler.ThreadWithPumper

    +
    +public PumpStreamHandler.ThreadWithPumper(StreamPumper p)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getPumper

    +
    +protected StreamPumper getPumper()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.html new file mode 100644 index 000000000..5d378b8d3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/PumpStreamHandler.html @@ -0,0 +1,703 @@ + + + + + + +PumpStreamHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class PumpStreamHandler

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.PumpStreamHandler
+
    +
    +
    All Implemented Interfaces:
    ExecuteStreamHandler
    +
    +
    +
    Direct Known Subclasses:
    JUnitTask.JUnitLogStreamHandler, LogStreamHandler
    +
    +
    +
    +
    public class PumpStreamHandler
    extends java.lang.Object
    implements ExecuteStreamHandler
    + + +

    +Copies standard output and error of subprocesses to standard output and + error of the parent process. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +protected static classPumpStreamHandler.ThreadWithPumper + +
    +          Specialized subclass that allows access to the running StreamPumper.
    +  + + + + + + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    PumpStreamHandler() + +
    +          Construct a new PumpStreamHandler.
    PumpStreamHandler(java.io.OutputStream outAndErr) + +
    +          Construct a new PumpStreamHandler.
    PumpStreamHandler(java.io.OutputStream out, + java.io.OutputStream err) + +
    +          Construct a new PumpStreamHandler.
    PumpStreamHandler(java.io.OutputStream out, + java.io.OutputStream err, + java.io.InputStream input) + +
    +          Construct a new PumpStreamHandler.
    PumpStreamHandler(java.io.OutputStream out, + java.io.OutputStream err, + java.io.InputStream input, + boolean nonBlockingRead) + +
    +          Construct a new PumpStreamHandler.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidcreateProcessErrorPump(java.io.InputStream is, + java.io.OutputStream os) + +
    +          Create the pump to handle error output.
    +protected  voidcreateProcessOutputPump(java.io.InputStream is, + java.io.OutputStream os) + +
    +          Create the pump to handle process output.
    +protected  java.lang.ThreadcreatePump(java.io.InputStream is, + java.io.OutputStream os) + +
    +          Creates a stream pumper to copy the given input stream to the + given output stream.
    +protected  java.lang.ThreadcreatePump(java.io.InputStream is, + java.io.OutputStream os, + boolean closeWhenExhausted) + +
    +          Creates a stream pumper to copy the given input stream to the + given output stream.
    +protected  java.lang.ThreadcreatePump(java.io.InputStream is, + java.io.OutputStream os, + boolean closeWhenExhausted, + boolean nonBlockingIO) + +
    +          Creates a stream pumper to copy the given input stream to the + given output stream.
    +protected  voidfinish(java.lang.Thread t) + +
    +          Waits for a thread to finish while trying to make it finish + quicker by stopping the pumper (if the thread is a ThreadWithPumper instance) or interrupting + the thread.
    +protected  java.io.OutputStreamgetErr() + +
    +          Get the error stream.
    +protected  java.io.OutputStreamgetOut() + +
    +          Get the output stream.
    + voidsetProcessErrorStream(java.io.InputStream is) + +
    +          Set the InputStream from which to read the + standard error of the process.
    + voidsetProcessInputStream(java.io.OutputStream os) + +
    +          Set the OutputStream by means of which + input can be sent to the process.
    + voidsetProcessOutputStream(java.io.InputStream is) + +
    +          Set the InputStream from which to read the + standard output of the process.
    + voidstart() + +
    +          Start the Threads.
    + voidstop() + +
    +          Stop pumping the streams.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PumpStreamHandler

    +
    +public PumpStreamHandler(java.io.OutputStream out,
+                         java.io.OutputStream err,
+                         java.io.InputStream input,
+                         boolean nonBlockingRead)
    +
    +
    Construct a new PumpStreamHandler. +

    +

    +
    Parameters:
    out - the output OutputStream.
    err - the error OutputStream.
    input - the input InputStream.
    nonBlockingRead - set it to true if the input should be + read with simulated non blocking IO.
    +
    +
    + +

    +PumpStreamHandler

    +
    +public PumpStreamHandler(java.io.OutputStream out,
+                         java.io.OutputStream err,
+                         java.io.InputStream input)
    +
    +
    Construct a new PumpStreamHandler. +

    +

    +
    Parameters:
    out - the output OutputStream.
    err - the error OutputStream.
    input - the input InputStream.
    +
    +
    + +

    +PumpStreamHandler

    +
    +public PumpStreamHandler(java.io.OutputStream out,
+                         java.io.OutputStream err)
    +
    +
    Construct a new PumpStreamHandler. +

    +

    +
    Parameters:
    out - the output OutputStream.
    err - the error OutputStream.
    +
    +
    + +

    +PumpStreamHandler

    +
    +public PumpStreamHandler(java.io.OutputStream outAndErr)
    +
    +
    Construct a new PumpStreamHandler. +

    +

    +
    Parameters:
    outAndErr - the output/error OutputStream.
    +
    +
    + +

    +PumpStreamHandler

    +
    +public PumpStreamHandler()
    +
    +
    Construct a new PumpStreamHandler. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setProcessOutputStream

    +
    +public void setProcessOutputStream(java.io.InputStream is)
    +
    +
    Set the InputStream from which to read the + standard output of the process. +

    +

    +
    Specified by:
    setProcessOutputStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    is - the InputStream.
    +
    +
    +
    + +

    +setProcessErrorStream

    +
    +public void setProcessErrorStream(java.io.InputStream is)
    +
    +
    Set the InputStream from which to read the + standard error of the process. +

    +

    +
    Specified by:
    setProcessErrorStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    is - the InputStream.
    +
    +
    +
    + +

    +setProcessInputStream

    +
    +public void setProcessInputStream(java.io.OutputStream os)
    +
    +
    Set the OutputStream by means of which + input can be sent to the process. +

    +

    +
    Specified by:
    setProcessInputStream in interface ExecuteStreamHandler
    +
    +
    +
    Parameters:
    os - the OutputStream.
    +
    +
    +
    + +

    +start

    +
    +public void start()
    +
    +
    Start the Threads. +

    +

    +
    Specified by:
    start in interface ExecuteStreamHandler
    +
    +
    +
    +
    +
    +
    + +

    +stop

    +
    +public void stop()
    +
    +
    Stop pumping the streams. +

    +

    +
    Specified by:
    stop in interface ExecuteStreamHandler
    +
    +
    +
    +
    +
    +
    + +

    +finish

    +
    +protected final void finish(java.lang.Thread t)
    +
    +
    Waits for a thread to finish while trying to make it finish + quicker by stopping the pumper (if the thread is a ThreadWithPumper instance) or interrupting + the thread. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getErr

    +
    +protected java.io.OutputStream getErr()
    +
    +
    Get the error stream. +

    +

    +
    +
    +
    + +
    Returns:
    OutputStream.
    +
    +
    +
    + +

    +getOut

    +
    +protected java.io.OutputStream getOut()
    +
    +
    Get the output stream. +

    +

    +
    +
    +
    + +
    Returns:
    OutputStream.
    +
    +
    +
    + +

    +createProcessOutputPump

    +
    +protected void createProcessOutputPump(java.io.InputStream is,
+                                       java.io.OutputStream os)
    +
    +
    Create the pump to handle process output. +

    +

    +
    +
    +
    +
    Parameters:
    is - the InputStream.
    os - the OutputStream.
    +
    +
    +
    + +

    +createProcessErrorPump

    +
    +protected void createProcessErrorPump(java.io.InputStream is,
+                                      java.io.OutputStream os)
    +
    +
    Create the pump to handle error output. +

    +

    +
    +
    +
    +
    Parameters:
    is - the input stream to copy from.
    os - the output stream to copy to.
    +
    +
    +
    + +

    +createPump

    +
    +protected java.lang.Thread createPump(java.io.InputStream is,
+                                      java.io.OutputStream os)
    +
    +
    Creates a stream pumper to copy the given input stream to the + given output stream. +

    +

    +
    +
    +
    +
    Parameters:
    is - the input stream to copy from.
    os - the output stream to copy to. +
    Returns:
    a thread object that does the pumping.
    +
    +
    +
    + +

    +createPump

    +
    +protected java.lang.Thread createPump(java.io.InputStream is,
+                                      java.io.OutputStream os,
+                                      boolean closeWhenExhausted)
    +
    +
    Creates a stream pumper to copy the given input stream to the + given output stream. +

    +

    +
    +
    +
    +
    Parameters:
    is - the input stream to copy from.
    os - the output stream to copy to.
    closeWhenExhausted - if true close the inputstream. +
    Returns:
    a thread object that does the pumping, subclasses + should return an instance of ThreadWithPumper.
    +
    +
    +
    + +

    +createPump

    +
    +protected java.lang.Thread createPump(java.io.InputStream is,
+                                      java.io.OutputStream os,
+                                      boolean closeWhenExhausted,
+                                      boolean nonBlockingIO)
    +
    +
    Creates a stream pumper to copy the given input stream to the + given output stream. +

    +

    +
    +
    +
    +
    Parameters:
    is - the input stream to copy from.
    os - the output stream to copy to.
    closeWhenExhausted - if true close the inputstream.
    nonBlockingIO - set it to true to use simulated non + blocking IO. +
    Returns:
    a thread object that does the pumping, subclasses + should return an instance of ThreadWithPumper.
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.ActionChoices.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.ActionChoices.html new file mode 100644 index 000000000..32c28d89f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.ActionChoices.html @@ -0,0 +1,291 @@ + + + + + + +Recorder.ActionChoices (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Recorder.ActionChoices

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Recorder.ActionChoices
+
    +
    +
    Enclosing class:
    Recorder
    +
    +
    +
    +
    public static class Recorder.ActionChoices
    extends EnumeratedAttribute
    + + +

    +A list of possible values for the setAction() method. + Possible values include: start and stop. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Recorder.ActionChoices() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Recorder.ActionChoices

    +
    +public Recorder.ActionChoices()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.VerbosityLevelChoices.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.VerbosityLevelChoices.html new file mode 100644 index 000000000..c72b4291c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.VerbosityLevelChoices.html @@ -0,0 +1,274 @@ + + + + + + +Recorder.VerbosityLevelChoices (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Recorder.VerbosityLevelChoices

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.LogLevel
+          extended by org.apache.tools.ant.taskdefs.Recorder.VerbosityLevelChoices
+
    +
    +
    Enclosing class:
    Recorder
    +
    +
    +
    +
    public static class Recorder.VerbosityLevelChoices
    extends LogLevel
    + + +

    +A list of possible values for the setLoglevel() method. + Possible values include: error, warn, info, verbose, debug. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.LogLevel
    DEBUG, ERR, INFO, VERBOSE, WARN
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Recorder.VerbosityLevelChoices() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.LogLevel
    getLevel, getValues
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Recorder.VerbosityLevelChoices

    +
    +public Recorder.VerbosityLevelChoices()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.html new file mode 100644 index 000000000..427b97311 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Recorder.html @@ -0,0 +1,768 @@ + + + + + + +Recorder (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Recorder

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Recorder
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, java.util.EventListener, BuildListener, SubBuildListener
    +
    +
    +
    +
    public class Recorder
    extends Task
    implements SubBuildListener
    + + +

    +Adds a listener to the current build process that records the + output to a file. +

    Several recorders can exist at the same time. Each recorder is + associated with a file. The filename is used as a unique identifier for + the recorders. The first call to the recorder task with an unused filename + will create a recorder (using the parameters provided) and add it to the + listeners of the build. All subsequent calls to the recorder task using + this filename will modify that recorders state (recording or not) or other + properties (like logging level).

    +

    Some technical issues: the file's print stream is flushed for "finished" + events (buildFinished, targetFinished and taskFinished), and is closed on + a buildFinished event.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    Version:
    +
    0.5
    +
    See Also:
    RecorderEntry
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classRecorder.ActionChoices + +
    +          A list of possible values for the setAction() method.
    +static classRecorder.VerbosityLevelChoices + +
    +          A list of possible values for the setLoglevel() method.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Recorder() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Cleans recorder registry.
    + voidbuildStarted(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidexecute() + +
    +          The main execution.
    +protected  RecorderEntrygetRecorder(java.lang.String name, + Project proj) + +
    +          Gets the recorder that's associated with the passed in name.
    + voidinit() + +
    +          Overridden so we can add the task as build listener.
    + voidmessageLogged(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidsetAction(Recorder.ActionChoices action) + +
    +          Sets the action for the associated recorder entry.
    + voidsetAppend(boolean append) + +
    +          Whether or not the logger should append to a previous file.
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Set emacs mode.
    + voidsetLoglevel(Recorder.VerbosityLevelChoices level) + +
    +          Sets the level to which this recorder entry should log to.
    + voidsetName(java.lang.String fname) + +
    +          Sets the name of the file to log to, and the name of the recorder + entry.
    + voidsubBuildFinished(BuildEvent event) + +
    +          Cleans recorder registry, if this is the subbuild the task has + been created in.
    + voidsubBuildStarted(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidtargetFinished(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidtargetStarted(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidtaskFinished(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    + voidtaskStarted(BuildEvent event) + +
    +          Empty implementation required by SubBuildListener interface.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Recorder

    +
    +public Recorder()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +init

    +
    +public void init()
    +
    +
    Overridden so we can add the task as build listener. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    +
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String fname)
    +
    +
    Sets the name of the file to log to, and the name of the recorder + entry. +

    +

    +
    +
    +
    +
    Parameters:
    fname - File name of logfile.
    +
    +
    +
    + +

    +setAction

    +
    +public void setAction(Recorder.ActionChoices action)
    +
    +
    Sets the action for the associated recorder entry. +

    +

    +
    +
    +
    +
    Parameters:
    action - The action for the entry to take: start or stop.
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    Whether or not the logger should append to a previous file. +

    +

    +
    +
    +
    +
    Parameters:
    append - if true, append to a previous file.
    +
    +
    +
    + +

    +setEmacsMode

    +
    +public void setEmacsMode(boolean emacsMode)
    +
    +
    Set emacs mode. +

    +

    +
    +
    +
    +
    Parameters:
    emacsMode - if true use emacs mode
    +
    +
    +
    + +

    +setLoglevel

    +
    +public void setLoglevel(Recorder.VerbosityLevelChoices level)
    +
    +
    Sets the level to which this recorder entry should log to. +

    +

    +
    +
    +
    +
    Parameters:
    level - the level to set.
    See Also:
    Recorder.VerbosityLevelChoices
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    The main execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getRecorder

    +
    +protected RecorderEntry getRecorder(java.lang.String name,
+                                    Project proj)
+                             throws BuildException
    +
    +
    Gets the recorder that's associated with the passed in name. If the + recorder doesn't exist, then a new one is created. +

    +

    +
    +
    +
    +
    Parameters:
    name - the name of the recoder
    proj - the current project +
    Returns:
    a recorder +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +subBuildStarted

    +
    +public void subBuildStarted(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    subBuildStarted in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Empty implementation required by SubBuildListener interface. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Cleans recorder registry. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +subBuildFinished

    +
    +public void subBuildFinished(BuildEvent event)
    +
    +
    Cleans recorder registry, if this is the subbuild the task has + been created in. +

    +

    +
    Specified by:
    subBuildFinished in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - ignored.
    Since:
    +
    Ant 1.7
    +
    See Also:
    BuildEvent.getException()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/RecorderEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/RecorderEntry.html new file mode 100644 index 000000000..873bdc18a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/RecorderEntry.html @@ -0,0 +1,716 @@ + + + + + + +RecorderEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class RecorderEntry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.RecorderEntry
+
    +
    +
    All Implemented Interfaces:
    java.util.EventListener, BuildListener, BuildLogger, SubBuildListener
    +
    +
    +
    +
    public class RecorderEntry
    extends java.lang.Object
    implements BuildLogger, SubBuildListener
    + + +

    +This is a class that represents a recorder. This is the listener to the + build process. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + + +
    +Constructor Summary
    +protected RecorderEntry(java.lang.String name) + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidbuildFinished(BuildEvent event) + +
    +          Signals that the last target has finished..
    + voidbuildStarted(BuildEvent event) + +
    +          Signals that a build has started..
    + voidcleanup() + +
    +           
    + java.lang.StringgetFilename() + +
    +           
    + ProjectgetProject() + +
    +          Get the project associated with this recorder entry.
    + voidmessageLogged(BuildEvent event) + +
    +          Signals a message logging event..
    + voidsetEmacsMode(boolean emacsMode) + +
    +          Sets this logger to produce emacs (and other editor) friendly output..
    + voidsetErrorPrintStream(java.io.PrintStream err) + +
    +          Sets the output stream to which this logger is to send error messages..
    + voidsetMessageOutputLevel(int level) + +
    +          Sets the highest level of message this logger should respond to..
    + voidsetOutputPrintStream(java.io.PrintStream output) + +
    +          Sets the output stream to which this logger is to send its output..
    + voidsetProject(Project project) + +
    +          Set the project associated with this recorder entry.
    + voidsetRecordState(java.lang.Boolean state) + +
    +          Turns off or on this recorder.
    + voidsubBuildFinished(BuildEvent event) + +
    +          Cleans up any resources held by this recorder entry at the end + of a subbuild if it has been created for the subbuild's project + instance.
    + voidsubBuildStarted(BuildEvent event) + +
    +          Empty implementation to satisfy the BuildListener interface.
    + voidtargetFinished(BuildEvent event) + +
    +          Signals that a target has finished..
    + voidtargetStarted(BuildEvent event) + +
    +          Signals that a target is starting..
    + voidtaskFinished(BuildEvent event) + +
    +          Signals that a task has finished..
    + voidtaskStarted(BuildEvent event) + +
    +          Signals that a task is starting..
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +RecorderEntry

    +
    +protected RecorderEntry(java.lang.String name)
    +
    +
    +
    Parameters:
    name - The name of this recorder (used as the filename).
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getFilename

    +
    +public java.lang.String getFilename()
    +
    +
    +
    +
    +
    + +
    Returns:
    the name of the file the output is sent to.
    +
    +
    +
    + +

    +setRecordState

    +
    +public void setRecordState(java.lang.Boolean state)
    +
    +
    Turns off or on this recorder. +

    +

    +
    +
    +
    +
    Parameters:
    state - true for on, false for off, null for no change.
    +
    +
    +
    + +

    +buildStarted

    +
    +public void buildStarted(BuildEvent event)
    +
    +
    Signals that a build has started. This event + is fired before any targets have started. + +

    This event is fired before the project instance is fully + configured. In particular no properties have been set and the + project may not know its name or default target, yet.

    . +

    +

    +
    Specified by:
    buildStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    +
    +
    +
    + +

    +buildFinished

    +
    +public void buildFinished(BuildEvent event)
    +
    +
    Signals that the last target has finished. This event + will still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    buildFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +subBuildFinished

    +
    +public void subBuildFinished(BuildEvent event)
    +
    +
    Cleans up any resources held by this recorder entry at the end + of a subbuild if it has been created for the subbuild's project + instance. +

    +

    +
    Specified by:
    subBuildFinished in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - the buildFinished event
    Since:
    +
    Ant 1.6.2
    +
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +subBuildStarted

    +
    +public void subBuildStarted(BuildEvent event)
    +
    +
    Empty implementation to satisfy the BuildListener interface. +

    +

    +
    Specified by:
    subBuildStarted in interface SubBuildListener
    +
    +
    +
    Parameters:
    event - the buildStarted event
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +targetStarted

    +
    +public void targetStarted(BuildEvent event)
    +
    +
    Signals that a target is starting.. +

    +

    +
    Specified by:
    targetStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTarget()
    +
    +
    +
    + +

    +targetFinished

    +
    +public void targetFinished(BuildEvent event)
    +
    +
    Signals that a target has finished. This event will + still be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    targetFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +taskStarted

    +
    +public void taskStarted(BuildEvent event)
    +
    +
    Signals that a task is starting.. +

    +

    +
    Specified by:
    taskStarted in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getTask()
    +
    +
    +
    + +

    +taskFinished

    +
    +public void taskFinished(BuildEvent event)
    +
    +
    Signals that a task has finished. This event will still + be fired if an error occurred during the build.. +

    +

    +
    Specified by:
    taskFinished in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getException()
    +
    +
    +
    + +

    +messageLogged

    +
    +public void messageLogged(BuildEvent event)
    +
    +
    Signals a message logging event.. +

    +

    +
    Specified by:
    messageLogged in interface BuildListener
    +
    +
    +
    Parameters:
    event - An event with any relevant extra information. + Must not be null.
    See Also:
    BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
    +
    +
    +
    + +

    +setMessageOutputLevel

    +
    +public void setMessageOutputLevel(int level)
    +
    +
    Sets the highest level of message this logger should respond to. + + Only messages with a message level lower than or equal to the + given level should be written to the log. +

    + Constants for the message levels are in the + Project class. The order of the levels, from least + to most verbose, is MSG_ERR, MSG_WARN, + MSG_INFO, MSG_VERBOSE, + MSG_DEBUG.. +

    +

    +
    Specified by:
    setMessageOutputLevel in interface BuildLogger
    +
    +
    +
    Parameters:
    level - the logging level for the logger.
    +
    +
    +
    + +

    +setOutputPrintStream

    +
    +public void setOutputPrintStream(java.io.PrintStream output)
    +
    +
    Sets the output stream to which this logger is to send its output.. +

    +

    +
    Specified by:
    setOutputPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    output - The output stream for the logger. + Must not be null.
    +
    +
    +
    + +

    +setEmacsMode

    +
    +public void setEmacsMode(boolean emacsMode)
    +
    +
    Sets this logger to produce emacs (and other editor) friendly output.. +

    +

    +
    Specified by:
    setEmacsMode in interface BuildLogger
    +
    +
    +
    Parameters:
    emacsMode - true if output is to be unadorned so that + emacs and other editors can parse files names, etc.
    +
    +
    +
    + +

    +setErrorPrintStream

    +
    +public void setErrorPrintStream(java.io.PrintStream err)
    +
    +
    Sets the output stream to which this logger is to send error messages.. +

    +

    +
    Specified by:
    setErrorPrintStream in interface BuildLogger
    +
    +
    +
    Parameters:
    err - The error stream for the logger. + Must not be null.
    +
    +
    +
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set the project associated with this recorder entry. +

    +

    +
    +
    +
    +
    Parameters:
    project - the project instance
    Since:
    +
    1.6.2
    +
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get the project associated with this recorder entry. +

    +

    +
    +
    +
    +
    Since:
    +
    1.8.0
    +
    +
    +
    +
    + +

    +cleanup

    +
    +public void cleanup()
    +
    +
    +
    +
    +
    +
    Since:
    +
    1.6.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Redirector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Redirector.html new file mode 100644 index 000000000..600026d06 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Redirector.html @@ -0,0 +1,1004 @@ + + + + + + +Redirector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Redirector

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Redirector
+
    +
    +
    +
    public class Redirector
    extends java.lang.Object
    + + +

    +The Redirector class manages the setup and connection of input and output + redirection for an Ant project component. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    Redirector(ProjectComponent managingTask) + +
    +          Create a redirector instance for the given task
    Redirector(Task managingTask) + +
    +          Create a redirector instance for the given task
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcomplete() + +
    +          Complete redirection.
    + ExecuteStreamHandlercreateHandler() + +
    +          Create the StreamHandler to use with our Execute instance.
    + voidcreateStreams() + +
    +          Create the input, error and output streams based on the configuration + options.
    + java.io.OutputStreamgetErrorStream() + +
    +          Get the error stream for the redirector
    + java.io.InputStreamgetInputStream() + +
    +          Get the input stream for the redirector
    + java.io.OutputStreamgetOutputStream() + +
    +          Get the output stream for the redirector
    +protected  voidhandleErrorFlush(java.lang.String output) + +
    +          Handle a flush operation on the error stream
    +protected  voidhandleErrorOutput(java.lang.String output) + +
    +          Process error output
    +protected  voidhandleFlush(java.lang.String output) + +
    +          Process data due to a flush operation.
    +protected  inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Handle an input request
    +protected  voidhandleOutput(java.lang.String output) + +
    +          Pass output sent to System.out to specified output.
    + voidsetAlwaysLog(boolean alwaysLog) + +
    +          If true, (error and non-error) output will be "teed", redirected as + specified while being sent to Ant's logging mechanism as if no + redirection had taken place.
    + voidsetAppend(boolean append) + +
    +          Whether output should be appended to or overwrite an existing file.
    + voidsetAppendProperties(boolean appendProperties) + +
    +          This Redirector's subordinate + PropertyOutputStreams will not set their respective + properties while (appendProperties && append).
    + voidsetCreateEmptyFiles(boolean createEmptyFiles) + +
    +          Whether output and error files should be created even when empty.
    + voidsetError(java.io.File error) + +
    +          Set the file to which standard error is to be redirected.
    + voidsetError(java.io.File[] error) + +
    +          Set the files to which standard error is to be redirected.
    + voidsetErrorEncoding(java.lang.String errorEncoding) + +
    +          Set the error encoding.
    + voidsetErrorFilterChains(java.util.Vector errorFilterChains) + +
    +          Set the error FilterChains.
    + voidsetErrorProperty(java.lang.String errorProperty) + +
    +          Property name whose value should be set to the error of the process.
    + voidsetInput(java.io.File input) + +
    +          Set the input to use for the task
    + voidsetInput(java.io.File[] input) + +
    +          Set the input to use for the task
    + voidsetInputEncoding(java.lang.String inputEncoding) + +
    +          Set the input encoding.
    + voidsetInputFilterChains(java.util.Vector inputFilterChains) + +
    +          Set the input FilterChains.
    + voidsetInputString(java.lang.String inputString) + +
    +          Set the string to use as input
    + voidsetLogError(boolean logError) + +
    +          Controls whether error output of exec is logged.
    + voidsetLogInputString(boolean logInputString) + +
    +          Set whether to include the value of the input string in log messages.
    + voidsetOutput(java.io.File out) + +
    +          File the output of the process is redirected to.
    + voidsetOutput(java.io.File[] out) + +
    +          Files the output of the process is redirected to.
    + voidsetOutputEncoding(java.lang.String outputEncoding) + +
    +          Set the output encoding.
    + voidsetOutputFilterChains(java.util.Vector outputFilterChains) + +
    +          Set the output FilterChains.
    + voidsetOutputProperty(java.lang.String outputProperty) + +
    +          Property name whose value should be set to the output of the process.
    + voidsetProperties() + +
    +          Notify the Redirector that it is now okay to set any output + and/or error properties.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Redirector

    +
    +public Redirector(Task managingTask)
    +
    +
    Create a redirector instance for the given task +

    +

    +
    Parameters:
    managingTask - the task for which the redirector is to work
    +
    +
    + +

    +Redirector

    +
    +public Redirector(ProjectComponent managingTask)
    +
    +
    Create a redirector instance for the given task +

    +

    +
    Parameters:
    managingTask - the project component for which the redirector is to work
    Since:
    +
    Ant 1.6.3
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setInput

    +
    +public void setInput(java.io.File input)
    +
    +
    Set the input to use for the task +

    +

    +
    Parameters:
    input - the file from which input is read.
    +
    +
    +
    + +

    +setInput

    +
    +public void setInput(java.io.File[] input)
    +
    +
    Set the input to use for the task +

    +

    +
    Parameters:
    input - the files from which input is read.
    +
    +
    +
    + +

    +setInputString

    +
    +public void setInputString(java.lang.String inputString)
    +
    +
    Set the string to use as input +

    +

    +
    Parameters:
    inputString - the string which is used as the input source
    +
    +
    +
    + +

    +setLogInputString

    +
    +public void setLogInputString(boolean logInputString)
    +
    +
    Set whether to include the value of the input string in log messages. + Defaults to true. +

    +

    +
    Parameters:
    logInputString - true or false.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File out)
    +
    +
    File the output of the process is redirected to. If error is not + redirected, it too will appear in the output +

    +

    +
    Parameters:
    out - the file to which output stream is written
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File[] out)
    +
    +
    Files the output of the process is redirected to. If error is not + redirected, it too will appear in the output +

    +

    +
    Parameters:
    out - the files to which output stream is written
    +
    +
    +
    + +

    +setOutputEncoding

    +
    +public void setOutputEncoding(java.lang.String outputEncoding)
    +
    +
    Set the output encoding. +

    +

    +
    Parameters:
    outputEncoding - String.
    +
    +
    +
    + +

    +setErrorEncoding

    +
    +public void setErrorEncoding(java.lang.String errorEncoding)
    +
    +
    Set the error encoding. +

    +

    +
    Parameters:
    errorEncoding - String.
    +
    +
    +
    + +

    +setInputEncoding

    +
    +public void setInputEncoding(java.lang.String inputEncoding)
    +
    +
    Set the input encoding. +

    +

    +
    Parameters:
    inputEncoding - String.
    +
    +
    +
    + +

    +setLogError

    +
    +public void setLogError(boolean logError)
    +
    +
    Controls whether error output of exec is logged. This is only useful when + output is being redirected and error output is desired in the Ant log +

    +

    +
    Parameters:
    logError - if true the standard error is sent to the Ant log system and + not sent to output.
    +
    +
    +
    + +

    +setAppendProperties

    +
    +public void setAppendProperties(boolean appendProperties)
    +
    +
    This Redirector's subordinate + PropertyOutputStreams will not set their respective + properties while (appendProperties && append). +

    +

    +
    Parameters:
    appendProperties - whether to append properties.
    +
    +
    +
    + +

    +setError

    +
    +public void setError(java.io.File error)
    +
    +
    Set the file to which standard error is to be redirected. +

    +

    +
    Parameters:
    error - the file to which error is to be written
    +
    +
    +
    + +

    +setError

    +
    +public void setError(java.io.File[] error)
    +
    +
    Set the files to which standard error is to be redirected. +

    +

    +
    Parameters:
    error - the file to which error is to be written
    +
    +
    +
    + +

    +setOutputProperty

    +
    +public void setOutputProperty(java.lang.String outputProperty)
    +
    +
    Property name whose value should be set to the output of the process. +

    +

    +
    Parameters:
    outputProperty - the name of the property to be set with the task's output.
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    Whether output should be appended to or overwrite an existing file. + Defaults to false. +

    +

    +
    Parameters:
    append - if true output and error streams are appended to their + respective files, if specified.
    +
    +
    +
    + +

    +setAlwaysLog

    +
    +public void setAlwaysLog(boolean alwaysLog)
    +
    +
    If true, (error and non-error) output will be "teed", redirected as + specified while being sent to Ant's logging mechanism as if no + redirection had taken place. Defaults to false. +

    +

    +
    Parameters:
    alwaysLog - boolean
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setCreateEmptyFiles

    +
    +public void setCreateEmptyFiles(boolean createEmptyFiles)
    +
    +
    Whether output and error files should be created even when empty. + Defaults to true. +

    +

    +
    Parameters:
    createEmptyFiles - boolean.
    +
    +
    +
    + +

    +setErrorProperty

    +
    +public void setErrorProperty(java.lang.String errorProperty)
    +
    +
    Property name whose value should be set to the error of the process. +

    +

    +
    Parameters:
    errorProperty - the name of the property to be set with the error output.
    +
    +
    +
    + +

    +setInputFilterChains

    +
    +public void setInputFilterChains(java.util.Vector inputFilterChains)
    +
    +
    Set the input FilterChains. +

    +

    +
    Parameters:
    inputFilterChains - Vector containing FilterChain.
    +
    +
    +
    + +

    +setOutputFilterChains

    +
    +public void setOutputFilterChains(java.util.Vector outputFilterChains)
    +
    +
    Set the output FilterChains. +

    +

    +
    Parameters:
    outputFilterChains - Vector containing FilterChain.
    +
    +
    +
    + +

    +setErrorFilterChains

    +
    +public void setErrorFilterChains(java.util.Vector errorFilterChains)
    +
    +
    Set the error FilterChains. +

    +

    +
    Parameters:
    errorFilterChains - Vector containing FilterChain.
    +
    +
    +
    + +

    +createStreams

    +
    +public void createStreams()
    +
    +
    Create the input, error and output streams based on the configuration + options. +

    +

    +
    +
    +
    +
    + +

    +createHandler

    +
    +public ExecuteStreamHandler createHandler()
+                                   throws BuildException
    +
    +
    Create the StreamHandler to use with our Execute instance. +

    +

    + +
    Returns:
    the execute stream handler to manage the input, output and error + streams. +
    Throws: +
    BuildException - if the execute stream handler cannot be created.
    +
    +
    +
    + +

    +handleOutput

    +
    +protected void handleOutput(java.lang.String output)
    +
    +
    Pass output sent to System.out to specified output. +

    +

    +
    Parameters:
    output - the data to be output
    +
    +
    +
    + +

    +handleInput

    +
    +protected int handleInput(byte[] buffer,
+                          int offset,
+                          int length)
+                   throws java.io.IOException
    +
    +
    Handle an input request +

    +

    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read +
    Returns:
    the number of bytes read +
    Throws: +
    java.io.IOException - if the data cannot be read
    +
    +
    +
    + +

    +handleFlush

    +
    +protected void handleFlush(java.lang.String output)
    +
    +
    Process data due to a flush operation. +

    +

    +
    Parameters:
    output - the data being flushed.
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +protected void handleErrorOutput(java.lang.String output)
    +
    +
    Process error output +

    +

    +
    Parameters:
    output - the error output data.
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +protected void handleErrorFlush(java.lang.String output)
    +
    +
    Handle a flush operation on the error stream +

    +

    +
    Parameters:
    output - the error information being flushed.
    +
    +
    +
    + +

    +getOutputStream

    +
    +public java.io.OutputStream getOutputStream()
    +
    +
    Get the output stream for the redirector +

    +

    + +
    Returns:
    the redirector's output stream or null if no output has been + configured
    +
    +
    +
    + +

    +getErrorStream

    +
    +public java.io.OutputStream getErrorStream()
    +
    +
    Get the error stream for the redirector +

    +

    + +
    Returns:
    the redirector's error stream or null if no output has been + configured
    +
    +
    +
    + +

    +getInputStream

    +
    +public java.io.InputStream getInputStream()
    +
    +
    Get the input stream for the redirector +

    +

    + +
    Returns:
    the redirector's input stream or null if no output has been + configured
    +
    +
    +
    + +

    +complete

    +
    +public void complete()
+              throws java.io.IOException
    +
    +
    Complete redirection. + + This operation will close any streams and create any specified property + values. +

    +

    + +
    Throws: +
    java.io.IOException - if the output properties cannot be read from their output + streams.
    +
    +
    +
    + +

    +setProperties

    +
    +public void setProperties()
    +
    +
    Notify the Redirector that it is now okay to set any output + and/or error properties. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rename.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rename.html new file mode 100644 index 000000000..91a4144b1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rename.html @@ -0,0 +1,379 @@ + + + + + + +Rename (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Rename

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Rename
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +Deprecated. The rename task is deprecated since Ant 1.2. Use move instead. +

    +

    +
    public class Rename
    extends Task
    + + +

    +Renames a file. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Rename() + +
    +          Deprecated.  
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Deprecated. Renames the file src to dest
    + voidsetDest(java.io.File dest) + +
    +          Deprecated. Sets the new name of the file.
    + voidsetReplace(java.lang.String replace) + +
    +          Deprecated. Sets whether an existing file should be replaced.
    + voidsetSrc(java.io.File src) + +
    +          Deprecated. Sets the file to be renamed.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Rename

    +
    +public Rename()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    Deprecated. 
    Sets the file to be renamed. +

    +

    +
    Parameters:
    src - the file to rename
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    Deprecated. 
    Sets the new name of the file. +

    +

    +
    Parameters:
    dest - the new name of the file.
    +
    +
    +
    + +

    +setReplace

    +
    +public void setReplace(java.lang.String replace)
    +
    +
    Deprecated. 
    Sets whether an existing file should be replaced. +

    +

    +
    Parameters:
    replace - on, if an existing file should be replaced.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Deprecated. 
    Renames the file src to dest +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - The exception is + thrown, if the rename operation fails.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.NestedString.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.NestedString.html new file mode 100644 index 000000000..ab291faeb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.NestedString.html @@ -0,0 +1,304 @@ + + + + + + +Replace.NestedString (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Replace.NestedString

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Replace.NestedString
+
    +
    +
    Enclosing class:
    Replace
    +
    +
    +
    +
    public class Replace.NestedString
    extends java.lang.Object
    + + +

    +An inline string to use as the replacement text. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Replace.NestedString() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String val) + +
    +          The text of the element.
    + java.lang.StringgetText() + +
    +           
    + voidsetExpandProperties(boolean b) + +
    +          Whether properties should be expanded in nested test.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Replace.NestedString

    +
    +public Replace.NestedString()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setExpandProperties

    +
    +public void setExpandProperties(boolean b)
    +
    +
    Whether properties should be expanded in nested test. + +

    If you use this class via its Java interface the text + you add via addText has most likely been + expanded already so you do not want to set this to + true.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String val)
    +
    +
    The text of the element. +

    +

    +
    Parameters:
    val - the string to add
    +
    +
    +
    + +

    +getText

    +
    +public java.lang.String getText()
    +
    +
    + +
    Returns:
    the text
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.Replacefilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.Replacefilter.html new file mode 100644 index 000000000..f37178ce2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.Replacefilter.html @@ -0,0 +1,464 @@ + + + + + + +Replace.Replacefilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Replace.Replacefilter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Replace.Replacefilter
+
    +
    +
    Enclosing class:
    Replace
    +
    +
    +
    +
    public class Replace.Replacefilter
    extends java.lang.Object
    + + +

    +A filter to apply. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Replace.Replacefilter() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + Replace.NestedStringcreateReplaceToken() + +
    +          Create a token to filter as the text of a nested element.
    + Replace.NestedStringcreateReplaceValue() + +
    +          Create a string to replace the token as the text of a nested element.
    + java.lang.StringgetProperty() + +
    +          Get the name of the property whose value is to serve as + the replacement value.
    + java.lang.StringgetReplaceValue() + +
    +          Get the replacement value for this filter token.
    + java.lang.StringgetToken() + +
    +          Get the string to search for.
    + java.lang.StringgetValue() + +
    +          Get replacement String.
    + voidsetProperty(java.lang.String property) + +
    +          Set the name of the property whose value is to serve as + the replacement value; required if value is not set.
    + voidsetToken(java.lang.String t) + +
    +          Set the token to replace.
    + voidsetValue(java.lang.String value) + +
    +          The replacement string; required if property + is not set.
    + voidvalidate() + +
    +          Validate the filter's configuration.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Replace.Replacefilter

    +
    +public Replace.Replacefilter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +validate

    +
    +public void validate()
+              throws BuildException
    +
    +
    Validate the filter's configuration. +

    +

    + +
    Throws: +
    BuildException - if any part is invalid.
    +
    +
    +
    + +

    +getReplaceValue

    +
    +public java.lang.String getReplaceValue()
    +
    +
    Get the replacement value for this filter token. +

    +

    + +
    Returns:
    the replacement value
    +
    +
    +
    + +

    +setToken

    +
    +public void setToken(java.lang.String t)
    +
    +
    Set the token to replace. +

    +

    +
    Parameters:
    t - String token.
    +
    +
    +
    + +

    +getToken

    +
    +public java.lang.String getToken()
    +
    +
    Get the string to search for. +

    +

    + +
    Returns:
    current String token.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    The replacement string; required if property + is not set. +

    +

    +
    Parameters:
    value - String value to replace.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get replacement String. +

    +

    + +
    Returns:
    replacement or null.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Set the name of the property whose value is to serve as + the replacement value; required if value is not set. +

    +

    +
    Parameters:
    property - property name.
    +
    +
    +
    + +

    +getProperty

    +
    +public java.lang.String getProperty()
    +
    +
    Get the name of the property whose value is to serve as + the replacement value. +

    +

    + +
    Returns:
    property or null.
    +
    +
    +
    + +

    +createReplaceToken

    +
    +public Replace.NestedString createReplaceToken()
    +
    +
    Create a token to filter as the text of a nested element. +

    +

    + +
    Returns:
    nested token NestedString to configure.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createReplaceValue

    +
    +public Replace.NestedString createReplaceValue()
    +
    +
    Create a string to replace the token as the text of a nested element. +

    +

    + +
    Returns:
    replacement value NestedString to configure.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.html new file mode 100644 index 000000000..207e50fb1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Replace.html @@ -0,0 +1,843 @@ + + + + + + +Replace (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Replace

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Replace
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Replace
    extends MatchingTask
    + + +

    +Replaces all occurrences of one or more string tokens with given + values in the indicated files. Each value can be either a string + or the value of a property available in a designated property file. + If you want to replace a text that crosses line boundaries, you + must use a nested <replacetoken> element. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    + classReplace.NestedString + +
    +          An inline string to use as the replacement text.
    + classReplace.Replacefilter + +
    +          A filter to apply.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Replace() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection rc) + +
    +          Support arbitrary file system based resource collections.
    + Replace.ReplacefiltercreateReplacefilter() + +
    +          Add a nested <replacefilter> element.
    + Replace.NestedStringcreateReplaceToken() + +
    +          Create a token to filter as the text of a nested element.
    + Replace.NestedStringcreateReplaceValue() + +
    +          Create a string to replace the token as the text of a nested element.
    + voidexecute() + +
    +          Do the execution.
    + java.util.PropertiesgetProperties(java.io.File propertyFile) + +
    +          Load a properties file.
    + java.util.PropertiesgetProperties(Resource propertyResource) + +
    +          Load a properties resource.
    + voidsetDir(java.io.File dir) + +
    +          The base directory to use when replacing a token in multiple files; + required if file is not defined.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Set the file encoding to use on the files read and written by the task; + optional, defaults to default JVM encoding.
    + voidsetFailOnNoReplacements(boolean b) + +
    +          Whether the build should fail if nothing has been replaced.
    + voidsetFile(java.io.File file) + +
    +          Set the source file; required unless dir is set.
    + voidsetPreserveLastModified(boolean b) + +
    +          Whether the file timestamp shall be preserved even if the file + is modified.
    + voidsetPropertyFile(java.io.File propertyFile) + +
    +          The name of a property file from which properties specified using nested + <replacefilter> elements are drawn; required only if + the property attribute of <replacefilter> is used.
    + voidsetPropertyResource(Resource propertyResource) + +
    +          A resource from which properties specified using nested + <replacefilter> elements are drawn; required + only if the property attribute of + <replacefilter> is used.
    + voidsetReplaceFilterFile(java.io.File replaceFilterFile) + +
    +          Sets the name of a property file containing filters; optional.
    + voidsetReplaceFilterResource(Resource replaceFilter) + +
    +          Sets the name of a resource containing filters; optional.
    + voidsetSummary(boolean summary) + +
    +          Indicates whether a summary of the replace operation should be + produced, detailing how many token occurrences and files were + processed; optional, default=false.
    + voidsetToken(java.lang.String token) + +
    +          Set the string token to replace; required unless a nested + replacetoken element or the + replacefilterresource attribute is used.
    + voidsetValue(java.lang.String value) + +
    +          Set the string value to use as token replacement; + optional, default is the empty string "".
    + voidvalidateAttributes() + +
    +          Validate attributes provided for this task in .xml build file.
    + voidvalidateReplacefilters() + +
    +          Validate nested elements.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Replace

    +
    +public Replace()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Do the execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if we cant build
    +
    +
    +
    + +

    +validateAttributes

    +
    +public void validateAttributes()
+                        throws BuildException
    +
    +
    Validate attributes provided for this task in .xml build file. +

    +

    + +
    Throws: +
    BuildException - if any supplied attribute is invalid or any + mandatory attribute is missing.
    +
    +
    +
    + +

    +validateReplacefilters

    +
    +public void validateReplacefilters()
+                            throws BuildException
    +
    +
    Validate nested elements. +

    +

    + +
    Throws: +
    BuildException - if any supplied attribute is invalid or any + mandatory attribute is missing.
    +
    +
    +
    + +

    +getProperties

    +
    +public java.util.Properties getProperties(java.io.File propertyFile)
+                                   throws BuildException
    +
    +
    Load a properties file. +

    +

    +
    Parameters:
    propertyFile - the file to load the properties from. +
    Returns:
    loaded Properties object. +
    Throws: +
    BuildException - if the file could not be found or read.
    +
    +
    +
    + +

    +getProperties

    +
    +public java.util.Properties getProperties(Resource propertyResource)
+                                   throws BuildException
    +
    +
    Load a properties resource. +

    +

    +
    Parameters:
    propertyResource - the resource to load the properties from. +
    Returns:
    loaded Properties object. +
    Throws: +
    BuildException - if the resource could not be found or read.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Set the source file; required unless dir is set. +

    +

    +
    Parameters:
    file - source File.
    +
    +
    +
    + +

    +setSummary

    +
    +public void setSummary(boolean summary)
    +
    +
    Indicates whether a summary of the replace operation should be + produced, detailing how many token occurrences and files were + processed; optional, default=false. +

    +

    +
    Parameters:
    summary - boolean whether a summary of the + replace operation should be logged.
    +
    +
    +
    + +

    +setReplaceFilterFile

    +
    +public void setReplaceFilterFile(java.io.File replaceFilterFile)
    +
    +
    Sets the name of a property file containing filters; optional. + Each property will be treated as a replacefilter where token is the name + of the property and value is the value of the property. +

    +

    +
    Parameters:
    replaceFilterFile - File to load.
    +
    +
    +
    + +

    +setReplaceFilterResource

    +
    +public void setReplaceFilterResource(Resource replaceFilter)
    +
    +
    Sets the name of a resource containing filters; optional. + Each property will be treated as a replacefilter where token is the name + of the property and value is the value of the property. +

    +

    +
    Parameters:
    replaceFilter - Resource to load.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
    +
    +
    The base directory to use when replacing a token in multiple files; + required if file is not defined. +

    +

    +
    Parameters:
    dir - File representing the base directory.
    +
    +
    +
    + +

    +setToken

    +
    +public void setToken(java.lang.String token)
    +
    +
    Set the string token to replace; required unless a nested + replacetoken element or the + replacefilterresource attribute is used. +

    +

    +
    Parameters:
    token - token String.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the string value to use as token replacement; + optional, default is the empty string "". +

    +

    +
    Parameters:
    value - replacement value.
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Set the file encoding to use on the files read and written by the task; + optional, defaults to default JVM encoding. +

    +

    +
    Parameters:
    encoding - the encoding to use on the files.
    +
    +
    +
    + +

    +createReplaceToken

    +
    +public Replace.NestedString createReplaceToken()
    +
    +
    Create a token to filter as the text of a nested element. +

    +

    + +
    Returns:
    nested token NestedString to configure.
    +
    +
    +
    + +

    +createReplaceValue

    +
    +public Replace.NestedString createReplaceValue()
    +
    +
    Create a string to replace the token as the text of a nested element. +

    +

    + +
    Returns:
    replacement value NestedString to configure.
    +
    +
    +
    + +

    +setPropertyFile

    +
    +public void setPropertyFile(java.io.File propertyFile)
    +
    +
    The name of a property file from which properties specified using nested + <replacefilter> elements are drawn; required only if + the property attribute of <replacefilter> is used. +

    +

    +
    Parameters:
    propertyFile - File to load.
    +
    +
    +
    + +

    +setPropertyResource

    +
    +public void setPropertyResource(Resource propertyResource)
    +
    +
    A resource from which properties specified using nested + <replacefilter> elements are drawn; required + only if the property attribute of + <replacefilter> is used. +

    +

    +
    Parameters:
    propertyResource - Resource to load.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createReplacefilter

    +
    +public Replace.Replacefilter createReplacefilter()
    +
    +
    Add a nested <replacefilter> element. +

    +

    + +
    Returns:
    a nested Replacefilter object to be configured.
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection rc)
    +
    +
    Support arbitrary file system based resource collections. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(boolean b)
    +
    +
    Whether the file timestamp shall be preserved even if the file + is modified. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFailOnNoReplacements

    +
    +public void setFailOnNoReplacements(boolean b)
    +
    +
    Whether the build should fail if nothing has been replaced. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ResourceCount.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ResourceCount.html new file mode 100644 index 000000000..ab468b6ce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/ResourceCount.html @@ -0,0 +1,460 @@ + + + + + + +ResourceCount (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class ResourceCount

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ResourceCount
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class ResourceCount
    extends Task
    implements Condition
    + + +

    +Count resources from a ResourceCollection, storing to a property or + writing to the log. Can also be used as a Condition. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ResourceCount() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection r) + +
    +          Add the ResourceCollection to count.
    + booleaneval() + +
    +          Fulfill the condition contract.
    + voidexecute() + +
    +          Execute as a Task.
    + voidsetCount(int c) + +
    +          Set the target count number for use as a Condition.
    + voidsetProperty(java.lang.String p) + +
    +          Set the name of the property to set in task mode.
    + voidsetRefid(Reference r) + +
    +          Set the ResourceCollection reference.
    + voidsetWhen(Comparison c) + +
    +          Set the comparison for use as a Condition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ResourceCount

    +
    +public ResourceCount()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +add

    +
    +public void add(ResourceCollection r)
    +
    +
    Add the ResourceCollection to count. +

    +

    +
    +
    +
    +
    Parameters:
    r - the ResourceCollection to count. +
    Throws: +
    BuildException - if already set.
    +
    +
    +
    + +

    +setRefid

    +
    +public void setRefid(Reference r)
    +
    +
    Set the ResourceCollection reference. +

    +

    +
    +
    +
    +
    Parameters:
    r - the Reference.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Execute as a Task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Fulfill the condition contract. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the specified ResourceCollection satisfies the set criteria. +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +setCount

    +
    +public void setCount(int c)
    +
    +
    Set the target count number for use as a Condition. +

    +

    +
    +
    +
    +
    Parameters:
    c - number of Resources as int.
    +
    +
    +
    + +

    +setWhen

    +
    +public void setWhen(Comparison c)
    +
    +
    Set the comparison for use as a Condition. +

    +

    +
    +
    +
    +
    Parameters:
    c - Comparison (an EnumeratedAttribute) When.
    See Also:
    Comparison
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String p)
    +
    +
    Set the name of the property to set in task mode. +

    +

    +
    +
    +
    +
    Parameters:
    p - the property name to set.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Retry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Retry.html new file mode 100644 index 000000000..b207915cc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Retry.html @@ -0,0 +1,361 @@ + + + + + + +Retry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Retry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Retry
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TaskContainer
    +
    +
    +
    +
    public class Retry
    extends Task
    implements TaskContainer
    + + +

    +Retries the nested task a set number of times +

    + +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Retry() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task t) + +
    +          set the task
    + voidexecute() + +
    +          perform the work
    + voidsetRetryCount(int n) + +
    +          set the number of times to retry the task
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Retry

    +
    +public Retry()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public void addTask(Task t)
    +
    +
    set the task +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    t - the task to retry.
    +
    +
    +
    + +

    +setRetryCount

    +
    +public void setRetryCount(int n)
    +
    +
    set the number of times to retry the task +

    +

    +
    +
    +
    +
    Parameters:
    n - the number to use.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    perform the work +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if there is an error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.ImplementationSpecificArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.ImplementationSpecificArgument.html new file mode 100644 index 000000000..2646dd032 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.ImplementationSpecificArgument.html @@ -0,0 +1,315 @@ + + + + + + +Rmic.ImplementationSpecificArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Rmic.ImplementationSpecificArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.Commandline.Argument
+          extended by org.apache.tools.ant.util.facade.ImplementationSpecificArgument
+              extended by org.apache.tools.ant.taskdefs.Rmic.ImplementationSpecificArgument
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Rmic
    +
    +
    +
    +
    public class Rmic.ImplementationSpecificArgument
    extends ImplementationSpecificArgument
    + + +

    +Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Rmic.ImplementationSpecificArgument() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsetCompiler(java.lang.String impl) + +
    +          Only pass the specified argument if the + chosen compiler implementation matches the + value of this attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.util.facade.ImplementationSpecificArgument
    getParts, setImplementation
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.Commandline.Argument
    getParts, setFile, setLine, setPath, setPathref, setPrefix, setSuffix, setValue
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Rmic.ImplementationSpecificArgument

    +
    +public Rmic.ImplementationSpecificArgument()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCompiler

    +
    +public void setCompiler(java.lang.String impl)
    +
    +
    Only pass the specified argument if the + chosen compiler implementation matches the + value of this attribute. Legal values are + the same as those in the above list of + valid compilers.) +

    +

    +
    Parameters:
    impl - the compiler to be used.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.html new file mode 100644 index 000000000..386e9db33 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Rmic.html @@ -0,0 +1,1753 @@ + + + + + + +Rmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Rmic

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Rmic
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Rmic
    extends MatchingTask
    + + +

    +Runs the rmic compiler against classes.

    +

    Rmic can be run on a single class (as specified with the classname + attribute) or a number of classes at once (all classes below base that + are neither _Stub nor _Skel classes). If you want to rmic a single + class and this class is a class nested into another class, you have to + specify the classname in the form Outer$$Inner instead of + Outer.Inner.

    +

    It is possible to refine the set of files that are being rmiced. This can + be done with the includes, includesfile, excludes, + excludesfile and defaultexcludes + attributes. With the includes or includesfile attribute you + specify the files you want to have included by using patterns. The + exclude or excludesfile attribute is used to specify + the files you want to have excluded. This is also done with patterns. And + finally with the defaultexcludes attribute, you can specify whether + you want to use default exclusions or not. See the section on + directory based tasks, on how the + inclusion/exclusion of files works, and how to write patterns.

    +

    This task forms an implicit FileSet and + supports all attributes of <fileset> + (dir becomes base) as well as the nested + <include>, <exclude> and + <patternset> elements.

    +

    It is possible to use different compilers. This can be selected + with the "build.rmic" property or the compiler + attribute. There are three choices:

    +
      +
    • sun (the standard compiler of the JDK)
      • +
    • kaffe (the standard compiler of + Kaffe)
      • +
    • weblogic
      • +
    + +

    The miniRMI + project contains a compiler implementation for this task as well, + please consult miniRMI's documentation to learn how to use it.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    + classRmic.ImplementationSpecificArgument + +
    +          Adds an "compiler" attribute to Commandline$Attribute used to + filter command line attributes based on the current + implementation.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_BASE_NOT_SET + +
    +          base attribute not set message
    +static java.lang.StringERROR_LOADING_CAUSED_EXCEPTION + +
    +          loaded error message
    +static java.lang.StringERROR_NO_BASE_EXISTS + +
    +          base not exists message
    +static java.lang.StringERROR_NOT_A_DIR + +
    +          base not a directory message
    +static java.lang.StringERROR_NOT_DEFINED + +
    +          not defined message
    +static java.lang.StringERROR_NOT_FOUND + +
    +          could not be found message
    +static java.lang.StringERROR_RMIC_FAILED + +
    +          rmic failed message
    +static java.lang.StringERROR_UNABLE_TO_VERIFY_CLASS + +
    +          unable to verify message
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Rmic() + +
    +          Constructor for Rmic.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(RmicAdapter adapter) + +
    +          Set the compiler adapter explicitly.
    +protected  voidcleanup() + +
    +          Cleans up resources.
    + PathcreateClasspath() + +
    +          Creates a nested classpath element.
    + Rmic.ImplementationSpecificArgumentcreateCompilerArg() + +
    +          Adds an implementation specific command line argument.
    + PathcreateCompilerClasspath() + +
    +          The classpath to use when loading the compiler implementation + if it is not a built-in one.
    + PathcreateExtdirs() + +
    +          Maybe creates a nested extdirs element.
    + voidexecute() + +
    +          execute by creating an instance of an implementation + class and getting to do the work
    + java.io.FilegetBase() + +
    +          Gets the base directory to output generated class.
    + java.lang.StringgetClassname() + +
    +          Gets the class name to compile.
    + PathgetClasspath() + +
    +          Gets the classpath.
    + java.util.VectorgetCompileList() + +
    +           
    + java.lang.StringgetCompiler() + +
    +          get the name of the current compiler
    + java.lang.String[]getCurrentCompilerArgs() + +
    +          Get the additional implementation specific command line arguments.
    + booleangetDebug() + +
    +          Gets the debug flag.
    + java.io.FilegetDestdir() + +
    +          Gets the base directory to output the generated files.
    + java.lang.StringgetExecutable() + +
    +          Explicitly specified name of the executable to use when forking + - if any.
    + PathgetExtdirs() + +
    +          Gets the extension directories that will be used during the + compilation.
    + java.util.VectorgetFileList() + +
    +          Gets file list to compile.
    + booleangetFiltering() + +
    +          Gets whether token filtering is set
    + booleangetIdl() + +
    +          Gets IDL flags.
    + java.lang.StringgetIdlopts() + +
    +          Gets additional arguments for idl compile.
    + booleangetIiop() + +
    +          Gets iiop flags.
    + java.lang.StringgetIiopopts() + +
    +          Gets additional arguments for iiop.
    + booleangetIncludeantruntime() + +
    +          Gets whether or not the ant classpath is to be included in the + task's classpath.
    + booleangetIncludejavaruntime() + +
    +          Gets whether or not the java runtime should be included in this + task's classpath.
    + java.lang.ClassLoadergetLoader() + +
    +          Classloader for the user-specified classpath.
    + java.io.FilegetOutputDir() + +
    +          Gets the base directory to output the generated files, + favoring destdir if set, otherwise defaulting to basedir.
    + java.lang.ClassgetRemoteInterface(java.lang.Class testClass) + +
    +          Returns the topmost interface that extends Remote for a given + class - if one exists.
    + java.io.FilegetSourceBase() + +
    +          Gets the source dirs to find the source java files.
    + java.lang.StringgetStubVersion() + +
    +          Gets the JDK version for the generated stub code.
    + booleangetVerify() + +
    +          Get verify flag.
    + booleanisValidRmiRemote(java.lang.String classname) + +
    +          Load named class and test whether it can be rmic'ed
    +protected  voidscanDir(java.io.File baseDir, + java.lang.String[] files, + FileNameMapper mapper) + +
    +          Scans the directory looking for class files to be compiled.
    + voidsetBase(java.io.File base) + +
    +          Sets the location to store the compiled files; required
    + voidsetClassname(java.lang.String classname) + +
    +          Sets the class to run rmic against; + optional
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used for this compilation.
    + voidsetClasspathRef(Reference pathRef) + +
    +          Adds to the classpath a reference to + a <path> defined elsewhere.
    + voidsetCompiler(java.lang.String compiler) + +
    +          Sets the compiler implementation to use; optional, + defaults to the value of the build.rmic property, + or failing that, default compiler for the current VM
    + voidsetDebug(boolean debug) + +
    +          Generate debug info (passes -g to rmic); + optional, defaults to false
    + voidsetDestdir(java.io.File destdir) + +
    +          Sets the base directory to output the generated files.
    + voidsetExecutable(java.lang.String ex) + +
    +          Name of the executable to use when forking.
    + voidsetExtdirs(Path extDirs) + +
    +          Sets the extension directories that will be used during the + compilation; optional.
    + voidsetFiltering(boolean filter) + +
    +          Sets token filtering [optional], default=false
    + voidsetIdl(boolean idl) + +
    +          Indicates that IDL output should be + generated.
    + voidsetIdlopts(java.lang.String idlOpts) + +
    +          pass additional arguments for IDL compile
    + voidsetIiop(boolean iiop) + +
    +          Indicates that IIOP compatible stubs should + be generated; optional, defaults to false + if not set.
    + voidsetIiopopts(java.lang.String iiopOpts) + +
    +          Set additional arguments for iiop
    + voidsetIncludeantruntime(boolean include) + +
    +          Sets whether or not to include ant's own classpath in this task's + classpath.
    + voidsetIncludejavaruntime(boolean include) + +
    +          task's classpath.
    + voidsetListfiles(boolean list) + +
    +          If true, list the source files being handed off to the compiler.
    + voidsetSourceBase(java.io.File sourceBase) + +
    +          optional directory to save generated source files to.
    + voidsetStubVersion(java.lang.String stubVersion) + +
    +          Specify the JDK version for the generated stub code.
    + voidsetVerify(boolean verify) + +
    +          Flag to enable verification so that the classes + found by the directory match are + checked to see if they implement java.rmi.Remote.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_RMIC_FAILED

    +
    +public static final java.lang.String ERROR_RMIC_FAILED
    +
    +
    rmic failed message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_UNABLE_TO_VERIFY_CLASS

    +
    +public static final java.lang.String ERROR_UNABLE_TO_VERIFY_CLASS
    +
    +
    unable to verify message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NOT_FOUND

    +
    +public static final java.lang.String ERROR_NOT_FOUND
    +
    +
    could not be found message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NOT_DEFINED

    +
    +public static final java.lang.String ERROR_NOT_DEFINED
    +
    +
    not defined message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_LOADING_CAUSED_EXCEPTION

    +
    +public static final java.lang.String ERROR_LOADING_CAUSED_EXCEPTION
    +
    +
    loaded error message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_BASE_EXISTS

    +
    +public static final java.lang.String ERROR_NO_BASE_EXISTS
    +
    +
    base not exists message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NOT_A_DIR

    +
    +public static final java.lang.String ERROR_NOT_A_DIR
    +
    +
    base not a directory message +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_BASE_NOT_SET

    +
    +public static final java.lang.String ERROR_BASE_NOT_SET
    +
    +
    base attribute not set message +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Rmic

    +
    +public Rmic()
    +
    +
    Constructor for Rmic. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setBase

    +
    +public void setBase(java.io.File base)
    +
    +
    Sets the location to store the compiled files; required +

    +

    +
    Parameters:
    base - the location to store the compiled files
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File destdir)
    +
    +
    Sets the base directory to output the generated files. +

    +

    +
    Parameters:
    destdir - the base directory to output the generated files.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getDestdir

    +
    +public java.io.File getDestdir()
    +
    +
    Gets the base directory to output the generated files. +

    +

    + +
    Returns:
    the base directory to output the generated files.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getOutputDir

    +
    +public java.io.File getOutputDir()
    +
    +
    Gets the base directory to output the generated files, + favoring destdir if set, otherwise defaulting to basedir. +

    +

    + +
    Returns:
    the actual directory to output to (either destdir or basedir)
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getBase

    +
    +public java.io.File getBase()
    +
    +
    Gets the base directory to output generated class. +

    +

    + +
    Returns:
    the location of the compiled files
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String classname)
    +
    +
    Sets the class to run rmic against; + optional +

    +

    +
    Parameters:
    classname - the name of the class for rmic to create code for
    +
    +
    +
    + +

    +getClassname

    +
    +public java.lang.String getClassname()
    +
    +
    Gets the class name to compile. +

    +

    + +
    Returns:
    the name of the class to compile
    +
    +
    +
    + +

    +setSourceBase

    +
    +public void setSourceBase(java.io.File sourceBase)
    +
    +
    optional directory to save generated source files to. +

    +

    +
    Parameters:
    sourceBase - the directory to save source files to.
    +
    +
    +
    + +

    +getSourceBase

    +
    +public java.io.File getSourceBase()
    +
    +
    Gets the source dirs to find the source java files. +

    +

    + +
    Returns:
    sourceBase the directory containing the source files.
    +
    +
    +
    + +

    +setStubVersion

    +
    +public void setStubVersion(java.lang.String stubVersion)
    +
    +
    Specify the JDK version for the generated stub code. + Specify "1.1" to pass the "-v1.1" option to rmic. +

    +

    +
    Parameters:
    stubVersion - the JDK version
    +
    +
    +
    + +

    +getStubVersion

    +
    +public java.lang.String getStubVersion()
    +
    +
    Gets the JDK version for the generated stub code. +

    +

    + +
    Returns:
    stubVersion
    +
    +
    +
    + +

    +setFiltering

    +
    +public void setFiltering(boolean filter)
    +
    +
    Sets token filtering [optional], default=false +

    +

    +
    Parameters:
    filter - turn on token filtering
    +
    +
    +
    + +

    +getFiltering

    +
    +public boolean getFiltering()
    +
    +
    Gets whether token filtering is set +

    +

    + +
    Returns:
    filtering
    +
    +
    +
    + +

    +setDebug

    +
    +public void setDebug(boolean debug)
    +
    +
    Generate debug info (passes -g to rmic); + optional, defaults to false +

    +

    +
    Parameters:
    debug - turn on debug info
    +
    +
    +
    + +

    +getDebug

    +
    +public boolean getDebug()
    +
    +
    Gets the debug flag. +

    +

    + +
    Returns:
    debug
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used for this compilation. +

    +

    +
    Parameters:
    classpath - the classpath used for this compilation
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Creates a nested classpath element. +

    +

    + +
    Returns:
    classpath
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference pathRef)
    +
    +
    Adds to the classpath a reference to + a <path> defined elsewhere. +

    +

    +
    Parameters:
    pathRef - the reference to add to the classpath
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    Gets the classpath. +

    +

    + +
    Returns:
    the classpath
    +
    +
    +
    + +

    +setVerify

    +
    +public void setVerify(boolean verify)
    +
    +
    Flag to enable verification so that the classes + found by the directory match are + checked to see if they implement java.rmi.Remote. + optional; This defaults to false if not set. +

    +

    +
    Parameters:
    verify - turn on verification for classes
    +
    +
    +
    + +

    +getVerify

    +
    +public boolean getVerify()
    +
    +
    Get verify flag. +

    +

    + +
    Returns:
    verify
    +
    +
    +
    + +

    +setIiop

    +
    +public void setIiop(boolean iiop)
    +
    +
    Indicates that IIOP compatible stubs should + be generated; optional, defaults to false + if not set. +

    +

    +
    Parameters:
    iiop - generate IIOP compatible stubs
    +
    +
    +
    + +

    +getIiop

    +
    +public boolean getIiop()
    +
    +
    Gets iiop flags. +

    +

    + +
    Returns:
    iiop
    +
    +
    +
    + +

    +setIiopopts

    +
    +public void setIiopopts(java.lang.String iiopOpts)
    +
    +
    Set additional arguments for iiop +

    +

    +
    Parameters:
    iiopOpts - additional arguments for iiop
    +
    +
    +
    + +

    +getIiopopts

    +
    +public java.lang.String getIiopopts()
    +
    +
    Gets additional arguments for iiop. +

    +

    + +
    Returns:
    iiopOpts
    +
    +
    +
    + +

    +setIdl

    +
    +public void setIdl(boolean idl)
    +
    +
    Indicates that IDL output should be + generated. This defaults to false + if not set. +

    +

    +
    Parameters:
    idl - generate IDL output
    +
    +
    +
    + +

    +getIdl

    +
    +public boolean getIdl()
    +
    +
    Gets IDL flags. +

    +

    + +
    Returns:
    the idl flag
    +
    +
    +
    + +

    +setIdlopts

    +
    +public void setIdlopts(java.lang.String idlOpts)
    +
    +
    pass additional arguments for IDL compile +

    +

    +
    Parameters:
    idlOpts - additional IDL arguments
    +
    +
    +
    + +

    +getIdlopts

    +
    +public java.lang.String getIdlopts()
    +
    +
    Gets additional arguments for idl compile. +

    +

    + +
    Returns:
    the idl options
    +
    +
    +
    + +

    +getFileList

    +
    +public java.util.Vector getFileList()
    +
    +
    Gets file list to compile. +

    +

    + +
    Returns:
    the list of files to compile.
    +
    +
    +
    + +

    +setIncludeantruntime

    +
    +public void setIncludeantruntime(boolean include)
    +
    +
    Sets whether or not to include ant's own classpath in this task's + classpath. + Optional; default is true. +

    +

    +
    Parameters:
    include - if true include ant's classpath
    +
    +
    +
    + +

    +getIncludeantruntime

    +
    +public boolean getIncludeantruntime()
    +
    +
    Gets whether or not the ant classpath is to be included in the + task's classpath. +

    +

    + +
    Returns:
    true if ant's classpath is to be included
    +
    +
    +
    + +

    +setIncludejavaruntime

    +
    +public void setIncludejavaruntime(boolean include)
    +
    +
    task's classpath. + Enables or disables including the default run-time + libraries from the executing VM; optional, + defaults to false +

    +

    +
    Parameters:
    include - if true include default run-time libraries
    +
    +
    +
    + +

    +getIncludejavaruntime

    +
    +public boolean getIncludejavaruntime()
    +
    +
    Gets whether or not the java runtime should be included in this + task's classpath. +

    +

    + +
    Returns:
    true if default run-time libraries are included
    +
    +
    +
    + +

    +setExtdirs

    +
    +public void setExtdirs(Path extDirs)
    +
    +
    Sets the extension directories that will be used during the + compilation; optional. +

    +

    +
    Parameters:
    extDirs - the extension directories to be used
    +
    +
    +
    + +

    +createExtdirs

    +
    +public Path createExtdirs()
    +
    +
    Maybe creates a nested extdirs element. +

    +

    + +
    Returns:
    path object to be configured with the extension directories
    +
    +
    +
    + +

    +getExtdirs

    +
    +public Path getExtdirs()
    +
    +
    Gets the extension directories that will be used during the + compilation. +

    +

    + +
    Returns:
    the extension directories to be used
    +
    +
    +
    + +

    +getCompileList

    +
    +public java.util.Vector getCompileList()
    +
    +
    + +
    Returns:
    the compile list.
    +
    +
    +
    + +

    +setCompiler

    +
    +public void setCompiler(java.lang.String compiler)
    +
    +
    Sets the compiler implementation to use; optional, + defaults to the value of the build.rmic property, + or failing that, default compiler for the current VM +

    +

    +
    Parameters:
    compiler - the compiler implemention to use
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getCompiler

    +
    +public java.lang.String getCompiler()
    +
    +
    get the name of the current compiler +

    +

    + +
    Returns:
    the name of the compiler
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +createCompilerArg

    +
    +public Rmic.ImplementationSpecificArgument createCompilerArg()
    +
    +
    Adds an implementation specific command line argument. +

    +

    + +
    Returns:
    an object to be configured with a command line argument
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getCurrentCompilerArgs

    +
    +public java.lang.String[] getCurrentCompilerArgs()
    +
    +
    Get the additional implementation specific command line arguments. +

    +

    + +
    Returns:
    array of command line arguments, guaranteed to be non-null.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setExecutable

    +
    +public void setExecutable(java.lang.String ex)
    +
    +
    Name of the executable to use when forking. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getExecutable

    +
    +public java.lang.String getExecutable()
    +
    +
    Explicitly specified name of the executable to use when forking + - if any. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createCompilerClasspath

    +
    +public Path createCompilerClasspath()
    +
    +
    The classpath to use when loading the compiler implementation + if it is not a built-in one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setListfiles

    +
    +public void setListfiles(boolean list)
    +
    +
    If true, list the source files being handed off to the compiler. +

    +

    +
    Parameters:
    list - if true list the source files
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(RmicAdapter adapter)
    +
    +
    Set the compiler adapter explicitly. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    execute by creating an instance of an implementation + class and getting to do the work +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if there's a problem with baseDir or RMIC
    +
    +
    +
    + +

    +cleanup

    +
    +protected void cleanup()
    +
    +
    Cleans up resources. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +scanDir

    +
    +protected void scanDir(java.io.File baseDir,
+                       java.lang.String[] files,
+                       FileNameMapper mapper)
    +
    +
    Scans the directory looking for class files to be compiled. + The result is returned in the class variable compileList. +

    +

    +
    Parameters:
    baseDir - the base direction
    files - the list of files to scan
    mapper - the mapper of files to target files
    +
    +
    +
    + +

    +isValidRmiRemote

    +
    +public boolean isValidRmiRemote(java.lang.String classname)
    +
    +
    Load named class and test whether it can be rmic'ed +

    +

    +
    Parameters:
    classname - the name of the class to be tested +
    Returns:
    true if the class can be rmic'ed
    +
    +
    +
    + +

    +getRemoteInterface

    +
    +public java.lang.Class getRemoteInterface(java.lang.Class testClass)
    +
    +
    Returns the topmost interface that extends Remote for a given + class - if one exists. +

    +

    +
    Parameters:
    testClass - the class to be tested +
    Returns:
    the topmost interface that extends Remote, or null if there + is none.
    +
    +
    +
    + +

    +getLoader

    +
    +public java.lang.ClassLoader getLoader()
    +
    +
    Classloader for the user-specified classpath. +

    +

    + +
    Returns:
    the classloader
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.DelimiterType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.DelimiterType.html new file mode 100644 index 000000000..255e92764 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.DelimiterType.html @@ -0,0 +1,338 @@ + + + + + + +SQLExec.DelimiterType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SQLExec.DelimiterType

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.SQLExec.DelimiterType
+
    +
    +
    Enclosing class:
    SQLExec
    +
    +
    +
    +
    public static class SQLExec.DelimiterType
    extends EnumeratedAttribute
    + + +

    +delimiters we support, "normal" and "row" +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringNORMAL + +
    +          The enumerated strings
    +static java.lang.StringROW + +
    +          The enumerated strings
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    SQLExec.DelimiterType() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NORMAL

    +
    +public static final java.lang.String NORMAL
    +
    +
    The enumerated strings +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ROW

    +
    +public static final java.lang.String ROW
    +
    +
    The enumerated strings +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +SQLExec.DelimiterType

    +
    +public SQLExec.DelimiterType()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the enumerated strings
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.OnError.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.OnError.html new file mode 100644 index 000000000..786c892db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.OnError.html @@ -0,0 +1,290 @@ + + + + + + +SQLExec.OnError (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SQLExec.OnError

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.SQLExec.OnError
+
    +
    +
    Enclosing class:
    SQLExec
    +
    +
    +
    +
    public static class SQLExec.OnError
    extends EnumeratedAttribute
    + + +

    +The action a task should perform on an error, + one of "continue", "stop" and "abort" +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    SQLExec.OnError() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SQLExec.OnError

    +
    +public SQLExec.OnError()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the enumerated values
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.Transaction.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.Transaction.html new file mode 100644 index 000000000..29b58a3f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.Transaction.html @@ -0,0 +1,326 @@ + + + + + + +SQLExec.Transaction (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SQLExec.Transaction

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.SQLExec.Transaction
+
    +
    +
    Enclosing class:
    SQLExec
    +
    +
    +
    +
    public class SQLExec.Transaction
    extends java.lang.Object
    + + +

    +Contains the definition of a new transaction element. + Transactions allow several files or blocks of statements + to be executed using the same JDBC connection and commit + operation in between. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    SQLExec.Transaction() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source resource.
    + voidaddText(java.lang.String sql) + +
    +          Set inline text
    + voidsetSrc(java.io.File src) + +
    +          Set the source file attribute.
    + voidsetSrcResource(Resource src) + +
    +          Set the source resource attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SQLExec.Transaction

    +
    +public SQLExec.Transaction()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    Set the source file attribute. +

    +

    +
    Parameters:
    src - the source file
    +
    +
    +
    + +

    +setSrcResource

    +
    +public void setSrcResource(Resource src)
    +
    +
    Set the source resource attribute. +

    +

    +
    Parameters:
    src - the source file
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String sql)
    +
    +
    Set inline text +

    +

    +
    Parameters:
    sql - the inline text
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source resource. +

    +

    +
    Parameters:
    a - the source resource collection.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.html new file mode 100644 index 000000000..c63e39869 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SQLExec.html @@ -0,0 +1,1302 @@ + + + + + + +SQLExec (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SQLExec

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.JDBCTask
+              extended by org.apache.tools.ant.taskdefs.SQLExec
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class SQLExec
    extends JDBCTask
    + + +

    +Executes a series of SQL statements on a database using JDBC. + +

    Statements can + either be read in from a text file using the src attribute or from + between the enclosing SQL tags.

    + +

    Multiple statements can be provided, separated by semicolons (or the + defined delimiter). Individual lines within the statements can be + commented using either --, // or REM at the start of the line.

    + +

    The autocommit attribute specifies whether auto-commit should be + turned on or off whilst executing the statements. If auto-commit is turned + on each statement will be executed and committed. If it is turned off the + statements will all be executed as one transaction.

    + +

    The onerror attribute specifies how to proceed when an error occurs + during the execution of one of the statements. + The possible values are: continue execution, only show the error; + stop execution and commit transaction; + and abort execution and transaction and fail task.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classSQLExec.DelimiterType + +
    +          delimiters we support, "normal" and "row"
    +static classSQLExec.OnError + +
    +          The action a task should perform on an error, + one of "continue", "stop" and "abort"
    + classSQLExec.Transaction + +
    +          Contains the definition of a new transaction element.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    SQLExec() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Adds a collection of resources (nested element).
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files (nested fileset attribute).
    + voidaddText(java.lang.String sql) + +
    +          Set an inline SQL command to execute.
    + SQLExec.TransactioncreateTransaction() + +
    +          Add a SQL transaction to execute
    +protected  voidexecSQL(java.lang.String sql, + java.io.PrintStream out) + +
    +          Exec the sql statement.
    + voidexecute() + +
    +          Load the sql file and then execute it
    +protected  java.sql.ConnectiongetConnection() + +
    +          Caches the connection returned by the base class's getConnection method.
    + booleangetExpandProperties() + +
    +          is property expansion inside inline text enabled?
    +protected  java.sql.StatementgetStatement() + +
    +          Creates and configures a Statement instance which is then + cached for subsequent calls.
    + intlastDelimiterPosition(java.lang.StringBuffer buf, + java.lang.String currentLine) + +
    +           
    +protected  voidprintResults(java.io.PrintStream out) + +
    +          Deprecated. since 1.6.x. + Use the two arg version instead.
    +protected  voidprintResults(java.sql.ResultSet rs, + java.io.PrintStream out) + +
    +          print any results in the result set.
    +protected  voidrunStatements(java.io.Reader reader, + java.io.PrintStream out) + +
    +          read in lines and execute them
    + voidsetAppend(boolean append) + +
    +          whether output should be appended to or overwrite + an existing file.
    + voidsetCsvColumnSeparator(java.lang.String s) + +
    +          The column separator used when printing the results.
    + voidsetCsvQuoteCharacter(java.lang.String s) + +
    +          The character used to quote column values.
    + voidsetDelimiter(java.lang.String delimiter) + +
    +          Set the delimiter that separates SQL statements.
    + voidsetDelimiterType(SQLExec.DelimiterType delimiterType) + +
    +          Set the delimiter type: "normal" or "row" (default "normal").
    + voidsetEncoding(java.lang.String encoding) + +
    +          Set the file encoding to use on the SQL files read in
    +protected  voidsetErrorProperty() + +
    +           
    + voidsetErrorProperty(java.lang.String errorProperty) + +
    +          Property to set to "true" if a statement throws an error.
    + voidsetEscapeProcessing(boolean enable) + +
    +          Set escape processing for statements.
    + voidsetExpandProperties(boolean expandProperties) + +
    +          Enable property expansion inside nested text
    + voidsetKeepformat(boolean keepformat) + +
    +          whether or not format should be preserved.
    + voidsetOnerror(SQLExec.OnError action) + +
    +          Action to perform when statement fails: continue, stop, or abort + optional; default "abort"
    + voidsetOutput(java.io.File output) + +
    +          Set the output file; + optional, defaults to the Ant log.
    + voidsetOutput(Resource output) + +
    +          Set the output Resource; + optional, defaults to the Ant log.
    + voidsetPrint(boolean print) + +
    +          Print result sets from the statements; + optional, default false
    + voidsetRawBlobs(boolean rawBlobs) + +
    +          Set whether to print raw BLOBs rather than their string (hex) representations.
    +protected  voidsetRowCountProperty(int rowCount) + +
    +           
    + voidsetRowCountProperty(java.lang.String rowCountProperty) + +
    +          Sets a given property to the number of rows in the first + statement that returned a row count.
    + voidsetShowheaders(boolean showheaders) + +
    +          Print headers for result sets from the + statements; optional, default true.
    + voidsetShowtrailers(boolean showtrailers) + +
    +          Print trailing info (rows affected) for the SQL + Addresses Bug/Request #27446
    + voidsetShowWarnings(boolean b) + +
    +          whether to show SQLWarnings as WARN messages.
    + voidsetSrc(java.io.File srcFile) + +
    +          Set the name of the SQL file to be run.
    + voidsetStrictDelimiterMatching(boolean b) + +
    +          If false, delimiters will be searched for in a case-insesitive + manner (i.e.
    + voidsetTreatWarningsAsErrors(boolean b) + +
    +          Whether a warning is an error - in which case onError aplies.
    +protected  voidsetWarningProperty() + +
    +           
    + voidsetWarningProperty(java.lang.String warningProperty) + +
    +          Property to set to "true" if a statement produces a warning.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.JDBCTask
    addConnectionProperty, createClasspath, getClasspath, getLoader, getLoaderMap, getPassword, getRdbms, getUrl, getUserId, getVersion, isAutocommit, isCaching, isValidRdbms, setAutocommit, setCaching, setClasspath, setClasspathRef, setDriver, setFailOnConnectionError, setPassword, setRdbms, setUrl, setUserid, setVersion
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SQLExec

    +
    +public SQLExec()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.io.File srcFile)
    +
    +
    Set the name of the SQL file to be run. + Required unless statements are enclosed in the build file +

    +

    +
    Parameters:
    srcFile - the file containing the SQL command.
    +
    +
    +
    + +

    +setExpandProperties

    +
    +public void setExpandProperties(boolean expandProperties)
    +
    +
    Enable property expansion inside nested text +

    +

    +
    Parameters:
    expandProperties - if true expand properties.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getExpandProperties

    +
    +public boolean getExpandProperties()
    +
    +
    is property expansion inside inline text enabled? +

    +

    + +
    Returns:
    true if properties are to be expanded.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addText

    +
    +public void addText(java.lang.String sql)
    +
    +
    Set an inline SQL command to execute. + NB: Properties are not expanded in this text unless expandProperties + is set. +

    +

    +
    Parameters:
    sql - an inline string containing the SQL command.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files (nested fileset attribute). +

    +

    +
    Parameters:
    set - a set of files contains SQL commands, each File is run in + a separate transaction.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Adds a collection of resources (nested element). +

    +

    +
    Parameters:
    rc - a collection of resources containing SQL commands, + each resource is run in a separate transaction.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createTransaction

    +
    +public SQLExec.Transaction createTransaction()
    +
    +
    Add a SQL transaction to execute +

    +

    + +
    Returns:
    a Transaction to be configured.
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Set the file encoding to use on the SQL files read in +

    +

    +
    Parameters:
    encoding - the encoding to use on the files
    +
    +
    +
    + +

    +setDelimiter

    +
    +public void setDelimiter(java.lang.String delimiter)
    +
    +
    Set the delimiter that separates SQL statements. Defaults to ";"; + optional + +

    For example, set this to "go" and delimitertype to "ROW" for + Sybase ASE or MS SQL Server.

    +

    +

    +
    Parameters:
    delimiter - the separator.
    +
    +
    +
    + +

    +setDelimiterType

    +
    +public void setDelimiterType(SQLExec.DelimiterType delimiterType)
    +
    +
    Set the delimiter type: "normal" or "row" (default "normal"). + +

    The delimiter type takes two values - normal and row. Normal + means that any occurrence of the delimiter terminate the SQL + command whereas with row, only a line containing just the + delimiter is recognized as the end of the command.

    +

    +

    +
    Parameters:
    delimiterType - the type of delimiter - "normal" or "row".
    +
    +
    +
    + +

    +setPrint

    +
    +public void setPrint(boolean print)
    +
    +
    Print result sets from the statements; + optional, default false +

    +

    +
    Parameters:
    print - if true print result sets.
    +
    +
    +
    + +

    +setShowheaders

    +
    +public void setShowheaders(boolean showheaders)
    +
    +
    Print headers for result sets from the + statements; optional, default true. +

    +

    +
    Parameters:
    showheaders - if true print headers of result sets.
    +
    +
    +
    + +

    +setShowtrailers

    +
    +public void setShowtrailers(boolean showtrailers)
    +
    +
    Print trailing info (rows affected) for the SQL + Addresses Bug/Request #27446 +

    +

    +
    Parameters:
    showtrailers - if true prints the SQL rows affected
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.io.File output)
    +
    +
    Set the output file; + optional, defaults to the Ant log. +

    +

    +
    Parameters:
    output - the output file to use for logging messages.
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(Resource output)
    +
    +
    Set the output Resource; + optional, defaults to the Ant log. +

    +

    +
    Parameters:
    output - the output Resource to store results.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setAppend

    +
    +public void setAppend(boolean append)
    +
    +
    whether output should be appended to or overwrite + an existing file. Defaults to false. +

    +

    +
    Parameters:
    append - if true append to an existing file.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setOnerror

    +
    +public void setOnerror(SQLExec.OnError action)
    +
    +
    Action to perform when statement fails: continue, stop, or abort + optional; default "abort" +

    +

    +
    Parameters:
    action - the action to perform on statement failure.
    +
    +
    +
    + +

    +setKeepformat

    +
    +public void setKeepformat(boolean keepformat)
    +
    +
    whether or not format should be preserved. + Defaults to false. +

    +

    +
    Parameters:
    keepformat - The keepformat to set
    +
    +
    +
    + +

    +setEscapeProcessing

    +
    +public void setEscapeProcessing(boolean enable)
    +
    +
    Set escape processing for statements. +

    +

    +
    Parameters:
    enable - if true enable escape processing, default is true.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setRawBlobs

    +
    +public void setRawBlobs(boolean rawBlobs)
    +
    +
    Set whether to print raw BLOBs rather than their string (hex) representations. +

    +

    +
    Parameters:
    rawBlobs - whether to print raw BLOBs.
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    +
    + +

    +setStrictDelimiterMatching

    +
    +public void setStrictDelimiterMatching(boolean b)
    +
    +
    If false, delimiters will be searched for in a case-insesitive + manner (i.e. delimer="go" matches "GO") and surrounding + whitespace will be ignored (delimter="go" matches "GO "). +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setShowWarnings

    +
    +public void setShowWarnings(boolean b)
    +
    +
    whether to show SQLWarnings as WARN messages. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setTreatWarningsAsErrors

    +
    +public void setTreatWarningsAsErrors(boolean b)
    +
    +
    Whether a warning is an error - in which case onError aplies. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCsvColumnSeparator

    +
    +public void setCsvColumnSeparator(java.lang.String s)
    +
    +
    The column separator used when printing the results. + +

    Defaults to ","

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCsvQuoteCharacter

    +
    +public void setCsvQuoteCharacter(java.lang.String s)
    +
    +
    The character used to quote column values. + +

    If set, columns that contain either the column separator or + the quote character itself will be surrounded by the quote + character. The quote character itself will be doubled if it + appears inside of the column's value.

    + +

    If this value is not set (the default), no column values + will be quoted, not even if they contain the column + separator.

    + +

    Note: BLOB values will never be quoted.

    + +

    Defaults to "not set"

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setErrorProperty

    +
    +public void setErrorProperty(java.lang.String errorProperty)
    +
    +
    Property to set to "true" if a statement throws an error. +

    +

    +
    Parameters:
    errorProperty - the name of the property to set in the + event of an error.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setWarningProperty

    +
    +public void setWarningProperty(java.lang.String warningProperty)
    +
    +
    Property to set to "true" if a statement produces a warning. +

    +

    +
    Parameters:
    warningProperty - the name of the property to set in the + event of a warning.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setRowCountProperty

    +
    +public void setRowCountProperty(java.lang.String rowCountProperty)
    +
    +
    Sets a given property to the number of rows in the first + statement that returned a row count. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Load the sql file and then execute it +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +runStatements

    +
    +protected void runStatements(java.io.Reader reader,
+                             java.io.PrintStream out)
+                      throws java.sql.SQLException,
+                             java.io.IOException
    +
    +
    read in lines and execute them +

    +

    +
    Parameters:
    reader - the reader contains sql lines.
    out - the place to output results. +
    Throws: +
    java.sql.SQLException - on sql problems +
    java.io.IOException - on io problems
    +
    +
    +
    + +

    +execSQL

    +
    +protected void execSQL(java.lang.String sql,
+                       java.io.PrintStream out)
+                throws java.sql.SQLException
    +
    +
    Exec the sql statement. +

    +

    +
    Parameters:
    sql - the SQL statement to execute
    out - the place to put output +
    Throws: +
    java.sql.SQLException - on SQL problems
    +
    +
    +
    + +

    +printResults

    +
    +protected void printResults(java.io.PrintStream out)
+                     throws java.sql.SQLException
    +
    +
    Deprecated. since 1.6.x. + Use the two arg version instead. +

    +

    print any results in the statement +

    +

    +
    Parameters:
    out - the place to print results +
    Throws: +
    java.sql.SQLException - on SQL problems.
    +
    +
    +
    + +

    +printResults

    +
    +protected void printResults(java.sql.ResultSet rs,
+                            java.io.PrintStream out)
+                     throws java.sql.SQLException
    +
    +
    print any results in the result set. +

    +

    +
    Parameters:
    rs - the resultset to print information about
    out - the place to print results +
    Throws: +
    java.sql.SQLException - on SQL problems.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getConnection

    +
    +protected java.sql.Connection getConnection()
    +
    +
    Caches the connection returned by the base class's getConnection method. + +

    Subclasses that need to provide a different connection than + the base class would, should override this method but keep in + mind that this class expects to get the same connection + instance on consecutive calls.

    + +

    returns null if the connection does not connect to the + expected RDBMS.

    +

    +

    +
    Overrides:
    getConnection in class JDBCTask
    +
    +
    + +
    Returns:
    Connection the newly created connection or null if the + connection failed and failOnConnectionError is false.
    +
    +
    +
    + +

    +getStatement

    +
    +protected java.sql.Statement getStatement()
+                                   throws java.sql.SQLException
    +
    +
    Creates and configures a Statement instance which is then + cached for subsequent calls. + +

    Subclasses that want to provide different Statement + instances, should override this method but keep in mind that + this class expects to get the same connection instance on + consecutive calls.

    +

    +

    + +
    Throws: +
    java.sql.SQLException
    +
    +
    +
    + +

    +lastDelimiterPosition

    +
    +public int lastDelimiterPosition(java.lang.StringBuffer buf,
+                                 java.lang.String currentLine)
    +
    +
    +
    +
    +
    +
    + +

    +setErrorProperty

    +
    +protected final void setErrorProperty()
    +
    +
    +
    +
    +
    +
    + +

    +setWarningProperty

    +
    +protected final void setWarningProperty()
    +
    +
    +
    +
    +
    +
    + +

    +setRowCountProperty

    +
    +protected final void setRowCountProperty(int rowCount)
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SendEmail.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SendEmail.html new file mode 100644 index 000000000..cfff4d196 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SendEmail.html @@ -0,0 +1,353 @@ + + + + + + +SendEmail (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SendEmail

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.email.EmailTask
+              extended by org.apache.tools.ant.taskdefs.SendEmail
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class SendEmail
    extends EmailTask
    + + +

    +A task to send SMTP email. + This task can send mail using either plain + text, UU encoding or Mime format mail depending on what is available. + Attachments may be sent using nested FileSet + elements. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
    EmailTask.Encoding
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
    AUTO, MIME, PLAIN, UU
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    SendEmail() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsetMailport(java.lang.Integer value) + +
    +          Deprecated. since 1.5.x. + Use EmailTask.setMailport(int) instead.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
    addBcc, addCc, addFileset, addFrom, addMessage, addReplyTo, addTo, createAttachments, createHeader, execute, getCharset, getIncludeFileNames, setBccList, setCcList, setCharset, setEnableStartTLS, setEncoding, setFailOnError, setFiles, setFrom, setIgnoreInvalidRecipients, setIncludefilenames, setMailhost, setMailport, setMessage, setMessageFile, setMessageMimeType, setPassword, setReplyTo, setSSL, setSubject, setToList, setUser
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SendEmail

    +
    +public SendEmail()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMailport

    +
    +public void setMailport(java.lang.Integer value)
    +
    +
    Deprecated. since 1.5.x. + Use EmailTask.setMailport(int) instead. +

    +

    Sets the mailport parameter of this build task. +

    +

    +
    Parameters:
    value - mail port name.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sequential.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sequential.html new file mode 100644 index 000000000..bd9b85a20 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sequential.html @@ -0,0 +1,346 @@ + + + + + + +Sequential (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Sequential

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Sequential
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, TaskContainer
    +
    +
    +
    +
    public class Sequential
    extends Task
    implements TaskContainer
    + + +

    +Sequential is a container task - it can contain other Ant tasks. The nested + tasks are simply executed in sequence. Sequential's primary use is to support + the sequential execution of a subset of tasks within the Parallel Task + +

    + The sequential task has no attributes and does not support any nested + elements apart from Ant tasks. Any valid Ant task may be embedded within the + sequential task.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Sequential() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddTask(Task nestedTask) + +
    +          Add a nested task to Sequential.
    + voidexecute() + +
    +          Execute all nestedTasks.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sequential

    +
    +public Sequential()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addTask

    +
    +public void addTask(Task nestedTask)
    +
    +
    Add a nested task to Sequential. +

    +

    +

    +
    Specified by:
    addTask in interface TaskContainer
    +
    +
    +
    Parameters:
    nestedTask - Nested task to execute Sequential +

    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute all nestedTasks. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if one of the nested tasks fails.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SignJar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SignJar.html new file mode 100644 index 000000000..96bd6c9a3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SignJar.html @@ -0,0 +1,1046 @@ + + + + + + +SignJar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SignJar

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractJarSignerTask
+              extended by org.apache.tools.ant.taskdefs.SignJar
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class SignJar
    extends AbstractJarSignerTask
    + + +

    +Signs JAR or ZIP files with the javasign command line tool. The tool detailed + dependency checking: files are only signed if they are not signed. The + signjar attribute can point to the file to generate; if this file + exists then its modification date is used as a cue as to whether to resign + any JAR file. + + Timestamp driven signing is based on the unstable and inadequately documented + information in the Java1.5 docs +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    See Also:
    + beta documentation
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.FiledestDir + +
    +          the output directory when using paths.
    +static java.lang.StringERROR_BAD_MAP + +
    +          error string for unit test verification: "Cannot map source file to anything sensible: "
    +static java.lang.StringERROR_MAPPER_WITHOUT_DEST + +
    +          error string for unit test verification: "The destDir attribute is required if a mapper is set"
    +static java.lang.StringERROR_NO_ALIAS + +
    +          error string for unit test verification: "alias attribute must be set"
    +static java.lang.StringERROR_NO_STOREPASS + +
    +          error string for unit test verification: "storepass attribute must be set"
    +static java.lang.StringERROR_SIGNEDJAR_AND_PATHS + +
    +          error string for unit test verification "You cannot specify the signed JAR when using paths or filesets"
    +static java.lang.StringERROR_TODIR_AND_SIGNEDJAR + +
    +          error string for unit test verification: "\'destdir\' and \'signedjar\' cannot both be set"
    +static java.lang.StringERROR_TOO_MANY_MAPPERS + +
    +          error string for unit test verification: "Too many mappers"
    +protected  booleaninternalsf + +
    +          flag for internal sf signing
    +protected  booleanlazy + +
    +          Whether to assume a jar which has an appropriate .SF file in is already + signed.
    +protected  booleansectionsonly + +
    +          sign sections only?
    +protected  java.lang.Stringsigfile + +
    +          name to a signature file
    +protected  java.io.Filesignedjar + +
    +          name of a single jar
    +protected  java.lang.Stringtsacert + +
    +          alias for the TSA in the keystore
    +protected  java.lang.Stringtsaurl + +
    +          URL for a tsa; null implies no tsa support
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractJarSignerTask
    alias, ERROR_NO_SOURCE, filesets, jar, JARSIGNER_COMMAND, keypass, keystore, maxMemory, storepass, storetype, verbose
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    SignJar() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper newMapper) + +
    +          add a mapper to determine file naming policy.
    + voidexecute() + +
    +          sign the jar(s)
    + FileNameMappergetMapper() + +
    +          get the active mapper; may be null
    + java.lang.StringgetTsacert() + +
    +          get the -tsacert option
    + java.lang.StringgetTsaurl() + +
    +          get the -tsaurl url
    + booleanisForce() + +
    +          Should the task force signing of a jar even it is already + signed?
    +protected  booleanisSigned(java.io.File file) + +
    +          test for a file being signed, by looking for a signature in the META-INF + directory with our alias/sigfile.
    +protected  booleanisUpToDate(java.io.File jarFile, + java.io.File signedjarFile) + +
    +          Compare a jar file with its corresponding signed jar.
    + voidsetDestDir(java.io.File destDir) + +
    +          Optionally sets the output directory to be used.
    + voidsetForce(boolean b) + +
    +          Whether to force signing of a jar even it is already signed.
    + voidsetInternalsf(boolean internalsf) + +
    +          Flag to include the .SF file inside the signature; optional; default + false
    + voidsetLazy(boolean lazy) + +
    +          flag to control whether the presence of a signature file means a JAR is + signed; optional, default false
    + voidsetPreserveLastModified(boolean preserveLastModified) + +
    +          true to indicate that the signed jar modification date remains the same + as the original.
    + voidsetSectionsonly(boolean sectionsonly) + +
    +          flag to compute hash of entire manifest; optional, default false
    + voidsetSigfile(java.lang.String sigfile) + +
    +          name of .SF/.DSA file; optional
    + voidsetSignedjar(java.io.File signedjar) + +
    +          name of signed JAR file; optional
    + voidsetTsacert(java.lang.String tsacert) + +
    +          set the alias in the keystore of the TSA to use;
    + voidsetTsaurl(java.lang.String tsaurl) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractJarSignerTask
    addFileset, addSysproperty, addValue, beginExecution, bindToKeystore, createJarSigner, createPath, createUnifiedSourcePath, createUnifiedSources, declareSysProperty, endExecution, getRedirector, hasResources, setAlias, setCommonOptions, setExecutable, setJar, setKeypass, setKeystore, setMaxmemory, setStorepass, setStoretype, setVerbose
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +sigfile

    +
    +protected java.lang.String sigfile
    +
    +
    name to a signature file +

    +

    +
    +
    +
    + +

    +signedjar

    +
    +protected java.io.File signedjar
    +
    +
    name of a single jar +

    +

    +
    +
    +
    + +

    +internalsf

    +
    +protected boolean internalsf
    +
    +
    flag for internal sf signing +

    +

    +
    +
    +
    + +

    +sectionsonly

    +
    +protected boolean sectionsonly
    +
    +
    sign sections only? +

    +

    +
    +
    +
    + +

    +lazy

    +
    +protected boolean lazy
    +
    +
    Whether to assume a jar which has an appropriate .SF file in is already + signed. +

    +

    +
    +
    +
    + +

    +destDir

    +
    +protected java.io.File destDir
    +
    +
    the output directory when using paths. +

    +

    +
    +
    +
    + +

    +tsaurl

    +
    +protected java.lang.String tsaurl
    +
    +
    URL for a tsa; null implies no tsa support +

    +

    +
    +
    +
    + +

    +tsacert

    +
    +protected java.lang.String tsacert
    +
    +
    alias for the TSA in the keystore +

    +

    +
    +
    +
    + +

    +ERROR_TODIR_AND_SIGNEDJAR

    +
    +public static final java.lang.String ERROR_TODIR_AND_SIGNEDJAR
    +
    +
    error string for unit test verification: "\'destdir\' and \'signedjar\' cannot both be set" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_TOO_MANY_MAPPERS

    +
    +public static final java.lang.String ERROR_TOO_MANY_MAPPERS
    +
    +
    error string for unit test verification: "Too many mappers" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_SIGNEDJAR_AND_PATHS

    +
    +public static final java.lang.String ERROR_SIGNEDJAR_AND_PATHS
    +
    +
    error string for unit test verification "You cannot specify the signed JAR when using paths or filesets" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_BAD_MAP

    +
    +public static final java.lang.String ERROR_BAD_MAP
    +
    +
    error string for unit test verification: "Cannot map source file to anything sensible: " +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_MAPPER_WITHOUT_DEST

    +
    +public static final java.lang.String ERROR_MAPPER_WITHOUT_DEST
    +
    +
    error string for unit test verification: "The destDir attribute is required if a mapper is set" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_ALIAS

    +
    +public static final java.lang.String ERROR_NO_ALIAS
    +
    +
    error string for unit test verification: "alias attribute must be set" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_STOREPASS

    +
    +public static final java.lang.String ERROR_NO_STOREPASS
    +
    +
    error string for unit test verification: "storepass attribute must be set" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +SignJar

    +
    +public SignJar()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSigfile

    +
    +public void setSigfile(java.lang.String sigfile)
    +
    +
    name of .SF/.DSA file; optional +

    +

    +
    Parameters:
    sigfile - the name of the .SF/.DSA file
    +
    +
    +
    + +

    +setSignedjar

    +
    +public void setSignedjar(java.io.File signedjar)
    +
    +
    name of signed JAR file; optional +

    +

    +
    Parameters:
    signedjar - the name of the signed jar file
    +
    +
    +
    + +

    +setInternalsf

    +
    +public void setInternalsf(boolean internalsf)
    +
    +
    Flag to include the .SF file inside the signature; optional; default + false +

    +

    +
    Parameters:
    internalsf - if true include the .SF file inside the signature
    +
    +
    +
    + +

    +setSectionsonly

    +
    +public void setSectionsonly(boolean sectionsonly)
    +
    +
    flag to compute hash of entire manifest; optional, default false +

    +

    +
    Parameters:
    sectionsonly - flag to compute hash of entire manifest
    +
    +
    +
    + +

    +setLazy

    +
    +public void setLazy(boolean lazy)
    +
    +
    flag to control whether the presence of a signature file means a JAR is + signed; optional, default false +

    +

    +
    Parameters:
    lazy - flag to control whether the presence of a signature
    +
    +
    +
    + +

    +setDestDir

    +
    +public void setDestDir(java.io.File destDir)
    +
    +
    Optionally sets the output directory to be used. +

    +

    +
    Parameters:
    destDir - the directory in which to place signed jars
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper newMapper)
    +
    +
    add a mapper to determine file naming policy. Only used with toDir + processing. +

    +

    +
    Parameters:
    newMapper - the mapper to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getMapper

    +
    +public FileNameMapper getMapper()
    +
    +
    get the active mapper; may be null +

    +

    + +
    Returns:
    mapper or null
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getTsaurl

    +
    +public java.lang.String getTsaurl()
    +
    +
    get the -tsaurl url +

    +

    + +
    Returns:
    url or null
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setTsaurl

    +
    +public void setTsaurl(java.lang.String tsaurl)
    +
    +
    +
    Parameters:
    tsaurl - the tsa url.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getTsacert

    +
    +public java.lang.String getTsacert()
    +
    +
    get the -tsacert option +

    +

    + +
    Returns:
    a certificate alias or null
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setTsacert

    +
    +public void setTsacert(java.lang.String tsacert)
    +
    +
    set the alias in the keystore of the TSA to use; +

    +

    +
    Parameters:
    tsacert - the cert alias.
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean b)
    +
    +
    Whether to force signing of a jar even it is already signed. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +isForce

    +
    +public boolean isForce()
    +
    +
    Should the task force signing of a jar even it is already + signed? +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    sign the jar(s) +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on errors
    +
    +
    +
    + +

    +isUpToDate

    +
    +protected boolean isUpToDate(java.io.File jarFile,
+                             java.io.File signedjarFile)
    +
    +
    Compare a jar file with its corresponding signed jar. The logic for this + is complex, and best explained in the source itself. Essentially if + either file doesnt exist, or the destfile has an out of date timestamp, + then the return value is false. +

    + If we are signing ourself, the check isSigned(File) is used to + trigger the process. +

    +

    +
    Parameters:
    jarFile - the unsigned jar file
    signedjarFile - the result signed jar file +
    Returns:
    true if the signedjarFile is considered up to date
    +
    +
    +
    + +

    +isSigned

    +
    +protected boolean isSigned(java.io.File file)
    +
    +
    test for a file being signed, by looking for a signature in the META-INF + directory with our alias/sigfile. +

    +

    +
    Parameters:
    file - the file to be checked +
    Returns:
    true if the file is signed
    See Also:
    IsSigned.isSigned(File, String)
    +
    +
    +
    + +

    +setPreserveLastModified

    +
    +public void setPreserveLastModified(boolean preserveLastModified)
    +
    +
    true to indicate that the signed jar modification date remains the same + as the original. Defaults to false +

    +

    +
    Parameters:
    preserveLastModified - if true preserve the last modified time
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sleep.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sleep.html new file mode 100644 index 000000000..1c7a93504 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sleep.html @@ -0,0 +1,477 @@ + + + + + + +Sleep (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Sleep

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Sleep
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Sleep
    extends Task
    + + +

    +Sleep, or pause, for a period of time. + + A task for sleeping a short period of time, useful when a + build or deployment process requires an interval between tasks. +

    + A negative value can be supplied to any of attributes provided the total sleep time + is positive, pending fundamental changes in physics and JVM + execution times

    + Note that sleep times are always hints to be interpreted by the OS how it feels + small times may either be ignored or rounded up to a minimum timeslice. Note + also that the system clocks often have a fairly low granularity too, which complicates + measuring how long a sleep actually took.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Sleep() + +
    +          Creates new instance
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voiddoSleep(long millis) + +
    +          sleep for a period of time
    + voidexecute() + +
    +          Executes this build task.
    + voidsetFailOnError(boolean failOnError) + +
    +          flag controlling whether to break the build on an error.
    + voidsetHours(int hours) + +
    +          hours to add to the sleep time.
    + voidsetMilliseconds(int milliseconds) + +
    +          milliseconds to add to the sleep time
    + voidsetMinutes(int minutes) + +
    +          minutes to add to the sleep time
    + voidsetSeconds(int seconds) + +
    +          seconds to add to the sleep time
    + voidvalidate() + +
    +          verify parameters
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sleep

    +
    +public Sleep()
    +
    +
    Creates new instance +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setSeconds

    +
    +public void setSeconds(int seconds)
    +
    +
    seconds to add to the sleep time +

    +

    +
    Parameters:
    seconds - The new Seconds value
    +
    +
    +
    + +

    +setHours

    +
    +public void setHours(int hours)
    +
    +
    hours to add to the sleep time. +

    +

    +
    Parameters:
    hours - The new Hours value
    +
    +
    +
    + +

    +setMinutes

    +
    +public void setMinutes(int minutes)
    +
    +
    minutes to add to the sleep time +

    +

    +
    Parameters:
    minutes - The new Minutes value
    +
    +
    +
    + +

    +setMilliseconds

    +
    +public void setMilliseconds(int milliseconds)
    +
    +
    milliseconds to add to the sleep time +

    +

    +
    Parameters:
    milliseconds - The new Milliseconds value
    +
    +
    +
    + +

    +doSleep

    +
    +public void doSleep(long millis)
    +
    +
    sleep for a period of time +

    +

    +
    Parameters:
    millis - time to sleep
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failOnError)
    +
    +
    flag controlling whether to break the build on an error. +

    +

    +
    Parameters:
    failOnError - The new FailOnError value
    +
    +
    +
    + +

    +validate

    +
    +public void validate()
+              throws BuildException
    +
    +
    verify parameters +

    +

    + +
    Throws: +
    BuildException - if something is invalid
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes this build task. Throws org.apache.tools.ant.BuildException + if there is an error during task execution. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - Description of Exception
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/StreamPumper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/StreamPumper.html new file mode 100644 index 000000000..fe58e6601 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/StreamPumper.html @@ -0,0 +1,460 @@ + + + + + + +StreamPumper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class StreamPumper

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.StreamPumper
+
    +
    +
    All Implemented Interfaces:
    java.lang.Runnable
    +
    +
    +
    +
    public class StreamPumper
    extends java.lang.Object
    implements java.lang.Runnable
    + + +

    +Copies all data from an input stream to an output stream. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    StreamPumper(java.io.InputStream is, + java.io.OutputStream os) + +
    +          Create a new StreamPumper.
    StreamPumper(java.io.InputStream is, + java.io.OutputStream os, + boolean closeWhenExhausted) + +
    +          Create a new StreamPumper.
    StreamPumper(java.io.InputStream is, + java.io.OutputStream os, + boolean closeWhenExhausted, + boolean useAvailable) + +
    +          Create a new StreamPumper.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetBufferSize() + +
    +          Get the size in bytes of the read buffer.
    + java.lang.ExceptiongetException() + +
    +          Get the exception encountered, if any.
    + booleanisFinished() + +
    +          Tells whether the end of the stream has been reached.
    + voidrun() + +
    +          Copies data from the input stream to the output stream.
    + voidsetBufferSize(int bufferSize) + +
    +          Set the size in bytes of the read buffer.
    + voidwaitFor() + +
    +          This method blocks until the StreamPumper finishes.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +StreamPumper

    +
    +public StreamPumper(java.io.InputStream is,
+                    java.io.OutputStream os,
+                    boolean closeWhenExhausted)
    +
    +
    Create a new StreamPumper. +

    +

    +
    Parameters:
    is - input stream to read data from
    os - output stream to write data to.
    closeWhenExhausted - if true, the output stream will be closed when + the input is exhausted.
    +
    +
    + +

    +StreamPumper

    +
    +public StreamPumper(java.io.InputStream is,
+                    java.io.OutputStream os,
+                    boolean closeWhenExhausted,
+                    boolean useAvailable)
    +
    +
    Create a new StreamPumper. + +

    Note: If you set useAvailable to true, you must + explicitly invoke stop or interrupt the + corresponding Thread when you are done or the run method will + never finish on some JVMs (namely those where available returns + 0 on a closed stream). Setting it to true may also impact + performance negatively. This flag should only be set to true + if you intend to stop the pumper before the input stream gets + closed.

    +

    +

    +
    Parameters:
    is - input stream to read data from
    os - output stream to write data to.
    closeWhenExhausted - if true, the output stream will be closed when + the input is exhausted.
    useAvailable - whether the pumper should use available to determine + whether input is ready, thus trying to emulate + non-blocking behavior.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +

    +StreamPumper

    +
    +public StreamPumper(java.io.InputStream is,
+                    java.io.OutputStream os)
    +
    +
    Create a new StreamPumper. +

    +

    +
    Parameters:
    is - input stream to read data from
    os - output stream to write data to.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +run

    +
    +public void run()
    +
    +
    Copies data from the input stream to the output stream. + + Terminates as soon as the input stream is closed or an error occurs. +

    +

    +
    Specified by:
    run in interface java.lang.Runnable
    +
    +
    +
    +
    +
    +
    + +

    +isFinished

    +
    +public boolean isFinished()
    +
    +
    Tells whether the end of the stream has been reached. +

    +

    +
    +
    +
    + +
    Returns:
    true is the stream has been exhausted.
    +
    +
    +
    + +

    +waitFor

    +
    +public void waitFor()
+             throws java.lang.InterruptedException
    +
    +
    This method blocks until the StreamPumper finishes. +

    +

    +
    +
    +
    + +
    Throws: +
    java.lang.InterruptedException - if interrupted.
    See Also:
    isFinished()
    +
    +
    +
    + +

    +setBufferSize

    +
    +public void setBufferSize(int bufferSize)
    +
    +
    Set the size in bytes of the read buffer. +

    +

    +
    +
    +
    +
    Parameters:
    bufferSize - the buffer size to use. +
    Throws: +
    java.lang.IllegalStateException - if the StreamPumper is already running.
    +
    +
    +
    + +

    +getBufferSize

    +
    +public int getBufferSize()
    +
    +
    Get the size in bytes of the read buffer. +

    +

    +
    +
    +
    + +
    Returns:
    the int size of the read buffer.
    +
    +
    +
    + +

    +getException

    +
    +public java.lang.Exception getException()
    +
    +
    Get the exception encountered, if any. +

    +

    +
    +
    +
    + +
    Returns:
    the Exception encountered.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SubAnt.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SubAnt.html new file mode 100644 index 000000000..d4099c6f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/SubAnt.html @@ -0,0 +1,954 @@ + + + + + + +SubAnt (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class SubAnt

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.SubAnt
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class SubAnt
    extends Task
    + + +

    +Calls a given target for all defined sub-builds. This is an extension + of ant for bulk project execution. +

    +

    Use with directories

    +

    + subant can be used with directory sets to execute a build from different directories. + 2 different options are offered +

    +
      +
    • + run the same build file /somepath/otherpath/mybuild.xml + with different base directories use the genericantfile attribute +
      • +
    • if you want to run directory1/build.xml, directory2/build.xml, .... + use the antfile attribute. The base directory does not get set by the subant task in this case, + because you can specify it in each build file. +
      • +
    +

    + +

    +

    +
    Since:
    +
    Ant1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    SubAnt() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Adds a resource collection to the implicit build path.
    + voidaddConfiguredTarget(Ant.TargetElement t) + +
    +          Add a target to this Ant invocation.
    + voidaddDirset(DirSet set) + +
    +          Adds a directory set to the implicit build path.
    + voidaddFilelist(FileList list) + +
    +          Adds an ordered file list to the implicit build path.
    + voidaddFileset(FileSet set) + +
    +          Adds a file set to the implicit build path.
    + voidaddProperty(Property p) + +
    +          Corresponds to <ant>'s + nested <property> element.
    + voidaddPropertyset(PropertySet ps) + +
    +          Corresponds to <ant>'s + nested <propertyset> element.
    + voidaddReference(Ant.Reference r) + +
    +          Corresponds to <ant>'s + nested <reference> element.
    + PathcreateBuildpath() + +
    +          Creates a nested build path, and add it to the implicit build path.
    + Path.PathElementcreateBuildpathElement() + +
    +          Creates a nested <buildpathelement>, + and add it to the implicit build path.
    + voidexecute() + +
    +          Runs the various sub-builds.
    +protected  java.lang.StringgetDefaultBuildFile() + +
    +          Get the default build file name to use when launching the task.
    + voidhandleErrorFlush(java.lang.String output) + +
    +          Pass output sent to System.err to the new project.
    + voidhandleErrorOutput(java.lang.String output) + +
    +          Pass output sent to System.err to the new project.
    + voidhandleFlush(java.lang.String output) + +
    +          Pass output sent to System.out to the new project.
    + inthandleInput(byte[] buffer, + int offset, + int length) + +
    +          Process input into the ant task
    + voidhandleOutput(java.lang.String output) + +
    +          Pass output sent to System.out to the new project.
    + voidsetAntfile(java.lang.String antfile) + +
    +          This method builds the file name to use in conjunction with directories.
    + voidsetBuildpath(Path s) + +
    +          Set the buildpath to be used to find sub-projects.
    + voidsetBuildpathRef(Reference r) + +
    +          Buildpath to use, by reference.
    + voidsetFailonerror(boolean failOnError) + +
    +          Sets whether to fail with a build exception on error, or go on.
    + voidsetGenericAntfile(java.io.File afile) + +
    +          This method builds a file path to use in conjunction with directories.
    + voidsetInheritall(boolean b) + +
    +          Corresponds to <ant>'s + inheritall attribute.
    + voidsetInheritrefs(boolean b) + +
    +          Corresponds to <ant>'s + inheritrefs attribute.
    + voidsetOutput(java.lang.String s) + +
    +          Corresponds to <ant>'s + output attribute.
    + voidsetTarget(java.lang.String target) + +
    +          The target to call on the different sub-builds.
    + voidsetVerbose(boolean on) + +
    +          Enable/ disable verbose log messages showing when each sub-build path is entered/ exited.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +SubAnt

    +
    +public SubAnt()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getDefaultBuildFile

    +
    +protected java.lang.String getDefaultBuildFile()
    +
    +
    Get the default build file name to use when launching the task. +

    + This function may be overrided by providers of custom ProjectHelper so they can implement easily their sub + launcher. +

    +

    + +
    Returns:
    the name of the default file
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +handleOutput

    +
    +public void handleOutput(java.lang.String output)
    +
    +
    Pass output sent to System.out to the new project. +

    +

    +
    Overrides:
    handleOutput in class Task
    +
    +
    +
    Parameters:
    output - a line of output
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +handleInput

    +
    +public int handleInput(byte[] buffer,
+                       int offset,
+                       int length)
+                throws java.io.IOException
    +
    +
    Process input into the ant task +

    +

    +
    Overrides:
    handleInput in class Task
    +
    +
    +
    Parameters:
    buffer - the buffer into which data is to be read.
    offset - the offset into the buffer at which data is stored.
    length - the amount of data to read +
    Returns:
    the number of bytes read +
    Throws: +
    java.io.IOException - if the data cannot be read
    Since:
    +
    Ant 1.6.2
    +
    See Also:
    Task.handleInput(byte[], int, int)
    +
    +
    +
    + +

    +handleFlush

    +
    +public void handleFlush(java.lang.String output)
    +
    +
    Pass output sent to System.out to the new project. +

    +

    +
    Overrides:
    handleFlush in class Task
    +
    +
    +
    Parameters:
    output - The output to log. Should not be null.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +handleErrorOutput

    +
    +public void handleErrorOutput(java.lang.String output)
    +
    +
    Pass output sent to System.err to the new project. +

    +

    +
    Overrides:
    handleErrorOutput in class Task
    +
    +
    +
    Parameters:
    output - The error output to log. Should not be null.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +handleErrorFlush

    +
    +public void handleErrorFlush(java.lang.String output)
    +
    +
    Pass output sent to System.err to the new project. +

    +

    +
    Overrides:
    handleErrorFlush in class Task
    +
    +
    +
    Parameters:
    output - The error output to log. Should not be null.
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Runs the various sub-builds. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +setAntfile

    +
    +public void setAntfile(java.lang.String antfile)
    +
    +
    This method builds the file name to use in conjunction with directories. + +

    Defaults to "build.xml". + If genericantfile is set, this attribute is ignored.

    +

    +

    +
    Parameters:
    antfile - the short build file name. Defaults to "build.xml".
    +
    +
    +
    + +

    +setGenericAntfile

    +
    +public void setGenericAntfile(java.io.File afile)
    +
    +
    This method builds a file path to use in conjunction with directories. + +

    Use genericantfile, in order to run the same build file + with different basedirs.

    + If this attribute is set, antfile is ignored. +

    +

    +
    Parameters:
    afile - (path of the generic ant file, absolute or relative to + project base directory)
    +
    +
    +
    + +

    +setFailonerror

    +
    +public void setFailonerror(boolean failOnError)
    +
    +
    Sets whether to fail with a build exception on error, or go on. +

    +

    +
    Parameters:
    failOnError - the new value for this boolean flag.
    +
    +
    +
    + +

    +setTarget

    +
    +public void setTarget(java.lang.String target)
    +
    +
    The target to call on the different sub-builds. Set to "" to execute + the default target. +

    +

    +
    Parameters:
    target - the target +

    +
    +
    +
    + +

    +addConfiguredTarget

    +
    +public void addConfiguredTarget(Ant.TargetElement t)
    +
    +
    Add a target to this Ant invocation. +

    +

    +
    Parameters:
    t - the TargetElement to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean on)
    +
    +
    Enable/ disable verbose log messages showing when each sub-build path is entered/ exited. + The default value is "false". +

    +

    +
    Parameters:
    on - true to enable verbose mode, false otherwise (default).
    +
    +
    +
    + +

    +setOutput

    +
    +public void setOutput(java.lang.String s)
    +
    +
    Corresponds to <ant>'s + output attribute. +

    +

    +
    Parameters:
    s - the filename to write the output to.
    +
    +
    +
    + +

    +setInheritall

    +
    +public void setInheritall(boolean b)
    +
    +
    Corresponds to <ant>'s + inheritall attribute. +

    +

    +
    Parameters:
    b - the new value for this boolean flag.
    +
    +
    +
    + +

    +setInheritrefs

    +
    +public void setInheritrefs(boolean b)
    +
    +
    Corresponds to <ant>'s + inheritrefs attribute. +

    +

    +
    Parameters:
    b - the new value for this boolean flag.
    +
    +
    +
    + +

    +addProperty

    +
    +public void addProperty(Property p)
    +
    +
    Corresponds to <ant>'s + nested <property> element. +

    +

    +
    Parameters:
    p - the property to pass on explicitly to the sub-build.
    +
    +
    +
    + +

    +addReference

    +
    +public void addReference(Ant.Reference r)
    +
    +
    Corresponds to <ant>'s + nested <reference> element. +

    +

    +
    Parameters:
    r - the reference to pass on explicitly to the sub-build.
    +
    +
    +
    + +

    +addPropertyset

    +
    +public void addPropertyset(PropertySet ps)
    +
    +
    Corresponds to <ant>'s + nested <propertyset> element. +

    +

    +
    Parameters:
    ps - the propertset
    +
    +
    +
    + +

    +addDirset

    +
    +public void addDirset(DirSet set)
    +
    +
    Adds a directory set to the implicit build path. +

    + Note that the directories will be added to the build path + in no particular order, so if order is significant, one should + use a file list instead! +

    +

    +
    Parameters:
    set - the directory set to add.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a file set to the implicit build path. +

    + Note that the directories will be added to the build path + in no particular order, so if order is significant, one should + use a file list instead! +

    +

    +
    Parameters:
    set - the file set to add.
    +
    +
    +
    + +

    +addFilelist

    +
    +public void addFilelist(FileList list)
    +
    +
    Adds an ordered file list to the implicit build path. +

    + Note that contrary to file and directory sets, file lists + can reference non-existent files or directories! +

    +

    +
    Parameters:
    list - the file list to add.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Adds a resource collection to the implicit build path. +

    +

    +
    Parameters:
    rc - the resource collection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setBuildpath

    +
    +public void setBuildpath(Path s)
    +
    +
    Set the buildpath to be used to find sub-projects. +

    +

    +
    Parameters:
    s - an Ant Path object containing the buildpath.
    +
    +
    +
    + +

    +createBuildpath

    +
    +public Path createBuildpath()
    +
    +
    Creates a nested build path, and add it to the implicit build path. +

    +

    + +
    Returns:
    the newly created nested build path.
    +
    +
    +
    + +

    +createBuildpathElement

    +
    +public Path.PathElement createBuildpathElement()
    +
    +
    Creates a nested <buildpathelement>, + and add it to the implicit build path. +

    +

    + +
    Returns:
    the newly created nested build path element.
    +
    +
    +
    + +

    +setBuildpathRef

    +
    +public void setBuildpathRef(Reference r)
    +
    +
    Buildpath to use, by reference. +

    +

    +
    Parameters:
    r - a reference to an Ant Path object containing the buildpath.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.MyCopy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.MyCopy.html new file mode 100644 index 000000000..34de341cd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.MyCopy.html @@ -0,0 +1,439 @@ + + + + + + +Sync.MyCopy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Sync.MyCopy

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Copy
+              extended by org.apache.tools.ant.taskdefs.Sync.MyCopy
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Enclosing class:
    Sync
    +
    +
    +
    +
    public static class Sync.MyCopy
    extends Copy
    + + +

    +Subclass Copy in order to access it's file/dir maps. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Copy
    completeDirMap, destDir, destFile, dirCopyMap, failonerror, file, fileCopyMap, filesets, fileUtils, filtering, flatten, forceOverwrite, includeEmpty, mapperElement, preserveLastModified, rcs, verbosity
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Sync.MyCopy() + +
    +          Constructor for MyCopy.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleangetIncludeEmptyDirs() + +
    +          Get the includeEmptyDirs attribute.
    + java.io.FilegetToDir() + +
    +          Get the destination directory.
    +protected  voidscan(java.io.File fromDir, + java.io.File toDir, + java.lang.String[] files, + java.lang.String[] dirs) + +
    +          Compares source files to destination files to see if they should be + copied.
    +protected  java.util.Mapscan(Resource[] resources, + java.io.File toDir) + +
    +          Compares source resources to destination files to see if they + should be copied.
    +protected  booleansupportsNonFileResources() + +
    +          Yes, we can.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Copy
    add, add, addFileset, buildMap, buildMap, createFilterChain, createFilterSet, createMapper, doFileOperations, doResourceOperations, execute, getEncoding, getFileUtils, getFilterChains, getFilterSets, getForce, getOutputEncoding, getPreserveLastModified, isEnableMultipleMapping, setEnableMultipleMappings, setEncoding, setFailOnError, setFile, setFiltering, setFlatten, setForce, setGranularity, setIncludeEmptyDirs, setOutputEncoding, setOverwrite, setPreserveLastModified, setPreserveLastModified, setTodir, setTofile, setVerbose, validateAttributes
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sync.MyCopy

    +
    +public Sync.MyCopy()
    +
    +
    Constructor for MyCopy. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +scan

    +
    +protected void scan(java.io.File fromDir,
+                    java.io.File toDir,
+                    java.lang.String[] files,
+                    java.lang.String[] dirs)
    +
    +
    Compares source files to destination files to see if they should be + copied. +

    +

    +
    Overrides:
    scan in class Copy
    +
    +
    +
    Parameters:
    fromDir - The source directory.
    toDir - The destination directory.
    files - A list of files to copy.
    dirs - A list of directories to copy.
    +
    +
    +
    + +

    +scan

    +
    +protected java.util.Map scan(Resource[] resources,
+                             java.io.File toDir)
    +
    +
    Compares source resources to destination files to see if they + should be copied. +

    +

    +
    Overrides:
    scan in class Copy
    +
    +
    +
    Parameters:
    resources - The source resources.
    toDir - The destination directory. +
    Returns:
    a Map with the out-of-date resources as keys and an + array of target file names as values.
    +
    +
    +
    + +

    +getToDir

    +
    +public java.io.File getToDir()
    +
    +
    Get the destination directory. +

    +

    + +
    Returns:
    the destination directory
    +
    +
    +
    + +

    +getIncludeEmptyDirs

    +
    +public boolean getIncludeEmptyDirs()
    +
    +
    Get the includeEmptyDirs attribute. +

    +

    + +
    Returns:
    true if emptyDirs are to be included
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Yes, we can. +

    +

    +
    Overrides:
    supportsNonFileResources in class Copy
    +
    +
    + +
    Returns:
    true always.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.SyncTarget.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.SyncTarget.html new file mode 100644 index 000000000..08bca04ef --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.SyncTarget.html @@ -0,0 +1,384 @@ + + + + + + +Sync.SyncTarget (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Sync.SyncTarget

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.taskdefs.Sync.SyncTarget
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    Enclosing class:
    Sync
    +
    +
    +
    +
    public static class Sync.SyncTarget
    extends AbstractFileSet
    + + +

    +Inner class used to hold exclude patterns and selectors to save + stuff that happens to live in the target directory but should + not get removed. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.DataType
    checked, ref
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Sync.SyncTarget() + +
    +          Constructor for SyncTarget.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.BooleangetPreserveEmptyDirs() + +
    +          Whether empty directories matched by this fileset should be + preserved.
    + voidsetDir(java.io.File dir) + +
    +          Override AbstractFileSet#setDir(File) to disallow + setting the directory.
    + voidsetPreserveEmptyDirs(boolean b) + +
    +          Whether empty directories matched by this fileset should be + preserved.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, clone, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.DataType
    checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sync.SyncTarget

    +
    +public Sync.SyncTarget()
    +
    +
    Constructor for SyncTarget. + This just changes the default value of "defaultexcludes" from + true to false. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setDir

    +
    +public void setDir(java.io.File dir)
+            throws BuildException
    +
    +
    Override AbstractFileSet#setDir(File) to disallow + setting the directory. +

    +

    +
    Overrides:
    setDir in class AbstractFileSet
    +
    +
    +
    Parameters:
    dir - ignored +
    Throws: +
    BuildException - always
    +
    +
    +
    + +

    +setPreserveEmptyDirs

    +
    +public void setPreserveEmptyDirs(boolean b)
    +
    +
    Whether empty directories matched by this fileset should be + preserved. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getPreserveEmptyDirs

    +
    +public java.lang.Boolean getPreserveEmptyDirs()
    +
    +
    Whether empty directories matched by this fileset should be + preserved. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.html new file mode 100644 index 000000000..afbb2f162 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Sync.html @@ -0,0 +1,580 @@ + + + + + + +Sync (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Sync

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Sync
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Sync
    extends Task
    + + +

    +Synchronize a local target directory from the files defined + in one or more filesets. + +

    Uses a <copy> task internally, but forbidding the use of + mappers and filter chains. Files of the destination directory not + present in any of the source fileset are removed.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.6 + + revised by Dan Armbrust + to remove orphaned directories.
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classSync.MyCopy + +
    +          Subclass Copy in order to access it's file/dir maps.
    +static classSync.SyncTarget + +
    +          Inner class used to hold exclude patterns and selectors to save + stuff that happens to live in the target directory but should + not get removed.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Sync() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Adds a collection of filesystem resources to copy.
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files to copy.
    + voidaddPreserveInTarget(Sync.SyncTarget s) + +
    +          A container for patterns and selectors that can be used to + specify files that should be kept in the target even if they + are not present in any source directory.
    + voidexecute() + +
    +          Execute the sync task.
    + voidinit() + +
    +          Initialize the sync task.
    + voidsetFailOnError(boolean failonerror) + +
    +          If false, note errors to the output but keep going.
    + voidsetGranularity(long granularity) + +
    +          The number of milliseconds leeway to give before deciding a + target is out of date.
    + voidsetIncludeEmptyDirs(boolean includeEmpty) + +
    +          Used to copy empty directories.
    + voidsetOverwrite(boolean overwrite) + +
    +          Overwrite any existing destination file(s).
    + voidsetTodir(java.io.File destDir) + +
    +          Sets the destination directory.
    + voidsetVerbose(boolean verbose) + +
    +          Used to force listing of all names of copied files.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sync

    +
    +public Sync()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Initialize the sync task. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    + +
    Throws: +
    BuildException - if there is a problem.
    See Also:
    Task.init()
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the sync task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if there is an error.
    See Also:
    Task.execute()
    +
    +
    +
    + +

    +setTodir

    +
    +public void setTodir(java.io.File destDir)
    +
    +
    Sets the destination directory. +

    +

    +
    Parameters:
    destDir - the destination directory
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    Used to force listing of all names of copied files. +

    +

    +
    Parameters:
    verbose - if true force listing of all names of copied files.
    +
    +
    +
    + +

    +setOverwrite

    +
    +public void setOverwrite(boolean overwrite)
    +
    +
    Overwrite any existing destination file(s). +

    +

    +
    Parameters:
    overwrite - if true overwrite any existing destination file(s).
    +
    +
    +
    + +

    +setIncludeEmptyDirs

    +
    +public void setIncludeEmptyDirs(boolean includeEmpty)
    +
    +
    Used to copy empty directories. +

    +

    +
    Parameters:
    includeEmpty - If true copy empty directories.
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failonerror)
    +
    +
    If false, note errors to the output but keep going. +

    +

    +
    Parameters:
    failonerror - true or false
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files to copy. +

    +

    +
    Parameters:
    set - a fileset
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Adds a collection of filesystem resources to copy. +

    +

    +
    Parameters:
    rc - a resource collection
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setGranularity

    +
    +public void setGranularity(long granularity)
    +
    +
    The number of milliseconds leeway to give before deciding a + target is out of date. + +

    Default is 0 milliseconds, or 2 seconds on DOS systems.

    +

    +

    +
    Parameters:
    granularity - a long value
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +addPreserveInTarget

    +
    +public void addPreserveInTarget(Sync.SyncTarget s)
    +
    +
    A container for patterns and selectors that can be used to + specify files that should be kept in the target even if they + are not present in any source directory. + +

    You must not invoke this method more than once.

    +

    +

    +
    Parameters:
    s - a preserveintarget nested element
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html new file mode 100644 index 000000000..1e1d7f1cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarCompressionMethod.html @@ -0,0 +1,290 @@ + + + + + + +Tar.TarCompressionMethod (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tar.TarCompressionMethod

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Tar.TarCompressionMethod
+
    +
    +
    Enclosing class:
    Tar
    +
    +
    +
    +
    public static final class Tar.TarCompressionMethod
    extends EnumeratedAttribute
    + + +

    +Valid Modes for Compression attribute to Tar Task +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Tar.TarCompressionMethod() + +
    +          Default constructor
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          Get valid enumeration values.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Tar.TarCompressionMethod

    +
    +public Tar.TarCompressionMethod()
    +
    +
    Default constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get valid enumeration values. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    valid enumeration values
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarFileSet.html new file mode 100644 index 000000000..7dd2ae189 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarFileSet.html @@ -0,0 +1,459 @@ + + + + + + +Tar.TarFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tar.TarFileSet

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.ArchiveFileSet
+                      extended by org.apache.tools.ant.types.TarFileSet
+                          extended by org.apache.tools.ant.taskdefs.Tar.TarFileSet
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, ResourceCollection, SelectorContainer
    +
    +
    +
    Enclosing class:
    Tar
    +
    +
    +
    +
    public static class Tar.TarFileSet
    extends TarFileSet
    + + +

    +This is a FileSet with the option to specify permissions + and other attributes. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.ArchiveFileSet
    DEFAULT_DIR_MODE, DEFAULT_FILE_MODE
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.DataType
    checked, ref
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Tar.TarFileSet() + +
    +          Creates a new TarFileSet instance.
    Tar.TarFileSet(FileSet fileset) + +
    +          Creates a new TarFileSet instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getFiles(Project p) + +
    +          Get a list of files and directories specified in the fileset.
    + intgetMode() + +
    +           
    + booleangetPreserveLeadingSlashes() + +
    +           
    + voidsetMode(java.lang.String octalString) + +
    +          A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644
    + voidsetPreserveLeadingSlashes(boolean b) + +
    +          Flag to indicates whether leading `/'s should + be preserved in the file names.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.TarFileSet
    clone, configureFileSet, getGid, getGroup, getRef, getUid, getUserName, hasGroupBeenSet, hasGroupIdBeenSet, hasUserIdBeenSet, hasUserNameBeenSet, newArchiveScanner, setGid, setGroup, setRefid, setUid, setUserName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet
    addConfigured, dieOnCircularReference, getCheckedRef, getDirectoryScanner, getDirMode, getDirMode, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, setDir, setDirMode, setErrorOnMissingArchive, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setupDirectoryScanner, setupDirectoryScanner
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.DataType
    checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Tar.TarFileSet

    +
    +public Tar.TarFileSet(FileSet fileset)
    +
    +
    Creates a new TarFileSet instance. + Using a fileset as a constructor argument. +

    +

    +
    Parameters:
    fileset - a FileSet value
    +
    +
    + +

    +Tar.TarFileSet

    +
    +public Tar.TarFileSet()
    +
    +
    Creates a new TarFileSet instance. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getFiles

    +
    +public java.lang.String[] getFiles(Project p)
    +
    +
    Get a list of files and directories specified in the fileset. +

    +

    +
    Parameters:
    p - the current project. +
    Returns:
    a list of file and directory names, relative to + the baseDir for the project.
    +
    +
    +
    + +

    +setMode

    +
    +public void setMode(java.lang.String octalString)
    +
    +
    A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 +

    +

    +
    Parameters:
    octalString - a 3 digit octal string.
    +
    +
    +
    + +

    +getMode

    +
    +public int getMode()
    +
    +
    + +
    Returns:
    the current mode.
    +
    +
    +
    + +

    +setPreserveLeadingSlashes

    +
    +public void setPreserveLeadingSlashes(boolean b)
    +
    +
    Flag to indicates whether leading `/'s should + be preserved in the file names. + Optional, default is false. +

    +

    +
    Parameters:
    b - the leading slashes flag.
    +
    +
    +
    + +

    +getPreserveLeadingSlashes

    +
    +public boolean getPreserveLeadingSlashes()
    +
    +
    + +
    Returns:
    the leading slashes flag.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html new file mode 100644 index 000000000..0b59e6245 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.TarLongFileMode.html @@ -0,0 +1,500 @@ + + + + + + +Tar.TarLongFileMode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tar.TarLongFileMode

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Tar.TarLongFileMode
+
    +
    +
    Enclosing class:
    Tar
    +
    +
    +
    +
    public static class Tar.TarLongFileMode
    extends EnumeratedAttribute
    + + +

    +Set of options for long file handling in the task. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFAIL + +
    +          permissible values for longfile attribute
    +static java.lang.StringGNU + +
    +          permissible values for longfile attribute
    +static java.lang.StringOMIT + +
    +          permissible values for longfile attribute
    +static java.lang.StringTRUNCATE + +
    +          permissible values for longfile attribute
    +static java.lang.StringWARN + +
    +          permissible values for longfile attribute
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Tar.TarLongFileMode() + +
    +          Constructor, defaults to "warn"
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    + booleanisFailMode() + +
    +           
    + booleanisGnuMode() + +
    +           
    + booleanisOmitMode() + +
    +           
    + booleanisTruncateMode() + +
    +           
    + booleanisWarnMode() + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +WARN

    +
    +public static final java.lang.String WARN
    +
    +
    permissible values for longfile attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAIL

    +
    +public static final java.lang.String FAIL
    +
    +
    permissible values for longfile attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TRUNCATE

    +
    +public static final java.lang.String TRUNCATE
    +
    +
    permissible values for longfile attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +GNU

    +
    +public static final java.lang.String GNU
    +
    +
    permissible values for longfile attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +OMIT

    +
    +public static final java.lang.String OMIT
    +
    +
    permissible values for longfile attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Tar.TarLongFileMode

    +
    +public Tar.TarLongFileMode()
    +
    +
    Constructor, defaults to "warn" +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the possible values for this enumerated type.
    +
    +
    +
    + +

    +isTruncateMode

    +
    +public boolean isTruncateMode()
    +
    +
    + +
    Returns:
    true if value is "truncate".
    +
    +
    +
    + +

    +isWarnMode

    +
    +public boolean isWarnMode()
    +
    +
    + +
    Returns:
    true if value is "warn".
    +
    +
    +
    + +

    +isGnuMode

    +
    +public boolean isGnuMode()
    +
    +
    + +
    Returns:
    true if value is "gnu".
    +
    +
    +
    + +

    +isFailMode

    +
    +public boolean isFailMode()
    +
    +
    + +
    Returns:
    true if value is "fail".
    +
    +
    +
    + +

    +isOmitMode

    +
    +public boolean isOmitMode()
    +
    +
    + +
    Returns:
    true if value is "omit".
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.html new file mode 100644 index 000000000..3dbae346c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tar.html @@ -0,0 +1,1037 @@ + + + + + + +Tar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tar

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Tar
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Tar
    extends MatchingTask
    + + +

    +Creates a tar archive. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classTar.TarCompressionMethod + +
    +          Valid Modes for Compression attribute to Tar Task
    +static classTar.TarFileSet + +
    +          This is a FileSet with the option to specify permissions + and other attributes.
    +static classTar.TarLongFileMode + +
    +          Set of options for long file handling in the task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFAIL + +
    +          Deprecated. since 1.5.x. + Tar.FAIL is deprecated and is replaced with + Tar.TarLongFileMode.FAIL
    +static java.lang.StringGNU + +
    +          Deprecated. since 1.5.x. + Tar.GNU is deprecated and is replaced with + Tar.TarLongFileMode.GNU
    +static java.lang.StringOMIT + +
    +          Deprecated. since 1.5.x. + Tar.OMIT is deprecated and is replaced with + Tar.TarLongFileMode.OMIT
    +static java.lang.StringTRUNCATE + +
    +          Deprecated. since 1.5.x. + Tar.TRUNCATE is deprecated and is replaced with + Tar.TarLongFileMode.TRUNCATE
    +static java.lang.StringWARN + +
    +          Deprecated. since 1.5.x. + Tar.WARN is deprecated and is replaced with + Tar.TarLongFileMode.WARN
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Tar() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection res) + +
    +          Add a collection of resources to archive.
    +protected  booleanarchiveIsUpToDate(Resource r) + +
    +          Is the archive up to date in relationship to a list of files.
    +protected  booleanarchiveIsUpToDate(java.lang.String[] files) + +
    +          Deprecated. since 1.5.x. + use the two-arg version instead.
    +protected  booleanarchiveIsUpToDate(java.lang.String[] files, + java.io.File dir) + +
    +          Is the archive up to date in relationship to a list of files.
    +protected  Tar.TarFileSetasTarFileSet(ArchiveFileSet archiveFileSet) + +
    +          Copies fullpath, prefix and permission attributes from the + ArchiveFileSet to a new TarFileSet (or returns it unchanged if + it already is a TarFileSet).
    +protected  booleancheck(java.io.File basedir, + java.lang.String[] files) + +
    +          Checks whether the archive is out-of-date with respect to the + given files, ensures that the archive won't contain itself.
    +protected  booleancheck(ResourceCollection rc) + +
    +          Checks whether the archive is out-of-date with respect to the resources + of the given collection.
    + Tar.TarFileSetcreateTarFileSet() + +
    +          Add a new fileset with the option to specify permissions
    + voidexecute() + +
    +          do the business
    +protected static java.lang.String[]getFileNames(FileSet fs) + +
    +          Grabs all included files and directors from the FileSet and + returns them as an array of (relative) file names.
    +protected static booleanisFileFileSet(ResourceCollection rc) + +
    +          whether the given resource collection is a (subclass of) + FileSet that only contains file system resources.
    + voidsetBasedir(java.io.File baseDir) + +
    +          This is the base directory to look in for things to tar.
    + voidsetCompression(Tar.TarCompressionMethod mode) + +
    +          Set compression method.
    + voidsetDestFile(java.io.File destFile) + +
    +          Set is the name/location of where to create the tar file.
    + voidsetLongfile(java.lang.String mode) + +
    +          Deprecated. since 1.5.x. + setLongFile(String) is deprecated and is replaced with + setLongFile(Tar.TarLongFileMode) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the mode in its own class.
    + voidsetLongfile(Tar.TarLongFileMode mode) + +
    +          Set how to handle long files, those with a path>100 chars.
    + voidsetTarfile(java.io.File tarFile) + +
    +          Deprecated. since 1.5.x. + For consistency with other tasks, please use setDestFile().
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +protected  voidtar(ResourceCollection rc, + TarOutputStream tOut) + +
    +          Adds the resources contained in this collection to the archive.
    +protected  voidtarFile(java.io.File file, + TarOutputStream tOut, + java.lang.String vPath, + Tar.TarFileSet tarFileSet) + +
    +          tar a file
    +protected  voidtarResource(Resource r, + TarOutputStream tOut, + java.lang.String vPath, + Tar.TarFileSet tarFileSet) + +
    +          tar a resource
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +WARN

    +
    +public static final java.lang.String WARN
    +
    +
    Deprecated. since 1.5.x. + Tar.WARN is deprecated and is replaced with + Tar.TarLongFileMode.WARN
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAIL

    +
    +public static final java.lang.String FAIL
    +
    +
    Deprecated. since 1.5.x. + Tar.FAIL is deprecated and is replaced with + Tar.TarLongFileMode.FAIL
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TRUNCATE

    +
    +public static final java.lang.String TRUNCATE
    +
    +
    Deprecated. since 1.5.x. + Tar.TRUNCATE is deprecated and is replaced with + Tar.TarLongFileMode.TRUNCATE
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +GNU

    +
    +public static final java.lang.String GNU
    +
    +
    Deprecated. since 1.5.x. + Tar.GNU is deprecated and is replaced with + Tar.TarLongFileMode.GNU
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +OMIT

    +
    +public static final java.lang.String OMIT
    +
    +
    Deprecated. since 1.5.x. + Tar.OMIT is deprecated and is replaced with + Tar.TarLongFileMode.OMIT
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Tar

    +
    +public Tar()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +createTarFileSet

    +
    +public Tar.TarFileSet createTarFileSet()
    +
    +
    Add a new fileset with the option to specify permissions +

    +

    + +
    Returns:
    the tar fileset to be used as the nested element.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection res)
    +
    +
    Add a collection of resources to archive. +

    +

    +
    Parameters:
    res - a resource collection to archive.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setTarfile

    +
    +public void setTarfile(java.io.File tarFile)
    +
    +
    Deprecated. since 1.5.x. + For consistency with other tasks, please use setDestFile(). +

    +

    Set is the name/location of where to create the tar file. +

    +

    +
    Parameters:
    tarFile - the location of the tar file.
    +
    +
    +
    + +

    +setDestFile

    +
    +public void setDestFile(java.io.File destFile)
    +
    +
    Set is the name/location of where to create the tar file. +

    +

    +
    Parameters:
    destFile - The output of the tar
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File baseDir)
    +
    +
    This is the base directory to look in for things to tar. +

    +

    +
    Parameters:
    baseDir - the base directory.
    +
    +
    +
    + +

    +setLongfile

    +
    +public void setLongfile(java.lang.String mode)
    +
    +
    Deprecated. since 1.5.x. + setLongFile(String) is deprecated and is replaced with + setLongFile(Tar.TarLongFileMode) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the mode in its own class. +

    +

    Set how to handle long files, those with a path>100 chars. + Optional, default=warn. +

    + Allowable values are +

      +
    • truncate - paths are truncated to the maximum length +
    • fail - paths greater than the maximum cause a build exception +
    • warn - paths greater than the maximum cause a warning and GNU is used +
    • gnu - GNU extensions are used for any paths greater than the maximum. +
    • omit - paths greater than the maximum are omitted from the archive +
    +

    +

    +
    Parameters:
    mode - the mode string to handle long files.
    +
    +
    +
    + +

    +setLongfile

    +
    +public void setLongfile(Tar.TarLongFileMode mode)
    +
    +
    Set how to handle long files, those with a path>100 chars. + Optional, default=warn. +

    + Allowable values are +

      +
    • truncate - paths are truncated to the maximum length +
    • fail - paths greater than the maximum cause a build exception +
    • warn - paths greater than the maximum cause a warning and GNU is used +
    • gnu - GNU extensions are used for any paths greater than the maximum. +
    • omit - paths greater than the maximum are omitted from the archive +
    +

    +

    +
    Parameters:
    mode - the mode to handle long file names.
    +
    +
    +
    + +

    +setCompression

    +
    +public void setCompression(Tar.TarCompressionMethod mode)
    +
    +
    Set compression method. + Allowable values are +
      +
    • none - no compression +
    • gzip - Gzip compression +
    • bzip2 - Bzip2 compression +
    +

    +

    +
    Parameters:
    mode - the compression method.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    do the business +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +tarFile

    +
    +protected void tarFile(java.io.File file,
+                       TarOutputStream tOut,
+                       java.lang.String vPath,
+                       Tar.TarFileSet tarFileSet)
+                throws java.io.IOException
    +
    +
    tar a file +

    +

    +
    Parameters:
    file - the file to tar
    tOut - the output stream
    vPath - the path name of the file to tar
    tarFileSet - the fileset that the file came from. +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +tarResource

    +
    +protected void tarResource(Resource r,
+                           TarOutputStream tOut,
+                           java.lang.String vPath,
+                           Tar.TarFileSet tarFileSet)
+                    throws java.io.IOException
    +
    +
    tar a resource +

    +

    +
    Parameters:
    r - the resource to tar
    tOut - the output stream
    vPath - the path name of the file to tar
    tarFileSet - the fileset that the file came from, may be null. +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +archiveIsUpToDate

    +
    +protected boolean archiveIsUpToDate(java.lang.String[] files)
    +
    +
    Deprecated. since 1.5.x. + use the two-arg version instead. +

    +

    Is the archive up to date in relationship to a list of files. +

    +

    +
    Parameters:
    files - the files to check +
    Returns:
    true if the archive is up to date.
    +
    +
    +
    + +

    +archiveIsUpToDate

    +
    +protected boolean archiveIsUpToDate(java.lang.String[] files,
+                                    java.io.File dir)
    +
    +
    Is the archive up to date in relationship to a list of files. +

    +

    +
    Parameters:
    files - the files to check
    dir - the base directory for the files. +
    Returns:
    true if the archive is up to date.
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +archiveIsUpToDate

    +
    +protected boolean archiveIsUpToDate(Resource r)
    +
    +
    Is the archive up to date in relationship to a list of files. +

    +

    +
    Parameters:
    r - the files to check +
    Returns:
    true if the archive is up to date.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <tar>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    + +
    Returns:
    true for this task.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +check

    +
    +protected boolean check(ResourceCollection rc)
    +
    +
    Checks whether the archive is out-of-date with respect to the resources + of the given collection. + +

    Also checks that either all collections only contain file + resources or this class supports non-file collections.

    + +

    And - in case of file-collections - ensures that the archive won't + contain itself.

    +

    +

    +
    Parameters:
    rc - the resource collection to check +
    Returns:
    whether the archive is up-to-date
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +check

    +
    +protected boolean check(java.io.File basedir,
+                        java.lang.String[] files)
    +
    +
    Checks whether the archive is out-of-date with respect to the + given files, ensures that the archive won't contain itself.

    +

    +

    +
    Parameters:
    basedir - base directory for file names
    files - array of relative file names +
    Returns:
    whether the archive is up-to-date
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +tar

    +
    +protected void tar(ResourceCollection rc,
+                   TarOutputStream tOut)
+            throws java.io.IOException
    +
    +
    Adds the resources contained in this collection to the archive. + +

    Uses the file based methods for file resources for backwards + compatibility.

    +

    +

    +
    Parameters:
    rc - the collection containing resources to add
    tOut - stream writing to the archive. +
    Throws: +
    java.io.IOException - on error.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +isFileFileSet

    +
    +protected static boolean isFileFileSet(ResourceCollection rc)
    +
    +
    whether the given resource collection is a (subclass of) + FileSet that only contains file system resources. +

    +

    +
    Parameters:
    rc - the resource collection to check. +
    Returns:
    true if the collection is a fileset.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getFileNames

    +
    +protected static java.lang.String[] getFileNames(FileSet fs)
    +
    +
    Grabs all included files and directors from the FileSet and + returns them as an array of (relative) file names. +

    +

    +
    Parameters:
    fs - the fileset to operate on. +
    Returns:
    a list of the filenames.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +asTarFileSet

    +
    +protected Tar.TarFileSet asTarFileSet(ArchiveFileSet archiveFileSet)
    +
    +
    Copies fullpath, prefix and permission attributes from the + ArchiveFileSet to a new TarFileSet (or returns it unchanged if + it already is a TarFileSet). +

    +

    +
    Parameters:
    archiveFileSet - fileset to copy attributes from, may be null +
    Returns:
    a new TarFileSet.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TaskOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TaskOutputStream.html new file mode 100644 index 000000000..121fad3fb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TaskOutputStream.html @@ -0,0 +1,253 @@ + + + + + + +TaskOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class TaskOutputStream

    +
    +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.taskdefs.TaskOutputStream
+
    +
    +
    All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable
    +
    +
    +Deprecated. since 1.2.x. + Use LogOutputStream instead. +

    +

    +
    public class TaskOutputStream
    extends java.io.OutputStream
    + + +

    +Redirects text written to a stream thru the standard + ant logging mechanism. This class is useful for integrating + with tools that write to System.out and System.err. For example, + the following will cause all text written to System.out to be + logged with "info" priority: + 

    System.setOut(new PrintStream(new TaskOutputStream(project, Project.MSG_INFO)));
    + +

    As of Ant 1.2, this class is considered to be dead code + by the Ant developers and is unmaintained. Don't use + it.

    +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidwrite(int c) + +
    +          Deprecated. Write a character to the output stream.
    +  + + + + + + + +
    Methods inherited from class java.io.OutputStream
    close, flush, write, write
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +write

    +
    +public void write(int c)
+           throws java.io.IOException
    +
    +
    Deprecated. 
    Write a character to the output stream. This method looks + to make sure that there isn't an error being reported and + will flush each line of input out to the project's log stream. +

    +

    +
    Specified by:
    write in class java.io.OutputStream
    +
    +
    +
    Parameters:
    c - the character to write +
    Throws: +
    java.io.IOException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Taskdef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Taskdef.html new file mode 100644 index 000000000..0b2c42b0b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Taskdef.html @@ -0,0 +1,342 @@ + + + + + + +Taskdef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Taskdef

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.Definer
+                      extended by org.apache.tools.ant.taskdefs.Typedef
+                          extended by org.apache.tools.ant.taskdefs.Taskdef
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Taskdef
    extends Typedef
    + + +

    +Adds a task definition to the current project, such that this new task can be + used in the current project. Two attributes are needed, the name that identifies + this task uniquely, and the full name of the class (including the packages) that + implements this task.

    +

    You can also define a group of tasks at once using the file or + resource attributes. These attributes point to files in the format of + Java property files. Each line defines a single task in the + format:

    + 
    + taskname=fully.qualified.java.classname
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Definer
    Definer.Format, Definer.OnError
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Taskdef() + +
    +          Default constructor.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Definer
    addDefinition, execute, getClassname, getFile, getName, getResource, loadProperties, makeResourceFromURI, setAdapter, setAdapterClass, setAdaptTo, setAdaptToClass, setAntlib, setClassname, setFile, setFormat, setName, setOnError, setResource, setRestrict
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
    createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Taskdef

    +
    +public Taskdef()
    +
    +
    Default constructor. + Creates a new Taskdef instance. + This sets the adapter and the adaptto classes to + TaskAdapter and Task. +

    +

    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TempFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TempFile.html new file mode 100644 index 000000000..1b8304f5b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/TempFile.html @@ -0,0 +1,497 @@ + + + + + + +TempFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class TempFile

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.TempFile
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class TempFile
    extends Task
    + + +

    +This task sets a property to the name of a temporary file. + Unlike File.createTempFile(java.lang.String, java.lang.String, java.io.File), this task does not (by default) actually create the + temporary file, but it does guarantee that the file did not + exist when the task was executed. +

    + Examples + 

    <tempfile property="temp.file" />
    + create a temporary file + 
    <tempfile property="temp.file" suffix=".xml" />
    + create a temporary file with the .xml suffix. + 
    <tempfile property="temp.file" destDir="build"/>
    + create a temp file in the build subdir +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TempFile() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Creates the temporary file.
    + booleanisCreateFile() + +
    +          Learn whether createFile flag is set for this tempfile task.
    + booleanisDeleteOnExit() + +
    +          Learn whether deleteOnExit is set for this tempfile task.
    + voidsetCreateFile(boolean createFile) + +
    +          If set the file is actually created, if not just a name is created.
    + voidsetDeleteOnExit(boolean deleteOnExit) + +
    +          Set whether the tempfile created by this task should be set + for deletion on normal VM exit.
    + voidsetDestDir(java.io.File destDir) + +
    +          Sets the destination directory.
    + voidsetPrefix(java.lang.String prefix) + +
    +          Sets the optional prefix string for the temp file.
    + voidsetProperty(java.lang.String property) + +
    +          Sets the property you wish to assign the temporary file to.
    + voidsetSuffix(java.lang.String suffix) + +
    +          Sets the optional suffix string for the temp file.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TempFile

    +
    +public TempFile()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Sets the property you wish to assign the temporary file to. +

    +

    +
    Parameters:
    property - The property to set
    +
    +
    +
    + +

    +setDestDir

    +
    +public void setDestDir(java.io.File destDir)
    +
    +
    Sets the destination directory. If not set, + the basedir directory is used instead. +

    +

    +
    Parameters:
    destDir - The new destDir value
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    Sets the optional prefix string for the temp file. +

    +

    +
    Parameters:
    prefix - string to prepend to generated string
    +
    +
    +
    + +

    +setSuffix

    +
    +public void setSuffix(java.lang.String suffix)
    +
    +
    Sets the optional suffix string for the temp file. +

    +

    +
    Parameters:
    suffix - suffix including any "." , e.g ".xml"
    +
    +
    +
    + +

    +setDeleteOnExit

    +
    +public void setDeleteOnExit(boolean deleteOnExit)
    +
    +
    Set whether the tempfile created by this task should be set + for deletion on normal VM exit. +

    +

    +
    Parameters:
    deleteOnExit - boolean flag.
    +
    +
    +
    + +

    +isDeleteOnExit

    +
    +public boolean isDeleteOnExit()
    +
    +
    Learn whether deleteOnExit is set for this tempfile task. +

    +

    + +
    Returns:
    boolean deleteOnExit flag.
    +
    +
    +
    + +

    +setCreateFile

    +
    +public void setCreateFile(boolean createFile)
    +
    +
    If set the file is actually created, if not just a name is created. +

    +

    +
    Parameters:
    createFile - boolean flag.
    +
    +
    +
    + +

    +isCreateFile

    +
    +public boolean isCreateFile()
    +
    +
    Learn whether createFile flag is set for this tempfile task. +

    +

    + +
    Returns:
    the createFile flag.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Creates the temporary file. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong with the build
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.DateFormatFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.DateFormatFactory.html new file mode 100644 index 000000000..43eec0952 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.DateFormatFactory.html @@ -0,0 +1,223 @@ + + + + + + +Touch.DateFormatFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface Touch.DateFormatFactory

    +
    +
    Enclosing class:
    Touch
    +
    +
    +
    +
    public static interface Touch.DateFormatFactory
    + + +

    +

    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.text.DateFormatgetFallbackFormat() + +
    +           
    + java.text.DateFormatgetPrimaryFormat() + +
    +           
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getPrimaryFormat

    +
    +java.text.DateFormat getPrimaryFormat()
    +
    +
    +
    +
    +
    +
    + +

    +getFallbackFormat

    +
    +java.text.DateFormat getFallbackFormat()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.html new file mode 100644 index 000000000..342d4c57a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Touch.html @@ -0,0 +1,697 @@ + + + + + + +Touch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Touch

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Touch
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Touch
    extends Task
    + + +

    +Touch a file and/or fileset(s) and/or filelist(s); + corresponds to the Unix touch command. + +

    If the file to touch doesn't exist, an empty one is created.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceTouch.DateFormatFactory + +
    +           
    +  + + + + + + + + + + +
    +Field Summary
    +static Touch.DateFormatFactoryDEFAULT_DF_FACTORY + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Touch() + +
    +          Construct a new Touch task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Add a FileNameMapper.
    + voidadd(ResourceCollection rc) + +
    +          Add a collection of resources to touch.
    + voidaddConfiguredMapper(Mapper mapper) + +
    +          Add a Mapper.
    + voidaddFilelist(FileList list) + +
    +          Add a filelist to touch.
    + voidaddFileset(FileSet set) + +
    +          Add a set of files to touch.
    +protected  voidcheckConfiguration() + +
    +          Check that this task has been configured properly.
    + voidexecute() + +
    +          Execute the touch operation.
    + voidsetDatetime(java.lang.String dateTime) + +
    +          Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM".
    + voidsetFile(java.io.File file) + +
    +          Sets a single source file to touch.
    + voidsetMillis(long millis) + +
    +          Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970.
    + voidsetMkdirs(boolean mkdirs) + +
    +          Set whether nonexistent parent directories should be created + when touching new files.
    + voidsetPattern(java.lang.String pattern) + +
    +          Set the format of the datetime attribute.
    + voidsetVerbose(boolean verbose) + +
    +          Set whether the touch task will report every file it creates; + defaults to true.
    +protected  voidtouch() + +
    +          Does the actual work; assumes everything has been checked by now.
    +protected  voidtouch(java.io.File file) + +
    +          Deprecated. since 1.6.x.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_DF_FACTORY

    +
    +public static final Touch.DateFormatFactory DEFAULT_DF_FACTORY
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Touch

    +
    +public Touch()
    +
    +
    Construct a new Touch task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Sets a single source file to touch. If the file does not exist + an empty file will be created. +

    +

    +
    Parameters:
    file - the File to touch.
    +
    +
    +
    + +

    +setMillis

    +
    +public void setMillis(long millis)
    +
    +
    Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970. Optional, default=now. +

    +

    +
    Parameters:
    millis - the long timestamp to use.
    +
    +
    +
    + +

    +setDatetime

    +
    +public void setDatetime(java.lang.String dateTime)
    +
    +
    Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM". + Optional, default=now. +

    +

    +
    Parameters:
    dateTime - the String date in the specified format.
    +
    +
    +
    + +

    +setMkdirs

    +
    +public void setMkdirs(boolean mkdirs)
    +
    +
    Set whether nonexistent parent directories should be created + when touching new files. +

    +

    +
    Parameters:
    mkdirs - boolean whether to create parent directories.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    Set whether the touch task will report every file it creates; + defaults to true. +

    +

    +
    Parameters:
    verbose - boolean flag.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String pattern)
    +
    +
    Set the format of the datetime attribute. +

    +

    +
    Parameters:
    pattern - the SimpleDateFormat-compatible format pattern.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +addConfiguredMapper

    +
    +public void addConfiguredMapper(Mapper mapper)
    +
    +
    Add a Mapper. +

    +

    +
    Parameters:
    mapper - the Mapper to add.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
+         throws BuildException
    +
    +
    Add a FileNameMapper. +

    +

    +
    Parameters:
    fileNameMapper - the FileNameMapper to add. +
    Throws: +
    BuildException - if multiple mappers are added.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Add a set of files to touch. +

    +

    +
    Parameters:
    set - the Fileset to add.
    +
    +
    +
    + +

    +addFilelist

    +
    +public void addFilelist(FileList list)
    +
    +
    Add a filelist to touch. +

    +

    +
    Parameters:
    list - the Filelist to add.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a collection of resources to touch. +

    +

    +
    Parameters:
    rc - the collection to add.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
+                           throws BuildException
    +
    +
    Check that this task has been configured properly. +

    +

    + +
    Throws: +
    BuildException - if configuration errors are detected.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the touch operation. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +touch

    +
    +protected void touch()
+              throws BuildException
    +
    +
    Does the actual work; assumes everything has been checked by now. +

    +

    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +touch

    +
    +protected void touch(java.io.File file)
    +
    +
    Deprecated. since 1.6.x. +

    +

    Touch a single file with the current timestamp (this.millis). This method + does not interact with any nested mappers and remains for reasons of + backwards-compatibility only. +

    +

    +
    Parameters:
    file - file to touch +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Transform.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Transform.html new file mode 100644 index 000000000..36ed6d253 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Transform.html @@ -0,0 +1,333 @@ + + + + + + +Transform (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Transform

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.Transform
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Transform
    extends ExecuteOn
    + + +

    +Has been merged into ExecuteOn, empty class for backwards compatibility. + We leave that in case that external programs access this class directly, + for example via + Transform tr = (Transform) getProject().createTask("apply") +

    + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    ExecuteOn.FileDirBoth
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
    cmdl, failOnError, newEnvironment, redirector, redirectorElement
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Transform() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
    add, add, addDirset, addFilelist, addFileset, checkConfiguration, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setAddsourcefile, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setSkipEmptyFilesets, setType, setupRedirector, setVerbose
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
    addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, isValidOs, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setCommand, setDir, setError, setErrorProperty, setExecutable, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Transform

    +
    +public Transform()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Truncate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Truncate.html new file mode 100644 index 000000000..8875f0b9a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Truncate.html @@ -0,0 +1,445 @@ + + + + + + +Truncate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Truncate

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Truncate
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Truncate
    extends Task
    + + +

    +Set the length of one or more files, as the intermittently available + truncate Unix utility/function. +

    + +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Truncate() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Add a nested (filesystem-only) ResourceCollection.
    + voidexecute() + +
    +          Called by the project to let the task do its work..
    + voidsetAdjust(java.lang.Long adjust) + +
    +          Set the amount by which files' lengths should be adjusted.
    + voidsetCreate(boolean create) + +
    +          Set whether to create nonexistent files.
    + voidsetFile(java.io.File f) + +
    +          Set a single target File.
    + voidsetLength(java.lang.Long length) + +
    +          Set the length to which files should be set.
    + voidsetMkdirs(boolean mkdirs) + +
    +          Set whether, when creating nonexistent files, nonexistent directories + should also be created.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Truncate

    +
    +public Truncate()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File f)
    +
    +
    Set a single target File. +

    +

    +
    Parameters:
    f - the single File
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a nested (filesystem-only) ResourceCollection. +

    +

    +
    Parameters:
    rc - the ResourceCollection to add.
    +
    +
    +
    + +

    +setAdjust

    +
    +public void setAdjust(java.lang.Long adjust)
    +
    +
    Set the amount by which files' lengths should be adjusted. + It is permissible to append K / M / G / T / P. +

    +

    +
    Parameters:
    adjust - (positive or negative) adjustment amount.
    +
    +
    +
    + +

    +setLength

    +
    +public void setLength(java.lang.Long length)
    +
    +
    Set the length to which files should be set. + It is permissible to append K / M / G / T / P. +

    +

    +
    Parameters:
    length - (positive) adjustment amount.
    +
    +
    +
    + +

    +setCreate

    +
    +public void setCreate(boolean create)
    +
    +
    Set whether to create nonexistent files. +

    +

    +
    Parameters:
    create - boolean, default true.
    +
    +
    +
    + +

    +setMkdirs

    +
    +public void setMkdirs(boolean mkdirs)
    +
    +
    Set whether, when creating nonexistent files, nonexistent directories + should also be created. +

    +

    +
    Parameters:
    mkdirs - boolean, default false.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice.. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.CustomFormat.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.CustomFormat.html new file mode 100644 index 000000000..a02d2951c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.CustomFormat.html @@ -0,0 +1,448 @@ + + + + + + +Tstamp.CustomFormat (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tstamp.CustomFormat

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Tstamp.CustomFormat
+
    +
    +
    Enclosing class:
    Tstamp
    +
    +
    +
    +
    public class Tstamp.CustomFormat
    extends java.lang.Object
    + + +

    +This nested element that allows a property to be set + to the current date and time in a given format. + The date/time patterns are as defined in the + Java SimpleDateFormat class. + The format element also allows offsets to be applied to + the time to generate different time values. +

    + +

    +

    +
    To do:
    +
    consider refactoring out into a re-usable element.
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Tstamp.CustomFormat() + +
    +          Create a format
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute(Project project, + java.util.Date date, + Location location) + +
    +          validate parameter and execute the format.
    + voidsetLocale(java.lang.String locale) + +
    +          The locale used to create date/time string.
    + voidsetOffset(int offset) + +
    +          The numeric offset to the current time.
    + voidsetPattern(java.lang.String pattern) + +
    +          The date/time pattern to be used.
    + voidsetProperty(java.lang.String propertyName) + +
    +          The property to receive the date/time string in the given pattern
    + voidsetTimezone(java.lang.String id) + +
    +          The timezone to use for displaying time.
    + voidsetUnit(java.lang.String unit) + +
    +          Deprecated. since 1.5.x. + setUnit(String) is deprecated and is replaced with + setUnit(Tstamp.Unit) to make Ant's + Introspection mechanism do the work and also to + encapsulate operations on the unit in its own + class.
    + voidsetUnit(Tstamp.Unit unit) + +
    +          The unit of the offset to be applied to the current time.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Tstamp.CustomFormat

    +
    +public Tstamp.CustomFormat()
    +
    +
    Create a format +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String propertyName)
    +
    +
    The property to receive the date/time string in the given pattern +

    +

    +
    Parameters:
    propertyName - the name of the property.
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String pattern)
    +
    +
    The date/time pattern to be used. The values are as + defined by the Java SimpleDateFormat class. +

    +

    +
    Parameters:
    pattern - the pattern to use.
    See Also:
    SimpleDateFormat
    +
    +
    +
    + +

    +setLocale

    +
    +public void setLocale(java.lang.String locale)
    +
    +
    The locale used to create date/time string. + The general form is "language, country, variant" but + either variant or variant and country may be omitted. + For more information please refer to documentation + for the java.util.Locale class. +

    +

    +
    Parameters:
    locale - the locale to use.
    See Also:
    Locale
    +
    +
    +
    + +

    +setTimezone

    +
    +public void setTimezone(java.lang.String id)
    +
    +
    The timezone to use for displaying time. + The values are as defined by the Java TimeZone class. +

    +

    +
    Parameters:
    id - the timezone value.
    See Also:
    TimeZone
    +
    +
    +
    + +

    +setOffset

    +
    +public void setOffset(int offset)
    +
    +
    The numeric offset to the current time. +

    +

    +
    Parameters:
    offset - the offset to use.
    +
    +
    +
    + +

    +setUnit

    +
    +public void setUnit(java.lang.String unit)
    +
    +
    Deprecated. since 1.5.x. + setUnit(String) is deprecated and is replaced with + setUnit(Tstamp.Unit) to make Ant's + Introspection mechanism do the work and also to + encapsulate operations on the unit in its own + class. +

    +

    Set the unit type (using String). +

    +

    +
    Parameters:
    unit - the unit to use.
    +
    +
    +
    + +

    +setUnit

    +
    +public void setUnit(Tstamp.Unit unit)
    +
    +
    The unit of the offset to be applied to the current time. + Valid Values are +
      +
    • millisecond
      • +
    • second
      • +
    • minute
      • +
    • hour
      • +
    • day
      • +
    • week
      • +
    • month
      • +
    • year
      • +
    + The default unit is day. +

    +

    +
    Parameters:
    unit - the unit to use.
    +
    +
    +
    + +

    +execute

    +
    +public void execute(Project project,
+                    java.util.Date date,
+                    Location location)
    +
    +
    validate parameter and execute the format. +

    +

    +
    Parameters:
    project - project to set property in.
    date - date to use as a starting point.
    location - line in file (for errors)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.Unit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.Unit.html new file mode 100644 index 000000000..4b624e351 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.Unit.html @@ -0,0 +1,312 @@ + + + + + + +Tstamp.Unit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tstamp.Unit

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Tstamp.Unit
+
    +
    +
    Enclosing class:
    Tstamp
    +
    +
    +
    +
    public static class Tstamp.Unit
    extends EnumeratedAttribute
    + + +

    +set of valid units to use for time offsets. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Tstamp.Unit() + +
    +          Constructor for Unit enumerated type.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetCalendarField() + +
    +          Convert the value to int unit value.
    + java.lang.String[]getValues() + +
    +          Get the valid values.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Tstamp.Unit

    +
    +public Tstamp.Unit()
    +
    +
    Constructor for Unit enumerated type. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getCalendarField

    +
    +public int getCalendarField()
    +
    +
    Convert the value to int unit value. +

    +

    + +
    Returns:
    an int value.
    +
    +
    +
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get the valid values. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the value values.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.html new file mode 100644 index 000000000..99783b940 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Tstamp.html @@ -0,0 +1,387 @@ + + + + + + +Tstamp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Tstamp

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Tstamp
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Tstamp
    extends Task
    + + +

    +Sets properties to the current time, or offsets from the current time. + The default properties are TSTAMP, DSTAMP and TODAY; +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    + classTstamp.CustomFormat + +
    +          This nested element that allows a property to be set + to the current date and time in a given format.
    +static classTstamp.Unit + +
    +          set of valid units to use for time offsets.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Tstamp() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + Tstamp.CustomFormatcreateFormat() + +
    +          create a custom format with the current prefix.
    + voidexecute() + +
    +          create the timestamps.
    + voidsetPrefix(java.lang.String prefix) + +
    +          Set a prefix for the properties.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Tstamp

    +
    +public Tstamp()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    Set a prefix for the properties. If the prefix does not end with a "." + one is automatically added. +

    +

    +
    Parameters:
    prefix - the prefix to use.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    create the timestamps. Custom ones are done before + the standard ones, to get their retaliation in early. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +createFormat

    +
    +public Tstamp.CustomFormat createFormat()
    +
    +
    create a custom format with the current prefix. +

    +

    + +
    Returns:
    a ready to fill-in format
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Typedef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Typedef.html new file mode 100644 index 000000000..29936fba9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Typedef.html @@ -0,0 +1,344 @@ + + + + + + +Typedef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Typedef

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.Definer
+                      extended by org.apache.tools.ant.taskdefs.Typedef
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    Taskdef
    +
    +
    +
    +
    public class Typedef
    extends Definer
    + + +

    +Adds a data type definition to the current project. + Two attributes are + needed, the name that identifies this data type uniquely, and the full + name of the class (including the packages) that implements this + type. +

    You can also define a group of data types at once using the file or + resource attributes. These attributes point to files in the format of + Java property files. Each line defines a single data type in the + format:

    + 
    + typename=fully.qualified.java.classname
+
    +

    Typedef should be used to add your own types to the system. Data + types are things likepaths or filesets that can be defined at + the project level and referenced via their ID attribute.

    +

    Custom data types usually need custom tasks to put them to good use.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Definer
    Definer.Format, Definer.OnError
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Typedef() + +
    +           
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Definer
    addDefinition, execute, getClassname, getFile, getName, getResource, loadProperties, makeResourceFromURI, setAdapter, setAdapterClass, setAdaptTo, setAdaptToClass, setAntlib, setClassname, setFile, setFormat, setName, setOnError, setResource, setRestrict
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
    createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
    getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Typedef

    +
    +public Typedef()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Unpack.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Unpack.html new file mode 100644 index 000000000..2bd5e3140 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Unpack.html @@ -0,0 +1,592 @@ + + + + + + +Unpack (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Unpack

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Unpack
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    BUnzip2, GUnzip
    +
    +
    +
    +
    public abstract class Unpack
    extends Task
    + + +

    +Abstract Base class for unpack tasks. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.io.Filedest + +
    +           
    +protected  java.io.Filesource + +
    +           
    +protected  ResourcesrcResource + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Unpack() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source Archive resource.
    + voidexecute() + +
    +          Execute the task.
    +protected abstract  voidextract() + +
    +          Do the uncompressing.
    +protected abstract  java.lang.StringgetDefaultExtension() + +
    +          Get the extension.
    + voidsetDest(java.io.File dest) + +
    +          The destination file or directory; optional.
    + voidsetDest(java.lang.String dest) + +
    +          Deprecated. since 1.5.x. + setDest(String) is deprecated and is replaced with + setDest(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class.
    + voidsetSrc(java.io.File src) + +
    +          The file to expand; required.
    + voidsetSrc(java.lang.String src) + +
    +          Deprecated. since 1.5.x. + setSrc(String) is deprecated and is replaced with + setSrc(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class.
    + voidsetSrcResource(Resource src) + +
    +          The resource to expand; required.
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +source

    +
    +protected java.io.File source
    +
    +
    +
    +
    +
    + +

    +dest

    +
    +protected java.io.File dest
    +
    +
    +
    +
    +
    + +

    +srcResource

    +
    +protected Resource srcResource
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Unpack

    +
    +public Unpack()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrc

    +
    +public void setSrc(java.lang.String src)
    +
    +
    Deprecated. since 1.5.x. + setSrc(String) is deprecated and is replaced with + setSrc(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +

    +

    +
    Parameters:
    src - a String value
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.lang.String dest)
    +
    +
    Deprecated. since 1.5.x. + setDest(String) is deprecated and is replaced with + setDest(File) to make Ant's Introspection + mechanism do the work and also to encapsulate operations on + the type in its own class. +

    +

    +
    Parameters:
    dest - a String value
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    The file to expand; required. +

    +

    +
    Parameters:
    src - file to expand
    +
    +
    +
    + +

    +setSrcResource

    +
    +public void setSrcResource(Resource src)
    +
    +
    The resource to expand; required. +

    +

    +
    Parameters:
    src - resource to expand
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source Archive resource. +

    +

    +
    Parameters:
    a - the archive as a single element Resource collection.
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File dest)
    +
    +
    The destination file or directory; optional. +

    +

    +
    Parameters:
    dest - destination file or directory
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getDefaultExtension

    +
    +protected abstract java.lang.String getDefaultExtension()
    +
    +
    Get the extension. + This is to be overridden by subclasses. +

    +

    + +
    Returns:
    the default extension.
    +
    +
    +
    + +

    +extract

    +
    +protected abstract void extract()
    +
    +
    Do the uncompressing. + This is to be overridden by subclasses. +

    +

    +
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns false.

    +

    +

    + +
    Returns:
    false for this task.
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.UntarCompressionMethod.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.UntarCompressionMethod.html new file mode 100644 index 000000000..332df64bb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.UntarCompressionMethod.html @@ -0,0 +1,322 @@ + + + + + + +Untar.UntarCompressionMethod (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Untar.UntarCompressionMethod

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Untar.UntarCompressionMethod
+
    +
    +
    Enclosing class:
    Untar
    +
    +
    +
    +
    public static final class Untar.UntarCompressionMethod
    extends EnumeratedAttribute
    + + +

    +Valid Modes for Compression attribute to Untar Task +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Untar.UntarCompressionMethod() + +
    +          Constructor
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.io.InputStreamdecompress(java.lang.String name, + java.io.InputStream istream) + +
    +          This method wraps the input stream with the + corresponding decompression method
    + java.lang.String[]getValues() + +
    +          Get valid enumeration values
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Untar.UntarCompressionMethod

    +
    +public Untar.UntarCompressionMethod()
    +
    +
    Constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Get valid enumeration values +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    valid values
    +
    +
    +
    + +

    +decompress

    +
    +public java.io.InputStream decompress(java.lang.String name,
+                                      java.io.InputStream istream)
+                               throws java.io.IOException,
+                                      BuildException
    +
    +
    This method wraps the input stream with the + corresponding decompression method +

    +

    +
    Parameters:
    name - provides location information for BuildException
    istream - input stream +
    Returns:
    input stream with on-the-fly decompression +
    Throws: +
    java.io.IOException - thrown by GZIPInputStream constructor +
    BuildException - thrown if bzip stream does not + start with expected magic values
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.html new file mode 100644 index 000000000..1e4966d2a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Untar.html @@ -0,0 +1,468 @@ + + + + + + +Untar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Untar

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.Expand
+              extended by org.apache.tools.ant.taskdefs.Untar
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Untar
    extends Expand
    + + +

    +Untar a file. +

    PatternSets are used to select files to extract + from the archive. If no patternset is used, all files are extracted. +

    +

    FileSets may be used to select archived files + to perform unarchival upon. +

    +

    File permissions will not be restored on extracted files.

    +

    The untar task recognizes the long pathname entries used by GNU tar.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classUntar.UntarCompressionMethod + +
    +          Valid Modes for Compression attribute to Untar Task
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Expand
    ERROR_MULTIPLE_MAPPERS, NATIVE_ENCODING
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Untar() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidexpandFile(FileUtils fileUtils, + java.io.File srcF, + java.io.File dir) + +
    +          This method is to be overridden by extending unarchival tasks.
    +protected  voidexpandResource(Resource srcR, + java.io.File dir) + +
    +          This method is to be overridden by extending unarchival tasks.
    + voidsetCompression(Untar.UntarCompressionMethod method) + +
    +          Set decompression algorithm to use; default=none.
    + voidsetEncoding(java.lang.String encoding) + +
    +          No encoding support in Untar.
    + voidsetScanForUnicodeExtraFields(boolean b) + +
    +          No unicode extra fields in tar.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Expand
    add, add, addFileset, addPatternset, createMapper, execute, extractFile, getEncoding, getFailOnEmptyArchive, getMapper, getScanForUnicodeExtraFields, internalSetEncoding, internalSetScanForUnicodeExtraFields, setDest, setFailOnEmptyArchive, setOverwrite, setSrc, setStripAbsolutePathSpec
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Untar

    +
    +public Untar()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCompression

    +
    +public void setCompression(Untar.UntarCompressionMethod method)
    +
    +
    Set decompression algorithm to use; default=none. + + Allowable values are +
      +
    • none - no compression +
    • gzip - Gzip compression +
    • bzip2 - Bzip2 compression +
    +

    +

    +
    Parameters:
    method - compression method
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    No encoding support in Untar. +

    +

    +
    Overrides:
    setEncoding in class Expand
    +
    +
    +
    Parameters:
    encoding - not used +
    Throws: +
    BuildException - always
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setScanForUnicodeExtraFields

    +
    +public void setScanForUnicodeExtraFields(boolean b)
    +
    +
    No unicode extra fields in tar. +

    +

    +
    Overrides:
    setScanForUnicodeExtraFields in class Expand
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +expandFile

    +
    +protected void expandFile(FileUtils fileUtils,
+                          java.io.File srcF,
+                          java.io.File dir)
    +
    +
    This method is to be overridden by extending unarchival tasks. +

    +

    +
    Overrides:
    expandFile in class Expand
    +
    +
    +
    Parameters:
    fileUtils - the fileUtils
    srcF - the source file
    dir - the destination directory
    +
    +
    +
    + +

    +expandResource

    +
    +protected void expandResource(Resource srcR,
+                              java.io.File dir)
    +
    +
    This method is to be overridden by extending unarchival tasks. +

    +

    +
    Overrides:
    expandResource in class Expand
    +
    +
    +
    Parameters:
    srcR - the source resource
    dir - the destination directory
    Since:
    +
    Ant 1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/UpToDate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/UpToDate.html new file mode 100644 index 000000000..d1d3de4e2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/UpToDate.html @@ -0,0 +1,606 @@ + + + + + + +UpToDate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class UpToDate

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.UpToDate
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class UpToDate
    extends Task
    implements Condition
    + + +

    +Sets the given property if the specified target has a timestamp + greater than all of the source files. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected  MappermapperElement + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    UpToDate() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          A nested filenamemapper
    + voidaddSrcfiles(FileSet fs) + +
    +          Nested <srcfiles> element.
    + MappercreateMapper() + +
    +          Defines the FileNameMapper to use (nested mapper element).
    + UnioncreateSrcResources() + +
    +          Nested resource collections as sources.
    + booleaneval() + +
    +          Evaluate (all) target and source file(s) to + see if the target(s) is/are up-to-date.
    + voidexecute() + +
    +          Sets property to true if target file(s) have a more recent timestamp + than (each of) the corresponding source file(s).
    +protected  booleanscanDir(java.io.File srcDir, + java.lang.String[] files) + +
    +          Scan a directory for files to check for "up to date"ness
    + voidsetProperty(java.lang.String property) + +
    +          The property to set if the target file is more up-to-date than + (each of) the source file(s).
    + voidsetSrcfile(java.io.File file) + +
    +          The file that must be older than the target file + if the property is to be set.
    + voidsetTargetFile(java.io.File file) + +
    +          The file which must be more up-to-date than (each of) the source file(s) + if the property is to be set.
    + voidsetValue(java.lang.String value) + +
    +          The value to set the named property to if the target file is more + up-to-date than (each of) the source file(s).
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +mapperElement

    +
    +protected Mapper mapperElement
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +UpToDate

    +
    +public UpToDate()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    The property to set if the target file is more up-to-date than + (each of) the source file(s). +

    +

    +
    +
    +
    +
    Parameters:
    property - the name of the property to set if Target is up-to-date.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    The value to set the named property to if the target file is more + up-to-date than (each of) the source file(s). Defaults to 'true'. +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to set the property to if Target is up-to-date
    +
    +
    +
    + +

    +setTargetFile

    +
    +public void setTargetFile(java.io.File file)
    +
    +
    The file which must be more up-to-date than (each of) the source file(s) + if the property is to be set. +

    +

    +
    +
    +
    +
    Parameters:
    file - the file we are checking against.
    +
    +
    +
    + +

    +setSrcfile

    +
    +public void setSrcfile(java.io.File file)
    +
    +
    The file that must be older than the target file + if the property is to be set. +

    +

    +
    +
    +
    +
    Parameters:
    file - the file we are checking against the target file.
    +
    +
    +
    + +

    +addSrcfiles

    +
    +public void addSrcfiles(FileSet fs)
    +
    +
    Nested <srcfiles> element. +

    +

    +
    +
    +
    +
    Parameters:
    fs - the source files
    +
    +
    +
    + +

    +createSrcResources

    +
    +public Union createSrcResources()
    +
    +
    Nested resource collections as sources. +

    +

    +
    +
    +
    + +
    Returns:
    the source resources to configure.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Defines the FileNameMapper to use (nested mapper element). +

    +

    +
    +
    +
    + +
    Returns:
    a mapper to be configured +
    Throws: +
    BuildException - if more than one mapper is defined
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    A nested filenamemapper +

    +

    +
    +
    +
    +
    Parameters:
    fileNameMapper - the mapper to add
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Evaluate (all) target and source file(s) to + see if the target(s) is/are up-to-date. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the target(s) is/are up-to-date
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Sets property to true if target file(s) have a more recent timestamp + than (each of) the corresponding source file(s). +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +scanDir

    +
    +protected boolean scanDir(java.io.File srcDir,
+                          java.lang.String[] files)
    +
    +
    Scan a directory for files to check for "up to date"ness +

    +

    +
    +
    +
    +
    Parameters:
    srcDir - the directory
    files - the files to scan for +
    Returns:
    true if the files are up to date
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/VerifyJar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/VerifyJar.html new file mode 100644 index 000000000..a1c33fe51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/VerifyJar.html @@ -0,0 +1,405 @@ + + + + + + +VerifyJar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class VerifyJar

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractJarSignerTask
+              extended by org.apache.tools.ant.taskdefs.VerifyJar
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class VerifyJar
    extends AbstractJarSignerTask
    + + +

    +JAR verification task. + For every JAR passed in, we fork jarsigner to verify + that it is correctly signed. This is more rigorous than just checking for + the existence of a signature; the entire certification chain is tested +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_NO_FILE + +
    +          no file message "Not found :"
    +static java.lang.StringERROR_NO_VERIFY + +
    +          Error output if there is a failure to verify the jar.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractJarSignerTask
    alias, ERROR_NO_SOURCE, filesets, jar, JARSIGNER_COMMAND, keypass, keystore, maxMemory, storepass, storetype, verbose
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    VerifyJar() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          verify our jar files
    + voidsetCertificates(boolean certificates) + +
    +          Ask for certificate information to be printed
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractJarSignerTask
    addFileset, addSysproperty, addValue, beginExecution, bindToKeystore, createJarSigner, createPath, createUnifiedSourcePath, createUnifiedSources, declareSysProperty, endExecution, getRedirector, hasResources, setAlias, setCommonOptions, setExecutable, setJar, setKeypass, setKeystore, setMaxmemory, setStorepass, setStoretype, setVerbose
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_NO_FILE

    +
    +public static final java.lang.String ERROR_NO_FILE
    +
    +
    no file message "Not found :" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_VERIFY

    +
    +public static final java.lang.String ERROR_NO_VERIFY
    +
    +
    Error output if there is a failure to verify the jar. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +VerifyJar

    +
    +public VerifyJar()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCertificates

    +
    +public void setCertificates(boolean certificates)
    +
    +
    Ask for certificate information to be printed +

    +

    +
    Parameters:
    certificates - if true print certificates.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    verify our jar files +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.Unit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.Unit.html new file mode 100644 index 000000000..bbfb2fe2f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.Unit.html @@ -0,0 +1,448 @@ + + + + + + +WaitFor.Unit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class WaitFor.Unit

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.WaitFor.Unit
+
    +
    +
    Enclosing class:
    WaitFor
    +
    +
    +
    +
    public static class WaitFor.Unit
    extends EnumeratedAttribute
    + + +

    +The enumeration of units: + millisecond, second, minute, hour, day, week +

    + +

    +

    +
    To do:
    +
    we use timestamps in many places, why not factor this out
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringDAY + +
    +          day string
    +static java.lang.StringHOUR + +
    +          hour string
    +static java.lang.StringMILLISECOND + +
    +          millisecond string
    +static java.lang.StringMINUTE + +
    +          minute string
    +static java.lang.StringSECOND + +
    +          second string
    +static java.lang.StringWEEK + +
    +          week string
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    WaitFor.Unit() + +
    +          Constructor the Unit enumerated type.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + longgetMultiplier() + +
    +          Convert the value to a multipler (millisecond to unit).
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +MILLISECOND

    +
    +public static final java.lang.String MILLISECOND
    +
    +
    millisecond string +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +SECOND

    +
    +public static final java.lang.String SECOND
    +
    +
    second string +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MINUTE

    +
    +public static final java.lang.String MINUTE
    +
    +
    minute string +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +HOUR

    +
    +public static final java.lang.String HOUR
    +
    +
    hour string +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DAY

    +
    +public static final java.lang.String DAY
    +
    +
    day string +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +WEEK

    +
    +public static final java.lang.String WEEK
    +
    +
    week string +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +WaitFor.Unit

    +
    +public WaitFor.Unit()
    +
    +
    Constructor the Unit enumerated type. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getMultiplier

    +
    +public long getMultiplier()
    +
    +
    Convert the value to a multipler (millisecond to unit). +

    +

    + +
    Returns:
    a multipler (a long value)
    +
    +
    +
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.html new file mode 100644 index 000000000..10cf08f36 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WaitFor.html @@ -0,0 +1,737 @@ + + + + + + +WaitFor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class WaitFor

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.WaitFor
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    BlockFor
    +
    +
    +
    +
    public class WaitFor
    extends ConditionBase
    + + +

    +Wait for an external event to occur. + + Wait for an external process to start or to complete some + task. This is useful with the parallel task to + synchronize the execution of tests with server startup. + + The following attributes can be specified on a waitfor task: +

      +
    • maxwait - maximum length of time to wait before giving up
      • +
    • maxwaitunit - The unit to be used to interpret maxwait attribute
      • +
    • checkevery - amount of time to sleep between each check
      • +
    • checkeveryunit - The unit to be used to interpret checkevery attribute
      • +
    • timeoutproperty - name of a property to set if maxwait has been exceeded.
      • +
    + + The maxwaitunit and checkeveryunit are allowed to have the following values: + millisecond, second, minute, hour, day and week. The default is millisecond. + + For programmatic use/subclassing, there are two methods that may be overrridden, + processSuccess and processTimeout +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classWaitFor.Unit + +
    +          The enumeration of units: + millisecond, second, minute, hour, day, week
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static longDEFAULT_CHECK_MILLIS + +
    +          default check time
    +static longDEFAULT_MAX_WAIT_MILLIS + +
    +          default wait time
    +static longONE_DAY + +
    +          a day in milliseconds
    +static longONE_HOUR + +
    +          an hour in milliseconds
    +static longONE_MILLISECOND + +
    +          a millisecond
    +static longONE_MINUTE + +
    +          a minute in milliseconds
    +static longONE_SECOND + +
    +          a second in milliseconds
    +static longONE_WEEK + +
    +          a week in milliseconds
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    WaitFor() + +
    +          Constructor, names this task "waitfor".
    WaitFor(java.lang.String taskName) + +
    +          Constructor that takes the name of the task in the task name.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + longcalculateCheckEveryMillis() + +
    +          Get the check wait time, in milliseconds.
    + longcalculateMaxWaitMillis() + +
    +          Get the maxiumum wait time, in milliseconds.
    + voidexecute() + +
    +          Check repeatedly for the specified conditions until they become + true or the timeout expires.
    +protected  voidprocessSuccess() + +
    +          Actions to be taken on a successful waitfor.
    +protected  voidprocessTimeout() + +
    +          Actions to be taken on an unsuccessful wait.
    + voidsetCheckEvery(long time) + +
    +          Set the time between each check
    + voidsetCheckEveryUnit(WaitFor.Unit unit) + +
    +          Set the check every time unit
    + voidsetMaxWait(long time) + +
    +          Set the maximum length of time to wait.
    + voidsetMaxWaitUnit(WaitFor.Unit unit) + +
    +          Set the max wait time unit
    + voidsetTimeoutProperty(java.lang.String p) + +
    +          Name the property to set after a timeout.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ONE_MILLISECOND

    +
    +public static final long ONE_MILLISECOND
    +
    +
    a millisecond +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ONE_SECOND

    +
    +public static final long ONE_SECOND
    +
    +
    a second in milliseconds +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ONE_MINUTE

    +
    +public static final long ONE_MINUTE
    +
    +
    a minute in milliseconds +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ONE_HOUR

    +
    +public static final long ONE_HOUR
    +
    +
    an hour in milliseconds +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ONE_DAY

    +
    +public static final long ONE_DAY
    +
    +
    a day in milliseconds +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ONE_WEEK

    +
    +public static final long ONE_WEEK
    +
    +
    a week in milliseconds +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DEFAULT_MAX_WAIT_MILLIS

    +
    +public static final long DEFAULT_MAX_WAIT_MILLIS
    +
    +
    default wait time +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DEFAULT_CHECK_MILLIS

    +
    +public static final long DEFAULT_CHECK_MILLIS
    +
    +
    default check time +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +WaitFor

    +
    +public WaitFor()
    +
    +
    Constructor, names this task "waitfor". +

    +

    +
    + +

    +WaitFor

    +
    +public WaitFor(java.lang.String taskName)
    +
    +
    Constructor that takes the name of the task in the task name. +

    +

    +
    Parameters:
    taskName - the name of the task.
    Since:
    +
    Ant 1.8
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMaxWait

    +
    +public void setMaxWait(long time)
    +
    +
    Set the maximum length of time to wait. +

    +

    +
    Parameters:
    time - a long value
    +
    +
    +
    + +

    +setMaxWaitUnit

    +
    +public void setMaxWaitUnit(WaitFor.Unit unit)
    +
    +
    Set the max wait time unit +

    +

    +
    Parameters:
    unit - an enumerated Unit value
    +
    +
    +
    + +

    +setCheckEvery

    +
    +public void setCheckEvery(long time)
    +
    +
    Set the time between each check +

    +

    +
    Parameters:
    time - a long value
    +
    +
    +
    + +

    +setCheckEveryUnit

    +
    +public void setCheckEveryUnit(WaitFor.Unit unit)
    +
    +
    Set the check every time unit +

    +

    +
    Parameters:
    unit - an enumerated Unit value
    +
    +
    +
    + +

    +setTimeoutProperty

    +
    +public void setTimeoutProperty(java.lang.String p)
    +
    +
    Name the property to set after a timeout. +

    +

    +
    Parameters:
    p - the property name
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Check repeatedly for the specified conditions until they become + true or the timeout expires. +

    +

    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +calculateCheckEveryMillis

    +
    +public long calculateCheckEveryMillis()
    +
    +
    Get the check wait time, in milliseconds. +

    +

    + +
    Returns:
    how long to wait between checks
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +calculateMaxWaitMillis

    +
    +public long calculateMaxWaitMillis()
    +
    +
    Get the maxiumum wait time, in milliseconds. +

    +

    + +
    Returns:
    how long to wait before timing out
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +processSuccess

    +
    +protected void processSuccess()
    +
    +
    Actions to be taken on a successful waitfor. + This is an override point. The base implementation does nothing. +

    +

    +
    Since:
    +
    Ant1.7
    +
    +
    +
    +
    + +

    +processTimeout

    +
    +protected void processTimeout()
    +
    +
    Actions to be taken on an unsuccessful wait. + This is an override point. It is where the timeout processing takes place. + The base implementation sets the timeoutproperty if there was a timeout + and the property was defined. +

    +

    +
    Since:
    +
    Ant1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/War.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/War.html new file mode 100644 index 000000000..6c306bf0e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/War.html @@ -0,0 +1,609 @@ + + + + + + +War (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class War

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Zip
+                  extended by org.apache.tools.ant.taskdefs.Jar
+                      extended by org.apache.tools.ant.taskdefs.War
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class War
    extends Jar
    + + +

    +An extension of <jar> to create a WAR archive. + Contains special treatment for files that should end up in the + WEB-INF/lib, WEB-INF/classes or + WEB-INF directories of the Web Application Archive.

    +

    (The War task is a shortcut for specifying the particular layout of a WAR file. + The same thing can be accomplished by using the prefix and fullpath + attributes of zipfilesets in a Zip or Jar task.)

    +

    The extended zipfileset element from the zip task + (with attributes prefix, fullpath, and src) + is available in the War task.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    See Also:
    Jar
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Jar
    Jar.FilesetManifestConfig, Jar.StrictMode
    +  + + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.Zip
    Zip.ArchiveState, Zip.Duplicate, Zip.UnicodeExtraField, Zip.WhenEmpty
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.Zip
    addedDirs, archiveType, doubleFilePass, duplicate, emptyBehavior, entries, skipWriting, zipFile
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    War() + +
    +          Constructor for the War Task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddClasses(ZipFileSet fs) + +
    +          add files under WEB-INF/classes
    + voidaddLib(ZipFileSet fs) + +
    +          add files under WEB-INF/lib/
    + voidaddWebinf(ZipFileSet fs) + +
    +          files to add under WEB-INF;
    +protected  voidcleanUp() + +
    +          Make sure we don't think we already have a web.xml next time this task + gets executed.
    +protected  voidinitZipOutputStream(ZipOutputStream zOut) + +
    +          override of parent; validates configuration + before initializing the output stream.
    + voidsetNeedxmlfile(boolean needxmlfile) + +
    +          Set the policy on the web.xml file, that is, whether or not it is needed
    + voidsetWarfile(java.io.File warFile) + +
    +          Deprecated. since 1.5.x. + Use setDestFile(File) instead
    + voidsetWebxml(java.io.File descr) + +
    +          set the deployment descriptor to use (WEB-INF/web.xml); + required unless update=true
    +protected  voidzipFile(java.io.File file, + ZipOutputStream zOut, + java.lang.String vPath, + int mode) + +
    +          Overridden from Zip class to deal with web.xml + + Here are cases that can arise + -not a web.xml file : add + -first web.xml : add, remember we added it + -same web.xml again: skip + -alternate web.xml : warn and skip
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Jar
    addConfiguredIndexJars, addConfiguredManifest, addConfiguredService, addMetainf, createEmptyZip, finalizeZipOutputStream, findJarName, getResourcesToAdd, grabFilesAndDirs, reset, setFilesetmanifest, setFlattenAttributes, setIndex, setIndexMetaInf, setJarfile, setManifest, setManifestEncoding, setMergeClassPathAttributes, setStrict, setWhenempty, setWhenmanifestonly, writeIndexLikeList, zipFile
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.Zip
    add, addFileset, addParentDirs, addResources, addResources, addZipfileset, addZipGroupFileset, execute, executeMain, getComment, getCreateUnicodeExtraFields, getCurrentExtraFields, getDestFile, getEncoding, getFallBackToUTF8, getLevel, getNonFileSetResourcesToAdd, getPreserve0Permissions, getResourcesToAdd, getUseLanguageEnodingFlag, grabNonFileSetResources, grabResources, hasUpdatedFile, isAddingNewFiles, isCompress, isEmpty, isFirstPass, isInUpdateMode, logWhenWriting, selectDirectoryResources, selectFileResources, selectResources, setBasedir, setComment, setCompress, setCreateUnicodeExtraFields, setCurrentExtraFields, setDestFile, setDuplicate, setEncoding, setFallBackToUTF8, setFile, setFilesonly, setKeepCompression, setLevel, setPreserve0Permissions, setRoundUp, setUpdate, setUseLanguageEncodingFlag, setZipfile, zipDir, zipDir, zipDir, zipFile
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +War

    +
    +public War()
    +
    +
    Constructor for the War Task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setWarfile

    +
    +public void setWarfile(java.io.File warFile)
    +
    +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead +

    +

    Deprecated name of the file to create + -use destfile instead. +

    +

    +
    Parameters:
    warFile - the destination file
    +
    +
    +
    + +

    +setWebxml

    +
    +public void setWebxml(java.io.File descr)
    +
    +
    set the deployment descriptor to use (WEB-INF/web.xml); + required unless update=true +

    +

    +
    Parameters:
    descr - the deployment descriptor file
    +
    +
    +
    + +

    +setNeedxmlfile

    +
    +public void setNeedxmlfile(boolean needxmlfile)
    +
    +
    Set the policy on the web.xml file, that is, whether or not it is needed +

    +

    +
    Parameters:
    needxmlfile - whether a web.xml file is needed. Default: true
    +
    +
    +
    + +

    +addLib

    +
    +public void addLib(ZipFileSet fs)
    +
    +
    add files under WEB-INF/lib/ +

    +

    +
    Parameters:
    fs - the zip file set to add
    +
    +
    +
    + +

    +addClasses

    +
    +public void addClasses(ZipFileSet fs)
    +
    +
    add files under WEB-INF/classes +

    +

    +
    Parameters:
    fs - the zip file set to add
    +
    +
    +
    + +

    +addWebinf

    +
    +public void addWebinf(ZipFileSet fs)
    +
    +
    files to add under WEB-INF; +

    +

    +
    Parameters:
    fs - the zip file set to add
    +
    +
    +
    + +

    +initZipOutputStream

    +
    +protected void initZipOutputStream(ZipOutputStream zOut)
+                            throws java.io.IOException,
+                                   BuildException
    +
    +
    override of parent; validates configuration + before initializing the output stream. +

    +

    +
    Overrides:
    initZipOutputStream in class Jar
    +
    +
    +
    Parameters:
    zOut - the zip output stream +
    Throws: +
    java.io.IOException - on output error +
    BuildException - if invalid configuration
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.File file,
+                       ZipOutputStream zOut,
+                       java.lang.String vPath,
+                       int mode)
+                throws java.io.IOException
    +
    +
    Overridden from Zip class to deal with web.xml + + Here are cases that can arise + -not a web.xml file : add + -first web.xml : add, remember we added it + -same web.xml again: skip + -alternate web.xml : warn and skip +

    +

    +
    Overrides:
    zipFile in class Zip
    +
    +
    +
    Parameters:
    file - the file to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on output error
    +
    +
    +
    + +

    +cleanUp

    +
    +protected void cleanUp()
    +
    +
    Make sure we don't think we already have a web.xml next time this task + gets executed. +

    +

    +
    Overrides:
    cleanUp in class Jar
    +
    +
    +
    See Also:
    Zip.cleanUp()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WhichResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WhichResource.html new file mode 100644 index 000000000..169678aec --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/WhichResource.html @@ -0,0 +1,448 @@ + + + + + + +WhichResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class WhichResource

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.WhichResource
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class WhichResource
    extends Task
    + + +

    +Find a class or resource on the supplied classpath, or the + system classpath if none is supplied. The named property is set if + the item can be found. For example + 

    + <whichresource resource="/log4j.properties"
+   property="log4j.url" >
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    WhichResource() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateClasspath() + +
    +          Adds a path to the classpath.
    + voidexecute() + +
    +          execute it
    + voidsetClass(java.lang.String classname) + +
    +          name the class to look for
    + voidsetClasspath(Path cp) + +
    +          Set the classpath to be used for this compilation.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath to use by reference.
    + voidsetProperty(java.lang.String property) + +
    +          the property to fill with the URL of the resource or class
    + voidsetResource(java.lang.String resource) + +
    +          name the resource to look for
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +WhichResource

    +
    +public WhichResource()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setClasspath

    +
    +public void setClasspath(Path cp)
    +
    +
    Set the classpath to be used for this compilation. +

    +

    +
    Parameters:
    cp - the classpath to be used.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Adds a path to the classpath. +

    +

    + +
    Returns:
    a classpath to be configured.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath to use by reference. +

    +

    +
    Parameters:
    r - a reference to an existing classpath.
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    execute it +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String resource)
    +
    +
    name the resource to look for +

    +

    +
    Parameters:
    resource - the name of the resource to look for.
    +
    +
    +
    + +

    +setClass

    +
    +public void setClass(java.lang.String classname)
    +
    +
    name the class to look for +

    +

    +
    Parameters:
    classname - the name of the class to look for.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    the property to fill with the URL of the resource or class +

    +

    +
    Parameters:
    property - the property to be set.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison.html new file mode 100644 index 000000000..73bbfe8d6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison.html @@ -0,0 +1,322 @@ + + + + + + +XSLTLiaison (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface XSLTLiaison

    +
    +
    All Known Subinterfaces:
    XSLTLiaison2, XSLTLiaison3
    +
    +
    +
    All Known Implementing Classes:
    TraXLiaison
    +
    +
    +
    +
    public interface XSLTLiaison
    + + +

    +Proxy interface for XSLT processors. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    See Also:
    XSLTProcess
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFILE_PROTOCOL_PREFIX + +
    +          the file protocol prefix for systemid.
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddParam(java.lang.String name, + java.lang.String expression) + +
    +          Add a parameter to be set during the XSL transformation.
    + voidsetStylesheet(java.io.File stylesheet) + +
    +          set the stylesheet to use for the transformation.
    + voidtransform(java.io.File infile, + java.io.File outfile) + +
    +          Perform the transformation of a file into another.
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FILE_PROTOCOL_PREFIX

    +
    +static final java.lang.String FILE_PROTOCOL_PREFIX
    +
    +
    the file protocol prefix for systemid. + This file protocol must be appended to an absolute path. + Typically: FILE_PROTOCOL_PREFIX + file.getAbsolutePath() + Note that on Windows, an extra '/' must be appended to the + protocol prefix so that there is always 3 consecutive slashes. +

    +

    +
    Since:
    +
    Ant 1.4
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setStylesheet

    +
    +void setStylesheet(java.io.File stylesheet)
+                   throws java.lang.Exception
    +
    +
    set the stylesheet to use for the transformation. +

    +

    +
    Parameters:
    stylesheet - the stylesheet to be used for transformation. +
    Throws: +
    java.lang.Exception - thrown if any problems happens.
    Since:
    +
    Ant 1.4
    +
    +
    +
    +
    + +

    +addParam

    +
    +void addParam(java.lang.String name,
+              java.lang.String expression)
+              throws java.lang.Exception
    +
    +
    Add a parameter to be set during the XSL transformation. +

    +

    +
    Parameters:
    name - the parameter name.
    expression - the parameter value as an expression string. +
    Throws: +
    java.lang.Exception - thrown if any problems happens.
    Since:
    +
    Ant 1.3
    +
    +
    +
    +
    + +

    +transform

    +
    +void transform(java.io.File infile,
+               java.io.File outfile)
+               throws java.lang.Exception
    +
    +
    Perform the transformation of a file into another. +

    +

    +
    Parameters:
    infile - the input file, probably an XML one. :-)
    outfile - the output file resulting from the transformation +
    Throws: +
    java.lang.Exception - thrown if any problems happens.
    Since:
    +
    Ant 1.4
    +
    See Also:
    setStylesheet(File)
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison2.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison2.html new file mode 100644 index 000000000..2867e6cab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison2.html @@ -0,0 +1,250 @@ + + + + + + +XSLTLiaison2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface XSLTLiaison2

    +
    +
    All Superinterfaces:
    XSLTLiaison
    +
    +
    +
    All Known Subinterfaces:
    XSLTLiaison3
    +
    +
    +
    All Known Implementing Classes:
    TraXLiaison
    +
    +
    +
    +
    public interface XSLTLiaison2
    extends XSLTLiaison
    + + +

    +Extended Proxy interface for XSLT processors. +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    See Also:
    XSLTProcess
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
    FILE_PROTOCOL_PREFIX
    +  + + + + + + + + + + + +
    +Method Summary
    + voidconfigure(XSLTProcess xsltTask) + +
    +          Configure the liasion from the XSLTProcess task
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
    addParam, setStylesheet, transform
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +configure

    +
    +void configure(XSLTProcess xsltTask)
    +
    +
    Configure the liasion from the XSLTProcess task +

    +

    +
    +
    +
    +
    Parameters:
    xsltTask - the XSLTProcess task
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison3.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison3.html new file mode 100644 index 000000000..e4cdecca6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLiaison3.html @@ -0,0 +1,259 @@ + + + + + + +XSLTLiaison3 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface XSLTLiaison3

    +
    +
    All Superinterfaces:
    XSLTLiaison, XSLTLiaison2
    +
    +
    +
    All Known Implementing Classes:
    TraXLiaison
    +
    +
    +
    +
    public interface XSLTLiaison3
    extends XSLTLiaison2
    + + +

    +Extends Proxy interface for XSLT processors. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    XSLTProcess
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
    FILE_PROTOCOL_PREFIX
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsetStylesheet(Resource stylesheet) + +
    +          sets the stylesheet to use as a resource
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison2
    configure
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
    addParam, setStylesheet, transform
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setStylesheet

    +
    +void setStylesheet(Resource stylesheet)
+                   throws java.lang.Exception
    +
    +
    sets the stylesheet to use as a resource +

    +

    +
    +
    +
    +
    Parameters:
    stylesheet - the stylesheet to use as a resource +
    Throws: +
    java.lang.Exception - if the stylesheet cannot be loaded
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLogger.html new file mode 100644 index 000000000..49182b0d5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLogger.html @@ -0,0 +1,214 @@ + + + + + + +XSLTLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface XSLTLogger

    +
    +
    All Known Implementing Classes:
    XSLTProcess
    +
    +
    +
    +
    public interface XSLTLogger
    + + +

    +Interface to log messages for XSLT +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidlog(java.lang.String msg) + +
    +          Log a message.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +log

    +
    +void log(java.lang.String msg)
    +
    +
    Log a message. +

    +

    +
    Parameters:
    msg - the message to log
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLoggerAware.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLoggerAware.html new file mode 100644 index 000000000..28c238e84 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTLoggerAware.html @@ -0,0 +1,214 @@ + + + + + + +XSLTLoggerAware (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Interface XSLTLoggerAware

    +
    +
    All Known Implementing Classes:
    TraXLiaison
    +
    +
    +
    +
    public interface XSLTLoggerAware
    + + +

    +Interface for a class that one can set an XSLTLogger on. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidsetLogger(XSLTLogger l) + +
    +          Set the logger for this class.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setLogger

    +
    +void setLogger(XSLTLogger l)
    +
    +
    Set the logger for this class. +

    +

    +
    Parameters:
    l - the logger
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.Attribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.Attribute.html new file mode 100644 index 000000000..b875de0b0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.Attribute.html @@ -0,0 +1,347 @@ + + + + + + +XSLTProcess.Factory.Attribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess.Factory.Attribute

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.XSLTProcess.Factory.Attribute
+
    +
    +
    All Implemented Interfaces:
    DynamicAttribute, DynamicConfigurator, DynamicElement
    +
    +
    +
    Enclosing class:
    XSLTProcess.Factory
    +
    +
    +
    +
    public static class XSLTProcess.Factory.Attribute
    extends java.lang.Object
    implements DynamicConfigurator
    + + +

    +A JAXP factory attribute. This is mostly processor specific, for + example for Xalan 2.3+, the following attributes could be set: +

      +
    • http://xml.apache.org/xalan/features/optimize (true|false)
      • +
    • http://xml.apache.org/xalan/features/incremental (true|false)
      • +
    +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess.Factory.Attribute() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.ObjectcreateDynamicElement(java.lang.String name) + +
    +          Not used.
    + java.lang.StringgetName() + +
    +           
    + java.lang.ObjectgetValue() + +
    +           
    + voidsetDynamicAttribute(java.lang.String name, + java.lang.String value) + +
    +          Set an attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess.Factory.Attribute

    +
    +public XSLTProcess.Factory.Attribute()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    +
    +
    +
    + +
    Returns:
    the attribute name.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.Object getValue()
    +
    +
    +
    +
    +
    + +
    Returns:
    the output property value.
    +
    +
    +
    + +

    +createDynamicElement

    +
    +public java.lang.Object createDynamicElement(java.lang.String name)
+                                      throws BuildException
    +
    +
    Not used. +

    +

    +
    Specified by:
    createDynamicElement in interface DynamicElement
    +
    +
    +
    Parameters:
    name - not used +
    Returns:
    null +
    Throws: +
    BuildException - never
    +
    +
    +
    + +

    +setDynamicAttribute

    +
    +public void setDynamicAttribute(java.lang.String name,
+                                java.lang.String value)
+                         throws BuildException
    +
    +
    Set an attribute. + Only "name" and "value" are supported as names. +

    +

    +
    Specified by:
    setDynamicAttribute in interface DynamicAttribute
    +
    +
    +
    Parameters:
    name - the name of the attribute
    value - the value of the attribute +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.html new file mode 100644 index 000000000..6c69c6124 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Factory.html @@ -0,0 +1,340 @@ + + + + + + +XSLTProcess.Factory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess.Factory

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.XSLTProcess.Factory
+
    +
    +
    Enclosing class:
    XSLTProcess
    +
    +
    +
    +
    public static class XSLTProcess.Factory
    extends java.lang.Object
    + + +

    +The factory element to configure a transformer factory +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classXSLTProcess.Factory.Attribute + +
    +          A JAXP factory attribute.
    +  + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess.Factory() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddAttribute(XSLTProcess.Factory.Attribute attr) + +
    +          Create an instance of a factory attribute.
    + java.util.EnumerationgetAttributes() + +
    +          return the attribute elements.
    + java.lang.StringgetName() + +
    +           
    + voidsetName(java.lang.String name) + +
    +          Set the name of the factory
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess.Factory

    +
    +public XSLTProcess.Factory()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    + +
    Returns:
    the name of the factory.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of the factory +

    +

    +
    Parameters:
    name - the name of the factory.
    +
    +
    +
    + +

    +addAttribute

    +
    +public void addAttribute(XSLTProcess.Factory.Attribute attr)
    +
    +
    Create an instance of a factory attribute. +

    +

    +
    Parameters:
    attr - the newly created factory attribute
    +
    +
    +
    + +

    +getAttributes

    +
    +public java.util.Enumeration getAttributes()
    +
    +
    return the attribute elements. +

    +

    + +
    Returns:
    the enumeration of attributes
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.OutputProperty.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.OutputProperty.html new file mode 100644 index 000000000..a8c0b4ac5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.OutputProperty.html @@ -0,0 +1,324 @@ + + + + + + +XSLTProcess.OutputProperty (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess.OutputProperty

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.XSLTProcess.OutputProperty
+
    +
    +
    Enclosing class:
    XSLTProcess
    +
    +
    +
    +
    public static class XSLTProcess.OutputProperty
    extends java.lang.Object
    + + +

    +Specify how the result tree should be output as specified + in the + specification. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess.OutputProperty() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +           
    + java.lang.StringgetValue() + +
    +           
    + voidsetName(java.lang.String name) + +
    +          set the name for this property
    + voidsetValue(java.lang.String value) + +
    +          set the value for this property
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess.OutputProperty

    +
    +public XSLTProcess.OutputProperty()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    + +
    Returns:
    the output property name.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    set the name for this property +

    +

    +
    Parameters:
    name - A non-null String that specifies an + output property name, which may be namespace qualified.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    + +
    Returns:
    the output property value.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    set the value for this property +

    +

    +
    Parameters:
    value - The non-null string value of the output property.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Param.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Param.html new file mode 100644 index 000000000..993d00fe5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.Param.html @@ -0,0 +1,470 @@ + + + + + + +XSLTProcess.Param (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess.Param

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.XSLTProcess.Param
+
    +
    +
    Enclosing class:
    XSLTProcess
    +
    +
    +
    +
    public static class XSLTProcess.Param
    extends java.lang.Object
    + + +

    +The Param inner class used to store XSL parameters +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess.Param() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetExpression() + +
    +          Get the parameter's value
    + java.lang.StringgetName() + +
    +          Get the parameter name
    + voidsetExpression(java.lang.String expression) + +
    +          The parameter value + NOTE : was intended to be an XSL expression.
    + voidsetIf(java.lang.Object ifCond) + +
    +          Set whether this param should be used.
    + voidsetIf(java.lang.String ifProperty) + +
    +          Set whether this param should be used.
    + voidsetName(java.lang.String name) + +
    +          Set the parameter name.
    + voidsetProject(Project project) + +
    +          Set the current project
    + voidsetUnless(java.lang.Object unlessCond) + +
    +          Set whether this param should NOT be used.
    + voidsetUnless(java.lang.String unlessProperty) + +
    +          Set whether this param should NOT be used.
    + booleanshouldUse() + +
    +          Ensures that the param passes the conditions placed + on it with if and unless properties.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess.Param

    +
    +public XSLTProcess.Param()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set the current project +

    +

    +
    Parameters:
    project - the current project
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the parameter name. +

    +

    +
    Parameters:
    name - the name of the parameter.
    +
    +
    +
    + +

    +setExpression

    +
    +public void setExpression(java.lang.String expression)
    +
    +
    The parameter value + NOTE : was intended to be an XSL expression. +

    +

    +
    Parameters:
    expression - the parameter's value.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
+                         throws BuildException
    +
    +
    Get the parameter name +

    +

    + +
    Returns:
    the parameter name +
    Throws: +
    BuildException - if the name is not set.
    +
    +
    +
    + +

    +getExpression

    +
    +public java.lang.String getExpression()
+                               throws BuildException
    +
    +
    Get the parameter's value +

    +

    + +
    Returns:
    the parameter value +
    Throws: +
    BuildException - if the value is not set.
    +
    +
    +
    + +

    +setIf

    +
    +public void setIf(java.lang.Object ifCond)
    +
    +
    Set whether this param should be used. It will be used if + the expression evalutes to true or the name of a property + which has been set, otherwise it won't. +

    +

    +
    Parameters:
    ifCond - evaluated expression
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setIf

    +
    +public void setIf(java.lang.String ifProperty)
    +
    +
    Set whether this param should be used. It will be used if + the expression evalutes to true or the name of a property + which has been set, otherwise it won't. +

    +

    +
    Parameters:
    ifProperty - evaluated expression
    +
    +
    +
    + +

    +setUnless

    +
    +public void setUnless(java.lang.Object unlessCond)
    +
    +
    Set whether this param should NOT be used. It will not be + used if the expression evaluates to true or the name of a + property which has been set, otherwise it will be used. +

    +

    +
    Parameters:
    unlessCond - evaluated expression
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setUnless

    +
    +public void setUnless(java.lang.String unlessProperty)
    +
    +
    Set whether this param should NOT be used. It will not be + used if the expression evaluates to true or the name of a + property which has been set, otherwise it will be used. +

    +

    +
    Parameters:
    unlessProperty - evaluated expression
    +
    +
    +
    + +

    +shouldUse

    +
    +public boolean shouldUse()
    +
    +
    Ensures that the param passes the conditions placed + on it with if and unless properties. +

    +

    + +
    Returns:
    true if the task passes the "if" and "unless" parameters
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.TraceConfiguration.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.TraceConfiguration.html new file mode 100644 index 000000000..f6a3dbf0b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.TraceConfiguration.html @@ -0,0 +1,490 @@ + + + + + + +XSLTProcess.TraceConfiguration (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess.TraceConfiguration

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.XSLTProcess.TraceConfiguration
+
    +
    +
    Enclosing class:
    XSLTProcess
    +
    +
    +
    +
    public final class XSLTProcess.TraceConfiguration
    extends java.lang.Object
    + + +

    +Configuration for Xalan2 traces. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess.TraceConfiguration() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleangetElements() + +
    +          True if the listener is to print events that occur as each + node is 'executed' in the stylesheet.
    + booleangetExtension() + +
    +          True if the listener is to print information after each + extension event.
    + booleangetGeneration() + +
    +          True if the listener is to print information after each + result-tree generation event.
    + java.io.OutputStreamgetOutputStream() + +
    +          The stream to write traces to.
    + booleangetSelection() + +
    +          True if the listener is to print information after each + selection event.
    + booleangetTemplates() + +
    +          True if the listener is to print an event whenever a + template is invoked.
    + voidsetElements(boolean b) + +
    +          Set to true if the listener is to print events that occur + as each node is 'executed' in the stylesheet.
    + voidsetExtension(boolean b) + +
    +          Set to true if the listener is to print information after + each extension event.
    + voidsetGeneration(boolean b) + +
    +          Set to true if the listener is to print information after + each result-tree generation event.
    + voidsetSelection(boolean b) + +
    +          Set to true if the listener is to print information after + each selection event.
    + voidsetTemplates(boolean b) + +
    +          Set to true if the listener is to print an event whenever a + template is invoked.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess.TraceConfiguration

    +
    +public XSLTProcess.TraceConfiguration()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setElements

    +
    +public void setElements(boolean b)
    +
    +
    Set to true if the listener is to print events that occur + as each node is 'executed' in the stylesheet. +

    +

    +
    +
    +
    +
    + +

    +getElements

    +
    +public boolean getElements()
    +
    +
    True if the listener is to print events that occur as each + node is 'executed' in the stylesheet. +

    +

    +
    +
    +
    +
    + +

    +setExtension

    +
    +public void setExtension(boolean b)
    +
    +
    Set to true if the listener is to print information after + each extension event. +

    +

    +
    +
    +
    +
    + +

    +getExtension

    +
    +public boolean getExtension()
    +
    +
    True if the listener is to print information after each + extension event. +

    +

    +
    +
    +
    +
    + +

    +setGeneration

    +
    +public void setGeneration(boolean b)
    +
    +
    Set to true if the listener is to print information after + each result-tree generation event. +

    +

    +
    +
    +
    +
    + +

    +getGeneration

    +
    +public boolean getGeneration()
    +
    +
    True if the listener is to print information after each + result-tree generation event. +

    +

    +
    +
    +
    +
    + +

    +setSelection

    +
    +public void setSelection(boolean b)
    +
    +
    Set to true if the listener is to print information after + each selection event. +

    +

    +
    +
    +
    +
    + +

    +getSelection

    +
    +public boolean getSelection()
    +
    +
    True if the listener is to print information after each + selection event. +

    +

    +
    +
    +
    +
    + +

    +setTemplates

    +
    +public void setTemplates(boolean b)
    +
    +
    Set to true if the listener is to print an event whenever a + template is invoked. +

    +

    +
    +
    +
    +
    + +

    +getTemplates

    +
    +public boolean getTemplates()
    +
    +
    True if the listener is to print an event whenever a + template is invoked. +

    +

    +
    +
    +
    +
    + +

    +getOutputStream

    +
    +public java.io.OutputStream getOutputStream()
    +
    +
    The stream to write traces to. +

    +

    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.html new file mode 100644 index 000000000..95da7c6fa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XSLTProcess.html @@ -0,0 +1,1595 @@ + + + + + + +XSLTProcess (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XSLTProcess

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.XSLTProcess
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, XSLTLogger, SelectorContainer
    +
    +
    +
    +
    public class XSLTProcess
    extends MatchingTask
    implements XSLTLogger
    + + +

    +Processes a set of XML documents via XSLT. This is + useful for building views of XML based documentation. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classXSLTProcess.Factory + +
    +          The factory element to configure a transformer factory
    +static classXSLTProcess.OutputProperty + +
    +          Specify how the result tree should be output as specified + in the + specification.
    +static classXSLTProcess.Param + +
    +          The Param inner class used to store XSL parameters
    + classXSLTProcess.TraceConfiguration + +
    +          Configuration for Xalan2 traces.
    +  + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringPROCESSOR_TRAX + +
    +          The default processor is trax
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    XSLTProcess() + +
    +          Creates a new XSLTProcess Task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          Adds a nested filenamemapper.
    + voidadd(ResourceCollection rc) + +
    +          Adds a collection of resources to style in addition to the + given file or the implicit fileset.
    + voidaddConfiguredStyle(Resources rc) + +
    +          Add a nested <style> element.
    + voidaddConfiguredXMLCatalog(XMLCatalog xmlCatalog) + +
    +          Add the catalog to our internal catalog
    + voidaddMapper(Mapper mapper) + +
    +          Defines the mapper to map source to destination files.
    + voidaddSysproperty(Environment.Variable sysp) + +
    +          A system property to set during transformation.
    + voidaddSyspropertyset(PropertySet sysp) + +
    +          A set of system properties to set during transformation.
    +protected  voidconfigureLiaison(java.io.File stylesheet) + +
    +          Deprecated. since Ant 1.7
    +protected  voidconfigureLiaison(Resource stylesheet) + +
    +          Loads the stylesheet and set xsl:param parameters.
    + PathcreateClasspath() + +
    +          Set the optional classpath to the XSL processor
    + XSLTProcess.FactorycreateFactory() + +
    +          Create the factory element to configure a trax liaison.
    + XSLTProcess.OutputPropertycreateOutputProperty() + +
    +          Create an instance of an output property to be configured.
    + XSLTProcess.ParamcreateParam() + +
    +          Create an instance of an XSL parameter for configuration by Ant.
    + XSLTProcess.TraceConfigurationcreateTrace() + +
    +          Enables Xalan2 traces and uses the given configuration.
    + voidexecute() + +
    +          Executes the task.
    + XSLTProcess.FactorygetFactory() + +
    +          Get the factory instance configured for this processor
    +protected  XSLTLiaisongetLiaison() + +
    +          Get the Liason implementation to use in processing.
    + java.util.EnumerationgetOutputProperties() + +
    +          Get an enumeration on the outputproperties.
    + booleangetSuppressWarnings() + +
    +          Whether to suppress warning messages of the processor.
    + XSLTProcess.TraceConfigurationgetTraceConfiguration() + +
    +          Configuration for Xalan2 traces.
    + XMLCataloggetXMLCatalog() + +
    +          Get the XML catalog containing entity definitions
    +protected  voidhandleError(java.lang.String msg) + +
    +          Throws an exception with the given message if failOnError is + true, otherwise logs the message using the WARN level.
    +protected  voidhandleError(java.lang.Throwable ex) + +
    +          Throws an exception with the given nested exception if + failOnError is true, otherwise logs the message using the WARN + level.
    +protected  voidhandleTransformationError(java.lang.Exception ex) + +
    +          Throws an exception with the given nested exception if + failOnError and failOnTransformationError are true, otherwise + logs the message using the WARN level.
    + voidinit() + +
    +          Initialize internal instance of XMLCatalog
    + voidsetBasedir(java.io.File dir) + +
    +          Set the base directory; + optional, default is the project's basedir.
    + voidsetClasspath(Path classpath) + +
    +          Set the optional classpath to the XSL processor
    + voidsetClasspathRef(Reference r) + +
    +          Set the reference to an optional classpath to the XSL processor
    + voidsetDestdir(java.io.File dir) + +
    +          Set the destination directory into which the XSL result + files should be copied to; + required, unless in and out are + specified.
    + voidsetExtension(java.lang.String name) + +
    +          Set the desired file extension to be used for the target; + optional, default is html.
    + voidsetFailOnError(boolean b) + +
    +          Whether any errors should make the build fail.
    + voidsetFailOnNoResources(boolean b) + +
    +          Whether the build should fail if the nested resource collection is empty.
    + voidsetFailOnTransformationError(boolean b) + +
    +          Whether transformation errors should make the build fail.
    + voidsetFileDirParameter(java.lang.String fileDirParameter) + +
    +          Pass the directory name of the current processed file as a xsl parameter + to the transformation.
    + voidsetFileNameParameter(java.lang.String fileNameParameter) + +
    +          Pass the filename of the current processed file as a xsl parameter + to the transformation.
    + voidsetForce(boolean force) + +
    +          Set whether to check dependencies, or always generate; + optional, default is false.
    + voidsetIn(java.io.File inFile) + +
    +          specifies a single XML document to be styled.
    + voidsetOut(java.io.File outFile) + +
    +          Specifies the output name for the styled result from the + in attribute; required if in is set
    + voidsetProcessor(java.lang.String processor) + +
    +          Set the name of the XSL processor to use; optional, default trax.
    + voidsetReloadStylesheet(boolean b) + +
    +          Controls whether the stylesheet is reloaded for every transform.
    + voidsetScanIncludedDirectories(boolean b) + +
    +          Whether to style all files in the included directories as well; + optional, default is true.
    + voidsetStyle(java.lang.String xslFile) + +
    +          Name of the stylesheet to use - given either relative + to the project's basedir or as an absolute path; required.
    + voidsetSuppressWarnings(boolean b) + +
    +          Whether to suppress warning messages of the processor.
    + voidsetUseImplicitFileset(boolean useimplicitfileset) + +
    +          Whether to use the implicit fileset.
    + voidsetXslResource(Resource xslResource) + +
    +          API method to set the XSL Resource.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.taskdefs.XSLTLogger
    log
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +PROCESSOR_TRAX

    +
    +public static final java.lang.String PROCESSOR_TRAX
    +
    +
    The default processor is trax +

    +

    +
    Since:
    +
    Ant 1.7
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +XSLTProcess

    +
    +public XSLTProcess()
    +
    +
    Creates a new XSLTProcess Task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setScanIncludedDirectories

    +
    +public void setScanIncludedDirectories(boolean b)
    +
    +
    Whether to style all files in the included directories as well; + optional, default is true. +

    +

    +
    +
    +
    +
    Parameters:
    b - true if files in included directories are processed.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setReloadStylesheet

    +
    +public void setReloadStylesheet(boolean b)
    +
    +
    Controls whether the stylesheet is reloaded for every transform. + +

    Setting this to true may get around a bug in certain + Xalan-J versions, default is false.

    +

    +

    +
    +
    +
    +
    Parameters:
    b - a boolean value
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +addMapper

    +
    +public void addMapper(Mapper mapper)
    +
    +
    Defines the mapper to map source to destination files. +

    +

    +
    +
    +
    +
    Parameters:
    mapper - the mapper to use +
    Throws: +
    BuildException - if more than one mapper is defined
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Adds a collection of resources to style in addition to the + given file or the implicit fileset. +

    +

    +
    +
    +
    +
    Parameters:
    rc - the collection of resources to style
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addConfiguredStyle

    +
    +public void addConfiguredStyle(Resources rc)
    +
    +
    Add a nested <style> element. +

    +

    +
    +
    +
    +
    Parameters:
    rc - the configured Resources object represented as <style>.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setXslResource

    +
    +public void setXslResource(Resource xslResource)
    +
    +
    API method to set the XSL Resource. +

    +

    +
    +
    +
    +
    Parameters:
    xslResource - Resource to set as the stylesheet.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
+         throws BuildException
    +
    +
    Adds a nested filenamemapper. +

    +

    +
    +
    +
    +
    Parameters:
    fileNameMapper - the mapper to add +
    Throws: +
    BuildException - if more than one mapper is defined
    Since:
    +
    Ant 1.7.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if there is an execution problem.
    To do:
    +
    validate that if either in or our is defined, then both are
    +
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean force)
    +
    +
    Set whether to check dependencies, or always generate; + optional, default is false. +

    +

    +
    +
    +
    +
    Parameters:
    force - true if always generate.
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File dir)
    +
    +
    Set the base directory; + optional, default is the project's basedir. +

    +

    +
    +
    +
    +
    Parameters:
    dir - the base directory
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File dir)
    +
    +
    Set the destination directory into which the XSL result + files should be copied to; + required, unless in and out are + specified. +

    +

    +
    +
    +
    +
    Parameters:
    dir - the name of the destination directory
    +
    +
    +
    + +

    +setExtension

    +
    +public void setExtension(java.lang.String name)
    +
    +
    Set the desired file extension to be used for the target; + optional, default is html. +

    +

    +
    +
    +
    +
    Parameters:
    name - the extension to use
    +
    +
    +
    + +

    +setStyle

    +
    +public void setStyle(java.lang.String xslFile)
    +
    +
    Name of the stylesheet to use - given either relative + to the project's basedir or as an absolute path; required. +

    +

    +
    +
    +
    +
    Parameters:
    xslFile - the stylesheet to use
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the optional classpath to the XSL processor +

    +

    +
    +
    +
    +
    Parameters:
    classpath - the classpath to use when loading the XSL processor
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Set the optional classpath to the XSL processor +

    +

    +
    +
    +
    + +
    Returns:
    a path instance to be configured by the Ant core.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the reference to an optional classpath to the XSL processor +

    +

    +
    +
    +
    +
    Parameters:
    r - the id of the Ant path instance to act as the classpath + for loading the XSL processor
    +
    +
    +
    + +

    +setProcessor

    +
    +public void setProcessor(java.lang.String processor)
    +
    +
    Set the name of the XSL processor to use; optional, default trax. +

    +

    +
    +
    +
    +
    Parameters:
    processor - the name of the XSL processor
    +
    +
    +
    + +

    +setUseImplicitFileset

    +
    +public void setUseImplicitFileset(boolean useimplicitfileset)
    +
    +
    Whether to use the implicit fileset. + +

    Set this to false if you want explicit control with nested + resource collections.

    +

    +

    +
    +
    +
    +
    Parameters:
    useimplicitfileset - set to true if you want to use implicit fileset
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addConfiguredXMLCatalog

    +
    +public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog)
    +
    +
    Add the catalog to our internal catalog +

    +

    +
    +
    +
    +
    Parameters:
    xmlCatalog - the XMLCatalog instance to use to look up DTDs
    +
    +
    +
    + +

    +setFileNameParameter

    +
    +public void setFileNameParameter(java.lang.String fileNameParameter)
    +
    +
    Pass the filename of the current processed file as a xsl parameter + to the transformation. This value sets the name of that xsl parameter. +

    +

    +
    +
    +
    +
    Parameters:
    fileNameParameter - name of the xsl parameter retrieving the + current file name
    +
    +
    +
    + +

    +setFileDirParameter

    +
    +public void setFileDirParameter(java.lang.String fileDirParameter)
    +
    +
    Pass the directory name of the current processed file as a xsl parameter + to the transformation. This value sets the name of that xsl parameter. +

    +

    +
    +
    +
    +
    Parameters:
    fileDirParameter - name of the xsl parameter retrieving the + current file directory
    +
    +
    +
    + +

    +setSuppressWarnings

    +
    +public void setSuppressWarnings(boolean b)
    +
    +
    Whether to suppress warning messages of the processor. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getSuppressWarnings

    +
    +public boolean getSuppressWarnings()
    +
    +
    Whether to suppress warning messages of the processor. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFailOnTransformationError

    +
    +public void setFailOnTransformationError(boolean b)
    +
    +
    Whether transformation errors should make the build fail. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean b)
    +
    +
    Whether any errors should make the build fail. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFailOnNoResources

    +
    +public void setFailOnNoResources(boolean b)
    +
    +
    Whether the build should fail if the nested resource collection is empty. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addSysproperty

    +
    +public void addSysproperty(Environment.Variable sysp)
    +
    +
    A system property to set during transformation. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +addSyspropertyset

    +
    +public void addSyspropertyset(PropertySet sysp)
    +
    +
    A set of system properties to set during transformation. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +createTrace

    +
    +public XSLTProcess.TraceConfiguration createTrace()
    +
    +
    Enables Xalan2 traces and uses the given configuration. + +

    Note that this element doesn't have any effect with a + processor other than trax or if the Transformer is not Xalan2's + transformer implementation.

    +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getTraceConfiguration

    +
    +public XSLTProcess.TraceConfiguration getTraceConfiguration()
    +
    +
    Configuration for Xalan2 traces. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setOut

    +
    +public void setOut(java.io.File outFile)
    +
    +
    Specifies the output name for the styled result from the + in attribute; required if in is set +

    +

    +
    +
    +
    +
    Parameters:
    outFile - the output File instance.
    +
    +
    +
    + +

    +setIn

    +
    +public void setIn(java.io.File inFile)
    +
    +
    specifies a single XML document to be styled. Should be used + with the out attribute; ; required if out is set +

    +

    +
    +
    +
    +
    Parameters:
    inFile - the input file
    +
    +
    +
    + +

    +getFactory

    +
    +public XSLTProcess.Factory getFactory()
    +
    +
    Get the factory instance configured for this processor +

    +

    +
    +
    +
    + +
    Returns:
    the factory instance in use
    +
    +
    +
    + +

    +getXMLCatalog

    +
    +public XMLCatalog getXMLCatalog()
    +
    +
    Get the XML catalog containing entity definitions +

    +

    +
    +
    +
    + +
    Returns:
    the XML catalog for the task.
    +
    +
    +
    + +

    +getOutputProperties

    +
    +public java.util.Enumeration getOutputProperties()
    +
    +
    Get an enumeration on the outputproperties. +

    +

    +
    +
    +
    + +
    Returns:
    the outputproperties
    +
    +
    +
    + +

    +getLiaison

    +
    +protected XSLTLiaison getLiaison()
    +
    +
    Get the Liason implementation to use in processing. +

    +

    +
    +
    +
    + +
    Returns:
    an instance of the XSLTLiason interface.
    +
    +
    +
    + +

    +createParam

    +
    +public XSLTProcess.Param createParam()
    +
    +
    Create an instance of an XSL parameter for configuration by Ant. +

    +

    +
    +
    +
    + +
    Returns:
    an instance of the Param class to be configured.
    +
    +
    +
    + +

    +createOutputProperty

    +
    +public XSLTProcess.OutputProperty createOutputProperty()
    +
    +
    Create an instance of an output property to be configured. +

    +

    +
    +
    +
    + +
    Returns:
    the newly created output property.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Initialize internal instance of XMLCatalog +

    +

    +
    Overrides:
    init in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +configureLiaison

    +
    +protected void configureLiaison(java.io.File stylesheet)
+                         throws BuildException
    +
    +
    Deprecated. since Ant 1.7 +

    +

    Loads the stylesheet and set xsl:param parameters. +

    +

    +
    +
    +
    +
    Parameters:
    stylesheet - the file from which to load the stylesheet. +
    Throws: +
    BuildException - if the stylesheet cannot be loaded.
    +
    +
    +
    + +

    +configureLiaison

    +
    +protected void configureLiaison(Resource stylesheet)
+                         throws BuildException
    +
    +
    Loads the stylesheet and set xsl:param parameters. +

    +

    +
    +
    +
    +
    Parameters:
    stylesheet - the resource from which to load the stylesheet. +
    Throws: +
    BuildException - if the stylesheet cannot be loaded.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createFactory

    +
    +public XSLTProcess.Factory createFactory()
+                                  throws BuildException
    +
    +
    Create the factory element to configure a trax liaison. +

    +

    +
    +
    +
    + +
    Returns:
    the newly created factory element. +
    Throws: +
    BuildException - if the element is created more than one time.
    +
    +
    +
    + +

    +handleError

    +
    +protected void handleError(java.lang.String msg)
    +
    +
    Throws an exception with the given message if failOnError is + true, otherwise logs the message using the WARN level. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +handleError

    +
    +protected void handleError(java.lang.Throwable ex)
    +
    +
    Throws an exception with the given nested exception if + failOnError is true, otherwise logs the message using the WARN + level. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +handleTransformationError

    +
    +protected void handleTransformationError(java.lang.Exception ex)
    +
    +
    Throws an exception with the given nested exception if + failOnError and failOnTransformationError are true, otherwise + logs the message using the WARN level. +

    +

    +
    +
    +
    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XmlProperty.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XmlProperty.html new file mode 100644 index 000000000..9aa1860ac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/XmlProperty.html @@ -0,0 +1,1014 @@ + + + + + + +XmlProperty (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class XmlProperty

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.XmlProperty
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class XmlProperty
    extends Task
    + + +

    +Loads property values from a valid XML file, generating the + property names from the file's element and attribute names. + +

    Example:

    + 
    +   <root-tag myattr="true">
+     <inner-tag someattr="val">Text</inner-tag>
+     <a2><a3><a4>false</a4></a3></a2>
+     <x>x1</x>
+     <x>x2</x>
+   </root-tag>
+
    + +

    this generates the following properties:

    + + 
    +  root-tag(myattr)=true
+  root-tag.inner-tag=Text
+  root-tag.inner-tag(someattr)=val
+  root-tag.a2.a3.a4=false
+  root-tag.x=x1,x2
+
    + +

    The collapseAttributes property of this task can be set + to true (the default is false) which will instead result in the + following properties (note the difference in names of properties + corresponding to XML attributes):

    + + 
    +  root-tag.myattr=true
+  root-tag.inner-tag=Text
+  root-tag.inner-tag.someattr=val
+  root-tag.a2.a3.a4=false
+  root-tag.x=x1,x2
+
    + +

    Optionally, to more closely mirror the abilities of the Property + task, a selected set of attributes can be treated specially. To + enable this behavior, the "semanticAttributes" property of this task + must be set to true (it defaults to false). If this attribute is + specified, the following attributes take on special meaning + (setting this to true implicitly sets collapseAttributes to true as + well):

    + +
      +
    • value: Identifies a text value for a property.
      • +
    • location: Identifies a file location for a property.
      • +
    • id: Sets an id for a property
      • +
    • refid: Sets a property to the value of another property + based upon the provided id
      • +
    • pathid: Defines a path rather than a property with + the given id.
      • +
    + +

    For example, with keepRoot = false, the following properties file:

    + + 
    + <root-tag>
+   <build>
+   <build folder="build">
+     <classes id="build.classes" location="${build.folder}/classes"/>
+     <reference refid="build.classes"/>
+   </build>
+   <compile>
+     <classpath pathid="compile.classpath">
+       <pathelement location="${build.classes}"/>
+     </classpath>
+   </compile>
+   <run-time>
+     <jars>*.jar</jars>
+     <classpath pathid="run-time.classpath">
+       <path refid="compile.classpath"/>
+       <pathelement path="${run-time.jars}"/>
+     </classpath>
+   </run-time>
+ </root-tag>
+
    + +

    is equivalent to the following entries in a build file:

    + + 
    + <property name="build" location="build"/>
+ <property name="build.classes" location="${build.location}/classes"/>
+ <property name="build.reference" refid="build.classes"/>
+
+ <property name="run-time.jars" value="*.jar/>
+
+ <classpath id="compile.classpath">
+   <pathelement location="${build.classes}"/>
+ </classpath>
+
+ <classpath id="run-time.classpath">
+   <path refid="compile.classpath"/>
+   <pathelement path="${run-time.jars}"/>
+ </classpath>
+
    + +

    This task requires the following attributes:

    + +
      +
    • file: The name of the file to load.
      • +
    + +

    This task supports the following attributes:

    + +
      +
    • prefix: Optionally specify a prefix applied to + all properties loaded. Defaults to an empty string.
      • +
    • keepRoot: Indicate whether the root xml element + is kept as part of property name. Defaults to true.
      • +
    • validate: Indicate whether the xml file is validated. + Defaults to false.
      • +
    • collapseAttributes: Indicate whether attributes are + stored in property names with parens or with period + delimiters. Defaults to false, meaning properties + are stored with parens (i.e., foo(attr)).
      • +
    • semanticAttributes: Indicate whether attributes + named "location", "value", "refid" and "path" + are interpreted as ant properties. Defaults + to false.
      • +
    • rootDirectory: Indicate the directory to use + as the root directory for resolving location + properties. Defaults to the directory + of the project using the task.
      • +
    • includeSemanticAttribute: Indicate whether to include + the semantic attribute ("location" or "value") as + part of the property name. Defaults to false.
      • +
    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    XmlProperty() + +
    +          Constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddConfigured(ResourceCollection a) + +
    +          Set the source resource.
    + voidaddConfiguredXMLCatalog(XMLCatalog catalog) + +
    +          add an XMLCatalog as a nested element; optional.
    + voidexecute() + +
    +          Run the task.
    +protected  booleangetCollapseAttributes() + +
    +           
    + java.lang.StringgetDelimiter() + +
    +          Get the current delimiter.
    +protected  org.xml.sax.EntityResolvergetEntityResolver() + +
    +           
    +protected  java.io.FilegetFile() + +
    +           
    +protected  booleangetIncludeSementicAttribute() + +
    +           
    +protected  booleangetKeeproot() + +
    +           
    +protected  java.lang.StringgetPrefix() + +
    +           
    +protected  ResourcegetResource() + +
    +           
    +protected  java.io.FilegetRootDirectory() + +
    +           
    +protected  booleangetSemanticAttributes() + +
    +           
    +protected  booleangetValidate() + +
    +           
    + voidinit() + +
    +          Initializes the task.
    + java.lang.ObjectprocessNode(org.w3c.dom.Node node, + java.lang.String prefix, + java.lang.Object container) + +
    +          Process the given node, adding any required attributes from + this child node alone -- but not processing any + children.
    + voidsetCollapseAttributes(boolean collapseAttributes) + +
    +          flag to treat attributes as nested elements; + optional, default false
    + voidsetDelimiter(java.lang.String delimiter) + +
    +          Sets a new delimiter.
    + voidsetFile(java.io.File src) + +
    +          The XML file to parse; required.
    + voidsetIncludeSemanticAttribute(boolean includeSemanticAttribute) + +
    +          Include the semantic attribute name as part of the property name.
    + voidsetKeeproot(boolean keepRoot) + +
    +          flag to include the xml root tag as a + first value in the property name; optional, + default is true
    + voidsetPrefix(java.lang.String prefix) + +
    +          the prefix to prepend to each property
    + voidsetRootDirectory(java.io.File rootDirectory) + +
    +          The directory to use for resolving file references.
    + voidsetSemanticAttributes(boolean semanticAttributes) + +
    +          Attribute to enable special handling of attributes - see ant manual.
    + voidsetSrcResource(Resource src) + +
    +          The resource to pack; required.
    + voidsetValidate(boolean validate) + +
    +          flag to validate the XML file; optional, default false
    +protected  booleansupportsNonFileResources() + +
    +          Whether this task can deal with non-file resources.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +XmlProperty

    +
    +public XmlProperty()
    +
    +
    Constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +init

    +
    +public void init()
    +
    +
    Initializes the task. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    +
    +
    +
    +
    + +

    +getEntityResolver

    +
    +protected org.xml.sax.EntityResolver getEntityResolver()
    +
    +
    + +
    Returns:
    the xmlCatalog as the entityresolver.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Run the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - The exception raised during task execution.
    To do:
    +
    validate the source file is valid before opening, print a better error message, add a verbose level log message listing the name of the file being loaded
    +
    +
    +
    +
    + +

    +processNode

    +
    +public java.lang.Object processNode(org.w3c.dom.Node node,
+                                    java.lang.String prefix,
+                                    java.lang.Object container)
    +
    +
    Process the given node, adding any required attributes from + this child node alone -- but not processing any + children. +

    +

    +
    Parameters:
    node - the XML Node to parse
    prefix - A string to prepend to any properties that get + added by this node.
    container - Optionally, an object that a parent node + generated that this node might belong to. For example, this + node could be within a node that generated a Path. +
    Returns:
    the Object created by this node. Generally, this is + either a String if this node resulted in setting an attribute, + or a Path.
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File src)
    +
    +
    The XML file to parse; required. +

    +

    +
    Parameters:
    src - the file to parse
    +
    +
    +
    + +

    +setSrcResource

    +
    +public void setSrcResource(Resource src)
    +
    +
    The resource to pack; required. +

    +

    +
    Parameters:
    src - resource to expand
    +
    +
    +
    + +

    +addConfigured

    +
    +public void addConfigured(ResourceCollection a)
    +
    +
    Set the source resource. +

    +

    +
    Parameters:
    a - the resource to pack as a single element Resource collection.
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    the prefix to prepend to each property +

    +

    +
    Parameters:
    prefix - the prefix to prepend to each property
    +
    +
    +
    + +

    +setKeeproot

    +
    +public void setKeeproot(boolean keepRoot)
    +
    +
    flag to include the xml root tag as a + first value in the property name; optional, + default is true +

    +

    +
    Parameters:
    keepRoot - if true (default), include the xml root tag
    +
    +
    +
    + +

    +setValidate

    +
    +public void setValidate(boolean validate)
    +
    +
    flag to validate the XML file; optional, default false +

    +

    +
    Parameters:
    validate - if true validate the XML file, default false
    +
    +
    +
    + +

    +setCollapseAttributes

    +
    +public void setCollapseAttributes(boolean collapseAttributes)
    +
    +
    flag to treat attributes as nested elements; + optional, default false +

    +

    +
    Parameters:
    collapseAttributes - if true treat attributes as nested elements
    +
    +
    +
    + +

    +setSemanticAttributes

    +
    +public void setSemanticAttributes(boolean semanticAttributes)
    +
    +
    Attribute to enable special handling of attributes - see ant manual. +

    +

    +
    Parameters:
    semanticAttributes - if true enable the special handling.
    +
    +
    +
    + +

    +setRootDirectory

    +
    +public void setRootDirectory(java.io.File rootDirectory)
    +
    +
    The directory to use for resolving file references. + Ignored if semanticAttributes is not set to true. +

    +

    +
    Parameters:
    rootDirectory - the directory.
    +
    +
    +
    + +

    +setIncludeSemanticAttribute

    +
    +public void setIncludeSemanticAttribute(boolean includeSemanticAttribute)
    +
    +
    Include the semantic attribute name as part of the property name. + Ignored if semanticAttributes is not set to true. +

    +

    +
    Parameters:
    includeSemanticAttribute - if true include the sematic attribute + name.
    +
    +
    +
    + +

    +addConfiguredXMLCatalog

    +
    +public void addConfiguredXMLCatalog(XMLCatalog catalog)
    +
    +
    add an XMLCatalog as a nested element; optional. +

    +

    +
    Parameters:
    catalog - the XMLCatalog to use
    +
    +
    +
    + +

    +getFile

    +
    +protected java.io.File getFile()
    +
    +
    + +
    Returns:
    the file attribute.
    +
    +
    +
    + +

    +getResource

    +
    +protected Resource getResource()
    +
    +
    + +
    Returns:
    the resource.
    +
    +
    +
    + +

    +getPrefix

    +
    +protected java.lang.String getPrefix()
    +
    +
    + +
    Returns:
    the prefix attribute.
    +
    +
    +
    + +

    +getKeeproot

    +
    +protected boolean getKeeproot()
    +
    +
    + +
    Returns:
    the keeproot attribute.
    +
    +
    +
    + +

    +getValidate

    +
    +protected boolean getValidate()
    +
    +
    + +
    Returns:
    the validate attribute.
    +
    +
    +
    + +

    +getCollapseAttributes

    +
    +protected boolean getCollapseAttributes()
    +
    +
    + +
    Returns:
    the collapse attributes attribute.
    +
    +
    +
    + +

    +getSemanticAttributes

    +
    +protected boolean getSemanticAttributes()
    +
    +
    + +
    Returns:
    the semantic attributes attribute.
    +
    +
    +
    + +

    +getRootDirectory

    +
    +protected java.io.File getRootDirectory()
    +
    +
    + +
    Returns:
    the root directory attribute.
    +
    +
    +
    + +

    +getIncludeSementicAttribute

    +
    +protected boolean getIncludeSementicAttribute()
    +
    +
    + +
    Returns:
    the include semantic attribute.
    +
    +
    +
    + +

    +supportsNonFileResources

    +
    +protected boolean supportsNonFileResources()
    +
    +
    Whether this task can deal with non-file resources. + +

    This implementation returns true only if this task is + <xmlproperty>. Any subclass of this class that also wants to + support non-file resources needs to override this method. We + need to do so for backwards compatibility reasons since we + can't expect subclasses to support resources.

    +

    +

    + +
    Returns:
    true for this task.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getDelimiter

    +
    +public java.lang.String getDelimiter()
    +
    +
    Get the current delimiter. +

    +

    + +
    Returns:
    delimiter
    +
    +
    +
    + +

    +setDelimiter

    +
    +public void setDelimiter(java.lang.String delimiter)
    +
    +
    Sets a new delimiter. +

    +

    +
    Parameters:
    delimiter - new value
    Since:
    +
    Ant 1.7.1
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.ArchiveState.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.ArchiveState.html new file mode 100644 index 000000000..ed9da5e3c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.ArchiveState.html @@ -0,0 +1,275 @@ + + + + + + +Zip.ArchiveState (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Zip.ArchiveState

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.Zip.ArchiveState
+
    +
    +
    Enclosing class:
    Zip
    +
    +
    +
    +
    public static class Zip.ArchiveState
    extends java.lang.Object
    + + +

    +Holds the up-to-date status and the out-of-date resources of + the original archive. +

    + +

    +

    +
    Since:
    +
    Ant 1.5.3
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + Resource[][]getResourcesToAdd() + +
    +          Get the resources to add.
    + booleanisOutOfDate() + +
    +          Return the outofdate status.
    + booleanisWithoutAnyResources() + +
    +          find out if there are absolutely no resources to add
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +isOutOfDate

    +
    +public boolean isOutOfDate()
    +
    +
    Return the outofdate status. +

    +

    + +
    Returns:
    the outofdate status
    +
    +
    +
    + +

    +getResourcesToAdd

    +
    +public Resource[][] getResourcesToAdd()
    +
    +
    Get the resources to add. +

    +

    + +
    Returns:
    the resources to add
    +
    +
    +
    + +

    +isWithoutAnyResources

    +
    +public boolean isWithoutAnyResources()
    +
    +
    find out if there are absolutely no resources to add +

    +

    + +
    Returns:
    true if there are no resources to add
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.Duplicate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.Duplicate.html new file mode 100644 index 000000000..478c73b0b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.Duplicate.html @@ -0,0 +1,291 @@ + + + + + + +Zip.Duplicate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Zip.Duplicate

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Zip.Duplicate
+
    +
    +
    Enclosing class:
    Zip
    +
    +
    +
    +
    public static class Zip.Duplicate
    extends EnumeratedAttribute
    + + +

    +Possible behaviors when a duplicate file is added: + "add", "preserve" or "fail" +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Zip.Duplicate() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Zip.Duplicate

    +
    +public Zip.Duplicate()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.UnicodeExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.UnicodeExtraField.html new file mode 100644 index 000000000..bed047421 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.UnicodeExtraField.html @@ -0,0 +1,342 @@ + + + + + + +Zip.UnicodeExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Zip.UnicodeExtraField

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Zip.UnicodeExtraField
+
    +
    +
    Enclosing class:
    Zip
    +
    +
    +
    +
    public static final class Zip.UnicodeExtraField
    extends EnumeratedAttribute
    + + +

    +Policiy for creation of Unicode extra fields: never, always or + not-encodeable. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +static Zip.UnicodeExtraFieldNEVER + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Zip.UnicodeExtraField() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + ZipOutputStream.UnicodeExtraFieldPolicygetPolicy() + +
    +           
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NEVER

    +
    +public static final Zip.UnicodeExtraField NEVER
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Zip.UnicodeExtraField

    +
    +public Zip.UnicodeExtraField()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +getPolicy

    +
    +public ZipOutputStream.UnicodeExtraFieldPolicy getPolicy()
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.WhenEmpty.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.WhenEmpty.html new file mode 100644 index 000000000..1bb69023c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.WhenEmpty.html @@ -0,0 +1,289 @@ + + + + + + +Zip.WhenEmpty (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Zip.WhenEmpty

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.Zip.WhenEmpty
+
    +
    +
    Enclosing class:
    Zip
    +
    +
    +
    +
    public static class Zip.WhenEmpty
    extends EnumeratedAttribute
    + + +

    +Possible behaviors when there are no matching files for the task: + "fail", "skip", or "create". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    Zip.WhenEmpty() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          The string values for the enumerated value
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Zip.WhenEmpty

    +
    +public Zip.WhenEmpty()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    The string values for the enumerated value +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    the values
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.html new file mode 100644 index 000000000..d45c859c2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/Zip.html @@ -0,0 +1,2219 @@ + + + + + + +Zip (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs +
    +Class Zip

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.Zip
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    Direct Known Subclasses:
    Jar
    +
    +
    +
    +
    public class Zip
    extends MatchingTask
    + + +

    +Create a Zip file. +

    + +

    +

    +
    Since:
    +
    Ant 1.1
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classZip.ArchiveState + +
    +          Holds the up-to-date status and the out-of-date resources of + the original archive.
    +static classZip.Duplicate + +
    +          Possible behaviors when a duplicate file is added: + "add", "preserve" or "fail"
    +static classZip.UnicodeExtraField + +
    +          Policiy for creation of Unicode extra fields: never, always or + not-encodeable.
    +static classZip.WhenEmpty + +
    +          Possible behaviors when there are no matching files for the task: + "fail", "skip", or "create".
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.util.HashtableaddedDirs + +
    +           
    +protected  java.lang.StringarchiveType + +
    +           
    +protected  booleandoubleFilePass + +
    +          If this flag is true, execute() will run most operations twice, + the first time with skipWriting set to + true and the second time with setting it to false.
    +protected  java.lang.Stringduplicate + +
    +           
    +protected  java.lang.StringemptyBehavior + +
    +           
    +protected  java.util.Hashtableentries + +
    +           
    +protected  booleanskipWriting + +
    +          whether the methods should just perform some sort of dry-run.
    +protected  java.io.FilezipFile + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Zip() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection a) + +
    +          Add a collection of resources to be archived.
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files.
    +protected  voidaddParentDirs(java.io.File baseDir, + java.lang.String entry, + ZipOutputStream zOut, + java.lang.String prefix, + int dirMode) + +
    +          Ensure all parent dirs of a given entry have been added.
    +protected  voidaddResources(FileSet fileset, + Resource[] resources, + ZipOutputStream zOut) + +
    +          Add the given resources.
    +protected  voidaddResources(ResourceCollection rc, + Resource[] resources, + ZipOutputStream zOut) + +
    +          Add the given resources.
    + voidaddZipfileset(ZipFileSet set) + +
    +          Adds a set of files that can be + read from an archive and be given a prefix/fullpath.
    + voidaddZipGroupFileset(FileSet set) + +
    +          Adds a group of zip files.
    +protected  voidcleanUp() + +
    +          Do any clean up necessary to allow this instance to be used again.
    +protected  booleancreateEmptyZip(java.io.File zipFile) + +
    +          Create an empty zip file
    + voidexecute() + +
    +          validate and build
    + voidexecuteMain() + +
    +          Build the zip file.
    +protected  voidfinalizeZipOutputStream(ZipOutputStream zOut) + +
    +          method for subclasses to override
    + java.lang.StringgetComment() + +
    +          Comment of the archive
    + Zip.UnicodeExtraFieldgetCreateUnicodeExtraFields() + +
    +          Whether Unicode extra fields will be created.
    +protected  ZipExtraField[]getCurrentExtraFields() + +
    +          Provides the extra fields for the zip entry currently being + added to the archive - if any.
    + java.io.FilegetDestFile() + +
    +          The file to create.
    + java.lang.StringgetEncoding() + +
    +          Encoding to use for filenames.
    + booleangetFallBackToUTF8() + +
    +          Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding.
    + intgetLevel() + +
    +          Get the compression level.
    +protected  Zip.ArchiveStategetNonFileSetResourcesToAdd(ResourceCollection[] rcs, + java.io.File zipFile, + boolean needsUpdate) + +
    +          Collect the resources that are newer than the corresponding + entries (or missing) in the original archive.
    + booleangetPreserve0Permissions() + +
    +          Assume 0 Unix mode is intentional.
    +protected  Zip.ArchiveStategetResourcesToAdd(FileSet[] filesets, + java.io.File zipFile, + boolean needsUpdate) + +
    +          Collect the resources that are newer than the corresponding + entries (or missing) in the original archive.
    +protected  Zip.ArchiveStategetResourcesToAdd(ResourceCollection[] rcs, + java.io.File zipFile, + boolean needsUpdate) + +
    +          Collect the resources that are newer than the corresponding + entries (or missing) in the original archive.
    + booleangetUseLanguageEnodingFlag() + +
    +          Whether the language encoding flag will be used.
    +protected  Resource[][]grabNonFileSetResources(ResourceCollection[] rcs) + +
    +          Fetch all included and not excluded resources from the collections.
    +protected  Resource[][]grabResources(FileSet[] filesets) + +
    +          Fetch all included and not excluded resources from the sets.
    +protected  booleanhasUpdatedFile() + +
    +          Get the value of the updatedFile attribute.
    +protected  voidinitZipOutputStream(ZipOutputStream zOut) + +
    +          method for subclasses to override
    +protected  booleanisAddingNewFiles() + +
    +          Indicates if the task is adding new files into the archive as opposed to + copying back unchanged files from the backup copy
    + booleanisCompress() + +
    +          Whether we want to compress the files or only store them;
    +protected static booleanisEmpty(Resource[][] r) + +
    +          Check is the resource arrays are empty.
    +protected  booleanisFirstPass() + +
    +          Whether this is the first time the archive building methods are invoked.
    + booleanisInUpdateMode() + +
    +          Are we updating an existing archive?
    +protected  voidlogWhenWriting(java.lang.String msg, + int level) + +
    +          Logs a message at the given output level, but only if this is + the pass that will actually create the archive.
    + voidreset() + +
    +          Makes this instance reset all attributes to their default + values and forget all children.
    +protected  Resource[]selectDirectoryResources(Resource[] orig) + +
    +          Drops all non-directory resources from the given array.
    +protected  Resource[]selectFileResources(Resource[] orig) + +
    +          Drops all non-file resources from the given array.
    +protected  Resource[]selectResources(Resource[] orig, + ResourceSelector selector) + +
    +          Drops all resources from the given array that are not selected
    + voidsetBasedir(java.io.File baseDir) + +
    +          Directory from which to archive files; optional.
    + voidsetComment(java.lang.String comment) + +
    +          Comment to use for archive.
    + voidsetCompress(boolean c) + +
    +          Whether we want to compress the files or only store them; + optional, default=true;
    + voidsetCreateUnicodeExtraFields(Zip.UnicodeExtraField b) + +
    +          Whether Unicode extra fields will be created.
    +protected  voidsetCurrentExtraFields(ZipExtraField[] extra) + +
    +          Sets the extra fields for the zip entry currently being + added to the archive - if any.
    + voidsetDestFile(java.io.File destFile) + +
    +          The file to create; required.
    + voidsetDuplicate(Zip.Duplicate df) + +
    +          Sets behavior for when a duplicate file is about to be added - + one of add, preserve or fail.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Encoding to use for filenames, defaults to the platform's + default encoding.
    + voidsetFallBackToUTF8(boolean b) + +
    +          Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding.
    + voidsetFile(java.io.File file) + +
    +          Deprecated. since 1.5.x. + Use setDestFile(File) instead.
    + voidsetFilesonly(boolean f) + +
    +          If true, emulate Sun's jar utility by not adding parent directories; + optional, defaults to false.
    + voidsetKeepCompression(boolean keep) + +
    +          Whether the original compression of entries coming from a ZIP + archive should be kept (for example when updating an archive).
    + voidsetLevel(int level) + +
    +          Set the compression level to use.
    + voidsetPreserve0Permissions(boolean b) + +
    +          Assume 0 Unix mode is intentional.
    + voidsetRoundUp(boolean r) + +
    +          Whether the file modification times will be rounded up to the + next even number of seconds.
    + voidsetUpdate(boolean c) + +
    +          If true, updates an existing file, otherwise overwrite + any existing one; optional defaults to false.
    + voidsetUseLanguageEncodingFlag(boolean b) + +
    +          Whether to set the language encoding flag.
    + voidsetWhenempty(Zip.WhenEmpty we) + +
    +          Sets behavior of the task when no files match.
    + voidsetZipfile(java.io.File zipFile) + +
    +          Deprecated. since 1.5.x. + Use setDestFile(File) instead.
    +protected  voidzipDir(java.io.File dir, + ZipOutputStream zOut, + java.lang.String vPath, + int mode) + +
    +          Add a directory to the zip stream.
    +protected  voidzipDir(java.io.File dir, + ZipOutputStream zOut, + java.lang.String vPath, + int mode, + ZipExtraField[] extra) + +
    +          Add a directory to the zip stream.
    +protected  voidzipDir(Resource dir, + ZipOutputStream zOut, + java.lang.String vPath, + int mode, + ZipExtraField[] extra) + +
    +          Add a directory to the zip stream.
    +protected  voidzipFile(java.io.File file, + ZipOutputStream zOut, + java.lang.String vPath, + int mode) + +
    +          Method that gets called when adding from java.io.File instances.
    +protected  voidzipFile(java.io.InputStream in, + ZipOutputStream zOut, + java.lang.String vPath, + long lastModified, + java.io.File fromArchive, + int mode) + +
    +          Adds a new entry to the archive, takes care of duplicates as well.
    +protected  voidzipFile(java.io.InputStream in, + ZipOutputStream zOut, + java.lang.String vPath, + long lastModified, + java.io.File fromArchive, + int mode, + ZipExtraField[] extra) + +
    +          Adds a new entry to the archive, takes care of duplicates as well.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +zipFile

    +
    +protected java.io.File zipFile
    +
    +
    +
    +
    +
    + +

    +entries

    +
    +protected java.util.Hashtable entries
    +
    +
    +
    +
    +
    + +

    +duplicate

    +
    +protected java.lang.String duplicate
    +
    +
    +
    +
    +
    + +

    +archiveType

    +
    +protected java.lang.String archiveType
    +
    +
    +
    +
    +
    + +

    +emptyBehavior

    +
    +protected java.lang.String emptyBehavior
    +
    +
    +
    +
    +
    + +

    +addedDirs

    +
    +protected java.util.Hashtable addedDirs
    +
    +
    +
    +
    +
    + +

    +doubleFilePass

    +
    +protected boolean doubleFilePass
    +
    +
    If this flag is true, execute() will run most operations twice, + the first time with skipWriting set to + true and the second time with setting it to false. + +

    The only situation in Ant's current code base where this is + ever going to be true is if the jar task has been configured + with a filesetmanifest other than "skip".

    +

    +

    +
    +
    +
    + +

    +skipWriting

    +
    +protected boolean skipWriting
    +
    +
    whether the methods should just perform some sort of dry-run. + +

    Will only ever be true in the first pass if the task + performs two passes because doubleFilePass is true.

    +

    +

    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Zip

    +
    +public Zip()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +isFirstPass

    +
    +protected final boolean isFirstPass()
    +
    +
    Whether this is the first time the archive building methods are invoked. +

    +

    + +
    Returns:
    true if either doubleFilePass + is false or skipWriting is true.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setZipfile

    +
    +public void setZipfile(java.io.File zipFile)
    +
    +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +

    +

    This is the name/location of where to + create the .zip file. +

    +

    +
    Parameters:
    zipFile - the path of the zipFile
    +
    +
    +
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    Deprecated. since 1.5.x. + Use setDestFile(File) instead. +

    +

    This is the name/location of where to + create the file. +

    +

    +
    Parameters:
    file - the path of the zipFile
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setDestFile

    +
    +public void setDestFile(java.io.File destFile)
    +
    +
    The file to create; required. +

    +

    +
    Parameters:
    destFile - The new destination File
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +getDestFile

    +
    +public java.io.File getDestFile()
    +
    +
    The file to create. +

    +

    + +
    Returns:
    the destination file
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File baseDir)
    +
    +
    Directory from which to archive files; optional. +

    +

    +
    Parameters:
    baseDir - the base directory
    +
    +
    +
    + +

    +setCompress

    +
    +public void setCompress(boolean c)
    +
    +
    Whether we want to compress the files or only store them; + optional, default=true; +

    +

    +
    Parameters:
    c - if true, compress the files
    +
    +
    +
    + +

    +isCompress

    +
    +public boolean isCompress()
    +
    +
    Whether we want to compress the files or only store them; +

    +

    + +
    Returns:
    true if the files are to be compressed
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +setFilesonly

    +
    +public void setFilesonly(boolean f)
    +
    +
    If true, emulate Sun's jar utility by not adding parent directories; + optional, defaults to false. +

    +

    +
    Parameters:
    f - if true, emulate sun's jar by not adding parent directories
    +
    +
    +
    + +

    +setUpdate

    +
    +public void setUpdate(boolean c)
    +
    +
    If true, updates an existing file, otherwise overwrite + any existing one; optional defaults to false. +

    +

    +
    Parameters:
    c - if true, updates an existing zip file
    +
    +
    +
    + +

    +isInUpdateMode

    +
    +public boolean isInUpdateMode()
    +
    +
    Are we updating an existing archive? +

    +

    + +
    Returns:
    true if updating an existing archive
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files. +

    +

    +
    Parameters:
    set - the fileset to add
    +
    +
    +
    + +

    +addZipfileset

    +
    +public void addZipfileset(ZipFileSet set)
    +
    +
    Adds a set of files that can be + read from an archive and be given a prefix/fullpath. +

    +

    +
    Parameters:
    set - the zipfileset to add
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection a)
    +
    +
    Add a collection of resources to be archived. +

    +

    +
    Parameters:
    a - the resources to archive
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addZipGroupFileset

    +
    +public void addZipGroupFileset(FileSet set)
    +
    +
    Adds a group of zip files. +

    +

    +
    Parameters:
    set - the group (a fileset) to add
    +
    +
    +
    + +

    +setDuplicate

    +
    +public void setDuplicate(Zip.Duplicate df)
    +
    +
    Sets behavior for when a duplicate file is about to be added - + one of add, preserve or fail. + Possible values are: add (keep both + of the files); preserve (keep the first version + of the file found); fail halt a problem + Default for zip tasks is add +

    +

    +
    Parameters:
    df - a Duplicate enumerated value
    +
    +
    +
    + +

    +setWhenempty

    +
    +public void setWhenempty(Zip.WhenEmpty we)
    +
    +
    Sets behavior of the task when no files match. + Possible values are: fail (throw an exception + and halt the build); skip (do not create + any archive, but issue a warning); create + (make an archive with no entries). + Default for zip tasks is skip; + for jar tasks, create. +

    +

    +
    Parameters:
    we - a WhenEmpty enumerated value
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Encoding to use for filenames, defaults to the platform's + default encoding. + +

    For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html.

    +

    +

    +
    Parameters:
    encoding - the encoding name
    +
    +
    +
    + +

    +getEncoding

    +
    +public java.lang.String getEncoding()
    +
    +
    Encoding to use for filenames. +

    +

    + +
    Returns:
    the name of the encoding to use
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +setKeepCompression

    +
    +public void setKeepCompression(boolean keep)
    +
    +
    Whether the original compression of entries coming from a ZIP + archive should be kept (for example when updating an archive). + Default is false. +

    +

    +
    Parameters:
    keep - if true, keep the original compression
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setComment

    +
    +public void setComment(java.lang.String comment)
    +
    +
    Comment to use for archive. +

    +

    +
    Parameters:
    comment - The content of the comment.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getComment

    +
    +public java.lang.String getComment()
    +
    +
    Comment of the archive +

    +

    + +
    Returns:
    Comment of the archive.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setLevel

    +
    +public void setLevel(int level)
    +
    +
    Set the compression level to use. Default is + ZipOutputStream.DEFAULT_COMPRESSION. +

    +

    +
    Parameters:
    level - compression level.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getLevel

    +
    +public int getLevel()
    +
    +
    Get the compression level. +

    +

    + +
    Returns:
    compression level.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setRoundUp

    +
    +public void setRoundUp(boolean r)
    +
    +
    Whether the file modification times will be rounded up to the + next even number of seconds. + +

    Zip archives store file modification times with a + granularity of two seconds, so the times will either be rounded + up or down. If you round down, the archive will always seem + out-of-date when you rerun the task, so the default is to round + up. Rounding up may lead to a different type of problems like + JSPs inside a web archive that seem to be slightly more recent + than precompiled pages, rendering precompilation useless.

    +

    +

    +
    Parameters:
    r - a boolean value
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    +
    + +

    +setPreserve0Permissions

    +
    +public void setPreserve0Permissions(boolean b)
    +
    +
    Assume 0 Unix mode is intentional. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getPreserve0Permissions

    +
    +public boolean getPreserve0Permissions()
    +
    +
    Assume 0 Unix mode is intentional. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setUseLanguageEncodingFlag

    +
    +public void setUseLanguageEncodingFlag(boolean b)
    +
    +
    Whether to set the language encoding flag. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getUseLanguageEnodingFlag

    +
    +public boolean getUseLanguageEnodingFlag()
    +
    +
    Whether the language encoding flag will be used. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCreateUnicodeExtraFields

    +
    +public void setCreateUnicodeExtraFields(Zip.UnicodeExtraField b)
    +
    +
    Whether Unicode extra fields will be created. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getCreateUnicodeExtraFields

    +
    +public Zip.UnicodeExtraField getCreateUnicodeExtraFields()
    +
    +
    Whether Unicode extra fields will be created. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setFallBackToUTF8

    +
    +public void setFallBackToUTF8(boolean b)
    +
    +
    Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding. + +

    Defaults to false.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getFallBackToUTF8

    +
    +public boolean getFallBackToUTF8()
    +
    +
    Whether to fall back to UTF-8 if a name cannot be enoded using + the specified encoding. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    validate and build +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +hasUpdatedFile

    +
    +protected boolean hasUpdatedFile()
    +
    +
    Get the value of the updatedFile attribute. + This should only be called after executeMain has been + called. +

    +

    + +
    Returns:
    true if executeMain has written to the zip file.
    +
    +
    +
    + +

    +executeMain

    +
    +public void executeMain()
+                 throws BuildException
    +
    +
    Build the zip file. + This is called twice if doubleFilePass is true. +

    +

    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +isAddingNewFiles

    +
    +protected final boolean isAddingNewFiles()
    +
    +
    Indicates if the task is adding new files into the archive as opposed to + copying back unchanged files from the backup copy +

    +

    + +
    Returns:
    true if adding new files
    +
    +
    +
    + +

    +addResources

    +
    +protected final void addResources(FileSet fileset,
+                                  Resource[] resources,
+                                  ZipOutputStream zOut)
+                           throws java.io.IOException
    +
    +
    Add the given resources. +

    +

    +
    Parameters:
    fileset - may give additional information like fullpath or + permissions.
    resources - the resources to add
    zOut - the stream to write to +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +addResources

    +
    +protected final void addResources(ResourceCollection rc,
+                                  Resource[] resources,
+                                  ZipOutputStream zOut)
+                           throws java.io.IOException
    +
    +
    Add the given resources. +

    +

    +
    Parameters:
    rc - may give additional information like fullpath or + permissions.
    resources - the resources to add
    zOut - the stream to write to +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +initZipOutputStream

    +
    +protected void initZipOutputStream(ZipOutputStream zOut)
+                            throws java.io.IOException,
+                                   BuildException
    +
    +
    method for subclasses to override +

    +

    +
    Parameters:
    zOut - the zip output stream +
    Throws: +
    java.io.IOException - on output error +
    BuildException - on other errors
    +
    +
    +
    + +

    +finalizeZipOutputStream

    +
    +protected void finalizeZipOutputStream(ZipOutputStream zOut)
+                                throws java.io.IOException,
+                                       BuildException
    +
    +
    method for subclasses to override +

    +

    +
    Parameters:
    zOut - the zip output stream +
    Throws: +
    java.io.IOException - on output error +
    BuildException - on other errors
    +
    +
    +
    + +

    +createEmptyZip

    +
    +protected boolean createEmptyZip(java.io.File zipFile)
+                          throws BuildException
    +
    +
    Create an empty zip file +

    +

    +
    Parameters:
    zipFile - the zip file +
    Returns:
    true for historic reasons +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getResourcesToAdd

    +
    +protected Zip.ArchiveState getResourcesToAdd(ResourceCollection[] rcs,
+                                             java.io.File zipFile,
+                                             boolean needsUpdate)
+                                      throws BuildException
    +
    +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. + +

    If we are going to recreate the archive instead of updating + it, all resources should be considered as new, if a single one + is. Because of this, subclasses overriding this method must + call super.getResourcesToAdd and indicate with the + third arg if they already know that the archive is + out-of-date.

    + +

    This method first delegates to getNonFileSetResourceToAdd + and then invokes the FileSet-arg version. All this to keep + backwards compatibility for subclasses that don't know how to + deal with non-FileSet ResourceCollections.

    +

    +

    +
    Parameters:
    rcs - The resource collections to grab resources from
    zipFile - intended archive file (may or may not exist)
    needsUpdate - whether we already know that the archive is + out-of-date. Subclasses overriding this method are supposed to + set this value correctly in their call to + super.getResourcesToAdd. +
    Returns:
    an array of resources to add for each fileset passed in as well + as a flag that indicates whether the archive is uptodate. +
    Throws: +
    BuildException - if it likes
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getResourcesToAdd

    +
    +protected Zip.ArchiveState getResourcesToAdd(FileSet[] filesets,
+                                             java.io.File zipFile,
+                                             boolean needsUpdate)
+                                      throws BuildException
    +
    +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. + +

    If we are going to recreate the archive instead of updating + it, all resources should be considered as new, if a single one + is. Because of this, subclasses overriding this method must + call super.getResourcesToAdd and indicate with the + third arg if they already know that the archive is + out-of-date.

    +

    +

    +
    Parameters:
    filesets - The filesets to grab resources from
    zipFile - intended archive file (may or may not exist)
    needsUpdate - whether we already know that the archive is + out-of-date. Subclasses overriding this method are supposed to + set this value correctly in their call to + super.getResourcesToAdd. +
    Returns:
    an array of resources to add for each fileset passed in as well + as a flag that indicates whether the archive is uptodate. +
    Throws: +
    BuildException - if it likes
    +
    +
    +
    + +

    +getNonFileSetResourcesToAdd

    +
    +protected Zip.ArchiveState getNonFileSetResourcesToAdd(ResourceCollection[] rcs,
+                                                       java.io.File zipFile,
+                                                       boolean needsUpdate)
+                                                throws BuildException
    +
    +
    Collect the resources that are newer than the corresponding + entries (or missing) in the original archive. + +

    If we are going to recreate the archive instead of updating + it, all resources should be considered as new, if a single one + is. Because of this, subclasses overriding this method must + call super.getResourcesToAdd and indicate with the + third arg if they already know that the archive is + out-of-date.

    +

    +

    +
    Parameters:
    rcs - The filesets to grab resources from
    zipFile - intended archive file (may or may not exist)
    needsUpdate - whether we already know that the archive is + out-of-date. Subclasses overriding this method are supposed to + set this value correctly in their call to + super.getResourcesToAdd. +
    Returns:
    an array of resources to add for each fileset passed in as well + as a flag that indicates whether the archive is uptodate. +
    Throws: +
    BuildException - if it likes
    +
    +
    +
    + +

    +grabResources

    +
    +protected Resource[][] grabResources(FileSet[] filesets)
    +
    +
    Fetch all included and not excluded resources from the sets. + +

    Included directories will precede included files.

    +

    +

    +
    Parameters:
    filesets - an array of filesets +
    Returns:
    the resources included
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +grabNonFileSetResources

    +
    +protected Resource[][] grabNonFileSetResources(ResourceCollection[] rcs)
    +
    +
    Fetch all included and not excluded resources from the collections. + +

    Included directories will precede included files.

    +

    +

    +
    Parameters:
    rcs - an array of resource collections +
    Returns:
    the resources included
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +zipDir

    +
    +protected void zipDir(java.io.File dir,
+                      ZipOutputStream zOut,
+                      java.lang.String vPath,
+                      int mode)
+               throws java.io.IOException
    +
    +
    Add a directory to the zip stream. +

    +

    +
    Parameters:
    dir - the directort to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +zipDir

    +
    +protected void zipDir(java.io.File dir,
+                      ZipOutputStream zOut,
+                      java.lang.String vPath,
+                      int mode,
+                      ZipExtraField[] extra)
+               throws java.io.IOException
    +
    +
    Add a directory to the zip stream. +

    +

    +
    Parameters:
    dir - the directory to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set.
    extra - ZipExtraFields to add +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +zipDir

    +
    +protected void zipDir(Resource dir,
+                      ZipOutputStream zOut,
+                      java.lang.String vPath,
+                      int mode,
+                      ZipExtraField[] extra)
+               throws java.io.IOException
    +
    +
    Add a directory to the zip stream. +

    +

    +
    Parameters:
    dir - the directory to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set.
    extra - ZipExtraFields to add +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getCurrentExtraFields

    +
    +protected final ZipExtraField[] getCurrentExtraFields()
    +
    +
    Provides the extra fields for the zip entry currently being + added to the archive - if any. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setCurrentExtraFields

    +
    +protected final void setCurrentExtraFields(ZipExtraField[] extra)
    +
    +
    Sets the extra fields for the zip entry currently being + added to the archive - if any. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.InputStream in,
+                       ZipOutputStream zOut,
+                       java.lang.String vPath,
+                       long lastModified,
+                       java.io.File fromArchive,
+                       int mode)
+                throws java.io.IOException
    +
    +
    Adds a new entry to the archive, takes care of duplicates as well. +

    +

    +
    Parameters:
    in - the stream to read data for the entry from. The + caller of the method is responsible for closing the stream.
    zOut - the stream to write to.
    vPath - the name this entry shall have in the archive.
    lastModified - last modification time for the entry.
    fromArchive - the original archive we are copying this + entry from, will be null if we are not copying from an archive.
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +zipFile

    +
    +protected final void zipFile(java.io.InputStream in,
+                             ZipOutputStream zOut,
+                             java.lang.String vPath,
+                             long lastModified,
+                             java.io.File fromArchive,
+                             int mode,
+                             ZipExtraField[] extra)
+                      throws java.io.IOException
    +
    +
    Adds a new entry to the archive, takes care of duplicates as well. +

    +

    +
    Parameters:
    in - the stream to read data for the entry from. The + caller of the method is responsible for closing the stream.
    zOut - the stream to write to.
    vPath - the name this entry shall have in the archive.
    lastModified - last modification time for the entry.
    fromArchive - the original archive we are copying this + entry from, will be null if we are not copying from an archive.
    mode - the Unix permissions to set.
    extra - ZipExtraFields to add +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +zipFile

    +
    +protected void zipFile(java.io.File file,
+                       ZipOutputStream zOut,
+                       java.lang.String vPath,
+                       int mode)
+                throws java.io.IOException
    +
    +
    Method that gets called when adding from java.io.File instances. + +

    This implementation delegates to the six-arg version.

    +

    +

    +
    Parameters:
    file - the file to add to the archive
    zOut - the stream to write to
    vPath - the name this entry shall have in the archive
    mode - the Unix permissions to set. +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +addParentDirs

    +
    +protected final void addParentDirs(java.io.File baseDir,
+                                   java.lang.String entry,
+                                   ZipOutputStream zOut,
+                                   java.lang.String prefix,
+                                   int dirMode)
+                            throws java.io.IOException
    +
    +
    Ensure all parent dirs of a given entry have been added. +

    +

    +
    Parameters:
    baseDir - the base directory to use (may be null)
    entry - the entry name to create directories from
    zOut - the stream to write to
    prefix - a prefix to place on the created entries
    dirMode - the directory mode +
    Throws: +
    java.io.IOException - on error
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +cleanUp

    +
    +protected void cleanUp()
    +
    +
    Do any clean up necessary to allow this instance to be used again. + +

    When we get here, the Zip file has been closed and all we + need to do is to reset some globals.

    + +

    This method will only reset globals that have been changed + during execute(), it will not alter the attributes or nested + child elements. If you want to reset the instance so that you + can later zip a completely different set of files, you must use + the reset method.

    +

    +

    +
    See Also:
    reset()
    +
    +
    +
    + +

    +reset

    +
    +public void reset()
    +
    +
    Makes this instance reset all attributes to their default + values and forget all children. +

    +

    +
    Since:
    +
    Ant 1.5
    +
    See Also:
    cleanUp()
    +
    +
    +
    + +

    +isEmpty

    +
    +protected static final boolean isEmpty(Resource[][] r)
    +
    +
    Check is the resource arrays are empty. +

    +

    +
    Parameters:
    r - the arrays to check +
    Returns:
    true if all individual arrays are empty
    Since:
    +
    Ant 1.5.2
    +
    +
    +
    +
    + +

    +selectFileResources

    +
    +protected Resource[] selectFileResources(Resource[] orig)
    +
    +
    Drops all non-file resources from the given array. +

    +

    +
    Parameters:
    orig - the resources to filter +
    Returns:
    the filters resources
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +selectDirectoryResources

    +
    +protected Resource[] selectDirectoryResources(Resource[] orig)
    +
    +
    Drops all non-directory resources from the given array. +

    +

    +
    Parameters:
    orig - the resources to filter +
    Returns:
    the filters resources
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +selectResources

    +
    +protected Resource[] selectResources(Resource[] orig,
+                                     ResourceSelector selector)
    +
    +
    Drops all resources from the given array that are not selected +

    +

    +
    Parameters:
    orig - the resources to filter +
    Returns:
    the filters resources
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +logWhenWriting

    +
    +protected void logWhenWriting(java.lang.String msg,
+                              int level)
    +
    +
    Logs a message at the given output level, but only if this is + the pass that will actually create the archive. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.html new file mode 100644 index 000000000..fc3f6e118 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptCompilerAdapter.html @@ -0,0 +1,416 @@ + + + + + + +AptCompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class AptCompilerAdapter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.AptCompilerAdapter
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class AptCompilerAdapter
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the apt compiler for JDK 1.5 +

    + As usual, the low level entry points for Java tools are neither documented or + stable; this entry point may change from that of 1.5.0_01-b08 without any + warning at all. The IDE decompile of the tool entry points is as follows: + 

    + public class Main {
+ public Main() ;
+ 
    
+ public static transient void main(String... strings) ;
+ 
    
+ public static transient int process(String... strings);
+ 
    
+ public static transient int process(PrintWriter printWriter,
+      String... strings) ;
+ public static transient int process(
+      AnnotationProcessorFactory annotationProcessorFactory,
+      String... strings) ;
+ 
    
+ public static transient int process(
+      AnnotationProcessorFactory annotationProcessorFactory,
+      PrintWriter printWriter,
+      String... strings);
+ private static transient int processing(
+      AnnotationProcessorFactory annotationProcessorFactory,
+      PrintWriter printWriter,
+      String... strings) ;
+ }
+
    + + This Adapter is designed to run Apt in-JVM, an option that is not actually + exposed to end-users, because it was too brittle during beta testing; classpath + problems being the core issue. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringAPT_ENTRY_POINT + +
    +          class in tools.jar that implements APT
    +static java.lang.StringAPT_METHOD_NAME + +
    +          method used to compile.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    AptCompilerAdapter() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Run the compilation.
    +protected  AptgetApt() + +
    +          Get the facade task that fronts this adapter
    +protected  voidsetAptCommandlineSwitches(Commandline cmd) + +
    +          using our front end task, set up the command line switches
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +APT_ENTRY_POINT

    +
    +public static final java.lang.String APT_ENTRY_POINT
    +
    +
    class in tools.jar that implements APT +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +APT_METHOD_NAME

    +
    +public static final java.lang.String APT_METHOD_NAME
    +
    +
    method used to compile. +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +AptCompilerAdapter

    +
    +public AptCompilerAdapter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getApt

    +
    +protected Apt getApt()
    +
    +
    Get the facade task that fronts this adapter +

    +

    + +
    Returns:
    task instance
    See Also:
    DefaultCompilerAdapter.getJavac()
    +
    +
    +
    + +

    +setAptCommandlineSwitches

    +
    +protected void setAptCommandlineSwitches(Commandline cmd)
    +
    +
    using our front end task, set up the command line switches +

    +

    +
    Parameters:
    cmd - command line to set up
    +
    +
    +
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Run the compilation. +

    +

    + +
    Returns:
    true on success. +
    Throws: +
    BuildException - if the compilation has problems.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptExternalCompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptExternalCompilerAdapter.html new file mode 100644 index 000000000..8a8c1fd1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/AptExternalCompilerAdapter.html @@ -0,0 +1,314 @@ + + + + + + +AptExternalCompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class AptExternalCompilerAdapter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.AptExternalCompilerAdapter
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class AptExternalCompilerAdapter
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the apt compiler for JDK 1.5 using an external process +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    AptExternalCompilerAdapter() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Performs a compile using the Javac externally.
    +protected  AptgetApt() + +
    +          Get the facade task that fronts this adapter
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AptExternalCompilerAdapter

    +
    +public AptExternalCompilerAdapter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getApt

    +
    +protected Apt getApt()
    +
    +
    Get the facade task that fronts this adapter +

    +

    + +
    Returns:
    task instance
    See Also:
    DefaultCompilerAdapter.getJavac()
    +
    +
    +
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Performs a compile using the Javac externally. +

    +

    + +
    Returns:
    true the compilation was successful. +
    Throws: +
    BuildException - if there is a problem.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapter.html new file mode 100644 index 000000000..56ed698f8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapter.html @@ -0,0 +1,246 @@ + + + + + + +CompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Interface CompilerAdapter

    +
    +
    All Known Implementing Classes:
    AptCompilerAdapter, AptExternalCompilerAdapter, DefaultCompilerAdapter, Gcj, Javac12, Javac13, JavacExternal, Jikes, Jvc, Kjc, Sj
    +
    +
    +
    +
    public interface CompilerAdapter
    + + +

    +The interface that all compiler adapters must adhere to. + +

    A compiler adapter is an adapter that interprets the javac's + parameters in preparation to be passed off to the compiler this + adapter represents. As all the necessary values are stored in the + Javac task itself, the only thing all adapters need is the javac + task, the execute command and a parameterless constructor (for + reflection).

    +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Executes the task.
    + voidsetJavac(Javac attributes) + +
    +          Sets the compiler attributes, which are stored in the Javac task.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setJavac

    +
    +void setJavac(Javac attributes)
    +
    +
    Sets the compiler attributes, which are stored in the Javac task. +

    +

    +
    Parameters:
    attributes - the compiler attributes
    +
    +
    +
    + +

    +execute

    +
    +boolean execute()
+                throws BuildException
    +
    +
    Executes the task. +

    +

    + +
    Returns:
    has the compilation been successful +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterExtension.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterExtension.html new file mode 100644 index 000000000..85143a493 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterExtension.html @@ -0,0 +1,223 @@ + + + + + + +CompilerAdapterExtension (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Interface CompilerAdapterExtension

    +
    +
    All Known Implementing Classes:
    AptCompilerAdapter, AptExternalCompilerAdapter, DefaultCompilerAdapter, Gcj, Javac12, Javac13, JavacExternal, Jikes, Jvc, Kjc, Sj
    +
    +
    +
    +
    public interface CompilerAdapterExtension
    + + +

    +Extension interface for compilers that support source extensions + other than .java. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getSupportedFileExtensions() + +
    +          Returns a list of source file extensions that are recognized by + this compiler adapter.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getSupportedFileExtensions

    +
    +java.lang.String[] getSupportedFileExtensions()
    +
    +
    Returns a list of source file extensions that are recognized by + this compiler adapter. + +

    For example, most compiler adapters will return [ "java" ], + but a compiler adapter that can compile both Java and Groovy + source code would return [ "java", "groovy" ].

    +

    +

    + +
    Returns:
    list of source file extensions recognized by this + compiler adapter.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterFactory.html new file mode 100644 index 000000000..eeb8a2383 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/CompilerAdapterFactory.html @@ -0,0 +1,298 @@ + + + + + + +CompilerAdapterFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class CompilerAdapterFactory

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.CompilerAdapterFactory
+
    +
    +
    +
    public final class CompilerAdapterFactory
    extends java.lang.Object
    + + +

    +Creates the necessary compiler adapter, given basic criteria. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    +static CompilerAdaptergetCompiler(java.lang.String compilerType, + Task task) + +
    +          Based on the parameter passed in, this method creates the necessary + factory desired.
    +static CompilerAdaptergetCompiler(java.lang.String compilerType, + Task task, + Path classpath) + +
    +          Based on the parameter passed in, this method creates the necessary + factory desired.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getCompiler

    +
    +public static CompilerAdapter getCompiler(java.lang.String compilerType,
+                                          Task task)
+                                   throws BuildException
    +
    +
    Based on the parameter passed in, this method creates the necessary + factory desired. + + The current mapping for compiler names are as follows: +
    • jikes = jikes compiler +
    • classic, javac1.1, javac1.2 = the standard compiler from JDK + 1.1/1.2 +
    • modern, javac1.3, javac1.4, javac1.5 = the compiler of JDK 1.3+ +
    • jvc, microsoft = the command line compiler from Microsoft's SDK + for Java / Visual J++ +
    • kjc = the kopi compiler
      • +
    • gcj = the gcj compiler from gcc
      • +
    • sj, symantec = the Symantec Java compiler
      • +
    • a fully qualified classname = the name of a compiler + adapter +
    +

    +

    +
    Parameters:
    compilerType - either the name of the desired compiler, or the + full classname of the compiler's adapter.
    task - a task to log through. +
    Returns:
    the compiler adapter +
    Throws: +
    BuildException - if the compiler type could not be resolved into + a compiler adapter.
    +
    +
    +
    + +

    +getCompiler

    +
    +public static CompilerAdapter getCompiler(java.lang.String compilerType,
+                                          Task task,
+                                          Path classpath)
+                                   throws BuildException
    +
    +
    Based on the parameter passed in, this method creates the necessary + factory desired. + + The current mapping for compiler names are as follows: +
    • jikes = jikes compiler +
    • classic, javac1.1, javac1.2 = the standard compiler from JDK + 1.1/1.2 +
    • modern, javac1.3, javac1.4, javac1.5 = the compiler of JDK 1.3+ +
    • jvc, microsoft = the command line compiler from Microsoft's SDK + for Java / Visual J++ +
    • kjc = the kopi compiler
      • +
    • gcj = the gcj compiler from gcc
      • +
    • sj, symantec = the Symantec Java compiler
      • +
    • a fully qualified classname = the name of a compiler + adapter +
    +

    +

    +
    Parameters:
    compilerType - either the name of the desired compiler, or the + full classname of the compiler's adapter.
    task - a task to log through.
    classpath - the classpath to use when looking up an + adapter class +
    Returns:
    the compiler adapter +
    Throws: +
    BuildException - if the compiler type could not be resolved into + a compiler adapter.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.html new file mode 100644 index 000000000..44a1cc453 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/DefaultCompilerAdapter.html @@ -0,0 +1,1354 @@ + + + + + + +DefaultCompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class DefaultCompilerAdapter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    Direct Known Subclasses:
    AptCompilerAdapter, AptExternalCompilerAdapter, Gcj, Javac12, Javac13, JavacExternal, Jikes, Jvc, Kjc, Sj
    +
    +
    +
    +
    public abstract class DefaultCompilerAdapter
    extends java.lang.Object
    implements CompilerAdapter, CompilerAdapterExtension
    + + +

    +This is the default implementation for the CompilerAdapter interface. + Currently, this is a cut-and-paste of the original javac task. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  Javacattributes + +
    +           
    +protected  Pathbootclasspath + +
    +           
    +protected  PathcompileClasspath + +
    +           
    +protected  java.io.File[]compileList + +
    +           
    +protected  PathcompileSourcepath + +
    +           
    +protected  booleandebug + +
    +           
    +protected  booleandepend + +
    +           
    +protected  booleandeprecation + +
    +           
    +protected  java.io.FiledestDir + +
    +           
    +protected  java.lang.Stringencoding + +
    +           
    +protected  Pathextdirs + +
    +           
    +protected  booleanincludeAntRuntime + +
    +           
    +protected  booleanincludeJavaRuntime + +
    +           
    +protected  Locationlocation + +
    +           
    +protected static java.lang.StringlSep + +
    +           
    +protected  java.lang.StringmemoryInitialSize + +
    +           
    +protected  java.lang.StringmemoryMaximumSize + +
    +           
    +protected  booleanoptimize + +
    +           
    +protected  Projectproject + +
    +           
    +protected  Pathsrc + +
    +           
    +protected  java.lang.Stringtarget + +
    +           
    +protected  booleanverbose + +
    +           
    +  + + + + + + + + + + +
    +Constructor Summary
    DefaultCompilerAdapter() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidaddCurrentCompilerArgs(Commandline cmd) + +
    +          Adds the command line arguments specific to the current implementation.
    +protected  voidaddExtdirsToClasspath(Path classpath) + +
    +          Deprecated. since 1.5.x. + Use org.apache.tools.ant.types.Path#addExtdirs instead.
    +protected  booleanassumeJava11() + +
    +          Shall we assume JDK 1.1 command line switches?
    +protected  booleanassumeJava12() + +
    +          Shall we assume JDK 1.2 command line switches?
    +protected  booleanassumeJava13() + +
    +          Shall we assume JDK 1.3 command line switches?
    +protected  booleanassumeJava14() + +
    +          Shall we assume JDK 1.4 command line switches?
    +protected  booleanassumeJava15() + +
    +          Shall we assume JDK 1.5 command line switches?
    +protected  booleanassumeJava16() + +
    +          Shall we assume JDK 1.6 command line switches?
    +protected  booleanassumeJava17() + +
    +          Shall we assume JDK 1.7 command line switches?
    +protected  intexecuteExternalCompile(java.lang.String[] args, + int firstFileName) + +
    +          Do the compile with the specified arguments.
    +protected  intexecuteExternalCompile(java.lang.String[] args, + int firstFileName, + boolean quoteFiles) + +
    +          Do the compile with the specified arguments.
    +protected  PathgetBootClassPath() + +
    +          Combines a user specified bootclasspath with the system + bootclasspath taking build.sysclasspath into account.
    +protected  PathgetCompileClasspath() + +
    +          Builds the compilation classpath.
    + JavacgetJavac() + +
    +          Get the Javac task instance associated with this compiler adapter
    +protected  java.lang.StringgetNoDebugArgument() + +
    +          The argument the compiler wants to see if the debug attribute + has been set to false.
    +protected  ProjectgetProject() + +
    +          Get the project this compiler adapter was created in.
    + java.lang.String[]getSupportedFileExtensions() + +
    +          By default, only recognize files with a Java extension, + but specialized compilers can recognize multiple kinds + of files.
    +protected  voidlogAndAddFilesToCompile(Commandline cmd) + +
    +          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList"
    + voidsetJavac(Javac attributes) + +
    +          Set the Javac instance which contains the configured compilation + attributes.
    +protected  CommandlinesetupJavacCommand() + +
    +          Set up the command line.
    +protected  CommandlinesetupJavacCommand(boolean debugLevelCheck) + +
    +          Does the command line argument processing for classic and adds + the files to compile as well.
    +protected  CommandlinesetupJavacCommandlineSwitches(Commandline cmd) + +
    +          Get the command line arguments for the switches.
    +protected  CommandlinesetupJavacCommandlineSwitches(Commandline cmd, + boolean useDebugLevel) + +
    +          Does the command line argument processing common to classic and + modern.
    +protected  CommandlinesetupModernJavacCommand() + +
    +          Does the command line argument processing for modern and adds + the files to compile as well.
    +protected  CommandlinesetupModernJavacCommandlineSwitches(Commandline cmd) + +
    +          Does the command line argument processing for modern.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.apache.tools.ant.taskdefs.compilers.CompilerAdapter
    execute
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +src

    +
    +protected Path src
    +
    +
    +
    +
    +
    + +

    +destDir

    +
    +protected java.io.File destDir
    +
    +
    +
    +
    +
    + +

    +encoding

    +
    +protected java.lang.String encoding
    +
    +
    +
    +
    +
    + +

    +debug

    +
    +protected boolean debug
    +
    +
    +
    +
    +
    + +

    +optimize

    +
    +protected boolean optimize
    +
    +
    +
    +
    +
    + +

    +deprecation

    +
    +protected boolean deprecation
    +
    +
    +
    +
    +
    + +

    +depend

    +
    +protected boolean depend
    +
    +
    +
    +
    +
    + +

    +verbose

    +
    +protected boolean verbose
    +
    +
    +
    +
    +
    + +

    +target

    +
    +protected java.lang.String target
    +
    +
    +
    +
    +
    + +

    +bootclasspath

    +
    +protected Path bootclasspath
    +
    +
    +
    +
    +
    + +

    +extdirs

    +
    +protected Path extdirs
    +
    +
    +
    +
    +
    + +

    +compileClasspath

    +
    +protected Path compileClasspath
    +
    +
    +
    +
    +
    + +

    +compileSourcepath

    +
    +protected Path compileSourcepath
    +
    +
    +
    +
    +
    + +

    +project

    +
    +protected Project project
    +
    +
    +
    +
    +
    + +

    +location

    +
    +protected Location location
    +
    +
    +
    +
    +
    + +

    +includeAntRuntime

    +
    +protected boolean includeAntRuntime
    +
    +
    +
    +
    +
    + +

    +includeJavaRuntime

    +
    +protected boolean includeJavaRuntime
    +
    +
    +
    +
    +
    + +

    +memoryInitialSize

    +
    +protected java.lang.String memoryInitialSize
    +
    +
    +
    +
    +
    + +

    +memoryMaximumSize

    +
    +protected java.lang.String memoryMaximumSize
    +
    +
    +
    +
    +
    + +

    +compileList

    +
    +protected java.io.File[] compileList
    +
    +
    +
    +
    +
    + +

    +attributes

    +
    +protected Javac attributes
    +
    +
    +
    +
    +
    + +

    +lSep

    +
    +protected static final java.lang.String lSep
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +DefaultCompilerAdapter

    +
    +public DefaultCompilerAdapter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setJavac

    +
    +public void setJavac(Javac attributes)
    +
    +
    Set the Javac instance which contains the configured compilation + attributes. +

    +

    +
    Specified by:
    setJavac in interface CompilerAdapter
    +
    +
    +
    Parameters:
    attributes - a configured Javac task.
    +
    +
    +
    + +

    +getJavac

    +
    +public Javac getJavac()
    +
    +
    Get the Javac task instance associated with this compiler adapter +

    +

    +
    +
    +
    + +
    Returns:
    the configured Javac task instance used by this adapter.
    +
    +
    +
    + +

    +getSupportedFileExtensions

    +
    +public java.lang.String[] getSupportedFileExtensions()
    +
    +
    By default, only recognize files with a Java extension, + but specialized compilers can recognize multiple kinds + of files. +

    +

    +
    Specified by:
    getSupportedFileExtensions in interface CompilerAdapterExtension
    +
    +
    + +
    Returns:
    list of source file extensions recognized by this + compiler adapter.
    +
    +
    +
    + +

    +getProject

    +
    +protected Project getProject()
    +
    +
    Get the project this compiler adapter was created in. +

    +

    +
    +
    +
    + +
    Returns:
    the owner project
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getCompileClasspath

    +
    +protected Path getCompileClasspath()
    +
    +
    Builds the compilation classpath. +

    +

    +
    +
    +
    + +
    Returns:
    the compilation class path
    +
    +
    +
    + +

    +setupJavacCommandlineSwitches

    +
    +protected Commandline setupJavacCommandlineSwitches(Commandline cmd)
    +
    +
    Get the command line arguments for the switches. +

    +

    +
    +
    +
    +
    Parameters:
    cmd - the command line +
    Returns:
    the command line
    +
    +
    +
    + +

    +setupJavacCommandlineSwitches

    +
    +protected Commandline setupJavacCommandlineSwitches(Commandline cmd,
+                                                    boolean useDebugLevel)
    +
    +
    Does the command line argument processing common to classic and + modern. Doesn't add the files to compile. +

    +

    +
    +
    +
    +
    Parameters:
    cmd - the command line
    useDebugLevel - if true set set the debug level with the -g switch +
    Returns:
    the command line
    +
    +
    +
    + +

    +setupModernJavacCommandlineSwitches

    +
    +protected Commandline setupModernJavacCommandlineSwitches(Commandline cmd)
    +
    +
    Does the command line argument processing for modern. Doesn't + add the files to compile. +

    +

    +
    +
    +
    +
    Parameters:
    cmd - the command line +
    Returns:
    the command line
    +
    +
    +
    + +

    +setupModernJavacCommand

    +
    +protected Commandline setupModernJavacCommand()
    +
    +
    Does the command line argument processing for modern and adds + the files to compile as well. +

    +

    +
    +
    +
    + +
    Returns:
    the command line
    +
    +
    +
    + +

    +setupJavacCommand

    +
    +protected Commandline setupJavacCommand()
    +
    +
    Set up the command line. +

    +

    +
    +
    +
    + +
    Returns:
    the command line
    +
    +
    +
    + +

    +setupJavacCommand

    +
    +protected Commandline setupJavacCommand(boolean debugLevelCheck)
    +
    +
    Does the command line argument processing for classic and adds + the files to compile as well. +

    +

    +
    +
    +
    +
    Parameters:
    debugLevelCheck - if true set the debug level with the -g switch +
    Returns:
    the command line
    +
    +
    +
    + +

    +logAndAddFilesToCompile

    +
    +protected void logAndAddFilesToCompile(Commandline cmd)
    +
    +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +

    +

    +
    +
    +
    +
    Parameters:
    cmd - the command line
    +
    +
    +
    + +

    +executeExternalCompile

    +
    +protected int executeExternalCompile(java.lang.String[] args,
+                                     int firstFileName)
    +
    +
    Do the compile with the specified arguments. +

    +

    +
    +
    +
    +
    Parameters:
    args - - arguments to pass to process on command line
    firstFileName - - index of the first source file in args, + if the index is negative, no temporary file will ever be + created, but this may hit the command line length limit on your + system. +
    Returns:
    the exit code of the compilation
    +
    +
    +
    + +

    +executeExternalCompile

    +
    +protected int executeExternalCompile(java.lang.String[] args,
+                                     int firstFileName,
+                                     boolean quoteFiles)
    +
    +
    Do the compile with the specified arguments. + +

    The working directory if the executed process will be the + project's base directory.

    +

    +

    +
    +
    +
    +
    Parameters:
    args - - arguments to pass to process on command line
    firstFileName - - index of the first source file in args, + if the index is negative, no temporary file will ever be + created, but this may hit the command line length limit on your + system.
    quoteFiles - - if set to true, filenames containing + spaces will be quoted when they appear in the external file. + This is necessary when running JDK 1.4's javac and probably + others. +
    Returns:
    the exit code of the compilation
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addExtdirsToClasspath

    +
    +protected void addExtdirsToClasspath(Path classpath)
    +
    +
    Deprecated. since 1.5.x. + Use org.apache.tools.ant.types.Path#addExtdirs instead. +

    +

    Add extdirs to classpath +

    +

    +
    +
    +
    +
    Parameters:
    classpath - the classpath to use
    +
    +
    +
    + +

    +addCurrentCompilerArgs

    +
    +protected void addCurrentCompilerArgs(Commandline cmd)
    +
    +
    Adds the command line arguments specific to the current implementation. +

    +

    +
    +
    +
    +
    Parameters:
    cmd - the command line to use
    +
    +
    +
    + +

    +assumeJava11

    +
    +protected boolean assumeJava11()
    +
    +
    Shall we assume JDK 1.1 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if jdk 1.1
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +assumeJava12

    +
    +protected boolean assumeJava12()
    +
    +
    Shall we assume JDK 1.2 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if jdk 1.2
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +assumeJava13

    +
    +protected boolean assumeJava13()
    +
    +
    Shall we assume JDK 1.3 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if jdk 1.3
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +assumeJava14

    +
    +protected boolean assumeJava14()
    +
    +
    Shall we assume JDK 1.4 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if jdk 1.4
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +assumeJava15

    +
    +protected boolean assumeJava15()
    +
    +
    Shall we assume JDK 1.5 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if JDK 1.5
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +assumeJava16

    +
    +protected boolean assumeJava16()
    +
    +
    Shall we assume JDK 1.6 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if JDK 1.6
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +assumeJava17

    +
    +protected boolean assumeJava17()
    +
    +
    Shall we assume JDK 1.7 command line switches? +

    +

    +
    +
    +
    + +
    Returns:
    true if JDK 1.7
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +getBootClassPath

    +
    +protected Path getBootClassPath()
    +
    +
    Combines a user specified bootclasspath with the system + bootclasspath taking build.sysclasspath into account. +

    +

    +
    +
    +
    + +
    Returns:
    a non-null Path instance that combines the user + specified and the system bootclasspath.
    +
    +
    +
    + +

    +getNoDebugArgument

    +
    +protected java.lang.String getNoDebugArgument()
    +
    +
    The argument the compiler wants to see if the debug attribute + has been set to false. + +

    A return value of null means no argument at all.

    +

    +

    +
    +
    +
    + +
    Returns:
    "-g:none" unless we expect to invoke a JDK 1.1 compiler.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Gcj.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Gcj.html new file mode 100644 index 000000000..6c50f8f51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Gcj.html @@ -0,0 +1,341 @@ + + + + + + +Gcj (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Gcj

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Gcj
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Gcj
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the gcj compiler. + This is primarily a cut-and-paste from the jikes. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Gcj() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Performs a compile using the gcj compiler.
    + booleanisNativeBuild() + +
    +          Whether any of the arguments given via <compilerarg> + implies that compilation to native code is requested.
    +protected  CommandlinesetupGCJCommand() + +
    +          Set up the gcj commandline.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Gcj

    +
    +public Gcj()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Performs a compile using the gcj compiler. +

    +

    + +
    Returns:
    true if the compilation succeeded +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +setupGCJCommand

    +
    +protected Commandline setupGCJCommand()
    +
    +
    Set up the gcj commandline. +

    +

    + +
    Returns:
    the command line
    +
    +
    +
    + +

    +isNativeBuild

    +
    +public boolean isNativeBuild()
    +
    +
    Whether any of the arguments given via <compilerarg> + implies that compilation to native code is requested. +

    +

    + +
    Returns:
    true if compilation to native code is requested
    Since:
    +
    Ant 1.6.2
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac12.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac12.html new file mode 100644 index 000000000..f393df9f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac12.html @@ -0,0 +1,323 @@ + + + + + + +Javac12 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Javac12

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Javac12
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +Deprecated. Use Javac13 instead. +

    +

    +
    public class Javac12
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the javac compiler for JDK 1.2 + This is primarily a cut-and-paste from the original javac task before it + was refactored. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected static java.lang.StringCLASSIC_COMPILER_CLASSNAME + +
    +          Deprecated.  
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Javac12() + +
    +          Deprecated.  
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Deprecated. Run the compilation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +CLASSIC_COMPILER_CLASSNAME

    +
    +protected static final java.lang.String CLASSIC_COMPILER_CLASSNAME
    +
    +
    Deprecated. 
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Javac12

    +
    +public Javac12()
    +
    +
    Deprecated. 
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Deprecated. 
    Run the compilation. +

    +

    + +
    Returns:
    true if the compiler ran with a zero exit result (ok) +
    Throws: +
    BuildException - if the compilation has problems.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac13.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac13.html new file mode 100644 index 000000000..072fd9d28 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Javac13.html @@ -0,0 +1,294 @@ + + + + + + +Javac13 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Javac13

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Javac13
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Javac13
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the javac compiler for JDK 1.3 + This is primarily a cut-and-paste from the original javac task before it + was refactored. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Javac13() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Run the compilation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javac13

    +
    +public Javac13()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Run the compilation. +

    +

    + +
    Returns:
    true if the compiler ran with a zero exit result (ok) +
    Throws: +
    BuildException - if the compilation has problems.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/JavacExternal.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/JavacExternal.html new file mode 100644 index 000000000..e565af7c6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/JavacExternal.html @@ -0,0 +1,292 @@ + + + + + + +JavacExternal (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class JavacExternal

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.JavacExternal
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class JavacExternal
    extends DefaultCompilerAdapter
    + + +

    +Performs a compile using javac externally. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    JavacExternal() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Performs a compile using the Javac externally.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +JavacExternal

    +
    +public JavacExternal()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Performs a compile using the Javac externally. +

    +

    + +
    Returns:
    true if the compilation succeeded +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jikes.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jikes.html new file mode 100644 index 000000000..9c1772bfb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jikes.html @@ -0,0 +1,301 @@ + + + + + + +Jikes (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Jikes

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Jikes
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Jikes
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the jikes compiler. + This is primarily a cut-and-paste from the original javac task before it + was refactored. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Jikes() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Performs a compile using the Jikes compiler from IBM.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Jikes

    +
    +public Jikes()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Performs a compile using the Jikes compiler from IBM. + Mostly of this code is identical to doClassicCompile() + However, it does not support all options like + extdirs, deprecation and so on, because + there is no option in jikes and I don't understand + what they should do. + + It has been successfully tested with jikes >1.10. +

    +

    + +
    Returns:
    true if the compilation succeeded +
    Throws: +
    BuildException - on error
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jvc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jvc.html new file mode 100644 index 000000000..c9f68144b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Jvc.html @@ -0,0 +1,294 @@ + + + + + + +Jvc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Jvc

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Jvc
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Jvc
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the jvc compiler from microsoft. + This is primarily a cut-and-paste from the original javac task before it + was refactored. +

    + +

    +

    +
    Since:
    +
    Ant 1.3
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Jvc() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Run the compilation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Jvc

    +
    +public Jvc()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Run the compilation. +

    +

    + +
    Returns:
    true if the compiler ran with a zero exit result (ok) +
    Throws: +
    BuildException - if the compilation has problems.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Kjc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Kjc.html new file mode 100644 index 000000000..332b65913 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Kjc.html @@ -0,0 +1,316 @@ + + + + + + +Kjc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Kjc

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Kjc
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Kjc
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the Java compiler for KJC. + This is primarily a cut-and-paste from Jikes.java and + DefaultCompilerAdapter. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Kjc() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Run the compilation.
    +protected  CommandlinesetupKjcCommand() + +
    +          setup kjc command arguments.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getNoDebugArgument, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Kjc

    +
    +public Kjc()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Run the compilation. +

    +

    + +
    Returns:
    true if the compilation succeeded +
    Throws: +
    BuildException - if the compilation has problems.
    +
    +
    +
    + +

    +setupKjcCommand

    +
    +protected Commandline setupKjcCommand()
    +
    +
    setup kjc command arguments. +

    +

    + +
    Returns:
    the command line
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Sj.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Sj.html new file mode 100644 index 000000000..832455d20 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/Sj.html @@ -0,0 +1,322 @@ + + + + + + +Sj (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.compilers +
    +Class Sj

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.compilers.Sj
+
    +
    +
    All Implemented Interfaces:
    CompilerAdapter, CompilerAdapterExtension
    +
    +
    +
    +
    public class Sj
    extends DefaultCompilerAdapter
    + + +

    +The implementation of the sj compiler. + Uses the defaults for DefaultCompilerAdapter +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    attributes, bootclasspath, compileClasspath, compileList, compileSourcepath, debug, depend, deprecation, destDir, encoding, extdirs, includeAntRuntime, includeJavaRuntime, location, lSep, memoryInitialSize, memoryMaximumSize, optimize, project, src, target, verbose
    +  + + + + + + + + + + +
    +Constructor Summary
    Sj() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleanexecute() + +
    +          Performs a compile using the sj compiler from Symantec.
    +protected  java.lang.StringgetNoDebugArgument() + +
    +          Returns null since sj either has -g for debug=true or no + argument at all.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.compilers.DefaultCompilerAdapter
    addCurrentCompilerArgs, addExtdirsToClasspath, assumeJava11, assumeJava12, assumeJava13, assumeJava14, assumeJava15, assumeJava16, assumeJava17, executeExternalCompile, executeExternalCompile, getBootClassPath, getCompileClasspath, getJavac, getProject, getSupportedFileExtensions, logAndAddFilesToCompile, setJavac, setupJavacCommand, setupJavacCommand, setupJavacCommandlineSwitches, setupJavacCommandlineSwitches, setupModernJavacCommand, setupModernJavacCommandlineSwitches
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Sj

    +
    +public Sj()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public boolean execute()
+                throws BuildException
    +
    +
    Performs a compile using the sj compiler from Symantec. +

    +

    + +
    Returns:
    true if the compilation succeeded +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +getNoDebugArgument

    +
    +protected java.lang.String getNoDebugArgument()
    +
    +
    Returns null since sj either has -g for debug=true or no + argument at all. +

    +

    +
    Overrides:
    getNoDebugArgument in class DefaultCompilerAdapter
    +
    +
    + +
    Returns:
    null.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-frame.html new file mode 100644 index 000000000..5a52aed36 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-frame.html @@ -0,0 +1,67 @@ + + + + + + +org.apache.tools.ant.taskdefs.compilers (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.compilers + + + + +
    +Interfaces  + +
    +CompilerAdapter +
    +CompilerAdapterExtension
    + + + + + + +
    +Classes  + +
    +AptCompilerAdapter +
    +AptExternalCompilerAdapter +
    +CompilerAdapterFactory +
    +DefaultCompilerAdapter +
    +Gcj +
    +Javac12 +
    +Javac13 +
    +JavacExternal +
    +Jikes +
    +Jvc +
    +Kjc +
    +Sj
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-summary.html new file mode 100644 index 000000000..50d09df5f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-summary.html @@ -0,0 +1,221 @@ + + + + + + +org.apache.tools.ant.taskdefs.compilers (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.taskdefs.compilers +

    + + + + + + + + + + + + + +
    +Interface Summary
    CompilerAdapterThe interface that all compiler adapters must adhere to.
    CompilerAdapterExtensionExtension interface for compilers that support source extensions + other than .java.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    AptCompilerAdapterThe implementation of the apt compiler for JDK 1.5 +

    + As usual, the low level entry points for Java tools are neither documented or + stable; this entry point may change from that of 1.5.0_01-b08 without any + warning at all.

    AptExternalCompilerAdapterThe implementation of the apt compiler for JDK 1.5 using an external process
    CompilerAdapterFactoryCreates the necessary compiler adapter, given basic criteria.
    DefaultCompilerAdapterThis is the default implementation for the CompilerAdapter interface.
    GcjThe implementation of the gcj compiler.
    Javac12Deprecated. Use Javac13 instead.
    Javac13The implementation of the javac compiler for JDK 1.3 + This is primarily a cut-and-paste from the original javac task before it + was refactored.
    JavacExternalPerforms a compile using javac externally.
    JikesThe implementation of the jikes compiler.
    JvcThe implementation of the jvc compiler from microsoft.
    KjcThe implementation of the Java compiler for KJC.
    SjThe implementation of the sj compiler.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-tree.html new file mode 100644 index 000000000..63c77eae5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/compilers/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.compilers Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.taskdefs.compilers +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/And.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/And.html new file mode 100644 index 000000000..bc18c60c8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/And.html @@ -0,0 +1,309 @@ + + + + + + +And (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class And

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.condition.And
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class And
    extends ConditionBase
    implements Condition
    + + +

    +<and> condition container. + +

    Iterates over all conditions and returns false as soon as one + evaluates to false.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    And() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +And

    +
    +public And()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if all the contained conditions evaluates to true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/AntVersion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/AntVersion.html new file mode 100644 index 000000000..8d623982d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/AntVersion.html @@ -0,0 +1,492 @@ + + + + + + +AntVersion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class AntVersion

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.condition.AntVersion
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class AntVersion
    extends Task
    implements Condition
    + + +

    +An Ant version condition. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    AntVersion() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evalute the condition.
    + voidexecute() + +
    +          Run as a task.
    + java.lang.StringgetAtLeast() + +
    +          Get the atleast attribute.
    + java.lang.StringgetExactly() + +
    +          Get the exactly attribute.
    + java.lang.StringgetProperty() + +
    +          Get the name of the property to hold the ant version.
    + voidsetAtLeast(java.lang.String atLeast) + +
    +          Set the atleast attribute.
    + voidsetExactly(java.lang.String exactly) + +
    +          Set the exactly attribute.
    + voidsetProperty(java.lang.String propertyname) + +
    +          Set the name of the property to hold the ant version.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +AntVersion

    +
    +public AntVersion()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Run as a task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evalute the condition. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true. +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    +
    + +

    +getAtLeast

    +
    +public java.lang.String getAtLeast()
    +
    +
    Get the atleast attribute. +

    +

    +
    +
    +
    + +
    Returns:
    the atleast attribute.
    +
    +
    +
    + +

    +setAtLeast

    +
    +public void setAtLeast(java.lang.String atLeast)
    +
    +
    Set the atleast attribute. + This is of the form major.minor.point. + For example 1.7.0. +

    +

    +
    +
    +
    +
    Parameters:
    atLeast - the version to check against.
    +
    +
    +
    + +

    +getExactly

    +
    +public java.lang.String getExactly()
    +
    +
    Get the exactly attribute. +

    +

    +
    +
    +
    + +
    Returns:
    the exactly attribute.
    +
    +
    +
    + +

    +setExactly

    +
    +public void setExactly(java.lang.String exactly)
    +
    +
    Set the exactly attribute. + This is of the form major.minor.point. + For example 1.7.0. +

    +

    +
    +
    +
    +
    Parameters:
    exactly - the version to check against.
    +
    +
    +
    + +

    +getProperty

    +
    +public java.lang.String getProperty()
    +
    +
    Get the name of the property to hold the ant version. +

    +

    +
    +
    +
    + +
    Returns:
    the name of the property.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String propertyname)
    +
    +
    Set the name of the property to hold the ant version. +

    +

    +
    +
    +
    +
    Parameters:
    propertyname - the name of the property.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Condition.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Condition.html new file mode 100644 index 000000000..d8f8336e0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Condition.html @@ -0,0 +1,214 @@ + + + + + + +Condition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Interface Condition

    +
    +
    All Known Implementing Classes:
    And, AntVersion, Available, Checksum, Contains, Equals, FilesMatch, HasFreeSpace, HasMethod, Http, IsFailure, IsFalse, IsFileSelected, IsLastModified, IsReachable, IsReference, IsSet, IsSigned, IsTrue, Length, Matches, Not, Or, Os, ParserSupports, ResourceContains, ResourceCount, ResourceExists, ResourcesMatch, ScriptCondition, Socket, TypeFound, UpToDate, Xor
    +
    +
    +
    +
    public interface Condition
    + + +

    +Interface for conditions to use inside the <condition> task. +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +boolean eval()
+             throws BuildException
    +
    +
    Is this condition true? +

    +

    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ConditionBase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ConditionBase.html new file mode 100644 index 000000000..ffb4a7783 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ConditionBase.html @@ -0,0 +1,806 @@ + + + + + + +ConditionBase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class ConditionBase

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    And, ConditionTask, Not, Or, WaitFor, Xor
    +
    +
    +
    +
    public abstract class ConditionBase
    extends ProjectComponent
    + + +

    +Baseclass for the <condition> task as well as several + conditions - ensures that the types of conditions inside the task + and the "container" conditions are in sync. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + + + +
    +Constructor Summary
    +protected ConditionBase() + +
    +          Simple constructor.
    +protected ConditionBase(java.lang.String taskName) + +
    +          Constructor that takes the name of the task in the task name.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(Condition c) + +
    +          Add an arbitrary condition
    + voidaddAnd(And a) + +
    +          Add an <and> condition "container".
    + voidaddAvailable(Available a) + +
    +          Add an <available> condition.
    + voidaddChecksum(Checksum c) + +
    +          Add an <checksum> condition.
    + voidaddContains(Contains test) + +
    +          Add a <contains> condition.
    + voidaddEquals(Equals e) + +
    +          Add an <equals> condition.
    + voidaddFilesMatch(FilesMatch test) + +
    +          Add a <filesmatch> condition.
    + voidaddHttp(Http h) + +
    +          Add an <http> condition.
    + voidaddIsFalse(IsFalse test) + +
    +          Add a <isfalse> condition.
    + voidaddIsFileSelected(IsFileSelected test) + +
    +          Add an <isfileselected> condition.
    + voidaddIsReference(IsReference i) + +
    +          Add an <isreference> condition.
    + voidaddIsSet(IsSet i) + +
    +          Add an <isset> condition.
    + voidaddIsTrue(IsTrue test) + +
    +          Add a <istrue> condition.
    + voidaddNot(Not n) + +
    +          Add an <not> condition "container".
    + voidaddOr(Or o) + +
    +          Add an <or> condition "container".
    + voidaddOs(Os o) + +
    +          Add an <os> condition.
    + voidaddSocket(Socket s) + +
    +          Add a <socket> condition.
    + voidaddUptodate(UpToDate u) + +
    +          Add an <uptodate> condition.
    +protected  intcountConditions() + +
    +          Count the conditions.
    +protected  java.util.EnumerationgetConditions() + +
    +          Iterate through all conditions.
    + java.lang.StringgetTaskName() + +
    +          Returns the name to use in logging messages.
    + voidsetTaskName(java.lang.String name) + +
    +          Sets the name to use in logging messages.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ConditionBase

    +
    +protected ConditionBase()
    +
    +
    Simple constructor. +

    +

    +
    + +

    +ConditionBase

    +
    +protected ConditionBase(java.lang.String taskName)
    +
    +
    Constructor that takes the name of the task in the task name. +

    +

    +
    Parameters:
    taskName - the name of the task.
    Since:
    +
    Ant 1.7
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +countConditions

    +
    +protected int countConditions()
    +
    +
    Count the conditions. +

    +

    + +
    Returns:
    the number of conditions in the container
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +getConditions

    +
    +protected final java.util.Enumeration getConditions()
    +
    +
    Iterate through all conditions. +

    +

    + +
    Returns:
    an enumeration to use for iteration
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +setTaskName

    +
    +public void setTaskName(java.lang.String name)
    +
    +
    Sets the name to use in logging messages. +

    +

    +
    Parameters:
    name - The name to use in logging messages. + Should not be null.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +getTaskName

    +
    +public java.lang.String getTaskName()
    +
    +
    Returns the name to use in logging messages. +

    +

    + +
    Returns:
    the name to use in logging messages.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addAvailable

    +
    +public void addAvailable(Available a)
    +
    +
    Add an <available> condition. +

    +

    +
    Parameters:
    a - an available condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addChecksum

    +
    +public void addChecksum(Checksum c)
    +
    +
    Add an <checksum> condition. +

    +

    +
    Parameters:
    c - a Checksum condition
    Since:
    +
    1.4, Ant 1.5
    +
    +
    +
    +
    + +

    +addUptodate

    +
    +public void addUptodate(UpToDate u)
    +
    +
    Add an <uptodate> condition. +

    +

    +
    Parameters:
    u - an UpToDate condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addNot

    +
    +public void addNot(Not n)
    +
    +
    Add an <not> condition "container". +

    +

    +
    Parameters:
    n - a Not condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addAnd

    +
    +public void addAnd(And a)
    +
    +
    Add an <and> condition "container". +

    +

    +
    Parameters:
    a - an And condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addOr

    +
    +public void addOr(Or o)
    +
    +
    Add an <or> condition "container". +

    +

    +
    Parameters:
    o - an Or condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addEquals

    +
    +public void addEquals(Equals e)
    +
    +
    Add an <equals> condition. +

    +

    +
    Parameters:
    e - an Equals condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addOs

    +
    +public void addOs(Os o)
    +
    +
    Add an <os> condition. +

    +

    +
    Parameters:
    o - an Os condition
    Since:
    +
    1.1
    +
    +
    +
    +
    + +

    +addIsSet

    +
    +public void addIsSet(IsSet i)
    +
    +
    Add an <isset> condition. +

    +

    +
    Parameters:
    i - an IsSet condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addHttp

    +
    +public void addHttp(Http h)
    +
    +
    Add an <http> condition. +

    +

    +
    Parameters:
    h - an Http condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addSocket

    +
    +public void addSocket(Socket s)
    +
    +
    Add a <socket> condition. +

    +

    +
    Parameters:
    s - a Socket condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addFilesMatch

    +
    +public void addFilesMatch(FilesMatch test)
    +
    +
    Add a <filesmatch> condition. +

    +

    +
    Parameters:
    test - a FilesMatch condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addContains

    +
    +public void addContains(Contains test)
    +
    +
    Add a <contains> condition. +

    +

    +
    Parameters:
    test - a Contains condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addIsTrue

    +
    +public void addIsTrue(IsTrue test)
    +
    +
    Add a <istrue> condition. +

    +

    +
    Parameters:
    test - an IsTrue condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addIsFalse

    +
    +public void addIsFalse(IsFalse test)
    +
    +
    Add a <isfalse> condition. +

    +

    +
    Parameters:
    test - an IsFalse condition
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +addIsReference

    +
    +public void addIsReference(IsReference i)
    +
    +
    Add an <isreference> condition. +

    +

    +
    Parameters:
    i - an IsReference condition
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addIsFileSelected

    +
    +public void addIsFileSelected(IsFileSelected test)
    +
    +
    Add an <isfileselected> condition. +

    +

    +
    Parameters:
    test - the condition
    +
    +
    +
    + +

    +add

    +
    +public void add(Condition c)
    +
    +
    Add an arbitrary condition +

    +

    +
    Parameters:
    c - a condition
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Contains.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Contains.html new file mode 100644 index 000000000..3feaacf25 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Contains.html @@ -0,0 +1,348 @@ + + + + + + +Contains (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Contains

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.Contains
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class Contains
    extends java.lang.Object
    implements Condition
    + + +

    +Is one string part of another string? +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Contains() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetCasesensitive(boolean b) + +
    +          Whether to search ignoring case or not.
    + voidsetString(java.lang.String string) + +
    +          The string to search in.
    + voidsetSubstring(java.lang.String subString) + +
    +          The string to search for.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Contains

    +
    +public Contains()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setString

    +
    +public void setString(java.lang.String string)
    +
    +
    The string to search in. +

    +

    +
    +
    +
    +
    Parameters:
    string - the string to search in
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setSubstring

    +
    +public void setSubstring(java.lang.String subString)
    +
    +
    The string to search for. +

    +

    +
    +
    +
    +
    Parameters:
    subString - the string to search for
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setCasesensitive

    +
    +public void setCasesensitive(boolean b)
    +
    +
    Whether to search ignoring case or not. +

    +

    +
    +
    +
    +
    Parameters:
    b - if false, ignore case
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the substring is within the string +
    Throws: +
    BuildException - if the attributes are not set correctly
    Since:
    +
    Ant 1.5
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Equals.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Equals.html new file mode 100644 index 000000000..7e09b2200 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Equals.html @@ -0,0 +1,448 @@ + + + + + + +Equals (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Equals

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.Equals
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class Equals
    extends java.lang.Object
    implements Condition
    + + +

    +Simple comparison condition. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Equals() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetArg1(java.lang.Object arg1) + +
    +          Set the first argument
    + voidsetArg1(java.lang.String a1) + +
    +          Set the first string
    + voidsetArg2(java.lang.Object arg2) + +
    +          Set the second argument
    + voidsetArg2(java.lang.String a2) + +
    +          Set the second string
    + voidsetCasesensitive(boolean b) + +
    +          Should the comparison be case sensitive?
    + voidsetForcestring(boolean forcestring) + +
    +          Set whether to force string comparisons for non-equal, non-string objects.
    + voidsetTrim(boolean b) + +
    +          Should we want to trim the arguments before comparing them?
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Equals

    +
    +public Equals()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setArg1

    +
    +public void setArg1(java.lang.Object arg1)
    +
    +
    Set the first argument +

    +

    +
    +
    +
    +
    Parameters:
    arg1 - the first argument.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setArg1

    +
    +public void setArg1(java.lang.String a1)
    +
    +
    Set the first string +

    +

    +
    +
    +
    +
    Parameters:
    a1 - the first string
    +
    +
    +
    + +

    +setArg2

    +
    +public void setArg2(java.lang.Object arg2)
    +
    +
    Set the second argument +

    +

    +
    +
    +
    +
    Parameters:
    arg2 - the second argument.
    Since:
    +
    Ant 1.8
    +
    +
    +
    +
    + +

    +setArg2

    +
    +public void setArg2(java.lang.String a2)
    +
    +
    Set the second string +

    +

    +
    +
    +
    +
    Parameters:
    a2 - the second string
    +
    +
    +
    + +

    +setTrim

    +
    +public void setTrim(boolean b)
    +
    +
    Should we want to trim the arguments before comparing them? +

    +

    +
    +
    +
    +
    Parameters:
    b - if true trim the arguments
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setCasesensitive

    +
    +public void setCasesensitive(boolean b)
    +
    +
    Should the comparison be case sensitive? +

    +

    +
    +
    +
    +
    Parameters:
    b - if true use a case sensitive comparison (this is the + default)
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +setForcestring

    +
    +public void setForcestring(boolean forcestring)
    +
    +
    Set whether to force string comparisons for non-equal, non-string objects. + This allows object properties (legal in Ant 1.8.x+) to be compared as strings. +

    +

    +
    +
    +
    +
    Parameters:
    forcestring - value to set
    Since:
    +
    Ant 1.8.1
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the two strings are equal +
    Throws: +
    BuildException - if the attributes are not set correctly
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/FilesMatch.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/FilesMatch.html new file mode 100644 index 000000000..2a4ab69e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/FilesMatch.html @@ -0,0 +1,340 @@ + + + + + + +FilesMatch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class FilesMatch

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.FilesMatch
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class FilesMatch
    extends java.lang.Object
    implements Condition
    + + +

    +Compares two files for equality based on size and + content. Timestamps are not at all looked at. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    FilesMatch() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          comparison method of the interface
    + voidsetFile1(java.io.File file1) + +
    +          Sets the File1 attribute
    + voidsetFile2(java.io.File file2) + +
    +          Sets the File2 attribute
    + voidsetTextfile(boolean textfile) + +
    +          Set whether to ignore line endings when comparing files.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +FilesMatch

    +
    +public FilesMatch()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile1

    +
    +public void setFile1(java.io.File file1)
    +
    +
    Sets the File1 attribute +

    +

    +
    +
    +
    +
    Parameters:
    file1 - The new File1 value
    +
    +
    +
    + +

    +setFile2

    +
    +public void setFile2(java.io.File file2)
    +
    +
    Sets the File2 attribute +

    +

    +
    +
    +
    +
    Parameters:
    file2 - The new File2 value
    +
    +
    +
    + +

    +setTextfile

    +
    +public void setTextfile(boolean textfile)
    +
    +
    Set whether to ignore line endings when comparing files. +

    +

    +
    +
    +
    +
    Parameters:
    textfile - whether to ignore line endings.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    comparison method of the interface +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the files are equal +
    Throws: +
    BuildException - if it all went pear-shaped
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasFreeSpace.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasFreeSpace.html new file mode 100644 index 000000000..7851c94b5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasFreeSpace.html @@ -0,0 +1,367 @@ + + + + + + +HasFreeSpace (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class HasFreeSpace

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.HasFreeSpace
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class HasFreeSpace
    extends java.lang.Object
    implements Condition
    + + +

    +<hasfreespace> +

    Condition returns true if selected partition + has the requested space, false otherwise.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    HasFreeSpace() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluate the condition.
    + java.lang.StringgetNeeded() + +
    +          The amount of free space required
    + java.lang.StringgetPartition() + +
    +          The partition/device to check
    + voidsetNeeded(java.lang.String needed) + +
    +          Set the amount of space required.
    + voidsetPartition(java.lang.String partition) + +
    +          Set the partition name.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HasFreeSpace

    +
    +public HasFreeSpace()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluate the condition. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if there enough free space. +
    Throws: +
    BuildException - if there is a problem.
    +
    +
    +
    + +

    +getPartition

    +
    +public java.lang.String getPartition()
    +
    +
    The partition/device to check +

    +

    +
    +
    +
    + +
    Returns:
    the partition.
    +
    +
    +
    + +

    +setPartition

    +
    +public void setPartition(java.lang.String partition)
    +
    +
    Set the partition name. +

    +

    +
    +
    +
    +
    Parameters:
    partition - the name to use.
    +
    +
    +
    + +

    +getNeeded

    +
    +public java.lang.String getNeeded()
    +
    +
    The amount of free space required +

    +

    +
    +
    +
    + +
    Returns:
    the amount required
    +
    +
    +
    + +

    +setNeeded

    +
    +public void setNeeded(java.lang.String needed)
    +
    +
    Set the amount of space required. +

    +

    +
    +
    +
    +
    Parameters:
    needed - the amount required.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasMethod.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasMethod.html new file mode 100644 index 000000000..73c3ad762 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/HasMethod.html @@ -0,0 +1,461 @@ + + + + + + +HasMethod (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class HasMethod

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.HasMethod
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class HasMethod
    extends ProjectComponent
    implements Condition
    + + +

    +test for a method +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    HasMethod() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + PathcreateClasspath() + +
    +          Classpath to be used when searching for classes and resources.
    + booleaneval() + +
    +          Is this condition true?.
    + voidsetClassname(java.lang.String classname) + +
    +          Set the classname attribute.
    + voidsetClasspath(Path classpath) + +
    +          Set the classpath to be used when searching for classes and resources.
    + voidsetClasspathRef(Reference r) + +
    +          Set the classpath by reference.
    + voidsetField(java.lang.String field) + +
    +          Set the name of the field.
    + voidsetIgnoreSystemClasses(boolean ignoreSystemClasses) + +
    +          Set whether to ignore system classes when looking for the class.
    + voidsetMethod(java.lang.String method) + +
    +          Set the name of the method.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HasMethod

    +
    +public HasMethod()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setClasspath

    +
    +public void setClasspath(Path classpath)
    +
    +
    Set the classpath to be used when searching for classes and resources. +

    +

    +
    +
    +
    +
    Parameters:
    classpath - an Ant Path object containing the search path.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Classpath to be used when searching for classes and resources. +

    +

    +
    +
    +
    + +
    Returns:
    an empty Path instance to be configured by Ant.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Set the classpath by reference. +

    +

    +
    +
    +
    +
    Parameters:
    r - a Reference to a Path instance to be used as the classpath + value.
    +
    +
    +
    + +

    +setClassname

    +
    +public void setClassname(java.lang.String classname)
    +
    +
    Set the classname attribute. +

    +

    +
    +
    +
    +
    Parameters:
    classname - the name of the class to check.
    +
    +
    +
    + +

    +setMethod

    +
    +public void setMethod(java.lang.String method)
    +
    +
    Set the name of the method. +

    +

    +
    +
    +
    +
    Parameters:
    method - the name of the method to check.
    +
    +
    +
    + +

    +setField

    +
    +public void setField(java.lang.String field)
    +
    +
    Set the name of the field. +

    +

    +
    +
    +
    +
    Parameters:
    field - the name of the field to check.
    +
    +
    +
    + +

    +setIgnoreSystemClasses

    +
    +public void setIgnoreSystemClasses(boolean ignoreSystemClasses)
    +
    +
    Set whether to ignore system classes when looking for the class. +

    +

    +
    +
    +
    +
    Parameters:
    ignoreSystemClasses - a boolean value.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Is this condition true?. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html new file mode 100644 index 000000000..fb25bd090 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Http.html @@ -0,0 +1,378 @@ + + + + + + +Http (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Http

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.Http
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Http
    extends ProjectComponent
    implements Condition
    + + +

    +Condition to wait for a HTTP request to succeed. Its attribute(s) are: + url - the URL of the request. + errorsBeginAt - number at which errors begin at; default=400. + requestMethod - HTTP request method to use; GET, HEAD, etc. default=GET +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Http() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetErrorsBeginAt(int errorsBeginAt) + +
    +          Set the errorsBeginAt attribute
    + voidsetRequestMethod(java.lang.String method) + +
    +          Sets the method to be used when issuing the HTTP request.
    + voidsetUrl(java.lang.String url) + +
    +          Set the url attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Http

    +
    +public Http()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setUrl

    +
    +public void setUrl(java.lang.String url)
    +
    +
    Set the url attribute +

    +

    +
    +
    +
    +
    Parameters:
    url - the url of the request
    +
    +
    +
    + +

    +setErrorsBeginAt

    +
    +public void setErrorsBeginAt(int errorsBeginAt)
    +
    +
    Set the errorsBeginAt attribute +

    +

    +
    +
    +
    +
    Parameters:
    errorsBeginAt - number at which errors begin at, default is + 400
    +
    +
    +
    + +

    +setRequestMethod

    +
    +public void setRequestMethod(java.lang.String method)
    +
    +
    Sets the method to be used when issuing the HTTP request. +

    +

    +
    +
    +
    +
    Parameters:
    method - The HTTP request method to use. Valid values are + the same as those accepted by the + HttpURLConnection.setRequestMetho d() method, + such as "GET", "HEAD", "TRACE", etc. The default + if not specified is "GET".
    Since:
    +
    Ant 1.8.0
    +
    See Also:
    HttpURLConnection.setRequestMethod(java.lang.String)
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the HTTP request succeeds +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFailure.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFailure.html new file mode 100644 index 000000000..35d0aa62b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFailure.html @@ -0,0 +1,313 @@ + + + + + + +IsFailure (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsFailure

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.IsFailure
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class IsFailure
    extends java.lang.Object
    implements Condition
    + + +

    +Condition to test a return-code for failure. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    IsFailure() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Fulfill the condition interface.
    + intgetCode() + +
    +          Get the return code that will be checked by this IsFailure condition.
    + voidsetCode(int c) + +
    +          Set the return code to check.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsFailure

    +
    +public IsFailure()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCode

    +
    +public void setCode(int c)
    +
    +
    Set the return code to check. +

    +

    +
    +
    +
    +
    Parameters:
    c - the return code.
    +
    +
    +
    + +

    +getCode

    +
    +public int getCode()
    +
    +
    Get the return code that will be checked by this IsFailure condition. +

    +

    +
    +
    +
    + +
    Returns:
    return code as int.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Fulfill the condition interface. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    the result of evaluating the specified return code.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFalse.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFalse.html new file mode 100644 index 000000000..44f47aaa5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFalse.html @@ -0,0 +1,320 @@ + + + + + + +IsFalse (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsFalse

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsFalse
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsFalse
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that tests whether a given string evals to false +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsFalse() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetValue(boolean value) + +
    +          set the value to be tested; let ant eval it to true/false
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsFalse

    +
    +public IsFalse()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setValue

    +
    +public void setValue(boolean value)
    +
    +
    set the value to be tested; let ant eval it to true/false +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to test
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    the inverted value; +
    Throws: +
    BuildException - if someone forgot to spec a value
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFileSelected.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFileSelected.html new file mode 100644 index 000000000..574f3be59 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsFileSelected.html @@ -0,0 +1,390 @@ + + + + + + +IsFileSelected (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsFileSelected

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.AbstractSelectorContainer
+              extended by org.apache.tools.ant.taskdefs.condition.IsFileSelected
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition, SelectorContainer
    +
    +
    +
    +
    public class IsFileSelected
    extends AbstractSelectorContainer
    implements Condition
    + + +

    +This is a condition that checks to see if a file passes an embedded selector. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.DataType
    checked, ref
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsFileSelected() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluate the selector with the file.
    + voidsetBaseDir(java.io.File baseDir) + +
    +          The base directory to use.
    + voidsetFile(java.io.File file) + +
    +          The file to check.
    + voidvalidate() + +
    +          validate the parameters.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.selectors.AbstractSelectorContainer
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, clone, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, toString
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.DataType
    checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsFileSelected

    +
    +public IsFileSelected()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    The file to check. +

    +

    +
    +
    +
    +
    Parameters:
    file - the file to check if if passes the embedded selector.
    +
    +
    +
    + +

    +setBaseDir

    +
    +public void setBaseDir(java.io.File baseDir)
    +
    +
    The base directory to use. +

    +

    +
    +
    +
    +
    Parameters:
    baseDir - the base directory to use, if null use the project's + basedir.
    +
    +
    +
    + +

    +validate

    +
    +public void validate()
    +
    +
    validate the parameters. +

    +

    +
    Overrides:
    validate in class AbstractSelectorContainer
    +
    +
    +
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Evaluate the selector with the file. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the file is selected by the embedded selector.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.CompareMode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.CompareMode.html new file mode 100644 index 000000000..89aef7478 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.CompareMode.html @@ -0,0 +1,301 @@ + + + + + + +IsLastModified.CompareMode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsLastModified.CompareMode

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.condition.IsLastModified.CompareMode
+
    +
    +
    Enclosing class:
    IsLastModified
    +
    +
    +
    +
    public static class IsLastModified.CompareMode
    extends EnumeratedAttribute
    + + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    IsLastModified.CompareMode() + +
    +           
    IsLastModified.CompareMode(java.lang.String s) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsLastModified.CompareMode

    +
    +public IsLastModified.CompareMode()
    +
    +
    +
    + +

    +IsLastModified.CompareMode

    +
    +public IsLastModified.CompareMode(java.lang.String s)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.html new file mode 100644 index 000000000..ca118bd41 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsLastModified.html @@ -0,0 +1,497 @@ + + + + + + +IsLastModified (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsLastModified

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsLastModified
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsLastModified
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that makes assertions about the last modified date of a + resource. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classIsLastModified.CompareMode + +
    +           
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsLastModified() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(Resource r) + +
    +          The resource to test.
    + booleaneval() + +
    +          Is this condition true?
    +protected  longgetMillis() + +
    +          Calculate timestamp as millis either based on millis or + dateTime (and pattern) attribute.
    + voidsetDatetime(java.lang.String dateTime) + +
    +          Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM".
    + voidsetMillis(long millis) + +
    +          Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970.
    + voidsetMode(IsLastModified.CompareMode mode) + +
    +          The type of comparison to test.
    + voidsetPattern(java.lang.String pattern) + +
    +          Set the format of the datetime attribute.
    +protected  voidvalidate() + +
    +          Argument validation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsLastModified

    +
    +public IsLastModified()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setMillis

    +
    +public void setMillis(long millis)
    +
    +
    Set the new modification time of file(s) touched + in milliseconds since midnight Jan 1 1970. +

    +

    +
    +
    +
    +
    Parameters:
    millis - the long timestamp to use.
    +
    +
    +
    + +

    +setDatetime

    +
    +public void setDatetime(java.lang.String dateTime)
    +
    +
    Set the new modification time of file(s) touched + in the format "MM/DD/YYYY HH:MM AM or PM" + or "MM/DD/YYYY HH:MM:SS AM or PM". +

    +

    +
    +
    +
    +
    Parameters:
    dateTime - the String date in the specified format.
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String pattern)
    +
    +
    Set the format of the datetime attribute. +

    +

    +
    +
    +
    +
    Parameters:
    pattern - the SimpleDateFormat-compatible + format pattern.
    +
    +
    +
    + +

    +add

    +
    +public void add(Resource r)
    +
    +
    The resource to test. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +setMode

    +
    +public void setMode(IsLastModified.CompareMode mode)
    +
    +
    The type of comparison to test. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +validate

    +
    +protected void validate()
+                 throws BuildException
    +
    +
    Argument validation. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +getMillis

    +
    +protected long getMillis()
+                  throws BuildException
    +
    +
    Calculate timestamp as millis either based on millis or + dateTime (and pattern) attribute. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReachable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReachable.html new file mode 100644 index 000000000..dcf495281 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReachable.html @@ -0,0 +1,573 @@ + + + + + + +IsReachable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsReachable

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsReachable
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsReachable
    extends ProjectComponent
    implements Condition
    + + +

    +Test for a host being reachable using ICMP "ping" packets & echo operations. + Ping packets are very reliable for assessing reachability in a LAN or WAN, + but they do not get through any well-configured firewall. Echo (port 7) may. +

    + This condition turns unknown host exceptions into false conditions. This is + because on a laptop, DNS is one of the first services lost when the network + goes; you are implicitly offline. +

    + If a URL is supplied instead of a host, the hostname is extracted and used in + the test--all other parts of the URL are discarded. +

    + The test may not work through firewalls; that is, something may be reachable + using a protocol such as HTTP, while the lower level ICMP packets get dropped + on the floor. Similarly, a host may be detected as reachable with ICMP, but not + reachable on other ports (i.e. port 80), because of firewalls. +

    + Requires Java 5+ to work properly. On Java 1.4, if a hostname + can be resolved, the destination is assumed to be reachable. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static intDEFAULT_TIMEOUT + +
    +          The default timeout.
    +static java.lang.StringERROR_BAD_TIMEOUT + +
    +          Error when invalid timeout value is defined
    +static java.lang.StringERROR_BAD_URL + +
    +          Error message when an invalid url is used.
    +static java.lang.StringERROR_BOTH_TARGETS + +
    +          Error message when url and host are specified.
    +static java.lang.StringERROR_NO_HOST_IN_URL + +
    +          Error message when no hostname in url.
    +static java.lang.StringERROR_NO_HOSTNAME + +
    +          Error when no hostname is defined
    +static java.lang.StringERROR_ON_NETWORK + +
    +          Network error message is seen.
    +static java.lang.StringMETHOD_NAME + +
    +          The method name to look for in InetAddress
    +static java.lang.StringMSG_NO_REACHABLE_TEST + +
    +          Error message when no reachably test avail.
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsReachable() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluate the condition.
    + voidsetHost(java.lang.String host) + +
    +          Set the host to ping.
    + voidsetTimeout(int timeout) + +
    +          Set the timeout for the reachability test in seconds.
    + voidsetUrl(java.lang.String url) + +
    +          Set the URL from which to extract the hostname.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +DEFAULT_TIMEOUT

    +
    +public static final int DEFAULT_TIMEOUT
    +
    +
    The default timeout. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_HOSTNAME

    +
    +public static final java.lang.String ERROR_NO_HOSTNAME
    +
    +
    Error when no hostname is defined +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_BAD_TIMEOUT

    +
    +public static final java.lang.String ERROR_BAD_TIMEOUT
    +
    +
    Error when invalid timeout value is defined +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_ON_NETWORK

    +
    +public static final java.lang.String ERROR_ON_NETWORK
    +
    +
    Network error message is seen. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_BOTH_TARGETS

    +
    +public static final java.lang.String ERROR_BOTH_TARGETS
    +
    +
    Error message when url and host are specified. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MSG_NO_REACHABLE_TEST

    +
    +public static final java.lang.String MSG_NO_REACHABLE_TEST
    +
    +
    Error message when no reachably test avail. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_BAD_URL

    +
    +public static final java.lang.String ERROR_BAD_URL
    +
    +
    Error message when an invalid url is used. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_HOST_IN_URL

    +
    +public static final java.lang.String ERROR_NO_HOST_IN_URL
    +
    +
    Error message when no hostname in url. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +METHOD_NAME

    +
    +public static final java.lang.String METHOD_NAME
    +
    +
    The method name to look for in InetAddress +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +IsReachable

    +
    +public IsReachable()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setHost

    +
    +public void setHost(java.lang.String host)
    +
    +
    Set the host to ping. +

    +

    +
    +
    +
    +
    Parameters:
    host - the host to ping.
    +
    +
    +
    + +

    +setUrl

    +
    +public void setUrl(java.lang.String url)
    +
    +
    Set the URL from which to extract the hostname. +

    +

    +
    +
    +
    +
    Parameters:
    url - a URL object.
    +
    +
    +
    + +

    +setTimeout

    +
    +public void setTimeout(int timeout)
    +
    +
    Set the timeout for the reachability test in seconds. +

    +

    +
    +
    +
    +
    Parameters:
    timeout - the timeout in seconds.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluate the condition. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true. +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReference.html new file mode 100644 index 000000000..19174574b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsReference.html @@ -0,0 +1,347 @@ + + + + + + +IsReference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsReference

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsReference
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsReference
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that tests whether a given reference has been defined. + +

    Optionally tests whether it is of a given type/class.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.6
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsReference() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetRefid(Reference r) + +
    +          Set the refid attribute.
    + voidsetType(java.lang.String type) + +
    +          Set the type attribute.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsReference

    +
    +public IsReference()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setRefid

    +
    +public void setRefid(Reference r)
    +
    +
    Set the refid attribute. +

    +

    +
    +
    +
    +
    Parameters:
    r - a Reference value
    +
    +
    +
    + +

    +setType

    +
    +public void setType(java.lang.String type)
    +
    +
    Set the type attribute. This is optional attribute. +

    +

    +
    +
    +
    +
    Parameters:
    type - an ant component type name
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the reference exists and if type is set, if + the reference is the same type +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSet.html new file mode 100644 index 000000000..791e89a3b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSet.html @@ -0,0 +1,320 @@ + + + + + + +IsSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsSet

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsSet
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsSet
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that tests whether a given property has been set. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsSet() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetProperty(java.lang.String p) + +
    +          Set the property attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsSet

    +
    +public IsSet()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String p)
    +
    +
    Set the property attribute +

    +

    +
    +
    +
    +
    Parameters:
    p - the property name
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the property exists +
    Throws: +
    BuildException - if the property attribute is not set
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSigned.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSigned.html new file mode 100644 index 000000000..eaed573d4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsSigned.html @@ -0,0 +1,398 @@ + + + + + + +IsSigned (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsSigned

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.taskdefs.condition.IsSigned
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsSigned
    extends DataType
    implements Condition
    + + +

    +Checks whether a jarfile is signed: if the name of the + signature is passed, the file is checked for presence of that + particular signature; otherwise the file is checked for the + existence of any signature. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.DataType
    checked, ref
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsSigned() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature.
    +static booleanisSigned(java.io.File zipFile, + java.lang.String name) + +
    +          Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature.
    + voidsetFile(java.io.File file) + +
    +          The jarfile that is to be tested for the presence + of a signature.
    + voidsetName(java.lang.String name) + +
    +          The signature name to check jarfile for.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.DataType
    checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsSigned

    +
    +public IsSigned()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFile

    +
    +public void setFile(java.io.File file)
    +
    +
    The jarfile that is to be tested for the presence + of a signature. +

    +

    +
    +
    +
    +
    Parameters:
    file - jarfile to be tested.
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    The signature name to check jarfile for. +

    +

    +
    +
    +
    +
    Parameters:
    name - signature to look for.
    +
    +
    +
    + +

    +isSigned

    +
    +public static boolean isSigned(java.io.File zipFile,
+                               java.lang.String name)
+                        throws java.io.IOException
    +
    +
    Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature. +

    +

    +
    +
    +
    +
    Parameters:
    zipFile - the zipfile to check
    name - the signature to check (may be killed) +
    Returns:
    true if the file is signed. +
    Throws: +
    java.io.IOException - on error
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
    +
    +
    Returns true if the file exists and is signed with + the signature specified, or, if name wasn't + specified, if the file contains a signature. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the file is signed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsTrue.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsTrue.html new file mode 100644 index 000000000..99a618f9c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/IsTrue.html @@ -0,0 +1,320 @@ + + + + + + +IsTrue (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class IsTrue

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.IsTrue
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class IsTrue
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that tests whether a given string evals to true +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    IsTrue() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetValue(boolean value) + +
    +          set the value to be tested; let ant eval it to true/false
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +IsTrue

    +
    +public IsTrue()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setValue

    +
    +public void setValue(boolean value)
    +
    +
    set the value to be tested; let ant eval it to true/false +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to test
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    the value +
    Throws: +
    BuildException - if someone forgot to spec a value
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Matches.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Matches.html new file mode 100644 index 000000000..d9c04b32f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Matches.html @@ -0,0 +1,446 @@ + + + + + + +Matches (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Matches

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.Matches
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Matches
    extends ProjectComponent
    implements Condition
    + + +

    +Simple regular expression condition. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Matches() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddRegexp(RegularExpression regularExpression) + +
    +          A regular expression.
    + booleaneval() + +
    +          Is this condition true?
    + voidsetCasesensitive(boolean b) + +
    +          Whether to ignore case or not.
    + voidsetMultiline(boolean b) + +
    +          Whether to match should be multiline.
    + voidsetPattern(java.lang.String pattern) + +
    +          Set the regular expression to match against
    + voidsetSingleLine(boolean b) + +
    +          Whether to treat input as singleline ('.' matches newline).
    + voidsetString(java.lang.String string) + +
    +          Set the string
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Matches

    +
    +public Matches()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setString

    +
    +public void setString(java.lang.String string)
    +
    +
    Set the string +

    +

    +
    +
    +
    +
    Parameters:
    string - the string to match
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String pattern)
    +
    +
    Set the regular expression to match against +

    +

    +
    +
    +
    +
    Parameters:
    pattern - the regular expression pattern
    +
    +
    +
    + +

    +addRegexp

    +
    +public void addRegexp(RegularExpression regularExpression)
    +
    +
    A regular expression. + You can use this element to refer to a previously + defined regular expression datatype instance +

    +

    +
    +
    +
    +
    Parameters:
    regularExpression - the regular expression object + to be configured as an element
    +
    +
    +
    + +

    +setCasesensitive

    +
    +public void setCasesensitive(boolean b)
    +
    +
    Whether to ignore case or not. +

    +

    +
    +
    +
    +
    Parameters:
    b - if false, ignore case.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +setMultiline

    +
    +public void setMultiline(boolean b)
    +
    +
    Whether to match should be multiline. +

    +

    +
    +
    +
    +
    Parameters:
    b - the value to set.
    +
    +
    +
    + +

    +setSingleLine

    +
    +public void setSingleLine(boolean b)
    +
    +
    Whether to treat input as singleline ('.' matches newline). + Corresponsds to java.util.regex.Pattern.DOTALL. +

    +

    +
    +
    +
    +
    Parameters:
    b - the value to set.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the string matches the regular expression pattern +
    Throws: +
    BuildException - if the attributes are not set correctly
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Not.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Not.html new file mode 100644 index 000000000..a00cf2921 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Not.html @@ -0,0 +1,308 @@ + + + + + + +Not (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Not

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.condition.Not
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Not
    extends ConditionBase
    implements Condition
    + + +

    +<not> condition. + + Evaluates to true if the single condition nested into it is false + and vice versa. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Not() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluate condition
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Not

    +
    +public Not()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluate condition +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true. +
    Throws: +
    BuildException - if the condition is not configured correctly.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Or.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Or.html new file mode 100644 index 000000000..664f5a227 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Or.html @@ -0,0 +1,309 @@ + + + + + + +Or (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Or

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.condition.Or
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Or
    extends ConditionBase
    implements Condition
    + + +

    +<or> condition container. + +

    Iterates over all conditions and returns true as soon as one + evaluates to true.

    +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Or() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Or

    +
    +public Or()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if any of the contained conditions evaluate to true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Os.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Os.html new file mode 100644 index 000000000..3d49f2343 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Os.html @@ -0,0 +1,807 @@ + + + + + + +Os (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Os

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.Os
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class Os
    extends java.lang.Object
    implements Condition
    + + +

    +Condition that tests the OS type. +

    + +

    +

    +
    Since:
    +
    Ant 1.4
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringFAMILY_9X + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_DOS + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_MAC + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_NETWARE + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_NT + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_OS2 + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_OS400 + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_TANDEM + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_UNIX + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_VMS + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_WINDOWS + +
    +          OS family that can be tested for.
    +static java.lang.StringFAMILY_ZOS + +
    +          OS family that can be tested for.
    +  + + + + + + + + + + + + + +
    +Constructor Summary
    Os() + +
    +          Default constructor
    Os(java.lang.String family) + +
    +          Constructor that sets the family attribute
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Determines if the OS on which Ant is executing matches the type of + that set in setFamily.
    +static booleanisArch(java.lang.String arch) + +
    +          Determines if the OS on which Ant is executing matches the + given OS architecture.
    +static booleanisFamily(java.lang.String family) + +
    +          Determines if the OS on which Ant is executing matches the + given OS family.
    +static booleanisName(java.lang.String name) + +
    +          Determines if the OS on which Ant is executing matches the + given OS name.
    +static booleanisOs(java.lang.String family, + java.lang.String name, + java.lang.String arch, + java.lang.String version) + +
    +          Determines if the OS on which Ant is executing matches the + given OS family, name, architecture and version
    +static booleanisVersion(java.lang.String version) + +
    +          Determines if the OS on which Ant is executing matches the + given OS version.
    + voidsetArch(java.lang.String arch) + +
    +          Sets the desired OS architecture
    + voidsetFamily(java.lang.String f) + +
    +          Sets the desired OS family type
    + voidsetName(java.lang.String name) + +
    +          Sets the desired OS name
    + voidsetVersion(java.lang.String version) + +
    +          Sets the desired OS version
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +FAMILY_WINDOWS

    +
    +public static final java.lang.String FAMILY_WINDOWS
    +
    +
    OS family that can be tested for. "windows" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_9X

    +
    +public static final java.lang.String FAMILY_9X
    +
    +
    OS family that can be tested for. "win9x" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_NT

    +
    +public static final java.lang.String FAMILY_NT
    +
    +
    OS family that can be tested for. "winnt" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_OS2

    +
    +public static final java.lang.String FAMILY_OS2
    +
    +
    OS family that can be tested for. "os/2" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_NETWARE

    +
    +public static final java.lang.String FAMILY_NETWARE
    +
    +
    OS family that can be tested for. "netware" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_DOS

    +
    +public static final java.lang.String FAMILY_DOS
    +
    +
    OS family that can be tested for. "dos" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_MAC

    +
    +public static final java.lang.String FAMILY_MAC
    +
    +
    OS family that can be tested for. "mac" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_TANDEM

    +
    +public static final java.lang.String FAMILY_TANDEM
    +
    +
    OS family that can be tested for. "tandem" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_UNIX

    +
    +public static final java.lang.String FAMILY_UNIX
    +
    +
    OS family that can be tested for. "unix" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_VMS

    +
    +public static final java.lang.String FAMILY_VMS
    +
    +
    OS family that can be tested for. "openvms" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_ZOS

    +
    +public static final java.lang.String FAMILY_ZOS
    +
    +
    OS family that can be tested for. "z/os" +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FAMILY_OS400

    +
    +public static final java.lang.String FAMILY_OS400
    +
    +
    OS family that can be tested for. "os/400" +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Os

    +
    +public Os()
    +
    +
    Default constructor +

    +

    +
    + +

    +Os

    +
    +public Os(java.lang.String family)
    +
    +
    Constructor that sets the family attribute +

    +

    +
    Parameters:
    family - a String value
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFamily

    +
    +public void setFamily(java.lang.String f)
    +
    +
    Sets the desired OS family type +

    +

    +
    +
    +
    +
    Parameters:
    f - The OS family type desired
    + Possible values:
    +
      +
    • dos
      • +
    • mac
      • +
    • netware
      • +
    • os/2
      • +
    • tandem
      • +
    • unix
      • +
    • windows
      • +
    • win9x
      • +
    • z/os
      • +
    • os/400
      • +
    +
    +
    +
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Sets the desired OS name +

    +

    +
    +
    +
    +
    Parameters:
    name - The OS name
    +
    +
    +
    + +

    +setArch

    +
    +public void setArch(java.lang.String arch)
    +
    +
    Sets the desired OS architecture +

    +

    +
    +
    +
    +
    Parameters:
    arch - The OS architecture
    +
    +
    +
    + +

    +setVersion

    +
    +public void setVersion(java.lang.String version)
    +
    +
    Sets the desired OS version +

    +

    +
    +
    +
    +
    Parameters:
    version - The OS version
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Determines if the OS on which Ant is executing matches the type of + that set in setFamily. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the os matches. +
    Throws: +
    BuildException - if there is an error.
    See Also:
    setFamily(String)
    +
    +
    +
    + +

    +isFamily

    +
    +public static boolean isFamily(java.lang.String family)
    +
    +
    Determines if the OS on which Ant is executing matches the + given OS family. +

    +

    +
    +
    +
    +
    Parameters:
    family - the family to check for +
    Returns:
    true if the OS matches
    Since:
    +
    1.5
    +
    +
    +
    +
    + +

    +isName

    +
    +public static boolean isName(java.lang.String name)
    +
    +
    Determines if the OS on which Ant is executing matches the + given OS name. +

    +

    +
    +
    +
    +
    Parameters:
    name - the OS name to check for +
    Returns:
    true if the OS matches
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +isArch

    +
    +public static boolean isArch(java.lang.String arch)
    +
    +
    Determines if the OS on which Ant is executing matches the + given OS architecture. +

    +

    +
    +
    +
    +
    Parameters:
    arch - the OS architecture to check for +
    Returns:
    true if the OS matches
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +isVersion

    +
    +public static boolean isVersion(java.lang.String version)
    +
    +
    Determines if the OS on which Ant is executing matches the + given OS version. +

    +

    +
    +
    +
    +
    Parameters:
    version - the OS version to check for +
    Returns:
    true if the OS matches
    Since:
    +
    1.7
    +
    +
    +
    +
    + +

    +isOs

    +
    +public static boolean isOs(java.lang.String family,
+                           java.lang.String name,
+                           java.lang.String arch,
+                           java.lang.String version)
    +
    +
    Determines if the OS on which Ant is executing matches the + given OS family, name, architecture and version +

    +

    +
    +
    +
    +
    Parameters:
    family - The OS family
    name - The OS name
    arch - The OS architecture
    version - The OS version +
    Returns:
    true if the OS matches
    Since:
    +
    1.7
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ParserSupports.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ParserSupports.html new file mode 100644 index 000000000..26f37e537 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ParserSupports.html @@ -0,0 +1,567 @@ + + + + + + +ParserSupports (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class ParserSupports

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ParserSupports
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class ParserSupports
    extends ProjectComponent
    implements Condition
    + + +

    +Test for the XML parser supporting a particular feature +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringERROR_BOTH_ATTRIBUTES + +
    +          error - combined attributes not allowed
    +static java.lang.StringERROR_NO_ATTRIBUTES + +
    +          error - missing attribute
    +static java.lang.StringERROR_NO_VALUE + +
    +          error - no value
    +static java.lang.StringFEATURE + +
    +          feature
    +static java.lang.StringNOT_RECOGNIZED + +
    +          error - not recognized
    +static java.lang.StringNOT_SUPPORTED + +
    +          error - not supported
    +static java.lang.StringPROPERTY + +
    +          property
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ParserSupports() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?.
    + booleanevalFeature() + +
    +          Set a feature
    + booleanevalProperty() + +
    +          Set a property
    + voidsetFeature(java.lang.String feature) + +
    +          Feature to probe for.
    + voidsetProperty(java.lang.String property) + +
    +          Property to probe for
    + voidsetValue(java.lang.String value) + +
    +          Optional value to set.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +ERROR_BOTH_ATTRIBUTES

    +
    +public static final java.lang.String ERROR_BOTH_ATTRIBUTES
    +
    +
    error - combined attributes not allowed +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FEATURE

    +
    +public static final java.lang.String FEATURE
    +
    +
    feature +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROPERTY

    +
    +public static final java.lang.String PROPERTY
    +
    +
    property +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NOT_RECOGNIZED

    +
    +public static final java.lang.String NOT_RECOGNIZED
    +
    +
    error - not recognized +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NOT_SUPPORTED

    +
    +public static final java.lang.String NOT_SUPPORTED
    +
    +
    error - not supported +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_ATTRIBUTES

    +
    +public static final java.lang.String ERROR_NO_ATTRIBUTES
    +
    +
    error - missing attribute +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ERROR_NO_VALUE

    +
    +public static final java.lang.String ERROR_NO_VALUE
    +
    +
    error - no value +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +ParserSupports

    +
    +public ParserSupports()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setFeature

    +
    +public void setFeature(java.lang.String feature)
    +
    +
    Feature to probe for. +

    +

    +
    +
    +
    +
    Parameters:
    feature - the feature to probe for.
    +
    +
    +
    + +

    +setProperty

    +
    +public void setProperty(java.lang.String property)
    +
    +
    Property to probe for +

    +

    +
    +
    +
    +
    Parameters:
    property - the property to probe for.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Optional value to set. + Converted to a boolean value when setting a property +

    +

    +
    +
    +
    +
    Parameters:
    value - the value to set.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Is this condition true?. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    +
    + +

    +evalFeature

    +
    +public boolean evalFeature()
    +
    +
    Set a feature +

    +

    +
    +
    +
    + +
    Returns:
    true if the feature could be set
    +
    +
    +
    + +

    +evalProperty

    +
    +public boolean evalProperty()
    +
    +
    Set a property +

    +

    +
    +
    +
    + +
    Returns:
    true if the feature could be set
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceContains.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceContains.html new file mode 100644 index 000000000..bb862ba8b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceContains.html @@ -0,0 +1,415 @@ + + + + + + +ResourceContains (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class ResourceContains

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.ResourceContains
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class ResourceContains
    extends java.lang.Object
    implements Condition
    + + +

    +<resourcecontains> + Is a string contained in a resource (file currently)? +

    + +

    +

    +
    Since:
    +
    Ant 1.7.1
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ResourceContains() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluates the condition.
    + ProjectgetProject() + +
    +          Get this condition's Project.
    + voidsetCasesensitive(boolean casesensitive) + +
    +          Sets case sensitivity attribute.
    + voidsetProject(Project project) + +
    +          Set this condition's Project.
    + voidsetRefid(java.lang.String refid) + +
    +          Sets the refid to search; should indicate a resource directly + or by way of a single-element ResourceCollection.
    + voidsetResource(java.lang.String r) + +
    +          Sets the resource to search
    + voidsetSubstring(java.lang.String substring) + +
    +          Sets the substring to look for
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ResourceContains

    +
    +public ResourceContains()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProject

    +
    +public void setProject(Project project)
    +
    +
    Set this condition's Project. +

    +

    +
    +
    +
    +
    Parameters:
    project - Project
    +
    +
    +
    + +

    +getProject

    +
    +public Project getProject()
    +
    +
    Get this condition's Project. +

    +

    +
    +
    +
    + +
    Returns:
    Project
    +
    +
    +
    + +

    +setResource

    +
    +public void setResource(java.lang.String r)
    +
    +
    Sets the resource to search +

    +

    +
    +
    +
    +
    Parameters:
    r - the value to use.
    +
    +
    +
    + +

    +setRefid

    +
    +public void setRefid(java.lang.String refid)
    +
    +
    Sets the refid to search; should indicate a resource directly + or by way of a single-element ResourceCollection. +

    +

    +
    +
    +
    +
    Parameters:
    refid - the value to use.
    +
    +
    +
    + +

    +setSubstring

    +
    +public void setSubstring(java.lang.String substring)
    +
    +
    Sets the substring to look for +

    +

    +
    +
    +
    +
    Parameters:
    substring - the value to use.
    +
    +
    +
    + +

    +setCasesensitive

    +
    +public void setCasesensitive(boolean casesensitive)
    +
    +
    Sets case sensitivity attribute. +

    +

    +
    +
    +
    +
    Parameters:
    casesensitive - the value to use.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluates the condition. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the substring is contained in the resource +
    Throws: +
    BuildException - if there is a problem.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceExists.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceExists.html new file mode 100644 index 000000000..30626539a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourceExists.html @@ -0,0 +1,347 @@ + + + + + + +ResourceExists (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class ResourceExists

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ResourceExists
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class ResourceExists
    extends ProjectComponent
    implements Condition
    + + +

    +Condition that checks whether a given resource exists. +

    + +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ResourceExists() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(Resource r) + +
    +          The resource to test.
    + booleaneval() + +
    +          Is this condition true?
    +protected  voidvalidate() + +
    +          Argument validation.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ResourceExists

    +
    +public ResourceExists()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +add

    +
    +public void add(Resource r)
    +
    +
    The resource to test. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +validate

    +
    +protected void validate()
+                 throws BuildException
    +
    +
    Argument validation. +

    +

    +
    +
    +
    + +
    Throws: +
    BuildException
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourcesMatch.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourcesMatch.html new file mode 100644 index 000000000..2927d5b58 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/ResourcesMatch.html @@ -0,0 +1,321 @@ + + + + + + +ResourcesMatch (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class ResourcesMatch

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.condition.ResourcesMatch
+
    +
    +
    All Implemented Interfaces:
    Condition
    +
    +
    +
    +
    public class ResourcesMatch
    extends java.lang.Object
    implements Condition
    + + +

    +Compares resources for equality based on size and content. + All resources specified must match; no resource collections + specified is an error condition; if resource collections are + specified, but yield fewer than two elements, the condition + evaluates to true. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ResourcesMatch() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(ResourceCollection rc) + +
    +          Add a resource collection.
    + booleaneval() + +
    +          Verify that all resources match.
    + voidsetAsText(boolean asText) + +
    +          Set whether to treat resources as if they were text files, + ignoring line endings.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ResourcesMatch

    +
    +public ResourcesMatch()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setAsText

    +
    +public void setAsText(boolean asText)
    +
    +
    Set whether to treat resources as if they were text files, + ignoring line endings. +

    +

    +
    +
    +
    +
    Parameters:
    asText - whether to ignore line endings.
    +
    +
    +
    + +

    +add

    +
    +public void add(ResourceCollection rc)
    +
    +
    Add a resource collection. +

    +

    +
    +
    +
    +
    Parameters:
    rc - the resource collection to add.
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Verify that all resources match. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if all resources are equal. +
    Throws: +
    BuildException - if there is an error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Socket.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Socket.html new file mode 100644 index 000000000..567daf3d3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Socket.html @@ -0,0 +1,346 @@ + + + + + + +Socket (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Socket

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.Socket
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Socket
    extends ProjectComponent
    implements Condition
    + + +

    +Condition to wait for a TCP/IP socket to have a listener. Its attributes are: + server - the name of the server. + port - the port number of the socket. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Socket() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Is this condition true?
    + voidsetPort(int port) + +
    +          Set the port attribute
    + voidsetServer(java.lang.String server) + +
    +          Set the server attribute
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Socket

    +
    +public Socket()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setServer

    +
    +public void setServer(java.lang.String server)
    +
    +
    Set the server attribute +

    +

    +
    +
    +
    +
    Parameters:
    server - the server name
    +
    +
    +
    + +

    +setPort

    +
    +public void setPort(int port)
    +
    +
    Set the port attribute +

    +

    +
    +
    +
    +
    Parameters:
    port - the port number of the socket
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Description copied from interface: Condition
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if a socket can be created +
    Throws: +
    BuildException - if the attributes are not set
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/TypeFound.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/TypeFound.html new file mode 100644 index 000000000..2ae5a86af --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/TypeFound.html @@ -0,0 +1,367 @@ + + + + + + +TypeFound (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class TypeFound

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.TypeFound
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class TypeFound
    extends ProjectComponent
    implements Condition
    + + +

    +looks for a task or other Ant type that exists. Existence is defined as + the type is defined, and its implementation class is present. This + will work for datatypes and preset, script and macro definitions. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    TypeFound() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  booleandoesTypeExist(java.lang.String typename) + +
    +          test for a task or other ant type existing in the current project
    + booleaneval() + +
    +          Is this condition true?
    + voidsetName(java.lang.String name) + +
    +          the task or other type to look for
    + voidsetURI(java.lang.String uri) + +
    +          The URI for this definition.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +TypeFound

    +
    +public TypeFound()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    the task or other type to look for +

    +

    +
    +
    +
    +
    Parameters:
    name - the name of the type
    +
    +
    +
    + +

    +setURI

    +
    +public void setURI(java.lang.String uri)
    +
    +
    The URI for this definition. +

    +

    +
    +
    +
    +
    Parameters:
    uri - the namespace URI. If this is not set, use the + default ant namespace.
    +
    +
    +
    + +

    +doesTypeExist

    +
    +protected boolean doesTypeExist(java.lang.String typename)
    +
    +
    test for a task or other ant type existing in the current project +

    +

    +
    +
    +
    +
    Parameters:
    typename - the name of the type +
    Returns:
    true if the typename exists
    +
    +
    +
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Is this condition true? +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    true if the condition is true +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Xor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Xor.html new file mode 100644 index 000000000..90dc84c7e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/Xor.html @@ -0,0 +1,306 @@ + + + + + + +Xor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.condition +
    +Class Xor

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.condition.Xor
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, Condition
    +
    +
    +
    +
    public class Xor
    extends ConditionBase
    implements Condition
    + + +

    +The Xor condition type to exclusive or operations. + This does not shortcut stuff. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Xor() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleaneval() + +
    +          Evaluate the contained conditions.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
    add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Xor

    +
    +public Xor()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +eval

    +
    +public boolean eval()
+             throws BuildException
    +
    +
    Evaluate the contained conditions. +

    +

    +
    Specified by:
    eval in interface Condition
    +
    +
    + +
    Returns:
    the result of xoring the conditions together. +
    Throws: +
    BuildException - if an error occurs.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-frame.html new file mode 100644 index 000000000..744420221 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-frame.html @@ -0,0 +1,101 @@ + + + + + + +org.apache.tools.ant.taskdefs.condition (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.condition + + + + +
    +Interfaces  + +
    +Condition
    + + + + + + +
    +Classes  + +
    +And +
    +AntVersion +
    +ConditionBase +
    +Contains +
    +Equals +
    +FilesMatch +
    +HasFreeSpace +
    +HasMethod +
    +Http +
    +IsFailure +
    +IsFalse +
    +IsFileSelected +
    +IsLastModified +
    +IsLastModified.CompareMode +
    +IsReachable +
    +IsReference +
    +IsSet +
    +IsSigned +
    +IsTrue +
    +Matches +
    +Not +
    +Or +
    +Os +
    +ParserSupports +
    +ResourceContains +
    +ResourceExists +
    +ResourcesMatch +
    +Socket +
    +TypeFound +
    +Xor
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-summary.html new file mode 100644 index 000000000..7de7f903e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-summary.html @@ -0,0 +1,290 @@ + + + + + + +org.apache.tools.ant.taskdefs.condition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.taskdefs.condition +

    + + + + + + + + + +
    +Interface Summary
    ConditionInterface for conditions to use inside the <condition> task.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    And<and> condition container.
    AntVersionAn Ant version condition.
    ConditionBaseBaseclass for the <condition> task as well as several + conditions - ensures that the types of conditions inside the task + and the "container" conditions are in sync.
    ContainsIs one string part of another string?
    EqualsSimple comparison condition.
    FilesMatchCompares two files for equality based on size and + content.
    HasFreeSpace<hasfreespace>
    HasMethodtest for a method
    HttpCondition to wait for a HTTP request to succeed.
    IsFailureCondition to test a return-code for failure.
    IsFalseCondition that tests whether a given string evals to false
    IsFileSelectedThis is a condition that checks to see if a file passes an embedded selector.
    IsLastModifiedCondition that makes assertions about the last modified date of a + resource.
    IsLastModified.CompareMode 
    IsReachableTest for a host being reachable using ICMP "ping" packets & echo operations.
    IsReferenceCondition that tests whether a given reference has been defined.
    IsSetCondition that tests whether a given property has been set.
    IsSignedChecks whether a jarfile is signed: if the name of the + signature is passed, the file is checked for presence of that + particular signature; otherwise the file is checked for the + existence of any signature.
    IsTrueCondition that tests whether a given string evals to true
    MatchesSimple regular expression condition.
    Not<not> condition.
    Or<or> condition container.
    OsCondition that tests the OS type.
    ParserSupportsTest for the XML parser supporting a particular feature
    ResourceContains<resourcecontains> + Is a string contained in a resource (file currently)?
    ResourceExistsCondition that checks whether a given resource exists.
    ResourcesMatchCompares resources for equality based on size and content.
    SocketCondition to wait for a TCP/IP socket to have a listener.
    TypeFoundlooks for a task or other Ant type that exists.
    XorThe Xor condition type to exclusive or operations.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-tree.html new file mode 100644 index 000000000..1ec9e3231 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/condition/package-tree.html @@ -0,0 +1,195 @@ + + + + + + +org.apache.tools.ant.taskdefs.condition Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.taskdefs.condition +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    +
      +
    • java.lang.Object
        +
      • org.apache.tools.ant.taskdefs.condition.Contains (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.types.EnumeratedAttribute +
      • org.apache.tools.ant.taskdefs.condition.Equals (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.taskdefs.condition.FilesMatch (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.taskdefs.condition.HasFreeSpace (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.taskdefs.condition.IsFailure (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.taskdefs.condition.Os (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
          +
        • org.apache.tools.ant.taskdefs.condition.ConditionBase
            +
          • org.apache.tools.ant.taskdefs.condition.And (implements org.apache.tools.ant.taskdefs.condition.Condition) +
          • org.apache.tools.ant.taskdefs.condition.Not (implements org.apache.tools.ant.taskdefs.condition.Condition) +
          • org.apache.tools.ant.taskdefs.condition.Or (implements org.apache.tools.ant.taskdefs.condition.Condition) +
          • org.apache.tools.ant.taskdefs.condition.Xor (implements org.apache.tools.ant.taskdefs.condition.Condition) +
          +
        • org.apache.tools.ant.types.DataType (implements java.lang.Cloneable) + +
        • org.apache.tools.ant.taskdefs.condition.HasMethod (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.Http (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsFalse (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsLastModified (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsReachable (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsReference (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsSet (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.IsTrue (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.Matches (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.ParserSupports (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.ResourceExists (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.taskdefs.condition.Socket (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        • org.apache.tools.ant.Task
            +
          • org.apache.tools.ant.taskdefs.condition.AntVersion (implements org.apache.tools.ant.taskdefs.condition.Condition) +
          +
        • org.apache.tools.ant.taskdefs.condition.TypeFound (implements org.apache.tools.ant.taskdefs.condition.Condition) +
        +
      • org.apache.tools.ant.taskdefs.condition.ResourceContains (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      • org.apache.tools.ant.taskdefs.condition.ResourcesMatch (implements org.apache.tools.ant.taskdefs.condition.Condition) +
      +
    +

    +Interface Hierarchy +

    +
      +
    • org.apache.tools.ant.taskdefs.condition.Condition
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CVSEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CVSEntry.html new file mode 100644 index 000000000..6ac754699 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CVSEntry.html @@ -0,0 +1,422 @@ + + + + + + +CVSEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class CVSEntry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.cvslib.CVSEntry
+
    +
    +
    +
    public class CVSEntry
    extends java.lang.Object
    + + +

    +CVS Entry. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    CVSEntry(java.util.Date date, + java.lang.String author, + java.lang.String comment) + +
    +          Creates a new instance of a CVSEntry
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddFile(java.lang.String file, + java.lang.String revision) + +
    +          Adds a file to the CVSEntry
    + voidaddFile(java.lang.String file, + java.lang.String revision, + java.lang.String previousRevision) + +
    +          Adds a file to the CVSEntry
    + java.lang.StringgetAuthor() + +
    +          Gets the author of the CVSEntry
    + java.lang.StringgetComment() + +
    +          Gets the comment for the CVSEntry
    + java.util.DategetDate() + +
    +          Gets the date of the CVSEntry
    + java.util.VectorgetFiles() + +
    +          Gets the files in this CVSEntry
    + voidsetAuthor(java.lang.String author) + +
    +          Sets the author of the CVSEntry
    + java.lang.StringtoString() + +
    +          Gets a String containing author, date, files and comment
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CVSEntry

    +
    +public CVSEntry(java.util.Date date,
+                java.lang.String author,
+                java.lang.String comment)
    +
    +
    Creates a new instance of a CVSEntry +

    +

    +
    Parameters:
    date - the date
    author - the author
    comment - a comment to be added to the revision
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addFile

    +
    +public void addFile(java.lang.String file,
+                    java.lang.String revision)
    +
    +
    Adds a file to the CVSEntry +

    +

    +
    Parameters:
    file - the file to add
    revision - the revision
    +
    +
    +
    + +

    +addFile

    +
    +public void addFile(java.lang.String file,
+                    java.lang.String revision,
+                    java.lang.String previousRevision)
    +
    +
    Adds a file to the CVSEntry +

    +

    +
    Parameters:
    file - the file to add
    revision - the revision
    previousRevision - the previous revision
    +
    +
    +
    + +

    +getDate

    +
    +public java.util.Date getDate()
    +
    +
    Gets the date of the CVSEntry +

    +

    + +
    Returns:
    the date
    +
    +
    +
    + +

    +setAuthor

    +
    +public void setAuthor(java.lang.String author)
    +
    +
    Sets the author of the CVSEntry +

    +

    +
    Parameters:
    author - the author
    +
    +
    +
    + +

    +getAuthor

    +
    +public java.lang.String getAuthor()
    +
    +
    Gets the author of the CVSEntry +

    +

    + +
    Returns:
    the author
    +
    +
    +
    + +

    +getComment

    +
    +public java.lang.String getComment()
    +
    +
    Gets the comment for the CVSEntry +

    +

    + +
    Returns:
    the comment
    +
    +
    +
    + +

    +getFiles

    +
    +public java.util.Vector getFiles()
    +
    +
    Gets the files in this CVSEntry +

    +

    + +
    Returns:
    the files
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Gets a String containing author, date, files and comment +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a string representation of this CVSEntry
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.html new file mode 100644 index 000000000..f224efcd7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogTask.html @@ -0,0 +1,621 @@ + + + + + + +ChangeLogTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class ChangeLogTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractCvsTask
+              extended by org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ChangeLogTask
    extends AbstractCvsTask
    + + +

    +Examines the output of cvs log and group related changes together. + + It produces an XML output representing the list of changes. + 

    + <!-- Root element -->
+ <!ELEMENT changelog 
+ (entry+)
+ >
+ <!-- CVS Entry -->
+ <!ELEMENT entry 
+ (date,author,file+,msg)
+ >
+ <!-- Date of cvs entry -->
+ <!ELEMENT date (#PCDATA)
+ >
+ <!-- Author of change -->
+ <!ELEMENT author (#PCDATA)
+ >
+ <!-- List of files affected -->
+ <!ELEMENT msg (#PCDATA)
+ >
+ <!-- File changed -->
+ <!ELEMENT file 
+ (name,revision,prevrevision?
+ )>
+ <!-- Name of the file -->
+ <!ELEMENT name (#PCDATA)
+ >
+ <!-- Revision number -->
+ <!ELEMENT revision 
+ (#PCDATA)>
+ <!-- Previous revision number -->
+ <!ELEMENT prevrevision 
+ (#PCDATA)>
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    AbstractCvsTask.Module
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    DEFAULT_COMPRESSION_LEVEL
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ChangeLogTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddFileset(FileSet fileSet) + +
    +          Adds a set of files about which cvs logs will be generated.
    + voidaddUser(CvsUser user) + +
    +          Add a user to list changelog knows about.
    + voidexecute() + +
    +          Execute task
    + voidsetDaysinpast(int days) + +
    +          Set the number of days worth of log entries to process.
    + voidsetDestfile(java.io.File destFile) + +
    +          Set the output file for the log.
    + voidsetDir(java.io.File inputDir) + +
    +          Set the base dir for cvs.
    + voidsetEnd(java.util.Date endDate) + +
    +          Set the date at which the changelog should stop.
    + voidsetEndTag(java.lang.String end) + +
    +          Set the tag at which the changelog should stop.
    + voidsetRemote(boolean remote) + +
    +          Whether to use rlog against a remote repository instead of log + in a working copy's directory.
    + voidsetStart(java.util.Date start) + +
    +          Set the date at which the changelog should start.
    + voidsetStartTag(java.lang.String start) + +
    +          Set the tag at which the changelog should start.
    + voidsetUsersfile(java.io.File usersFile) + +
    +          Set a lookup list of user names & addresses
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    addCommandArgument, addCommandArgument, addConfiguredCommandline, addConfiguredCommandline, addModule, configureCommandline, getCommand, getCvsRoot, getCvsRsh, getDest, getErrorStream, getExecuteStreamHandler, getModules, getOutputStream, getPackage, getPassFile, getPort, getTag, removeCommandline, runCommand, setAppend, setCommand, setCompression, setCompressionLevel, setCvsRoot, setCvsRsh, setDate, setDest, setError, setErrorStream, setExecuteStreamHandler, setFailOnError, setNoexec, setOutput, setOutputStream, setPackage, setPassfile, setPort, setQuiet, setReallyquiet, setTag
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ChangeLogTask

    +
    +public ChangeLogTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setDir

    +
    +public void setDir(java.io.File inputDir)
    +
    +
    Set the base dir for cvs. +

    +

    +
    Parameters:
    inputDir - The new dir value
    +
    +
    +
    + +

    +setDestfile

    +
    +public void setDestfile(java.io.File destFile)
    +
    +
    Set the output file for the log. +

    +

    +
    Parameters:
    destFile - The new destfile value
    +
    +
    +
    + +

    +setUsersfile

    +
    +public void setUsersfile(java.io.File usersFile)
    +
    +
    Set a lookup list of user names & addresses +

    +

    +
    Parameters:
    usersFile - The file containing the users info.
    +
    +
    +
    + +

    +addUser

    +
    +public void addUser(CvsUser user)
    +
    +
    Add a user to list changelog knows about. +

    +

    +
    Parameters:
    user - the user
    +
    +
    +
    + +

    +setStart

    +
    +public void setStart(java.util.Date start)
    +
    +
    Set the date at which the changelog should start. +

    +

    +
    Parameters:
    start - The date at which the changelog should start.
    +
    +
    +
    + +

    +setEnd

    +
    +public void setEnd(java.util.Date endDate)
    +
    +
    Set the date at which the changelog should stop. +

    +

    +
    Parameters:
    endDate - The date at which the changelog should stop.
    +
    +
    +
    + +

    +setDaysinpast

    +
    +public void setDaysinpast(int days)
    +
    +
    Set the number of days worth of log entries to process. +

    +

    +
    Parameters:
    days - the number of days of log to process.
    +
    +
    +
    + +

    +setRemote

    +
    +public void setRemote(boolean remote)
    +
    +
    Whether to use rlog against a remote repository instead of log + in a working copy's directory. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setStartTag

    +
    +public void setStartTag(java.lang.String start)
    +
    +
    Set the tag at which the changelog should start. +

    +

    +
    Parameters:
    start - The date at which the changelog should start.
    +
    +
    +
    + +

    +setEndTag

    +
    +public void setEndTag(java.lang.String end)
    +
    +
    Set the tag at which the changelog should stop. +

    +

    +
    Parameters:
    end - The date at which the changelog should stop.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet fileSet)
    +
    +
    Adds a set of files about which cvs logs will be generated. +

    +

    +
    Parameters:
    fileSet - a set of files about which cvs logs will be generated.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute task +

    +

    +
    Overrides:
    execute in class AbstractCvsTask
    +
    +
    + +
    Throws: +
    BuildException - if something goes wrong executing the + cvs command
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogWriter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogWriter.html new file mode 100644 index 000000000..f466b04d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/ChangeLogWriter.html @@ -0,0 +1,255 @@ + + + + + + +ChangeLogWriter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class ChangeLogWriter

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.cvslib.ChangeLogWriter
+
    +
    +
    +
    public class ChangeLogWriter
    extends java.lang.Object
    + + +

    +Class used to generate an XML changelog. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ChangeLogWriter() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidprintChangeLog(java.io.PrintWriter output, + CVSEntry[] entries) + +
    +          Print out the specified entries.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ChangeLogWriter

    +
    +public ChangeLogWriter()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +printChangeLog

    +
    +public void printChangeLog(java.io.PrintWriter output,
+                           CVSEntry[] entries)
    +
    +
    Print out the specified entries. +

    +

    +
    Parameters:
    output - writer to which to send output.
    entries - the entries to be written.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.html new file mode 100644 index 000000000..af2c48258 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagDiff.html @@ -0,0 +1,528 @@ + + + + + + +CvsTagDiff (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class CvsTagDiff

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractCvsTask
+              extended by org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class CvsTagDiff
    extends AbstractCvsTask
    + + +

    +Examines the output of cvs rdiff between two tags. + + It produces an XML output representing the list of changes. + 

    + <!-- Root element -->
+ <!ELEMENT tagdiff ( entry+ ) >
+ <!-- Start tag of the report -->
+ <!ATTLIST tagdiff startTag NMTOKEN #IMPLIED >
+ <!-- End tag of the report -->
+ <!ATTLIST tagdiff endTag NMTOKEN #IMPLIED >
+ <!-- Start date of the report -->
+ <!ATTLIST tagdiff startDate NMTOKEN #IMPLIED >
+ <!-- End date of the report -->
+ <!ATTLIST tagdiff endDate NMTOKEN #IMPLIED >
+
+ <!-- CVS tag entry -->
+ <!ELEMENT entry ( file ) >
+ <!-- File added, changed or removed -->
+ <!ELEMENT file ( name, revision?, prevrevision? ) >
+ <!-- Name of the file -->
+ <!ELEMENT name ( #PCDATA ) >
+ <!-- Revision number -->
+ <!ELEMENT revision ( #PCDATA ) >
+ <!-- Previous revision number -->
+ <!ELEMENT prevrevision ( #PCDATA ) >
+
    +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    AbstractCvsTask.Module
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    DEFAULT_COMPRESSION_LEVEL
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CvsTagDiff() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Execute task.
    + voidsetDestFile(java.io.File f) + +
    +          Set the output file for the diff.
    + voidsetEndDate(java.lang.String s) + +
    +          Set the end date.
    + voidsetEndTag(java.lang.String s) + +
    +          Set the end tag.
    + voidsetIgnoreRemoved(boolean b) + +
    +          Set the ignore removed indicator.
    + voidsetPackage(java.lang.String p) + +
    +          The package/module to analyze.
    + voidsetStartDate(java.lang.String s) + +
    +          Set the start date.
    + voidsetStartTag(java.lang.String s) + +
    +          Set the start tag.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    addCommandArgument, addCommandArgument, addConfiguredCommandline, addConfiguredCommandline, addModule, configureCommandline, getCommand, getCvsRoot, getCvsRsh, getDest, getErrorStream, getExecuteStreamHandler, getModules, getOutputStream, getPackage, getPassFile, getPort, getTag, removeCommandline, runCommand, setAppend, setCommand, setCompression, setCompressionLevel, setCvsRoot, setCvsRsh, setDate, setDest, setError, setErrorStream, setExecuteStreamHandler, setFailOnError, setNoexec, setOutput, setOutputStream, setPassfile, setPort, setQuiet, setReallyquiet, setTag
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CvsTagDiff

    +
    +public CvsTagDiff()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setPackage

    +
    +public void setPackage(java.lang.String p)
    +
    +
    The package/module to analyze. +

    +

    +
    Overrides:
    setPackage in class AbstractCvsTask
    +
    +
    +
    Parameters:
    p - the name of the package to analyse
    +
    +
    +
    + +

    +setStartTag

    +
    +public void setStartTag(java.lang.String s)
    +
    +
    Set the start tag. +

    +

    +
    Parameters:
    s - the start tag.
    +
    +
    +
    + +

    +setStartDate

    +
    +public void setStartDate(java.lang.String s)
    +
    +
    Set the start date. +

    +

    +
    Parameters:
    s - the start date.
    +
    +
    +
    + +

    +setEndTag

    +
    +public void setEndTag(java.lang.String s)
    +
    +
    Set the end tag. +

    +

    +
    Parameters:
    s - the end tag.
    +
    +
    +
    + +

    +setEndDate

    +
    +public void setEndDate(java.lang.String s)
    +
    +
    Set the end date. +

    +

    +
    Parameters:
    s - the end date.
    +
    +
    +
    + +

    +setDestFile

    +
    +public void setDestFile(java.io.File f)
    +
    +
    Set the output file for the diff. +

    +

    +
    Parameters:
    f - the output file for the diff.
    +
    +
    +
    + +

    +setIgnoreRemoved

    +
    +public void setIgnoreRemoved(boolean b)
    +
    +
    Set the ignore removed indicator. +

    +

    +
    Parameters:
    b - the ignore removed indicator.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute task. +

    +

    +
    Overrides:
    execute in class AbstractCvsTask
    +
    +
    + +
    Throws: +
    BuildException - if an error occurs
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagEntry.html new file mode 100644 index 000000000..7be952017 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsTagEntry.html @@ -0,0 +1,369 @@ + + + + + + +CvsTagEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class CvsTagEntry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.cvslib.CvsTagEntry
+
    +
    +
    +
    public class CvsTagEntry
    extends java.lang.Object
    + + +

    +Holds the information of a line of rdiff +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + +
    +Constructor Summary
    CvsTagEntry(java.lang.String filename) + +
    +          Creates a new CvsTagEntry
    CvsTagEntry(java.lang.String filename, + java.lang.String revision) + +
    +          Creates a new CvsTagEntry
    CvsTagEntry(java.lang.String filename, + java.lang.String revision, + java.lang.String prevRevision) + +
    +          Creates a new CvsTagEntry
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetFile() + +
    +          Gets the filename for this CvsTagEntry
    + java.lang.StringgetPreviousRevision() + +
    +          Gets the previous revision for this CvsTagEntry
    + java.lang.StringgetRevision() + +
    +          Gets the revision for this CvsTagEntry
    + java.lang.StringtoString() + +
    +          Gets a String containing filename and difference from previous version
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CvsTagEntry

    +
    +public CvsTagEntry(java.lang.String filename)
    +
    +
    Creates a new CvsTagEntry +

    +

    +
    Parameters:
    filename - the filename to add
    +
    +
    + +

    +CvsTagEntry

    +
    +public CvsTagEntry(java.lang.String filename,
+                   java.lang.String revision)
    +
    +
    Creates a new CvsTagEntry +

    +

    +
    Parameters:
    filename - the filename to add
    revision - the revision
    +
    +
    + +

    +CvsTagEntry

    +
    +public CvsTagEntry(java.lang.String filename,
+                   java.lang.String revision,
+                   java.lang.String prevRevision)
    +
    +
    Creates a new CvsTagEntry +

    +

    +
    Parameters:
    filename - the filename to add
    revision - the revision
    prevRevision - the previous revision
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getFile

    +
    +public java.lang.String getFile()
    +
    +
    Gets the filename for this CvsTagEntry +

    +

    + +
    Returns:
    the filename
    +
    +
    +
    + +

    +getRevision

    +
    +public java.lang.String getRevision()
    +
    +
    Gets the revision for this CvsTagEntry +

    +

    + +
    Returns:
    the revision
    +
    +
    +
    + +

    +getPreviousRevision

    +
    +public java.lang.String getPreviousRevision()
    +
    +
    Gets the previous revision for this CvsTagEntry +

    +

    + +
    Returns:
    the previous revision
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Gets a String containing filename and difference from previous version +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a string representation of this CVSTagEntry
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsUser.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsUser.html new file mode 100644 index 000000000..a2bb7f731 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsUser.html @@ -0,0 +1,343 @@ + + + + + + +CvsUser (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class CvsUser

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.cvslib.CvsUser
+
    +
    +
    +
    public class CvsUser
    extends java.lang.Object
    + + +

    +Represents a CVS user with a userID and a full name. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    CvsUser() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetDisplayname() + +
    +          Get the user's full name
    + java.lang.StringgetUserID() + +
    +          Get the user's id.
    + voidsetDisplayname(java.lang.String displayName) + +
    +          Set the user's fullname
    + voidsetUserid(java.lang.String userID) + +
    +          Set the user's id
    + voidvalidate() + +
    +          Validate that this object is configured.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CvsUser

    +
    +public CvsUser()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setDisplayname

    +
    +public void setDisplayname(java.lang.String displayName)
    +
    +
    Set the user's fullname +

    +

    +
    Parameters:
    displayName - the user's full name
    +
    +
    +
    + +

    +setUserid

    +
    +public void setUserid(java.lang.String userID)
    +
    +
    Set the user's id +

    +

    +
    Parameters:
    userID - the user's new id value.
    +
    +
    +
    + +

    +getUserID

    +
    +public java.lang.String getUserID()
    +
    +
    Get the user's id. +

    +

    + +
    Returns:
    The userID value
    +
    +
    +
    + +

    +getDisplayname

    +
    +public java.lang.String getDisplayname()
    +
    +
    Get the user's full name +

    +

    + +
    Returns:
    the user's full name
    +
    +
    +
    + +

    +validate

    +
    +public void validate()
+              throws BuildException
    +
    +
    Validate that this object is configured. +

    +

    + +
    Throws: +
    BuildException - if the instance has not be correctly + configured.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsVersion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsVersion.html new file mode 100644 index 000000000..243064a06 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/CvsVersion.html @@ -0,0 +1,467 @@ + + + + + + +CvsVersion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.cvslib +
    +Class CvsVersion

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AbstractCvsTask
+              extended by org.apache.tools.ant.taskdefs.cvslib.CvsVersion
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class CvsVersion
    extends AbstractCvsTask
    + + +

    +this task allows to find out the client and the server version of a + CVS installation + + example usage : + <cvsversion + cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + passfile="c:/programme/cygwin/home/antoine/.cvspass" + clientversionproperty="apacheclient" + serverversionproperty="apacheserver" /> + + the task can be used also in the API by calling its execute method, + then calling getServerVersion and/or getClientVersion +

    + +

    +

    +
    Since:
    +
    ant 1.6.1
    +
    +
    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    AbstractCvsTask.Module
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    DEFAULT_COMPRESSION_LEVEL
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    CvsVersion() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          the execute method running CvsVersion
    + java.lang.StringgetClientVersion() + +
    +          Get the CVS client version
    + java.lang.StringgetServerVersion() + +
    +          Get the CVS server version
    + voidsetClientVersionProperty(java.lang.String clientVersionProperty) + +
    +          Set a property where to store the CVS client version
    + voidsetServerVersionProperty(java.lang.String serverVersionProperty) + +
    +          Set a property where to store the CVS server version
    + booleansupportsCvsLogWithSOption() + +
    +          Find out if the server version supports log with S option
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.AbstractCvsTask
    addCommandArgument, addCommandArgument, addConfiguredCommandline, addConfiguredCommandline, addModule, configureCommandline, getCommand, getCvsRoot, getCvsRsh, getDest, getErrorStream, getExecuteStreamHandler, getModules, getOutputStream, getPackage, getPassFile, getPort, getTag, removeCommandline, runCommand, setAppend, setCommand, setCompression, setCompressionLevel, setCvsRoot, setCvsRsh, setDate, setDest, setError, setErrorStream, setExecuteStreamHandler, setFailOnError, setNoexec, setOutput, setOutputStream, setPackage, setPassfile, setPort, setQuiet, setReallyquiet, setTag
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CvsVersion

    +
    +public CvsVersion()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getClientVersion

    +
    +public java.lang.String getClientVersion()
    +
    +
    Get the CVS client version +

    +

    + +
    Returns:
    CVS client version
    +
    +
    +
    + +

    +getServerVersion

    +
    +public java.lang.String getServerVersion()
    +
    +
    Get the CVS server version +

    +

    + +
    Returns:
    CVS server version
    +
    +
    +
    + +

    +setClientVersionProperty

    +
    +public void setClientVersionProperty(java.lang.String clientVersionProperty)
    +
    +
    Set a property where to store the CVS client version +

    +

    +
    Parameters:
    clientVersionProperty - property for CVS client version
    +
    +
    +
    + +

    +setServerVersionProperty

    +
    +public void setServerVersionProperty(java.lang.String serverVersionProperty)
    +
    +
    Set a property where to store the CVS server version +

    +

    +
    Parameters:
    serverVersionProperty - property for CVS server version
    +
    +
    +
    + +

    +supportsCvsLogWithSOption

    +
    +public boolean supportsCvsLogWithSOption()
    +
    +
    Find out if the server version supports log with S option +

    +

    + +
    Returns:
    boolean indicating if the server version supports log with S option
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    the execute method running CvsVersion +

    +

    +
    Overrides:
    execute in class AbstractCvsTask
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-frame.html new file mode 100644 index 000000000..215b4f58d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +org.apache.tools.ant.taskdefs.cvslib (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.cvslib + + + + +
    +Classes  + +
    +ChangeLogTask +
    +ChangeLogWriter +
    +CVSEntry +
    +CvsTagDiff +
    +CvsTagEntry +
    +CvsUser +
    +CvsVersion
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-summary.html new file mode 100644 index 000000000..ab58c65d5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +org.apache.tools.ant.taskdefs.cvslib (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.taskdefs.cvslib +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    ChangeLogTaskExamines the output of cvs log and group related changes together.
    ChangeLogWriterClass used to generate an XML changelog.
    CVSEntryCVS Entry.
    CvsTagDiffExamines the output of cvs rdiff between two tags.
    CvsTagEntryHolds the information of a line of rdiff
    CvsUserRepresents a CVS user with a userID and a full name.
    CvsVersionthis task allows to find out the client and the server version of a + CVS installation + + example usage : + <cvsversion + cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" + passfile="c:/programme/cygwin/home/antoine/.cvspass" + clientversionproperty="apacheclient" + serverversionproperty="apacheserver" /> + + the task can be used also in the API by calling its execute method, + then calling getServerVersion and/or getClientVersion
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-tree.html new file mode 100644 index 000000000..6ffacc8d9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/cvslib/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +org.apache.tools.ant.taskdefs.cvslib Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.taskdefs.cvslib +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailAddress.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailAddress.html new file mode 100644 index 000000000..5dac3734d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailAddress.html @@ -0,0 +1,374 @@ + + + + + + +EmailAddress (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class EmailAddress

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.email.EmailAddress
+
    +
    +
    +
    public class EmailAddress
    extends java.lang.Object
    + + +

    +Holds an email address. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    EmailAddress() + +
    +          Creates an empty email address
    EmailAddress(java.lang.String email) + +
    +          Creates a new email address based on the given string
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetAddress() + +
    +          Returns the address
    + java.lang.StringgetName() + +
    +          Returns the display name
    + voidsetAddress(java.lang.String address) + +
    +          Sets the email address
    + voidsetName(java.lang.String name) + +
    +          Sets the personal / display name of the address
    + java.lang.StringtoString() + +
    +          Constructs a string "name <address>" or "address"
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EmailAddress

    +
    +public EmailAddress()
    +
    +
    Creates an empty email address +

    +

    +
    + +

    +EmailAddress

    +
    +public EmailAddress(java.lang.String email)
    +
    +
    Creates a new email address based on the given string +

    +

    +
    Parameters:
    email - the email address (with or without <>) + Acceptable forms include: + address +
    + name
    +
    name + (name) address + address (name)
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Sets the personal / display name of the address +

    +

    +
    Parameters:
    name - the display name
    +
    +
    +
    + +

    +setAddress

    +
    +public void setAddress(java.lang.String address)
    +
    +
    Sets the email address +

    +

    +
    Parameters:
    address - the actual email address (without <>)
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    Constructs a string "name <address>" or "address" +

    +

    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    + +
    Returns:
    a string representation of the address
    +
    +
    +
    + +

    +getAddress

    +
    +public java.lang.String getAddress()
    +
    +
    Returns the address +

    +

    + +
    Returns:
    the address part
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Returns the display name +

    +

    + +
    Returns:
    the display name part
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html new file mode 100644 index 000000000..f975bc788 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.Encoding.html @@ -0,0 +1,288 @@ + + + + + + +EmailTask.Encoding (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class EmailTask.Encoding

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.email.EmailTask.Encoding
+
    +
    +
    Enclosing class:
    EmailTask
    +
    +
    +
    +
    public static class EmailTask.Encoding
    extends EnumeratedAttribute
    + + +

    +Enumerates the encoding constants. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    EmailTask.Encoding() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          finds the valid encoding values
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EmailTask.Encoding

    +
    +public EmailTask.Encoding()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    finds the valid encoding values +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    a list of valid entries
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.html new file mode 100644 index 000000000..d1557151b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/EmailTask.html @@ -0,0 +1,1132 @@ + + + + + + +EmailTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class EmailTask

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.email.EmailTask
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    Direct Known Subclasses:
    MimeMail, SendEmail
    +
    +
    +
    +
    public class EmailTask
    extends Task
    + + +

    +A task to send SMTP email. This is a refactoring of the SendMail and + MimeMail tasks such that both are within a single task. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classEmailTask.Encoding + +
    +          Enumerates the encoding constants.
    +  + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static java.lang.StringAUTO + +
    +          Constant to show that the best available mailer should be used.
    +static java.lang.StringMIME + +
    +          Constant to allow the Mime mailer to be requested
    +static java.lang.StringPLAIN + +
    +          Constant to allow the plaintext mailer to be requested
    +static java.lang.StringUU + +
    +          Constant to allow the UU mailer to be requested
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    EmailTask() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddBcc(EmailAddress address) + +
    +          Add a "bcc" address element.
    + voidaddCc(EmailAddress address) + +
    +          Add a "cc" address element.
    + voidaddFileset(FileSet fs) + +
    +          Add a set of files (nested fileset attribute).
    + voidaddFrom(EmailAddress address) + +
    +          Add a from address element.
    + voidaddMessage(Message message) + +
    +          Add a message element.
    + voidaddReplyTo(EmailAddress address) + +
    +          Add a replyto address element.
    + voidaddTo(EmailAddress address) + +
    +          Add a to address element.
    + PathcreateAttachments() + +
    +          Creates a Path as container for attachments.
    + HeadercreateHeader() + +
    +          Create a nested header element.
    + voidexecute() + +
    +          Send an email.
    + java.lang.StringgetCharset() + +
    +          Returns the character set of mail message.
    + booleangetIncludeFileNames() + +
    +          Get whether file names should be included.
    + voidsetBccList(java.lang.String list) + +
    +          Shorthand to set the "bcc" address element.
    + voidsetCcList(java.lang.String list) + +
    +          Shorthand to set the "cc" address element.
    + voidsetCharset(java.lang.String charset) + +
    +          Sets the character set of mail message.
    + voidsetEnableStartTLS(boolean b) + +
    +          Set whether to allow authentication to switch to a TLS + connection via STARTTLS.
    + voidsetEncoding(EmailTask.Encoding encoding) + +
    +          Set the preferred encoding method.
    + voidsetFailOnError(boolean failOnError) + +
    +          Set whether BuildExceptions should be passed back to the core.
    + voidsetFiles(java.lang.String filenames) + +
    +          Set the list of files to be attached.
    + voidsetFrom(java.lang.String address) + +
    +          Shorthand to set the from address element.
    + voidsetIgnoreInvalidRecipients(boolean b) + +
    +          Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail.
    + voidsetIncludefilenames(boolean includeFileNames) + +
    +          Set whether to include filenames.
    + voidsetMailhost(java.lang.String host) + +
    +          Set the host.
    + voidsetMailport(int port) + +
    +          Set the mail server port.
    + voidsetMessage(java.lang.String message) + +
    +          Shorthand method to set the message.
    + voidsetMessageFile(java.io.File file) + +
    +          Shorthand method to set the message from a file.
    + voidsetMessageMimeType(java.lang.String type) + +
    +          Shorthand method to set type of the text message, text/plain by default + but text/html or text/xml is quite feasible.
    + voidsetPassword(java.lang.String password) + +
    +          Set the password for SMTP auth; this requires JavaMail.
    + voidsetReplyTo(java.lang.String address) + +
    +          Shorthand to set the replyto address element.
    + voidsetSSL(boolean ssl) + +
    +          Set whether to send data over SSL.
    + voidsetSubject(java.lang.String subject) + +
    +          Set the subject line of the email.
    + voidsetToList(java.lang.String list) + +
    +          Shorthand to set the "to" address element.
    + voidsetUser(java.lang.String user) + +
    +          Set the user for SMTP auth; this requires JavaMail.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +AUTO

    +
    +public static final java.lang.String AUTO
    +
    +
    Constant to show that the best available mailer should be used. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +MIME

    +
    +public static final java.lang.String MIME
    +
    +
    Constant to allow the Mime mailer to be requested +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +UU

    +
    +public static final java.lang.String UU
    +
    +
    Constant to allow the UU mailer to be requested +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PLAIN

    +
    +public static final java.lang.String PLAIN
    +
    +
    Constant to allow the plaintext mailer to be requested +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +EmailTask

    +
    +public EmailTask()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setUser

    +
    +public void setUser(java.lang.String user)
    +
    +
    Set the user for SMTP auth; this requires JavaMail. +

    +

    +
    Parameters:
    user - the String username.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setPassword

    +
    +public void setPassword(java.lang.String password)
    +
    +
    Set the password for SMTP auth; this requires JavaMail. +

    +

    +
    Parameters:
    password - the String password.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setSSL

    +
    +public void setSSL(boolean ssl)
    +
    +
    Set whether to send data over SSL. +

    +

    +
    Parameters:
    ssl - boolean; if true SSL will be used.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setEnableStartTLS

    +
    +public void setEnableStartTLS(boolean b)
    +
    +
    Set whether to allow authentication to switch to a TLS + connection via STARTTLS. +

    +

    +
    Parameters:
    b - boolean; if true STARTTLS will be supported.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(EmailTask.Encoding encoding)
    +
    +
    Set the preferred encoding method. +

    +

    +
    Parameters:
    encoding - The encoding (one of AUTO, MIME, UU, PLAIN).
    +
    +
    +
    + +

    +setMailport

    +
    +public void setMailport(int port)
    +
    +
    Set the mail server port. +

    +

    +
    Parameters:
    port - The port to use.
    +
    +
    +
    + +

    +setMailhost

    +
    +public void setMailhost(java.lang.String host)
    +
    +
    Set the host. +

    +

    +
    Parameters:
    host - The host to connect to.
    +
    +
    +
    + +

    +setSubject

    +
    +public void setSubject(java.lang.String subject)
    +
    +
    Set the subject line of the email. +

    +

    +
    Parameters:
    subject - Subject of this email.
    +
    +
    +
    + +

    +setMessage

    +
    +public void setMessage(java.lang.String message)
    +
    +
    Shorthand method to set the message. +

    +

    +
    Parameters:
    message - Message body of this email.
    +
    +
    +
    + +

    +setMessageFile

    +
    +public void setMessageFile(java.io.File file)
    +
    +
    Shorthand method to set the message from a file. +

    +

    +
    Parameters:
    file - The file from which to take the message.
    +
    +
    +
    + +

    +setMessageMimeType

    +
    +public void setMessageMimeType(java.lang.String type)
    +
    +
    Shorthand method to set type of the text message, text/plain by default + but text/html or text/xml is quite feasible. +

    +

    +
    Parameters:
    type - The new MessageMimeType value.
    +
    +
    +
    + +

    +addMessage

    +
    +public void addMessage(Message message)
+                throws BuildException
    +
    +
    Add a message element. +

    +

    +
    Parameters:
    message - The message object. +
    Throws: +
    BuildException - if a message has already been added.
    +
    +
    +
    + +

    +addFrom

    +
    +public void addFrom(EmailAddress address)
    +
    +
    Add a from address element. +

    +

    +
    Parameters:
    address - The address to send from.
    +
    +
    +
    + +

    +setFrom

    +
    +public void setFrom(java.lang.String address)
    +
    +
    Shorthand to set the from address element. +

    +

    +
    Parameters:
    address - The address to send mail from.
    +
    +
    +
    + +

    +addReplyTo

    +
    +public void addReplyTo(EmailAddress address)
    +
    +
    Add a replyto address element. +

    +

    +
    Parameters:
    address - The address to reply to.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setReplyTo

    +
    +public void setReplyTo(java.lang.String address)
    +
    +
    Shorthand to set the replyto address element. +

    +

    +
    Parameters:
    address - The address to which replies should be directed.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +addTo

    +
    +public void addTo(EmailAddress address)
    +
    +
    Add a to address element. +

    +

    +
    Parameters:
    address - An email address.
    +
    +
    +
    + +

    +setToList

    +
    +public void setToList(java.lang.String list)
    +
    +
    Shorthand to set the "to" address element. +

    +

    +
    Parameters:
    list - Comma-separated list of addresses.
    +
    +
    +
    + +

    +addCc

    +
    +public void addCc(EmailAddress address)
    +
    +
    Add a "cc" address element. +

    +

    +
    Parameters:
    address - The email address.
    +
    +
    +
    + +

    +setCcList

    +
    +public void setCcList(java.lang.String list)
    +
    +
    Shorthand to set the "cc" address element. +

    +

    +
    Parameters:
    list - Comma separated list of addresses.
    +
    +
    +
    + +

    +addBcc

    +
    +public void addBcc(EmailAddress address)
    +
    +
    Add a "bcc" address element. +

    +

    +
    Parameters:
    address - The email address.
    +
    +
    +
    + +

    +setBccList

    +
    +public void setBccList(java.lang.String list)
    +
    +
    Shorthand to set the "bcc" address element. +

    +

    +
    Parameters:
    list - comma separated list of addresses.
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failOnError)
    +
    +
    Set whether BuildExceptions should be passed back to the core. +

    +

    +
    Parameters:
    failOnError - The new FailOnError value.
    +
    +
    +
    + +

    +setFiles

    +
    +public void setFiles(java.lang.String filenames)
    +
    +
    Set the list of files to be attached. +

    +

    +
    Parameters:
    filenames - Comma-separated list of files.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet fs)
    +
    +
    Add a set of files (nested fileset attribute). +

    +

    +
    Parameters:
    fs - The fileset.
    +
    +
    +
    + +

    +createAttachments

    +
    +public Path createAttachments()
    +
    +
    Creates a Path as container for attachments. Supports any + filesystem resource-collections that way. +

    +

    + +
    Returns:
    the path to be configured.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +createHeader

    +
    +public Header createHeader()
    +
    +
    Create a nested header element. +

    +

    + +
    Returns:
    a Header instance.
    +
    +
    +
    + +

    +setIncludefilenames

    +
    +public void setIncludefilenames(boolean includeFileNames)
    +
    +
    Set whether to include filenames. +

    +

    +
    Parameters:
    includeFileNames - Whether to include filenames in the text of the + message.
    +
    +
    +
    + +

    +getIncludeFileNames

    +
    +public boolean getIncludeFileNames()
    +
    +
    Get whether file names should be included. +

    +

    + +
    Returns:
    Identifies whether file names should be included.
    +
    +
    +
    + +

    +setIgnoreInvalidRecipients

    +
    +public void setIgnoreInvalidRecipients(boolean b)
    +
    +
    Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail. + +

    Even with this property set to true the task will still fail + if the mail couldn't be sent to any recipient at all.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
    +
    +
    Send an email. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    +
    +
    +
    +
    + +

    +setCharset

    +
    +public void setCharset(java.lang.String charset)
    +
    +
    Sets the character set of mail message. + Will be ignored if mimeType contains ....; Charset=... substring or + encoding is not a mime. +

    +

    +
    Parameters:
    charset - the character encoding to use.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getCharset

    +
    +public java.lang.String getCharset()
    +
    +
    Returns the character set of mail message. +

    +

    + +
    Returns:
    Charset of mail message.
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Header.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Header.html new file mode 100644 index 000000000..d7604fac5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Header.html @@ -0,0 +1,322 @@ + + + + + + +Header (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class Header

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.email.Header
+
    +
    +
    +
    public class Header
    extends java.lang.Object
    + + +

    +Class representing a generic e-mail header. +

    + +

    +

    +
    Since:
    +
    Ant 1.7
    +
    +
    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Header() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the name of this Header.
    + java.lang.StringgetValue() + +
    +          Get the value of this Header.
    + voidsetName(java.lang.String name) + +
    +          Set the name of this Header.
    + voidsetValue(java.lang.String value) + +
    +          Set the value of this Header.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Header

    +
    +public Header()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name of this Header. +

    +

    +
    Parameters:
    name - the name to set.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name of this Header. +

    +

    + +
    Returns:
    name as String.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Set the value of this Header. +

    +

    +
    Parameters:
    value - the value to set.
    +
    +
    +
    + +

    +getValue

    +
    +public java.lang.String getValue()
    +
    +
    Get the value of this Header. +

    +

    + +
    Returns:
    value as String.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Mailer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Mailer.html new file mode 100644 index 000000000..d74cfb3b3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Mailer.html @@ -0,0 +1,1082 @@ + + + + + + +Mailer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class Mailer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.email.Mailer
+
    +
    +
    Direct Known Subclasses:
    MimeMailer
    +
    +
    +
    +
    public abstract class Mailer
    extends java.lang.Object
    + + +

    +Base class for the various emailing implementations. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected  java.util.VectorbccList + +
    +           
    +protected  java.util.VectorccList + +
    +           
    +protected  java.util.Vectorfiles + +
    +           
    +protected  EmailAddressfrom + +
    +           
    +protected  java.util.Vectorheaders + +
    +           
    +protected  java.lang.Stringhost + +
    +           
    +protected  booleanincludeFileNames + +
    +           
    +protected  Messagemessage + +
    +           
    +protected  java.lang.Stringpassword + +
    +           
    +protected  intport + +
    +           
    +protected  java.util.VectorreplyToList + +
    +           
    +protected  booleanSSL + +
    +           
    +protected  java.lang.Stringsubject + +
    +           
    +protected  Tasktask + +
    +           
    +protected  java.util.VectortoList + +
    +           
    +protected  java.lang.Stringuser + +
    +           
    +  + + + + + + + + + + +
    +Constructor Summary
    Mailer() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  java.lang.StringgetDate() + +
    +          Return the current Date in a format suitable for a SMTP date + header.
    +protected  booleanisPortExplicitlySpecified() + +
    +          Whether the port has been explicitly specified by the user.
    +protected  booleanisStartTLSEnabled() + +
    +           
    +abstract  voidsend() + +
    +          Send the email.
    + voidsetBccList(java.util.Vector list) + +
    +          Set the bcc addresses.
    + voidsetCcList(java.util.Vector list) + +
    +          Set the cc addresses.
    + voidsetEnableStartTLS(boolean b) + +
    +          Set whether to allow authentication to switch to a TLS + connection via STARTTLS.
    + voidsetFiles(java.util.Vector files) + +
    +          Set the files to attach.
    + voidsetFrom(EmailAddress from) + +
    +          Set the address to send from.
    + voidsetHeaders(java.util.Vector v) + +
    +          Set the generic headers to add to the email.
    + voidsetHost(java.lang.String host) + +
    +          Set the mail server.
    + voidsetIgnoreInvalidRecipients(boolean b) + +
    +          Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail.
    + voidsetIncludeFileNames(boolean b) + +
    +          Indicate whether filenames should be listed in the body.
    + voidsetMessage(Message m) + +
    +          Set the message.
    + voidsetPassword(java.lang.String password) + +
    +          Set the password for smtp auth.
    + voidsetPort(int port) + +
    +          Set the smtp port.
    + voidsetPortExplicitlySpecified(boolean explicit) + +
    +          Whether the port has been explicitly specified by the user.
    + voidsetReplyToList(java.util.Vector list) + +
    +          Set the replyto addresses.
    + voidsetSSL(boolean ssl) + +
    +          Set whether to send the mail through SSL.
    + voidsetSubject(java.lang.String subject) + +
    +          Set the subject.
    + voidsetTask(Task task) + +
    +          Set the owning task.
    + voidsetToList(java.util.Vector list) + +
    +          Set the to addresses.
    + voidsetUser(java.lang.String user) + +
    +          Set the user for smtp auth.
    +protected  booleanshouldIgnoreInvalidRecipients() + +
    +          Whether invalid recipients should be ignored.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +host

    +
    +protected java.lang.String host
    +
    +
    +
    +
    +
    + +

    +port

    +
    +protected int port
    +
    +
    +
    +
    +
    + +

    +user

    +
    +protected java.lang.String user
    +
    +
    +
    +
    +
    + +

    +password

    +
    +protected java.lang.String password
    +
    +
    +
    +
    +
    + +

    +SSL

    +
    +protected boolean SSL
    +
    +
    +
    +
    +
    + +

    +message

    +
    +protected Message message
    +
    +
    +
    +
    +
    + +

    +from

    +
    +protected EmailAddress from
    +
    +
    +
    +
    +
    + +

    +replyToList

    +
    +protected java.util.Vector replyToList
    +
    +
    +
    +
    +
    + +

    +toList

    +
    +protected java.util.Vector toList
    +
    +
    +
    +
    +
    + +

    +ccList

    +
    +protected java.util.Vector ccList
    +
    +
    +
    +
    +
    + +

    +bccList

    +
    +protected java.util.Vector bccList
    +
    +
    +
    +
    +
    + +

    +files

    +
    +protected java.util.Vector files
    +
    +
    +
    +
    +
    + +

    +subject

    +
    +protected java.lang.String subject
    +
    +
    +
    +
    +
    + +

    +task

    +
    +protected Task task
    +
    +
    +
    +
    +
    + +

    +includeFileNames

    +
    +protected boolean includeFileNames
    +
    +
    +
    +
    +
    + +

    +headers

    +
    +protected java.util.Vector headers
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Mailer

    +
    +public Mailer()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setHost

    +
    +public void setHost(java.lang.String host)
    +
    +
    Set the mail server. +

    +

    +
    Parameters:
    host - the mail server name.
    +
    +
    +
    + +

    +setPort

    +
    +public void setPort(int port)
    +
    +
    Set the smtp port. +

    +

    +
    Parameters:
    port - the SMTP port.
    +
    +
    +
    + +

    +setPortExplicitlySpecified

    +
    +public void setPortExplicitlySpecified(boolean explicit)
    +
    +
    Whether the port has been explicitly specified by the user. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +isPortExplicitlySpecified

    +
    +protected boolean isPortExplicitlySpecified()
    +
    +
    Whether the port has been explicitly specified by the user. +

    +

    +
    Since:
    +
    Ant 1.8.2
    +
    +
    +
    +
    + +

    +setUser

    +
    +public void setUser(java.lang.String user)
    +
    +
    Set the user for smtp auth. +

    +

    +
    Parameters:
    user - the username.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setPassword

    +
    +public void setPassword(java.lang.String password)
    +
    +
    Set the password for smtp auth. +

    +

    +
    Parameters:
    password - the authentication password.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setSSL

    +
    +public void setSSL(boolean ssl)
    +
    +
    Set whether to send the mail through SSL. +

    +

    +
    Parameters:
    ssl - if true use SSL transport.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setEnableStartTLS

    +
    +public void setEnableStartTLS(boolean b)
    +
    +
    Set whether to allow authentication to switch to a TLS + connection via STARTTLS. +

    +

    +
    Parameters:
    b - boolean; if true STARTTLS will be supported.
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +isStartTLSEnabled

    +
    +protected boolean isStartTLSEnabled()
    +
    +
    +
    +
    +
    +
    + +

    +setMessage

    +
    +public void setMessage(Message m)
    +
    +
    Set the message. +

    +

    +
    Parameters:
    m - the message content.
    +
    +
    +
    + +

    +setFrom

    +
    +public void setFrom(EmailAddress from)
    +
    +
    Set the address to send from. +

    +

    +
    Parameters:
    from - the sender.
    +
    +
    +
    + +

    +setReplyToList

    +
    +public void setReplyToList(java.util.Vector list)
    +
    +
    Set the replyto addresses. +

    +

    +
    Parameters:
    list - a vector of reployTo addresses.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setToList

    +
    +public void setToList(java.util.Vector list)
    +
    +
    Set the to addresses. +

    +

    +
    Parameters:
    list - a vector of recipient addresses.
    +
    +
    +
    + +

    +setCcList

    +
    +public void setCcList(java.util.Vector list)
    +
    +
    Set the cc addresses. +

    +

    +
    Parameters:
    list - a vector of cc addresses.
    +
    +
    +
    + +

    +setBccList

    +
    +public void setBccList(java.util.Vector list)
    +
    +
    Set the bcc addresses. +

    +

    +
    Parameters:
    list - a vector of the bcc addresses.
    +
    +
    +
    + +

    +setFiles

    +
    +public void setFiles(java.util.Vector files)
    +
    +
    Set the files to attach. +

    +

    +
    Parameters:
    files - list of files to attach to the email.
    +
    +
    +
    + +

    +setSubject

    +
    +public void setSubject(java.lang.String subject)
    +
    +
    Set the subject. +

    +

    +
    Parameters:
    subject - the subject line.
    +
    +
    +
    + +

    +setTask

    +
    +public void setTask(Task task)
    +
    +
    Set the owning task. +

    +

    +
    Parameters:
    task - the owning task instance.
    +
    +
    +
    + +

    +setIncludeFileNames

    +
    +public void setIncludeFileNames(boolean b)
    +
    +
    Indicate whether filenames should be listed in the body. +

    +

    +
    Parameters:
    b - if true list attached file names in the body content.
    +
    +
    +
    + +

    +setHeaders

    +
    +public void setHeaders(java.util.Vector v)
    +
    +
    Set the generic headers to add to the email. +

    +

    +
    Parameters:
    v - a Vector presumed to contain Header objects.
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +send

    +
    +public abstract void send()
+                   throws BuildException
    +
    +
    Send the email. +

    +

    + +
    Throws: +
    BuildException - if the email can't be sent.
    +
    +
    +
    + +

    +setIgnoreInvalidRecipients

    +
    +public void setIgnoreInvalidRecipients(boolean b)
    +
    +
    Whether invalid recipients should be ignored (but a warning + will be logged) instead of making the task fail. + +

    Even with this property set to true the task will still fail + if the mail couldn't be sent to any recipient at all.

    +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +shouldIgnoreInvalidRecipients

    +
    +protected boolean shouldIgnoreInvalidRecipients()
    +
    +
    Whether invalid recipients should be ignored. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +getDate

    +
    +protected final java.lang.String getDate()
    +
    +
    Return the current Date in a format suitable for a SMTP date + header. +

    +

    + +
    Returns:
    the current date in SMTP suitable format.
    Since:
    +
    Ant 1.5
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Message.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Message.html new file mode 100644 index 000000000..862cfcf86 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/Message.html @@ -0,0 +1,484 @@ + + + + + + +Message (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class Message

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.email.Message
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Message
    extends ProjectComponent
    + + +

    +Class representing an email message. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    Message() + +
    +          Creates a new empty message
    Message(java.io.File file) + +
    +          Creates a new message using the contents of the given file.
    Message(java.lang.String text) + +
    +          Creates a new message based on the given string
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddText(java.lang.String text) + +
    +          Adds a textual part of the message
    + java.lang.StringgetCharset() + +
    +          Returns the charset of mail message.
    + java.lang.StringgetMimeType() + +
    +          Returns the content type
    + booleanisMimeTypeSpecified() + +
    +          Returns true if the mimeType has been set.
    + voidprint(java.io.PrintStream ps) + +
    +          Prints the message onto an output stream
    + voidsetCharset(java.lang.String charset) + +
    +          Sets the character set of mail message.
    + voidsetMimeType(java.lang.String mimeType) + +
    +          Sets the content type for the message
    + voidsetSrc(java.io.File src) + +
    +          Sets the source file of the message
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Message

    +
    +public Message()
    +
    +
    Creates a new empty message +

    +

    +
    + +

    +Message

    +
    +public Message(java.lang.String text)
    +
    +
    Creates a new message based on the given string +

    +

    +
    Parameters:
    text - the message
    +
    +
    + +

    +Message

    +
    +public Message(java.io.File file)
    +
    +
    Creates a new message using the contents of the given file. +

    +

    +
    Parameters:
    file - the source of the message
    +
    + + + + + + + + +
    +Method Detail
    + +

    +addText

    +
    +public void addText(java.lang.String text)
    +
    +
    Adds a textual part of the message +

    +

    +
    Parameters:
    text - some text to add
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File src)
    +
    +
    Sets the source file of the message +

    +

    +
    Parameters:
    src - the source of the message
    +
    +
    +
    + +

    +setMimeType

    +
    +public void setMimeType(java.lang.String mimeType)
    +
    +
    Sets the content type for the message +

    +

    +
    Parameters:
    mimeType - a mime type e.g. "text/plain"
    +
    +
    +
    + +

    +getMimeType

    +
    +public java.lang.String getMimeType()
    +
    +
    Returns the content type +

    +

    + +
    Returns:
    the mime type
    +
    +
    +
    + +

    +print

    +
    +public void print(java.io.PrintStream ps)
+           throws java.io.IOException
    +
    +
    Prints the message onto an output stream +

    +

    +
    Parameters:
    ps - The print stream to write to +
    Throws: +
    java.io.IOException - if an error occurs
    +
    +
    +
    + +

    +isMimeTypeSpecified

    +
    +public boolean isMimeTypeSpecified()
    +
    +
    Returns true if the mimeType has been set. +

    +

    + +
    Returns:
    false if the default value is in use
    +
    +
    +
    + +

    +setCharset

    +
    +public void setCharset(java.lang.String charset)
    +
    +
    Sets the character set of mail message. + Will be ignored if mimeType contains ....; Charset=... substring. +

    +

    +
    Parameters:
    charset - the character set name.
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +getCharset

    +
    +public java.lang.String getCharset()
    +
    +
    Returns the charset of mail message. +

    +

    + +
    Returns:
    Charset of mail message.
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/MimeMailer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/MimeMailer.html new file mode 100644 index 000000000..00a025263 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/MimeMailer.html @@ -0,0 +1,290 @@ + + + + + + +MimeMailer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.email +
    +Class MimeMailer

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.email.Mailer
+      extended by org.apache.tools.ant.taskdefs.email.MimeMailer
+
    +
    +
    +
    public class MimeMailer
    extends Mailer
    + + +

    +Uses the JavaMail classes to send Mime format email. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.email.Mailer
    bccList, ccList, files, from, headers, host, includeFileNames, message, password, port, replyToList, SSL, subject, task, toList, user
    +  + + + + + + + + + + +
    +Constructor Summary
    MimeMailer() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + voidsend() + +
    +          Send the email.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.email.Mailer
    getDate, isPortExplicitlySpecified, isStartTLSEnabled, setBccList, setCcList, setEnableStartTLS, setFiles, setFrom, setHeaders, setHost, setIgnoreInvalidRecipients, setIncludeFileNames, setMessage, setPassword, setPort, setPortExplicitlySpecified, setReplyToList, setSSL, setSubject, setTask, setToList, setUser, shouldIgnoreInvalidRecipients
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +MimeMailer

    +
    +public MimeMailer()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +send

    +
    +public void send()
    +
    +
    Send the email. +

    +

    +
    Specified by:
    send in class Mailer
    +
    +
    + +
    Throws: +
    BuildException - if the email can't be sent.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-frame.html new file mode 100644 index 000000000..a3aa13fe9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +org.apache.tools.ant.taskdefs.email (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.email + + + + +
    +Classes  + +
    +EmailAddress +
    +EmailTask +
    +EmailTask.Encoding +
    +Header +
    +Mailer +
    +Message +
    +MimeMailer
    + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-summary.html new file mode 100644 index 000000000..075e1040a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-summary.html @@ -0,0 +1,176 @@ + + + + + + +org.apache.tools.ant.taskdefs.email (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.tools.ant.taskdefs.email +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    EmailAddressHolds an email address.
    EmailTaskA task to send SMTP email.
    EmailTask.EncodingEnumerates the encoding constants.
    HeaderClass representing a generic e-mail header.
    MailerBase class for the various emailing implementations.
    MessageClass representing an email message.
    MimeMailerUses the JavaMail classes to send Mime format email.
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-tree.html new file mode 100644 index 000000000..6a39005e9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/email/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.taskdefs.email Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.tools.ant.taskdefs.email +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ANTLR.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ANTLR.html new file mode 100644 index 000000000..25483d816 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ANTLR.html @@ -0,0 +1,714 @@ + + + + + + +ANTLR (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class ANTLR

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ANTLR
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class ANTLR
    extends Task
    + + +

    +Invokes the ANTLR Translator generator on a grammar file. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    ANTLR() + +
    +          Constructor for ANTLR task.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidaddClasspathEntry(java.lang.String resource) + +
    +          Search for the given resource and add the directory or archive + that contains it to the classpath.
    + PathcreateClasspath() + +
    +          Adds a classpath to be set + because a directory might be given for Antlr debug.
    + Commandline.ArgumentcreateJvmarg() + +
    +          Adds a new JVM argument.
    + voidexecute() + +
    +          Execute the task.
    + voidinit() + +
    +          Adds the jars or directories containing Antlr + this should make the forked JVM work without having to + specify it directly.
    +protected  booleanis272() + +
    +          Whether the antlr version is 2.7.2 (or higher).
    + voidsetDebug(boolean enable) + +
    +          Sets a flag to enable ParseView debugging
    + voidsetDiagnostic(boolean enable) + +
    +          Sets a flag to emit diagnostic text
    + voidsetDir(java.io.File d) + +
    +          The working directory of the process
    + voidsetFork(boolean s) + +
    +           
    + voidsetGlib(java.io.File superGrammar) + +
    +          Sets an optional super grammar file
    + voidsetGlib(java.lang.String superGrammar) + +
    +          Deprecated. since ant 1.6
    + voidsetHtml(boolean enable) + +
    +          If true, emit html
    + voidsetOutputdirectory(java.io.File outputDirectory) + +
    +          The directory to write the generated files to.
    + voidsetTarget(java.io.File target) + +
    +          The grammar file to process.
    + voidsetTrace(boolean enable) + +
    +          If true, enables all tracing.
    + voidsetTraceLexer(boolean enable) + +
    +          If true, enables lexer tracing.
    + voidsetTraceParser(boolean enable) + +
    +          If true, enables parser tracing.
    + voidsetTraceTreeWalker(boolean enable) + +
    +          Sets a flag to allow the user to enable tree walker tracing
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +ANTLR

    +
    +public ANTLR()
    +
    +
    Constructor for ANTLR task. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setTarget

    +
    +public void setTarget(java.io.File target)
    +
    +
    The grammar file to process. +

    +

    +
    Parameters:
    target - the gramer file
    +
    +
    +
    + +

    +setOutputdirectory

    +
    +public void setOutputdirectory(java.io.File outputDirectory)
    +
    +
    The directory to write the generated files to. +

    +

    +
    Parameters:
    outputDirectory - the output directory
    +
    +
    +
    + +

    +setGlib

    +
    +public void setGlib(java.lang.String superGrammar)
    +
    +
    Deprecated. since ant 1.6 +

    +

    Sets an optional super grammar file. + Use setGlib(File superGrammar) instead. +

    +

    +
    Parameters:
    superGrammar - the super grammar filename
    +
    +
    +
    + +

    +setGlib

    +
    +public void setGlib(java.io.File superGrammar)
    +
    +
    Sets an optional super grammar file +

    +

    +
    Parameters:
    superGrammar - the super grammar file
    Since:
    +
    ant 1.6
    +
    +
    +
    +
    + +

    +setDebug

    +
    +public void setDebug(boolean enable)
    +
    +
    Sets a flag to enable ParseView debugging +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setHtml

    +
    +public void setHtml(boolean enable)
    +
    +
    If true, emit html +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setDiagnostic

    +
    +public void setDiagnostic(boolean enable)
    +
    +
    Sets a flag to emit diagnostic text +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setTrace

    +
    +public void setTrace(boolean enable)
    +
    +
    If true, enables all tracing. +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setTraceParser

    +
    +public void setTraceParser(boolean enable)
    +
    +
    If true, enables parser tracing. +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setTraceLexer

    +
    +public void setTraceLexer(boolean enable)
    +
    +
    If true, enables lexer tracing. +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setTraceTreeWalker

    +
    +public void setTraceTreeWalker(boolean enable)
    +
    +
    Sets a flag to allow the user to enable tree walker tracing +

    +

    +
    Parameters:
    enable - a boolean value
    +
    +
    +
    + +

    +setFork

    +
    +public void setFork(boolean s)
    +
    +
    +
    Parameters:
    s - a boolean value
    +
    +
    +
    + +

    +setDir

    +
    +public void setDir(java.io.File d)
    +
    +
    The working directory of the process +

    +

    +
    Parameters:
    d - the working directory
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Adds a classpath to be set + because a directory might be given for Antlr debug. +

    +

    + +
    Returns:
    a path to be configured
    +
    +
    +
    + +

    +createJvmarg

    +
    +public Commandline.Argument createJvmarg()
    +
    +
    Adds a new JVM argument. +

    +

    + +
    Returns:
    create a new JVM argument so that any argument can be passed to the JVM.
    See Also:
    setFork(boolean)
    +
    +
    +
    + +

    +init

    +
    +public void init()
+          throws BuildException
    +
    +
    Adds the jars or directories containing Antlr + this should make the forked JVM work without having to + specify it directly. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +addClasspathEntry

    +
    +protected void addClasspathEntry(java.lang.String resource)
    +
    +
    Search for the given resource and add the directory or archive + that contains it to the classpath. + +

    Doesn't work for archives in JDK 1.1 as the URL returned by + getResource doesn't contain the name of the archive.

    +

    +

    +
    Parameters:
    resource - the resource name to search for
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error
    +
    +
    +
    + +

    +is272

    +
    +protected boolean is272()
    +
    +
    Whether the antlr version is 2.7.2 (or higher). +

    +

    + +
    Returns:
    true if the version of Antlr present is 2.7.2 or later.
    Since:
    +
    Ant 1.6
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Cab.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Cab.html new file mode 100644 index 000000000..6246b30ad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Cab.html @@ -0,0 +1,632 @@ + + + + + + +Cab (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class Cab

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.Cab
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Cab
    extends MatchingTask
    + + +

    +Create a CAB archive. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +protected  java.lang.StringarchiveType + +
    +           
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Cab() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddFileset(FileSet set) + +
    +          Adds a set of files to archive.
    +protected  voidappendFiles(java.util.Vector files, + DirectoryScanner ds) + +
    +          Append all files found by a directory scanner to a vector.
    +protected  voidcheckConfiguration() + +
    +          Check if the attributes and nested elements are correct.
    +protected  ExecTaskcreateExec() + +
    +          Create a new exec delegate.
    +protected  java.io.FilecreateListFile(java.util.Vector files) + +
    +          Creates a list file.
    + voidexecute() + +
    +          execute this task.
    +protected  java.util.VectorgetFileList() + +
    +          Get the complete list of files to be included in the cab.
    +protected  booleanisUpToDate(java.util.Vector files) + +
    +          Check to see if the target is up to date with respect to input files.
    + voidsetBasedir(java.io.File baseDir) + +
    +          Base directory to look in for files to CAB.
    + voidsetCabfile(java.io.File cabFile) + +
    +          The name/location of where to create the .cab file.
    + voidsetCompress(boolean compress) + +
    +          If true, compress the files otherwise only store them.
    + voidsetOptions(java.lang.String options) + +
    +          Sets additional cabarc options that are not supported directly.
    + voidsetVerbose(boolean verbose) + +
    +          If true, display cabarc output.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +archiveType

    +
    +protected java.lang.String archiveType
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +Cab

    +
    +public Cab()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setCabfile

    +
    +public void setCabfile(java.io.File cabFile)
    +
    +
    The name/location of where to create the .cab file. +

    +

    +
    Parameters:
    cabFile - the location of the cab file.
    +
    +
    +
    + +

    +setBasedir

    +
    +public void setBasedir(java.io.File baseDir)
    +
    +
    Base directory to look in for files to CAB. +

    +

    +
    Parameters:
    baseDir - base directory for files to cab.
    +
    +
    +
    + +

    +setCompress

    +
    +public void setCompress(boolean compress)
    +
    +
    If true, compress the files otherwise only store them. +

    +

    +
    Parameters:
    compress - a boolean value.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    If true, display cabarc output. +

    +

    +
    Parameters:
    verbose - a boolean value.
    +
    +
    +
    + +

    +setOptions

    +
    +public void setOptions(java.lang.String options)
    +
    +
    Sets additional cabarc options that are not supported directly. +

    +

    +
    Parameters:
    options - cabarc command line options.
    +
    +
    +
    + +

    +addFileset

    +
    +public void addFileset(FileSet set)
    +
    +
    Adds a set of files to archive. +

    +

    +
    Parameters:
    set - a set of files to archive.
    +
    +
    +
    + +

    +checkConfiguration

    +
    +protected void checkConfiguration()
+                           throws BuildException
    +
    +
    Check if the attributes and nested elements are correct. +

    +

    + +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +createExec

    +
    +protected ExecTask createExec()
+                       throws BuildException
    +
    +
    Create a new exec delegate. The delegate task is populated so that + it appears in the logs to be the same task as this one. +

    +

    + +
    Returns:
    the delegate. +
    Throws: +
    BuildException - on error.
    +
    +
    +
    + +

    +isUpToDate

    +
    +protected boolean isUpToDate(java.util.Vector files)
    +
    +
    Check to see if the target is up to date with respect to input files. +

    +

    +
    Parameters:
    files - the list of files to check. +
    Returns:
    true if the cab file is newer than its dependents.
    +
    +
    +
    + +

    +createListFile

    +
    +protected java.io.File createListFile(java.util.Vector files)
+                               throws java.io.IOException
    +
    +
    Creates a list file. This temporary file contains a list of all files + to be included in the cab, one file per line. + +

    This method expects to only be called on Windows and thus + quotes the file names.

    +

    +

    +
    Parameters:
    files - the list of files to use. +
    Returns:
    the list file created. +
    Throws: +
    java.io.IOException - if there is an error.
    +
    +
    +
    + +

    +appendFiles

    +
    +protected void appendFiles(java.util.Vector files,
+                           DirectoryScanner ds)
    +
    +
    Append all files found by a directory scanner to a vector. +

    +

    +
    Parameters:
    files - the vector to append the files to.
    ds - the scanner to get the files from.
    +
    +
    +
    + +

    +getFileList

    +
    +protected java.util.Vector getFileList()
+                                throws BuildException
    +
    +
    Get the complete list of files to be included in the cab. Filenames + are gathered from the fileset if it has been added, otherwise from the + traditional include parameters. +

    +

    + +
    Returns:
    the list of files. +
    Throws: +
    BuildException - if there is an error.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    execute this task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html new file mode 100644 index 000000000..ced107a7c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.FormatAttribute.html @@ -0,0 +1,290 @@ + + + + + + +EchoProperties.FormatAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class EchoProperties.FormatAttribute

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.EchoProperties.FormatAttribute
+
    +
    +
    Enclosing class:
    EchoProperties
    +
    +
    +
    +
    public static class EchoProperties.FormatAttribute
    extends EnumeratedAttribute
    + + +

    +A enumerated type for the format attribute. + The values are "xml" and "text". +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    EchoProperties.FormatAttribute() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EchoProperties.FormatAttribute

    +
    +public EchoProperties.FormatAttribute()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    Description copied from class: EnumeratedAttribute
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    accepted values
    See Also:
    EnumeratedAttribute.getValues()
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.html new file mode 100644 index 000000000..ddf504f79 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/EchoProperties.html @@ -0,0 +1,620 @@ + + + + + + +EchoProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class EchoProperties

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.EchoProperties
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class EchoProperties
    extends Task
    + + +

    +Displays all the current properties in the build. The output can be sent to + a file if desired.

    + + Attribute "destfile" defines a file to send the properties to. This can be + processed as a standard property file later.

    + + Attribute "prefix" defines a prefix which is used to filter the properties + only those properties starting with this prefix will be echoed.

    + + By default, the "failonerror" attribute is enabled. If an error occurs while + writing the properties to a file, and this attribute is enabled, then a + BuildException will be thrown. If disabled, then IO errors will be reported + as a log statement, but no error will be thrown.

    + + Examples: 

    +  <echoproperties  />
+
    Report the current properties to the log.

    + + 

    +  <echoproperties destfile="my.properties" />
+
    Report the current properties to the file "my.properties", and will + fail the build if the file could not be created or written to.

    + + 

    +  <echoproperties destfile="my.properties" failonerror="false"
+      prefix="ant" />
+
    Report all properties beginning with 'ant' to the file + "my.properties", and will log a message if the file could not be created or + written to, but will still allow the build to continue. +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    +
    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    +static classEchoProperties.FormatAttribute + +
    +          A enumerated type for the format attribute.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    EchoProperties() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidaddPropertyset(PropertySet ps) + +
    +          A set of properties to write.
    + voidexecute() + +
    +          Run the task.
    +protected  voidjdkSaveProperties(java.util.Properties props, + java.io.OutputStream os, + java.lang.String header) + +
    +          JDK 1.2 allows for the safer method + Properties.store(OutputStream, String), which throws an + IOException on an output error.
    +protected  voidsaveProperties(java.util.Hashtable allProps, + java.io.OutputStream os) + +
    +          Send the key/value pairs in the hashtable to the given output stream.
    + voidsetDestfile(java.io.File destfile) + +
    +          Set a file to store the property output.
    + voidsetFailOnError(boolean failonerror) + +
    +          If true, the task will fail if an error occurs writing the properties + file, otherwise errors are just logged.
    + voidsetFormat(EchoProperties.FormatAttribute ea) + +
    +          Set the output format - xml or text.
    + voidsetPrefix(java.lang.String prefix) + +
    +          If the prefix is set, then only properties which start with this + prefix string will be recorded.
    + voidsetRegex(java.lang.String regex) + +
    +          If the regex is set, then only properties whose names match it + will be recorded.
    + voidsetSrcfile(java.io.File file) + +
    +          Sets the input file.
    +protected  voidxmlSaveProperties(java.util.Properties props, + java.io.OutputStream os) + +
    +          Output the properties as xml output.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +EchoProperties

    +
    +public EchoProperties()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSrcfile

    +
    +public void setSrcfile(java.io.File file)
    +
    +
    Sets the input file. +

    +

    +
    Parameters:
    file - the input file
    +
    +
    +
    + +

    +setDestfile

    +
    +public void setDestfile(java.io.File destfile)
    +
    +
    Set a file to store the property output. If this is never specified, + then the output will be sent to the Ant log. +

    +

    +
    Parameters:
    destfile - file to store the property output
    +
    +
    +
    + +

    +setFailOnError

    +
    +public void setFailOnError(boolean failonerror)
    +
    +
    If true, the task will fail if an error occurs writing the properties + file, otherwise errors are just logged. +

    +

    +
    Parameters:
    failonerror - true if IO exceptions are reported as build + exceptions, or false if IO exceptions are ignored.
    +
    +
    +
    + +

    +setPrefix

    +
    +public void setPrefix(java.lang.String prefix)
    +
    +
    If the prefix is set, then only properties which start with this + prefix string will be recorded. If regex is not set and if this + is never set, or it is set to an empty string or null, + then all properties will be recorded.

    + + For example, if the attribute is set as: + 

    <echoproperties  prefix="ant." />
    + then the property "ant.home" will be recorded, but "ant-example" + will not. +

    +

    +
    Parameters:
    prefix - The new prefix value
    +
    +
    +
    + +

    +setRegex

    +
    +public void setRegex(java.lang.String regex)
    +
    +
    If the regex is set, then only properties whose names match it + will be recorded. If prefix is not set and if this is never set, + or it is set to an empty string or null, then all + properties will be recorded.

    + + For example, if the attribute is set as: + 

    <echoproperties  prefix=".*ant.*" />
    + then the properties "ant.home" and "user.variant" will be recorded, + but "ant-example" will not. +

    +

    +
    Parameters:
    regex - The new regex value
    Since:
    +
    Ant 1.7
    +
    +
    +
    +
    + +

    +addPropertyset

    +
    +public void addPropertyset(PropertySet ps)
    +
    +
    A set of properties to write. +

    +

    +
    Parameters:
    ps - the property set to write
    Since:
    +
    Ant 1.6
    +
    +
    +
    +
    + +

    +setFormat

    +
    +public void setFormat(EchoProperties.FormatAttribute ea)
    +
    +
    Set the output format - xml or text. +

    +

    +
    Parameters:
    ea - an enumerated FormatAttribute value
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Run the task. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - trouble, probably file IO
    +
    +
    +
    + +

    +saveProperties

    +
    +protected void saveProperties(java.util.Hashtable allProps,
+                              java.io.OutputStream os)
+                       throws java.io.IOException,
+                              BuildException
    +
    +
    Send the key/value pairs in the hashtable to the given output stream. + Only those properties matching the prefix constraint will be + sent to the output stream. + The output stream will be closed when this method returns. +

    +

    +
    Parameters:
    allProps - propfile to save
    os - output stream +
    Throws: +
    java.io.IOException - on output errors +
    BuildException - on other errors
    +
    +
    +
    + +

    +xmlSaveProperties

    +
    +protected void xmlSaveProperties(java.util.Properties props,
+                                 java.io.OutputStream os)
+                          throws java.io.IOException
    +
    +
    Output the properties as xml output. +

    +

    +
    Parameters:
    props - the properties to save
    os - the output stream to write to (Note this gets closed) +
    Throws: +
    java.io.IOException - on error in writing to the stream
    +
    +
    +
    + +

    +jdkSaveProperties

    +
    +protected void jdkSaveProperties(java.util.Properties props,
+                                 java.io.OutputStream os,
+                                 java.lang.String header)
+                          throws java.io.IOException
    +
    +
    JDK 1.2 allows for the safer method + Properties.store(OutputStream, String), which throws an + IOException on an output error. +

    +

    +
    Parameters:
    props - the properties to record
    os - record the properties to this output stream
    header - prepend this header to the property output +
    Throws: +
    java.io.IOException - on an I/O error during a write.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.ClassArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.ClassArgument.html new file mode 100644 index 000000000..d9235d8f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.ClassArgument.html @@ -0,0 +1,281 @@ + + + + + + +Javah.ClassArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class Javah.ClassArgument

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.Javah.ClassArgument
+
    +
    +
    Enclosing class:
    Javah
    +
    +
    +
    +
    public class Javah.ClassArgument
    extends java.lang.Object
    + + +

    +A class corresponding the the nested "class" element. + It contains a "name" attribute. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    Javah.ClassArgument() + +
    +          Constructor for ClassArgument.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetName() + +
    +          Get the name attribute.
    + voidsetName(java.lang.String name) + +
    +          Set the name attribute.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javah.ClassArgument

    +
    +public Javah.ClassArgument()
    +
    +
    Constructor for ClassArgument. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setName

    +
    +public void setName(java.lang.String name)
    +
    +
    Set the name attribute. +

    +

    +
    Parameters:
    name - the name attribute.
    +
    +
    +
    + +

    +getName

    +
    +public java.lang.String getName()
    +
    +
    Get the name attribute. +

    +

    + +
    Returns:
    the name attribute.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.html new file mode 100644 index 000000000..1d54f09ff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Javah.html @@ -0,0 +1,1069 @@ + + + + + + +Javah (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class Javah

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.Javah
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class Javah
    extends Task
    + + +

    +Generates JNI header files using javah. + + This task can take the following arguments: +

      +
    • classname - the fully-qualified name of a class
      • +
    • outputFile - Concatenates the resulting header or source files for all + the classes listed into this file
      • +
    • destdir - Sets the directory where javah saves the header files or the + stub files
      • +
    • classpath
      • +
    • bootclasspath
      • +
    • force - Specifies that output files should always be written + (JDK1.2 only)
      • +
    • old - Specifies that old JDK1.0-style header files should be generated + (otherwise output file contain JNI-style native method + function prototypes) (JDK1.2 only)
      • +
    • stubs - generate C declarations from the Java object file (used with old)
      • +
    • verbose - causes javah to print a message to stdout concerning the status + of the generated files
      • +
    • extdirs - Override location of installed extensions
      • +
    + Of these arguments, either outputFile or destdir is required, + but not both. More than one classname may be specified, using a comma-separated + list or by using <class name="xxx"> elements within the task. +

    + When this task executes, it will generate C header and source files that + are needed to implement native methods. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Nested Class Summary
    + classJavah.ClassArgument + +
    +          A class corresponding the the nested "class" element.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Javah() + +
    +          No arg constructor.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(JavahAdapter adapter) + +
    +          Set the adapter explicitly.
    + voidaddFileSet(FileSet fs) + +
    +          Add a fileset.
    + ImplementationSpecificArgumentcreateArg() + +
    +          Adds an implementation specific command-line argument.
    + PathcreateBootclasspath() + +
    +          Adds path to bootstrap class files.
    + Javah.ClassArgumentcreateClass() + +
    +          Adds class to process.
    + PathcreateClasspath() + +
    +          Path to use for classpath.
    + PathcreateImplementationClasspath() + +
    +          The classpath to use when loading the javah implementation + if it is not a built-in one.
    + voidexecute() + +
    +          Execute the task
    + PathgetBootclasspath() + +
    +          The bootclasspath to use.
    + java.lang.String[]getClasses() + +
    +          Names of the classes to process.
    + PathgetClasspath() + +
    +          The classpath to use.
    + java.lang.String[]getCurrentArgs() + +
    +          Returns the (implementation specific) settings given as nested + arg elements.
    + java.io.FilegetDestdir() + +
    +          The destination directory, if any.
    + booleangetForce() + +
    +          Whether output files should always be written.
    + booleangetOld() + +
    +          Whether old JDK1.0-style header files should be generated.
    + java.io.FilegetOutputfile() + +
    +          The destination file, if any.
    + booleangetStubs() + +
    +          Whether C declarations from the Java object file should be generated.
    + booleangetVerbose() + +
    +          Whether verbose output should get generated.
    + voidlogAndAddFiles(Commandline cmd) + +
    +          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList"
    +protected  voidlogAndAddFilesToCompile(Commandline cmd) + +
    +          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList"
    + voidsetBootclasspath(Path src) + +
    +          location of bootstrap class files.
    + voidsetBootClasspathRef(Reference r) + +
    +          To the bootstrap path, this adds a reference to a classpath defined elsewhere.
    + voidsetClass(java.lang.String cls) + +
    +          the fully-qualified name of the class (or classes, separated by commas).
    + voidsetClasspath(Path src) + +
    +          the classpath to use.
    + voidsetClasspathRef(Reference r) + +
    +          Adds a reference to a classpath defined elsewhere.
    + voidsetDestdir(java.io.File destDir) + +
    +          Set the destination directory into which the Java source + files should be compiled.
    + voidsetForce(boolean force) + +
    +          If true, output files should always be written (JDK1.2 only).
    + voidsetImplementation(java.lang.String impl) + +
    +          Choose the implementation for this particular task.
    + voidsetOld(boolean old) + +
    +          If true, specifies that old JDK1.0-style header files should be + generated.
    + voidsetOutputFile(java.io.File outputFile) + +
    +          Concatenates the resulting header or source files for all + the classes listed into this file.
    + voidsetStubs(boolean stubs) + +
    +          If true, generate C declarations from the Java object file (used with old).
    + voidsetVerbose(boolean verbose) + +
    +          If true, causes Javah to print a message concerning + the status of the generated files.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Javah

    +
    +public Javah()
    +
    +
    No arg constructor. +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setClass

    +
    +public void setClass(java.lang.String cls)
    +
    +
    the fully-qualified name of the class (or classes, separated by commas). +

    +

    +
    Parameters:
    cls - the classname (or classnames).
    +
    +
    +
    + +

    +createClass

    +
    +public Javah.ClassArgument createClass()
    +
    +
    Adds class to process. +

    +

    + +
    Returns:
    a ClassArgument to be configured.
    +
    +
    +
    + +

    +addFileSet

    +
    +public void addFileSet(FileSet fs)
    +
    +
    Add a fileset. +

    +

    +
    Parameters:
    fs - the fileset to add.
    +
    +
    +
    + +

    +getClasses

    +
    +public java.lang.String[] getClasses()
    +
    +
    Names of the classes to process. +

    +

    + +
    Returns:
    the array of classes.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setDestdir

    +
    +public void setDestdir(java.io.File destDir)
    +
    +
    Set the destination directory into which the Java source + files should be compiled. +

    +

    +
    Parameters:
    destDir - the destination directory.
    +
    +
    +
    + +

    +getDestdir

    +
    +public java.io.File getDestdir()
    +
    +
    The destination directory, if any. +

    +

    + +
    Returns:
    the destination directory.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(Path src)
    +
    +
    the classpath to use. +

    +

    +
    Parameters:
    src - the classpath.
    +
    +
    +
    + +

    +createClasspath

    +
    +public Path createClasspath()
    +
    +
    Path to use for classpath. +

    +

    + +
    Returns:
    a path to be configured.
    +
    +
    +
    + +

    +setClasspathRef

    +
    +public void setClasspathRef(Reference r)
    +
    +
    Adds a reference to a classpath defined elsewhere. +

    +

    +
    Parameters:
    r - a reference to a classpath.
    To do:
    +
    this needs to be documented in the HTML docs.
    +
    +
    +
    +
    + +

    +getClasspath

    +
    +public Path getClasspath()
    +
    +
    The classpath to use. +

    +

    + +
    Returns:
    the classpath.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setBootclasspath

    +
    +public void setBootclasspath(Path src)
    +
    +
    location of bootstrap class files. +

    +

    +
    Parameters:
    src - the bootstrap classpath.
    +
    +
    +
    + +

    +createBootclasspath

    +
    +public Path createBootclasspath()
    +
    +
    Adds path to bootstrap class files. +

    +

    + +
    Returns:
    a path to be configured.
    +
    +
    +
    + +

    +setBootClasspathRef

    +
    +public void setBootClasspathRef(Reference r)
    +
    +
    To the bootstrap path, this adds a reference to a classpath defined elsewhere. +

    +

    +
    Parameters:
    r - a reference to a classpath
    To do:
    +
    this needs to be documented in the HTML.
    +
    +
    +
    +
    + +

    +getBootclasspath

    +
    +public Path getBootclasspath()
    +
    +
    The bootclasspath to use. +

    +

    + +
    Returns:
    the bootclass path.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setOutputFile

    +
    +public void setOutputFile(java.io.File outputFile)
    +
    +
    Concatenates the resulting header or source files for all + the classes listed into this file. +

    +

    +
    Parameters:
    outputFile - the output file.
    +
    +
    +
    + +

    +getOutputfile

    +
    +public java.io.File getOutputfile()
    +
    +
    The destination file, if any. +

    +

    + +
    Returns:
    the destination file.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setForce

    +
    +public void setForce(boolean force)
    +
    +
    If true, output files should always be written (JDK1.2 only). +

    +

    +
    Parameters:
    force - the value to use.
    +
    +
    +
    + +

    +getForce

    +
    +public boolean getForce()
    +
    +
    Whether output files should always be written. +

    +

    + +
    Returns:
    the force attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setOld

    +
    +public void setOld(boolean old)
    +
    +
    If true, specifies that old JDK1.0-style header files should be + generated. + (otherwise output file contain JNI-style native method function + prototypes) (JDK1.2 only). +

    +

    +
    Parameters:
    old - if true use old 1.0 style header files.
    +
    +
    +
    + +

    +getOld

    +
    +public boolean getOld()
    +
    +
    Whether old JDK1.0-style header files should be generated. +

    +

    + +
    Returns:
    the old attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setStubs

    +
    +public void setStubs(boolean stubs)
    +
    +
    If true, generate C declarations from the Java object file (used with old). +

    +

    +
    Parameters:
    stubs - if true, generated C declarations.
    +
    +
    +
    + +

    +getStubs

    +
    +public boolean getStubs()
    +
    +
    Whether C declarations from the Java object file should be generated. +

    +

    + +
    Returns:
    the stubs attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(boolean verbose)
    +
    +
    If true, causes Javah to print a message concerning + the status of the generated files. +

    +

    +
    Parameters:
    verbose - if true, do verbose printing.
    +
    +
    +
    + +

    +getVerbose

    +
    +public boolean getVerbose()
    +
    +
    Whether verbose output should get generated. +

    +

    + +
    Returns:
    the verbose attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setImplementation

    +
    +public void setImplementation(java.lang.String impl)
    +
    +
    Choose the implementation for this particular task. +

    +

    +
    Parameters:
    impl - the name of the implemenation.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createArg

    +
    +public ImplementationSpecificArgument createArg()
    +
    +
    Adds an implementation specific command-line argument. +

    +

    + +
    Returns:
    a ImplementationSpecificArgument to be configured.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +getCurrentArgs

    +
    +public java.lang.String[] getCurrentArgs()
    +
    +
    Returns the (implementation specific) settings given as nested + arg elements. +

    +

    + +
    Returns:
    the arguments.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createImplementationClasspath

    +
    +public Path createImplementationClasspath()
    +
    +
    The classpath to use when loading the javah implementation + if it is not a built-in one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(JavahAdapter adapter)
    +
    +
    Set the adapter explicitly. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - is there is a problem in the task execution.
    +
    +
    +
    + +

    +logAndAddFiles

    +
    +public void logAndAddFiles(Commandline cmd)
    +
    +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +

    +

    +
    Parameters:
    cmd - the command line.
    +
    +
    +
    + +

    +logAndAddFilesToCompile

    +
    +protected void logAndAddFilesToCompile(Commandline cmd)
    +
    +
    Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +

    +

    +
    Parameters:
    cmd - the command line to add parameters to.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Native2Ascii.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Native2Ascii.html new file mode 100644 index 000000000..12ea5c51b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Native2Ascii.html @@ -0,0 +1,662 @@ + + + + + + +Native2Ascii (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class Native2Ascii

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.Native2Ascii
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class Native2Ascii
    extends MatchingTask
    + + +

    +Converts files from native encodings to ASCII. +

    + +

    +

    +
    Since:
    +
    Ant 1.2
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    Native2Ascii() + +
    +          No args constructor
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidadd(FileNameMapper fileNameMapper) + +
    +          A nested filenamemapper
    + voidadd(Native2AsciiAdapter adapter) + +
    +          Set the adapter explicitly.
    + ImplementationSpecificArgumentcreateArg() + +
    +          Adds an implementation specific command-line argument.
    + PathcreateImplementationClasspath() + +
    +          The classpath to use when loading the native2ascii + implementation if it is not a built-in one.
    + MappercreateMapper() + +
    +          Defines the FileNameMapper to use (nested mapper element).
    + voidexecute() + +
    +          Execute the task
    + java.lang.String[]getCurrentArgs() + +
    +          Returns the (implementation specific) settings given as nested + arg elements.
    + java.lang.StringgetEncoding() + +
    +          The value of the encoding attribute.
    + booleangetReverse() + +
    +          The value of the reverse attribute.
    + voidsetDest(java.io.File destDir) + +
    +          Set the destination directory to place converted files into.
    + voidsetEncoding(java.lang.String encoding) + +
    +          Set the encoding to translate to/from.
    + voidsetExt(java.lang.String ext) + +
    +          Set the extension which converted files should have.
    + voidsetImplementation(java.lang.String impl) + +
    +          Choose the implementation for this particular task.
    + voidsetReverse(boolean reverse) + +
    +          Flag the conversion to run in the reverse sense, + that is Ascii to Native encoding.
    + voidsetSrc(java.io.File srcDir) + +
    +          Set the source directory in which to find files to convert.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +Native2Ascii

    +
    +public Native2Ascii()
    +
    +
    No args constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +setReverse

    +
    +public void setReverse(boolean reverse)
    +
    +
    Flag the conversion to run in the reverse sense, + that is Ascii to Native encoding. +

    +

    +
    Parameters:
    reverse - True if the conversion is to be reversed, + otherwise false;
    +
    +
    +
    + +

    +getReverse

    +
    +public boolean getReverse()
    +
    +
    The value of the reverse attribute. +

    +

    + +
    Returns:
    the reverse attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setEncoding

    +
    +public void setEncoding(java.lang.String encoding)
    +
    +
    Set the encoding to translate to/from. + If unset, the default encoding for the JVM is used. +

    +

    +
    Parameters:
    encoding - String containing the name of the Native + encoding to convert from or to.
    +
    +
    +
    + +

    +getEncoding

    +
    +public java.lang.String getEncoding()
    +
    +
    The value of the encoding attribute. +

    +

    + +
    Returns:
    the encoding attribute.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +setSrc

    +
    +public void setSrc(java.io.File srcDir)
    +
    +
    Set the source directory in which to find files to convert. +

    +

    +
    Parameters:
    srcDir - directory to find input file in.
    +
    +
    +
    + +

    +setDest

    +
    +public void setDest(java.io.File destDir)
    +
    +
    Set the destination directory to place converted files into. +

    +

    +
    Parameters:
    destDir - directory to place output file into.
    +
    +
    +
    + +

    +setExt

    +
    +public void setExt(java.lang.String ext)
    +
    +
    Set the extension which converted files should have. + If unset, files will not be renamed. +

    +

    +
    Parameters:
    ext - File extension to use for converted files.
    +
    +
    +
    + +

    +setImplementation

    +
    +public void setImplementation(java.lang.String impl)
    +
    +
    Choose the implementation for this particular task. +

    +

    +
    Parameters:
    impl - the name of the implemenation
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createMapper

    +
    +public Mapper createMapper()
+                    throws BuildException
    +
    +
    Defines the FileNameMapper to use (nested mapper element). +

    +

    + +
    Returns:
    the mapper to use for file name translations. +
    Throws: +
    BuildException - if more than one mapper is defined.
    +
    +
    +
    + +

    +add

    +
    +public void add(FileNameMapper fileNameMapper)
    +
    +
    A nested filenamemapper +

    +

    +
    Parameters:
    fileNameMapper - the mapper to add
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createArg

    +
    +public ImplementationSpecificArgument createArg()
    +
    +
    Adds an implementation specific command-line argument. +

    +

    + +
    Returns:
    a ImplementationSpecificArgument to be configured
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    +
    + +

    +createImplementationClasspath

    +
    +public Path createImplementationClasspath()
    +
    +
    The classpath to use when loading the native2ascii + implementation if it is not a built-in one. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +add

    +
    +public void add(Native2AsciiAdapter adapter)
    +
    +
    Set the adapter explicitly. +

    +

    +
    Since:
    +
    Ant 1.8.0
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Execute the task +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - is there is a problem in the task execution.
    +
    +
    +
    + +

    +getCurrentArgs

    +
    +public java.lang.String[] getCurrentArgs()
    +
    +
    Returns the (implementation specific) settings given as nested + arg elements. +

    +

    + +
    Returns:
    the arguments.
    Since:
    +
    Ant 1.6.3
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.TraceAttr.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.TraceAttr.html new file mode 100644 index 000000000..9c3fb1b4b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.TraceAttr.html @@ -0,0 +1,290 @@ + + + + + + +NetRexxC.TraceAttr (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class NetRexxC.TraceAttr

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.NetRexxC.TraceAttr
+
    +
    +
    Enclosing class:
    NetRexxC
    +
    +
    +
    +
    public static class NetRexxC.TraceAttr
    extends EnumeratedAttribute
    + + +

    +Enumerated class corresponding to the trace attribute. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    NetRexxC.TraceAttr() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +NetRexxC.TraceAttr

    +
    +public NetRexxC.TraceAttr()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.VerboseAttr.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.VerboseAttr.html new file mode 100644 index 000000000..d3253615f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.VerboseAttr.html @@ -0,0 +1,290 @@ + + + + + + +NetRexxC.VerboseAttr (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class NetRexxC.VerboseAttr

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.NetRexxC.VerboseAttr
+
    +
    +
    Enclosing class:
    NetRexxC
    +
    +
    +
    +
    public static class NetRexxC.VerboseAttr
    extends EnumeratedAttribute
    + + +

    +Enumerated class corresponding to the verbose attribute. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    NetRexxC.VerboseAttr() + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +NetRexxC.VerboseAttr

    +
    +public NetRexxC.VerboseAttr()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.html new file mode 100644 index 000000000..ad3d81f6d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/NetRexxC.html @@ -0,0 +1,1324 @@ + + + + + + +NetRexxC (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class NetRexxC

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.NetRexxC
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer
    +
    +
    +
    +
    public class NetRexxC
    extends MatchingTask
    + + +

    +Compiles NetRexx source files. + This task can take the following + arguments: +

      +
    • binary
      • +
    • classpath
      • +
    • comments
      • +
    • compile
      • +
    • console
      • +
    • crossref
      • +
    • decimal
      • +
    • destdir
      • +
    • diag
      • +
    • explicit
      • +
    • format
      • +
    • keep
      • +
    • logo
      • +
    • replace
      • +
    • savelog
      • +
    • srcdir
      • +
    • sourcedir
      • +
    • strictargs
      • +
    • strictassign
      • +
    • strictcase
      • +
    • strictimport
      • +
    • symbols
      • +
    • time
      • +
    • trace
      • +
    • utf8
      • +
    • verbose
      • +
    • suppressMethodArgumentNotUsed
      • +
    • suppressPrivatePropertyNotUsed
      • +
    • suppressVariableNotUsed
      • +
    • suppressExceptionNotSignalled
      • +
    • suppressDeprecation
      • +
    • removeKeepExtension
      • +
    + Of these arguments, the srcdir argument is required. + +

    When this task executes, it will recursively scan the srcdir + looking for NetRexx source files to compile. This task makes its + compile decision based on timestamp. +

    Before files are compiled they and any other file in the + srcdir will be copied to the destdir allowing support files to be + located properly in the classpath. The reason for copying the source files + before the compile is that NetRexxC has only two destinations for classfiles: +

      +
    1. The current directory, and,
      2. +
    2. The directory the source is in (see sourcedir option) +
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classNetRexxC.TraceAttr + +
    +          Enumerated class corresponding to the trace attribute.
    +static classNetRexxC.VerboseAttr + +
    +          Enumerated class corresponding to the verbose attribute.
    +  + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    fileset
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.Task
    target, taskName, taskType, wrapper
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.ProjectComponent
    description, location, project
    +  + + + + + + + + + + +
    +Constructor Summary
    NetRexxC() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Executes the task - performs the actual compiler call.
    + voidinit() + +
    +          init-Method sets defaults from Properties.
    + voidsetBinary(boolean binary) + +
    +          Set whether literals are treated as binary, rather than NetRexx types.
    + voidsetClasspath(java.lang.String classpath) + +
    +          Set the classpath used for NetRexx compilation.
    + voidsetComments(boolean comments) + +
    +          Set whether comments are passed through to the generated java source.
    + voidsetCompact(boolean compact) + +
    +          Set whether error messages come out in compact or verbose format.
    + voidsetCompile(boolean compile) + +
    +          Set whether the NetRexx compiler should compile the generated java code.
    + voidsetConsole(boolean console) + +
    +          Set whether or not compiler messages should be displayed on the 'console'.
    + voidsetCrossref(boolean crossref) + +
    +          Whether variable cross references are generated.
    + voidsetDecimal(boolean decimal) + +
    +          Set whether decimal arithmetic should be used for the netrexx code.
    + voidsetDestDir(java.io.File destDirName) + +
    +          Set the destination directory into which the NetRexx source files + should be copied and then compiled.
    + voidsetDiag(boolean diag) + +
    +          Whether diagnostic information about the compile is generated
    + voidsetExplicit(boolean explicit) + +
    +          Sets whether variables must be declared explicitly before use.
    + voidsetFormat(boolean format) + +
    +          Whether the generated java code is formatted nicely or left to match + NetRexx line numbers for call stack debugging.
    + voidsetJava(boolean java) + +
    +          Whether the generated java code is produced.
    + voidsetKeep(boolean keep) + +
    +          Sets whether the generated java source file should be kept after + compilation.
    + voidsetLogo(boolean logo) + +
    +          Whether the compiler text logo is displayed when compiling.
    + voidsetRemoveKeepExtension(boolean removeKeepExtension) + +
    +          Tells wether the trailing .keep in nocompile-mode should be removed + so that the resulting java source really ends on .java.
    + voidsetReplace(boolean replace) + +
    +          Whether the generated .java file should be replaced when compiling.
    + voidsetSavelog(boolean savelog) + +
    +          Sets whether the compiler messages will be written to NetRexxC.log as + well as to the console.
    + voidsetSourcedir(boolean sourcedir) + +
    +          Tells the NetRexx compiler to store the class files in the same + directory as the source files.
    + voidsetSrcDir(java.io.File srcDirName) + +
    +          Set the source dir to find the source Java files.
    + voidsetStrictargs(boolean strictargs) + +
    +          Tells the NetRexx compiler that method calls always need parentheses, + even if no arguments are needed, e.g.
    + voidsetStrictassign(boolean strictassign) + +
    +          Tells the NetRexx compile that assignments must match exactly on type.
    + voidsetStrictcase(boolean strictcase) + +
    +          Specifies whether the NetRexx compiler should be case sensitive or not.
    + voidsetStrictimport(boolean strictimport) + +
    +          Sets whether classes need to be imported explicitly using an import + statement.
    + voidsetStrictprops(boolean strictprops) + +
    +          Sets whether local properties need to be qualified explicitly using + this.
    + voidsetStrictsignal(boolean strictsignal) + +
    +          Whether the compiler should force catching of exceptions by explicitly + named types.
    + voidsetSuppressDeprecation(boolean suppressDeprecation) + +
    +          Tells whether we should filter out any deprecation-messages + of the compiler out.
    + voidsetSuppressExceptionNotSignalled(boolean suppressExceptionNotSignalled) + +
    +          Whether the task should suppress the "FooException is in SIGNALS list + but is not signalled within the method", which is sometimes rather + useless.
    + voidsetSuppressMethodArgumentNotUsed(boolean suppressMethodArgumentNotUsed) + +
    +          Whether the task should suppress the "Method argument is not used" in + strictargs-Mode, which can not be suppressed by the compiler itself.
    + voidsetSuppressPrivatePropertyNotUsed(boolean suppressPrivatePropertyNotUsed) + +
    +          Whether the task should suppress the "Private property is defined but + not used" in strictargs-Mode, which can be quite annoying while + developing.
    + voidsetSuppressVariableNotUsed(boolean suppressVariableNotUsed) + +
    +          Whether the task should suppress the "Variable is set but not used" in + strictargs-Mode.
    + voidsetSymbols(boolean symbols) + +
    +          Sets whether debug symbols should be generated into the class file.
    + voidsetTime(boolean time) + +
    +          Asks the NetRexx compiler to print compilation times to the console + Valid true values are "yes", "on" or "true".
    + voidsetTrace(NetRexxC.TraceAttr trace) + +
    +          Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace".
    + voidsetTrace(java.lang.String trace) + +
    +          Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace".
    + voidsetUtf8(boolean utf8) + +
    +          Tells the NetRexx compiler that the source is in UTF8.
    + voidsetVerbose(NetRexxC.VerboseAttr verbose) + +
    +          Whether lots of warnings and error messages should be generated
    + voidsetVerbose(java.lang.String verbose) + +
    +          Whether lots of warnings and error messages should be generated
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
    add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.Task
    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.ProjectComponent
    clone, getDescription, getLocation, getProject, setDescription, setLocation
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +NetRexxC

    +
    +public NetRexxC()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setBinary

    +
    +public void setBinary(boolean binary)
    +
    +
    Set whether literals are treated as binary, rather than NetRexx types. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default is false. +

    +

    +
    Parameters:
    binary - a boolean value.
    +
    +
    +
    + +

    +setClasspath

    +
    +public void setClasspath(java.lang.String classpath)
    +
    +
    Set the classpath used for NetRexx compilation. +

    +

    +
    Parameters:
    classpath - the classpath to use.
    +
    +
    +
    + +

    +setComments

    +
    +public void setComments(boolean comments)
    +
    +
    Set whether comments are passed through to the generated java source. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    comments - a boolean value.
    +
    +
    +
    + +

    +setCompact

    +
    +public void setCompact(boolean compact)
    +
    +
    Set whether error messages come out in compact or verbose format. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is true. +

    +

    +
    Parameters:
    compact - a boolean value.
    +
    +
    +
    + +

    +setCompile

    +
    +public void setCompile(boolean compile)
    +
    +
    Set whether the NetRexx compiler should compile the generated java code. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is true. + Setting this flag to false, will automatically set the keep flag to true. +

    +

    +
    Parameters:
    compile - a boolean value.
    +
    +
    +
    + +

    +setConsole

    +
    +public void setConsole(boolean console)
    +
    +
    Set whether or not compiler messages should be displayed on the 'console'. + Note that this task will rely on the default value for filtering compile messages. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    console - a boolean value.
    +
    +
    +
    + +

    +setCrossref

    +
    +public void setCrossref(boolean crossref)
    +
    +
    Whether variable cross references are generated. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    crossref - a boolean value.
    +
    +
    +
    + +

    +setDecimal

    +
    +public void setDecimal(boolean decimal)
    +
    +
    Set whether decimal arithmetic should be used for the netrexx code. + Setting this to off will report decimal arithmetic as an error, for + performance critical applications. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is true. +

    +

    +
    Parameters:
    decimal - a boolean value.
    +
    +
    +
    + +

    +setDestDir

    +
    +public void setDestDir(java.io.File destDirName)
    +
    +
    Set the destination directory into which the NetRexx source files + should be copied and then compiled. +

    +

    +
    Parameters:
    destDirName - the destination directory.
    +
    +
    +
    + +

    +setDiag

    +
    +public void setDiag(boolean diag)
    +
    +
    Whether diagnostic information about the compile is generated +

    +

    +
    Parameters:
    diag - a boolean value.
    +
    +
    +
    + +

    +setExplicit

    +
    +public void setExplicit(boolean explicit)
    +
    +
    Sets whether variables must be declared explicitly before use. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    explicit - a boolean value.
    +
    +
    +
    + +

    +setFormat

    +
    +public void setFormat(boolean format)
    +
    +
    Whether the generated java code is formatted nicely or left to match + NetRexx line numbers for call stack debugging. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value false. +

    +

    +
    Parameters:
    format - a boolean value.
    +
    +
    +
    + +

    +setJava

    +
    +public void setJava(boolean java)
    +
    +
    Whether the generated java code is produced. + This is not implemented yet. +

    +

    +
    Parameters:
    java - a boolean value.
    +
    +
    +
    + +

    +setKeep

    +
    +public void setKeep(boolean keep)
    +
    +
    Sets whether the generated java source file should be kept after + compilation. The generated files will have an extension of .java.keep, + not .java. See setRemoveKeepExtension + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    keep - a boolean value.
    See Also:
    setRemoveKeepExtension(boolean)
    +
    +
    +
    + +

    +setLogo

    +
    +public void setLogo(boolean logo)
    +
    +
    Whether the compiler text logo is displayed when compiling. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    logo - a boolean value.
    +
    +
    +
    + +

    +setReplace

    +
    +public void setReplace(boolean replace)
    +
    +
    Whether the generated .java file should be replaced when compiling. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    replace - a boolean value.
    +
    +
    +
    + +

    +setSavelog

    +
    +public void setSavelog(boolean savelog)
    +
    +
    Sets whether the compiler messages will be written to NetRexxC.log as + well as to the console. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    savelog - a boolean value.
    +
    +
    +
    + +

    +setSourcedir

    +
    +public void setSourcedir(boolean sourcedir)
    +
    +
    Tells the NetRexx compiler to store the class files in the same + directory as the source files. The alternative is the working directory. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is true. +

    +

    +
    Parameters:
    sourcedir - a boolean value.
    +
    +
    +
    + +

    +setSrcDir

    +
    +public void setSrcDir(java.io.File srcDirName)
    +
    +
    Set the source dir to find the source Java files. +

    +

    +
    Parameters:
    srcDirName - the source directory.
    +
    +
    +
    + +

    +setStrictargs

    +
    +public void setStrictargs(boolean strictargs)
    +
    +
    Tells the NetRexx compiler that method calls always need parentheses, + even if no arguments are needed, e.g. aStringVar.getBytes + vs. aStringVar.getBytes(). + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    strictargs - a boolean value.
    +
    +
    +
    + +

    +setStrictassign

    +
    +public void setStrictassign(boolean strictassign)
    +
    +
    Tells the NetRexx compile that assignments must match exactly on type. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    strictassign - a boolean value.
    +
    +
    +
    + +

    +setStrictcase

    +
    +public void setStrictcase(boolean strictcase)
    +
    +
    Specifies whether the NetRexx compiler should be case sensitive or not. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    strictcase - a boolean value.
    +
    +
    +
    + +

    +setStrictimport

    +
    +public void setStrictimport(boolean strictimport)
    +
    +
    Sets whether classes need to be imported explicitly using an import + statement. By default the NetRexx compiler will import certain packages + automatically. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    strictimport - a boolean value.
    +
    +
    +
    + +

    +setStrictprops

    +
    +public void setStrictprops(boolean strictprops)
    +
    +
    Sets whether local properties need to be qualified explicitly using + this. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    strictprops - a boolean value.
    +
    +
    +
    + +

    +setStrictsignal

    +
    +public void setStrictsignal(boolean strictsignal)
    +
    +
    Whether the compiler should force catching of exceptions by explicitly + named types. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false +

    +

    +
    Parameters:
    strictsignal - a boolean value.
    +
    +
    +
    + +

    +setSymbols

    +
    +public void setSymbols(boolean symbols)
    +
    +
    Sets whether debug symbols should be generated into the class file. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    symbols - a boolean value.
    +
    +
    +
    + +

    +setTime

    +
    +public void setTime(boolean time)
    +
    +
    Asks the NetRexx compiler to print compilation times to the console + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    time - a boolean value.
    +
    +
    +
    + +

    +setTrace

    +
    +public void setTrace(NetRexxC.TraceAttr trace)
    +
    +
    Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace". "trace" and + "trace2". +

    +

    +
    Parameters:
    trace - the value to set.
    +
    +
    +
    + +

    +setTrace

    +
    +public void setTrace(java.lang.String trace)
    +
    +
    Turns on or off tracing and directs the resultant trace output Valid + values are: "trace", "trace1", "trace2" and "notrace". "trace" and + "trace2". +

    +

    +
    Parameters:
    trace - the value to set.
    +
    +
    +
    + +

    +setUtf8

    +
    +public void setUtf8(boolean utf8)
    +
    +
    Tells the NetRexx compiler that the source is in UTF8. + Valid true values are "yes", "on" or "true". Anything else sets the flag to false. + The default value is false. +

    +

    +
    Parameters:
    utf8 - a boolean value.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(NetRexxC.VerboseAttr verbose)
    +
    +
    Whether lots of warnings and error messages should be generated +

    +

    +
    Parameters:
    verbose - the value to set - verbose<level> or noverbose.
    +
    +
    +
    + +

    +setVerbose

    +
    +public void setVerbose(java.lang.String verbose)
    +
    +
    Whether lots of warnings and error messages should be generated +

    +

    +
    Parameters:
    verbose - the value to set - verbose<level> or noverbose.
    +
    +
    +
    + +

    +setSuppressMethodArgumentNotUsed

    +
    +public void setSuppressMethodArgumentNotUsed(boolean suppressMethodArgumentNotUsed)
    +
    +
    Whether the task should suppress the "Method argument is not used" in + strictargs-Mode, which can not be suppressed by the compiler itself. + The warning is logged as verbose message, though. +

    +

    +
    Parameters:
    suppressMethodArgumentNotUsed - a boolean value.
    +
    +
    +
    + +

    +setSuppressPrivatePropertyNotUsed

    +
    +public void setSuppressPrivatePropertyNotUsed(boolean suppressPrivatePropertyNotUsed)
    +
    +
    Whether the task should suppress the "Private property is defined but + not used" in strictargs-Mode, which can be quite annoying while + developing. The warning is logged as verbose message, though. +

    +

    +
    Parameters:
    suppressPrivatePropertyNotUsed - a boolean value.
    +
    +
    +
    + +

    +setSuppressVariableNotUsed

    +
    +public void setSuppressVariableNotUsed(boolean suppressVariableNotUsed)
    +
    +
    Whether the task should suppress the "Variable is set but not used" in + strictargs-Mode. Be careful with this one! The warning is logged as + verbose message, though. +

    +

    +
    Parameters:
    suppressVariableNotUsed - a boolean value.
    +
    +
    +
    + +

    +setSuppressExceptionNotSignalled

    +
    +public void setSuppressExceptionNotSignalled(boolean suppressExceptionNotSignalled)
    +
    +
    Whether the task should suppress the "FooException is in SIGNALS list + but is not signalled within the method", which is sometimes rather + useless. The warning is logged as verbose message, though. +

    +

    +
    Parameters:
    suppressExceptionNotSignalled - a boolean value.
    +
    +
    +
    + +

    +setSuppressDeprecation

    +
    +public void setSuppressDeprecation(boolean suppressDeprecation)
    +
    +
    Tells whether we should filter out any deprecation-messages + of the compiler out. +

    +

    +
    Parameters:
    suppressDeprecation - a boolean value.
    +
    +
    +
    + +

    +setRemoveKeepExtension

    +
    +public void setRemoveKeepExtension(boolean removeKeepExtension)
    +
    +
    Tells wether the trailing .keep in nocompile-mode should be removed + so that the resulting java source really ends on .java. + This facilitates the use of the javadoc tool lateron. +

    +

    +
    +
    +
    +
    + +

    +init

    +
    +public void init()
    +
    +
    init-Method sets defaults from Properties. That way, when ant is called + with arguments like -Dant.netrexxc.verbose=verbose5 one can easily take + control of all netrexxc-tasks. +

    +

    +
    Overrides:
    init in class Task
    +
    +
    +
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws BuildException
    +
    +
    Executes the task - performs the actual compiler call. +

    +

    +
    Overrides:
    execute in class Task
    +
    +
    + +
    Throws: +
    BuildException - on error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Operation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Operation.html new file mode 100644 index 000000000..e36c56253 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Operation.html @@ -0,0 +1,401 @@ + + + + + + +PropertyFile.Entry.Operation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class PropertyFile.Entry.Operation

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Operation
+
    +
    +
    Enclosing class:
    PropertyFile.Entry
    +
    +
    +
    +
    public static class PropertyFile.Entry.Operation
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "+", "-", "=" +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static intDECREMENT_OPER + +
    +          -
    +static intDELETE_OPER + +
    +          del
    +static intEQUALS_OPER + +
    +          =
    +static intINCREMENT_OPER + +
    +          +
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyFile.Entry.Operation() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +static inttoOperation(java.lang.String oper) + +
    +          Convert string to index.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +INCREMENT_OPER

    +
    +public static final int INCREMENT_OPER
    +
    +
    + +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DECREMENT_OPER

    +
    +public static final int DECREMENT_OPER
    +
    +
    - +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +EQUALS_OPER

    +
    +public static final int EQUALS_OPER
    +
    +
    = +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DELETE_OPER

    +
    +public static final int DELETE_OPER
    +
    +
    del +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyFile.Entry.Operation

    +
    +public PropertyFile.Entry.Operation()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +toOperation

    +
    +public static int toOperation(java.lang.String oper)
    +
    +
    Convert string to index. +

    +

    +
    Parameters:
    oper - the string to convert. +
    Returns:
    the index.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Type.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Type.html new file mode 100644 index 000000000..a00c15a7c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.Type.html @@ -0,0 +1,381 @@ + + + + + + +PropertyFile.Entry.Type (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class PropertyFile.Entry.Type

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry.Type
+
    +
    +
    Enclosing class:
    PropertyFile.Entry
    +
    +
    +
    +
    public static class PropertyFile.Entry.Type
    extends EnumeratedAttribute
    + + +

    +Enumerated attribute with the values "int", "date" and "string". +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static intDATE_TYPE + +
    +          date
    +static intINTEGER_TYPE + +
    +          int
    +static intSTRING_TYPE + +
    +          string
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyFile.Entry.Type() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement.
    +static inttoType(java.lang.String type) + +
    +          Convert string to index.
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +INTEGER_TYPE

    +
    +public static final int INTEGER_TYPE
    +
    +
    int +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +DATE_TYPE

    +
    +public static final int DATE_TYPE
    +
    +
    date +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +STRING_TYPE

    +
    +public static final int STRING_TYPE
    +
    +
    string +

    +

    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyFile.Entry.Type

    +
    +public PropertyFile.Entry.Type()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    +
    + +

    +toType

    +
    +public static int toType(java.lang.String type)
    +
    +
    Convert string to index. +

    +

    +
    Parameters:
    type - the string to convert. +
    Returns:
    the index.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html new file mode 100644 index 000000000..e8a2bf2a2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Entry.html @@ -0,0 +1,452 @@ + + + + + + +PropertyFile.Entry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class PropertyFile.Entry

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.PropertyFile.Entry
+
    +
    +
    Enclosing class:
    PropertyFile
    +
    +
    +
    +
    public static class PropertyFile.Entry
    extends java.lang.Object
    + + +

    +Instance of this class represents nested elements of + a task propertyfile. +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classPropertyFile.Entry.Operation + +
    +          Enumerated attribute with the values "+", "-", "="
    +static classPropertyFile.Entry.Type + +
    +          Enumerated attribute with the values "int", "date" and "string".
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyFile.Entry() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +protected  voidexecuteOn(java.util.Properties props) + +
    +          Apply the nested element to the properties.
    + voidsetDefault(java.lang.String value) + +
    +          Initial value to set for a property if it is not + already defined in the property file.
    + voidsetKey(java.lang.String value) + +
    +          Name of the property name/value pair
    + voidsetOperation(PropertyFile.Entry.Operation value) + +
    +          operation to apply.
    + voidsetPattern(java.lang.String value) + +
    +          For int and date type only.
    + voidsetType(PropertyFile.Entry.Type value) + +
    +          Regard the value as : int, date or string (default)
    + voidsetUnit(PropertyFile.Unit unit) + +
    +          The unit of the value to be applied to date +/- operations.
    + voidsetValue(java.lang.String value) + +
    +          Value to set (=), to add (+) or subtract (-)
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyFile.Entry

    +
    +public PropertyFile.Entry()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setKey

    +
    +public void setKey(java.lang.String value)
    +
    +
    Name of the property name/value pair +

    +

    +
    Parameters:
    value - the key.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(java.lang.String value)
    +
    +
    Value to set (=), to add (+) or subtract (-) +

    +

    +
    Parameters:
    value - the value.
    +
    +
    +
    + +

    +setOperation

    +
    +public void setOperation(PropertyFile.Entry.Operation value)
    +
    +
    operation to apply. + "+" or "=" +(default) for all datatypes; "-" for date and int only)\. +

    +

    +
    Parameters:
    value - the operation enumerated value.
    +
    +
    +
    + +

    +setType

    +
    +public void setType(PropertyFile.Entry.Type value)
    +
    +
    Regard the value as : int, date or string (default) +

    +

    +
    Parameters:
    value - the type enumerated value.
    +
    +
    +
    + +

    +setDefault

    +
    +public void setDefault(java.lang.String value)
    +
    +
    Initial value to set for a property if it is not + already defined in the property file. + For type date, an additional keyword is allowed: "now" +

    +

    +
    Parameters:
    value - the default value.
    +
    +
    +
    + +

    +setPattern

    +
    +public void setPattern(java.lang.String value)
    +
    +
    For int and date type only. If present, Values will + be parsed and formatted accordingly. +

    +

    +
    Parameters:
    value - the pattern to use.
    +
    +
    +
    + +

    +setUnit

    +
    +public void setUnit(PropertyFile.Unit unit)
    +
    +
    The unit of the value to be applied to date +/- operations. + Valid Values are: +
      +
    • millisecond
      • +
    • second
      • +
    • minute
      • +
    • hour
      • +
    • day (default)
      • +
    • week
      • +
    • month
      • +
    • year
      • +
    + This only applies to date types using a +/- operation. +

    +

    +
    Parameters:
    unit - the unit enumerated value.
    Since:
    +
    Ant 1.5
    +
    +
    +
    +
    + +

    +executeOn

    +
    +protected void executeOn(java.util.Properties props)
+                  throws BuildException
    +
    +
    Apply the nested element to the properties. +

    +

    +
    Parameters:
    props - the properties to apply the entry on. +
    Throws: +
    BuildException - if there is an error.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Unit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Unit.html new file mode 100644 index 000000000..4ed992743 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.Unit.html @@ -0,0 +1,320 @@ + + + + + + +PropertyFile.Unit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class PropertyFile.Unit

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.PropertyFile.Unit
+
    +
    +
    Enclosing class:
    PropertyFile
    +
    +
    +
    +
    public static class PropertyFile.Unit
    extends EnumeratedAttribute
    + + +

    +Borrowed from Tstamp +

    + +

    +

    +
    Since:
    +
    Ant 1.5
    +
    To do:
    +
    share all this time stuff across many tasks as a datetime datatype
    +
    +
    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    value
    +  + + + + + + + + + + +
    +Constructor Summary
    PropertyFile.Unit() + +
    +          no arg constructor
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetCalendarField() + +
    +          Convert the value to a Calendar field index.
    + java.lang.String[]getValues() + +
    +          This is the only method a subclass needs to implement..
    +  + + + + + + + +
    Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
    containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +PropertyFile.Unit

    +
    +public PropertyFile.Unit()
    +
    +
    no arg constructor +

    +

    + + + + + + + + +
    +Method Detail
    + +

    +getCalendarField

    +
    +public int getCalendarField()
    +
    +
    Convert the value to a Calendar field index. +

    +

    + +
    Returns:
    the calander value.
    +
    +
    +
    + +

    +getValues

    +
    +public java.lang.String[] getValues()
    +
    +
    This is the only method a subclass needs to implement.. +

    +

    +
    Specified by:
    getValues in class EnumeratedAttribute
    +
    +
    + +
    Returns:
    an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.html new file mode 100644 index 000000000..64c18699f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/PropertyFile.html @@ -0,0 +1,484 @@ + + + + + + +PropertyFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.tools.ant.taskdefs.optional +
    +Class PropertyFile

    +
    +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.PropertyFile
+
    +
    +
    All Implemented Interfaces:
    java.lang.Cloneable
    +
    +
    +
    +
    public class PropertyFile
    extends Task
    + + +

    +Modifies settings in a property file. + +

    +The following is an example of its usage: +

      <target name="setState">
      +
        <property
        +
          name="header"
          + value="##Generated file - do not modify!"/>
          + <propertyfile file="apropfile.properties" comment="${header}">
          + <entry key="product.version.major" type="int" value="5"/>
          + <entry key="product.version.minor" type="int" value="0"/>
          + <entry key="product.build.major" type="int" value="0" />
          + <entry key="product.build.minor" type="int" operation="+" />
          + <entry key="product.build.date" type="date" value="now" />
          + <entry key="intSet" type="int" operation="=" value="681"/>
          + <entry key="intDec" type="int" operation="-"/>
          + <entry key="StringEquals" type="string" value="testValue"/>
          + </propertyfile>
        + </target>

      + +The <propertyfile> task must have:
      +

      • file
      +Other parameters are:
      +
      • comment, key, operation, type and value (the final four being + eliminated shortly)
      + +The <entry> task must have:
      +
      • key
      +Other parameters are:
      +
      • operation
        • +
      • type
        • +
      • value
        • +
      • default
        • +
      • unit
        • +
      + +If type is unspecified, it defaults to string + +Parameter values:
      +
      • operation:
        • +
        • "=" (set -- default)
          • +
        • "-" (dec)
          • +
        • "+" (inc)
          • + +
        • type:
          • +
          • "int"
            • +
          • "date"
            • +
          • "string"
        + +
      • value:
        • +
        • holds the default value, if the property + was not found in property file
          • +
        • "now" In case of type "date", the + value "now" will be replaced by the current + date/time and used even if a valid date was + found in the property file.
        + + +String property types can only use the "=" operation. +Int property types can only use the "=", "-" or "+" operations.

        + +The message property is used for the property file header, with "\\" being +a newline delimiter character. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + +
        +Nested Class Summary
        +static classPropertyFile.Entry + +
        +          Instance of this class represents nested elements of + a task propertyfile.
        +static classPropertyFile.Unit + +
        +          Borrowed from Tstamp
        +  + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        PropertyFile() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + PropertyFile.EntrycreateEntry() + +
        +          The entry nested element.
        + voidexecute() + +
        +          Execute the task.
        + voidsetComment(java.lang.String hdr) + +
        +          optional header comment for the file
        + voidsetFile(java.io.File file) + +
        +          Location of the property file to be edited; required.
        + voidsetJDKProperties(boolean val) + +
        +          optional flag to use original Java properties (as opposed to + layout preserving properties)
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +PropertyFile

        +
        +public PropertyFile()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - on error.
        +
        +
        +
        + +

        +createEntry

        +
        +public PropertyFile.Entry createEntry()
        +
        +
        The entry nested element. +

        +

        + +
        Returns:
        an entry nested element to be configured.
        +
        +
        +
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        Location of the property file to be edited; required. +

        +

        +
        Parameters:
        file - the property file.
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String hdr)
        +
        +
        optional header comment for the file +

        +

        +
        Parameters:
        hdr - the string to use for the comment.
        +
        +
        +
        + +

        +setJDKProperties

        +
        +public void setJDKProperties(boolean val)
        +
        +
        optional flag to use original Java properties (as opposed to + layout preserving properties) +

        +

        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/RenameExtensions.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/RenameExtensions.html new file mode 100644 index 000000000..3a978f8c9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/RenameExtensions.html @@ -0,0 +1,421 @@ + + + + + + +RenameExtensions (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class RenameExtensions

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.RenameExtensions
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, SelectorContainer
        +
        +
        +Deprecated. since 1.5.x. + Use <move> instead +

        +

        +
        public class RenameExtensions
        extends MatchingTask
        + + +

        +

        +
        Version:
        +
        1.2
        +
        +
        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        fileset
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        RenameExtensions() + +
        +          Deprecated. Creates new RenameExtensions
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Deprecated. Executes the task.
        + voidsetFromExtension(java.lang.String from) + +
        +          Deprecated. The string that files must end in to be renamed
        + voidsetReplace(boolean replace) + +
        +          Deprecated. store replace attribute - this determines whether the target file + should be overwritten if present
        + voidsetSrcDir(java.io.File srcDir) + +
        +          Deprecated. Set the source dir to find the files to be renamed.
        + voidsetToExtension(java.lang.String to) + +
        +          Deprecated. The string that renamed files will end with on + completion
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +RenameExtensions

        +
        +public RenameExtensions()
        +
        +
        Deprecated. 
        Creates new RenameExtensions +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +setFromExtension

        +
        +public void setFromExtension(java.lang.String from)
        +
        +
        Deprecated. 
        The string that files must end in to be renamed +

        +

        +
        Parameters:
        from - the extension of files being renamed.
        +
        +
        +
        + +

        +setToExtension

        +
        +public void setToExtension(java.lang.String to)
        +
        +
        Deprecated. 
        The string that renamed files will end with on + completion +

        +

        +
        Parameters:
        to - the extension of the renamed files.
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(boolean replace)
        +
        +
        Deprecated. 
        store replace attribute - this determines whether the target file + should be overwritten if present +

        +

        +
        Parameters:
        replace - if true overwrite any target files that exist.
        +
        +
        +
        + +

        +setSrcDir

        +
        +public void setSrcDir(java.io.File srcDir)
        +
        +
        Deprecated. 
        Set the source dir to find the files to be renamed. +

        +

        +
        Parameters:
        srcDir - the source directory.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Deprecated. 
        Executes the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - is there is a problem in the task execution.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.html new file mode 100644 index 000000000..1dcaa291d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ReplaceRegExp.html @@ -0,0 +1,732 @@ + + + + + + +ReplaceRegExp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class ReplaceRegExp

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ReplaceRegExp
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class ReplaceRegExp
        extends Task
        + + +

        +Performs regular expression string replacements in a text + file. The input file(s) must be able to be properly processed by + a Reader instance. That is, they must be text only, no binary. + + The syntax of the regular expression depends on the implementation that + you choose to use. The system property ant.regexp.regexpimpl + will be the classname of the implementation that will be used (the default + is org.apache.tools.ant.util.regexp.JakartaOroRegexp and + requires the Jakarta Oro Package). + + 

        + Available implementations:
+
+   org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp (default)
+        Uses Java's built-in regular expression package
+
+   org.apache.tools.ant.util.regexp.JakartaOroRegexp
+        Requires  the jakarta-oro package
+
+   org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
+        Requires the jakarta-regexp package
+
+ Usage:
+
+   Call Syntax:
+
+     <replaceregexp file="file"
+                    match="pattern"
+                    replace="pattern"
+                    flags="options"?
+                    byline="true|false"? >
+       regexp?
+       substitution?
+       fileset*
+     </replaceregexp>
+
+    NOTE: You must have either the file attribute specified, or at least one fileset subelement
+    to operation on.  You may not have the file attribute specified if you nest fileset elements
+    inside this task.  Also, you cannot specify both match and a regular expression subelement at
+    the same time, nor can you specify the replace attribute and the substitution subelement at
+    the same time.
+
+   Attributes:
+
+     file    --> A single file to operation on (mutually exclusive
+                    with the fileset subelements)
+     match   --> The Regular expression to match
+     replace --> The Expression replacement string
+     flags   --> The options to give to the replacement
+                 g = Substitute all occurrences. default is to replace only the first one
+                 i = Case insensitive match
+
+     byline  --> Should this file be processed a single line at a time (default is false)
+                 "true" indicates to perform replacement on a line by line basis
+                 "false" indicates to perform replacement on the whole file at once.
+
+  Example:
+
+     The following call could be used to replace an old property name in a ".properties"
+     file with a new name.  In the replace attribute, you can refer to any part of the
+     match expression in parenthesis using backslash followed by a number like '\1'.
+
+     <replaceregexp file="test.properties"
+                    match="MyProperty=(.*)"
+                    replace="NewProperty=\1"
+                    byline="true" />
+
+
        +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        ReplaceRegExp() + +
        +          Default Constructor
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfigured(ResourceCollection rc) + +
        +          Support arbitrary file system based resource collections.
        + voidaddFileset(FileSet set) + +
        +          list files to apply the replacement to
        + RegularExpressioncreateRegexp() + +
        +          A regular expression.
        + SubstitutioncreateSubstitution() + +
        +          A substitution pattern.
        +protected  voiddoReplace(java.io.File f, + int options) + +
        +          Perform the replacement on a file
        +protected  java.lang.StringdoReplace(RegularExpression r, + Substitution s, + java.lang.String input, + int options) + +
        +          Invoke a regular expression (r) on a string (input) using + substitutions (s) for a matching regex.
        + voidexecute() + +
        +          Execute the task
        + voidsetByLine(boolean byline) + +
        +          Process the file(s) one line at a time, executing the replacement + on one line at a time.
        + voidsetByLine(java.lang.String byline) + +
        +          Deprecated. since 1.6.x. + Use setByLine(boolean).
        + voidsetEncoding(java.lang.String encoding) + +
        +          Specifies the encoding Ant expects the files to be in - + defaults to the platforms default encoding.
        + voidsetFile(java.io.File file) + +
        +          file for which the regular expression should be replaced; + required unless a nested fileset is supplied.
        + voidsetFlags(java.lang.String flags) + +
        +          The flags to use when matching the regular expression.
        + voidsetMatch(java.lang.String match) + +
        +          the regular expression pattern to match in the file(s); + required if no nested <regexp> is used
        + voidsetPreserveLastModified(boolean b) + +
        +          Whether the file timestamp shall be preserved even if the file + is modified.
        + voidsetReplace(java.lang.String replace) + +
        +          The substitution pattern to place in the file(s) in place + of the regular expression.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ReplaceRegExp

        +
        +public ReplaceRegExp()
        +
        +
        Default Constructor +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        file for which the regular expression should be replaced; + required unless a nested fileset is supplied. +

        +

        +
        Parameters:
        file - The file for which the reg exp should be replaced.
        +
        +
        +
        + +

        +setMatch

        +
        +public void setMatch(java.lang.String match)
        +
        +
        the regular expression pattern to match in the file(s); + required if no nested <regexp> is used +

        +

        +
        Parameters:
        match - the match attribute.
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(java.lang.String replace)
        +
        +
        The substitution pattern to place in the file(s) in place + of the regular expression. + Required if no nested <substitution> is used +

        +

        +
        Parameters:
        replace - the replace attribute
        +
        +
        +
        + +

        +setFlags

        +
        +public void setFlags(java.lang.String flags)
        +
        +
        The flags to use when matching the regular expression. For more + information, consult the Perl5 syntax. +
          +
        • g : Global replacement. Replace all occurrences found +
        • i : Case Insensitive. Do not consider case in the match +
        • m : Multiline. Treat the string as multiple lines of input, + using "^" and "$" as the start or end of any line, respectively, + rather than start or end of string. +
        • s : Singleline. Treat the string as a single line of input, using + "." to match any character, including a newline, which normally, + it would not match. +
        +

        +

        +
        Parameters:
        flags - the flags attribute
        +
        +
        +
        + +

        +setByLine

        +
        +public void setByLine(java.lang.String byline)
        +
        +
        Deprecated. since 1.6.x. + Use setByLine(boolean). +

        +

        Process the file(s) one line at a time, executing the replacement + on one line at a time. This is useful if you + want to only replace the first occurrence of a regular expression on + each line, which is not easy to do when processing the file as a whole. + Defaults to false. +

        +

        +
        Parameters:
        byline - the byline attribute as a string
        +
        +
        +
        + +

        +setByLine

        +
        +public void setByLine(boolean byline)
        +
        +
        Process the file(s) one line at a time, executing the replacement + on one line at a time. This is useful if you + want to only replace the first occurrence of a regular expression on + each line, which is not easy to do when processing the file as a whole. + Defaults to false. +

        +

        +
        Parameters:
        byline - the byline attribute
        +
        +
        +
        + +

        +setEncoding

        +
        +public void setEncoding(java.lang.String encoding)
        +
        +
        Specifies the encoding Ant expects the files to be in - + defaults to the platforms default encoding. +

        +

        +
        Parameters:
        encoding - the encoding attribute
        Since:
        +
        Ant 1.6
        +
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet set)
        +
        +
        list files to apply the replacement to +

        +

        +
        Parameters:
        set - the fileset element
        +
        +
        +
        + +

        +addConfigured

        +
        +public void addConfigured(ResourceCollection rc)
        +
        +
        Support arbitrary file system based resource collections. +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +createRegexp

        +
        +public RegularExpression createRegexp()
        +
        +
        A regular expression. + You can use this element to refer to a previously + defined regular expression datatype instance +

        +

        + +
        Returns:
        the regular expression object to be configured as an element
        +
        +
        +
        + +

        +createSubstitution

        +
        +public Substitution createSubstitution()
        +
        +
        A substitution pattern. You can use this element to refer to a previously + defined substitution pattern datatype instance. +

        +

        + +
        Returns:
        the substitution pattern object to be configured as an element
        +
        +
        +
        + +

        +setPreserveLastModified

        +
        +public void setPreserveLastModified(boolean b)
        +
        +
        Whether the file timestamp shall be preserved even if the file + is modified. +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +doReplace

        +
        +protected java.lang.String doReplace(RegularExpression r,
+                                     Substitution s,
+                                     java.lang.String input,
+                                     int options)
        +
        +
        Invoke a regular expression (r) on a string (input) using + substitutions (s) for a matching regex. +

        +

        +
        Parameters:
        r - a regular expression
        s - a Substitution
        input - the string to do the replacement on
        options - The options for the regular expression +
        Returns:
        the replacement result
        +
        +
        +
        + +

        +doReplace

        +
        +protected void doReplace(java.io.File f,
+                         int options)
+                  throws java.io.IOException
        +
        +
        Perform the replacement on a file +

        +

        +
        Parameters:
        f - the file to perform the relacement on
        options - the regular expressions options +
        Throws: +
        java.io.IOException - if an error occurs
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - is there is a problem in the task execution.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Rpm.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Rpm.html new file mode 100644 index 000000000..9c6c4a057 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Rpm.html @@ -0,0 +1,615 @@ + + + + + + +Rpm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class Rpm

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.Rpm
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class Rpm
        extends Task
        + + +

        +Invokes the rpm tool to build a Linux installation file. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Rpm() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Execute the task
        +protected  ExecutegetExecute(Commandline toExecute, + ExecuteStreamHandler streamhandler) + +
        +          Get the execute object.
        +protected  java.lang.StringguessRpmBuildCommand() + +
        +          Checks whether rpmbuild is on the PATH and returns + the absolute path to it - falls back to rpm + otherwise.
        + voidsetCleanBuildDir(boolean cbd) + +
        +          Flag (optional, default=false) to remove + the generated files in the BUILD directory
        + voidsetCommand(java.lang.String c) + +
        +          What command to issue to the rpm build tool; optional.
        + voidsetError(java.io.File error) + +
        +          Optional file to save stderr to
        + voidsetFailOnError(boolean value) + +
        +          If true, stop the build process when the rpmbuild command + exits with an error status.
        + voidsetOutput(java.io.File output) + +
        +          Optional file to save stdout to.
        + voidsetQuiet(boolean value) + +
        +          If true, output from the RPM build command will only be logged to DEBUG.
        + voidsetRemoveSource(boolean rs) + +
        +          Flag (optional, default=false) + to remove the sources after the build.
        + voidsetRemoveSpec(boolean rs) + +
        +          Flag (optional, default=false) to remove the spec file from SPECS
        + voidsetRpmBuildCommand(java.lang.String c) + +
        +          The executable to run when building; optional.
        + voidsetSpecFile(java.lang.String sf) + +
        +          The name of the spec File to use; required.
        + voidsetTopDir(java.io.File td) + +
        +          The directory which will have the expected + subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Rpm

        +
        +public Rpm()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - is there is a problem in the task execution.
        +
        +
        +
        + +

        +setTopDir

        +
        +public void setTopDir(java.io.File td)
        +
        +
        The directory which will have the expected + subdirectories, SPECS, SOURCES, BUILD, SRPMS ; optional. + If this isn't specified, + the baseDir value is used +

        +

        +
        Parameters:
        td - the directory containing the normal RPM directories.
        +
        +
        +
        + +

        +setCommand

        +
        +public void setCommand(java.lang.String c)
        +
        +
        What command to issue to the rpm build tool; optional. + The default is "-bb" +

        +

        +
        Parameters:
        c - the command to use.
        +
        +
        +
        + +

        +setSpecFile

        +
        +public void setSpecFile(java.lang.String sf)
        +
        +
        The name of the spec File to use; required. +

        +

        +
        Parameters:
        sf - the spec file name to use.
        +
        +
        +
        + +

        +setCleanBuildDir

        +
        +public void setCleanBuildDir(boolean cbd)
        +
        +
        Flag (optional, default=false) to remove + the generated files in the BUILD directory +

        +

        +
        Parameters:
        cbd - a boolean value.
        +
        +
        +
        + +

        +setRemoveSpec

        +
        +public void setRemoveSpec(boolean rs)
        +
        +
        Flag (optional, default=false) to remove the spec file from SPECS +

        +

        +
        Parameters:
        rs - a boolean value.
        +
        +
        +
        + +

        +setRemoveSource

        +
        +public void setRemoveSource(boolean rs)
        +
        +
        Flag (optional, default=false) + to remove the sources after the build. + See the --rmsource option of rpmbuild. +

        +

        +
        Parameters:
        rs - a boolean value.
        +
        +
        +
        + +

        +setOutput

        +
        +public void setOutput(java.io.File output)
        +
        +
        Optional file to save stdout to. +

        +

        +
        Parameters:
        output - the file to save stdout to.
        +
        +
        +
        + +

        +setError

        +
        +public void setError(java.io.File error)
        +
        +
        Optional file to save stderr to +

        +

        +
        Parameters:
        error - the file to save error output to.
        +
        +
        +
        + +

        +setRpmBuildCommand

        +
        +public void setRpmBuildCommand(java.lang.String c)
        +
        +
        The executable to run when building; optional. + The default is rpmbuild. +

        +

        +
        Parameters:
        c - the rpm build executable
        Since:
        +
        Ant 1.6
        +
        +
        +
        +
        + +

        +setFailOnError

        +
        +public void setFailOnError(boolean value)
        +
        +
        If true, stop the build process when the rpmbuild command + exits with an error status. +

        +

        +
        Parameters:
        value - true if it should halt, otherwise + false. The default is false.
        Since:
        +
        Ant 1.6.3
        +
        +
        +
        +
        + +

        +setQuiet

        +
        +public void setQuiet(boolean value)
        +
        +
        If true, output from the RPM build command will only be logged to DEBUG. +

        +

        +
        Parameters:
        value - false if output should be logged, otherwise + true. The default is false.
        Since:
        +
        Ant 1.6.3
        +
        +
        +
        +
        + +

        +guessRpmBuildCommand

        +
        +protected java.lang.String guessRpmBuildCommand()
        +
        +
        Checks whether rpmbuild is on the PATH and returns + the absolute path to it - falls back to rpm + otherwise. +

        +

        + +
        Returns:
        the command used to build RPM's
        Since:
        +
        1.6
        +
        +
        +
        +
        + +

        +getExecute

        +
        +protected Execute getExecute(Commandline toExecute,
+                             ExecuteStreamHandler streamhandler)
        +
        +
        Get the execute object. +

        +

        +
        Parameters:
        toExecute - the command line to use.
        streamhandler - the stream handler to use. +
        Returns:
        the execute object.
        Since:
        +
        Ant 1.6.3
        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.SchemaLocation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.SchemaLocation.html new file mode 100644 index 000000000..69309b87e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.SchemaLocation.html @@ -0,0 +1,635 @@ + + + + + + +SchemaValidate.SchemaLocation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class SchemaValidate.SchemaLocation

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.SchemaValidate.SchemaLocation
+
        +
        +
        Enclosing class:
        SchemaValidate
        +
        +
        +
        +
        public static class SchemaValidate.SchemaLocation
        extends java.lang.Object
        + + +

        +representation of a schema location. This is a URI plus either a file or + a url +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringERROR_NO_FILE + +
        +          File not found
        +static java.lang.StringERROR_NO_LOCATION + +
        +          No location provided
        +static java.lang.StringERROR_NO_URI + +
        +          No namespace URI
        +static java.lang.StringERROR_NO_URL_REPRESENTATION + +
        +          Cannot make URL
        +static java.lang.StringERROR_TWO_LOCATIONS + +
        +          Both URL and File were given for schema
        +  + + + + + + + + + + +
        +Constructor Summary
        SchemaValidate.SchemaLocation() + +
        +          No arg constructor
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + booleanequals(java.lang.Object o) + +
        +          equality test checks namespace, location and filename.
        + java.io.FilegetFile() + +
        +          Get the file.
        + java.lang.StringgetNamespace() + +
        +          Get the namespace.
        + java.lang.StringgetSchemaLocationURL() + +
        +          get the URL of the schema
        + java.lang.StringgetURIandLocation() + +
        +          validate the fields then create a "uri location" string
        + java.lang.StringgetUrl() + +
        +          The URL containing the schema.
        + inthashCode() + +
        +          Generate a hashcode depending on the namespace, url and file name.
        + voidsetFile(java.io.File file) + +
        +          identify a file that contains this namespace's schema.
        + voidsetNamespace(java.lang.String namespace) + +
        +          set the namespace of this schema.
        + voidsetUrl(java.lang.String url) + +
        +          identify a URL that hosts the schema.
        + java.lang.StringtoString() + +
        +          Returns a string representation of the object for error messages + and the like
        + voidvalidateNamespace() + +
        +          assert that a namespace is valid
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +ERROR_NO_URI

        +
        +public static final java.lang.String ERROR_NO_URI
        +
        +
        No namespace URI +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_TWO_LOCATIONS

        +
        +public static final java.lang.String ERROR_TWO_LOCATIONS
        +
        +
        Both URL and File were given for schema +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_NO_FILE

        +
        +public static final java.lang.String ERROR_NO_FILE
        +
        +
        File not found +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_NO_URL_REPRESENTATION

        +
        +public static final java.lang.String ERROR_NO_URL_REPRESENTATION
        +
        +
        Cannot make URL +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_NO_LOCATION

        +
        +public static final java.lang.String ERROR_NO_LOCATION
        +
        +
        No location provided +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +SchemaValidate.SchemaLocation

        +
        +public SchemaValidate.SchemaLocation()
        +
        +
        No arg constructor +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +getNamespace

        +
        +public java.lang.String getNamespace()
        +
        +
        Get the namespace. +

        +

        + +
        Returns:
        the namespace.
        +
        +
        +
        + +

        +setNamespace

        +
        +public void setNamespace(java.lang.String namespace)
        +
        +
        set the namespace of this schema. Any URI +

        +

        +
        Parameters:
        namespace - the namespace to use.
        +
        +
        +
        + +

        +getFile

        +
        +public java.io.File getFile()
        +
        +
        Get the file. +

        +

        + +
        Returns:
        the file containing the schema.
        +
        +
        +
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        identify a file that contains this namespace's schema. + The file must exist. +

        +

        +
        Parameters:
        file - the file contains the schema.
        +
        +
        +
        + +

        +getUrl

        +
        +public java.lang.String getUrl()
        +
        +
        The URL containing the schema. +

        +

        + +
        Returns:
        the URL string.
        +
        +
        +
        + +

        +setUrl

        +
        +public void setUrl(java.lang.String url)
        +
        +
        identify a URL that hosts the schema. +

        +

        +
        Parameters:
        url - the URL string.
        +
        +
        +
        + +

        +getSchemaLocationURL

        +
        +public java.lang.String getSchemaLocationURL()
        +
        +
        get the URL of the schema +

        +

        + +
        Returns:
        a URL to the schema +
        Throws: +
        BuildException - if not
        +
        +
        +
        + +

        +getURIandLocation

        +
        +public java.lang.String getURIandLocation()
+                                   throws BuildException
        +
        +
        validate the fields then create a "uri location" string +

        +

        + +
        Returns:
        string of uri and location +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +validateNamespace

        +
        +public void validateNamespace()
        +
        +
        assert that a namespace is valid +

        +

        + +
        Throws: +
        BuildException - if not
        +
        +
        +
        + +

        +equals

        +
        +public boolean equals(java.lang.Object o)
        +
        +
        equality test checks namespace, location and filename. All must match, +

        +

        +
        Overrides:
        equals in class java.lang.Object
        +
        +
        +
        Parameters:
        o - object to compare against +
        Returns:
        true iff the objects are considered equal in value
        +
        +
        +
        + +

        +hashCode

        +
        +public int hashCode()
        +
        +
        Generate a hashcode depending on the namespace, url and file name. +

        +

        +
        Overrides:
        hashCode in class java.lang.Object
        +
        +
        + +
        Returns:
        the hashcode.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Returns a string representation of the object for error messages + and the like +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        a string representation of the object.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.html new file mode 100644 index 000000000..ad66a502c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/SchemaValidate.html @@ -0,0 +1,821 @@ + + + + + + +SchemaValidate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class SchemaValidate

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.XMLValidateTask
+              extended by org.apache.tools.ant.taskdefs.optional.SchemaValidate
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class SchemaValidate
        extends XMLValidateTask
        + + +

        +Validate XML Schema documents. + This task validates XML schema documents. It requires an XML parser + that handles the relevant SAx, Xerces or JAXP options. + + To resolve remote referencies, Ant may need its proxy set up, using the + setproxy task. + + Hands off most of the work to its parent, XMLValidateTask +

        + +

        +

        +
        Since:
        +
        Ant1.7
        +
        +
        + +

        + + + + + + + + + + + +
        +Nested Class Summary
        +static classSchemaValidate.SchemaLocation + +
        +          representation of a schema location.
        +  + + + + + + + +
        Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.XMLValidateTask
        XMLValidateTask.Attribute, XMLValidateTask.Property, XMLValidateTask.ValidatorErrorHandler
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringERROR_DUPLICATE_SCHEMA + +
        +          Duplicate declaration of schema
        +static java.lang.StringERROR_NO_XSD_SUPPORT + +
        +          schema features not supported
        +static java.lang.StringERROR_PARSER_CREATION_FAILURE + +
        +          unable to create parser
        +static java.lang.StringERROR_SAX_1 + +
        +          SAX1 not supported
        +static java.lang.StringERROR_TOO_MANY_DEFAULT_SCHEMAS + +
        +          too many default schemas
        +static java.lang.StringMESSAGE_ADDING_SCHEMA + +
        +          adding schema
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.XMLValidateTask
        classpath, errorHandler, failOnError, file, filesets, INIT_FAILED_MSG, lenient, MESSAGE_FILES_VALIDATED, readerClassName, warn, xmlReader
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        SchemaValidate() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfiguredSchema(SchemaValidate.SchemaLocation location) + +
        +          add the schema
        +protected  voidaddSchemaLocations() + +
        +          build a string list of all schema locations, then set the relevant + property.
        +protected  voidcreateAnonymousSchema() + +
        +          create a schema location to hold the anonymous + schema
        +protected  org.xml.sax.XMLReadercreateDefaultReader() + +
        +          Create a reader if the use of the class did not specify another one.
        + booleanenableJAXP12SchemaValidation() + +
        +          Set schema attributes in a JAXP 1.2 engine.
        + booleanenableXercesSchemaValidation() + +
        +          Turn on XSD support in Xerces.
        +protected  java.lang.StringgetNoNamespaceSchemaURL() + +
        +          get the URL of the no namespace schema
        + voidinit() + +
        +          Called by the project to let the task initialize properly.
        +protected  voidinitValidator() + +
        +          init the parser : load the parser class, and set features if necessary It + is only after this that the reader is valid
        +protected  voidonSuccessfulValidation(int fileProcessed) + +
        +          handler called on successful file validation.
        + voidsetDisableDTD(boolean disableDTD) + +
        +          flag to disable DTD support.
        +protected  voidsetFeatureIfSupported(java.lang.String feature, + boolean value) + +
        +          set a feature if it is supported, log at verbose level if + not
        + voidsetFullChecking(boolean fullChecking) + +
        +          enable full schema checking.
        + voidsetNoNamespaceFile(java.io.File defaultSchemaFile) + +
        +          identify a file containing the default schema
        + voidsetNoNamespaceURL(java.lang.String defaultSchemaURL) + +
        +          identify the URL of the default schema
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.XMLValidateTask
        addConfiguredXMLCatalog, addFileset, cleanup, createAttribute, createClasspath, createDTD, createProperty, createXmlReader, doValidate, execute, getEntityResolver, getXmlReader, isSax1Parser, setClassName, setClasspath, setClasspathRef, setFailOnError, setFeature, setFile, setLenient, setProperty, setWarn
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +ERROR_SAX_1

        +
        +public static final java.lang.String ERROR_SAX_1
        +
        +
        SAX1 not supported +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_NO_XSD_SUPPORT

        +
        +public static final java.lang.String ERROR_NO_XSD_SUPPORT
        +
        +
        schema features not supported +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_TOO_MANY_DEFAULT_SCHEMAS

        +
        +public static final java.lang.String ERROR_TOO_MANY_DEFAULT_SCHEMAS
        +
        +
        too many default schemas +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_PARSER_CREATION_FAILURE

        +
        +public static final java.lang.String ERROR_PARSER_CREATION_FAILURE
        +
        +
        unable to create parser +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +MESSAGE_ADDING_SCHEMA

        +
        +public static final java.lang.String MESSAGE_ADDING_SCHEMA
        +
        +
        adding schema +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ERROR_DUPLICATE_SCHEMA

        +
        +public static final java.lang.String ERROR_DUPLICATE_SCHEMA
        +
        +
        Duplicate declaration of schema +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +SchemaValidate

        +
        +public SchemaValidate()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +init

        +
        +public void init()
+          throws BuildException
        +
        +
        Called by the project to let the task initialize properly. The default + implementation is a no-op. +

        +

        +
        Overrides:
        init in class XMLValidateTask
        +
        +
        + +
        Throws: +
        BuildException - if something goes wrong with the build
        +
        +
        +
        + +

        +enableXercesSchemaValidation

        +
        +public boolean enableXercesSchemaValidation()
        +
        +
        Turn on XSD support in Xerces. +

        +

        + +
        Returns:
        true on success, false on failure
        +
        +
        +
        + +

        +enableJAXP12SchemaValidation

        +
        +public boolean enableJAXP12SchemaValidation()
        +
        +
        Set schema attributes in a JAXP 1.2 engine. +

        +

        + +
        Returns:
        true on success, false on failure
        See Also:
        + JAXP 1.2 Approved CHANGES
        +
        +
        +
        + +

        +addConfiguredSchema

        +
        +public void addConfiguredSchema(SchemaValidate.SchemaLocation location)
        +
        +
        add the schema +

        +

        +
        Parameters:
        location - the schema location. +
        Throws: +
        BuildException - if there is no namespace, or if there already + is a declaration of this schema with a different value
        +
        +
        +
        + +

        +setFullChecking

        +
        +public void setFullChecking(boolean fullChecking)
        +
        +
        enable full schema checking. Slower but better. +

        +

        +
        Parameters:
        fullChecking - a boolean value.
        +
        +
        +
        + +

        +createAnonymousSchema

        +
        +protected void createAnonymousSchema()
        +
        +
        create a schema location to hold the anonymous + schema +

        +

        +
        +
        +
        +
        + +

        +setNoNamespaceURL

        +
        +public void setNoNamespaceURL(java.lang.String defaultSchemaURL)
        +
        +
        identify the URL of the default schema +

        +

        +
        Parameters:
        defaultSchemaURL - the URL of the default schema.
        +
        +
        +
        + +

        +setNoNamespaceFile

        +
        +public void setNoNamespaceFile(java.io.File defaultSchemaFile)
        +
        +
        identify a file containing the default schema +

        +

        +
        Parameters:
        defaultSchemaFile - the location of the default schema.
        +
        +
        +
        + +

        +setDisableDTD

        +
        +public void setDisableDTD(boolean disableDTD)
        +
        +
        flag to disable DTD support. +

        +

        +
        Parameters:
        disableDTD - a boolean value.
        +
        +
        +
        + +

        +initValidator

        +
        +protected void initValidator()
        +
        +
        init the parser : load the parser class, and set features if necessary It + is only after this that the reader is valid +

        +

        +
        Overrides:
        initValidator in class XMLValidateTask
        +
        +
        + +
        Throws: +
        BuildException - if something went wrong
        +
        +
        +
        + +

        +createDefaultReader

        +
        +protected org.xml.sax.XMLReader createDefaultReader()
        +
        +
        Create a reader if the use of the class did not specify another one. + The reason to not use JAXPUtils.getXMLReader() was to + create our own factory with our own options. +

        +

        +
        Overrides:
        createDefaultReader in class XMLValidateTask
        +
        +
        + +
        Returns:
        a default XML parser
        +
        +
        +
        + +

        +addSchemaLocations

        +
        +protected void addSchemaLocations()
        +
        +
        build a string list of all schema locations, then set the relevant + property. +

        +

        +
        +
        +
        +
        + +

        +getNoNamespaceSchemaURL

        +
        +protected java.lang.String getNoNamespaceSchemaURL()
        +
        +
        get the URL of the no namespace schema +

        +

        + +
        Returns:
        the schema URL
        +
        +
        +
        + +

        +setFeatureIfSupported

        +
        +protected void setFeatureIfSupported(java.lang.String feature,
+                                     boolean value)
        +
        +
        set a feature if it is supported, log at verbose level if + not +

        +

        +
        Parameters:
        feature - the feature.
        value - a boolean value.
        +
        +
        +
        + +

        +onSuccessfulValidation

        +
        +protected void onSuccessfulValidation(int fileProcessed)
        +
        +
        handler called on successful file validation. +

        +

        +
        Overrides:
        onSuccessfulValidation in class XMLValidateTask
        +
        +
        +
        Parameters:
        fileProcessed - number of files processed.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Script.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Script.html new file mode 100644 index 000000000..07f0822e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Script.html @@ -0,0 +1,509 @@ + + + + + + +Script (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class Script

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.Script
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class Script
        extends Task
        + + +

        +Executes a script. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Script() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddText(java.lang.String text) + +
        +          Set the script text.
        + PathcreateClasspath() + +
        +          Classpath to be used when searching for classes and resources.
        + voidexecute() + +
        +          Run the script using the helper object.
        + voidsetClasspath(Path classpath) + +
        +          Set the classpath to be used when searching for classes and resources.
        + voidsetClasspathRef(Reference r) + +
        +          Set the classpath by reference.
        + voidsetLanguage(java.lang.String language) + +
        +          Defines the language (required).
        + voidsetManager(java.lang.String manager) + +
        +          Defines the manager.
        + voidsetProject(Project project) + +
        +          Set the project.
        + voidsetSetBeans(boolean setBeans) + +
        +          Set the setbeans attribute.
        + voidsetSrc(java.lang.String fileName) + +
        +          Load the script from an external file ; optional.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Script

        +
        +public Script()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setProject

        +
        +public void setProject(Project project)
        +
        +
        Set the project. +

        +

        +
        Overrides:
        setProject in class ProjectComponent
        +
        +
        +
        Parameters:
        project - the project that this task belongs to.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Run the script using the helper object. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if something goes wrong with the build
        +
        +
        +
        + +

        +setManager

        +
        +public void setManager(java.lang.String manager)
        +
        +
        Defines the manager. +

        +

        +
        Parameters:
        manager - the scripting manager.
        +
        +
        +
        + +

        +setLanguage

        +
        +public void setLanguage(java.lang.String language)
        +
        +
        Defines the language (required). +

        +

        +
        Parameters:
        language - the scripting language name for the script.
        +
        +
        +
        + +

        +setSrc

        +
        +public void setSrc(java.lang.String fileName)
        +
        +
        Load the script from an external file ; optional. +

        +

        +
        Parameters:
        fileName - the name of the file containing the script source.
        +
        +
        +
        + +

        +addText

        +
        +public void addText(java.lang.String text)
        +
        +
        Set the script text. +

        +

        +
        Parameters:
        text - a component of the script text to be added.
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Set the classpath to be used when searching for classes and resources. +

        +

        +
        Parameters:
        classpath - an Ant Path object containing the search path.
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Classpath to be used when searching for classes and resources. +

        +

        + +
        Returns:
        an empty Path instance to be configured by Ant.
        +
        +
        +
        + +

        +setClasspathRef

        +
        +public void setClasspathRef(Reference r)
        +
        +
        Set the classpath by reference. +

        +

        +
        Parameters:
        r - a Reference to a Path instance to be used as the classpath + value.
        +
        +
        +
        + +

        +setSetBeans

        +
        +public void setSetBeans(boolean setBeans)
        +
        +
        Set the setbeans attribute. + If this is true, <script> will create variables in the + script instance for all + properties, targets and references of the current project. + It this is false, only the project and self variables will + be set. + The default is true. +

        +

        +
        Parameters:
        setBeans - the value to set.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/TraXLiaison.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/TraXLiaison.html new file mode 100644 index 000000000..a090cd623 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/TraXLiaison.html @@ -0,0 +1,655 @@ + + + + + + +TraXLiaison (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class TraXLiaison

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.TraXLiaison
+
        +
        +
        All Implemented Interfaces:
        javax.xml.transform.ErrorListener, XSLTLiaison, XSLTLiaison2, XSLTLiaison3, XSLTLoggerAware
        +
        +
        +
        +
        public class TraXLiaison
        extends java.lang.Object
        implements XSLTLiaison3, javax.xml.transform.ErrorListener, XSLTLoggerAware
        + + +

        +Concrete liaison for XSLT processor implementing TraX. (ie JAXP 1.1) +

        + +

        +

        +
        Since:
        +
        Ant 1.3
        +
        +
        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from interface org.apache.tools.ant.taskdefs.XSLTLiaison
        FILE_PROTOCOL_PREFIX
        +  + + + + + + + + + + +
        +Constructor Summary
        TraXLiaison() + +
        +          Constructor for TraXLiaison.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddParam(java.lang.String name, + java.lang.String value) + +
        +          Add a parameter.
        + voidconfigure(XSLTProcess xsltTask) + +
        +          Specific configuration for the TRaX liaison.
        + voiderror(javax.xml.transform.TransformerException e) + +
        +          Log an error.
        + voidfatalError(javax.xml.transform.TransformerException e) + +
        +          Log a fatal error.
        +protected  java.lang.StringgetSystemId(java.io.File file) + +
        +          Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead.
        + voidsetAttribute(java.lang.String name, + java.lang.Object value) + +
        +          Set a custom attribute for the JAXP factory implementation.
        + voidsetEntityResolver(org.xml.sax.EntityResolver aResolver) + +
        +          Set the class to resolve entities during the transformation.
        + voidsetFactory(java.lang.String name) + +
        +          Set the factory name to use instead of JAXP default lookup.
        + voidsetLogger(XSLTLogger l) + +
        +          Set a logger.
        + voidsetOutputProperty(java.lang.String name, + java.lang.String value) + +
        +          Set the output property for the current transformer.
        + voidsetStylesheet(java.io.File stylesheet) + +
        +          Set the stylesheet file.
        + voidsetStylesheet(Resource stylesheet) + +
        +          Set the stylesheet file.
        + voidsetURIResolver(javax.xml.transform.URIResolver aResolver) + +
        +          Set the class to resolve URIs during the transformation
        + voidtransform(java.io.File infile, + java.io.File outfile) + +
        +          Transform an input file.
        + voidwarning(javax.xml.transform.TransformerException e) + +
        +          Log a warning.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +TraXLiaison

        +
        +public TraXLiaison()
+            throws java.lang.Exception
        +
        +
        Constructor for TraXLiaison. +

        +

        + +
        Throws: +
        java.lang.Exception - never
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setStylesheet

        +
        +public void setStylesheet(java.io.File stylesheet)
+                   throws java.lang.Exception
        +
        +
        Set the stylesheet file. +

        +

        +
        Specified by:
        setStylesheet in interface XSLTLiaison
        +
        +
        +
        Parameters:
        stylesheet - a File value +
        Throws: +
        java.lang.Exception - on error
        +
        +
        +
        + +

        +setStylesheet

        +
        +public void setStylesheet(Resource stylesheet)
+                   throws java.lang.Exception
        +
        +
        Set the stylesheet file. +

        +

        +
        Specified by:
        setStylesheet in interface XSLTLiaison3
        +
        +
        +
        Parameters:
        stylesheet - a Resource value +
        Throws: +
        java.lang.Exception - on error
        +
        +
        +
        + +

        +transform

        +
        +public void transform(java.io.File infile,
+                      java.io.File outfile)
+               throws java.lang.Exception
        +
        +
        Transform an input file. +

        +

        +
        Specified by:
        transform in interface XSLTLiaison
        +
        +
        +
        Parameters:
        infile - the file to transform
        outfile - the result file +
        Throws: +
        java.lang.Exception - on error
        See Also:
        XSLTLiaison.setStylesheet(File)
        +
        +
        +
        + +

        +setFactory

        +
        +public void setFactory(java.lang.String name)
        +
        +
        Set the factory name to use instead of JAXP default lookup. +

        +

        +
        +
        +
        +
        Parameters:
        name - the fully qualified class name of the factory to use + or null for the default JAXP look up mechanism.
        Since:
        +
        Ant 1.6
        +
        +
        +
        +
        + +

        +setAttribute

        +
        +public void setAttribute(java.lang.String name,
+                         java.lang.Object value)
        +
        +
        Set a custom attribute for the JAXP factory implementation. +

        +

        +
        +
        +
        +
        Parameters:
        name - the attribute name.
        value - the value of the attribute, usually a boolean + string or object.
        Since:
        +
        Ant 1.6
        +
        +
        +
        +
        + +

        +setOutputProperty

        +
        +public void setOutputProperty(java.lang.String name,
+                              java.lang.String value)
        +
        +
        Set the output property for the current transformer. + Note that the stylesheet must be set prior to calling + this method. +

        +

        +
        +
        +
        +
        Parameters:
        name - the output property name.
        value - the output property value.
        Since:
        +
        Ant 1.5, Ant 1.5
        +
        +
        +
        +
        + +

        +setEntityResolver

        +
        +public void setEntityResolver(org.xml.sax.EntityResolver aResolver)
        +
        +
        Set the class to resolve entities during the transformation. +

        +

        +
        +
        +
        +
        Parameters:
        aResolver - the resolver class.
        +
        +
        +
        + +

        +setURIResolver

        +
        +public void setURIResolver(javax.xml.transform.URIResolver aResolver)
        +
        +
        Set the class to resolve URIs during the transformation +

        +

        +
        +
        +
        +
        Parameters:
        aResolver - a EntityResolver value
        +
        +
        +
        + +

        +addParam

        +
        +public void addParam(java.lang.String name,
+                     java.lang.String value)
        +
        +
        Add a parameter. +

        +

        +
        Specified by:
        addParam in interface XSLTLiaison
        +
        +
        +
        Parameters:
        name - the name of the parameter
        value - the value of the parameter
        +
        +
        +
        + +

        +setLogger

        +
        +public void setLogger(XSLTLogger l)
        +
        +
        Set a logger. +

        +

        +
        Specified by:
        setLogger in interface XSLTLoggerAware
        +
        +
        +
        Parameters:
        l - a logger.
        +
        +
        +
        + +

        +error

        +
        +public void error(javax.xml.transform.TransformerException e)
        +
        +
        Log an error. +

        +

        +
        Specified by:
        error in interface javax.xml.transform.ErrorListener
        +
        +
        +
        Parameters:
        e - the exception to log.
        +
        +
        +
        + +

        +fatalError

        +
        +public void fatalError(javax.xml.transform.TransformerException e)
        +
        +
        Log a fatal error. +

        +

        +
        Specified by:
        fatalError in interface javax.xml.transform.ErrorListener
        +
        +
        +
        Parameters:
        e - the exception to log.
        +
        +
        +
        + +

        +warning

        +
        +public void warning(javax.xml.transform.TransformerException e)
        +
        +
        Log a warning. +

        +

        +
        Specified by:
        warning in interface javax.xml.transform.ErrorListener
        +
        +
        +
        Parameters:
        e - the exception to log.
        +
        +
        +
        + +

        +getSystemId

        +
        +protected java.lang.String getSystemId(java.io.File file)
        +
        +
        Deprecated. since 1.5.x. + Use org.apache.tools.ant.util.JAXPUtils#getSystemId instead. +

        +

        +
        +
        +
        +
        Parameters:
        file - the filename to use for the systemid +
        Returns:
        the systemid
        +
        +
        +
        + +

        +configure

        +
        +public void configure(XSLTProcess xsltTask)
        +
        +
        Specific configuration for the TRaX liaison. +

        +

        +
        Specified by:
        configure in interface XSLTLiaison2
        +
        +
        +
        Parameters:
        xsltTask - the XSLTProcess task instance from which this liasion + is to be configured.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Attribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Attribute.html new file mode 100644 index 000000000..c223eadfd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Attribute.html @@ -0,0 +1,325 @@ + + + + + + +XMLValidateTask.Attribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class XMLValidateTask.Attribute

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Attribute
+
        +
        +
        Enclosing class:
        XMLValidateTask
        +
        +
        +
        +
        public static class XMLValidateTask.Attribute
        extends java.lang.Object
        + + +

        +The class to create to set a feature of the parser. +

        + +

        +

        +
        Since:
        +
        ant1.6
        +
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        XMLValidateTask.Attribute() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetName() + +
        +          Gets the attribute name.
        + booleangetValue() + +
        +          Gets the attribute value.
        + voidsetName(java.lang.String name) + +
        +          Set the feature name.
        + voidsetValue(boolean value) + +
        +          Set the feature value to true or false.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +XMLValidateTask.Attribute

        +
        +public XMLValidateTask.Attribute()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setName

        +
        +public void setName(java.lang.String name)
        +
        +
        Set the feature name. +

        +

        +
        Parameters:
        name - the name to set
        +
        +
        +
        + +

        +setValue

        +
        +public void setValue(boolean value)
        +
        +
        Set the feature value to true or false. +

        +

        +
        Parameters:
        value - feature value
        +
        +
        +
        + +

        +getName

        +
        +public java.lang.String getName()
        +
        +
        Gets the attribute name. +

        +

        + +
        Returns:
        the feature name
        +
        +
        +
        + +

        +getValue

        +
        +public boolean getValue()
        +
        +
        Gets the attribute value. +

        +

        + +
        Returns:
        the feature value
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Property.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Property.html new file mode 100644 index 000000000..ca5e464e2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.Property.html @@ -0,0 +1,327 @@ + + + + + + +XMLValidateTask.Property (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class XMLValidateTask.Property

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.XMLValidateTask.Property
+
        +
        +
        Enclosing class:
        XMLValidateTask
        +
        +
        +
        +
        public static final class XMLValidateTask.Property
        extends java.lang.Object
        + + +

        +A Parser property. + See + XML parser properties for usable properties +

        + +

        +

        +
        Since:
        +
        ant 1.6.2
        +
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        XMLValidateTask.Property() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetName() + +
        +          accessor to the name of the property
        + java.lang.StringgetValue() + +
        +          getter for the value of the property
        + voidsetName(java.lang.String name) + +
        +          setter for the name of the property
        + voidsetValue(java.lang.String value) + +
        +          sets the value of the property
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +XMLValidateTask.Property

        +
        +public XMLValidateTask.Property()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getName

        +
        +public java.lang.String getName()
        +
        +
        accessor to the name of the property +

        +

        + +
        Returns:
        name of the property
        +
        +
        +
        + +

        +setName

        +
        +public void setName(java.lang.String name)
        +
        +
        setter for the name of the property +

        +

        +
        Parameters:
        name - name of the property
        +
        +
        +
        + +

        +getValue

        +
        +public java.lang.String getValue()
        +
        +
        getter for the value of the property +

        +

        + +
        Returns:
        value of the property
        +
        +
        +
        + +

        +setValue

        +
        +public void setValue(java.lang.String value)
        +
        +
        sets the value of the property +

        +

        +
        Parameters:
        value - value of the property
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.ValidatorErrorHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.ValidatorErrorHandler.html new file mode 100644 index 000000000..75492f574 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.ValidatorErrorHandler.html @@ -0,0 +1,437 @@ + + + + + + +XMLValidateTask.ValidatorErrorHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class XMLValidateTask.ValidatorErrorHandler

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.XMLValidateTask.ValidatorErrorHandler
+
        +
        +
        All Implemented Interfaces:
        org.xml.sax.ErrorHandler
        +
        +
        +
        Enclosing class:
        XMLValidateTask
        +
        +
        +
        +
        protected class XMLValidateTask.ValidatorErrorHandler
        extends java.lang.Object
        implements org.xml.sax.ErrorHandler
        + + +

        +ValidatorErrorHandler role : +

          +
        • log SAX parse exceptions, +
        • remember if an error occurred +
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected  java.io.FilecurrentFile + +
        +           
        +protected  booleanfailed + +
        +           
        +protected  java.lang.StringlastErrorMessage + +
        +           
        +  + + + + + + + + + + + +
        +Constructor Summary
        +protected XMLValidateTask.ValidatorErrorHandler() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voiderror(org.xml.sax.SAXParseException exception) + +
        +          receive notification of a recoverable error
        + voidfatalError(org.xml.sax.SAXParseException exception) + +
        +          record a fatal error
        + booleangetFailure() + +
        +          did an error happen during last parsing ?
        + voidinit(java.io.File file) + +
        +          initialises the class
        + voidwarning(org.xml.sax.SAXParseException exception) + +
        +          receive notification of a warning
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +currentFile

        +
        +protected java.io.File currentFile
        +
        +
        +
        +
        +
        + +

        +lastErrorMessage

        +
        +protected java.lang.String lastErrorMessage
        +
        +
        +
        +
        +
        + +

        +failed

        +
        +protected boolean failed
        +
        +
        +
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +XMLValidateTask.ValidatorErrorHandler

        +
        +protected XMLValidateTask.ValidatorErrorHandler()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +init

        +
        +public void init(java.io.File file)
        +
        +
        initialises the class +

        +

        +
        +
        +
        +
        Parameters:
        file - file used
        +
        +
        +
        + +

        +getFailure

        +
        +public boolean getFailure()
        +
        +
        did an error happen during last parsing ? +

        +

        +
        +
        +
        + +
        Returns:
        did an error happen during last parsing ?
        +
        +
        +
        + +

        +fatalError

        +
        +public void fatalError(org.xml.sax.SAXParseException exception)
        +
        +
        record a fatal error +

        +

        +
        Specified by:
        fatalError in interface org.xml.sax.ErrorHandler
        +
        +
        +
        Parameters:
        exception - the fatal error
        +
        +
        +
        + +

        +error

        +
        +public void error(org.xml.sax.SAXParseException exception)
        +
        +
        receive notification of a recoverable error +

        +

        +
        Specified by:
        error in interface org.xml.sax.ErrorHandler
        +
        +
        +
        Parameters:
        exception - the error
        +
        +
        +
        + +

        +warning

        +
        +public void warning(org.xml.sax.SAXParseException exception)
        +
        +
        receive notification of a warning +

        +

        +
        Specified by:
        warning in interface org.xml.sax.ErrorHandler
        +
        +
        +
        Parameters:
        exception - the warning
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.html new file mode 100644 index 000000000..8c2c7adfb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XMLValidateTask.html @@ -0,0 +1,1170 @@ + + + + + + +XMLValidateTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class XMLValidateTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.XMLValidateTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        Direct Known Subclasses:
        SchemaValidate
        +
        +
        +
        +
        public class XMLValidateTask
        extends Task
        + + +

        +Checks XML files are valid (or only well formed). The + task uses the SAX2 parser implementation provided by JAXP by default + (probably the one that is used by Ant itself), but one can specify any + SAX1/2 parser if needed. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + +
        +Nested Class Summary
        +static classXMLValidateTask.Attribute + +
        +          The class to create to set a feature of the parser.
        +static classXMLValidateTask.Property + +
        +          A Parser property.
        +protected  classXMLValidateTask.ValidatorErrorHandler + +
        +          ValidatorErrorHandler role : + + log SAX parse exceptions, + remember if an error occurred +
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected  Pathclasspath + +
        +           
        +protected  XMLValidateTask.ValidatorErrorHandlererrorHandler + +
        +           
        +protected  booleanfailOnError + +
        +           
        +protected  java.io.Filefile + +
        +          file to be validated
        +protected  java.util.Vectorfilesets + +
        +          sets of file to be validated
        +protected static java.lang.StringINIT_FAILED_MSG + +
        +           
        +protected  booleanlenient + +
        +           
        +static java.lang.StringMESSAGE_FILES_VALIDATED + +
        +          Message for sucessfull validation
        +protected  java.lang.StringreaderClassName + +
        +           
        +protected  booleanwarn + +
        +           
        +protected  org.xml.sax.XMLReaderxmlReader + +
        +          the parser is viewed as a SAX2 XMLReader.
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        XMLValidateTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfiguredXMLCatalog(XMLCatalog catalog) + +
        +          add an XMLCatalog as a nested element; optional.
        + voidaddFileset(FileSet set) + +
        +          specify a set of file to be checked
        +protected  voidcleanup() + +
        +          Cleans up resources.
        + XMLValidateTask.AttributecreateAttribute() + +
        +          Add an attribute nested element.
        + PathcreateClasspath() + +
        +           
        +protected  org.xml.sax.XMLReadercreateDefaultReader() + +
        +          create a reader if the use of the class did not specify another one.
        + DTDLocationcreateDTD() + +
        +          Create a DTD location record; optional.
        + XMLValidateTask.PropertycreateProperty() + +
        +          Creates a property.
        +protected  org.xml.sax.XMLReadercreateXmlReader() + +
        +          create the XML reader.
        +protected  booleandoValidate(java.io.File afile) + +
        +          parse the file
        + voidexecute() + +
        +          execute the task
        +protected  org.xml.sax.EntityResolvergetEntityResolver() + +
        +          accessor to the xmlCatalog used in the task
        +protected  org.xml.sax.XMLReadergetXmlReader() + +
        +          get the XML reader.
        + voidinit() + +
        +          Called by the project to let the task initialize properly.
        +protected  voidinitValidator() + +
        +          init the parser : + load the parser class, and set features if necessary + It is only after this that the reader is valid
        +protected  booleanisSax1Parser() + +
        +          test that returns true if we are using a SAX1 parser.
        +protected  voidonSuccessfulValidation(int fileProcessed) + +
        +          handler called on successful file validation.
        + voidsetClassName(java.lang.String className) + +
        +          Specify the class name of the SAX parser to be used.
        + voidsetClasspath(Path classpath) + +
        +          Specify the classpath to be searched to load the parser (optional)
        + voidsetClasspathRef(Reference r) + +
        +          Where to find the parser class; optional.
        + voidsetFailOnError(boolean fail) + +
        +          Specify how parser error are to be handled.
        +protected  voidsetFeature(java.lang.String feature, + boolean value) + +
        +          Set a feature on the parser.
        + voidsetFile(java.io.File file) + +
        +          specify the file to be checked; optional.
        + voidsetLenient(boolean bool) + +
        +          Specify whether the parser should be validating.
        +protected  voidsetProperty(java.lang.String name, + java.lang.String value) + +
        +          Sets a property.
        + voidsetWarn(boolean bool) + +
        +          Specify how parser error are to be handled.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +INIT_FAILED_MSG

        +
        +protected static final java.lang.String INIT_FAILED_MSG
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +failOnError

        +
        +protected boolean failOnError
        +
        +
        +
        +
        +
        + +

        +warn

        +
        +protected boolean warn
        +
        +
        +
        +
        +
        + +

        +lenient

        +
        +protected boolean lenient
        +
        +
        +
        +
        +
        + +

        +readerClassName

        +
        +protected java.lang.String readerClassName
        +
        +
        +
        +
        +
        + +

        +file

        +
        +protected java.io.File file
        +
        +
        file to be validated +

        +

        +
        +
        +
        + +

        +filesets

        +
        +protected java.util.Vector filesets
        +
        +
        sets of file to be validated +

        +

        +
        +
        +
        + +

        +classpath

        +
        +protected Path classpath
        +
        +
        +
        +
        +
        + +

        +xmlReader

        +
        +protected org.xml.sax.XMLReader xmlReader
        +
        +
        the parser is viewed as a SAX2 XMLReader. If a SAX1 parser is specified, + it's wrapped in an adapter that make it behave as a XMLReader. + a more 'standard' way of doing this would be to use the JAXP1.1 SAXParser + interface. +

        +

        +
        +
        +
        + +

        +errorHandler

        +
        +protected XMLValidateTask.ValidatorErrorHandler errorHandler
        +
        +
        +
        +
        +
        + +

        +MESSAGE_FILES_VALIDATED

        +
        +public static final java.lang.String MESSAGE_FILES_VALIDATED
        +
        +
        Message for sucessfull validation +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +XMLValidateTask

        +
        +public XMLValidateTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setFailOnError

        +
        +public void setFailOnError(boolean fail)
        +
        +
        Specify how parser error are to be handled. + Optional, default is true. +

        + If set to true (default), throw a buildException if the + parser yields an error. +

        +

        +
        Parameters:
        fail - if set to false do not fail on error
        +
        +
        +
        + +

        +setWarn

        +
        +public void setWarn(boolean bool)
        +
        +
        Specify how parser error are to be handled. +

        + If set to true (default), log a warn message for each SAX warn event. +

        +

        +
        Parameters:
        bool - if set to false do not send warnings
        +
        +
        +
        + +

        +setLenient

        +
        +public void setLenient(boolean bool)
        +
        +
        Specify whether the parser should be validating. Default + is true. +

        + If set to false, the validation will fail only if the parsed document + is not well formed XML. +

        + this option is ignored if the specified class + with setClassName(String) is not a SAX2 XMLReader. +

        +

        +
        Parameters:
        bool - if set to false only fail on malformed XML
        +
        +
        +
        + +

        +setClassName

        +
        +public void setClassName(java.lang.String className)
        +
        +
        Specify the class name of the SAX parser to be used. (optional) +

        +

        +
        Parameters:
        className - should be an implementation of SAX2 + org.xml.sax.XMLReader or SAX2 org.xml.sax.Parser. +

        if className is an implementation of + org.xml.sax.Parser, setLenient(boolean), + will be ignored. +

        if not set, the default will be used.

        See Also:
        XMLReader, +Parser
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Specify the classpath to be searched to load the parser (optional) +

        +

        +
        Parameters:
        classpath - the classpath to load the parser
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        + +
        Returns:
        the classpath created
        See Also:
        setClasspath(org.apache.tools.ant.types.Path)
        +
        +
        +
        + +

        +setClasspathRef

        +
        +public void setClasspathRef(Reference r)
        +
        +
        Where to find the parser class; optional. +

        +

        +
        Parameters:
        r - reference to a classpath defined elsewhere
        See Also:
        setClasspath(org.apache.tools.ant.types.Path)
        +
        +
        +
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        specify the file to be checked; optional. +

        +

        +
        Parameters:
        file - the file to be checked
        +
        +
        +
        + +

        +addConfiguredXMLCatalog

        +
        +public void addConfiguredXMLCatalog(XMLCatalog catalog)
        +
        +
        add an XMLCatalog as a nested element; optional. +

        +

        +
        Parameters:
        catalog - XMLCatalog to use
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet set)
        +
        +
        specify a set of file to be checked +

        +

        +
        Parameters:
        set - the fileset to check
        +
        +
        +
        + +

        +createAttribute

        +
        +public XMLValidateTask.Attribute createAttribute()
        +
        +
        Add an attribute nested element. This is used for setting arbitrary + features of the SAX parser. + Valid attributes + include +

        +

        + +
        Returns:
        attribute created
        Since:
        +
        ant1.6
        +
        +
        +
        +
        + +

        +createProperty

        +
        +public XMLValidateTask.Property createProperty()
        +
        +
        Creates a property. +

        +

        + +
        Returns:
        a property.
        Since:
        +
        ant 1.6.2
        +
        +
        +
        +
        + +

        +init

        +
        +public void init()
+          throws BuildException
        +
        +
        Called by the project to let the task initialize properly. +

        +

        +
        Overrides:
        init in class Task
        +
        +
        + +
        Throws: +
        BuildException - if something goes wrong with the build
        +
        +
        +
        + +

        +createDTD

        +
        +public DTDLocation createDTD()
        +
        +
        Create a DTD location record; optional. + This stores the location of a DTD. The DTD is identified + by its public Id. +

        +

        + +
        Returns:
        created DTD location
        +
        +
        +
        + +

        +getEntityResolver

        +
        +protected org.xml.sax.EntityResolver getEntityResolver()
        +
        +
        accessor to the xmlCatalog used in the task +

        +

        + +
        Returns:
        xmlCatalog reference
        +
        +
        +
        + +

        +getXmlReader

        +
        +protected org.xml.sax.XMLReader getXmlReader()
        +
        +
        get the XML reader. Non-null only after initValidator(). + If the reader is an instance of ParserAdapter then + the parser is a SAX1 parser, and you cannot call + setFeature(String, boolean) or setProperty(String, String) + on it. +

        +

        + +
        Returns:
        the XML reader or null.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        execute the task +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if failonerror is true and an error happens
        +
        +
        +
        + +

        +onSuccessfulValidation

        +
        +protected void onSuccessfulValidation(int fileProcessed)
        +
        +
        handler called on successful file validation. +

        +

        +
        Parameters:
        fileProcessed - number of files processed.
        +
        +
        +
        + +

        +initValidator

        +
        +protected void initValidator()
        +
        +
        init the parser : + load the parser class, and set features if necessary + It is only after this that the reader is valid +

        +

        + +
        Throws: +
        BuildException - if something went wrong
        +
        +
        +
        + +

        +isSax1Parser

        +
        +protected boolean isSax1Parser()
        +
        +
        test that returns true if we are using a SAX1 parser. +

        +

        + +
        Returns:
        true when a SAX1 parser is in use
        +
        +
        +
        + +

        +createXmlReader

        +
        +protected org.xml.sax.XMLReader createXmlReader()
        +
        +
        create the XML reader. + This is one by instantiating anything specified by readerClassName, + falling back to a default reader if not. + If the returned reader is an instance of ParserAdapter then + we have created and wrapped a SAX1 parser. +

        +

        + +
        Returns:
        the new XMLReader.
        +
        +
        +
        + +

        +cleanup

        +
        +protected void cleanup()
        +
        +
        Cleans up resources. +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +createDefaultReader

        +
        +protected org.xml.sax.XMLReader createDefaultReader()
        +
        +
        create a reader if the use of the class did not specify another one. + If a BuildException is thrown, the caller may revert to an alternate + reader. +

        +

        + +
        Returns:
        a new reader. +
        Throws: +
        BuildException - if something went wrong
        +
        +
        +
        + +

        +setFeature

        +
        +protected void setFeature(java.lang.String feature,
+                          boolean value)
+                   throws BuildException
        +
        +
        Set a feature on the parser. +

        +

        +
        Parameters:
        feature - the name of the feature to set
        value - the value of the feature +
        Throws: +
        BuildException - if the feature was not supported
        +
        +
        +
        + +

        +setProperty

        +
        +protected void setProperty(java.lang.String name,
+                           java.lang.String value)
+                    throws BuildException
        +
        +
        Sets a property. +

        +

        +
        Parameters:
        name - a property name
        value - a property value. +
        Throws: +
        BuildException - if an error occurs. +
        BuildException - if the property was not supported
        +
        +
        +
        + +

        +doValidate

        +
        +protected boolean doValidate(java.io.File afile)
        +
        +
        parse the file +

        +

        +
        Parameters:
        afile - the file to validate. +
        Returns:
        true if the file validates.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XSLTTraceSupport.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XSLTTraceSupport.html new file mode 100644 index 000000000..173759c75 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/XSLTTraceSupport.html @@ -0,0 +1,214 @@ + + + + + + +XSLTTraceSupport (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Interface XSLTTraceSupport

        +
        +
        All Known Implementing Classes:
        Xalan2TraceSupport
        +
        +
        +
        +
        public interface XSLTTraceSupport
        + + +

        +Sets up trace support for a given transformer. +

        + +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        + +

        + + + + + + + + + + + + +
        +Method Summary
        + voidconfigureTrace(javax.xml.transform.Transformer t, + XSLTProcess.TraceConfiguration conf) + +
        +           
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +configureTrace

        +
        +void configureTrace(javax.xml.transform.Transformer t,
+                    XSLTProcess.TraceConfiguration conf)
        +
        +
        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Xalan2TraceSupport.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Xalan2TraceSupport.html new file mode 100644 index 000000000..82e0fd536 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/Xalan2TraceSupport.html @@ -0,0 +1,263 @@ + + + + + + +Xalan2TraceSupport (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional +
        +Class Xalan2TraceSupport

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.Xalan2TraceSupport
+
        +
        +
        All Implemented Interfaces:
        XSLTTraceSupport
        +
        +
        +
        +
        public class Xalan2TraceSupport
        extends java.lang.Object
        implements XSLTTraceSupport
        + + +

        +Sets up trace support for a given transformer. +

        + +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        Xalan2TraceSupport() + +
        +           
        +  + + + + + + + + + + + +
        +Method Summary
        + voidconfigureTrace(javax.xml.transform.Transformer t, + XSLTProcess.TraceConfiguration conf) + +
        +           
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Xalan2TraceSupport

        +
        +public Xalan2TraceSupport()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +configureTrace

        +
        +public void configureTrace(javax.xml.transform.Transformer t,
+                           XSLTProcess.TraceConfiguration conf)
        +
        +
        +
        Specified by:
        configureTrace in interface XSLTTraceSupport
        +
        +
        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.html new file mode 100644 index 000000000..bce7a6cab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheck.html @@ -0,0 +1,556 @@ + + + + + + +CCMCheck (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMCheck

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        Direct Known Subclasses:
        CCMCheckin, CCMCheckinDefault, CCMCheckout
        +
        +
        +
        +
        public class CCMCheck
        extends Continuus
        + + +

        +Class common to all check commands (checkout, checkin,checkin default task); +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected  java.util.Vectorfilesets + +
        +           
        +static java.lang.StringFLAG_COMMENT + +
        +          -comment flag -- comment to attach to the file
        +static java.lang.StringFLAG_TASK + +
        +          -task flag -- associate checkout task with task
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMCheck() + +
        +          Constructor for CCMCheck.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddFileset(FileSet set) + +
        +          Adds a set of files to copy.
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get the value of comment.
        + java.io.FilegetFile() + +
        +          Get the value of file.
        + java.lang.StringgetTask() + +
        +          Get the value of task.
        + voidsetComment(java.lang.String v) + +
        +          Specifies a comment.
        + voidsetFile(java.io.File v) + +
        +          Sets the path to the file that the command will operate on.
        + voidsetTask(java.lang.String v) + +
        +          Specifies the task number used to check + in the file (may use 'default').
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +filesets

        +
        +protected java.util.Vector filesets
        +
        +
        +
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -comment flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_TASK

        +
        +public static final java.lang.String FLAG_TASK
        +
        +
        -task flag -- associate checkout task with task +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMCheck

        +
        +public CCMCheck()
        +
        +
        Constructor for CCMCheck. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +getFile

        +
        +public java.io.File getFile()
        +
        +
        Get the value of file. +

        +

        + +
        Returns:
        value of file.
        +
        +
        +
        + +

        +setFile

        +
        +public void setFile(java.io.File v)
        +
        +
        Sets the path to the file that the command will operate on. +

        +

        +
        Parameters:
        v - Value to assign to file.
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get the value of comment. +

        +

        + +
        Returns:
        value of comment.
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String v)
        +
        +
        Specifies a comment. +

        +

        +
        Parameters:
        v - Value to assign to comment.
        +
        +
        +
        + +

        +getTask

        +
        +public java.lang.String getTask()
        +
        +
        Get the value of task. +

        +

        + +
        Returns:
        value of task.
        +
        +
        +
        + +

        +setTask

        +
        +public void setTask(java.lang.String v)
        +
        +
        Specifies the task number used to check + in the file (may use 'default'). +

        +

        +
        Parameters:
        v - Value to assign to task.
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet set)
        +
        +
        Adds a set of files to copy. +

        +

        +
        Parameters:
        set - the set of files
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute ccm and then calls Exec's run method + to execute the command line. +

        +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - on error
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckin.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckin.html new file mode 100644 index 000000000..2e7b0dc68 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckin.html @@ -0,0 +1,313 @@ + + + + + + +CCMCheckin (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMCheckin

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
+                  extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckin
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMCheckin
        extends CCMCheck
        + + +

        +Performs Continuus checkin command. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        filesets, FLAG_COMMENT, FLAG_TASK
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMCheckin() + +
        +          Default constructor - setup checkin command
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        addFileset, execute, getComment, getFile, getTask, setComment, setFile, setTask
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMCheckin

        +
        +public CCMCheckin()
        +
        +
        Default constructor - setup checkin command +

        +

        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckinDefault.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckinDefault.html new file mode 100644 index 000000000..7e4aed025 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckinDefault.html @@ -0,0 +1,342 @@ + + + + + + +CCMCheckinDefault (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMCheckinDefault

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
+                  extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMCheckinDefault
        extends CCMCheck
        + + +

        +Performs Continuus Checkin Default task command. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringDEFAULT_TASK + +
        +          The default task
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        filesets, FLAG_COMMENT, FLAG_TASK
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMCheckinDefault() + +
        +          Constructor for CCMCheckinDefault.
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        addFileset, execute, getComment, getFile, getTask, setComment, setFile, setTask
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +DEFAULT_TASK

        +
        +public static final java.lang.String DEFAULT_TASK
        +
        +
        The default task +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMCheckinDefault

        +
        +public CCMCheckinDefault()
        +
        +
        Constructor for CCMCheckinDefault. +

        +

        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckout.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckout.html new file mode 100644 index 000000000..dd9141e69 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCheckout.html @@ -0,0 +1,313 @@ + + + + + + +CCMCheckout (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMCheckout

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
+                  extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckout
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMCheckout
        extends CCMCheck
        + + +

        +Performs Continuus checkout command. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        filesets, FLAG_COMMENT, FLAG_TASK
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMCheckout() + +
        +          default constructor
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck
        addFileset, execute, getComment, getFile, getTask, setComment, setFile, setTask
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMCheckout

        +
        +public CCMCheckout()
        +
        +
        default constructor +

        +

        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.html new file mode 100644 index 000000000..d1a04f371 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMCreateTask.html @@ -0,0 +1,895 @@ + + + + + + +CCMCreateTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMCreateTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMCreateTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, ExecuteStreamHandler
        +
        +
        +
        +
        public class CCMCreateTask
        extends Continuus
        implements ExecuteStreamHandler
        + + +

        +Creates new Continuus ccm task and sets it as the default. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          /comment -- comments associated to the task
        +static java.lang.StringFLAG_PLATFORM + +
        +          /platform flag -- target platform
        +static java.lang.StringFLAG_RELEASE + +
        +          /release flag
        +static java.lang.StringFLAG_RESOLVER + +
        +          /resolver flag
        +static java.lang.StringFLAG_SUBSYSTEM + +
        +          /release flag
        +static java.lang.StringFLAG_TASK + +
        +          -task flag -- associate checkout task with task
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMCreateTask() + +
        +          Constructor for CCMCreateTask.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get the value of comment.
        + java.lang.StringgetPlatform() + +
        +          Get the value of platform.
        + java.lang.StringgetRelease() + +
        +          Get the value of release.
        + java.lang.StringgetResolver() + +
        +          Get the value of resolver.
        + java.lang.StringgetSubSystem() + +
        +          Get the value of subSystem.
        + java.lang.StringgetTask() + +
        +          Get the value of task.
        + voidsetComment(java.lang.String v) + +
        +          Specifies a comment.
        + voidsetPlatform(java.lang.String v) + +
        +          Specifies the target platform.
        + voidsetProcessErrorStream(java.io.InputStream is) + +
        +          Install a handler for the error stream of the subprocess.
        + voidsetProcessInputStream(java.io.OutputStream param1) + +
        +          Install a handler for the input stream of the subprocess.
        + voidsetProcessOutputStream(java.io.InputStream is) + +
        +          read the output stream to retrieve the new task number.
        + voidsetRelease(java.lang.String v) + +
        +          Specify the CCM release.
        + voidsetResolver(java.lang.String v) + +
        +          Specifies the resolver.
        + voidsetSubSystem(java.lang.String v) + +
        +          Specifies the subsystem.
        + voidsetTask(java.lang.String v) + +
        +          Specifies the task number used to checkin + the file (may use 'default').
        + voidstart() + +
        +          Start handling of the streams.
        + voidstop() + +
        +          Stop handling of the streams - will not be restarted.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        /comment -- comments associated to the task +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PLATFORM

        +
        +public static final java.lang.String FLAG_PLATFORM
        +
        +
        /platform flag -- target platform +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RESOLVER

        +
        +public static final java.lang.String FLAG_RESOLVER
        +
        +
        /resolver flag +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RELEASE

        +
        +public static final java.lang.String FLAG_RELEASE
        +
        +
        /release flag +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_SUBSYSTEM

        +
        +public static final java.lang.String FLAG_SUBSYSTEM
        +
        +
        /release flag +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_TASK

        +
        +public static final java.lang.String FLAG_TASK
        +
        +
        -task flag -- associate checkout task with task +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMCreateTask

        +
        +public CCMCreateTask()
        +
        +
        Constructor for CCMCreateTask. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute ccm and then calls Exec's run method + to execute the command line. +

        +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - on error
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get the value of comment. +

        +

        +
        +
        +
        + +
        Returns:
        value of comment.
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String v)
        +
        +
        Specifies a comment. +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to comment.
        +
        +
        +
        + +

        +getPlatform

        +
        +public java.lang.String getPlatform()
        +
        +
        Get the value of platform. +

        +

        +
        +
        +
        + +
        Returns:
        value of platform.
        +
        +
        +
        + +

        +setPlatform

        +
        +public void setPlatform(java.lang.String v)
        +
        +
        Specifies the target platform. +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to platform.
        +
        +
        +
        + +

        +getResolver

        +
        +public java.lang.String getResolver()
        +
        +
        Get the value of resolver. +

        +

        +
        +
        +
        + +
        Returns:
        value of resolver.
        +
        +
        +
        + +

        +setResolver

        +
        +public void setResolver(java.lang.String v)
        +
        +
        Specifies the resolver. +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to resolver.
        +
        +
        +
        + +

        +getRelease

        +
        +public java.lang.String getRelease()
        +
        +
        Get the value of release. +

        +

        +
        +
        +
        + +
        Returns:
        value of release.
        +
        +
        +
        + +

        +setRelease

        +
        +public void setRelease(java.lang.String v)
        +
        +
        Specify the CCM release. +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to release.
        +
        +
        +
        + +

        +getSubSystem

        +
        +public java.lang.String getSubSystem()
        +
        +
        Get the value of subSystem. +

        +

        +
        +
        +
        + +
        Returns:
        value of subSystem.
        +
        +
        +
        + +

        +setSubSystem

        +
        +public void setSubSystem(java.lang.String v)
        +
        +
        Specifies the subsystem. +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to subSystem.
        +
        +
        +
        + +

        +getTask

        +
        +public java.lang.String getTask()
        +
        +
        Get the value of task. +

        +

        +
        +
        +
        + +
        Returns:
        value of task.
        +
        +
        +
        + +

        +setTask

        +
        +public void setTask(java.lang.String v)
        +
        +
        Specifies the task number used to checkin + the file (may use 'default'). +

        +

        +
        +
        +
        +
        Parameters:
        v - Value to assign to task.
        +
        +
        +
        + +

        +start

        +
        +public void start()
+           throws java.io.IOException
        +
        +
        Description copied from interface: ExecuteStreamHandler
        +
        Start handling of the streams. +

        +

        +
        Specified by:
        start in interface ExecuteStreamHandler
        +
        +
        + +
        Throws: +
        java.io.IOException - on error
        +
        +
        +
        + +

        +stop

        +
        +public void stop()
        +
        +
        Description copied from interface: ExecuteStreamHandler
        +
        Stop handling of the streams - will not be restarted. +

        +

        +
        Specified by:
        stop in interface ExecuteStreamHandler
        +
        +
        +
        +
        +
        +
        + +

        +setProcessInputStream

        +
        +public void setProcessInputStream(java.io.OutputStream param1)
+                           throws java.io.IOException
        +
        +
        Description copied from interface: ExecuteStreamHandler
        +
        Install a handler for the input stream of the subprocess. +

        +

        +
        Specified by:
        setProcessInputStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        param1 - the output stream +
        Throws: +
        java.io.IOException - on error
        +
        +
        +
        + +

        +setProcessErrorStream

        +
        +public void setProcessErrorStream(java.io.InputStream is)
+                           throws java.io.IOException
        +
        +
        Description copied from interface: ExecuteStreamHandler
        +
        Install a handler for the error stream of the subprocess. +

        +

        +
        Specified by:
        setProcessErrorStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        is - the input stream +
        Throws: +
        java.io.IOException - on error
        +
        +
        +
        + +

        +setProcessOutputStream

        +
        +public void setProcessOutputStream(java.io.InputStream is)
+                            throws java.io.IOException
        +
        +
        read the output stream to retrieve the new task number. +

        +

        +
        Specified by:
        setProcessOutputStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        is - InputStream +
        Throws: +
        java.io.IOException - on error
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.html new file mode 100644 index 000000000..8669c9b73 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/CCMReconfigure.html @@ -0,0 +1,532 @@ + + + + + + +CCMReconfigure (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class CCMReconfigure

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+              extended by org.apache.tools.ant.taskdefs.optional.ccm.CCMReconfigure
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMReconfigure
        extends Continuus
        + + +

        +Task allows to reconfigure a project, recursively or not +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_PROJECT + +
        +          /project flag -- target project
        +static java.lang.StringFLAG_RECURSE + +
        +          /recurse --
        +static java.lang.StringFLAG_VERBOSE + +
        +          /recurse --
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMReconfigure() + +
        +          Constructor for CCMReconfigure.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetCcmProject() + +
        +          Get the value of project.
        + booleanisRecurse() + +
        +          Get the value of recurse.
        + booleanisVerbose() + +
        +          Get the value of verbose.
        + voidsetCcmProject(java.lang.String v) + +
        +          Sets the ccm project on which the operation is applied.
        + voidsetRecurse(boolean v) + +
        +          If true, recurse on subproject (default false).
        + voidsetVerbose(boolean v) + +
        +          If true, do a verbose reconfigure operation (default false).
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ccm.Continuus
        getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_RECURSE

        +
        +public static final java.lang.String FLAG_RECURSE
        +
        +
        /recurse -- +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_VERBOSE

        +
        +public static final java.lang.String FLAG_VERBOSE
        +
        +
        /recurse -- +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PROJECT

        +
        +public static final java.lang.String FLAG_PROJECT
        +
        +
        /project flag -- target project +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMReconfigure

        +
        +public CCMReconfigure()
        +
        +
        Constructor for CCMReconfigure. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute ccm and then calls Exec's run method + to execute the command line. +

        +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - on error
        +
        +
        +
        + +

        +getCcmProject

        +
        +public java.lang.String getCcmProject()
        +
        +
        Get the value of project. +

        +

        + +
        Returns:
        value of project.
        +
        +
        +
        + +

        +setCcmProject

        +
        +public void setCcmProject(java.lang.String v)
        +
        +
        Sets the ccm project on which the operation is applied. +

        +

        +
        Parameters:
        v - Value to assign to project.
        +
        +
        +
        + +

        +isRecurse

        +
        +public boolean isRecurse()
        +
        +
        Get the value of recurse. +

        +

        + +
        Returns:
        value of recurse.
        +
        +
        +
        + +

        +setRecurse

        +
        +public void setRecurse(boolean v)
        +
        +
        If true, recurse on subproject (default false). +

        +

        +
        Parameters:
        v - Value to assign to recurse.
        +
        +
        +
        + +

        +isVerbose

        +
        +public boolean isVerbose()
        +
        +
        Get the value of verbose. +

        +

        + +
        Returns:
        value of verbose.
        +
        +
        +
        + +

        +setVerbose

        +
        +public void setVerbose(boolean v)
        +
        +
        If true, do a verbose reconfigure operation (default false). +

        +

        +
        Parameters:
        v - Value to assign to verbose.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.html new file mode 100644 index 000000000..1b6569ab6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/Continuus.html @@ -0,0 +1,532 @@ + + + + + + +Continuus (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ccm +
        +Class Continuus

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ccm.Continuus
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        Direct Known Subclasses:
        CCMCheck, CCMCreateTask, CCMReconfigure
        +
        +
        +
        +
        public abstract class Continuus
        extends Task
        + + +

        +A base class for creating tasks for executing commands on Continuus 5.1. +

        + The class extends the task as it operates by executing the ccm.exe program + supplied with Continuus/Synergy. By default the task expects the ccm executable to be + in the path, + you can override this be specifying the ccmdir attribute. +

        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringCOMMAND_CHECKIN + +
        +          The 'Checkin' command
        +static java.lang.StringCOMMAND_CHECKOUT + +
        +          The 'Checkout' command
        +static java.lang.StringCOMMAND_CREATE_TASK + +
        +          The 'CreateTask' command
        +static java.lang.StringCOMMAND_DEFAULT_TASK + +
        +          The 'Reconfigure' command
        +static java.lang.StringCOMMAND_RECONFIGURE + +
        +          The 'Reconfigure' command
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Continuus() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetCcmAction() + +
        +          Get the value of ccmAction.
        +protected  java.lang.StringgetCcmCommand() + +
        +          Builds and returns the command string to execute ccm
        +protected  intrun(Commandline cmd) + +
        +          Run the command.
        +protected  intrun(Commandline cmd, + ExecuteStreamHandler handler) + +
        +          Run the command.
        + voidsetCcmAction(java.lang.String v) + +
        +          Set the value of ccmAction.
        + voidsetCcmDir(java.lang.String dir) + +
        +          Set the directory where the ccm executable is located.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +COMMAND_CREATE_TASK

        +
        +public static final java.lang.String COMMAND_CREATE_TASK
        +
        +
        The 'CreateTask' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_CHECKOUT

        +
        +public static final java.lang.String COMMAND_CHECKOUT
        +
        +
        The 'Checkout' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_CHECKIN

        +
        +public static final java.lang.String COMMAND_CHECKIN
        +
        +
        The 'Checkin' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_RECONFIGURE

        +
        +public static final java.lang.String COMMAND_RECONFIGURE
        +
        +
        The 'Reconfigure' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_DEFAULT_TASK

        +
        +public static final java.lang.String COMMAND_DEFAULT_TASK
        +
        +
        The 'Reconfigure' command +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +Continuus

        +
        +public Continuus()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getCcmAction

        +
        +public java.lang.String getCcmAction()
        +
        +
        Get the value of ccmAction. +

        +

        + +
        Returns:
        value of ccmAction.
        +
        +
        +
        + +

        +setCcmAction

        +
        +public void setCcmAction(java.lang.String v)
        +
        +
        Set the value of ccmAction. +

        +

        +
        Parameters:
        v - Value to assign to ccmAction.
        +
        +
        +
        + +

        +setCcmDir

        +
        +public final void setCcmDir(java.lang.String dir)
        +
        +
        Set the directory where the ccm executable is located. +

        +

        +
        Parameters:
        dir - the directory containing the ccm executable
        +
        +
        +
        + +

        +getCcmCommand

        +
        +protected final java.lang.String getCcmCommand()
        +
        +
        Builds and returns the command string to execute ccm +

        +

        + +
        Returns:
        String containing path to the executable
        +
        +
        +
        + +

        +run

        +
        +protected int run(Commandline cmd,
+                  ExecuteStreamHandler handler)
        +
        +
        Run the command. +

        +

        +
        Parameters:
        cmd - the command line
        handler - an execute stream handler +
        Returns:
        the exit status of the command
        +
        +
        +
        + +

        +run

        +
        +protected int run(Commandline cmd)
        +
        +
        Run the command. +

        +

        +
        Parameters:
        cmd - the command line +
        Returns:
        the exit status of the command
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-frame.html new file mode 100644 index 000000000..ca5d78f12 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ccm (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.ccm + + + + +
        +Classes  + +
        +CCMCheck +
        +CCMCheckin +
        +CCMCheckinDefault +
        +CCMCheckout +
        +CCMCreateTask +
        +CCMReconfigure +
        +Continuus
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-summary.html new file mode 100644 index 000000000..23c4110ea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-summary.html @@ -0,0 +1,176 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ccm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.ccm +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        CCMCheckClass common to all check commands (checkout, checkin,checkin default task);
        CCMCheckinPerforms Continuus checkin command.
        CCMCheckinDefaultPerforms Continuus Checkin Default task command.
        CCMCheckoutPerforms Continuus checkout command.
        CCMCreateTaskCreates new Continuus ccm task and sets it as the default.
        CCMReconfigureTask allows to reconfigure a project, recursively or not
        ContinuusA base class for creating tasks for executing commands on Continuus 5.1.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-tree.html new file mode 100644 index 000000000..6453b51c6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ccm/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ccm Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.ccm +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.html new file mode 100644 index 000000000..0dc58c664 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckin.html @@ -0,0 +1,790 @@ + + + + + + +CCCheckin (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCCheckin

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCCheckin
        extends ClearCase
        + + +

        +Performs ClearCase checkin. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onNo
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        nowarnSuppress warning messagesNo
        preservetimePreserve the modification timeNo
        keepcopyKeeps a copy of the file with a .keep extensionNo
        identicalAllows the file to be checked in even if it is identical to the originalNo
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_IDENTICAL + +
        +          -identical flag -- allows the file to be checked in even if it is identical to the original
        +static java.lang.StringFLAG_KEEPCOPY + +
        +          -keep flag -- keeps a copy of the file with a .keep extension
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_NOWARN + +
        +          -nwarn flag -- suppresses warning messages
        +static java.lang.StringFLAG_PRESERVETIME + +
        +          -ptime flag -- preserves the modification time
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCCheckin() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetIdentical() + +
        +          Get identical flag status
        + booleangetKeepCopy() + +
        +          Get keepcopy flag status
        + booleangetNoWarn() + +
        +          Get nowarn flag status
        + booleangetPreserveTime() + +
        +          Get preservetime flag status
        + voidsetComment(java.lang.String comment) + +
        +          Sets the comment string.
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Specifies a file containing a comment.
        + voidsetIdentical(boolean identical) + +
        +          If true, allows the file to be checked in even + if it is identical to the original.
        + voidsetKeepCopy(boolean keep) + +
        +          If true, keeps a copy of the file with a .keep extension.
        + voidsetNoWarn(boolean nwarn) + +
        +          If true, suppress warning messages.
        + voidsetPreserveTime(boolean ptime) + +
        +          If true, preserve the modification time.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOWARN

        +
        +public static final java.lang.String FLAG_NOWARN
        +
        +
        -nwarn flag -- suppresses warning messages +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PRESERVETIME

        +
        +public static final java.lang.String FLAG_PRESERVETIME
        +
        +
        -ptime flag -- preserves the modification time +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_KEEPCOPY

        +
        +public static final java.lang.String FLAG_KEEPCOPY
        +
        +
        -keep flag -- keeps a copy of the file with a .keep extension +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_IDENTICAL

        +
        +public static final java.lang.String FLAG_IDENTICAL
        +
        +
        -identical flag -- allows the file to be checked in even if it is identical to the original +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCCheckin

        +
        +public CCCheckin()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets the comment string. +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Specifies a file containing a comment. +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setNoWarn

        +
        +public void setNoWarn(boolean nwarn)
        +
        +
        If true, suppress warning messages. +

        +

        +
        Parameters:
        nwarn - the status to set the flag to
        +
        +
        +
        + +

        +getNoWarn

        +
        +public boolean getNoWarn()
        +
        +
        Get nowarn flag status +

        +

        + +
        Returns:
        boolean containing status of nwarn flag
        +
        +
        +
        + +

        +setPreserveTime

        +
        +public void setPreserveTime(boolean ptime)
        +
        +
        If true, preserve the modification time. +

        +

        +
        Parameters:
        ptime - the status to set the flag to
        +
        +
        +
        + +

        +getPreserveTime

        +
        +public boolean getPreserveTime()
        +
        +
        Get preservetime flag status +

        +

        + +
        Returns:
        boolean containing status of preservetime flag
        +
        +
        +
        + +

        +setKeepCopy

        +
        +public void setKeepCopy(boolean keep)
        +
        +
        If true, keeps a copy of the file with a .keep extension. +

        +

        +
        Parameters:
        keep - the status to set the flag to
        +
        +
        +
        + +

        +getKeepCopy

        +
        +public boolean getKeepCopy()
        +
        +
        Get keepcopy flag status +

        +

        + +
        Returns:
        boolean containing status of keepcopy flag
        +
        +
        +
        + +

        +setIdentical

        +
        +public void setIdentical(boolean identical)
        +
        +
        If true, allows the file to be checked in even + if it is identical to the original. +

        +

        +
        Parameters:
        identical - the status to set the flag to
        +
        +
        +
        + +

        +getIdentical

        +
        +public boolean getIdentical()
        +
        +
        Get identical flag status +

        +

        + +
        Returns:
        boolean containing status of identical flag
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html new file mode 100644 index 000000000..cb50fe896 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCCheckout.html @@ -0,0 +1,998 @@ + + + + + + +CCCheckout (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCCheckout

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCCheckout
        extends ClearCase
        + + +

        +Performs ClearCase checkout. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onNo
        reservedSpecifies whether to check out the file as reserved or notYes
        outCreates a writable file under a different filenameNo
        nodataChecks out the file but does not create an editable file containing its dataNo
        branchSpecify a branch to check out the file toNo
        versionAllows checkout of a version other than main latestNo
        nowarnSuppress warning messagesNo
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        notcoFail if it's already checked out to the current view. Set to false to ignore it.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_BRANCH + +
        +          -branch flag -- checks out the file on a specified branch
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_NODATA + +
        +          -ndata flag -- checks out the file but does not create an editable file containing its data
        +static java.lang.StringFLAG_NOWARN + +
        +          -nwarn flag -- suppresses warning messages
        +static java.lang.StringFLAG_OUT + +
        +          -out flag -- create a writable file under a different filename
        +static java.lang.StringFLAG_RESERVED + +
        +          -reserved flag -- check out the file as reserved
        +static java.lang.StringFLAG_UNRESERVED + +
        +          -reserved flag -- check out the file as unreserved
        +static java.lang.StringFLAG_VERSION + +
        +          -version flag -- allows checkout of a version that is not main latest
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCCheckout() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetBranch() + +
        +          Get branch name
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetNoData() + +
        +          Get nodata flag status
        + booleangetNotco() + +
        +          Get notco flag status
        + booleangetNoWarn() + +
        +          Get nowarn flag status
        + java.lang.StringgetOut() + +
        +          Get out file
        + booleangetReserved() + +
        +          Get reserved flag status
        + booleangetVersion() + +
        +          Get version flag status
        + voidsetBranch(java.lang.String branch) + +
        +          Specify a branch to check out the file to.
        + voidsetComment(java.lang.String comment) + +
        +          Sets the comment string.
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Specifies a file containing a comment.
        + voidsetNoData(boolean ndata) + +
        +          If true, checks out the file but does not create an + editable file containing its data.
        + voidsetNotco(boolean notco) + +
        +          If true, checkout fails if the element is already checked out to the current view.
        + voidsetNoWarn(boolean nwarn) + +
        +          If true, warning messages are suppressed.
        + voidsetOut(java.lang.String outf) + +
        +          Creates a writable file under a different filename.
        + voidsetReserved(boolean reserved) + +
        +          If true, checks out the file as reserved.
        + voidsetVersion(boolean version) + +
        +          If true, allows checkout of a version other than main latest.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_RESERVED

        +
        +public static final java.lang.String FLAG_RESERVED
        +
        +
        -reserved flag -- check out the file as reserved +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_UNRESERVED

        +
        +public static final java.lang.String FLAG_UNRESERVED
        +
        +
        -reserved flag -- check out the file as unreserved +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_OUT

        +
        +public static final java.lang.String FLAG_OUT
        +
        +
        -out flag -- create a writable file under a different filename +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NODATA

        +
        +public static final java.lang.String FLAG_NODATA
        +
        +
        -ndata flag -- checks out the file but does not create an editable file containing its data +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_BRANCH

        +
        +public static final java.lang.String FLAG_BRANCH
        +
        +
        -branch flag -- checks out the file on a specified branch +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_VERSION

        +
        +public static final java.lang.String FLAG_VERSION
        +
        +
        -version flag -- allows checkout of a version that is not main latest +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOWARN

        +
        +public static final java.lang.String FLAG_NOWARN
        +
        +
        -nwarn flag -- suppresses warning messages +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCCheckout

        +
        +public CCCheckout()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setReserved

        +
        +public void setReserved(boolean reserved)
        +
        +
        If true, checks out the file as reserved. +

        +

        +
        Parameters:
        reserved - the status to set the flag to
        +
        +
        +
        + +

        +getReserved

        +
        +public boolean getReserved()
        +
        +
        Get reserved flag status +

        +

        + +
        Returns:
        boolean containing status of reserved flag
        +
        +
        +
        + +

        +setNotco

        +
        +public void setNotco(boolean notco)
        +
        +
        If true, checkout fails if the element is already checked out to the current view. +

        +

        +
        Parameters:
        notco - the status to set the flag to
        Since:
        +
        ant 1.6.1
        +
        +
        +
        +
        + +

        +getNotco

        +
        +public boolean getNotco()
        +
        +
        Get notco flag status +

        +

        + +
        Returns:
        boolean containing status of notco flag
        Since:
        +
        ant 1.6.1
        +
        +
        +
        +
        + +

        +setOut

        +
        +public void setOut(java.lang.String outf)
        +
        +
        Creates a writable file under a different filename. +

        +

        +
        Parameters:
        outf - the path to the out file
        +
        +
        +
        + +

        +getOut

        +
        +public java.lang.String getOut()
        +
        +
        Get out file +

        +

        + +
        Returns:
        String containing the path to the out file
        +
        +
        +
        + +

        +setNoData

        +
        +public void setNoData(boolean ndata)
        +
        +
        If true, checks out the file but does not create an + editable file containing its data. +

        +

        +
        Parameters:
        ndata - the status to set the flag to
        +
        +
        +
        + +

        +getNoData

        +
        +public boolean getNoData()
        +
        +
        Get nodata flag status +

        +

        + +
        Returns:
        boolean containing status of ndata flag
        +
        +
        +
        + +

        +setBranch

        +
        +public void setBranch(java.lang.String branch)
        +
        +
        Specify a branch to check out the file to. +

        +

        +
        Parameters:
        branch - the name of the branch
        +
        +
        +
        + +

        +getBranch

        +
        +public java.lang.String getBranch()
        +
        +
        Get branch name +

        +

        + +
        Returns:
        String containing the name of the branch
        +
        +
        +
        + +

        +setVersion

        +
        +public void setVersion(boolean version)
        +
        +
        If true, allows checkout of a version other than main latest. +

        +

        +
        Parameters:
        version - the status to set the flag to
        +
        +
        +
        + +

        +getVersion

        +
        +public boolean getVersion()
        +
        +
        Get version flag status +

        +

        + +
        Returns:
        boolean containing status of version flag
        +
        +
        +
        + +

        +setNoWarn

        +
        +public void setNoWarn(boolean nwarn)
        +
        +
        If true, warning messages are suppressed. +

        +

        +
        Parameters:
        nwarn - the status to set the flag to
        +
        +
        +
        + +

        +getNoWarn

        +
        +public boolean getNoWarn()
        +
        +
        Get nowarn flag status +

        +

        + +
        Returns:
        boolean containing status of nwarn flag
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets the comment string. +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Specifies a file containing a comment. +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.html new file mode 100644 index 000000000..6eef711e1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCLock.html @@ -0,0 +1,774 @@ + + + + + + +CCLock (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCLock

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCLock
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCLock
        extends ClearCase
        + + +

        +Performs a ClearCase Lock command. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        replaceSpecifies replacing an existing lockNo
        nusersSpecifies user(s) who can still modify the object/pnameNo
        obsoleteSpecifies that the object/pname should be marked obsoleteNo
        commentSpecifies how to populate comments fieldsNo
        pnameSpecifies the pathname to be locked.No
        objselectThis variable is obsolete. Should use objsel instead.No
        objselSpecifies the object(s) to be unlocked.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -comment flag -- method to use for commenting events
        +static java.lang.StringFLAG_NUSERS + +
        +          -nusers flag -- list of users to exclude from lock
        +static java.lang.StringFLAG_OBSOLETE + +
        +          -obsolete flag -- mark locked object as obsolete
        +static java.lang.StringFLAG_PNAME + +
        +          -pname flag -- pathname to lock
        +static java.lang.StringFLAG_REPLACE + +
        +          -replace flag -- replace existing lock on object(s)
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCLock() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment method
        + java.lang.StringgetNusers() + +
        +          Get nusers list
        + java.lang.StringgetObjselect() + +
        +          Get list of objects to be locked
        + booleangetObsolete() + +
        +          Get obsolete flag status
        + java.lang.StringgetPname() + +
        +          Get the pathname to be locked
        + booleangetReplace() + +
        +          Get replace flag status
        + voidsetComment(java.lang.String comment) + +
        +          Sets how comments should be written + for the event record(s)
        + voidsetNusers(java.lang.String nusers) + +
        +          Sets the users who may continue to + edit the object while it is locked.
        + voidsetObjSel(java.lang.String objsel) + +
        +          Sets the object(s) to be locked
        + voidsetObjselect(java.lang.String objselect) + +
        +          Sets the object(s) to be locked
        + voidsetObsolete(boolean obsolete) + +
        +          If true, mark object as obsolete.
        + voidsetPname(java.lang.String pname) + +
        +          Sets the pathname to be locked
        + voidsetReplace(boolean replace) + +
        +          If true, replace an existing lock.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_REPLACE

        +
        +public static final java.lang.String FLAG_REPLACE
        +
        +
        -replace flag -- replace existing lock on object(s) +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NUSERS

        +
        +public static final java.lang.String FLAG_NUSERS
        +
        +
        -nusers flag -- list of users to exclude from lock +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_OBSOLETE

        +
        +public static final java.lang.String FLAG_OBSOLETE
        +
        +
        -obsolete flag -- mark locked object as obsolete +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -comment flag -- method to use for commenting events +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PNAME

        +
        +public static final java.lang.String FLAG_PNAME
        +
        +
        -pname flag -- pathname to lock +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCLock

        +
        +public CCLock()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(boolean replace)
        +
        +
        If true, replace an existing lock. +

        +

        +
        Parameters:
        replace - the status to set the flag to
        +
        +
        +
        + +

        +getReplace

        +
        +public boolean getReplace()
        +
        +
        Get replace flag status +

        +

        + +
        Returns:
        boolean containing status of replace flag
        +
        +
        +
        + +

        +setObsolete

        +
        +public void setObsolete(boolean obsolete)
        +
        +
        If true, mark object as obsolete. +

        +

        +
        Parameters:
        obsolete - the status to set the flag to
        +
        +
        +
        + +

        +getObsolete

        +
        +public boolean getObsolete()
        +
        +
        Get obsolete flag status +

        +

        + +
        Returns:
        boolean containing status of obsolete flag
        +
        +
        +
        + +

        +setNusers

        +
        +public void setNusers(java.lang.String nusers)
        +
        +
        Sets the users who may continue to + edit the object while it is locked. +

        +

        +
        Parameters:
        nusers - users excluded from lock
        +
        +
        +
        + +

        +getNusers

        +
        +public java.lang.String getNusers()
        +
        +
        Get nusers list +

        +

        + +
        Returns:
        String containing the list of users excluded from lock
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets how comments should be written + for the event record(s) +

        +

        +
        Parameters:
        comment - comment method to use
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment method +

        +

        + +
        Returns:
        String containing the desired comment method
        +
        +
        +
        + +

        +setPname

        +
        +public void setPname(java.lang.String pname)
        +
        +
        Sets the pathname to be locked +

        +

        +
        Parameters:
        pname - pathname to be locked
        +
        +
        +
        + +

        +getPname

        +
        +public java.lang.String getPname()
        +
        +
        Get the pathname to be locked +

        +

        + +
        Returns:
        String containing the pathname to be locked
        +
        +
        +
        + +

        +setObjSel

        +
        +public void setObjSel(java.lang.String objsel)
        +
        +
        Sets the object(s) to be locked +

        +

        +
        Parameters:
        objsel - objects to be locked
        Since:
        +
        ant 1.6.1
        +
        +
        +
        +
        + +

        +setObjselect

        +
        +public void setObjselect(java.lang.String objselect)
        +
        +
        Sets the object(s) to be locked +

        +

        +
        Parameters:
        objselect - objects to be locked
        +
        +
        +
        + +

        +getObjselect

        +
        +public java.lang.String getObjselect()
        +
        +
        Get list of objects to be locked +

        +

        + +
        Returns:
        String containing the objects to be locked
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.html new file mode 100644 index 000000000..4ec2c3985 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkattr.html @@ -0,0 +1,815 @@ + + + + + + +CCMkattr (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMkattr

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMkattr
        extends ClearCase
        + + +

        +Task to perform mkattr command to ClearCase. +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onYes
        replaceReplace the value of the attribute if it already existsNo
        recurseProcess each subdirectory under viewpathNo
        versionIdentify a specific version to attach the attribute toNo
        typenameName of the attribute typeYes
        typevalueValue to attach to the attribute typeYes
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the element
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_RECURSE + +
        +          -recurse flag -- process all subdirectories
        +static java.lang.StringFLAG_REPLACE + +
        +          -replace flag -- replace the existing value of the attribute
        +static java.lang.StringFLAG_VERSION + +
        +          -version flag -- attach attribute to specified version
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMkattr() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetRecurse() + +
        +          Get recurse flag status
        + booleangetReplace() + +
        +          Get replace flag status
        + java.lang.StringgetTypeName() + +
        +          Get attribute type-name
        + java.lang.StringgetTypeValue() + +
        +          Get the attribute type-value
        + java.lang.StringgetVersion() + +
        +          Get version flag status
        + voidsetComment(java.lang.String comment) + +
        +          Set comment string
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Set comment file
        + voidsetRecurse(boolean recurse) + +
        +          Set recurse flag
        + voidsetReplace(boolean replace) + +
        +          Set the replace flag
        + voidsetTypeName(java.lang.String tn) + +
        +          Set the attribute type-name
        + voidsetTypeValue(java.lang.String tv) + +
        +          Set the attribute type-value
        + voidsetVersion(java.lang.String version) + +
        +          Set the version flag
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_REPLACE

        +
        +public static final java.lang.String FLAG_REPLACE
        +
        +
        -replace flag -- replace the existing value of the attribute +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RECURSE

        +
        +public static final java.lang.String FLAG_RECURSE
        +
        +
        -recurse flag -- process all subdirectories +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_VERSION

        +
        +public static final java.lang.String FLAG_VERSION
        +
        +
        -version flag -- attach attribute to specified version +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the element +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMkattr

        +
        +public CCMkattr()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(boolean replace)
        +
        +
        Set the replace flag +

        +

        +
        Parameters:
        replace - the status to set the flag to
        +
        +
        +
        + +

        +getReplace

        +
        +public boolean getReplace()
        +
        +
        Get replace flag status +

        +

        + +
        Returns:
        boolean containing status of replace flag
        +
        +
        +
        + +

        +setRecurse

        +
        +public void setRecurse(boolean recurse)
        +
        +
        Set recurse flag +

        +

        +
        Parameters:
        recurse - the status to set the flag to
        +
        +
        +
        + +

        +getRecurse

        +
        +public boolean getRecurse()
        +
        +
        Get recurse flag status +

        +

        + +
        Returns:
        boolean containing status of recurse flag
        +
        +
        +
        + +

        +setVersion

        +
        +public void setVersion(java.lang.String version)
        +
        +
        Set the version flag +

        +

        +
        Parameters:
        version - the status to set the flag to
        +
        +
        +
        + +

        +getVersion

        +
        +public java.lang.String getVersion()
        +
        +
        Get version flag status +

        +

        + +
        Returns:
        boolean containing status of version flag
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Set comment string +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Set comment file +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setTypeName

        +
        +public void setTypeName(java.lang.String tn)
        +
        +
        Set the attribute type-name +

        +

        +
        Parameters:
        tn - the type name
        +
        +
        +
        + +

        +getTypeName

        +
        +public java.lang.String getTypeName()
        +
        +
        Get attribute type-name +

        +

        + +
        Returns:
        String containing type name
        +
        +
        +
        + +

        +setTypeValue

        +
        +public void setTypeValue(java.lang.String tv)
        +
        +
        Set the attribute type-value +

        +

        +
        Parameters:
        tv - the type value
        +
        +
        +
        + +

        +getTypeValue

        +
        +public java.lang.String getTypeValue()
        +
        +
        Get the attribute type-value +

        +

        + +
        Returns:
        String containing type value
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.html new file mode 100644 index 000000000..1830ac8df --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkbl.html @@ -0,0 +1,835 @@ + + + + + + +CCMkbl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMkbl

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMkbl
        extends ClearCase
        + + +

        +Task to CreateBaseline command to ClearCase. +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        commentSpecify a comment. Only one of comment or cfile may be +used.No
        commentfileSpecify a file containing a comment. Only one of comment or +cfile may be used.No
        baselinerootnameSpecify the name to be associated with the baseline.Yes
        nowarnSuppress warning messagesNo
        identicalAllows the baseline to be created even if it is identical to the +previous baseline.No
        fullCreates a full baseline.No
        nlabelAllows the baseline to be created without a label.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_FULL + +
        +          -full flag -- baseline to be created is full
        +static java.lang.StringFLAG_IDENTICAL + +
        +          -identical flag -- allows the file to be checked in even if it is identical to the original
        +static java.lang.StringFLAG_INCREMENTAL + +
        +          -incremental flag -- baseline to be created is incremental
        +static java.lang.StringFLAG_NLABEL + +
        +          -nlabel -- baseline to be created without a label
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMkbl() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetBaselineRootName() + +
        +          Get baseline_root_name
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetFull() + +
        +          Get full flag status
        + booleangetIdentical() + +
        +          Get identical flag status
        + booleangetNlabel() + +
        +          Get nlabel status
        + booleangetNoWarn() + +
        +          Get nowarn flag status
        + voidsetBaselineRootName(java.lang.String baselineRootName) + +
        +          Set baseline_root_name
        + voidsetComment(java.lang.String comment) + +
        +          Set comment string
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Set comment file
        + voidsetFull(boolean full) + +
        +          Set the full flag
        + voidsetIdentical(boolean identical) + +
        +          Set the identical flag
        + voidsetNlabel(boolean nlabel) + +
        +          Set the nlabel flag
        + voidsetNoWarn(boolean nwarn) + +
        +          /** + Set the nowarn flag
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_IDENTICAL

        +
        +public static final java.lang.String FLAG_IDENTICAL
        +
        +
        -identical flag -- allows the file to be checked in even if it is identical to the original +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_INCREMENTAL

        +
        +public static final java.lang.String FLAG_INCREMENTAL
        +
        +
        -incremental flag -- baseline to be created is incremental +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_FULL

        +
        +public static final java.lang.String FLAG_FULL
        +
        +
        -full flag -- baseline to be created is full +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NLABEL

        +
        +public static final java.lang.String FLAG_NLABEL
        +
        +
        -nlabel -- baseline to be created without a label +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMkbl

        +
        +public CCMkbl()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Set comment string +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Set comment file +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setBaselineRootName

        +
        +public void setBaselineRootName(java.lang.String baselineRootName)
        +
        +
        Set baseline_root_name +

        +

        +
        Parameters:
        baselineRootName - the name of the baseline
        +
        +
        +
        + +

        +getBaselineRootName

        +
        +public java.lang.String getBaselineRootName()
        +
        +
        Get baseline_root_name +

        +

        + +
        Returns:
        String containing the name of the baseline
        +
        +
        +
        + +

        +setNoWarn

        +
        +public void setNoWarn(boolean nwarn)
        +
        +
        /** + Set the nowarn flag +

        +

        +
        Parameters:
        nwarn - the status to set the flag to
        +
        +
        +
        + +

        +getNoWarn

        +
        +public boolean getNoWarn()
        +
        +
        Get nowarn flag status +

        +

        + +
        Returns:
        boolean containing status of nwarn flag
        +
        +
        +
        + +

        +setIdentical

        +
        +public void setIdentical(boolean identical)
        +
        +
        Set the identical flag +

        +

        +
        Parameters:
        identical - the status to set the flag to
        +
        +
        +
        + +

        +getIdentical

        +
        +public boolean getIdentical()
        +
        +
        Get identical flag status +

        +

        + +
        Returns:
        boolean containing status of identical flag
        +
        +
        +
        + +

        +setFull

        +
        +public void setFull(boolean full)
        +
        +
        Set the full flag +

        +

        +
        Parameters:
        full - the status to set the flag to
        +
        +
        +
        + +

        +getFull

        +
        +public boolean getFull()
        +
        +
        Get full flag status +

        +

        + +
        Returns:
        boolean containing status of full flag
        +
        +
        +
        + +

        +setNlabel

        +
        +public void setNlabel(boolean nlabel)
        +
        +
        Set the nlabel flag +

        +

        +
        Parameters:
        nlabel - the status to set the flag to
        +
        +
        +
        + +

        +getNlabel

        +
        +public boolean getNlabel()
        +
        +
        Get nlabel status +

        +

        + +
        Returns:
        boolean containing status of nlabel flag
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.html new file mode 100644 index 000000000..89225cb6f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkdir.html @@ -0,0 +1,584 @@ + + + + + + +CCMkdir (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMkdir

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMkdir
        extends ClearCase
        + + +

        +Performs ClearCase mkdir. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view directory that the command will operate onYes
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        nocheckoutDo not checkout after element creationNo
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the directory
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the directory
        +static java.lang.StringFLAG_NOCHECKOUT + +
        +          -nco flag -- do not checkout element after creation
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMkdir() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetNoCheckout() + +
        +          Get no checkout flag status
        + voidsetComment(java.lang.String comment) + +
        +          Sets the comment string.
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Specifies a file containing a comment.
        + voidsetNoCheckout(boolean co) + +
        +          If true, do not checkout element after creation.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the directory +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the directory +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCHECKOUT

        +
        +public static final java.lang.String FLAG_NOCHECKOUT
        +
        +
        -nco flag -- do not checkout element after creation +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMkdir

        +
        +public CCMkdir()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets the comment string. +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Specifies a file containing a comment. +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setNoCheckout

        +
        +public void setNoCheckout(boolean co)
        +
        +
        If true, do not checkout element after creation. +

        +

        +
        Parameters:
        co - the status to set the flag to
        +
        +
        +
        + +

        +getNoCheckout

        +
        +public boolean getNoCheckout()
        +
        +
        Get no checkout flag status +

        +

        + +
        Returns:
        boolean containing status of noco flag
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.html new file mode 100644 index 000000000..352718911 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMkelem.html @@ -0,0 +1,926 @@ + + + + + + +CCMkelem (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMkelem

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMkelem
        extends ClearCase
        + + +

        +Performs ClearCase mkelem. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onYes
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        nowarnSuppress warning messagesNo
        nocheckoutDo not checkout after element creationNo
        checkinCheckin element after creationNo
        preservetimePreserve the modification time (for checkin)No
        masterAssign mastership of the main branch to the current siteNo
        eltypeElement type to use during element creationNo
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_CHECKIN + +
        +          -ci flag -- checkin element after creation
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_ELTYPE + +
        +          -eltype flag -- element type to use during creation
        +static java.lang.StringFLAG_MASTER + +
        +          -master flag -- change mastership of main branch to current site
        +static java.lang.StringFLAG_NOCHECKOUT + +
        +          -nco flag -- do not checkout element after creation
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_NOWARN + +
        +          -nwarn flag -- suppresses warning messages
        +static java.lang.StringFLAG_PRESERVETIME + +
        +          -ptime flag -- preserves the modification time on checkin
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMkelem() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + booleangetCheckin() + +
        +          Get ci flag status
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + java.lang.StringgetEltype() + +
        +          Get element type
        + booleangetMaster() + +
        +          Get master flag status
        + booleangetNoCheckout() + +
        +          Get no checkout flag status
        + booleangetNoWarn() + +
        +          Get nowarn flag status
        + booleangetPreserveTime() + +
        +          Get preservetime flag status
        + voidsetCheckin(boolean ci) + +
        +          If true, checkin the element after creation
        + voidsetComment(java.lang.String comment) + +
        +          Sets the comment string.
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Specifies a file containing a comment.
        + voidsetEltype(java.lang.String eltype) + +
        +          Specifies the element type to use.
        + voidsetMaster(boolean master) + +
        +          If true, changes mastership of the main branch + to the current site
        + voidsetNoCheckout(boolean co) + +
        +          If true, do not checkout element after creation.
        + voidsetNoWarn(boolean nwarn) + +
        +          If true, suppress warning messages.
        + voidsetPreserveTime(boolean ptime) + +
        +          If true, preserve the modification time.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOWARN

        +
        +public static final java.lang.String FLAG_NOWARN
        +
        +
        -nwarn flag -- suppresses warning messages +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PRESERVETIME

        +
        +public static final java.lang.String FLAG_PRESERVETIME
        +
        +
        -ptime flag -- preserves the modification time on checkin +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCHECKOUT

        +
        +public static final java.lang.String FLAG_NOCHECKOUT
        +
        +
        -nco flag -- do not checkout element after creation +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_CHECKIN

        +
        +public static final java.lang.String FLAG_CHECKIN
        +
        +
        -ci flag -- checkin element after creation +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_MASTER

        +
        +public static final java.lang.String FLAG_MASTER
        +
        +
        -master flag -- change mastership of main branch to current site +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_ELTYPE

        +
        +public static final java.lang.String FLAG_ELTYPE
        +
        +
        -eltype flag -- element type to use during creation +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMkelem

        +
        +public CCMkelem()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets the comment string. +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Specifies a file containing a comment. +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setNoWarn

        +
        +public void setNoWarn(boolean nwarn)
        +
        +
        If true, suppress warning messages. +

        +

        +
        Parameters:
        nwarn - the status to set the flag to
        +
        +
        +
        + +

        +getNoWarn

        +
        +public boolean getNoWarn()
        +
        +
        Get nowarn flag status +

        +

        + +
        Returns:
        boolean containing status of nwarn flag
        +
        +
        +
        + +

        +setPreserveTime

        +
        +public void setPreserveTime(boolean ptime)
        +
        +
        If true, preserve the modification time. +

        +

        +
        Parameters:
        ptime - the status to set the flag to
        +
        +
        +
        + +

        +getPreserveTime

        +
        +public boolean getPreserveTime()
        +
        +
        Get preservetime flag status +

        +

        + +
        Returns:
        boolean containing status of preservetime flag
        +
        +
        +
        + +

        +setNoCheckout

        +
        +public void setNoCheckout(boolean co)
        +
        +
        If true, do not checkout element after creation. +

        +

        +
        Parameters:
        co - the status to set the flag to
        +
        +
        +
        + +

        +getNoCheckout

        +
        +public boolean getNoCheckout()
        +
        +
        Get no checkout flag status +

        +

        + +
        Returns:
        boolean containing status of noco flag
        +
        +
        +
        + +

        +setCheckin

        +
        +public void setCheckin(boolean ci)
        +
        +
        If true, checkin the element after creation +

        +

        +
        Parameters:
        ci - the status to set the flag to
        +
        +
        +
        + +

        +getCheckin

        +
        +public boolean getCheckin()
        +
        +
        Get ci flag status +

        +

        + +
        Returns:
        boolean containing status of ci flag
        +
        +
        +
        + +

        +setMaster

        +
        +public void setMaster(boolean master)
        +
        +
        If true, changes mastership of the main branch + to the current site +

        +

        +
        Parameters:
        master - the status to set the flag to
        +
        +
        +
        + +

        +getMaster

        +
        +public boolean getMaster()
        +
        +
        Get master flag status +

        +

        + +
        Returns:
        boolean containing status of master flag
        +
        +
        +
        + +

        +setEltype

        +
        +public void setEltype(java.lang.String eltype)
        +
        +
        Specifies the element type to use. +

        +

        +
        Parameters:
        eltype - to create element
        +
        +
        +
        + +

        +getEltype

        +
        +public java.lang.String getEltype()
        +
        +
        Get element type +

        +

        + +
        Returns:
        String containing the element type
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.html new file mode 100644 index 000000000..e366ea41f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklabel.html @@ -0,0 +1,815 @@ + + + + + + +CCMklabel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMklabel

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMklabel
        extends ClearCase
        + + +

        +Task to perform mklabel command to ClearCase. +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onNo
        replaceReplace a label of the same type on the same branchNo
        recurseProcess each subdirectory under viewpathNo
        versionIdentify a specific version to attach the label toNo
        typenameName of the label typeYes
        vobName of the VOBNo
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_RECURSE + +
        +          -recurse flag -- process all subdirectories
        +static java.lang.StringFLAG_REPLACE + +
        +          -replace flag -- replace another label of the same type
        +static java.lang.StringFLAG_VERSION + +
        +          -version flag -- attach label to specified version
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMklabel() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetRecurse() + +
        +          Get recurse flag status
        + booleangetReplace() + +
        +          Get replace flag status
        + java.lang.StringgetTypeName() + +
        +          Get type-name
        + java.lang.StringgetVersion() + +
        +          Get version flag status
        + java.lang.StringgetVOB() + +
        +          Get VOB name
        + voidsetComment(java.lang.String comment) + +
        +          Set comment string
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Set comment file
        + voidsetRecurse(boolean recurse) + +
        +          Set recurse flag
        + voidsetReplace(boolean replace) + +
        +          Set the replace flag
        + voidsetTypeName(java.lang.String tn) + +
        +          Set the type-name
        + voidsetVersion(java.lang.String version) + +
        +          Set the version flag
        + voidsetVOB(java.lang.String vob) + +
        +          Set the VOB name
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_REPLACE

        +
        +public static final java.lang.String FLAG_REPLACE
        +
        +
        -replace flag -- replace another label of the same type +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RECURSE

        +
        +public static final java.lang.String FLAG_RECURSE
        +
        +
        -recurse flag -- process all subdirectories +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_VERSION

        +
        +public static final java.lang.String FLAG_VERSION
        +
        +
        -version flag -- attach label to specified version +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMklabel

        +
        +public CCMklabel()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(boolean replace)
        +
        +
        Set the replace flag +

        +

        +
        Parameters:
        replace - the status to set the flag to
        +
        +
        +
        + +

        +getReplace

        +
        +public boolean getReplace()
        +
        +
        Get replace flag status +

        +

        + +
        Returns:
        boolean containing status of replace flag
        +
        +
        +
        + +

        +setRecurse

        +
        +public void setRecurse(boolean recurse)
        +
        +
        Set recurse flag +

        +

        +
        Parameters:
        recurse - the status to set the flag to
        +
        +
        +
        + +

        +getRecurse

        +
        +public boolean getRecurse()
        +
        +
        Get recurse flag status +

        +

        + +
        Returns:
        boolean containing status of recurse flag
        +
        +
        +
        + +

        +setVersion

        +
        +public void setVersion(java.lang.String version)
        +
        +
        Set the version flag +

        +

        +
        Parameters:
        version - the status to set the flag to
        +
        +
        +
        + +

        +getVersion

        +
        +public java.lang.String getVersion()
        +
        +
        Get version flag status +

        +

        + +
        Returns:
        boolean containing status of version flag
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Set comment string +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Set comment file +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setTypeName

        +
        +public void setTypeName(java.lang.String tn)
        +
        +
        Set the type-name +

        +

        +
        Parameters:
        tn - the type name
        +
        +
        +
        + +

        +getTypeName

        +
        +public java.lang.String getTypeName()
        +
        +
        Get type-name +

        +

        + +
        Returns:
        String containing type name
        +
        +
        +
        + +

        +setVOB

        +
        +public void setVOB(java.lang.String vob)
        +
        +
        Set the VOB name +

        +

        +
        Parameters:
        vob - the VOB name
        +
        +
        +
        + +

        +getVOB

        +
        +public java.lang.String getVOB()
        +
        +
        Get VOB name +

        +

        + +
        Returns:
        String containing VOB name
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.html new file mode 100644 index 000000000..2cc92ac80 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCMklbtype.html @@ -0,0 +1,953 @@ + + + + + + +CCMklbtype (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCMklbtype

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCMklbtype
        extends ClearCase
        + + +

        +Task to perform mklbtype command to ClearCase. +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        typenameName of the label type to createYes
        vobName of the VOBNo
        replaceReplace an existing label definition of the same typeNo
        globalEither global or ordinary can be specified, not both. + Creates a label type that is global to the VOB or to + VOBs that use this VOBNo
        ordinaryEither global or ordinary can be specified, not both. + Creates a label type that can be used only in the current + VOB. DefaultNo
        pbranchAllows the label type to be used once per branch in a given + element's version treeNo
        sharedSets the way mastership is checked by ClearCase. See ClearCase + documentation for detailsNo
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or + cfile may be used.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_GLOBAL + +
        +          -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_ORDINARY + +
        +          -ordinary flag -- creates a label type that can be used only in the current VOB
        +static java.lang.StringFLAG_PBRANCH + +
        +          -pbranch flag -- allows label type to be used once per branch
        +static java.lang.StringFLAG_REPLACE + +
        +          -replace flag -- replace existing label definition of the same type
        +static java.lang.StringFLAG_SHARED + +
        +          -shared flag -- sets the way mastership is checked by ClearCase
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCMklbtype() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetGlobal() + +
        +          Get global flag status
        + booleangetOrdinary() + +
        +          Get ordinary flag status
        + booleangetPbranch() + +
        +          Get pbranch flag status
        + booleangetReplace() + +
        +          Get replace flag status
        + booleangetShared() + +
        +          Get shared flag status
        + java.lang.StringgetTypeName() + +
        +          Get type-name string
        + java.lang.StringgetVOB() + +
        +          Get VOB name
        + voidsetComment(java.lang.String comment) + +
        +          Set comment string
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Set comment file
        + voidsetGlobal(boolean glob) + +
        +          Set the global flag
        + voidsetOrdinary(boolean ordinary) + +
        +          Set the ordinary flag
        + voidsetPbranch(boolean pbranch) + +
        +          Set the pbranch flag
        + voidsetReplace(boolean repl) + +
        +          Set the replace flag
        + voidsetShared(boolean shared) + +
        +          Set the shared flag
        + voidsetTypeName(java.lang.String tn) + +
        +          Set type-name string
        + voidsetVOB(java.lang.String vob) + +
        +          Set the VOB name
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_REPLACE

        +
        +public static final java.lang.String FLAG_REPLACE
        +
        +
        -replace flag -- replace existing label definition of the same type +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_GLOBAL

        +
        +public static final java.lang.String FLAG_GLOBAL
        +
        +
        -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_ORDINARY

        +
        +public static final java.lang.String FLAG_ORDINARY
        +
        +
        -ordinary flag -- creates a label type that can be used only in the current VOB +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PBRANCH

        +
        +public static final java.lang.String FLAG_PBRANCH
        +
        +
        -pbranch flag -- allows label type to be used once per branch +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_SHARED

        +
        +public static final java.lang.String FLAG_SHARED
        +
        +
        -shared flag -- sets the way mastership is checked by ClearCase +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCMklbtype

        +
        +public CCMklbtype()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setTypeName

        +
        +public void setTypeName(java.lang.String tn)
        +
        +
        Set type-name string +

        +

        +
        Parameters:
        tn - the type-name string
        +
        +
        +
        + +

        +getTypeName

        +
        +public java.lang.String getTypeName()
        +
        +
        Get type-name string +

        +

        + +
        Returns:
        String containing the type-name
        +
        +
        +
        + +

        +setVOB

        +
        +public void setVOB(java.lang.String vob)
        +
        +
        Set the VOB name +

        +

        +
        Parameters:
        vob - the VOB name
        +
        +
        +
        + +

        +getVOB

        +
        +public java.lang.String getVOB()
        +
        +
        Get VOB name +

        +

        + +
        Returns:
        String containing VOB name
        +
        +
        +
        + +

        +setReplace

        +
        +public void setReplace(boolean repl)
        +
        +
        Set the replace flag +

        +

        +
        Parameters:
        repl - the status to set the flag to
        +
        +
        +
        + +

        +getReplace

        +
        +public boolean getReplace()
        +
        +
        Get replace flag status +

        +

        + +
        Returns:
        boolean containing status of replace flag
        +
        +
        +
        + +

        +setGlobal

        +
        +public void setGlobal(boolean glob)
        +
        +
        Set the global flag +

        +

        +
        Parameters:
        glob - the status to set the flag to
        +
        +
        +
        + +

        +getGlobal

        +
        +public boolean getGlobal()
        +
        +
        Get global flag status +

        +

        + +
        Returns:
        boolean containing status of global flag
        +
        +
        +
        + +

        +setOrdinary

        +
        +public void setOrdinary(boolean ordinary)
        +
        +
        Set the ordinary flag +

        +

        +
        Parameters:
        ordinary - the status to set the flag to
        +
        +
        +
        + +

        +getOrdinary

        +
        +public boolean getOrdinary()
        +
        +
        Get ordinary flag status +

        +

        + +
        Returns:
        boolean containing status of ordinary flag
        +
        +
        +
        + +

        +setPbranch

        +
        +public void setPbranch(boolean pbranch)
        +
        +
        Set the pbranch flag +

        +

        +
        Parameters:
        pbranch - the status to set the flag to
        +
        +
        +
        + +

        +getPbranch

        +
        +public boolean getPbranch()
        +
        +
        Get pbranch flag status +

        +

        + +
        Returns:
        boolean containing status of pbranch flag
        +
        +
        +
        + +

        +setShared

        +
        +public void setShared(boolean shared)
        +
        +
        Set the shared flag +

        +

        +
        Parameters:
        shared - the status to set the flag to
        +
        +
        +
        + +

        +getShared

        +
        +public boolean getShared()
        +
        +
        Get shared flag status +

        +

        + +
        Returns:
        boolean containing status of shared flag
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Set comment string +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Set comment file +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.html new file mode 100644 index 000000000..0b391140f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCRmtype.html @@ -0,0 +1,819 @@ + + + + + + +CCRmtype (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCRmtype

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCRmtype
        extends ClearCase
        + + +

        +Task to perform rmtype command to ClearCase. +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        typekindThe kind of type to create. Valid types are:
        + attype attribute type
        + brtype branch type
        + eltype element type
        + hltype hyperlink type
        + lbtype label type
        + trtype trigger type
        +         		Yes
        typenameThe name of the type to removeYes
        vobName of the VOBNo
        ignoreUsed with trigger types only. Forces removal of trigger type + even if a pre-operation trigger would prevent its removalNo
        rmallRemoves all instances of a type and the type object itselfNo
        commentSpecify a comment. Only one of comment or cfile may be used.No
        commentfileSpecify a file containing a comment. Only one of comment or cfile + may be used.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -c flag -- comment to attach to the file
        +static java.lang.StringFLAG_COMMENTFILE + +
        +          -cfile flag -- file containing a comment to attach to the file
        +static java.lang.StringFLAG_FORCE + +
        +          -force flag -- suppresses confirmation prompts
        +static java.lang.StringFLAG_IGNORE + +
        +          -ignore flag -- ignore pre-trigger operations when removing a trigger type
        +static java.lang.StringFLAG_NOCOMMENT + +
        +          -nc flag -- no comment is specified
        +static java.lang.StringFLAG_RMALL + +
        +          -rmall flag -- removes all instances of a type and the type object itself
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCRmtype() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment string
        + java.lang.StringgetCommentFile() + +
        +          Get comment file
        + booleangetIgnore() + +
        +          Get ignore flag status
        + booleangetRmAll() + +
        +          Get rmall flag status
        + java.lang.StringgetTypeKind() + +
        +          Get type-kind string
        + java.lang.StringgetTypeName() + +
        +          Get type-name string
        + java.lang.StringgetVOB() + +
        +          Get VOB name
        + voidsetComment(java.lang.String comment) + +
        +          Set comment string
        + voidsetCommentFile(java.lang.String cfile) + +
        +          Set comment file
        + voidsetIgnore(boolean ignore) + +
        +          Set the ignore flag
        + voidsetRmAll(boolean rmall) + +
        +          Set rmall flag
        + voidsetTypeKind(java.lang.String tk) + +
        +          Set type-kind string
        + voidsetTypeName(java.lang.String tn) + +
        +          Set type-name string
        + voidsetVOB(java.lang.String vob) + +
        +          Set the VOB name
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_IGNORE

        +
        +public static final java.lang.String FLAG_IGNORE
        +
        +
        -ignore flag -- ignore pre-trigger operations when removing a trigger type +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RMALL

        +
        +public static final java.lang.String FLAG_RMALL
        +
        +
        -rmall flag -- removes all instances of a type and the type object itself +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_FORCE

        +
        +public static final java.lang.String FLAG_FORCE
        +
        +
        -force flag -- suppresses confirmation prompts +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -c flag -- comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_COMMENTFILE

        +
        +public static final java.lang.String FLAG_COMMENTFILE
        +
        +
        -cfile flag -- file containing a comment to attach to the file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOCOMMENT

        +
        +public static final java.lang.String FLAG_NOCOMMENT
        +
        +
        -nc flag -- no comment is specified +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCRmtype

        +
        +public CCRmtype()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setIgnore

        +
        +public void setIgnore(boolean ignore)
        +
        +
        Set the ignore flag +

        +

        +
        Parameters:
        ignore - the status to set the flag to
        +
        +
        +
        + +

        +getIgnore

        +
        +public boolean getIgnore()
        +
        +
        Get ignore flag status +

        +

        + +
        Returns:
        boolean containing status of ignore flag
        +
        +
        +
        + +

        +setRmAll

        +
        +public void setRmAll(boolean rmall)
        +
        +
        Set rmall flag +

        +

        +
        Parameters:
        rmall - the status to set the flag to
        +
        +
        +
        + +

        +getRmAll

        +
        +public boolean getRmAll()
        +
        +
        Get rmall flag status +

        +

        + +
        Returns:
        boolean containing status of rmall flag
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Set comment string +

        +

        +
        Parameters:
        comment - the comment string
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment string +

        +

        + +
        Returns:
        String containing the comment
        +
        +
        +
        + +

        +setCommentFile

        +
        +public void setCommentFile(java.lang.String cfile)
        +
        +
        Set comment file +

        +

        +
        Parameters:
        cfile - the path to the comment file
        +
        +
        +
        + +

        +getCommentFile

        +
        +public java.lang.String getCommentFile()
        +
        +
        Get comment file +

        +

        + +
        Returns:
        String containing the path to the comment file
        +
        +
        +
        + +

        +setTypeKind

        +
        +public void setTypeKind(java.lang.String tk)
        +
        +
        Set type-kind string +

        +

        +
        Parameters:
        tk - the type-kind string
        +
        +
        +
        + +

        +getTypeKind

        +
        +public java.lang.String getTypeKind()
        +
        +
        Get type-kind string +

        +

        + +
        Returns:
        String containing the type-kind
        +
        +
        +
        + +

        +setTypeName

        +
        +public void setTypeName(java.lang.String tn)
        +
        +
        Set type-name string +

        +

        +
        Parameters:
        tn - the type-name string
        +
        +
        +
        + +

        +getTypeName

        +
        +public java.lang.String getTypeName()
        +
        +
        Get type-name string +

        +

        + +
        Returns:
        String containing the type-name
        +
        +
        +
        + +

        +setVOB

        +
        +public void setVOB(java.lang.String vob)
        +
        +
        Set the VOB name +

        +

        +
        Parameters:
        vob - the VOB name
        +
        +
        +
        + +

        +getVOB

        +
        +public java.lang.String getVOB()
        +
        +
        Get VOB name +

        +

        + +
        Returns:
        String containing VOB name
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.html new file mode 100644 index 000000000..927db9f1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnCheckout.html @@ -0,0 +1,448 @@ + + + + + + +CCUnCheckout (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCUnCheckout

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCUnCheckout
        extends ClearCase
        + + +

        +Performs ClearCase UnCheckout command. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onNo
        keepcopySpecifies whether to keep a copy of the file with a .keep extension or notNo
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_KEEPCOPY + +
        +          -keep flag -- keep a copy of the file with .keep extension
        +static java.lang.StringFLAG_RM + +
        +          -rm flag -- remove the copy of the file
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCUnCheckout() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + booleangetKeepCopy() + +
        +          Get keepcopy flag status
        + voidsetKeepCopy(boolean keep) + +
        +          If true, keep a copy of the file with a .keep extension.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_KEEPCOPY

        +
        +public static final java.lang.String FLAG_KEEPCOPY
        +
        +
        -keep flag -- keep a copy of the file with .keep extension +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RM

        +
        +public static final java.lang.String FLAG_RM
        +
        +
        -rm flag -- remove the copy of the file +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCUnCheckout

        +
        +public CCUnCheckout()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setKeepCopy

        +
        +public void setKeepCopy(boolean keep)
        +
        +
        If true, keep a copy of the file with a .keep extension. +

        +

        +
        Parameters:
        keep - the status to set the flag to
        +
        +
        +
        + +

        +getKeepCopy

        +
        +public boolean getKeepCopy()
        +
        +
        Get keepcopy flag status +

        +

        + +
        Returns:
        boolean containing status of keep flag
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.html new file mode 100644 index 000000000..707d83703 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUnlock.html @@ -0,0 +1,569 @@ + + + + + + +CCUnlock (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCUnlock

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCUnlock
        extends ClearCase
        + + +

        +Performs a ClearCase Unlock command. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        commentSpecifies how to populate comments fieldsNo
        pnameSpecifies the object pathname to be unlocked.No
        objselectThis variable is obsolete. Should use objsel instead.no
        objselSpecifies the object(s) to be unlocked.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_COMMENT + +
        +          -comment flag -- method to use for commenting events
        +static java.lang.StringFLAG_PNAME + +
        +          -pname flag -- pathname to lock
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCUnlock() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + java.lang.StringgetComment() + +
        +          Get comment method
        + java.lang.StringgetObjselect() + +
        +          Get list of objects to be locked
        + java.lang.StringgetPname() + +
        +          Get the pathname to be locked
        + voidsetComment(java.lang.String comment) + +
        +          Sets how comments should be written + for the event record(s)
        + voidsetObjSel(java.lang.String objsel) + +
        +          Sets the object(s) to be locked
        + voidsetObjselect(java.lang.String objselect) + +
        +          Sets the object(s) to be locked
        + voidsetPname(java.lang.String pname) + +
        +          Sets the pathname to be locked
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_COMMENT

        +
        +public static final java.lang.String FLAG_COMMENT
        +
        +
        -comment flag -- method to use for commenting events +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PNAME

        +
        +public static final java.lang.String FLAG_PNAME
        +
        +
        -pname flag -- pathname to lock +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCUnlock

        +
        +public CCUnlock()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setComment

        +
        +public void setComment(java.lang.String comment)
        +
        +
        Sets how comments should be written + for the event record(s) +

        +

        +
        Parameters:
        comment - comment method to use
        +
        +
        +
        + +

        +getComment

        +
        +public java.lang.String getComment()
        +
        +
        Get comment method +

        +

        + +
        Returns:
        String containing the desired comment method
        +
        +
        +
        + +

        +setPname

        +
        +public void setPname(java.lang.String pname)
        +
        +
        Sets the pathname to be locked +

        +

        +
        Parameters:
        pname - pathname to be locked
        +
        +
        +
        + +

        +getPname

        +
        +public java.lang.String getPname()
        +
        +
        Get the pathname to be locked +

        +

        + +
        Returns:
        String containing the pathname to be locked
        +
        +
        +
        + +

        +setObjselect

        +
        +public void setObjselect(java.lang.String objselect)
        +
        +
        Sets the object(s) to be locked +

        +

        +
        Parameters:
        objselect - objects to be locked
        +
        +
        +
        + +

        +setObjSel

        +
        +public void setObjSel(java.lang.String objsel)
        +
        +
        Sets the object(s) to be locked +

        +

        +
        Parameters:
        objsel - objects to be locked
        Since:
        +
        ant 1.6.1
        +
        +
        +
        +
        + +

        +getObjselect

        +
        +public java.lang.String getObjselect()
        +
        +
        Get list of objects to be locked +

        +

        + +
        Returns:
        String containing the objects to be locked
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.html new file mode 100644 index 000000000..935209c4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/CCUpdate.html @@ -0,0 +1,794 @@ + + + + + + +CCUpdate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class CCUpdate

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+              extended by org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class CCUpdate
        extends ClearCase
        + + +

        +Performs a ClearCase Update command. + +

        + The following attributes are interpreted: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        AttributeValuesRequired
        viewpathPath to the ClearCase view file or directory that the command will operate onNo
        graphicalDisplays a graphical dialog during the updateNo
        logSpecifies a log file for ClearCase to write toNo
        overwriteSpecifies whether to overwrite hijacked files or notNo
        renameSpecifies that hijacked files should be renamed with a .keep extensionNo
        currenttimeSpecifies that modification time should be written as the current + time. Either currenttime or preservetime can be specified.No
        preservetimeSpecifies that modification time should preserved from the VOB + time. Either currenttime or preservetime can be specified.No
        failonerrThrow an exception if the command fails. Default is trueNo
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringFLAG_CURRENTTIME + +
        +          -ctime flag -- modified time is written as the current time
        +static java.lang.StringFLAG_GRAPHICAL + +
        +          -graphical flag -- display graphical dialog during update operation
        +static java.lang.StringFLAG_LOG + +
        +          -log flag -- file to log status to
        +static java.lang.StringFLAG_NOVERWRITE + +
        +          -noverwrite flag -- do not overwrite hijacked files
        +static java.lang.StringFLAG_OVERWRITE + +
        +          -overwrite flag -- overwrite hijacked files
        +static java.lang.StringFLAG_PRESERVETIME + +
        +          -ptime flag -- modified time is written as the VOB time
        +static java.lang.StringFLAG_RENAME + +
        +          -rename flag -- rename hijacked files with .keep extension
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        CCUpdate() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidexecute() + +
        +          Executes the task.
        + booleangetCurrentTime() + +
        +          Get current time status
        + booleangetGraphical() + +
        +          Get graphical flag status
        + java.lang.StringgetLog() + +
        +          Get log file
        + booleangetOverwrite() + +
        +          Get overwrite hijacked files status
        + booleangetPreserveTime() + +
        +          Get preserve time status
        + booleangetRename() + +
        +          Get rename hijacked files status
        + voidsetCurrentTime(boolean ct) + +
        +          If true, modification time should be written as the current time.
        + voidsetGraphical(boolean graphical) + +
        +          If true, displays a graphical dialog during the update.
        + voidsetLog(java.lang.String log) + +
        +          Sets the log file where cleartool records + the status of the command.
        + voidsetOverwrite(boolean ow) + +
        +          If true, overwrite hijacked files.
        + voidsetPreserveTime(boolean pt) + +
        +          If true, modification time should be preserved from the VOB time.
        + voidsetRename(boolean ren) + +
        +          If true, hijacked files are renamed with a .keep extension.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
        getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +FLAG_GRAPHICAL

        +
        +public static final java.lang.String FLAG_GRAPHICAL
        +
        +
        -graphical flag -- display graphical dialog during update operation +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_LOG

        +
        +public static final java.lang.String FLAG_LOG
        +
        +
        -log flag -- file to log status to +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_OVERWRITE

        +
        +public static final java.lang.String FLAG_OVERWRITE
        +
        +
        -overwrite flag -- overwrite hijacked files +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_NOVERWRITE

        +
        +public static final java.lang.String FLAG_NOVERWRITE
        +
        +
        -noverwrite flag -- do not overwrite hijacked files +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_RENAME

        +
        +public static final java.lang.String FLAG_RENAME
        +
        +
        -rename flag -- rename hijacked files with .keep extension +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_CURRENTTIME

        +
        +public static final java.lang.String FLAG_CURRENTTIME
        +
        +
        -ctime flag -- modified time is written as the current time +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +FLAG_PRESERVETIME

        +
        +public static final java.lang.String FLAG_PRESERVETIME
        +
        +
        -ptime flag -- modified time is written as the VOB time +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +CCUpdate

        +
        +public CCUpdate()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the task. +

        + Builds a command line to execute cleartool and then calls Exec's run method + to execute the command line. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the command fails and failonerr is set to true
        +
        +
        +
        + +

        +setGraphical

        +
        +public void setGraphical(boolean graphical)
        +
        +
        If true, displays a graphical dialog during the update. +

        +

        +
        Parameters:
        graphical - the status to set the flag to
        +
        +
        +
        + +

        +getGraphical

        +
        +public boolean getGraphical()
        +
        +
        Get graphical flag status +

        +

        + +
        Returns:
        boolean containing status of graphical flag
        +
        +
        +
        + +

        +setOverwrite

        +
        +public void setOverwrite(boolean ow)
        +
        +
        If true, overwrite hijacked files. +

        +

        +
        Parameters:
        ow - the status to set the flag to
        +
        +
        +
        + +

        +getOverwrite

        +
        +public boolean getOverwrite()
        +
        +
        Get overwrite hijacked files status +

        +

        + +
        Returns:
        boolean containing status of overwrite flag
        +
        +
        +
        + +

        +setRename

        +
        +public void setRename(boolean ren)
        +
        +
        If true, hijacked files are renamed with a .keep extension. +

        +

        +
        Parameters:
        ren - the status to set the flag to
        +
        +
        +
        + +

        +getRename

        +
        +public boolean getRename()
        +
        +
        Get rename hijacked files status +

        +

        + +
        Returns:
        boolean containing status of rename flag
        +
        +
        +
        + +

        +setCurrentTime

        +
        +public void setCurrentTime(boolean ct)
        +
        +
        If true, modification time should be written as the current time. + Either currenttime or preservetime can be specified. +

        +

        +
        Parameters:
        ct - the status to set the flag to
        +
        +
        +
        + +

        +getCurrentTime

        +
        +public boolean getCurrentTime()
        +
        +
        Get current time status +

        +

        + +
        Returns:
        boolean containing status of current time flag
        +
        +
        +
        + +

        +setPreserveTime

        +
        +public void setPreserveTime(boolean pt)
        +
        +
        If true, modification time should be preserved from the VOB time. + Either currenttime or preservetime can be specified. +

        +

        +
        Parameters:
        pt - the status to set the flag to
        +
        +
        +
        + +

        +getPreserveTime

        +
        +public boolean getPreserveTime()
        +
        +
        Get preserve time status +

        +

        + +
        Returns:
        boolean containing status of preserve time flag
        +
        +
        +
        + +

        +setLog

        +
        +public void setLog(java.lang.String log)
        +
        +
        Sets the log file where cleartool records + the status of the command. +

        +

        +
        Parameters:
        log - the path to the log file
        +
        +
        +
        + +

        +getLog

        +
        +public java.lang.String getLog()
        +
        +
        Get log file +

        +

        + +
        Returns:
        String containing the path to the log file
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html new file mode 100644 index 000000000..894971c5b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/ClearCase.html @@ -0,0 +1,826 @@ + + + + + + +ClearCase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.clearcase +
        +Class ClearCase

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        Direct Known Subclasses:
        CCCheckin, CCCheckout, CCLock, CCMkattr, CCMkbl, CCMkdir, CCMkelem, CCMklabel, CCMklbtype, CCRmtype, CCUnCheckout, CCUnlock, CCUpdate
        +
        +
        +
        +
        public abstract class ClearCase
        extends Task
        + + +

        +A base class for creating tasks for executing commands on ClearCase. +

        + The class extends the 'exec' task as it operates by executing the cleartool program + supplied with ClearCase. By default the task expects the cleartool executable to be + in the path, * you can override this be specifying the cleartooldir attribute. +

        +

        + This class provides set and get methods for the 'viewpath' and 'objselect' + attribute. It also contains constants for the flags that can be passed to + cleartool. +

        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringCOMMAND_CHECKIN + +
        +          The 'Checkin' command
        +static java.lang.StringCOMMAND_CHECKOUT + +
        +          The 'Checkout' command
        +static java.lang.StringCOMMAND_LOCK + +
        +          The 'Lock' command
        +static java.lang.StringCOMMAND_LSCO + +
        +          The 'LsCheckout' command
        +static java.lang.StringCOMMAND_MKATTR + +
        +          The 'Mkattr' command
        +static java.lang.StringCOMMAND_MKBL + +
        +          The 'Mkbl' command
        +static java.lang.StringCOMMAND_MKDIR + +
        +          The 'Mkdir' command
        +static java.lang.StringCOMMAND_MKELEM + +
        +          The 'Mkelem' command
        +static java.lang.StringCOMMAND_MKLABEL + +
        +          The 'Mklabel' command
        +static java.lang.StringCOMMAND_MKLBTYPE + +
        +          The 'Mklbtype' command
        +static java.lang.StringCOMMAND_RMTYPE + +
        +          The 'Rmtype' command
        +static java.lang.StringCOMMAND_UNCHECKOUT + +
        +          The 'UndoCheckout' command
        +static java.lang.StringCOMMAND_UNLOCK + +
        +          The 'Unlock' command
        +static java.lang.StringCOMMAND_UPDATE + +
        +          The 'Update' command
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        ClearCase() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  java.lang.StringgetClearToolCommand() + +
        +          Builds and returns the command string to execute cleartool
        + booleangetFailOnErr() + +
        +          Get failonerr flag status
        + java.lang.StringgetObjSelect() + +
        +          Get the object to operate on
        + java.lang.StringgetViewPath() + +
        +          Get the path to the item in a clearcase view
        + java.lang.StringgetViewPathBasename() + +
        +          Get the basename path of the item in a clearcase view
        +protected  intrun(Commandline cmd) + +
        +          Execute the given command are return success or failure
        +protected  java.lang.StringrunS(Commandline cmdline) + +
        +          Execute the given command, and return it's output
        + voidsetClearToolDir(java.lang.String dir) + +
        +          Set the directory where the cleartool executable is located.
        + voidsetFailOnErr(boolean failonerr) + +
        +          If true, command will throw an exception on failure.
        + voidsetObjSelect(java.lang.String objSelect) + +
        +          Set the object to operate on.
        + voidsetViewPath(java.lang.String viewPath) + +
        +          Set the path to the item in a ClearCase view to operate on.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +COMMAND_UPDATE

        +
        +public static final java.lang.String COMMAND_UPDATE
        +
        +
        The 'Update' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_CHECKOUT

        +
        +public static final java.lang.String COMMAND_CHECKOUT
        +
        +
        The 'Checkout' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_CHECKIN

        +
        +public static final java.lang.String COMMAND_CHECKIN
        +
        +
        The 'Checkin' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_UNCHECKOUT

        +
        +public static final java.lang.String COMMAND_UNCHECKOUT
        +
        +
        The 'UndoCheckout' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_LOCK

        +
        +public static final java.lang.String COMMAND_LOCK
        +
        +
        The 'Lock' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_UNLOCK

        +
        +public static final java.lang.String COMMAND_UNLOCK
        +
        +
        The 'Unlock' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKBL

        +
        +public static final java.lang.String COMMAND_MKBL
        +
        +
        The 'Mkbl' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKLABEL

        +
        +public static final java.lang.String COMMAND_MKLABEL
        +
        +
        The 'Mklabel' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKLBTYPE

        +
        +public static final java.lang.String COMMAND_MKLBTYPE
        +
        +
        The 'Mklbtype' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_RMTYPE

        +
        +public static final java.lang.String COMMAND_RMTYPE
        +
        +
        The 'Rmtype' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_LSCO

        +
        +public static final java.lang.String COMMAND_LSCO
        +
        +
        The 'LsCheckout' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKELEM

        +
        +public static final java.lang.String COMMAND_MKELEM
        +
        +
        The 'Mkelem' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKATTR

        +
        +public static final java.lang.String COMMAND_MKATTR
        +
        +
        The 'Mkattr' command +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMMAND_MKDIR

        +
        +public static final java.lang.String COMMAND_MKDIR
        +
        +
        The 'Mkdir' command +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +ClearCase

        +
        +public ClearCase()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setClearToolDir

        +
        +public final void setClearToolDir(java.lang.String dir)
        +
        +
        Set the directory where the cleartool executable is located. +

        +

        +
        Parameters:
        dir - the directory containing the cleartool executable
        +
        +
        +
        + +

        +getClearToolCommand

        +
        +protected final java.lang.String getClearToolCommand()
        +
        +
        Builds and returns the command string to execute cleartool +

        +

        + +
        Returns:
        String containing path to the executable
        +
        +
        +
        + +

        +setViewPath

        +
        +public final void setViewPath(java.lang.String viewPath)
        +
        +
        Set the path to the item in a ClearCase view to operate on. +

        +

        +
        Parameters:
        viewPath - Path to the view directory or file
        +
        +
        +
        + +

        +getViewPath

        +
        +public java.lang.String getViewPath()
        +
        +
        Get the path to the item in a clearcase view +

        +

        + +
        Returns:
        mviewPath
        +
        +
        +
        + +

        +getViewPathBasename

        +
        +public java.lang.String getViewPathBasename()
        +
        +
        Get the basename path of the item in a clearcase view +

        +

        + +
        Returns:
        basename
        +
        +
        +
        + +

        +setObjSelect

        +
        +public final void setObjSelect(java.lang.String objSelect)
        +
        +
        Set the object to operate on. +

        +

        +
        Parameters:
        objSelect - object to operate on
        +
        +
        +
        + +

        +getObjSelect

        +
        +public java.lang.String getObjSelect()
        +
        +
        Get the object to operate on +

        +

        + +
        Returns:
        mobjSelect
        +
        +
        +
        + +

        +run

        +
        +protected int run(Commandline cmd)
        +
        +
        Execute the given command are return success or failure +

        +

        +
        Parameters:
        cmd - command line to execute +
        Returns:
        the exit status of the subprocess or INVALID
        +
        +
        +
        + +

        +runS

        +
        +protected java.lang.String runS(Commandline cmdline)
        +
        +
        Execute the given command, and return it's output +

        +

        +
        Parameters:
        cmdline - command line to execute +
        Returns:
        output of the command line
        +
        +
        +
        + +

        +setFailOnErr

        +
        +public void setFailOnErr(boolean failonerr)
        +
        +
        If true, command will throw an exception on failure. +

        +

        +
        Parameters:
        failonerr - the status to set the flag to
        Since:
        +
        ant 1.6.1
        +
        +
        +
        +
        + +

        +getFailOnErr

        +
        +public boolean getFailOnErr()
        +
        +
        Get failonerr flag status +

        +

        + +
        Returns:
        boolean containing status of failonerr flag
        Since:
        +
        ant 1.6.1
        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-frame.html new file mode 100644 index 000000000..727ddfa76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-frame.html @@ -0,0 +1,58 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.clearcase (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.clearcase + + + + +
        +Classes  + +
        +CCCheckin +
        +CCCheckout +
        +CCLock +
        +CCMkattr +
        +CCMkbl +
        +CCMkdir +
        +CCMkelem +
        +CCMklabel +
        +CCMklbtype +
        +CCRmtype +
        +CCUnCheckout +
        +CCUnlock +
        +CCUpdate +
        +ClearCase
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-summary.html new file mode 100644 index 000000000..c3cf8bf3b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-summary.html @@ -0,0 +1,204 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.clearcase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.clearcase +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        CCCheckinPerforms ClearCase checkin.
        CCCheckoutPerforms ClearCase checkout.
        CCLockPerforms a ClearCase Lock command.
        CCMkattrTask to perform mkattr command to ClearCase.
        CCMkblTask to CreateBaseline command to ClearCase.
        CCMkdirPerforms ClearCase mkdir.
        CCMkelemPerforms ClearCase mkelem.
        CCMklabelTask to perform mklabel command to ClearCase.
        CCMklbtypeTask to perform mklbtype command to ClearCase.
        CCRmtypeTask to perform rmtype command to ClearCase.
        CCUnCheckoutPerforms ClearCase UnCheckout command.
        CCUnlockPerforms a ClearCase Unlock command.
        CCUpdatePerforms a ClearCase Update command.
        ClearCaseA base class for creating tasks for executing commands on ClearCase.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-tree.html new file mode 100644 index 000000000..ee4cb0529 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/clearcase/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.clearcase Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.clearcase +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        +
          +
        • java.lang.Object
            +
          • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
              +
            • org.apache.tools.ant.Task
                +
              • org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
                  +
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckin
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCLock
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMkattr
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMkbl
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMkdir
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMkelem
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMklabel
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCRmtype
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCUnCheckout
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCUnlock
                • org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate
                +
              +
            +
          +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/AntAnalyzer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/AntAnalyzer.html new file mode 100644 index 000000000..732ab644d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/AntAnalyzer.html @@ -0,0 +1,319 @@ + + + + + + +AntAnalyzer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class AntAnalyzer

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.util.depend.AbstractAnalyzer
+      extended by org.apache.tools.ant.taskdefs.optional.depend.AntAnalyzer
+
        +
        +
        All Implemented Interfaces:
        DependencyAnalyzer
        +
        +
        +
        +
        public class AntAnalyzer
        extends AbstractAnalyzer
        + + +

        +An analyzer which uses the depend task's bytecode classes to analyze + dependencies +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
        MAX_LOOPS
        +  + + + + + + + + + + +
        +Constructor Summary
        AntAnalyzer() + +
        +          Default constructor
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voiddetermineDependencies(java.util.Vector files, + java.util.Vector classes) + +
        +          Determine the dependencies of the configured root classes.
        +protected  booleansupportsFileDependencies() + +
        +          Indicate if this analyzer can determine dependent files.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
        addClassPath, addRootClass, addSourcePath, config, getClassContainer, getClassDependencies, getFileDependencies, getRootClasses, getSourceContainer, isClosureRequired, reset, setClosure
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +AntAnalyzer

        +
        +public AntAnalyzer()
        +
        +
        Default constructor +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +determineDependencies

        +
        +protected void determineDependencies(java.util.Vector files,
+                                     java.util.Vector classes)
        +
        +
        Determine the dependencies of the configured root classes. +

        +

        +
        Specified by:
        determineDependencies in class AbstractAnalyzer
        +
        +
        +
        Parameters:
        files - a vector to be populated with the files which contain + the dependency classes
        classes - a vector to be populated with the names of the + dependency classes.
        +
        +
        +
        + +

        +supportsFileDependencies

        +
        +protected boolean supportsFileDependencies()
        +
        +
        Indicate if this analyzer can determine dependent files. +

        +

        +
        Specified by:
        supportsFileDependencies in class AbstractAnalyzer
        +
        +
        + +
        Returns:
        true if the analyzer provides dependency file information.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.html new file mode 100644 index 000000000..6491cf296 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFile.html @@ -0,0 +1,307 @@ + + + + + + +ClassFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class ClassFile

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.ClassFile
+
        +
        +
        +
        public class ClassFile
        extends java.lang.Object
        + + +

        +A ClassFile object stores information about a Java class. The class may + be read from a DataInputStream.and written to a DataOutputStream. These + are usually streams from a Java class file or a class file component of a + Jar file. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        ClassFile() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.util.VectorgetClassRefs() + +
        +          Get the classes which this class references.
        + java.lang.StringgetFullClassName() + +
        +          Get the class' fully qualified name in dot format.
        + voidread(java.io.InputStream stream) + +
        +          Read the class from a data stream.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ClassFile

        +
        +public ClassFile()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.InputStream stream)
+          throws java.io.IOException,
+                 java.lang.ClassFormatError
        +
        +
        Read the class from a data stream. This method takes an InputStream + as input and parses the class from the stream.

        +

        +

        +
        Parameters:
        stream - an InputStream from which the class will be read +
        Throws: +
        java.io.IOException - if there is a problem reading from the given + stream. +
        java.lang.ClassFormatError - if the class cannot be parsed correctly
        +
        +
        +
        + +

        +getClassRefs

        +
        +public java.util.Vector getClassRefs()
        +
        +
        Get the classes which this class references. +

        +

        + +
        Returns:
        a vector of class names which this class references
        +
        +
        +
        + +

        +getFullClassName

        +
        +public java.lang.String getFullClassName()
        +
        +
        Get the class' fully qualified name in dot format. +

        +

        + +
        Returns:
        the class name in dot format (eg. java.lang.Object)
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html new file mode 100644 index 000000000..282877447 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileIterator.html @@ -0,0 +1,211 @@ + + + + + + +ClassFileIterator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Interface ClassFileIterator

        +
        +
        All Known Implementing Classes:
        DirectoryIterator, JarFileIterator
        +
        +
        +
        +
        public interface ClassFileIterator
        + + +

        +Iterator interface for iterating over a set of class files +

        + +

        +

        + +

        + + + + + + + + + + + + +
        +Method Summary
        + ClassFilegetNextClassFile() + +
        +          Get the next class file in the iteration
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +getNextClassFile

        +
        +ClassFile getNextClassFile()
        +
        +
        Get the next class file in the iteration +

        +

        + +
        Returns:
        the next class file in the iteration
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileUtils.html new file mode 100644 index 000000000..6003b7e26 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/ClassFileUtils.html @@ -0,0 +1,282 @@ + + + + + + +ClassFileUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class ClassFileUtils

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.ClassFileUtils
+
        +
        +
        +
        public class ClassFileUtils
        extends java.lang.Object
        + + +

        +Utility class file routines. This class provides a number of static + utility methods to convert between the formats used in the Java class + file format and those commonly used in Java programming. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        ClassFileUtils() + +
        +           
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        +static java.lang.StringconvertDotName(java.lang.String dotName) + +
        +          Convert a class name from java source file dot notation to class file + slash notation..
        +static java.lang.StringconvertSlashName(java.lang.String name) + +
        +          Convert a class name from class file slash notation to java source + file dot notation.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ClassFileUtils

        +
        +public ClassFileUtils()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +convertSlashName

        +
        +public static java.lang.String convertSlashName(java.lang.String name)
        +
        +
        Convert a class name from class file slash notation to java source + file dot notation. +

        +

        +
        Parameters:
        name - the class name in slash notation org/apache/ant +
        Returns:
        the class name in dot notation (eg. java.lang.Object).
        +
        +
        +
        + +

        +convertDotName

        +
        +public static java.lang.String convertDotName(java.lang.String dotName)
        +
        +
        Convert a class name from java source file dot notation to class file + slash notation.. +

        +

        +
        Parameters:
        dotName - the class name in dot notation (eg. java.lang.Object). +
        Returns:
        the class name in slash notation (eg. java/lang/Object).
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/Depend.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/Depend.html new file mode 100644 index 000000000..7e909702c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/Depend.html @@ -0,0 +1,579 @@ + + + + + + +Depend (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class Depend

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.depend.Depend
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, SelectorContainer
        +
        +
        +
        +
        public class Depend
        extends MatchingTask
        + + +

        +Generates a dependency file for a given set of classes. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        fileset
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Depend() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + PathcreateClasspath() + +
        +          Adds a classpath to be used for this dependency check.
        + voidexecute() + +
        +          Does the work.
        + PathgetClasspath() + +
        +          Gets the classpath to be used for this dependency check.
        +protected  voidscanDir(java.io.File srcDir, + java.lang.String[] files) + +
        +          Scans the directory looking for source files that are newer than + their class files.
        + voidsetCache(java.io.File cache) + +
        +          Sets the dependency cache file.
        + voidsetClasspath(Path classpath) + +
        +          Set the classpath to be used for this dependency check.
        + voidsetClasspathRef(Reference r) + +
        +          Adds a reference to a classpath defined elsewhere.
        + voidsetClosure(boolean closure) + +
        +          If true, transitive dependencies are followed until the + closure of the dependency set if reached.
        + voidsetDestDir(Path destPath) + +
        +          Set the destination directory where the compiled Java files exist.
        + voidsetDump(boolean dump) + +
        +          If true, the dependency information will be written + to the debug level log.
        + voidsetSrcdir(Path srcPath) + +
        +          Set the directories path to find the Java source files.
        + voidsetWarnOnRmiStubs(boolean warnOnRmiStubs) + +
        +          Flag to set to true if you want dependency issues with RMI + stubs to appear at warning level.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Depend

        +
        +public Depend()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Set the classpath to be used for this dependency check. +

        +

        +
        Parameters:
        classpath - the classpath to be used when checking for + dependencies on elements in the classpath
        +
        +
        +
        + +

        +getClasspath

        +
        +public Path getClasspath()
        +
        +
        Gets the classpath to be used for this dependency check. +

        +

        + +
        Returns:
        the current dependency classpath
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Adds a classpath to be used for this dependency check. +

        +

        + +
        Returns:
        A path object to be configured by Ant
        +
        +
        +
        + +

        +setClasspathRef

        +
        +public void setClasspathRef(Reference r)
        +
        +
        Adds a reference to a classpath defined elsewhere. +

        +

        +
        Parameters:
        r - a reference to a path object to be used as the depend + classpath
        +
        +
        +
        + +

        +setWarnOnRmiStubs

        +
        +public void setWarnOnRmiStubs(boolean warnOnRmiStubs)
        +
        +
        Flag to set to true if you want dependency issues with RMI + stubs to appear at warning level. +

        +

        +
        Parameters:
        warnOnRmiStubs - if true set dependency issues to appear at warning level.
        Since:
        +
        Ant1.7
        +
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Does the work. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - Thrown in case of an unrecoverable error.
        +
        +
        +
        + +

        +scanDir

        +
        +protected void scanDir(java.io.File srcDir,
+                       java.lang.String[] files)
        +
        +
        Scans the directory looking for source files that are newer than + their class files. The results are returned in the class variable + compileList +

        +

        +
        Parameters:
        srcDir - the source directory
        files - the names of the files in the source dir which are to be + checked.
        +
        +
        +
        + +

        +setSrcdir

        +
        +public void setSrcdir(Path srcPath)
        +
        +
        Set the directories path to find the Java source files. +

        +

        +
        Parameters:
        srcPath - the source path
        +
        +
        +
        + +

        +setDestDir

        +
        +public void setDestDir(Path destPath)
        +
        +
        Set the destination directory where the compiled Java files exist. +

        +

        +
        Parameters:
        destPath - the destination areas where build files are written
        +
        +
        +
        + +

        +setCache

        +
        +public void setCache(java.io.File cache)
        +
        +
        Sets the dependency cache file. +

        +

        +
        Parameters:
        cache - the dependency cache file
        +
        +
        +
        + +

        +setClosure

        +
        +public void setClosure(boolean closure)
        +
        +
        If true, transitive dependencies are followed until the + closure of the dependency set if reached. + When not set, the depend task will only follow + direct dependencies between classes. +

        +

        +
        Parameters:
        closure - indicate if dependency closure is required.
        +
        +
        +
        + +

        +setDump

        +
        +public void setDump(boolean dump)
        +
        +
        If true, the dependency information will be written + to the debug level log. +

        +

        +
        Parameters:
        dump - set to true to dump dependency information to the log
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.html new file mode 100644 index 000000000..8b44a5253 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/DirectoryIterator.html @@ -0,0 +1,287 @@ + + + + + + +DirectoryIterator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class DirectoryIterator

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.DirectoryIterator
+
        +
        +
        All Implemented Interfaces:
        ClassFileIterator
        +
        +
        +
        +
        public class DirectoryIterator
        extends java.lang.Object
        implements ClassFileIterator
        + + +

        +An iterator which iterates through the contents of a java directory. The + iterator should be created with the directory at the root of the Java + namespace. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        DirectoryIterator(java.io.File rootDirectory, + boolean changeInto) + +
        +          Creates a directory iterator.
        +  + + + + + + + + + + + +
        +Method Summary
        + ClassFilegetNextClassFile() + +
        +          Template method to allow subclasses to supply elements for the + iteration.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +DirectoryIterator

        +
        +public DirectoryIterator(java.io.File rootDirectory,
+                         boolean changeInto)
+                  throws java.io.IOException
        +
        +
        Creates a directory iterator. The directory iterator is created to + scan the root directory. If the changeInto flag is given, then the + entries returned will be relative to this directory and not the + current directory. +

        +

        +
        Parameters:
        rootDirectory - the root if the directory namespace which is to + be iterated over
        changeInto - if true then the returned entries will be relative + to the rootDirectory and not the current directory. +
        Throws: +
        java.io.IOException - if there is a problem reading the directory + information.
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getNextClassFile

        +
        +public ClassFile getNextClassFile()
        +
        +
        Template method to allow subclasses to supply elements for the + iteration. The directory iterator maintains a stack of iterators + covering each level in the directory hierarchy. The current iterator + covers the current directory being scanned. If the next entry in that + directory is a subdirectory, the current iterator is pushed onto the + stack and a new iterator is created for the subdirectory. If the + entry is a file, it is returned as the next element and the iterator + remains valid. If there are no more entries in the current directory, + the topmost iterator on the stack is popped off to become the + current iterator. +

        +

        +
        Specified by:
        getNextClassFile in interface ClassFileIterator
        +
        +
        + +
        Returns:
        the next ClassFile in the iteration.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/JarFileIterator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/JarFileIterator.html new file mode 100644 index 000000000..e4fd32580 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/JarFileIterator.html @@ -0,0 +1,268 @@ + + + + + + +JarFileIterator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend +
        +Class JarFileIterator

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.JarFileIterator
+
        +
        +
        All Implemented Interfaces:
        ClassFileIterator
        +
        +
        +
        +
        public class JarFileIterator
        extends java.lang.Object
        implements ClassFileIterator
        + + +

        +A class file iterator which iterates through the contents of a Java jar + file. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        JarFileIterator(java.io.InputStream stream) + +
        +          Construct an iterator over a jar stream
        +  + + + + + + + + + + + +
        +Method Summary
        + ClassFilegetNextClassFile() + +
        +          Get the next ClassFile object from the jar
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +JarFileIterator

        +
        +public JarFileIterator(java.io.InputStream stream)
+                throws java.io.IOException
        +
        +
        Construct an iterator over a jar stream +

        +

        +
        Parameters:
        stream - the basic input stream from which the Jar is received +
        Throws: +
        java.io.IOException - if the jar stream cannot be created
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getNextClassFile

        +
        +public ClassFile getNextClassFile()
        +
        +
        Get the next ClassFile object from the jar +

        +

        +
        Specified by:
        getNextClassFile in interface ClassFileIterator
        +
        +
        + +
        Returns:
        a ClassFile object describing the class from the jar
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ClassCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ClassCPInfo.html new file mode 100644 index 000000000..38a98e9df --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ClassCPInfo.html @@ -0,0 +1,363 @@ + + + + + + +ClassCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class ClassCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo
+
        +
        +
        +
        public class ClassCPInfo
        extends ConstantPoolEntry
        + + +

        +The constant pool entry which stores class information. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        ClassCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetClassName() + +
        +          Get the class name of this entry.
        + voidread(java.io.DataInputStream cpStream) + +
        +          Read the entry from a stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this class info against the given constant pool.
        + java.lang.StringtoString() + +
        +          Generate a string readable version of this entry
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ClassCPInfo

        +
        +public ClassCPInfo()
        +
        +
        Constructor. Sets the tag value for this entry to type Class +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        Read the entry from a stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the stream containing the constant pool entry to be + read. +
        Throws: +
        java.io.IOException - thrown if there is a problem reading the entry + from the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Generate a string readable version of this entry +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        string representation of this constant pool entry
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this class info against the given constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool with which to resolve the + class.
        +
        +
        +
        + +

        +getClassName

        +
        +public java.lang.String getClassName()
        +
        +
        Get the class name of this entry. +

        +

        + +
        Returns:
        the class' name.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantCPInfo.html new file mode 100644 index 000000000..2f45e460a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantCPInfo.html @@ -0,0 +1,315 @@ + + + + + + +ConstantCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class ConstantCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+
        +
        +
        Direct Known Subclasses:
        DoubleCPInfo, FloatCPInfo, IntegerCPInfo, LongCPInfo, StringCPInfo
        +
        +
        +
        +
        public abstract class ConstantCPInfo
        extends ConstantPoolEntry
        + + +

        +A Constant Pool entry which represents a constant value. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + + +
        +Constructor Summary
        +protected ConstantCPInfo(int tagValue, + int entries) + +
        +          Initialise the constant entry.
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.ObjectgetValue() + +
        +          Get the value of the constant.
        + voidsetValue(java.lang.Object newValue) + +
        +          Set the constant value.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, read, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ConstantCPInfo

        +
        +protected ConstantCPInfo(int tagValue,
+                         int entries)
        +
        +
        Initialise the constant entry. +

        +

        +
        Parameters:
        tagValue - the constant pool entry type to be used.
        entries - the number of constant pool entry slots occupied by + this entry.
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getValue

        +
        +public java.lang.Object getValue()
        +
        +
        Get the value of the constant. +

        +

        + +
        Returns:
        the value of the constant (untyped).
        +
        +
        +
        + +

        +setValue

        +
        +public void setValue(java.lang.Object newValue)
        +
        +
        Set the constant value. +

        +

        +
        Parameters:
        newValue - the new untyped value of this constant.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.html new file mode 100644 index 000000000..e4b6eff63 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPool.html @@ -0,0 +1,568 @@ + + + + + + +ConstantPool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class ConstantPool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool
+
        +
        +
        +
        public class ConstantPool
        extends java.lang.Object
        + + +

        +The constant pool of a Java class. The constant pool is a collection of + constants used in a Java class file. It stores strings, constant values, + class names, method names, field names etc. +

        + +

        +

        +
        See Also:
        The Java Virtual + Machine Specification
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        ConstantPool() + +
        +          Initialise the constant pool.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + intaddEntry(ConstantPoolEntry entry) + +
        +          Add an entry to the constant pool.
        + intgetClassEntry(java.lang.String className) + +
        +          Get the index of a given CONSTANT_CLASS entry in the constant pool.
        + intgetConstantEntry(java.lang.Object constantValue) + +
        +          Get the index of a given constant value entry in the constant pool.
        + ConstantPoolEntrygetEntry(int index) + +
        +          Get an constant pool entry at a particular index.
        + intgetFieldRefEntry(java.lang.String fieldClassName, + java.lang.String fieldName, + java.lang.String fieldType) + +
        +          Get the index of a given CONSTANT_FIELDREF entry in the constant + pool.
        + intgetInterfaceMethodRefEntry(java.lang.String interfaceMethodClassName, + java.lang.String interfaceMethodName, + java.lang.String interfaceMethodType) + +
        +          Get the index of a given CONSTANT_INTERFACEMETHODREF entry in the + constant pool.
        + intgetMethodRefEntry(java.lang.String methodClassName, + java.lang.String methodName, + java.lang.String methodType) + +
        +          Get the index of a given CONSTANT_METHODREF entry in the constant + pool.
        + intgetNameAndTypeEntry(java.lang.String name, + java.lang.String type) + +
        +          Get the index of a given CONSTANT_NAMEANDTYPE entry in the constant + pool.
        + intgetUTF8Entry(java.lang.String value) + +
        +          Get the index of a given UTF8 constant pool entry.
        + voidread(java.io.DataInputStream classStream) + +
        +          Read the constant pool from a class input stream.
        + voidresolve() + +
        +          Resolve the entries in the constant pool.
        + intsize() + +
        +          Get the size of the constant pool.
        + java.lang.StringtoString() + +
        +          Dump the constant pool to a string.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ConstantPool

        +
        +public ConstantPool()
        +
        +
        Initialise the constant pool. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream classStream)
+          throws java.io.IOException
        +
        +
        Read the constant pool from a class input stream. +

        +

        +
        Parameters:
        classStream - the DataInputStream of a class file. +
        Throws: +
        java.io.IOException - if there is a problem reading the constant pool + from the stream
        +
        +
        +
        + +

        +size

        +
        +public int size()
        +
        +
        Get the size of the constant pool. +

        +

        + +
        Returns:
        the size of the constant pool
        +
        +
        +
        + +

        +addEntry

        +
        +public int addEntry(ConstantPoolEntry entry)
        +
        +
        Add an entry to the constant pool. +

        +

        +
        Parameters:
        entry - the new entry to be added to the constant pool. +
        Returns:
        the index into the constant pool at which the entry is + stored.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve()
        +
        +
        Resolve the entries in the constant pool. Resolution of the constant + pool involves transforming indexes to other constant pool entries + into the actual data for that entry. +

        +

        +
        +
        +
        +
        + +

        +getEntry

        +
        +public ConstantPoolEntry getEntry(int index)
        +
        +
        Get an constant pool entry at a particular index. +

        +

        +
        Parameters:
        index - the index into the constant pool. +
        Returns:
        the constant pool entry at that index.
        +
        +
        +
        + +

        +getUTF8Entry

        +
        +public int getUTF8Entry(java.lang.String value)
        +
        +
        Get the index of a given UTF8 constant pool entry. +

        +

        +
        Parameters:
        value - the string value of the UTF8 entry. +
        Returns:
        the index at which the given string occurs in the constant + pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getClassEntry

        +
        +public int getClassEntry(java.lang.String className)
        +
        +
        Get the index of a given CONSTANT_CLASS entry in the constant pool. +

        +

        +
        Parameters:
        className - the name of the class for which the class entry + index is required. +
        Returns:
        the index at which the given class entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getConstantEntry

        +
        +public int getConstantEntry(java.lang.Object constantValue)
        +
        +
        Get the index of a given constant value entry in the constant pool. +

        +

        +
        Parameters:
        constantValue - the constant value for which the index is + required. +
        Returns:
        the index at which the given value entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getMethodRefEntry

        +
        +public int getMethodRefEntry(java.lang.String methodClassName,
+                             java.lang.String methodName,
+                             java.lang.String methodType)
        +
        +
        Get the index of a given CONSTANT_METHODREF entry in the constant + pool. +

        +

        +
        Parameters:
        methodClassName - the name of the class which contains the + method being referenced.
        methodName - the name of the method being referenced.
        methodType - the type descriptor of the method being referenced. +
        Returns:
        the index at which the given method ref entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getInterfaceMethodRefEntry

        +
        +public int getInterfaceMethodRefEntry(java.lang.String interfaceMethodClassName,
+                                      java.lang.String interfaceMethodName,
+                                      java.lang.String interfaceMethodType)
        +
        +
        Get the index of a given CONSTANT_INTERFACEMETHODREF entry in the + constant pool. +

        +

        +
        Parameters:
        interfaceMethodClassName - the name of the interface which + contains the method being referenced.
        interfaceMethodName - the name of the method being referenced.
        interfaceMethodType - the type descriptor of the method being + referenced. +
        Returns:
        the index at which the given method ref entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getFieldRefEntry

        +
        +public int getFieldRefEntry(java.lang.String fieldClassName,
+                            java.lang.String fieldName,
+                            java.lang.String fieldType)
        +
        +
        Get the index of a given CONSTANT_FIELDREF entry in the constant + pool. +

        +

        +
        Parameters:
        fieldClassName - the name of the class which contains the field + being referenced.
        fieldName - the name of the field being referenced.
        fieldType - the type descriptor of the field being referenced. +
        Returns:
        the index at which the given field ref entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +getNameAndTypeEntry

        +
        +public int getNameAndTypeEntry(java.lang.String name,
+                               java.lang.String type)
        +
        +
        Get the index of a given CONSTANT_NAMEANDTYPE entry in the constant + pool. +

        +

        +
        Parameters:
        name - the name
        type - the type +
        Returns:
        the index at which the given NameAndType entry occurs in the + constant pool or -1 if the value does not occur.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Dump the constant pool to a string. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the constant pool entries as strings
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPoolEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPoolEntry.html new file mode 100644 index 000000000..5932bf945 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/ConstantPoolEntry.html @@ -0,0 +1,636 @@ + + + + + + +ConstantPoolEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class ConstantPoolEntry

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+
        +
        +
        Direct Known Subclasses:
        ClassCPInfo, ConstantCPInfo, FieldRefCPInfo, InterfaceMethodRefCPInfo, MethodRefCPInfo, NameAndTypeCPInfo, Utf8CPInfo
        +
        +
        +
        +
        public abstract class ConstantPoolEntry
        extends java.lang.Object
        + + +

        +An entry in the constant pool. This class contains a representation of the + constant pool entries. It is an abstract base class for all the different + forms of constant pool entry. +

        + +

        +

        +
        See Also:
        ConstantPool
        +
        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static intCONSTANT_CLASS + +
        +          Tag value for Class entries.
        +static intCONSTANT_DOUBLE + +
        +          Tag value for Double entries.
        +static intCONSTANT_FIELDREF + +
        +          Tag value for Field Reference entries.
        +static intCONSTANT_FLOAT + +
        +          Tag value for Float entries.
        +static intCONSTANT_INTEGER + +
        +          Tag value for Integer entries.
        +static intCONSTANT_INTERFACEMETHODREF + +
        +          Tag value for Interface Method Reference entries.
        +static intCONSTANT_LONG + +
        +          Tag value for Long entries.
        +static intCONSTANT_METHODREF + +
        +          Tag value for Method Reference entries.
        +static intCONSTANT_NAMEANDTYPE + +
        +          Tag value for Name and Type entries.
        +static intCONSTANT_STRING + +
        +          Tag value for String entries.
        +static intCONSTANT_UTF8 + +
        +          Tag value for UTF8 entries.
        +  + + + + + + + + + + +
        +Constructor Summary
        ConstantPoolEntry(int tagValue, + int entries) + +
        +          Initialise the constant pool entry.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + intgetNumEntries() + +
        +          Get the number of Constant Pool Entry slots within the constant pool + occupied by this entry.
        + intgetTag() + +
        +          Get the Entry's type tag.
        + booleanisResolved() + +
        +          Indicates whether this entry has been resolved.
        +abstract  voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        +static ConstantPoolEntryreadEntry(java.io.DataInputStream cpStream) + +
        +          Read a constant pool entry from a stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +CONSTANT_UTF8

        +
        +public static final int CONSTANT_UTF8
        +
        +
        Tag value for UTF8 entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_INTEGER

        +
        +public static final int CONSTANT_INTEGER
        +
        +
        Tag value for Integer entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_FLOAT

        +
        +public static final int CONSTANT_FLOAT
        +
        +
        Tag value for Float entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_LONG

        +
        +public static final int CONSTANT_LONG
        +
        +
        Tag value for Long entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_DOUBLE

        +
        +public static final int CONSTANT_DOUBLE
        +
        +
        Tag value for Double entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_CLASS

        +
        +public static final int CONSTANT_CLASS
        +
        +
        Tag value for Class entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_STRING

        +
        +public static final int CONSTANT_STRING
        +
        +
        Tag value for String entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_FIELDREF

        +
        +public static final int CONSTANT_FIELDREF
        +
        +
        Tag value for Field Reference entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_METHODREF

        +
        +public static final int CONSTANT_METHODREF
        +
        +
        Tag value for Method Reference entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_INTERFACEMETHODREF

        +
        +public static final int CONSTANT_INTERFACEMETHODREF
        +
        +
        Tag value for Interface Method Reference entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CONSTANT_NAMEANDTYPE

        +
        +public static final int CONSTANT_NAMEANDTYPE
        +
        +
        Tag value for Name and Type entries. +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +ConstantPoolEntry

        +
        +public ConstantPoolEntry(int tagValue,
+                         int entries)
        +
        +
        Initialise the constant pool entry. +

        +

        +
        Parameters:
        tagValue - the tag value which identifies which type of constant + pool entry this is.
        entries - the number of constant pool entry slots this entry + occupies.
        +
        + + + + + + + + +
        +Method Detail
        + +

        +readEntry

        +
        +public static ConstantPoolEntry readEntry(java.io.DataInputStream cpStream)
+                                   throws java.io.IOException
        +
        +
        Read a constant pool entry from a stream. This is a factory method + which reads a constant pool entry form a stream and returns the + appropriate subclass for the entry. +

        +

        +
        Parameters:
        cpStream - the stream from which the constant pool entry is to + be read. +
        Returns:
        the appropriate ConstantPoolEntry subclass representing the + constant pool entry from the stream. +
        Throws: +
        java.io.IOException - if the constant pool entry cannot be read + from the stream
        +
        +
        +
        + +

        +isResolved

        +
        +public boolean isResolved()
        +
        +
        Indicates whether this entry has been resolved. In general a constant + pool entry can reference another constant pool entry by its index + value. Resolution involves replacing this index value with the + constant pool entry at that index. +

        +

        + +
        Returns:
        true if this entry has been resolved.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        +
        + +

        +read

        +
        +public abstract void read(java.io.DataInputStream cpStream)
+                   throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +getTag

        +
        +public int getTag()
        +
        +
        Get the Entry's type tag. +

        +

        + +
        Returns:
        The Tag value of this entry
        +
        +
        +
        + +

        +getNumEntries

        +
        +public final int getNumEntries()
        +
        +
        Get the number of Constant Pool Entry slots within the constant pool + occupied by this entry. +

        +

        + +
        Returns:
        the number of slots used.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/DoubleCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/DoubleCPInfo.html new file mode 100644 index 000000000..9dc6d0fc3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/DoubleCPInfo.html @@ -0,0 +1,327 @@ + + + + + + +DoubleCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class DoubleCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+          extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.DoubleCPInfo
+
        +
        +
        +
        public class DoubleCPInfo
        extends ConstantCPInfo
        + + +

        +The constant pool entry subclass used to represent double constant + values. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        DoubleCPInfo() + +
        +          Constructor
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
        getValue, setValue
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +DoubleCPInfo

        +
        +public DoubleCPInfo()
        +
        +
        Constructor +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from the + stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FieldRefCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FieldRefCPInfo.html new file mode 100644 index 000000000..8d5f36d6e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FieldRefCPInfo.html @@ -0,0 +1,409 @@ + + + + + + +FieldRefCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class FieldRefCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo
+
        +
        +
        +
        public class FieldRefCPInfo
        extends ConstantPoolEntry
        + + +

        +A FieldRef CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        FieldRefCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetFieldClassName() + +
        +          Gets the name of the class defining the field
        + java.lang.StringgetFieldName() + +
        +          Get the name of the field
        + java.lang.StringgetFieldType() + +
        +          Get the type of the field
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +FieldRefCPInfo

        +
        +public FieldRefCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +getFieldClassName

        +
        +public java.lang.String getFieldClassName()
        +
        +
        Gets the name of the class defining the field +

        +

        + +
        Returns:
        the name of the class defining the field
        +
        +
        +
        + +

        +getFieldName

        +
        +public java.lang.String getFieldName()
        +
        +
        Get the name of the field +

        +

        + +
        Returns:
        the field's name
        +
        +
        +
        + +

        +getFieldType

        +
        +public java.lang.String getFieldType()
        +
        +
        Get the type of the field +

        +

        + +
        Returns:
        the field's type in string format
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FloatCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FloatCPInfo.html new file mode 100644 index 000000000..810685fdd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/FloatCPInfo.html @@ -0,0 +1,326 @@ + + + + + + +FloatCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class FloatCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+          extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.FloatCPInfo
+
        +
        +
        +
        public class FloatCPInfo
        extends ConstantCPInfo
        + + +

        +A Float CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        FloatCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
        getValue, setValue
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +FloatCPInfo

        +
        +public FloatCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/IntegerCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/IntegerCPInfo.html new file mode 100644 index 000000000..971220703 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/IntegerCPInfo.html @@ -0,0 +1,326 @@ + + + + + + +IntegerCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class IntegerCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+          extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.IntegerCPInfo
+
        +
        +
        +
        public class IntegerCPInfo
        extends ConstantCPInfo
        + + +

        +An Integer CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        IntegerCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
        getValue, setValue
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +IntegerCPInfo

        +
        +public IntegerCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.html new file mode 100644 index 000000000..ea5e0a8db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/InterfaceMethodRefCPInfo.html @@ -0,0 +1,409 @@ + + + + + + +InterfaceMethodRefCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class InterfaceMethodRefCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo
+
        +
        +
        +
        public class InterfaceMethodRefCPInfo
        extends ConstantPoolEntry
        + + +

        +A InterfaceMethodRef CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        InterfaceMethodRefCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetInterfaceMethodClassName() + +
        +          Gets the name of the class defining the interface method
        + java.lang.StringgetInterfaceMethodName() + +
        +          Get the name of the interface method
        + java.lang.StringgetInterfaceMethodType() + +
        +          Gets the type of the interface method
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +InterfaceMethodRefCPInfo

        +
        +public InterfaceMethodRefCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +getInterfaceMethodClassName

        +
        +public java.lang.String getInterfaceMethodClassName()
        +
        +
        Gets the name of the class defining the interface method +

        +

        + +
        Returns:
        the name of the class defining the interface method
        +
        +
        +
        + +

        +getInterfaceMethodName

        +
        +public java.lang.String getInterfaceMethodName()
        +
        +
        Get the name of the interface method +

        +

        + +
        Returns:
        the name of the interface method
        +
        +
        +
        + +

        +getInterfaceMethodType

        +
        +public java.lang.String getInterfaceMethodType()
        +
        +
        Gets the type of the interface method +

        +

        + +
        Returns:
        the interface method's type signature
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/LongCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/LongCPInfo.html new file mode 100644 index 000000000..ab11b83e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/LongCPInfo.html @@ -0,0 +1,326 @@ + + + + + + +LongCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class LongCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+          extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.LongCPInfo
+
        +
        +
        +
        public class LongCPInfo
        extends ConstantCPInfo
        + + +

        +A Long CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        LongCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + +
        +Method Summary
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
        getValue, setValue
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +LongCPInfo

        +
        +public LongCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodRefCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodRefCPInfo.html new file mode 100644 index 000000000..28b6b5721 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/MethodRefCPInfo.html @@ -0,0 +1,409 @@ + + + + + + +MethodRefCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class MethodRefCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo
+
        +
        +
        +
        public class MethodRefCPInfo
        extends ConstantPoolEntry
        + + +

        +A MethodRef CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        MethodRefCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetMethodClassName() + +
        +          Get the name of the class defining the method
        + java.lang.StringgetMethodName() + +
        +          Get the name of the method.
        + java.lang.StringgetMethodType() + +
        +          Get the type signature of the method.
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +MethodRefCPInfo

        +
        +public MethodRefCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        +
        + +

        +getMethodClassName

        +
        +public java.lang.String getMethodClassName()
        +
        +
        Get the name of the class defining the method +

        +

        + +
        Returns:
        the name of the class defining this method
        +
        +
        +
        + +

        +getMethodName

        +
        +public java.lang.String getMethodName()
        +
        +
        Get the name of the method. +

        +

        + +
        Returns:
        the name of the method.
        +
        +
        +
        + +

        +getMethodType

        +
        +public java.lang.String getMethodType()
        +
        +
        Get the type signature of the method. +

        +

        + +
        Returns:
        the type signature of the method.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/NameAndTypeCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/NameAndTypeCPInfo.html new file mode 100644 index 000000000..3ff21473e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/NameAndTypeCPInfo.html @@ -0,0 +1,387 @@ + + + + + + +NameAndTypeCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class NameAndTypeCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo
+
        +
        +
        +
        public class NameAndTypeCPInfo
        extends ConstantPoolEntry
        + + +

        +A NameAndType CP Info +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        NameAndTypeCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetName() + +
        +          Get the name component of this entry
        + java.lang.StringgetType() + +
        +          Get the type signature of this entry
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +NameAndTypeCPInfo

        +
        +public NameAndTypeCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        +
        + +

        +getName

        +
        +public java.lang.String getName()
        +
        +
        Get the name component of this entry +

        +

        + +
        Returns:
        the name of this name and type entry
        +
        +
        +
        + +

        +getType

        +
        +public java.lang.String getType()
        +
        +
        Get the type signature of this entry +

        +

        + +
        Returns:
        the type signature of this entry
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/StringCPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/StringCPInfo.html new file mode 100644 index 000000000..4b48b3f17 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/StringCPInfo.html @@ -0,0 +1,354 @@ + + + + + + +StringCPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class StringCPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
+          extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo
+
        +
        +
        +
        public class StringCPInfo
        extends ConstantCPInfo
        + + +

        +A String Constant Pool Entry. The String info contains an index into the + constant pool where a UTF8 string is stored. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        StringCPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + voidresolve(ConstantPool constantPool) + +
        +          Resolve this constant pool entry with respect to its dependents in + the constant pool.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
        getValue, setValue
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +StringCPInfo

        +
        +public StringCPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +resolve

        +
        +public void resolve(ConstantPool constantPool)
        +
        +
        Resolve this constant pool entry with respect to its dependents in + the constant pool. +

        +

        +
        Overrides:
        resolve in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        constantPool - the constant pool of which this entry is a member + and against which this entry is to be resolved.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/Utf8CPInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/Utf8CPInfo.html new file mode 100644 index 000000000..bcad151a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/Utf8CPInfo.html @@ -0,0 +1,338 @@ + + + + + + +Utf8CPInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
        +Class Utf8CPInfo

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
+      extended by org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo
+
        +
        +
        +
        public class Utf8CPInfo
        extends ConstantPoolEntry
        + + +

        +A UTF8 Constant Pool Entry. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        CONSTANT_CLASS, CONSTANT_DOUBLE, CONSTANT_FIELDREF, CONSTANT_FLOAT, CONSTANT_INTEGER, CONSTANT_INTERFACEMETHODREF, CONSTANT_LONG, CONSTANT_METHODREF, CONSTANT_NAMEANDTYPE, CONSTANT_STRING, CONSTANT_UTF8
        +  + + + + + + + + + + +
        +Constructor Summary
        Utf8CPInfo() + +
        +          Constructor.
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringgetValue() + +
        +          Get the string value of the UTF-8 entry
        + voidread(java.io.DataInputStream cpStream) + +
        +          read a constant pool entry from a class stream.
        + java.lang.StringtoString() + +
        +          Print a readable version of the constant pool entry.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
        getNumEntries, getTag, isResolved, readEntry, resolve
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Utf8CPInfo

        +
        +public Utf8CPInfo()
        +
        +
        Constructor. +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +read

        +
        +public void read(java.io.DataInputStream cpStream)
+          throws java.io.IOException
        +
        +
        read a constant pool entry from a class stream. +

        +

        +
        Specified by:
        read in class ConstantPoolEntry
        +
        +
        +
        Parameters:
        cpStream - the DataInputStream which contains the constant pool + entry to be read. +
        Throws: +
        java.io.IOException - if there is a problem reading the entry from + the stream.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Print a readable version of the constant pool entry. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation of this constant pool entry.
        +
        +
        +
        + +

        +getValue

        +
        +public java.lang.String getValue()
        +
        +
        Get the string value of the UTF-8 entry +

        +

        + +
        Returns:
        the UTF-8 value as a Java string
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-frame.html new file mode 100644 index 000000000..d3b11b117 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-frame.html @@ -0,0 +1,58 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend.constantpool (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.depend.constantpool + + + + +
        +Classes  + +
        +ClassCPInfo +
        +ConstantCPInfo +
        +ConstantPool +
        +ConstantPoolEntry +
        +DoubleCPInfo +
        +FieldRefCPInfo +
        +FloatCPInfo +
        +IntegerCPInfo +
        +InterfaceMethodRefCPInfo +
        +LongCPInfo +
        +MethodRefCPInfo +
        +NameAndTypeCPInfo +
        +StringCPInfo +
        +Utf8CPInfo
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-summary.html new file mode 100644 index 000000000..6658a2a47 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-summary.html @@ -0,0 +1,205 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend.constantpool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.depend.constantpool +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        ClassCPInfoThe constant pool entry which stores class information.
        ConstantCPInfoA Constant Pool entry which represents a constant value.
        ConstantPoolThe constant pool of a Java class.
        ConstantPoolEntryAn entry in the constant pool.
        DoubleCPInfoThe constant pool entry subclass used to represent double constant + values.
        FieldRefCPInfoA FieldRef CP Info
        FloatCPInfoA Float CP Info
        IntegerCPInfoAn Integer CP Info
        InterfaceMethodRefCPInfoA InterfaceMethodRef CP Info
        LongCPInfoA Long CP Info
        MethodRefCPInfoA MethodRef CP Info
        NameAndTypeCPInfoA NameAndType CP Info
        StringCPInfoA String Constant Pool Entry.
        Utf8CPInfoA UTF8 Constant Pool Entry.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-tree.html new file mode 100644 index 000000000..e976b1d46 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/constantpool/package-tree.html @@ -0,0 +1,151 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend.constantpool Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.depend.constantpool +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        +
          +
        • java.lang.Object
            +
          • org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPool
          • org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantPoolEntry
              +
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.ClassCPInfo
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.ConstantCPInfo
                +
              • org.apache.tools.ant.taskdefs.optional.depend.constantpool.DoubleCPInfo
              • org.apache.tools.ant.taskdefs.optional.depend.constantpool.FloatCPInfo
              • org.apache.tools.ant.taskdefs.optional.depend.constantpool.IntegerCPInfo
              • org.apache.tools.ant.taskdefs.optional.depend.constantpool.LongCPInfo
              • org.apache.tools.ant.taskdefs.optional.depend.constantpool.StringCPInfo
              +
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.FieldRefCPInfo
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.InterfaceMethodRefCPInfo
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.MethodRefCPInfo
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.NameAndTypeCPInfo
            • org.apache.tools.ant.taskdefs.optional.depend.constantpool.Utf8CPInfo
            +
          +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-frame.html new file mode 100644 index 000000000..e9abb8b1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-frame.html @@ -0,0 +1,53 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.depend + + + + +
        +Interfaces  + +
        +ClassFileIterator
        + + + + + + +
        +Classes  + +
        +AntAnalyzer +
        +ClassFile +
        +ClassFileUtils +
        +Depend +
        +DirectoryIterator +
        +JarFileIterator
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-summary.html new file mode 100644 index 000000000..df6fab20e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-summary.html @@ -0,0 +1,188 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.depend +

        + + + + + + + + + +
        +Interface Summary
        ClassFileIteratorIterator interface for iterating over a set of class files
        +  + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        AntAnalyzerAn analyzer which uses the depend task's bytecode classes to analyze + dependencies
        ClassFileA ClassFile object stores information about a Java class.
        ClassFileUtilsUtility class file routines.
        DependGenerates a dependency file for a given set of classes.
        DirectoryIteratorAn iterator which iterates through the contents of a java directory.
        JarFileIteratorA class file iterator which iterates through the contents of a Java jar + file.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-tree.html new file mode 100644 index 000000000..1beeec2be --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/depend/package-tree.html @@ -0,0 +1,165 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.depend Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.depend +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        + +

        +Interface Hierarchy +

        + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.html new file mode 100644 index 000000000..de2a37074 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.html @@ -0,0 +1,851 @@ + + + + + + +BorlandDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class BorlandDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.BorlandDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        ExecuteStreamHandler, EJBDeploymentTool
        +
        +
        +
        +
        public class BorlandDeploymentTool
        extends GenericDeploymentTool
        implements ExecuteStreamHandler
        + + +

        +BorlandDeploymentTool is dedicated to the Borland Application Server 4.5 and 4.5.1 + This task generates and compiles the stubs and skeletons for all ejb described into the + Deployment Descriptor, builds the jar file including the support files and verify + whether the produced jar is valid or not. + The supported options are: +

          +
        • debug (boolean) : turn on the debug mode for generation of + stubs and skeletons (default:false)
          • +
        • verify (boolean) : turn on the verification at the end of the jar + production (default:true)
          • +
        • verifyargs (String) : add optional argument to verify command + (see vbj com.inprise.ejb.util.Verify)
          • +
        • basdtd (String) : location of the BAS DTD
          • +
        • generateclient (boolean) : turn on the client jar file generation
          • +
        • version (int) : tell what is the Borland appserver version 4 or 5
          • +
        + +
        +
+      <ejbjar srcdir="${build.classes}"
+               basejarname="vsmp"
+               descriptordir="${rsc.dir}/hrmanager">
+        <borland destdir="tstlib">
+          <classpath refid="classpath" />
+        </borland>
+        <include name="**\ejb-jar.xml"/>
+        <support dir="${build.classes}">
+          <include name="demo\smp\*.class"/>
+          <include name="demo\helper\*.class"/>
+         </support>
+     </ejbjar>
+
        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected static java.lang.StringBAS_DD + +
        +           
        +protected static java.lang.StringBES_DD + +
        +           
        +protected static java.lang.StringDEFAULT_BAS_DTD_LOCATION + +
        +           
        +protected static java.lang.StringDEFAULT_BAS45_EJB11_DTD_LOCATION + +
        +           
        +protected static java.lang.StringJAVA2IIOP + +
        +          Java2iiop executable
        +static java.lang.StringPUBLICID_BORLAND_EJB + +
        +          Borland 1.1 ejb id
        +protected static java.lang.StringVERIFY + +
        +          Verify class
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        BorlandDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the + EJB Jar.
        +protected  DescriptorHandlergetBorlandDescriptorHandler(java.io.File srcDir) + +
        +          Get the borland descriptor handler.
        + voidsetBASdtd(java.lang.String inString) + +
        +          Setter used to store the location of the borland DTD.
        + voidsetDebug(boolean debug) + +
        +          set the debug mode for java2iiop (default false)
        + voidsetGenerateclient(boolean b) + +
        +          setter used to store whether the task will include the generate client task.
        + voidsetJava2iiopParams(java.lang.String params) + +
        +          If filled, the params are added to the java2iiop command.
        + voidsetProcessErrorStream(java.io.InputStream is) + +
        +          Set the error stream of the process.
        + voidsetProcessInputStream(java.io.OutputStream param1) + +
        +          Install a handler for the input stream of the subprocess..
        + voidsetProcessOutputStream(java.io.InputStream is) + +
        +          Set the output stream of the process.
        + voidsetSuffix(java.lang.String inString) + +
        +          Setter used to store the suffix for the generated borland jar file.
        + voidsetVerify(boolean verify) + +
        +          set the verify mode for the produced jar (default true)
        + voidsetVerifyArgs(java.lang.String args) + +
        +          sets some additional args to send to verify command
        + voidsetVersion(int version) + +
        +          setter used to store the borland appserver version [4 or 5]
        + voidstart() + +
        +          Start handling of the streams..
        + voidstop() + +
        +          Stop handling of the streams - will not be restarted..
        +protected  voidwriteJar(java.lang.String baseName, + java.io.File jarFile, + java.util.Hashtable files, + java.lang.String publicId) + +
        +          Method used to encapsulate the writing of the JAR file.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDescriptorHandler, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, registerKnownDTDs, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName, validateConfigured
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +PUBLICID_BORLAND_EJB

        +
        +public static final java.lang.String PUBLICID_BORLAND_EJB
        +
        +
        Borland 1.1 ejb id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_BAS45_EJB11_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_BAS45_EJB11_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_BAS_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_BAS_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +BAS_DD

        +
        +protected static final java.lang.String BAS_DD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +BES_DD

        +
        +protected static final java.lang.String BES_DD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JAVA2IIOP

        +
        +protected static final java.lang.String JAVA2IIOP
        +
        +
        Java2iiop executable +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +VERIFY

        +
        +protected static final java.lang.String VERIFY
        +
        +
        Verify class +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +BorlandDeploymentTool

        +
        +public BorlandDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setDebug

        +
        +public void setDebug(boolean debug)
        +
        +
        set the debug mode for java2iiop (default false) +

        +

        +
        +
        +
        +
        Parameters:
        debug - the setting to use.
        +
        +
        +
        + +

        +setVerify

        +
        +public void setVerify(boolean verify)
        +
        +
        set the verify mode for the produced jar (default true) +

        +

        +
        +
        +
        +
        Parameters:
        verify - the setting to use.
        +
        +
        +
        + +

        +setSuffix

        +
        +public void setSuffix(java.lang.String inString)
        +
        +
        Setter used to store the suffix for the generated borland jar file. +

        +

        +
        +
        +
        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +setVerifyArgs

        +
        +public void setVerifyArgs(java.lang.String args)
        +
        +
        sets some additional args to send to verify command +

        +

        +
        +
        +
        +
        Parameters:
        args - additional command line parameters
        +
        +
        +
        + +

        +setBASdtd

        +
        +public void setBASdtd(java.lang.String inString)
        +
        +
        Setter used to store the location of the borland DTD. This can be a file on the system + or a resource on the classpath. +

        +

        +
        +
        +
        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +setGenerateclient

        +
        +public void setGenerateclient(boolean b)
        +
        +
        setter used to store whether the task will include the generate client task. + (see : BorlandGenerateClient task) +

        +

        +
        +
        +
        +
        Parameters:
        b - if true generate the client task.
        +
        +
        +
        + +

        +setVersion

        +
        +public void setVersion(int version)
        +
        +
        setter used to store the borland appserver version [4 or 5] +

        +

        +
        +
        +
        +
        Parameters:
        version - app server version 4 or 5
        +
        +
        +
        + +

        +setJava2iiopParams

        +
        +public void setJava2iiopParams(java.lang.String params)
        +
        +
        If filled, the params are added to the java2iiop command. + (ex: -no_warn_missing_define) +

        +

        +
        +
        +
        +
        Parameters:
        params - additional params for java2iiop
        +
        +
        +
        + +

        +getBorlandDescriptorHandler

        +
        +protected DescriptorHandler getBorlandDescriptorHandler(java.io.File srcDir)
        +
        +
        Get the borland descriptor handler. +

        +

        +
        +
        +
        +
        Parameters:
        srcDir - the source directory. +
        Returns:
        the descriptor.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the + EJB Jar. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - the map to add the files to.
        ddPrefix - the prefix to use.
        +
        +
        +
        + +

        +writeJar

        +
        +protected void writeJar(java.lang.String baseName,
+                        java.io.File jarFile,
+                        java.util.Hashtable files,
+                        java.lang.String publicId)
+                 throws BuildException
        +
        +
        Method used to encapsulate the writing of the JAR file. Iterates over the + filenames/java.io.Files in the Hashtable stored on the instance variable + ejbFiles. +

        +

        +
        Overrides:
        writeJar in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        baseName - the base name.
        jarFile - the jar file to write to.
        files - the files to write to the jar.
        publicId - the id to use. +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +start

        +
        +public void start()
+           throws java.io.IOException
        +
        +
        Start handling of the streams.. +

        +

        +
        Specified by:
        start in interface ExecuteStreamHandler
        +
        +
        + +
        Throws: +
        java.io.IOException - on error
        +
        +
        +
        + +

        +stop

        +
        +public void stop()
        +
        +
        Stop handling of the streams - will not be restarted.. +

        +

        +
        Specified by:
        stop in interface ExecuteStreamHandler
        +
        +
        +
        +
        +
        +
        + +

        +setProcessInputStream

        +
        +public void setProcessInputStream(java.io.OutputStream param1)
+                           throws java.io.IOException
        +
        +
        Install a handler for the input stream of the subprocess.. +

        +

        +
        Specified by:
        setProcessInputStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        param1 - output stream to write to the standard input stream of the + subprocess +
        Throws: +
        java.io.IOException - on error
        +
        +
        +
        + +

        +setProcessOutputStream

        +
        +public void setProcessOutputStream(java.io.InputStream is)
+                            throws java.io.IOException
        +
        +
        Set the output stream of the process. +

        +

        +
        Specified by:
        setProcessOutputStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        is - the input stream. +
        Throws: +
        java.io.IOException - if there is an error.
        +
        +
        +
        + +

        +setProcessErrorStream

        +
        +public void setProcessErrorStream(java.io.InputStream is)
+                           throws java.io.IOException
        +
        +
        Set the error stream of the process. +

        +

        +
        Specified by:
        setProcessErrorStream in interface ExecuteStreamHandler
        +
        +
        +
        Parameters:
        is - the input stream. +
        Throws: +
        java.io.IOException - if there is an error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandGenerateClient.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandGenerateClient.html new file mode 100644 index 000000000..024fc4c64 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/BorlandGenerateClient.html @@ -0,0 +1,580 @@ + + + + + + +BorlandGenerateClient (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class BorlandGenerateClient

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ejb.BorlandGenerateClient
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class BorlandGenerateClient
        extends Task
        + + +

        +Generates a Borland Application Server 4.5 client JAR using as + input the EJB JAR file. + + Two mode are available: java mode (default) and fork mode. With the fork mode, + it is impossible to add classpath to the command line. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        BorlandGenerateClient() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + PathcreateClasspath() + +
        +          Adds path to the classpath.
        + voidexecute() + +
        +          Do the work.
        +protected  voidexecuteFork() + +
        +          launch the generate client using system api.
        +protected  voidexecuteForkV4() + +
        +          launch the generate client using system api.
        +protected  voidexecuteForkV5() + +
        +          launch the generate client using system api.
        +protected  voidexecuteJava() + +
        +          launch the generate client using java api.
        + voidsetClasspath(Path classpath) + +
        +          Path to use for classpath.
        + voidsetClasspathRef(Reference r) + +
        +          Reference to existing path, to use as a classpath.
        + voidsetClientjar(java.io.File clientjar) + +
        +          Client JAR file name.
        + voidsetDebug(boolean debug) + +
        +          If true, turn on the debug mode for each of the Borland tools launched.
        + voidsetEjbjar(java.io.File ejbfile) + +
        +          EJB JAR file.
        + voidsetMode(java.lang.String s) + +
        +          Command launching mode: java or fork.
        + voidsetVersion(int version) + +
        +          Set the version attribute.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +BorlandGenerateClient

        +
        +public BorlandGenerateClient()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setVersion

        +
        +public void setVersion(int version)
        +
        +
        Set the version attribute. +

        +

        +
        Parameters:
        version - the value to use.
        +
        +
        +
        + +

        +setMode

        +
        +public void setMode(java.lang.String s)
        +
        +
        Command launching mode: java or fork. +

        +

        +
        Parameters:
        s - the mode to use.
        +
        +
        +
        + +

        +setDebug

        +
        +public void setDebug(boolean debug)
        +
        +
        If true, turn on the debug mode for each of the Borland tools launched. +

        +

        +
        Parameters:
        debug - a boolean value.
        +
        +
        +
        + +

        +setEjbjar

        +
        +public void setEjbjar(java.io.File ejbfile)
        +
        +
        EJB JAR file. +

        +

        +
        Parameters:
        ejbfile - the file to use.
        +
        +
        +
        + +

        +setClientjar

        +
        +public void setClientjar(java.io.File clientjar)
        +
        +
        Client JAR file name. +

        +

        +
        Parameters:
        clientjar - the file to use.
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Path to use for classpath. +

        +

        +
        Parameters:
        classpath - the path to use.
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Adds path to the classpath. +

        +

        + +
        Returns:
        a path to be configured as a nested element.
        +
        +
        +
        + +

        +setClasspathRef

        +
        +public void setClasspathRef(Reference r)
        +
        +
        Reference to existing path, to use as a classpath. +

        +

        +
        Parameters:
        r - the reference to use.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Do the work. + + The work is actually done by creating a separate JVM to run a java task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if something goes wrong with the build
        +
        +
        +
        + +

        +executeJava

        +
        +protected void executeJava()
+                    throws BuildException
        +
        +
        launch the generate client using java api. +

        +

        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +executeFork

        +
        +protected void executeFork()
+                    throws BuildException
        +
        +
        launch the generate client using system api. +

        +

        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +executeForkV4

        +
        +protected void executeForkV4()
+                      throws BuildException
        +
        +
        launch the generate client using system api. +

        +

        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +executeForkV5

        +
        +protected void executeForkV5()
+                      throws BuildException
        +
        +
        launch the generate client using system api. +

        +

        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html new file mode 100644 index 000000000..e5018415d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html @@ -0,0 +1,642 @@ + + + + + + +DescriptorHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class DescriptorHandler

        +
        +java.lang.Object
+  extended by org.xml.sax.HandlerBase
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler
+
        +
        +
        All Implemented Interfaces:
        org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
        +
        +
        +
        +
        public class DescriptorHandler
        extends org.xml.sax.HandlerBase
        + + +

        +Inner class used by EjbJar to facilitate the parsing of deployment + descriptors and the capture of appropriate information. Extends + HandlerBase so it only implements the methods needed. During parsing + creates a hashtable consisting of entries mapping the name it should be + inserted into an EJB jar as to a File representing the file on disk. This + list can then be accessed through the getFiles() method. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected  java.lang.StringcurrentElement + +
        +          Instance variable used to store the name of the current element being + processed by the SAX parser.
        +protected  java.lang.StringcurrentText + +
        +          The text of the current element
        +protected  java.util.HashtableejbFiles + +
        +          Instance variable that stores the names of the files as they will be + put into the jar file, mapped to File objects Accessed by the SAX + parser call-back method characters().
        +protected  java.lang.StringejbName + +
        +          Instance variable that stores the value found in the <ejb-name> element
        +  + + + + + + + + + + +
        +Constructor Summary
        DescriptorHandler(Task task, + java.io.File srcDir) + +
        +          Constructor for DescriptorHandler.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidcharacters(char[] ch, + int start, + int length) + +
        +          SAX parser call-back method invoked whenever characters are located within + an element.
        + voidendElement(java.lang.String name) + +
        +          SAX parser call-back method that is invoked when an element is exited.
        + java.lang.StringgetEjbName() + +
        +          Getter method that returns the value of the <ejb-name> element.
        + java.util.HashtablegetFiles() + +
        +          Getter method that returns the set of files to include in the EJB jar.
        + java.lang.StringgetPublicId() + +
        +          Get the publicId of the DTD
        +protected  voidprocessElement() + +
        +          Called when an endelement is seen.
        + voidregisterDTD(java.lang.String publicId, + java.lang.String location) + +
        +          Register a dtd with a location.
        + org.xml.sax.InputSourceresolveEntity(java.lang.String publicId, + java.lang.String systemId) + +
        +          Resolve the entity.
        + voidstartDocument() + +
        +          SAX parser call-back method that is used to initialize the values of some + instance variables to ensure safe operation.
        + voidstartElement(java.lang.String name, + org.xml.sax.AttributeList attrs) + +
        +          SAX parser call-back method that is invoked when a new element is entered + into.
        +  + + + + + + + +
        Methods inherited from class org.xml.sax.HandlerBase
        endDocument, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, unparsedEntityDecl, warning
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +currentElement

        +
        +protected java.lang.String currentElement
        +
        +
        Instance variable used to store the name of the current element being + processed by the SAX parser. Accessed by the SAX parser call-back methods + startElement() and endElement(). +

        +

        +
        +
        +
        + +

        +currentText

        +
        +protected java.lang.String currentText
        +
        +
        The text of the current element +

        +

        +
        +
        +
        + +

        +ejbFiles

        +
        +protected java.util.Hashtable ejbFiles
        +
        +
        Instance variable that stores the names of the files as they will be + put into the jar file, mapped to File objects Accessed by the SAX + parser call-back method characters(). +

        +

        +
        +
        +
        + +

        +ejbName

        +
        +protected java.lang.String ejbName
        +
        +
        Instance variable that stores the value found in the <ejb-name> element +

        +

        +
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +DescriptorHandler

        +
        +public DescriptorHandler(Task task,
+                         java.io.File srcDir)
        +
        +
        Constructor for DescriptorHandler. +

        +

        +
        Parameters:
        task - the task that owns this desciptor
        srcDir - the source directory
        +
        + + + + + + + + +
        +Method Detail
        + +

        +registerDTD

        +
        +public void registerDTD(java.lang.String publicId,
+                        java.lang.String location)
        +
        +
        Register a dtd with a location. + The location is one of a filename, a resource name in the classpath, or + a URL. +

        +

        +
        Parameters:
        publicId - the public identity of the dtd
        location - the location of the dtd
        +
        +
        +
        + +

        +resolveEntity

        +
        +public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
+                                             java.lang.String systemId)
+                                      throws org.xml.sax.SAXException
        +
        +
        Resolve the entity. +

        +

        +
        Specified by:
        resolveEntity in interface org.xml.sax.EntityResolver
        Overrides:
        resolveEntity in class org.xml.sax.HandlerBase
        +
        +
        +
        Parameters:
        publicId - The public identifier, or null + if none is available.
        systemId - The system identifier provided in the XML + document. Will not be null. +
        Returns:
        an inputsource for this identifier +
        Throws: +
        org.xml.sax.SAXException - if there is a problem.
        See Also:
        EntityResolver.resolveEntity(String, String).
        +
        +
        +
        + +

        +getFiles

        +
        +public java.util.Hashtable getFiles()
        +
        +
        Getter method that returns the set of files to include in the EJB jar. +

        +

        + +
        Returns:
        the map of files
        +
        +
        +
        + +

        +getPublicId

        +
        +public java.lang.String getPublicId()
        +
        +
        Get the publicId of the DTD +

        +

        + +
        Returns:
        the public id
        +
        +
        +
        + +

        +getEjbName

        +
        +public java.lang.String getEjbName()
        +
        +
        Getter method that returns the value of the <ejb-name> element. +

        +

        + +
        Returns:
        the ejb name
        +
        +
        +
        + +

        +startDocument

        +
        +public void startDocument()
+                   throws org.xml.sax.SAXException
        +
        +
        SAX parser call-back method that is used to initialize the values of some + instance variables to ensure safe operation. +

        +

        +
        Specified by:
        startDocument in interface org.xml.sax.DocumentHandler
        Overrides:
        startDocument in class org.xml.sax.HandlerBase
        +
        +
        + +
        Throws: +
        org.xml.sax.SAXException - on error
        +
        +
        +
        + +

        +startElement

        +
        +public void startElement(java.lang.String name,
+                         org.xml.sax.AttributeList attrs)
+                  throws org.xml.sax.SAXException
        +
        +
        SAX parser call-back method that is invoked when a new element is entered + into. Used to store the context (attribute name) in the currentAttribute + instance variable. +

        +

        +
        Specified by:
        startElement in interface org.xml.sax.DocumentHandler
        Overrides:
        startElement in class org.xml.sax.HandlerBase
        +
        +
        +
        Parameters:
        name - The name of the element being entered.
        attrs - Attributes associated to the element. +
        Throws: +
        org.xml.sax.SAXException - on error
        +
        +
        +
        + +

        +endElement

        +
        +public void endElement(java.lang.String name)
+                throws org.xml.sax.SAXException
        +
        +
        SAX parser call-back method that is invoked when an element is exited. + Used to blank out (set to the empty string, not nullify) the name of + the currentAttribute. A better method would be to use a stack as an + instance variable, however since we are only interested in leaf-node + data this is a simpler and workable solution. +

        +

        +
        Specified by:
        endElement in interface org.xml.sax.DocumentHandler
        Overrides:
        endElement in class org.xml.sax.HandlerBase
        +
        +
        +
        Parameters:
        name - The name of the attribute being exited. Ignored + in this implementation. +
        Throws: +
        org.xml.sax.SAXException - on error
        +
        +
        +
        + +

        +characters

        +
        +public void characters(char[] ch,
+                       int start,
+                       int length)
+                throws org.xml.sax.SAXException
        +
        +
        SAX parser call-back method invoked whenever characters are located within + an element. currentAttribute (modified by startElement and endElement) + tells us whether we are in an interesting element (one of the up to four + classes of an EJB). If so then converts the classname from the format + org.apache.tools.ant.Parser to the convention for storing such a class, + org/apache/tools/ant/Parser.class. This is then resolved into a file + object under the srcdir which is stored in a Hashtable. +

        +

        +
        Specified by:
        characters in interface org.xml.sax.DocumentHandler
        Overrides:
        characters in class org.xml.sax.HandlerBase
        +
        +
        +
        Parameters:
        ch - A character array containing all the characters in + the element, and maybe others that should be ignored.
        start - An integer marking the position in the char + array to start reading from.
        length - An integer representing an offset into the + char array where the current data terminates. +
        Throws: +
        org.xml.sax.SAXException - on error
        +
        +
        +
        + +

        +processElement

        +
        +protected void processElement()
        +
        +
        Called when an endelement is seen. + This may be overridden in derived classes. + This updates the ejbfiles if the element is an interface or a bean class. + This updates the ejbname if the element is an ejb name. +

        +

        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html new file mode 100644 index 000000000..c0596b151 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html @@ -0,0 +1,283 @@ + + + + + + +EJBDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Interface EJBDeploymentTool

        +
        +
        All Known Implementing Classes:
        BorlandDeploymentTool, GenericDeploymentTool, IPlanetDeploymentTool, JbossDeploymentTool, JonasDeploymentTool, WeblogicDeploymentTool, WeblogicTOPLinkDeploymentTool, WebsphereDeploymentTool
        +
        +
        +
        +
        public interface EJBDeploymentTool
        + + +

        +The interface to implement for deployment tools. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidconfigure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config) + +
        +          Configure this tool for use in the ejbjar task.
        + voidprocessDescriptor(java.lang.String descriptorFilename, + javax.xml.parsers.SAXParser saxParser) + +
        +          Process a deployment descriptor, generating the necessary vendor specific + deployment files.
        + voidsetTask(Task task) + +
        +          Set the task which owns this tool
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +processDescriptor

        +
        +void processDescriptor(java.lang.String descriptorFilename,
+                       javax.xml.parsers.SAXParser saxParser)
+                       throws BuildException
        +
        +
        Process a deployment descriptor, generating the necessary vendor specific + deployment files. +

        +

        +
        Parameters:
        descriptorFilename - the name of the deployment descriptor
        saxParser - a SAX parser which can be used to parse the deployment descriptor. +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +validateConfigured

        +
        +void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +setTask

        +
        +void setTask(Task task)
        +
        +
        Set the task which owns this tool +

        +

        +
        Parameters:
        task - the task.
        +
        +
        +
        + +

        +configure

        +
        +void configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config)
        +
        +
        Configure this tool for use in the ejbjar task. +

        +

        +
        Parameters:
        config - contains configuration state.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.CMPVersion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.CMPVersion.html new file mode 100644 index 000000000..9bb95a448 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.CMPVersion.html @@ -0,0 +1,344 @@ + + + + + + +EjbJar.CMPVersion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class EjbJar.CMPVersion

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion
+
        +
        +
        Enclosing class:
        EjbJar
        +
        +
        +
        +
        public static class EjbJar.CMPVersion
        extends EnumeratedAttribute
        + + +

        +CMP versions supported + valid CMP versions are 1.0 and 2.0 +

        + +

        +

        +
        Since:
        +
        ant 1.6
        +
        +
        + +

        + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringCMP1_0 + +
        +          1.0 value
        +static java.lang.StringCMP2_0 + +
        +          2.0 value
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
        value
        +  + + + + + + + + + + +
        +Constructor Summary
        EjbJar.CMPVersion() + +
        +           
        +  + + + + + + + + + + + +
        +Method Summary
        + java.lang.String[]getValues() + +
        +          This is the only method a subclass needs to implement..
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
        containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +CMP1_0

        +
        +public static final java.lang.String CMP1_0
        +
        +
        1.0 value +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +CMP2_0

        +
        +public static final java.lang.String CMP2_0
        +
        +
        2.0 value +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +EjbJar.CMPVersion

        +
        +public EjbJar.CMPVersion()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getValues

        +
        +public java.lang.String[] getValues()
        +
        +
        This is the only method a subclass needs to implement.. +

        +

        +
        Specified by:
        getValues in class EnumeratedAttribute
        +
        +
        + +
        Returns:
        an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.DTDLocation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.DTDLocation.html new file mode 100644 index 000000000..6909ceb33 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.DTDLocation.html @@ -0,0 +1,237 @@ + + + + + + +EjbJar.DTDLocation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class EjbJar.DTDLocation

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.types.ResourceLocation
+      extended by org.apache.tools.ant.types.DTDLocation
+          extended by org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.DTDLocation
+
        +
        +
        Enclosing class:
        EjbJar
        +
        +
        +
        +
        public static class EjbJar.DTDLocation
        extends DTDLocation
        + + +

        +Inner class used to record information about the location of a local DTD +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        EjbJar.DTDLocation() + +
        +           
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.ResourceLocation
        getBase, getLocation, getPublicId, setBase, setLocation, setPublicId
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +EjbJar.DTDLocation

        +
        +public EjbJar.DTDLocation()
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html new file mode 100644 index 000000000..114cce64a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html @@ -0,0 +1,386 @@ + + + + + + +EjbJar.NamingScheme (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class EjbJar.NamingScheme

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme
+
        +
        +
        Enclosing class:
        EjbJar
        +
        +
        +
        +
        public static class EjbJar.NamingScheme
        extends EnumeratedAttribute
        + + +

        +An EnumeratedAttribute class for handling different EJB jar naming + schemes +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringBASEJARNAME + +
        +          Naming scheme where the generated jar is named by the basejarname + attribute
        +static java.lang.StringDESCRIPTOR + +
        +          Naming scheme where the generated jar name is based on the name of + the deployment descriptor file
        +static java.lang.StringDIRECTORY + +
        +          Naming scheme where the generated jar name is based on the + name of the directory containing the deployment descriptor
        +static java.lang.StringEJB_NAME + +
        +          Naming scheme where generated jar is determined from the ejb-name in + the deployment descripor
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
        value
        +  + + + + + + + + + + +
        +Constructor Summary
        EjbJar.NamingScheme() + +
        +           
        +  + + + + + + + + + + + +
        +Method Summary
        + java.lang.String[]getValues() + +
        +          Gets the values of the NamingScheme
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
        containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +EJB_NAME

        +
        +public static final java.lang.String EJB_NAME
        +
        +
        Naming scheme where generated jar is determined from the ejb-name in + the deployment descripor +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DIRECTORY

        +
        +public static final java.lang.String DIRECTORY
        +
        +
        Naming scheme where the generated jar name is based on the + name of the directory containing the deployment descriptor +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DESCRIPTOR

        +
        +public static final java.lang.String DESCRIPTOR
        +
        +
        Naming scheme where the generated jar name is based on the name of + the deployment descriptor file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +BASEJARNAME

        +
        +public static final java.lang.String BASEJARNAME
        +
        +
        Naming scheme where the generated jar is named by the basejarname + attribute +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +EjbJar.NamingScheme

        +
        +public EjbJar.NamingScheme()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getValues

        +
        +public java.lang.String[] getValues()
        +
        +
        Gets the values of the NamingScheme +

        +

        +
        Specified by:
        getValues in class EnumeratedAttribute
        +
        +
        + +
        Returns:
        an array of the values of this attribute class.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.html new file mode 100644 index 000000000..79616db67 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.html @@ -0,0 +1,984 @@ + + + + + + +EjbJar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class EjbJar

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.ejb.EjbJar
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, SelectorContainer
        +
        +
        +
        +
        public class EjbJar
        extends MatchingTask
        + + +

        +Provides automated EJB JAR file creation. +

        + Extends the + MatchingTask class provided in the default ant distribution to provide a + directory scanning EJB jarfile generator. +

        + +

        + The task works by taking the deployment descriptors one at a time and + parsing them to locate the names of the classes which should be placed in + the jar. The classnames are translated to java.io.Files by replacing + periods with File.separatorChar and resolving the generated filename as a + relative path under the srcDir attribute. All necessary files are then + assembled into a jarfile. One jarfile is constructed for each deployment + descriptor found. +

        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + +
        +Nested Class Summary
        +static classEjbJar.CMPVersion + +
        +          CMP versions supported + valid CMP versions are 1.0 and 2.0
        +static classEjbJar.DTDLocation + +
        +          Inner class used to record information about the location of a local DTD
        +static classEjbJar.NamingScheme + +
        +          An EnumeratedAttribute class for handling different EJB jar naming + schemes
        +  + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        fileset
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        EjbJar() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddDeploymentTool(EJBDeploymentTool deploymentTool) + +
        +          Add a deployment tool to the list of deployment tools that will be + processed
        + BorlandDeploymentToolcreateBorland() + +
        +          Adds a deployment tool for Borland server.
        + PathcreateClasspath() + +
        +          Adds to the classpath used to locate the super classes and + interfaces of the classes that will make up the EJB JAR.
        + EjbJar.DTDLocationcreateDTD() + +
        +          Create a DTD location record.
        + IPlanetDeploymentToolcreateIplanet() + +
        +          Adds a deployment tool for iPlanet Application Server.
        + JbossDeploymentToolcreateJboss() + +
        +          Adds a deployment tool for JBoss server.
        + JonasDeploymentToolcreateJonas() + +
        +          Adds a deployment tool for JOnAS server.
        + FileSetcreateSupport() + +
        +          Adds a fileset for support elements.
        + WeblogicDeploymentToolcreateWeblogic() + +
        +          Adds a deployment tool for Weblogic server.
        + WeblogicTOPLinkDeploymentToolcreateWeblogictoplink() + +
        +          Adds a deployment tool for Weblogic when using the Toplink + Object-Relational mapping.
        + WebsphereDeploymentToolcreateWebsphere() + +
        +          Adds a deployment tool for Websphere 4.0 server.
        + voidexecute() + +
        +          Invoked by Ant after the task is prepared, when it is ready to execute + this task.
        + java.lang.StringgetCmpversion() + +
        +          Gets the CMP version.
        + java.io.FilegetDestdir() + +
        +          Gets the destination directory.
        + voidsetBasejarname(java.lang.String inValue) + +
        +          Set the base name of the EJB JAR that is to be created if it is not + to be determined from the name of the deployment descriptor files.
        + voidsetBasenameterminator(java.lang.String inValue) + +
        +          The string which terminates the bean name.
        + voidsetClasspath(Path classpath) + +
        +          Set the classpath to use when resolving classes for inclusion in the jar.
        + voidsetCmpversion(EjbJar.CMPVersion version) + +
        +          Sets the CMP version.
        + voidsetDependency(java.lang.String analyzer) + +
        +          Set the analyzer to use when adding in dependencies to the JAR.
        + voidsetDescriptordir(java.io.File inDir) + +
        +          Set the descriptor directory.
        + voidsetDestdir(java.io.File inDir) + +
        +          Set the destination directory.
        + voidsetFlatdestdir(boolean inValue) + +
        +          Controls whether the + destination JARs are written out in the destination directory with + the same hierarchical structure from which the deployment descriptors + have been read.
        + voidsetGenericjarsuffix(java.lang.String inString) + +
        +          Set the suffix for the generated jar file.
        + voidsetManifest(java.io.File manifest) + +
        +          Set the Manifest file to use when jarring.
        + voidsetNaming(EjbJar.NamingScheme namingScheme) + +
        +          Set the naming scheme used to determine the name of the generated jars + from the deployment descriptor
        + voidsetSrcdir(java.io.File inDir) + +
        +          Sets the source directory, which is the directory that + contains the classes that will be added to the EJB jar.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +EjbJar

        +
        +public EjbJar()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +addDeploymentTool

        +
        +protected void addDeploymentTool(EJBDeploymentTool deploymentTool)
        +
        +
        Add a deployment tool to the list of deployment tools that will be + processed +

        +

        +
        Parameters:
        deploymentTool - a deployment tool instance to which descriptors + will be passed for processing.
        +
        +
        +
        + +

        +createWeblogic

        +
        +public WeblogicDeploymentTool createWeblogic()
        +
        +
        Adds a deployment tool for Weblogic server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createWebsphere

        +
        +public WebsphereDeploymentTool createWebsphere()
        +
        +
        Adds a deployment tool for Websphere 4.0 server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createBorland

        +
        +public BorlandDeploymentTool createBorland()
        +
        +
        Adds a deployment tool for Borland server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createIplanet

        +
        +public IPlanetDeploymentTool createIplanet()
        +
        +
        Adds a deployment tool for iPlanet Application Server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createJboss

        +
        +public JbossDeploymentTool createJboss()
        +
        +
        Adds a deployment tool for JBoss server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createJonas

        +
        +public JonasDeploymentTool createJonas()
        +
        +
        Adds a deployment tool for JOnAS server. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createWeblogictoplink

        +
        +public WeblogicTOPLinkDeploymentTool createWeblogictoplink()
        +
        +
        Adds a deployment tool for Weblogic when using the Toplink + Object-Relational mapping. +

        +

        + +
        Returns:
        the deployment tool instance to be configured.
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Adds to the classpath used to locate the super classes and + interfaces of the classes that will make up the EJB JAR. +

        +

        + +
        Returns:
        the path to be configured.
        +
        +
        +
        + +

        +createDTD

        +
        +public EjbJar.DTDLocation createDTD()
        +
        +
        Create a DTD location record. This stores the location of a DTD. The + DTD is identified by its public Id. The location may either be a file + location or a resource location. +

        +

        + +
        Returns:
        the DTD location object to be configured by Ant
        +
        +
        +
        + +

        +createSupport

        +
        +public FileSet createSupport()
        +
        +
        Adds a fileset for support elements. +

        +

        + +
        Returns:
        a fileset which can be populated with support files.
        +
        +
        +
        + +

        +setManifest

        +
        +public void setManifest(java.io.File manifest)
        +
        +
        Set the Manifest file to use when jarring. As of EJB 1.1, manifest + files are no longer used to configure the EJB. However, they still + have a vital importance if the EJB is intended to be packaged in an + EAR file. By adding "Class-Path" settings to a Manifest file, the EJB + can look for classes inside the EAR file itself, allowing for easier + deployment. This is outlined in the J2EE specification, and all J2EE + components are meant to support it. +

        +

        +
        Parameters:
        manifest - the manifest to be used in the EJB jar
        +
        +
        +
        + +

        +setSrcdir

        +
        +public void setSrcdir(java.io.File inDir)
        +
        +
        Sets the source directory, which is the directory that + contains the classes that will be added to the EJB jar. Typically + this will include the home and remote interfaces and the bean class. +

        +

        +
        Parameters:
        inDir - the source directory.
        +
        +
        +
        + +

        +setDescriptordir

        +
        +public void setDescriptordir(java.io.File inDir)
        +
        +
        Set the descriptor directory. The descriptor directory contains the + EJB deployment descriptors. These are XML files that declare the + properties of a bean in a particular deployment scenario. Such + properties include, for example, the transactional nature of the bean + and the security access control to the bean's methods. +

        +

        +
        Parameters:
        inDir - the directory containing the deployment descriptors.
        +
        +
        +
        + +

        +setDependency

        +
        +public void setDependency(java.lang.String analyzer)
        +
        +
        Set the analyzer to use when adding in dependencies to the JAR. +

        +

        +
        Parameters:
        analyzer - the name of the dependency analyzer or a class.
        +
        +
        +
        + +

        +setBasejarname

        +
        +public void setBasejarname(java.lang.String inValue)
        +
        +
        Set the base name of the EJB JAR that is to be created if it is not + to be determined from the name of the deployment descriptor files. +

        +

        +
        Parameters:
        inValue - the basename that will be used when writing the jar + file containing the EJB
        +
        +
        +
        + +

        +setNaming

        +
        +public void setNaming(EjbJar.NamingScheme namingScheme)
        +
        +
        Set the naming scheme used to determine the name of the generated jars + from the deployment descriptor +

        +

        +
        Parameters:
        namingScheme - the naming scheme to be used
        +
        +
        +
        + +

        +getDestdir

        +
        +public java.io.File getDestdir()
        +
        +
        Gets the destination directory. +

        +

        + +
        Returns:
        destination directory
        Since:
        +
        ant 1.6
        +
        +
        +
        +
        + +

        +setDestdir

        +
        +public void setDestdir(java.io.File inDir)
        +
        +
        Set the destination directory. The EJB jar files will be written into + this directory. The jar files that exist in this directory are also + used when determining if the contents of the jar file have changed. + Note that this parameter is only used if no deployment tools are + specified. Typically each deployment tool will specify its own + destination directory. +

        +

        +
        Parameters:
        inDir - the destination directory in which to generate jars
        +
        +
        +
        + +

        +getCmpversion

        +
        +public java.lang.String getCmpversion()
        +
        +
        Gets the CMP version. +

        +

        + +
        Returns:
        CMP version
        Since:
        +
        ant 1.6
        +
        +
        +
        +
        + +

        +setCmpversion

        +
        +public void setCmpversion(EjbJar.CMPVersion version)
        +
        +
        Sets the CMP version. +

        +

        +
        Parameters:
        version - CMP version. + Must be either 1.0 or 2.0.
        + Default is 1.0.
        + Initially, only the JBoss implementation does something specific for CMP 2.0.
        Since:
        +
        ant 1.6
        +
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Set the classpath to use when resolving classes for inclusion in the jar. +

        +

        +
        Parameters:
        classpath - the classpath to use.
        +
        +
        +
        + +

        +setFlatdestdir

        +
        +public void setFlatdestdir(boolean inValue)
        +
        +
        Controls whether the + destination JARs are written out in the destination directory with + the same hierarchical structure from which the deployment descriptors + have been read. If this is set to true the generated EJB jars are + written into the root of the destination directory, otherwise they + are written out in the same relative position as the deployment + descriptors in the descriptor directory. +

        +

        +
        Parameters:
        inValue - the new value of the flatdestdir flag.
        +
        +
        +
        + +

        +setGenericjarsuffix

        +
        +public void setGenericjarsuffix(java.lang.String inString)
        +
        +
        Set the suffix for the generated jar file. When generic jars are + generated, they have a suffix which is appended to the the bean name + to create the name of the jar file. Note that this suffix includes + the extension fo te jar file and should therefore end with an + appropriate extension such as .jar or .ear +

        +

        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +setBasenameterminator

        +
        +public void setBasenameterminator(java.lang.String inValue)
        +
        +
        The string which terminates the bean name. + The convention used by this task is + that bean descriptors are named as the BeanName with some suffix. The + baseNameTerminator string separates the bean name and the suffix and + is used to determine the bean name. +

        +

        +
        Parameters:
        inValue - a string which marks the end of the basename.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Invoked by Ant after the task is prepared, when it is ready to execute + this task. + + This will configure all of the nested deployment tools to allow them to + process the jar. If no deployment tools have been configured a generic + tool is created to handle the jar. + + A parser is configured and then each descriptor found is passed to all + the deployment tool elements for processing. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - thrown whenever a problem is + encountered that cannot be recovered from, to signal to ant + that a major problem occurred within this task.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html new file mode 100644 index 000000000..63560fc1f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html @@ -0,0 +1,1326 @@ + + + + + + +GenericDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class GenericDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        Direct Known Subclasses:
        BorlandDeploymentTool, IPlanetDeploymentTool, JbossDeploymentTool, JonasDeploymentTool, WeblogicDeploymentTool, WebsphereDeploymentTool
        +
        +
        +
        +
        public class GenericDeploymentTool
        extends java.lang.Object
        implements EJBDeploymentTool
        + + +

        +A deployment tool which creates generic EJB jars. Generic jars contains + only those classes and META-INF entries specified in the EJB 1.1 standard + + This class is also used as a framework for the creation of vendor specific + deployment tools. A number of template methods are provided through which the + vendor specific tool can hook into the EJB creation process. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringANALYZER_CLASS_FULL + +
        +          The analyzer class for the super analyzer
        +static java.lang.StringANALYZER_CLASS_SUPER + +
        +          The analyzer class for the super analyzer
        +static java.lang.StringANALYZER_FULL + +
        +          A dependency analyzer name to find all related classes
        +static java.lang.StringANALYZER_NONE + +
        +          A dependency analyzer name for no analyzer
        +static java.lang.StringANALYZER_SUPER + +
        +          A dependency analyzer name to find ancestor classes
        +static java.lang.StringDEFAULT_ANALYZER + +
        +          The default analyzer
        +static intDEFAULT_BUFFER_SIZE + +
        +          The default buffer byte size to use for IO
        +protected static java.lang.StringEJB_DD + +
        +          Name for EJB Deployment descriptor within EJB jars
        +static intJAR_COMPRESS_LEVEL + +
        +          The level to use for compression
        +protected static java.lang.StringMANIFEST + +
        +          The standard MANIFEST file
        +protected static java.lang.StringMETA_DIR + +
        +          The standard META-INF directory in jar files
        +  + + + + + + + + + + +
        +Constructor Summary
        GenericDeploymentTool() + +
        +          No arg constructor
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddFileToJar(java.util.jar.JarOutputStream jStream, + java.io.File inputFile, + java.lang.String logicalFilename) + +
        +          Utility method that encapsulates the logic of adding a file entry to + a .jar file.
        +protected  voidaddSupportClasses(java.util.Hashtable ejbFiles) + +
        +          Adds any classes the user specifies using support nested elements + to the ejbFiles Hashtable.
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the + EJB Jar.
        +protected  voidcheckAndAddDependants(java.util.Hashtable checkEntries) + +
        +          Add all available classes, that depend on Remote, Home, Bean, PK
        +protected  voidcheckConfiguration(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          This method is called as the first step in the processDescriptor method + to allow vendor-specific subclasses to validate the task configuration + prior to processing the descriptor.
        + voidconfigure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config) + +
        +          Configure this tool for use in the ejbjar task.
        + PathcreateClasspath() + +
        +          Add the classpath for the user classes
        +protected  java.lang.ClassLoadergetClassLoaderForBuild() + +
        +          Returns a Classloader object which parses the passed in generic EjbJar classpath.
        +protected  PathgetCombinedClasspath() + +
        +          Get the classpath by combining the one from the surrounding task, if any + and the one from this tool.
        +protected  org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.ConfiggetConfig() + +
        +          Get the basename terminator.
        +protected  DescriptorHandlergetDescriptorHandler(java.io.File srcDir) + +
        +          Get a descriptionHandler.
        +protected  java.io.FilegetDestDir() + +
        +          Get the destination directory.
        +protected  java.lang.StringgetJarBaseName(java.lang.String descriptorFileName) + +
        +          Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file.
        +protected  LocationgetLocation() + +
        +          Get the build file location associated with this element's task.
        +protected  java.io.FilegetManifestFile(java.lang.String prefix) + +
        +          Get the manifets file to use for building the generic jar.
        +protected  java.lang.StringgetPublicId() + +
        +          Returns the Public ID of the DTD specified in the EJB descriptor.
        +protected  TaskgetTask() + +
        +          Get the task for this tool.
        + java.lang.StringgetVendorDDPrefix(java.lang.String baseName, + java.lang.String descriptorFileName) + +
        +          Get the prefix for vendor deployment descriptors.
        +protected  voidlog(java.lang.String message, + int level) + +
        +          Log a message to the Ant output.
        +protected  booleanneedToRebuild(java.util.Hashtable ejbFiles, + java.io.File jarFile) + +
        +          This method checks the timestamp on each file listed in the + ejbFiles and compares them to the timestamp on the jarFile + .
        +protected  java.util.HashtableparseEjbFiles(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed.
        + voidprocessDescriptor(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          Process a deployment descriptor, generating the necessary vendor specific + deployment files..
        +protected  voidregisterKnownDTDs(DescriptorHandler handler) + +
        +          Register the locations of all known DTDs.
        + voidsetClasspath(Path classpath) + +
        +          Set the classpath to be used for this compilation.
        + voidsetDestdir(java.io.File inDir) + +
        +          Set the destination directory; required.
        + voidsetGenericJarSuffix(java.lang.String inString) + +
        +          Set the suffix for the generated jar file.
        + voidsetTask(Task task) + +
        +          Set the task which owns this tool
        +protected  booleanusingBaseJarName() + +
        +          Indicate if this build is using the base jar name.
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +protected  voidwriteJar(java.lang.String baseName, + java.io.File jarfile, + java.util.Hashtable files, + java.lang.String publicId) + +
        +          Method used to encapsulate the writing of the JAR file.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +DEFAULT_BUFFER_SIZE

        +
        +public static final int DEFAULT_BUFFER_SIZE
        +
        +
        The default buffer byte size to use for IO +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JAR_COMPRESS_LEVEL

        +
        +public static final int JAR_COMPRESS_LEVEL
        +
        +
        The level to use for compression +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +META_DIR

        +
        +protected static final java.lang.String META_DIR
        +
        +
        The standard META-INF directory in jar files +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +MANIFEST

        +
        +protected static final java.lang.String MANIFEST
        +
        +
        The standard MANIFEST file +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +EJB_DD

        +
        +protected static final java.lang.String EJB_DD
        +
        +
        Name for EJB Deployment descriptor within EJB jars +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ANALYZER_SUPER

        +
        +public static final java.lang.String ANALYZER_SUPER
        +
        +
        A dependency analyzer name to find ancestor classes +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ANALYZER_FULL

        +
        +public static final java.lang.String ANALYZER_FULL
        +
        +
        A dependency analyzer name to find all related classes +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ANALYZER_NONE

        +
        +public static final java.lang.String ANALYZER_NONE
        +
        +
        A dependency analyzer name for no analyzer +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_ANALYZER

        +
        +public static final java.lang.String DEFAULT_ANALYZER
        +
        +
        The default analyzer +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ANALYZER_CLASS_SUPER

        +
        +public static final java.lang.String ANALYZER_CLASS_SUPER
        +
        +
        The analyzer class for the super analyzer +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +ANALYZER_CLASS_FULL

        +
        +public static final java.lang.String ANALYZER_CLASS_FULL
        +
        +
        The analyzer class for the super analyzer +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +GenericDeploymentTool

        +
        +public GenericDeploymentTool()
        +
        +
        No arg constructor +

        +

        + + + + + + + + +
        +Method Detail
        + +

        +setDestdir

        +
        +public void setDestdir(java.io.File inDir)
        +
        +
        Set the destination directory; required. +

        +

        +
        +
        +
        +
        Parameters:
        inDir - the destination directory.
        +
        +
        +
        + +

        +getDestDir

        +
        +protected java.io.File getDestDir()
        +
        +
        Get the destination directory. +

        +

        +
        +
        +
        + +
        Returns:
        the destination directory into which EJB jars are to be written
        +
        +
        +
        + +

        +setTask

        +
        +public void setTask(Task task)
        +
        +
        Set the task which owns this tool +

        +

        +
        Specified by:
        setTask in interface EJBDeploymentTool
        +
        +
        +
        Parameters:
        task - the Task to which this deployment tool is associated.
        +
        +
        +
        + +

        +getTask

        +
        +protected Task getTask()
        +
        +
        Get the task for this tool. +

        +

        +
        +
        +
        + +
        Returns:
        the Task instance this tool is associated with.
        +
        +
        +
        + +

        +getConfig

        +
        +protected org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config getConfig()
        +
        +
        Get the basename terminator. +

        +

        +
        +
        +
        + +
        Returns:
        an ejbjar task configuration
        +
        +
        +
        + +

        +usingBaseJarName

        +
        +protected boolean usingBaseJarName()
        +
        +
        Indicate if this build is using the base jar name. +

        +

        +
        +
        +
        + +
        Returns:
        true if the name of the generated jar is coming from the + basejarname attribute
        +
        +
        +
        + +

        +setGenericJarSuffix

        +
        +public void setGenericJarSuffix(java.lang.String inString)
        +
        +
        Set the suffix for the generated jar file. +

        +

        +
        +
        +
        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Add the classpath for the user classes +

        +

        +
        +
        +
        + +
        Returns:
        a Path instance to be configured by Ant.
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Set the classpath to be used for this compilation. +

        +

        +
        +
        +
        +
        Parameters:
        classpath - the classpath to be used for this build.
        +
        +
        +
        + +

        +getCombinedClasspath

        +
        +protected Path getCombinedClasspath()
        +
        +
        Get the classpath by combining the one from the surrounding task, if any + and the one from this tool. +

        +

        +
        +
        +
        + +
        Returns:
        the combined classpath
        +
        +
        +
        + +

        +log

        +
        +protected void log(java.lang.String message,
+                   int level)
        +
        +
        Log a message to the Ant output. +

        +

        +
        +
        +
        +
        Parameters:
        message - the message to be logged.
        level - the severity of this message.
        +
        +
        +
        + +

        +getLocation

        +
        +protected Location getLocation()
        +
        +
        Get the build file location associated with this element's task. +

        +

        +
        +
        +
        + +
        Returns:
        the task's location instance.
        +
        +
        +
        + +

        +configure

        +
        +public void configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config)
        +
        +
        Configure this tool for use in the ejbjar task. +

        +

        +
        Specified by:
        configure in interface EJBDeploymentTool
        +
        +
        +
        Parameters:
        config - the configuration from the surrounding ejbjar task.
        +
        +
        +
        + +

        +addFileToJar

        +
        +protected void addFileToJar(java.util.jar.JarOutputStream jStream,
+                            java.io.File inputFile,
+                            java.lang.String logicalFilename)
+                     throws BuildException
        +
        +
        Utility method that encapsulates the logic of adding a file entry to + a .jar file. Used by execute() to add entries to the jar file as it is + constructed. +

        +

        +
        +
        +
        +
        Parameters:
        jStream - A JarOutputStream into which to write the + jar entry.
        inputFile - A File from which to read the + contents the file being added.
        logicalFilename - A String representing the name, including + all relevant path information, that should be stored for the entry + being added. +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +getDescriptorHandler

        +
        +protected DescriptorHandler getDescriptorHandler(java.io.File srcDir)
        +
        +
        Get a descriptionHandler. +

        +

        +
        +
        +
        +
        Parameters:
        srcDir - the source directory. +
        Returns:
        a handler.
        +
        +
        +
        + +

        +registerKnownDTDs

        +
        +protected void registerKnownDTDs(DescriptorHandler handler)
        +
        +
        Register the locations of all known DTDs. + + vendor-specific subclasses should override this method to define + the vendor-specific locations of the EJB DTDs +

        +

        +
        +
        +
        +
        Parameters:
        handler - no used in this class.
        +
        +
        +
        + +

        +processDescriptor

        +
        +public void processDescriptor(java.lang.String descriptorFileName,
+                              javax.xml.parsers.SAXParser saxParser)
        +
        +
        Process a deployment descriptor, generating the necessary vendor specific + deployment files.. +

        +

        +
        Specified by:
        processDescriptor in interface EJBDeploymentTool
        +
        +
        +
        Parameters:
        descriptorFileName - the name of the deployment descriptor
        saxParser - a SAX parser which can be used to parse the deployment descriptor.
        +
        +
        +
        + +

        +checkConfiguration

        +
        +protected void checkConfiguration(java.lang.String descriptorFileName,
+                                  javax.xml.parsers.SAXParser saxParser)
+                           throws BuildException
        +
        +
        This method is called as the first step in the processDescriptor method + to allow vendor-specific subclasses to validate the task configuration + prior to processing the descriptor. If the configuration is invalid, + a BuildException should be thrown. +

        +

        +
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed
        saxParser - SAXParser which may be used to parse the XML + descriptor +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +parseEjbFiles

        +
        +protected java.util.Hashtable parseEjbFiles(java.lang.String descriptorFileName,
+                                            javax.xml.parsers.SAXParser saxParser)
+                                     throws java.io.IOException,
+                                            org.xml.sax.SAXException
        +
        +
        This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed. +

        +

        +
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed
        saxParser - SAXParser which may be used to parse the XML + descriptor +
        Returns:
        Hashtable of EJB class (and other) files to be + added to the completed JAR file +
        Throws: +
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another + exception +
        java.io.IOException - An IOException from the parser, possibly from a + the byte stream or character stream
        +
        +
        +
        + +

        +addSupportClasses

        +
        +protected void addSupportClasses(java.util.Hashtable ejbFiles)
        +
        +
        Adds any classes the user specifies using support nested elements + to the ejbFiles Hashtable. +

        +

        +
        +
        +
        +
        Parameters:
        ejbFiles - Hashtable of EJB classes (and other) files that will be + added to the completed JAR file
        +
        +
        +
        + +

        +getJarBaseName

        +
        +protected java.lang.String getJarBaseName(java.lang.String descriptorFileName)
        +
        +
        Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file. +

        +

        +
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed +
        Returns:
        The "basename" which will be used to name the + completed JAR file
        +
        +
        +
        + +

        +getVendorDDPrefix

        +
        +public java.lang.String getVendorDDPrefix(java.lang.String baseName,
+                                          java.lang.String descriptorFileName)
        +
        +
        Get the prefix for vendor deployment descriptors. + + This will contain the path and the start of the descriptor name, + depending on the naming scheme +

        +

        +
        +
        +
        +
        Parameters:
        baseName - the base name to use.
        descriptorFileName - the file name to use. +
        Returns:
        the prefix.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the + EJB Jar. +

        +

        +
        +
        +
        +
        Parameters:
        ejbFiles - a hashtable entryname -> file.
        ddPrefix - a prefix to use.
        +
        +
        +
        + +

        +needToRebuild

        +
        +protected boolean needToRebuild(java.util.Hashtable ejbFiles,
+                                java.io.File jarFile)
        +
        +
        This method checks the timestamp on each file listed in the + ejbFiles and compares them to the timestamp on the jarFile + . If the jarFile's timestamp is more recent than + each EJB file, true is returned. Otherwise, false + is returned. + TODO: find a way to check the manifest-file, that is found by naming convention +

        +

        +
        +
        +
        +
        Parameters:
        ejbFiles - Hashtable of EJB classes (and other) files that will be + added to the completed JAR file
        jarFile - JAR file which will contain all of the EJB classes (and + other) files +
        Returns:
        boolean indicating whether or not the jarFile + is up to date
        +
        +
        +
        + +

        +getPublicId

        +
        +protected java.lang.String getPublicId()
        +
        +
        Returns the Public ID of the DTD specified in the EJB descriptor. Not + every vendor-specific DeploymentTool will need to reference + this value or may want to determine this value in a vendor-specific way. +

        +

        +
        +
        +
        + +
        Returns:
        Public ID of the DTD specified in the EJB descriptor.
        +
        +
        +
        + +

        +getManifestFile

        +
        +protected java.io.File getManifestFile(java.lang.String prefix)
        +
        +
        Get the manifets file to use for building the generic jar. + + If the file does not exist the global manifest from the config is used + otherwise the default Ant manifest will be used. +

        +

        +
        +
        +
        +
        Parameters:
        prefix - the prefix where to llook for the manifest file based on + the naming convention. +
        Returns:
        the manifest file or null if the manifest file does not exist
        +
        +
        +
        + +

        +writeJar

        +
        +protected void writeJar(java.lang.String baseName,
+                        java.io.File jarfile,
+                        java.util.Hashtable files,
+                        java.lang.String publicId)
+                 throws BuildException
        +
        +
        Method used to encapsulate the writing of the JAR file. Iterates over the + filenames/java.io.Files in the Hashtable stored on the instance variable + ejbFiles. +

        +

        +
        +
        +
        +
        Parameters:
        baseName - the base name to use.
        jarfile - the jar file to write to.
        files - the files to write to the jar.
        publicId - the id to use. +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +checkAndAddDependants

        +
        +protected void checkAndAddDependants(java.util.Hashtable checkEntries)
+                              throws BuildException
        +
        +
        Add all available classes, that depend on Remote, Home, Bean, PK +

        +

        +
        +
        +
        +
        Parameters:
        checkEntries - files, that are extracted from the deployment descriptor +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +getClassLoaderForBuild

        +
        +protected java.lang.ClassLoader getClassLoaderForBuild()
        +
        +
        Returns a Classloader object which parses the passed in generic EjbJar classpath. + The loader is used to dynamically load classes from javax.ejb.* and the classes + being added to the jar. +

        +

        +
        +
        +
        + +
        Returns:
        a classloader.
        +
        +
        +
        + +

        +validateConfigured

        +
        +public void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        +
        Specified by:
        validateConfigured in interface EJBDeploymentTool
        +
        +
        + +
        Throws: +
        BuildException - If the Deployment Tool's configuration isn't + valid
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html new file mode 100644 index 000000000..3ad5362e9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html @@ -0,0 +1,593 @@ + + + + + + +IPlanetDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class IPlanetDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        +
        public class IPlanetDeploymentTool
        extends GenericDeploymentTool
        + + +

        +This class is used to generate iPlanet Application Server (iAS) 6.0 stubs and + skeletons and build an EJB Jar file. It is designed to be used with the Ant + ejbjar task. If only stubs and skeletons need to be generated + (in other words, if no JAR file needs to be created), refer to the + iplanet-ejbc task and the IPlanetEjbcTask class. +

        + The following attributes may be specified by the user: +

          +
        • destdir -- The base directory into which the generated JAR + files will be written. Each JAR file is written + in directories which correspond to their location + within the "descriptordir" namespace. This is a + required attribute. +
        • classpath -- The classpath used when generating EJB stubs and + skeletons. This is an optional attribute (if + omitted, the classpath specified in the "ejbjar" + parent task will be used). If specified, the + classpath elements will be prepended to the + classpath specified in the parent "ejbjar" task. + Note that nested "classpath" elements may also be + used. +
        • keepgenerated -- Indicates whether or not the Java source + files which are generated by ejbc will be + saved or automatically deleted. If "yes", + the source files will be retained. This is + an optional attribute (if omitted, it + defaults to "no"). +
        • debug -- Indicates whether or not the ejbc utility should + log additional debugging statements to the standard + output. If "yes", the additional debugging statements + will be generated (if omitted, it defaults to "no"). +
        • iashome -- May be used to specify the "home" directory for + this iPlanet Application server installation. This + is used to find the ejbc utility if it isn't + included in the user's system path. This is an + optional attribute (if specified, it should refer + to the [install-location]/iplanet/ias6/ias + directory). If omitted, the ejbc utility + must be on the user's system path. +
        • suffix -- String value appended to the JAR filename when + creating each JAR. This attribute is not required + (if omitted, it defaults to ".jar"). +
        +

        + For each EJB descriptor found in the "ejbjar" parent task, this deployment + tool will locate the three classes that comprise the EJB. If these class + files cannot be located in the specified srcdir directory, the + task will fail. The task will also attempt to locate the EJB stubs and + skeletons in this directory. If found, the timestamps on the stubs and + skeletons will be checked to ensure they are up to date. Only if these files + cannot be found or if they are out of date will ejbc be called. +

        + +

        +

        +
        See Also:
        IPlanetEjbc
        +
        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        IPlanetDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add the iAS-specific EJB descriptor to the list of files which will be + written to the JAR file.
        +protected  voidcheckConfiguration(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          Verifies that the user selections are valid.
        +protected  java.lang.StringgetPublicId() + +
        +          The iAS ejbc utility doesn't require the Public ID of the descriptor's + DTD for it to process correctly--this method always returns null + .
        +protected  java.util.HashtableparseEjbFiles(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed.
        + voidprocessDescriptor(java.lang.String descriptorName, + javax.xml.parsers.SAXParser saxParser) + +
        +          Process a deployment descriptor, generating the necessary vendor specific + deployment files...
        + voidsetDebug(boolean debug) + +
        +          Sets whether or not debugging output will be generated when ejbc is + executed.
        + voidsetGenericJarSuffix(java.lang.String inString) + +
        +          Since iAS doesn't generate a "generic" JAR as part of its processing, + this attribute is ignored and a warning message is displayed to the user.
        + voidsetIashome(java.io.File iashome) + +
        +          Setter method used to store the "home" directory of the user's iAS + installation.
        + voidsetKeepgenerated(boolean keepgenerated) + +
        +          Setter method used to specify whether the Java source files generated by + the ejbc utility should be saved or automatically deleted.
        + voidsetSuffix(java.lang.String jarSuffix) + +
        +          Setter method used to specify the filename suffix (for example, ".jar") + for the JAR files to be created.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDescriptorHandler, getDestDir, getJarBaseName, getLocation, getManifestFile, getTask, getVendorDDPrefix, log, needToRebuild, registerKnownDTDs, setClasspath, setDestdir, setTask, usingBaseJarName, validateConfigured, writeJar
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +IPlanetDeploymentTool

        +
        +public IPlanetDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setIashome

        +
        +public void setIashome(java.io.File iashome)
        +
        +
        Setter method used to store the "home" directory of the user's iAS + installation. The directory specified should typically be + [install-location]/iplanet/ias6/ias. +

        +

        +
        Parameters:
        iashome - The home directory for the user's iAS installation.
        +
        +
        +
        + +

        +setKeepgenerated

        +
        +public void setKeepgenerated(boolean keepgenerated)
        +
        +
        Setter method used to specify whether the Java source files generated by + the ejbc utility should be saved or automatically deleted. +

        +

        +
        Parameters:
        keepgenerated - boolean which, if true, indicates that + Java source files generated by ejbc for the stubs + and skeletons should be kept.
        +
        +
        +
        + +

        +setDebug

        +
        +public void setDebug(boolean debug)
        +
        +
        Sets whether or not debugging output will be generated when ejbc is + executed. +

        +

        +
        Parameters:
        debug - A boolean indicating if debugging output should be generated
        +
        +
        +
        + +

        +setSuffix

        +
        +public void setSuffix(java.lang.String jarSuffix)
        +
        +
        Setter method used to specify the filename suffix (for example, ".jar") + for the JAR files to be created. +

        +

        +
        Parameters:
        jarSuffix - The string to use as the JAR filename suffix.
        +
        +
        +
        + +

        +setGenericJarSuffix

        +
        +public void setGenericJarSuffix(java.lang.String inString)
        +
        +
        Since iAS doesn't generate a "generic" JAR as part of its processing, + this attribute is ignored and a warning message is displayed to the user. +

        +

        +
        Overrides:
        setGenericJarSuffix in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        inString - the string to use as the suffix. This parameter is + ignored.
        +
        +
        +
        + +

        +processDescriptor

        +
        +public void processDescriptor(java.lang.String descriptorName,
+                              javax.xml.parsers.SAXParser saxParser)
        +
        +
        Process a deployment descriptor, generating the necessary vendor specific + deployment files... +

        +

        +
        Specified by:
        processDescriptor in interface EJBDeploymentTool
        Overrides:
        processDescriptor in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        descriptorName - the name of the deployment descriptor
        saxParser - a SAX parser which can be used to parse the deployment descriptor.
        +
        +
        +
        + +

        +checkConfiguration

        +
        +protected void checkConfiguration(java.lang.String descriptorFileName,
+                                  javax.xml.parsers.SAXParser saxParser)
+                           throws BuildException
        +
        +
        Verifies that the user selections are valid. +

        +

        +
        Overrides:
        checkConfiguration in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed
        saxParser - SAXParser which may be used to parse the XML + descriptor +
        Throws: +
        BuildException - If the user selections are invalid.
        +
        +
        +
        + +

        +parseEjbFiles

        +
        +protected java.util.Hashtable parseEjbFiles(java.lang.String descriptorFileName,
+                                            javax.xml.parsers.SAXParser saxParser)
+                                     throws java.io.IOException,
+                                            org.xml.sax.SAXException
        +
        +
        This method returns a list of EJB files found when the specified EJB + descriptor is parsed and processed. +

        +

        +
        Overrides:
        parseEjbFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed
        saxParser - SAXParser which may be used to parse the XML + descriptor +
        Returns:
        Hashtable of EJB class (and other) files to be + added to the completed JAR file +
        Throws: +
        java.io.IOException - An IOException from the parser, possibly from + the byte stream or character stream +
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another + exception
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add the iAS-specific EJB descriptor to the list of files which will be + written to the JAR file. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - Hashtable of EJB class (and other) files to be added to + the completed JAR file.
        ddPrefix - not used
        +
        +
        +
        + +

        +getPublicId

        +
        +protected java.lang.String getPublicId()
        +
        +
        The iAS ejbc utility doesn't require the Public ID of the descriptor's + DTD for it to process correctly--this method always returns null + . +

        +

        +
        Overrides:
        getPublicId in class GenericDeploymentTool
        +
        +
        + +
        Returns:
        null.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html new file mode 100644 index 000000000..4905c8fed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html @@ -0,0 +1,247 @@ + + + + + + +IPlanetEjbc.EjbcException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class IPlanetEjbc.EjbcException

        +
        +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc.EjbcException
+
        +
        +
        All Implemented Interfaces:
        java.io.Serializable
        +
        +
        +
        Enclosing class:
        IPlanetEjbc
        +
        +
        +
        +
        public class IPlanetEjbc.EjbcException
        extends java.lang.Exception
        + + +

        +This inner class is used to signal any problems during the execution of + the ejbc compiler. +

        + +

        +

        +
        See Also:
        Serialized Form
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        IPlanetEjbc.EjbcException(java.lang.String msg) + +
        +          Constructs an exception with the given descriptive message.
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class java.lang.Throwable
        fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +IPlanetEjbc.EjbcException

        +
        +public IPlanetEjbc.EjbcException(java.lang.String msg)
        +
        +
        Constructs an exception with the given descriptive message. +

        +

        +
        Parameters:
        msg - Description of the exception which has occurred.
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html new file mode 100644 index 000000000..67aa9a8c3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html @@ -0,0 +1,541 @@ + + + + + + +IPlanetEjbc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class IPlanetEjbc

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc
+
        +
        +
        +
        public class IPlanetEjbc
        extends java.lang.Object
        + + +

        +Compiles EJB stubs and skeletons for the iPlanet Application + Server (iAS). The class will read a standard EJB descriptor (as well as an + EJB descriptor specific to iPlanet Application Server) to identify one or + more EJBs to process. It will search for EJB "source" classes (the remote +; * interface, home interface, and EJB implementation class) and the EJB stubs + and skeletons in the specified destination directory. Only if the stubs and + skeletons cannot be found or if they're out of date will the iPlanet + Application Server ejbc utility be run. +

        + Because this class (and it's assorted inner classes) may be bundled into the + iPlanet Application Server distribution at some point (and removed from the + Ant distribution), the class has been written to be independent of all + Ant-specific classes. It is also for this reason (and to avoid cluttering + the Apache Ant source files) that this utility has been packaged into a + single source file. +

        + For more information on Ant Tasks for iPlanet Application Server, see the + IPlanetDeploymentTool and IPlanetEjbcTask classes. +

        + +

        +

        +
        See Also:
        IPlanetDeploymentTool, +IPlanetEjbcTask
        +
        + +

        + + + + + + + + + + + +
        +Nested Class Summary
        + classIPlanetEjbc.EjbcException + +
        +          This inner class is used to signal any problems during the execution of + the ejbc compiler.
        +  + + + + + + + + + + +
        +Constructor Summary
        IPlanetEjbc(java.io.File stdDescriptor, + java.io.File iasDescriptor, + java.io.File destDirectory, + java.lang.String classpath, + javax.xml.parsers.SAXParser parser) + +
        +          Constructs an instance which may be used to process EJB descriptors and + generate EJB stubs and skeletons, if needed.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidcheckConfiguration() + +
        +          Verifies that the user selections are valid.
        + voidexecute() + +
        +          Compiles the stub and skeletons for the specified EJBs, if they need to + be updated.
        + java.lang.String[]getCmpDescriptors() + +
        +          Returns the list of CMP descriptors referenced in the EJB descriptors.
        + java.lang.StringgetDisplayName() + +
        +          Returns the display-name element read from the standard EJB descriptor.
        + java.util.HashtablegetEjbFiles() + +
        +          Returns a Hashtable which contains a list of EJB class files processed by + the ejbc utility (both "source" class files as well as stubs and + skeletons).
        +static voidmain(java.lang.String[] args) + +
        +          Main application method for the iPlanet Application Server ejbc utility.
        + voidregisterDTD(java.lang.String publicID, + java.lang.String location) + +
        +          Registers the location of a local DTD file or resource.
        + voidsetDebugOutput(boolean debugOutput) + +
        +          If true, enables debugging output when ejbc is executed.
        + voidsetIasHomeDir(java.io.File iasHomeDir) + +
        +          May be used to specify the "home" directory for this iAS installation.
        + voidsetRetainSource(boolean retainSource) + +
        +          If true, the Java source files which are generated by the + ejbc process are retained.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +IPlanetEjbc

        +
        +public IPlanetEjbc(java.io.File stdDescriptor,
+                   java.io.File iasDescriptor,
+                   java.io.File destDirectory,
+                   java.lang.String classpath,
+                   javax.xml.parsers.SAXParser parser)
        +
        +
        Constructs an instance which may be used to process EJB descriptors and + generate EJB stubs and skeletons, if needed. +

        +

        +
        Parameters:
        stdDescriptor - File referencing a standard EJB descriptor.
        iasDescriptor - File referencing an iAS-specific EJB descriptor.
        destDirectory - File referencing the base directory where both + EJB "source" files are found and where stubs and + skeletons will be written.
        classpath - String representation of the classpath to be used + by the iAS ejbc utility.
        parser - SAXParser to be used to process both of the EJB + descriptors.
        To do:
        +
        classpathElements is not needed here, its never used + (at least IDEA tells me so! :)
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setRetainSource

        +
        +public void setRetainSource(boolean retainSource)
        +
        +
        If true, the Java source files which are generated by the + ejbc process are retained. +

        +

        +
        Parameters:
        retainSource - A boolean indicating if the Java source files for + the stubs and skeletons should be retained.
        To do:
        +
        This is not documented in the HTML. On purpose?
        +
        +
        +
        +
        + +

        +setDebugOutput

        +
        +public void setDebugOutput(boolean debugOutput)
        +
        +
        If true, enables debugging output when ejbc is executed. +

        +

        +
        Parameters:
        debugOutput - A boolean indicating if debugging output should be + generated
        +
        +
        +
        + +

        +registerDTD

        +
        +public void registerDTD(java.lang.String publicID,
+                        java.lang.String location)
        +
        +
        Registers the location of a local DTD file or resource. By registering + a local DTD, EJB descriptors can be parsed even when the remote servers + which contain the "public" DTDs cannot be accessed. +

        +

        +
        Parameters:
        publicID - The public DTD identifier found in an XML document.
        location - The file or resource name for the appropriate DTD stored + on the local machine.
        +
        +
        +
        + +

        +setIasHomeDir

        +
        +public void setIasHomeDir(java.io.File iasHomeDir)
        +
        +
        May be used to specify the "home" directory for this iAS installation. + The directory specified should typically be + [install-location]/iplanet/ias6/ias. +

        +

        +
        Parameters:
        iasHomeDir - The home directory for the user's iAS installation.
        +
        +
        +
        + +

        +getEjbFiles

        +
        +public java.util.Hashtable getEjbFiles()
        +
        +
        Returns a Hashtable which contains a list of EJB class files processed by + the ejbc utility (both "source" class files as well as stubs and + skeletons). The key for the Hashtable is a String representing the path + to the class file (relative to the destination directory). The value for + the Hashtable is a File object which reference the actual class file. +

        +

        + +
        Returns:
        The list of EJB files processed by the ejbc utility.
        +
        +
        +
        + +

        +getDisplayName

        +
        +public java.lang.String getDisplayName()
        +
        +
        Returns the display-name element read from the standard EJB descriptor. +

        +

        + +
        Returns:
        The EJB-JAR display name.
        +
        +
        +
        + +

        +getCmpDescriptors

        +
        +public java.lang.String[] getCmpDescriptors()
        +
        +
        Returns the list of CMP descriptors referenced in the EJB descriptors. +

        +

        + +
        Returns:
        An array of CMP descriptors.
        +
        +
        +
        + +

        +main

        +
        +public static void main(java.lang.String[] args)
        +
        +
        Main application method for the iPlanet Application Server ejbc utility. + If the application is run with no commandline arguments, a usage + statement is printed for the user. +

        +

        +
        Parameters:
        args - The commandline arguments passed to the application.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws IPlanetEjbc.EjbcException,
+                    java.io.IOException,
+                    org.xml.sax.SAXException
        +
        +
        Compiles the stub and skeletons for the specified EJBs, if they need to + be updated. +

        +

        + +
        Throws: +
        IPlanetEjbc.EjbcException - If the ejbc utility cannot be correctly configured + or if one or more of the EJB "source" classes + cannot be found in the destination directory +
        java.io.IOException - If the parser encounters a problem reading the XML + file +
        org.xml.sax.SAXException - If the parser encounters a problem processing the + XML descriptor (it may wrap another exception)
        +
        +
        +
        + +

        +checkConfiguration

        +
        +protected void checkConfiguration()
+                           throws IPlanetEjbc.EjbcException
        +
        +
        Verifies that the user selections are valid. +

        +

        + +
        Throws: +
        IPlanetEjbc.EjbcException - If the user selections are invalid.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.html new file mode 100644 index 000000000..aa58f70a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.html @@ -0,0 +1,540 @@ + + + + + + +IPlanetEjbcTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class IPlanetEjbcTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class IPlanetEjbcTask
        extends Task
        + + +

        +Compiles EJB stubs and skeletons for the iPlanet Application Server. + The EJBs to be processed are specified by the EJB 1.1 standard XML + descriptor, and additional attributes are obtained from the iPlanet Application + Server-specific XML descriptor. Since the XML descriptors can include + multiple EJBs, this is a convenient way of specifying many EJBs in a single + Ant task. The following attributes are allowed: +

          +
        • ejbdescriptor -- Standard EJB 1.1 XML descriptor (typically + titled "ejb-jar.xml"). This attribute is + required. +
        • iasdescriptor -- EJB XML descriptor for iPlanet Application + Server (typically titled "ias-ejb-jar.xml). + This attribute is required. +
        • dest -- The is the base directory where the RMI stubs and + skeletons are written. In addition, the class files + for each bean (home interface, remote interface, and + EJB implementation) must be found in this directory. + This attribute is required. +
        • classpath -- The classpath used when generating EJB stubs and + skeletons. This is an optional attribute (if + omitted, the classpath specified when Ant was + started will be used). Nested "classpath" + elements may also be used. +
        • keepgenerated -- Indicates whether or not the Java source + files which are generated by ejbc will be + saved or automatically deleted. If "yes", + the source files will be retained. This is + an optional attribute (if omitted, it + defaults to "no"). +
        • debug -- Indicates whether or not the ejbc utility should + log additional debugging statements to the standard + output. If "yes", the additional debugging statements + will be generated (if omitted, it defaults to "no"). +
        • iashome -- May be used to specify the "home" directory for + this iPlanet Application Server installation. This + is used to find the ejbc utility if it isn't + included in the user's system path. This is an + optional attribute (if specified, it should refer + to the [install-location]/iplanet/ias6/ias + directory). If omitted, the ejbc utility + must be on the user's system path. +
        +

        + For each EJB specified, this task will locate the three classes that comprise + the EJB. If these class files cannot be located in the dest + directory, the task will fail. The task will also attempt to locate the EJB + stubs and skeletons in this directory. If found, the timestamps on the + stubs and skeletons will be checked to ensure they are up to date. Only if + these files cannot be found or if they are out of date will ejbc be called + to generate new stubs and skeletons. +

        + +

        +

        +
        See Also:
        IPlanetEjbc
        +
        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        IPlanetEjbcTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + PathcreateClasspath() + +
        +          Adds to the classpath used when compiling the EJB stubs and skeletons.
        + voidexecute() + +
        +          Does the work.
        + voidsetClasspath(Path classpath) + +
        +          Sets the classpath to be used when compiling the EJB stubs and skeletons.
        + voidsetDebug(boolean debug) + +
        +          If true, debugging output will be generated when ejbc is + executed.
        + voidsetDest(java.io.File dest) + +
        +          Sets the destination directory where the EJB source classes must exist + and where the stubs and skeletons will be written.
        + voidsetEjbdescriptor(java.io.File ejbdescriptor) + +
        +          Sets the location of the standard XML EJB descriptor.
        + voidsetIasdescriptor(java.io.File iasdescriptor) + +
        +          Sets the location of the iAS-specific XML EJB descriptor.
        + voidsetIashome(java.io.File iashome) + +
        +          May be used to specify the "home" directory for this iAS installation.
        + voidsetKeepgenerated(boolean keepgenerated) + +
        +          If true, the Java source files which are generated by ejbc will be saved .
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +IPlanetEjbcTask

        +
        +public IPlanetEjbcTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setEjbdescriptor

        +
        +public void setEjbdescriptor(java.io.File ejbdescriptor)
        +
        +
        Sets the location of the standard XML EJB descriptor. Typically, this + file is named "ejb-jar.xml". +

        +

        +
        Parameters:
        ejbdescriptor - The name and location of the EJB descriptor.
        +
        +
        +
        + +

        +setIasdescriptor

        +
        +public void setIasdescriptor(java.io.File iasdescriptor)
        +
        +
        Sets the location of the iAS-specific XML EJB descriptor. Typically, + this file is named "ias-ejb-jar.xml". +

        +

        +
        Parameters:
        iasdescriptor - The name and location of the iAS-specific EJB + descriptor.
        +
        +
        +
        + +

        +setDest

        +
        +public void setDest(java.io.File dest)
        +
        +
        Sets the destination directory where the EJB source classes must exist + and where the stubs and skeletons will be written. The destination + directory must exist before this task is executed. +

        +

        +
        Parameters:
        dest - The directory where the compiled classes will be written.
        +
        +
        +
        + +

        +setClasspath

        +
        +public void setClasspath(Path classpath)
        +
        +
        Sets the classpath to be used when compiling the EJB stubs and skeletons. +

        +

        +
        Parameters:
        classpath - The classpath to be used.
        +
        +
        +
        + +

        +createClasspath

        +
        +public Path createClasspath()
        +
        +
        Adds to the classpath used when compiling the EJB stubs and skeletons. +

        +

        + +
        Returns:
        the class path.
        +
        +
        +
        + +

        +setKeepgenerated

        +
        +public void setKeepgenerated(boolean keepgenerated)
        +
        +
        If true, the Java source files which are generated by ejbc will be saved . +

        +

        +
        Parameters:
        keepgenerated - A boolean indicating if the Java source files for + the stubs and skeletons should be retained.
        +
        +
        +
        + +

        +setDebug

        +
        +public void setDebug(boolean debug)
        +
        +
        If true, debugging output will be generated when ejbc is + executed. +

        +

        +
        Parameters:
        debug - A boolean indicating if debugging output should be generated
        +
        +
        +
        + +

        +setIashome

        +
        +public void setIashome(java.io.File iashome)
        +
        +
        May be used to specify the "home" directory for this iAS installation. + The directory specified should typically be + [install-location]/iplanet/ias6/ias. +

        +

        +
        Parameters:
        iashome - The home directory for the user's iAS installation.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Does the work. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.html new file mode 100644 index 000000000..1855a4dd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.html @@ -0,0 +1,229 @@ + + + + + + +InnerClassFilenameFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class InnerClassFilenameFilter

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.InnerClassFilenameFilter
+
        +
        +
        All Implemented Interfaces:
        java.io.FilenameFilter
        +
        +
        +
        +
        public class InnerClassFilenameFilter
        extends java.lang.Object
        implements java.io.FilenameFilter
        + + +

        +A filename filter for inner class files of a particular class. +

        + +

        +

        + +

        + + + + + + + + + + + + +
        +Method Summary
        + booleanaccept(java.io.File dir, + java.lang.String filename) + +
        +          Check if the file name passes the filter.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +accept

        +
        +public boolean accept(java.io.File dir,
+                      java.lang.String filename)
        +
        +
        Check if the file name passes the filter. +

        +

        +
        Specified by:
        accept in interface java.io.FilenameFilter
        +
        +
        +
        Parameters:
        dir - not used.
        filename - the filename to filter on. +
        Returns:
        true if the filename is an inner class of the base class.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.html new file mode 100644 index 000000000..7544ae7ef --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.html @@ -0,0 +1,411 @@ + + + + + + +JbossDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class JbossDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.JbossDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        +
        public class JbossDeploymentTool
        extends GenericDeploymentTool
        + + +

        +The deployment tool to add the jboss specific deployment descriptor to the ejb jar file. + Jboss only requires one additional file jboss.xml and does not require any additional + compilation. +

        + +

        +

        +
        Version:
        +
        1.0
        +
        See Also:
        EjbJar.createJboss()
        +
        + +

        + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected static java.lang.StringJBOSS_CMP10D + +
        +           
        +protected static java.lang.StringJBOSS_CMP20D + +
        +           
        +protected static java.lang.StringJBOSS_DD + +
        +           
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        JbossDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the + EJB Jar.
        + voidsetSuffix(java.lang.String inString) + +
        +          Setter used to store the suffix for the generated JBoss jar file.
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDescriptorHandler, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, registerKnownDTDs, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName, writeJar
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +JBOSS_DD

        +
        +protected static final java.lang.String JBOSS_DD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JBOSS_CMP10D

        +
        +protected static final java.lang.String JBOSS_CMP10D
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JBOSS_CMP20D

        +
        +protected static final java.lang.String JBOSS_CMP20D
        +
        +
        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +JbossDeploymentTool

        +
        +public JbossDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setSuffix

        +
        +public void setSuffix(java.lang.String inString)
        +
        +
        Setter used to store the suffix for the generated JBoss jar file. +

        +

        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the + EJB Jar. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - the hashtable of files to populate.
        ddPrefix - the prefix to use.
        +
        +
        +
        + +

        +validateConfigured

        +
        +public void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        +
        Specified by:
        validateConfigured in interface EJBDeploymentTool
        Overrides:
        validateConfigured in class GenericDeploymentTool
        +
        +
        + +
        Throws: +
        BuildException - If the Deployment Tool's configuration isn't + valid
        Since:
        +
        ant 1.6
        +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.html new file mode 100644 index 000000000..8a85e5d78 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.html @@ -0,0 +1,1070 @@ + + + + + + +JonasDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class JonasDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.JonasDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        +
        public class JonasDeploymentTool
        extends GenericDeploymentTool
        + + +

        +The deployment tool to add the jonas specific deployment descriptors to the + ejb JAR file. JONAS only requires one additional file jonas-ejb-jar.xml. +

        + +

        +

        +
        Version:
        +
        1.0
        +
        See Also:
        EjbJar.createJonas()
        +
        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected static java.lang.StringDAVID_ORB + +
        +          DAVID ORB.
        +protected static java.lang.StringEJB_JAR_1_1_DTD + +
        +          Name of the standard deployment descriptor DTD (these files are stored in + the ${JONAS_ROOT}/xml directory).
        +protected static java.lang.StringEJB_JAR_1_1_PUBLIC_ID + +
        +          Public Id of the standard deployment descriptor DTD.
        +protected static java.lang.StringEJB_JAR_2_0_DTD + +
        +           
        +protected static java.lang.StringEJB_JAR_2_0_PUBLIC_ID + +
        +           
        +protected static java.lang.StringGENIC_CLASS + +
        +          GenIC class name (JOnAS 2.5)
        +protected static java.lang.StringJEREMIE_ORB + +
        +          JEREMIE ORB.
        +protected static java.lang.StringJONAS_DD + +
        +          Default JOnAS deployment descriptor name.
        +protected static java.lang.StringJONAS_EJB_JAR_2_4_DTD + +
        +          Name of the JOnAS-specific deployment descriptor DTD (these files are + stored in the ${JONAS_ROOT}/xml directory).
        +protected static java.lang.StringJONAS_EJB_JAR_2_4_PUBLIC_ID + +
        +          Public Id of the JOnAS-specific deployment descriptor DTD.
        +protected static java.lang.StringJONAS_EJB_JAR_2_5_DTD + +
        +           
        +protected static java.lang.StringJONAS_EJB_JAR_2_5_PUBLIC_ID + +
        +           
        +protected static java.lang.StringOLD_GENIC_CLASS_1 + +
        +          Old GenIC class name (JOnAS 2.4.x).
        +protected static java.lang.StringOLD_GENIC_CLASS_2 + +
        +          Old GenIC class name.
        +protected static java.lang.StringRMI_ORB + +
        +          RMI ORB.
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        JonasDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the + EJB Jar..
        +protected  voidcheckConfiguration(java.lang.String descriptorFileName, + javax.xml.parsers.SAXParser saxParser) + +
        +          Verify the configuration.
        +protected  java.lang.StringgetJarBaseName(java.lang.String descriptorFileName) + +
        +          Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file..
        +protected  java.io.FilegetVendorOutputJarFile(java.lang.String baseName) + +
        +          Get the vendor specific name of the Jar that will be output..
        + voidprocessDescriptor(java.lang.String aDescriptorName, + javax.xml.parsers.SAXParser saxParser) + +
        +          Process a deployment descriptor, generating the necessary vendor specific + deployment files...
        +protected  voidregisterKnownDTDs(DescriptorHandler handler) + +
        +          Register the locations of all known DTDs..
        + voidsetAdditionalargs(java.lang.String aString) + +
        +          Sets the additional arguments.
        + voidsetJarsuffix(java.lang.String aString) + +
        +          Sets the jar suffix.
        + voidsetJavac(java.lang.String aString) + +
        +          Sets the java compiler to use.
        + voidsetJavacopts(java.lang.String aString) + +
        +          Set the options to pass to the java compiler.
        + voidsetJonasroot(java.io.File aFile) + +
        +          Set the JOnAS root directory.
        + voidsetKeepgenerated(boolean aBoolean) + +
        +          Sets the keepgenerated flag.
        + voidsetKeepgeneric(boolean aBoolean) + +
        +          Sets the keepgeneric flag.
        + voidsetNocompil(boolean aBoolean) + +
        +          Sets the nocompil flag.
        + voidsetNogenic(boolean aBoolean) + +
        +          Sets the nogenic flag.
        + voidsetNovalidation(boolean aBoolean) + +
        +          Sets the novalidation flag.
        + voidsetOrb(java.lang.String aString) + +
        +          Sets the orb to construct classpath.
        + voidsetRmicopts(java.lang.String aString) + +
        +          Set the options to pass to the rmi compiler.
        + voidsetSecpropag(boolean aBoolean) + +
        +          Sets the secpropag flag.
        + voidsetVerbose(boolean aBoolean) + +
        +          Sets the verbose flag.
        +protected  voidwriteJar(java.lang.String baseName, + java.io.File jarfile, + java.util.Hashtable ejbFiles, + java.lang.String publicId) + +
        +          Method used to encapsulate the writing of the JAR file..
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDescriptorHandler, getDestDir, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName, validateConfigured
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +EJB_JAR_1_1_PUBLIC_ID

        +
        +protected static final java.lang.String EJB_JAR_1_1_PUBLIC_ID
        +
        +
        Public Id of the standard deployment descriptor DTD. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +EJB_JAR_2_0_PUBLIC_ID

        +
        +protected static final java.lang.String EJB_JAR_2_0_PUBLIC_ID
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JONAS_EJB_JAR_2_4_PUBLIC_ID

        +
        +protected static final java.lang.String JONAS_EJB_JAR_2_4_PUBLIC_ID
        +
        +
        Public Id of the JOnAS-specific deployment descriptor DTD. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JONAS_EJB_JAR_2_5_PUBLIC_ID

        +
        +protected static final java.lang.String JONAS_EJB_JAR_2_5_PUBLIC_ID
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +RMI_ORB

        +
        +protected static final java.lang.String RMI_ORB
        +
        +
        RMI ORB. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JEREMIE_ORB

        +
        +protected static final java.lang.String JEREMIE_ORB
        +
        +
        JEREMIE ORB. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DAVID_ORB

        +
        +protected static final java.lang.String DAVID_ORB
        +
        +
        DAVID ORB. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +EJB_JAR_1_1_DTD

        +
        +protected static final java.lang.String EJB_JAR_1_1_DTD
        +
        +
        Name of the standard deployment descriptor DTD (these files are stored in + the ${JONAS_ROOT}/xml directory). +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +EJB_JAR_2_0_DTD

        +
        +protected static final java.lang.String EJB_JAR_2_0_DTD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JONAS_EJB_JAR_2_4_DTD

        +
        +protected static final java.lang.String JONAS_EJB_JAR_2_4_DTD
        +
        +
        Name of the JOnAS-specific deployment descriptor DTD (these files are + stored in the ${JONAS_ROOT}/xml directory). +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JONAS_EJB_JAR_2_5_DTD

        +
        +protected static final java.lang.String JONAS_EJB_JAR_2_5_DTD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +JONAS_DD

        +
        +protected static final java.lang.String JONAS_DD
        +
        +
        Default JOnAS deployment descriptor name. +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +GENIC_CLASS

        +
        +protected static final java.lang.String GENIC_CLASS
        +
        +
        GenIC class name (JOnAS 2.5) +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +OLD_GENIC_CLASS_1

        +
        +protected static final java.lang.String OLD_GENIC_CLASS_1
        +
        +
        Old GenIC class name (JOnAS 2.4.x). +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +OLD_GENIC_CLASS_2

        +
        +protected static final java.lang.String OLD_GENIC_CLASS_2
        +
        +
        Old GenIC class name. +

        +

        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +JonasDeploymentTool

        +
        +public JonasDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setKeepgenerated

        +
        +public void setKeepgenerated(boolean aBoolean)
        +
        +
        Sets the keepgenerated flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setAdditionalargs

        +
        +public void setAdditionalargs(java.lang.String aString)
        +
        +
        Sets the additional arguments. +

        +

        +
        Parameters:
        aString - additional args.
        +
        +
        +
        + +

        +setNocompil

        +
        +public void setNocompil(boolean aBoolean)
        +
        +
        Sets the nocompil flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setNovalidation

        +
        +public void setNovalidation(boolean aBoolean)
        +
        +
        Sets the novalidation flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setJavac

        +
        +public void setJavac(java.lang.String aString)
        +
        +
        Sets the java compiler to use. +

        +

        +
        Parameters:
        aString - the java compiler.
        +
        +
        +
        + +

        +setJavacopts

        +
        +public void setJavacopts(java.lang.String aString)
        +
        +
        Set the options to pass to the java compiler. +

        +

        +
        Parameters:
        aString - the options.
        +
        +
        +
        + +

        +setRmicopts

        +
        +public void setRmicopts(java.lang.String aString)
        +
        +
        Set the options to pass to the rmi compiler. +

        +

        +
        Parameters:
        aString - the options.
        +
        +
        +
        + +

        +setSecpropag

        +
        +public void setSecpropag(boolean aBoolean)
        +
        +
        Sets the secpropag flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setVerbose

        +
        +public void setVerbose(boolean aBoolean)
        +
        +
        Sets the verbose flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setJonasroot

        +
        +public void setJonasroot(java.io.File aFile)
        +
        +
        Set the JOnAS root directory. +

        +

        +
        Parameters:
        aFile - the JOnAS root directory.
        +
        +
        +
        + +

        +setKeepgeneric

        +
        +public void setKeepgeneric(boolean aBoolean)
        +
        +
        Sets the keepgeneric flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +setJarsuffix

        +
        +public void setJarsuffix(java.lang.String aString)
        +
        +
        Sets the jar suffix. +

        +

        +
        Parameters:
        aString - the string to use as the suffix.
        +
        +
        +
        + +

        +setOrb

        +
        +public void setOrb(java.lang.String aString)
        +
        +
        Sets the orb to construct classpath. +

        +

        +
        Parameters:
        aString - 'RMI', 'JEREMIE', or 'DAVID'.
        +
        +
        +
        + +

        +setNogenic

        +
        +public void setNogenic(boolean aBoolean)
        +
        +
        Sets the nogenic flag. +

        +

        +
        Parameters:
        aBoolean - true if the flag must be set.
        +
        +
        +
        + +

        +processDescriptor

        +
        +public void processDescriptor(java.lang.String aDescriptorName,
+                              javax.xml.parsers.SAXParser saxParser)
        +
        +
        Process a deployment descriptor, generating the necessary vendor specific + deployment files... +

        +

        +
        Specified by:
        processDescriptor in interface EJBDeploymentTool
        Overrides:
        processDescriptor in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        aDescriptorName - the name of the deployment descriptor
        saxParser - a SAX parser which can be used to parse the deployment descriptor.
        +
        +
        +
        + +

        +writeJar

        +
        +protected void writeJar(java.lang.String baseName,
+                        java.io.File jarfile,
+                        java.util.Hashtable ejbFiles,
+                        java.lang.String publicId)
+                 throws BuildException
        +
        +
        Method used to encapsulate the writing of the JAR file. Iterates over the + filenames/java.io.Files in the Hashtable stored on the instance variable + ejbFiles.. +

        +

        +
        Overrides:
        writeJar in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        baseName - the base name to use.
        jarfile - the jar file to write to.
        ejbFiles - the files to write to the jar.
        publicId - the id to use. +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the + EJB Jar.. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - a hashtable entryname -> file.
        ddPrefix - a prefix to use.
        +
        +
        +
        + +

        +getVendorOutputJarFile

        +
        +protected java.io.File getVendorOutputJarFile(java.lang.String baseName)
        +
        +
        Get the vendor specific name of the Jar that will be output. The modification date + of this jar will be checked against the dependent bean classes.. +

        +

        +
        +
        +
        +
        Parameters:
        baseName - the basename to use.
        +
        +
        +
        + +

        +getJarBaseName

        +
        +protected java.lang.String getJarBaseName(java.lang.String descriptorFileName)
        +
        +
        Using the EJB descriptor file name passed from the ejbjar + task, this method returns the "basename" which will be used to name the + completed JAR file.. +

        +

        +
        Overrides:
        getJarBaseName in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        descriptorFileName - String representing the file name of an EJB + descriptor to be processed +
        Returns:
        The "basename" which will be used to name the + completed JAR file
        +
        +
        +
        + +

        +registerKnownDTDs

        +
        +protected void registerKnownDTDs(DescriptorHandler handler)
        +
        +
        Register the locations of all known DTDs. + + vendor-specific subclasses should override this method to define + the vendor-specific locations of the EJB DTDs. +

        +

        +
        Overrides:
        registerKnownDTDs in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        handler - no used in this class.
        +
        +
        +
        + +

        +checkConfiguration

        +
        +protected void checkConfiguration(java.lang.String descriptorFileName,
+                                  javax.xml.parsers.SAXParser saxParser)
+                           throws BuildException
        +
        +
        Verify the configuration. +

        +

        +
        Overrides:
        checkConfiguration in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        descriptorFileName - the name of the descriptor file.
        saxParser - not used. +
        Throws: +
        BuildException - if there is an error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.html new file mode 100644 index 000000000..7188140b6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.html @@ -0,0 +1,1313 @@ + + + + + + +WeblogicDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class WeblogicDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        Direct Known Subclasses:
        WeblogicTOPLinkDeploymentTool
        +
        +
        +
        +
        public class WeblogicDeploymentTool
        extends GenericDeploymentTool
        + + +

        +The weblogic element is used to control the weblogic.ejbc compiler for + generating weblogic EJB jars. Prior to Ant 1.3, the method of locating CMP + descriptors was to use the ejbjar naming convention. So if your ejb-jar was + called, Customer-ejb-jar.xml, your weblogic descriptor was called Customer- + weblogic-ejb-jar.xml and your CMP descriptor had to be Customer-weblogic-cmp- + rdbms-jar.xml. In addition, the <type-storage> element in the weblogic + descriptor had to be set to the standard name META-INF/weblogic-cmp-rdbms- + jar.xml, as that is where the CMP descriptor was mapped to in the generated + jar. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected static java.lang.StringCOMPILER_EJB11 + +
        +           
        +protected static java.lang.StringCOMPILER_EJB20 + +
        +           
        +protected static java.lang.StringDEFAULT_COMPILER + +
        +           
        +protected static java.lang.StringDEFAULT_WL51_DTD_LOCATION + +
        +           
        +protected static java.lang.StringDEFAULT_WL51_EJB11_DTD_LOCATION + +
        +          Weblogic 5.1 dtd location
        +protected static java.lang.StringDEFAULT_WL60_51_DTD_LOCATION + +
        +           
        +protected static java.lang.StringDEFAULT_WL60_DTD_LOCATION + +
        +           
        +protected static java.lang.StringDEFAULT_WL60_EJB11_DTD_LOCATION + +
        +          Weblogic 6.0 ejb 1.1 dtd location
        +protected static java.lang.StringDEFAULT_WL60_EJB20_DTD_LOCATION + +
        +          Weblogic 6.0 ejb 2.0 dtd location
        +protected static java.lang.StringDEFAULT_WL70_DTD_LOCATION + +
        +           
        +static java.lang.StringPUBLICID_EJB11 + +
        +          EJB11 id
        +static java.lang.StringPUBLICID_EJB20 + +
        +          EJB20 id
        +static java.lang.StringPUBLICID_WEBLOGIC_EJB510 + +
        +          Weblogic 5.1.0 id
        +static java.lang.StringPUBLICID_WEBLOGIC_EJB600 + +
        +          Weblogic 6.0.0 id
        +static java.lang.StringPUBLICID_WEBLOGIC_EJB700 + +
        +          Weblogic 7.0.0 id
        +protected static java.lang.StringWL_CMP_DD + +
        +           
        +protected static java.lang.StringWL_DD + +
        +           
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        WeblogicDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddSysproperty(Environment.Variable sysp) + +
        +          Add a nested sysproperty element.
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the EJB Jar.
        + PathcreateWLClasspath() + +
        +          Get the classpath to the weblogic classpaths.
        +protected  java.lang.ClassLoadergetClassLoaderFromJar(java.io.File classjar) + +
        +          Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it.
        + java.lang.StringgetEjbcClass() + +
        +          Get the ejbc compiler class.
        + java.lang.IntegergetJvmDebugLevel() + +
        +          Get the debug level.
        +protected  DescriptorHandlergetWeblogicDescriptorHandler(java.io.File srcDir) + +
        +          Get the weblogic descriptor handler.
        +protected  booleanisRebuildRequired(java.io.File genericJarFile, + java.io.File weblogicJarFile) + +
        +          Helper method to check to see if a weblogic EBJ1.1 jar needs to be + rebuilt using ejbc.
        +protected  voidregisterKnownDTDs(DescriptorHandler handler) + +
        +          Register the DTDs.
        + voidsetArgs(java.lang.String args) + +
        +          Any optional extra arguments pass to the weblogic.ejbc + tool.
        + voidsetCompiler(java.lang.String compiler) + +
        +          The compiler (switch -compiler) to use; optional.
        + voidsetEjbcClass(java.lang.String ejbcClass) + +
        +          Set the classname of the ejbc compiler; optional + Normally ejbjar determines + the appropriate class based on the DTD used for the EJB.
        + voidsetEJBdtd(java.lang.String inString) + +
        +          Deprecated.
        + voidsetJvmargs(java.lang.String args) + +
        +          Set any additional arguments to pass to the weblogic JVM; optional.
        + voidsetJvmDebugLevel(java.lang.Integer jvmDebugLevel) + +
        +          Sets the weblogic.StdoutSeverityLevel to use when running the JVM that + executes ejbc; optional.
        + voidsetKeepgenerated(java.lang.String inValue) + +
        +          Controls whether weblogic will keep the generated Java + files used to build the class files added to the + jar.
        + voidsetKeepgeneric(boolean inValue) + +
        +          controls whether the generic file used as input to + ejbc is retained; defaults to false
        + voidsetNewCMP(boolean newCMP) + +
        +          If this is set to true, the new method for locating + CMP descriptors will be used; optional, default false.
        + voidsetNoEJBC(boolean noEJBC) + +
        +          Do not EJBC the jar after it has been put together; + optional, default false
        + voidsetOldCMP(boolean oldCMP) + +
        +          Set the value of the oldCMP scheme.
        + voidsetOutputDir(java.io.File outputDir) + +
        +          If set ejbc will use this directory as the output + destination rather than a jar file.
        + voidsetRebuild(boolean rebuild) + +
        +          Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbc; optional, default true.
        + voidsetSuffix(java.lang.String inString) + +
        +          Setter used to store the suffix for the generated weblogic jar file.
        + voidsetWeblogicdtd(java.lang.String inString) + +
        +          Deprecated.
        + voidsetWLClasspath(Path wlClasspath) + +
        +          Optional classpath to WL6.0.
        + voidsetWLdtd(java.lang.String inString) + +
        +          Deprecated.
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +protected  voidwriteJar(java.lang.String baseName, + java.io.File jarFile, + java.util.Hashtable files, + java.lang.String publicId) + +
        +          Method used to encapsulate the writing of the JAR file.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDescriptorHandler, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +PUBLICID_EJB11

        +
        +public static final java.lang.String PUBLICID_EJB11
        +
        +
        EJB11 id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +PUBLICID_EJB20

        +
        +public static final java.lang.String PUBLICID_EJB20
        +
        +
        EJB20 id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +PUBLICID_WEBLOGIC_EJB510

        +
        +public static final java.lang.String PUBLICID_WEBLOGIC_EJB510
        +
        +
        Weblogic 5.1.0 id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +PUBLICID_WEBLOGIC_EJB600

        +
        +public static final java.lang.String PUBLICID_WEBLOGIC_EJB600
        +
        +
        Weblogic 6.0.0 id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +PUBLICID_WEBLOGIC_EJB700

        +
        +public static final java.lang.String PUBLICID_WEBLOGIC_EJB700
        +
        +
        Weblogic 7.0.0 id +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL51_EJB11_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL51_EJB11_DTD_LOCATION
        +
        +
        Weblogic 5.1 dtd location +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL60_EJB11_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL60_EJB11_DTD_LOCATION
        +
        +
        Weblogic 6.0 ejb 1.1 dtd location +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL60_EJB20_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL60_EJB20_DTD_LOCATION
        +
        +
        Weblogic 6.0 ejb 2.0 dtd location +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL51_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL51_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL60_51_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL60_51_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL60_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL60_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_WL70_DTD_LOCATION

        +
        +protected static final java.lang.String DEFAULT_WL70_DTD_LOCATION
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +DEFAULT_COMPILER

        +
        +protected static final java.lang.String DEFAULT_COMPILER
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WL_DD

        +
        +protected static final java.lang.String WL_DD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WL_CMP_DD

        +
        +protected static final java.lang.String WL_CMP_DD
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMPILER_EJB11

        +
        +protected static final java.lang.String COMPILER_EJB11
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +COMPILER_EJB20

        +
        +protected static final java.lang.String COMPILER_EJB20
        +
        +
        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +WeblogicDeploymentTool

        +
        +public WeblogicDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +addSysproperty

        +
        +public void addSysproperty(Environment.Variable sysp)
        +
        +
        Add a nested sysproperty element. +

        +

        +
        Parameters:
        sysp - the element to add.
        +
        +
        +
        + +

        +createWLClasspath

        +
        +public Path createWLClasspath()
        +
        +
        Get the classpath to the weblogic classpaths. +

        +

        + +
        Returns:
        the classpath to configure.
        +
        +
        +
        + +

        +setOutputDir

        +
        +public void setOutputDir(java.io.File outputDir)
        +
        +
        If set ejbc will use this directory as the output + destination rather than a jar file. This allows for the + generation of "exploded" jars. +

        +

        +
        Parameters:
        outputDir - the directory to be used.
        +
        +
        +
        + +

        +setWLClasspath

        +
        +public void setWLClasspath(Path wlClasspath)
        +
        +
        Optional classpath to WL6.0. + Weblogic 6.0 will give a warning if the home and remote interfaces + of a bean are on the system classpath used to run weblogic.ejbc. + In that case, the standard weblogic classes should be set with + this attribute (or equivalent nested element) and the + home and remote interfaces located with the standard classpath + attribute. +

        +

        +
        Parameters:
        wlClasspath - the path to be used.
        +
        +
        +
        + +

        +setCompiler

        +
        +public void setCompiler(java.lang.String compiler)
        +
        +
        The compiler (switch -compiler) to use; optional. + This allows for the selection of a different compiler + to be used for the compilation of the generated Java + files. This could be set, for example, to Jikes to + compile with the Jikes compiler. If this is not set + and the build.compiler property is set + to jikes, the Jikes compiler will be used. If this + is not desired, the value "default" + may be given to use the default compiler. +

        +

        +
        Parameters:
        compiler - the compiler to be used.
        +
        +
        +
        + +

        +setRebuild

        +
        +public void setRebuild(boolean rebuild)
        +
        +
        Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbc; optional, default true. + This flag controls whether weblogic.ejbc is always + invoked to build the jar file. In certain circumstances, + such as when only a bean class has been changed, the jar + can be generated by merely replacing the changed classes + and not rerunning ejbc. Setting this to false will reduce + the time to run ejbjar. +

        +

        +
        Parameters:
        rebuild - a boolean value.
        +
        +
        +
        + +

        +setJvmDebugLevel

        +
        +public void setJvmDebugLevel(java.lang.Integer jvmDebugLevel)
        +
        +
        Sets the weblogic.StdoutSeverityLevel to use when running the JVM that + executes ejbc; optional. Set to 16 to avoid the warnings about EJB Home and + Remotes being in the classpath +

        +

        +
        Parameters:
        jvmDebugLevel - the value to use.
        +
        +
        +
        + +

        +getJvmDebugLevel

        +
        +public java.lang.Integer getJvmDebugLevel()
        +
        +
        Get the debug level. +

        +

        + +
        Returns:
        the jvm debug level (may be null).
        +
        +
        +
        + +

        +setSuffix

        +
        +public void setSuffix(java.lang.String inString)
        +
        +
        Setter used to store the suffix for the generated weblogic jar file. +

        +

        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +setKeepgeneric

        +
        +public void setKeepgeneric(boolean inValue)
        +
        +
        controls whether the generic file used as input to + ejbc is retained; defaults to false +

        +

        +
        Parameters:
        inValue - true for keep generic
        +
        +
        +
        + +

        +setKeepgenerated

        +
        +public void setKeepgenerated(java.lang.String inValue)
        +
        +
        Controls whether weblogic will keep the generated Java + files used to build the class files added to the + jar. This can be useful when debugging; default is false. +

        +

        +
        Parameters:
        inValue - either 'true' or 'false'
        +
        +
        +
        + +

        +setArgs

        +
        +public void setArgs(java.lang.String args)
        +
        +
        Any optional extra arguments pass to the weblogic.ejbc + tool. +

        +

        +
        Parameters:
        args - extra arguments to pass to the ejbc tool.
        +
        +
        +
        + +

        +setJvmargs

        +
        +public void setJvmargs(java.lang.String args)
        +
        +
        Set any additional arguments to pass to the weblogic JVM; optional. +

        +

        +
        Parameters:
        args - the arguments to be passed to the JVM
        +
        +
        +
        + +

        +setEjbcClass

        +
        +public void setEjbcClass(java.lang.String ejbcClass)
        +
        +
        Set the classname of the ejbc compiler; optional + Normally ejbjar determines + the appropriate class based on the DTD used for the EJB. The EJB 2.0 compiler + featured in weblogic 6 has, however, been deprecated in version 7. When + using with version 7 this attribute should be set to + "weblogic.ejbc" to avoid the deprecation warning. +

        +

        +
        Parameters:
        ejbcClass - the name of the class to use.
        +
        +
        +
        + +

        +getEjbcClass

        +
        +public java.lang.String getEjbcClass()
        +
        +
        Get the ejbc compiler class. +

        +

        + +
        Returns:
        the name of the ejbc compiler class.
        +
        +
        +
        + +

        +setWeblogicdtd

        +
        +public void setWeblogicdtd(java.lang.String inString)
        +
        +
        Deprecated. Defines the location of the ejb-jar DTD in + the weblogic class hierarchy. Should not be needed, and the + nested <dtd> element is recommended when it is. +

        +

        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +setWLdtd

        +
        +public void setWLdtd(java.lang.String inString)
        +
        +
        Deprecated. Defines the location of weblogic DTD in + the weblogic class hierarchy. Should not be needed, and the + nested <dtd> element is recommended when it is. +

        +

        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +setEJBdtd

        +
        +public void setEJBdtd(java.lang.String inString)
        +
        +
        Deprecated. Defines the location of Sun's EJB DTD in + the weblogic class hierarchy. Should not be needed, and the + nested <dtd> element is recommended when it is. +

        +

        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +setOldCMP

        +
        +public void setOldCMP(boolean oldCMP)
        +
        +
        Set the value of the oldCMP scheme. This is an antonym for newCMP +

        +

        +
        Parameters:
        oldCMP - a boolean value.
        +
        +
        +
        + +

        +setNewCMP

        +
        +public void setNewCMP(boolean newCMP)
        +
        +
        If this is set to true, the new method for locating + CMP descriptors will be used; optional, default false. +

        + The old CMP scheme locates the + weblogic CMP descriptor based on the naming convention where the + weblogic CMP file is expected to be named with the bean name as the + prefix. Under this scheme the name of the CMP descriptor does not match + the name actually used in the main weblogic EJB descriptor. Also, + descriptors which contain multiple CMP references could not be used. +

        +

        +
        Parameters:
        newCMP - a boolean value.
        +
        +
        +
        + +

        +setNoEJBC

        +
        +public void setNoEJBC(boolean noEJBC)
        +
        +
        Do not EJBC the jar after it has been put together; + optional, default false +

        +

        +
        Parameters:
        noEJBC - a boolean value.
        +
        +
        +
        + +

        +registerKnownDTDs

        +
        +protected void registerKnownDTDs(DescriptorHandler handler)
        +
        +
        Register the DTDs. +

        +

        +
        Overrides:
        registerKnownDTDs in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        handler - the handler to use.
        +
        +
        +
        + +

        +getWeblogicDescriptorHandler

        +
        +protected DescriptorHandler getWeblogicDescriptorHandler(java.io.File srcDir)
        +
        +
        Get the weblogic descriptor handler. +

        +

        +
        Parameters:
        srcDir - the source directory. +
        Returns:
        the descriptor.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the EJB Jar. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - the hash table to be populated.
        ddPrefix - the prefix to use.
        +
        +
        +
        + +

        +writeJar

        +
        +protected void writeJar(java.lang.String baseName,
+                        java.io.File jarFile,
+                        java.util.Hashtable files,
+                        java.lang.String publicId)
+                 throws BuildException
        +
        +
        Method used to encapsulate the writing of the JAR file. Iterates over + the filenames/java.io.Files in the Hashtable stored on the instance + variable ejbFiles. +

        +

        +
        Overrides:
        writeJar in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        baseName - the base name.
        jarFile - the jar file to populate.
        files - the hash table of files to write.
        publicId - the id to use. +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +validateConfigured

        +
        +public void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        +
        Specified by:
        validateConfigured in interface EJBDeploymentTool
        Overrides:
        validateConfigured in class GenericDeploymentTool
        +
        +
        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +isRebuildRequired

        +
        +protected boolean isRebuildRequired(java.io.File genericJarFile,
+                                    java.io.File weblogicJarFile)
        +
        +
        Helper method to check to see if a weblogic EBJ1.1 jar needs to be + rebuilt using ejbc. Called from writeJar it sees if the "Bean" classes + are the only thing that needs to be updated and either updates the Jar + with the Bean classfile or returns true, saying that the whole weblogic + jar needs to be regened with ejbc. This allows faster build times for + working developers.

        + + The way weblogic ejbc works is it creates wrappers for the publicly + defined methods as they are exposed in the remote interface. If the + actual bean changes without changing the the method signatures then + only the bean classfile needs to be updated and the rest of the + weblogic jar file can remain the same. If the Interfaces, ie. the + method signatures change or if the xml deployment descriptors changed, + the whole jar needs to be rebuilt with ejbc. This is not strictly true + for the xml files. If the JNDI name changes then the jar doesnt have to + be rebuild, but if the resources references change then it does. At + this point the weblogic jar gets rebuilt if the xml files change at + all. +

        +

        +
        Parameters:
        genericJarFile - java.io.File The generic jar file.
        weblogicJarFile - java.io.File The weblogic jar file to check to + see if it needs to be rebuilt. +
        Returns:
        true if the jar needs to be rebuilt.
        +
        +
        +
        + +

        +getClassLoaderFromJar

        +
        +protected java.lang.ClassLoader getClassLoaderFromJar(java.io.File classjar)
+                                               throws java.io.IOException
        +
        +
        Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it. +

        +

        +
        Parameters:
        classjar - java.io.File representing jar file to get classes from. +
        Returns:
        the classloader for the jarfile. +
        Throws: +
        java.io.IOException - if there is a problem.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.html new file mode 100644 index 000000000..5f1cc86b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WeblogicTOPLinkDeploymentTool.html @@ -0,0 +1,409 @@ + + + + + + +WeblogicTOPLinkDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class WeblogicTOPLinkDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool
+          extended by org.apache.tools.ant.taskdefs.optional.ejb.WeblogicTOPLinkDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        +
        public class WeblogicTOPLinkDeploymentTool
        extends WeblogicDeploymentTool
        + + +

        +Deployment tool for Weblogic TOPLink. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool
        COMPILER_EJB11, COMPILER_EJB20, DEFAULT_COMPILER, DEFAULT_WL51_DTD_LOCATION, DEFAULT_WL51_EJB11_DTD_LOCATION, DEFAULT_WL60_51_DTD_LOCATION, DEFAULT_WL60_DTD_LOCATION, DEFAULT_WL60_EJB11_DTD_LOCATION, DEFAULT_WL60_EJB20_DTD_LOCATION, DEFAULT_WL70_DTD_LOCATION, PUBLICID_EJB11, PUBLICID_EJB20, PUBLICID_WEBLOGIC_EJB510, PUBLICID_WEBLOGIC_EJB600, PUBLICID_WEBLOGIC_EJB700, WL_CMP_DD, WL_DD
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        WeblogicTOPLinkDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String ddPrefix) + +
        +          Add any vendor specific files which should be included in the + EJB Jar.
        +protected  DescriptorHandlergetDescriptorHandler(java.io.File srcDir) + +
        +          Get the descriptor handler.
        + voidsetToplinkdescriptor(java.lang.String inString) + +
        +          Setter used to store the name of the toplink descriptor.
        + voidsetToplinkdtd(java.lang.String inString) + +
        +          Setter used to store the location of the toplink DTD file.
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.WeblogicDeploymentTool
        addSysproperty, createWLClasspath, getClassLoaderFromJar, getEjbcClass, getJvmDebugLevel, getWeblogicDescriptorHandler, isRebuildRequired, registerKnownDTDs, setArgs, setCompiler, setEjbcClass, setEJBdtd, setJvmargs, setJvmDebugLevel, setKeepgenerated, setKeepgeneric, setNewCMP, setNoEJBC, setOldCMP, setOutputDir, setRebuild, setSuffix, setWeblogicdtd, setWLClasspath, setWLdtd, writeJar
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +WeblogicTOPLinkDeploymentTool

        +
        +public WeblogicTOPLinkDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setToplinkdescriptor

        +
        +public void setToplinkdescriptor(java.lang.String inString)
        +
        +
        Setter used to store the name of the toplink descriptor. +

        +

        +
        Parameters:
        inString - the string to use as the descriptor name.
        +
        +
        +
        + +

        +setToplinkdtd

        +
        +public void setToplinkdtd(java.lang.String inString)
        +
        +
        Setter used to store the location of the toplink DTD file. + This is expected to be an URL (file or otherwise). If running + this on NT using a file URL, the safest thing would be to not use a + drive spec in the URL and make sure the file resides on the drive that + ANT is running from. This will keep the setting in the build XML + platform independent. +

        +

        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +getDescriptorHandler

        +
        +protected DescriptorHandler getDescriptorHandler(java.io.File srcDir)
        +
        +
        Get the descriptor handler. +

        +

        +
        Overrides:
        getDescriptorHandler in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        srcDir - the source file. +
        Returns:
        the descriptor handler.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String ddPrefix)
        +
        +
        Add any vendor specific files which should be included in the + EJB Jar. +

        +

        +
        Overrides:
        addVendorFiles in class WeblogicDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - the hashtable to add files to.
        ddPrefix - the prefix to use.
        +
        +
        +
        + +

        +validateConfigured

        +
        +public void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        +
        Specified by:
        validateConfigured in interface EJBDeploymentTool
        Overrides:
        validateConfigured in class WeblogicDeploymentTool
        +
        +
        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.html new file mode 100644 index 000000000..a31a415a5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.html @@ -0,0 +1,1124 @@ + + + + + + +WebsphereDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.ejb +
        +Class WebsphereDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        EJBDeploymentTool
        +
        +
        +
        +
        public class WebsphereDeploymentTool
        extends GenericDeploymentTool
        + + +

        +Websphere deployment tool that augments the ejbjar task. + Searches for the websphere specific deployment descriptors and + adds them to the final ejb jar file. Websphere has two specific descriptors for session + beans: +

          +
        • ibm-ejb-jar-bnd.xmi
          • +
        • ibm-ejb-jar-ext.xmi
          • +
        + and another two for container managed entity beans: +
          +
        • Map.mapxmi
          • +
        • Schema.dbxmi
          • +
        + In terms of WebSphere, the generation of container code and stubs is + called deployment. This step can be performed by the websphere + element as part of the jar generation process. If the switch + ejbdeploy is on, the ejbdeploy tool from the websphere toolset + is called for every ejb-jar. Unfortunately, this step only works, if you + use the ibm jdk. Otherwise, the rmic (called by ejbdeploy) throws a + ClassFormatError. Be sure to switch ejbdeploy off, if run ant with + sun jdk. +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static java.lang.StringPUBLICID_EJB11 + +
        +          ID for ejb 1.1
        +static java.lang.StringPUBLICID_EJB20 + +
        +          ID for ejb 2.0
        +protected static java.lang.StringSCHEMA_DIR + +
        +          Schema directory
        +protected static java.lang.StringWAS_BND + +
        +           
        +protected static java.lang.StringWAS_CMP_MAP + +
        +           
        +protected static java.lang.StringWAS_CMP_SCHEMA + +
        +           
        +protected static java.lang.StringWAS_EXT + +
        +           
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR
        +  + + + + + + + + + + +
        +Constructor Summary
        WebsphereDeploymentTool() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +protected  voidaddVendorFiles(java.util.Hashtable ejbFiles, + java.lang.String baseName) + +
        +          Add any vendor specific files which should be included in the EJB Jar.
        + PathcreateWASClasspath() + +
        +          Get the classpath to the websphere classpaths.
        +protected  java.lang.ClassLoadergetClassLoaderFromJar(java.io.File classjar) + +
        +          Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it.
        +protected  DescriptorHandlergetDescriptorHandler(java.io.File srcDir) + +
        +          Get a descriptionHandler..
        +protected  java.lang.StringgetOptions() + +
        +          Gets the options for the EJB Deploy operation
        +protected  DescriptorHandlergetWebsphereDescriptorHandler(java.io.File srcDir) + +
        +          Get a description handler.
        +protected  booleanisRebuildRequired(java.io.File genericJarFile, + java.io.File websphereJarFile) + +
        +          Helper method to check to see if a websphere EBJ1.1 jar needs to be + rebuilt using ejbdeploy.
        + voidsetCodegen(boolean codegen) + +
        +          Flag, default false, to only generate the deployment + code, do not run RMIC or Javac
        + voidsetDbname(java.lang.String dbName) + +
        +          Sets the name of the Database to create; optional.
        + voidsetDbschema(java.lang.String dbSchema) + +
        +          Sets the name of the schema to create; optional.
        + voidsetDbvendor(java.lang.String dbvendor) + +
        +          Sets the DB Vendor for the Entity Bean mapping ; optional.
        + voidsetEjbdeploy(boolean ejbdeploy) + +
        +          Decide, wether ejbdeploy should be called or not; + optional, default true.
        + voidsetEJBdtd(java.lang.String inString) + +
        +          Setter used to store the location of the Sun's Generic EJB DTD.
        + voidsetKeepgeneric(boolean inValue) + +
        +          This controls whether the generic file used as input to + ejbdeploy is retained; optional, default false.
        + voidsetNewCMP(boolean newCMP) + +
        +          Set the value of the newCMP scheme.
        + voidsetNoinform(boolean noinform) + +
        +          Flag to disable informational messages; optional, default false.
        + voidsetNovalidate(boolean novalidate) + +
        +          Flag to disable the validation steps; optional, default false.
        + voidsetNowarn(boolean nowarn) + +
        +          Flag to disable warning and informational messages; optional, default false.
        + voidsetOldCMP(boolean oldCMP) + +
        +          Set the value of the oldCMP scheme.
        + voidsetQuiet(boolean quiet) + +
        +          Flag, default true, to only output error messages.
        + voidsetRebuild(boolean rebuild) + +
        +          Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbdeploy; optional, default true.
        + voidsetRmicoptions(java.lang.String options) + +
        +          Set the rmic options.
        + voidsetSuffix(java.lang.String inString) + +
        +          String value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file.
        + voidsetTempdir(java.lang.String tempdir) + +
        +          The directory, where ejbdeploy will write temporary files; + optional, defaults to '_ejbdeploy_temp'.
        + voidsetTrace(boolean trace) + +
        +          Flag to enable internal tracing when set, optional, default false.
        + voidsetUse35(boolean attr) + +
        +          Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false.
        + voidsetWASClasspath(Path wasClasspath) + +
        +          Set the websphere classpath.
        + voidvalidateConfigured() + +
        +          Called to validate that the tool parameters have been configured.
        +protected  voidwriteJar(java.lang.String baseName, + java.io.File jarFile, + java.util.Hashtable files, + java.lang.String publicId) + +
        +          Method used to encapsulate the writing of the JAR file..
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
        addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, registerKnownDTDs, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +PUBLICID_EJB11

        +
        +public static final java.lang.String PUBLICID_EJB11
        +
        +
        ID for ejb 1.1 +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +PUBLICID_EJB20

        +
        +public static final java.lang.String PUBLICID_EJB20
        +
        +
        ID for ejb 2.0 +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +SCHEMA_DIR

        +
        +protected static final java.lang.String SCHEMA_DIR
        +
        +
        Schema directory +

        +

        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WAS_EXT

        +
        +protected static final java.lang.String WAS_EXT
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WAS_BND

        +
        +protected static final java.lang.String WAS_BND
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WAS_CMP_MAP

        +
        +protected static final java.lang.String WAS_CMP_MAP
        +
        +
        +
        See Also:
        Constant Field Values
        +
        +
        + +

        +WAS_CMP_SCHEMA

        +
        +protected static final java.lang.String WAS_CMP_SCHEMA
        +
        +
        +
        See Also:
        Constant Field Values
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +WebsphereDeploymentTool

        +
        +public WebsphereDeploymentTool()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +createWASClasspath

        +
        +public Path createWASClasspath()
        +
        +
        Get the classpath to the websphere classpaths. +

        +

        + +
        Returns:
        the websphere classpath.
        +
        +
        +
        + +

        +setWASClasspath

        +
        +public void setWASClasspath(Path wasClasspath)
        +
        +
        Set the websphere classpath. +

        +

        +
        Parameters:
        wasClasspath - the websphere classpath.
        +
        +
        +
        + +

        +setDbvendor

        +
        +public void setDbvendor(java.lang.String dbvendor)
        +
        +
        Sets the DB Vendor for the Entity Bean mapping ; optional. +

        + Valid options can be obtained by running the following command: + + <WAS_HOME>/bin/EJBDeploy.[sh/bat] -help + +

        +

        + This is also used to determine the name of the Map.mapxmi and + Schema.dbxmi files, for example Account-DB2UDB_V81-Map.mapxmi + and Account-DB2UDB_V81-Schema.dbxmi. +

        +

        +

        +
        Parameters:
        dbvendor - database vendor type
        +
        +
        +
        + +

        +setDbname

        +
        +public void setDbname(java.lang.String dbName)
        +
        +
        Sets the name of the Database to create; optional. +

        +

        +
        Parameters:
        dbName - name of the database
        +
        +
        +
        + +

        +setDbschema

        +
        +public void setDbschema(java.lang.String dbSchema)
        +
        +
        Sets the name of the schema to create; optional. +

        +

        +
        Parameters:
        dbSchema - name of the schema
        +
        +
        +
        + +

        +setCodegen

        +
        +public void setCodegen(boolean codegen)
        +
        +
        Flag, default false, to only generate the deployment + code, do not run RMIC or Javac +

        +

        +
        Parameters:
        codegen - option
        +
        +
        +
        + +

        +setQuiet

        +
        +public void setQuiet(boolean quiet)
        +
        +
        Flag, default true, to only output error messages. +

        +

        +
        Parameters:
        quiet - option
        +
        +
        +
        + +

        +setNovalidate

        +
        +public void setNovalidate(boolean novalidate)
        +
        +
        Flag to disable the validation steps; optional, default false. +

        +

        +
        Parameters:
        novalidate - option
        +
        +
        +
        + +

        +setNowarn

        +
        +public void setNowarn(boolean nowarn)
        +
        +
        Flag to disable warning and informational messages; optional, default false. +

        +

        +
        Parameters:
        nowarn - option
        +
        +
        +
        + +

        +setNoinform

        +
        +public void setNoinform(boolean noinform)
        +
        +
        Flag to disable informational messages; optional, default false. +

        +

        +
        Parameters:
        noinform - if true disables informational messages
        +
        +
        +
        + +

        +setTrace

        +
        +public void setTrace(boolean trace)
        +
        +
        Flag to enable internal tracing when set, optional, default false. +

        +

        +
        Parameters:
        trace - a boolean vaule.
        +
        +
        +
        + +

        +setRmicoptions

        +
        +public void setRmicoptions(java.lang.String options)
        +
        +
        Set the rmic options. +

        +

        +
        Parameters:
        options - the options to use.
        +
        +
        +
        + +

        +setUse35

        +
        +public void setUse35(boolean attr)
        +
        +
        Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false. +

        +

        +
        Parameters:
        attr - a boolean value.
        +
        +
        +
        + +

        +setRebuild

        +
        +public void setRebuild(boolean rebuild)
        +
        +
        Set the rebuild flag to false to only update changes in the jar rather + than rerunning ejbdeploy; optional, default true. +

        +

        +
        Parameters:
        rebuild - a boolean value.
        +
        +
        +
        + +

        +setSuffix

        +
        +public void setSuffix(java.lang.String inString)
        +
        +
        String value appended to the basename of the deployment + descriptor to create the filename of the WebLogic EJB + jar file. Optional, default '.jar'. +

        +

        +
        Parameters:
        inString - the string to use as the suffix.
        +
        +
        +
        + +

        +setKeepgeneric

        +
        +public void setKeepgeneric(boolean inValue)
        +
        +
        This controls whether the generic file used as input to + ejbdeploy is retained; optional, default false. +

        +

        +
        Parameters:
        inValue - either 'true' or 'false'.
        +
        +
        +
        + +

        +setEjbdeploy

        +
        +public void setEjbdeploy(boolean ejbdeploy)
        +
        +
        Decide, wether ejbdeploy should be called or not; + optional, default true. +

        +

        +
        Parameters:
        ejbdeploy - a boolean value.
        +
        +
        +
        + +

        +setEJBdtd

        +
        +public void setEJBdtd(java.lang.String inString)
        +
        +
        Setter used to store the location of the Sun's Generic EJB DTD. This + can be a file on the system or a resource on the classpath. +

        +

        +
        Parameters:
        inString - the string to use as the DTD location.
        +
        +
        +
        + +

        +setOldCMP

        +
        +public void setOldCMP(boolean oldCMP)
        +
        +
        Set the value of the oldCMP scheme. This is an antonym for newCMP +

        +

        +
        Parameters:
        oldCMP - a boolean value.
        +
        +
        +
        + +

        +setNewCMP

        +
        +public void setNewCMP(boolean newCMP)
        +
        +
        Set the value of the newCMP scheme. The old CMP scheme locates the + websphere CMP descriptor based on the naming convention where the + websphere CMP file is expected to be named with the bean name as the + prefix. Under this scheme the name of the CMP descriptor does not match + the name actually used in the main websphere EJB descriptor. Also, + descriptors which contain multiple CMP references could not be used. +

        +

        +
        Parameters:
        newCMP - a boolean value.
        +
        +
        +
        + +

        +setTempdir

        +
        +public void setTempdir(java.lang.String tempdir)
        +
        +
        The directory, where ejbdeploy will write temporary files; + optional, defaults to '_ejbdeploy_temp'. +

        +

        +
        Parameters:
        tempdir - the directory name to use.
        +
        +
        +
        + +

        +getDescriptorHandler

        +
        +protected DescriptorHandler getDescriptorHandler(java.io.File srcDir)
        +
        +
        Get a descriptionHandler.. +

        +

        +
        Overrides:
        getDescriptorHandler in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        srcDir - the source directory. +
        Returns:
        a handler.
        +
        +
        +
        + +

        +getWebsphereDescriptorHandler

        +
        +protected DescriptorHandler getWebsphereDescriptorHandler(java.io.File srcDir)
        +
        +
        Get a description handler. +

        +

        +
        Parameters:
        srcDir - the source directory. +
        Returns:
        the handler.
        +
        +
        +
        + +

        +addVendorFiles

        +
        +protected void addVendorFiles(java.util.Hashtable ejbFiles,
+                              java.lang.String baseName)
        +
        +
        Add any vendor specific files which should be included in the EJB Jar. +

        +

        +
        Overrides:
        addVendorFiles in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        ejbFiles - a hashtable entryname -> file.
        baseName - a prefix to use.
        +
        +
        +
        + +

        +getOptions

        +
        +protected java.lang.String getOptions()
        +
        +
        Gets the options for the EJB Deploy operation +

        +

        + +
        Returns:
        String
        +
        +
        +
        + +

        +writeJar

        +
        +protected void writeJar(java.lang.String baseName,
+                        java.io.File jarFile,
+                        java.util.Hashtable files,
+                        java.lang.String publicId)
+                 throws BuildException
        +
        +
        Method used to encapsulate the writing of the JAR file. Iterates over the + filenames/java.io.Files in the Hashtable stored on the instance variable + ejbFiles.. +

        +

        +
        Overrides:
        writeJar in class GenericDeploymentTool
        +
        +
        +
        Parameters:
        baseName - the base name to use.
        jarFile - the jar file to write to.
        files - the files to write to the jar.
        publicId - the id to use. +
        Throws: +
        BuildException - if there is a problem.
        +
        +
        +
        + +

        +validateConfigured

        +
        +public void validateConfigured()
+                        throws BuildException
        +
        +
        Called to validate that the tool parameters have been configured. +

        +

        +
        Specified by:
        validateConfigured in interface EJBDeploymentTool
        Overrides:
        validateConfigured in class GenericDeploymentTool
        +
        +
        + +
        Throws: +
        BuildException - if there is an error.
        +
        +
        +
        + +

        +isRebuildRequired

        +
        +protected boolean isRebuildRequired(java.io.File genericJarFile,
+                                    java.io.File websphereJarFile)
        +
        +
        Helper method to check to see if a websphere EBJ1.1 jar needs to be + rebuilt using ejbdeploy. Called from writeJar it sees if the "Bean" + classes are the only thing that needs to be updated and either updates + the Jar with the Bean classfile or returns true, saying that the whole + websphere jar needs to be regened with ejbdeploy. This allows faster + build times for working developers.

        + + The way websphere ejbdeploy works is it creates wrappers for the + publicly defined methods as they are exposed in the remote interface. + If the actual bean changes without changing the the method signatures + then only the bean classfile needs to be updated and the rest of the + websphere jar file can remain the same. If the Interfaces, ie. the + method signatures change or if the xml deployment descriptors changed, + the whole jar needs to be rebuilt with ejbdeploy. This is not strictly + true for the xml files. If the JNDI name changes then the jar doesnt + have to be rebuild, but if the resources references change then it + does. At this point the websphere jar gets rebuilt if the xml files + change at all. +

        +

        +
        Parameters:
        genericJarFile - java.io.File The generic jar file.
        websphereJarFile - java.io.File The websphere jar file to check to + see if it needs to be rebuilt. +
        Returns:
        true if a rebuild is required.
        +
        +
        +
        + +

        +getClassLoaderFromJar

        +
        +protected java.lang.ClassLoader getClassLoaderFromJar(java.io.File classjar)
+                                               throws java.io.IOException
        +
        +
        Helper method invoked by isRebuildRequired to get a ClassLoader for a + Jar File passed to it. +

        +

        +
        Parameters:
        classjar - java.io.File representing jar file to get classes from. +
        Returns:
        a classloader for the jar file. +
        Throws: +
        java.io.IOException - if there is an error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-frame.html new file mode 100644 index 000000000..60f7dc3ed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-frame.html @@ -0,0 +1,83 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ejb (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.ejb + + + + +
        +Interfaces  + +
        +EJBDeploymentTool
        + + + + + + +
        +Classes  + +
        +BorlandDeploymentTool +
        +BorlandGenerateClient +
        +DescriptorHandler +
        +EjbJar +
        +EjbJar.CMPVersion +
        +EjbJar.DTDLocation +
        +EjbJar.NamingScheme +
        +GenericDeploymentTool +
        +InnerClassFilenameFilter +
        +IPlanetDeploymentTool +
        +IPlanetEjbc +
        +IPlanetEjbcTask +
        +JbossDeploymentTool +
        +JonasDeploymentTool +
        +WeblogicDeploymentTool +
        +WeblogicTOPLinkDeploymentTool +
        +WebsphereDeploymentTool
        + + + + + + +
        +
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-summary.html new file mode 100644 index 000000000..65b6896c8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-summary.html @@ -0,0 +1,251 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ejb (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.ejb +

        + + + + + + + + + +
        +Interface Summary
        EJBDeploymentToolThe interface to implement for deployment tools.
        +  + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        BorlandDeploymentToolBorlandDeploymentTool is dedicated to the Borland Application Server 4.5 and 4.5.1 + This task generates and compiles the stubs and skeletons for all ejb described into the + Deployment Descriptor, builds the jar file including the support files and verify + whether the produced jar is valid or not.
        BorlandGenerateClientGenerates a Borland Application Server 4.5 client JAR using as + input the EJB JAR file.
        DescriptorHandlerInner class used by EjbJar to facilitate the parsing of deployment + descriptors and the capture of appropriate information.
        EjbJarProvides automated EJB JAR file creation.
        EjbJar.CMPVersionCMP versions supported + valid CMP versions are 1.0 and 2.0
        EjbJar.DTDLocationInner class used to record information about the location of a local DTD
        EjbJar.NamingSchemeAn EnumeratedAttribute class for handling different EJB jar naming + schemes
        GenericDeploymentToolA deployment tool which creates generic EJB jars.
        InnerClassFilenameFilterA filename filter for inner class files of a particular class.
        IPlanetDeploymentToolThis class is used to generate iPlanet Application Server (iAS) 6.0 stubs and + skeletons and build an EJB Jar file.
        IPlanetEjbcCompiles EJB stubs and skeletons for the iPlanet Application + Server (iAS).
        IPlanetEjbcTaskCompiles EJB stubs and skeletons for the iPlanet Application Server.
        JbossDeploymentToolThe deployment tool to add the jboss specific deployment descriptor to the ejb jar file.
        JonasDeploymentToolThe deployment tool to add the jonas specific deployment descriptors to the + ejb JAR file.
        WeblogicDeploymentToolThe weblogic element is used to control the weblogic.ejbc compiler for + generating weblogic EJB jars.
        WeblogicTOPLinkDeploymentToolDeployment tool for Weblogic TOPLink.
        WebsphereDeploymentToolWebsphere deployment tool that augments the ejbjar task.
        +  + +

        + + + + + +
        +Exception Summary
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-tree.html new file mode 100644 index 000000000..6ca8ee604 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/package-tree.html @@ -0,0 +1,181 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ejb Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.ejb +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        + +

        +Interface Hierarchy +

        + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatability.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatability.html new file mode 100644 index 000000000..092a21417 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatability.html @@ -0,0 +1,235 @@ + + + + + + +Compatability (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class Compatability

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.Compatability
+
        +
        +
        +
        public final class Compatability
        extends java.lang.Object
        + + +

        +Enum used in (@link Extension) to indicate the compatability + of one extension to another. See (@link Extension) for instances + of object. + + WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING + This file is from excalibur.extension package. Dont edit this file + directly as there is no unit tests to make sure it is operational + in ant. Edit file in excalibur and run tests there before changing + ants file. + WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING +

        + +

        +

        +
        See Also:
        Extension
        +
        + +

        + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringtoString() + +
        +          Return name of compatability level.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Return name of compatability level. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the name of compatability level
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.html new file mode 100644 index 000000000..841ccb868 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Compatibility.html @@ -0,0 +1,235 @@ + + + + + + +Compatibility (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class Compatibility

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.Compatibility
+
        +
        +
        +
        public final class Compatibility
        extends java.lang.Object
        + + +

        +Enum used in (@link Extension) to indicate the compatibility + of one extension to another. See (@link Extension) for instances + of object. + + WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING + This file is from excalibur.extension package. Dont edit this file + directly as there is no unit tests to make sure it is operational + in ant. Edit file in excalibur and run tests there before changing + ants file. + WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING +

        + +

        +

        +
        See Also:
        Extension
        +
        + +

        + + + + + + + + + + + + +
        +Method Summary
        + java.lang.StringtoString() + +
        +          Return name of compatibility level.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Return name of compatibility level. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the name of compatibility level
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/DeweyDecimal.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/DeweyDecimal.html new file mode 100644 index 000000000..4d942080b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/DeweyDecimal.html @@ -0,0 +1,268 @@ + + + + + + +DeweyDecimal (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class DeweyDecimal

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.util.DeweyDecimal
+      extended by org.apache.tools.ant.taskdefs.optional.extension.DeweyDecimal
+
        +
        +Deprecated. use org.apache.tools.ant.util.DeweyDecimal instead. + Deprecated since ant 1.8 +

        +

        +
        public final class DeweyDecimal
        extends DeweyDecimal
        + + +

        +Utility class to contain version numbers in "Dewey Decimal" + syntax. Numbers in the "Dewey Decimal" syntax consist of positive + decimal integers separated by periods ".". For example, "2.0" or + "1.2.3.4.5.6.7". This allows an extensible number to be used to + represent major, minor, micro, etc versions. The version number + must begin with a number. + + Original Implementation moved to org.apache.tools.ant.util.DeweyDecimal +

        + +

        +

        + +

        + + + + + + + + + + + + + + +
        +Constructor Summary
        DeweyDecimal(int[] components) + +
        +          Deprecated. Construct a DeweyDecimal from an array of integer components.
        DeweyDecimal(java.lang.String string) + +
        +          Deprecated. Construct a DeweyDecimal from string in DeweyDecimal format.
        +  + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.util.DeweyDecimal
        get, getSize, isEqual, isGreaterThan, isGreaterThanOrEqual, isLessThan, isLessThanOrEqual, toString
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +DeweyDecimal

        +
        +public DeweyDecimal(int[] components)
        +
        +
        Deprecated. 
        Construct a DeweyDecimal from an array of integer components. +

        +

        +
        Parameters:
        components - an array of integer components.
        +
        +
        + +

        +DeweyDecimal

        +
        +public DeweyDecimal(java.lang.String string)
+             throws java.lang.NumberFormatException
        +
        +
        Deprecated. 
        Construct a DeweyDecimal from string in DeweyDecimal format. +

        +

        +
        Parameters:
        string - the string in dewey decimal format +
        Throws: +
        java.lang.NumberFormatException - if string is malformed
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Extension.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Extension.html new file mode 100644 index 000000000..6ddab8b39 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Extension.html @@ -0,0 +1,935 @@ + + + + + + +Extension (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class Extension

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.Extension
+
        +
        +
        +
        public final class Extension
        extends java.lang.Object
        + + +

        +

        Utility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.

        + +

        For more information about optional packages, see the document + Optional Package Versioning in the documentation bundle for your + Java2 Standard Edition package, in file + guide/extensions/versioning.html.

        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static CompatibilityCOMPATIBLE + +
        +          Enum indicating that extension is compatible with other extension.
        +static java.util.jar.Attributes.NameEXTENSION_LIST + +
        +          Manifest Attribute Name object for EXTENSION_LIST.
        +static java.util.jar.Attributes.NameEXTENSION_NAME + +
        +          Manifest Attribute Name object for EXTENSION_NAME.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_URL + +
        +          Manifest Attribute Name object for IMPLEMENTATION_URL.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_VENDOR + +
        +          Manifest Attribute Name object for IMPLEMENTATION_VENDOR.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_VENDOR_ID + +
        +          Manifest Attribute Name object for IMPLEMENTATION_VENDOR_ID.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_VERSION + +
        +          Manifest Attribute Name object for IMPLEMENTATION_VERSION.
        +static CompatibilityINCOMPATIBLE + +
        +          Enum indicating that extension is incompatible with + other extension in ways other than other enums + indicate).
        +static java.util.jar.Attributes.NameOPTIONAL_EXTENSION_LIST + +
        +          Name object for Optional-Extension-List + manifest attribute used for declaring optional dependencies on + installed extensions.
        +static CompatibilityREQUIRE_IMPLEMENTATION_UPGRADE + +
        +          Enum indicating that extension requires an upgrade + of implementation to be compatible with other extension.
        +static CompatibilityREQUIRE_SPECIFICATION_UPGRADE + +
        +          Enum indicating that extension requires an upgrade + of specification to be compatible with other extension.
        +static CompatibilityREQUIRE_VENDOR_SWITCH + +
        +          Enum indicating that extension requires a vendor + switch to be compatible with other extension.
        +static java.util.jar.Attributes.NameSPECIFICATION_VENDOR + +
        +          Manifest Attribute Name object for SPECIFICATION_VENDOR.
        +static java.util.jar.Attributes.NameSPECIFICATION_VERSION + +
        +          Manifest Attribute Name object for SPECIFICATION_VERSION.
        +  + + + + + + + + + + +
        +Constructor Summary
        Extension(java.lang.String extensionName, + java.lang.String specificationVersion, + java.lang.String specificationVendor, + java.lang.String implementationVersion, + java.lang.String implementationVendor, + java.lang.String implementationVendorId, + java.lang.String implementationURL) + +
        +          The constructor to create Extension object.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        +static voidaddExtension(Extension extension, + java.util.jar.Attributes attributes) + +
        +          Add Extension to the specified manifest Attributes.
        +static voidaddExtension(Extension extension, + java.lang.String prefix, + java.util.jar.Attributes attributes) + +
        +          Add Extension to the specified manifest Attributes.
        +static Extension[]getAvailable(java.util.jar.Manifest manifest) + +
        +          Return an array of Extension objects representing optional + packages that are available in the JAR file associated with the + specified Manifest.
        + CompatibilitygetCompatibilityWith(Extension required) + +
        +          Return a Compatibility enum indicating the relationship of this + Extension with the specified Extension.
        + java.lang.StringgetExtensionName() + +
        +          Get the name of the extension.
        + java.lang.StringgetImplementationURL() + +
        +          Get the url of the extensions implementation.
        + java.lang.StringgetImplementationVendor() + +
        +          Get the vendor of the extensions implementation.
        + java.lang.StringgetImplementationVendorID() + +
        +          Get the vendorID of the extensions implementation.
        + DeweyDecimalgetImplementationVersion() + +
        +          Get the version of the extensions implementation.
        +static Extension[]getOptions(java.util.jar.Manifest manifest) + +
        +          Return the set of Extension objects representing "Optional + Packages" that the application declares they will use if present.
        +static Extension[]getRequired(java.util.jar.Manifest manifest) + +
        +          Return the set of Extension objects representing optional + packages that are required by the application contained in the JAR + file associated with the specified Manifest.
        + java.lang.StringgetSpecificationVendor() + +
        +          Get the vendor of the extensions specification.
        + DeweyDecimalgetSpecificationVersion() + +
        +          Get the version of the extensions specification.
        + booleanisCompatibleWith(Extension required) + +
        +          Return true if the specified Extension + (which represents an optional package required by an application) + is satisfied by this Extension (which represents an + optional package that is already installed.
        + java.lang.StringtoString() + +
        +          Return a String representation of this object.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +EXTENSION_LIST

        +
        +public static final java.util.jar.Attributes.Name EXTENSION_LIST
        +
        +
        Manifest Attribute Name object for EXTENSION_LIST. +

        +

        +
        +
        +
        + +

        +OPTIONAL_EXTENSION_LIST

        +
        +public static final java.util.jar.Attributes.Name OPTIONAL_EXTENSION_LIST
        +
        +
        Name object for Optional-Extension-List + manifest attribute used for declaring optional dependencies on + installed extensions. Note that the dependencies declared by this method + are not required for the library to operate but if present will be used. + It is NOT part of the official "Optional Package" specification. +

        +

        +
        See Also:
        + Installed extension dependency
        +
        +
        + +

        +EXTENSION_NAME

        +
        +public static final java.util.jar.Attributes.Name EXTENSION_NAME
        +
        +
        Manifest Attribute Name object for EXTENSION_NAME. +

        +

        +
        +
        +
        + +

        +SPECIFICATION_VERSION

        +
        +public static final java.util.jar.Attributes.Name SPECIFICATION_VERSION
        +
        +
        Manifest Attribute Name object for SPECIFICATION_VERSION. +

        +

        +
        +
        +
        + +

        +SPECIFICATION_VENDOR

        +
        +public static final java.util.jar.Attributes.Name SPECIFICATION_VENDOR
        +
        +
        Manifest Attribute Name object for SPECIFICATION_VENDOR. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_VERSION

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_VERSION
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_VERSION. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_VENDOR

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_VENDOR
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_VENDOR. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_URL

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_URL
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_URL. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_VENDOR_ID

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_VENDOR_ID
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_VENDOR_ID. +

        +

        +
        +
        +
        + +

        +COMPATIBLE

        +
        +public static final Compatibility COMPATIBLE
        +
        +
        Enum indicating that extension is compatible with other extension. +

        +

        +
        +
        +
        + +

        +REQUIRE_SPECIFICATION_UPGRADE

        +
        +public static final Compatibility REQUIRE_SPECIFICATION_UPGRADE
        +
        +
        Enum indicating that extension requires an upgrade + of specification to be compatible with other extension. +

        +

        +
        +
        +
        + +

        +REQUIRE_VENDOR_SWITCH

        +
        +public static final Compatibility REQUIRE_VENDOR_SWITCH
        +
        +
        Enum indicating that extension requires a vendor + switch to be compatible with other extension. +

        +

        +
        +
        +
        + +

        +REQUIRE_IMPLEMENTATION_UPGRADE

        +
        +public static final Compatibility REQUIRE_IMPLEMENTATION_UPGRADE
        +
        +
        Enum indicating that extension requires an upgrade + of implementation to be compatible with other extension. +

        +

        +
        +
        +
        + +

        +INCOMPATIBLE

        +
        +public static final Compatibility INCOMPATIBLE
        +
        +
        Enum indicating that extension is incompatible with + other extension in ways other than other enums + indicate). For example the other extension may have + a different ID. +

        +

        +
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +Extension

        +
        +public Extension(java.lang.String extensionName,
+                 java.lang.String specificationVersion,
+                 java.lang.String specificationVendor,
+                 java.lang.String implementationVersion,
+                 java.lang.String implementationVendor,
+                 java.lang.String implementationVendorId,
+                 java.lang.String implementationURL)
        +
        +
        The constructor to create Extension object. + Note that every component is allowed to be specified + but only the extensionName is mandatory. +

        +

        +
        Parameters:
        extensionName - the name of extension.
        specificationVersion - the specification Version of extension.
        specificationVendor - the specification Vendor of extension.
        implementationVersion - the implementation Version of extension.
        implementationVendor - the implementation Vendor of extension.
        implementationVendorId - the implementation VendorId of extension.
        implementationURL - the implementation URL of extension.
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getAvailable

        +
        +public static Extension[] getAvailable(java.util.jar.Manifest manifest)
        +
        +
        Return an array of Extension objects representing optional + packages that are available in the JAR file associated with the + specified Manifest. If there are no such optional + packages, a zero-length array is returned. +

        +

        +
        Parameters:
        manifest - Manifest to be parsed +
        Returns:
        the "available" extensions in specified manifest
        +
        +
        +
        + +

        +getRequired

        +
        +public static Extension[] getRequired(java.util.jar.Manifest manifest)
        +
        +
        Return the set of Extension objects representing optional + packages that are required by the application contained in the JAR + file associated with the specified Manifest. If there + are no such optional packages, a zero-length list is returned. +

        +

        +
        Parameters:
        manifest - Manifest to be parsed +
        Returns:
        the dependencies that are specified in manifes
        +
        +
        +
        + +

        +getOptions

        +
        +public static Extension[] getOptions(java.util.jar.Manifest manifest)
        +
        +
        Return the set of Extension objects representing "Optional + Packages" that the application declares they will use if present. If + there are no such optional packages, a zero-length list is returned. +

        +

        +
        Parameters:
        manifest - Manifest to be parsed +
        Returns:
        the optional dependencies that are specified in manifest
        +
        +
        +
        + +

        +addExtension

        +
        +public static void addExtension(Extension extension,
+                                java.util.jar.Attributes attributes)
        +
        +
        Add Extension to the specified manifest Attributes. +

        +

        +
        Parameters:
        attributes - the attributes of manifest to add to
        extension - the extension
        +
        +
        +
        + +

        +addExtension

        +
        +public static void addExtension(Extension extension,
+                                java.lang.String prefix,
+                                java.util.jar.Attributes attributes)
        +
        +
        Add Extension to the specified manifest Attributes. + Use the specified prefix so that dependencies can added + with a prefix such as "java3d-" etc. +

        +

        +
        Parameters:
        attributes - the attributes of manifest to add to
        extension - the extension
        prefix - the name to prefix to extension
        +
        +
        +
        + +

        +getExtensionName

        +
        +public java.lang.String getExtensionName()
        +
        +
        Get the name of the extension. +

        +

        + +
        Returns:
        the name of the extension
        +
        +
        +
        + +

        +getSpecificationVendor

        +
        +public java.lang.String getSpecificationVendor()
        +
        +
        Get the vendor of the extensions specification. +

        +

        + +
        Returns:
        the vendor of the extensions specification.
        +
        +
        +
        + +

        +getSpecificationVersion

        +
        +public DeweyDecimal getSpecificationVersion()
        +
        +
        Get the version of the extensions specification. +

        +

        + +
        Returns:
        the version of the extensions specification.
        +
        +
        +
        + +

        +getImplementationURL

        +
        +public java.lang.String getImplementationURL()
        +
        +
        Get the url of the extensions implementation. +

        +

        + +
        Returns:
        the url of the extensions implementation.
        +
        +
        +
        + +

        +getImplementationVendor

        +
        +public java.lang.String getImplementationVendor()
        +
        +
        Get the vendor of the extensions implementation. +

        +

        + +
        Returns:
        the vendor of the extensions implementation.
        +
        +
        +
        + +

        +getImplementationVendorID

        +
        +public java.lang.String getImplementationVendorID()
        +
        +
        Get the vendorID of the extensions implementation. +

        +

        + +
        Returns:
        the vendorID of the extensions implementation.
        +
        +
        +
        + +

        +getImplementationVersion

        +
        +public DeweyDecimal getImplementationVersion()
        +
        +
        Get the version of the extensions implementation. +

        +

        + +
        Returns:
        the version of the extensions implementation.
        +
        +
        +
        + +

        +getCompatibilityWith

        +
        +public Compatibility getCompatibilityWith(Extension required)
        +
        +
        Return a Compatibility enum indicating the relationship of this + Extension with the specified Extension. +

        +

        +
        Parameters:
        required - Description of the required optional package +
        Returns:
        the enum indicating the compatibility (or lack thereof) + of specifed extension
        +
        +
        +
        + +

        +isCompatibleWith

        +
        +public boolean isCompatibleWith(Extension required)
        +
        +
        Return true if the specified Extension + (which represents an optional package required by an application) + is satisfied by this Extension (which represents an + optional package that is already installed. Otherwise, return + false. +

        +

        +
        Parameters:
        required - Description of the required optional package +
        Returns:
        true if the specified extension is compatible with this extension
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Return a String representation of this object. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        string representation of object.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.html new file mode 100644 index 000000000..aee9bb581 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionAdapter.html @@ -0,0 +1,487 @@ + + + + + + +ExtensionAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class ExtensionAdapter

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.taskdefs.optional.extension.ExtensionAdapter
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class ExtensionAdapter
        extends DataType
        + + +

        +Simple class that represents an Extension and conforms to Ants + patterns. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.types.DataType
        checked, ref
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        ExtensionAdapter() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidsetExtensionName(java.lang.String extensionName) + +
        +          Set the name of extension.
        + voidsetImplementationUrl(java.lang.String implementationURL) + +
        +          Set the implementationURL of extension.
        + voidsetImplementationVendor(java.lang.String implementationVendor) + +
        +          Set the implementationVendor of extension.
        + voidsetImplementationVendorId(java.lang.String implementationVendorID) + +
        +          Set the implementationVendorID of extension.
        + voidsetImplementationVersion(java.lang.String implementationVersion) + +
        +          Set the implementationVersion of extension.
        + voidsetRefid(Reference reference) + +
        +          Makes this instance in effect a reference to another ExtensionAdapter + instance.
        + voidsetSpecificationVendor(java.lang.String specificationVendor) + +
        +          Set the specificationVendor of extension.
        + voidsetSpecificationVersion(java.lang.String specificationVersion) + +
        +          Set the specificationVersion of extension.
        + java.lang.StringtoString() + +
        +          a debug toString method.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.DataType
        checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ExtensionAdapter

        +
        +public ExtensionAdapter()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setExtensionName

        +
        +public void setExtensionName(java.lang.String extensionName)
        +
        +
        Set the name of extension. +

        +

        +
        Parameters:
        extensionName - the name of extension
        +
        +
        +
        + +

        +setSpecificationVersion

        +
        +public void setSpecificationVersion(java.lang.String specificationVersion)
        +
        +
        Set the specificationVersion of extension. +

        +

        +
        Parameters:
        specificationVersion - the specificationVersion of extension
        +
        +
        +
        + +

        +setSpecificationVendor

        +
        +public void setSpecificationVendor(java.lang.String specificationVendor)
        +
        +
        Set the specificationVendor of extension. +

        +

        +
        Parameters:
        specificationVendor - the specificationVendor of extension
        +
        +
        +
        + +

        +setImplementationVendorId

        +
        +public void setImplementationVendorId(java.lang.String implementationVendorID)
        +
        +
        Set the implementationVendorID of extension. +

        +

        +
        Parameters:
        implementationVendorID - the implementationVendorID of extension
        +
        +
        +
        + +

        +setImplementationVendor

        +
        +public void setImplementationVendor(java.lang.String implementationVendor)
        +
        +
        Set the implementationVendor of extension. +

        +

        +
        Parameters:
        implementationVendor - the implementationVendor of extension
        +
        +
        +
        + +

        +setImplementationVersion

        +
        +public void setImplementationVersion(java.lang.String implementationVersion)
        +
        +
        Set the implementationVersion of extension. +

        +

        +
        Parameters:
        implementationVersion - the implementationVersion of extension
        +
        +
        +
        + +

        +setImplementationUrl

        +
        +public void setImplementationUrl(java.lang.String implementationURL)
        +
        +
        Set the implementationURL of extension. +

        +

        +
        Parameters:
        implementationURL - the implementationURL of extension
        +
        +
        +
        + +

        +setRefid

        +
        +public void setRefid(Reference reference)
+              throws BuildException
        +
        +
        Makes this instance in effect a reference to another ExtensionAdapter + instance. + +

        You must not set another attribute or nest elements inside + this element if you make it a reference.

        +

        +

        +
        Overrides:
        setRefid in class DataType
        +
        +
        +
        Parameters:
        reference - the reference to which this instance is associated +
        Throws: +
        BuildException - if this instance already has been configured.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        a debug toString method. +

        +

        +
        Overrides:
        toString in class DataType
        +
        +
        + +
        Returns:
        the extension in a string.
        See Also:
        Object.toString()
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.html new file mode 100644 index 000000000..ca78530d1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionResolver.html @@ -0,0 +1,220 @@ + + + + + + +ExtensionResolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Interface ExtensionResolver

        +
        +
        All Known Implementing Classes:
        AntResolver, LocationResolver, URLResolver
        +
        +
        +
        +
        public interface ExtensionResolver
        + + +

        +Interface to locate a File that satisfies extension. +

        + +

        +

        + +

        + + + + + + + + + + + + +
        +Method Summary
        + java.io.Fileresolve(Extension extension, + Project project) + +
        +          Attempt to locate File that satisfies + extension via resolver.
        +  +

        + + + + + + + + +
        +Method Detail
        + +

        +resolve

        +
        +java.io.File resolve(Extension extension,
+                     Project project)
+                     throws BuildException
        +
        +
        Attempt to locate File that satisfies + extension via resolver. +

        +

        +
        Parameters:
        extension - the extension
        project - the Ant project instance +
        Returns:
        the File satisfying extension, null + if can not resolve extension +
        Throws: +
        BuildException - if error occurs attempting to + resolve extension
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.html new file mode 100644 index 000000000..4b6033467 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionSet.html @@ -0,0 +1,474 @@ + + + + + + +ExtensionSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class ExtensionSet

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.taskdefs.optional.extension.ExtensionSet
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class ExtensionSet
        extends DataType
        + + +

        +The Extension set lists a set of "Optional Packages" / + "Extensions". +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.types.DataType
        checked, ref
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        ExtensionSet() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddExtension(ExtensionAdapter extensionAdapter) + +
        +          Adds an extension that this library requires.
        + voidaddFileset(FileSet fileSet) + +
        +          Adds a set of files about which extensions data will be extracted.
        + voidaddLibfileset(LibFileSet fileSet) + +
        +          Adds a set of files about which extensions data will be extracted.
        +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
        +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
        + voidsetRefid(Reference reference) + +
        +          Makes this instance in effect a reference to another ExtensionSet + instance.
        + Extension[]toExtensions(Project proj) + +
        +          Extract a set of Extension objects from the ExtensionSet.
        + java.lang.StringtoString() + +
        +          Basic DataType toString().
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.DataType
        checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ExtensionSet

        +
        +public ExtensionSet()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +addExtension

        +
        +public void addExtension(ExtensionAdapter extensionAdapter)
        +
        +
        Adds an extension that this library requires. +

        +

        +
        Parameters:
        extensionAdapter - an extension that this library requires.
        +
        +
        +
        + +

        +addLibfileset

        +
        +public void addLibfileset(LibFileSet fileSet)
        +
        +
        Adds a set of files about which extensions data will be extracted. +

        +

        +
        Parameters:
        fileSet - a set of files about which extensions data will be extracted.
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet fileSet)
        +
        +
        Adds a set of files about which extensions data will be extracted. +

        +

        +
        Parameters:
        fileSet - a set of files about which extensions data will be extracted.
        +
        +
        +
        + +

        +toExtensions

        +
        +public Extension[] toExtensions(Project proj)
+                         throws BuildException
        +
        +
        Extract a set of Extension objects from the ExtensionSet. +

        +

        +
        Parameters:
        proj - the project instance. +
        Returns:
        an array containing the Extensions from this set +
        Throws: +
        BuildException - if an error occurs
        +
        +
        +
        + +

        +setRefid

        +
        +public void setRefid(Reference reference)
+              throws BuildException
        +
        +
        Makes this instance in effect a reference to another ExtensionSet + instance. + +

        You must not set another attribute or nest elements inside + this element if you make it a reference.

        +

        +

        +
        Overrides:
        setRefid in class DataType
        +
        +
        +
        Parameters:
        reference - the reference to which this instance is associated +
        Throws: +
        BuildException - if this instance already has been configured.
        +
        +
        +
        + +

        +dieOnCircularReference

        +
        +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
        +
        +
        Description copied from class: DataType
        +
        Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

        If one is included, throw a BuildException created by circularReference.

        + +

        This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

        + +

        The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

        +

        +

        +
        Overrides:
        dieOnCircularReference in class DataType
        +
        +
        +
        Parameters:
        stk - the stack of references to check.
        p - the project to use to dereference the references. +
        Throws: +
        BuildException - on error.
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Description copied from class: DataType
        +
        Basic DataType toString(). +

        +

        +
        Overrides:
        toString in class DataType
        +
        +
        + +
        Returns:
        the extensions in a string.
        See Also:
        Object.toString()
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.html new file mode 100644 index 000000000..485328db5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtensionUtil.html @@ -0,0 +1,190 @@ + + + + + + +ExtensionUtil (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class ExtensionUtil

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.ExtensionUtil
+
        +
        +
        +
        public final class ExtensionUtil
        extends java.lang.Object
        + + +

        +A set of useful methods relating to extensions. +

        + +

        +

        + +

        + + + + + + + + +
        +Method Summary
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + +

        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.html new file mode 100644 index 000000000..d0534279e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/ExtraAttribute.html @@ -0,0 +1,305 @@ + + + + + + +ExtraAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class ExtraAttribute

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.ExtraAttribute
+
        +
        +
        +
        public class ExtraAttribute
        extends java.lang.Object
        + + +

        +Simple holder for extra attributes in main section of manifest. +

        + +

        +

        +
        To do:
        +
        Refactor this and all the other parameter, sysproperty, + property etc into a single class in framework
        +
        +
        + +

        + + + + + + + + + + + +
        +Constructor Summary
        ExtraAttribute() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidsetName(java.lang.String name) + +
        +          Set the name of the parameter.
        + voidsetValue(java.lang.String value) + +
        +          Set the value of the parameter.
        + voidvalidate() + +
        +          Make sure that neither the name or the value + is null.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +ExtraAttribute

        +
        +public ExtraAttribute()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setName

        +
        +public void setName(java.lang.String name)
        +
        +
        Set the name of the parameter. +

        +

        +
        Parameters:
        name - the name of parameter
        +
        +
        +
        + +

        +setValue

        +
        +public void setValue(java.lang.String value)
        +
        +
        Set the value of the parameter. +

        +

        +
        Parameters:
        value - the parameter value
        +
        +
        +
        + +

        +validate

        +
        +public void validate()
+              throws BuildException
        +
        +
        Make sure that neither the name or the value + is null. +

        +

        + +
        Throws: +
        BuildException - if the attribute is invalid.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.html new file mode 100644 index 000000000..e6de1c863 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibAvailableTask.html @@ -0,0 +1,393 @@ + + + + + + +JarLibAvailableTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class JarLibAvailableTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.extension.JarLibAvailableTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class JarLibAvailableTask
        extends Task
        + + +

        +Checks whether an extension is present in a fileset or an extensionSet. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        JarLibAvailableTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfiguredExtension(ExtensionAdapter extension) + +
        +          Set the Extension looking for.
        + voidaddConfiguredExtensionSet(ExtensionSet extensionSet) + +
        +          Adds a set of extensions to search in.
        + voidexecute() + +
        +          Execute the task.
        + voidsetFile(java.io.File file) + +
        +          The JAR library to check.
        + voidsetProperty(java.lang.String property) + +
        +          The name of property to set if extensions are available.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +JarLibAvailableTask

        +
        +public JarLibAvailableTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setProperty

        +
        +public void setProperty(java.lang.String property)
        +
        +
        The name of property to set if extensions are available. +

        +

        +
        Parameters:
        property - The name of property to set if extensions is available.
        +
        +
        +
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        The JAR library to check. +

        +

        +
        Parameters:
        file - The jar library to check.
        +
        +
        +
        + +

        +addConfiguredExtension

        +
        +public void addConfiguredExtension(ExtensionAdapter extension)
        +
        +
        Set the Extension looking for. +

        +

        +
        Parameters:
        extension - Set the Extension looking for.
        +
        +
        +
        + +

        +addConfiguredExtensionSet

        +
        +public void addConfiguredExtensionSet(ExtensionSet extensionSet)
        +
        +
        Adds a set of extensions to search in. +

        +

        +
        Parameters:
        extensionSet - a set of extensions to search in.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if somethign goes wrong.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.html new file mode 100644 index 000000000..9d83dd79f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibDisplayTask.html @@ -0,0 +1,359 @@ + + + + + + +JarLibDisplayTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class JarLibDisplayTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.extension.JarLibDisplayTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class JarLibDisplayTask
        extends Task
        + + +

        +Displays the "Optional Package" and "Package Specification" information + contained within the specified JARs. + +

        Prior to JDK1.3, an "Optional Package" was known as an Extension. + The specification for this mechanism is available in the JDK1.3 + documentation in the directory + $JDK_HOME/docs/guide/extensions/versioning.html. Alternatively it is + available online at + http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html.

        +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        JarLibDisplayTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddFileset(FileSet fileSet) + +
        +          Adds a set of files about which library data will be displayed.
        + voidexecute() + +
        +          Execute the task.
        + voidsetFile(java.io.File file) + +
        +          The JAR library to display information for.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +JarLibDisplayTask

        +
        +public JarLibDisplayTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setFile

        +
        +public void setFile(java.io.File file)
        +
        +
        The JAR library to display information for. +

        +

        +
        Parameters:
        file - The jar library to display information for.
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet fileSet)
        +
        +
        Adds a set of files about which library data will be displayed. +

        +

        +
        Parameters:
        fileSet - a set of files about which library data will be displayed.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the task fails.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.html new file mode 100644 index 000000000..8b8259e97 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibManifestTask.html @@ -0,0 +1,428 @@ + + + + + + +JarLibManifestTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class JarLibManifestTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.extension.JarLibManifestTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public final class JarLibManifestTask
        extends Task
        + + +

        +Generates a manifest that declares all the dependencies. + The dependencies are determined by looking in the + specified path and searching for Extension / "Optional Package" + specifications in the manifests of the jars. + +

        Prior to JDK1.3, an "Optional Package" was known as an Extension. + The specification for this mechanism is available in the JDK1.3 + documentation in the directory + $JDK_HOME/docs/guide/extensions/versioning.html. Alternatively it is + available online at + http://java.sun.com/j2se/1.3/docs/guide/extensions/versioning.html.

        +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        JarLibManifestTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfiguredAttribute(ExtraAttribute attribute) + +
        +          Adds an attribute that is to be put in main section of manifest.
        + voidaddConfiguredDepends(ExtensionSet extensionSet) + +
        +          Adds a set of extensions that this library requires.
        + voidaddConfiguredExtension(ExtensionAdapter extensionAdapter) + +
        +          Adds an extension that this library implements.
        + voidaddConfiguredOptions(ExtensionSet extensionSet) + +
        +          Adds a set of extensions that this library optionally requires.
        + voidexecute() + +
        +          Execute the task.
        + voidsetDestfile(java.io.File destFile) + +
        +          The location where generated manifest is placed.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +JarLibManifestTask

        +
        +public JarLibManifestTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setDestfile

        +
        +public void setDestfile(java.io.File destFile)
        +
        +
        The location where generated manifest is placed. +

        +

        +
        Parameters:
        destFile - The location where generated manifest is placed.
        +
        +
        +
        + +

        +addConfiguredExtension

        +
        +public void addConfiguredExtension(ExtensionAdapter extensionAdapter)
+                            throws BuildException
        +
        +
        Adds an extension that this library implements. +

        +

        +
        Parameters:
        extensionAdapter - an extension that this library implements. +
        Throws: +
        BuildException - if there is multiple extensions detected + in the library.
        +
        +
        +
        + +

        +addConfiguredDepends

        +
        +public void addConfiguredDepends(ExtensionSet extensionSet)
        +
        +
        Adds a set of extensions that this library requires. +

        +

        +
        Parameters:
        extensionSet - a set of extensions that this library requires.
        +
        +
        +
        + +

        +addConfiguredOptions

        +
        +public void addConfiguredOptions(ExtensionSet extensionSet)
        +
        +
        Adds a set of extensions that this library optionally requires. +

        +

        +
        Parameters:
        extensionSet - a set of extensions that this library optionally requires.
        +
        +
        +
        + +

        +addConfiguredAttribute

        +
        +public void addConfiguredAttribute(ExtraAttribute attribute)
        +
        +
        Adds an attribute that is to be put in main section of manifest. +

        +

        +
        Parameters:
        attribute - an attribute that is to be put in main section of manifest.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the task fails.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.html new file mode 100644 index 000000000..acfba1cc3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/JarLibResolveTask.html @@ -0,0 +1,465 @@ + + + + + + +JarLibResolveTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class JarLibResolveTask

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.extension.JarLibResolveTask
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable
        +
        +
        +
        +
        public class JarLibResolveTask
        extends Task
        + + +

        +Tries to locate a JAR to satisfy an extension and place + location of JAR into property. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        JarLibResolveTask() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddConfiguredAnt(AntResolver ant) + +
        +          Adds Ant resolver to run an Ant build file to generate a library.
        + voidaddConfiguredExtension(ExtensionAdapter extension) + +
        +          Set the Extension looking for.
        + voidaddConfiguredLocation(LocationResolver loc) + +
        +          Adds location resolver to look for a library in a location + relative to project directory.
        + voidaddConfiguredUrl(URLResolver url) + +
        +          Adds a URL resolver to download a library from a URL + to a local file.
        + voidexecute() + +
        +          Execute the task.
        + voidsetCheckExtension(boolean checkExtension) + +
        +          Check nested libraries for extensions
        + voidsetFailOnError(boolean failOnError) + +
        +          Set whether to fail if error.
        + voidsetProperty(java.lang.String property) + +
        +          The name of the property in which the location of + library is stored.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +JarLibResolveTask

        +
        +public JarLibResolveTask()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setProperty

        +
        +public void setProperty(java.lang.String property)
        +
        +
        The name of the property in which the location of + library is stored. +

        +

        +
        Parameters:
        property - The name of the property in which the location of + library is stored.
        +
        +
        +
        + +

        +setCheckExtension

        +
        +public void setCheckExtension(boolean checkExtension)
        +
        +
        Check nested libraries for extensions +

        +

        +
        Parameters:
        checkExtension - if true, libraries returned by nested + resolvers should be checked to see if they supply extension.
        +
        +
        +
        + +

        +setFailOnError

        +
        +public void setFailOnError(boolean failOnError)
        +
        +
        Set whether to fail if error. +

        +

        +
        Parameters:
        failOnError - if true, failure to locate library should fail build.
        +
        +
        +
        + +

        +addConfiguredLocation

        +
        +public void addConfiguredLocation(LocationResolver loc)
        +
        +
        Adds location resolver to look for a library in a location + relative to project directory. +

        +

        +
        Parameters:
        loc - the resolver location to search.
        +
        +
        +
        + +

        +addConfiguredUrl

        +
        +public void addConfiguredUrl(URLResolver url)
        +
        +
        Adds a URL resolver to download a library from a URL + to a local file. +

        +

        +
        Parameters:
        url - the URL resolver from which to download the library
        +
        +
        +
        + +

        +addConfiguredAnt

        +
        +public void addConfiguredAnt(AntResolver ant)
        +
        +
        Adds Ant resolver to run an Ant build file to generate a library. +

        +

        +
        Parameters:
        ant - the AntResolver to generate the library.
        +
        +
        +
        + +

        +addConfiguredExtension

        +
        +public void addConfiguredExtension(ExtensionAdapter extension)
        +
        +
        Set the Extension looking for. +

        +

        +
        Parameters:
        extension - Set the Extension looking for.
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Execute the task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the task fails.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.html new file mode 100644 index 000000000..a81124f1f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/LibFileSet.html @@ -0,0 +1,373 @@ + + + + + + +LibFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class LibFileSet

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.taskdefs.optional.extension.LibFileSet
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, ResourceCollection, SelectorContainer
        +
        +
        +
        +
        public class LibFileSet
        extends FileSet
        + + +

        +LibFileSet represents a fileset containing libraries. + Asociated with the libraries is data pertaining to + how they are to be handled when building manifests. +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.types.DataType
        checked, ref
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        LibFileSet() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidsetIncludeImpl(boolean includeImpl) + +
        +          Flag indicating whether should include the + "Implementation-*" attributes in manifest.
        + voidsetIncludeUrl(boolean includeURL) + +
        +          Flag indicating whether should include the + "Implementation-URL" attribute in manifest.
        + voidsetUrlBase(java.lang.String urlBase) + +
        +          Set the url base for fileset.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.FileSet
        clone, isFilesystemOnly, iterator, size
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.types.DataType
        checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +LibFileSet

        +
        +public LibFileSet()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setIncludeUrl

        +
        +public void setIncludeUrl(boolean includeURL)
        +
        +
        Flag indicating whether should include the + "Implementation-URL" attribute in manifest. + Defaults to false. +

        +

        +
        Parameters:
        includeURL - the flag
        +
        +
        +
        + +

        +setIncludeImpl

        +
        +public void setIncludeImpl(boolean includeImpl)
        +
        +
        Flag indicating whether should include the + "Implementation-*" attributes in manifest. + Defaults to false. +

        +

        +
        Parameters:
        includeImpl - the flag
        +
        +
        +
        + +

        +setUrlBase

        +
        +public void setUrlBase(java.lang.String urlBase)
        +
        +
        Set the url base for fileset. +

        +

        +
        Parameters:
        urlBase - the base url
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Specification.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Specification.html new file mode 100644 index 000000000..b4077daf6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/Specification.html @@ -0,0 +1,799 @@ + + + + + + +Specification (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension +
        +Class Specification

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.Specification
+
        +
        +
        +
        public final class Specification
        extends java.lang.Object
        + + +

        +

        Utility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.

        + +

        For more information about optional packages, see the document + Optional Package Versioning in the documentation bundle for your + Java2 Standard Edition package, in file + guide/extensions/versioning.html.

        +

        + +

        +

        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +static CompatibilityCOMPATIBLE + +
        +          Enum indicating that extension is compatible with other Package + Specification.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_TITLE + +
        +          Manifest Attribute Name object for IMPLEMENTATION_TITLE.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_VENDOR + +
        +          Manifest Attribute Name object for IMPLEMENTATION_VENDOR.
        +static java.util.jar.Attributes.NameIMPLEMENTATION_VERSION + +
        +          Manifest Attribute Name object for IMPLEMENTATION_VERSION.
        +static CompatibilityINCOMPATIBLE + +
        +          This enum indicates that an extension is incompatible with + other Package Specification in ways other than other enums + indicate.
        +static CompatibilityREQUIRE_IMPLEMENTATION_CHANGE + +
        +          Enum indicating that extension requires an upgrade + of implementation to be compatible with other Package Specification.
        +static CompatibilityREQUIRE_SPECIFICATION_UPGRADE + +
        +          Enum indicating that extension requires an upgrade + of specification to be compatible with other Package Specification.
        +static CompatibilityREQUIRE_VENDOR_SWITCH + +
        +          Enum indicating that extension requires a vendor + switch to be compatible with other Package Specification.
        +static java.util.jar.Attributes.NameSPECIFICATION_TITLE + +
        +          Manifest Attribute Name object for SPECIFICATION_TITLE.
        +static java.util.jar.Attributes.NameSPECIFICATION_VENDOR + +
        +          Manifest Attribute Name object for SPECIFICATION_VENDOR.
        +static java.util.jar.Attributes.NameSPECIFICATION_VERSION + +
        +          Manifest Attribute Name object for SPECIFICATION_VERSION.
        +  + + + + + + + + + + + + + +
        +Constructor Summary
        Specification(java.lang.String specificationTitle, + java.lang.String specificationVersion, + java.lang.String specificationVendor, + java.lang.String implementationTitle, + java.lang.String implementationVersion, + java.lang.String implementationVendor) + +
        +          The constructor to create Package Specification object.
        Specification(java.lang.String specificationTitle, + java.lang.String specificationVersion, + java.lang.String specificationVendor, + java.lang.String implementationTitle, + java.lang.String implementationVersion, + java.lang.String implementationVendor, + java.lang.String[] sections) + +
        +          The constructor to create Package Specification object.
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + CompatibilitygetCompatibilityWith(Specification other) + +
        +          Return a Compatibility enum indicating the relationship of this + Package Specification with the specified + Extension.
        + java.lang.StringgetImplementationTitle() + +
        +          Get the title of the specification.
        + java.lang.StringgetImplementationVendor() + +
        +          Get the vendor of the extensions implementation.
        + java.lang.StringgetImplementationVersion() + +
        +          Get the version of the implementation.
        + java.lang.String[]getSections() + +
        +          Return an array containing sections to which specification applies + or null if relevent to no sections.
        +static Specification[]getSpecifications(java.util.jar.Manifest manifest) + +
        +          Return an array of Package Specification objects.
        + java.lang.StringgetSpecificationTitle() + +
        +          Get the title of the specification.
        + java.lang.StringgetSpecificationVendor() + +
        +          Get the vendor of the specification.
        + DeweyDecimalgetSpecificationVersion() + +
        +          Get the version of the specification.
        + booleanisCompatibleWith(Specification other) + +
        +          Return true if the specified package + is satisfied by this Specification.
        + java.lang.StringtoString() + +
        +          Return a String representation of this object.
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +SPECIFICATION_TITLE

        +
        +public static final java.util.jar.Attributes.Name SPECIFICATION_TITLE
        +
        +
        Manifest Attribute Name object for SPECIFICATION_TITLE. +

        +

        +
        +
        +
        + +

        +SPECIFICATION_VERSION

        +
        +public static final java.util.jar.Attributes.Name SPECIFICATION_VERSION
        +
        +
        Manifest Attribute Name object for SPECIFICATION_VERSION. +

        +

        +
        +
        +
        + +

        +SPECIFICATION_VENDOR

        +
        +public static final java.util.jar.Attributes.Name SPECIFICATION_VENDOR
        +
        +
        Manifest Attribute Name object for SPECIFICATION_VENDOR. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_TITLE

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_TITLE
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_TITLE. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_VERSION

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_VERSION
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_VERSION. +

        +

        +
        +
        +
        + +

        +IMPLEMENTATION_VENDOR

        +
        +public static final java.util.jar.Attributes.Name IMPLEMENTATION_VENDOR
        +
        +
        Manifest Attribute Name object for IMPLEMENTATION_VENDOR. +

        +

        +
        +
        +
        + +

        +COMPATIBLE

        +
        +public static final Compatibility COMPATIBLE
        +
        +
        Enum indicating that extension is compatible with other Package + Specification. +

        +

        +
        +
        +
        + +

        +REQUIRE_SPECIFICATION_UPGRADE

        +
        +public static final Compatibility REQUIRE_SPECIFICATION_UPGRADE
        +
        +
        Enum indicating that extension requires an upgrade + of specification to be compatible with other Package Specification. +

        +

        +
        +
        +
        + +

        +REQUIRE_VENDOR_SWITCH

        +
        +public static final Compatibility REQUIRE_VENDOR_SWITCH
        +
        +
        Enum indicating that extension requires a vendor + switch to be compatible with other Package Specification. +

        +

        +
        +
        +
        + +

        +REQUIRE_IMPLEMENTATION_CHANGE

        +
        +public static final Compatibility REQUIRE_IMPLEMENTATION_CHANGE
        +
        +
        Enum indicating that extension requires an upgrade + of implementation to be compatible with other Package Specification. +

        +

        +
        +
        +
        + +

        +INCOMPATIBLE

        +
        +public static final Compatibility INCOMPATIBLE
        +
        +
        This enum indicates that an extension is incompatible with + other Package Specification in ways other than other enums + indicate. For example, the other Package Specification + may have a different ID. +

        +

        +
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +Specification

        +
        +public Specification(java.lang.String specificationTitle,
+                     java.lang.String specificationVersion,
+                     java.lang.String specificationVendor,
+                     java.lang.String implementationTitle,
+                     java.lang.String implementationVersion,
+                     java.lang.String implementationVendor)
        +
        +
        The constructor to create Package Specification object. + Note that every component is allowed to be specified + but only the specificationTitle is mandatory. +

        +

        +
        Parameters:
        specificationTitle - the name of specification.
        specificationVersion - the specification Version.
        specificationVendor - the specification Vendor.
        implementationTitle - the title of implementation.
        implementationVersion - the implementation Version.
        implementationVendor - the implementation Vendor.
        +
        +
        + +

        +Specification

        +
        +public Specification(java.lang.String specificationTitle,
+                     java.lang.String specificationVersion,
+                     java.lang.String specificationVendor,
+                     java.lang.String implementationTitle,
+                     java.lang.String implementationVersion,
+                     java.lang.String implementationVendor,
+                     java.lang.String[] sections)
        +
        +
        The constructor to create Package Specification object. + Note that every component is allowed to be specified + but only the specificationTitle is mandatory. +

        +

        +
        Parameters:
        specificationTitle - the name of specification.
        specificationVersion - the specification Version.
        specificationVendor - the specification Vendor.
        implementationTitle - the title of implementation.
        implementationVersion - the implementation Version.
        implementationVendor - the implementation Vendor.
        sections - the sections/packages that Specification applies to.
        +
        + + + + + + + + +
        +Method Detail
        + +

        +getSpecifications

        +
        +public static Specification[] getSpecifications(java.util.jar.Manifest manifest)
+                                         throws java.text.ParseException
        +
        +
        Return an array of Package Specification objects. + If there are no such optional packages, a zero-length array is returned. +

        +

        +
        Parameters:
        manifest - Manifest to be parsed +
        Returns:
        the Package Specifications extensions in specified manifest +
        Throws: +
        java.text.ParseException - if the attributes of the specifications cannot + be parsed according to their expected formats.
        +
        +
        +
        + +

        +getSpecificationTitle

        +
        +public java.lang.String getSpecificationTitle()
        +
        +
        Get the title of the specification. +

        +

        + +
        Returns:
        the title of speciication
        +
        +
        +
        + +

        +getSpecificationVendor

        +
        +public java.lang.String getSpecificationVendor()
        +
        +
        Get the vendor of the specification. +

        +

        + +
        Returns:
        the vendor of the specification.
        +
        +
        +
        + +

        +getImplementationTitle

        +
        +public java.lang.String getImplementationTitle()
        +
        +
        Get the title of the specification. +

        +

        + +
        Returns:
        the title of the specification.
        +
        +
        +
        + +

        +getSpecificationVersion

        +
        +public DeweyDecimal getSpecificationVersion()
        +
        +
        Get the version of the specification. +

        +

        + +
        Returns:
        the version of the specification.
        +
        +
        +
        + +

        +getImplementationVendor

        +
        +public java.lang.String getImplementationVendor()
        +
        +
        Get the vendor of the extensions implementation. +

        +

        + +
        Returns:
        the vendor of the extensions implementation.
        +
        +
        +
        + +

        +getImplementationVersion

        +
        +public java.lang.String getImplementationVersion()
        +
        +
        Get the version of the implementation. +

        +

        + +
        Returns:
        the version of the implementation.
        +
        +
        +
        + +

        +getSections

        +
        +public java.lang.String[] getSections()
        +
        +
        Return an array containing sections to which specification applies + or null if relevent to no sections. +

        +

        + +
        Returns:
        an array containing sections to which specification applies + or null if relevent to no sections.
        +
        +
        +
        + +

        +getCompatibilityWith

        +
        +public Compatibility getCompatibilityWith(Specification other)
        +
        +
        Return a Compatibility enum indicating the relationship of this + Package Specification with the specified + Extension. +

        +

        +
        Parameters:
        other - the other specification +
        Returns:
        the enum indicating the compatibility (or lack thereof) + of specifed Package Specification
        +
        +
        +
        + +

        +isCompatibleWith

        +
        +public boolean isCompatibleWith(Specification other)
        +
        +
        Return true if the specified package + is satisfied by this Specification. Otherwise, return + false. +

        +

        +
        Parameters:
        other - the specification +
        Returns:
        true if the specification is compatible with this specification
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Return a String representation of this object. +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        string representation of object.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-frame.html new file mode 100644 index 000000000..b7a0a9632 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-frame.html @@ -0,0 +1,69 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.extension + + + + +
        +Interfaces  + +
        +ExtensionResolver
        + + + + + + +
        +Classes  + +
        +Compatability +
        +Compatibility +
        +DeweyDecimal +
        +Extension +
        +ExtensionAdapter +
        +ExtensionSet +
        +ExtensionUtil +
        +ExtraAttribute +
        +JarLibAvailableTask +
        +JarLibDisplayTask +
        +JarLibManifestTask +
        +JarLibResolveTask +
        +LibFileSet +
        +Specification
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-summary.html new file mode 100644 index 000000000..4e7ffb4fe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-summary.html @@ -0,0 +1,228 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.extension +

        + + + + + + + + + +
        +Interface Summary
        ExtensionResolverInterface to locate a File that satisfies extension.
        +  + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Class Summary
        CompatabilityEnum used in (@link Extension) to indicate the compatability + of one extension to another.
        CompatibilityEnum used in (@link Extension) to indicate the compatibility + of one extension to another.
        DeweyDecimalDeprecated. use org.apache.tools.ant.util.DeweyDecimal instead.
        ExtensionUtility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.
        ExtensionAdapterSimple class that represents an Extension and conforms to Ants + patterns.
        ExtensionSetThe Extension set lists a set of "Optional Packages" / + "Extensions".
        ExtensionUtilA set of useful methods relating to extensions.
        ExtraAttributeSimple holder for extra attributes in main section of manifest.
        JarLibAvailableTaskChecks whether an extension is present in a fileset or an extensionSet.
        JarLibDisplayTaskDisplays the "Optional Package" and "Package Specification" information + contained within the specified JARs.
        JarLibManifestTaskGenerates a manifest that declares all the dependencies.
        JarLibResolveTaskTries to locate a JAR to satisfy an extension and place + location of JAR into property.
        LibFileSetLibFileSet represents a fileset containing libraries.
        SpecificationUtility class that represents either an available "Optional Package" + (formerly known as "Standard Extension") as described in the manifest + of a JAR file, or the requirement for such an optional package.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-tree.html new file mode 100644 index 000000000..a44a3f611 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/package-tree.html @@ -0,0 +1,168 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.extension +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        + +

        +Interface Hierarchy +

        + +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/AntResolver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/AntResolver.html new file mode 100644 index 000000000..23503b904 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/AntResolver.html @@ -0,0 +1,362 @@ + + + + + + +AntResolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension.resolvers +
        +Class AntResolver

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver
+
        +
        +
        All Implemented Interfaces:
        ExtensionResolver
        +
        +
        +
        +
        public class AntResolver
        extends java.lang.Object
        implements ExtensionResolver
        + + +

        +Resolver that just returns s specified location. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        AntResolver() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.io.Fileresolve(Extension extension, + Project project) + +
        +          Returns the resolved file
        + voidsetAntfile(java.io.File antfile) + +
        +          Sets the ant file
        + voidsetDestfile(java.io.File destfile) + +
        +          Sets the destination file
        + voidsetTarget(java.lang.String target) + +
        +          Sets the target
        + java.lang.StringtoString() + +
        +          Returns a string representation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +AntResolver

        +
        +public AntResolver()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setAntfile

        +
        +public void setAntfile(java.io.File antfile)
        +
        +
        Sets the ant file +

        +

        +
        +
        +
        +
        Parameters:
        antfile - the ant file to set
        +
        +
        +
        + +

        +setDestfile

        +
        +public void setDestfile(java.io.File destfile)
        +
        +
        Sets the destination file +

        +

        +
        +
        +
        +
        Parameters:
        destfile - the destination file
        +
        +
        +
        + +

        +setTarget

        +
        +public void setTarget(java.lang.String target)
        +
        +
        Sets the target +

        +

        +
        +
        +
        +
        Parameters:
        target - the target
        +
        +
        +
        + +

        +resolve

        +
        +public java.io.File resolve(Extension extension,
+                            Project project)
+                     throws BuildException
        +
        +
        Returns the resolved file +

        +

        +
        Specified by:
        resolve in interface ExtensionResolver
        +
        +
        +
        Parameters:
        extension - the extension
        project - the project +
        Returns:
        the file resolved +
        Throws: +
        BuildException - if the file cannot be resolved
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Returns a string representation +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/LocationResolver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/LocationResolver.html new file mode 100644 index 000000000..008a9ffff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/LocationResolver.html @@ -0,0 +1,314 @@ + + + + + + +LocationResolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension.resolvers +
        +Class LocationResolver

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver
+
        +
        +
        All Implemented Interfaces:
        ExtensionResolver
        +
        +
        +
        +
        public class LocationResolver
        extends java.lang.Object
        implements ExtensionResolver
        + + +

        +Resolver that just returns s specified location. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        LocationResolver() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.io.Fileresolve(Extension extension, + Project project) + +
        +          Returns the resolved file
        + voidsetLocation(java.lang.String location) + +
        +          Sets the location for this resolver
        + java.lang.StringtoString() + +
        +          Returns a string representation of the Location
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +LocationResolver

        +
        +public LocationResolver()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setLocation

        +
        +public void setLocation(java.lang.String location)
        +
        +
        Sets the location for this resolver +

        +

        +
        +
        +
        +
        Parameters:
        location - the location
        +
        +
        +
        + +

        +resolve

        +
        +public java.io.File resolve(Extension extension,
+                            Project project)
+                     throws BuildException
        +
        +
        Returns the resolved file +

        +

        +
        Specified by:
        resolve in interface ExtensionResolver
        +
        +
        +
        Parameters:
        extension - the extension
        project - the project +
        Returns:
        the file resolved +
        Throws: +
        BuildException - if no location is set
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Returns a string representation of the Location +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/URLResolver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/URLResolver.html new file mode 100644 index 000000000..49393bb1c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/URLResolver.html @@ -0,0 +1,362 @@ + + + + + + +URLResolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.extension.resolvers +
        +Class URLResolver

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver
+
        +
        +
        All Implemented Interfaces:
        ExtensionResolver
        +
        +
        +
        +
        public class URLResolver
        extends java.lang.Object
        implements ExtensionResolver
        + + +

        +Resolver that just returns s specified location. +

        + +

        +

        + +

        + + + + + + + + + + + +
        +Constructor Summary
        URLResolver() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + java.io.Fileresolve(Extension extension, + Project project) + +
        +          Returns the file resolved from URL and directory
        + voidsetDestdir(java.io.File destdir) + +
        +          Sets the destination directory
        + voidsetDestfile(java.io.File destfile) + +
        +          Sets the destination file
        + voidsetUrl(java.net.URL url) + +
        +          Sets the URL
        + java.lang.StringtoString() + +
        +          Returns a string representation of the URL
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +URLResolver

        +
        +public URLResolver()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setUrl

        +
        +public void setUrl(java.net.URL url)
        +
        +
        Sets the URL +

        +

        +
        +
        +
        +
        Parameters:
        url - the url
        +
        +
        +
        + +

        +setDestfile

        +
        +public void setDestfile(java.io.File destfile)
        +
        +
        Sets the destination file +

        +

        +
        +
        +
        +
        Parameters:
        destfile - the destination file
        +
        +
        +
        + +

        +setDestdir

        +
        +public void setDestdir(java.io.File destdir)
        +
        +
        Sets the destination directory +

        +

        +
        +
        +
        +
        Parameters:
        destdir - the destination directory
        +
        +
        +
        + +

        +resolve

        +
        +public java.io.File resolve(Extension extension,
+                            Project project)
+                     throws BuildException
        +
        +
        Returns the file resolved from URL and directory +

        +

        +
        Specified by:
        resolve in interface ExtensionResolver
        +
        +
        +
        Parameters:
        extension - the extention
        project - the project +
        Returns:
        file the file resolved +
        Throws: +
        BuildException - if the URL is invalid
        +
        +
        +
        + +

        +toString

        +
        +public java.lang.String toString()
        +
        +
        Returns a string representation of the URL +

        +

        +
        Overrides:
        toString in class java.lang.Object
        +
        +
        + +
        Returns:
        the string representation
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-frame.html new file mode 100644 index 000000000..8b6d45419 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension.resolvers (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.extension.resolvers + + + + +
        +Classes  + +
        +AntResolver +
        +LocationResolver +
        +URLResolver
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-summary.html new file mode 100644 index 000000000..74cf8ce4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-summary.html @@ -0,0 +1,160 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension.resolvers (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.extension.resolvers +

        + + + + + + + + + + + + + + + + + +
        +Class Summary
        AntResolverResolver that just returns s specified location.
        LocationResolverResolver that just returns s specified location.
        URLResolverResolver that just returns s specified location.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-tree.html new file mode 100644 index 000000000..5afb349db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/extension/resolvers/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.extension.resolvers Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.extension.resolvers +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        +
          +
        • java.lang.Object
            +
          • org.apache.tools.ant.taskdefs.optional.extension.resolvers.AntResolver (implements org.apache.tools.ant.taskdefs.optional.extension.ExtensionResolver) +
          • org.apache.tools.ant.taskdefs.optional.extension.resolvers.LocationResolver (implements org.apache.tools.ant.taskdefs.optional.extension.ExtensionResolver) +
          • org.apache.tools.ant.taskdefs.optional.extension.resolvers.URLResolver (implements org.apache.tools.ant.taskdefs.optional.extension.ExtensionResolver) +
          +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/Translate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/Translate.html new file mode 100644 index 000000000..18739579d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/Translate.html @@ -0,0 +1,595 @@ + + + + + + +Translate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.i18n +
        +Class Translate

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.i18n.Translate
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, SelectorContainer
        +
        +
        +
        +
        public class Translate
        extends MatchingTask
        + + +

        +Translates text embedded in files using Resource Bundle files. + Since ant 1.6 preserves line endings +

        + +

        +

        + +

        + + + + + + + +
        +Field Summary
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        fileset
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Translate() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidaddFileset(FileSet set) + +
        +          Adds a set of files to translate as a nested fileset element.
        + voidexecute() + +
        +          Check attributes values, load resource map and translate
        + voidsetBundle(java.lang.String bundle) + +
        +          Sets Family name of resource bundle; required.
        + voidsetBundleCountry(java.lang.String bundleCountry) + +
        +          Sets locale specific country of resource bundle; optional.
        + voidsetBundleEncoding(java.lang.String bundleEncoding) + +
        +          Sets Resource Bundle file encoding scheme; optional.
        + voidsetBundleLanguage(java.lang.String bundleLanguage) + +
        +          Sets locale specific language of resource bundle; optional.
        + voidsetBundleVariant(java.lang.String bundleVariant) + +
        +          Sets locale specific variant of resource bundle; optional.
        + voidsetDestEncoding(java.lang.String destEncoding) + +
        +          Sets destination file encoding scheme; optional.
        + voidsetEndToken(java.lang.String endToken) + +
        +          Sets ending token to identify keys; required.
        + voidsetForceOverwrite(boolean forceOverwrite) + +
        +          Whether or not to overwrite existing file irrespective of + whether it is newer than the source file as well as the + resource bundle file.
        + voidsetSrcEncoding(java.lang.String srcEncoding) + +
        +          Sets source file encoding scheme; optional, + defaults to encoding of local system.
        + voidsetStartToken(java.lang.String startToken) + +
        +          Sets starting token to identify keys; required.
        + voidsetToDir(java.io.File toDir) + +
        +          Sets Destination directory; required.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Constructor Detail
        + +

        +Translate

        +
        +public Translate()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +setBundle

        +
        +public void setBundle(java.lang.String bundle)
        +
        +
        Sets Family name of resource bundle; required. +

        +

        +
        Parameters:
        bundle - family name of resource bundle
        +
        +
        +
        + +

        +setBundleLanguage

        +
        +public void setBundleLanguage(java.lang.String bundleLanguage)
        +
        +
        Sets locale specific language of resource bundle; optional. +

        +

        +
        Parameters:
        bundleLanguage - langage of the bundle
        +
        +
        +
        + +

        +setBundleCountry

        +
        +public void setBundleCountry(java.lang.String bundleCountry)
        +
        +
        Sets locale specific country of resource bundle; optional. +

        +

        +
        Parameters:
        bundleCountry - country of the bundle
        +
        +
        +
        + +

        +setBundleVariant

        +
        +public void setBundleVariant(java.lang.String bundleVariant)
        +
        +
        Sets locale specific variant of resource bundle; optional. +

        +

        +
        Parameters:
        bundleVariant - locale variant of resource bundle
        +
        +
        +
        + +

        +setToDir

        +
        +public void setToDir(java.io.File toDir)
        +
        +
        Sets Destination directory; required. +

        +

        +
        Parameters:
        toDir - destination directory
        +
        +
        +
        + +

        +setStartToken

        +
        +public void setStartToken(java.lang.String startToken)
        +
        +
        Sets starting token to identify keys; required. +

        +

        +
        Parameters:
        startToken - starting token to identify keys
        +
        +
        +
        + +

        +setEndToken

        +
        +public void setEndToken(java.lang.String endToken)
        +
        +
        Sets ending token to identify keys; required. +

        +

        +
        Parameters:
        endToken - ending token to identify keys
        +
        +
        +
        + +

        +setSrcEncoding

        +
        +public void setSrcEncoding(java.lang.String srcEncoding)
        +
        +
        Sets source file encoding scheme; optional, + defaults to encoding of local system. +

        +

        +
        Parameters:
        srcEncoding - source file encoding
        +
        +
        +
        + +

        +setDestEncoding

        +
        +public void setDestEncoding(java.lang.String destEncoding)
        +
        +
        Sets destination file encoding scheme; optional. Defaults to source file + encoding +

        +

        +
        Parameters:
        destEncoding - destination file encoding scheme
        +
        +
        +
        + +

        +setBundleEncoding

        +
        +public void setBundleEncoding(java.lang.String bundleEncoding)
        +
        +
        Sets Resource Bundle file encoding scheme; optional. Defaults to source file + encoding +

        +

        +
        Parameters:
        bundleEncoding - bundle file encoding scheme
        +
        +
        +
        + +

        +setForceOverwrite

        +
        +public void setForceOverwrite(boolean forceOverwrite)
        +
        +
        Whether or not to overwrite existing file irrespective of + whether it is newer than the source file as well as the + resource bundle file. + Defaults to false. +

        +

        +
        Parameters:
        forceOverwrite - whether or not to overwrite existing files
        +
        +
        +
        + +

        +addFileset

        +
        +public void addFileset(FileSet set)
        +
        +
        Adds a set of files to translate as a nested fileset element. +

        +

        +
        Parameters:
        set - the fileset to be added
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Check attributes values, load resource map and translate +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - if the required attributes are not set + Required :
          +
        • bundle
          • +
        • starttoken
          • +
        • endtoken
          • +
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-frame.html new file mode 100644 index 000000000..6b4836488 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.i18n (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.i18n + + + + +
        +Classes  + +
        +Translate
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-summary.html new file mode 100644 index 000000000..009c5c238 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-summary.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.i18n (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.i18n +

        + + + + + + + + + +
        +Class Summary
        TranslateTranslates text embedded in files using Resource Bundle files.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-tree.html new file mode 100644 index 000000000..f5a25057d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/i18n/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.i18n Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.i18n +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        +
          +
        • java.lang.Object +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/Image.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/Image.html new file mode 100644 index 000000000..a3e84480f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/Image.html @@ -0,0 +1,893 @@ + + + + + + +Image (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.image +
        +Class Image

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.image.Image
+
        +
        +
        All Implemented Interfaces:
        java.lang.Cloneable, SelectorContainer
        +
        +
        +
        +
        public class Image
        extends MatchingTask
        + + +

        +A MatchingTask which relies on JAI (Java + Advanced Imaging) to perform image manipulation operations on + existing images. The operations are represented as ImageOperation + DataType objects. The operations are arranged to conform to the + Chaining Model of JAI. Check out the + JAI Programming Guide. +

        + +

        +

        +
        See Also:
        ImageOperation, +DataType
        +
        + +

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Field Summary
        +protected  java.io.FiledestDir + +
        +           
        +protected  java.util.Vectorfilesets + +
        +           
        +protected  booleangarbage_collect + +
        +           
        +protected  java.util.Vectorinstructions + +
        +           
        +protected  booleanoverwrite + +
        +           
        +protected  java.io.FilesrcDir + +
        +           
        +protected  java.lang.Stringstr_encoding + +
        +           
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        fileset
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.Task
        target, taskName, taskType, wrapper
        +  + + + + + + + +
        Fields inherited from class org.apache.tools.ant.ProjectComponent
        description, location, project
        +  + + + + + + + + + + +
        +Constructor Summary
        Image() + +
        +           
        +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +Method Summary
        + voidadd(FileNameMapper fileNameMapper) + +
        +          Add a nested filenamemapper.
        + voidadd(ImageOperation instr) + +
        +          Add an ImageOperation to chain.
        + voidaddDraw(Draw instr) + +
        +          Add a Draw ImageOperation to the chain.
        + voidaddFileset(FileSet set) + +
        +          Add a set of files to be deleted.
        + voidaddImageOperation(ImageOperation instr) + +
        +          Add an ImageOperation to chain.
        + voidaddRotate(Rotate instr) + +
        +          Add a Rotate ImageOperation to the chain.
        + voidaddScale(Scale instr) + +
        +          Add a Scale ImageOperation to the chain.
        + MappercreateMapper() + +
        +          Defines the mapper to map source to destination files.
        + voidexecute() + +
        +          Executes the Task.
        + intprocessDir(java.io.File srcDir, + java.lang.String[] srcNames, + java.io.File dstDir, + FileNameMapper mapper) + +
        +          Executes all the chained ImageOperations on the files inside + the directory.
        + voidprocessFile(java.io.File file) + +
        +          Deprecated. this method isn't used anymore
        + voidprocessFile(java.io.File file, + java.io.File newFile) + +
        +          Executes all the chained ImageOperations on the file + specified.
        + voidsetDestDir(java.io.File destDir) + +
        +          Set the destination directory for manipulated images.
        + voidsetEncoding(java.lang.String encoding) + +
        +          Set the image encoding type.
        + voidsetFailOnError(boolean failonerror) + +
        +          Set whether to fail on error.
        + voidsetGc(boolean gc) + +
        +          Set whether to invoke Garbage Collection after each image processed.
        + voidsetOverwrite(boolean overwrite) + +
        +          Set whether to overwrite a file if there is a naming conflict.
        + voidsetSrcdir(java.io.File srcDir) + +
        +          Set the source dir to find the image files.
        +protected  voidvalidateAttributes() + +
        +          Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes.
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.Task
        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
        +  + + + + + + + +
        Methods inherited from class org.apache.tools.ant.ProjectComponent
        clone, getDescription, getLocation, getProject, setDescription, setLocation
        +  + + + + + + + +
        Methods inherited from class java.lang.Object
        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        +  +

        + + + + + + + + +
        +Field Detail
        + +

        +instructions

        +
        +protected java.util.Vector instructions
        +
        +
        +
        +
        +
        + +

        +overwrite

        +
        +protected boolean overwrite
        +
        +
        +
        +
        +
        + +

        +filesets

        +
        +protected java.util.Vector filesets
        +
        +
        +
        +
        +
        + +

        +srcDir

        +
        +protected java.io.File srcDir
        +
        +
        +
        +
        +
        + +

        +destDir

        +
        +protected java.io.File destDir
        +
        +
        +
        +
        +
        + +

        +str_encoding

        +
        +protected java.lang.String str_encoding
        +
        +
        +
        +
        +
        + +

        +garbage_collect

        +
        +protected boolean garbage_collect
        +
        +
        +
        +
        + + + + + + + + +
        +Constructor Detail
        + +

        +Image

        +
        +public Image()
        +
        +
        + + + + + + + + +
        +Method Detail
        + +

        +addFileset

        +
        +public void addFileset(FileSet set)
        +
        +
        Add a set of files to be deleted. +

        +

        +
        Parameters:
        set - the FileSet to add.
        +
        +
        +
        + +

        +setFailOnError

        +
        +public void setFailOnError(boolean failonerror)
        +
        +
        Set whether to fail on error. + If false, note errors to the output but keep going. +

        +

        +
        Parameters:
        failonerror - true or false.
        +
        +
        +
        + +

        +setSrcdir

        +
        +public void setSrcdir(java.io.File srcDir)
        +
        +
        Set the source dir to find the image files. +

        +

        +
        Parameters:
        srcDir - the directory in which the image files reside.
        +
        +
        +
        + +

        +setEncoding

        +
        +public void setEncoding(java.lang.String encoding)
        +
        +
        Set the image encoding type. + See this table in the JAI Programming Guide. +

        +

        +
        Parameters:
        encoding - the String image encoding.
        +
        +
        +
        + +

        +setOverwrite

        +
        +public void setOverwrite(boolean overwrite)
        +
        +
        Set whether to overwrite a file if there is a naming conflict. +

        +

        +
        Parameters:
        overwrite - whether to overwrite.
        +
        +
        +
        + +

        +setGc

        +
        +public void setGc(boolean gc)
        +
        +
        Set whether to invoke Garbage Collection after each image processed. + Defaults to false. +

        +

        +
        Parameters:
        gc - whether to invoke the garbage collector.
        +
        +
        +
        + +

        +setDestDir

        +
        +public void setDestDir(java.io.File destDir)
        +
        +
        Set the destination directory for manipulated images. +

        +

        +
        Parameters:
        destDir - The destination directory.
        +
        +
        +
        + +

        +addImageOperation

        +
        +public void addImageOperation(ImageOperation instr)
        +
        +
        Add an ImageOperation to chain. +

        +

        +
        Parameters:
        instr - The ImageOperation to append to the chain.
        +
        +
        +
        + +

        +addRotate

        +
        +public void addRotate(Rotate instr)
        +
        +
        Add a Rotate ImageOperation to the chain. +

        +

        +
        Parameters:
        instr - The Rotate operation to add to the chain.
        See Also:
        Rotate
        +
        +
        +
        + +

        +addScale

        +
        +public void addScale(Scale instr)
        +
        +
        Add a Scale ImageOperation to the chain. +

        +

        +
        Parameters:
        instr - The Scale operation to add to the chain.
        See Also:
        Scale
        +
        +
        +
        + +

        +addDraw

        +
        +public void addDraw(Draw instr)
        +
        +
        Add a Draw ImageOperation to the chain. DrawOperation + DataType objects can be nested inside the Draw object. +

        +

        +
        Parameters:
        instr - The Draw operation to add to the chain.
        See Also:
        Draw, +DrawOperation
        +
        +
        +
        + +

        +add

        +
        +public void add(ImageOperation instr)
        +
        +
        Add an ImageOperation to chain. +

        +

        +
        Parameters:
        instr - The ImageOperation to append to the chain.
        Since:
        +
        Ant 1.7
        +
        +
        +
        +
        + +

        +createMapper

        +
        +public Mapper createMapper()
+                    throws BuildException
        +
        +
        Defines the mapper to map source to destination files. +

        +

        + +
        Returns:
        a mapper to be configured +
        Throws: +
        BuildException - if more than one mapper is defined
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +add

        +
        +public void add(FileNameMapper fileNameMapper)
        +
        +
        Add a nested filenamemapper. +

        +

        +
        Parameters:
        fileNameMapper - the mapper to add.
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +processDir

        +
        +public int processDir(java.io.File srcDir,
+                      java.lang.String[] srcNames,
+                      java.io.File dstDir,
+                      FileNameMapper mapper)
        +
        +
        Executes all the chained ImageOperations on the files inside + the directory. +

        +

        +
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +processFile

        +
        +public void processFile(java.io.File file)
        +
        +
        Deprecated. this method isn't used anymore +

        +

        Executes all the chained ImageOperations on the file + specified. +

        +

        +
        Parameters:
        file - The file to be processed.
        +
        +
        +
        + +

        +processFile

        +
        +public void processFile(java.io.File file,
+                        java.io.File newFile)
        +
        +
        Executes all the chained ImageOperations on the file + specified. +

        +

        +
        Parameters:
        file - The file to be processed.
        newFile - The file to write to.
        Since:
        +
        Ant 1.8.0
        +
        +
        +
        +
        + +

        +execute

        +
        +public void execute()
+             throws BuildException
        +
        +
        Executes the Task. +

        +

        +
        Overrides:
        execute in class Task
        +
        +
        + +
        Throws: +
        BuildException - on error.
        +
        +
        +
        + +

        +validateAttributes

        +
        +protected void validateAttributes()
+                           throws BuildException
        +
        +
        Ensure we have a consistent and legal set of attributes, and set + any internal flags necessary based on different combinations + of attributes. +

        +

        + +
        Throws: +
        BuildException - on error.
        +
        +
        + +
        + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-frame.html new file mode 100644 index 000000000..9f3d468d0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.image (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.image + + + + +
        +Classes  + +
        +Image
        + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-summary.html new file mode 100644 index 000000000..71f421ff7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-summary.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.image (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +

        +Package org.apache.tools.ant.taskdefs.optional.image +

        + + + + + + + + + +
        +Class Summary
        ImageA MatchingTask which relies on JAI (Java + Advanced Imaging) to perform image manipulation operations on + existing images.
        +  + +

        +

        +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview   Package  Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-tree.html new file mode 100644 index 000000000..92cd8ad70 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/image/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.image Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.image +

        +
        +
        +
        Package Hierarchies:
        All Packages
        +
        +

        +Class Hierarchy +

        +
          +
        • java.lang.Object
            +
          • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
              +
            • org.apache.tools.ant.Task +
            +
          +
        +
        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package  Class   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html new file mode 100644 index 000000000..619608651 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html @@ -0,0 +1,635 @@ + + + + + + +AbstractHotDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + + + + + + + + + + + +
        Overview  Package   Class  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
        + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
        + + + +
        + +

        + +org.apache.tools.ant.taskdefs.optional.j2ee +
        +Class AbstractHotDeploymentTool

        +
        +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
+
        +
        +
        All Implemented Interfaces:
        HotDeploymentTool
        +
        +
        +
        Direct Known Subclasses:
        GenericHotDeploymentTool, WebLogicHotDeploymentTool
        +
        +
        +
        +
        public abstract class AbstractHotDeploymentTool
        extends java.lang.Object
        implements HotDeploymentTool
        + + +

        +Abstract class to support vendor-specific hot deployment tools. + This class will validate boilerplate attributes. + + Subclassing this class for a vendor specific tool involves the + following. +

        1. Implement the isActionValid() method to insure the + action supplied as the "action" attribute of ServerDeploy is valid. +
        2. Implement the validateAttributes() method to insure + all required attributes are supplied, and are in the correct format. +
        3. Add a add<TOOL> method to the ServerDeploy + class. This method will be called when Ant encounters a + add<TOOL> task nested in the + serverdeploy task. +
        4. Define the deploy method. This method should perform + whatever task it takes to hot-deploy the component. IE: spawn a JVM and + run class, exec a native executable, run Java code... +

          + +

          +

          +
          See Also:
          HotDeploymentTool, +ServerDeploy
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          ACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractHotDeploymentTool() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateClasspath() + +
          +          Add a classpath as a nested element.
          +abstract  voiddeploy() + +
          +          Perform the actual deployment.
          + PathgetClasspath() + +
          +          gets the classpath field.
          + java.lang.StringgetPassword() + +
          +          Returns the password field.
          + java.lang.StringgetServer() + +
          +          Returns the server field.
          +protected  ServerDeploygetTask() + +
          +          Returns the task field, a ServerDeploy object.
          + java.lang.StringgetUserName() + +
          +          Returns the userName field.
          +protected abstract  booleanisActionValid() + +
          +          Determines if the "action" attribute defines a valid action.
          + voidsetClasspath(Path classpath) + +
          +          The classpath to be passed to the JVM running the tool; + optional depending upon the tool.
          + voidsetPassword(java.lang.String password) + +
          +          The password of the user; optional.
          + voidsetServer(java.lang.String server) + +
          +          The address or URL for the server where the component will be deployed.
          + voidsetTask(ServerDeploy task) + +
          +          Sets the parent task.
          + voidsetUserName(java.lang.String userName) + +
          +          The user with privileges to deploy applications to the server; optional.
          + voidvalidateAttributes() + +
          +          Validates the passed in attributes.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractHotDeploymentTool

          +
          +public AbstractHotDeploymentTool()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Add a classpath as a nested element. +

          +

          +
          +
          +
          + +
          Returns:
          A Path object representing the classpath to be used.
          +
          +
          +
          + +

          +isActionValid

          +
          +protected abstract boolean isActionValid()
          +
          +
          Determines if the "action" attribute defines a valid action. +

          Subclasses should determine if the action passed in is + supported by the vendor's deployment tool. +

          Actions may by "deploy", "delete", etc... It all depends + on the tool. +

          +

          +
          +
          +
          + +
          Returns:
          true if the "action" attribute is valid, false if not.
          +
          +
          +
          + +

          +validateAttributes

          +
          +public void validateAttributes()
+                        throws BuildException
          +
          +
          Validates the passed in attributes. + Subclasses should chain to this super-method to insure + validation of boilerplate attributes. +

          Only the "action" attribute is required in the + base class. Subclasses should check attributes accordingly. +

          +

          +
          Specified by:
          validateAttributes in interface HotDeploymentTool
          +
          +
          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +deploy

          +
          +public abstract void deploy()
+                     throws BuildException
          +
          +
          Perform the actual deployment. + It's up to the subclasses to implement the actual behavior. +

          +

          +
          Specified by:
          deploy in interface HotDeploymentTool
          +
          +
          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +setTask

          +
          +public void setTask(ServerDeploy task)
          +
          +
          Sets the parent task. +

          +

          +
          Specified by:
          setTask in interface HotDeploymentTool
          +
          +
          +
          Parameters:
          task - a ServerDeploy object representing the parent task.
          +
          +
          +
          + +

          +getTask

          +
          +protected ServerDeploy getTask()
          +
          +
          Returns the task field, a ServerDeploy object. +

          +

          +
          +
          +
          + +
          Returns:
          An ServerDeploy representing the parent task.
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          gets the classpath field. +

          +

          +
          +
          +
          + +
          Returns:
          A Path representing the "classpath" attribute.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          The classpath to be passed to the JVM running the tool; + optional depending upon the tool. + The classpath may also be supplied as a nested element. +

          +

          +
          +
          +
          +
          Parameters:
          classpath - A Path object representing the "classpath" attribute.
          +
          +
          +
          + +

          +getUserName

          +
          +public java.lang.String getUserName()
          +
          +
          Returns the userName field. +

          +

          +
          +
          +
          + +
          Returns:
          A String representing the "userName" attribute.
          +
          +
          +
          + +

          +setUserName

          +
          +public void setUserName(java.lang.String userName)
          +
          +
          The user with privileges to deploy applications to the server; optional. +

          +

          +
          +
          +
          +
          Parameters:
          userName - A String representing the "userName" attribute.
          +
          +
          +
          + +

          +getPassword

          +
          +public java.lang.String getPassword()
          +
          +
          Returns the password field. +

          +

          +
          +
          +
          + +
          Returns:
          A String representing the "password" attribute.
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          The password of the user; optional. +

          +

          +
          +
          +
          +
          Parameters:
          password - A String representing the "password" attribute.
          +
          +
          +
          + +

          +getServer

          +
          +public java.lang.String getServer()
          +
          +
          Returns the server field. +

          +

          +
          +
          +
          + +
          Returns:
          A String representing the "server" attribute.
          +
          +
          +
          + +

          +setServer

          +
          +public void setServer(java.lang.String server)
          +
          +
          The address or URL for the server where the component will be deployed. +

          +

          +
          +
          +
          +
          Parameters:
          server - A String representing the "server" attribute.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html new file mode 100644 index 000000000..1ca93c04b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html @@ -0,0 +1,501 @@ + + + + + + +GenericHotDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.j2ee +
          +Class GenericHotDeploymentTool

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool
+
          +
          +
          All Implemented Interfaces:
          HotDeploymentTool
          +
          +
          +
          Direct Known Subclasses:
          JonasHotDeploymentTool
          +
          +
          +
          +
          public class GenericHotDeploymentTool
          extends AbstractHotDeploymentTool
          + + +

          +A generic tool for J2EE server hot deployment. +

          The simple implementation spawns a JVM with the supplied + class name, jvm args, and arguments. +

          + +

          +

          +
          See Also:
          HotDeploymentTool, +AbstractHotDeploymentTool, +ServerDeploy
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          ACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE
          +  + + + + + + + + + + +
          +Constructor Summary
          GenericHotDeploymentTool() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + Commandline.ArgumentcreateArg() + +
          +          Add a nested argument element to hand to the deployment tool; optional.
          + Commandline.ArgumentcreateJvmarg() + +
          +          Add a nested argment element to hand to the JVM running the + deployment tool.
          + voiddeploy() + +
          +          Perform the actual deployment.
          + java.lang.StringgetClassName() + +
          +          Get the classname attribute.
          + JavagetJava() + +
          +          get the java attribute.
          +protected  booleanisActionValid() + +
          +          Determines if the "action" attribute defines a valid action.
          + voidsetClassName(java.lang.String className) + +
          +          The name of the class to execute to perfom + deployment; required.
          + voidsetTask(ServerDeploy task) + +
          +          Sets the parent task.
          + voidvalidateAttributes() + +
          +          Validates the passed in attributes.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
          createClasspath, getClasspath, getPassword, getServer, getTask, getUserName, setClasspath, setPassword, setServer, setUserName
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +GenericHotDeploymentTool

          +
          +public GenericHotDeploymentTool()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createArg

          +
          +public Commandline.Argument createArg()
          +
          +
          Add a nested argument element to hand to the deployment tool; optional. +

          +

          + +
          Returns:
          A Commandline.Argument object representing the + command line argument being passed when the deployment + tool is run. IE: "-user=mark", "-password=venture"...
          +
          +
          +
          + +

          +createJvmarg

          +
          +public Commandline.Argument createJvmarg()
          +
          +
          Add a nested argment element to hand to the JVM running the + deployment tool. + Creates a nested arg element. +

          +

          + +
          Returns:
          A Commandline.Argument object representing the + JVM command line argument being passed when the deployment + tool is run. IE: "-ms64m", "-mx128m"...
          +
          +
          +
          + +

          +isActionValid

          +
          +protected boolean isActionValid()
          +
          +
          Determines if the "action" attribute defines a valid action. +

          Subclasses should determine if the action passed in is + supported by the vendor's deployment tool. + For this generic implementation, the only valid action is "deploy" +

          +

          +
          Specified by:
          isActionValid in class AbstractHotDeploymentTool
          +
          +
          + +
          Returns:
          true if the "action" attribute is valid, false if not.
          +
          +
          +
          + +

          +setTask

          +
          +public void setTask(ServerDeploy task)
          +
          +
          Sets the parent task. +

          +

          +
          Specified by:
          setTask in interface HotDeploymentTool
          Overrides:
          setTask in class AbstractHotDeploymentTool
          +
          +
          +
          Parameters:
          task - An ServerDeploy object representing the parent task.
          +
          +
          +
          + +

          +deploy

          +
          +public void deploy()
+            throws BuildException
          +
          +
          Perform the actual deployment. + For this generic implementation, a JVM is spawned using the + supplied classpath, classname, JVM args, and command line arguments. +

          +

          +
          Specified by:
          deploy in interface HotDeploymentTool
          Specified by:
          deploy in class AbstractHotDeploymentTool
          +
          +
          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +validateAttributes

          +
          +public void validateAttributes()
+                        throws BuildException
          +
          +
          Validates the passed in attributes. + Ensures the className and arguments attribute have been set. +

          +

          +
          Specified by:
          validateAttributes in interface HotDeploymentTool
          Overrides:
          validateAttributes in class AbstractHotDeploymentTool
          +
          +
          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +setClassName

          +
          +public void setClassName(java.lang.String className)
          +
          +
          The name of the class to execute to perfom + deployment; required. + Example: "com.foobar.tools.deploy.DeployTool" +

          +

          +
          Parameters:
          className - The fully qualified class name of the class + to perform deployment.
          +
          +
          +
          + +

          +getJava

          +
          +public Java getJava()
          +
          +
          get the java attribute. +

          +

          + +
          Returns:
          the java attribute.
          +
          +
          +
          + +

          +getClassName

          +
          +public java.lang.String getClassName()
          +
          +
          Get the classname attribute. +

          +

          + +
          Returns:
          the classname value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html new file mode 100644 index 000000000..6a088b538 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html @@ -0,0 +1,379 @@ + + + + + + +HotDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.j2ee +
          +Interface HotDeploymentTool

          +
          +
          All Known Implementing Classes:
          AbstractHotDeploymentTool, GenericHotDeploymentTool, JonasHotDeploymentTool, WebLogicHotDeploymentTool
          +
          +
          +
          +
          public interface HotDeploymentTool
          + + +

          +An interface for vendor-specific "hot" deployment tools. +

          + +

          +

          +
          See Also:
          AbstractHotDeploymentTool, +ServerDeploy
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringACTION_DELETE + +
          +          The delete action String
          +static java.lang.StringACTION_DEPLOY + +
          +          The deploy action String
          +static java.lang.StringACTION_LIST + +
          +          The list action String
          +static java.lang.StringACTION_UNDEPLOY + +
          +          The undeploy action String
          +static java.lang.StringACTION_UPDATE + +
          +          The update action String
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voiddeploy() + +
          +          Perform the actual deployment.
          + voidsetTask(ServerDeploy task) + +
          +          Sets the parent task.
          + voidvalidateAttributes() + +
          +          Validates the passed in attributes.
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ACTION_DELETE

          +
          +static final java.lang.String ACTION_DELETE
          +
          +
          The delete action String +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_DEPLOY

          +
          +static final java.lang.String ACTION_DEPLOY
          +
          +
          The deploy action String +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_LIST

          +
          +static final java.lang.String ACTION_LIST
          +
          +
          The list action String +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_UNDEPLOY

          +
          +static final java.lang.String ACTION_UNDEPLOY
          +
          +
          The undeploy action String +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_UPDATE

          +
          +static final java.lang.String ACTION_UPDATE
          +
          +
          The update action String +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +validateAttributes

          +
          +void validateAttributes()
+                        throws BuildException
          +
          +
          Validates the passed in attributes. +

          +

          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +deploy

          +
          +void deploy()
+            throws BuildException
          +
          +
          Perform the actual deployment. +

          +

          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +setTask

          +
          +void setTask(ServerDeploy task)
          +
          +
          Sets the parent task. +

          +

          +
          Parameters:
          task - A ServerDeploy object representing the parent task.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.html new file mode 100644 index 000000000..164f68577 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.html @@ -0,0 +1,517 @@ + + + + + + +JonasHotDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.j2ee +
          +Class JonasHotDeploymentTool

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool
+          extended by org.apache.tools.ant.taskdefs.optional.j2ee.JonasHotDeploymentTool
+
          +
          +
          All Implemented Interfaces:
          HotDeploymentTool
          +
          +
          +
          +
          public class JonasHotDeploymentTool
          extends GenericHotDeploymentTool
          implements HotDeploymentTool
          + + +

          +An Ant wrapper task for the weblogic.deploy tool. This is used + to hot-deploy J2EE applications to a running WebLogic server. + This is not the same as creating the application + archive. This task assumes the archive (EAR, JAR, or WAR) file + has been assembled and is supplied as the "source" attribute. +

          + + In the end, this task assembles the commadline parameters and + runs the weblogic.deploy tool in a seperate JVM. +

          + +

          +

          +
          See Also:
          HotDeploymentTool, +AbstractHotDeploymentTool, +ServerDeploy
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected static java.lang.StringDEFAULT_ORB + +
          +          Description of the Field
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          ACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE
          +  + + + + + + + + + + +
          +Constructor Summary
          JonasHotDeploymentTool() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathgetClasspath() + +
          +          gets the classpath field.
          +protected  booleanisActionValid() + +
          +          Determines if the action supplied is valid.
          + voidsetDavidhost(java.lang.String inValue) + +
          +          Set the host for the David ORB; required if + ORB==david.
          + voidsetDavidport(int inValue) + +
          +          Set the port for the David ORB; required if + ORB==david.
          + voidsetJonasroot(java.io.File inValue) + +
          +          set the jonas root directory (-Dinstall.root=).
          + voidsetOrb(java.lang.String inValue) + +
          +          Choose your ORB : RMI, JEREMIE, DAVID, ...; optional.
          + voidvalidateAttributes() + +
          +          Validates the passed in attributes.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool
          createArg, createJvmarg, deploy, getClassName, getJava, setClassName, setTask
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
          createClasspath, getPassword, getServer, getTask, getUserName, setClasspath, setPassword, setServer, setUserName
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          deploy, setTask
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_ORB

          +
          +protected static final java.lang.String DEFAULT_ORB
          +
          +
          Description of the Field +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JonasHotDeploymentTool

          +
          +public JonasHotDeploymentTool()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDavidhost

          +
          +public void setDavidhost(java.lang.String inValue)
          +
          +
          Set the host for the David ORB; required if + ORB==david. +

          +

          +
          +
          +
          +
          Parameters:
          inValue - The new davidhost value
          +
          +
          +
          + +

          +setDavidport

          +
          +public void setDavidport(int inValue)
          +
          +
          Set the port for the David ORB; required if + ORB==david. +

          +

          +
          +
          +
          +
          Parameters:
          inValue - The new davidport value
          +
          +
          +
          + +

          +setJonasroot

          +
          +public void setJonasroot(java.io.File inValue)
          +
          +
          set the jonas root directory (-Dinstall.root=). This + element is required. +

          +

          +
          +
          +
          +
          Parameters:
          inValue - The new jonasroot value
          +
          +
          +
          + +

          +setOrb

          +
          +public void setOrb(java.lang.String inValue)
          +
          +
          Choose your ORB : RMI, JEREMIE, DAVID, ...; optional. + If omitted, it defaults + to the one present in classpath. The corresponding JOnAS JAR is + automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must + specify davidhost and davidport properties. +

          +

          +
          +
          +
          +
          Parameters:
          inValue - RMI, JEREMIE, DAVID,...
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          gets the classpath field. +

          +

          +
          Overrides:
          getClasspath in class AbstractHotDeploymentTool
          +
          +
          + +
          Returns:
          A Path representing the "classpath" attribute.
          +
          +
          +
          + +

          +validateAttributes

          +
          +public void validateAttributes()
+                        throws BuildException
          +
          +
          Validates the passed in attributes.

          + + The rules are: +

            +
          1. If action is "deploy" or "update" the "application" + and "source" attributes must be supplied. +
          2. If action is "delete" or "undeploy" the + "application" attribute must be supplied. +

            +

            +
            Specified by:
            validateAttributes in interface HotDeploymentTool
            Overrides:
            validateAttributes in class GenericHotDeploymentTool
            +
            +
            + +
            Throws: +
            BuildException - Description + of Exception
            +
            +
          +
          + +

          +isActionValid

          +
          +protected boolean isActionValid()
          +
          +
          Determines if the action supplied is valid.

          + + Valid actions are contained in the static array + VALID_ACTIONS +

          +

          +
          Overrides:
          isActionValid in class GenericHotDeploymentTool
          +
          +
          + +
          Returns:
          true if the action attribute is valid, false if + not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html new file mode 100644 index 000000000..535cfb59e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html @@ -0,0 +1,481 @@ + + + + + + +ServerDeploy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.j2ee +
          +Class ServerDeploy

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class ServerDeploy
          extends Task
          + + +

          +Controls hot deployment tools for J2EE servers. + + This class is used as a framework for the creation of vendor specific + hot deployment tools. +

          + +

          +

          +
          See Also:
          HotDeploymentTool, +AbstractHotDeploymentTool, +GenericHotDeploymentTool, +WebLogicHotDeploymentTool
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ServerDeploy() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddGeneric(GenericHotDeploymentTool tool) + +
          +          Creates a generic deployment tool.
          + voidaddJonas(JonasHotDeploymentTool tool) + +
          +          Creates a JOnAS deployment tool, for deployment to JOnAS servers.
          + voidaddWeblogic(WebLogicHotDeploymentTool tool) + +
          +          Creates a WebLogic deployment tool, for deployment to WebLogic servers.
          + voidexecute() + +
          +          Execute the task.
          + java.lang.StringgetAction() + +
          +          Returns the action field.
          + java.io.FilegetSource() + +
          +          Returns the source field (the path/filename of the component to be + deployed.
          + voidsetAction(java.lang.String action) + +
          +          The action to be performed, usually "deploy"; required.
          + voidsetSource(java.io.File source) + +
          +          The filename of the component to be deployed; optional + depending upon the tool and the action.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ServerDeploy

          +
          +public ServerDeploy()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addGeneric

          +
          +public void addGeneric(GenericHotDeploymentTool tool)
          +
          +
          Creates a generic deployment tool. +

          Ant calls this method on creation to handle embedded "generic" elements + in the ServerDeploy task. +

          +

          +
          Parameters:
          tool - An instance of GenericHotDeployment tool, passed in by Ant.
          +
          +
          +
          + +

          +addWeblogic

          +
          +public void addWeblogic(WebLogicHotDeploymentTool tool)
          +
          +
          Creates a WebLogic deployment tool, for deployment to WebLogic servers. +

          Ant calls this method on creation to handle embedded "weblogic" elements + in the ServerDeploy task. +

          +

          +
          Parameters:
          tool - An instance of WebLogicHotDeployment tool, passed in by Ant.
          +
          +
          +
          + +

          +addJonas

          +
          +public void addJonas(JonasHotDeploymentTool tool)
          +
          +
          Creates a JOnAS deployment tool, for deployment to JOnAS servers. +

          Ant calls this method on creation to handle embedded "jonas" elements + in the ServerDeploy task. +

          +

          +
          Parameters:
          tool - An instance of JonasHotDeployment tool, passed in by Ant.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute the task. +

          This method calls the deploy() method on each of the vendor-specific tools + in the vendorTools collection. This performs the actual + process of deployment on each tool. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the attributes + are invalid or incomplete, or a failure occurs in the deployment process.
          +
          +
          +
          + +

          +getAction

          +
          +public java.lang.String getAction()
          +
          +
          Returns the action field. +

          +

          + +
          Returns:
          A string representing the "action" attribute.
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(java.lang.String action)
          +
          +
          The action to be performed, usually "deploy"; required. + Some tools support additional actions, such as "delete", "list", "undeploy", "update"... +

          +

          +
          Parameters:
          action - A String representing the "action" attribute.
          +
          +
          +
          + +

          +getSource

          +
          +public java.io.File getSource()
          +
          +
          Returns the source field (the path/filename of the component to be + deployed. +

          +

          + +
          Returns:
          A File object representing the "source" attribute.
          +
          +
          +
          + +

          +setSource

          +
          +public void setSource(java.io.File source)
          +
          +
          The filename of the component to be deployed; optional + depending upon the tool and the action. +

          +

          +
          Parameters:
          source - String representing the "source" attribute.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.html new file mode 100644 index 000000000..28987ee88 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.html @@ -0,0 +1,583 @@ + + + + + + +WebLogicHotDeploymentTool (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.j2ee +
          +Class WebLogicHotDeploymentTool

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
+      extended by org.apache.tools.ant.taskdefs.optional.j2ee.WebLogicHotDeploymentTool
+
          +
          +
          All Implemented Interfaces:
          HotDeploymentTool
          +
          +
          +
          +
          public class WebLogicHotDeploymentTool
          extends AbstractHotDeploymentTool
          implements HotDeploymentTool
          + + +

          +An Ant wrapper task for the weblogic.deploy tool. This is used to + hot-deploy J2EE applications to a running WebLogic server. + This is not the same as creating the application archive. + This task assumes the archive (EAR, JAR, or WAR) file has been + assembled and is supplied as the "source" attribute. +

          In the end, this task assembles the commadline parameters + and runs the weblogic.deploy tool in a seperate JVM. +

          + +

          +

          +
          See Also:
          HotDeploymentTool, +AbstractHotDeploymentTool, +ServerDeploy
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          ACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE
          +  + + + + + + + + + + +
          +Constructor Summary
          WebLogicHotDeploymentTool() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringBufferbuildArgsPrefix() + +
          +          Builds the prefix arguments to pass to weblogic.deploy.
          +protected  java.lang.StringbuildDeployArgs() + +
          +          Builds the arguments to pass to weblogic.deploy for deployment actions + ("deploy" and "update").
          +protected  java.lang.StringbuildListArgs() + +
          +          Builds the arguments to pass to weblogic.deploy for the list action
          +protected  java.lang.StringbuildUndeployArgs() + +
          +          Builds the arguments to pass to weblogic.deploy for undeployment actions + ("undeploy" and "delete").
          + voiddeploy() + +
          +          Perform the actual deployment.
          + java.lang.StringgetArguments() + +
          +          Builds the arguments to pass to weblogic.deploy according to the + supplied action.
          +protected  booleanisActionValid() + +
          +          Determines if the action supplied is valid.
          + voidsetApplication(java.lang.String application) + +
          +          The name of the application being deployed; required.
          + voidsetComponent(java.lang.String component) + +
          +          the component string for the deployment targets; optional.
          + voidsetDebug(boolean debug) + +
          +          If set to true, additional information will be + printed during the deployment process; optional.
          + voidvalidateAttributes() + +
          +          Validates the passed in attributes.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
          createClasspath, getClasspath, getPassword, getServer, getTask, getUserName, setClasspath, setPassword, setServer, setTask, setUserName
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
          setTask
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +WebLogicHotDeploymentTool

          +
          +public WebLogicHotDeploymentTool()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +deploy

          +
          +public void deploy()
          +
          +
          Perform the actual deployment. + For this implementation, a JVM is spawned and the weblogic.deploy + tools is executed. +

          +

          +
          Specified by:
          deploy in interface HotDeploymentTool
          Specified by:
          deploy in class AbstractHotDeploymentTool
          +
          +
          + +
          Throws: +
          BuildException - if the attributes are invalid or incomplete.
          +
          +
          +
          + +

          +validateAttributes

          +
          +public void validateAttributes()
+                        throws BuildException
          +
          +
          Validates the passed in attributes. +

          The rules are: +

          1. If action is "deploy" or "update" the "application" and "source" + attributes must be supplied. +
          2. If action is "delete" or "undeploy" the "application" attribute must + be supplied. +

            +

            +
            Specified by:
            validateAttributes in interface HotDeploymentTool
            Overrides:
            validateAttributes in class AbstractHotDeploymentTool
            +
            +
            + +
            Throws: +
            BuildException - if the attributes are invalid or incomplete
            +
            +
          +
          + +

          +getArguments

          +
          +public java.lang.String getArguments()
+                              throws BuildException
          +
          +
          Builds the arguments to pass to weblogic.deploy according to the + supplied action. +

          +

          +
          +
          +
          + +
          Returns:
          A String containing the arguments for the weblogic.deploy tool. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +isActionValid

          +
          +protected boolean isActionValid()
          +
          +
          Determines if the action supplied is valid. +

          Valid actions are contained in the static array VALID_ACTIONS +

          +

          +
          Specified by:
          isActionValid in class AbstractHotDeploymentTool
          +
          +
          + +
          Returns:
          true if the action attribute is valid, false if not.
          +
          +
          +
          + +

          +buildArgsPrefix

          +
          +protected java.lang.StringBuffer buildArgsPrefix()
          +
          +
          Builds the prefix arguments to pass to weblogic.deploy. + These arguments are generic across all actions. +

          +

          +
          +
          +
          + +
          Returns:
          A StringBuffer containing the prefix arguments. + The action-specific build methods will append to this StringBuffer.
          +
          +
          +
          + +

          +buildDeployArgs

          +
          +protected java.lang.String buildDeployArgs()
          +
          +
          Builds the arguments to pass to weblogic.deploy for deployment actions + ("deploy" and "update"). +

          +

          +
          +
          +
          + +
          Returns:
          A String containing the full argument string for weblogic.deploy.
          +
          +
          +
          + +

          +buildUndeployArgs

          +
          +protected java.lang.String buildUndeployArgs()
          +
          +
          Builds the arguments to pass to weblogic.deploy for undeployment actions + ("undeploy" and "delete"). +

          +

          +
          +
          +
          + +
          Returns:
          A String containing the full argument string for weblogic.deploy.
          +
          +
          +
          + +

          +buildListArgs

          +
          +protected java.lang.String buildListArgs()
          +
          +
          Builds the arguments to pass to weblogic.deploy for the list action +

          +

          +
          +
          +
          + +
          Returns:
          A String containing the full argument string for weblogic.deploy.
          +
          +
          +
          + +

          +setDebug

          +
          +public void setDebug(boolean debug)
          +
          +
          If set to true, additional information will be + printed during the deployment process; optional. +

          +

          +
          +
          +
          +
          Parameters:
          debug - A boolean representing weblogic.deploy "-debug" flag.
          +
          +
          +
          + +

          +setApplication

          +
          +public void setApplication(java.lang.String application)
          +
          +
          The name of the application being deployed; required. +

          +

          +
          +
          +
          +
          Parameters:
          application - A String representing the application portion of the + weblogic.deploy command line.
          +
          +
          +
          + +

          +setComponent

          +
          +public void setComponent(java.lang.String component)
          +
          +
          the component string for the deployment targets; optional. + It is in the form <component>:<target1>,<target2>... + Where component is the archive name (minus the .jar, .ear, .war + extension). Targets are the servers where the components will be deployed +

          +

          +
          +
          +
          +
          Parameters:
          component - A String representing the value of the "-component" + argument of the weblogic.deploy command line argument.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-frame.html new file mode 100644 index 000000000..0917c1464 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.j2ee (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.j2ee + + + + +
          +Interfaces  + +
          +HotDeploymentTool
          + + + + + + +
          +Classes  + +
          +AbstractHotDeploymentTool +
          +GenericHotDeploymentTool +
          +JonasHotDeploymentTool +
          +ServerDeploy +
          +WebLogicHotDeploymentTool
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-summary.html new file mode 100644 index 000000000..17cd5bf5a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-summary.html @@ -0,0 +1,182 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.j2ee (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.j2ee +

          + + + + + + + + + +
          +Interface Summary
          HotDeploymentToolAn interface for vendor-specific "hot" deployment tools.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractHotDeploymentToolAbstract class to support vendor-specific hot deployment tools.
          GenericHotDeploymentToolA generic tool for J2EE server hot deployment.
          JonasHotDeploymentToolAn Ant wrapper task for the weblogic.deploy tool.
          ServerDeployControls hot deployment tools for J2EE servers.
          WebLogicHotDeploymentToolAn Ant wrapper task for the weblogic.deploy tool.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-tree.html new file mode 100644 index 000000000..ea31654bf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/j2ee/package-tree.html @@ -0,0 +1,164 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.j2ee Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.j2ee +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJDoc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJDoc.html new file mode 100644 index 000000000..e35e9e7f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJDoc.html @@ -0,0 +1,418 @@ + + + + + + +JJDoc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javacc +
          +Class JJDoc

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.javacc.JJDoc
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JJDoc
          extends Task
          + + +

          +Runs the JJDoc compiler compiler. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JJDoc() + +
          +          Constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Do the task.
          + voidsetJavacchome(java.io.File javaccHome) + +
          +          The directory containing the JavaCC distribution.
          + voidsetOnetable(boolean oneTable) + +
          +          Sets the ONE_TABLE documentation option.
          + voidsetOutputfile(java.lang.String outputFile) + +
          +          The outputfile to write the generated BNF documentation file to.
          + voidsetTarget(java.io.File target) + +
          +          The javacc grammar file to process.
          + voidsetText(boolean plainText) + +
          +          Sets the TEXT BNF documentation option.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JJDoc

          +
          +public JJDoc()
          +
          +
          Constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setText

          +
          +public void setText(boolean plainText)
          +
          +
          Sets the TEXT BNF documentation option. +

          +

          +
          Parameters:
          plainText - a boolean value.
          +
          +
          +
          + +

          +setOnetable

          +
          +public void setOnetable(boolean oneTable)
          +
          +
          Sets the ONE_TABLE documentation option. +

          +

          +
          Parameters:
          oneTable - a boolean value.
          +
          +
          +
          + +

          +setOutputfile

          +
          +public void setOutputfile(java.lang.String outputFile)
          +
          +
          The outputfile to write the generated BNF documentation file to. + If not set, the file is written with the same name as + the JavaCC grammar file with a suffix .html or .txt. +

          +

          +
          Parameters:
          outputFile - the name of the output file.
          +
          +
          +
          + +

          +setTarget

          +
          +public void setTarget(java.io.File target)
          +
          +
          The javacc grammar file to process. +

          +

          +
          Parameters:
          target - the grammar file.
          +
          +
          +
          + +

          +setJavacchome

          +
          +public void setJavacchome(java.io.File javaccHome)
          +
          +
          The directory containing the JavaCC distribution. +

          +

          +
          Parameters:
          javaccHome - the home directory.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Do the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there is an error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.html new file mode 100644 index 000000000..352d9e5f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JJTree.html @@ -0,0 +1,630 @@ + + + + + + +JJTree (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javacc +
          +Class JJTree

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.javacc.JJTree
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JJTree
          extends Task
          + + +

          +Runs the JJTree compiler compiler. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JJTree() + +
          +          Constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Run the task.
          + voidsetBuildnodefiles(boolean buildNodeFiles) + +
          +          Sets the BUILD_NODE_FILES grammar option.
          + voidsetJavacchome(java.io.File javaccHome) + +
          +          The directory containing the JavaCC distribution.
          + voidsetMulti(boolean multi) + +
          +          Sets the MULTI grammar option.
          + voidsetNodedefaultvoid(boolean nodeDefaultVoid) + +
          +          Sets the NODE_DEFAULT_VOID grammar option.
          + voidsetNodefactory(boolean nodeFactory) + +
          +          Sets the NODE_FACTORY grammar option.
          + voidsetNodepackage(java.lang.String nodePackage) + +
          +          Sets the NODE_PACKAGE grammar option.
          + voidsetNodeprefix(java.lang.String nodePrefix) + +
          +          Sets the NODE_PREFIX grammar option.
          + voidsetNodescopehook(boolean nodeScopeHook) + +
          +          Sets the NODE_SCOPE_HOOK grammar option.
          + voidsetNodeusesparser(boolean nodeUsesParser) + +
          +          Sets the NODE_USES_PARSER grammar option.
          + voidsetOutputdirectory(java.io.File outputDirectory) + +
          +          The directory to write the generated JavaCC grammar and node files to.
          + voidsetOutputfile(java.lang.String outputFile) + +
          +          The outputfile to write the generated JavaCC grammar file to.
          + voidsetStatic(boolean staticParser) + +
          +          Sets the STATIC grammar option.
          + voidsetTarget(java.io.File targetFile) + +
          +          The jjtree grammar file to process.
          + voidsetVisitor(boolean visitor) + +
          +          Sets the VISITOR grammar option.
          + voidsetVisitorException(java.lang.String visitorException) + +
          +          Sets the VISITOR_EXCEPTION grammar option.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JJTree

          +
          +public JJTree()
          +
          +
          Constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setBuildnodefiles

          +
          +public void setBuildnodefiles(boolean buildNodeFiles)
          +
          +
          Sets the BUILD_NODE_FILES grammar option. +

          +

          +
          Parameters:
          buildNodeFiles - a boolean value.
          +
          +
          +
          + +

          +setMulti

          +
          +public void setMulti(boolean multi)
          +
          +
          Sets the MULTI grammar option. +

          +

          +
          Parameters:
          multi - a boolean value.
          +
          +
          +
          + +

          +setNodedefaultvoid

          +
          +public void setNodedefaultvoid(boolean nodeDefaultVoid)
          +
          +
          Sets the NODE_DEFAULT_VOID grammar option. +

          +

          +
          Parameters:
          nodeDefaultVoid - a boolean value.
          +
          +
          +
          + +

          +setNodefactory

          +
          +public void setNodefactory(boolean nodeFactory)
          +
          +
          Sets the NODE_FACTORY grammar option. +

          +

          +
          Parameters:
          nodeFactory - a boolean value.
          +
          +
          +
          + +

          +setNodescopehook

          +
          +public void setNodescopehook(boolean nodeScopeHook)
          +
          +
          Sets the NODE_SCOPE_HOOK grammar option. +

          +

          +
          Parameters:
          nodeScopeHook - a boolean value.
          +
          +
          +
          + +

          +setNodeusesparser

          +
          +public void setNodeusesparser(boolean nodeUsesParser)
          +
          +
          Sets the NODE_USES_PARSER grammar option. +

          +

          +
          Parameters:
          nodeUsesParser - a boolean value.
          +
          +
          +
          + +

          +setStatic

          +
          +public void setStatic(boolean staticParser)
          +
          +
          Sets the STATIC grammar option. +

          +

          +
          Parameters:
          staticParser - a boolean value.
          +
          +
          +
          + +

          +setVisitor

          +
          +public void setVisitor(boolean visitor)
          +
          +
          Sets the VISITOR grammar option. +

          +

          +
          Parameters:
          visitor - a boolean value.
          +
          +
          +
          + +

          +setNodepackage

          +
          +public void setNodepackage(java.lang.String nodePackage)
          +
          +
          Sets the NODE_PACKAGE grammar option. +

          +

          +
          Parameters:
          nodePackage - the option to use.
          +
          +
          +
          + +

          +setVisitorException

          +
          +public void setVisitorException(java.lang.String visitorException)
          +
          +
          Sets the VISITOR_EXCEPTION grammar option. +

          +

          +
          Parameters:
          visitorException - the option to use.
          +
          +
          +
          + +

          +setNodeprefix

          +
          +public void setNodeprefix(java.lang.String nodePrefix)
          +
          +
          Sets the NODE_PREFIX grammar option. +

          +

          +
          Parameters:
          nodePrefix - the option to use.
          +
          +
          +
          + +

          +setOutputdirectory

          +
          +public void setOutputdirectory(java.io.File outputDirectory)
          +
          +
          The directory to write the generated JavaCC grammar and node files to. + If not set, the files are written to the directory + containing the grammar file. +

          +

          +
          Parameters:
          outputDirectory - the output directory.
          +
          +
          +
          + +

          +setOutputfile

          +
          +public void setOutputfile(java.lang.String outputFile)
          +
          +
          The outputfile to write the generated JavaCC grammar file to. + If not set, the file is written with the same name as + the JJTree grammar file with a suffix .jj. +

          +

          +
          Parameters:
          outputFile - the output file name.
          +
          +
          +
          + +

          +setTarget

          +
          +public void setTarget(java.io.File targetFile)
          +
          +
          The jjtree grammar file to process. +

          +

          +
          Parameters:
          targetFile - the grammar file.
          +
          +
          +
          + +

          +setJavacchome

          +
          +public void setJavacchome(java.io.File javaccHome)
          +
          +
          The directory containing the JavaCC distribution. +

          +

          +
          Parameters:
          javaccHome - the directory containing JavaCC.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.html new file mode 100644 index 000000000..bc575bb8c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/JavaCC.html @@ -0,0 +1,1213 @@ + + + + + + +JavaCC (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javacc +
          +Class JavaCC

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.javacc.JavaCC
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JavaCC
          extends Task
          + + +

          +JavaCC compiler compiler task. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static java.lang.String[]ARCHIVE_LOCATIONS + +
          +           
          +protected static int[]ARCHIVE_LOCATIONS_VS_MAJOR_VERSION + +
          +           
          +protected static java.lang.StringCOM_JAVACC_CLASS + +
          +           
          +protected static java.lang.StringCOM_JJDOC_CLASS + +
          +           
          +protected static java.lang.StringCOM_JJTREE_CLASS + +
          +           
          +protected static java.lang.StringCOM_PACKAGE + +
          +           
          +protected static java.lang.StringORG_JAVACC_CLASS + +
          +           
          +protected static java.lang.StringORG_JJDOC_CLASS + +
          +           
          +protected static java.lang.StringORG_JJTREE_CLASS + +
          +           
          +protected static java.lang.StringORG_PACKAGE_3_0 + +
          +           
          +protected static java.lang.StringORG_PACKAGE_3_1 + +
          +           
          +protected static intTASKDEF_TYPE_JAVACC + +
          +           
          +protected static intTASKDEF_TYPE_JJDOC + +
          +           
          +protected static intTASKDEF_TYPE_JJTREE + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JavaCC() + +
          +          Constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Run the task.
          +protected static java.io.FilegetArchiveFile(java.io.File home) + +
          +          Helper method to retrieve the path used to store the JavaCC.zip + or javacc.jar which is different from versions.
          +protected static java.lang.StringgetMainClass(java.io.File home, + int type) + +
          +          Helper method to retrieve main class which is different from versions.
          +protected static java.lang.StringgetMainClass(Path path, + int type) + +
          +          Helper method to retrieve main class which is different from versions.
          +protected static intgetMajorVersionNumber(java.io.File home) + +
          +          Helper method to determine the major version number of JavaCC.
          + voidsetBuildparser(boolean buildParser) + +
          +          Sets the BUILD_PARSER grammar option.
          + voidsetBuildtokenmanager(boolean buildTokenManager) + +
          +          Sets the BUILD_TOKEN_MANAGER grammar option.
          + voidsetCachetokens(boolean cacheTokens) + +
          +          Sets the CACHE_TOKENS grammar option.
          + voidsetChoiceambiguitycheck(int choiceAmbiguityCheck) + +
          +          Sets the CHOICE_AMBIGUITY_CHECK grammar option.
          + voidsetCommontokenaction(boolean commonTokenAction) + +
          +          Sets the COMMON_TOKEN_ACTION grammar option.
          + voidsetDebuglookahead(boolean debugLookahead) + +
          +          Sets the DEBUG_LOOKAHEAD grammar option.
          + voidsetDebugparser(boolean debugParser) + +
          +          Sets the DEBUG_PARSER grammar option.
          + voidsetDebugtokenmanager(boolean debugTokenManager) + +
          +          Sets the DEBUG_TOKEN_MANAGER grammar option.
          + voidsetErrorreporting(boolean errorReporting) + +
          +          Sets the ERROR_REPORTING grammar option.
          + voidsetForcelacheck(boolean forceLACheck) + +
          +          Sets the FORCE_LA_CHECK grammar option.
          + voidsetIgnorecase(boolean ignoreCase) + +
          +          Sets the IGNORE_CASE grammar option.
          + voidsetJavacchome(java.io.File javaccHome) + +
          +          The directory containing the JavaCC distribution.
          + voidsetJavaunicodeescape(boolean javaUnicodeEscape) + +
          +          Sets the JAVA_UNICODE_ESCAPE grammar option.
          + voidsetJDKversion(java.lang.String jdkVersion) + +
          +          Sets the JDK_VERSION option.
          + voidsetKeeplinecolumn(boolean keepLineColumn) + +
          +          Sets the KEEP_LINE_COLUMN grammar option.
          + voidsetLookahead(int lookahead) + +
          +          Sets the LOOKAHEAD grammar option.
          + voidsetOptimizetokenmanager(boolean optimizeTokenManager) + +
          +          Sets the OPTIMIZE_TOKEN_MANAGER grammar option.
          + voidsetOtherambiguityCheck(int otherAmbiguityCheck) + +
          +          Sets the OTHER_AMBIGUITY_CHECK grammar option.
          + voidsetOutputdirectory(java.io.File outputDirectory) + +
          +          The directory to write the generated files to.
          + voidsetSanitycheck(boolean sanityCheck) + +
          +          Sets the SANITY_CHECK grammar option.
          + voidsetStatic(boolean staticParser) + +
          +          Sets the STATIC grammar option.
          + voidsetTarget(java.io.File targetFile) + +
          +          The grammar file to process.
          + voidsetUnicodeinput(boolean unicodeInput) + +
          +          Sets the UNICODE_INPUT grammar option.
          + voidsetUsercharstream(boolean userCharStream) + +
          +          Sets the USER_CHAR_STREAM grammar option.
          + voidsetUsertokenmanager(boolean userTokenManager) + +
          +          Sets the USER_TOKEN_MANAGER grammar option.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +TASKDEF_TYPE_JAVACC

          +
          +protected static final int TASKDEF_TYPE_JAVACC
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TASKDEF_TYPE_JJTREE

          +
          +protected static final int TASKDEF_TYPE_JJTREE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TASKDEF_TYPE_JJDOC

          +
          +protected static final int TASKDEF_TYPE_JJDOC
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ARCHIVE_LOCATIONS

          +
          +protected static final java.lang.String[] ARCHIVE_LOCATIONS
          +
          +
          +
          +
          +
          + +

          +ARCHIVE_LOCATIONS_VS_MAJOR_VERSION

          +
          +protected static final int[] ARCHIVE_LOCATIONS_VS_MAJOR_VERSION
          +
          +
          +
          +
          +
          + +

          +COM_PACKAGE

          +
          +protected static final java.lang.String COM_PACKAGE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COM_JAVACC_CLASS

          +
          +protected static final java.lang.String COM_JAVACC_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COM_JJTREE_CLASS

          +
          +protected static final java.lang.String COM_JJTREE_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COM_JJDOC_CLASS

          +
          +protected static final java.lang.String COM_JJDOC_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ORG_PACKAGE_3_0

          +
          +protected static final java.lang.String ORG_PACKAGE_3_0
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ORG_PACKAGE_3_1

          +
          +protected static final java.lang.String ORG_PACKAGE_3_1
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ORG_JAVACC_CLASS

          +
          +protected static final java.lang.String ORG_JAVACC_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ORG_JJTREE_CLASS

          +
          +protected static final java.lang.String ORG_JJTREE_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ORG_JJDOC_CLASS

          +
          +protected static final java.lang.String ORG_JJDOC_CLASS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JavaCC

          +
          +public JavaCC()
          +
          +
          Constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setLookahead

          +
          +public void setLookahead(int lookahead)
          +
          +
          Sets the LOOKAHEAD grammar option. +

          +

          +
          Parameters:
          lookahead - an int value.
          +
          +
          +
          + +

          +setChoiceambiguitycheck

          +
          +public void setChoiceambiguitycheck(int choiceAmbiguityCheck)
          +
          +
          Sets the CHOICE_AMBIGUITY_CHECK grammar option. +

          +

          +
          Parameters:
          choiceAmbiguityCheck - an int value.
          +
          +
          +
          + +

          +setOtherambiguityCheck

          +
          +public void setOtherambiguityCheck(int otherAmbiguityCheck)
          +
          +
          Sets the OTHER_AMBIGUITY_CHECK grammar option. +

          +

          +
          Parameters:
          otherAmbiguityCheck - an int value.
          +
          +
          +
          + +

          +setStatic

          +
          +public void setStatic(boolean staticParser)
          +
          +
          Sets the STATIC grammar option. +

          +

          +
          Parameters:
          staticParser - a boolean value.
          +
          +
          +
          + +

          +setDebugparser

          +
          +public void setDebugparser(boolean debugParser)
          +
          +
          Sets the DEBUG_PARSER grammar option. +

          +

          +
          Parameters:
          debugParser - a boolean value.
          +
          +
          +
          + +

          +setDebuglookahead

          +
          +public void setDebuglookahead(boolean debugLookahead)
          +
          +
          Sets the DEBUG_LOOKAHEAD grammar option. +

          +

          +
          Parameters:
          debugLookahead - a boolean value.
          +
          +
          +
          + +

          +setDebugtokenmanager

          +
          +public void setDebugtokenmanager(boolean debugTokenManager)
          +
          +
          Sets the DEBUG_TOKEN_MANAGER grammar option. +

          +

          +
          Parameters:
          debugTokenManager - a boolean value.
          +
          +
          +
          + +

          +setOptimizetokenmanager

          +
          +public void setOptimizetokenmanager(boolean optimizeTokenManager)
          +
          +
          Sets the OPTIMIZE_TOKEN_MANAGER grammar option. +

          +

          +
          Parameters:
          optimizeTokenManager - a boolean value.
          +
          +
          +
          + +

          +setErrorreporting

          +
          +public void setErrorreporting(boolean errorReporting)
          +
          +
          Sets the ERROR_REPORTING grammar option. +

          +

          +
          Parameters:
          errorReporting - a boolean value.
          +
          +
          +
          + +

          +setJavaunicodeescape

          +
          +public void setJavaunicodeescape(boolean javaUnicodeEscape)
          +
          +
          Sets the JAVA_UNICODE_ESCAPE grammar option. +

          +

          +
          Parameters:
          javaUnicodeEscape - a boolean value.
          +
          +
          +
          + +

          +setUnicodeinput

          +
          +public void setUnicodeinput(boolean unicodeInput)
          +
          +
          Sets the UNICODE_INPUT grammar option. +

          +

          +
          Parameters:
          unicodeInput - a boolean value.
          +
          +
          +
          + +

          +setIgnorecase

          +
          +public void setIgnorecase(boolean ignoreCase)
          +
          +
          Sets the IGNORE_CASE grammar option. +

          +

          +
          Parameters:
          ignoreCase - a boolean value.
          +
          +
          +
          + +

          +setCommontokenaction

          +
          +public void setCommontokenaction(boolean commonTokenAction)
          +
          +
          Sets the COMMON_TOKEN_ACTION grammar option. +

          +

          +
          Parameters:
          commonTokenAction - a boolean value.
          +
          +
          +
          + +

          +setUsertokenmanager

          +
          +public void setUsertokenmanager(boolean userTokenManager)
          +
          +
          Sets the USER_TOKEN_MANAGER grammar option. +

          +

          +
          Parameters:
          userTokenManager - a boolean value.
          +
          +
          +
          + +

          +setUsercharstream

          +
          +public void setUsercharstream(boolean userCharStream)
          +
          +
          Sets the USER_CHAR_STREAM grammar option. +

          +

          +
          Parameters:
          userCharStream - a boolean value.
          +
          +
          +
          + +

          +setBuildparser

          +
          +public void setBuildparser(boolean buildParser)
          +
          +
          Sets the BUILD_PARSER grammar option. +

          +

          +
          Parameters:
          buildParser - a boolean value.
          +
          +
          +
          + +

          +setBuildtokenmanager

          +
          +public void setBuildtokenmanager(boolean buildTokenManager)
          +
          +
          Sets the BUILD_TOKEN_MANAGER grammar option. +

          +

          +
          Parameters:
          buildTokenManager - a boolean value.
          +
          +
          +
          + +

          +setSanitycheck

          +
          +public void setSanitycheck(boolean sanityCheck)
          +
          +
          Sets the SANITY_CHECK grammar option. +

          +

          +
          Parameters:
          sanityCheck - a boolean value.
          +
          +
          +
          + +

          +setForcelacheck

          +
          +public void setForcelacheck(boolean forceLACheck)
          +
          +
          Sets the FORCE_LA_CHECK grammar option. +

          +

          +
          Parameters:
          forceLACheck - a boolean value.
          +
          +
          +
          + +

          +setCachetokens

          +
          +public void setCachetokens(boolean cacheTokens)
          +
          +
          Sets the CACHE_TOKENS grammar option. +

          +

          +
          Parameters:
          cacheTokens - a boolean value.
          +
          +
          +
          + +

          +setKeeplinecolumn

          +
          +public void setKeeplinecolumn(boolean keepLineColumn)
          +
          +
          Sets the KEEP_LINE_COLUMN grammar option. +

          +

          +
          Parameters:
          keepLineColumn - a boolean value.
          +
          +
          +
          + +

          +setJDKversion

          +
          +public void setJDKversion(java.lang.String jdkVersion)
          +
          +
          Sets the JDK_VERSION option. +

          +

          +
          Parameters:
          jdkVersion - the version to use.
          Since:
          +
          Ant1.7
          +
          +
          +
          +
          + +

          +setOutputdirectory

          +
          +public void setOutputdirectory(java.io.File outputDirectory)
          +
          +
          The directory to write the generated files to. + If not set, the files are written to the directory + containing the grammar file. +

          +

          +
          Parameters:
          outputDirectory - the output directory.
          +
          +
          +
          + +

          +setTarget

          +
          +public void setTarget(java.io.File targetFile)
          +
          +
          The grammar file to process. +

          +

          +
          Parameters:
          targetFile - the grammar file.
          +
          +
          +
          + +

          +setJavacchome

          +
          +public void setJavacchome(java.io.File javaccHome)
          +
          +
          The directory containing the JavaCC distribution. +

          +

          +
          Parameters:
          javaccHome - the directory.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +getArchiveFile

          +
          +protected static java.io.File getArchiveFile(java.io.File home)
+                                      throws BuildException
          +
          +
          Helper method to retrieve the path used to store the JavaCC.zip + or javacc.jar which is different from versions. +

          +

          +
          Parameters:
          home - the javacc home path directory. +
          Returns:
          the file object pointing to the JavaCC archive. +
          Throws: +
          BuildException - thrown if the home directory is invalid + or if the archive could not be found despite attempts to do so.
          +
          +
          +
          + +

          +getMainClass

          +
          +protected static java.lang.String getMainClass(java.io.File home,
+                                               int type)
+                                        throws BuildException
          +
          +
          Helper method to retrieve main class which is different from versions. +

          +

          +
          Parameters:
          home - the javacc home path directory.
          type - the taskdef. +
          Returns:
          the main class for the taskdef. +
          Throws: +
          BuildException - thrown if the home directory is invalid + or if the archive could not be found despite attempts to do so.
          +
          +
          +
          + +

          +getMainClass

          +
          +protected static java.lang.String getMainClass(Path path,
+                                               int type)
+                                        throws BuildException
          +
          +
          Helper method to retrieve main class which is different from versions. +

          +

          +
          Parameters:
          path - classpath to search in.
          type - the taskdef. +
          Returns:
          the main class for the taskdef. +
          Throws: +
          BuildException - thrown if the home directory is invalid + or if the archive could not be found despite attempts to do so.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getMajorVersionNumber

          +
          +protected static int getMajorVersionNumber(java.io.File home)
+                                    throws BuildException
          +
          +
          Helper method to determine the major version number of JavaCC. +

          +

          +
          Parameters:
          home - the javacc home path directory. +
          Returns:
          a the major version number +
          Throws: +
          BuildException - thrown if the home directory is invalid + or if the archive could not be found despite attempts to do so.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-frame.html new file mode 100644 index 000000000..b49d42a7b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javacc (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.javacc + + + + +
          +Classes  + +
          +JavaCC +
          +JJDoc +
          +JJTree
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-summary.html new file mode 100644 index 000000000..089fa772e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-summary.html @@ -0,0 +1,160 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javacc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.javacc +

          + + + + + + + + + + + + + + + + + +
          +Class Summary
          JavaCCJavaCC compiler compiler task.
          JJDocRuns the JJDoc compiler compiler.
          JJTreeRuns the JJTree compiler compiler.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-tree.html new file mode 100644 index 000000000..49bd418bb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javacc/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javacc Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.javacc +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.javacc.JavaCC
                • org.apache.tools.ant.taskdefs.optional.javacc.JJDoc
                • org.apache.tools.ant.taskdefs.optional.javacc.JJTree
                +
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Gcjh.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Gcjh.html new file mode 100644 index 000000000..3ecc07de6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Gcjh.html @@ -0,0 +1,303 @@ + + + + + + +Gcjh (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javah +
          +Class Gcjh

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.javah.Gcjh
+
          +
          +
          All Implemented Interfaces:
          JavahAdapter
          +
          +
          +
          +
          public class Gcjh
          extends java.lang.Object
          implements JavahAdapter
          + + +

          +Adapter to the native gcjh compiler. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.2
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringIMPLEMENTATION_NAME + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          Gcjh() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + booleancompile(Javah javah) + +
          +          Performs the actual compilation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IMPLEMENTATION_NAME

          +
          +public static final java.lang.String IMPLEMENTATION_NAME
          +
          +
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Gcjh

          +
          +public Gcjh()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +compile

          +
          +public boolean compile(Javah javah)
+                throws BuildException
          +
          +
          Performs the actual compilation. +

          +

          +
          Specified by:
          compile in interface JavahAdapter
          +
          +
          +
          Parameters:
          javah - the calling javah task. +
          Returns:
          true if the compilation was successful. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.html new file mode 100644 index 000000000..67cd495e0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapter.html @@ -0,0 +1,220 @@ + + + + + + +JavahAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javah +
          +Interface JavahAdapter

          +
          +
          All Known Implementing Classes:
          Gcjh, Kaffeh, SunJavah
          +
          +
          +
          +
          public interface JavahAdapter
          + + +

          +Interface for different backend implementations of the Javah task. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + booleancompile(Javah javah) + +
          +          Performs the actual compilation.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +compile

          +
          +boolean compile(Javah javah)
+                throws BuildException
          +
          +
          Performs the actual compilation. +

          +

          +
          Parameters:
          javah - the calling javah task. +
          Returns:
          true if the compilation was successful. +
          Throws: +
          BuildException - if there is an error.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.html new file mode 100644 index 000000000..931fd907e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/JavahAdapterFactory.html @@ -0,0 +1,327 @@ + + + + + + +JavahAdapterFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javah +
          +Class JavahAdapterFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory
+
          +
          +
          +
          public class JavahAdapterFactory
          extends java.lang.Object
          + + +

          +Creates the JavahAdapter based on the user choice and + potentially the VM vendor. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JavahAdapterFactory() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static JavahAdaptergetAdapter(java.lang.String choice, + ProjectComponent log) + +
          +          Creates the JavahAdapter based on the user choice and + potentially the VM vendor.
          +static JavahAdaptergetAdapter(java.lang.String choice, + ProjectComponent log, + Path classpath) + +
          +          Creates the JavahAdapter based on the user choice and + potentially the VM vendor.
          +static java.lang.StringgetDefault() + +
          +          Determines the default choice of adapter based on the VM + vendor.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JavahAdapterFactory

          +
          +public JavahAdapterFactory()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getDefault

          +
          +public static java.lang.String getDefault()
          +
          +
          Determines the default choice of adapter based on the VM + vendor. +

          +

          + +
          Returns:
          the default choice of adapter based on the VM + vendor
          +
          +
          +
          + +

          +getAdapter

          +
          +public static JavahAdapter getAdapter(java.lang.String choice,
+                                      ProjectComponent log)
+                               throws BuildException
          +
          +
          Creates the JavahAdapter based on the user choice and + potentially the VM vendor. +

          +

          +
          Parameters:
          choice - the user choice (if any).
          log - a ProjectComponent instance used to access Ant's + logging system. +
          Returns:
          The adapter to use. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +getAdapter

          +
          +public static JavahAdapter getAdapter(java.lang.String choice,
+                                      ProjectComponent log,
+                                      Path classpath)
+                               throws BuildException
          +
          +
          Creates the JavahAdapter based on the user choice and + potentially the VM vendor. +

          +

          +
          Parameters:
          choice - the user choice (if any).
          log - a ProjectComponent instance used to access Ant's + logging system.
          classpath - the classpath to use when looking up an + adapter class +
          Returns:
          The adapter to use. +
          Throws: +
          BuildException - if there is an error.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.html new file mode 100644 index 000000000..e3d3cacdf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/Kaffeh.html @@ -0,0 +1,307 @@ + + + + + + +Kaffeh (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javah +
          +Class Kaffeh

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.javah.Kaffeh
+
          +
          +
          All Implemented Interfaces:
          JavahAdapter
          +
          +
          +
          +
          public class Kaffeh
          extends java.lang.Object
          implements JavahAdapter
          + + +

          +Adapter to the native kaffeh compiler. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringIMPLEMENTATION_NAME + +
          +          the name of the javah adapter - kaffeh
          +  + + + + + + + + + + +
          +Constructor Summary
          Kaffeh() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + booleancompile(Javah javah) + +
          +          Performs the actual compilation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IMPLEMENTATION_NAME

          +
          +public static final java.lang.String IMPLEMENTATION_NAME
          +
          +
          the name of the javah adapter - kaffeh +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Kaffeh

          +
          +public Kaffeh()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +compile

          +
          +public boolean compile(Javah javah)
+                throws BuildException
          +
          +
          Performs the actual compilation. +

          +

          +
          Specified by:
          compile in interface JavahAdapter
          +
          +
          +
          Parameters:
          javah - the calling javah task. +
          Returns:
          true if the compilation was successful. +
          Throws: +
          BuildException - if there is an error.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.html new file mode 100644 index 000000000..500fa8ab9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/SunJavah.html @@ -0,0 +1,307 @@ + + + + + + +SunJavah (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.javah +
          +Class SunJavah

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.javah.SunJavah
+
          +
          +
          All Implemented Interfaces:
          JavahAdapter
          +
          +
          +
          +
          public class SunJavah
          extends java.lang.Object
          implements JavahAdapter
          + + +

          +Adapter to com.sun.tools.javah.oldjavah.Main or com.sun.tools.javah.Main. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringIMPLEMENTATION_NAME + +
          +          the name of the javah adapter - sun
          +  + + + + + + + + + + +
          +Constructor Summary
          SunJavah() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + booleancompile(Javah javah) + +
          +          Performs the actual compilation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IMPLEMENTATION_NAME

          +
          +public static final java.lang.String IMPLEMENTATION_NAME
          +
          +
          the name of the javah adapter - sun +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SunJavah

          +
          +public SunJavah()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +compile

          +
          +public boolean compile(Javah javah)
+                throws BuildException
          +
          +
          Performs the actual compilation. +

          +

          +
          Specified by:
          compile in interface JavahAdapter
          +
          +
          +
          Parameters:
          javah - the calling javah task. +
          Returns:
          true if the compilation was successful. +
          Throws: +
          BuildException - if there is an error.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-frame.html new file mode 100644 index 000000000..5131a53e4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-frame.html @@ -0,0 +1,49 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javah (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.javah + + + + +
          +Interfaces  + +
          +JavahAdapter
          + + + + + + +
          +Classes  + +
          +Gcjh +
          +JavahAdapterFactory +
          +Kaffeh +
          +SunJavah
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-summary.html new file mode 100644 index 000000000..2054255a2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-summary.html @@ -0,0 +1,179 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javah (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.javah +

          + + + + + + + + + +
          +Interface Summary
          JavahAdapterInterface for different backend implementations of the Javah task.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          GcjhAdapter to the native gcjh compiler.
          JavahAdapterFactoryCreates the JavahAdapter based on the user choice and + potentially the VM vendor.
          KaffehAdapter to the native kaffeh compiler.
          SunJavahAdapter to com.sun.tools.javah.oldjavah.Main or com.sun.tools.javah.Main.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-tree.html new file mode 100644 index 000000000..079e63ebd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/javah/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.javah Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.javah +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.taskdefs.optional.javah.Gcjh (implements org.apache.tools.ant.taskdefs.optional.javah.JavahAdapter) +
            • org.apache.tools.ant.taskdefs.optional.javah.JavahAdapterFactory
            • org.apache.tools.ant.taskdefs.optional.javah.Kaffeh (implements org.apache.tools.ant.taskdefs.optional.javah.JavahAdapter) +
            • org.apache.tools.ant.taskdefs.optional.javah.SunJavah (implements org.apache.tools.ant.taskdefs.optional.javah.JavahAdapter) +
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.FormatAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.FormatAttribute.html new file mode 100644 index 000000000..89a1dc0f6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.FormatAttribute.html @@ -0,0 +1,292 @@ + + + + + + +JDependTask.FormatAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jdepend +
          +Class JDependTask.FormatAttribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask.FormatAttribute
+
          +
          +
          Enclosing class:
          JDependTask
          +
          +
          +
          +
          public static class JDependTask.FormatAttribute
          extends EnumeratedAttribute
          + + +

          +A class for the enumerated attribute format, + values are xml and text. +

          + +

          +

          +
          See Also:
          EnumeratedAttribute
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          JDependTask.FormatAttribute() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JDependTask.FormatAttribute

          +
          +public JDependTask.FormatAttribute()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the enumerated values
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.html new file mode 100644 index 000000000..f3bcfdea3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/JDependTask.html @@ -0,0 +1,934 @@ + + + + + + +JDependTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jdepend +
          +Class JDependTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.jdepend.JDependTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JDependTask
          extends Task
          + + +

          +Runs JDepend tests. + +

          JDepend is a tool to generate design quality metrics for each Java package. + It has been initially created by Mike Clark. JDepend can be found at http://www.clarkware.com/software/JDepend.html. + + The current implementation spawn a new Java VM. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classJDependTask.FormatAttribute + +
          +          A class for the enumerated attribute format, + values are xml and text.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JDependTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateClassespath() + +
          +          Adds a path to class code to analyze.
          + PathcreateClasspath() + +
          +          Adds a path to the classpath.
          + PatternSet.NameEntrycreateExclude() + +
          +          add a name entry on the exclude list
          + Commandline.ArgumentcreateJvmarg(CommandlineJava commandline) + +
          +          Create a new JVM argument.
          + PathcreateSourcespath() + +
          +          Deprecated. since 1.6.x.
          +protected  ExecuteWatchdogcreateWatchdog() + +
          +           
          + voidexecute() + +
          +          execute the task
          + intexecuteAsForked(CommandlineJava commandline, + ExecuteWatchdog watchdog) + +
          +          Execute the task by forking a new JVM.
          + intexecuteInVM(CommandlineJava commandline) + +
          +          Execute inside VM.
          + PathgetClassespath() + +
          +          Gets the classespath.
          + PathgetClasspath() + +
          +          Gets the classpath to be used for this compilation.
          + java.io.FilegetDir() + +
          +           
          + PatternSetgetExcludes() + +
          +           
          + booleangetFork() + +
          +           
          + booleangetHaltonerror() + +
          +           
          + java.io.FilegetOutputFile() + +
          +           
          + PathgetSourcespath() + +
          +          Deprecated. since 1.6.x.
          + java.lang.LonggetTimeout() + +
          +           
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used for this compilation.
          + voidsetClasspathRef(Reference r) + +
          +          Adds a reference to a classpath defined elsewhere.
          + voidsetDir(java.io.File dir) + +
          +          The directory to invoke the VM in.
          + voidsetFork(boolean value) + +
          +          If true, forks into a new JVM.
          + voidsetFormat(JDependTask.FormatAttribute ea) + +
          +          The format to write the output in, "xml" or "text".
          + voidsetHaltonerror(boolean haltonerror) + +
          +          Whether or not to halt on failure.
          + voidsetIncluderuntime(boolean b) + +
          +          If true, + include jdepend.jar in the forked VM.
          + voidsetJvm(java.lang.String value) + +
          +          The command used to invoke a forked Java Virtual Machine.
          + voidsetOutputFile(java.io.File outputFile) + +
          +          The output file name.
          + voidsetTimeout(java.lang.Long value) + +
          +          Set the timeout value (in milliseconds).
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JDependTask

          +
          +public JDependTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setIncluderuntime

          +
          +public void setIncluderuntime(boolean b)
          +
          +
          If true, + include jdepend.jar in the forked VM. +

          +

          +
          Parameters:
          b - include ant run time yes or no
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Long value)
          +
          +
          Set the timeout value (in milliseconds). + +

          If the operation is running for more than this value, the jdepend + will be canceled. (works only when in 'fork' mode).

          +

          +

          +
          Parameters:
          value - the maximum time (in milliseconds) allowed before + declaring the test as 'timed-out'
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +getTimeout

          +
          +public java.lang.Long getTimeout()
          +
          +
          + +
          Returns:
          the timeout value
          +
          +
          +
          + +

          +setOutputFile

          +
          +public void setOutputFile(java.io.File outputFile)
          +
          +
          The output file name. +

          +

          +
          Parameters:
          outputFile - the output file name
          +
          +
          +
          + +

          +getOutputFile

          +
          +public java.io.File getOutputFile()
          +
          +
          + +
          Returns:
          the output file name
          +
          +
          +
          + +

          +setHaltonerror

          +
          +public void setHaltonerror(boolean haltonerror)
          +
          +
          Whether or not to halt on failure. Default: false. +

          +

          +
          Parameters:
          haltonerror - the value to set
          +
          +
          +
          + +

          +getHaltonerror

          +
          +public boolean getHaltonerror()
          +
          +
          + +
          Returns:
          the value of the haltonerror attribute
          +
          +
          +
          + +

          +setFork

          +
          +public void setFork(boolean value)
          +
          +
          If true, forks into a new JVM. Default: false. +

          +

          +
          Parameters:
          value - true if a JVM should be forked, + otherwise false
          +
          +
          +
          + +

          +getFork

          +
          +public boolean getFork()
          +
          +
          + +
          Returns:
          the value of the fork attribute
          +
          +
          +
          + +

          +setJvm

          +
          +public void setJvm(java.lang.String value)
          +
          +
          The command used to invoke a forked Java Virtual Machine. + + Default is java. Ignored if no JVM is forked. +

          +

          +
          Parameters:
          value - the new VM to use instead of java
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +createSourcespath

          +
          +public Path createSourcespath()
          +
          +
          Deprecated. since 1.6.x. +

          +

          Adds a path to source code to analyze. +

          +

          + +
          Returns:
          a source path
          +
          +
          +
          + +

          +getSourcespath

          +
          +public Path getSourcespath()
          +
          +
          Deprecated. since 1.6.x. +

          +

          Gets the sourcepath. +

          +

          + +
          Returns:
          the sources path
          +
          +
          +
          + +

          +createClassespath

          +
          +public Path createClassespath()
          +
          +
          Adds a path to class code to analyze. +

          +

          + +
          Returns:
          a classes path
          +
          +
          +
          + +

          +getClassespath

          +
          +public Path getClassespath()
          +
          +
          Gets the classespath. +

          +

          + +
          Returns:
          the classes path
          +
          +
          +
          + +

          +setDir

          +
          +public void setDir(java.io.File dir)
          +
          +
          The directory to invoke the VM in. Ignored if no JVM is forked. +

          +

          +
          Parameters:
          dir - the directory to invoke the JVM from.
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +getDir

          +
          +public java.io.File getDir()
          +
          +
          + +
          Returns:
          the dir attribute
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used for this compilation. +

          +

          +
          Parameters:
          classpath - a class path to be used
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          Gets the classpath to be used for this compilation. +

          +

          + +
          Returns:
          the class path used for compilation
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Adds a path to the classpath. +

          +

          + +
          Returns:
          a classpath
          +
          +
          +
          + +

          +createJvmarg

          +
          +public Commandline.Argument createJvmarg(CommandlineJava commandline)
          +
          +
          Create a new JVM argument. Ignored if no JVM is forked. +

          +

          +
          Parameters:
          commandline - the commandline to create the argument on +
          Returns:
          create a new JVM argument so that any argument can + be passed to the JVM.
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Adds a reference to a classpath defined elsewhere. +

          +

          +
          Parameters:
          r - a classpath reference
          +
          +
          +
          + +

          +createExclude

          +
          +public PatternSet.NameEntry createExclude()
          +
          +
          add a name entry on the exclude list +

          +

          + +
          Returns:
          a pattern for the excludes
          +
          +
          +
          + +

          +getExcludes

          +
          +public PatternSet getExcludes()
          +
          +
          + +
          Returns:
          the excludes patterns
          +
          +
          +
          + +

          +setFormat

          +
          +public void setFormat(JDependTask.FormatAttribute ea)
          +
          +
          The format to write the output in, "xml" or "text". +

          +

          +
          Parameters:
          ea - xml or text
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          execute the task +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +executeInVM

          +
          +public int executeInVM(CommandlineJava commandline)
+                throws BuildException
          +
          +
          Execute inside VM. +

          +

          +
          Parameters:
          commandline - the command line +
          Returns:
          the return value of the mvm +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +executeAsForked

          +
          +public int executeAsForked(CommandlineJava commandline,
+                           ExecuteWatchdog watchdog)
+                    throws BuildException
          +
          +
          Execute the task by forking a new JVM. The command will block until + it finishes. To know if the process was destroyed or not, use the + killedProcess() method of the watchdog class. +

          +

          +
          Parameters:
          commandline - the commandline for forked jvm
          watchdog - the watchdog in charge of cancelling the test if it + exceeds a certain amount of time. Can be null. +
          Returns:
          the result of running the jdepend +
          Throws: +
          BuildException - in case of error
          +
          +
          +
          + +

          +createWatchdog

          +
          +protected ExecuteWatchdog createWatchdog()
+                                  throws BuildException
          +
          +
          + +
          Returns:
          null if there is a timeout value, otherwise the + watchdog instance. +
          Throws: +
          BuildException - in case of error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-frame.html new file mode 100644 index 000000000..6603752c8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jdepend (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.jdepend + + + + +
          +Classes  + +
          +JDependTask +
          +JDependTask.FormatAttribute
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-summary.html new file mode 100644 index 000000000..21ae274b4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jdepend (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.jdepend +

          + + + + + + + + + + + + + +
          +Class Summary
          JDependTaskRuns JDepend tests.
          JDependTask.FormatAttributeA class for the enumerated attribute format, + values are xml and text.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-tree.html new file mode 100644 index 000000000..16bad8603 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jdepend/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jdepend Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.jdepend +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html new file mode 100644 index 000000000..db19d8ab3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/ClassNameReader.html @@ -0,0 +1,259 @@ + + + + + + +ClassNameReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jlink +
          +Class ClassNameReader

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jlink.ClassNameReader
+
          +
          +
          +
          public class ClassNameReader
          extends java.lang.Object
          + + +

          +Provides a quick and dirty way to determine the true name of a class + given just an InputStream. Reads in just enough to perform this + minimal task only. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ClassNameReader() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +static java.lang.StringgetClassName(java.io.InputStream input) + +
          +          Get the class name of a class in an input stream.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ClassNameReader

          +
          +public ClassNameReader()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getClassName

          +
          +public static java.lang.String getClassName(java.io.InputStream input)
+                                     throws java.io.IOException
          +
          +
          Get the class name of a class in an input stream. +

          +

          +
          Parameters:
          input - an InputStream value +
          Returns:
          the name of the class +
          Throws: +
          java.io.IOException - if an error occurs
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html new file mode 100644 index 000000000..383f19a8e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/JlinkTask.html @@ -0,0 +1,483 @@ + + + + + + +JlinkTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jlink +
          +Class JlinkTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.jlink.JlinkTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SelectorContainer
          +
          +
          +
          +
          public class JlinkTask
          extends MatchingTask
          + + +

          +This class defines objects that can link together various jar and + zip files. + +

          It is basically a wrapper for the jlink code written originally + by Patrick Beard. The + classes org.apache.tools.ant.taskdefs.optional.jlink.Jlink and + org.apache.tools.ant.taskdefs.optional.jlink.ClassNameReader + support this class.

          + +

          For example: + + 

          + <jlink compress="false" outfile="out.jar"/>
+   <mergefiles>
+     <pathelement path="${build.dir}/mergefoo.jar"/>
+     <pathelement path="${build.dir}/mergebar.jar"/>
+   </mergefiles>
+   <addfiles>
+     <pathelement path="${build.dir}/mac.jar"/>
+     <pathelement path="${build.dir}/pc.zip"/>
+   </addfiles>
+ </jlink>
+
          + +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          fileset
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JlinkTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateAddfiles() + +
          +          Establishes the object that contains the files to + be added to the output.
          + PathcreateMergefiles() + +
          +          Establishes the object that contains the files to + be merged into the output.
          + voidexecute() + +
          +          Does the adding and merging.
          + voidsetAddfiles(Path addfiles) + +
          +          Sets the files to be added into the output.
          + voidsetCompress(boolean compress) + +
          +          Defines whether or not the output should be compacted.
          + voidsetMergefiles(Path mergefiles) + +
          +          Sets the files to be merged into the output.
          + voidsetOutfile(java.io.File outfile) + +
          +          The output file for this run of jlink.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JlinkTask

          +
          +public JlinkTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setOutfile

          +
          +public void setOutfile(java.io.File outfile)
          +
          +
          The output file for this run of jlink. Usually a jar or zip file. +

          +

          +
          Parameters:
          outfile - the output file
          +
          +
          +
          + +

          +createMergefiles

          +
          +public Path createMergefiles()
          +
          +
          Establishes the object that contains the files to + be merged into the output. +

          +

          + +
          Returns:
          a path to be configured
          +
          +
          +
          + +

          +setMergefiles

          +
          +public void setMergefiles(Path mergefiles)
          +
          +
          Sets the files to be merged into the output. +

          +

          +
          Parameters:
          mergefiles - a path
          +
          +
          +
          + +

          +createAddfiles

          +
          +public Path createAddfiles()
          +
          +
          Establishes the object that contains the files to + be added to the output. +

          +

          + +
          Returns:
          a path to be configured
          +
          +
          +
          + +

          +setAddfiles

          +
          +public void setAddfiles(Path addfiles)
          +
          +
          Sets the files to be added into the output. +

          +

          +
          Parameters:
          addfiles - a path
          +
          +
          +
          + +

          +setCompress

          +
          +public void setCompress(boolean compress)
          +
          +
          Defines whether or not the output should be compacted. +

          +

          +
          Parameters:
          compress - a boolean value
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Does the adding and merging. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/jlink.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/jlink.html new file mode 100644 index 000000000..705369675 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/jlink.html @@ -0,0 +1,411 @@ + + + + + + +jlink (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jlink +
          +Class jlink

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jlink.jlink
+
          +
          +
          +
          public class jlink
          extends java.lang.Object
          + + +

          +jlink links together multiple .jar files. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          jlink() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddAddFile(java.lang.String fileToAdd) + +
          +          Adds a file to be added into the output.
          + voidaddAddFiles(java.lang.String[] filesToAdd) + +
          +          Adds several file to be added into the output.
          + voidaddMergeFile(java.lang.String fileToMerge) + +
          +          Adds a file to be merged into the output.
          + voidaddMergeFiles(java.lang.String[] filesToMerge) + +
          +          Adds several files to be merged into the output.
          + voidlink() + +
          +          Performs the linking of files.
          +static voidmain(java.lang.String[] args) + +
          +          The command line entry point for jlink.
          + voidsetCompression(boolean compress) + +
          +          Determines whether output will be compressed.
          + voidsetOutfile(java.lang.String outfile) + +
          +          The file that will be created by this instance of jlink.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +jlink

          +
          +public jlink()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setOutfile

          +
          +public void setOutfile(java.lang.String outfile)
          +
          +
          The file that will be created by this instance of jlink. +

          +

          +
          Parameters:
          outfile - the file to create.
          +
          +
          +
          + +

          +addMergeFile

          +
          +public void addMergeFile(java.lang.String fileToMerge)
          +
          +
          Adds a file to be merged into the output. +

          +

          +
          Parameters:
          fileToMerge - the file to merge into the output.
          +
          +
          +
          + +

          +addAddFile

          +
          +public void addAddFile(java.lang.String fileToAdd)
          +
          +
          Adds a file to be added into the output. +

          +

          +
          Parameters:
          fileToAdd - the file to add to the output.
          +
          +
          +
          + +

          +addMergeFiles

          +
          +public void addMergeFiles(java.lang.String[] filesToMerge)
          +
          +
          Adds several files to be merged into the output. +

          +

          +
          Parameters:
          filesToMerge - an array of files to merge into the output.
          +
          +
          +
          + +

          +addAddFiles

          +
          +public void addAddFiles(java.lang.String[] filesToAdd)
          +
          +
          Adds several file to be added into the output. +

          +

          +
          Parameters:
          filesToAdd - an array of files to add to the output.
          +
          +
          +
          + +

          +setCompression

          +
          +public void setCompression(boolean compress)
          +
          +
          Determines whether output will be compressed. +

          +

          +
          Parameters:
          compress - if true use compression.
          +
          +
          +
          + +

          +link

          +
          +public void link()
+          throws java.lang.Exception
          +
          +
          Performs the linking of files. Addfiles are added to the output as-is. + For example, a jar file is added to the output as a jar file. However, + mergefiles are first examined for their type. If it is a jar or zip + file, the contents will be extracted from the mergefile and entered + into the output. If a zip or jar file is encountered in a subdirectory + it will be added, not merged. If a directory is encountered, it becomes + the root entry of all the files below it. Thus, you can provide + multiple, disjoint directories, as addfiles: they will all be added in + a rational manner to outfile. +

          +

          + +
          Throws: +
          java.lang.Exception - on error.
          +
          +
          +
          + +

          +main

          +
          +public static void main(java.lang.String[] args)
          +
          +
          The command line entry point for jlink. +

          +

          +
          Parameters:
          args - an array of arguments
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-frame.html new file mode 100644 index 000000000..5222c3d06 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jlink (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.jlink + + + + +
          +Classes  + +
          +ClassNameReader +
          +jlink +
          +JlinkTask
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-summary.html new file mode 100644 index 000000000..80f6df668 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-summary.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jlink (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.jlink +

          + + + + + + + + + + + + + + + + + +
          +Class Summary
          ClassNameReaderProvides a quick and dirty way to determine the true name of a class + given just an InputStream.
          jlinkjlink links together multiple .jar files.
          JlinkTaskThis class defines objects that can link together various jar and + zip files.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-tree.html new file mode 100644 index 000000000..40f36dbb2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jlink/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jlink Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.jlink +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.html new file mode 100644 index 000000000..33e329208 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/Jasper41Mangler.html @@ -0,0 +1,292 @@ + + + + + + +Jasper41Mangler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Class Jasper41Mangler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.Jasper41Mangler
+
          +
          +
          All Implemented Interfaces:
          JspMangler
          +
          +
          +
          +
          public class Jasper41Mangler
          extends java.lang.Object
          implements JspMangler
          + + +

          +this class implements the name mangling rules of the jasper in tomcat4.1.x + which is likely to remain for some time +

          + +

          +

          +
          See Also:
          "org.apache.jasper.JspCompilationContext"
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Jasper41Mangler() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringmapJspToJavaName(java.io.File jspFile) + +
          +          map from a jsp file to a java filename; does not do packages
          + java.lang.StringmapPath(java.lang.String path) + +
          +          taking in the substring representing the path relative to the source dir + return a new string representing the destination path
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Jasper41Mangler

          +
          +public Jasper41Mangler()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +mapJspToJavaName

          +
          +public java.lang.String mapJspToJavaName(java.io.File jspFile)
          +
          +
          map from a jsp file to a java filename; does not do packages +

          +

          +
          Specified by:
          mapJspToJavaName in interface JspMangler
          +
          +
          +
          Parameters:
          jspFile - file +
          Returns:
          java filename
          +
          +
          +
          + +

          +mapPath

          +
          +public java.lang.String mapPath(java.lang.String path)
          +
          +
          taking in the substring representing the path relative to the source dir + return a new string representing the destination path +

          +

          +
          Specified by:
          mapPath in interface JspMangler
          +
          +
          +
          Parameters:
          path - not used. +
          Returns:
          null as this is not implemented.
          To do:
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.WebAppParameter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.WebAppParameter.html new file mode 100644 index 000000000..86aeeb4a6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.WebAppParameter.html @@ -0,0 +1,278 @@ + + + + + + +JspC.WebAppParameter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Class JspC.WebAppParameter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.JspC.WebAppParameter
+
          +
          +
          Enclosing class:
          JspC
          +
          +
          +
          +
          public static class JspC.WebAppParameter
          extends java.lang.Object
          + + +

          +static inner class used as a parameter element +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JspC.WebAppParameter() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.io.FilegetDirectory() + +
          +          query current directory
          + voidsetBaseDir(java.io.File directory) + +
          +          set directory; alternate syntax
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JspC.WebAppParameter

          +
          +public JspC.WebAppParameter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getDirectory

          +
          +public java.io.File getDirectory()
          +
          +
          query current directory +

          +

          + +
          Returns:
          the directory.
          +
          +
          +
          + +

          +setBaseDir

          +
          +public void setBaseDir(java.io.File directory)
          +
          +
          set directory; alternate syntax +

          +

          +
          Parameters:
          directory - the base dir.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.html new file mode 100644 index 000000000..ca62ec6e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspC.html @@ -0,0 +1,1275 @@ + + + + + + +JspC (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Class JspC

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.jsp.JspC
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SelectorContainer
          +
          +
          +
          +
          public class JspC
          extends MatchingTask
          + + +

          +Runs a JSP compiler. + +

          This task takes the given jsp files and compiles them into java + files. It is then up to the user to compile the java files into classes. + +

          The task requires the srcdir and destdir attributes to be + set. This Task is a MatchingTask, so the files to be compiled can be + specified using includes/excludes attributes or nested include/exclude + elements. Optional attributes are verbose (set the verbosity level passed + to jasper), package (name of the destination package for generated java + classes and classpath (the classpath to use when running the jsp + compiler). +

          This task supports the nested elements classpath (A Path) and + classpathref (A Reference) which can be used in preference to the + attribute classpath, if the jsp compiler is not already in the ant + classpath. + +

          Usage

          + 
          + <jspc srcdir="${basedir}/src/war"
+       destdir="${basedir}/gensrc"
+       package="com.i3sp.jsp"
+       verbose="9">
+   <include name="**\/*.jsp" />
+ </jspc>
+
          + +

          Large Amount of cutting and pasting from the Javac task... +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classJspC.WebAppParameter + +
          +          static inner class used as a parameter element
          +  + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.util.VectorcompileList + +
          +           
          +protected  booleanfailOnError + +
          +          flag to control action on execution trouble
          +protected  JspC.WebAppParameterwebApp + +
          +          web apps
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          fileset
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JspC() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddWebApp(JspC.WebAppParameter webappParam) + +
          +          Adds a single webapp.
          + PathcreateClasspath() + +
          +          Adds a path to the classpath.
          + PathcreateCompilerclasspath() + +
          +          Support nested compiler classpath, used to locate compiler adapter
          + voiddeleteEmptyJavaFiles() + +
          +          delete any java output files that are empty + this is to get around a little defect in jasper: when it + fails, it leaves incomplete files around.
          + voidexecute() + +
          +          execute by building up a list of files that + have changed and hand them off to a jsp compiler
          + PathgetClasspath() + +
          +          Get the classpath.
          + java.util.VectorgetCompileList() + +
          +          get the list of files to compile
          + PathgetCompilerclasspath() + +
          +          get the classpath used to find the compiler adapter
          + java.io.FilegetDestdir() + +
          +          Get the destination directory.
          + booleangetFailonerror() + +
          +          Gets the failonerror flag.
          + java.lang.StringgetIeplugin() + +
          +          Get the IE CLASSID value.
          + java.lang.StringgetPackage() + +
          +          Get the name of the package.
          + PathgetSrcDir() + +
          +          Get the source dir.
          + java.io.FilegetUribase() + +
          +          Get the uri base value.
          + java.io.FilegetUriroot() + +
          +          Get the uri root value.
          + intgetVerbose() + +
          +          Get the verbose level.
          + JspC.WebAppParametergetWebApp() + +
          +          Get the web app.
          + java.io.FilegetWebinc() + +
          +          Get the webinc attribute.
          + java.io.FilegetWebxml() + +
          +          Filename for web.xml.
          + booleanisMapped() + +
          +          If true, generate separate write() calls for each HTML line + in the JSP.
          +protected  java.io.FilemapToJavaFile(JspMangler mangler, + java.io.File srcFile, + java.io.File srcDir, + java.io.File dest) + +
          +          get a filename from our jsp file.
          +protected  voidresetFileLists() + +
          +          Clear the list of files to be compiled and copied..
          +protected  voidscanDir(java.io.File srcDir, + java.io.File dest, + JspMangler mangler, + java.lang.String[] files) + +
          +          Scans the directory looking for source files to be compiled.
          + voidsetClasspath(Path cp) + +
          +          Set the classpath to be used for this compilation.
          + voidsetClasspathRef(Reference r) + +
          +          Adds a reference to a classpath defined elsewhere
          + voidsetCompiler(java.lang.String compiler) + +
          +          Class name of a JSP compiler adapter.
          + voidsetCompilerclasspath(Path cp) + +
          +          Set the classpath to be used to find this compiler adapter
          + voidsetDestdir(java.io.File destDir) + +
          +          Set the destination directory into which the JSP source + files should be compiled.
          + voidsetFailonerror(boolean fail) + +
          +          Whether or not the build should halt if compilation fails.
          + voidsetIeplugin(java.lang.String iepluginid) + +
          +          Java Plugin CLASSID for Internet Explorer
          + voidsetMapped(boolean mapped) + +
          +          If true, generate separate write() calls for each HTML line + in the JSP.
          + voidsetPackage(java.lang.String pkg) + +
          +          Set the name of the package the compiled jsp files should be in.
          + voidsetSrcDir(Path srcDir) + +
          +          Set the path for source JSP files.
          + voidsetUribase(java.io.File uribase) + +
          +          The URI context of relative URI references in the JSP pages.
          + voidsetUriroot(java.io.File uriroot) + +
          +          The root directory that uri files should be resolved + against.
          + voidsetVerbose(int i) + +
          +          Set the verbose level of the compiler
          + voidsetWebinc(java.io.File webinc) + +
          +          output filename for the fraction of web.xml that lists + servlets.
          + voidsetWebxml(java.io.File webxml) + +
          +          Filename for web.xml.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +compileList

          +
          +protected java.util.Vector compileList
          +
          +
          +
          +
          +
          + +

          +failOnError

          +
          +protected boolean failOnError
          +
          +
          flag to control action on execution trouble +

          +

          +
          +
          +
          + +

          +webApp

          +
          +protected JspC.WebAppParameter webApp
          +
          +
          web apps +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JspC

          +
          +public JspC()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setSrcDir

          +
          +public void setSrcDir(Path srcDir)
          +
          +
          Set the path for source JSP files. +

          +

          +
          Parameters:
          srcDir - the source path.
          +
          +
          +
          + +

          +getSrcDir

          +
          +public Path getSrcDir()
          +
          +
          Get the source dir. +

          +

          + +
          Returns:
          the source path.
          +
          +
          +
          + +

          +setDestdir

          +
          +public void setDestdir(java.io.File destDir)
          +
          +
          Set the destination directory into which the JSP source + files should be compiled. +

          +

          +
          Parameters:
          destDir - the destination directory.
          +
          +
          +
          + +

          +getDestdir

          +
          +public java.io.File getDestdir()
          +
          +
          Get the destination directory. +

          +

          + +
          Returns:
          the directory.
          +
          +
          +
          + +

          +setPackage

          +
          +public void setPackage(java.lang.String pkg)
          +
          +
          Set the name of the package the compiled jsp files should be in. +

          +

          +
          Parameters:
          pkg - the name of the package.
          +
          +
          +
          + +

          +getPackage

          +
          +public java.lang.String getPackage()
          +
          +
          Get the name of the package. +

          +

          + +
          Returns:
          the package.
          +
          +
          +
          + +

          +setVerbose

          +
          +public void setVerbose(int i)
          +
          +
          Set the verbose level of the compiler +

          +

          +
          Parameters:
          i - the verbose level to use.
          +
          +
          +
          + +

          +getVerbose

          +
          +public int getVerbose()
          +
          +
          Get the verbose level. +

          +

          + +
          Returns:
          the level.
          +
          +
          +
          + +

          +setFailonerror

          +
          +public void setFailonerror(boolean fail)
          +
          +
          Whether or not the build should halt if compilation fails. + Defaults to true. +

          +

          +
          Parameters:
          fail - a boolean value.
          +
          +
          +
          + +

          +getFailonerror

          +
          +public boolean getFailonerror()
          +
          +
          Gets the failonerror flag. +

          +

          + +
          Returns:
          the flag.
          +
          +
          +
          + +

          +getIeplugin

          +
          +public java.lang.String getIeplugin()
          +
          +
          Get the IE CLASSID value. +

          +

          + +
          Returns:
          the value.
          +
          +
          +
          + +

          +setIeplugin

          +
          +public void setIeplugin(java.lang.String iepluginid)
          +
          +
          Java Plugin CLASSID for Internet Explorer +

          +

          +
          Parameters:
          iepluginid - the id to use.
          +
          +
          +
          + +

          +isMapped

          +
          +public boolean isMapped()
          +
          +
          If true, generate separate write() calls for each HTML line + in the JSP. +

          +

          + +
          Returns:
          mapping status
          +
          +
          +
          + +

          +setMapped

          +
          +public void setMapped(boolean mapped)
          +
          +
          If true, generate separate write() calls for each HTML line + in the JSP. +

          +

          +
          Parameters:
          mapped - a boolean value.
          +
          +
          +
          + +

          +setUribase

          +
          +public void setUribase(java.io.File uribase)
          +
          +
          The URI context of relative URI references in the JSP pages. + If it does not exist then it is derived from the location + of the file relative to the declared or derived value of uriroot. +

          +

          +
          Parameters:
          uribase - The new Uribase value
          +
          +
          +
          + +

          +getUribase

          +
          +public java.io.File getUribase()
          +
          +
          Get the uri base value. +

          +

          + +
          Returns:
          the value.
          +
          +
          +
          + +

          +setUriroot

          +
          +public void setUriroot(java.io.File uriroot)
          +
          +
          The root directory that uri files should be resolved + against. (Default is the directory jspc is invoked from) +

          +

          +
          Parameters:
          uriroot - The new Uribase value
          +
          +
          +
          + +

          +getUriroot

          +
          +public java.io.File getUriroot()
          +
          +
          Get the uri root value. +

          +

          + +
          Returns:
          the value.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path cp)
          +
          +
          Set the classpath to be used for this compilation. +

          +

          +
          Parameters:
          cp - the path to be used.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Adds a path to the classpath. +

          +

          + +
          Returns:
          a path to be configured.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Adds a reference to a classpath defined elsewhere +

          +

          +
          Parameters:
          r - a reference to a classpath.
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          Get the classpath. +

          +

          + +
          Returns:
          the classpath.
          +
          +
          +
          + +

          +setCompilerclasspath

          +
          +public void setCompilerclasspath(Path cp)
          +
          +
          Set the classpath to be used to find this compiler adapter +

          +

          +
          Parameters:
          cp - the compiler classpath.
          +
          +
          +
          + +

          +getCompilerclasspath

          +
          +public Path getCompilerclasspath()
          +
          +
          get the classpath used to find the compiler adapter +

          +

          + +
          Returns:
          the compiler classpath.
          +
          +
          +
          + +

          +createCompilerclasspath

          +
          +public Path createCompilerclasspath()
          +
          +
          Support nested compiler classpath, used to locate compiler adapter +

          +

          + +
          Returns:
          a path to be configured.
          +
          +
          +
          + +

          +setWebxml

          +
          +public void setWebxml(java.io.File webxml)
          +
          +
          Filename for web.xml. +

          +

          +
          Parameters:
          webxml - The new Webxml value
          +
          +
          +
          + +

          +getWebxml

          +
          +public java.io.File getWebxml()
          +
          +
          Filename for web.xml. +

          +

          + +
          Returns:
          The filename for web.xml.
          +
          +
          +
          + +

          +setWebinc

          +
          +public void setWebinc(java.io.File webinc)
          +
          +
          output filename for the fraction of web.xml that lists + servlets. +

          +

          +
          Parameters:
          webinc - The new Webinc value
          +
          +
          +
          + +

          +getWebinc

          +
          +public java.io.File getWebinc()
          +
          +
          Get the webinc attribute. +

          +

          + +
          Returns:
          the webinc attribute.
          +
          +
          +
          + +

          +addWebApp

          +
          +public void addWebApp(JspC.WebAppParameter webappParam)
+               throws BuildException
          +
          +
          Adds a single webapp. +

          +

          +
          Parameters:
          webappParam - add a web app parameter +
          Throws: +
          BuildException - if more than one webapp is specified.
          +
          +
          +
          + +

          +getWebApp

          +
          +public JspC.WebAppParameter getWebApp()
          +
          +
          Get the web app. +

          +

          + +
          Returns:
          the web app attribute.
          +
          +
          +
          + +

          +setCompiler

          +
          +public void setCompiler(java.lang.String compiler)
          +
          +
          Class name of a JSP compiler adapter. +

          +

          +
          Parameters:
          compiler - the compiler class name.
          +
          +
          +
          + +

          +getCompileList

          +
          +public java.util.Vector getCompileList()
          +
          +
          get the list of files to compile +

          +

          + +
          Returns:
          the list of files.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          execute by building up a list of files that + have changed and hand them off to a jsp compiler +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +resetFileLists

          +
          +protected void resetFileLists()
          +
          +
          Clear the list of files to be compiled and copied.. +

          +

          +
          +
          +
          +
          + +

          +scanDir

          +
          +protected void scanDir(java.io.File srcDir,
+                       java.io.File dest,
+                       JspMangler mangler,
+                       java.lang.String[] files)
          +
          +
          Scans the directory looking for source files to be compiled. + The results are returned in the class variable compileList +

          +

          +
          Parameters:
          srcDir - the source directory.
          dest - the destination directory.
          mangler - the jsp filename mangler.
          files - the file names to mangle.
          +
          +
          +
          + +

          +mapToJavaFile

          +
          +protected java.io.File mapToJavaFile(JspMangler mangler,
+                                     java.io.File srcFile,
+                                     java.io.File srcDir,
+                                     java.io.File dest)
          +
          +
          get a filename from our jsp file. +

          +

          +
          Parameters:
          mangler - the jsp filename managler.
          srcFile - the source file.
          srcDir - the source directory.
          dest - the destination directory. +
          Returns:
          the filename.
          To do:
          +
          support packages and subdirs
          +
          +
          +
          +
          + +

          +deleteEmptyJavaFiles

          +
          +public void deleteEmptyJavaFiles()
          +
          +
          delete any java output files that are empty + this is to get around a little defect in jasper: when it + fails, it leaves incomplete files around. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.html new file mode 100644 index 000000000..4ab987a16 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspMangler.html @@ -0,0 +1,238 @@ + + + + + + +JspMangler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Interface JspMangler

          +
          +
          All Known Implementing Classes:
          Jasper41Mangler, JspNameMangler
          +
          +
          +
          +
          public interface JspMangler
          + + +

          +This is an interface to the Mangler service that jspc needs to map + JSP file names to java files. + Note the complete lack of correlation + with Jasper's mangler interface. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringmapJspToJavaName(java.io.File jspFile) + +
          +          map from a jsp file to a java filename; does not do packages
          + java.lang.StringmapPath(java.lang.String path) + +
          +          taking in the substring representing the path relative to the source dir + return a new string representing the destination path
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +mapJspToJavaName

          +
          +java.lang.String mapJspToJavaName(java.io.File jspFile)
          +
          +
          map from a jsp file to a java filename; does not do packages +

          +

          +
          Parameters:
          jspFile - file +
          Returns:
          java filename
          +
          +
          +
          + +

          +mapPath

          +
          +java.lang.String mapPath(java.lang.String path)
          +
          +
          taking in the substring representing the path relative to the source dir + return a new string representing the destination path +

          +

          +
          Parameters:
          path - the path to map. +
          Returns:
          the mapped path.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.html new file mode 100644 index 000000000..51c827264 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/JspNameMangler.html @@ -0,0 +1,329 @@ + + + + + + +JspNameMangler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Class JspNameMangler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.JspNameMangler
+
          +
          +
          All Implemented Interfaces:
          JspMangler
          +
          +
          +
          +
          public class JspNameMangler
          extends java.lang.Object
          implements JspMangler
          + + +

          +This is a class derived from the Jasper code + (org.apache.jasper.compiler.CommandLineCompiler) to map from a JSP filename + to a valid Java classname. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.String[]keywords + +
          +          this is the list of keywords which can not be used as classnames
          +  + + + + + + + + + + +
          +Constructor Summary
          JspNameMangler() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringmapJspToJavaName(java.io.File jspFile) + +
          +          map from a jsp file to a java filename; does not do packages
          + java.lang.StringmapPath(java.lang.String path) + +
          +          taking in the substring representing the path relative to the source dir + return a new string representing the destination path + not supported, as jasper in tomcat4.0 doesnt either
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +keywords

          +
          +public static final java.lang.String[] keywords
          +
          +
          this is the list of keywords which can not be used as classnames +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JspNameMangler

          +
          +public JspNameMangler()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +mapJspToJavaName

          +
          +public java.lang.String mapJspToJavaName(java.io.File jspFile)
          +
          +
          map from a jsp file to a java filename; does not do packages +

          +

          +
          Specified by:
          mapJspToJavaName in interface JspMangler
          +
          +
          +
          Parameters:
          jspFile - file +
          Returns:
          java filename
          +
          +
          +
          + +

          +mapPath

          +
          +public java.lang.String mapPath(java.lang.String path)
          +
          +
          taking in the substring representing the path relative to the source dir + return a new string representing the destination path + not supported, as jasper in tomcat4.0 doesnt either +

          +

          +
          Specified by:
          mapPath in interface JspMangler
          +
          +
          +
          Parameters:
          path - not used +
          Returns:
          null always.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.html new file mode 100644 index 000000000..2f77032cd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/WLJspc.html @@ -0,0 +1,526 @@ + + + + + + +WLJspc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp +
          +Class WLJspc

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.MatchingTask
+              extended by org.apache.tools.ant.taskdefs.optional.jsp.WLJspc
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SelectorContainer
          +
          +
          +
          +
          public class WLJspc
          extends MatchingTask
          + + +

          +Precompiles JSP's using WebLogic's JSP compiler (weblogic.jspc). + + Tested only on Weblogic 4.5.1 - NT4.0 and Solaris 5.7 + + required attributes + src : root of source tree for JSP, ie, the document root for your weblogic server + dest : root of destination directory, what you have set as + WorkingDir in the weblogic properties + package : start package name under which your JSP's would be compiled + + other attributes + classpath + + A classpath should be set which contains the weblogic classes as well as all + application classes referenced by the JSP. The system classpath is also + appended when the jspc is called, so you may choose to put everything in + the classpath while calling Ant. However, since presumably the JSP's will + reference classes being build by Ant, it would be better to explicitly add + the classpath in the task + + The task checks timestamps on the JSP's and the generated classes, and compiles + only those files that have changed. + + It follows the weblogic naming convention of putting classes in + _dirName/_fileName.class for dirname/fileName.jsp + + Limitation: It compiles the files thru the Classic compiler only. + Limitation: Since it is my experience that weblogic jspc throws out of + memory error on being given too many files at one go, it is + called multiple times with one jsp file each. + + 

          + example
+ <target name="jspcompile" depends="compile">
+   <wljspc src="c:\\weblogic\\myserver\\public_html"
+           dest="c:\\weblogic\\myserver\\serverclasses" package="myapp.jsp">
+   <classpath>
+          <pathelement location="${weblogic.classpath}" />
+           <pathelement path="${compile.dest}" />
+      </classpath>
+
+   </wljspc>
+ </target>
+
          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          fileset
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          WLJspc() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateClasspath() + +
          +          Maybe creates a nested classpath element.
          + voidexecute() + +
          +          Run the task.
          +protected  java.lang.StringreplaceString(java.lang.String inpString, + java.lang.String escapeChars, + java.lang.String replaceChars) + +
          +          Replace occurances of a string with a replacement string.
          +protected  voidscanDir(java.lang.String[] files) + +
          +          Scan the array of files and add the jsp + files that need to be compiled to the filesToDo field.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used for this compilation.
          + voidsetDest(java.io.File dirName) + +
          +          Set the directory containing the source jsp's
          + voidsetPackage(java.lang.String packageName) + +
          +          Set the package under which the compiled classes go
          + voidsetSrc(java.io.File dirName) + +
          +          Set the directory containing the source jsp's
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +WLJspc

          +
          +public WLJspc()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used for this compilation. +

          +

          +
          Parameters:
          classpath - the classpath to use.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Maybe creates a nested classpath element. +

          +

          + +
          Returns:
          a path to be configured.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File dirName)
          +
          +
          Set the directory containing the source jsp's +

          +

          +
          Parameters:
          dirName - the directory containg the source jsp's
          +
          +
          +
          + +

          +setDest

          +
          +public void setDest(java.io.File dirName)
          +
          +
          Set the directory containing the source jsp's +

          +

          +
          Parameters:
          dirName - the directory containg the source jsp's
          +
          +
          +
          + +

          +setPackage

          +
          +public void setPackage(java.lang.String packageName)
          +
          +
          Set the package under which the compiled classes go +

          +

          +
          Parameters:
          packageName - the package name for the clases
          +
          +
          +
          + +

          +scanDir

          +
          +protected void scanDir(java.lang.String[] files)
          +
          +
          Scan the array of files and add the jsp + files that need to be compiled to the filesToDo field. +

          +

          +
          Parameters:
          files - the files to scan.
          +
          +
          +
          + +

          +replaceString

          +
          +protected java.lang.String replaceString(java.lang.String inpString,
+                                         java.lang.String escapeChars,
+                                         java.lang.String replaceChars)
          +
          +
          Replace occurances of a string with a replacement string. +

          +

          +
          Parameters:
          inpString - the string to convert.
          escapeChars - the string to replace.
          replaceChars - the string to place. +
          Returns:
          the converted string.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.html new file mode 100644 index 000000000..7489f6d38 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/DefaultJspCompilerAdapter.html @@ -0,0 +1,499 @@ + + + + + + +DefaultJspCompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp.compilers +
          +Class DefaultJspCompilerAdapter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter
+
          +
          +
          All Implemented Interfaces:
          JspCompilerAdapter
          +
          +
          +
          Direct Known Subclasses:
          JasperC
          +
          +
          +
          +
          public abstract class DefaultJspCompilerAdapter
          extends java.lang.Object
          implements JspCompilerAdapter
          + + +

          +This is the default implementation for the JspCompilerAdapter interface. + This is currently very light on the ground since only one compiler type is + supported. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  JspCowner + +
          +          our owner
          +  + + + + + + + + + + +
          +Constructor Summary
          DefaultJspCompilerAdapter() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidaddArg(CommandlineJava cmd, + java.lang.String argument) + +
          +          add an argument oneple to the argument list, if the value aint null
          +protected  voidaddArg(CommandlineJava cmd, + java.lang.String argument, + java.io.File file) + +
          +          add an argument tuple to the arg list, if the file parameter aint null
          +protected  voidaddArg(CommandlineJava cmd, + java.lang.String argument, + java.lang.String value) + +
          +          add an argument tuple to the argument list, if the value aint null
          + JspCgetJspc() + +
          +          get the owner
          + ProjectgetProject() + +
          +          get our project
          + booleanimplementsOwnDependencyChecking() + +
          +          ask if compiler can sort out its own dependencies
          +protected  voidlogAndAddFilesToCompile(JspC jspc, + java.util.Vector compileList, + CommandlineJava cmd) + +
          +          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList"
          + voidsetJspc(JspC owner) + +
          +          set the owner
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapter
          createMangler, execute
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +owner

          +
          +protected JspC owner
          +
          +
          our owner +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DefaultJspCompilerAdapter

          +
          +public DefaultJspCompilerAdapter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +logAndAddFilesToCompile

          +
          +protected void logAndAddFilesToCompile(JspC jspc,
+                                       java.util.Vector compileList,
+                                       CommandlineJava cmd)
          +
          +
          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +

          +

          +
          +
          +
          +
          Parameters:
          jspc - the compiler task for logging
          compileList - the list of files to compile
          cmd - the command line used
          +
          +
          +
          + +

          +setJspc

          +
          +public void setJspc(JspC owner)
          +
          +
          set the owner +

          +

          +
          Specified by:
          setJspc in interface JspCompilerAdapter
          +
          +
          +
          Parameters:
          owner - the owner JspC compiler
          +
          +
          +
          + +

          +getJspc

          +
          +public JspC getJspc()
          +
          +
          get the owner +

          +

          +
          +
          +
          + +
          Returns:
          the owner; should never be null
          +
          +
          +
          + +

          +addArg

          +
          +protected void addArg(CommandlineJava cmd,
+                      java.lang.String argument)
          +
          +
          add an argument oneple to the argument list, if the value aint null +

          +

          +
          +
          +
          +
          Parameters:
          cmd - the command line
          argument - The argument
          +
          +
          +
          + +

          +addArg

          +
          +protected void addArg(CommandlineJava cmd,
+                      java.lang.String argument,
+                      java.lang.String value)
          +
          +
          add an argument tuple to the argument list, if the value aint null +

          +

          +
          +
          +
          +
          Parameters:
          cmd - the command line
          argument - The argument
          value - the parameter
          +
          +
          +
          + +

          +addArg

          +
          +protected void addArg(CommandlineJava cmd,
+                      java.lang.String argument,
+                      java.io.File file)
          +
          +
          add an argument tuple to the arg list, if the file parameter aint null +

          +

          +
          +
          +
          +
          Parameters:
          cmd - the command line
          argument - The argument
          file - the parameter
          +
          +
          +
          + +

          +implementsOwnDependencyChecking

          +
          +public boolean implementsOwnDependencyChecking()
          +
          +
          ask if compiler can sort out its own dependencies +

          +

          +
          Specified by:
          implementsOwnDependencyChecking in interface JspCompilerAdapter
          +
          +
          + +
          Returns:
          true if the compiler wants to do its own + depends
          +
          +
          +
          + +

          +getProject

          +
          +public Project getProject()
          +
          +
          get our project +

          +

          +
          +
          +
          + +
          Returns:
          owner project data
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.html new file mode 100644 index 000000000..1cde88461 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JasperC.html @@ -0,0 +1,317 @@ + + + + + + +JasperC (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp.compilers +
          +Class JasperC

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter
+      extended by org.apache.tools.ant.taskdefs.optional.jsp.compilers.JasperC
+
          +
          +
          All Implemented Interfaces:
          JspCompilerAdapter
          +
          +
          +
          +
          public class JasperC
          extends DefaultJspCompilerAdapter
          + + +

          +The implementation of the jasper compiler. + This is a cut-and-paste of the original Jspc task. +

          + +

          +

          +
          Since:
          +
          ant1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter
          owner
          +  + + + + + + + + + + +
          +Constructor Summary
          JasperC(JspMangler mangler) + +
          +          Constructor for JasperC.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + JspManglercreateMangler() + +
          +           
          + booleanexecute() + +
          +          Our execute method.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.jsp.compilers.DefaultJspCompilerAdapter
          addArg, addArg, addArg, getJspc, getProject, implementsOwnDependencyChecking, logAndAddFilesToCompile, setJspc
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JasperC

          +
          +public JasperC(JspMangler mangler)
          +
          +
          Constructor for JasperC. +

          +

          +
          Parameters:
          mangler - a filename converter
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public boolean execute()
+                throws BuildException
          +
          +
          Our execute method. +

          +

          + +
          Returns:
          true if successful +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +createMangler

          +
          +public JspMangler createMangler()
          +
          +
          + +
          Returns:
          an instance of the mangler this compiler uses
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.html new file mode 100644 index 000000000..bfc7ecfa7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapter.html @@ -0,0 +1,285 @@ + + + + + + +JspCompilerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp.compilers +
          +Interface JspCompilerAdapter

          +
          +
          All Known Implementing Classes:
          DefaultJspCompilerAdapter, JasperC
          +
          +
          +
          +
          public interface JspCompilerAdapter
          + + +

          +The interface that all jsp compiler adapters must adher to. + +

          A compiler adapter is an adapter that interprets the jspc's + parameters in preperation to be passed off to the compier this + adapter represents. As all the necessary values are stored in the + Jspc task itself, the only thing all adapters need is the jsp + task, the execute command and a parameterless constructor (for + reflection).

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + JspManglercreateMangler() + +
          +           
          + booleanexecute() + +
          +          Executes the task.
          + booleanimplementsOwnDependencyChecking() + +
          +          ask if compiler can sort out its own dependencies
          + voidsetJspc(JspC attributes) + +
          +          Sets the compiler attributes, which are stored in the Jspc task.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setJspc

          +
          +void setJspc(JspC attributes)
          +
          +
          Sets the compiler attributes, which are stored in the Jspc task. +

          +

          +
          Parameters:
          attributes - the jsp compiler attributes
          +
          +
          +
          + +

          +execute

          +
          +boolean execute()
+                throws BuildException
          +
          +
          Executes the task. +

          +

          + +
          Returns:
          has the compilation been successful +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +createMangler

          +
          +JspMangler createMangler()
          +
          +
          + +
          Returns:
          an instance of the mangler this compiler uses
          +
          +
          +
          + +

          +implementsOwnDependencyChecking

          +
          +boolean implementsOwnDependencyChecking()
          +
          +
          ask if compiler can sort out its own dependencies +

          +

          + +
          Returns:
          true if the compiler wants to do its own + depends
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.html new file mode 100644 index 000000000..c609b9774 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/JspCompilerAdapterFactory.html @@ -0,0 +1,275 @@ + + + + + + +JspCompilerAdapterFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.jsp.compilers +
          +Class JspCompilerAdapterFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.jsp.compilers.JspCompilerAdapterFactory
+
          +
          +
          +
          public final class JspCompilerAdapterFactory
          extends java.lang.Object
          + + +

          +Creates the necessary compiler adapter, given basic criteria. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          +static JspCompilerAdaptergetCompiler(java.lang.String compilerType, + Task task) + +
          +          Based on the parameter passed in, this method creates the necessary + factory desired.
          +static JspCompilerAdaptergetCompiler(java.lang.String compilerType, + Task task, + AntClassLoader loader) + +
          +          Based on the parameter passed in, this method creates the necessary + factory desired.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getCompiler

          +
          +public static JspCompilerAdapter getCompiler(java.lang.String compilerType,
+                                             Task task)
+                                      throws BuildException
          +
          +
          Based on the parameter passed in, this method creates the necessary + factory desired. + + The current mapping for compiler names are as follows: +
          • jasper = jasper compiler (the default) +
          • a fully qualified classname = the name of a jsp compiler + adapter +
          +

          +

          +
          Parameters:
          compilerType - either the name of the desired compiler, or the + full classname of the compiler's adapter.
          task - a task to log through. +
          Returns:
          the compiler +
          Throws: +
          BuildException - if the compiler type could not be resolved into + a compiler adapter.
          +
          +
          +
          + +

          +getCompiler

          +
          +public static JspCompilerAdapter getCompiler(java.lang.String compilerType,
+                                             Task task,
+                                             AntClassLoader loader)
+                                      throws BuildException
          +
          +
          Based on the parameter passed in, this method creates the necessary + factory desired. + + The current mapping for compiler names are as follows: +
          • jasper = jasper compiler (the default) +
          • a fully qualified classname = the name of a jsp compiler + adapter +
          +

          +

          +
          Parameters:
          compilerType - either the name of the desired compiler, or the + full classname of the compiler's adapter.
          task - a task to log through.
          loader - AntClassLoader with which the compiler should be loaded +
          Returns:
          the compiler +
          Throws: +
          BuildException - if the compiler type could not be resolved into + a compiler adapter.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-frame.html new file mode 100644 index 000000000..427bdb845 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-frame.html @@ -0,0 +1,47 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp.compilers (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp.compilers + + + + +
          +Interfaces  + +
          +JspCompilerAdapter
          + + + + + + +
          +Classes  + +
          +DefaultJspCompilerAdapter +
          +JasperC +
          +JspCompilerAdapterFactory
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-summary.html new file mode 100644 index 000000000..f363b9719 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-summary.html @@ -0,0 +1,174 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp.compilers (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.jsp.compilers +

          + + + + + + + + + +
          +Interface Summary
          JspCompilerAdapterThe interface that all jsp compiler adapters must adher to.
          +  + +

          + + + + + + + + + + + + + + + + + +
          +Class Summary
          DefaultJspCompilerAdapterThis is the default implementation for the JspCompilerAdapter interface.
          JasperCThe implementation of the jasper compiler.
          JspCompilerAdapterFactoryCreates the necessary compiler adapter, given basic criteria.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-tree.html new file mode 100644 index 000000000..84c85860e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/compilers/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp.compilers Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.jsp.compilers +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-frame.html new file mode 100644 index 000000000..7a991ea4d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp + + + + +
          +Interfaces  + +
          +JspMangler
          + + + + + + +
          +Classes  + +
          +Jasper41Mangler +
          +JspC +
          +JspC.WebAppParameter +
          +JspNameMangler +
          +WLJspc
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-summary.html new file mode 100644 index 000000000..ae315c46e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-summary.html @@ -0,0 +1,186 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.jsp +

          + + + + + + + + + +
          +Interface Summary
          JspManglerThis is an interface to the Mangler service that jspc needs to map + JSP file names to java files.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          Jasper41Manglerthis class implements the name mangling rules of the jasper in tomcat4.1.x + which is likely to remain for some time
          JspCRuns a JSP compiler.
          JspC.WebAppParameterstatic inner class used as a parameter element
          JspNameManglerThis is a class derived from the Jasper code + (org.apache.jasper.compiler.CommandLineCompiler) to map from a JSP filename + to a valid Java classname.
          WLJspcPrecompiles JSP's using WebLogic's JSP compiler (weblogic.jspc).
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-tree.html new file mode 100644 index 000000000..aa31fd0f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/jsp/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.jsp Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.jsp +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object +
          +

          +Interface Hierarchy +

          +
            +
          • org.apache.tools.ant.taskdefs.optional.jsp.JspMangler
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.Format.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.Format.html new file mode 100644 index 000000000..ec6d4d3a6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.Format.html @@ -0,0 +1,288 @@ + + + + + + +AggregateTransformer.Format (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class AggregateTransformer.Format

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer.Format
+
          +
          +
          Enclosing class:
          AggregateTransformer
          +
          +
          +
          +
          public static class AggregateTransformer.Format
          extends EnumeratedAttribute
          + + +

          +defines acceptable formats. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          AggregateTransformer.Format() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          list authorized values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AggregateTransformer.Format

          +
          +public AggregateTransformer.Format()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          list authorized values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          authorized values.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.html new file mode 100644 index 000000000..cd40633b8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/AggregateTransformer.html @@ -0,0 +1,713 @@ + + + + + + +AggregateTransformer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class AggregateTransformer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.AggregateTransformer
+
          +
          +
          +
          public class AggregateTransformer
          extends java.lang.Object
          + + +

          +Transform a JUnit xml report. + The default transformation generates an html report in either framed or non-framed + style. The non-framed style is convenient to have a concise report via mail, the + framed report is much more convenient if you want to browse into different + packages or testcases since it is a Javadoc like report. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classAggregateTransformer.Format + +
          +          defines acceptable formats.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static javax.xml.parsers.DocumentBuilderFactorydbfactory + +
          +          XML Parser factory accessible to subclasses
          +protected  org.w3c.dom.Documentdocument + +
          +          the xml document to process
          +protected  java.lang.Stringformat + +
          +          the format to use for the report.
          +static java.lang.StringFRAMES + +
          +          name of the frames format.
          +static java.lang.StringNOFRAMES + +
          +          name of the no frames format.
          +protected  java.io.FilestyleDir + +
          +          the style directory.
          +protected  Tasktask + +
          +          Task
          +protected  java.io.FiletoDir + +
          +          the destination directory, this is the root from where html should be generated
          +  + + + + + + + + + + +
          +Constructor Summary
          AggregateTransformer(Task task) + +
          +          constructor creating the transformer from the junitreport task.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcheckOptions() + +
          +          check for invalid options
          + XSLTProcess.ParamcreateParam() + +
          +          Create an instance of an XSL parameter for configuration by Ant.
          +protected static javax.xml.parsers.DocumentBuilderFactorygetDocumentBuilderFactory() + +
          +          Get the Document Builder Factory
          +protected  ResourcegetStylesheet() + +
          +          access the stylesheet to be used as a resource.
          +protected  java.lang.StringgetStylesheetSystemId() + +
          +          Get the systemid of the appropriate stylesheet based on its + name and styledir.
          + voidsetExtension(java.lang.String ext) + +
          +          set the extension of the output files
          + voidsetFormat(AggregateTransformer.Format format) + +
          +          sets the format.
          + voidsetStyledir(java.io.File styledir) + +
          +          set the style directory.
          + voidsetTodir(java.io.File todir) + +
          +          set the destination directory.
          + voidsetXmlDocument(org.w3c.dom.Document doc) + +
          +          sets the input document.
          +protected  voidsetXmlfile(java.io.File xmlfile) + +
          +          Set the xml file to be processed.
          + voidtransform() + +
          +          transformation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +FRAMES

          +
          +public static final java.lang.String FRAMES
          +
          +
          name of the frames format. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +NOFRAMES

          +
          +public static final java.lang.String NOFRAMES
          +
          +
          name of the no frames format. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +task

          +
          +protected Task task
          +
          +
          Task +

          +

          +
          +
          +
          + +

          +document

          +
          +protected org.w3c.dom.Document document
          +
          +
          the xml document to process +

          +

          +
          +
          +
          + +

          +styleDir

          +
          +protected java.io.File styleDir
          +
          +
          the style directory. XSLs should be read from here if necessary +

          +

          +
          +
          +
          + +

          +toDir

          +
          +protected java.io.File toDir
          +
          +
          the destination directory, this is the root from where html should be generated +

          +

          +
          +
          +
          + +

          +format

          +
          +protected java.lang.String format
          +
          +
          the format to use for the report. Must be FRAMES or NOFRAMES +

          +

          +
          +
          +
          + +

          +dbfactory

          +
          +protected static javax.xml.parsers.DocumentBuilderFactory dbfactory
          +
          +
          XML Parser factory accessible to subclasses +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +AggregateTransformer

          +
          +public AggregateTransformer(Task task)
          +
          +
          constructor creating the transformer from the junitreport task. +

          +

          +
          Parameters:
          task - task delegating to this class
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getDocumentBuilderFactory

          +
          +protected static javax.xml.parsers.DocumentBuilderFactory getDocumentBuilderFactory()
          +
          +
          Get the Document Builder Factory +

          +

          + +
          Returns:
          the DocumentBuilderFactory instance in use
          +
          +
          +
          + +

          +setFormat

          +
          +public void setFormat(AggregateTransformer.Format format)
          +
          +
          sets the format. +

          +

          +
          Parameters:
          format - Must be FRAMES or NOFRAMES
          +
          +
          +
          + +

          +setXmlDocument

          +
          +public void setXmlDocument(org.w3c.dom.Document doc)
          +
          +
          sets the input document. +

          +

          +
          Parameters:
          doc - input dom tree
          +
          +
          +
          + +

          +setXmlfile

          +
          +protected void setXmlfile(java.io.File xmlfile)
+                   throws BuildException
          +
          +
          Set the xml file to be processed. This is a helper if you want + to set the file directly. Much more for testing purposes. +

          +

          +
          Parameters:
          xmlfile - xml file to be processed +
          Throws: +
          BuildException - if the document cannot be parsed.
          +
          +
          +
          + +

          +setStyledir

          +
          +public void setStyledir(java.io.File styledir)
          +
          +
          set the style directory. It is optional and will override the + default xsl used. +

          +

          +
          Parameters:
          styledir - the directory containing the xsl files if the user + would like to override with its own style.
          +
          +
          +
          + +

          +setTodir

          +
          +public void setTodir(java.io.File todir)
          +
          +
          set the destination directory. +

          +

          +
          Parameters:
          todir - the destination directory
          +
          +
          +
          + +

          +setExtension

          +
          +public void setExtension(java.lang.String ext)
          +
          +
          set the extension of the output files +

          +

          +
          Parameters:
          ext - extension.
          +
          +
          +
          + +

          +createParam

          +
          +public XSLTProcess.Param createParam()
          +
          +
          Create an instance of an XSL parameter for configuration by Ant. +

          +

          + +
          Returns:
          an instance of the Param class to be configured.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +transform

          +
          +public void transform()
+               throws BuildException
          +
          +
          transformation +

          +

          + +
          Throws: +
          BuildException - exception if something goes wrong with the transformation.
          +
          +
          +
          + +

          +getStylesheet

          +
          +protected Resource getStylesheet()
          +
          +
          access the stylesheet to be used as a resource. +

          +

          + +
          Returns:
          stylesheet as a resource
          +
          +
          +
          + +

          +checkOptions

          +
          +protected void checkOptions()
+                     throws BuildException
          +
          +
          check for invalid options +

          +

          + +
          Throws: +
          BuildException - if something goes wrong.
          +
          +
          +
          + +

          +getStylesheetSystemId

          +
          +protected java.lang.String getStylesheetSystemId()
+                                          throws java.io.IOException
          +
          +
          Get the systemid of the appropriate stylesheet based on its + name and styledir. If no styledir is defined it will load + it as a java resource in the xsl child package, otherwise it + will get it from the given directory. +

          +

          + +
          Returns:
          system ID of the stylesheet. +
          Throws: +
          java.io.IOException - thrown if the requested stylesheet does + not exist.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.html new file mode 100644 index 000000000..55e1c3be5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BaseTest.html @@ -0,0 +1,902 @@ + + + + + + +BaseTest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class BaseTest

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.BaseTest
+
          +
          +
          Direct Known Subclasses:
          BatchTest, JUnitTest
          +
          +
          +
          +
          public abstract class BaseTest
          extends java.lang.Object
          + + +

          +Baseclass for BatchTest and JUnitTest. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.io.FiledestDir + +
          +          destination directory
          +protected  java.lang.StringerrorProperty + +
          +           
          +protected  java.lang.StringfailureProperty + +
          +           
          +protected  booleanfiltertrace + +
          +           
          +protected  booleanfork + +
          +           
          +protected  java.util.Vectorformatters + +
          +           
          +protected  booleanhaltOnError + +
          +           
          +protected  booleanhaltOnFail + +
          +           
          +protected  java.lang.StringifProperty + +
          +           
          +protected  java.lang.StringunlessProperty + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          BaseTest() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFormatter(FormatterElement elem) + +
          +          Allow a formatter nested element.
          + java.lang.StringgetErrorProperty() + +
          +          Get the failure property name.
          + java.lang.StringgetFailureProperty() + +
          +          Get the failure property name.
          + booleangetFiltertrace() + +
          +          Get the filtertrace attribute.
          + booleangetFork() + +
          +          Get the fork attribute.
          + booleangetHaltonerror() + +
          +          Get the haltonerror attribute.
          + booleangetHaltonfailure() + +
          +          Get the haltonfailure attribute.
          + java.lang.ObjectgetIfCondition() + +
          +          The if expression
          + java.lang.StringgetTodir() + +
          +          Get the destination directory.
          + java.lang.ObjectgetUnlessCondition() + +
          +          The unless expression
          + voidsetErrorProperty(java.lang.String errorProperty) + +
          +          Set the name of the error property.
          + voidsetFailureProperty(java.lang.String failureProperty) + +
          +          Set the name of the failure property.
          + voidsetFiltertrace(boolean value) + +
          +          Set the filtertrace attribute.
          + voidsetFork(boolean value) + +
          +          Set the fork attribute.
          + voidsetHaltonerror(boolean value) + +
          +          Set the haltonerror attribute.
          + voidsetHaltonfailure(boolean value) + +
          +          Set the haltonfailure attribute.
          + voidsetIf(java.lang.Object ifCondition) + +
          +          Set the if attribute.
          + voidsetIf(java.lang.String propertyName) + +
          +          Set the if attribute.
          + voidsetTodir(java.io.File destDir) + +
          +          Sets the destination directory.
          + voidsetUnless(java.lang.Object unlessCondition) + +
          +          Set the unless attribute.
          + voidsetUnless(java.lang.String propertyName) + +
          +          Set the unless attribute.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +haltOnError

          +
          +protected boolean haltOnError
          +
          +
          +
          +
          +
          + +

          +haltOnFail

          +
          +protected boolean haltOnFail
          +
          +
          +
          +
          +
          + +

          +filtertrace

          +
          +protected boolean filtertrace
          +
          +
          +
          +
          +
          + +

          +fork

          +
          +protected boolean fork
          +
          +
          +
          +
          +
          + +

          +ifProperty

          +
          +protected java.lang.String ifProperty
          +
          +
          +
          +
          +
          + +

          +unlessProperty

          +
          +protected java.lang.String unlessProperty
          +
          +
          +
          +
          +
          + +

          +formatters

          +
          +protected java.util.Vector formatters
          +
          +
          +
          +
          +
          + +

          +destDir

          +
          +protected java.io.File destDir
          +
          +
          destination directory +

          +

          +
          +
          +
          + +

          +failureProperty

          +
          +protected java.lang.String failureProperty
          +
          +
          +
          +
          +
          + +

          +errorProperty

          +
          +protected java.lang.String errorProperty
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseTest

          +
          +public BaseTest()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFiltertrace

          +
          +public void setFiltertrace(boolean value)
          +
          +
          Set the filtertrace attribute. +

          +

          +
          Parameters:
          value - a boolean value.
          +
          +
          +
          + +

          +getFiltertrace

          +
          +public boolean getFiltertrace()
          +
          +
          Get the filtertrace attribute. +

          +

          + +
          Returns:
          the attribute.
          +
          +
          +
          + +

          +setFork

          +
          +public void setFork(boolean value)
          +
          +
          Set the fork attribute. +

          +

          +
          Parameters:
          value - a boolean value.
          +
          +
          +
          + +

          +getFork

          +
          +public boolean getFork()
          +
          +
          Get the fork attribute. +

          +

          + +
          Returns:
          the attribute.
          +
          +
          +
          + +

          +setHaltonerror

          +
          +public void setHaltonerror(boolean value)
          +
          +
          Set the haltonerror attribute. +

          +

          +
          Parameters:
          value - a boolean value.
          +
          +
          +
          + +

          +setHaltonfailure

          +
          +public void setHaltonfailure(boolean value)
          +
          +
          Set the haltonfailure attribute. +

          +

          +
          Parameters:
          value - a boolean value.
          +
          +
          +
          + +

          +getHaltonerror

          +
          +public boolean getHaltonerror()
          +
          +
          Get the haltonerror attribute. +

          +

          + +
          Returns:
          the attribute.
          +
          +
          +
          + +

          +getHaltonfailure

          +
          +public boolean getHaltonfailure()
          +
          +
          Get the haltonfailure attribute. +

          +

          + +
          Returns:
          the attribute.
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.Object ifCondition)
          +
          +
          Set the if attribute. + If this expression evaluates to true or the name of a property + which is present in project, the test will be run. +

          +

          +
          Parameters:
          ifCondition - the expression to evaluate
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.String propertyName)
          +
          +
          Set the if attribute. + If this expression evaluates to true or the name of a property + which is present in project, the test will be run. +

          +

          +
          Parameters:
          propertyName - the expression to evaluate
          +
          +
          +
          + +

          +getIfCondition

          +
          +public java.lang.Object getIfCondition()
          +
          +
          The if expression +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.Object unlessCondition)
          +
          +
          Set the unless attribute. If this expression evaluates to + false or the name of a property which is not present in + project, the test will be run. +

          +

          +
          Parameters:
          unlessCondition - the expression to evaluate
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.String propertyName)
          +
          +
          Set the unless attribute. If this expression evaluates to + false or the name of a property which is not present in + project, the test will be run. +

          +

          +
          Parameters:
          propertyName - the expression to evaluate
          +
          +
          +
          + +

          +getUnlessCondition

          +
          +public java.lang.Object getUnlessCondition()
          +
          +
          The unless expression +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +addFormatter

          +
          +public void addFormatter(FormatterElement elem)
          +
          +
          Allow a formatter nested element. +

          +

          +
          Parameters:
          elem - a formatter nested element.
          +
          +
          +
          + +

          +setTodir

          +
          +public void setTodir(java.io.File destDir)
          +
          +
          Sets the destination directory. +

          +

          +
          Parameters:
          destDir - the destination directory.
          +
          +
          +
          + +

          +getTodir

          +
          +public java.lang.String getTodir()
          +
          +
          Get the destination directory. +

          +

          + +
          Returns:
          the destination directory as an absolute path if it exists + otherwise return null
          +
          +
          +
          + +

          +getFailureProperty

          +
          +public java.lang.String getFailureProperty()
          +
          +
          Get the failure property name. +

          +

          + +
          Returns:
          the name of the property to set on failure.
          +
          +
          +
          + +

          +setFailureProperty

          +
          +public void setFailureProperty(java.lang.String failureProperty)
          +
          +
          Set the name of the failure property. +

          +

          +
          Parameters:
          failureProperty - the name of the property to set if + the test fails.
          +
          +
          +
          + +

          +getErrorProperty

          +
          +public java.lang.String getErrorProperty()
          +
          +
          Get the failure property name. +

          +

          + +
          Returns:
          the name of the property to set on failure.
          +
          +
          +
          + +

          +setErrorProperty

          +
          +public void setErrorProperty(java.lang.String errorProperty)
          +
          +
          Set the name of the error property. +

          +

          +
          Parameters:
          errorProperty - the name of the property to set if + the test has an error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.html new file mode 100644 index 000000000..c5aab2870 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BatchTest.html @@ -0,0 +1,371 @@ + + + + + + +BatchTest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class BatchTest

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.BaseTest
+      extended by org.apache.tools.ant.taskdefs.optional.junit.BatchTest
+
          +
          +
          +
          public final class BatchTest
          extends BaseTest
          + + +

          +

          Create then run JUnitTest's based on the list of files + given by the fileset attribute. + +

          Every .java or .class file in the fileset is + assumed to be a testcase. + A JUnitTest is created for each of these named classes with + basic setup inherited from the parent BatchTest. +

          + +

          +

          +
          See Also:
          JUnitTest
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.junit.BaseTest
          destDir, errorProperty, failureProperty, filtertrace, fork, formatters, haltOnError, haltOnFail, ifProperty, unlessProperty
          +  + + + + + + + + + + +
          +Constructor Summary
          BatchTest(Project project) + +
          +          create a new batchtest instance
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection rc) + +
          +          Add a new ResourceCollection instance to this + batchtest.
          + voidaddFileSet(FileSet fs) + +
          +          Add a new fileset instance to this batchtest.
          + java.util.Enumerationelements() + +
          +          Return all JUnitTest instances obtain by applying the fileset rules.
          +static java.lang.StringjavaToClass(java.lang.String filename) + +
          +          Convenient method to convert a pathname without extension to a + fully qualified classname.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.junit.BaseTest
          addFormatter, getErrorProperty, getFailureProperty, getFiltertrace, getFork, getHaltonerror, getHaltonfailure, getIfCondition, getTodir, getUnlessCondition, setErrorProperty, setFailureProperty, setFiltertrace, setFork, setHaltonerror, setHaltonfailure, setIf, setIf, setTodir, setUnless, setUnless
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BatchTest

          +
          +public BatchTest(Project project)
          +
          +
          create a new batchtest instance +

          +

          +
          Parameters:
          project - the project it depends on.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addFileSet

          +
          +public void addFileSet(FileSet fs)
          +
          +
          Add a new fileset instance to this batchtest. Whatever the fileset is, + only filename that are .java or .class will be + considered as 'candidates'. +

          +

          +
          Parameters:
          fs - the new fileset containing the rules to get the testcases.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection rc)
          +
          +
          Add a new ResourceCollection instance to this + batchtest. Whatever the collection is, only names that are + .java or .class will be considered as + 'candidates'. +

          +

          +
          Parameters:
          rc - the new ResourceCollection containing the rules to + get the testcases.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +elements

          +
          +public java.util.Enumeration elements()
          +
          +
          Return all JUnitTest instances obtain by applying the fileset rules. +

          +

          + +
          Returns:
          an enumeration of all elements of this batchtest that are + a JUnitTest instance.
          +
          +
          +
          + +

          +javaToClass

          +
          +public static java.lang.String javaToClass(java.lang.String filename)
          +
          +
          Convenient method to convert a pathname without extension to a + fully qualified classname. For example org/apache/Whatever will + be converted to org.apache.Whatever +

          +

          +
          Parameters:
          filename - the filename to "convert" to a classname. +
          Returns:
          the classname matching the filename.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.html new file mode 100644 index 000000000..48c8f374f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/BriefJUnitResultFormatter.html @@ -0,0 +1,544 @@ + + + + + + +BriefJUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class BriefJUnitResultFormatter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.BriefJUnitResultFormatter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          +
          public class BriefJUnitResultFormatter
          extends java.lang.Object
          implements JUnitResultFormatter
          + + +

          +Prints plain text output of the test to a specified Writer. + Inspired by the PlainJUnitResultFormatter. +

          + +

          +

          +
          See Also:
          FormatterElement, +PlainJUnitResultFormatter
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          BriefJUnitResultFormatter() + +
          +          Constructor for BriefJUnitResultFormatter.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable error) + +
          +          A test caused an error.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +          Interface TestListener for JUnit > 3.4.
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener for JUnit <= 3.4.
          + voidendTest(junit.framework.Test test) + +
          +          A test ended.
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          +protected  voidformatError(java.lang.String type, + junit.framework.Test test, + java.lang.Throwable error) + +
          +          Format an error and print it.
          +protected  java.lang.StringformatTest(junit.framework.Test test) + +
          +          Format the test for printing..
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to.
          + voidsetSystemError(java.lang.String err) + +
          +          This is what the test has written to System.err.
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out.
          + voidstartTest(junit.framework.Test test) + +
          +          A test started.
          + voidstartTestSuite(JUnitTest suite) + +
          +          The whole testsuite started.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BriefJUnitResultFormatter

          +
          +public BriefJUnitResultFormatter()
          +
          +
          Constructor for BriefJUnitResultFormatter. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Sets the stream the formatter is supposed to write its results to. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to write to
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          This is what the test has written to System.out. +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String err)
          +
          +
          This is what the test has written to System.err. +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          +
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
          +
          +
          The whole testsuite started. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the test suite
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
          +
          +
          The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the test suite
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test test)
          +
          +
          A test started. +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - a test
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          A test ended. +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - a test
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          Interface TestListener for JUnit <= 3.4. + +

          A Test failed. +

          +

          +
          +
          +
          +
          Parameters:
          test - a test
          t - the exception thrown by the test
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          Interface TestListener for JUnit > 3.4. + +

          A Test failed. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - a test
          t - the assertion failed by the test
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable error)
          +
          +
          A test caused an error. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - a test
          error - the error thrown by the test
          +
          +
          +
          + +

          +formatTest

          +
          +protected java.lang.String formatTest(junit.framework.Test test)
          +
          +
          Format the test for printing.. +

          +

          +
          +
          +
          +
          Parameters:
          test - a test +
          Returns:
          the formatted testname
          +
          +
          +
          + +

          +formatError

          +
          +protected void formatError(java.lang.String type,
+                           junit.framework.Test test,
+                           java.lang.Throwable error)
          +
          +
          Format an error and print it. +

          +

          +
          +
          +
          +
          Parameters:
          type - the type of error
          test - the test that failed
          error - the exception that the test threw
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Constants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Constants.html new file mode 100644 index 000000000..26f8df68f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Constants.html @@ -0,0 +1,223 @@ + + + + + + +Constants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class Constants

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.Constants
+
          +
          +
          +
          public class Constants
          extends java.lang.Object
          + + +

          +Constants, like filenames shared between various classes in this package. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Constants() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Constants

          +
          +public Constants()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeFilter.html new file mode 100644 index 000000000..291bdb10c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeFilter.html @@ -0,0 +1,211 @@ + + + + + + +DOMUtil.NodeFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface DOMUtil.NodeFilter

          +
          +
          Enclosing class:
          DOMUtil
          +
          +
          +
          +
          public static interface DOMUtil.NodeFilter
          + + +

          +Filter interface to be applied when iterating over a DOM tree. + Just think of it like a FileFilter clone. +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + booleanaccept(org.w3c.dom.Node node) + +
          +           
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +accept

          +
          +boolean accept(org.w3c.dom.Node node)
          +
          +
          +
          Parameters:
          node - the node to check for acceptance. +
          Returns:
          true if the node is accepted by this filter, + otherwise false
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeListImpl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeListImpl.html new file mode 100644 index 000000000..619f19a62 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.NodeListImpl.html @@ -0,0 +1,347 @@ + + + + + + +DOMUtil.NodeListImpl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class DOMUtil.NodeListImpl

          +
          +java.lang.Object
+  extended by java.util.AbstractCollection<E>
+      extended by java.util.AbstractList<E>
+          extended by java.util.Vector
+              extended by org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeListImpl
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess, org.w3c.dom.NodeList
          +
          +
          +
          Enclosing class:
          DOMUtil
          +
          +
          +
          +
          public static class DOMUtil.NodeListImpl
          extends java.util.Vector
          implements org.w3c.dom.NodeList
          + + +

          +custom implementation of a nodelist +

          + +

          +

          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.util.Vector
          capacityIncrement, elementCount, elementData
          +  + + + + + + + +
          Fields inherited from class java.util.AbstractList
          modCount
          +  + + + + + + + + + + +
          +Constructor Summary
          DOMUtil.NodeListImpl() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetLength() + +
          +          Get the number of nodes in the list.
          + org.w3c.dom.Nodeitem(int i) + +
          +          Get a particular node.
          +  + + + + + + + +
          Methods inherited from class java.util.Vector
          add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
          +  + + + + + + + +
          Methods inherited from class java.util.AbstractList
          iterator, listIterator, listIterator
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface java.util.List
          iterator, listIterator, listIterator
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DOMUtil.NodeListImpl

          +
          +public DOMUtil.NodeListImpl()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getLength

          +
          +public int getLength()
          +
          +
          Get the number of nodes in the list. +

          +

          +
          Specified by:
          getLength in interface org.w3c.dom.NodeList
          +
          +
          + +
          Returns:
          the length of the list.
          +
          +
          +
          + +

          +item

          +
          +public org.w3c.dom.Node item(int i)
          +
          +
          Get a particular node. +

          +

          +
          Specified by:
          item in interface org.w3c.dom.NodeList
          +
          +
          +
          Parameters:
          i - the index of the node to get. +
          Returns:
          the node if the index is in bounds, null otherwise.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.html new file mode 100644 index 000000000..7157ea219 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/DOMUtil.html @@ -0,0 +1,335 @@ + + + + + + +DOMUtil (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class DOMUtil

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.DOMUtil
+
          +
          +
          +
          public final class DOMUtil
          extends java.lang.Object
          + + +

          +Some utilities that might be useful when manipulating DOM trees. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static interfaceDOMUtil.NodeFilter + +
          +          Filter interface to be applied when iterating over a DOM tree.
          +static classDOMUtil.NodeListImpl + +
          +          custom implementation of a nodelist
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static org.w3c.dom.ElementgetChildByTagName(org.w3c.dom.Node parent, + java.lang.String tagname) + +
          +          Iterate over the children of a given node and return the first node + that has a specific name.
          +static java.lang.StringgetNodeAttribute(org.w3c.dom.Node node, + java.lang.String name) + +
          +          return the attribute value of an element.
          +static org.w3c.dom.NodeimportNode(org.w3c.dom.Node parent, + org.w3c.dom.Node child) + +
          +          Simple tree walker that will clone recursively a node.
          +static org.w3c.dom.NodeListlistChildNodes(org.w3c.dom.Node parent, + DOMUtil.NodeFilter filter, + boolean recurse) + +
          +          list a set of node that match a specific filter.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +listChildNodes

          +
          +public static org.w3c.dom.NodeList listChildNodes(org.w3c.dom.Node parent,
+                                                  DOMUtil.NodeFilter filter,
+                                                  boolean recurse)
          +
          +
          list a set of node that match a specific filter. The list can be made + recursively or not. +

          +

          +
          Parameters:
          parent - the parent node to search from
          filter - the filter that children should match.
          recurse - true if you want the list to be made recursively + otherwise false. +
          Returns:
          the node list that matches the filter.
          +
          +
          +
          + +

          +getNodeAttribute

          +
          +public static java.lang.String getNodeAttribute(org.w3c.dom.Node node,
+                                                java.lang.String name)
          +
          +
          return the attribute value of an element. +

          +

          +
          Parameters:
          node - the node to get the attribute from.
          name - the name of the attribute we are looking for the value. +
          Returns:
          the value of the requested attribute or null if the + attribute was not found or if node is not an Element.
          +
          +
          +
          + +

          +getChildByTagName

          +
          +public static org.w3c.dom.Element getChildByTagName(org.w3c.dom.Node parent,
+                                                    java.lang.String tagname)
          +
          +
          Iterate over the children of a given node and return the first node + that has a specific name. +

          +

          +
          Parameters:
          parent - the node to search child from. Can be null.
          tagname - the child name we are looking for. Cannot be null. +
          Returns:
          the first child that matches the given name or null if + the parent is null or if a child does not match the + given name.
          +
          +
          +
          + +

          +importNode

          +
          +public static org.w3c.dom.Node importNode(org.w3c.dom.Node parent,
+                                          org.w3c.dom.Node child)
          +
          +
          Simple tree walker that will clone recursively a node. This is to + avoid using parser-specific API such as Sun's changeNodeOwner + when we are dealing with DOM L1 implementations since cloneNode(boolean) + will not change the owner document. + changeNodeOwner is much faster and avoid the costly cloning process. + importNode is in the DOM L2 interface. +

          +

          +
          Parameters:
          parent - the node parent to which we should do the import to.
          child - the node to clone recursively. Its clone will be + appended to parent. +
          Returns:
          the cloned node that is appended to parent
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.html new file mode 100644 index 000000000..ebf8720e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/Enumerations.html @@ -0,0 +1,247 @@ + + + + + + +Enumerations (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class Enumerations

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.Enumerations
+
          +
          +
          +
          public final class Enumerations
          extends java.lang.Object
          + + +

          +A couple of methods related to enumerations that might be useful. + This class should probably disappear once the required JDK is set to 1.2 + instead of 1.1. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.util.EnumerationfromArray(java.lang.Object[] array) + +
          +          creates an enumeration from an array of objects.
          +static java.util.EnumerationfromCompound(java.util.Enumeration[] enums) + +
          +          creates an enumeration from an array of enumeration.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +fromArray

          +
          +public static java.util.Enumeration fromArray(java.lang.Object[] array)
          +
          +
          creates an enumeration from an array of objects. +

          +

          +
          Parameters:
          array - the array of object to enumerate. +
          Returns:
          the enumeration over the array of objects.
          +
          +
          +
          + +

          +fromCompound

          +
          +public static java.util.Enumeration fromCompound(java.util.Enumeration[] enums)
          +
          +
          creates an enumeration from an array of enumeration. The created enumeration + will sequentially enumerate over all elements of each enumeration and skip + null enumeration elements in the array. +

          +

          +
          Parameters:
          enums - the array of enumerations. +
          Returns:
          the enumeration over the array of enumerations.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.TestInfos.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.TestInfos.html new file mode 100644 index 000000000..bce083e61 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.TestInfos.html @@ -0,0 +1,340 @@ + + + + + + +FailureRecorder.TestInfos (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class FailureRecorder.TestInfos

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder.TestInfos
+
          +
          +
          All Implemented Interfaces:
          java.lang.Comparable
          +
          +
          +
          Enclosing class:
          FailureRecorder
          +
          +
          +
          +
          public static class FailureRecorder.TestInfos
          extends java.lang.Object
          implements java.lang.Comparable
          + + +

          +TestInfos holds information about a given test for later use. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FailureRecorder.TestInfos(junit.framework.Test test) + +
          +          This constructor extracts the needed information from the given test.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intcompareTo(java.lang.Object other) + +
          +          The SortedMap needs comparable elements.
          + booleanequals(java.lang.Object obj) + +
          +           
          + inthashCode() + +
          +           
          + java.lang.StringtoString() + +
          +          This String-Representation can directly be used for instantiation of + the JUnit testcase.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FailureRecorder.TestInfos

          +
          +public FailureRecorder.TestInfos(junit.framework.Test test)
          +
          +
          This constructor extracts the needed information from the given test. +

          +

          +
          Parameters:
          test - Test to analyze
          +
          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          This String-Representation can directly be used for instantiation of + the JUnit testcase. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the string representation.
          See Also:
          Object.toString(), +FailureRecorder.createSuiteMethod()
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object other)
          +
          +
          The SortedMap needs comparable elements. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          +
          +
          +
          Parameters:
          other - the object to compare to. +
          Returns:
          the result of the comparison.
          See Also:
          Comparable.compareTo(T), +SortedSet.comparator()
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object obj)
          +
          +
          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.html new file mode 100644 index 000000000..05bbdc75e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FailureRecorder.html @@ -0,0 +1,871 @@ + + + + + + +FailureRecorder (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class FailureRecorder

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.optional.junit.FailureRecorder
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.EventListener, junit.framework.TestListener, BuildListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          +
          public class FailureRecorder
          extends ProjectComponent
          implements JUnitResultFormatter, BuildListener
          + + +

          +

          Collects all failing test cases and creates a new JUnit test class containing + a suite() method which calls these failed tests.

          +

          Having classes A ... D with each several testcases you could earn a new + test class like + 

          + // generated on: 2007.08.06 09:42:34,555
+ import junit.framework.*;
+ public class FailedTests extends TestCase {
+     public FailedTests(String testname) {
+         super(testname);
+     }
+     public static Test suite() {
+         TestSuite suite = new TestSuite();
+         suite.addTest( new B("test04") );
+         suite.addTest( new org.D("test10") );
+         return suite;
+     }
+ }
+
          + + Because each running test case gets its own formatter, we collect + the failing test cases in a static list. Because we dont have a finalizer + method in the formatters "lifecycle", we register this formatter as + BuildListener and generate the new java source on taskFinished event. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classFailureRecorder.TestInfos + +
          +          TestInfos holds information about a given test for later use.
          +  + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_CLASS_LOCATION + +
          +          Default location and name for the generated JUnit class file, + in the temp directory + FailedTests
          +static java.lang.StringMAGIC_PROPERTY_CLASS_LOCATION + +
          +          This is the name of a magic System property ("ant.junit.failureCollector").
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FailureRecorder() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable throwable) + +
          +          Add the failed test to the list.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError error) + +
          +          Add the failed test to the list.
          + voidbuildFinished(BuildEvent event) + +
          +          Not used + Signals that the last target has finished.
          + voidbuildStarted(BuildEvent event) + +
          +          Not used + Signals that a build has started.
          + voidendTest(junit.framework.Test test) + +
          +          Not used +
          + voidendTestSuite(JUnitTest suite) + +
          +          Not used + The whole testsuite ended.
          + voidlog(java.lang.String message) + +
          +          Logging facade in INFO-mode.
          + voidmessageLogged(BuildEvent event) + +
          +          Not used + Signals a message logging event.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Not used + Sets the stream the formatter is supposed to write its results to.
          + voidsetProject(Project project) + +
          +          This method is called by the Ant runtime by reflection.
          + voidsetSystemError(java.lang.String err) + +
          +          Not used + This is what the test has written to System.err
          + voidsetSystemOutput(java.lang.String out) + +
          +          Not used + This is what the test has written to System.out
          + voidstartTest(junit.framework.Test test) + +
          +          Not used +
          + voidstartTestSuite(JUnitTest suite) + +
          +          Not used + The whole testsuite started.
          + voidtargetFinished(BuildEvent event) + +
          +          Not used + Signals that a target has finished.
          + voidtargetStarted(BuildEvent event) + +
          +          Not used + Signals that a target is starting.
          + voidtaskFinished(BuildEvent event) + +
          +          The task outside of this JUnitResultFormatter is the task.
          + voidtaskStarted(BuildEvent event) + +
          +          Not used + Signals that a task is starting.
          + voidverbose(java.lang.String message) + +
          +          Logging facade in VERBOSE-mode.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MAGIC_PROPERTY_CLASS_LOCATION

          +
          +public static final java.lang.String MAGIC_PROPERTY_CLASS_LOCATION
          +
          +
          This is the name of a magic System property ("ant.junit.failureCollector"). The value of this + System property should point to the location where to store the + generated class (without suffix). + Default location and name is defined in DEFAULT_CLASS_LOCATION. +

          +

          +
          See Also:
          DEFAULT_CLASS_LOCATION, +Constant Field Values
          +
          +
          + +

          +DEFAULT_CLASS_LOCATION

          +
          +public static final java.lang.String DEFAULT_CLASS_LOCATION
          +
          +
          Default location and name for the generated JUnit class file, + in the temp directory + FailedTests +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FailureRecorder

          +
          +public FailureRecorder()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          This method is called by the Ant runtime by reflection. We use the project reference for + registration of this class as BuildListener. +

          +

          +
          Overrides:
          setProject in class ProjectComponent
          +
          +
          +
          Parameters:
          project - project reference
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
+                  throws BuildException
          +
          +
          Not used + The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the suite. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable throwable)
          +
          +
          Add the failed test to the list. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test that errored.
          throwable - the reason it errored.
          See Also:
          TestListener.addError(junit.framework.Test, java.lang.Throwable)
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError error)
          +
          +
          Add the failed test to the list. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test that failed.
          error - the assertion that failed.
          See Also:
          TestListener.addFailure(junit.framework.Test, junit.framework.AssertionFailedError)
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Not used + Sets the stream the formatter is supposed to write its results to. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String err)
          +
          +
          Not used + This is what the test has written to System.err +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          Not used + This is what the test has written to System.out +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
+                    throws BuildException
          +
          +
          Not used + The whole testsuite started. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the suite. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          Not used + +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test test)
          +
          +
          Not used + +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String message)
          +
          +
          Logging facade in INFO-mode. +

          +

          +
          Overrides:
          log in class ProjectComponent
          +
          +
          +
          Parameters:
          message - Log-message
          +
          +
          +
          + +

          +verbose

          +
          +public void verbose(java.lang.String message)
          +
          +
          Logging facade in VERBOSE-mode. +

          +

          +
          +
          +
          +
          Parameters:
          message - Log-message
          +
          +
          +
          + +

          +buildFinished

          +
          +public void buildFinished(BuildEvent event)
          +
          +
          Not used + Signals that the last target has finished. This event + will still be fired if an error occurred during the build. +

          +

          +
          Specified by:
          buildFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +buildStarted

          +
          +public void buildStarted(BuildEvent event)
          +
          +
          Not used + Signals that a build has started. This event + is fired before any targets have started. + +

          This event is fired before the project instance is fully + configured. In particular no properties have been set and the + project may not know its name or default target, yet.

          +

          +

          +
          Specified by:
          buildStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          +
          +
          +
          + +

          +messageLogged

          +
          +public void messageLogged(BuildEvent event)
          +
          +
          Not used + Signals a message logging event. +

          +

          +
          Specified by:
          messageLogged in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          See Also:
          BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
          +
          +
          +
          + +

          +targetFinished

          +
          +public void targetFinished(BuildEvent event)
          +
          +
          Not used + Signals that a target has finished. This event will + still be fired if an error occurred during the build. +

          +

          +
          Specified by:
          targetFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +targetStarted

          +
          +public void targetStarted(BuildEvent event)
          +
          +
          Not used + Signals that a target is starting. +

          +

          +
          Specified by:
          targetStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          See Also:
          BuildEvent.getTarget()
          +
          +
          +
          + +

          +taskFinished

          +
          +public void taskFinished(BuildEvent event)
          +
          +
          The task outside of this JUnitResultFormatter is the task. So all tests passed + and we could create the new java class. +

          +

          +
          Specified by:
          taskFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - not used
          See Also:
          BuildListener.taskFinished(org.apache.tools.ant.BuildEvent)
          +
          +
          +
          + +

          +taskStarted

          +
          +public void taskStarted(BuildEvent event)
          +
          +
          Not used + Signals that a task is starting. +

          +

          +
          Specified by:
          taskStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - An event with any relevant extra information. + Must not be null.
          See Also:
          BuildEvent.getTask()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html new file mode 100644 index 000000000..b34df7b28 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.TypeAttribute.html @@ -0,0 +1,292 @@ + + + + + + +FormatterElement.TypeAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class FormatterElement.TypeAttribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.junit.FormatterElement.TypeAttribute
+
          +
          +
          Enclosing class:
          FormatterElement
          +
          +
          +
          +
          public static class FormatterElement.TypeAttribute
          extends EnumeratedAttribute
          + + +

          +

          Enumerated attribute with the values "plain", "xml", "brief" and "failure". + +

          Use to enumerate options for type attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FormatterElement.TypeAttribute() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FormatterElement.TypeAttribute

          +
          +public FormatterElement.TypeAttribute()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement.. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html new file mode 100644 index 000000000..66a653502 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/FormatterElement.html @@ -0,0 +1,675 @@ + + + + + + +FormatterElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class FormatterElement

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.FormatterElement
+
          +
          +
          +
          public class FormatterElement
          extends java.lang.Object
          + + +

          +

          A wrapper for the implementations of JUnitResultFormatter. + In particular, used as a nested <formatter> element in + a <junit> task. +

          For example, + 

          +       <junit printsummary="no" haltonfailure="yes" fork="false">
+           <formatter type="plain" usefile="false" />
+           <test name="org.apache.ecs.InternationalCharTest" />
+       </junit>
          + adds a plain type implementation + (PlainJUnitResultFormatter) to display the results of the test. + +

          Either the type or the classname attribute + must be set. +

          + +

          +

          +
          See Also:
          JUnitTask, +XMLJUnitResultFormatter, +BriefJUnitResultFormatter, +PlainJUnitResultFormatter, +FailureRecorder, +JUnitResultFormatter
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classFormatterElement.TypeAttribute + +
          +           Enumerated attribute with the values "plain", "xml", "brief" and "failure".
          +  + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringBRIEF_FORMATTER_CLASS_NAME + +
          +          brief formatter class
          +static java.lang.StringFAILURE_RECORDER_CLASS_NAME + +
          +          failure recorder class
          +static java.lang.StringPLAIN_FORMATTER_CLASS_NAME + +
          +          plain formatter class
          +static java.lang.StringXML_FORMATTER_CLASS_NAME + +
          +          xml formatter class
          +  + + + + + + + + + + +
          +Constructor Summary
          FormatterElement() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetClassname() + +
          +          Get name of class to be used as the formatter.
          + java.lang.StringgetExtension() + +
          +          Get the extension used for the report file.
          + voidsetClassname(java.lang.String classname) + +
          +           Set name of class to be used as the formatter.
          + voidsetExtension(java.lang.String ext) + +
          +          Set the extension to use for the report file.
          + voidsetIf(java.lang.Object ifCond) + +
          +          Set whether this formatter should be used.
          + voidsetIf(java.lang.String ifCond) + +
          +          Set whether this formatter should be used.
          + voidsetOutput(java.io.OutputStream out) + +
          +           Set output stream for formatter to use.
          + voidsetProject(Project project) + +
          +          Store the project reference for passing it to nested components.
          + voidsetType(FormatterElement.TypeAttribute type) + +
          +           Quick way to use a standard formatter.
          + voidsetUnless(java.lang.Object unlessCond) + +
          +          Set whether this formatter should NOT be used.
          + voidsetUnless(java.lang.String unlessCond) + +
          +          Set whether this formatter should NOT be used.
          + voidsetUseFile(boolean useFile) + +
          +          Set whether the formatter should log to file.
          + booleanshouldUse(Task t) + +
          +          Ensures that the selector passes the conditions placed + on it with if and unless properties.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +XML_FORMATTER_CLASS_NAME

          +
          +public static final java.lang.String XML_FORMATTER_CLASS_NAME
          +
          +
          xml formatter class +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +BRIEF_FORMATTER_CLASS_NAME

          +
          +public static final java.lang.String BRIEF_FORMATTER_CLASS_NAME
          +
          +
          brief formatter class +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PLAIN_FORMATTER_CLASS_NAME

          +
          +public static final java.lang.String PLAIN_FORMATTER_CLASS_NAME
          +
          +
          plain formatter class +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FAILURE_RECORDER_CLASS_NAME

          +
          +public static final java.lang.String FAILURE_RECORDER_CLASS_NAME
          +
          +
          failure recorder class +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FormatterElement

          +
          +public FormatterElement()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setType

          +
          +public void setType(FormatterElement.TypeAttribute type)
          +
          +

          Quick way to use a standard formatter. + +

          At the moment, there are three supported standard formatters. +

            +
          • The xml type uses a XMLJUnitResultFormatter. +
          • The brief type uses a BriefJUnitResultFormatter. +
          • The plain type (the default) uses a PlainJUnitResultFormatter. +
          • The failure type uses a FailureRecorder. +
          + +

          Sets classname attribute - so you can't use that + attribute if you use this one. +

          +

          +
          Parameters:
          type - the enumerated value to use.
          +
          +
          +
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String classname)
          +
          +

          Set name of class to be used as the formatter. + +

          This class must implement JUnitResultFormatter +

          +

          +
          Parameters:
          classname - the name of the formatter class.
          +
          +
          +
          + +

          +getClassname

          +
          +public java.lang.String getClassname()
          +
          +
          Get name of class to be used as the formatter. +

          +

          + +
          Returns:
          the name of the class.
          +
          +
          +
          + +

          +setExtension

          +
          +public void setExtension(java.lang.String ext)
          +
          +
          Set the extension to use for the report file. +

          +

          +
          Parameters:
          ext - the extension to use.
          +
          +
          +
          + +

          +getExtension

          +
          +public java.lang.String getExtension()
          +
          +
          Get the extension used for the report file. +

          +

          + +
          Returns:
          the extension.
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +

          Set output stream for formatter to use. + +

          Defaults to standard out. +

          +

          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setUseFile

          +
          +public void setUseFile(boolean useFile)
          +
          +
          Set whether the formatter should log to file. +

          +

          +
          Parameters:
          useFile - if true use a file, if false send + to standard out.
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.Object ifCond)
          +
          +
          Set whether this formatter should be used. It will be used if + the expression evaluates to true or the name of a property + which has been set, otherwise it won't. +

          +

          +
          Parameters:
          ifCond - name of property
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.String ifCond)
          +
          +
          Set whether this formatter should be used. It will be used if + the expression evaluates to true or the name of a property + which has been set, otherwise it won't. +

          +

          +
          Parameters:
          ifCond - name of property
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.Object unlessCond)
          +
          +
          Set whether this formatter should NOT be used. It will be used + if the expression evaluates to false or the name of a property + which has not been set, orthwise it will not be used. +

          +

          +
          Parameters:
          unlessCond - name of property
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.String unlessCond)
          +
          +
          Set whether this formatter should NOT be used. It will be used + if the expression evaluates to false or the name of a property + which has not been set, orthwise it will not be used. +

          +

          +
          Parameters:
          unlessCond - name of property
          +
          +
          +
          + +

          +shouldUse

          +
          +public boolean shouldUse(Task t)
          +
          +
          Ensures that the selector passes the conditions placed + on it with if and unless properties. +

          +

          +
          Parameters:
          t - the task the this formatter is used in. +
          Returns:
          true if the formatter should be used.
          +
          +
          +
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Store the project reference for passing it to nested components. +

          +

          +
          Parameters:
          project - the reference
          Since:
          +
          Ant 1.8
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnit4TestMethodAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnit4TestMethodAdapter.html new file mode 100644 index 000000000..176722f50 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnit4TestMethodAdapter.html @@ -0,0 +1,385 @@ + + + + + + +JUnit4TestMethodAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnit4TestMethodAdapter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.JUnit4TestMethodAdapter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.Test
          +
          +
          +
          +
          public class JUnit4TestMethodAdapter
          extends java.lang.Object
          implements junit.framework.Test
          + + +

          +Adapter between JUnit 3.8.x API and JUnit 4.x API for execution of tests + and listening of events (test start, test finish, test failure). + The constructor is passed a JUnit 4 test class and a list of name of methods + in it that should be executed. Method run(TestResult) executes + the given JUnit-4-style test methods and notifies the given TestResult + object using its old (JUnit 3.8.x style) API. +

          + +

          +

          +
          Author:
          +
          Marian Petras
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JUnit4TestMethodAdapter(java.lang.Class testClass, + java.lang.String[] methodNames) + +
          +          Creates a new adapter for the given class and a method within the class.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intcountTestCases() + +
          +           
          + org.junit.runner.DescriptiongetDescription() + +
          +           
          + java.lang.ClassgetTestClass() + +
          +           
          + java.util.ListgetTests() + +
          +           
          + voidrun(junit.framework.TestResult result) + +
          +           
          + java.lang.StringtoString() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnit4TestMethodAdapter

          +
          +public JUnit4TestMethodAdapter(java.lang.Class testClass,
+                               java.lang.String[] methodNames)
          +
          +
          Creates a new adapter for the given class and a method within the class. +

          +

          +
          Parameters:
          testClass - test class containing the method to be executed
          methodNames - names of the test methods that are to be executed +
          Throws: +
          java.lang.IllegalArgumentException - if any of the arguments is null + or if any of the given method names is null or empty
          +
          + + + + + + + + +
          +Method Detail
          + +

          +countTestCases

          +
          +public int countTestCases()
          +
          +
          +
          Specified by:
          countTestCases in interface junit.framework.Test
          +
          +
          +
          +
          +
          +
          + +

          +getDescription

          +
          +public org.junit.runner.Description getDescription()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +getTests

          +
          +public java.util.List getTests()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +getTestClass

          +
          +public java.lang.Class getTestClass()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +run

          +
          +public void run(junit.framework.TestResult result)
          +
          +
          +
          Specified by:
          run in interface junit.framework.Test
          +
          +
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitResultFormatter.html new file mode 100644 index 000000000..37f547b51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitResultFormatter.html @@ -0,0 +1,328 @@ + + + + + + +JUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface JUnitResultFormatter

          +
          +
          All Superinterfaces:
          JUnitTaskMirror.JUnitResultFormatterMirror, junit.framework.TestListener
          +
          +
          +
          All Known Implementing Classes:
          BriefJUnitResultFormatter, FailureRecorder, OutErrSummaryJUnitResultFormatter, PlainJUnitResultFormatter, SummaryJUnitResultFormatter, TearDownOnVmCrash, XMLJUnitResultFormatter
          +
          +
          +
          +
          public interface JUnitResultFormatter
          extends junit.framework.TestListener, JUnitTaskMirror.JUnitResultFormatterMirror
          + + +

          +This Interface describes classes that format the results of a JUnit + testrun. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to.
          + voidsetSystemError(java.lang.String err) + +
          +          This is what the test has written to System.err
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out
          + voidstartTestSuite(JUnitTest suite) + +
          +          The whole testsuite started.
          +  + + + + + + + +
          Methods inherited from interface junit.framework.TestListener
          addError, addFailure, endTest, startTest
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +startTestSuite

          +
          +void startTestSuite(JUnitTest suite)
+                    throws BuildException
          +
          +
          The whole testsuite started. +

          +

          +
          +
          +
          +
          Parameters:
          suite - the suite. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +endTestSuite

          +
          +void endTestSuite(JUnitTest suite)
+                  throws BuildException
          +
          +
          The whole testsuite ended. +

          +

          +
          +
          +
          +
          Parameters:
          suite - the suite. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +setOutput

          +
          +void setOutput(java.io.OutputStream out)
          +
          +
          Sets the stream the formatter is supposed to write its results to. +

          +

          +
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +void setSystemOutput(java.lang.String out)
          +
          +
          This is what the test has written to System.out +

          +

          +
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +void setSystemError(java.lang.String err)
          +
          +
          This is what the test has written to System.err +

          +

          +
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.ForkMode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.ForkMode.html new file mode 100644 index 000000000..c20a329f3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.ForkMode.html @@ -0,0 +1,383 @@ + + + + + + +JUnitTask.ForkMode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask.ForkMode

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.ForkMode
+
          +
          +
          Enclosing class:
          JUnitTask
          +
          +
          +
          +
          public static final class JUnitTask.ForkMode
          extends EnumeratedAttribute
          + + +

          +These are the different forking options +

          + +

          +

          +
          Since:
          +
          1.6.2
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringONCE + +
          +          fork once only
          +static java.lang.StringPER_BATCH + +
          +          fork once per batch of tests
          +static java.lang.StringPER_TEST + +
          +          fork once per test class
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          JUnitTask.ForkMode() + +
          +          No arg constructor.
          JUnitTask.ForkMode(java.lang.String value) + +
          +          Constructor using a value.
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ONCE

          +
          +public static final java.lang.String ONCE
          +
          +
          fork once only +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PER_TEST

          +
          +public static final java.lang.String PER_TEST
          +
          +
          fork once per test class +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PER_BATCH

          +
          +public static final java.lang.String PER_BATCH
          +
          +
          fork once per batch of tests +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask.ForkMode

          +
          +public JUnitTask.ForkMode()
          +
          +
          No arg constructor. +

          +

          +
          + +

          +JUnitTask.ForkMode

          +
          +public JUnitTask.ForkMode(java.lang.String value)
          +
          +
          Constructor using a value. +

          +

          +
          Parameters:
          value - the value to use - once, perTest or perBatch.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement.. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogOutputStream.html new file mode 100644 index 000000000..8bb72eb23 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogOutputStream.html @@ -0,0 +1,306 @@ + + + + + + +JUnitTask.JUnitLogOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask.JUnitLogOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.util.LineOrientedOutputStream
+          extended by org.apache.tools.ant.taskdefs.LogOutputStream
+              extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.JUnitLogOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          Enclosing class:
          JUnitTask
          +
          +
          +
          +
          protected static class JUnitTask.JUnitLogOutputStream
          extends LogOutputStream
          + + +

          +A stream handler for handling the junit task. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JUnitTask.JUnitLogOutputStream(Task task, + int level) + +
          +          Constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  voidprocessLine(java.lang.String line, + int level) + +
          +          Logs a line.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.LogOutputStream
          getMessageLevel, processBuffer, processLine
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.LineOrientedOutputStream
          close, flush, write, write
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask.JUnitLogOutputStream

          +
          +public JUnitTask.JUnitLogOutputStream(Task task,
+                                      int level)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          task - the task being logged.
          level - the log level used to log data written to this stream.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +processLine

          +
          +protected void processLine(java.lang.String line,
+                           int level)
          +
          +
          Logs a line. + If the line starts with junit.framework.TestListener: set the level + to MSG_VERBOSE. +

          +

          +
          Overrides:
          processLine in class LogOutputStream
          +
          +
          +
          Parameters:
          line - the line to log.
          level - the logging level to use.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogStreamHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogStreamHandler.html new file mode 100644 index 000000000..44e5e187f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.JUnitLogStreamHandler.html @@ -0,0 +1,270 @@ + + + + + + +JUnitTask.JUnitLogStreamHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask.JUnitLogStreamHandler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.PumpStreamHandler
+      extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.JUnitLogStreamHandler
+
          +
          +
          All Implemented Interfaces:
          ExecuteStreamHandler
          +
          +
          +
          Enclosing class:
          JUnitTask
          +
          +
          +
          +
          protected static class JUnitTask.JUnitLogStreamHandler
          extends PumpStreamHandler
          + + +

          +A log stream handler for junit. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.PumpStreamHandler
          PumpStreamHandler.ThreadWithPumper
          +  + + + + + + + + + + + +
          +Constructor Summary
          JUnitTask.JUnitLogStreamHandler(Task task, + int outlevel, + int errlevel) + +
          +          Constructor.
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.PumpStreamHandler
          createProcessErrorPump, createProcessOutputPump, createPump, createPump, createPump, finish, getErr, getOut, setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start, stop
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask.JUnitLogStreamHandler

          +
          +public JUnitTask.JUnitLogStreamHandler(Task task,
+                                       int outlevel,
+                                       int errlevel)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          task - the task to log.
          outlevel - the level to use for standard output.
          errlevel - the level to use for error output.
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.SummaryAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.SummaryAttribute.html new file mode 100644 index 000000000..45d0166a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.SummaryAttribute.html @@ -0,0 +1,310 @@ + + + + + + +JUnitTask.SummaryAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask.SummaryAttribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.SummaryAttribute
+
          +
          +
          Enclosing class:
          JUnitTask
          +
          +
          +
          +
          public static class JUnitTask.SummaryAttribute
          extends EnumeratedAttribute
          + + +

          +Print summary enumeration values. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          JUnitTask.SummaryAttribute() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanasBoolean() + +
          +          gives the boolean equivalent of the authorized values
          + java.lang.String[]getValues() + +
          +          list the possible values
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask.SummaryAttribute

          +
          +public JUnitTask.SummaryAttribute()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          list the possible values +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          array of allowed values
          +
          +
          +
          + +

          +asBoolean

          +
          +public boolean asBoolean()
          +
          +
          gives the boolean equivalent of the authorized values +

          +

          + +
          Returns:
          boolean equivalent of the value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.TestResultHolder.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.TestResultHolder.html new file mode 100644 index 000000000..718fbadeb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.TestResultHolder.html @@ -0,0 +1,306 @@ + + + + + + +JUnitTask.TestResultHolder (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask.TestResultHolder

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask.TestResultHolder
+
          +
          +
          Enclosing class:
          JUnitTask
          +
          +
          +
          +
          protected static class JUnitTask.TestResultHolder
          extends java.lang.Object
          + + +

          +A value class that contains the result of a test. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          + booleancrashed + +
          +          true if the test crashed
          + intexitCode + +
          +          the exit code of the test.
          + booleantimedOut + +
          +          true if the test timed out
          +  + + + + + + + + + + + +
          +Constructor Summary
          +protected JUnitTask.TestResultHolder() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +exitCode

          +
          +public int exitCode
          +
          +
          the exit code of the test. +

          +

          +
          +
          +
          + +

          +timedOut

          +
          +public boolean timedOut
          +
          +
          true if the test timed out +

          +

          +
          +
          +
          + +

          +crashed

          +
          +public boolean crashed
          +
          +
          true if the test crashed +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask.TestResultHolder

          +
          +protected JUnitTask.TestResultHolder()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.html new file mode 100644 index 000000000..7474338b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTask.html @@ -0,0 +1,1914 @@ + + + + + + +JUnitTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JUnitTask
          extends Task
          + + +

          +Runs JUnit tests. + +

          JUnit is a framework to create unit tests. It has been initially + created by Erich Gamma and Kent Beck. JUnit can be found at http://www.junit.org. + +

          JUnitTask can run a single specific + JUnitTest using the test element.

          + For example, the following target 
          +   <target name="test-int-chars" depends="jar-test">
+       <echo message="testing international characters"/>
+       <junit printsummary="no" haltonfailure="yes" fork="false">
+           <classpath refid="classpath"/>
+           <formatter type="plain" usefile="false" />
+           <test name="org.apache.ecs.InternationalCharTest" />
+       </junit>
+   </target>
+
          +

          runs a single junit test + (org.apache.ecs.InternationalCharTest) in the current + VM using the path with id classpath as classpath and + presents the results formatted using the standard + plain formatter on the command line.

          + +

          This task can also run batches of tests. The + batchtest element creates a BatchTest + based on a fileset. This allows, for example, all classes found in + directory to be run as testcases.

          + +

          For example,

          + <target name="run-tests" depends="dump-info,compile-tests" if="junit.present">
+   <junit printsummary="no" haltonfailure="yes" fork="${junit.fork}">
+     <jvmarg value="-classic"/>
+     <classpath refid="tests-classpath"/>
+     <sysproperty key="build.tests" value="${build.tests}"/>
+     <formatter type="brief" usefile="false" />
+     <batchtest>
+       <fileset dir="${tests.dir}">
+         <include name="**/*Test*" />
+       </fileset>
+     </batchtest>
+   </junit>
+ </target>
+
          +

          this target finds any classes with a test directory + anywhere in their path (under the top ${tests.dir}, of + course) and creates JUnitTest's for each one.

          + +

          Of course, <junit> and + <batch> elements can be combined for more + complex tests. For an example, see the ant build.xml + target run-tests (the second example is an edited + version).

          + +

          To spawn a new Java VM to prevent interferences between + different testcases, you need to enable fork. A + number of attributes and elements allow you to set up how this JVM + runs. +

          + +

          +

          +
          Since:
          +
          Ant 1.2
          +
          See Also:
          JUnitTest, +BatchTest
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classJUnitTask.ForkMode + +
          +          These are the different forking options
          +protected static classJUnitTask.JUnitLogOutputStream + +
          +          A stream handler for handling the junit task.
          +protected static classJUnitTask.JUnitLogStreamHandler + +
          +          A log stream handler for junit.
          +static classJUnitTask.SummaryAttribute + +
          +          Print summary enumeration values.
          +protected static classJUnitTask.TestResultHolder + +
          +          A value class that contains the result of a test.
          +  + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringENABLE_TESTLISTENER_EVENTS + +
          +          Name of magic property that enables test listener events.
          +static java.lang.StringTESTLISTENER_PREFIX + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JUnitTask() + +
          +          Creates a new JUnitRunner and enables fork of a new Java VM.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidactOnTestResult(int exitValue, + boolean wasKilled, + JUnitTest test, + java.lang.String name) + +
          +          Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property.
          +protected  voidactOnTestResult(JUnitTask.TestResultHolder result, + JUnitTest test, + java.lang.String name) + +
          +          Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property.
          + voidaddAssertions(Assertions asserts) + +
          +          Assertions to enable in this program (if fork=true)
          +protected  voidaddClasspathEntry(java.lang.String resource) + +
          +          Search for the given resource and add the directory or archive + that contains it to the classpath.
          + voidaddConfiguredSysproperty(Environment.Variable sysp) + +
          +          Adds a system property that tests can access.
          + voidaddEnv(Environment.Variable var) + +
          +          Adds an environment variable; used when forking.
          + voidaddFormatter(FormatterElement fe) + +
          +          Add a new formatter to all tests of this task.
          + voidaddSysproperty(Environment.Variable sysp) + +
          +          Deprecated. since ant 1.6
          + voidaddSyspropertyset(PropertySet sysp) + +
          +          Adds a set of properties that will be used as system properties + that tests can access.
          + voidaddTest(JUnitTest test) + +
          +          Add a new single testcase.
          +protected  java.util.EnumerationallTests() + +
          +          return an enumeration listing each test, then each batchtest
          +protected  voidcleanup() + +
          +          Removes resources.
          + BatchTestcreateBatchTest() + +
          +          Adds a set of tests based on pattern matching.
          + PathcreateBootclasspath() + +
          +          Adds a path to the bootclasspath.
          + PathcreateClasspath() + +
          +          Adds path to classpath used for tests.
          + Commandline.ArgumentcreateJvmarg() + +
          +          Adds a JVM argument; ignored if not forking.
          + PermissionscreatePermissions() + +
          +          Sets the permissions for the application run inside the same JVM.
          +protected  ExecuteWatchdogcreateWatchdog() + +
          +           
          + voidexecute() + +
          +          Runs the testcase.
          +protected  voidexecute(JUnitTest arg) + +
          +          Run the tests.
          +protected  voidexecute(java.util.List testList) + +
          +          Execute a list of tests in a single forked Java VM.
          +protected  java.util.CollectionexecuteOrQueue(java.util.Enumeration testList, + boolean runIndividual) + +
          +          Executes all tests that don't need to be forked (or all tests + if the runIndividual argument is true.
          +protected  CommandlineJavagetCommandline() + +
          +          Get the command line used to run the tests.
          +protected  java.io.OutputStreamgetDefaultOutput() + +
          +          Get the default output for a formatter.
          + booleangetEnableTestListenerEvents() + +
          +          Whether test listener events shall be generated.
          +protected  java.util.EnumerationgetIndividualTests() + +
          +          Merge all individual tests from the batchtest with all individual tests + and return an enumeration over all JUnitTest.
          +protected  java.io.FilegetOutput(FormatterElement fe, + JUnitTest test) + +
          +          If the formatter sends output to a file, return that file.
          + voidhandleErrorFlush(java.lang.String output) + +
          +          Pass output sent to System.err to the TestRunner so it can + collect it for the formatters.
          + voidhandleErrorOutput(java.lang.String output) + +
          +          Pass output sent to System.err to the TestRunner so it can + collect it for the formatters.
          +protected  voidhandleFlush(java.lang.String output) + +
          +          Pass output sent to System.out to the TestRunner so it can + collect ot for the formatters.
          +protected  inthandleInput(byte[] buffer, + int offset, + int length) + +
          +          Handle an input request by this task.
          +protected  voidhandleOutput(java.lang.String output) + +
          +          Pass output sent to System.out to the TestRunner so it can + collect it for the formatters.
          + voidinit() + +
          +          Adds the jars or directories containing Ant, this task and + JUnit to the classpath - this should make the forked JVM work + without having to specify them directly.
          + voidsetCloneVm(boolean cloneVm) + +
          +          If set, system properties will be copied to the cloned VM - as + well as the bootclasspath unless you have explicitly specified + a bootclaspath.
          + voidsetDir(java.io.File dir) + +
          +          The directory to invoke the VM in.
          + voidsetEnableTestListenerEvents(boolean b) + +
          +          Whether test listener events shall be generated.
          + voidsetErrorProperty(java.lang.String propertyName) + +
          +          Property to set to "true" if there is a error in a test.
          + voidsetFailureProperty(java.lang.String propertyName) + +
          +          Property to set to "true" if there is a failure in a test.
          + voidsetFiltertrace(boolean value) + +
          +          If true, smartly filter the stack frames of + JUnit errors and failures before reporting them.
          + voidsetFork(boolean value) + +
          +          If true, JVM should be forked for each test.
          + voidsetForkMode(JUnitTask.ForkMode mode) + +
          +          Set the behavior when fork fork has been enabled.
          + voidsetHaltonerror(boolean value) + +
          +          If true, stop the build process when there is an error in a test.
          + voidsetHaltonfailure(boolean value) + +
          +          If true, stop the build process if a test fails + (errors are considered failures as well).
          + voidsetIncludeantruntime(boolean b) + +
          +          If true, include ant.jar, optional.jar and junit.jar in the forked VM.
          + voidsetJvm(java.lang.String value) + +
          +          The command used to invoke the Java Virtual Machine, + default is 'java'.
          + voidsetLogFailedTests(boolean logFailedTests) + +
          +          If true, write a single "FAILED" line for failed tests to Ant's + log system.
          + voidsetMaxmemory(java.lang.String max) + +
          +          Set the maximum memory to be used by all forked JVMs.
          + voidsetNewenvironment(boolean newenv) + +
          +          If true, use a new environment when forked.
          + voidsetOutputToFormatters(boolean outputToFormatters) + +
          +          If true, send any output generated by tests to the formatters.
          + voidsetPrintsummary(JUnitTask.SummaryAttribute value) + +
          +          If true, print one-line statistics for each test, or "withOutAndErr" + to also show standard output and error.
          + voidsetReloading(boolean value) + +
          +          If true, force ant to re-classload all classes for each JUnit TestCase
          + voidsetShowOutput(boolean showOutput) + +
          +          If true, send any output generated by tests to Ant's logging system + as well as to the formatters.
          + voidsetTempdir(java.io.File tmpDir) + +
          +          Where Ant should place temporary files.
          + voidsetTimeout(java.lang.Integer value) + +
          +          Set the timeout value (in milliseconds).
          +protected  voidsetupJUnitDelegate() + +
          +          Sets up the delegate that will actually run the tests.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +TESTLISTENER_PREFIX

          +
          +public static final java.lang.String TESTLISTENER_PREFIX
          +
          +
          +
          Since:
          +
          Ant 1.7
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENABLE_TESTLISTENER_EVENTS

          +
          +public static final java.lang.String ENABLE_TESTLISTENER_EVENTS
          +
          +
          Name of magic property that enables test listener events. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTask

          +
          +public JUnitTask()
+          throws java.lang.Exception
          +
          +
          Creates a new JUnitRunner and enables fork of a new Java VM. +

          +

          + +
          Throws: +
          java.lang.Exception - under ??? circumstances
          Since:
          +
          Ant 1.2
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setReloading

          +
          +public void setReloading(boolean value)
          +
          +
          If true, force ant to re-classload all classes for each JUnit TestCase +

          +

          +
          Parameters:
          value - force class reloading for each test case
          +
          +
          +
          + +

          +setFiltertrace

          +
          +public void setFiltertrace(boolean value)
          +
          +
          If true, smartly filter the stack frames of + JUnit errors and failures before reporting them. + +

          This property is applied on all BatchTest (batchtest) and + JUnitTest (test) however it can possibly be overridden by their + own properties.

          +

          +

          +
          Parameters:
          value - false if it should not filter, otherwise + true
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +setHaltonerror

          +
          +public void setHaltonerror(boolean value)
          +
          +
          If true, stop the build process when there is an error in a test. + This property is applied on all BatchTest (batchtest) and JUnitTest + (test) however it can possibly be overridden by their own + properties. +

          +

          +
          Parameters:
          value - true if it should halt, otherwise + false
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +setErrorProperty

          +
          +public void setErrorProperty(java.lang.String propertyName)
          +
          +
          Property to set to "true" if there is a error in a test. + +

          This property is applied on all BatchTest (batchtest) and + JUnitTest (test), however, it can possibly be overriden by + their own properties.

          +

          +

          +
          Parameters:
          propertyName - the name of the property to set in the + event of an error.
          Since:
          +
          Ant 1.4
          +
          +
          +
          +
          + +

          +setHaltonfailure

          +
          +public void setHaltonfailure(boolean value)
          +
          +
          If true, stop the build process if a test fails + (errors are considered failures as well). + This property is applied on all BatchTest (batchtest) and + JUnitTest (test) however it can possibly be overridden by their + own properties. +

          +

          +
          Parameters:
          value - true if it should halt, otherwise + false
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +setFailureProperty

          +
          +public void setFailureProperty(java.lang.String propertyName)
          +
          +
          Property to set to "true" if there is a failure in a test. + +

          This property is applied on all BatchTest (batchtest) and + JUnitTest (test), however, it can possibly be overriden by + their own properties.

          +

          +

          +
          Parameters:
          propertyName - the name of the property to set in the + event of an failure.
          Since:
          +
          Ant 1.4
          +
          +
          +
          +
          + +

          +setFork

          +
          +public void setFork(boolean value)
          +
          +
          If true, JVM should be forked for each test. + +

          It avoids interference between testcases and possibly avoids + hanging the build. this property is applied on all BatchTest + (batchtest) and JUnitTest (test) however it can possibly be + overridden by their own properties.

          +

          +

          +
          Parameters:
          value - true if a JVM should be forked, otherwise + false
          Since:
          +
          Ant 1.2
          +
          See Also:
          setTimeout(java.lang.Integer)
          +
          +
          +
          + +

          +setForkMode

          +
          +public void setForkMode(JUnitTask.ForkMode mode)
          +
          +
          Set the behavior when fork fork has been enabled. + +

          Possible values are "once", "perTest" and "perBatch". If + set to "once", only a single Java VM will be forked for all + tests, with "perTest" (the default) each test will run in a + fresh Java VM and "perBatch" will run all tests from the same + <batchtest> in the same Java VM.

          + +

          This attribute will be ignored if tests run in the same VM + as Ant.

          + +

          Only tests with the same configuration of haltonerror, + haltonfailure, errorproperty, failureproperty and filtertrace + can share a forked Java VM, so even if you set the value to + "once", Ant may need to fork mutliple VMs.

          +

          +

          +
          Parameters:
          mode - the mode to use.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setPrintsummary

          +
          +public void setPrintsummary(JUnitTask.SummaryAttribute value)
          +
          +
          If true, print one-line statistics for each test, or "withOutAndErr" + to also show standard output and error. + + Can take the values on, off, and withOutAndErr. +

          +

          +
          Parameters:
          value - true to print a summary, + withOutAndErr to include the test's output as + well, false otherwise.
          Since:
          +
          Ant 1.2
          +
          See Also:
          SummaryJUnitResultFormatter
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Integer value)
          +
          +
          Set the timeout value (in milliseconds). + +

          If the test is running for more than this value, the test + will be canceled. (works only when in 'fork' mode).

          +

          +

          +
          Parameters:
          value - the maximum time (in milliseconds) allowed before + declaring the test as 'timed-out'
          Since:
          +
          Ant 1.2
          +
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +setMaxmemory

          +
          +public void setMaxmemory(java.lang.String max)
          +
          +
          Set the maximum memory to be used by all forked JVMs. +

          +

          +
          Parameters:
          max - the value as defined by -mx or -Xmx + in the java command line options.
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +setJvm

          +
          +public void setJvm(java.lang.String value)
          +
          +
          The command used to invoke the Java Virtual Machine, + default is 'java'. The command is resolved by + java.lang.Runtime.exec(). Ignored if fork is disabled. +

          +

          +
          Parameters:
          value - the new VM to use instead of java
          Since:
          +
          Ant 1.2
          +
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +createJvmarg

          +
          +public Commandline.Argument createJvmarg()
          +
          +
          Adds a JVM argument; ignored if not forking. +

          +

          + +
          Returns:
          create a new JVM argument so that any argument can be + passed to the JVM.
          Since:
          +
          Ant 1.2
          +
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +setDir

          +
          +public void setDir(java.io.File dir)
          +
          +
          The directory to invoke the VM in. Ignored if no JVM is forked. +

          +

          +
          Parameters:
          dir - the directory to invoke the JVM from.
          Since:
          +
          Ant 1.2
          +
          See Also:
          setFork(boolean)
          +
          +
          +
          + +

          +addSysproperty

          +
          +public void addSysproperty(Environment.Variable sysp)
          +
          +
          Deprecated. since ant 1.6 +

          +

          Adds a system property that tests can access. + This might be useful to tranfer Ant properties to the + testcases when JVM forking is not enabled. +

          +

          +
          Parameters:
          sysp - environment variable to add
          Since:
          +
          Ant 1.3
          +
          +
          +
          +
          + +

          +addConfiguredSysproperty

          +
          +public void addConfiguredSysproperty(Environment.Variable sysp)
          +
          +
          Adds a system property that tests can access. + This might be useful to tranfer Ant properties to the + testcases when JVM forking is not enabled. +

          +

          +
          Parameters:
          sysp - new environment variable to add
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addSyspropertyset

          +
          +public void addSyspropertyset(PropertySet sysp)
          +
          +
          Adds a set of properties that will be used as system properties + that tests can access. + + This might be useful to tranfer Ant properties to the + testcases when JVM forking is not enabled. +

          +

          +
          Parameters:
          sysp - set of properties to be added
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Adds path to classpath used for tests. +

          +

          + +
          Returns:
          reference to the classpath in the embedded java command line
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +createBootclasspath

          +
          +public Path createBootclasspath()
          +
          +
          Adds a path to the bootclasspath. +

          +

          + +
          Returns:
          reference to the bootclasspath in the embedded java command line
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addEnv

          +
          +public void addEnv(Environment.Variable var)
          +
          +
          Adds an environment variable; used when forking. + +

          Will be ignored if we are not forking a new VM.

          +

          +

          +
          Parameters:
          var - environment variable to be added
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +setNewenvironment

          +
          +public void setNewenvironment(boolean newenv)
          +
          +
          If true, use a new environment when forked. + +

          Will be ignored if we are not forking a new VM.

          +

          +

          +
          Parameters:
          newenv - boolean indicating if setting a new environment is wished
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +addTest

          +
          +public void addTest(JUnitTest test)
          +
          +
          Add a new single testcase. +

          +

          +
          Parameters:
          test - a new single testcase
          Since:
          +
          Ant 1.2
          +
          See Also:
          JUnitTest
          +
          +
          +
          + +

          +createBatchTest

          +
          +public BatchTest createBatchTest()
          +
          +
          Adds a set of tests based on pattern matching. +

          +

          + +
          Returns:
          a new instance of a batch test.
          Since:
          +
          Ant 1.2
          +
          See Also:
          BatchTest
          +
          +
          +
          + +

          +addFormatter

          +
          +public void addFormatter(FormatterElement fe)
          +
          +
          Add a new formatter to all tests of this task. +

          +

          +
          Parameters:
          fe - formatter element
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +setIncludeantruntime

          +
          +public void setIncludeantruntime(boolean b)
          +
          +
          If true, include ant.jar, optional.jar and junit.jar in the forked VM. +

          +

          +
          Parameters:
          b - include ant run time yes or no
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +setShowOutput

          +
          +public void setShowOutput(boolean showOutput)
          +
          +
          If true, send any output generated by tests to Ant's logging system + as well as to the formatters. + By default only the formatters receive the output. + +

          Output will always be passed to the formatters and not by + shown by default. This option should for example be set for + tests that are interactive and prompt the user to do + something.

          +

          +

          +
          Parameters:
          showOutput - if true, send output to Ant's logging system too
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +setOutputToFormatters

          +
          +public void setOutputToFormatters(boolean outputToFormatters)
          +
          +
          If true, send any output generated by tests to the formatters. +

          +

          +
          Parameters:
          outputToFormatters - if true, send output to formatters (Default + is true).
          Since:
          +
          Ant 1.7.0
          +
          +
          +
          +
          + +

          +setLogFailedTests

          +
          +public void setLogFailedTests(boolean logFailedTests)
          +
          +
          If true, write a single "FAILED" line for failed tests to Ant's + log system. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +addAssertions

          +
          +public void addAssertions(Assertions asserts)
          +
          +
          Assertions to enable in this program (if fork=true) +

          +

          +
          Parameters:
          asserts - assertion set
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +createPermissions

          +
          +public Permissions createPermissions()
          +
          +
          Sets the permissions for the application run inside the same JVM. +

          +

          + +
          Returns:
          .
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +setCloneVm

          +
          +public void setCloneVm(boolean cloneVm)
          +
          +
          If set, system properties will be copied to the cloned VM - as + well as the bootclasspath unless you have explicitly specified + a bootclaspath. + +

          Doesn't have any effect unless fork is true.

          +

          +

          +
          Parameters:
          cloneVm - a boolean value.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setTempdir

          +
          +public void setTempdir(java.io.File tmpDir)
          +
          +
          Where Ant should place temporary files. +

          +

          +
          Parameters:
          tmpDir - location where temporary files should go to
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +setEnableTestListenerEvents

          +
          +public void setEnableTestListenerEvents(boolean b)
          +
          +
          Whether test listener events shall be generated. + +

          Defaults to false.

          + +

          This value will be overridden by the magic property + ant.junit.enabletestlistenerevents if it has been set.

          +

          +

          +
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +getEnableTestListenerEvents

          +
          +public boolean getEnableTestListenerEvents()
          +
          +
          Whether test listener events shall be generated. +

          +

          +
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +init

          +
          +public void init()
          +
          +
          Adds the jars or directories containing Ant, this task and + JUnit to the classpath - this should make the forked JVM work + without having to specify them directly. +

          +

          +
          Overrides:
          init in class Task
          +
          +
          +
          Since:
          +
          Ant 1.4
          +
          +
          +
          +
          + +

          +setupJUnitDelegate

          +
          +protected void setupJUnitDelegate()
          +
          +
          Sets up the delegate that will actually run the tests. + +

          Will be invoked implicitly once the delegate is needed.

          +

          +

          +
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Runs the testcase. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - in case of test failures or errors
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +execute

          +
          +protected void execute(JUnitTest arg)
+                throws BuildException
          +
          +
          Run the tests. +

          +

          +
          Parameters:
          arg - one JunitTest +
          Throws: +
          BuildException - in case of test failures or errors
          +
          +
          +
          + +

          +execute

          +
          +protected void execute(java.util.List testList)
+                throws BuildException
          +
          +
          Execute a list of tests in a single forked Java VM. +

          +

          +
          Parameters:
          testList - the list of tests to execute. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +handleOutput

          +
          +protected void handleOutput(java.lang.String output)
          +
          +
          Pass output sent to System.out to the TestRunner so it can + collect it for the formatters. +

          +

          +
          Overrides:
          handleOutput in class Task
          +
          +
          +
          Parameters:
          output - output coming from System.out
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +handleInput

          +
          +protected int handleInput(byte[] buffer,
+                          int offset,
+                          int length)
+                   throws java.io.IOException
          +
          +
          Handle an input request by this task. +

          +

          +
          Overrides:
          handleInput in class Task
          +
          +
          +
          Parameters:
          buffer - the buffer into which data is to be read.
          offset - the offset into the buffer at which data is stored.
          length - the amount of data to read. +
          Returns:
          the number of bytes read. +
          Throws: +
          java.io.IOException - if the data cannot be read.
          Since:
          +
          Ant 1.6
          +
          See Also:
          This implementation delegates to a runner if it + present.
          +
          +
          +
          + +

          +handleFlush

          +
          +protected void handleFlush(java.lang.String output)
          +
          +
          Pass output sent to System.out to the TestRunner so it can + collect ot for the formatters. +

          +

          +
          Overrides:
          handleFlush in class Task
          +
          +
          +
          Parameters:
          output - output coming from System.out
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +handleErrorOutput

          +
          +public void handleErrorOutput(java.lang.String output)
          +
          +
          Pass output sent to System.err to the TestRunner so it can + collect it for the formatters. +

          +

          +
          Overrides:
          handleErrorOutput in class Task
          +
          +
          +
          Parameters:
          output - output coming from System.err
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +handleErrorFlush

          +
          +public void handleErrorFlush(java.lang.String output)
          +
          +
          Pass output sent to System.err to the TestRunner so it can + collect it for the formatters. +

          +

          +
          Overrides:
          handleErrorFlush in class Task
          +
          +
          +
          Parameters:
          output - coming from System.err
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +createWatchdog

          +
          +protected ExecuteWatchdog createWatchdog()
+                                  throws BuildException
          +
          +
          + +
          Returns:
          null if there is a timeout value, otherwise the + watchdog instance. +
          Throws: +
          BuildException - under unspecified circumstances
          Since:
          +
          Ant 1.2
          +
          +
          +
          +
          + +

          +getDefaultOutput

          +
          +protected java.io.OutputStream getDefaultOutput()
          +
          +
          Get the default output for a formatter. +

          +

          + +
          Returns:
          default output stream for a formatter
          Since:
          +
          Ant 1.3
          +
          +
          +
          +
          + +

          +getIndividualTests

          +
          +protected java.util.Enumeration getIndividualTests()
          +
          +
          Merge all individual tests from the batchtest with all individual tests + and return an enumeration over all JUnitTest. +

          +

          + +
          Returns:
          enumeration over individual tests
          Since:
          +
          Ant 1.3
          +
          +
          +
          +
          + +

          +allTests

          +
          +protected java.util.Enumeration allTests()
          +
          +
          return an enumeration listing each test, then each batchtest +

          +

          + +
          Returns:
          enumeration
          Since:
          +
          Ant 1.3
          +
          +
          +
          +
          + +

          +getOutput

          +
          +protected java.io.File getOutput(FormatterElement fe,
+                                 JUnitTest test)
          +
          +
          If the formatter sends output to a file, return that file. + null otherwise. +

          +

          +
          Parameters:
          fe - formatter element
          test - one JUnit test +
          Returns:
          file reference
          Since:
          +
          Ant 1.3
          +
          +
          +
          +
          + +

          +addClasspathEntry

          +
          +protected void addClasspathEntry(java.lang.String resource)
          +
          +
          Search for the given resource and add the directory or archive + that contains it to the classpath. + +

          Doesn't work for archives in JDK 1.1 as the URL returned by + getResource doesn't contain the name of the archive.

          +

          +

          +
          Parameters:
          resource - resource that one wants to lookup
          Since:
          +
          Ant 1.4
          +
          +
          +
          +
          + +

          +cleanup

          +
          +protected void cleanup()
          +
          +
          Removes resources. + +

          Is invoked in execute. Subclasses that + don't invoke execute should invoke this method in a finally + block.

          +

          +

          +
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +getCommandline

          +
          +protected CommandlineJava getCommandline()
          +
          +
          Get the command line used to run the tests. +

          +

          + +
          Returns:
          the command line.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +executeOrQueue

          +
          +protected java.util.Collection executeOrQueue(java.util.Enumeration testList,
+                                              boolean runIndividual)
          +
          +
          Executes all tests that don't need to be forked (or all tests + if the runIndividual argument is true. Returns a collection of + lists of tests that share the same VM configuration and haven't + been executed yet. +

          +

          +
          Parameters:
          testList - the list of tests to be executed or queued.
          runIndividual - if true execute each test individually. +
          Returns:
          a list of tasks to be executed.
          Since:
          +
          1.6.2
          +
          +
          +
          +
          + +

          +actOnTestResult

          +
          +protected void actOnTestResult(int exitValue,
+                               boolean wasKilled,
+                               JUnitTest test,
+                               java.lang.String name)
          +
          +
          Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property. +

          +

          +
          Parameters:
          exitValue - the exitValue of the test.
          wasKilled - if true, the test had been killed.
          test - the test in question.
          name - the name of the test.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +actOnTestResult

          +
          +protected void actOnTestResult(JUnitTask.TestResultHolder result,
+                               JUnitTest test,
+                               java.lang.String name)
          +
          +
          Logs information about failed tests, potentially stops + processing (by throwing a BuildException) if a failure/error + occurred or sets a property. +

          +

          +
          Parameters:
          result - the result of the test.
          test - the test in question.
          name - the name of the test.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitResultFormatterMirror.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitResultFormatterMirror.html new file mode 100644 index 000000000..6e2d82f5e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitResultFormatterMirror.html @@ -0,0 +1,216 @@ + + + + + + +JUnitTaskMirror.JUnitResultFormatterMirror (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface JUnitTaskMirror.JUnitResultFormatterMirror

          +
          +
          All Known Subinterfaces:
          JUnitResultFormatter, JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          +
          +
          +
          All Known Implementing Classes:
          BriefJUnitResultFormatter, FailureRecorder, OutErrSummaryJUnitResultFormatter, PlainJUnitResultFormatter, SummaryJUnitResultFormatter, TearDownOnVmCrash, XMLJUnitResultFormatter
          +
          +
          +
          Enclosing interface:
          JUnitTaskMirror
          +
          +
          +
          +
          public static interface JUnitTaskMirror.JUnitResultFormatterMirror
          + + +

          +The interface that JUnitResultFormatter extends. +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidsetOutput(java.io.OutputStream outputStream) + +
          +          Set the output stream.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setOutput

          +
          +void setOutput(java.io.OutputStream outputStream)
          +
          +
          Set the output stream. +

          +

          +
          Parameters:
          outputStream - the stream to use.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitTestRunnerMirror.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitTestRunnerMirror.html new file mode 100644 index 000000000..d92808db4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.JUnitTestRunnerMirror.html @@ -0,0 +1,494 @@ + + + + + + +JUnitTaskMirror.JUnitTestRunnerMirror (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface JUnitTaskMirror.JUnitTestRunnerMirror

          +
          +
          All Known Implementing Classes:
          JUnitTestRunner
          +
          +
          +
          Enclosing interface:
          JUnitTaskMirror
          +
          +
          +
          +
          public static interface JUnitTaskMirror.JUnitTestRunnerMirror
          + + +

          +Interface that test runners implement. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intERRORS + +
          +          An error occurred.
          +static intFAILURES + +
          +          Some tests failed.
          +static java.lang.StringIGNORED_FILE_NAME + +
          +          Used in formatter arguments as a placeholder for the basename + of the output file (which gets replaced by a test specific + output file name later).
          +static intSUCCESS + +
          +          No problems with this test.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFormatter(JUnitTaskMirror.JUnitResultFormatterMirror formatter) + +
          +          Add a formatter to the test.
          + intgetRetCode() + +
          +          Returns what System.exit() would return in the standalone version.
          + voidhandleErrorFlush(java.lang.String output) + +
          +          Handle output sent to System.err.
          + voidhandleErrorOutput(java.lang.String output) + +
          +          Handle output sent to System.err.
          + voidhandleFlush(java.lang.String output) + +
          +          Handle output sent to System.out.
          + inthandleInput(byte[] buffer, + int offset, + int length) + +
          +          Handle an input request.
          + voidhandleOutput(java.lang.String output) + +
          +          Handle output sent to System.out.
          + voidrun() + +
          +          Run the test.
          + voidsetPermissions(Permissions perm) + +
          +          Permissions for the test run.
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IGNORED_FILE_NAME

          +
          +static final java.lang.String IGNORED_FILE_NAME
          +
          +
          Used in formatter arguments as a placeholder for the basename + of the output file (which gets replaced by a test specific + output file name later). +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SUCCESS

          +
          +static final int SUCCESS
          +
          +
          No problems with this test. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FAILURES

          +
          +static final int FAILURES
          +
          +
          Some tests failed. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERRORS

          +
          +static final int ERRORS
          +
          +
          An error occurred. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setPermissions

          +
          +void setPermissions(Permissions perm)
          +
          +
          Permissions for the test run. +

          +

          +
          Parameters:
          perm - the permissions to use.
          +
          +
          +
          + +

          +run

          +
          +void run()
          +
          +
          Run the test. +

          +

          +
          +
          +
          +
          + +

          +addFormatter

          +
          +void addFormatter(JUnitTaskMirror.JUnitResultFormatterMirror formatter)
          +
          +
          Add a formatter to the test. +

          +

          +
          Parameters:
          formatter - the formatter to use.
          +
          +
          +
          + +

          +getRetCode

          +
          +int getRetCode()
          +
          +
          Returns what System.exit() would return in the standalone version. +

          +

          + +
          Returns:
          2 if errors occurred, 1 if tests failed else 0.
          +
          +
          +
          + +

          +handleErrorFlush

          +
          +void handleErrorFlush(java.lang.String output)
          +
          +
          Handle output sent to System.err. +

          +

          +
          Parameters:
          output - coming from System.err
          +
          +
          +
          + +

          +handleErrorOutput

          +
          +void handleErrorOutput(java.lang.String output)
          +
          +
          Handle output sent to System.err. +

          +

          +
          Parameters:
          output - output for System.err
          +
          +
          +
          + +

          +handleOutput

          +
          +void handleOutput(java.lang.String output)
          +
          +
          Handle output sent to System.out. +

          +

          +
          Parameters:
          output - output for System.out.
          +
          +
          +
          + +

          +handleInput

          +
          +int handleInput(byte[] buffer,
+                int offset,
+                int length)
+                throws java.io.IOException
          +
          +
          Handle an input request. +

          +

          +
          Parameters:
          buffer - the buffer into which data is to be read.
          offset - the offset into the buffer at which data is stored.
          length - the amount of data to read. +
          Returns:
          the number of bytes read. +
          Throws: +
          java.io.IOException - if the data cannot be read.
          +
          +
          +
          + +

          +handleFlush

          +
          +void handleFlush(java.lang.String output)
          +
          +
          Handle output sent to System.out. +

          +

          +
          Parameters:
          output - output for System.out.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.SummaryJUnitResultFormatterMirror.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.SummaryJUnitResultFormatterMirror.html new file mode 100644 index 000000000..302f74560 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.SummaryJUnitResultFormatterMirror.html @@ -0,0 +1,228 @@ + + + + + + +JUnitTaskMirror.SummaryJUnitResultFormatterMirror (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface JUnitTaskMirror.SummaryJUnitResultFormatterMirror

          +
          +
          All Superinterfaces:
          JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          All Known Implementing Classes:
          OutErrSummaryJUnitResultFormatter, SummaryJUnitResultFormatter
          +
          +
          +
          Enclosing interface:
          JUnitTaskMirror
          +
          +
          +
          +
          public static interface JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          extends JUnitTaskMirror.JUnitResultFormatterMirror
          + + +

          +The interface that SummaryJUnitResultFormatter extends. +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidsetWithOutAndErr(boolean value) + +
          +          Set where standard out and standard error should be included.
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitResultFormatterMirror
          setOutput
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setWithOutAndErr

          +
          +void setWithOutAndErr(boolean value)
          +
          +
          Set where standard out and standard error should be included. +

          +

          +
          +
          +
          +
          Parameters:
          value - if true include the outputs in the summary.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.html new file mode 100644 index 000000000..bda1c297a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirror.html @@ -0,0 +1,324 @@ + + + + + + +JUnitTaskMirror (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface JUnitTaskMirror

          +
          +
          All Known Implementing Classes:
          JUnitTaskMirrorImpl
          +
          +
          +
          +
          public interface JUnitTaskMirror
          + + +

          +Handles the portions of JUnitTask which need to directly access + actual JUnit classes, so that junit.jar need not be on Ant's startup classpath. + Neither JUnitTask.java nor JUnitTaskMirror.java nor their transitive static + deps may import any junit.** classes! + Specifically, need to not refer to + - JUnitResultFormatter or its subclasses + - JUnitVersionHelper + - JUnitTestRunner + Cf. JUnitTask.SplitLoader#isSplit(String) + Public only to permit access from classes in this package; do not use directly. +

          + +

          +

          +
          Since:
          +
          1.7
          +
          See Also:
          "bug #38799"
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static interfaceJUnitTaskMirror.JUnitResultFormatterMirror + +
          +          The interface that JUnitResultFormatter extends.
          +static interfaceJUnitTaskMirror.JUnitTestRunnerMirror + +
          +          Interface that test runners implement.
          +static interfaceJUnitTaskMirror.SummaryJUnitResultFormatterMirror + +
          +          The interface that SummaryJUnitResultFormatter extends.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddVmExit(JUnitTest test, + JUnitTaskMirror.JUnitResultFormatterMirror formatter, + java.io.OutputStream out, + java.lang.String message, + java.lang.String testCase) + +
          +          Add the formatter to be called when the jvm exits before + the test suite finishs.
          + JUnitTaskMirror.JUnitTestRunnerMirrornewJUnitTestRunner(JUnitTest test, + java.lang.String[] methods, + boolean haltOnError, + boolean filterTrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents, + AntClassLoader classLoader) + +
          +          Create a new test runner for a test.
          + JUnitTaskMirror.SummaryJUnitResultFormatterMirrornewSummaryJUnitResultFormatter() + +
          +          Create a summary result formatter.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +addVmExit

          +
          +void addVmExit(JUnitTest test,
+               JUnitTaskMirror.JUnitResultFormatterMirror formatter,
+               java.io.OutputStream out,
+               java.lang.String message,
+               java.lang.String testCase)
          +
          +
          Add the formatter to be called when the jvm exits before + the test suite finishs. +

          +

          +
          Parameters:
          test - the test.
          formatter - the fomatter to use.
          out - the output stream to use.
          message - the message to write out.
          testCase - the name of the test.
          +
          +
          +
          + +

          +newJUnitTestRunner

          +
          +JUnitTaskMirror.JUnitTestRunnerMirror newJUnitTestRunner(JUnitTest test,
+                                                         java.lang.String[] methods,
+                                                         boolean haltOnError,
+                                                         boolean filterTrace,
+                                                         boolean haltOnFailure,
+                                                         boolean showOutput,
+                                                         boolean logTestListenerEvents,
+                                                         AntClassLoader classLoader)
          +
          +
          Create a new test runner for a test. +

          +

          +
          Parameters:
          test - the test to run.
          methods - names of the test methods to be run.
          haltOnError - if true halt the tests if an error occurs.
          filterTrace - if true filter the stack traces.
          haltOnFailure - if true halt the test if a failure occurs.
          showOutput - if true show output.
          logTestListenerEvents - if true log test listener events.
          classLoader - the classloader to use to create the runner. +
          Returns:
          the test runner.
          +
          +
          +
          + +

          +newSummaryJUnitResultFormatter

          +
          +JUnitTaskMirror.SummaryJUnitResultFormatterMirror newSummaryJUnitResultFormatter()
          +
          +
          Create a summary result formatter. +

          +

          + +
          Returns:
          the created formatter.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirrorImpl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirrorImpl.html new file mode 100644 index 000000000..700a6b6a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTaskMirrorImpl.html @@ -0,0 +1,362 @@ + + + + + + +JUnitTaskMirrorImpl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTaskMirrorImpl

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirrorImpl
+
          +
          +
          All Implemented Interfaces:
          JUnitTaskMirror
          +
          +
          +
          +
          public final class JUnitTaskMirrorImpl
          extends java.lang.Object
          implements JUnitTaskMirror
          + + +

          +Implementation of the part of the junit task which can directly refer to junit.* classes. + Public only to permit use of reflection; do not use directly. +

          + +

          +

          +
          Since:
          +
          1.7
          +
          See Also:
          JUnitTaskMirror, +"bug #38799"
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror
          JUnitTaskMirror.JUnitResultFormatterMirror, JUnitTaskMirror.JUnitTestRunnerMirror, JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          +  + + + + + + + + + + + +
          +Constructor Summary
          JUnitTaskMirrorImpl(JUnitTask task) + +
          +          Constructor.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddVmExit(JUnitTest test, + JUnitTaskMirror.JUnitResultFormatterMirror aFormatter, + java.io.OutputStream out, + java.lang.String message, + java.lang.String testCase) + +
          +          Add the formatter to be called when the jvm exits before + the test suite finishs..
          + JUnitTaskMirror.JUnitTestRunnerMirrornewJUnitTestRunner(JUnitTest test, + java.lang.String[] methods, + boolean haltOnError, + boolean filterTrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents, + AntClassLoader classLoader) + +
          +          Create a new test runner for a test..
          + JUnitTaskMirror.SummaryJUnitResultFormatterMirrornewSummaryJUnitResultFormatter() + +
          +          Create a summary result formatter..
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTaskMirrorImpl

          +
          +public JUnitTaskMirrorImpl(JUnitTask task)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          task - the junittask that uses this mirror.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addVmExit

          +
          +public void addVmExit(JUnitTest test,
+                      JUnitTaskMirror.JUnitResultFormatterMirror aFormatter,
+                      java.io.OutputStream out,
+                      java.lang.String message,
+                      java.lang.String testCase)
          +
          +
          Add the formatter to be called when the jvm exits before + the test suite finishs.. +

          +

          +
          Specified by:
          addVmExit in interface JUnitTaskMirror
          +
          +
          +
          Parameters:
          test - the test.
          aFormatter - the fomatter to use.
          out - the output stream to use.
          message - the message to write out.
          testCase - the name of the test.
          +
          +
          +
          + +

          +newJUnitTestRunner

          +
          +public JUnitTaskMirror.JUnitTestRunnerMirror newJUnitTestRunner(JUnitTest test,
+                                                                java.lang.String[] methods,
+                                                                boolean haltOnError,
+                                                                boolean filterTrace,
+                                                                boolean haltOnFailure,
+                                                                boolean showOutput,
+                                                                boolean logTestListenerEvents,
+                                                                AntClassLoader classLoader)
          +
          +
          Create a new test runner for a test.. +

          +

          +
          Specified by:
          newJUnitTestRunner in interface JUnitTaskMirror
          +
          +
          +
          Parameters:
          test - the test to run.
          methods - names of the test methods to be run.
          haltOnError - if true halt the tests if an error occurs.
          filterTrace - if true filter the stack traces.
          haltOnFailure - if true halt the test if a failure occurs.
          showOutput - if true show output.
          logTestListenerEvents - if true log test listener events.
          classLoader - the classloader to use to create the runner. +
          Returns:
          the test runner.
          +
          +
          +
          + +

          +newSummaryJUnitResultFormatter

          +
          +public JUnitTaskMirror.SummaryJUnitResultFormatterMirror newSummaryJUnitResultFormatter()
          +
          +
          Create a summary result formatter.. +

          +

          +
          Specified by:
          newSummaryJUnitResultFormatter in interface JUnitTaskMirror
          +
          +
          + +
          Returns:
          the created formatter.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.html new file mode 100644 index 000000000..319496ec6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTest.html @@ -0,0 +1,782 @@ + + + + + + +JUnitTest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTest

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.BaseTest
+      extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTest
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class JUnitTest
          extends BaseTest
          implements java.lang.Cloneable
          + + +

          +

          Run a single JUnit test. + +

          The JUnit test is actually run by JUnitTestRunner. + So read the doc comments for that class :) +

          + +

          +

          +
          Since:
          +
          Ant 1.2
          +
          See Also:
          JUnitTask, +JUnitTestRunner
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.junit.BaseTest
          destDir, errorProperty, failureProperty, filtertrace, fork, formatters, haltOnError, haltOnFail, ifProperty, unlessProperty
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          JUnitTest() + +
          +          No arg constructor.
          JUnitTest(java.lang.String name) + +
          +          Constructor with name.
          JUnitTest(java.lang.String name, + boolean haltOnError, + boolean haltOnFailure, + boolean filtertrace) + +
          +          Constructor with options.
          JUnitTest(java.lang.String name, + boolean haltOnError, + boolean haltOnFailure, + boolean filtertrace, + java.lang.String[] methods) + +
          +          Constructor with options.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +           
          + longerrorCount() + +
          +          Get the number of errors.
          + longfailureCount() + +
          +          Get the number of failures.
          + FormatterElement[]getFormatters() + +
          +          Get the formatters set for this test.
          + java.lang.StringgetName() + +
          +          Get the name of the test class.
          + java.lang.StringgetOutfile() + +
          +          Get the name of the output file
          + java.util.PropertiesgetProperties() + +
          +          Get the properties used in the test.
          + longgetRunTime() + +
          +          Get the run time.
          +static java.lang.String[]parseTestMethodNamesList(java.lang.String methodNames) + +
          +          Parses a comma-separated list of method names and check their validity.
          + longrunCount() + +
          +          Get the number of runs.
          + voidsetCounts(long runs, + long failures, + long errors) + +
          +          Set the number of runs, failures and errors.
          + voidsetMethods(java.lang.String value) + +
          +          Sets names of individual test methods to be executed.
          + voidsetName(java.lang.String value) + +
          +          Set the name of the test class.
          + voidsetOutfile(java.lang.String value) + +
          +          Set the name of the output file.
          + voidsetProperties(java.util.Hashtable p) + +
          +          Set the properties to be used in the test.
          + voidsetRunTime(long runTime) + +
          +          Set the runtime.
          + booleanshouldRun(Project p) + +
          +          Check if this test should run based on the if and unless + attributes.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.junit.BaseTest
          addFormatter, getErrorProperty, getFailureProperty, getFiltertrace, getFork, getHaltonerror, getHaltonfailure, getIfCondition, getTodir, getUnlessCondition, setErrorProperty, setFailureProperty, setFiltertrace, setFork, setHaltonerror, setHaltonfailure, setIf, setIf, setTodir, setUnless, setUnless
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTest

          +
          +public JUnitTest()
          +
          +
          No arg constructor. +

          +

          +
          + +

          +JUnitTest

          +
          +public JUnitTest(java.lang.String name)
          +
          +
          Constructor with name. +

          +

          +
          Parameters:
          name - the name of the test.
          +
          +
          + +

          +JUnitTest

          +
          +public JUnitTest(java.lang.String name,
+                 boolean haltOnError,
+                 boolean haltOnFailure,
+                 boolean filtertrace)
          +
          +
          Constructor with options. +

          +

          +
          Parameters:
          name - the name of the test.
          haltOnError - if true halt the tests if there is an error.
          haltOnFailure - if true halt the tests if there is a failure.
          filtertrace - if true filter stack traces.
          +
          +
          + +

          +JUnitTest

          +
          +public JUnitTest(java.lang.String name,
+                 boolean haltOnError,
+                 boolean haltOnFailure,
+                 boolean filtertrace,
+                 java.lang.String[] methods)
          +
          +
          Constructor with options. +

          +

          +
          Parameters:
          name - the name of the test.
          haltOnError - if true halt the tests if there is an error.
          haltOnFailure - if true halt the tests if there is a failure.
          filtertrace - if true filter stack traces.
          methods - if non-null run only these test methods
          Since:
          +
          1.8.2
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setMethods

          +
          +public void setMethods(java.lang.String value)
          +
          +
          Sets names of individual test methods to be executed. +

          +

          +
          +
          +
          +
          Parameters:
          value - comma-separated list of names of individual test methods + to be executed, + or null if all test methods should be executed
          Since:
          +
          1.8.2
          +
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String value)
          +
          +
          Set the name of the test class. +

          +

          +
          +
          +
          +
          Parameters:
          value - the name to use.
          +
          +
          +
          + +

          +setOutfile

          +
          +public void setOutfile(java.lang.String value)
          +
          +
          Set the name of the output file. +

          +

          +
          +
          +
          +
          Parameters:
          value - the name of the output file to use.
          +
          +
          +
          + +

          +parseTestMethodNamesList

          +
          +public static java.lang.String[] parseTestMethodNamesList(java.lang.String methodNames)
+                                                   throws java.lang.IllegalArgumentException
          +
          +
          Parses a comma-separated list of method names and check their validity. +

          +

          +
          +
          +
          +
          Parameters:
          methodNames - comma-separated list of method names to be parsed +
          Returns:
          array of individual test method names +
          Throws: +
          java.lang.IllegalArgumentException - if the given string is null or if it is not + a comma-separated list of valid Java identifiers; + an empty string is acceptable and is handled as an empty + list
          Since:
          +
          1.8.2
          +
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of the test class. +

          +

          +
          +
          +
          + +
          Returns:
          the name of the test.
          +
          +
          +
          + +

          +getOutfile

          +
          +public java.lang.String getOutfile()
          +
          +
          Get the name of the output file +

          +

          +
          +
          +
          + +
          Returns:
          the name of the output file.
          +
          +
          +
          + +

          +setCounts

          +
          +public void setCounts(long runs,
+                      long failures,
+                      long errors)
          +
          +
          Set the number of runs, failures and errors. +

          +

          +
          +
          +
          +
          Parameters:
          runs - the number of runs.
          failures - the number of failures.
          errors - the number of errors.
          +
          +
          +
          + +

          +setRunTime

          +
          +public void setRunTime(long runTime)
          +
          +
          Set the runtime. +

          +

          +
          +
          +
          +
          Parameters:
          runTime - the time in milliseconds.
          +
          +
          +
          + +

          +runCount

          +
          +public long runCount()
          +
          +
          Get the number of runs. +

          +

          +
          +
          +
          + +
          Returns:
          the number of runs.
          +
          +
          +
          + +

          +failureCount

          +
          +public long failureCount()
          +
          +
          Get the number of failures. +

          +

          +
          +
          +
          + +
          Returns:
          the number of failures.
          +
          +
          +
          + +

          +errorCount

          +
          +public long errorCount()
          +
          +
          Get the number of errors. +

          +

          +
          +
          +
          + +
          Returns:
          the number of errors.
          +
          +
          +
          + +

          +getRunTime

          +
          +public long getRunTime()
          +
          +
          Get the run time. +

          +

          +
          +
          +
          + +
          Returns:
          the run time in milliseconds.
          +
          +
          +
          + +

          +getProperties

          +
          +public java.util.Properties getProperties()
          +
          +
          Get the properties used in the test. +

          +

          +
          +
          +
          + +
          Returns:
          the properties.
          +
          +
          +
          + +

          +setProperties

          +
          +public void setProperties(java.util.Hashtable p)
          +
          +
          Set the properties to be used in the test. +

          +

          +
          +
          +
          +
          Parameters:
          p - the properties. + This is a copy of the projects ant properties.
          +
          +
          +
          + +

          +shouldRun

          +
          +public boolean shouldRun(Project p)
          +
          +
          Check if this test should run based on the if and unless + attributes. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use to check if the if and unless + properties exist in. +
          Returns:
          true if this test or testsuite should be run.
          +
          +
          +
          + +

          +getFormatters

          +
          +public FormatterElement[] getFormatters()
          +
          +
          Get the formatters set for this test. +

          +

          +
          +
          +
          + +
          Returns:
          the formatters as an array.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          + +
          Returns:
          a clone of this test.
          Since:
          +
          Ant 1.5
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.html new file mode 100644 index 000000000..269c51a09 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitTestRunner.html @@ -0,0 +1,990 @@ + + + + + + +JUnitTestRunner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitTestRunner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitTestRunner
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          +
          public class JUnitTestRunner
          extends java.lang.Object
          implements junit.framework.TestListener, JUnitTaskMirror.JUnitTestRunnerMirror
          + + +

          +Simple Testrunner for JUnit that runs all tests of a testsuite. + +

          This TestRunner expects a name of a TestCase class as its + argument. If this class provides a static suite() method it will be + called and the resulting Test will be run. So, the signature should be + 

          
+     public static junit.framework.Test suite()
+
          + +

          If no such method exists, all public methods starting with + "test" and taking no argument will be run. + +

          Summary output is generated at the end. +

          + +

          +

          +
          Since:
          +
          Ant 1.2
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.junit.JUnitTaskMirror.JUnitTestRunnerMirror
          ERRORS, FAILURES, IGNORED_FILE_NAME, SUCCESS
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure) + +
          +          Constructor for fork=true or when the user hasn't specified a + classpath.
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput) + +
          +          Constructor for fork=true or when the user hasn't specified a + classpath.
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents) + +
          +          Constructor for fork=true or when the user hasn't specified a + classpath.
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents, + java.lang.ClassLoader loader) + +
          +          Constructor to use when the user has specified a classpath.
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput, + java.lang.ClassLoader loader) + +
          +          Constructor to use when the user has specified a classpath.
          JUnitTestRunner(JUnitTest test, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + java.lang.ClassLoader loader) + +
          +          Constructor to use when the user has specified a classpath.
          JUnitTestRunner(JUnitTest test, + java.lang.String[] methods, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents) + +
          +          Constructor for fork=true or when the user hasn't specified a + classpath.
          JUnitTestRunner(JUnitTest test, + java.lang.String[] methods, + boolean haltOnError, + boolean filtertrace, + boolean haltOnFailure, + boolean showOutput, + boolean logTestListenerEvents, + java.lang.ClassLoader loader) + +
          +          Constructor to use when the user has specified a classpath.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +          Interface TestListener for JUnit > 3.4.
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener for JUnit <= 3.4.
          + voidaddFormatter(JUnitResultFormatter f) + +
          +          Add a formatter.
          + voidaddFormatter(JUnitTaskMirror.JUnitResultFormatterMirror f) + +
          +          Add a formatter to the test..
          + voidendTest(junit.framework.Test test) + +
          +          Interface TestListener.
          +static java.lang.StringfilterStack(java.lang.String stack) + +
          +          Filters stack frames from internal JUnit and Ant classes
          +static java.lang.StringgetFilteredTrace(java.lang.Throwable t) + +
          +          Returns a filtered stack trace.
          + intgetRetCode() + +
          +          Returns what System.exit() would return in the standalone version.
          + voidhandleErrorFlush(java.lang.String output) + +
          +          Handle output sent to System.err..
          + voidhandleErrorOutput(java.lang.String output) + +
          +          Handle output sent to System.err..
          + voidhandleFlush(java.lang.String output) + +
          +          Handle output sent to System.out..
          + inthandleInput(byte[] buffer, + int offset, + int length) + +
          +          Handle input.
          + voidhandleOutput(java.lang.String output) + +
          +          Handle a string destined for standard output.
          +static voidmain(java.lang.String[] args) + +
          +          Entry point for standalone (forked) mode.
          + voidrun() + +
          +          Run the test.
          + voidsetPermissions(Permissions permissions) + +
          +          Permissions for the test run.
          + voidstartTest(junit.framework.Test t) + +
          +          Interface TestListener.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure)
          +
          +
          Constructor for fork=true or when the user hasn't specified a + classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput)
          +
          +
          Constructor for fork=true or when the user hasn't specified a + classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          showOutput - whether to send output to System.out/.err as well as formatters.
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput,
+                       boolean logTestListenerEvents)
          +
          +
          Constructor for fork=true or when the user hasn't specified a + classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          showOutput - whether to send output to System.out/.err as well as formatters.
          logTestListenerEvents - whether to print TestListener events.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       java.lang.String[] methods,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput,
+                       boolean logTestListenerEvents)
          +
          +
          Constructor for fork=true or when the user hasn't specified a + classpath. +

          +

          +
          Parameters:
          test - the test to run.
          methods - names of methods of the test to be executed.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          showOutput - whether to send output to System.out/.err as well as formatters.
          logTestListenerEvents - whether to print TestListener events.
          Since:
          +
          1.8.2
          +
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       java.lang.ClassLoader loader)
          +
          +
          Constructor to use when the user has specified a classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          loader - the classloader to use running the test.
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput,
+                       java.lang.ClassLoader loader)
          +
          +
          Constructor to use when the user has specified a classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          showOutput - whether to send output to System.out/.err as well as formatters.
          loader - the classloader to use running the test.
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput,
+                       boolean logTestListenerEvents,
+                       java.lang.ClassLoader loader)
          +
          +
          Constructor to use when the user has specified a classpath. +

          +

          +
          Parameters:
          test - the test to run.
          haltOnError - whether to stop the run if an error is found.
          filtertrace - whether to filter junit.*.* stack frames out of exceptions
          haltOnFailure - whether to stop the run if failure is found.
          showOutput - whether to send output to System.out/.err as well as formatters.
          logTestListenerEvents - whether to print TestListener events.
          loader - the classloader to use running the test.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +JUnitTestRunner

          +
          +public JUnitTestRunner(JUnitTest test,
+                       java.lang.String[] methods,
+                       boolean haltOnError,
+                       boolean filtertrace,
+                       boolean haltOnFailure,
+                       boolean showOutput,
+                       boolean logTestListenerEvents,
+                       java.lang.ClassLoader loader)
          +
          +
          Constructor to use when the user has specified a classpath. +

          +

          +
          Since:
          +
          1.8.2
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +run

          +
          +public void run()
          +
          +
          Run the test. +

          +

          +
          Specified by:
          run in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          +
          +
          +
          + +

          +getRetCode

          +
          +public int getRetCode()
          +
          +
          Returns what System.exit() would return in the standalone version. +

          +

          +
          Specified by:
          getRetCode in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          + +
          Returns:
          2 if errors occurred, 1 if tests failed else 0.
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test t)
          +
          +
          Interface TestListener. + +

          A new Test is started. +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          t - the test.
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          Interface TestListener. + +

          A Test is finished. +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          Interface TestListener for JUnit <= 3.4. + +

          A Test failed. +

          +

          +
          +
          +
          +
          Parameters:
          test - the test.
          t - the exception thrown by the test.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          Interface TestListener for JUnit > 3.4. + +

          A Test failed. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the assertion thrown by the test.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable t)
          +
          +
          Interface TestListener. + +

          An error occurred while running the test. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the error thrown by the test.
          +
          +
          +
          + +

          +setPermissions

          +
          +public void setPermissions(Permissions permissions)
          +
          +
          Permissions for the test run. +

          +

          +
          Specified by:
          setPermissions in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          permissions - the permissions to use.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +handleOutput

          +
          +public void handleOutput(java.lang.String output)
          +
          +
          Handle a string destined for standard output. +

          +

          +
          Specified by:
          handleOutput in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          output - the string to output
          +
          +
          +
          + +

          +handleInput

          +
          +public int handleInput(byte[] buffer,
+                       int offset,
+                       int length)
+                throws java.io.IOException
          +
          +
          Handle input. +

          +

          +
          Specified by:
          handleInput in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          buffer - not used.
          offset - not used.
          length - not used. +
          Returns:
          -1 always. +
          Throws: +
          java.io.IOException - never.
          Since:
          +
          Ant 1.6
          +
          See Also:
          Task.handleInput(byte[], int, int)
          +
          +
          +
          + +

          +handleErrorOutput

          +
          +public void handleErrorOutput(java.lang.String output)
          +
          +
          Handle output sent to System.err.. +

          +

          +
          Specified by:
          handleErrorOutput in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          output - output for System.err
          +
          +
          +
          + +

          +handleFlush

          +
          +public void handleFlush(java.lang.String output)
          +
          +
          Handle output sent to System.out.. +

          +

          +
          Specified by:
          handleFlush in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          output - output for System.out.
          +
          +
          +
          + +

          +handleErrorFlush

          +
          +public void handleErrorFlush(java.lang.String output)
          +
          +
          Handle output sent to System.err.. +

          +

          +
          Specified by:
          handleErrorFlush in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          output - coming from System.err
          +
          +
          +
          + +

          +addFormatter

          +
          +public void addFormatter(JUnitResultFormatter f)
          +
          +
          Add a formatter. +

          +

          +
          +
          +
          +
          Parameters:
          f - the formatter to add.
          +
          +
          +
          + +

          +addFormatter

          +
          +public void addFormatter(JUnitTaskMirror.JUnitResultFormatterMirror f)
          +
          +
          Add a formatter to the test.. +

          +

          +
          Specified by:
          addFormatter in interface JUnitTaskMirror.JUnitTestRunnerMirror
          +
          +
          +
          Parameters:
          f - the formatter to use.
          +
          +
          +
          + +

          +main

          +
          +public static void main(java.lang.String[] args)
+                 throws java.io.IOException
          +
          +
          Entry point for standalone (forked) mode. + + Parameters: testcaseclassname plus parameters in the format + key=value, none of which is required. + + + + + + + + + + + + + + + + +
          keydescriptiondefault value
          haltOnErrorhalt test on + errors?false
          haltOnFailurehalt test on + failures?false
          formatterA JUnitResultFormatter given as + classname,filename. If filename is ommitted, System.out is + assumed.none
          showoutputsend output to System.err/.out as + well as to the formatters?false
          logtestlistenereventslog TestListener events to + System.out.false
          methodsComma-separated list of names of individual + test methods to execute. + null
          +

          +

          +
          +
          +
          +
          Parameters:
          args - the command line arguments. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +getFilteredTrace

          +
          +public static java.lang.String getFilteredTrace(java.lang.Throwable t)
          +
          +
          Returns a filtered stack trace. + This is ripped out of junit.runner.BaseTestRunner. +

          +

          +
          +
          +
          +
          Parameters:
          t - the exception to filter. +
          Returns:
          the filtered stack trace.
          +
          +
          +
          + +

          +filterStack

          +
          +public static java.lang.String filterStack(java.lang.String stack)
          +
          +
          Filters stack frames from internal JUnit and Ant classes +

          +

          +
          +
          +
          +
          Parameters:
          stack - the stack trace to filter. +
          Returns:
          the filtered stack.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitVersionHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitVersionHelper.html new file mode 100644 index 000000000..e92a279ab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/JUnitVersionHelper.html @@ -0,0 +1,338 @@ + + + + + + +JUnitVersionHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class JUnitVersionHelper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.JUnitVersionHelper
+
          +
          +
          +
          public class JUnitVersionHelper
          extends java.lang.Object
          + + +

          +Work around for some changes to the public JUnit API between + different JUnit releases. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringJUNIT_FRAMEWORK_JUNIT4_TEST_CASE_FACADE + +
          +          Name of the JUnit4 class we look for.
          +  + + + + + + + + + + +
          +Constructor Summary
          JUnitVersionHelper() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.lang.StringgetTestCaseClassName(junit.framework.Test test) + +
          +          Tries to find the name of the class which a test represents + across JUnit 3 and 4.
          +static java.lang.StringgetTestCaseName(junit.framework.Test t) + +
          +          JUnit 3.7 introduces TestCase.getName() and subsequent versions + of JUnit remove the old name() method.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +JUNIT_FRAMEWORK_JUNIT4_TEST_CASE_FACADE

          +
          +public static final java.lang.String JUNIT_FRAMEWORK_JUNIT4_TEST_CASE_FACADE
          +
          +
          Name of the JUnit4 class we look for. + "junit.framework.JUnit4TestCaseFacade" +

          +

          +
          Since:
          +
          Ant 1.7.1
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JUnitVersionHelper

          +
          +public JUnitVersionHelper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getTestCaseName

          +
          +public static java.lang.String getTestCaseName(junit.framework.Test t)
          +
          +
          JUnit 3.7 introduces TestCase.getName() and subsequent versions + of JUnit remove the old name() method. This method provides + access to the name of a TestCase via reflection that is + supposed to work with version before and after JUnit 3.7. + +

          since Ant 1.5.1 this method will invoke "public + String getName()" on any implementation of Test if + it exists.

          + +

          Since Ant 1.7 also checks for JUnit4TestCaseFacade explicitly. + This is used by junit.framework.JUnit4TestAdapter.

          +

          +

          +
          Parameters:
          t - the test. +
          Returns:
          the name of the test.
          +
          +
          +
          + +

          +getTestCaseClassName

          +
          +public static java.lang.String getTestCaseClassName(junit.framework.Test test)
          +
          +
          Tries to find the name of the class which a test represents + across JUnit 3 and 4. For Junit4 it parses the toString() value of the + test, and extracts it from there. +

          +

          +
          Parameters:
          test - test case to look at +
          Returns:
          the extracted class name.
          Since:
          +
          Ant 1.7.1 (it was private until then)
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/OutErrSummaryJUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/OutErrSummaryJUnitResultFormatter.html new file mode 100644 index 000000000..bf2f2b37c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/OutErrSummaryJUnitResultFormatter.html @@ -0,0 +1,239 @@ + + + + + + +OutErrSummaryJUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class OutErrSummaryJUnitResultFormatter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter
+      extended by org.apache.tools.ant.taskdefs.optional.junit.OutErrSummaryJUnitResultFormatter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror, JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          +
          +
          +
          +
          public class OutErrSummaryJUnitResultFormatter
          extends SummaryJUnitResultFormatter
          + + +

          +Used instead of SummaryJUnitResultFormatter in forked tests if + withOutAndErr is requested. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          OutErrSummaryJUnitResultFormatter() + +
          +          Empty
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter
          addError, addFailure, addFailure, endTest, endTestSuite, setOutput, setSystemError, setSystemOutput, setWithOutAndErr, startTest, startTestSuite
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +OutErrSummaryJUnitResultFormatter

          +
          +public OutErrSummaryJUnitResultFormatter()
          +
          +
          Empty +

          +

          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.html new file mode 100644 index 000000000..0168c191f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/PlainJUnitResultFormatter.html @@ -0,0 +1,499 @@ + + + + + + +PlainJUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class PlainJUnitResultFormatter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.PlainJUnitResultFormatter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          +
          public class PlainJUnitResultFormatter
          extends java.lang.Object
          implements JUnitResultFormatter
          + + +

          +Prints plain text output of the test to a specified Writer. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          PlainJUnitResultFormatter() + +
          +          No arg constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +          Interface TestListener for JUnit > 3.4.
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener for JUnit <= 3.4.
          + voidendTest(junit.framework.Test test) + +
          +          Interface TestListener.
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to..
          + voidsetSystemError(java.lang.String err) + +
          +          This is what the test has written to System.err.
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out.
          + voidstartTest(junit.framework.Test t) + +
          +          Interface TestListener.
          + voidstartTestSuite(JUnitTest suite) + +
          +          The whole testsuite started.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PlainJUnitResultFormatter

          +
          +public PlainJUnitResultFormatter()
          +
          +
          No arg constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Sets the stream the formatter is supposed to write its results to.. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          This is what the test has written to System.out. +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String err)
          +
          +
          This is what the test has written to System.err. +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          +
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
+                    throws BuildException
          +
          +
          The whole testsuite started. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the test suite +
          Throws: +
          BuildException - if unable to write the output
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
+                  throws BuildException
          +
          +
          The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the test suite +
          Throws: +
          BuildException - if unable to write the output
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test t)
          +
          +
          Interface TestListener. + +

          A new Test is started. +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          t - the test.
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          Interface TestListener. + +

          A Test is finished. +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          Interface TestListener for JUnit <= 3.4. + +

          A Test failed. +

          +

          +
          +
          +
          +
          Parameters:
          test - the test.
          t - the exception.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          Interface TestListener for JUnit > 3.4. + +

          A Test failed. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the assertion that failed.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable t)
          +
          +
          Interface TestListener. + +

          An error occurred while running the test. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the exception.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.html new file mode 100644 index 000000000..76801d8c9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/SummaryJUnitResultFormatter.html @@ -0,0 +1,517 @@ + + + + + + +SummaryJUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class SummaryJUnitResultFormatter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.SummaryJUnitResultFormatter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror, JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          +
          +
          +
          Direct Known Subclasses:
          OutErrSummaryJUnitResultFormatter
          +
          +
          +
          +
          public class SummaryJUnitResultFormatter
          extends java.lang.Object
          implements JUnitResultFormatter, JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          + + +

          +Prints short summary output of the test to Ant's logging system. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SummaryJUnitResultFormatter() + +
          +          Empty
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Empty
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +          Interface TestListener for JUnit > 3.4.
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Empty
          + voidendTest(junit.framework.Test test) + +
          +          Empty
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to..
          + voidsetSystemError(java.lang.String err) + +
          +          This is what the test has written to System.err.
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out.
          + voidsetWithOutAndErr(boolean value) + +
          +          Should the output to System.out and System.err be written to + the summary.
          + voidstartTest(junit.framework.Test t) + +
          +          Empty
          + voidstartTestSuite(JUnitTest suite) + +
          +          The testsuite started.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SummaryJUnitResultFormatter

          +
          +public SummaryJUnitResultFormatter()
          +
          +
          Empty +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
          +
          +
          The testsuite started. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the testsuite.
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test t)
          +
          +
          Empty +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          t - not used.
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          Empty +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - not used.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          Empty +

          +

          +
          +
          +
          +
          Parameters:
          test - not used.
          t - not used.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          Interface TestListener for JUnit > 3.4. + +

          A Test failed. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - not used.
          t - not used.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable t)
          +
          +
          Empty +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - not used.
          t - not used.
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Sets the stream the formatter is supposed to write its results to.. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          This is what the test has written to System.out. +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String err)
          +
          +
          This is what the test has written to System.err. +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          +
          + +

          +setWithOutAndErr

          +
          +public void setWithOutAndErr(boolean value)
          +
          +
          Should the output to System.out and System.err be written to + the summary. +

          +

          +
          Specified by:
          setWithOutAndErr in interface JUnitTaskMirror.SummaryJUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          value - if true write System.out and System.err to the summary.
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
+                  throws BuildException
          +
          +
          The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the testsuite. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/TearDownOnVmCrash.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/TearDownOnVmCrash.html new file mode 100644 index 000000000..9abceef30 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/TearDownOnVmCrash.html @@ -0,0 +1,492 @@ + + + + + + +TearDownOnVmCrash (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class TearDownOnVmCrash

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.TearDownOnVmCrash
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          +
          public class TearDownOnVmCrash
          extends java.lang.Object
          implements JUnitResultFormatter
          + + +

          +Formatter that doesn't create any output but tries to invoke the + tearDown method on a testcase if that test was forked and caused a + timeout or VM crash. + +

          This formatter has some limitations, for details see the + <junit> task's manual.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          TearDownOnVmCrash() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test fakeTest, + java.lang.Throwable t) + +
          +          Only invoke tearDown if the suite is known and not the dummy + test we get when a Batch fails and the error is an actual + error generated by Ant.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +           
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +           
          + voidendTest(junit.framework.Test test) + +
          +           
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to.
          + voidsetSystemError(java.lang.String err) + +
          +          This is what the test has written to System.err
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out
          + voidstartTest(junit.framework.Test test) + +
          +           
          + voidstartTestSuite(JUnitTest suite) + +
          +          Records the suite's name to later determine the class to invoke + tearDown on.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TearDownOnVmCrash

          +
          +public TearDownOnVmCrash()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
          +
          +
          Records the suite's name to later determine the class to invoke + tearDown on. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the suite.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test fakeTest,
+                     java.lang.Throwable t)
          +
          +
          Only invoke tearDown if the suite is known and not the dummy + test we get when a Batch fails and the error is an actual + error generated by Ant. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test test)
          +
          +
          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
          +
          +
          Description copied from interface: JUnitResultFormatter
          +
          The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the suite.
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Description copied from interface: JUnitResultFormatter
          +
          Sets the stream the formatter is supposed to write its results to. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          Description copied from interface: JUnitResultFormatter
          +
          This is what the test has written to System.out +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String err)
          +
          +
          Description copied from interface: JUnitResultFormatter
          +
          This is what the test has written to System.err +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          err - the string to write.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.html new file mode 100644 index 000000000..7f8ee4e10 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLConstants.html @@ -0,0 +1,674 @@ + + + + + + +XMLConstants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Interface XMLConstants

          +
          +
          All Known Implementing Classes:
          XMLJUnitResultFormatter, XMLResultAggregator
          +
          +
          +
          +
          public interface XMLConstants
          + + +

          +

          Interface groups XML constants. + Interface that groups all constants used throughout the XML + documents that are generated by the XMLJUnitResultFormatter. +

          + As of now the DTD is: + 

          + <!ELEMENT testsuites (testsuite*)>
+
+ <!ELEMENT testsuite (properties, testcase*,
+                    failure?, error?,
+                     system-out?, system-err?)>
+ <!ATTLIST testsuite name      CDATA #REQUIRED>
+ <!ATTLIST testsuite tests     CDATA #REQUIRED>
+ <!ATTLIST testsuite failures  CDATA #REQUIRED>
+ <!ATTLIST testsuite errors    CDATA #REQUIRED>
+ <!ATTLIST testsuite time      CDATA #REQUIRED>
+ <!ATTLIST testsuite package   CDATA #IMPLIED>
+ <!ATTLIST testsuite id        CDATA #IMPLIED>
+
+
+ <!ELEMENT properties (property*)>
+
+ <!ELEMENT property EMPTY>
+   <!ATTLIST property name  CDATA #REQUIRED>
+   <!ATTLIST property value CDATA #REQUIRED>
+
+ <!ELEMENT testcase (failure?, error?)>
+   <!ATTLIST testcase name       CDATA #REQUIRED>
+   <!ATTLIST testcase classname  CDATA #IMPLIED>
+   <!ATTLIST testcase time       CDATA #REQUIRED>
+
+ <!ELEMENT failure (#PCDATA)>
+  <!ATTLIST failure message CDATA #IMPLIED>
+  <!ATTLIST failure type    CDATA #REQUIRED>
+
+ <!ELEMENT error (#PCDATA)>
+   <!ATTLIST error message CDATA #IMPLIED>
+   <!ATTLIST error type    CDATA #REQUIRED>
+
+ <!ELEMENT system-err (#PCDATA)>
+
+ <!ELEMENT system-out (#PCDATA)>
+
+
          +

          + +

          +

          +
          See Also:
          XMLJUnitResultFormatter, +XMLResultAggregator
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringATTR_CLASSNAME + +
          +          classname attribute for testcase elements
          +static java.lang.StringATTR_ERRORS + +
          +          errors attribute for testsuite elements
          +static java.lang.StringATTR_FAILURES + +
          +          failures attribute for testsuite elements
          +static java.lang.StringATTR_ID + +
          +          id attribute
          +static java.lang.StringATTR_MESSAGE + +
          +          message attribute for failure elements
          +static java.lang.StringATTR_NAME + +
          +          name attribute for property, testcase and testsuite elements
          +static java.lang.StringATTR_PACKAGE + +
          +          package attribute for the aggregate document
          +static java.lang.StringATTR_TESTS + +
          +          tests attribute for testsuite elements
          +static java.lang.StringATTR_TIME + +
          +          time attribute for testcase and testsuite elements
          +static java.lang.StringATTR_TYPE + +
          +          type attribute for failure and error elements
          +static java.lang.StringATTR_VALUE + +
          +          value attribute for property elements
          +static java.lang.StringERROR + +
          +          the error element
          +static java.lang.StringFAILURE + +
          +          the failure element
          +static java.lang.StringHOSTNAME + +
          +          name of host running the tests
          +static java.lang.StringPROPERTIES + +
          +          the properties element
          +static java.lang.StringPROPERTY + +
          +          the property element
          +static java.lang.StringSYSTEM_ERR + +
          +          the system-err element
          +static java.lang.StringSYSTEM_OUT + +
          +          the system-out element
          +static java.lang.StringTESTCASE + +
          +          the testcase element
          +static java.lang.StringTESTSUITE + +
          +          the testsuite element
          +static java.lang.StringTESTSUITES + +
          +          the testsuites element for the aggregate document
          +static java.lang.StringTIMESTAMP + +
          +          timestamp of test cases
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +TESTSUITES

          +
          +static final java.lang.String TESTSUITES
          +
          +
          the testsuites element for the aggregate document +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TESTSUITE

          +
          +static final java.lang.String TESTSUITE
          +
          +
          the testsuite element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TESTCASE

          +
          +static final java.lang.String TESTCASE
          +
          +
          the testcase element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR

          +
          +static final java.lang.String ERROR
          +
          +
          the error element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FAILURE

          +
          +static final java.lang.String FAILURE
          +
          +
          the failure element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SYSTEM_ERR

          +
          +static final java.lang.String SYSTEM_ERR
          +
          +
          the system-err element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SYSTEM_OUT

          +
          +static final java.lang.String SYSTEM_OUT
          +
          +
          the system-out element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_PACKAGE

          +
          +static final java.lang.String ATTR_PACKAGE
          +
          +
          package attribute for the aggregate document +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_NAME

          +
          +static final java.lang.String ATTR_NAME
          +
          +
          name attribute for property, testcase and testsuite elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_TIME

          +
          +static final java.lang.String ATTR_TIME
          +
          +
          time attribute for testcase and testsuite elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_ERRORS

          +
          +static final java.lang.String ATTR_ERRORS
          +
          +
          errors attribute for testsuite elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_FAILURES

          +
          +static final java.lang.String ATTR_FAILURES
          +
          +
          failures attribute for testsuite elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_TESTS

          +
          +static final java.lang.String ATTR_TESTS
          +
          +
          tests attribute for testsuite elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_TYPE

          +
          +static final java.lang.String ATTR_TYPE
          +
          +
          type attribute for failure and error elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_MESSAGE

          +
          +static final java.lang.String ATTR_MESSAGE
          +
          +
          message attribute for failure elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PROPERTIES

          +
          +static final java.lang.String PROPERTIES
          +
          +
          the properties element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PROPERTY

          +
          +static final java.lang.String PROPERTY
          +
          +
          the property element +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_VALUE

          +
          +static final java.lang.String ATTR_VALUE
          +
          +
          value attribute for property elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_CLASSNAME

          +
          +static final java.lang.String ATTR_CLASSNAME
          +
          +
          classname attribute for testcase elements +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ATTR_ID

          +
          +static final java.lang.String ATTR_ID
          +
          +
          id attribute +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TIMESTAMP

          +
          +static final java.lang.String TIMESTAMP
          +
          +
          timestamp of test cases +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HOSTNAME

          +
          +static final java.lang.String HOSTNAME
          +
          +
          name of host running the tests +

          +

          +
          See Also:
          Constant Field Values
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.html new file mode 100644 index 000000000..86ac0c7f5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLJUnitResultFormatter.html @@ -0,0 +1,516 @@ + + + + + + +XMLJUnitResultFormatter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class XMLJUnitResultFormatter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter
+
          +
          +
          All Implemented Interfaces:
          junit.framework.TestListener, JUnitResultFormatter, JUnitTaskMirror.JUnitResultFormatterMirror, XMLConstants
          +
          +
          +
          +
          public class XMLJUnitResultFormatter
          extends java.lang.Object
          implements JUnitResultFormatter, XMLConstants
          + + +

          +Prints XML output of the test to a specified Writer. +

          + +

          +

          +
          See Also:
          FormatterElement
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants
          ATTR_CLASSNAME, ATTR_ERRORS, ATTR_FAILURES, ATTR_ID, ATTR_MESSAGE, ATTR_NAME, ATTR_PACKAGE, ATTR_TESTS, ATTR_TIME, ATTR_TYPE, ATTR_VALUE, ERROR, FAILURE, HOSTNAME, PROPERTIES, PROPERTY, SYSTEM_ERR, SYSTEM_OUT, TESTCASE, TESTSUITE, TESTSUITES, TIMESTAMP
          +  + + + + + + + + + + +
          +Constructor Summary
          XMLJUnitResultFormatter() + +
          +          No arg constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddError(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener.
          + voidaddFailure(junit.framework.Test test, + junit.framework.AssertionFailedError t) + +
          +          Interface TestListener for JUnit > 3.4.
          + voidaddFailure(junit.framework.Test test, + java.lang.Throwable t) + +
          +          Interface TestListener for JUnit <= 3.4.
          + voidendTest(junit.framework.Test test) + +
          +          Interface TestListener.
          + voidendTestSuite(JUnitTest suite) + +
          +          The whole testsuite ended.
          + voidsetOutput(java.io.OutputStream out) + +
          +          Sets the stream the formatter is supposed to write its results to..
          + voidsetSystemError(java.lang.String out) + +
          +          This is what the test has written to System.err.
          + voidsetSystemOutput(java.lang.String out) + +
          +          This is what the test has written to System.out.
          + voidstartTest(junit.framework.Test t) + +
          +          Interface TestListener.
          + voidstartTestSuite(JUnitTest suite) + +
          +          The whole testsuite started.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +XMLJUnitResultFormatter

          +
          +public XMLJUnitResultFormatter()
          +
          +
          No arg constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setOutput

          +
          +public void setOutput(java.io.OutputStream out)
          +
          +
          Sets the stream the formatter is supposed to write its results to.. +

          +

          +
          Specified by:
          setOutput in interface JUnitResultFormatter
          Specified by:
          setOutput in interface JUnitTaskMirror.JUnitResultFormatterMirror
          +
          +
          +
          Parameters:
          out - the output stream to use.
          +
          +
          +
          + +

          +setSystemOutput

          +
          +public void setSystemOutput(java.lang.String out)
          +
          +
          This is what the test has written to System.out. +

          +

          +
          Specified by:
          setSystemOutput in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +setSystemError

          +
          +public void setSystemError(java.lang.String out)
          +
          +
          This is what the test has written to System.err. +

          +

          +
          Specified by:
          setSystemError in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          out - the string to write.
          +
          +
          +
          + +

          +startTestSuite

          +
          +public void startTestSuite(JUnitTest suite)
          +
          +
          The whole testsuite started. +

          +

          +
          Specified by:
          startTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the testsuite.
          +
          +
          +
          + +

          +endTestSuite

          +
          +public void endTestSuite(JUnitTest suite)
+                  throws BuildException
          +
          +
          The whole testsuite ended. +

          +

          +
          Specified by:
          endTestSuite in interface JUnitResultFormatter
          +
          +
          +
          Parameters:
          suite - the testsuite. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +startTest

          +
          +public void startTest(junit.framework.Test t)
          +
          +
          Interface TestListener. + +

          A new Test is started. +

          +

          +
          Specified by:
          startTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          t - the test.
          +
          +
          +
          + +

          +endTest

          +
          +public void endTest(junit.framework.Test test)
          +
          +
          Interface TestListener. + +

          A Test is finished. +

          +

          +
          Specified by:
          endTest in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       java.lang.Throwable t)
          +
          +
          Interface TestListener for JUnit <= 3.4. + +

          A Test failed. +

          +

          +
          +
          +
          +
          Parameters:
          test - the test.
          t - the exception.
          +
          +
          +
          + +

          +addFailure

          +
          +public void addFailure(junit.framework.Test test,
+                       junit.framework.AssertionFailedError t)
          +
          +
          Interface TestListener for JUnit > 3.4. + +

          A Test failed. +

          +

          +
          Specified by:
          addFailure in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the assertion.
          +
          +
          +
          + +

          +addError

          +
          +public void addError(junit.framework.Test test,
+                     java.lang.Throwable t)
          +
          +
          Interface TestListener. + +

          An error occurred while running the test. +

          +

          +
          Specified by:
          addError in interface junit.framework.TestListener
          +
          +
          +
          Parameters:
          test - the test.
          t - the error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.html new file mode 100644 index 000000000..7ca827ee7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/XMLResultAggregator.html @@ -0,0 +1,718 @@ + + + + + + +XMLResultAggregator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.junit +
          +Class XMLResultAggregator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, XMLConstants
          +
          +
          +
          +
          public class XMLResultAggregator
          extends Task
          implements XMLConstants
          + + +

          +Aggregates all <junit> XML formatter testsuite data under + a specific directory and transforms the results via XSLT. + It is not particulary clean but + should be helpful while I am thinking about another technique. + +

          The main problem is due to the fact that a JVM can be forked for a testcase + thus making it impossible to aggregate all testcases since the listener is + (obviously) in the forked JVM. A solution could be to write a + TestListener that will receive events from the TestRunner via sockets. This + is IMHO the simplest way to do it to avoid this file hacking thing. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_DIR + +
          +          The default directory: ..
          +static java.lang.StringDEFAULT_FILENAME + +
          +          the default file name: TESTS-TestSuites.xml
          +protected  java.util.Vectorfilesets + +
          +          the list of all filesets, that should contains the xml to aggregate
          +protected  intgeneratedId + +
          +          the current generated id
          +protected  java.io.FiletoDir + +
          +          the directory to write the file to
          +protected  java.lang.StringtoFile + +
          +          the name of the result file
          +protected  java.util.Vectortransformers + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.junit.XMLConstants
          ATTR_CLASSNAME, ATTR_ERRORS, ATTR_FAILURES, ATTR_ID, ATTR_MESSAGE, ATTR_NAME, ATTR_PACKAGE, ATTR_TESTS, ATTR_TIME, ATTR_TYPE, ATTR_VALUE, ERROR, FAILURE, HOSTNAME, PROPERTIES, PROPERTY, SYSTEM_ERR, SYSTEM_OUT, TESTCASE, TESTSUITE, TESTSUITES, TIMESTAMP
          +  + + + + + + + + + + +
          +Constructor Summary
          XMLResultAggregator() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileSet(FileSet fs) + +
          +          Add a new fileset containing the XML results to aggregate
          +protected  voidaddTestSuite(org.w3c.dom.Element root, + org.w3c.dom.Element testsuite) + +
          +           Add a new testsuite node to the document.
          +protected  org.w3c.dom.ElementcreateDocument() + +
          +           Create a DOM tree.
          + AggregateTransformercreateReport() + +
          +          Generate a report based on the document created by the merge.
          + voidexecute() + +
          +          Aggregate all testsuites into a single document and write it to the + specified directory and file.
          + java.io.FilegetDestinationFile() + +
          +          Get the full destination file where to write the result.
          +protected  java.io.File[]getFiles() + +
          +          Get all .xml files in the fileset.
          + voidsetTodir(java.io.File value) + +
          +          Set the destination directory where the results should be written.
          + voidsetTofile(java.lang.String value) + +
          +          Set the name of the aggregegated results file.
          +protected  voidwriteDOMTree(org.w3c.dom.Document doc, + java.io.File file) + +
          +          Write the DOM tree to a file.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +filesets

          +
          +protected java.util.Vector filesets
          +
          +
          the list of all filesets, that should contains the xml to aggregate +

          +

          +
          +
          +
          + +

          +toFile

          +
          +protected java.lang.String toFile
          +
          +
          the name of the result file +

          +

          +
          +
          +
          + +

          +toDir

          +
          +protected java.io.File toDir
          +
          +
          the directory to write the file to +

          +

          +
          +
          +
          + +

          +transformers

          +
          +protected java.util.Vector transformers
          +
          +
          +
          +
          +
          + +

          +DEFAULT_DIR

          +
          +public static final java.lang.String DEFAULT_DIR
          +
          +
          The default directory: .. It is resolved from the project directory +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FILENAME

          +
          +public static final java.lang.String DEFAULT_FILENAME
          +
          +
          the default file name: TESTS-TestSuites.xml +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +generatedId

          +
          +protected int generatedId
          +
          +
          the current generated id +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +XMLResultAggregator

          +
          +public XMLResultAggregator()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createReport

          +
          +public AggregateTransformer createReport()
          +
          +
          Generate a report based on the document created by the merge. +

          +

          +
          +
          +
          + +
          Returns:
          the report
          +
          +
          +
          + +

          +setTofile

          +
          +public void setTofile(java.lang.String value)
          +
          +
          Set the name of the aggregegated results file. It must be relative + from the todir attribute. If not set it will use DEFAULT_FILENAME +

          +

          +
          +
          +
          +
          Parameters:
          value - the name of the file.
          See Also:
          setTodir(File)
          +
          +
          +
          + +

          +setTodir

          +
          +public void setTodir(java.io.File value)
          +
          +
          Set the destination directory where the results should be written. If not + set if will use DEFAULT_DIR. When given a relative directory + it will resolve it from the project directory. +

          +

          +
          +
          +
          +
          Parameters:
          value - the directory where to write the results, absolute or + relative.
          +
          +
          +
          + +

          +addFileSet

          +
          +public void addFileSet(FileSet fs)
          +
          +
          Add a new fileset containing the XML results to aggregate +

          +

          +
          +
          +
          +
          Parameters:
          fs - the new fileset of xml results.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Aggregate all testsuites into a single document and write it to the + specified directory and file. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - thrown if there is a serious error while writing + the document.
          +
          +
          +
          + +

          +getDestinationFile

          +
          +public java.io.File getDestinationFile()
          +
          +
          Get the full destination file where to write the result. It is made of + the todir and tofile attributes. +

          +

          +
          +
          +
          + +
          Returns:
          the destination file where should be written the result file.
          +
          +
          +
          + +

          +getFiles

          +
          +protected java.io.File[] getFiles()
          +
          +
          Get all .xml files in the fileset. +

          +

          +
          +
          +
          + +
          Returns:
          all files in the fileset that end with a '.xml'.
          +
          +
          +
          + +

          +writeDOMTree

          +
          +protected void writeDOMTree(org.w3c.dom.Document doc,
+                            java.io.File file)
+                     throws java.io.IOException
          +
          +
          Write the DOM tree to a file. +

          +

          +
          +
          +
          +
          Parameters:
          doc - the XML document to dump to disk.
          file - the filename to write the document to. Should obviouslly be a .xml file. +
          Throws: +
          java.io.IOException - thrown if there is an error while writing the content.
          +
          +
          +
          + +

          +createDocument

          +
          +protected org.w3c.dom.Element createDocument()
          +
          +

          Create a DOM tree. + Has 'testsuites' as firstchild and aggregates all + testsuite results that exists in the base directory. +

          +

          +
          +
          +
          + +
          Returns:
          the root element of DOM tree that aggregates all testsuites.
          +
          +
          +
          + +

          +addTestSuite

          +
          +protected void addTestSuite(org.w3c.dom.Element root,
+                            org.w3c.dom.Element testsuite)
          +
          +

          Add a new testsuite node to the document. + The main difference is that it + split the previous fully qualified name into a package and a name. +

          For example: org.apache.Whatever will be split into + org.apache and Whatever. +

          +

          +
          +
          +
          +
          Parameters:
          root - the root element to which the testsuite node should + be appended.
          testsuite - the element to append to the given root. It will slightly + modify the original node to change the name attribute and add + a package one.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-frame.html new file mode 100644 index 000000000..8c0c66b04 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-frame.html @@ -0,0 +1,113 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.junit (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.junit + + + + +
          +Interfaces  + +
          +DOMUtil.NodeFilter +
          +JUnitResultFormatter +
          +JUnitTaskMirror +
          +JUnitTaskMirror.JUnitResultFormatterMirror +
          +JUnitTaskMirror.JUnitTestRunnerMirror +
          +JUnitTaskMirror.SummaryJUnitResultFormatterMirror +
          +XMLConstants
          + + + + + + +
          +Classes  + +
          +AggregateTransformer +
          +AggregateTransformer.Format +
          +BaseTest +
          +BatchTest +
          +BriefJUnitResultFormatter +
          +Constants +
          +DOMUtil +
          +DOMUtil.NodeListImpl +
          +Enumerations +
          +FailureRecorder +
          +FailureRecorder.TestInfos +
          +FormatterElement +
          +FormatterElement.TypeAttribute +
          +JUnit4TestMethodAdapter +
          +JUnitTask +
          +JUnitTask.ForkMode +
          +JUnitTask.JUnitLogOutputStream +
          +JUnitTask.JUnitLogStreamHandler +
          +JUnitTask.SummaryAttribute +
          +JUnitTask.TestResultHolder +
          +JUnitTaskMirrorImpl +
          +JUnitTest +
          +JUnitTestRunner +
          +JUnitVersionHelper +
          +OutErrSummaryJUnitResultFormatter +
          +PlainJUnitResultFormatter +
          +SummaryJUnitResultFormatter +
          +TearDownOnVmCrash +
          +XMLJUnitResultFormatter +
          +XMLResultAggregator
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-summary.html new file mode 100644 index 000000000..da9cd311e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-summary.html @@ -0,0 +1,316 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.junit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.junit +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Interface Summary
          DOMUtil.NodeFilterFilter interface to be applied when iterating over a DOM tree.
          JUnitResultFormatterThis Interface describes classes that format the results of a JUnit + testrun.
          JUnitTaskMirrorHandles the portions of JUnitTask which need to directly access + actual JUnit classes, so that junit.jar need not be on Ant's startup classpath.
          JUnitTaskMirror.JUnitResultFormatterMirrorThe interface that JUnitResultFormatter extends.
          JUnitTaskMirror.JUnitTestRunnerMirrorInterface that test runners implement.
          JUnitTaskMirror.SummaryJUnitResultFormatterMirrorThe interface that SummaryJUnitResultFormatter extends.
          XMLConstants Interface groups XML constants.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AggregateTransformerTransform a JUnit xml report.
          AggregateTransformer.Formatdefines acceptable formats.
          BaseTestBaseclass for BatchTest and JUnitTest.
          BatchTest Create then run JUnitTest's based on the list of files + given by the fileset attribute.
          BriefJUnitResultFormatterPrints plain text output of the test to a specified Writer.
          ConstantsConstants, like filenames shared between various classes in this package.
          DOMUtilSome utilities that might be useful when manipulating DOM trees.
          DOMUtil.NodeListImplcustom implementation of a nodelist
          EnumerationsA couple of methods related to enumerations that might be useful.
          FailureRecorderCollects all failing test cases and creates a new JUnit test class containing + a suite() method which calls these failed tests.
          FailureRecorder.TestInfosTestInfos holds information about a given test for later use.
          FormatterElement A wrapper for the implementations of JUnitResultFormatter.
          FormatterElement.TypeAttribute Enumerated attribute with the values "plain", "xml", "brief" and "failure".
          JUnit4TestMethodAdapterAdapter between JUnit 3.8.x API and JUnit 4.x API for execution of tests + and listening of events (test start, test finish, test failure).
          JUnitTaskRuns JUnit tests.
          JUnitTask.ForkModeThese are the different forking options
          JUnitTask.JUnitLogOutputStreamA stream handler for handling the junit task.
          JUnitTask.JUnitLogStreamHandlerA log stream handler for junit.
          JUnitTask.SummaryAttributePrint summary enumeration values.
          JUnitTask.TestResultHolderA value class that contains the result of a test.
          JUnitTaskMirrorImplImplementation of the part of the junit task which can directly refer to junit.* classes.
          JUnitTest Run a single JUnit test.
          JUnitTestRunnerSimple Testrunner for JUnit that runs all tests of a testsuite.
          JUnitVersionHelperWork around for some changes to the public JUnit API between + different JUnit releases.
          OutErrSummaryJUnitResultFormatterUsed instead of SummaryJUnitResultFormatter in forked tests if + withOutAndErr is requested.
          PlainJUnitResultFormatterPrints plain text output of the test to a specified Writer.
          SummaryJUnitResultFormatterPrints short summary output of the test to Ant's logging system.
          TearDownOnVmCrashFormatter that doesn't create any output but tries to invoke the + tearDown method on a testcase if that test was forked and caused a + timeout or VM crash.
          XMLJUnitResultFormatterPrints XML output of the test to a specified Writer.
          XMLResultAggregatorAggregates all <junit> XML formatter testsuite data under + a specific directory and transforms the results via XSLT.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-tree.html new file mode 100644 index 000000000..aa61c6404 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/junit/package-tree.html @@ -0,0 +1,201 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.junit Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.junit +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html new file mode 100644 index 000000000..60cafecb7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html @@ -0,0 +1,379 @@ + + + + + + +DefaultNative2Ascii (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +Class DefaultNative2Ascii

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii
+
          +
          +
          All Implemented Interfaces:
          Native2AsciiAdapter
          +
          +
          +
          Direct Known Subclasses:
          KaffeNative2Ascii, SunNative2Ascii
          +
          +
          +
          +
          public abstract class DefaultNative2Ascii
          extends java.lang.Object
          implements Native2AsciiAdapter
          + + +

          +encapsulates the handling common to diffent Native2Asciiadapter + implementations. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          DefaultNative2Ascii() + +
          +          No-arg constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidaddFiles(Commandline cmd, + ProjectComponent log, + java.io.File src, + java.io.File dest) + +
          +          Adds source and dest files to the command line.
          + booleanconvert(Native2Ascii args, + java.io.File srcFile, + java.io.File destFile) + +
          +          Splits the task into setting up the command line switches
          +protected abstract  booleanrun(Commandline cmd, + ProjectComponent log) + +
          +          Executes the command.
          +protected  voidsetup(Commandline cmd, + Native2Ascii args) + +
          +          Sets up the initial command line.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DefaultNative2Ascii

          +
          +public DefaultNative2Ascii()
          +
          +
          No-arg constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +convert

          +
          +public final boolean convert(Native2Ascii args,
+                             java.io.File srcFile,
+                             java.io.File destFile)
+                      throws BuildException
          +
          +
          Splits the task into setting up the command line switches +

          +

          +
          Specified by:
          convert in interface Native2AsciiAdapter
          +
          +
          +
          Parameters:
          args - the native 2 ascii arguments.
          srcFile - the source file.
          destFile - the destination file. +
          Returns:
          run if the conversion was successful. +
          Throws: +
          BuildException - if there is a problem. + (delegated to setup), adding the file names + (delegated to addFiles) and running the tool + (delegated to run).
          +
          +
          +
          + +

          +setup

          +
          +protected void setup(Commandline cmd,
+                     Native2Ascii args)
+              throws BuildException
          +
          +
          Sets up the initial command line. + +

          only the -encoding argument and nested arg elements get + handled here.

          +

          +

          +
          +
          +
          +
          Parameters:
          cmd - Command line to add to
          args - provides the user-setting and access to Ant's + logging system. +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          +
          + +

          +addFiles

          +
          +protected void addFiles(Commandline cmd,
+                        ProjectComponent log,
+                        java.io.File src,
+                        java.io.File dest)
+                 throws BuildException
          +
          +
          Adds source and dest files to the command line. + +

          This implementation adds them without any leading + qualifiers, source first.

          +

          +

          +
          +
          +
          +
          Parameters:
          cmd - Command line to add to
          log - provides access to Ant's logging system.
          src - the source file
          dest - the destination file +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          +
          + +

          +run

          +
          +protected abstract boolean run(Commandline cmd,
+                               ProjectComponent log)
+                        throws BuildException
          +
          +
          Executes the command. +

          +

          +
          +
          +
          +
          Parameters:
          cmd - Command line to execute
          log - provides access to Ant's logging system. +
          Returns:
          whether execution was successful +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html new file mode 100644 index 000000000..bce7c689a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html @@ -0,0 +1,350 @@ + + + + + + +KaffeNative2Ascii (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +Class KaffeNative2Ascii

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii
+      extended by org.apache.tools.ant.taskdefs.optional.native2ascii.KaffeNative2Ascii
+
          +
          +
          All Implemented Interfaces:
          Native2AsciiAdapter
          +
          +
          +
          +
          public final class KaffeNative2Ascii
          extends DefaultNative2Ascii
          + + +

          +Adapter to kaffe.tools.native2ascii.Native2Ascii. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringIMPLEMENTATION_NAME + +
          +          Identifies this adapter.
          +  + + + + + + + + + + +
          +Constructor Summary
          KaffeNative2Ascii() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  booleanrun(Commandline cmd, + ProjectComponent log) + +
          +          Executes the command.
          +protected  voidsetup(Commandline cmd, + Native2Ascii args) + +
          +          Sets up the initial command line.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii
          addFiles, convert
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IMPLEMENTATION_NAME

          +
          +public static final java.lang.String IMPLEMENTATION_NAME
          +
          +
          Identifies this adapter. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +KaffeNative2Ascii

          +
          +public KaffeNative2Ascii()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setup

          +
          +protected void setup(Commandline cmd,
+                     Native2Ascii args)
+              throws BuildException
          +
          +
          Sets up the initial command line. + +

          only the -encoding argument and nested arg elements get + handled here.

          +

          +

          +
          Overrides:
          setup in class DefaultNative2Ascii
          +
          +
          +
          Parameters:
          cmd - Command line to add to
          args - provides the user-setting and access to Ant's + logging system. +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          +
          + +

          +run

          +
          +protected boolean run(Commandline cmd,
+                      ProjectComponent log)
+               throws BuildException
          +
          +
          Executes the command. +

          +

          +
          Specified by:
          run in class DefaultNative2Ascii
          +
          +
          +
          Parameters:
          cmd - Command line to execute
          log - provides access to Ant's logging system. +
          Returns:
          whether execution was successful +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html new file mode 100644 index 000000000..9aa49a2eb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html @@ -0,0 +1,223 @@ + + + + + + +Native2AsciiAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +Interface Native2AsciiAdapter

          +
          +
          All Known Implementing Classes:
          DefaultNative2Ascii, KaffeNative2Ascii, SunNative2Ascii
          +
          +
          +
          +
          public interface Native2AsciiAdapter
          + + +

          +Interface for an adapter to a native2ascii implementation. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + booleanconvert(Native2Ascii args, + java.io.File srcFile, + java.io.File destFile) + +
          +          Convert the encoding of srcFile writing to destFile.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +convert

          +
          +boolean convert(Native2Ascii args,
+                java.io.File srcFile,
+                java.io.File destFile)
+                throws BuildException
          +
          +
          Convert the encoding of srcFile writing to destFile. +

          +

          +
          Parameters:
          args - Task that holds command line arguments and allows + the implementation to send messages to Ant's logging system
          srcFile - the source to convert
          destFile - where to send output to +
          Returns:
          whether the conversion has been successful. +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapterFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapterFactory.html new file mode 100644 index 000000000..d0b72ce11 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapterFactory.html @@ -0,0 +1,327 @@ + + + + + + +Native2AsciiAdapterFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +Class Native2AsciiAdapterFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.native2ascii.Native2AsciiAdapterFactory
+
          +
          +
          +
          public class Native2AsciiAdapterFactory
          extends java.lang.Object
          + + +

          +Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Native2AsciiAdapterFactory() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static Native2AsciiAdaptergetAdapter(java.lang.String choice, + ProjectComponent log) + +
          +          Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor.
          +static Native2AsciiAdaptergetAdapter(java.lang.String choice, + ProjectComponent log, + Path classpath) + +
          +          Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor.
          +static java.lang.StringgetDefault() + +
          +          Determines the default choice of adapter based on the VM + vendor.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Native2AsciiAdapterFactory

          +
          +public Native2AsciiAdapterFactory()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getDefault

          +
          +public static java.lang.String getDefault()
          +
          +
          Determines the default choice of adapter based on the VM + vendor. +

          +

          + +
          Returns:
          the default choice of adapter based on the VM + vendor
          +
          +
          +
          + +

          +getAdapter

          +
          +public static Native2AsciiAdapter getAdapter(java.lang.String choice,
+                                             ProjectComponent log)
+                                      throws BuildException
          +
          +
          Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor. +

          +

          +
          Parameters:
          choice - the user choice (if any).
          log - a ProjectComponent instance used to access Ant's + logging system. +
          Returns:
          The adapter to use. +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          +
          + +

          +getAdapter

          +
          +public static Native2AsciiAdapter getAdapter(java.lang.String choice,
+                                             ProjectComponent log,
+                                             Path classpath)
+                                      throws BuildException
          +
          +
          Creates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor. +

          +

          +
          Parameters:
          choice - the user choice (if any).
          log - a ProjectComponent instance used to access Ant's + logging system.
          classpath - the classpath to use when looking up an + adapter class +
          Returns:
          The adapter to use. +
          Throws: +
          BuildException - if there was a problem.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/SunNative2Ascii.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/SunNative2Ascii.html new file mode 100644 index 000000000..526701a8a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/SunNative2Ascii.html @@ -0,0 +1,350 @@ + + + + + + +SunNative2Ascii (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +Class SunNative2Ascii

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii
+      extended by org.apache.tools.ant.taskdefs.optional.native2ascii.SunNative2Ascii
+
          +
          +
          All Implemented Interfaces:
          Native2AsciiAdapter
          +
          +
          +
          +
          public final class SunNative2Ascii
          extends DefaultNative2Ascii
          + + +

          +Adapter to sun.tools.native2ascii.Main. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringIMPLEMENTATION_NAME + +
          +          Identifies this adapter.
          +  + + + + + + + + + + +
          +Constructor Summary
          SunNative2Ascii() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  booleanrun(Commandline cmd, + ProjectComponent log) + +
          +          Executes the command.
          +protected  voidsetup(Commandline cmd, + Native2Ascii args) + +
          +          Sets up the initial command line.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii
          addFiles, convert
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IMPLEMENTATION_NAME

          +
          +public static final java.lang.String IMPLEMENTATION_NAME
          +
          +
          Identifies this adapter. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SunNative2Ascii

          +
          +public SunNative2Ascii()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setup

          +
          +protected void setup(Commandline cmd,
+                     Native2Ascii args)
+              throws BuildException
          +
          +
          Sets up the initial command line. + +

          only the -encoding argument and nested arg elements get + handled here.

          +

          +

          +
          Overrides:
          setup in class DefaultNative2Ascii
          +
          +
          +
          Parameters:
          cmd - Command line to add to
          args - provides the user-setting and access to Ant's + logging system. +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          +
          + +

          +run

          +
          +protected boolean run(Commandline cmd,
+                      ProjectComponent log)
+               throws BuildException
          +
          +
          Executes the command. +

          +

          +
          Specified by:
          run in class DefaultNative2Ascii
          +
          +
          +
          Parameters:
          cmd - Command line to execute
          log - provides access to Ant's logging system. +
          Returns:
          whether execution was successful +
          Throws: +
          BuildException - if there was a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-frame.html new file mode 100644 index 000000000..78d47f518 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-frame.html @@ -0,0 +1,49 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.native2ascii (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.native2ascii + + + + +
          +Interfaces  + +
          +Native2AsciiAdapter
          + + + + + + +
          +Classes  + +
          +DefaultNative2Ascii +
          +KaffeNative2Ascii +
          +Native2AsciiAdapterFactory +
          +SunNative2Ascii
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-summary.html new file mode 100644 index 000000000..e05076f55 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-summary.html @@ -0,0 +1,180 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.native2ascii (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.native2ascii +

          + + + + + + + + + +
          +Interface Summary
          Native2AsciiAdapterInterface for an adapter to a native2ascii implementation.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          DefaultNative2Asciiencapsulates the handling common to diffent Native2Asciiadapter + implementations.
          KaffeNative2AsciiAdapter to kaffe.tools.native2ascii.Native2Ascii.
          Native2AsciiAdapterFactoryCreates the Native2AsciiAdapter based on the user choice and + potentially the VM vendor.
          SunNative2AsciiAdapter to sun.tools.native2ascii.Main.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-tree.html new file mode 100644 index 000000000..ac4b768ea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.native2ascii Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.native2ascii +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html new file mode 100644 index 000000000..42a1bd5f5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Action.html @@ -0,0 +1,312 @@ + + + + + + +FTP.Action (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.Action

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.Action
+
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          public static class FTP.Action
          extends EnumeratedAttribute
          + + +

          +an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir" +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP.Action() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetAction() + +
          +          Get the symbolic equivalent of the action value.
          + java.lang.String[]getValues() + +
          +          Get the valid values
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.Action

          +
          +public FTP.Action()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array of the valid FTP actions.
          +
          +
          +
          + +

          +getAction

          +
          +public int getAction()
          +
          +
          Get the symbolic equivalent of the action value. +

          +

          + +
          Returns:
          the SYMBOL representing the given action.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html new file mode 100644 index 000000000..7652cd7ca --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPFile.html @@ -0,0 +1,637 @@ + + + + + + +FTP.FTPDirectoryScanner.AntFTPFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.FTPDirectoryScanner.AntFTPFile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile
+
          +
          +
          Direct Known Subclasses:
          FTP.FTPDirectoryScanner.AntFTPRootFile
          +
          +
          +
          Enclosing class:
          FTP.FTPDirectoryScanner
          +
          +
          +
          +
          protected class FTP.FTPDirectoryScanner.AntFTPFile
          extends java.lang.Object
          + + +

          +an AntFTPFile is a representation of a remote file +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          FTP.FTPDirectoryScanner.AntFTPFile(FTP.FTPDirectoryScanner.AntFTPFile parent, + java.lang.String path) + +
          +          other constructor
          FTP.FTPDirectoryScanner.AntFTPFile(org.apache.commons.net.ftp.FTPClient client, + org.apache.commons.net.ftp.FTPFile ftpFile, + java.lang.String curpwd) + +
          +          constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexists() + +
          +          find out if the file exists
          + java.lang.StringgetAbsolutePath() + +
          +          find out the absolute path of the file
          +protected  org.apache.commons.net.ftp.FTPClientgetClient() + +
          +          return the attached FTP client object.
          + java.lang.StringgetCurpwd() + +
          +          returns the path of the directory containing the AntFTPFile.
          + java.lang.StringgetCurpwdPlusFileSep() + +
          +          returns the path of the directory containing the AntFTPFile.
          + java.lang.StringgetFastRelativePath() + +
          +          find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case.
          + org.apache.commons.net.ftp.FTPFilegetFile(org.apache.commons.net.ftp.FTPFile[] theFiles, + java.lang.String lastpathelement) + +
          +          find a file matching a string in an array of FTPFile.
          + java.lang.StringgetLink() + +
          +          if the file is a symbolic link, find out to what it is pointing
          + java.lang.StringgetName() + +
          +          get the name of the file
          + java.lang.StringgetRelativePath() + +
          +          find out the relative path to the rootPath of the enclosing scanner.
          + booleanisDirectory() + +
          +          tell if a file is a directory.
          + booleanisSymbolicLink() + +
          +          tell if a file is a symbolic link
          + booleanisTraverseSymlinks() + +
          +          find out if a symbolic link is encountered in the relative path of this file + from rootPath.
          +protected  voidsetCurpwd(java.lang.String curpwd) + +
          +          sets the current path of an AntFTPFile
          + java.lang.StringtoString() + +
          +          Get a string rep of this object.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.FTPDirectoryScanner.AntFTPFile

          +
          +public FTP.FTPDirectoryScanner.AntFTPFile(org.apache.commons.net.ftp.FTPClient client,
+                                          org.apache.commons.net.ftp.FTPFile ftpFile,
+                                          java.lang.String curpwd)
          +
          +
          constructor +

          +

          +
          Parameters:
          client - ftp client variable
          ftpFile - the file
          curpwd - absolute remote path where the file is found
          +
          +
          + +

          +FTP.FTPDirectoryScanner.AntFTPFile

          +
          +public FTP.FTPDirectoryScanner.AntFTPFile(FTP.FTPDirectoryScanner.AntFTPFile parent,
+                                          java.lang.String path)
          +
          +
          other constructor +

          +

          +
          Parameters:
          parent - the parent file
          path - a relative path to the parent file
          +
          + + + + + + + + +
          +Method Detail
          + +

          +exists

          +
          +public boolean exists()
          +
          +
          find out if the file exists +

          +

          + +
          Returns:
          true if the file exists
          +
          +
          +
          + +

          +getLink

          +
          +public java.lang.String getLink()
          +
          +
          if the file is a symbolic link, find out to what it is pointing +

          +

          + +
          Returns:
          the target of the symbolic link
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          get the name of the file +

          +

          + +
          Returns:
          the name of the file
          +
          +
          +
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          find out the absolute path of the file +

          +

          + +
          Returns:
          absolute path as string
          +
          +
          +
          + +

          +getFastRelativePath

          +
          +public java.lang.String getFastRelativePath()
          +
          +
          find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case. + This is OK on a case sensitive system such as UNIX +

          +

          + +
          Returns:
          relative path
          +
          +
          +
          + +

          +getRelativePath

          +
          +public java.lang.String getRelativePath()
+                                 throws java.io.IOException,
+                                        BuildException
          +
          +
          find out the relative path to the rootPath of the enclosing scanner. + this relative path is spelled exactly like on disk, + for instance if the AntFTPFile has been instantiated as ALPHA, + but the file is really called alpha, this method will return alpha. + If a symbolic link is encountered, it is followed, but the name of the link + rather than the name of the target is returned. + (ie does not behave like File.getCanonicalPath()) +

          +

          + +
          Returns:
          relative path, separated by remoteFileSep +
          Throws: +
          java.io.IOException - if a change directory fails, ... +
          BuildException - if one of the components of the relative path cannot + be found.
          +
          +
          +
          + +

          +getFile

          +
          +public org.apache.commons.net.ftp.FTPFile getFile(org.apache.commons.net.ftp.FTPFile[] theFiles,
+                                                  java.lang.String lastpathelement)
          +
          +
          find a file matching a string in an array of FTPFile. + This method will find "alpha" when requested for "ALPHA" + if and only if the caseSensitive attribute is set to false. + When caseSensitive is set to true, only the exact match is returned. +

          +

          +
          Parameters:
          theFiles - array of files
          lastpathelement - the file name being sought +
          Returns:
          null if the file cannot be found, otherwise return the matching file.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          tell if a file is a directory. + note that it will return false for symbolic links pointing to directories. +

          +

          + +
          Returns:
          true for directories
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink()
          +
          +
          tell if a file is a symbolic link +

          +

          + +
          Returns:
          true for symbolic links
          +
          +
          +
          + +

          +getClient

          +
          +protected org.apache.commons.net.ftp.FTPClient getClient()
          +
          +
          return the attached FTP client object. + Warning : this instance is really shared with the enclosing class. +

          +

          + +
          Returns:
          FTP client
          +
          +
          +
          + +

          +setCurpwd

          +
          +protected void setCurpwd(java.lang.String curpwd)
          +
          +
          sets the current path of an AntFTPFile +

          +

          +
          Parameters:
          curpwd - the current path one wants to set
          +
          +
          +
          + +

          +getCurpwd

          +
          +public java.lang.String getCurpwd()
          +
          +
          returns the path of the directory containing the AntFTPFile. + of the full path of the file itself in case of AntFTPRootFile +

          +

          + +
          Returns:
          parent directory of the AntFTPFile
          +
          +
          +
          + +

          +getCurpwdPlusFileSep

          +
          +public java.lang.String getCurpwdPlusFileSep()
          +
          +
          returns the path of the directory containing the AntFTPFile. + of the full path of the file itself in case of AntFTPRootFile + and appends the remote file separator if necessary. +

          +

          + +
          Returns:
          parent directory of the AntFTPFile
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +isTraverseSymlinks

          +
          +public boolean isTraverseSymlinks()
+                           throws java.io.IOException,
+                                  BuildException
          +
          +
          find out if a symbolic link is encountered in the relative path of this file + from rootPath. +

          +

          + +
          Returns:
          true if a symbolic link is encountered in the relative path. +
          Throws: +
          java.io.IOException - if one of the change directory or directory listing operations + fails +
          BuildException - if a path component in the relative path cannot be found.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get a string rep of this object. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          a string containing the pwd and the file.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html new file mode 100644 index 000000000..c4a0a5373 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.AntFTPRootFile.html @@ -0,0 +1,310 @@ + + + + + + +FTP.FTPDirectoryScanner.AntFTPRootFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.FTPDirectoryScanner.AntFTPRootFile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPRootFile
+
          +
          +
          Enclosing class:
          FTP.FTPDirectoryScanner
          +
          +
          +
          +
          protected class FTP.FTPDirectoryScanner.AntFTPRootFile
          extends FTP.FTPDirectoryScanner.AntFTPFile
          + + +

          +special class to represent the remote directory itself +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FTP.FTPDirectoryScanner.AntFTPRootFile(org.apache.commons.net.ftp.FTPClient aclient, + java.lang.String remotedir) + +
          +          constructor
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetAbsolutePath() + +
          +          find the absolute path
          + java.lang.StringgetRelativePath() + +
          +          find out the relative path to root
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner.AntFTPFile
          exists, getClient, getCurpwd, getCurpwdPlusFileSep, getFastRelativePath, getFile, getLink, getName, isDirectory, isSymbolicLink, isTraverseSymlinks, setCurpwd, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.FTPDirectoryScanner.AntFTPRootFile

          +
          +public FTP.FTPDirectoryScanner.AntFTPRootFile(org.apache.commons.net.ftp.FTPClient aclient,
+                                              java.lang.String remotedir)
          +
          +
          constructor +

          +

          +
          Parameters:
          aclient - FTP client
          remotedir - remote directory
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          find the absolute path +

          +

          +
          Overrides:
          getAbsolutePath in class FTP.FTPDirectoryScanner.AntFTPFile
          +
          +
          + +
          Returns:
          absolute path
          +
          +
          +
          + +

          +getRelativePath

          +
          +public java.lang.String getRelativePath()
+                                 throws BuildException,
+                                        java.io.IOException
          +
          +
          find out the relative path to root +

          +

          +
          Overrides:
          getRelativePath in class FTP.FTPDirectoryScanner.AntFTPFile
          +
          +
          + +
          Returns:
          empty string +
          Throws: +
          BuildException - actually never +
          java.io.IOException - actually never
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html new file mode 100644 index 000000000..262a6bcda --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPDirectoryScanner.html @@ -0,0 +1,427 @@ + + + + + + +FTP.FTPDirectoryScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.FTPDirectoryScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          protected class FTP.FTPDirectoryScanner
          extends DirectoryScanner
          + + +

          +internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +protected  classFTP.FTPDirectoryScanner.AntFTPFile + +
          +          an AntFTPFile is a representation of a remote file
          +protected  classFTP.FTPDirectoryScanner.AntFTPRootFile + +
          +          special class to represent the remote directory itself
          +  + + + + + + + + + + +
          +Field Summary
          +protected  org.apache.commons.net.ftp.FTPClientftp + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP.FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp) + +
          +          constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + org.apache.commons.net.ftp.FTPFile[]listFiles(java.lang.String directory) + +
          +          cd into one directory and + list the files present in one directory.
          + org.apache.commons.net.ftp.FTPFile[]listFiles(java.lang.String directory, + boolean changedir) + +
          +          list the files present in one directory.
          + voidscan() + +
          +          scans the remote directory, + storing internally the included files, directories, ...
          +protected  voidscandir(java.lang.String dir, + java.lang.String vpath, + boolean fast) + +
          +          scans a particular directory.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ftp

          +
          +protected org.apache.commons.net.ftp.FTPClient ftp
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.FTPDirectoryScanner

          +
          +public FTP.FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp)
          +
          +
          constructor +

          +

          +
          Parameters:
          ftp - ftpclient object
          +
          + + + + + + + + +
          +Method Detail
          + +

          +scan

          +
          +public void scan()
          +
          +
          scans the remote directory, + storing internally the included files, directories, ... +

          +

          +
          Specified by:
          scan in interface FileScanner
          Overrides:
          scan in class DirectoryScanner
          +
          +
          +
          +
          +
          +
          + +

          +scandir

          +
          +protected void scandir(java.lang.String dir,
+                       java.lang.String vpath,
+                       boolean fast)
          +
          +
          scans a particular directory. populates the scannedDirs cache. +

          +

          +
          Parameters:
          dir - directory to scan
          vpath - relative path to the base directory of the remote fileset + always ended with a File.separator
          fast - seems to be always true in practice
          +
          +
          +
          + +

          +listFiles

          +
          +public org.apache.commons.net.ftp.FTPFile[] listFiles(java.lang.String directory,
+                                                      boolean changedir)
          +
          +
          list the files present in one directory. +

          +

          +
          Parameters:
          directory - full path on the remote side
          changedir - if true change to directory directory before listing +
          Returns:
          array of FTPFile
          +
          +
          +
          + +

          +listFiles

          +
          +public org.apache.commons.net.ftp.FTPFile[] listFiles(java.lang.String directory)
          +
          +
          cd into one directory and + list the files present in one directory. +

          +

          +
          Parameters:
          directory - full path on the remote side +
          Returns:
          array of FTPFile
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPFileProxy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPFileProxy.html new file mode 100644 index 000000000..5913a990a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPFileProxy.html @@ -0,0 +1,539 @@ + + + + + + +FTP.FTPFileProxy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.FTPFileProxy

          +
          +java.lang.Object
+  extended by java.io.File
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Comparable<java.io.File>
          +
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          protected static class FTP.FTPFileProxy
          extends java.io.File
          + + +

          +internal class providing a File-like interface to some of the information + available from the FTP server +

          + +

          +

          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.File
          pathSeparator, pathSeparatorChar, separator, separatorChar
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          FTP.FTPFileProxy(org.apache.commons.net.ftp.FTPFile file) + +
          +          creates a proxy to a FTP file
          FTP.FTPFileProxy(java.lang.String completePath) + +
          +          creates a proxy to a FTP directory
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexists() + +
          +           
          + java.lang.StringgetAbsolutePath() + +
          +           
          + java.lang.StringgetName() + +
          +           
          + java.lang.StringgetParent() + +
          +           
          + java.lang.StringgetPath() + +
          +           
          + booleanisAbsolute() + +
          +          FTP files are stored as absolute paths
          + booleanisDirectory() + +
          +           
          + booleanisFile() + +
          +           
          + booleanisHidden() + +
          +          FTP files cannot be hidden
          + longlastModified() + +
          +           
          + longlength() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.io.File
          canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, getAbsoluteFile, getCanonicalFile, getCanonicalPath, getParentFile, hashCode, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toString, toURI, toURL
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.FTPFileProxy

          +
          +public FTP.FTPFileProxy(org.apache.commons.net.ftp.FTPFile file)
          +
          +
          creates a proxy to a FTP file +

          +

          +
          Parameters:
          file -
          +
          +
          + +

          +FTP.FTPFileProxy

          +
          +public FTP.FTPFileProxy(java.lang.String completePath)
          +
          +
          creates a proxy to a FTP directory +

          +

          +
          Parameters:
          completePath - the remote directory.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +exists

          +
          +public boolean exists()
          +
          +
          +
          Overrides:
          exists in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          +
          Overrides:
          getAbsolutePath in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          +
          Overrides:
          getName in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getParent

          +
          +public java.lang.String getParent()
          +
          +
          +
          Overrides:
          getParent in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getPath

          +
          +public java.lang.String getPath()
          +
          +
          +
          Overrides:
          getPath in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isAbsolute

          +
          +public boolean isAbsolute()
          +
          +
          FTP files are stored as absolute paths +

          +

          +
          Overrides:
          isAbsolute in class java.io.File
          +
          +
          + +
          Returns:
          true
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          +
          Overrides:
          isDirectory in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isFile

          +
          +public boolean isFile()
          +
          +
          +
          Overrides:
          isFile in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isHidden

          +
          +public boolean isHidden()
          +
          +
          FTP files cannot be hidden +

          +

          +
          Overrides:
          isHidden in class java.io.File
          +
          +
          + +
          Returns:
          false
          +
          +
          +
          + +

          +lastModified

          +
          +public long lastModified()
          +
          +
          +
          Overrides:
          lastModified in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +length

          +
          +public long length()
          +
          +
          +
          Overrides:
          length in class java.io.File
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html new file mode 100644 index 000000000..9f038b22b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.FTPSystemType.html @@ -0,0 +1,289 @@ + + + + + + +FTP.FTPSystemType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.FTPSystemType

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.FTPSystemType
+
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          public static class FTP.FTPSystemType
          extends EnumeratedAttribute
          + + +

          +one of the valid system type keys recognized by the systemTypeKey + attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP.FTPSystemType() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Get the valid values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.FTPSystemType

          +
          +public FTP.FTPSystemType()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the list of valid system types.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html new file mode 100644 index 000000000..1c66dd28c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.Granularity.html @@ -0,0 +1,326 @@ + + + + + + +FTP.Granularity (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.Granularity

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.Granularity
+
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          public static class FTP.Granularity
          extends EnumeratedAttribute
          + + +

          +represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.

          + + A timestamp adjustment may be used in file transfers for checking + uptodateness. MINUTE means to add one minute to the server + timestamp. This is done because FTP servers typically list + timestamps HH:mm and client FileSystems typically use HH:mm:ss. + + The default is to use MINUTE for PUT actions and NONE for GET + actions, since GETs have the preserveLastModified + option, which takes care of the problem in most use cases where + this level of granularity is an issue. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP.Granularity() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + longgetMilliseconds(int action) + +
          +          returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter.
          + java.lang.String[]getValues() + +
          +          Get the valid values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.Granularity

          +
          +public FTP.Granularity()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the list of valid Granularity values
          +
          +
          +
          + +

          +getMilliseconds

          +
          +public long getMilliseconds(int action)
          +
          +
          returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter. +

          +

          +
          Parameters:
          action - SEND_FILES or GET_FILES +
          Returns:
          the number of milliseconds associated with + the attribute, in the context of the supplied action
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html new file mode 100644 index 000000000..846c22002 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.LanguageCode.html @@ -0,0 +1,288 @@ + + + + + + +FTP.LanguageCode (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP.LanguageCode

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTP.LanguageCode
+
          +
          +
          Enclosing class:
          FTP
          +
          +
          +
          +
          public static class FTP.LanguageCode
          extends EnumeratedAttribute
          + + +

          +Enumerated class for languages. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP.LanguageCode() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Return the value values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP.LanguageCode

          +
          +public FTP.LanguageCode()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Return the value values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the list of valid language types.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.html new file mode 100644 index 000000000..50b2e40b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTP.html @@ -0,0 +1,2151 @@ + + + + + + +FTP (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTP

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.net.FTP
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class FTP
          extends Task
          + + +

          +Basic FTP client. Performs the following actions: +

            +
          • send - send files to a remote server. This is the + default action.
            • +
          • get - retrieve files from a remote server.
            • +
          • del - delete files from a remote server.
            • +
          • list - create a file listing.
            • +
          • chmod - change unix file permissions.
            • +
          • rmdir - remove directories, if empty, from a + remote server.
            • +
          + Note: Some FTP servers - notably the Solaris server - seem + to hold data ports open after a "retr" operation, allowing them to timeout + instead of shutting them down cleanly. This happens in active or passive + mode, and the ports will remain open even after ending the FTP session. FTP + "send" operations seem to close ports immediately. This behavior may cause + problems on some systems when downloading large sets of files. +

          + +

          +

          +
          Since:
          +
          Ant 1.3
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classFTP.Action + +
          +          an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
          +protected  classFTP.FTPDirectoryScanner + +
          +          internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false
          +protected static classFTP.FTPFileProxy + +
          +          internal class providing a File-like interface to some of the information + available from the FTP server
          +static classFTP.FTPSystemType + +
          +          one of the valid system type keys recognized by the systemTypeKey + attribute.
          +static classFTP.Granularity + +
          +          represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
          +static classFTP.LanguageCode + +
          +          Enumerated class for languages.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static java.lang.String[]ACTION_STRS + +
          +           
          +protected static java.lang.String[]ACTION_TARGET_STRS + +
          +           
          +protected static intCHMOD + +
          +           
          +protected static java.lang.String[]COMPLETED_ACTION_STRS + +
          +           
          +static intDEFAULT_FTP_PORT + +
          +          Default port for FTP
          +protected static intDEL_FILES + +
          +           
          +protected static intGET_FILES + +
          +           
          +protected static intLIST_FILES + +
          +           
          +protected static intMK_DIR + +
          +           
          +protected static intRM_DIR + +
          +           
          +protected static intSEND_FILES + +
          +           
          +protected static intSITE_CMD + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FTP() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          A set of files to upload or download
          +protected  voidcheckAttributes() + +
          +          Checks to see that all required parameters are set.
          +protected  voidcreateParents(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String filename) + +
          +          Creates all parent directories specified in a complete relative + pathname.
          +protected  voiddelFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String filename) + +
          +          Delete a file from the remote host.
          +protected  voiddoSiteCommand(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String theCMD) + +
          +          Sends a site command to the ftp server
          + voidexecute() + +
          +          Runs the task.
          +protected  voidexecuteRetryable(RetryHandler h, + Retryable r, + java.lang.String descr) + +
          +          Executable a retryable object.
          + java.lang.StringgetDefaultDateFormatConfig() + +
          +           
          +protected  voidgetFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir, + java.lang.String filename) + +
          +          Retrieve a single file from the remote host.
          + java.lang.StringgetRecentDateFormatConfig() + +
          +           
          + java.lang.StringgetServerLanguageCodeConfig() + +
          +           
          + java.lang.StringgetServerTimeZoneConfig() + +
          +           
          + java.lang.StringgetShortMonthNamesConfig() + +
          +           
          + java.lang.StringgetSystemTypeKey() + +
          +           
          +protected  booleanisUpToDate(org.apache.commons.net.ftp.FTPClient ftp, + java.io.File localFile, + java.lang.String remoteFile) + +
          +          Checks to see if the remote file is current as compared with the local + file.
          +protected  voidlistFile(org.apache.commons.net.ftp.FTPClient ftp, + java.io.BufferedWriter bw, + java.lang.String filename) + +
          +          List information about a single file from the remote host.
          + voidlog(java.lang.String msg, + int level) + +
          +           
          +protected  voidmakeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir) + +
          +          Create the specified directory on the remote host.
          +protected  java.lang.StringresolveFile(java.lang.String file) + +
          +          Correct a file path to correspond to the remote host requirements.
          +protected  voidrmDir(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dirname) + +
          +          Delete a directory, if empty, from the remote host.
          +protected  voidsendFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir, + java.lang.String filename) + +
          +          Sends a single file to the remote host.
          + voidsetAccount(java.lang.String pAccount) + +
          +          Sets the login account to use on the specified server.
          + voidsetAction(FTP.Action action) + +
          +          Sets the FTP action to be taken.
          + voidsetAction(java.lang.String action) + +
          +          Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class.
          + voidsetBinary(boolean binary) + +
          +          If true, uses binary mode, otherwise text mode (default is binary).
          + voidsetChmod(java.lang.String theMode) + +
          +          Sets the file permission mode (Unix only) for files sent to the + server.
          + voidsetDefaultDateFormatConfig(java.lang.String defaultDateFormat) + +
          +          Sets the defaultDateFormatConfig attribute.
          + voidsetDepends(boolean depends) + +
          +          Set to true to transmit only files that are new or changed from their + remote counterparts.
          + voidsetEnableRemoteVerification(boolean b) + +
          +          Whether to verify that data and control connections are + connected to the same remote host.
          + voidsetIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors) + +
          +          set the flag to skip errors on directory creation.
          + voidsetInitialSiteCommand(java.lang.String initialCommand) + +
          +          Sets the initialSiteCommand attribute.
          + voidsetListing(java.io.File listing) + +
          +          The output file for the "list" action.
          + voidsetNewer(boolean newer) + +
          +          A synonym for depends.
          + voidsetPassive(boolean passive) + +
          +          Specifies whether to use passive mode.
          + voidsetPassword(java.lang.String password) + +
          +          Sets the login password for the given user id.
          + voidsetPort(int port) + +
          +          Sets the FTP port used by the remote server.
          + voidsetPreserveLastModified(boolean preserveLastModified) + +
          +          Set to true to preserve modification times for "gotten" files.
          + voidsetRecentDateFormatConfig(java.lang.String recentDateFormat) + +
          +          Sets the recentDateFormatConfig attribute.
          + voidsetRemotedir(java.lang.String dir) + +
          +          Sets the remote directory where files will be placed.
          + voidsetRetriesAllowed(java.lang.String retriesAllowed) + +
          +          Defines how many times to retry executing FTP command before giving up.
          + voidsetSeparator(java.lang.String separator) + +
          +          Sets the remote file separator character.
          + voidsetServer(java.lang.String server) + +
          +          Sets the FTP server to send files to.
          + voidsetServerLanguageCodeConfig(FTP.LanguageCode serverLanguageCode) + +
          +          Sets the serverLanguageCode attribute.
          + voidsetServerTimeZoneConfig(java.lang.String serverTimeZoneId) + +
          +          Sets the serverTimeZoneConfig attribute.
          + voidsetShortMonthNamesConfig(java.lang.String shortMonthNames) + +
          +          Sets the shortMonthNamesConfig attribute
          + voidsetSiteCommand(java.lang.String siteCommand) + +
          +          Sets the siteCommand attribute.
          + voidsetSkipFailedTransfers(boolean skipFailedTransfers) + +
          +          If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred.
          + voidsetSystemTypeKey(FTP.FTPSystemType systemKey) + +
          +          Sets the systemTypeKey attribute.
          + voidsetTimeDiffAuto(boolean timeDiffAuto) + +
          +          "true" to find out automatically the time difference + between local and remote machine.
          + voidsetTimeDiffMillis(long timeDiffMillis) + +
          +          number of milliseconds to add to the time on the remote machine + to get the time on the local machine.
          + voidsetTimestampGranularity(FTP.Granularity timestampGranularity) + +
          +          Sets the timestampGranularity attribute
          + voidsetUmask(java.lang.String theUmask) + +
          +          Sets the default mask for file creation on a unix server.
          + voidsetUserid(java.lang.String userid) + +
          +          Sets the login user id to use on the specified server.
          + voidsetVerbose(boolean verbose) + +
          +          Set to true to receive notification about each file as it is + transferred.
          +protected  voidtransferFiles(org.apache.commons.net.ftp.FTPClient ftp) + +
          +          Sends all files specified by the configured filesets to the remote + server.
          +protected  inttransferFiles(org.apache.commons.net.ftp.FTPClient ftp, + FileSet fs) + +
          +          For each file in the fileset, do the appropriate action: send, get, + delete, or list.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +SEND_FILES

          +
          +protected static final int SEND_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GET_FILES

          +
          +protected static final int GET_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEL_FILES

          +
          +protected static final int DEL_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LIST_FILES

          +
          +protected static final int LIST_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MK_DIR

          +
          +protected static final int MK_DIR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CHMOD

          +
          +protected static final int CHMOD
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RM_DIR

          +
          +protected static final int RM_DIR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SITE_CMD

          +
          +protected static final int SITE_CMD
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FTP_PORT

          +
          +public static final int DEFAULT_FTP_PORT
          +
          +
          Default port for FTP +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_STRS

          +
          +protected static final java.lang.String[] ACTION_STRS
          +
          +
          +
          +
          +
          + +

          +COMPLETED_ACTION_STRS

          +
          +protected static final java.lang.String[] COMPLETED_ACTION_STRS
          +
          +
          +
          +
          +
          + +

          +ACTION_TARGET_STRS

          +
          +protected static final java.lang.String[] ACTION_TARGET_STRS
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FTP

          +
          +public FTP()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRemotedir

          +
          +public void setRemotedir(java.lang.String dir)
          +
          +
          Sets the remote directory where files will be placed. This may be a + relative or absolute path, and must be in the path syntax expected by + the remote server. No correction of path syntax will be performed. +

          +

          +
          +
          +
          +
          Parameters:
          dir - the remote directory name.
          +
          +
          +
          + +

          +setServer

          +
          +public void setServer(java.lang.String server)
          +
          +
          Sets the FTP server to send files to. +

          +

          +
          +
          +
          +
          Parameters:
          server - the remote server name.
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(int port)
          +
          +
          Sets the FTP port used by the remote server. +

          +

          +
          +
          +
          +
          Parameters:
          port - the port on which the remote server is listening.
          +
          +
          +
          + +

          +setUserid

          +
          +public void setUserid(java.lang.String userid)
          +
          +
          Sets the login user id to use on the specified server. +

          +

          +
          +
          +
          +
          Parameters:
          userid - remote system userid.
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          Sets the login password for the given user id. +

          +

          +
          +
          +
          +
          Parameters:
          password - the password on the remote system.
          +
          +
          +
          + +

          +setAccount

          +
          +public void setAccount(java.lang.String pAccount)
          +
          +
          Sets the login account to use on the specified server. +

          +

          +
          +
          +
          +
          Parameters:
          pAccount - the account name on remote system
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setBinary

          +
          +public void setBinary(boolean binary)
          +
          +
          If true, uses binary mode, otherwise text mode (default is binary). +

          +

          +
          +
          +
          +
          Parameters:
          binary - if true use binary mode in transfers.
          +
          +
          +
          + +

          +setPassive

          +
          +public void setPassive(boolean passive)
          +
          +
          Specifies whether to use passive mode. Set to true if you are behind a + firewall and cannot connect without it. Passive mode is disabled by + default. +

          +

          +
          +
          +
          +
          Parameters:
          passive - true is passive mode should be used.
          +
          +
          +
          + +

          +setVerbose

          +
          +public void setVerbose(boolean verbose)
          +
          +
          Set to true to receive notification about each file as it is + transferred. +

          +

          +
          +
          +
          +
          Parameters:
          verbose - true if verbose notifications are required.
          +
          +
          +
          + +

          +setNewer

          +
          +public void setNewer(boolean newer)
          +
          +
          A synonym for depends. Set to true to transmit only new + or changed files. + + See the related attributes timediffmillis and timediffauto. +

          +

          +
          +
          +
          +
          Parameters:
          newer - if true only transfer newer files.
          +
          +
          +
          + +

          +setTimeDiffMillis

          +
          +public void setTimeDiffMillis(long timeDiffMillis)
          +
          +
          number of milliseconds to add to the time on the remote machine + to get the time on the local machine. + + use in conjunction with newer +

          +

          +
          +
          +
          +
          Parameters:
          timeDiffMillis - number of milliseconds
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +setTimeDiffAuto

          +
          +public void setTimeDiffAuto(boolean timeDiffAuto)
          +
          +
          "true" to find out automatically the time difference + between local and remote machine. + + This requires right to create + and delete a temporary file in the remote directory. +

          +

          +
          +
          +
          +
          Parameters:
          timeDiffAuto - true = find automatically the time diff
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +setPreserveLastModified

          +
          +public void setPreserveLastModified(boolean preserveLastModified)
          +
          +
          Set to true to preserve modification times for "gotten" files. +

          +

          +
          +
          +
          +
          Parameters:
          preserveLastModified - if true preserver modification times.
          +
          +
          +
          + +

          +setDepends

          +
          +public void setDepends(boolean depends)
          +
          +
          Set to true to transmit only files that are new or changed from their + remote counterparts. The default is to transmit all files. +

          +

          +
          +
          +
          +
          Parameters:
          depends - if true only transfer newer files.
          +
          +
          +
          + +

          +setSeparator

          +
          +public void setSeparator(java.lang.String separator)
          +
          +
          Sets the remote file separator character. This normally defaults to the + Unix standard forward slash, but can be manually overridden using this + call if the remote server requires some other separator. Only the first + character of the string is used. +

          +

          +
          +
          +
          +
          Parameters:
          separator - the file separator on the remote system.
          +
          +
          +
          + +

          +setChmod

          +
          +public void setChmod(java.lang.String theMode)
          +
          +
          Sets the file permission mode (Unix only) for files sent to the + server. +

          +

          +
          +
          +
          +
          Parameters:
          theMode - unix style file mode for the files sent to the remote + system.
          +
          +
          +
          + +

          +setUmask

          +
          +public void setUmask(java.lang.String theUmask)
          +
          +
          Sets the default mask for file creation on a unix server. +

          +

          +
          +
          +
          +
          Parameters:
          theUmask - unix style umask for files created on the remote server.
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          A set of files to upload or download +

          +

          +
          +
          +
          +
          Parameters:
          set - the set of files to be added to the list of files to be + transferred.
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(java.lang.String action)
+               throws BuildException
          +
          +
          Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. +

          +

          Sets the FTP action to be taken. Currently accepts "put", "get", "del", + "mkdir", "chmod", "list", and "site". +

          +

          +
          +
          +
          +
          Parameters:
          action - the FTP action to be performed. +
          Throws: +
          BuildException - if the action is not a valid action.
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(FTP.Action action)
+               throws BuildException
          +
          +
          Sets the FTP action to be taken. Currently accepts "put", "get", "del", + "mkdir", "chmod", "list", and "site". +

          +

          +
          +
          +
          +
          Parameters:
          action - the FTP action to be performed. +
          Throws: +
          BuildException - if the action is not a valid action.
          +
          +
          +
          + +

          +setListing

          +
          +public void setListing(java.io.File listing)
          +
          +
          The output file for the "list" action. This attribute is ignored for + any other actions. +

          +

          +
          +
          +
          +
          Parameters:
          listing - file in which to store the listing.
          +
          +
          +
          + +

          +setSkipFailedTransfers

          +
          +public void setSkipFailedTransfers(boolean skipFailedTransfers)
          +
          +
          If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred. +

          +

          +
          +
          +
          +
          Parameters:
          skipFailedTransfers - true if failures in transfers are ignored.
          +
          +
          +
          + +

          +setIgnoreNoncriticalErrors

          +
          +public void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)
          +
          +
          set the flag to skip errors on directory creation. + (and maybe later other server specific errors) +

          +

          +
          +
          +
          +
          Parameters:
          ignoreNoncriticalErrors - true if non-critical errors should not + cause a failure.
          +
          +
          +
          + +

          +setSystemTypeKey

          +
          +public void setSystemTypeKey(FTP.FTPSystemType systemKey)
          +
          +
          Sets the systemTypeKey attribute. + Method for setting FTPClientConfig remote system key. +

          +

          +
          +
          +
          +
          Parameters:
          systemKey - the key to be set - BUT if blank + the default value of null (which signifies "autodetect") will be kept.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setDefaultDateFormatConfig

          +
          +public void setDefaultDateFormatConfig(java.lang.String defaultDateFormat)
          +
          +
          Sets the defaultDateFormatConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          defaultDateFormat - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setRecentDateFormatConfig

          +
          +public void setRecentDateFormatConfig(java.lang.String recentDateFormat)
          +
          +
          Sets the recentDateFormatConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          recentDateFormat - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setServerLanguageCodeConfig

          +
          +public void setServerLanguageCodeConfig(FTP.LanguageCode serverLanguageCode)
          +
          +
          Sets the serverLanguageCode attribute. +

          +

          +
          +
          +
          +
          Parameters:
          serverLanguageCode - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setServerTimeZoneConfig

          +
          +public void setServerTimeZoneConfig(java.lang.String serverTimeZoneId)
          +
          +
          Sets the serverTimeZoneConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          serverTimeZoneId - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setShortMonthNamesConfig

          +
          +public void setShortMonthNamesConfig(java.lang.String shortMonthNames)
          +
          +
          Sets the shortMonthNamesConfig attribute +

          +

          +
          +
          +
          +
          Parameters:
          shortMonthNames - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setRetriesAllowed

          +
          +public void setRetriesAllowed(java.lang.String retriesAllowed)
          +
          +
          Defines how many times to retry executing FTP command before giving up. + Default is 0 - try once and if failure then give up. +

          +

          +
          +
          +
          +
          Parameters:
          retriesAllowed - number of retries to allow. -1 means + keep trying forever. "forever" may also be specified as a + synonym for -1.
          +
          +
          +
          + +

          +getSystemTypeKey

          +
          +public java.lang.String getSystemTypeKey()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the systemTypeKey.
          +
          +
          +
          + +

          +getDefaultDateFormatConfig

          +
          +public java.lang.String getDefaultDateFormatConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the defaultDateFormatConfig.
          +
          +
          +
          + +

          +getRecentDateFormatConfig

          +
          +public java.lang.String getRecentDateFormatConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the recentDateFormatConfig.
          +
          +
          +
          + +

          +getServerLanguageCodeConfig

          +
          +public java.lang.String getServerLanguageCodeConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the serverLanguageCodeConfig.
          +
          +
          +
          + +

          +getServerTimeZoneConfig

          +
          +public java.lang.String getServerTimeZoneConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the serverTimeZoneConfig.
          +
          +
          +
          + +

          +getShortMonthNamesConfig

          +
          +public java.lang.String getShortMonthNamesConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the shortMonthNamesConfig.
          +
          +
          +
          + +

          +setTimestampGranularity

          +
          +public void setTimestampGranularity(FTP.Granularity timestampGranularity)
          +
          +
          Sets the timestampGranularity attribute +

          +

          +
          +
          +
          +
          Parameters:
          timestampGranularity - The timestampGranularity to set.
          +
          +
          +
          + +

          +setSiteCommand

          +
          +public void setSiteCommand(java.lang.String siteCommand)
          +
          +
          Sets the siteCommand attribute. This attribute + names the command that will be executed if the action + is "site". +

          +

          +
          +
          +
          +
          Parameters:
          siteCommand - The siteCommand to set.
          +
          +
          +
          + +

          +setInitialSiteCommand

          +
          +public void setInitialSiteCommand(java.lang.String initialCommand)
          +
          +
          Sets the initialSiteCommand attribute. This attribute + names a site command that will be executed immediately + after connection. +

          +

          +
          +
          +
          +
          Parameters:
          initialCommand - The initialSiteCommand to set.
          +
          +
          +
          + +

          +setEnableRemoteVerification

          +
          +public void setEnableRemoteVerification(boolean b)
          +
          +
          Whether to verify that data and control connections are + connected to the same remote host. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +checkAttributes

          +
          +protected void checkAttributes()
+                        throws BuildException
          +
          +
          Checks to see that all required parameters are set. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if the configuration is not valid.
          +
          +
          +
          + +

          +executeRetryable

          +
          +protected void executeRetryable(RetryHandler h,
+                                Retryable r,
+                                java.lang.String descr)
+                         throws java.io.IOException
          +
          +
          Executable a retryable object. +

          +

          +
          +
          +
          +
          Parameters:
          h - the retry hander.
          r - the object that should be retried until it succeeds + or the number of retrys is reached.
          descr - a description of the command that is being run. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +transferFiles

          +
          +protected int transferFiles(org.apache.commons.net.ftp.FTPClient ftp,
+                            FileSet fs)
+                     throws java.io.IOException,
+                            BuildException
          +
          +
          For each file in the fileset, do the appropriate action: send, get, + delete, or list. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTPClient instance used to perform FTP actions
          fs - the fileset on which the actions are performed. +
          Returns:
          the number of files to be transferred. +
          Throws: +
          java.io.IOException - if there is a problem reading a file +
          BuildException - if there is a problem in the configuration.
          +
          +
          +
          + +

          +transferFiles

          +
          +protected void transferFiles(org.apache.commons.net.ftp.FTPClient ftp)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Sends all files specified by the configured filesets to the remote + server. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTPClient instance used to perform FTP actions +
          Throws: +
          java.io.IOException - if there is a problem reading a file +
          BuildException - if there is a problem in the configuration.
          +
          +
          +
          + +

          +resolveFile

          +
          +protected java.lang.String resolveFile(java.lang.String file)
          +
          +
          Correct a file path to correspond to the remote host requirements. This + implementation currently assumes that the remote end can handle + Unix-style paths with forward-slash separators. This can be overridden + with the separator task parameter. No attempt is made to + determine what syntax is appropriate for the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          file - the remote file name to be resolved +
          Returns:
          the filename as it will appear on the server.
          +
          +
          +
          + +

          +createParents

          +
          +protected void createParents(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String filename)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Creates all parent directories specified in a complete relative + pathname. Attempts to create existing directories will not cause + errors. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTP client instance to use to execute FTP actions on + the remote server.
          filename - the name of the file whose parents should be created. +
          Throws: +
          java.io.IOException - under non documented circumstances +
          BuildException - if it is impossible to cd to a remote directory
          +
          +
          +
          + +

          +isUpToDate

          +
          +protected boolean isUpToDate(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.io.File localFile,
+                             java.lang.String remoteFile)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Checks to see if the remote file is current as compared with the local + file. Returns true if the target file is up to date. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftpclient
          localFile - local file
          remoteFile - remote file +
          Returns:
          true if the target file is up to date +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if the date of the remote files cannot be found and the action is + GET_FILES
          +
          +
          +
          + +

          +doSiteCommand

          +
          +protected void doSiteCommand(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String theCMD)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Sends a site command to the ftp server +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          theCMD - command to execute +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +sendFile

          +
          +protected void sendFile(org.apache.commons.net.ftp.FTPClient ftp,
+                        java.lang.String dir,
+                        java.lang.String filename)
+                 throws java.io.IOException,
+                        BuildException
          +
          +
          Sends a single file to the remote host. filename may + contain a relative path specification. When this is the case, sendFile + will attempt to create any necessary parent directories before sending + the file. The file will then be sent using the entire relative path + spec - no attempt is made to change directories. It is anticipated that + this may eventually cause problems with some FTP servers, but it + simplifies the coding. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          dir - base directory of the file to be sent (local)
          filename - relative path of the file to be send + locally relative to dir + remotely relative to the remotedir attribute +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +delFile

          +
          +protected void delFile(org.apache.commons.net.ftp.FTPClient ftp,
+                       java.lang.String filename)
+                throws java.io.IOException,
+                       BuildException
          +
          +
          Delete a file from the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          filename - file to delete +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is set to false + and the deletion could not be done
          +
          +
          +
          + +

          +rmDir

          +
          +protected void rmDir(org.apache.commons.net.ftp.FTPClient ftp,
+                     java.lang.String dirname)
+              throws java.io.IOException,
+                     BuildException
          +
          +
          Delete a directory, if empty, from the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          dirname - directory to delete +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is set to false + and the deletion could not be done
          +
          +
          +
          + +

          +getFile

          +
          +protected void getFile(org.apache.commons.net.ftp.FTPClient ftp,
+                       java.lang.String dir,
+                       java.lang.String filename)
+                throws java.io.IOException,
+                       BuildException
          +
          +
          Retrieve a single file from the remote host. filename may + contain a relative path specification.

          + + The file will then be retreived using the entire relative path spec - + no attempt is made to change directories. It is anticipated that this + may eventually cause problems with some FTP servers, but it simplifies + the coding.

          +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the ftp client
          dir - local base directory to which the file should go back
          filename - relative path of the file based upon the ftp remote directory + and/or the local base directory (dir) +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is false + and the file cannot be retrieved.
          +
          +
          +
          + +

          +listFile

          +
          +protected void listFile(org.apache.commons.net.ftp.FTPClient ftp,
+                        java.io.BufferedWriter bw,
+                        java.lang.String filename)
+                 throws java.io.IOException,
+                        BuildException
          +
          +
          List information about a single file from the remote host. filename + may contain a relative path specification.

          + + The file listing will then be retrieved using the entire relative path + spec - no attempt is made to change directories. It is anticipated that + this may eventually cause problems with some FTP servers, but it + simplifies the coding.

          +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          bw - buffered writer
          filename - the directory one wants to list +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +makeRemoteDir

          +
          +protected void makeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String dir)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Create the specified directory on the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - The FTP client connection
          dir - The directory to create (format must be correct for host + type) +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if ignoreNoncriticalErrors has not been set to true + and a directory could not be created, for instance because it was + already existing. Precisely, the codes 521, 550 and 553 will trigger + a BuildException
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Runs the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the task fails or is not configured + correctly.
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String msg,
+                int level)
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Action.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Action.html new file mode 100644 index 000000000..e28f02481 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Action.html @@ -0,0 +1,312 @@ + + + + + + +FTPTask.Action (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTask.Action

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTask.Action
+
          +
          +
          Enclosing class:
          FTPTask
          +
          +
          +
          +
          public static class FTPTask.Action
          extends EnumeratedAttribute
          + + +

          +an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir" +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTask.Action() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetAction() + +
          +          Get the symbolic equivalent of the action value.
          + java.lang.String[]getValues() + +
          +          Get the valid values
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTask.Action

          +
          +public FTPTask.Action()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array of the valid FTP actions.
          +
          +
          +
          + +

          +getAction

          +
          +public int getAction()
          +
          +
          Get the symbolic equivalent of the action value. +

          +

          + +
          Returns:
          the SYMBOL representing the given action.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.FTPSystemType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.FTPSystemType.html new file mode 100644 index 000000000..907223a25 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.FTPSystemType.html @@ -0,0 +1,289 @@ + + + + + + +FTPTask.FTPSystemType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTask.FTPSystemType

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTask.FTPSystemType
+
          +
          +
          Enclosing class:
          FTPTask
          +
          +
          +
          +
          public static class FTPTask.FTPSystemType
          extends EnumeratedAttribute
          + + +

          +one of the valid system type keys recognized by the systemTypeKey + attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTask.FTPSystemType() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Get the valid values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTask.FTPSystemType

          +
          +public FTPTask.FTPSystemType()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the list of valid system types.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Granularity.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Granularity.html new file mode 100644 index 000000000..2ae9e6d44 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.Granularity.html @@ -0,0 +1,326 @@ + + + + + + +FTPTask.Granularity (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTask.Granularity

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTask.Granularity
+
          +
          +
          Enclosing class:
          FTPTask
          +
          +
          +
          +
          public static class FTPTask.Granularity
          extends EnumeratedAttribute
          + + +

          +represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.

          + + A timestamp adjustment may be used in file transfers for checking + uptodateness. MINUTE means to add one minute to the server + timestamp. This is done because FTP servers typically list + timestamps HH:mm and client FileSystems typically use HH:mm:ss. + + The default is to use MINUTE for PUT actions and NONE for GET + actions, since GETs have the preserveLastModified + option, which takes care of the problem in most use cases where + this level of granularity is an issue. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTask.Granularity() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + longgetMilliseconds(int action) + +
          +          returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter.
          + java.lang.String[]getValues() + +
          +          Get the valid values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTask.Granularity

          +
          +public FTPTask.Granularity()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Get the valid values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the list of valid Granularity values
          +
          +
          +
          + +

          +getMilliseconds

          +
          +public long getMilliseconds(int action)
          +
          +
          returns the number of milliseconds associated with + the attribute, which can vary in some cases depending + on the value of the action parameter. +

          +

          +
          Parameters:
          action - SEND_FILES or GET_FILES +
          Returns:
          the number of milliseconds associated with + the attribute, in the context of the supplied action
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.html new file mode 100644 index 000000000..1d998bdaf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTask.html @@ -0,0 +1,2355 @@ + + + + + + +FTPTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.net.FTPTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class FTPTask
          extends Task
          + + +

          +Basic FTP client. Performs the following actions: +

            +
          • send - send files to a remote server. This is the + default action.
            • +
          • get - retrieve files from a remote server.
            • +
          • del - delete files from a remote server.
            • +
          • list - create a file listing.
            • +
          • chmod - change unix file permissions.
            • +
          • rmdir - remove directories, if empty, from a + remote server.
            • +
          + Note: Some FTP servers - notably the Solaris server - seem + to hold data ports open after a "retr" operation, allowing them to timeout + instead of shutting them down cleanly. This happens in active or passive + mode, and the ports will remain open even after ending the FTP session. FTP + "send" operations seem to close ports immediately. This behavior may cause + problems on some systems when downloading large sets of files. +

          + +

          +

          +
          Since:
          +
          Ant 1.3
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classFTPTask.Action + +
          +          an action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
          +static classFTPTask.FTPSystemType + +
          +          one of the valid system type keys recognized by the systemTypeKey + attribute.
          +static classFTPTask.Granularity + +
          +          represents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.String[]ACTION_STRS + +
          +           
          +static java.lang.String[]ACTION_TARGET_STRS + +
          +           
          +static intCHMOD + +
          +           
          +static java.lang.String[]COMPLETED_ACTION_STRS + +
          +           
          +static intDEFAULT_FTP_PORT + +
          +          Default port for FTP
          +static intDEL_FILES + +
          +           
          +static intGET_FILES + +
          +           
          +static intLIST_FILES + +
          +           
          +static intMK_DIR + +
          +           
          +static intRM_DIR + +
          +           
          +static intSEND_FILES + +
          +           
          +static intSITE_CMD + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          A set of files to upload or download
          +protected  voidcheckAttributes() + +
          +          Checks to see that all required parameters are set.
          + PathcreateClasspath() + +
          +           
          + voidexecute() + +
          +          Runs the task.
          + java.lang.StringgetAccount() + +
          +           
          + intgetAction() + +
          +           
          + java.lang.StringgetChmod() + +
          +           
          + java.lang.StringgetDefaultDateFormatConfig() + +
          +           
          + booleangetEnableRemoteVerification() + +
          +           
          + java.util.VectorgetFilesets() + +
          +           
          + longgetGranularityMillis() + +
          +           
          + java.lang.StringgetInitialSiteCommand() + +
          +           
          + java.io.FilegetListing() + +
          +           
          + java.lang.StringgetPassword() + +
          +           
          + intgetPort() + +
          +           
          + java.lang.StringgetRecentDateFormatConfig() + +
          +           
          + java.lang.StringgetRemotedir() + +
          +           
          + intgetRetriesAllowed() + +
          +           
          + java.lang.StringgetSeparator() + +
          +           
          + java.lang.StringgetServer() + +
          +           
          + java.lang.StringgetServerLanguageCodeConfig() + +
          +           
          + java.lang.StringgetServerTimeZoneConfig() + +
          +           
          + java.lang.StringgetShortMonthNamesConfig() + +
          +           
          + java.lang.StringgetSiteCommand() + +
          +           
          + java.lang.StringgetSystemTypeKey() + +
          +           
          + longgetTimeDiffMillis() + +
          +           
          + FTPTask.GranularitygetTimestampGranularity() + +
          +           
          + java.lang.StringgetUmask() + +
          +           
          + java.lang.StringgetUserid() + +
          +           
          + booleanisBinary() + +
          +           
          + booleanisConfigurationSet() + +
          +           
          + booleanisIgnoreNoncriticalErrors() + +
          +           
          + booleanisNewer() + +
          +           
          + booleanisPassive() + +
          +           
          + booleanisPreserveLastModified() + +
          +           
          + booleanisSkipFailedTransfers() + +
          +           
          + booleanisTimeDiffAuto() + +
          +           
          + booleanisVerbose() + +
          +           
          + voidlog(java.lang.String msg, + int level) + +
          +           
          + voidsetAccount(java.lang.String pAccount) + +
          +          Sets the login account to use on the specified server.
          + voidsetAction(FTPTask.Action action) + +
          +          Sets the FTP action to be taken.
          + voidsetAction(java.lang.String action) + +
          +          Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class.
          + voidsetBinary(boolean binary) + +
          +          If true, uses binary mode, otherwise text mode (default is binary).
          + voidsetChmod(java.lang.String theMode) + +
          +          Sets the file permission mode (Unix only) for files sent to the + server.
          + voidsetDefaultDateFormatConfig(java.lang.String defaultDateFormat) + +
          +          Sets the defaultDateFormatConfig attribute.
          + voidsetDepends(boolean depends) + +
          +          Set to true to transmit only files that are new or changed from their + remote counterparts.
          + voidsetEnableRemoteVerification(boolean b) + +
          +          Whether to verify that data and control connections are + connected to the same remote host.
          + voidsetGranularityMillis(long granularity) + +
          +           
          + voidsetIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors) + +
          +          set the flag to skip errors on directory creation.
          + voidsetInitialSiteCommand(java.lang.String initialCommand) + +
          +          Sets the initialSiteCommand attribute.
          + voidsetListing(java.io.File listing) + +
          +          The output file for the "list" action.
          + voidsetNewer(boolean newer) + +
          +          A synonym for depends.
          + voidsetPassive(boolean passive) + +
          +          Specifies whether to use passive mode.
          + voidsetPassword(java.lang.String password) + +
          +          Sets the login password for the given user id.
          + voidsetPort(int port) + +
          +          Sets the FTP port used by the remote server.
          + voidsetPreserveLastModified(boolean preserveLastModified) + +
          +          Set to true to preserve modification times for "gotten" files.
          + voidsetRecentDateFormatConfig(java.lang.String recentDateFormat) + +
          +          Sets the recentDateFormatConfig attribute.
          + voidsetRemotedir(java.lang.String dir) + +
          +          Sets the remote directory where files will be placed.
          + voidsetRetriesAllowed(java.lang.String retriesAllowed) + +
          +          Defines how many times to retry executing FTP command before giving up.
          + voidsetSeparator(java.lang.String separator) + +
          +          Sets the remote file separator character.
          + voidsetServer(java.lang.String server) + +
          +          Sets the FTP server to send files to.
          + voidsetServerLanguageCodeConfig(java.lang.String serverLanguageCode) + +
          +          Sets the serverLanguageCode attribute.
          + voidsetServerTimeZoneConfig(java.lang.String serverTimeZoneId) + +
          +          Sets the serverTimeZoneConfig attribute.
          + voidsetShortMonthNamesConfig(java.lang.String shortMonthNames) + +
          +          Sets the shortMonthNamesConfig attribute
          + voidsetSiteCommand(java.lang.String siteCommand) + +
          +          Sets the siteCommand attribute.
          + voidsetSkipFailedTransfers(boolean skipFailedTransfers) + +
          +          If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred.
          + voidsetSystemTypeKey(FTPTask.FTPSystemType systemKey) + +
          +          Sets the systemTypeKey attribute.
          + voidsetTimeDiffAuto(boolean timeDiffAuto) + +
          +          "true" to find out automatically the time difference + between local and remote machine.
          + voidsetTimeDiffMillis(long timeDiffMillis) + +
          +          number of milliseconds to add to the time on the remote machine + to get the time on the local machine.
          + voidsetTimestampGranularity(FTPTask.Granularity timestampGranularity) + +
          +          Sets the timestampGranularity attribute
          + voidsetUmask(java.lang.String theUmask) + +
          +          Sets the default mask for file creation on a unix server.
          +protected  voidsetupFTPDelegate() + +
          +           
          + voidsetUserid(java.lang.String userid) + +
          +          Sets the login user id to use on the specified server.
          + voidsetVerbose(boolean verbose) + +
          +          Set to true to receive notification about each file as it is + transferred.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +SEND_FILES

          +
          +public static final int SEND_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GET_FILES

          +
          +public static final int GET_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEL_FILES

          +
          +public static final int DEL_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LIST_FILES

          +
          +public static final int LIST_FILES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MK_DIR

          +
          +public static final int MK_DIR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CHMOD

          +
          +public static final int CHMOD
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RM_DIR

          +
          +public static final int RM_DIR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SITE_CMD

          +
          +public static final int SITE_CMD
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FTP_PORT

          +
          +public static final int DEFAULT_FTP_PORT
          +
          +
          Default port for FTP +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ACTION_STRS

          +
          +public static final java.lang.String[] ACTION_STRS
          +
          +
          +
          +
          +
          + +

          +COMPLETED_ACTION_STRS

          +
          +public static final java.lang.String[] COMPLETED_ACTION_STRS
          +
          +
          +
          +
          +
          + +

          +ACTION_TARGET_STRS

          +
          +public static final java.lang.String[] ACTION_TARGET_STRS
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTask

          +
          +public FTPTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRemotedir

          +
          +public void setRemotedir(java.lang.String dir)
          +
          +
          Sets the remote directory where files will be placed. This may be a + relative or absolute path, and must be in the path syntax expected by + the remote server. No correction of path syntax will be performed. +

          +

          +
          +
          +
          +
          Parameters:
          dir - the remote directory name.
          +
          +
          +
          + +

          +getRemotedir

          +
          +public java.lang.String getRemotedir()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setServer

          +
          +public void setServer(java.lang.String server)
          +
          +
          Sets the FTP server to send files to. +

          +

          +
          +
          +
          +
          Parameters:
          server - the remote server name.
          +
          +
          +
          + +

          +getServer

          +
          +public java.lang.String getServer()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(int port)
          +
          +
          Sets the FTP port used by the remote server. +

          +

          +
          +
          +
          +
          Parameters:
          port - the port on which the remote server is listening.
          +
          +
          +
          + +

          +getPort

          +
          +public int getPort()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setUserid

          +
          +public void setUserid(java.lang.String userid)
          +
          +
          Sets the login user id to use on the specified server. +

          +

          +
          +
          +
          +
          Parameters:
          userid - remote system userid.
          +
          +
          +
          + +

          +getUserid

          +
          +public java.lang.String getUserid()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          Sets the login password for the given user id. +

          +

          +
          +
          +
          +
          Parameters:
          password - the password on the remote system.
          +
          +
          +
          + +

          +getPassword

          +
          +public java.lang.String getPassword()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setAccount

          +
          +public void setAccount(java.lang.String pAccount)
          +
          +
          Sets the login account to use on the specified server. +

          +

          +
          +
          +
          +
          Parameters:
          pAccount - the account name on remote system
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getAccount

          +
          +public java.lang.String getAccount()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setBinary

          +
          +public void setBinary(boolean binary)
          +
          +
          If true, uses binary mode, otherwise text mode (default is binary). +

          +

          +
          +
          +
          +
          Parameters:
          binary - if true use binary mode in transfers.
          +
          +
          +
          + +

          +isBinary

          +
          +public boolean isBinary()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setPassive

          +
          +public void setPassive(boolean passive)
          +
          +
          Specifies whether to use passive mode. Set to true if you are behind a + firewall and cannot connect without it. Passive mode is disabled by + default. +

          +

          +
          +
          +
          +
          Parameters:
          passive - true is passive mode should be used.
          +
          +
          +
          + +

          +isPassive

          +
          +public boolean isPassive()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setVerbose

          +
          +public void setVerbose(boolean verbose)
          +
          +
          Set to true to receive notification about each file as it is + transferred. +

          +

          +
          +
          +
          +
          Parameters:
          verbose - true if verbose notifications are required.
          +
          +
          +
          + +

          +isVerbose

          +
          +public boolean isVerbose()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setNewer

          +
          +public void setNewer(boolean newer)
          +
          +
          A synonym for depends. Set to true to transmit only new + or changed files. + + See the related attributes timediffmillis and timediffauto. +

          +

          +
          +
          +
          +
          Parameters:
          newer - if true only transfer newer files.
          +
          +
          +
          + +

          +isNewer

          +
          +public boolean isNewer()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setTimeDiffMillis

          +
          +public void setTimeDiffMillis(long timeDiffMillis)
          +
          +
          number of milliseconds to add to the time on the remote machine + to get the time on the local machine. + + use in conjunction with newer +

          +

          +
          +
          +
          +
          Parameters:
          timeDiffMillis - number of milliseconds
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +getTimeDiffMillis

          +
          +public long getTimeDiffMillis()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setTimeDiffAuto

          +
          +public void setTimeDiffAuto(boolean timeDiffAuto)
          +
          +
          "true" to find out automatically the time difference + between local and remote machine. + + This requires right to create + and delete a temporary file in the remote directory. +

          +

          +
          +
          +
          +
          Parameters:
          timeDiffAuto - true = find automatically the time diff
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +isTimeDiffAuto

          +
          +public boolean isTimeDiffAuto()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setPreserveLastModified

          +
          +public void setPreserveLastModified(boolean preserveLastModified)
          +
          +
          Set to true to preserve modification times for "gotten" files. +

          +

          +
          +
          +
          +
          Parameters:
          preserveLastModified - if true preserver modification times.
          +
          +
          +
          + +

          +isPreserveLastModified

          +
          +public boolean isPreserveLastModified()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setDepends

          +
          +public void setDepends(boolean depends)
          +
          +
          Set to true to transmit only files that are new or changed from their + remote counterparts. The default is to transmit all files. +

          +

          +
          +
          +
          +
          Parameters:
          depends - if true only transfer newer files.
          +
          +
          +
          + +

          +setSeparator

          +
          +public void setSeparator(java.lang.String separator)
          +
          +
          Sets the remote file separator character. This normally defaults to the + Unix standard forward slash, but can be manually overridden using this + call if the remote server requires some other separator. Only the first + character of the string is used. +

          +

          +
          +
          +
          +
          Parameters:
          separator - the file separator on the remote system.
          +
          +
          +
          + +

          +getSeparator

          +
          +public java.lang.String getSeparator()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setChmod

          +
          +public void setChmod(java.lang.String theMode)
          +
          +
          Sets the file permission mode (Unix only) for files sent to the + server. +

          +

          +
          +
          +
          +
          Parameters:
          theMode - unix style file mode for the files sent to the remote + system.
          +
          +
          +
          + +

          +getChmod

          +
          +public java.lang.String getChmod()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setUmask

          +
          +public void setUmask(java.lang.String theUmask)
          +
          +
          Sets the default mask for file creation on a unix server. +

          +

          +
          +
          +
          +
          Parameters:
          theUmask - unix style umask for files created on the remote server.
          +
          +
          +
          + +

          +getUmask

          +
          +public java.lang.String getUmask()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          A set of files to upload or download +

          +

          +
          +
          +
          +
          Parameters:
          set - the set of files to be added to the list of files to be + transferred.
          +
          +
          +
          + +

          +getFilesets

          +
          +public java.util.Vector getFilesets()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(java.lang.String action)
+               throws BuildException
          +
          +
          Deprecated. since 1.5.x. + setAction(String) is deprecated and is replaced with + setAction(FTP.Action) to make Ant's Introspection mechanism do the + work and also to encapsulate operations on the type in its own + class. +

          +

          Sets the FTP action to be taken. Currently accepts "put", "get", "del", + "mkdir", "chmod", "list", and "site". +

          +

          +
          +
          +
          +
          Parameters:
          action - the FTP action to be performed. +
          Throws: +
          BuildException - if the action is not a valid action.
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(FTPTask.Action action)
+               throws BuildException
          +
          +
          Sets the FTP action to be taken. Currently accepts "put", "get", "del", + "mkdir", "chmod", "list", and "site". +

          +

          +
          +
          +
          +
          Parameters:
          action - the FTP action to be performed. +
          Throws: +
          BuildException - if the action is not a valid action.
          +
          +
          +
          + +

          +getAction

          +
          +public int getAction()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setListing

          +
          +public void setListing(java.io.File listing)
          +
          +
          The output file for the "list" action. This attribute is ignored for + any other actions. +

          +

          +
          +
          +
          +
          Parameters:
          listing - file in which to store the listing.
          +
          +
          +
          + +

          +getListing

          +
          +public java.io.File getListing()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setSkipFailedTransfers

          +
          +public void setSkipFailedTransfers(boolean skipFailedTransfers)
          +
          +
          If true, enables unsuccessful file put, delete and get + operations to be skipped with a warning and the remainder + of the files still transferred. +

          +

          +
          +
          +
          +
          Parameters:
          skipFailedTransfers - true if failures in transfers are ignored.
          +
          +
          +
          + +

          +isSkipFailedTransfers

          +
          +public boolean isSkipFailedTransfers()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setIgnoreNoncriticalErrors

          +
          +public void setIgnoreNoncriticalErrors(boolean ignoreNoncriticalErrors)
          +
          +
          set the flag to skip errors on directory creation. + (and maybe later other server specific errors) +

          +

          +
          +
          +
          +
          Parameters:
          ignoreNoncriticalErrors - true if non-critical errors should not + cause a failure.
          +
          +
          +
          + +

          +isIgnoreNoncriticalErrors

          +
          +public boolean isIgnoreNoncriticalErrors()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +isConfigurationSet

          +
          +public boolean isConfigurationSet()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setSystemTypeKey

          +
          +public void setSystemTypeKey(FTPTask.FTPSystemType systemKey)
          +
          +
          Sets the systemTypeKey attribute. + Method for setting FTPClientConfig remote system key. +

          +

          +
          +
          +
          +
          Parameters:
          systemKey - the key to be set - BUT if blank + the default value of null (which signifies "autodetect") will be kept.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setDefaultDateFormatConfig

          +
          +public void setDefaultDateFormatConfig(java.lang.String defaultDateFormat)
          +
          +
          Sets the defaultDateFormatConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          defaultDateFormat - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setRecentDateFormatConfig

          +
          +public void setRecentDateFormatConfig(java.lang.String recentDateFormat)
          +
          +
          Sets the recentDateFormatConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          recentDateFormat - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setServerLanguageCodeConfig

          +
          +public void setServerLanguageCodeConfig(java.lang.String serverLanguageCode)
          +
          +
          Sets the serverLanguageCode attribute. +

          +

          +
          +
          +
          +
          Parameters:
          serverLanguageCode - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setServerTimeZoneConfig

          +
          +public void setServerTimeZoneConfig(java.lang.String serverTimeZoneId)
          +
          +
          Sets the serverTimeZoneConfig attribute. +

          +

          +
          +
          +
          +
          Parameters:
          serverTimeZoneId - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setShortMonthNamesConfig

          +
          +public void setShortMonthNamesConfig(java.lang.String shortMonthNames)
          +
          +
          Sets the shortMonthNamesConfig attribute +

          +

          +
          +
          +
          +
          Parameters:
          shortMonthNames - configuration to be set, unless it is + null or empty string, in which case ignored.
          See Also:
          FTPClientConfig
          +
          +
          +
          + +

          +setRetriesAllowed

          +
          +public void setRetriesAllowed(java.lang.String retriesAllowed)
          +
          +
          Defines how many times to retry executing FTP command before giving up. + Default is 0 - try once and if failure then give up. +

          +

          +
          +
          +
          +
          Parameters:
          retriesAllowed - number of retries to allow. -1 means + keep trying forever. "forever" may also be specified as a + synonym for -1.
          +
          +
          +
          + +

          +getRetriesAllowed

          +
          +public int getRetriesAllowed()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +getSystemTypeKey

          +
          +public java.lang.String getSystemTypeKey()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the systemTypeKey.
          +
          +
          +
          + +

          +getDefaultDateFormatConfig

          +
          +public java.lang.String getDefaultDateFormatConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the defaultDateFormatConfig.
          +
          +
          +
          + +

          +getRecentDateFormatConfig

          +
          +public java.lang.String getRecentDateFormatConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the recentDateFormatConfig.
          +
          +
          +
          + +

          +getServerLanguageCodeConfig

          +
          +public java.lang.String getServerLanguageCodeConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the serverLanguageCodeConfig.
          +
          +
          +
          + +

          +getServerTimeZoneConfig

          +
          +public java.lang.String getServerTimeZoneConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the serverTimeZoneConfig.
          +
          +
          +
          + +

          +getShortMonthNamesConfig

          +
          +public java.lang.String getShortMonthNamesConfig()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the shortMonthNamesConfig.
          +
          +
          +
          + +

          +getTimestampGranularity

          +
          +public FTPTask.Granularity getTimestampGranularity()
          +
          +
          +
          +
          +
          + +
          Returns:
          Returns the timestampGranularity.
          +
          +
          +
          + +

          +setTimestampGranularity

          +
          +public void setTimestampGranularity(FTPTask.Granularity timestampGranularity)
          +
          +
          Sets the timestampGranularity attribute +

          +

          +
          +
          +
          +
          Parameters:
          timestampGranularity - The timestampGranularity to set.
          +
          +
          +
          + +

          +setSiteCommand

          +
          +public void setSiteCommand(java.lang.String siteCommand)
          +
          +
          Sets the siteCommand attribute. This attribute + names the command that will be executed if the action + is "site". +

          +

          +
          +
          +
          +
          Parameters:
          siteCommand - The siteCommand to set.
          +
          +
          +
          + +

          +getSiteCommand

          +
          +public java.lang.String getSiteCommand()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setInitialSiteCommand

          +
          +public void setInitialSiteCommand(java.lang.String initialCommand)
          +
          +
          Sets the initialSiteCommand attribute. This attribute + names a site command that will be executed immediately + after connection. +

          +

          +
          +
          +
          +
          Parameters:
          initialCommand - The initialSiteCommand to set.
          +
          +
          +
          + +

          +getInitialSiteCommand

          +
          +public java.lang.String getInitialSiteCommand()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +getGranularityMillis

          +
          +public long getGranularityMillis()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setGranularityMillis

          +
          +public void setGranularityMillis(long granularity)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setEnableRemoteVerification

          +
          +public void setEnableRemoteVerification(boolean b)
          +
          +
          Whether to verify that data and control connections are + connected to the same remote host. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getEnableRemoteVerification

          +
          +public boolean getEnableRemoteVerification()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +checkAttributes

          +
          +protected void checkAttributes()
+                        throws BuildException
          +
          +
          Checks to see that all required parameters are set. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if the configuration is not valid.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Runs the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the task fails or is not configured + correctly.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setupFTPDelegate

          +
          +protected void setupFTPDelegate()
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String msg,
+                int level)
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html new file mode 100644 index 000000000..26238b5f0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirror.html @@ -0,0 +1,207 @@ + + + + + + +FTPTaskMirror (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Interface FTPTaskMirror

          +
          +
          All Known Implementing Classes:
          FTPTaskMirrorImpl
          +
          +
          +
          +
          public interface FTPTaskMirror
          + + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voiddoFTP() + +
          +           
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +doFTP

          +
          +void doFTP()
+           throws BuildException
          +
          +
          + +
          Throws: +
          BuildException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile.html new file mode 100644 index 000000000..5fd6230ab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile.html @@ -0,0 +1,637 @@ + + + + + + +FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
+
          +
          +
          Direct Known Subclasses:
          FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile
          +
          +
          +
          Enclosing class:
          FTPTaskMirrorImpl.FTPDirectoryScanner
          +
          +
          +
          +
          protected class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
          extends java.lang.Object
          + + +

          +an AntFTPFile is a representation of a remote file +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(org.apache.commons.net.ftp.FTPClient client, + org.apache.commons.net.ftp.FTPFile ftpFile, + java.lang.String curpwd) + +
          +          constructor
          FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile parent, + java.lang.String path) + +
          +          other constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexists() + +
          +          find out if the file exists
          + java.lang.StringgetAbsolutePath() + +
          +          find out the absolute path of the file
          +protected  org.apache.commons.net.ftp.FTPClientgetClient() + +
          +          return the attached FTP client object.
          + java.lang.StringgetCurpwd() + +
          +          returns the path of the directory containing the AntFTPFile.
          + java.lang.StringgetCurpwdPlusFileSep() + +
          +          returns the path of the directory containing the AntFTPFile.
          + java.lang.StringgetFastRelativePath() + +
          +          find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case.
          + org.apache.commons.net.ftp.FTPFilegetFile(org.apache.commons.net.ftp.FTPFile[] theFiles, + java.lang.String lastpathelement) + +
          +          find a file matching a string in an array of FTPFile.
          + java.lang.StringgetLink() + +
          +          if the file is a symbolic link, find out to what it is pointing
          + java.lang.StringgetName() + +
          +          get the name of the file
          + java.lang.StringgetRelativePath() + +
          +          find out the relative path to the rootPath of the enclosing scanner.
          + booleanisDirectory() + +
          +          tell if a file is a directory.
          + booleanisSymbolicLink() + +
          +          tell if a file is a symbolic link
          + booleanisTraverseSymlinks() + +
          +          find out if a symbolic link is encountered in the relative path of this file + from rootPath.
          +protected  voidsetCurpwd(java.lang.String curpwd) + +
          +          sets the current path of an AntFTPFile
          + java.lang.StringtoString() + +
          +          Get a string rep of this object.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile

          +
          +public FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(org.apache.commons.net.ftp.FTPClient client,
+                                                        org.apache.commons.net.ftp.FTPFile ftpFile,
+                                                        java.lang.String curpwd)
          +
          +
          constructor +

          +

          +
          Parameters:
          client - ftp client variable
          ftpFile - the file
          curpwd - absolute remote path where the file is found
          +
          +
          + +

          +FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile

          +
          +public FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile(FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile parent,
+                                                        java.lang.String path)
          +
          +
          other constructor +

          +

          +
          Parameters:
          parent - the parent file
          path - a relative path to the parent file
          +
          + + + + + + + + +
          +Method Detail
          + +

          +exists

          +
          +public boolean exists()
          +
          +
          find out if the file exists +

          +

          + +
          Returns:
          true if the file exists
          +
          +
          +
          + +

          +getLink

          +
          +public java.lang.String getLink()
          +
          +
          if the file is a symbolic link, find out to what it is pointing +

          +

          + +
          Returns:
          the target of the symbolic link
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          get the name of the file +

          +

          + +
          Returns:
          the name of the file
          +
          +
          +
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          find out the absolute path of the file +

          +

          + +
          Returns:
          absolute path as string
          +
          +
          +
          + +

          +getFastRelativePath

          +
          +public java.lang.String getFastRelativePath()
          +
          +
          find out the relative path assuming that the path used to construct + this AntFTPFile was spelled properly with regards to case. + This is OK on a case sensitive system such as UNIX +

          +

          + +
          Returns:
          relative path
          +
          +
          +
          + +

          +getRelativePath

          +
          +public java.lang.String getRelativePath()
+                                 throws java.io.IOException,
+                                        BuildException
          +
          +
          find out the relative path to the rootPath of the enclosing scanner. + this relative path is spelled exactly like on disk, + for instance if the AntFTPFile has been instantiated as ALPHA, + but the file is really called alpha, this method will return alpha. + If a symbolic link is encountered, it is followed, but the name of the link + rather than the name of the target is returned. + (ie does not behave like File.getCanonicalPath()) +

          +

          + +
          Returns:
          relative path, separated by remoteFileSep +
          Throws: +
          java.io.IOException - if a change directory fails, ... +
          BuildException - if one of the components of the relative path cannot + be found.
          +
          +
          +
          + +

          +getFile

          +
          +public org.apache.commons.net.ftp.FTPFile getFile(org.apache.commons.net.ftp.FTPFile[] theFiles,
+                                                  java.lang.String lastpathelement)
          +
          +
          find a file matching a string in an array of FTPFile. + This method will find "alpha" when requested for "ALPHA" + if and only if the caseSensitive attribute is set to false. + When caseSensitive is set to true, only the exact match is returned. +

          +

          +
          Parameters:
          theFiles - array of files
          lastpathelement - the file name being sought +
          Returns:
          null if the file cannot be found, otherwise return the matching file.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          tell if a file is a directory. + note that it will return false for symbolic links pointing to directories. +

          +

          + +
          Returns:
          true for directories
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink()
          +
          +
          tell if a file is a symbolic link +

          +

          + +
          Returns:
          true for symbolic links
          +
          +
          +
          + +

          +getClient

          +
          +protected org.apache.commons.net.ftp.FTPClient getClient()
          +
          +
          return the attached FTP client object. + Warning : this instance is really shared with the enclosing class. +

          +

          + +
          Returns:
          FTP client
          +
          +
          +
          + +

          +setCurpwd

          +
          +protected void setCurpwd(java.lang.String curpwd)
          +
          +
          sets the current path of an AntFTPFile +

          +

          +
          Parameters:
          curpwd - the current path one wants to set
          +
          +
          +
          + +

          +getCurpwd

          +
          +public java.lang.String getCurpwd()
          +
          +
          returns the path of the directory containing the AntFTPFile. + of the full path of the file itself in case of AntFTPRootFile +

          +

          + +
          Returns:
          parent directory of the AntFTPFile
          +
          +
          +
          + +

          +getCurpwdPlusFileSep

          +
          +public java.lang.String getCurpwdPlusFileSep()
          +
          +
          returns the path of the directory containing the AntFTPFile. + of the full path of the file itself in case of AntFTPRootFile + and appends the remote file separator if necessary. +

          +

          + +
          Returns:
          parent directory of the AntFTPFile
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +isTraverseSymlinks

          +
          +public boolean isTraverseSymlinks()
+                           throws java.io.IOException,
+                                  BuildException
          +
          +
          find out if a symbolic link is encountered in the relative path of this file + from rootPath. +

          +

          + +
          Returns:
          true if a symbolic link is encountered in the relative path. +
          Throws: +
          java.io.IOException - if one of the change directory or directory listing operations + fails +
          BuildException - if a path component in the relative path cannot be found.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get a string rep of this object. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          a string containing the pwd and the file.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile.html new file mode 100644 index 000000000..555d61a19 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile.html @@ -0,0 +1,310 @@ + + + + + + +FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile
+
          +
          +
          Enclosing class:
          FTPTaskMirrorImpl.FTPDirectoryScanner
          +
          +
          +
          +
          protected class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile
          extends FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
          + + +

          +special class to represent the remote directory itself +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile(org.apache.commons.net.ftp.FTPClient aclient, + java.lang.String remotedir) + +
          +          constructor
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetAbsolutePath() + +
          +          find the absolute path
          + java.lang.StringgetRelativePath() + +
          +          find out the relative path to root
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
          exists, getClient, getCurpwd, getCurpwdPlusFileSep, getFastRelativePath, getFile, getLink, getName, isDirectory, isSymbolicLink, isTraverseSymlinks, setCurpwd, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile

          +
          +public FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile(org.apache.commons.net.ftp.FTPClient aclient,
+                                                            java.lang.String remotedir)
          +
          +
          constructor +

          +

          +
          Parameters:
          aclient - FTP client
          remotedir - remote directory
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          find the absolute path +

          +

          +
          Overrides:
          getAbsolutePath in class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
          +
          +
          + +
          Returns:
          absolute path
          +
          +
          +
          + +

          +getRelativePath

          +
          +public java.lang.String getRelativePath()
+                                 throws BuildException,
+                                        java.io.IOException
          +
          +
          find out the relative path to root +

          +

          +
          Overrides:
          getRelativePath in class FTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile
          +
          +
          + +
          Returns:
          empty string +
          Throws: +
          BuildException - actually never +
          java.io.IOException - actually never
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.html new file mode 100644 index 000000000..237b0e6ca --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPDirectoryScanner.html @@ -0,0 +1,427 @@ + + + + + + +FTPTaskMirrorImpl.FTPDirectoryScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTaskMirrorImpl.FTPDirectoryScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPDirectoryScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          Enclosing class:
          FTPTaskMirrorImpl
          +
          +
          +
          +
          protected class FTPTaskMirrorImpl.FTPDirectoryScanner
          extends DirectoryScanner
          + + +

          +internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +protected  classFTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPFile + +
          +          an AntFTPFile is a representation of a remote file
          +protected  classFTPTaskMirrorImpl.FTPDirectoryScanner.AntFTPRootFile + +
          +          special class to represent the remote directory itself
          +  + + + + + + + + + + +
          +Field Summary
          +protected  org.apache.commons.net.ftp.FTPClientftp + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTaskMirrorImpl.FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp) + +
          +          constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + org.apache.commons.net.ftp.FTPFile[]listFiles(java.lang.String directory) + +
          +          cd into one directory and + list the files present in one directory.
          + org.apache.commons.net.ftp.FTPFile[]listFiles(java.lang.String directory, + boolean changedir) + +
          +          list the files present in one directory.
          + voidscan() + +
          +          scans the remote directory, + storing internally the included files, directories, ...
          +protected  voidscandir(java.lang.String dir, + java.lang.String vpath, + boolean fast) + +
          +          scans a particular directory.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ftp

          +
          +protected org.apache.commons.net.ftp.FTPClient ftp
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTaskMirrorImpl.FTPDirectoryScanner

          +
          +public FTPTaskMirrorImpl.FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp)
          +
          +
          constructor +

          +

          +
          Parameters:
          ftp - ftpclient object
          +
          + + + + + + + + +
          +Method Detail
          + +

          +scan

          +
          +public void scan()
          +
          +
          scans the remote directory, + storing internally the included files, directories, ... +

          +

          +
          Specified by:
          scan in interface FileScanner
          Overrides:
          scan in class DirectoryScanner
          +
          +
          +
          +
          +
          +
          + +

          +scandir

          +
          +protected void scandir(java.lang.String dir,
+                       java.lang.String vpath,
+                       boolean fast)
          +
          +
          scans a particular directory. populates the scannedDirs cache. +

          +

          +
          Parameters:
          dir - directory to scan
          vpath - relative path to the base directory of the remote fileset + always ended with a File.separator
          fast - seems to be always true in practice
          +
          +
          +
          + +

          +listFiles

          +
          +public org.apache.commons.net.ftp.FTPFile[] listFiles(java.lang.String directory,
+                                                      boolean changedir)
          +
          +
          list the files present in one directory. +

          +

          +
          Parameters:
          directory - full path on the remote side
          changedir - if true change to directory directory before listing +
          Returns:
          array of FTPFile
          +
          +
          +
          + +

          +listFiles

          +
          +public org.apache.commons.net.ftp.FTPFile[] listFiles(java.lang.String directory)
          +
          +
          cd into one directory and + list the files present in one directory. +

          +

          +
          Parameters:
          directory - full path on the remote side +
          Returns:
          array of FTPFile
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPFileProxy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPFileProxy.html new file mode 100644 index 000000000..75888c836 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.FTPFileProxy.html @@ -0,0 +1,539 @@ + + + + + + +FTPTaskMirrorImpl.FTPFileProxy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTaskMirrorImpl.FTPFileProxy

          +
          +java.lang.Object
+  extended by java.io.File
+      extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Comparable<java.io.File>
          +
          +
          +
          Enclosing class:
          FTPTaskMirrorImpl
          +
          +
          +
          +
          protected static class FTPTaskMirrorImpl.FTPFileProxy
          extends java.io.File
          + + +

          +internal class providing a File-like interface to some of the information + available from the FTP server +

          + +

          +

          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.File
          pathSeparator, pathSeparatorChar, separator, separatorChar
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          FTPTaskMirrorImpl.FTPFileProxy(org.apache.commons.net.ftp.FTPFile file) + +
          +          creates a proxy to a FTP file
          FTPTaskMirrorImpl.FTPFileProxy(java.lang.String completePath) + +
          +          creates a proxy to a FTP directory
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexists() + +
          +           
          + java.lang.StringgetAbsolutePath() + +
          +           
          + java.lang.StringgetName() + +
          +           
          + java.lang.StringgetParent() + +
          +           
          + java.lang.StringgetPath() + +
          +           
          + booleanisAbsolute() + +
          +          FTP files are stored as absolute paths
          + booleanisDirectory() + +
          +           
          + booleanisFile() + +
          +           
          + booleanisHidden() + +
          +          FTP files cannot be hidden
          + longlastModified() + +
          +           
          + longlength() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.io.File
          canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, getAbsoluteFile, getCanonicalFile, getCanonicalPath, getParentFile, hashCode, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toString, toURI, toURL
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTaskMirrorImpl.FTPFileProxy

          +
          +public FTPTaskMirrorImpl.FTPFileProxy(org.apache.commons.net.ftp.FTPFile file)
          +
          +
          creates a proxy to a FTP file +

          +

          +
          Parameters:
          file -
          +
          +
          + +

          +FTPTaskMirrorImpl.FTPFileProxy

          +
          +public FTPTaskMirrorImpl.FTPFileProxy(java.lang.String completePath)
          +
          +
          creates a proxy to a FTP directory +

          +

          +
          Parameters:
          completePath - the remote directory.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +exists

          +
          +public boolean exists()
          +
          +
          +
          Overrides:
          exists in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getAbsolutePath

          +
          +public java.lang.String getAbsolutePath()
          +
          +
          +
          Overrides:
          getAbsolutePath in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          +
          Overrides:
          getName in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getParent

          +
          +public java.lang.String getParent()
          +
          +
          +
          Overrides:
          getParent in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +getPath

          +
          +public java.lang.String getPath()
          +
          +
          +
          Overrides:
          getPath in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isAbsolute

          +
          +public boolean isAbsolute()
          +
          +
          FTP files are stored as absolute paths +

          +

          +
          Overrides:
          isAbsolute in class java.io.File
          +
          +
          + +
          Returns:
          true
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          +
          Overrides:
          isDirectory in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isFile

          +
          +public boolean isFile()
          +
          +
          +
          Overrides:
          isFile in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +isHidden

          +
          +public boolean isHidden()
          +
          +
          FTP files cannot be hidden +

          +

          +
          Overrides:
          isHidden in class java.io.File
          +
          +
          + +
          Returns:
          false
          +
          +
          +
          + +

          +lastModified

          +
          +public long lastModified()
          +
          +
          +
          Overrides:
          lastModified in class java.io.File
          +
          +
          +
          +
          +
          +
          + +

          +length

          +
          +public long length()
          +
          +
          +
          Overrides:
          length in class java.io.File
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.html new file mode 100644 index 000000000..cd94be61d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/FTPTaskMirrorImpl.html @@ -0,0 +1,740 @@ + + + + + + +FTPTaskMirrorImpl (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class FTPTaskMirrorImpl

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl
+
          +
          +
          All Implemented Interfaces:
          FTPTaskMirror
          +
          +
          +
          +
          public class FTPTaskMirrorImpl
          extends java.lang.Object
          implements FTPTaskMirror
          + + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +protected  classFTPTaskMirrorImpl.FTPDirectoryScanner + +
          +          internal class allowing to read the contents of a remote file system + using the FTP protocol + used in particular for ftp get operations + differences with DirectoryScanner + "" (the root of the fileset) is never included in the included directories + followSymlinks defaults to false
          +protected static classFTPTaskMirrorImpl.FTPFileProxy + +
          +          internal class providing a File-like interface to some of the information + available from the FTP server
          +  + + + + + + + + + + +
          +Constructor Summary
          FTPTaskMirrorImpl(FTPTask task) + +
          +          Constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcreateParents(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String filename) + +
          +          Creates all parent directories specified in a complete relative + pathname.
          +protected  voiddelFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String filename) + +
          +          Delete a file from the remote host.
          + voiddoFTP() + +
          +           
          +protected  voiddoSiteCommand(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String theCMD) + +
          +          Sends a site command to the ftp server
          +protected  voidexecuteRetryable(RetryHandler h, + Retryable r, + java.lang.String descr) + +
          +          Executable a retryable object.
          +protected  voidgetFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir, + java.lang.String filename) + +
          +          Retrieve a single file from the remote host.
          +protected  booleanisUpToDate(org.apache.commons.net.ftp.FTPClient ftp, + java.io.File localFile, + java.lang.String remoteFile) + +
          +          Checks to see if the remote file is current as compared with the local + file.
          +protected  voidlistFile(org.apache.commons.net.ftp.FTPClient ftp, + java.io.BufferedWriter bw, + java.lang.String filename) + +
          +          List information about a single file from the remote host.
          +protected  voidmakeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir) + +
          +          Create the specified directory on the remote host.
          +protected  java.lang.StringresolveFile(java.lang.String file) + +
          +          Correct a file path to correspond to the remote host requirements.
          +protected  voidrmDir(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dirname) + +
          +          Delete a directory, if empty, from the remote host.
          +protected  voidsendFile(org.apache.commons.net.ftp.FTPClient ftp, + java.lang.String dir, + java.lang.String filename) + +
          +          Sends a single file to the remote host.
          +protected  voidtransferFiles(org.apache.commons.net.ftp.FTPClient ftp) + +
          +          Sends all files specified by the configured filesets to the remote + server.
          +protected  inttransferFiles(org.apache.commons.net.ftp.FTPClient ftp, + FileSet fs) + +
          +          For each file in the fileset, do the appropriate action: send, get, + delete, or list.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FTPTaskMirrorImpl

          +
          +public FTPTaskMirrorImpl(FTPTask task)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          task - the FTPTask that uses this mirror.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +executeRetryable

          +
          +protected void executeRetryable(RetryHandler h,
+                                Retryable r,
+                                java.lang.String descr)
+                         throws java.io.IOException
          +
          +
          Executable a retryable object. +

          +

          +
          +
          +
          +
          Parameters:
          h - the retry hander.
          r - the object that should be retried until it succeeds + or the number of retrys is reached.
          descr - a description of the command that is being run. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +transferFiles

          +
          +protected int transferFiles(org.apache.commons.net.ftp.FTPClient ftp,
+                            FileSet fs)
+                     throws java.io.IOException,
+                            BuildException
          +
          +
          For each file in the fileset, do the appropriate action: send, get, + delete, or list. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTPClient instance used to perform FTP actions
          fs - the fileset on which the actions are performed. +
          Returns:
          the number of files to be transferred. +
          Throws: +
          java.io.IOException - if there is a problem reading a file +
          BuildException - if there is a problem in the configuration.
          +
          +
          +
          + +

          +transferFiles

          +
          +protected void transferFiles(org.apache.commons.net.ftp.FTPClient ftp)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Sends all files specified by the configured filesets to the remote + server. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTPClient instance used to perform FTP actions +
          Throws: +
          java.io.IOException - if there is a problem reading a file +
          BuildException - if there is a problem in the configuration.
          +
          +
          +
          + +

          +resolveFile

          +
          +protected java.lang.String resolveFile(java.lang.String file)
          +
          +
          Correct a file path to correspond to the remote host requirements. This + implementation currently assumes that the remote end can handle + Unix-style paths with forward-slash separators. This can be overridden + with the separator task parameter. No attempt is made to + determine what syntax is appropriate for the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          file - the remote file name to be resolved +
          Returns:
          the filename as it will appear on the server.
          +
          +
          +
          + +

          +createParents

          +
          +protected void createParents(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String filename)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Creates all parent directories specified in a complete relative + pathname. Attempts to create existing directories will not cause + errors. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the FTP client instance to use to execute FTP actions on + the remote server.
          filename - the name of the file whose parents should be created. +
          Throws: +
          java.io.IOException - under non documented circumstances +
          BuildException - if it is impossible to cd to a remote directory
          +
          +
          +
          + +

          +isUpToDate

          +
          +protected boolean isUpToDate(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.io.File localFile,
+                             java.lang.String remoteFile)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Checks to see if the remote file is current as compared with the local + file. Returns true if the target file is up to date. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftpclient
          localFile - local file
          remoteFile - remote file +
          Returns:
          true if the target file is up to date +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if the date of the remote files cannot be found and the action is + GET_FILES
          +
          +
          +
          + +

          +doSiteCommand

          +
          +protected void doSiteCommand(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String theCMD)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Sends a site command to the ftp server +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          theCMD - command to execute +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +sendFile

          +
          +protected void sendFile(org.apache.commons.net.ftp.FTPClient ftp,
+                        java.lang.String dir,
+                        java.lang.String filename)
+                 throws java.io.IOException,
+                        BuildException
          +
          +
          Sends a single file to the remote host. filename may + contain a relative path specification. When this is the case, sendFile + will attempt to create any necessary parent directories before sending + the file. The file will then be sent using the entire relative path + spec - no attempt is made to change directories. It is anticipated that + this may eventually cause problems with some FTP servers, but it + simplifies the coding. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          dir - base directory of the file to be sent (local)
          filename - relative path of the file to be send + locally relative to dir + remotely relative to the remotedir attribute +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +delFile

          +
          +protected void delFile(org.apache.commons.net.ftp.FTPClient ftp,
+                       java.lang.String filename)
+                throws java.io.IOException,
+                       BuildException
          +
          +
          Delete a file from the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          filename - file to delete +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is set to false + and the deletion could not be done
          +
          +
          +
          + +

          +rmDir

          +
          +protected void rmDir(org.apache.commons.net.ftp.FTPClient ftp,
+                     java.lang.String dirname)
+              throws java.io.IOException,
+                     BuildException
          +
          +
          Delete a directory, if empty, from the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          dirname - directory to delete +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is set to false + and the deletion could not be done
          +
          +
          +
          + +

          +getFile

          +
          +protected void getFile(org.apache.commons.net.ftp.FTPClient ftp,
+                       java.lang.String dir,
+                       java.lang.String filename)
+                throws java.io.IOException,
+                       BuildException
          +
          +
          Retrieve a single file from the remote host. filename may + contain a relative path specification.

          + + The file will then be retreived using the entire relative path spec - + no attempt is made to change directories. It is anticipated that this + may eventually cause problems with some FTP servers, but it simplifies + the coding.

          +

          +

          +
          +
          +
          +
          Parameters:
          ftp - the ftp client
          dir - local base directory to which the file should go back
          filename - relative path of the file based upon the ftp remote directory + and/or the local base directory (dir) +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if skipFailedTransfers is false + and the file cannot be retrieved.
          +
          +
          +
          + +

          +listFile

          +
          +protected void listFile(org.apache.commons.net.ftp.FTPClient ftp,
+                        java.io.BufferedWriter bw,
+                        java.lang.String filename)
+                 throws java.io.IOException,
+                        BuildException
          +
          +
          List information about a single file from the remote host. filename + may contain a relative path specification.

          + + The file listing will then be retrieved using the entire relative path + spec - no attempt is made to change directories. It is anticipated that + this may eventually cause problems with some FTP servers, but it + simplifies the coding.

          +

          +

          +
          +
          +
          +
          Parameters:
          ftp - ftp client
          bw - buffered writer
          filename - the directory one wants to list +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - in unknown circumstances
          +
          +
          +
          + +

          +makeRemoteDir

          +
          +protected void makeRemoteDir(org.apache.commons.net.ftp.FTPClient ftp,
+                             java.lang.String dir)
+                      throws java.io.IOException,
+                             BuildException
          +
          +
          Create the specified directory on the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          ftp - The FTP client connection
          dir - The directory to create (format must be correct for host + type) +
          Throws: +
          java.io.IOException - in unknown circumstances +
          BuildException - if ignoreNoncriticalErrors has not been set to true + and a directory could not be created, for instance because it was + already existing. Precisely, the codes 521, 550 and 553 will trigger + a BuildException
          +
          +
          +
          + +

          +doFTP

          +
          +public void doFTP()
+           throws BuildException
          +
          +
          +
          Specified by:
          doFTP in interface FTPTaskMirror
          +
          +
          + +
          Throws: +
          BuildException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/MimeMail.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/MimeMail.html new file mode 100644 index 000000000..ed2a0138c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/MimeMail.html @@ -0,0 +1,354 @@ + + + + + + +MimeMail (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class MimeMail

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.email.EmailTask
+              extended by org.apache.tools.ant.taskdefs.optional.net.MimeMail
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +Deprecated. since 1.6.x. + Use EmailTask instead. +

          +

          +
          public class MimeMail
          extends EmailTask
          + + +

          +A task to send SMTP email; Use mail instead +

          + +

          +

          +
          Since:
          +
          Ant1.4
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
          EmailTask.Encoding
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
          AUTO, MIME, PLAIN, UU
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          MimeMail() + +
          +          Deprecated.  
          +  + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Deprecated. Executes this build task.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.email.EmailTask
          addBcc, addCc, addFileset, addFrom, addMessage, addReplyTo, addTo, createAttachments, createHeader, getCharset, getIncludeFileNames, setBccList, setCcList, setCharset, setEnableStartTLS, setEncoding, setFailOnError, setFiles, setFrom, setIgnoreInvalidRecipients, setIncludefilenames, setMailhost, setMailport, setMessage, setMessageFile, setMessageMimeType, setPassword, setReplyTo, setSSL, setSubject, setToList, setUser
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MimeMail

          +
          +public MimeMail()
          +
          +
          Deprecated. 
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Deprecated. 
          Executes this build task. +

          +

          +
          Overrides:
          execute in class EmailTask
          +
          +
          + +
          Throws: +
          BuildException - On error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html new file mode 100644 index 000000000..0cdf471f5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.AntRExecClient.html @@ -0,0 +1,379 @@ + + + + + + +RExecTask.AntRExecClient (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class RExecTask.AntRExecClient

          +
          +java.lang.Object
+  extended by org.apache.commons.net.SocketClient
+      extended by org.apache.commons.net.bsd.RExecClient
+          extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.AntRExecClient
+
          +
          +
          Enclosing class:
          RExecTask
          +
          +
          +
          +
          public class RExecTask.AntRExecClient
          extends org.apache.commons.net.bsd.RExecClient
          + + +

          +This class handles the abstraction of the rexec protocol. + Currently it is a wrapper around Jakarta + Commons Net. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.commons.net.bsd.RExecClient
          _errorStream_, DEFAULT_PORT
          +  + + + + + + + +
          Fields inherited from class org.apache.commons.net.SocketClient
          _defaultPort_, _input_, _isConnected_, _output_, _socket_, _socketFactory_, _timeout_, NETASCII_EOL
          +  + + + + + + + + + + +
          +Constructor Summary
          RExecTask.AntRExecClient() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsendString(java.lang.String s, + boolean echoString) + +
          +          Write this string to the rexec session.
          + voidwaitForEOF(java.lang.Integer timeout) + +
          +          Read from the rexec session until the EOF is found or + the timeout has been reached
          + voidwaitForString(java.lang.String s) + +
          +          Read from the rexec session until the string we are + waiting for is found
          + voidwaitForString(java.lang.String s, + java.lang.Integer timeout) + +
          +          Read from the rexec session until the string we are + waiting for is found or the timeout has been reached
          +  + + + + + + + +
          Methods inherited from class org.apache.commons.net.bsd.RExecClient
          disconnect, getErrorStream, getInputStream, getOutputStream, isRemoteVerificationEnabled, rexec, rexec, setRemoteVerificationEnabled
          +  + + + + + + + +
          Methods inherited from class org.apache.commons.net.SocketClient
          _connectAction_, connect, connect, connect, connect, connect, connect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RExecTask.AntRExecClient

          +
          +public RExecTask.AntRExecClient()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +waitForString

          +
          +public void waitForString(java.lang.String s)
          +
          +
          Read from the rexec session until the string we are + waiting for is found +

          +

          +
          Parameters:
          s - The string to wait on
          +
          +
          +
          + +

          +waitForString

          +
          +public void waitForString(java.lang.String s,
+                          java.lang.Integer timeout)
          +
          +
          Read from the rexec session until the string we are + waiting for is found or the timeout has been reached +

          +

          +
          Parameters:
          s - The string to wait on
          timeout - The maximum number of seconds to wait
          +
          +
          +
          + +

          +sendString

          +
          +public void sendString(java.lang.String s,
+                       boolean echoString)
          +
          +
          Write this string to the rexec session. +

          +

          +
          Parameters:
          s - the string to write
          echoString - if true log the string sent
          +
          +
          +
          + +

          +waitForEOF

          +
          +public void waitForEOF(java.lang.Integer timeout)
          +
          +
          Read from the rexec session until the EOF is found or + the timeout has been reached +

          +

          +
          Parameters:
          timeout - The maximum number of seconds to wait
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html new file mode 100644 index 000000000..11d463a57 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecRead.html @@ -0,0 +1,333 @@ + + + + + + +RExecTask.RExecRead (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class RExecTask.RExecRead

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
+      extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecRead
+
          +
          +
          Enclosing class:
          RExecTask
          +
          +
          +
          +
          public class RExecTask.RExecRead
          extends RExecTask.RExecSubTask
          + + +

          +Reads the output from the connected server + until the required string is found or we time out. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
          taskString
          +  + + + + + + + + + + +
          +Constructor Summary
          RExecTask.RExecRead() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute(RExecTask.AntRExecClient rexec) + +
          +          Execute the read exec task.
          + voidsetDefaultTimeout(java.lang.Integer defaultTimeout) + +
          +          Sets the default timeout if none has been set already
          + voidsetTimeout(java.lang.Integer i) + +
          +          a timeout value that overrides any task wide timeout.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
          addText, setString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RExecTask.RExecRead

          +
          +public RExecTask.RExecRead()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(RExecTask.AntRExecClient rexec)
+             throws BuildException
          +
          +
          Execute the read exec task. +

          +

          +
          Overrides:
          execute in class RExecTask.RExecSubTask
          +
          +
          +
          Parameters:
          rexec - the task to use +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Integer i)
          +
          +
          a timeout value that overrides any task wide timeout. +

          +

          +
          Parameters:
          i - an Integer value
          +
          +
          +
          + +

          +setDefaultTimeout

          +
          +public void setDefaultTimeout(java.lang.Integer defaultTimeout)
          +
          +
          Sets the default timeout if none has been set already +

          +

          +
          Parameters:
          defaultTimeout - an Integer value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html new file mode 100644 index 000000000..94bf42fbe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecSubTask.html @@ -0,0 +1,341 @@ + + + + + + +RExecTask.RExecSubTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class RExecTask.RExecSubTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
+
          +
          +
          Direct Known Subclasses:
          RExecTask.RExecRead, RExecTask.RExecWrite
          +
          +
          +
          Enclosing class:
          RExecTask
          +
          +
          +
          +
          public class RExecTask.RExecSubTask
          extends java.lang.Object
          + + +

          +This class is the parent of the Read and Write tasks. + It handles the common attributes for both. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.StringtaskString + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          RExecTask.RExecSubTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String s) + +
          +          the message as nested text
          + voidexecute(RExecTask.AntRExecClient rexec) + +
          +          Execute the subtask.
          + voidsetString(java.lang.String s) + +
          +          the message as an attribute
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +taskString

          +
          +protected java.lang.String taskString
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +RExecTask.RExecSubTask

          +
          +public RExecTask.RExecSubTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(RExecTask.AntRExecClient rexec)
+             throws BuildException
          +
          +
          Execute the subtask. +

          +

          +
          Parameters:
          rexec - the client +
          Throws: +
          BuildException - always as it is not allowed to instantiate this object
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String s)
          +
          +
          the message as nested text +

          +

          +
          Parameters:
          s - the nested text
          +
          +
          +
          + +

          +setString

          +
          +public void setString(java.lang.String s)
          +
          +
          the message as an attribute +

          +

          +
          Parameters:
          s - a String value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html new file mode 100644 index 000000000..413db6c3d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html @@ -0,0 +1,312 @@ + + + + + + +RExecTask.RExecWrite (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class RExecTask.RExecWrite

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
+      extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecWrite
+
          +
          +
          Enclosing class:
          RExecTask
          +
          +
          +
          +
          public class RExecTask.RExecWrite
          extends RExecTask.RExecSubTask
          + + +

          +Sends text to the connected server +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
          taskString
          +  + + + + + + + + + + +
          +Constructor Summary
          RExecTask.RExecWrite() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute(RExecTask.AntRExecClient rexec) + +
          +          Execute the write exec task.
          + voidsetEcho(boolean b) + +
          +          Whether or not the message should be echoed to the log.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.RExecTask.RExecSubTask
          addText, setString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RExecTask.RExecWrite

          +
          +public RExecTask.RExecWrite()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(RExecTask.AntRExecClient rexec)
+             throws BuildException
          +
          +
          Execute the write exec task. +

          +

          +
          Overrides:
          execute in class RExecTask.RExecSubTask
          +
          +
          +
          Parameters:
          rexec - the task to use +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setEcho

          +
          +public void setEcho(boolean b)
          +
          +
          Whether or not the message should be echoed to the log. + Defaults to true. +

          +

          +
          Parameters:
          b - a boolean value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.html new file mode 100644 index 000000000..c969e37cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/RExecTask.html @@ -0,0 +1,559 @@ + + + + + + +RExecTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class RExecTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.net.RExecTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class RExecTask
          extends Task
          + + +

          +Automates the rexec protocol. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          + classRExecTask.AntRExecClient + +
          +          This class handles the abstraction of the rexec protocol.
          + classRExecTask.RExecRead + +
          +          Reads the output from the connected server + until the required string is found or we time out.
          + classRExecTask.RExecSubTask + +
          +          This class is the parent of the Read and Write tasks.
          + classRExecTask.RExecWrite + +
          +          Sends text to the connected server
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          RExecTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + RExecTask.RExecSubTaskcreateRead() + +
          +          A string to wait for from the server.
          + RExecTask.RExecSubTaskcreateWrite() + +
          +          Add text to send to the server + A subTask <write> tag was found.
          + voidexecute() + +
          +          Verify that all parameters are included.
          + voidsetCommand(java.lang.String c) + +
          +          Set the the comand to execute on the server;
          + voidsetInitialCR(boolean b) + +
          +          send a carriage return after connecting; optional, defaults to false.
          + voidsetPassword(java.lang.String p) + +
          +          Set the the login password to use + required if userid is set.
          + voidsetPort(int p) + +
          +          Set the tcp port to connect to; default is 23.
          + voidsetServer(java.lang.String m) + +
          +          Set the hostname or address of the remote server.
          + voidsetTimeout(java.lang.Integer i) + +
          +          set a default timeout in seconds to wait for a response, + zero means forever (the default)
          + voidsetUserid(java.lang.String u) + +
          +          Set the the login id to use on the server; + required if password is set.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RExecTask

          +
          +public RExecTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createRead

          +
          +public RExecTask.RExecSubTask createRead()
          +
          +
          A string to wait for from the server. + A subTask <read> tag was found. Create the object, + Save it in our list, and return it. +

          +

          + +
          Returns:
          a read sub task
          +
          +
          +
          + +

          +createWrite

          +
          +public RExecTask.RExecSubTask createWrite()
          +
          +
          Add text to send to the server + A subTask <write> tag was found. Create the object, + Save it in our list, and return it. +

          +

          + +
          Returns:
          a write sub task
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Verify that all parameters are included. + Connect and possibly login. + Iterate through the list of Reads and writes. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setCommand

          +
          +public void setCommand(java.lang.String c)
          +
          +
          Set the the comand to execute on the server; +

          +

          +
          Parameters:
          c - a String value
          +
          +
          +
          + +

          +setInitialCR

          +
          +public void setInitialCR(boolean b)
          +
          +
          send a carriage return after connecting; optional, defaults to false. +

          +

          +
          Parameters:
          b - a boolean value
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String p)
          +
          +
          Set the the login password to use + required if userid is set. +

          +

          +
          Parameters:
          p - a String value
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(int p)
          +
          +
          Set the tcp port to connect to; default is 23. +

          +

          +
          Parameters:
          p - an int value
          +
          +
          +
          + +

          +setServer

          +
          +public void setServer(java.lang.String m)
          +
          +
          Set the hostname or address of the remote server. +

          +

          +
          Parameters:
          m - a String value
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Integer i)
          +
          +
          set a default timeout in seconds to wait for a response, + zero means forever (the default) +

          +

          +
          Parameters:
          i - an Integer value
          +
          +
          +
          + +

          +setUserid

          +
          +public void setUserid(java.lang.String u)
          +
          +
          Set the the login id to use on the server; + required if password is set. +

          +

          +
          Parameters:
          u - a String value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/SetProxy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/SetProxy.html new file mode 100644 index 000000000..029774d94 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/SetProxy.html @@ -0,0 +1,570 @@ + + + + + + +SetProxy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class SetProxy

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.net.SetProxy
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class SetProxy
          extends Task
          + + +

          +Sets Java's web proxy properties, so that tasks and code run in + the same JVM can have through-the-firewall access to remote web sites, + and remote ftp sites. + You can nominate an http and ftp proxy, or a socks server, reset the server + settings, or do nothing at all. +

          + Examples + 

          <setproxy/>
          + do nothing + 
          <setproxy proxyhost="firewall"/>
          + set the proxy to firewall:80 + 
          <setproxy proxyhost="firewall" proxyport="81"/>
          + set the proxy to firewall:81 + 
          <setproxy proxyhost=""/>
          + stop using the http proxy; don't change the socks settings + 
          <setproxy socksproxyhost="socksy"/>
          + use socks via socksy:1080 + 
          <setproxy socksproxyhost=""/>
          + stop using the socks server. +

          + You can set a username and password for http with the proxyHost + and proxyPassword attributes. These can also be + used against SOCKS5 servers. +

          +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          See Also:
          + java 1.5 network property list
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.StringproxyHost + +
          +          proxy details
          +protected  intproxyPort + +
          +          name of proxy port
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SetProxy() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidapplyWebProxySettings() + +
          +          if the proxy port and host settings are not null, then the settings + get applied these settings last beyond the life of the object and + apply to all network connections + Relevant docs: buglist #4183340
          + voidexecute() + +
          +          Does the work.
          + voidsetNonProxyHosts(java.lang.String nonProxyHosts) + +
          +          A list of hosts to bypass the proxy on.
          + voidsetProxyHost(java.lang.String hostname) + +
          +          the HTTP/ftp proxy host.
          + voidsetProxyPassword(java.lang.String proxyPassword) + +
          +          Set the password for the proxy.
          + voidsetProxyPort(int port) + +
          +          the HTTP/ftp proxy port number; default is 80
          + voidsetProxyUser(java.lang.String proxyUser) + +
          +          set the proxy user.
          + voidsetSocksProxyHost(java.lang.String host) + +
          +          The name of a Socks server.
          + voidsetSocksProxyPort(int port) + +
          +          Set the ProxyPort for socks connections.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +proxyHost

          +
          +protected java.lang.String proxyHost
          +
          +
          proxy details +

          +

          +
          +
          +
          + +

          +proxyPort

          +
          +protected int proxyPort
          +
          +
          name of proxy port +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SetProxy

          +
          +public SetProxy()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProxyHost

          +
          +public void setProxyHost(java.lang.String hostname)
          +
          +
          the HTTP/ftp proxy host. Set this to "" for the http proxy + option to be disabled +

          +

          +
          Parameters:
          hostname - the new proxy hostname
          +
          +
          +
          + +

          +setProxyPort

          +
          +public void setProxyPort(int port)
          +
          +
          the HTTP/ftp proxy port number; default is 80 +

          +

          +
          Parameters:
          port - port number of the proxy
          +
          +
          +
          + +

          +setSocksProxyHost

          +
          +public void setSocksProxyHost(java.lang.String host)
          +
          +
          The name of a Socks server. Set to "" to turn socks + proxying off. +

          +

          +
          Parameters:
          host - The new SocksProxyHost value
          +
          +
          +
          + +

          +setSocksProxyPort

          +
          +public void setSocksProxyPort(int port)
          +
          +
          Set the ProxyPort for socks connections. The default value is 1080 +

          +

          +
          Parameters:
          port - The new SocksProxyPort value
          +
          +
          +
          + +

          +setNonProxyHosts

          +
          +public void setNonProxyHosts(java.lang.String nonProxyHosts)
          +
          +
          A list of hosts to bypass the proxy on. These should be separated + with the vertical bar character '|'. Only in Java 1.4 does ftp use + this list. + e.g. fozbot.corp.sun.com|*.eng.sun.com +

          +

          +
          Parameters:
          nonProxyHosts - lists of hosts to talk direct to
          +
          +
          +
          + +

          +setProxyUser

          +
          +public void setProxyUser(java.lang.String proxyUser)
          +
          +
          set the proxy user. Probably requires a password to accompany this + setting. Default="" +

          +

          +
          Parameters:
          proxyUser - username
          Since:
          +
          Ant1.6
          +
          +
          +
          +
          + +

          +setProxyPassword

          +
          +public void setProxyPassword(java.lang.String proxyPassword)
          +
          +
          Set the password for the proxy. Used only if the proxyUser is set. +

          +

          +
          Parameters:
          proxyPassword - password to go with the username
          Since:
          +
          Ant1.6
          +
          +
          +
          +
          + +

          +applyWebProxySettings

          +
          +public void applyWebProxySettings()
          +
          +
          if the proxy port and host settings are not null, then the settings + get applied these settings last beyond the life of the object and + apply to all network connections + Relevant docs: buglist #4183340 +

          +

          +
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Does the work. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - thrown in unrecoverable error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html new file mode 100644 index 000000000..593b0e206 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.AntTelnetClient.html @@ -0,0 +1,419 @@ + + + + + + +TelnetTask.AntTelnetClient (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class TelnetTask.AntTelnetClient

          +
          +java.lang.Object
+  extended by org.apache.commons.net.SocketClient
+      extended by org.apache.commons.net.telnet.TelnetClient
+          extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.AntTelnetClient
+
          +
          +
          Enclosing class:
          TelnetTask
          +
          +
          +
          +
          public class TelnetTask.AntTelnetClient
          extends org.apache.commons.net.telnet.TelnetClient
          + + +

          +This class handles the abstraction of the telnet protocol. + Currently it is a wrapper around Jakarta + Commons Net. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static intTERMINAL_TYPE + +
          +           
          +protected static intTERMINAL_TYPE_IS + +
          +           
          +protected static intTERMINAL_TYPE_SEND + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.commons.net.telnet.TelnetClient
          readerThread
          +  + + + + + + + +
          Fields inherited from class org.apache.commons.net.SocketClient
          _defaultPort_, _input_, _isConnected_, _output_, _socket_, _socketFactory_, _timeout_, NETASCII_EOL
          +  + + + + + + + + + + +
          +Constructor Summary
          TelnetTask.AntTelnetClient() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsendString(java.lang.String s, + boolean echoString) + +
          +          Write this string to the telnet session.
          + voidwaitForString(java.lang.String s) + +
          +          Read from the telnet session until the string we are + waiting for is found
          + voidwaitForString(java.lang.String s, + java.lang.Integer timeout) + +
          +          Read from the telnet session until the string we are + waiting for is found or the timeout has been reached
          +  + + + + + + + +
          Methods inherited from class org.apache.commons.net.telnet.TelnetClient
          _connectAction_, addOptionHandler, deleteOptionHandler, disconnect, getInputStream, getLocalOptionState, getOutputStream, getReaderThread, getRemoteOptionState, registerNotifHandler, registerSpyStream, sendAYT, setReaderThread, stopSpyStream, unregisterNotifHandler
          +  + + + + + + + +
          Methods inherited from class org.apache.commons.net.SocketClient
          connect, connect, connect, connect, connect, connect, getDefaultPort, getDefaultTimeout, getLocalAddress, getLocalPort, getRemoteAddress, getRemotePort, getSoLinger, getSoTimeout, getTcpNoDelay, isConnected, setDefaultPort, setDefaultTimeout, setSocketFactory, setSoLinger, setSoTimeout, setTcpNoDelay, verifyRemote
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +TERMINAL_TYPE

          +
          +protected static final int TERMINAL_TYPE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TERMINAL_TYPE_SEND

          +
          +protected static final int TERMINAL_TYPE_SEND
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TERMINAL_TYPE_IS

          +
          +protected static final int TERMINAL_TYPE_IS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TelnetTask.AntTelnetClient

          +
          +public TelnetTask.AntTelnetClient()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +waitForString

          +
          +public void waitForString(java.lang.String s)
          +
          +
          Read from the telnet session until the string we are + waiting for is found +

          +

          +
          Parameters:
          s - The string to wait on
          +
          +
          +
          + +

          +waitForString

          +
          +public void waitForString(java.lang.String s,
+                          java.lang.Integer timeout)
          +
          +
          Read from the telnet session until the string we are + waiting for is found or the timeout has been reached +

          +

          +
          Parameters:
          s - The string to wait on
          timeout - The maximum number of seconds to wait
          +
          +
          +
          + +

          +sendString

          +
          +public void sendString(java.lang.String s,
+                       boolean echoString)
          +
          +
          Write this string to the telnet session. +

          +

          +
          Parameters:
          s - the string to write
          echoString - if true log the string sent
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetRead.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetRead.html new file mode 100644 index 000000000..8a350e194 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetRead.html @@ -0,0 +1,333 @@ + + + + + + +TelnetTask.TelnetRead (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class TelnetTask.TelnetRead

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
+      extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetRead
+
          +
          +
          Enclosing class:
          TelnetTask
          +
          +
          +
          +
          public class TelnetTask.TelnetRead
          extends TelnetTask.TelnetSubTask
          + + +

          +Reads the output from the connected server + until the required string is found or we time out. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
          taskString
          +  + + + + + + + + + + +
          +Constructor Summary
          TelnetTask.TelnetRead() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute(TelnetTask.AntTelnetClient telnet) + +
          +          Execute the read task.
          + voidsetDefaultTimeout(java.lang.Integer defaultTimeout) + +
          +          Sets the default timeout if none has been set already
          + voidsetTimeout(java.lang.Integer i) + +
          +          a timeout value that overrides any task wide timeout.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
          addText, setString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TelnetTask.TelnetRead

          +
          +public TelnetTask.TelnetRead()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(TelnetTask.AntTelnetClient telnet)
+             throws BuildException
          +
          +
          Execute the read task. +

          +

          +
          Overrides:
          execute in class TelnetTask.TelnetSubTask
          +
          +
          +
          Parameters:
          telnet - the task to use +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Integer i)
          +
          +
          a timeout value that overrides any task wide timeout. +

          +

          +
          Parameters:
          i - an Integer value
          +
          +
          +
          + +

          +setDefaultTimeout

          +
          +public void setDefaultTimeout(java.lang.Integer defaultTimeout)
          +
          +
          Sets the default timeout if none has been set already +

          +

          +
          Parameters:
          defaultTimeout - an Integer value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetSubTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetSubTask.html new file mode 100644 index 000000000..be0ec1aa5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetSubTask.html @@ -0,0 +1,341 @@ + + + + + + +TelnetTask.TelnetSubTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class TelnetTask.TelnetSubTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
+
          +
          +
          Direct Known Subclasses:
          TelnetTask.TelnetRead, TelnetTask.TelnetWrite
          +
          +
          +
          Enclosing class:
          TelnetTask
          +
          +
          +
          +
          public class TelnetTask.TelnetSubTask
          extends java.lang.Object
          + + +

          +This class is the parent of the Read and Write tasks. + It handles the common attributes for both. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.StringtaskString + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          TelnetTask.TelnetSubTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String s) + +
          +          the message as nested text
          + voidexecute(TelnetTask.AntTelnetClient telnet) + +
          +          Execute the subtask.
          + voidsetString(java.lang.String s) + +
          +          the message as an attribute
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +taskString

          +
          +protected java.lang.String taskString
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TelnetTask.TelnetSubTask

          +
          +public TelnetTask.TelnetSubTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(TelnetTask.AntTelnetClient telnet)
+             throws BuildException
          +
          +
          Execute the subtask. +

          +

          +
          Parameters:
          telnet - the client +
          Throws: +
          BuildException - always as it is not allowed to instantiate this object
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String s)
          +
          +
          the message as nested text +

          +

          +
          Parameters:
          s - the nested text
          +
          +
          +
          + +

          +setString

          +
          +public void setString(java.lang.String s)
          +
          +
          the message as an attribute +

          +

          +
          Parameters:
          s - a String value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetWrite.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetWrite.html new file mode 100644 index 000000000..d725d9e5f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.TelnetWrite.html @@ -0,0 +1,312 @@ + + + + + + +TelnetTask.TelnetWrite (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class TelnetTask.TelnetWrite

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
+      extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetWrite
+
          +
          +
          Enclosing class:
          TelnetTask
          +
          +
          +
          +
          public class TelnetTask.TelnetWrite
          extends TelnetTask.TelnetSubTask
          + + +

          +Sends text to the connected server +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
          taskString
          +  + + + + + + + + + + +
          +Constructor Summary
          TelnetTask.TelnetWrite() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute(TelnetTask.AntTelnetClient telnet) + +
          +          Execute the write task.
          + voidsetEcho(boolean b) + +
          +          Whether or not the message should be echoed to the log.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.net.TelnetTask.TelnetSubTask
          addText, setString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TelnetTask.TelnetWrite

          +
          +public TelnetTask.TelnetWrite()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(TelnetTask.AntTelnetClient telnet)
+             throws BuildException
          +
          +
          Execute the write task. +

          +

          +
          Overrides:
          execute in class TelnetTask.TelnetSubTask
          +
          +
          +
          Parameters:
          telnet - the task to use +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setEcho

          +
          +public void setEcho(boolean b)
          +
          +
          Whether or not the message should be echoed to the log. + Defaults to true. +

          +

          +
          Parameters:
          b - a boolean value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html new file mode 100644 index 000000000..ef3806597 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html @@ -0,0 +1,534 @@ + + + + + + +TelnetTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.net +
          +Class TelnetTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.net.TelnetTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class TelnetTask
          extends Task
          + + +

          +Automates the telnet protocol. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          + classTelnetTask.AntTelnetClient + +
          +          This class handles the abstraction of the telnet protocol.
          + classTelnetTask.TelnetRead + +
          +          Reads the output from the connected server + until the required string is found or we time out.
          + classTelnetTask.TelnetSubTask + +
          +          This class is the parent of the Read and Write tasks.
          + classTelnetTask.TelnetWrite + +
          +          Sends text to the connected server
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          TelnetTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + TelnetTask.TelnetSubTaskcreateRead() + +
          +          A string to wait for from the server.
          + TelnetTask.TelnetSubTaskcreateWrite() + +
          +          Add text to send to the server + A subTask <write> tag was found.
          + voidexecute() + +
          +          Verify that all parameters are included.
          + voidsetInitialCR(boolean b) + +
          +          send a carriage return after connecting; optional, defaults to false.
          + voidsetPassword(java.lang.String p) + +
          +          Set the the login password to use + required if userid is set.
          + voidsetPort(int p) + +
          +          Set the tcp port to connect to; default is 23.
          + voidsetServer(java.lang.String m) + +
          +          Set the hostname or address of the remote server.
          + voidsetTimeout(java.lang.Integer i) + +
          +          set a default timeout in seconds to wait for a response, + zero means forever (the default)
          + voidsetUserid(java.lang.String u) + +
          +          Set the the login id to use on the server; + required if password is set.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TelnetTask

          +
          +public TelnetTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Verify that all parameters are included. + Connect and possibly login + Iterate through the list of Reads and writes +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setUserid

          +
          +public void setUserid(java.lang.String u)
          +
          +
          Set the the login id to use on the server; + required if password is set. +

          +

          +
          Parameters:
          u - a String value
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String p)
          +
          +
          Set the the login password to use + required if userid is set. +

          +

          +
          Parameters:
          p - a String value
          +
          +
          +
          + +

          +setServer

          +
          +public void setServer(java.lang.String m)
          +
          +
          Set the hostname or address of the remote server. +

          +

          +
          Parameters:
          m - a String value
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(int p)
          +
          +
          Set the tcp port to connect to; default is 23. +

          +

          +
          Parameters:
          p - an int value
          +
          +
          +
          + +

          +setInitialCR

          +
          +public void setInitialCR(boolean b)
          +
          +
          send a carriage return after connecting; optional, defaults to false. +

          +

          +
          Parameters:
          b - a boolean value
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(java.lang.Integer i)
          +
          +
          set a default timeout in seconds to wait for a response, + zero means forever (the default) +

          +

          +
          Parameters:
          i - an Integer value
          +
          +
          +
          + +

          +createRead

          +
          +public TelnetTask.TelnetSubTask createRead()
          +
          +
          A string to wait for from the server. + A subTask <read> tag was found. Create the object, + Save it in our list, and return it. +

          +

          + +
          Returns:
          a read telnet sub task
          +
          +
          +
          + +

          +createWrite

          +
          +public TelnetTask.TelnetSubTask createWrite()
          +
          +
          Add text to send to the server + A subTask <write> tag was found. Create the object, + Save it in our list, and return it. +

          +

          + +
          Returns:
          a write telnet sub task
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-frame.html new file mode 100644 index 000000000..94fd4e2da --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-frame.html @@ -0,0 +1,73 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.net (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.net + + + + +
          +Interfaces  + +
          +FTPTaskMirror
          + + + + + + +
          +Classes  + +
          +FTP +
          +FTP.Action +
          +FTP.FTPFileProxy +
          +FTP.FTPSystemType +
          +FTP.Granularity +
          +FTP.LanguageCode +
          +FTPTask +
          +FTPTask.Action +
          +FTPTask.FTPSystemType +
          +FTPTask.Granularity +
          +FTPTaskMirrorImpl +
          +FTPTaskMirrorImpl.FTPFileProxy +
          +MimeMail +
          +RExecTask +
          +SetProxy +
          +TelnetTask
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-summary.html new file mode 100644 index 000000000..235c9f4de --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-summary.html @@ -0,0 +1,238 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.net (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.net +

          + + + + + + + + + +
          +Interface Summary
          FTPTaskMirror 
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          FTPBasic FTP client.
          FTP.Actionan action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
          FTP.FTPFileProxyinternal class providing a File-like interface to some of the information + available from the FTP server
          FTP.FTPSystemTypeone of the valid system type keys recognized by the systemTypeKey + attribute.
          FTP.Granularityrepresents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
          FTP.LanguageCodeEnumerated class for languages.
          FTPTaskBasic FTP client.
          FTPTask.Actionan action to perform, one of + "send", "put", "recv", "get", "del", "delete", "list", "mkdir", "chmod", + "rmdir"
          FTPTask.FTPSystemTypeone of the valid system type keys recognized by the systemTypeKey + attribute.
          FTPTask.Granularityrepresents one of the valid timestamp adjustment values + recognized by the timestampGranularity attribute.
          FTPTaskMirrorImpl 
          FTPTaskMirrorImpl.FTPFileProxyinternal class providing a File-like interface to some of the information + available from the FTP server
          MimeMailDeprecated. since 1.6.x.
          RExecTaskAutomates the rexec protocol.
          SetProxySets Java's web proxy properties, so that tasks and code run in + the same JVM can have through-the-firewall access to remote web sites, + and remote ftp sites.
          TelnetTaskAutomates the telnet protocol.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-tree.html new file mode 100644 index 000000000..49a3ae0b0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/package-tree.html @@ -0,0 +1,182 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.net Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.net +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-frame.html new file mode 100644 index 000000000..2bb832373 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-frame.html @@ -0,0 +1,91 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional + + + + +
          +Interfaces  + +
          +XSLTTraceSupport
          + + + + + + +
          +Classes  + +
          +ANTLR +
          +Cab +
          +EchoProperties +
          +EchoProperties.FormatAttribute +
          +Javah +
          +Native2Ascii +
          +NetRexxC +
          +NetRexxC.TraceAttr +
          +NetRexxC.VerboseAttr +
          +PropertyFile +
          +PropertyFile.Entry +
          +PropertyFile.Entry.Operation +
          +PropertyFile.Entry.Type +
          +PropertyFile.Unit +
          +RenameExtensions +
          +ReplaceRegExp +
          +Rpm +
          +SchemaValidate +
          +SchemaValidate.SchemaLocation +
          +Script +
          +TraXLiaison +
          +Xalan2TraceSupport +
          +XMLValidateTask +
          +XMLValidateTask.Attribute +
          +XMLValidateTask.Property
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-summary.html new file mode 100644 index 000000000..eb7a4e1e0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-summary.html @@ -0,0 +1,264 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional +

          + + + + + + + + + +
          +Interface Summary
          XSLTTraceSupportSets up trace support for a given transformer.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          ANTLRInvokes the ANTLR Translator generator on a grammar file.
          CabCreate a CAB archive.
          EchoPropertiesDisplays all the current properties in the build.
          EchoProperties.FormatAttributeA enumerated type for the format attribute.
          JavahGenerates JNI header files using javah.
          Native2AsciiConverts files from native encodings to ASCII.
          NetRexxCCompiles NetRexx source files.
          NetRexxC.TraceAttrEnumerated class corresponding to the trace attribute.
          NetRexxC.VerboseAttrEnumerated class corresponding to the verbose attribute.
          PropertyFileModifies settings in a property file.
          PropertyFile.EntryInstance of this class represents nested elements of + a task propertyfile.
          PropertyFile.Entry.OperationEnumerated attribute with the values "+", "-", "="
          PropertyFile.Entry.TypeEnumerated attribute with the values "int", "date" and "string".
          PropertyFile.UnitBorrowed from Tstamp
          RenameExtensionsDeprecated. since 1.5.x.
          ReplaceRegExpPerforms regular expression string replacements in a text + file.
          RpmInvokes the rpm tool to build a Linux installation file.
          SchemaValidateValidate XML Schema documents.
          SchemaValidate.SchemaLocationrepresentation of a schema location.
          ScriptExecutes a script.
          TraXLiaisonConcrete liaison for XSLT processor implementing TraX.
          Xalan2TraceSupportSets up trace support for a given transformer.
          XMLValidateTaskChecks XML files are valid (or only well formed).
          XMLValidateTask.AttributeThe class to create to set a feature of the parser.
          XMLValidateTask.PropertyA Parser property.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-tree.html new file mode 100644 index 000000000..e105d3a55 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/package-tree.html @@ -0,0 +1,167 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html new file mode 100644 index 000000000..284cd9851 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Add.html @@ -0,0 +1,420 @@ + + + + + + +P4Add (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Add

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Add
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Add
          extends P4Base
          + + +

          +Adds specified files to Perforce. + + Example Usage: + + + + + + + +
          FunctionCommand
          Add files using P4USER, P4PORT and P4CLIENT settings specified<P4add
          P4view="//projects/foo/main/source/..."
          P4User="fbloggs" +
          P4Port="km01:1666" +
          P4Client="fbloggsclient">
          <fileset basedir="dir" includes="**/*.java">
          + </p4add>
          Add files using P4USER, P4PORT and P4CLIENT settings defined in environment + <P4add P4view="//projects/foo/main/source/..." />
          <fileset basedir="dir" + includes="**/*.java">
          </p4add>
          Specify the length of command line arguments to pass to each invocation of p4<p4add Commandlength="450">
          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Add() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          Add a fileset whose files will be added to Perforce.
          + voidexecute() + +
          +          Run the task.
          + voidsetChangelist(int changelist) + +
          +          If specified the open files are associated with the + specified pending changelist number; otherwise the open files are + associated with the default changelist.
          + voidsetCommandlength(int len) + +
          +          Set the maximum length + of the commandline when calling Perforce to add the files.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Add

          +
          +public P4Add()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCommandlength

          +
          +public void setCommandlength(int len)
+                      throws BuildException
          +
          +
          Set the maximum length + of the commandline when calling Perforce to add the files. + Defaults to 450, higher values mean faster execution, + but also possible failures. +

          +

          +
          Parameters:
          len - maximum length of command line default is 450. +
          Throws: +
          BuildException - if trying to set the command line length to 0 or less.
          +
          +
          +
          + +

          +setChangelist

          +
          +public void setChangelist(int changelist)
+                   throws BuildException
          +
          +
          If specified the open files are associated with the + specified pending changelist number; otherwise the open files are + associated with the default changelist. +

          +

          +
          Parameters:
          changelist - the change list number. +
          Throws: +
          BuildException - if trying to set a change list number <=0.
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          Add a fileset whose files will be added to Perforce. +

          +

          +
          Parameters:
          set - the FileSet that one wants to add to Perforce Source Control.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the execution of the Perforce command fails.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html new file mode 100644 index 000000000..ebc2bc772 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Base.html @@ -0,0 +1,829 @@ + + + + + + +P4Base (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Base

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          P4Add, P4Change, P4Counter, P4Delete, P4Edit, P4Fstat, P4Have, P4Integrate, P4Label, P4Labelsync, P4Reopen, P4Resolve, P4Revert, P4Submit, P4Sync
          +
          +
          +
          +
          public abstract class P4Base
          extends Task
          + + +

          +Base class for Perforce (P4) ANT tasks. See individual task for example usage. +

          + +

          +

          +
          See Also:
          P4Sync, +P4Have, +P4Change, +P4Edit, +P4Submit, +P4Label, +Execute
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  booleanfailOnError + +
          +          Keep going or fail on error - defaults to fail.
          +protected  java.lang.StringP4Client + +
          +          Perforce Client (eg myclientspec)
          +protected  java.lang.StringP4CmdOpts + +
          +          Perforce command opts.
          +protected  java.lang.StringP4Opts + +
          +          Perforce 'global' opts.
          +protected  java.lang.StringP4Port + +
          +          Perforce Server Port (eg KM01:1666)
          +protected  java.lang.StringP4User + +
          +          Perforce User (eg fbloggs)
          +protected  java.lang.StringP4View + +
          +          Perforce view for commands.
          +protected  java.lang.Stringshell + +
          +          The OS shell to use (cmd.exe or /bin/sh)
          +protected  org.apache.oro.text.perl.Perl5Utilutil + +
          +          Perl5 regexp in Java - cool eh?
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Base() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidexecP4Command(java.lang.String command) + +
          +          no usages found for this method + runs a Perforce command without a handler
          +protected  voidexecP4Command(java.lang.String command, + P4Handler handler) + +
          +          Execute P4 command assembled by subclasses.
          + java.lang.StringgetErrorMessage() + +
          +          gets the error message recorded by the Perforce handler
          + booleangetInError() + +
          +          gets whether or not the task has encountered an error
          + voidinit() + +
          +          sets attributes Port, Client, User from properties + if these properties are defined.
          + voidsetClient(java.lang.String p4Client) + +
          +          The p4 client spec to use; + optional, defaults to the current user
          + voidsetCmdopts(java.lang.String p4CmdOpts) + +
          +          Set extra command options; only used on some + of the Perforce tasks.
          + voidsetErrorMessage(java.lang.String errorMessage) + +
          +          sets the error message
          + voidsetFailonerror(boolean fail) + +
          +          whether to stop the build (true, default) + or keep going if an error is returned from the p4 command
          + voidsetGlobalopts(java.lang.String p4Opts) + +
          +          Set global P4 options; Used on all + of the Perforce tasks.
          + voidsetInError(boolean inError) + +
          +          sets the error flag on the task
          + voidsetPort(java.lang.String p4Port) + +
          +          The p4d server and port to connect to; + optional, default "perforce:1666"
          + voidsetUser(java.lang.String p4User) + +
          +          The p4 username; + optional, defaults to the current user
          + voidsetView(java.lang.String p4View) + +
          +          The client, branch or label view to operate upon; + optional default "//...".
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +util

          +
          +protected org.apache.oro.text.perl.Perl5Util util
          +
          +
          Perl5 regexp in Java - cool eh? +

          +

          +
          +
          +
          + +

          +shell

          +
          +protected java.lang.String shell
          +
          +
          The OS shell to use (cmd.exe or /bin/sh) +

          +

          +
          +
          +
          + +

          +P4Port

          +
          +protected java.lang.String P4Port
          +
          +
          Perforce Server Port (eg KM01:1666) +

          +

          +
          +
          +
          + +

          +P4Client

          +
          +protected java.lang.String P4Client
          +
          +
          Perforce Client (eg myclientspec) +

          +

          +
          +
          +
          + +

          +P4User

          +
          +protected java.lang.String P4User
          +
          +
          Perforce User (eg fbloggs) +

          +

          +
          +
          +
          + +

          +P4View

          +
          +protected java.lang.String P4View
          +
          +
          Perforce view for commands. (eg //projects/foobar/main/source/... ) +

          +

          +
          +
          +
          + +

          +failOnError

          +
          +protected boolean failOnError
          +
          +
          Keep going or fail on error - defaults to fail. +

          +

          +
          +
          +
          + +

          +P4Opts

          +
          +protected java.lang.String P4Opts
          +
          +
          Perforce 'global' opts. + Forms half of low level API +

          +

          +
          +
          +
          + +

          +P4CmdOpts

          +
          +protected java.lang.String P4CmdOpts
          +
          +
          Perforce command opts. + Forms half of low level API +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Base

          +
          +public P4Base()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getInError

          +
          +public boolean getInError()
          +
          +
          gets whether or not the task has encountered an error +

          +

          + +
          Returns:
          error flag
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +setInError

          +
          +public void setInError(boolean inError)
          +
          +
          sets the error flag on the task +

          +

          +
          Parameters:
          inError - if true an error has been encountered by the handler
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +getErrorMessage

          +
          +public java.lang.String getErrorMessage()
          +
          +
          gets the error message recorded by the Perforce handler +

          +

          + +
          Returns:
          error message
          +
          +
          +
          + +

          +setErrorMessage

          +
          +public void setErrorMessage(java.lang.String errorMessage)
          +
          +
          sets the error message +

          +

          +
          Parameters:
          errorMessage - line of error output
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(java.lang.String p4Port)
          +
          +
          The p4d server and port to connect to; + optional, default "perforce:1666" +

          +

          +
          Parameters:
          p4Port - the port one wants to set such as localhost:1666
          +
          +
          +
          + +

          +setClient

          +
          +public void setClient(java.lang.String p4Client)
          +
          +
          The p4 client spec to use; + optional, defaults to the current user +

          +

          +
          Parameters:
          p4Client - the name of the Perforce client spec
          +
          +
          +
          + +

          +setUser

          +
          +public void setUser(java.lang.String p4User)
          +
          +
          The p4 username; + optional, defaults to the current user +

          +

          +
          Parameters:
          p4User - the user name
          +
          +
          +
          + +

          +setGlobalopts

          +
          +public void setGlobalopts(java.lang.String p4Opts)
          +
          +
          Set global P4 options; Used on all + of the Perforce tasks. +

          +

          +
          Parameters:
          p4Opts - global options, to use a specific P4Config file for instance
          +
          +
          +
          + +

          +setView

          +
          +public void setView(java.lang.String p4View)
          +
          +
          The client, branch or label view to operate upon; + optional default "//...". + + the view is required for the following tasks : +
            +
          • p4delete
            • +
          • p4edit
            • +
          • p4reopen
            • +
          • p4resolve
            • +
          +

          +

          +
          Parameters:
          p4View - the view one wants to use
          +
          +
          +
          + +

          +setCmdopts

          +
          +public void setCmdopts(java.lang.String p4CmdOpts)
          +
          +
          Set extra command options; only used on some + of the Perforce tasks. +

          +

          +
          Parameters:
          p4CmdOpts - command line options going after the particular + Perforce command
          +
          +
          +
          + +

          +setFailonerror

          +
          +public void setFailonerror(boolean fail)
          +
          +
          whether to stop the build (true, default) + or keep going if an error is returned from the p4 command +

          +

          +
          Parameters:
          fail - indicates whether one wants to fail the build if an error comes from the + Perforce command
          +
          +
          +
          + +

          +init

          +
          +public void init()
          +
          +
          sets attributes Port, Client, User from properties + if these properties are defined. + Called automatically by UnknownElement +

          +

          +
          Overrides:
          init in class Task
          +
          +
          +
          See Also:
          + + + + +
          PropertyAttribute
          p4.portPort
          p4.clientClient
          p4.userUser
          +
          +
          +
          + +

          +execP4Command

          +
          +protected void execP4Command(java.lang.String command)
+                      throws BuildException
          +
          +
          no usages found for this method + runs a Perforce command without a handler +

          +

          +
          Parameters:
          command - the command that one wants to execute +
          Throws: +
          BuildException - if failonerror is set and the command fails
          +
          +
          +
          + +

          +execP4Command

          +
          +protected void execP4Command(java.lang.String command,
+                             P4Handler handler)
+                      throws BuildException
          +
          +
          Execute P4 command assembled by subclasses. +

          +

          +
          Parameters:
          command - The command to run
          handler - A P4Handler to process any input and output +
          Throws: +
          BuildException - if failonerror has been set to true
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html new file mode 100644 index 000000000..08967956f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Change.html @@ -0,0 +1,458 @@ + + + + + + +P4Change (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Change

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Change
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Change
          extends P4Base
          + + +

          +Requests a new changelist from the Perforce server. + P4Change creates a new changelist in perforce. P4Change sets the property + ${p4.change} with the new changelist number. This should then be passed into + p4edit and p4submit. +

          + +

          +

          +
          See Also:
          P4Edit, +P4Submit
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringdescription + +
          +           
          +protected  java.lang.StringemptyChangeList + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Change() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.lang.Stringbackslash(java.lang.String value) + +
          +          Ensure that a string is backslashing slashes so that it does not + confuse them with Perl substitution delimiter in Oro.
          + voidexecute() + +
          +          creates a new Perforce change list + sets the p4.change property to the number of the new change list
          + java.lang.StringgetEmptyChangeList() + +
          +          returns the text of an empty change list
          + voidsetDescription(java.lang.String desc) + +
          +          Description for ChangeList;optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +emptyChangeList

          +
          +protected java.lang.String emptyChangeList
          +
          +
          +
          +
          +
          + +

          +description

          +
          +protected java.lang.String description
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Change

          +
          +public P4Change()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          creates a new Perforce change list + sets the p4.change property to the number of the new change list +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the word error appears in the output coming from Perforce
          +
          +
          +
          + +

          +getEmptyChangeList

          +
          +public java.lang.String getEmptyChangeList()
+                                    throws BuildException
          +
          +
          returns the text of an empty change list +

          +

          + +
          Returns:
          the text of an empty change list +
          Throws: +
          BuildException - if the text error is displayed + in the Perforce output outside of a comment line
          +
          +
          +
          + +

          +backslash

          +
          +public static final java.lang.String backslash(java.lang.String value)
          +
          +
          Ensure that a string is backslashing slashes so that it does not + confuse them with Perl substitution delimiter in Oro. Backslashes are + always backslashes in a string unless they escape the delimiter. +

          +

          +
          Parameters:
          value - the string to backslash for slashes +
          Returns:
          the backslashed string
          See Also:
          Oro
          +
          +
          +
          + +

          +setDescription

          +
          +public void setDescription(java.lang.String desc)
          +
          +
          Description for ChangeList;optional. + If none is specified, it will default to "AutoSubmit By Ant" +

          +

          +
          Overrides:
          setDescription in class ProjectComponent
          +
          +
          +
          Parameters:
          desc - description for the change list
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.html new file mode 100644 index 000000000..52a961fd6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Counter.html @@ -0,0 +1,517 @@ + + + + + + +P4Counter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Counter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Counter
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Counter
          extends P4Base
          + + +

          +Obtains or sets the value of a counter. + +

          When used in its base form + (where only the counter name is provided), the counter value will be + printed to the output stream. When the value is provided, the counter + will be set to the value provided. When a property name is provided, + the property will be filled with the value of the counter. You may + not specify to both get and set the value of the counter in the same + Task. +

          +

          + The user performing this task must have Perforce "review" permissions + as defined by Perforce protections in order for this task to succeed. +

          + + Example Usage:
          + <p4counter name="${p4.counter}" property=${p4.change}"/> +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          + java.lang.Stringcounter + +
          +          name of the counter
          + java.lang.Stringproperty + +
          +          name of an optional property
          + booleanshouldSetProperty + +
          +          flag telling whether a property should be set
          + booleanshouldSetValue + +
          +          flag telling whether the value of the counter should be set
          + intvalue + +
          +          new value for the counter
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Counter() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          again, properties are mutable in this tsk
          + voidsetName(java.lang.String counter) + +
          +          The name of the counter; required
          + voidsetProperty(java.lang.String property) + +
          +          A property to be set with the value of the counter
          + voidsetValue(int value) + +
          +          The new value for the counter; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +counter

          +
          +public java.lang.String counter
          +
          +
          name of the counter +

          +

          +
          +
          +
          + +

          +property

          +
          +public java.lang.String property
          +
          +
          name of an optional property +

          +

          +
          +
          +
          + +

          +shouldSetValue

          +
          +public boolean shouldSetValue
          +
          +
          flag telling whether the value of the counter should be set +

          +

          +
          +
          +
          + +

          +shouldSetProperty

          +
          +public boolean shouldSetProperty
          +
          +
          flag telling whether a property should be set +

          +

          +
          +
          +
          + +

          +value

          +
          +public int value
          +
          +
          new value for the counter +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Counter

          +
          +public P4Counter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String counter)
          +
          +
          The name of the counter; required +

          +

          +
          Parameters:
          counter - name of the counter
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(int value)
          +
          +
          The new value for the counter; optional. +

          +

          +
          Parameters:
          value - new value for the counter
          +
          +
          +
          + +

          +setProperty

          +
          +public void setProperty(java.lang.String property)
          +
          +
          A property to be set with the value of the counter +

          +

          +
          Parameters:
          property - the name of a property to set with the value + of the counter
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          again, properties are mutable in this tsk +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the required parameters are not supplied.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.html new file mode 100644 index 000000000..c6427d375 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Delete.html @@ -0,0 +1,390 @@ + + + + + + +P4Delete (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Delete

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Delete
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Delete
          extends P4Base
          + + +

          +Checkout files for deletion. + + Example Usage:
          + <p4delete change="${p4.change}" view="//depot/project/foo.txt" />
          + + Simple re-write of P4Edit changing 'edit' to 'delete'.
          +

          + +

          +

          +
          To do:
          +
          What to do if file is already open in one of our changelists perhaps + (See also P4Edit)?
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          + java.lang.Stringchange + +
          +          number of the change list to work on
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Delete() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          executes the p4 delete task
          + voidsetChange(java.lang.String change) + +
          +          An existing changelist number for the deletion; optional + but strongly recommended.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +change

          +
          +public java.lang.String change
          +
          +
          number of the change list to work on +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Delete

          +
          +public P4Delete()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setChange

          +
          +public void setChange(java.lang.String change)
          +
          +
          An existing changelist number for the deletion; optional + but strongly recommended. +

          +

          +
          Parameters:
          change - the number of a change list
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          executes the p4 delete task +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there is no view specified
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html new file mode 100644 index 000000000..43fea1044 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Edit.html @@ -0,0 +1,389 @@ + + + + + + +P4Edit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Edit

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Edit
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Edit
          extends P4Base
          + + +

          +Open file(s) for edit. + P4Change should be used to obtain a new changelist for P4Edit as, + although P4Edit can open files to the default change, + P4Submit cannot yet submit to it. + Example Usage:
          + <p4edit change="${p4.change}" view="//depot/project/foo.txt" /> +

          + +

          +

          +
          To do:
          +
          Should call reopen if file is already open in one of our changelists perhaps?
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          + java.lang.Stringchange + +
          +          number of the change list to work on
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Edit() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Run the p4 edit command
          + voidsetChange(java.lang.String change) + +
          +          An existing changelist number to assign files to; optional + but strongly recommended.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +change

          +
          +public java.lang.String change
          +
          +
          number of the change list to work on +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Edit

          +
          +public P4Edit()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setChange

          +
          +public void setChange(java.lang.String change)
          +
          +
          An existing changelist number to assign files to; optional + but strongly recommended. +

          +

          +
          Parameters:
          change - the change list number
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the p4 edit command +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there is no view specified
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Fstat.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Fstat.html new file mode 100644 index 000000000..b33162bdd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Fstat.html @@ -0,0 +1,434 @@ + + + + + + +P4Fstat (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Fstat

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Fstat
          extends P4Base
          + + +

          +P4Fstat--find out which files are under Perforce control and which are not. + +
          Example Usage:
          + 

          + <project name="p4fstat" default="p4fstat"
+ basedir="C:\dev\gnu">
+     <target name="p4fstat" >
+         <p4fstat showfilter="all">
+             <fileset dir="depot" includes="**\/*"/>
+         </p4fstat>
+     </target>
+ </project>
+
          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Fstat() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          Adds a fileset to be examined by p4fstat.
          + voidexecute() + +
          +          Executes the p4fstat task.
          + intgetLengthOfTask() + +
          +          Return the number of files seen.
          + voidsetChangelist(int changelist) + +
          +          Sets optionally a change list number.
          + voidsetShowFilter(java.lang.String filter) + +
          +          Sets the filter that one wants applied.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Fstat

          +
          +public P4Fstat()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setShowFilter

          +
          +public void setShowFilter(java.lang.String filter)
          +
          +
          Sets the filter that one wants applied. + + + + + +
          OptionMeaning
          allall files under Perforce control or not
          existingonly files under Perforce control
          non-existingonly files not under Perforce control or not
          +

          +

          +
          Parameters:
          filter - should be one of all|existing|non-existing.
          +
          +
          +
          + +

          +setChangelist

          +
          +public void setChangelist(int changelist)
+                   throws BuildException
          +
          +
          Sets optionally a change list number. +

          +

          +
          Parameters:
          changelist - change list that one wants information about. +
          Throws: +
          BuildException - if the change list number is negative.
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          Adds a fileset to be examined by p4fstat. +

          +

          +
          Parameters:
          set - the fileset to add.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Executes the p4fstat task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if no files are specified.
          +
          +
          +
          + +

          +getLengthOfTask

          +
          +public int getLengthOfTask()
          +
          +
          Return the number of files seen. +

          +

          + +
          Returns:
          the number of files seen.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html new file mode 100644 index 000000000..895a944c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Handler.html @@ -0,0 +1,256 @@ + + + + + + +P4Handler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Interface P4Handler

          +
          +
          All Superinterfaces:
          ExecuteStreamHandler
          +
          +
          +
          All Known Implementing Classes:
          P4HandlerAdapter, P4Submit.P4SubmitAdapter, SimpleP4OutputHandler
          +
          +
          +
          +
          public interface P4Handler
          extends ExecuteStreamHandler
          + + +

          +Interface for p4 job output stream handler. Classes implementing this interface + can be called back by P4Base.execP4Command(); +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidprocess(java.lang.String line) + +
          +          processing of one line of stdout or of stderr
          + voidsetOutput(java.lang.String line) + +
          +          set any data to be written to P4's stdin
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.ExecuteStreamHandler
          setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start, stop
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +process

          +
          +void process(java.lang.String line)
+             throws BuildException
          +
          +
          processing of one line of stdout or of stderr +

          +

          +
          +
          +
          +
          Parameters:
          line - a line of stdout or stderr that the implementation will process +
          Throws: +
          BuildException - at the discretion of the implementation.
          +
          +
          +
          + +

          +setOutput

          +
          +void setOutput(java.lang.String line)
+               throws BuildException
          +
          +
          set any data to be written to P4's stdin +

          +

          +
          +
          +
          +
          Parameters:
          line - the text to write to P4's stdin +
          Throws: +
          BuildException - if the line cannot be processed.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.html new file mode 100644 index 000000000..b113ac90f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4HandlerAdapter.html @@ -0,0 +1,429 @@ + + + + + + +P4HandlerAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4HandlerAdapter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter
+
          +
          +
          All Implemented Interfaces:
          ExecuteStreamHandler, P4Handler
          +
          +
          +
          Direct Known Subclasses:
          SimpleP4OutputHandler
          +
          +
          +
          +
          public abstract class P4HandlerAdapter
          extends java.lang.Object
          implements P4Handler
          + + +

          +base class to manage streams around the execution of the Perforce + command line client +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          P4HandlerAdapter() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +abstract  voidprocess(java.lang.String line) + +
          +          subclasses of P4HandlerAdapter must implement this routine + processing of one line of stdout or of stderr
          + voidsetOutput(java.lang.String p4Input) + +
          +          set any data to be written to P4's stdin
          + voidsetProcessErrorStream(java.io.InputStream is) + +
          +          connects the handler to the stderr of the Perforce process
          + voidsetProcessInputStream(java.io.OutputStream os) + +
          +          connects the handler to the input stream into Perforce + used indirectly by tasks requiring to send specific standard input + such as p4label, p4change
          + voidsetProcessOutputStream(java.io.InputStream is) + +
          +          connects the handler to the stdout of the Perforce process
          + voidstart() + +
          +          this routine gets called by the execute routine of the Execute class + it connects the PumpStreamHandler to the input/output/error streams of the process.
          + voidstop() + +
          +          stops the processing of streams + called from P4Base#execP4Command(String command, P4Handler handler)
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4HandlerAdapter

          +
          +public P4HandlerAdapter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setOutput

          +
          +public void setOutput(java.lang.String p4Input)
          +
          +
          set any data to be written to P4's stdin +

          +

          +
          Specified by:
          setOutput in interface P4Handler
          +
          +
          +
          Parameters:
          p4Input - the text to write to P4's stdin
          +
          +
          +
          + +

          +process

          +
          +public abstract void process(java.lang.String line)
          +
          +
          subclasses of P4HandlerAdapter must implement this routine + processing of one line of stdout or of stderr +

          +

          +
          Specified by:
          process in interface P4Handler
          +
          +
          +
          Parameters:
          line - line of stdout or stderr to process
          +
          +
          +
          + +

          +start

          +
          +public void start()
+           throws BuildException
          +
          +
          this routine gets called by the execute routine of the Execute class + it connects the PumpStreamHandler to the input/output/error streams of the process. +

          +

          +
          Specified by:
          start in interface ExecuteStreamHandler
          +
          +
          + +
          Throws: +
          BuildException - if there is a error.
          See Also:
          Execute.execute()
          +
          +
          +
          + +

          +stop

          +
          +public void stop()
          +
          +
          stops the processing of streams + called from P4Base#execP4Command(String command, P4Handler handler) +

          +

          +
          Specified by:
          stop in interface ExecuteStreamHandler
          +
          +
          +
          See Also:
          P4Base.execP4Command(String, P4Handler)
          +
          +
          +
          + +

          +setProcessInputStream

          +
          +public void setProcessInputStream(java.io.OutputStream os)
+                           throws java.io.IOException
          +
          +
          connects the handler to the input stream into Perforce + used indirectly by tasks requiring to send specific standard input + such as p4label, p4change +

          +

          +
          Specified by:
          setProcessInputStream in interface ExecuteStreamHandler
          +
          +
          +
          Parameters:
          os - the stream bringing input to the p4 executable +
          Throws: +
          java.io.IOException - under unknown circumstances
          +
          +
          +
          + +

          +setProcessErrorStream

          +
          +public void setProcessErrorStream(java.io.InputStream is)
+                           throws java.io.IOException
          +
          +
          connects the handler to the stderr of the Perforce process +

          +

          +
          Specified by:
          setProcessErrorStream in interface ExecuteStreamHandler
          +
          +
          +
          Parameters:
          is - stderr coming from Perforce +
          Throws: +
          java.io.IOException - under unknown circumstances
          +
          +
          +
          + +

          +setProcessOutputStream

          +
          +public void setProcessOutputStream(java.io.InputStream is)
+                            throws java.io.IOException
          +
          +
          connects the handler to the stdout of the Perforce process +

          +

          +
          Specified by:
          setProcessOutputStream in interface ExecuteStreamHandler
          +
          +
          +
          Parameters:
          is - stdout coming from Perforce +
          Throws: +
          java.io.IOException - under unknown circumstances
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html new file mode 100644 index 000000000..6d772afc6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Have.html @@ -0,0 +1,331 @@ + + + + + + +P4Have (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Have

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Have
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Have
          extends P4Base
          + + +

          +Lists Perforce files currently on client. + + P4Have simply dumps the current file version info into + the Ant log (or stdout). +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Have() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Execute the Perforce have command.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Have

          +
          +public P4Have()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute the Perforce have command. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the command cannot be executed.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Integrate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Integrate.html new file mode 100644 index 000000000..a861aae20 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Integrate.html @@ -0,0 +1,854 @@ + + + + + + +P4Integrate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Integrate

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Integrate
          extends P4Base
          + + +

          +Integrate file(s). + P4Change should be used to obtain a new changelist for P4Integrate, + although P4Integrate can open files to the default change, + P4Submit cannot yet submit to it. + Example Usage:
          + <p4integrate change="${p4.change}" + fromfile="//depot/project/dev/foo.txt" tofile="//depot/project/main/foo.txt" /> +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Integrate() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          execute the p4 integrate
          + java.lang.StringgetBranch() + +
          +          get the branch
          + java.lang.StringgetChange() + +
          +          get the changelist number
          + java.lang.StringgetFromfile() + +
          +          get the from file specification
          + java.lang.StringgetTofile() + +
          +          get the to file specification
          + booleanisEnableBaselessMerges() + +
          +          gets the enablebaselessmerges flag
          + booleanisForceIntegrate() + +
          +          gets the forceintegrate flag
          + booleanisLeaveTargetRevision() + +
          +          gets the leavetargetrevision flag
          + booleanisNocopynewtargetfiles() + +
          +          indicates intention to suppress the copying on the local hard disk of new target files.
          + booleanisPropagatesourcefiletype() + +
          +          returns flag indicating if propagation of source file type is sought
          + booleanisRestoreDeletedRevisions() + +
          +          gets the restoredeletedrevisions flag
          + booleanisReversebranchmappings() + +
          +          returns the flag indicating if reverse branch mappings are sought
          + booleanisSimulationMode() + +
          +          gets the simulationmode flag
          + voidsetBranch(java.lang.String br) + +
          +          sets the branch
          + voidsetChange(java.lang.String change) + +
          +          set the changelist number for the operation
          + voidsetEnableBaselessMerges(boolean setrest) + +
          +          sets the enablebaselessmerges flag
          + voidsetForceIntegrate(boolean setrest) + +
          +          sets the forceintegrate flag
          + voidsetFromfile(java.lang.String fromf) + +
          +          sets the from file specification
          + voidsetLeaveTargetRevision(boolean setrest) + +
          +          sets the leavetargetrevision flag
          + voidsetNocopynewtargetfiles(boolean nocopynewtargetfiles) + +
          +          sets nocopynewtargetfiles flag
          + voidsetPropagatesourcefiletype(boolean propagatesourcefiletype) + +
          +          sets flag indicating if one wants to propagate the source file type
          + voidsetRestoreDeletedRevisions(boolean setrest) + +
          +          sets the restoredeletedrevisions flag
          + voidsetReversebranchmappings(boolean reversebranchmappings) + +
          +          sets the reversebranchmappings flag
          + voidsetSimulationMode(boolean setrest) + +
          +          sets the simulationmode flag
          + voidsetTofile(java.lang.String tof) + +
          +          sets the to file specification
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Integrate

          +
          +public P4Integrate()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getChange

          +
          +public java.lang.String getChange()
          +
          +
          get the changelist number +

          +

          + +
          Returns:
          the changelist number set for this task
          +
          +
          +
          + +

          +setChange

          +
          +public void setChange(java.lang.String change)
          +
          +
          set the changelist number for the operation +

          +

          +
          Parameters:
          change - An existing changelist number to assign files to; optional + but strongly recommended.
          +
          +
          +
          + +

          +getFromfile

          +
          +public java.lang.String getFromfile()
          +
          +
          get the from file specification +

          +

          + +
          Returns:
          the from file specification
          +
          +
          +
          + +

          +setFromfile

          +
          +public void setFromfile(java.lang.String fromf)
          +
          +
          sets the from file specification +

          +

          +
          Parameters:
          fromf - the from file specification
          +
          +
          +
          + +

          +getTofile

          +
          +public java.lang.String getTofile()
          +
          +
          get the to file specification +

          +

          + +
          Returns:
          the to file specification
          +
          +
          +
          + +

          +setTofile

          +
          +public void setTofile(java.lang.String tof)
          +
          +
          sets the to file specification +

          +

          +
          Parameters:
          tof - the to file specification
          +
          +
          +
          + +

          +getBranch

          +
          +public java.lang.String getBranch()
          +
          +
          get the branch +

          +

          + +
          Returns:
          the name of the branch
          +
          +
          +
          + +

          +setBranch

          +
          +public void setBranch(java.lang.String br)
          +
          +
          sets the branch +

          +

          +
          Parameters:
          br - the name of the branch to use
          +
          +
          +
          + +

          +isRestoreDeletedRevisions

          +
          +public boolean isRestoreDeletedRevisions()
          +
          +
          gets the restoredeletedrevisions flag +

          +

          + +
          Returns:
          restore deleted revisions
          +
          +
          +
          + +

          +setRestoreDeletedRevisions

          +
          +public void setRestoreDeletedRevisions(boolean setrest)
          +
          +
          sets the restoredeletedrevisions flag +

          +

          +
          Parameters:
          setrest - value chosen for restoredeletedrevisions
          +
          +
          +
          + +

          +isForceIntegrate

          +
          +public boolean isForceIntegrate()
          +
          +
          gets the forceintegrate flag +

          +

          + +
          Returns:
          restore deleted revisions
          +
          +
          +
          + +

          +setForceIntegrate

          +
          +public void setForceIntegrate(boolean setrest)
          +
          +
          sets the forceintegrate flag +

          +

          +
          Parameters:
          setrest - value chosen for forceintegrate
          +
          +
          +
          + +

          +isLeaveTargetRevision

          +
          +public boolean isLeaveTargetRevision()
          +
          +
          gets the leavetargetrevision flag +

          +

          + +
          Returns:
          flag indicating if the target revision should be preserved
          +
          +
          +
          + +

          +setLeaveTargetRevision

          +
          +public void setLeaveTargetRevision(boolean setrest)
          +
          +
          sets the leavetargetrevision flag +

          +

          +
          Parameters:
          setrest - value chosen for leavetargetrevision
          +
          +
          +
          + +

          +isEnableBaselessMerges

          +
          +public boolean isEnableBaselessMerges()
          +
          +
          gets the enablebaselessmerges flag +

          +

          + +
          Returns:
          boolean indicating if baseless merges are desired
          +
          +
          +
          + +

          +setEnableBaselessMerges

          +
          +public void setEnableBaselessMerges(boolean setrest)
          +
          +
          sets the enablebaselessmerges flag +

          +

          +
          Parameters:
          setrest - value chosen for enablebaselessmerges
          +
          +
          +
          + +

          +isSimulationMode

          +
          +public boolean isSimulationMode()
          +
          +
          gets the simulationmode flag +

          +

          + +
          Returns:
          simulation mode flag
          +
          +
          +
          + +

          +setSimulationMode

          +
          +public void setSimulationMode(boolean setrest)
          +
          +
          sets the simulationmode flag +

          +

          +
          Parameters:
          setrest - value chosen for simulationmode
          +
          +
          +
          + +

          +isReversebranchmappings

          +
          +public boolean isReversebranchmappings()
          +
          +
          returns the flag indicating if reverse branch mappings are sought +

          +

          + +
          Returns:
          reversebranchmappings flag
          +
          +
          +
          + +

          +setReversebranchmappings

          +
          +public void setReversebranchmappings(boolean reversebranchmappings)
          +
          +
          sets the reversebranchmappings flag +

          +

          +
          Parameters:
          reversebranchmappings - flag indicating if reverse branch mappings are sought
          +
          +
          +
          + +

          +isPropagatesourcefiletype

          +
          +public boolean isPropagatesourcefiletype()
          +
          +
          returns flag indicating if propagation of source file type is sought +

          +

          + +
          Returns:
          flag set to true if you want to propagate source file type for existing target files
          +
          +
          +
          + +

          +setPropagatesourcefiletype

          +
          +public void setPropagatesourcefiletype(boolean propagatesourcefiletype)
          +
          +
          sets flag indicating if one wants to propagate the source file type +

          +

          +
          Parameters:
          propagatesourcefiletype - set it to true if you want to change the type of existing target files + according to type of source file.
          +
          +
          +
          + +

          +isNocopynewtargetfiles

          +
          +public boolean isNocopynewtargetfiles()
          +
          +
          indicates intention to suppress the copying on the local hard disk of new target files. +

          +

          + +
          Returns:
          indicates intention to suppress the copying + on the local hard disk of new target files.
          +
          +
          +
          + +

          +setNocopynewtargetfiles

          +
          +public void setNocopynewtargetfiles(boolean nocopynewtargetfiles)
          +
          +
          sets nocopynewtargetfiles flag +

          +

          +
          Parameters:
          nocopynewtargetfiles - set it to true to gain speed in integration by not copying on + the local Perforce client new target files
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          execute the p4 integrate +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there are missing parameters
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html new file mode 100644 index 000000000..7b1c6ecd4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Label.html @@ -0,0 +1,462 @@ + + + + + + +P4Label (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Label

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Label
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Label
          extends P4Base
          + + +

          +Creates a new Perforce label and set contents to reflect current + client file revisions. + + Label name defaults to AntLabel if none set. + + Example Usage: + 

          +   <P4Label name="MyLabel-${TSTAMP}-${DSTAMP}" desc="Auto Build Label" />
+
          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringdesc + +
          +           
          +protected  java.lang.Stringlock + +
          +           
          +protected  java.lang.Stringname + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Label() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + voidsetDesc(java.lang.String desc) + +
          +          Label Description; optional
          + voidsetLock(java.lang.String lock) + +
          +          when set to "locked", Perforce will lock the label once created; optional.
          + voidsetName(java.lang.String name) + +
          +          The name of the label; optional, default "AntLabel"
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +name

          +
          +protected java.lang.String name
          +
          +
          +
          +
          +
          + +

          +desc

          +
          +protected java.lang.String desc
          +
          +
          +
          +
          +
          + +

          +lock

          +
          +protected java.lang.String lock
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Label

          +
          +public P4Label()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          The name of the label; optional, default "AntLabel" +

          +

          +
          Parameters:
          name - the name of the label
          +
          +
          +
          + +

          +setDesc

          +
          +public void setDesc(java.lang.String desc)
          +
          +
          Label Description; optional +

          +

          +
          Parameters:
          desc - description of the label
          +
          +
          +
          + +

          +setLock

          +
          +public void setLock(java.lang.String lock)
          +
          +
          when set to "locked", Perforce will lock the label once created; optional. +

          +

          +
          Parameters:
          lock - only admissible value "locked"
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if failonerror has been set to true and Perforce fails
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html new file mode 100644 index 000000000..66f836537 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Labelsync.html @@ -0,0 +1,527 @@ + + + + + + +P4Labelsync (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Labelsync

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Labelsync
          extends P4Base
          + + +

          +This method syncs an existing Perforce label against the Perforce client + or against a set of files/revisions. + + + Example Usage: + 

          +   <p4labelsync name="MyLabel-${TSTAMP}-${DSTAMP}"
+   view="//depot/...#head;//depot2/file1#25" />
+
          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringname + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Labelsync() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + booleanisAdd() + +
          +          -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view
          + booleanisDelete() + +
          +          -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view
          + booleanisSimulationmode() + +
          +          -n flag of p4 labelsync - display changes without actually doing them
          + voidsetAdd(boolean add) + +
          +          -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view
          + voidsetDelete(boolean delete) + +
          +          -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view
          + voidsetName(java.lang.String name) + +
          +          The name of the label; optional, default "AntLabel"
          + voidsetSimulationmode(boolean simulationmode) + +
          +          -n flag of p4 labelsync - display changes without actually doing them
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +name

          +
          +protected java.lang.String name
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Labelsync

          +
          +public P4Labelsync()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isAdd

          +
          +public boolean isAdd()
          +
          +
          -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view +

          +

          + +
          Returns:
          add attribute + if set to true the task will not remove any files from the label + only add files which were not there previously or update these where the revision has changed + the add attribute is the -a flag of p4 labelsync
          +
          +
          +
          + +

          +setAdd

          +
          +public void setAdd(boolean add)
          +
          +
          -a flag of p4 labelsync - preserve files which exist in the label, + but not in the current view +

          +

          +
          Parameters:
          add - if set to true the task will not remove any files from the label + only add files which were not there previously or update these where the revision has changed + the add attribute is the -a flag of p4 labelsync
          +
          +
          +
          + +

          +isDelete

          +
          +public boolean isDelete()
          +
          +
          -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view +

          +

          + +
          Returns:
          delete attribute
          +
          +
          +
          + +

          +setDelete

          +
          +public void setDelete(boolean delete)
          +
          +
          -d flag of p4 labelsync; indicates an intention of deleting from the label + the files specified in the view +

          +

          +
          Parameters:
          delete - indicates intention of deleting from the label + the files specified in the view
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          The name of the label; optional, default "AntLabel" +

          +

          +
          Parameters:
          name - of the label
          +
          +
          +
          + +

          +isSimulationmode

          +
          +public boolean isSimulationmode()
          +
          +
          -n flag of p4 labelsync - display changes without actually doing them +

          +

          + +
          Returns:
          -n flag of p4 labelsync
          +
          +
          +
          + +

          +setSimulationmode

          +
          +public void setSimulationmode(boolean simulationmode)
          +
          +
          -n flag of p4 labelsync - display changes without actually doing them +

          +

          +
          Parameters:
          simulationmode - display changes without actually doing them
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the label name is not supplied
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputHandler.html new file mode 100644 index 000000000..4f5e09033 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputHandler.html @@ -0,0 +1,211 @@ + + + + + + +P4OutputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Interface P4OutputHandler

          +
          +
          +
          public interface P4OutputHandler
          + + +

          +Interface for p4 job output stream handler. Classes implementing this interface + can be called back by P4Base.execP4Command(); +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidprocess(java.lang.String line) + +
          +          implementations will be able to process lines of output from Perforce
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +process

          +
          +void process(java.lang.String line)
+             throws BuildException
          +
          +
          implementations will be able to process lines of output from Perforce +

          +

          +
          Parameters:
          line - a line of stdout or stderr coming from Perforce +
          Throws: +
          BuildException - implementations are allowed to throw BuildException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html new file mode 100644 index 000000000..1d2cf116d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4OutputStream.html @@ -0,0 +1,329 @@ + + + + + + +P4OutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4OutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.taskdefs.optional.perforce.P4OutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class P4OutputStream
          extends java.io.OutputStream
          + + +

          +heavily inspired from LogOutputStream + this stream class calls back the P4Handler on each line of stdout or stderr read +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          P4OutputStream(P4Handler handler) + +
          +          creates a new P4OutputStream for a P4Handler
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Writes all remaining
          +protected  voidprocessBuffer() + +
          +          Converts the buffer to a string and sends it to processLine
          + voidwrite(int cc) + +
          +          Write the data to the buffer and flush the buffer, if a line + separator is detected.
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          flush, write, write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4OutputStream

          +
          +public P4OutputStream(P4Handler handler)
          +
          +
          creates a new P4OutputStream for a P4Handler +

          +

          +
          Parameters:
          handler - the handler which will process the streams
          +
          + + + + + + + + +
          +Method Detail
          + +

          +write

          +
          +public void write(int cc)
+           throws java.io.IOException
          +
          +
          Write the data to the buffer and flush the buffer, if a line + separator is detected. +

          +

          +
          Specified by:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          cc - data to log (byte). +
          Throws: +
          java.io.IOException - IOException if an I/O error occurs. In particular, + an IOException may be thrown if the + output stream has been closed.
          +
          +
          +
          + +

          +processBuffer

          +
          +protected void processBuffer()
          +
          +
          Converts the buffer to a string and sends it to processLine +

          +

          +
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Writes all remaining +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if an I/O error occurs.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html new file mode 100644 index 000000000..e0e920781 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Reopen.html @@ -0,0 +1,352 @@ + + + + + + +P4Reopen (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Reopen

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Reopen
          extends P4Base
          + + +

          +Reopen Perforce checkout files between changelists. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Reopen() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + voidsetToChange(java.lang.String toChange) + +
          +          The changelist to move files to; required.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Reopen

          +
          +public P4Reopen()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setToChange

          +
          +public void setToChange(java.lang.String toChange)
+                 throws BuildException
          +
          +
          The changelist to move files to; required. +

          +

          +
          Parameters:
          toChange - new change list number +
          Throws: +
          BuildException - if the change parameter is null or empty
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if P4View is null
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Resolve.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Resolve.html new file mode 100644 index 000000000..18224d3e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Resolve.html @@ -0,0 +1,558 @@ + + + + + + +P4Resolve (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Resolve

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Resolve
          extends P4Base
          + + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Resolve() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          execute the p4 resolve
          + java.lang.StringgetResolvemode() + +
          +          returns the resolve mode
          + booleanisForcetextmode() + +
          +          If set to true, attempts a textual merge, even for binary files
          + booleanisMarkersforall() + +
          +          If set to true, puts in markers for all changes, conflicting or not
          + booleanisRedoall() + +
          +          allows previously resolved files to be resolved again
          + booleanisSimulationmode() + +
          +          read the simulation mode flag
          + voidsetForcetextmode(boolean forcetextmode) + +
          +          If set to true, attempts a textual merge, even for binary files
          + voidsetMarkersforall(boolean markersforall) + +
          +          If set to true, puts in markers for all changes, conflicting or not
          + voidsetRedoall(boolean redoall) + +
          +          set the redoall flag
          + voidsetResolvemode(java.lang.String resolvemode) + +
          +          values for resolvemode + + automatic -am + force -af + safe -as + theirs -at + yours -ay +
          + voidsetSimulationmode(boolean simulationmode) + +
          +          sets a flag
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Resolve

          +
          +public P4Resolve()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getResolvemode

          +
          +public java.lang.String getResolvemode()
          +
          +
          returns the resolve mode +

          +

          + +
          Returns:
          returns the resolve mode
          +
          +
          +
          + +

          +setResolvemode

          +
          +public void setResolvemode(java.lang.String resolvemode)
          +
          +
          values for resolvemode +
            +
          • automatic -am
            • +
          • force -af
            • +
          • safe -as
            • +
          • theirs -at
            • +
          • yours -ay
            • +
          +

          +

          +
          Parameters:
          resolvemode - one of automatic, force, safe, theirs, yours
          +
          +
          +
          + +

          +isRedoall

          +
          +public boolean isRedoall()
          +
          +
          allows previously resolved files to be resolved again +

          +

          + +
          Returns:
          flag indicating whether one wants to + allow previously resolved files to be resolved again
          +
          +
          +
          + +

          +setRedoall

          +
          +public void setRedoall(boolean redoall)
          +
          +
          set the redoall flag +

          +

          +
          Parameters:
          redoall - flag indicating whether one want to + allow previously resolved files to be resolved again
          +
          +
          +
          + +

          +isSimulationmode

          +
          +public boolean isSimulationmode()
          +
          +
          read the simulation mode flag +

          +

          + +
          Returns:
          flag indicating whether one wants just to simulate + the p4 resolve operation whithout actually doing it
          +
          +
          +
          + +

          +setSimulationmode

          +
          +public void setSimulationmode(boolean simulationmode)
          +
          +
          sets a flag +

          +

          +
          Parameters:
          simulationmode - set to true, lists the integrations which would be performed, + without actually doing them.
          +
          +
          +
          + +

          +isForcetextmode

          +
          +public boolean isForcetextmode()
          +
          +
          If set to true, attempts a textual merge, even for binary files +

          +

          + +
          Returns:
          flag value
          +
          +
          +
          + +

          +setForcetextmode

          +
          +public void setForcetextmode(boolean forcetextmode)
          +
          +
          If set to true, attempts a textual merge, even for binary files +

          +

          +
          Parameters:
          forcetextmode - set the flag value
          +
          +
          +
          + +

          +isMarkersforall

          +
          +public boolean isMarkersforall()
          +
          +
          If set to true, puts in markers for all changes, conflicting or not +

          +

          + +
          Returns:
          flag markersforall value
          +
          +
          +
          + +

          +setMarkersforall

          +
          +public void setMarkersforall(boolean markersforall)
          +
          +
          If set to true, puts in markers for all changes, conflicting or not +

          +

          +
          Parameters:
          markersforall - flag true or false
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          execute the p4 resolve +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if there is a wrong resolve mode specified + or no view specified
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.html new file mode 100644 index 000000000..9b956c33b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Revert.html @@ -0,0 +1,374 @@ + + + + + + +P4Revert (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Revert

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Revert
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Revert
          extends P4Base
          + + +

          +Revert Perforce open files or files in a changelist +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Revert() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + voidsetChange(java.lang.String revertChange) + +
          +          The changelist to revert; optional.
          + voidsetRevertOnlyUnchanged(boolean onlyUnchanged) + +
          +          flag to revert only unchanged files (p4 revert -a); optional, default false.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Revert

          +
          +public P4Revert()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setChange

          +
          +public void setChange(java.lang.String revertChange)
+               throws BuildException
          +
          +
          The changelist to revert; optional. +

          +

          +
          Parameters:
          revertChange - : the change list to revert +
          Throws: +
          BuildException - if the change list is null or empty string
          +
          +
          +
          + +

          +setRevertOnlyUnchanged

          +
          +public void setRevertOnlyUnchanged(boolean onlyUnchanged)
          +
          +
          flag to revert only unchanged files (p4 revert -a); optional, default false. +

          +

          +
          Parameters:
          onlyUnchanged - if set to true revert only unchanged files
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if an error occurs during the execution of the Perforce command + and failonError is set to true
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.P4SubmitAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.P4SubmitAdapter.html new file mode 100644 index 000000000..c1e8a2393 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.P4SubmitAdapter.html @@ -0,0 +1,277 @@ + + + + + + +P4Submit.P4SubmitAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Submit.P4SubmitAdapter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter
+      extended by org.apache.tools.ant.taskdefs.optional.perforce.SimpleP4OutputHandler
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Submit.P4SubmitAdapter
+
          +
          +
          All Implemented Interfaces:
          ExecuteStreamHandler, P4Handler
          +
          +
          +
          Enclosing class:
          P4Submit
          +
          +
          +
          +
          public class P4Submit.P4SubmitAdapter
          extends SimpleP4OutputHandler
          + + +

          +internal class used to process the output of p4 submit +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          P4Submit.P4SubmitAdapter(P4Base parent) + +
          +          Constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidprocess(java.lang.String line) + +
          +          process a line of stdout/stderr coming from Perforce
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter
          setOutput, setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start, stop
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Submit.P4SubmitAdapter

          +
          +public P4Submit.P4SubmitAdapter(P4Base parent)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          parent - a P4Base instance.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +process

          +
          +public void process(java.lang.String line)
          +
          +
          process a line of stdout/stderr coming from Perforce +

          +

          +
          Specified by:
          process in interface P4Handler
          Overrides:
          process in class SimpleP4OutputHandler
          +
          +
          +
          Parameters:
          line - line of stdout or stderr coming from Perforce
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html new file mode 100644 index 000000000..5029b97dc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Submit.html @@ -0,0 +1,449 @@ + + + + + + +P4Submit (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Submit

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Submit
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Submit
          extends P4Base
          + + +

          +Submits a numbered changelist to Perforce. + + Note: P4Submit cannot (yet) submit the default changelist. + This shouldn't be a problem with the ANT task as the usual flow is + P4Change to create a new numbered change followed by P4Edit then P4Submit. + + Example Usage:-
          + <p4submit change="${p4.change}" /> +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          + classP4Submit.P4SubmitAdapter + +
          +          internal class used to process the output of p4 submit
          +  + + + + + + + + + + +
          +Field Summary
          + java.lang.Stringchange + +
          +          change list number
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Submit() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + voidsetChange(java.lang.String change) + +
          +          set the change list number to submit
          + voidsetChangeProperty(java.lang.String changeProperty) + +
          +          property defining the change number if the change number gets renumbered
          + voidsetNeedsResolveProperty(java.lang.String needsResolveProperty) + +
          +          property defining the need to resolve the change list
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +change

          +
          +public java.lang.String change
          +
          +
          change list number +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Submit

          +
          +public P4Submit()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setChange

          +
          +public void setChange(java.lang.String change)
          +
          +
          set the change list number to submit +

          +

          +
          Parameters:
          change - The changelist number to submit; required.
          +
          +
          +
          + +

          +setChangeProperty

          +
          +public void setChangeProperty(java.lang.String changeProperty)
          +
          +
          property defining the change number if the change number gets renumbered +

          +

          +
          Parameters:
          changeProperty - name of a new property to which the change number + will be assigned if it changes
          Since:
          +
          ant 1.6.1
          +
          +
          +
          +
          + +

          +setNeedsResolveProperty

          +
          +public void setNeedsResolveProperty(java.lang.String needsResolveProperty)
          +
          +
          property defining the need to resolve the change list +

          +

          +
          Parameters:
          needsResolveProperty - a property which will be set if the change needs resolve
          Since:
          +
          ant 1.6.1
          +
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if no change list specified
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html new file mode 100644 index 000000000..8734d09e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/P4Sync.html @@ -0,0 +1,397 @@ + + + + + + +P4Sync (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class P4Sync

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Base
+              extended by org.apache.tools.ant.taskdefs.optional.perforce.P4Sync
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class P4Sync
          extends P4Base
          + + +

          +Synchronize client space to a Perforce depot view. + + The API allows additional functionality of the "p4 sync" command + (such as "p4 sync -f //...#have" or other exotic invocations).

          + + Example Usage: + + + + + + + + + +
          FunctionCommand
          Sync to head using P4USER, P4PORT and P4CLIENT settings specified<P4Sync
          P4view="//projects/foo/main/source/..."
          + P4User="fbloggs"
          P4Port="km01:1666"
          P4Client="fbloggsclient" />
          Sync to head using P4USER, P4PORT and P4CLIENT settings defined in environment<P4Sync P4view="//projects/foo/main/source/..." />
          Force a re-sync to head, refreshing all files<P4Sync force="yes" P4view="//projects/foo/main/source/..." />
          Sync to a label<P4Sync label="myPerforceLabel" />
          +

          + +

          +

          +
          To do:
          +
          Add decent label error handling for non-exsitant labels
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          failOnError, P4Client, P4CmdOpts, P4Opts, P4Port, P4User, P4View, shell, util
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          P4Sync() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          do the work
          + voidsetForce(java.lang.String force) + +
          +          force a refresh of files, if this attribute is set; false by default.
          + voidsetLabel(java.lang.String label) + +
          +          Label to sync client to; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4Base
          execP4Command, execP4Command, getErrorMessage, getInError, init, setClient, setCmdopts, setErrorMessage, setFailonerror, setGlobalopts, setInError, setPort, setUser, setView
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +P4Sync

          +
          +public P4Sync()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
+              throws BuildException
          +
          +
          Label to sync client to; optional. +

          +

          +
          Parameters:
          label - name of a label against which one want to sync +
          Throws: +
          BuildException - if label is null or empty string
          +
          +
          +
          + +

          +setForce

          +
          +public void setForce(java.lang.String force)
+              throws BuildException
          +
          +
          force a refresh of files, if this attribute is set; false by default. +

          +

          +
          Parameters:
          force - sync all files, whether they are supposed to be already uptodate or not. +
          Throws: +
          BuildException - if a label is set and force is null
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          do the work +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if an error occurs during the execution of the Perforce command + and failOnError is set to true
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.html new file mode 100644 index 000000000..0df21ae76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/SimpleP4OutputHandler.html @@ -0,0 +1,284 @@ + + + + + + +SimpleP4OutputHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.perforce +
          +Class SimpleP4OutputHandler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter
+      extended by org.apache.tools.ant.taskdefs.optional.perforce.SimpleP4OutputHandler
+
          +
          +
          All Implemented Interfaces:
          ExecuteStreamHandler, P4Handler
          +
          +
          +
          Direct Known Subclasses:
          P4Submit.P4SubmitAdapter
          +
          +
          +
          +
          public class SimpleP4OutputHandler
          extends P4HandlerAdapter
          + + +

          +simple implementation of P4HandlerAdapter used by tasks which are not + actually processing the output from Perforce +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SimpleP4OutputHandler(P4Base parent) + +
          +          simple constructor
          +  + + + + + + + + + + + +
          +Method Summary
          + voidprocess(java.lang.String line) + +
          +          process one line of stderr/stdout + if error conditions are detected, then setters are called on the + parent
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter
          setOutput, setProcessErrorStream, setProcessInputStream, setProcessOutputStream, start, stop
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SimpleP4OutputHandler

          +
          +public SimpleP4OutputHandler(P4Base parent)
          +
          +
          simple constructor +

          +

          +
          Parameters:
          parent - a P4Base instance
          +
          + + + + + + + + +
          +Method Detail
          + +

          +process

          +
          +public void process(java.lang.String line)
+             throws BuildException
          +
          +
          process one line of stderr/stdout + if error conditions are detected, then setters are called on the + parent +

          +

          +
          Specified by:
          process in interface P4Handler
          Specified by:
          process in class P4HandlerAdapter
          +
          +
          +
          Parameters:
          line - line of output +
          Throws: +
          BuildException - does not throw exceptions any more
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-frame.html new file mode 100644 index 000000000..89f68d7db --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-frame.html @@ -0,0 +1,81 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.perforce (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.perforce + + + + +
          +Interfaces  + +
          +P4Handler +
          +P4OutputHandler
          + + + + + + +
          +Classes  + +
          +P4Add +
          +P4Base +
          +P4Change +
          +P4Counter +
          +P4Delete +
          +P4Edit +
          +P4Fstat +
          +P4HandlerAdapter +
          +P4Have +
          +P4Integrate +
          +P4Label +
          +P4Labelsync +
          +P4OutputStream +
          +P4Reopen +
          +P4Resolve +
          +P4Revert +
          +P4Submit +
          +P4Sync +
          +SimpleP4OutputHandler
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-summary.html new file mode 100644 index 000000000..57664fdbd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-summary.html @@ -0,0 +1,278 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.perforce (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.perforce +

          +ANT Tasks for Perforce integration. +

          +See: +
          +          Description +

          + + + + + + + + + + + + + +
          +Interface Summary
          P4HandlerInterface for p4 job output stream handler.
          P4OutputHandlerInterface for p4 job output stream handler.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          P4AddAdds specified files to Perforce.
          P4BaseBase class for Perforce (P4) ANT tasks.
          P4ChangeRequests a new changelist from the Perforce server.
          P4CounterObtains or sets the value of a counter.
          P4DeleteCheckout files for deletion.
          P4EditOpen file(s) for edit.
          P4FstatP4Fstat--find out which files are under Perforce control and which are not.
          P4HandlerAdapterbase class to manage streams around the execution of the Perforce + command line client
          P4HaveLists Perforce files currently on client.
          P4IntegrateIntegrate file(s).
          P4LabelCreates a new Perforce label and set contents to reflect current + client file revisions.
          P4LabelsyncThis method syncs an existing Perforce label against the Perforce client + or against a set of files/revisions.
          P4OutputStreamheavily inspired from LogOutputStream + this stream class calls back the P4Handler on each line of stdout or stderr read
          P4ReopenReopen Perforce checkout files between changelists.
          P4Resolve 
          P4RevertRevert Perforce open files or files in a changelist
          P4SubmitSubmits a numbered changelist to Perforce.
          P4SyncSynchronize client space to a Perforce depot view.
          SimpleP4OutputHandlersimple implementation of P4HandlerAdapter used by tasks which are not + actually processing the output from Perforce
          +  + +

          +

          +Package org.apache.tools.ant.taskdefs.optional.perforce Description +

          + +

          +ANT Tasks for Perforce integration. + +These tasks provide basic P4 capabilities to automated ANT-based build systems. Note: +the tasks in this package are linked against the Jakarta ORO 2.0 library which +brings the power of Perl 5 regular expressions to Java. + +These tasks also require you to have the p4 (or p4.exe) client in your path. +

          + +

          +

          +
          Author:
          +
          Les Hughes
          +
          See Also:
          Ant Project, +Perforce, +P4Sync, +P4Label, +P4Have, +P4Change, +P4Edit, +P4Submit, +P4Counter
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-tree.html new file mode 100644 index 000000000..acdcfae35 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/perforce/package-tree.html @@ -0,0 +1,169 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.perforce Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.perforce +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) + +
            • org.apache.tools.ant.taskdefs.optional.perforce.P4HandlerAdapter (implements org.apache.tools.ant.taskdefs.optional.perforce.P4Handler) + +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.perforce.P4Base
                    +
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Add
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Change
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Counter
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Delete
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Edit
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Fstat
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Have
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Integrate
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Label
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Labelsync
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Reopen
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Resolve
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Revert
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Submit
                  • org.apache.tools.ant.taskdefs.optional.perforce.P4Sync
                  +
                +
              +
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html new file mode 100644 index 000000000..6b1959a95 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/Pvcs.html @@ -0,0 +1,1054 @@ + + + + + + +Pvcs (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.pvcs +
          +Class Pvcs

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Pvcs
          extends Task
          + + +

          +Extracts the latest edition of the source code from a PVCS repository. + PVCS is a version control system + developed by Merant. +
          + Before using this tag, the user running ant must have access to the commands + of PVCS (get and pcli) and must have access to the repository. Note that the way to specify + the repository is platform dependent so use property to specify location of repository. +
          + This version has been tested agains PVCS version 6.5 and 6.6 under Windows and Solaris. + + + 19-04-2001

          The task now has a more robust + parser. It allows for platform independant file paths + and supports file names with (). Thanks to Erik Husby for + bringing the bug to my attention. + + 27-04-2001

          UNC paths are now handled properly. + Fix provided by Don Jeffery. He also added an UpdateOnly flag + that, when true, conditions the PVCS get using the -U option to only + update those files that have a modification time (in PVCS) that is newer + than the existing workfile. + + 25-10-2002

          Added a revision attribute that currently is a + synonym for label, but in a future release the behavior of the label + attribute will change to use the -v option of GET. See bug #13847 for + discussion. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Pvcs() + +
          +          Creates a Pvcs object
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddPvcsproject(PvcsProject p) + +
          +          Specify a project within the PVCS repository to extract files from.
          + voidexecute() + +
          +          Called by the project to let the task do its work.
          + java.lang.StringgetConfig() + +
          +          returns the path of the configuration file to be used
          + java.lang.StringgetFilenameFormat() + +
          +          The filenameFormat attribute defines a MessageFormat string used + to parse the output of the pcli command.
          + java.lang.StringgetForce() + +
          +          Get value of force
          + booleangetIgnoreReturnCode() + +
          +          Get value of ignorereturncode
          + java.lang.StringgetLabel() + +
          +          Get value of label
          + java.lang.StringgetLineStart() + +
          +          The lineStart attribute is used to parse the output of the pcli + command.
          + java.lang.StringgetPromotiongroup() + +
          +          Get value of promotiongroup
          + java.lang.StringgetPvcsbin() + +
          +          Get name of the PVCS bin directory
          + java.lang.StringgetPvcsproject() + +
          +          Get name of the project in the PVCS repository
          + java.util.VectorgetPvcsprojects() + +
          +          Get name of the project in the PVCS repository
          + java.lang.StringgetRepository() + +
          +          Get network name of the PVCS repository
          + java.lang.StringgetRevision() + +
          +          Get value of revision
          + booleangetUpdateOnly() + +
          +          get the updateOnly attribute.
          + java.lang.StringgetUserId() + +
          +          Get the userid.
          + java.lang.StringgetWorkspace() + +
          +          Get name of the workspace to store the retrieved files
          +protected  intrunCmd(Commandline cmd, + ExecuteStreamHandler out) + +
          +          Run the command.
          + voidsetConfig(java.io.File f) + +
          +          Sets a configuration file other than the default to be used.
          + voidsetFilenameFormat(java.lang.String f) + +
          +          The format of the folder names; optional.
          + voidsetForce(java.lang.String f) + +
          +          Specifies the value of the force argument; optional.
          + voidsetIgnoreReturnCode(boolean b) + +
          +          If set to true the return value from executing the pvcs + commands are ignored; optional, default false.
          + voidsetLabel(java.lang.String l) + +
          +          Only files marked with this label are extracted; optional.
          + voidsetLineStart(java.lang.String l) + +
          +          What a valid return value from PVCS looks like + when it describes a file.
          + voidsetPromotiongroup(java.lang.String w) + +
          +          Specifies the name of the promotiongroup argument
          + voidsetPvcsbin(java.lang.String bin) + +
          +          Specifies the location of the PVCS bin directory; optional if on the PATH.
          + voidsetPvcsproject(java.lang.String prj) + +
          +          The project within the PVCS repository to extract files from; + optional, default "/"
          + voidsetRepository(java.lang.String repo) + +
          +          The network name of the PVCS repository; required.
          + voidsetRevision(java.lang.String r) + +
          +          Only files with this revision are extract; optional.
          + voidsetUpdateOnly(boolean l) + +
          +          If set to true files are fetched only if + newer than existing local files; optional, default false.
          + voidsetUserId(java.lang.String u) + +
          +          User ID
          + voidsetWorkspace(java.lang.String ws) + +
          +          Workspace to use; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Pvcs

          +
          +public Pvcs()
          +
          +
          Creates a Pvcs object +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +runCmd

          +
          +protected int runCmd(Commandline cmd,
+                     ExecuteStreamHandler out)
          +
          +
          Run the command. +

          +

          +
          Parameters:
          cmd - the command line to use.
          out - the output stream handler to use. +
          Returns:
          the exit code of the command.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Description copied from class: Task
          +
          Called by the project to let the task do its work. This method may be + called more than once, if the task is invoked more than once. + For example, + if target1 and target2 both depend on target3, then running + "ant target1 target2" will run all tasks in target3 twice. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - Something is stopping the build...
          +
          +
          +
          + +

          +getRepository

          +
          +public java.lang.String getRepository()
          +
          +
          Get network name of the PVCS repository +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +getFilenameFormat

          +
          +public java.lang.String getFilenameFormat()
          +
          +
          The filenameFormat attribute defines a MessageFormat string used + to parse the output of the pcli command. It defaults to + {0}-arc({1}). Repositories where the archive + extension is not -arc should set this. +

          +

          + +
          Returns:
          the filename format attribute.
          +
          +
          +
          + +

          +setFilenameFormat

          +
          +public void setFilenameFormat(java.lang.String f)
          +
          +
          The format of the folder names; optional. + This must be in a format suitable for + java.text.MessageFormat. + Index 1 of the format will be used as the file name. + Defaults to {0}-arc({1}) +

          +

          +
          Parameters:
          f - the format to use.
          +
          +
          +
          + +

          +getLineStart

          +
          +public java.lang.String getLineStart()
          +
          +
          The lineStart attribute is used to parse the output of the pcli + command. It defaults to "P:. The parser already + knows about / and \\, this property is useful in cases where the + repository is accessed on a Windows platform via a drive letter + mapping. +

          +

          + +
          Returns:
          the lineStart attribute.
          +
          +
          +
          + +

          +setLineStart

          +
          +public void setLineStart(java.lang.String l)
          +
          +
          What a valid return value from PVCS looks like + when it describes a file. Defaults to "P:. + If you are not using an UNC name for your repository and the + drive letter P is incorrect for your setup, you may + need to change this value, UNC names will always be + accepted. +

          +

          +
          Parameters:
          l - the value to use.
          +
          +
          +
          + +

          +setRepository

          +
          +public void setRepository(java.lang.String repo)
          +
          +
          The network name of the PVCS repository; required. +

          +

          +
          Parameters:
          repo - String
          +
          +
          +
          + +

          +getPvcsproject

          +
          +public java.lang.String getPvcsproject()
          +
          +
          Get name of the project in the PVCS repository +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setPvcsproject

          +
          +public void setPvcsproject(java.lang.String prj)
          +
          +
          The project within the PVCS repository to extract files from; + optional, default "/" +

          +

          +
          Parameters:
          prj - String
          +
          +
          +
          + +

          +getPvcsprojects

          +
          +public java.util.Vector getPvcsprojects()
          +
          +
          Get name of the project in the PVCS repository +

          +

          + +
          Returns:
          Vector
          +
          +
          +
          + +

          +getWorkspace

          +
          +public java.lang.String getWorkspace()
          +
          +
          Get name of the workspace to store the retrieved files +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setWorkspace

          +
          +public void setWorkspace(java.lang.String ws)
          +
          +
          Workspace to use; optional. + By specifying a workspace, the files are extracted to that location. + A PVCS workspace is a name for a location of the workfiles and + isn't as such the location itself. + You define the location for a workspace using the PVCS GUI clients. + If this isn't specified the default workspace for the current user is used. +

          +

          +
          Parameters:
          ws - String
          +
          +
          +
          + +

          +getPvcsbin

          +
          +public java.lang.String getPvcsbin()
          +
          +
          Get name of the PVCS bin directory +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setPvcsbin

          +
          +public void setPvcsbin(java.lang.String bin)
          +
          +
          Specifies the location of the PVCS bin directory; optional if on the PATH. + On some systems the PVCS executables pcli + and get are not found in the PATH. In such cases this attribute + should be set to the bin directory of the PVCS installation containing + the executables mentioned before. If this attribute isn't specified the + tag expects the executables to be found using the PATH environment variable. +

          +

          +
          Parameters:
          bin - PVCS bin directory
          To do:
          +
          use a File setter and resolve paths.
          +
          +
          +
          +
          + +

          +getForce

          +
          +public java.lang.String getForce()
          +
          +
          Get value of force +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setForce

          +
          +public void setForce(java.lang.String f)
          +
          +
          Specifies the value of the force argument; optional. + If set to yes all files that exists and are + writable are overwritten. Default no causes the files + that are writable to be ignored. This stops the PVCS command + get to stop asking questions! +

          +

          +
          Parameters:
          f - String (yes/no)
          To do:
          +
          make a boolean setter
          +
          +
          +
          +
          + +

          +getPromotiongroup

          +
          +public java.lang.String getPromotiongroup()
          +
          +
          Get value of promotiongroup +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setPromotiongroup

          +
          +public void setPromotiongroup(java.lang.String w)
          +
          +
          Specifies the name of the promotiongroup argument +

          +

          +
          Parameters:
          w - String
          +
          +
          +
          + +

          +getLabel

          +
          +public java.lang.String getLabel()
          +
          +
          Get value of label +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String l)
          +
          +
          Only files marked with this label are extracted; optional. +

          +

          +
          Parameters:
          l - String
          +
          +
          +
          + +

          +getRevision

          +
          +public java.lang.String getRevision()
          +
          +
          Get value of revision +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setRevision

          +
          +public void setRevision(java.lang.String r)
          +
          +
          Only files with this revision are extract; optional. +

          +

          +
          Parameters:
          r - String
          +
          +
          +
          + +

          +getIgnoreReturnCode

          +
          +public boolean getIgnoreReturnCode()
          +
          +
          Get value of ignorereturncode +

          +

          + +
          Returns:
          String
          +
          +
          +
          + +

          +setIgnoreReturnCode

          +
          +public void setIgnoreReturnCode(boolean b)
          +
          +
          If set to true the return value from executing the pvcs + commands are ignored; optional, default false. +

          +

          +
          Parameters:
          b - a boolean value.
          +
          +
          +
          + +

          +addPvcsproject

          +
          +public void addPvcsproject(PvcsProject p)
          +
          +
          Specify a project within the PVCS repository to extract files from. +

          +

          +
          Parameters:
          p - the pvcs project to use.
          +
          +
          +
          + +

          +getUpdateOnly

          +
          +public boolean getUpdateOnly()
          +
          +
          get the updateOnly attribute. +

          +

          + +
          Returns:
          the updateOnly attribute.
          +
          +
          +
          + +

          +setUpdateOnly

          +
          +public void setUpdateOnly(boolean l)
          +
          +
          If set to true files are fetched only if + newer than existing local files; optional, default false. +

          +

          +
          Parameters:
          l - a boolean value.
          +
          +
          +
          + +

          +getConfig

          +
          +public java.lang.String getConfig()
          +
          +
          returns the path of the configuration file to be used +

          +

          + +
          Returns:
          the path of the config file
          +
          +
          +
          + +

          +setConfig

          +
          +public void setConfig(java.io.File f)
          +
          +
          Sets a configuration file other than the default to be used. + These files have a .cfg extension and are often found in archive or pvcsprop folders. +

          +

          +
          Parameters:
          f - config file - can be given absolute or relative to ant basedir
          +
          +
          +
          + +

          +getUserId

          +
          +public java.lang.String getUserId()
          +
          +
          Get the userid. +

          +

          + +
          Returns:
          the userid.
          +
          +
          +
          + +

          +setUserId

          +
          +public void setUserId(java.lang.String u)
          +
          +
          User ID +

          +

          +
          Parameters:
          u - the value to use.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html new file mode 100644 index 000000000..460947f3b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/PvcsProject.html @@ -0,0 +1,277 @@ + + + + + + +PvcsProject (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.pvcs +
          +Class PvcsProject

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject
+
          +
          +
          +
          public class PvcsProject
          extends java.lang.Object
          + + +

          +represents a project within the PVCS repository to extract files from. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          PvcsProject() + +
          +          no arg constructor
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetName() + +
          +          Get the name of the project
          + voidsetName(java.lang.String name) + +
          +          Set the name of the project
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PvcsProject

          +
          +public PvcsProject()
          +
          +
          no arg constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set the name of the project +

          +

          +
          Parameters:
          name - the value to use.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of the project +

          +

          + +
          Returns:
          the name of the project.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-frame.html new file mode 100644 index 000000000..485985502 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.pvcs (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.pvcs + + + + +
          +Classes  + +
          +Pvcs +
          +PvcsProject
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-summary.html new file mode 100644 index 000000000..737dcc617 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-summary.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.pvcs (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.pvcs +

          + + + + + + + + + + + + + +
          +Class Summary
          PvcsExtracts the latest edition of the source code from a PVCS repository.
          PvcsProjectrepresents a project within the PVCS repository to extract files from.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-tree.html new file mode 100644 index 000000000..f9081b9a6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/pvcs/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.pvcs Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.pvcs +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.pvcs.Pvcs
                +
              +
            • org.apache.tools.ant.taskdefs.optional.pvcs.PvcsProject
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html new file mode 100644 index 000000000..4e9815c4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.Attribute.html @@ -0,0 +1,256 @@ + + + + + + +ScriptDef.Attribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.script +
          +Class ScriptDef.Attribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.script.ScriptDef.Attribute
+
          +
          +
          Enclosing class:
          ScriptDef
          +
          +
          +
          +
          public static class ScriptDef.Attribute
          extends java.lang.Object
          + + +

          +Class representing an attribute definition +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptDef.Attribute() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + voidsetName(java.lang.String name) + +
          +          Set the attribute name
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptDef.Attribute

          +
          +public ScriptDef.Attribute()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set the attribute name +

          +

          +
          Parameters:
          name - the attribute name
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html new file mode 100644 index 000000000..5cc3389d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.NestedElement.html @@ -0,0 +1,304 @@ + + + + + + +ScriptDef.NestedElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.script +
          +Class ScriptDef.NestedElement

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.script.ScriptDef.NestedElement
+
          +
          +
          Enclosing class:
          ScriptDef
          +
          +
          +
          +
          public static class ScriptDef.NestedElement
          extends java.lang.Object
          + + +

          +Class to represent a nested element definition +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptDef.NestedElement() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetClassName(java.lang.String className) + +
          +          Set the classname of the class to be used for the nested element.
          + voidsetName(java.lang.String name) + +
          +          set the tag name for this nested element
          + voidsetType(java.lang.String type) + +
          +          Set the type of this element.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptDef.NestedElement

          +
          +public ScriptDef.NestedElement()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          set the tag name for this nested element +

          +

          +
          Parameters:
          name - the name of this nested element
          +
          +
          +
          + +

          +setType

          +
          +public void setType(java.lang.String type)
          +
          +
          Set the type of this element. This is the name of an + Ant task or type which is to be used when this element is to be + created. This is an alternative to specifying the class name directly +

          +

          +
          Parameters:
          type - the name of an Ant type, or task, to use for this nested + element.
          +
          +
          +
          + +

          +setClassName

          +
          +public void setClassName(java.lang.String className)
          +
          +
          Set the classname of the class to be used for the nested element. + This specifies the class directly and is an alternative to specifying + the Ant type name. +

          +

          +
          Parameters:
          className - the name of the class to use for this nested + element.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html new file mode 100644 index 000000000..51e1adccb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDef.html @@ -0,0 +1,649 @@ + + + + + + +ScriptDef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.script +
          +Class ScriptDef

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.AntlibDefinition
+              extended by org.apache.tools.ant.taskdefs.DefBase
+                  extended by org.apache.tools.ant.taskdefs.optional.script.ScriptDef
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class ScriptDef
          extends DefBase
          + + +

          +Define a task using a script +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classScriptDef.Attribute + +
          +          Class representing an attribute definition
          +static classScriptDef.NestedElement + +
          +          Class to represent a nested element definition
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptDef() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection resource) + +
          +          Add any source resource.
          + voidaddAttribute(ScriptDef.Attribute attribute) + +
          +          Add an attribute definition to this script.
          + voidaddElement(ScriptDef.NestedElement nestedElement) + +
          +          Add a nested element definition.
          + voidaddText(java.lang.String text) + +
          +          Set the script text.
          + java.lang.ObjectcreateNestedElement(java.lang.String elementName) + +
          +          Create a nested element to be configured.
          + voidexecute() + +
          +          Define the script.
          + voidexecuteScript(java.util.Map attributes, + java.util.Map elements) + +
          +          Deprecated. since 1.7. + Use executeScript(attribute, elements, instance) instead.
          + voidexecuteScript(java.util.Map attributes, + java.util.Map elements, + ScriptDefBase instance) + +
          +          Execute the script.
          + booleanisAttributeSupported(java.lang.String attributeName) + +
          +          Indicates whether the task supports a given attribute name
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetManager(java.lang.String manager) + +
          +          Defines the manager.
          + voidsetName(java.lang.String name) + +
          +          set the name under which this script will be activated in a build + file
          + voidsetProject(Project project) + +
          +          Set the project.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file ; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.DefBase
          createClasspath, createLoader, getClasspath, getClasspathId, getLoaderId, hasCpDelegate, init, isReverseLoader, setClasspath, setClasspathRef, setLoaderRef, setReverseLoader
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.AntlibDefinition
          getAntlibClassLoader, getURI, setAntlibClassLoader, setURI
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptDef

          +
          +public ScriptDef()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Set the project. +

          +

          +
          Overrides:
          setProject in class ProjectComponent
          +
          +
          +
          Parameters:
          project - the project that this def belows to.
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          set the name under which this script will be activated in a build + file +

          +

          +
          Parameters:
          name - the name of the script
          +
          +
          +
          + +

          +isAttributeSupported

          +
          +public boolean isAttributeSupported(java.lang.String attributeName)
          +
          +
          Indicates whether the task supports a given attribute name +

          +

          +
          Parameters:
          attributeName - the name of the attribute. +
          Returns:
          true if the attribute is supported by the script.
          +
          +
          +
          + +

          +addAttribute

          +
          +public void addAttribute(ScriptDef.Attribute attribute)
          +
          +
          Add an attribute definition to this script. +

          +

          +
          Parameters:
          attribute - the attribute definition.
          +
          +
          +
          + +

          +addElement

          +
          +public void addElement(ScriptDef.NestedElement nestedElement)
          +
          +
          Add a nested element definition. +

          +

          +
          Parameters:
          nestedElement - the nested element definition.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
          +
          +
          Define the script. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          +
          +
          +
          +
          + +

          +createNestedElement

          +
          +public java.lang.Object createNestedElement(java.lang.String elementName)
          +
          +
          Create a nested element to be configured. +

          +

          +
          Parameters:
          elementName - the name of the nested element. +
          Returns:
          object representing the element name.
          +
          +
          +
          + +

          +executeScript

          +
          +public void executeScript(java.util.Map attributes,
+                          java.util.Map elements)
          +
          +
          Deprecated. since 1.7. + Use executeScript(attribute, elements, instance) instead. +

          +

          Execute the script. +

          +

          +
          Parameters:
          attributes - collection of attributes
          elements - a list of nested element values.
          +
          +
          +
          + +

          +executeScript

          +
          +public void executeScript(java.util.Map attributes,
+                          java.util.Map elements,
+                          ScriptDefBase instance)
          +
          +
          Execute the script. + This is called by the script instance to execute the script for this + definition. +

          +

          +
          Parameters:
          attributes - collection of attributes
          elements - a list of nested element values.
          instance - the script instance; can be null
          +
          +
          +
          + +

          +setManager

          +
          +public void setManager(java.lang.String manager)
          +
          +
          Defines the manager. +

          +

          +
          Parameters:
          manager - the scripting manager.
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file ; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Set the script text. +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection resource)
          +
          +
          Add any source resource. +

          +

          +
          Parameters:
          resource - source of script
          Since:
          +
          Ant1.7.1
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDefBase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDefBase.html new file mode 100644 index 000000000..e25fb9d45 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/ScriptDefBase.html @@ -0,0 +1,447 @@ + + + + + + +ScriptDefBase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.script +
          +Class ScriptDefBase

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.script.ScriptDefBase
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DynamicAttribute, DynamicConfigurator, DynamicElement
          +
          +
          +
          +
          public class ScriptDefBase
          extends Task
          implements DynamicConfigurator
          + + +

          +The script execution class. This class finds the defining script task + and passes control to that task's executeScript method. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptDefBase() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          Set the script text.
          + java.lang.ObjectcreateDynamicElement(java.lang.String name) + +
          +          Create a nested element
          + voidexecute() + +
          +          Locate the script defining task and execute the script by passing + control to it
          + voidfail(java.lang.String message) + +
          +          Utility method for nested scripts; throws a BuildException + with the given message.
          + java.lang.StringgetText() + +
          +          get the text of this element; may be null
          + voidsetDynamicAttribute(java.lang.String name, + java.lang.String value) + +
          +          Set a task attribute
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptDefBase

          +
          +public ScriptDefBase()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
          +
          +
          Locate the script defining task and execute the script by passing + control to it +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          +
          +
          +
          +
          + +

          +createDynamicElement

          +
          +public java.lang.Object createDynamicElement(java.lang.String name)
          +
          +
          Create a nested element +

          +

          +
          Specified by:
          createDynamicElement in interface DynamicElement
          +
          +
          +
          Parameters:
          name - the nested element name +
          Returns:
          the element to be configured
          +
          +
          +
          + +

          +setDynamicAttribute

          +
          +public void setDynamicAttribute(java.lang.String name,
+                                java.lang.String value)
          +
          +
          Set a task attribute +

          +

          +
          Specified by:
          setDynamicAttribute in interface DynamicAttribute
          +
          +
          +
          Parameters:
          name - the attribute name.
          value - the attribute's string value
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Set the script text. +

          +

          +
          +
          +
          +
          Parameters:
          text - a component of the script text to be added.
          Since:
          +
          ant1.7
          +
          +
          +
          +
          + +

          +getText

          +
          +public java.lang.String getText()
          +
          +
          get the text of this element; may be null +

          +

          +
          +
          +
          + +
          Returns:
          text or null for no nested text
          Since:
          +
          ant1.7
          +
          +
          +
          +
          + +

          +fail

          +
          +public void fail(java.lang.String message)
          +
          +
          Utility method for nested scripts; throws a BuildException + with the given message. +

          +

          +
          +
          +
          +
          Parameters:
          message - text to pass to the BuildException +
          Throws: +
          BuildException - always.
          Since:
          +
          ant1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-frame.html new file mode 100644 index 000000000..588293fae --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.script (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.script + + + + +
          +Classes  + +
          +ScriptDef +
          +ScriptDef.Attribute +
          +ScriptDef.NestedElement +
          +ScriptDefBase
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-summary.html new file mode 100644 index 000000000..c97816e91 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-summary.html @@ -0,0 +1,164 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.script (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.script +

          + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          ScriptDefDefine a task using a script
          ScriptDef.AttributeClass representing an attribute definition
          ScriptDef.NestedElementClass to represent a nested element definition
          ScriptDefBaseThe script execution class.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-tree.html new file mode 100644 index 000000000..2dc2fc06d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/script/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.script Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.script +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOS.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOS.html new file mode 100644 index 000000000..7ada4a954 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOS.html @@ -0,0 +1,1219 @@ + + + + + + +SOS (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Class SOS

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sos.SOS
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SOSCmd
          +
          +
          +
          Direct Known Subclasses:
          SOSCheckin, SOSCheckout, SOSGet, SOSLabel
          +
          +
          +
          +
          public abstract class SOS
          extends Task
          implements SOSCmd
          + + +

          +A base class for creating tasks for executing commands on SourceOffSite. + + These tasks were inspired by the VSS tasks. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  CommandlinecommandLine + +
          +          Commandline to be executed.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          SOS() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Execute the created command line.
          +protected  java.lang.StringgetComment() + +
          +          Get the comment
          +protected  java.lang.StringgetFilename() + +
          +          Get the filename to be acted upon.
          +protected  java.lang.StringgetLabel() + +
          +          Get the label
          +protected  java.lang.StringgetLocalPath() + +
          +          Builds and returns the working directory.
          +protected  java.lang.StringgetNoCache() + +
          +          Get the NoCache flag.
          +protected  java.lang.StringgetNoCompress() + +
          +          Get the NoCompress flag.
          +protected  voidgetOptionalAttributes() + +
          +          Adds the optional attributes to the command line.
          +protected  java.lang.StringgetPassword() + +
          +          Get the password
          +protected  java.lang.StringgetProjectPath() + +
          +          Get the project path
          +protected  java.lang.StringgetRecursive() + +
          +          Get the 'recursive' Flag.
          +protected  voidgetRequiredAttributes() + +
          +          Sets the executable and add the required attributes to the command line.
          +protected  java.lang.StringgetSosCommand() + +
          +          Get the executable to run.
          +protected  java.lang.StringgetSosHome() + +
          +          Get the SOS home directory.
          +protected  java.lang.StringgetSosServerPath() + +
          +          Get the SOS serve path.
          +protected  java.lang.StringgetUsername() + +
          +          Get the username
          +protected  java.lang.StringgetVerbose() + +
          +          Get the 'verbose' Flag.
          +protected  java.lang.StringgetVersion() + +
          +          Get the version
          +protected  java.lang.StringgetVssServerPath() + +
          +          Get the VSS server path
          +protected  intrun(Commandline cmd) + +
          +          Execute the created command line.
          +protected  voidsetInternalComment(java.lang.String text) + +
          +          Set the comment text.
          +protected  voidsetInternalFilename(java.lang.String file) + +
          +          Set the file name.
          +protected  voidsetInternalLabel(java.lang.String text) + +
          +          Set the label.
          +protected  voidsetInternalRecursive(boolean recurse) + +
          +          Set the recursive flag.
          +protected  voidsetInternalVersion(java.lang.String text) + +
          +          Set the version.
          + voidsetLocalPath(Path path) + +
          +          Override the working directory and get to the specified path.
          + voidsetNoCache(boolean nocache) + +
          +          Flag to disable the cache when set.
          + voidsetNoCompress(boolean nocompress) + +
          +          Flag to disable compression when set.
          + voidsetPassword(java.lang.String password) + +
          +          The SourceSafe password.
          + voidsetProjectPath(java.lang.String projectpath) + +
          +          The SourceSafe project path.
          + voidsetSosCmd(java.lang.String dir) + +
          +          The directory where soscmd(.exe) is located.
          + voidsetSosHome(java.lang.String sosHome) + +
          +          Path to the SourceOffSite home directory.
          + voidsetSosServerPath(java.lang.String sosServerPath) + +
          +          The address and port of SourceOffSite Server, + for example 192.168.0.1:8888.
          + voidsetUsername(java.lang.String username) + +
          +          The SourceSafe username.
          + voidsetVerbose(boolean verbose) + +
          +          Enable verbose output.
          + voidsetVssServerPath(java.lang.String vssServerPath) + +
          +          The path to the location of the ss.ini file.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +commandLine

          +
          +protected Commandline commandLine
          +
          +
          Commandline to be executed. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SOS

          +
          +public SOS()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setNoCache

          +
          +public final void setNoCache(boolean nocache)
          +
          +
          Flag to disable the cache when set. + Required if SOSHOME is set as an environment variable. + Defaults to false. +

          +

          +
          +
          +
          +
          Parameters:
          nocache - True to disable caching.
          +
          +
          +
          + +

          +setNoCompress

          +
          +public final void setNoCompress(boolean nocompress)
          +
          +
          Flag to disable compression when set. Defaults to false. +

          +

          +
          +
          +
          +
          Parameters:
          nocompress - True to disable compression.
          +
          +
          +
          + +

          +setSosCmd

          +
          +public final void setSosCmd(java.lang.String dir)
          +
          +
          The directory where soscmd(.exe) is located. + soscmd must be on the path if omitted. +

          +

          +
          +
          +
          +
          Parameters:
          dir - The new sosCmd value.
          +
          +
          +
          + +

          +setUsername

          +
          +public final void setUsername(java.lang.String username)
          +
          +
          The SourceSafe username. +

          +

          +
          +
          +
          +
          Parameters:
          username - The new username value.
          +
          +
          +
          + +

          +setPassword

          +
          +public final void setPassword(java.lang.String password)
          +
          +
          The SourceSafe password. +

          +

          +
          +
          +
          +
          Parameters:
          password - The new password value.
          +
          +
          +
          + +

          +setProjectPath

          +
          +public final void setProjectPath(java.lang.String projectpath)
          +
          +
          The SourceSafe project path. +

          +

          +
          +
          +
          +
          Parameters:
          projectpath - The new projectpath value.
          +
          +
          +
          + +

          +setVssServerPath

          +
          +public final void setVssServerPath(java.lang.String vssServerPath)
          +
          +
          The path to the location of the ss.ini file. +

          +

          +
          +
          +
          +
          Parameters:
          vssServerPath - The new vssServerPath value.
          +
          +
          +
          + +

          +setSosHome

          +
          +public final void setSosHome(java.lang.String sosHome)
          +
          +
          Path to the SourceOffSite home directory. +

          +

          +
          +
          +
          +
          Parameters:
          sosHome - The new sosHome value.
          +
          +
          +
          + +

          +setSosServerPath

          +
          +public final void setSosServerPath(java.lang.String sosServerPath)
          +
          +
          The address and port of SourceOffSite Server, + for example 192.168.0.1:8888. +

          +

          +
          +
          +
          +
          Parameters:
          sosServerPath - The new sosServerPath value.
          +
          +
          +
          + +

          +setLocalPath

          +
          +public final void setLocalPath(Path path)
          +
          +
          Override the working directory and get to the specified path. +

          +

          +
          +
          +
          +
          Parameters:
          path - The new localPath value.
          +
          +
          +
          + +

          +setVerbose

          +
          +public void setVerbose(boolean verbose)
          +
          +
          Enable verbose output. Defaults to false. +

          +

          +
          +
          +
          +
          Parameters:
          verbose - True for verbose output.
          +
          +
          +
          + +

          +setInternalFilename

          +
          +protected void setInternalFilename(java.lang.String file)
          +
          +
          Set the file name. +

          +

          +
          +
          +
          +
          Parameters:
          file - the filename to use.
          +
          +
          +
          + +

          +setInternalRecursive

          +
          +protected void setInternalRecursive(boolean recurse)
          +
          +
          Set the recursive flag. +

          +

          +
          +
          +
          +
          Parameters:
          recurse - if true use the recursive flag on the command line.
          +
          +
          +
          + +

          +setInternalComment

          +
          +protected void setInternalComment(java.lang.String text)
          +
          +
          Set the comment text. +

          +

          +
          +
          +
          +
          Parameters:
          text - the comment text to use.
          +
          +
          +
          + +

          +setInternalLabel

          +
          +protected void setInternalLabel(java.lang.String text)
          +
          +
          Set the label. +

          +

          +
          +
          +
          +
          Parameters:
          text - the label to use.
          +
          +
          +
          + +

          +setInternalVersion

          +
          +protected void setInternalVersion(java.lang.String text)
          +
          +
          Set the version. +

          +

          +
          +
          +
          +
          Parameters:
          text - the version to use.
          +
          +
          +
          + +

          +getSosCommand

          +
          +protected java.lang.String getSosCommand()
          +
          +
          Get the executable to run. Add the path if it was specifed in the build file +

          +

          +
          +
          +
          + +
          Returns:
          the executable to run.
          +
          +
          +
          + +

          +getComment

          +
          +protected java.lang.String getComment()
          +
          +
          Get the comment +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getVersion

          +
          +protected java.lang.String getVersion()
          +
          +
          Get the version +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getLabel

          +
          +protected java.lang.String getLabel()
          +
          +
          Get the label +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getUsername

          +
          +protected java.lang.String getUsername()
          +
          +
          Get the username +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getPassword

          +
          +protected java.lang.String getPassword()
          +
          +
          Get the password +

          +

          +
          +
          +
          + +
          Returns:
          empty string if it wasn't set.
          +
          +
          +
          + +

          +getProjectPath

          +
          +protected java.lang.String getProjectPath()
          +
          +
          Get the project path +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getVssServerPath

          +
          +protected java.lang.String getVssServerPath()
          +
          +
          Get the VSS server path +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getSosHome

          +
          +protected java.lang.String getSosHome()
          +
          +
          Get the SOS home directory. +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getSosServerPath

          +
          +protected java.lang.String getSosServerPath()
          +
          +
          Get the SOS serve path. +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getFilename

          +
          +protected java.lang.String getFilename()
          +
          +
          Get the filename to be acted upon. +

          +

          +
          +
          +
          + +
          Returns:
          if it was set, null if not.
          +
          +
          +
          + +

          +getNoCompress

          +
          +protected java.lang.String getNoCompress()
          +
          +
          Get the NoCompress flag. +

          +

          +
          +
          +
          + +
          Returns:
          the 'nocompress' Flag if the attribute was 'true', + otherwise an empty string.
          +
          +
          +
          + +

          +getNoCache

          +
          +protected java.lang.String getNoCache()
          +
          +
          Get the NoCache flag. +

          +

          +
          +
          +
          + +
          Returns:
          the 'nocache' Flag if the attribute was 'true', otherwise an empty string.
          +
          +
          +
          + +

          +getVerbose

          +
          +protected java.lang.String getVerbose()
          +
          +
          Get the 'verbose' Flag. +

          +

          +
          +
          +
          + +
          Returns:
          the 'verbose' Flag if the attribute was 'true', otherwise an empty string.
          +
          +
          +
          + +

          +getRecursive

          +
          +protected java.lang.String getRecursive()
          +
          +
          Get the 'recursive' Flag. +

          +

          +
          +
          +
          + +
          Returns:
          the 'recursive' Flag if the attribute was 'true', otherwise an empty string.
          +
          +
          +
          + +

          +getLocalPath

          +
          +protected java.lang.String getLocalPath()
          +
          +
          Builds and returns the working directory. +

          + The localpath is created if it didn't exist. +

          +

          +
          +
          +
          + +
          Returns:
          the absolute path of the working directory.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute the created command line. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +run

          +
          +protected int run(Commandline cmd)
          +
          +
          Execute the created command line. +

          +

          +
          +
          +
          +
          Parameters:
          cmd - The command line to run. +
          Returns:
          int the exit code. +
          Throws: +
          BuildException
          +
          +
          +
          + +

          +getRequiredAttributes

          +
          +protected void getRequiredAttributes()
          +
          +
          Sets the executable and add the required attributes to the command line. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +getOptionalAttributes

          +
          +protected void getOptionalAttributes()
          +
          +
          Adds the optional attributes to the command line. +

          +

          +
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html new file mode 100644 index 000000000..58f9c65b3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckin.html @@ -0,0 +1,409 @@ + + + + + + +SOSCheckin (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Class SOSCheckin

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sos.SOS
+              extended by org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SOSCmd
          +
          +
          +
          +
          public class SOSCheckin
          extends SOS
          + + +

          +Commits and unlocks files in Visual SourceSafe via a SourceOffSite server. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          commandLine
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          SOSCheckin() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Build the command line.
          + voidsetComment(java.lang.String comment) + +
          +          The comment to apply to all files being labelled.
          + voidsetFile(java.lang.String filename) + +
          +          The filename to act upon.
          + voidsetRecursive(boolean recursive) + +
          +          Flag to recursively apply the action.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          execute, getComment, getFilename, getLabel, getLocalPath, getNoCache, getNoCompress, getOptionalAttributes, getPassword, getProjectPath, getRecursive, getRequiredAttributes, getSosCommand, getSosHome, getSosServerPath, getUsername, getVerbose, getVersion, getVssServerPath, run, setInternalComment, setInternalFilename, setInternalLabel, setInternalRecursive, setInternalVersion, setLocalPath, setNoCache, setNoCompress, setPassword, setProjectPath, setSosCmd, setSosHome, setSosServerPath, setUsername, setVerbose, setVssServerPath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SOSCheckin

          +
          +public SOSCheckin()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public final void setFile(java.lang.String filename)
          +
          +
          The filename to act upon. + If no file is specified then the task + acts upon the project. +

          +

          +
          Parameters:
          filename - The new file value
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Flag to recursively apply the action. Defaults to false. +

          +

          +
          Parameters:
          recursive - True for recursive operation.
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          The comment to apply to all files being labelled. +

          +

          +
          Parameters:
          comment - The new comment value
          +
          +
          +
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Build the command line.

          + + CheckInFile required parameters: -server -name -password -database -project + -file
          + CheckInFile optional parameters: -workdir -log -verbose -nocache -nocompression + -soshome
          + CheckInProject required parameters: -server -name -password -database + -project
          + CheckInProject optional parameters: workdir -recursive -log -verbose + -nocache -nocompression -soshome
          +

          +

          +
          +
          +
          + +
          Returns:
          Commandline the generated command to be executed
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html new file mode 100644 index 000000000..481e5048b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCheckout.html @@ -0,0 +1,393 @@ + + + + + + +SOSCheckout (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Class SOSCheckout

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sos.SOS
+              extended by org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SOSCmd
          +
          +
          +
          +
          public class SOSCheckout
          extends SOS
          + + +

          +Retrieves and locks files in Visual SourceSafe via a SourceOffSite server. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          commandLine
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          SOSCheckout() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Build the command line
          + + CheckOutFile required parameters: -server -name -password -database -project -file
          + CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
          + + CheckOutProject required parameters: -server -name -password -database -project
          + CheckOutProject optional parameters:-workdir -recursive -verbose -nocache + -nocompression -soshome
          + voidsetFile(java.lang.String filename) + +
          +          The filename to act upon.
          + voidsetRecursive(boolean recursive) + +
          +          Flag to recursively apply the action.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          execute, getComment, getFilename, getLabel, getLocalPath, getNoCache, getNoCompress, getOptionalAttributes, getPassword, getProjectPath, getRecursive, getRequiredAttributes, getSosCommand, getSosHome, getSosServerPath, getUsername, getVerbose, getVersion, getVssServerPath, run, setInternalComment, setInternalFilename, setInternalLabel, setInternalRecursive, setInternalVersion, setLocalPath, setNoCache, setNoCompress, setPassword, setProjectPath, setSosCmd, setSosHome, setSosServerPath, setUsername, setVerbose, setVssServerPath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SOSCheckout

          +
          +public SOSCheckout()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public final void setFile(java.lang.String filename)
          +
          +
          The filename to act upon. + If no file is specified then the task + acts upon the project. +

          +

          +
          Parameters:
          filename - The new file value
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Flag to recursively apply the action. Defaults to false. +

          +

          +
          Parameters:
          recursive - True for recursive operation.
          +
          +
          +
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Build the command line
          + + CheckOutFile required parameters: -server -name -password -database -project -file
          + CheckOutFile optional parameters: -workdir -verbose -nocache -nocompression -soshome
          + + CheckOutProject required parameters: -server -name -password -database -project
          + CheckOutProject optional parameters:-workdir -recursive -verbose -nocache + -nocompression -soshome
          +

          +

          +
          +
          +
          + +
          Returns:
          Commandline the generated command to be executed
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html new file mode 100644 index 000000000..b5693c561 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSCmd.html @@ -0,0 +1,708 @@ + + + + + + +SOSCmd (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Interface SOSCmd

          +
          +
          All Known Implementing Classes:
          SOS, SOSCheckin, SOSCheckout, SOSGet, SOSLabel
          +
          +
          +
          +
          public interface SOSCmd
          + + +

          +Interface to hold constants used by the SOS tasks +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMMAND_CHECKIN_FILE + +
          +          The checkin file command
          +static java.lang.StringCOMMAND_CHECKIN_PROJECT + +
          +          The checkin project command
          +static java.lang.StringCOMMAND_CHECKOUT_FILE + +
          +          The checkout file command
          +static java.lang.StringCOMMAND_CHECKOUT_PROJECT + +
          +          The checkout project command
          +static java.lang.StringCOMMAND_GET_FILE + +
          +          The get file command
          +static java.lang.StringCOMMAND_GET_PROJECT + +
          +          The get project command
          +static java.lang.StringCOMMAND_HISTORY + +
          +          The get history command
          +static java.lang.StringCOMMAND_LABEL + +
          +          The add label command
          +static java.lang.StringCOMMAND_SOS_EXE + +
          +          The sos executable
          +static java.lang.StringFLAG_COMMAND + +
          +          The command option
          +static java.lang.StringFLAG_COMMENT + +
          +          The log option
          +static java.lang.StringFLAG_FILE + +
          +          The file option
          +static java.lang.StringFLAG_LABEL + +
          +          The label option
          +static java.lang.StringFLAG_NO_CACHE + +
          +          The no cache option
          +static java.lang.StringFLAG_NO_COMPRESSION + +
          +          The no compression option
          +static java.lang.StringFLAG_PASSWORD + +
          +          The password option
          +static java.lang.StringFLAG_PROJECT + +
          +          The project option
          +static java.lang.StringFLAG_RECURSION + +
          +          The recursive option
          +static java.lang.StringFLAG_SOS_HOME + +
          +          The sos home option
          +static java.lang.StringFLAG_SOS_SERVER + +
          +          The server option
          +static java.lang.StringFLAG_USERNAME + +
          +          The username option
          +static java.lang.StringFLAG_VERBOSE + +
          +          The verbose option
          +static java.lang.StringFLAG_VERSION + +
          +          The revision option
          +static java.lang.StringFLAG_VSS_SERVER + +
          +          The database (vss server) option
          +static java.lang.StringFLAG_WORKING_DIR + +
          +          The workdir option
          +static java.lang.StringPROJECT_PREFIX + +
          +          The project prefix
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +COMMAND_SOS_EXE

          +
          +static final java.lang.String COMMAND_SOS_EXE
          +
          +
          The sos executable +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_GET_FILE

          +
          +static final java.lang.String COMMAND_GET_FILE
          +
          +
          The get file command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_GET_PROJECT

          +
          +static final java.lang.String COMMAND_GET_PROJECT
          +
          +
          The get project command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKOUT_FILE

          +
          +static final java.lang.String COMMAND_CHECKOUT_FILE
          +
          +
          The checkout file command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKOUT_PROJECT

          +
          +static final java.lang.String COMMAND_CHECKOUT_PROJECT
          +
          +
          The checkout project command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKIN_FILE

          +
          +static final java.lang.String COMMAND_CHECKIN_FILE
          +
          +
          The checkin file command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKIN_PROJECT

          +
          +static final java.lang.String COMMAND_CHECKIN_PROJECT
          +
          +
          The checkin project command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_HISTORY

          +
          +static final java.lang.String COMMAND_HISTORY
          +
          +
          The get history command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_LABEL

          +
          +static final java.lang.String COMMAND_LABEL
          +
          +
          The add label command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PROJECT_PREFIX

          +
          +static final java.lang.String PROJECT_PREFIX
          +
          +
          The project prefix +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_COMMAND

          +
          +static final java.lang.String FLAG_COMMAND
          +
          +
          The command option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VSS_SERVER

          +
          +static final java.lang.String FLAG_VSS_SERVER
          +
          +
          The database (vss server) option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_USERNAME

          +
          +static final java.lang.String FLAG_USERNAME
          +
          +
          The username option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_PASSWORD

          +
          +static final java.lang.String FLAG_PASSWORD
          +
          +
          The password option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_COMMENT

          +
          +static final java.lang.String FLAG_COMMENT
          +
          +
          The log option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_WORKING_DIR

          +
          +static final java.lang.String FLAG_WORKING_DIR
          +
          +
          The workdir option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_RECURSION

          +
          +static final java.lang.String FLAG_RECURSION
          +
          +
          The recursive option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VERSION

          +
          +static final java.lang.String FLAG_VERSION
          +
          +
          The revision option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_LABEL

          +
          +static final java.lang.String FLAG_LABEL
          +
          +
          The label option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_NO_COMPRESSION

          +
          +static final java.lang.String FLAG_NO_COMPRESSION
          +
          +
          The no compression option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_NO_CACHE

          +
          +static final java.lang.String FLAG_NO_CACHE
          +
          +
          The no cache option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_SOS_SERVER

          +
          +static final java.lang.String FLAG_SOS_SERVER
          +
          +
          The server option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_SOS_HOME

          +
          +static final java.lang.String FLAG_SOS_HOME
          +
          +
          The sos home option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_PROJECT

          +
          +static final java.lang.String FLAG_PROJECT
          +
          +
          The project option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_FILE

          +
          +static final java.lang.String FLAG_FILE
          +
          +
          The file option +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VERBOSE

          +
          +static final java.lang.String FLAG_VERBOSE
          +
          +
          The verbose option +

          +

          +
          See Also:
          Constant Field Values
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html new file mode 100644 index 000000000..91869804d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSGet.html @@ -0,0 +1,438 @@ + + + + + + +SOSGet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Class SOSGet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sos.SOS
+              extended by org.apache.tools.ant.taskdefs.optional.sos.SOSGet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SOSCmd
          +
          +
          +
          +
          public class SOSGet
          extends SOS
          + + +

          +Retrieves a read-only copy of the specified project or file + from Visual SourceSafe via a SourceOffSite server. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          commandLine
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          SOSGet() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Build the command line
          + + GetFile required parameters: -server -name -password -database -project -file
          + GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome
          + + GetProject required parameters: -server -name -password -database -project
          + GetProject optional parameters: -label -workdir -recursive -verbose -nocache + -nocompression -soshome
          + voidsetFile(java.lang.String filename) + +
          +          The Filename to act upon.
          + voidsetLabel(java.lang.String label) + +
          +          The labeled version to operate on in SourceSafe.
          + voidsetRecursive(boolean recursive) + +
          +          Flag to recursively apply the action.
          + voidsetVersion(java.lang.String version) + +
          +          Set the version number to get - + only works with SOSGet on a file.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          execute, getComment, getFilename, getLabel, getLocalPath, getNoCache, getNoCompress, getOptionalAttributes, getPassword, getProjectPath, getRecursive, getRequiredAttributes, getSosCommand, getSosHome, getSosServerPath, getUsername, getVerbose, getVersion, getVssServerPath, run, setInternalComment, setInternalFilename, setInternalLabel, setInternalRecursive, setInternalVersion, setLocalPath, setNoCache, setNoCompress, setPassword, setProjectPath, setSosCmd, setSosHome, setSosServerPath, setUsername, setVerbose, setVssServerPath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SOSGet

          +
          +public SOSGet()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public final void setFile(java.lang.String filename)
          +
          +
          The Filename to act upon. + If no file is specified then the tasks + act upon the project. +

          +

          +
          Parameters:
          filename - The new file value
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Flag to recursively apply the action. Defaults to false +

          +

          +
          Parameters:
          recursive - True for recursive operation.
          +
          +
          +
          + +

          +setVersion

          +
          +public void setVersion(java.lang.String version)
          +
          +
          Set the version number to get - + only works with SOSGet on a file. +

          +

          +
          Parameters:
          version - The new version value
          +
          +
          +
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
          +
          +
          The labeled version to operate on in SourceSafe. +

          +

          +
          Parameters:
          label - The new label value
          +
          +
          +
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Build the command line
          + + GetFile required parameters: -server -name -password -database -project -file
          + GetFile optional parameters: -workdir -revision -verbose -nocache -nocompression -soshome
          + + GetProject required parameters: -server -name -password -database -project
          + GetProject optional parameters: -label -workdir -recursive -verbose -nocache + -nocompression -soshome
          +

          +

          +
          +
          +
          + +
          Returns:
          Commandline the generated command to be executed
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html new file mode 100644 index 000000000..804a35320 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/SOSLabel.html @@ -0,0 +1,402 @@ + + + + + + +SOSLabel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sos +
          +Class SOSLabel

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sos.SOS
+              extended by org.apache.tools.ant.taskdefs.optional.sos.SOSLabel
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SOSCmd
          +
          +
          +
          +
          public class SOSLabel
          extends SOS
          + + +

          +Labels Visual SourceSafe files via a SourceOffSite server. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          commandLine
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          COMMAND_CHECKIN_FILE, COMMAND_CHECKIN_PROJECT, COMMAND_CHECKOUT_FILE, COMMAND_CHECKOUT_PROJECT, COMMAND_GET_FILE, COMMAND_GET_PROJECT, COMMAND_HISTORY, COMMAND_LABEL, COMMAND_SOS_EXE, FLAG_COMMAND, FLAG_COMMENT, FLAG_FILE, FLAG_LABEL, FLAG_NO_CACHE, FLAG_NO_COMPRESSION, FLAG_PASSWORD, FLAG_PROJECT, FLAG_RECURSION, FLAG_SOS_HOME, FLAG_SOS_SERVER, FLAG_USERNAME, FLAG_VERBOSE, FLAG_VERSION, FLAG_VSS_SERVER, FLAG_WORKING_DIR, PROJECT_PREFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          SOSLabel() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Build the command line
          + AddLabel required parameters: -server -name -password -database -project -label
          + AddLabel optional parameters: -verbose -comment
          + voidsetComment(java.lang.String comment) + +
          +          The comment to apply to all files being labelled.
          + voidsetLabel(java.lang.String label) + +
          +          The label to apply the the files in SourceSafe.
          + voidsetVersion(java.lang.String version) + +
          +          The version number to label.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.sos.SOS
          execute, getComment, getFilename, getLabel, getLocalPath, getNoCache, getNoCompress, getOptionalAttributes, getPassword, getProjectPath, getRecursive, getRequiredAttributes, getSosCommand, getSosHome, getSosServerPath, getUsername, getVerbose, getVersion, getVssServerPath, run, setInternalComment, setInternalFilename, setInternalLabel, setInternalRecursive, setInternalVersion, setLocalPath, setNoCache, setNoCompress, setPassword, setProjectPath, setSosCmd, setSosHome, setSosServerPath, setUsername, setVerbose, setVssServerPath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SOSLabel

          +
          +public SOSLabel()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setVersion

          +
          +public void setVersion(java.lang.String version)
          +
          +
          The version number to label. +

          +

          +
          Parameters:
          version - The new version value
          +
          +
          +
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
          +
          +
          The label to apply the the files in SourceSafe. +

          +

          +
          Parameters:
          label - The new label value
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          The comment to apply to all files being labelled. +

          +

          +
          Parameters:
          comment - The new comment value
          +
          +
          +
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Build the command line
          + AddLabel required parameters: -server -name -password -database -project -label
          + AddLabel optional parameters: -verbose -comment
          +

          +

          +
          +
          +
          + +
          Returns:
          Commandline the generated command to be executed
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-frame.html new file mode 100644 index 000000000..b0bee5c26 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sos (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.sos + + + + +
          +Interfaces  + +
          +SOSCmd
          + + + + + + +
          +Classes  + +
          +SOS +
          +SOSCheckin +
          +SOSCheckout +
          +SOSGet +
          +SOSLabel
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-summary.html new file mode 100644 index 000000000..04b3cd73e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-summary.html @@ -0,0 +1,207 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sos (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.sos +

          + + Ant tasks for working with a SourceOffSite source control system. +

          +See: +
          +          Description +

          + + + + + + + + + +
          +Interface Summary
          SOSCmdInterface to hold constants used by the SOS tasks
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          SOSA base class for creating tasks for executing commands on SourceOffSite.
          SOSCheckinCommits and unlocks files in Visual SourceSafe via a SourceOffSite server.
          SOSCheckoutRetrieves and locks files in Visual SourceSafe via a SourceOffSite server.
          SOSGetRetrieves a read-only copy of the specified project or file + from Visual SourceSafe via a SourceOffSite server.
          SOSLabelLabels Visual SourceSafe files via a SourceOffSite server.
          +  + +

          +

          +Package org.apache.tools.ant.taskdefs.optional.sos Description +

          + +

          +

          + Ant tasks for working with a SourceOffSite source control system. +

          +

          + The <SOSGet> Retreives file(s) from a SOS database
          + The <SOSCheckin> Commits and unlocks file(s) in a SOS database
          + The <SOSCheckout> Retreives and lock file(s) in a SOS database
          + The <SOSLabel> Label a SOS database
          +

          +

          + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-tree.html new file mode 100644 index 000000000..3c0ade25b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sos/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sos Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.sos +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.sos.SOS (implements org.apache.tools.ant.taskdefs.optional.sos.SOSCmd) +
                    +
                  • org.apache.tools.ant.taskdefs.optional.sos.SOSCheckin
                  • org.apache.tools.ant.taskdefs.optional.sos.SOSCheckout
                  • org.apache.tools.ant.taskdefs.optional.sos.SOSGet
                  • org.apache.tools.ant.taskdefs.optional.sos.SOSLabel
                  +
                +
              +
            +
          +

          +Interface Hierarchy +

          +
            +
          • org.apache.tools.ant.taskdefs.optional.sos.SOSCmd
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.html new file mode 100644 index 000000000..17728ec40 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/AntSoundPlayer.html @@ -0,0 +1,499 @@ + + + + + + +AntSoundPlayer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sound +
          +Class AntSoundPlayer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.sound.AntSoundPlayer
+
          +
          +
          All Implemented Interfaces:
          java.util.EventListener, javax.sound.sampled.LineListener, BuildListener
          +
          +
          +
          +
          public class AntSoundPlayer
          extends java.lang.Object
          implements javax.sound.sampled.LineListener, BuildListener
          + + +

          +This class is designed to be used by any AntTask that requires audio output. + + It implements the BuildListener interface to listen for BuildEvents + and could be easily extended to provide audio output upon any + specific build events occurring. + + I have only tested this with .WAV and .AIFF sound file formats. Both seem to work fine. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          AntSoundPlayer() + +
          +          Constructor for AntSoundPlayer.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddBuildFailedSound(java.io.File fileFail, + int loopsFail, + java.lang.Long durationFail) + +
          +           
          + voidaddBuildSuccessfulSound(java.io.File file, + int loops, + java.lang.Long duration) + +
          +           
          + voidbuildFinished(BuildEvent event) + +
          +          Fired after the last target has finished.
          + voidbuildStarted(BuildEvent event) + +
          +          Fired before any targets are started.
          + voidmessageLogged(BuildEvent event) + +
          +          Fired whenever a message is logged.
          + voidtargetFinished(BuildEvent event) + +
          +          Fired when a target has finished.
          + voidtargetStarted(BuildEvent event) + +
          +          Fired when a target is started.
          + voidtaskFinished(BuildEvent event) + +
          +          Fired when a task has finished.
          + voidtaskStarted(BuildEvent event) + +
          +          Fired when a task is started.
          + voidupdate(javax.sound.sampled.LineEvent event) + +
          +          This is implemented to listen for any line events and closes the + clip if required.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AntSoundPlayer

          +
          +public AntSoundPlayer()
          +
          +
          Constructor for AntSoundPlayer. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +addBuildSuccessfulSound

          +
          +public void addBuildSuccessfulSound(java.io.File file,
+                                    int loops,
+                                    java.lang.Long duration)
          +
          +
          +
          +
          +
          +
          Parameters:
          file - the location of the audio file to be played when the + build is successful
          loops - the number of times the file should be played when + the build is successful
          duration - the number of milliseconds the file should be + played when the build is successful
          +
          +
          +
          + +

          +addBuildFailedSound

          +
          +public void addBuildFailedSound(java.io.File fileFail,
+                                int loopsFail,
+                                java.lang.Long durationFail)
          +
          +
          +
          +
          +
          +
          Parameters:
          fileFail - the location of the audio file to be played + when the build fails
          loopsFail - the number of times the file should be played + when the build is fails
          durationFail - the number of milliseconds the file should be + played when the build fails
          +
          +
          +
          + +

          +update

          +
          +public void update(javax.sound.sampled.LineEvent event)
          +
          +
          This is implemented to listen for any line events and closes the + clip if required. +

          +

          +
          Specified by:
          update in interface javax.sound.sampled.LineListener
          +
          +
          +
          Parameters:
          event - the line event to follow
          +
          +
          +
          + +

          +buildStarted

          +
          +public void buildStarted(BuildEvent event)
          +
          +
          Fired before any targets are started. +

          +

          +
          Specified by:
          buildStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - ignored
          +
          +
          +
          + +

          +buildFinished

          +
          +public void buildFinished(BuildEvent event)
          +
          +
          Fired after the last target has finished. This event + will still be thrown if an error occurred during the build. +

          +

          +
          Specified by:
          buildFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - the build finished event.
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +targetStarted

          +
          +public void targetStarted(BuildEvent event)
          +
          +
          Fired when a target is started. +

          +

          +
          Specified by:
          targetStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - ignored.
          See Also:
          BuildEvent.getTarget()
          +
          +
          +
          + +

          +targetFinished

          +
          +public void targetFinished(BuildEvent event)
          +
          +
          Fired when a target has finished. This event will + still be thrown if an error occurred during the build. +

          +

          +
          Specified by:
          targetFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - ignored.
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +taskStarted

          +
          +public void taskStarted(BuildEvent event)
          +
          +
          Fired when a task is started. +

          +

          +
          Specified by:
          taskStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - ignored.
          See Also:
          BuildEvent.getTask()
          +
          +
          +
          + +

          +taskFinished

          +
          +public void taskFinished(BuildEvent event)
          +
          +
          Fired when a task has finished. This event will still + be throw if an error occurred during the build. +

          +

          +
          Specified by:
          taskFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - ignored.
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +messageLogged

          +
          +public void messageLogged(BuildEvent event)
          +
          +
          Fired whenever a message is logged. +

          +

          +
          Specified by:
          messageLogged in interface BuildListener
          +
          +
          +
          Parameters:
          event - the build event
          See Also:
          BuildEvent.getMessage(), +BuildEvent.getPriority()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html new file mode 100644 index 000000000..5615d9640 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.BuildAlert.html @@ -0,0 +1,365 @@ + + + + + + +SoundTask.BuildAlert (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sound +
          +Class SoundTask.BuildAlert

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.sound.SoundTask.BuildAlert
+
          +
          +
          Enclosing class:
          SoundTask
          +
          +
          +
          +
          public class SoundTask.BuildAlert
          extends java.lang.Object
          + + +

          +A class to be extended by any BuildAlert's that require the output + of sound. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SoundTask.BuildAlert() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.LonggetDuration() + +
          +          Gets the duration in milliseconds the file should be played.
          + intgetLoops() + +
          +          Sets the number of times the source file should be played.
          + java.io.FilegetSource() + +
          +          Gets the location of the file to get the audio.
          + voidsetDuration(java.lang.Long duration) + +
          +          Sets the duration in milliseconds the file should be played; optional.
          + voidsetLoops(int loops) + +
          +          Sets the number of times the source file should be played; optional.
          + voidsetSource(java.io.File source) + +
          +          Sets the location of the file to get the audio; required.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SoundTask.BuildAlert

          +
          +public SoundTask.BuildAlert()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDuration

          +
          +public void setDuration(java.lang.Long duration)
          +
          +
          Sets the duration in milliseconds the file should be played; optional. +

          +

          +
          Parameters:
          duration - the duration in millisconds
          +
          +
          +
          + +

          +setSource

          +
          +public void setSource(java.io.File source)
          +
          +
          Sets the location of the file to get the audio; required. +

          +

          +
          Parameters:
          source - the name of a sound-file directory or of the audio file
          +
          +
          +
          + +

          +setLoops

          +
          +public void setLoops(int loops)
          +
          +
          Sets the number of times the source file should be played; optional. +

          +

          +
          Parameters:
          loops - the number of loops to play the source file
          +
          +
          +
          + +

          +getSource

          +
          +public java.io.File getSource()
          +
          +
          Gets the location of the file to get the audio. +

          +

          + +
          Returns:
          the file location
          +
          +
          +
          + +

          +getLoops

          +
          +public int getLoops()
          +
          +
          Sets the number of times the source file should be played. +

          +

          + +
          Returns:
          the number of loops to play the source file
          +
          +
          +
          + +

          +getDuration

          +
          +public java.lang.Long getDuration()
          +
          +
          Gets the duration in milliseconds the file should be played. +

          +

          + +
          Returns:
          the duration in milliseconds
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html new file mode 100644 index 000000000..11cfc8b01 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/SoundTask.html @@ -0,0 +1,407 @@ + + + + + + +SoundTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.sound +
          +Class SoundTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.sound.SoundTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class SoundTask
          extends Task
          + + +

          +Plays a sound file at the end of the build, according to whether the build failed or succeeded. + + There are three attributes to be set: + + source: the location of the audio file to be played + duration: play the sound file continuously until "duration" milliseconds has expired + loops: the number of times the sound file should be played until stopped + + I have only tested this with .WAV and .AIFF sound file formats. Both seem + to work fine. + + plans for the future: + - use the midi api to define sounds (or drum beat etc) in xml and have + Ant play them back +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          + classSoundTask.BuildAlert + +
          +          A class to be extended by any BuildAlert's that require the output + of sound.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SoundTask() + +
          +          Constructor for SoundTask.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + SoundTask.BuildAlertcreateFail() + +
          +          add a sound when the build fails
          + SoundTask.BuildAlertcreateSuccess() + +
          +          add a sound when the build succeeds
          + voidexecute() + +
          +          Execute the task.
          + voidinit() + +
          +          Initialize the task.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SoundTask

          +
          +public SoundTask()
          +
          +
          Constructor for SoundTask. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +createSuccess

          +
          +public SoundTask.BuildAlert createSuccess()
          +
          +
          add a sound when the build succeeds +

          +

          + +
          Returns:
          a BuildAlert to be configured
          +
          +
          +
          + +

          +createFail

          +
          +public SoundTask.BuildAlert createFail()
          +
          +
          add a sound when the build fails +

          +

          + +
          Returns:
          a BuildAlert to be configured
          +
          +
          +
          + +

          +init

          +
          +public void init()
          +
          +
          Initialize the task. +

          +

          +
          Overrides:
          init in class Task
          +
          +
          +
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
          +
          +
          Execute the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-frame.html new file mode 100644 index 000000000..f8ba246d7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sound (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.sound + + + + +
          +Classes  + +
          +AntSoundPlayer +
          +SoundTask
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-summary.html new file mode 100644 index 000000000..96c8923e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-summary.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sound (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.sound +

          + + + + + + + + + + + + + +
          +Class Summary
          AntSoundPlayerThis class is designed to be used by any AntTask that requires audio output.
          SoundTaskPlays a sound file at the end of the build, according to whether the build failed or succeeded.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-tree.html new file mode 100644 index 000000000..a1ad0a921 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/sound/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.sound Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.sound +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.html new file mode 100644 index 000000000..ac442c815 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/SplashTask.html @@ -0,0 +1,525 @@ + + + + + + +SplashTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.splash +
          +Class SplashTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.splash.SplashTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class SplashTask
          extends Task
          + + +

          +Creates a splash screen. The splash screen is displayed + for the duration of the build and includes a handy progress bar as + well. Use in conjunction with the sound task to provide interest + whilst waiting for your builds to complete... +

          + +

          +

          +
          Since:
          +
          Ant1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SplashTask() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Execute the task.
          + voidsetDisplayText(java.lang.String displayText) + +
          +          Sets the display text presented in the splash window.
          + voidsetImageURL(java.lang.String imgurl) + +
          +          A URL pointing to an image to display; optional, default antlogo.gif + from the classpath.
          + voidsetPassword(java.lang.String password) + +
          +          Proxy password; required if user is set.
          + voidsetPort(java.lang.String port) + +
          +          Proxy port; optional, default 80.
          + voidsetProgressRegExp(java.lang.String progressRegExp) + +
          +          Progress regular expression which is used to parse the output + and dig out current progress optional; if not provided, + progress is increased every action and log output line
          + voidsetProxy(java.lang.String proxy) + +
          +          name of proxy; optional.
          + voidsetShowduration(int duration) + +
          +          how long to show the splash screen in milliseconds, + optional; default 5000 ms.
          + voidsetUseproxy(boolean useProxy) + +
          +          Deprecated. since 1.5.x. + Use org.apache.tools.ant.taskdefs.optional.SetProxy
          + voidsetUser(java.lang.String user) + +
          +          Proxy user; optional, default =none.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SplashTask

          +
          +public SplashTask()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setImageURL

          +
          +public void setImageURL(java.lang.String imgurl)
          +
          +
          A URL pointing to an image to display; optional, default antlogo.gif + from the classpath. +

          +

          +
          Parameters:
          imgurl - the url string pointing to the image
          +
          +
          +
          + +

          +setUseproxy

          +
          +public void setUseproxy(boolean useProxy)
          +
          +
          Deprecated. since 1.5.x. + Use org.apache.tools.ant.taskdefs.optional.SetProxy +

          +

          flag to enable proxy settings; optional, deprecated : consider + using <setproxy> instead +

          +

          +
          Parameters:
          useProxy - if ture, enable proxy settings
          +
          +
          +
          + +

          +setProxy

          +
          +public void setProxy(java.lang.String proxy)
          +
          +
          name of proxy; optional. +

          +

          +
          Parameters:
          proxy - the name of the proxy host
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(java.lang.String port)
          +
          +
          Proxy port; optional, default 80. +

          +

          +
          Parameters:
          port - the proxy port
          +
          +
          +
          + +

          +setUser

          +
          +public void setUser(java.lang.String user)
          +
          +
          Proxy user; optional, default =none. +

          +

          +
          Parameters:
          user - the proxy user
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          Proxy password; required if user is set. +

          +

          +
          Parameters:
          password - the proxy password
          +
          +
          +
          + +

          +setShowduration

          +
          +public void setShowduration(int duration)
          +
          +
          how long to show the splash screen in milliseconds, + optional; default 5000 ms. +

          +

          +
          Parameters:
          duration - the spash duration in milliseconds
          +
          +
          +
          + +

          +setProgressRegExp

          +
          +public void setProgressRegExp(java.lang.String progressRegExp)
          +
          +
          Progress regular expression which is used to parse the output + and dig out current progress optional; if not provided, + progress is increased every action and log output line +

          +

          +
          Parameters:
          progressRegExp - Progress regular expression, exactly one + group pattern must exists, and it represents the progress + number (0-100) (i.e "Progress: (.*)%")
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setDisplayText

          +
          +public void setDisplayText(java.lang.String displayText)
          +
          +
          Sets the display text presented in the splash window. + optional; defaults to "Building ..." +

          +

          +
          Parameters:
          displayText - the display text presented the splash window
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute the task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-frame.html new file mode 100644 index 000000000..1f637fa1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.splash (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.splash + + + + +
          +Classes  + +
          +SplashTask
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-summary.html new file mode 100644 index 000000000..86a7cf68e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-summary.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.splash (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.splash +

          + + + + + + + + + +
          +Class Summary
          SplashTaskCreates a splash screen.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-tree.html new file mode 100644 index 000000000..f34e20d6c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/splash/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.splash Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.splash +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.splash.SplashTask
                +
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html new file mode 100644 index 000000000..d9e2c3037 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/AbstractSshMessage.html @@ -0,0 +1,529 @@ + + + + + + +AbstractSshMessage (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class AbstractSshMessage

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
+
          +
          +
          Direct Known Subclasses:
          ScpFromMessage, ScpToMessage
          +
          +
          +
          +
          public abstract class AbstractSshMessage
          extends java.lang.Object
          + + +

          +Abstract class for ssh upload and download +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          AbstractSshMessage(boolean verbose, + com.jcraft.jsch.Session session) + +
          +          Constructor for AbstractSshMessage
          AbstractSshMessage(com.jcraft.jsch.Session session) + +
          +          Constructor for AbstractSshMessage
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +abstract  voidexecute() + +
          +          Carry out the transfer.
          +protected  com.jcraft.jsch.SftpProgressMonitorgetProgressMonitor() + +
          +          Get the progress monitor.
          +protected  booleangetVerbose() + +
          +          Is the verbose attribute set.
          +protected  voidlog(java.lang.String message) + +
          +          Log a message to the log listener.
          +protected  voidlogStats(long timeStarted, + long timeEnded, + long totalLength) + +
          +          Log transfer stats to the log listener.
          +protected  com.jcraft.jsch.ChannelopenExecChannel(java.lang.String command) + +
          +          Open an ssh channel.
          +protected  com.jcraft.jsch.ChannelSftpopenSftpChannel() + +
          +          Open an ssh sftp channel.
          +protected  voidsendAck(java.io.OutputStream out) + +
          +          Send an ack.
          + voidsetLogListener(LogListener aListener) + +
          +          Set a log listener.
          +protected  inttrackProgress(long filesize, + long totalLength, + int percentTransmitted) + +
          +          Track progress every 10% if 100kb < filesize < 1mb.
          +protected  voidwaitForAck(java.io.InputStream in) + +
          +          Reads the response, throws a BuildException if the response + indicates an error.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractSshMessage

          +
          +public AbstractSshMessage(com.jcraft.jsch.Session session)
          +
          +
          Constructor for AbstractSshMessage +

          +

          +
          Parameters:
          session - the ssh session to use
          +
          +
          + +

          +AbstractSshMessage

          +
          +public AbstractSshMessage(boolean verbose,
+                          com.jcraft.jsch.Session session)
          +
          +
          Constructor for AbstractSshMessage +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the ssh session to use
          Since:
          +
          Ant 1.6.2
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +openExecChannel

          +
          +protected com.jcraft.jsch.Channel openExecChannel(java.lang.String command)
+                                           throws com.jcraft.jsch.JSchException
          +
          +
          Open an ssh channel. +

          +

          +
          Parameters:
          command - the command to use +
          Returns:
          the channel +
          Throws: +
          com.jcraft.jsch.JSchException - on error
          +
          +
          +
          + +

          +openSftpChannel

          +
          +protected com.jcraft.jsch.ChannelSftp openSftpChannel()
+                                               throws com.jcraft.jsch.JSchException
          +
          +
          Open an ssh sftp channel. +

          +

          + +
          Returns:
          the channel +
          Throws: +
          com.jcraft.jsch.JSchException - on error
          +
          +
          +
          + +

          +sendAck

          +
          +protected void sendAck(java.io.OutputStream out)
+                throws java.io.IOException
          +
          +
          Send an ack. +

          +

          +
          Parameters:
          out - the output stream to use +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +waitForAck

          +
          +protected void waitForAck(java.io.InputStream in)
+                   throws java.io.IOException,
+                          BuildException
          +
          +
          Reads the response, throws a BuildException if the response + indicates an error. +

          +

          +
          Parameters:
          in - the input stream to use +
          Throws: +
          java.io.IOException - on I/O error +
          BuildException - on other errors
          +
          +
          +
          + +

          +execute

          +
          +public abstract void execute()
+                      throws java.io.IOException,
+                             com.jcraft.jsch.JSchException
          +
          +
          Carry out the transfer. +

          +

          + +
          Throws: +
          java.io.IOException - on I/O errors +
          com.jcraft.jsch.JSchException - on ssh errors
          +
          +
          +
          + +

          +setLogListener

          +
          +public void setLogListener(LogListener aListener)
          +
          +
          Set a log listener. +

          +

          +
          Parameters:
          aListener - the log listener
          +
          +
          +
          + +

          +log

          +
          +protected void log(java.lang.String message)
          +
          +
          Log a message to the log listener. +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          +
          + +

          +logStats

          +
          +protected void logStats(long timeStarted,
+                        long timeEnded,
+                        long totalLength)
          +
          +
          Log transfer stats to the log listener. +

          +

          +
          Parameters:
          timeStarted - the time started
          timeEnded - the finishing time
          totalLength - the total length
          +
          +
          +
          + +

          +getVerbose

          +
          +protected final boolean getVerbose()
          +
          +
          Is the verbose attribute set. +

          +

          + +
          Returns:
          true if the verbose attribute is set
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +trackProgress

          +
          +protected final int trackProgress(long filesize,
+                                  long totalLength,
+                                  int percentTransmitted)
          +
          +
          Track progress every 10% if 100kb < filesize < 1mb. For larger + files track progress for every percent transmitted. +

          +

          +
          Parameters:
          filesize - the size of the file been transmitted
          totalLength - the total transmission size
          percentTransmitted - the current percent transmitted +
          Returns:
          the percent that the file is of the total
          +
          +
          +
          + +

          +getProgressMonitor

          +
          +protected com.jcraft.jsch.SftpProgressMonitor getProgressMonitor()
          +
          +
          Get the progress monitor. +

          +

          + +
          Returns:
          the progress monitor.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Directory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Directory.html new file mode 100644 index 000000000..c4e199e37 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Directory.html @@ -0,0 +1,548 @@ + + + + + + +Directory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class Directory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.Directory
+
          +
          +
          +
          public class Directory
          extends java.lang.Object
          + + +

          +A helper object for Scp representing a directory in a file system. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          Directory(java.io.File directory) + +
          +          Constructor for a Directory.
          Directory(java.io.File directory, + Directory parent) + +
          +          Constructor for a Directory.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddDirectory(Directory directory) + +
          +          Add a directory to the child directories.
          + voidaddFile(java.io.File file) + +
          +          Add a file to the list of files.
          + java.util.IteratordirectoryIterator() + +
          +          Get an iterator over the child Directories.
          + booleanequals(java.lang.Object obj) + +
          +          The equality method.
          + java.util.IteratorfilesIterator() + +
          +          Get an iterator over the files.
          + intfileSize() + +
          +          Get the number of files in the files attribute.
          + DirectorygetChild(java.io.File dir) + +
          +          Get a child directory of this directory.
          + java.io.FilegetDirectory() + +
          +          Get the directory file.
          + DirectorygetParent() + +
          +          Get the parent Directory.
          + java.lang.String[]getPath() + +
          +          Get the path components of this directory.
          +static java.lang.String[]getPath(java.lang.String thePath) + +
          +          Convert a file path to an array of path components.
          + inthashCode() + +
          +          The hashcode method.
          + booleanisRoot() + +
          +          Is this a root Directory?
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Directory

          +
          +public Directory(java.io.File directory)
          +
          +
          Constructor for a Directory. +

          +

          +
          Parameters:
          directory - a directory.
          +
          +
          + +

          +Directory

          +
          +public Directory(java.io.File directory,
+                 Directory parent)
          +
          +
          Constructor for a Directory. +

          +

          +
          Parameters:
          directory - a directory
          parent - a parent Directory
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addDirectory

          +
          +public void addDirectory(Directory directory)
          +
          +
          Add a directory to the child directories. +

          +

          +
          Parameters:
          directory - a Directory
          +
          +
          +
          + +

          +addFile

          +
          +public void addFile(java.io.File file)
          +
          +
          Add a file to the list of files. +

          +

          +
          Parameters:
          file - a file to add
          +
          +
          +
          + +

          +directoryIterator

          +
          +public java.util.Iterator directoryIterator()
          +
          +
          Get an iterator over the child Directories. +

          +

          + +
          Returns:
          an iterator
          +
          +
          +
          + +

          +filesIterator

          +
          +public java.util.Iterator filesIterator()
          +
          +
          Get an iterator over the files. +

          +

          + +
          Returns:
          an iterator
          +
          +
          +
          + +

          +getParent

          +
          +public Directory getParent()
          +
          +
          Get the parent Directory. +

          +

          + +
          Returns:
          the parent Directory.
          +
          +
          +
          + +

          +isRoot

          +
          +public boolean isRoot()
          +
          +
          Is this a root Directory? +

          +

          + +
          Returns:
          true if there is no parent Directory
          +
          +
          +
          + +

          +getDirectory

          +
          +public java.io.File getDirectory()
          +
          +
          Get the directory file. +

          +

          + +
          Returns:
          the directory file
          +
          +
          +
          + +

          +getChild

          +
          +public Directory getChild(java.io.File dir)
          +
          +
          Get a child directory of this directory. +

          +

          +
          Parameters:
          dir - the directory to look for +
          Returns:
          the child directory, or null if not found
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object obj)
          +
          +
          The equality method. + This checks if the directory field is the same. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          obj - the object to compare to +
          Returns:
          true if this object has an equal directory field as the other object
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          The hashcode method. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          the hash code of the directory field
          +
          +
          +
          + +

          +getPath

          +
          +public java.lang.String[] getPath()
          +
          +
          Get the path components of this directory. +

          +

          + +
          Returns:
          the path components as an array of strings.
          +
          +
          +
          + +

          +getPath

          +
          +public static java.lang.String[] getPath(java.lang.String thePath)
          +
          +
          Convert a file path to an array of path components. + This uses File.sepatator to split the file path string. +

          +

          +
          Parameters:
          thePath - the file path string to convert +
          Returns:
          an array of path components
          +
          +
          +
          + +

          +fileSize

          +
          +public int fileSize()
          +
          +
          Get the number of files in the files attribute. +

          +

          + +
          Returns:
          the number of files
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html new file mode 100644 index 000000000..fb44c9150 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/LogListener.html @@ -0,0 +1,210 @@ + + + + + + +LogListener (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Interface LogListener

          +
          +
          All Known Implementing Classes:
          Scp, SSHBase, SSHExec, SSHSession
          +
          +
          +
          +
          public interface LogListener
          + + +

          +Interface for ssh log listeners to implement. +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidlog(java.lang.String message) + +
          +          Method for the loglistener to implement to recieve log messages.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +log

          +
          +void log(java.lang.String message)
          +
          +
          Method for the loglistener to implement to recieve log messages. +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html new file mode 100644 index 000000000..a843a2986 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHBase.html @@ -0,0 +1,731 @@ + + + + + + +SSHBase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHBase

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, LogListener
          +
          +
          +
          Direct Known Subclasses:
          Scp, SSHExec, SSHSession
          +
          +
          +
          +
          public abstract class SSHBase
          extends Task
          implements LogListener
          + + +

          +Base class for Ant tasks using jsch. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SSHBase() + +
          +          Constructor for SSHBase.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleangetFailonerror() + +
          +          Get the failonerror flag.
          + java.lang.StringgetHost() + +
          +          Get the host.
          + intgetPort() + +
          +          Get the port attribute.
          +protected  SSHUserInfogetUserInfo() + +
          +          Get the user information.
          + booleangetVerbose() + +
          +          Get the verbose flag.
          + voidinit() + +
          +          Initialize the task.
          +protected  com.jcraft.jsch.SessionopenSession() + +
          +          Open an ssh seession.
          + voidsetFailonerror(boolean failure) + +
          +          Set the failonerror flag.
          + voidsetHost(java.lang.String host) + +
          +          Remote host, either DNS name or IP.
          + voidsetKeyfile(java.lang.String keyfile) + +
          +          Sets the keyfile for the user.
          + voidsetKnownhosts(java.lang.String knownHosts) + +
          +          Sets the path to the file that has the identities of + all known hosts.
          + voidsetPassphrase(java.lang.String passphrase) + +
          +          Sets the passphrase for the users key.
          + voidsetPassword(java.lang.String password) + +
          +          Sets the password for the user.
          + voidsetPort(int port) + +
          +          Changes the port used to connect to the remote host.
          + voidsetTrust(boolean yesOrNo) + +
          +          Setting this to true trusts hosts whose identity is unknown.
          + voidsetUsername(java.lang.String username) + +
          +          Username known to remote host.
          + voidsetVerbose(boolean verbose) + +
          +          Set the verbose flag.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener
          log
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHBase

          +
          +public SSHBase()
          +
          +
          Constructor for SSHBase. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setHost

          +
          +public void setHost(java.lang.String host)
          +
          +
          Remote host, either DNS name or IP. +

          +

          +
          +
          +
          +
          Parameters:
          host - The new host value
          +
          +
          +
          + +

          +getHost

          +
          +public java.lang.String getHost()
          +
          +
          Get the host. +

          +

          +
          +
          +
          + +
          Returns:
          the host
          +
          +
          +
          + +

          +setFailonerror

          +
          +public void setFailonerror(boolean failure)
          +
          +
          Set the failonerror flag. + Default is true +

          +

          +
          +
          +
          +
          Parameters:
          failure - if true throw a build exception when a failure occuries, + otherwise just log the failure and continue
          +
          +
          +
          + +

          +getFailonerror

          +
          +public boolean getFailonerror()
          +
          +
          Get the failonerror flag. +

          +

          +
          +
          +
          + +
          Returns:
          the failonerror flag
          +
          +
          +
          + +

          +setVerbose

          +
          +public void setVerbose(boolean verbose)
          +
          +
          Set the verbose flag. +

          +

          +
          +
          +
          +
          Parameters:
          verbose - if true output more verbose logging
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +getVerbose

          +
          +public boolean getVerbose()
          +
          +
          Get the verbose flag. +

          +

          +
          +
          +
          + +
          Returns:
          the verbose flag
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setUsername

          +
          +public void setUsername(java.lang.String username)
          +
          +
          Username known to remote host. +

          +

          +
          +
          +
          +
          Parameters:
          username - The new username value
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          Sets the password for the user. +

          +

          +
          +
          +
          +
          Parameters:
          password - The new password value
          +
          +
          +
          + +

          +setKeyfile

          +
          +public void setKeyfile(java.lang.String keyfile)
          +
          +
          Sets the keyfile for the user. +

          +

          +
          +
          +
          +
          Parameters:
          keyfile - The new keyfile value
          +
          +
          +
          + +

          +setPassphrase

          +
          +public void setPassphrase(java.lang.String passphrase)
          +
          +
          Sets the passphrase for the users key. +

          +

          +
          +
          +
          +
          Parameters:
          passphrase - The new passphrase value
          +
          +
          +
          + +

          +setKnownhosts

          +
          +public void setKnownhosts(java.lang.String knownHosts)
          +
          +
          Sets the path to the file that has the identities of + all known hosts. This is used by SSH protocol to validate + the identity of the host. The default is + ${user.home}/.ssh/known_hosts. +

          +

          +
          +
          +
          +
          Parameters:
          knownHosts - a path to the known hosts file.
          +
          +
          +
          + +

          +setTrust

          +
          +public void setTrust(boolean yesOrNo)
          +
          +
          Setting this to true trusts hosts whose identity is unknown. +

          +

          +
          +
          +
          +
          Parameters:
          yesOrNo - if true trust the identity of unknown hosts.
          +
          +
          +
          + +

          +setPort

          +
          +public void setPort(int port)
          +
          +
          Changes the port used to connect to the remote host. +

          +

          +
          +
          +
          +
          Parameters:
          port - port number of remote host.
          +
          +
          +
          + +

          +getPort

          +
          +public int getPort()
          +
          +
          Get the port attribute. +

          +

          +
          +
          +
          + +
          Returns:
          the port
          +
          +
          +
          + +

          +init

          +
          +public void init()
+          throws BuildException
          +
          +
          Initialize the task. + This initializizs the known hosts and sets the default port. +

          +

          +
          Overrides:
          init in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +openSession

          +
          +protected com.jcraft.jsch.Session openSession()
+                                       throws com.jcraft.jsch.JSchException
          +
          +
          Open an ssh seession. +

          +

          +
          +
          +
          + +
          Returns:
          the opened session +
          Throws: +
          com.jcraft.jsch.JSchException - on error
          +
          +
          +
          + +

          +getUserInfo

          +
          +protected SSHUserInfo getUserInfo()
          +
          +
          Get the user information. +

          +

          +
          +
          +
          + +
          Returns:
          the user information
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html new file mode 100644 index 000000000..ef4fc8cdd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHExec.html @@ -0,0 +1,511 @@ + + + + + + +SSHExec (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHExec

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
+              extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHExec
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, LogListener
          +
          +
          +
          +
          public class SSHExec
          extends SSHBase
          + + +

          +Executes a command on a remote machine via ssh. +

          + +

          +

          +
          Since:
          +
          Ant 1.6 (created February 2, 2003)
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SSHExec() + +
          +          Constructor for SSHExecTask.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Execute the command on the remote host.
          + voidsetAppend(boolean append) + +
          +          Determines if the output is appended to the file given in + setOutput.
          + voidsetCommand(java.lang.String command) + +
          +          Sets the command to execute on the remote host.
          + voidsetCommandResource(java.lang.String f) + +
          +          Sets a commandResource from a file
          + voidsetInput(java.io.File input) + +
          +          If used, the content of the file is piped to the remote command
          + voidsetInputProperty(java.lang.String inputProperty) + +
          +          If used, the content of the property is piped to the remote command
          + voidsetOutput(java.io.File output) + +
          +          If used, stores the output of the command to the given file.
          + voidsetOutputproperty(java.lang.String property) + +
          +          If set, the output of the command will be stored in the given property.
          + voidsetTimeout(long timeout) + +
          +          The connection can be dropped after a specified number of + milliseconds.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
          getFailonerror, getHost, getPort, getUserInfo, getVerbose, init, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener
          log
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHExec

          +
          +public SSHExec()
          +
          +
          Constructor for SSHExecTask. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setCommand

          +
          +public void setCommand(java.lang.String command)
          +
          +
          Sets the command to execute on the remote host. +

          +

          +
          Parameters:
          command - The new command value
          +
          +
          +
          + +

          +setCommandResource

          +
          +public void setCommandResource(java.lang.String f)
          +
          +
          Sets a commandResource from a file +

          +

          +
          Parameters:
          f - the value to use.
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(long timeout)
          +
          +
          The connection can be dropped after a specified number of + milliseconds. This is sometimes useful when a connection may be + flaky. Default is 0, which means "wait forever". +

          +

          +
          Parameters:
          timeout - The new timeout value in seconds
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.File output)
          +
          +
          If used, stores the output of the command to the given file. +

          +

          +
          Parameters:
          output - The file to write to.
          +
          +
          +
          + +

          +setInput

          +
          +public void setInput(java.io.File input)
          +
          +
          If used, the content of the file is piped to the remote command +

          +

          +
          Parameters:
          input - The file which provides the input data for the remote command
          +
          +
          +
          + +

          +setInputProperty

          +
          +public void setInputProperty(java.lang.String inputProperty)
          +
          +
          If used, the content of the property is piped to the remote command +

          +

          +
          Parameters:
          inputProperty - The property which contains the input data for the remote command.
          +
          +
          +
          + +

          +setAppend

          +
          +public void setAppend(boolean append)
          +
          +
          Determines if the output is appended to the file given in + setOutput. Default is false, that is, overwrite + the file. +

          +

          +
          Parameters:
          append - True to append to an existing file, false to overwrite.
          +
          +
          +
          + +

          +setOutputproperty

          +
          +public void setOutputproperty(java.lang.String property)
          +
          +
          If set, the output of the command will be stored in the given property. +

          +

          +
          Parameters:
          property - The name of the property in which the command output + will be stored.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute the command on the remote host. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - Most likely a network error or bad parameter.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.LocalTunnel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.LocalTunnel.html new file mode 100644 index 000000000..8c08c5e6b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.LocalTunnel.html @@ -0,0 +1,345 @@ + + + + + + +SSHSession.LocalTunnel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHSession.LocalTunnel

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.LocalTunnel
+
          +
          +
          Enclosing class:
          SSHSession
          +
          +
          +
          +
          public class SSHSession.LocalTunnel
          extends java.lang.Object
          + + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SSHSession.LocalTunnel() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetLPort() + +
          +           
          + java.lang.StringgetRHost() + +
          +           
          + intgetRPort() + +
          +           
          + voidsetLPort(int lport) + +
          +           
          + voidsetRHost(java.lang.String rhost) + +
          +           
          + voidsetRPort(int rport) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHSession.LocalTunnel

          +
          +public SSHSession.LocalTunnel()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLPort

          +
          +public void setLPort(int lport)
          +
          +
          +
          +
          +
          +
          + +

          +setRHost

          +
          +public void setRHost(java.lang.String rhost)
          +
          +
          +
          +
          +
          +
          + +

          +setRPort

          +
          +public void setRPort(int rport)
          +
          +
          +
          +
          +
          +
          + +

          +getLPort

          +
          +public int getLPort()
          +
          +
          +
          +
          +
          +
          + +

          +getRHost

          +
          +public java.lang.String getRHost()
          +
          +
          +
          +
          +
          +
          + +

          +getRPort

          +
          +public int getRPort()
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.NestedSequential.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.NestedSequential.html new file mode 100644 index 000000000..24dbbcead --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.NestedSequential.html @@ -0,0 +1,286 @@ + + + + + + +SSHSession.NestedSequential (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHSession.NestedSequential

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.NestedSequential
+
          +
          +
          All Implemented Interfaces:
          TaskContainer
          +
          +
          +
          Enclosing class:
          SSHSession
          +
          +
          +
          +
          public static class SSHSession.NestedSequential
          extends java.lang.Object
          implements TaskContainer
          + + +

          +The class corresponding to the sequential nested element. + This is a simple task container. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SSHSession.NestedSequential() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddTask(Task task) + +
          +          Add a task or type to the container.
          + java.util.ListgetNested() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHSession.NestedSequential

          +
          +public SSHSession.NestedSequential()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addTask

          +
          +public void addTask(Task task)
          +
          +
          Add a task or type to the container. +

          +

          +
          Specified by:
          addTask in interface TaskContainer
          +
          +
          +
          Parameters:
          task - an unknown element.
          +
          +
          +
          + +

          +getNested

          +
          +public java.util.List getNested()
          +
          +
          +
          +
          +
          + +
          Returns:
          the list of unknown elements
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.RemoteTunnel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.RemoteTunnel.html new file mode 100644 index 000000000..5a00e7cd9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.RemoteTunnel.html @@ -0,0 +1,345 @@ + + + + + + +SSHSession.RemoteTunnel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHSession.RemoteTunnel

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHSession.RemoteTunnel
+
          +
          +
          Enclosing class:
          SSHSession
          +
          +
          +
          +
          public class SSHSession.RemoteTunnel
          extends java.lang.Object
          + + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SSHSession.RemoteTunnel() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetLHost() + +
          +           
          + intgetLPort() + +
          +           
          + intgetRPort() + +
          +           
          + voidsetLHost(java.lang.String lhost) + +
          +           
          + voidsetLPort(int lport) + +
          +           
          + voidsetRPort(int rport) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHSession.RemoteTunnel

          +
          +public SSHSession.RemoteTunnel()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLPort

          +
          +public void setLPort(int lport)
          +
          +
          +
          +
          +
          +
          + +

          +setLHost

          +
          +public void setLHost(java.lang.String lhost)
          +
          +
          +
          +
          +
          +
          + +

          +setRPort

          +
          +public void setRPort(int rport)
          +
          +
          +
          +
          +
          +
          + +

          +getLPort

          +
          +public int getLPort()
          +
          +
          +
          +
          +
          +
          + +

          +getLHost

          +
          +public java.lang.String getLHost()
          +
          +
          +
          +
          +
          +
          + +

          +getRPort

          +
          +public int getRPort()
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.html new file mode 100644 index 000000000..753b51b1e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHSession.html @@ -0,0 +1,523 @@ + + + + + + +SSHSession (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHSession

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
+              extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHSession
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, LogListener
          +
          +
          +
          +
          public class SSHSession
          extends SSHBase
          + + +

          +Establishes an ssh session with a remote machine, optionally + establishing port forwarding, then executes any nested task(s) + before closing the session. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          + classSSHSession.LocalTunnel + +
          +           
          +static classSSHSession.NestedSequential + +
          +          The class corresponding to the sequential nested element.
          + classSSHSession.RemoteTunnel + +
          +           
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SSHSession() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddTask(Task nestedTask) + +
          +          Add a nested task to Sequential.
          + SSHSession.LocalTunnelcreateLocalTunnel() + +
          +           
          + SSHSession.RemoteTunnelcreateRemoteTunnel() + +
          +           
          + SSHSession.NestedSequentialcreateSequential() + +
          +          This is the sequential nested element of the macrodef.
          + voidexecute() + +
          +          Establish the ssh session and execute all nestedTasks
          + voidsetLocaltunnels(java.lang.String tunnels) + +
          +          Changes the comma-delimited list of local tunnels to establish + on the connection.
          + voidsetRemotetunnels(java.lang.String tunnels) + +
          +          Changes the comma-delimited list of remote tunnels to establish + on the connection.
          + voidsetTimeout(long timeout) + +
          +          The connection can be dropped after a specified number of + milliseconds.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
          getFailonerror, getHost, getPort, getUserInfo, getVerbose, init, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener
          log
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHSession

          +
          +public SSHSession()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addTask

          +
          +public void addTask(Task nestedTask)
          +
          +
          Add a nested task to Sequential. +

          +

          +

          +
          Parameters:
          nestedTask - Nested task to execute Sequential +

          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(long timeout)
          +
          +
          The connection can be dropped after a specified number of + milliseconds. This is sometimes useful when a connection may be + flaky. Default is 0, which means "wait forever". +

          +

          +
          Parameters:
          timeout - The new timeout value in seconds
          +
          +
          +
          + +

          +setLocaltunnels

          +
          +public void setLocaltunnels(java.lang.String tunnels)
          +
          +
          Changes the comma-delimited list of local tunnels to establish + on the connection. +

          +

          +
          Parameters:
          tunnels - a comma-delimited list of lport:rhost:rport + tunnel specifications
          +
          +
          +
          + +

          +setRemotetunnels

          +
          +public void setRemotetunnels(java.lang.String tunnels)
          +
          +
          Changes the comma-delimited list of remote tunnels to establish + on the connection. +

          +

          +
          Parameters:
          tunnels - a comma-delimited list of rport:lhost:lport + tunnel specifications
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Establish the ssh session and execute all nestedTasks +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if one of the nested tasks fails, or + network error or bad parameter.
          +
          +
          +
          + +

          +createLocalTunnel

          +
          +public SSHSession.LocalTunnel createLocalTunnel()
          +
          +
          +
          +
          +
          +
          + +

          +createRemoteTunnel

          +
          +public SSHSession.RemoteTunnel createRemoteTunnel()
          +
          +
          +
          +
          +
          +
          + +

          +createSequential

          +
          +public SSHSession.NestedSequential createSequential()
          +
          +
          This is the sequential nested element of the macrodef. +

          +

          + +
          Returns:
          a sequential element to be configured.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html new file mode 100644 index 000000000..22d450653 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/SSHUserInfo.html @@ -0,0 +1,708 @@ + + + + + + +SSHUserInfo (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class SSHUserInfo

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHUserInfo
+
          +
          +
          All Implemented Interfaces:
          com.jcraft.jsch.UIKeyboardInteractive, com.jcraft.jsch.UserInfo
          +
          +
          +
          +
          public class SSHUserInfo
          extends java.lang.Object
          implements com.jcraft.jsch.UserInfo, com.jcraft.jsch.UIKeyboardInteractive
          + + +

          +Class containing information on an SSH user. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          SSHUserInfo() + +
          +          Constructor for SSHUserInfo.
          SSHUserInfo(java.lang.String password, + boolean trustAllCertificates) + +
          +          Constructor for SSHUserInfo.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetKeyfile() + +
          +          Returns the keyfile.
          + java.lang.StringgetName() + +
          +          Gets the user name.
          + java.lang.StringgetPassphrase() + +
          +          Returns the passphrase.
          + java.lang.StringgetPassphrase(java.lang.String message) + +
          +          Gets the pass phrase of the user.
          + java.lang.StringgetPassword() + +
          +          Gets the user's password.
          + booleangetTrust() + +
          +           
          + booleanprompt(java.lang.String str) + +
          +          Prompts a string.
          + java.lang.String[]promptKeyboardInteractive(java.lang.String destination, + java.lang.String name, + java.lang.String instruction, + java.lang.String[] prompt, + boolean[] echo) + +
          +          Implementation of UIKeyboardInteractive#promptKeyboardInteractive.
          + booleanpromptPassphrase(java.lang.String message) + +
          +          Implement the UserInfo interface.
          + booleanpromptPassword(java.lang.String passwordPrompt) + +
          +          Implement the UserInfo interface.
          + booleanpromptYesNo(java.lang.String message) + +
          +          Implement the UserInfo interface.
          + booleanretry() + +
          +          Indicates whether a retry was done.
          + voidsetKeyfile(java.lang.String keyfile) + +
          +          Sets the keyfile.
          + voidsetName(java.lang.String name) + +
          +          Sets the name.
          + voidsetPassphrase(java.lang.String passphrase) + +
          +          Sets the passphrase.
          + voidsetPassword(java.lang.String password) + +
          +          Sets the password.
          + voidsetTrust(boolean trust) + +
          +          Sets the trust.
          + voidshowMessage(java.lang.String message) + +
          +          Implement the UserInfo interface (noop).
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SSHUserInfo

          +
          +public SSHUserInfo()
          +
          +
          Constructor for SSHUserInfo. +

          +

          +
          + +

          +SSHUserInfo

          +
          +public SSHUserInfo(java.lang.String password,
+                   boolean trustAllCertificates)
          +
          +
          Constructor for SSHUserInfo. +

          +

          +
          Parameters:
          password - the user's password
          trustAllCertificates - if true trust hosts whose identity is unknown
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Gets the user name. +

          +

          +
          +
          +
          + +
          Returns:
          the user name
          +
          +
          +
          + +

          +getPassphrase

          +
          +public java.lang.String getPassphrase(java.lang.String message)
          +
          +
          Gets the pass phrase of the user. +

          +

          +
          +
          +
          +
          Parameters:
          message - a message +
          Returns:
          the passphrase
          +
          +
          +
          + +

          +getPassword

          +
          +public java.lang.String getPassword()
          +
          +
          Gets the user's password. +

          +

          +
          Specified by:
          getPassword in interface com.jcraft.jsch.UserInfo
          +
          +
          + +
          Returns:
          the user's password
          +
          +
          +
          + +

          +prompt

          +
          +public boolean prompt(java.lang.String str)
          +
          +
          Prompts a string. +

          +

          +
          +
          +
          +
          Parameters:
          str - the string +
          Returns:
          whether the string was prompted
          +
          +
          +
          + +

          +retry

          +
          +public boolean retry()
          +
          +
          Indicates whether a retry was done. +

          +

          +
          +
          +
          + +
          Returns:
          whether a retry was done
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Sets the name. +

          +

          +
          +
          +
          +
          Parameters:
          name - The name to set
          +
          +
          +
          + +

          +setPassphrase

          +
          +public void setPassphrase(java.lang.String passphrase)
          +
          +
          Sets the passphrase. +

          +

          +
          +
          +
          +
          Parameters:
          passphrase - The passphrase to set
          +
          +
          +
          + +

          +setPassword

          +
          +public void setPassword(java.lang.String password)
          +
          +
          Sets the password. +

          +

          +
          +
          +
          +
          Parameters:
          password - The password to set
          +
          +
          +
          + +

          +setTrust

          +
          +public void setTrust(boolean trust)
          +
          +
          Sets the trust. +

          +

          +
          +
          +
          +
          Parameters:
          trust - whether to trust or not.
          +
          +
          +
          + +

          +getTrust

          +
          +public boolean getTrust()
          +
          +
          +
          +
          +
          + +
          Returns:
          whether to trust or not.
          +
          +
          +
          + +

          +getPassphrase

          +
          +public java.lang.String getPassphrase()
          +
          +
          Returns the passphrase. +

          +

          +
          Specified by:
          getPassphrase in interface com.jcraft.jsch.UserInfo
          +
          +
          + +
          Returns:
          String
          +
          +
          +
          + +

          +getKeyfile

          +
          +public java.lang.String getKeyfile()
          +
          +
          Returns the keyfile. +

          +

          +
          +
          +
          + +
          Returns:
          String
          +
          +
          +
          + +

          +setKeyfile

          +
          +public void setKeyfile(java.lang.String keyfile)
          +
          +
          Sets the keyfile. +

          +

          +
          +
          +
          +
          Parameters:
          keyfile - The keyfile to set
          +
          +
          +
          + +

          +promptPassphrase

          +
          +public boolean promptPassphrase(java.lang.String message)
          +
          +
          Implement the UserInfo interface. +

          +

          +
          Specified by:
          promptPassphrase in interface com.jcraft.jsch.UserInfo
          +
          +
          +
          Parameters:
          message - ignored +
          Returns:
          true always
          +
          +
          +
          + +

          +promptPassword

          +
          +public boolean promptPassword(java.lang.String passwordPrompt)
          +
          +
          Implement the UserInfo interface. +

          +

          +
          Specified by:
          promptPassword in interface com.jcraft.jsch.UserInfo
          +
          +
          +
          Parameters:
          passwordPrompt - ignored +
          Returns:
          true the first time this is called, false otherwise
          +
          +
          +
          + +

          +promptYesNo

          +
          +public boolean promptYesNo(java.lang.String message)
          +
          +
          Implement the UserInfo interface. +

          +

          +
          Specified by:
          promptYesNo in interface com.jcraft.jsch.UserInfo
          +
          +
          +
          Parameters:
          message - ignored +
          Returns:
          the value of trustAllCertificates
          +
          +
          +
          + +

          +showMessage

          +
          +public void showMessage(java.lang.String message)
          +
          +
          Implement the UserInfo interface (noop). +

          +

          +
          Specified by:
          showMessage in interface com.jcraft.jsch.UserInfo
          +
          +
          +
          Parameters:
          message - ignored
          +
          +
          +
          + +

          +promptKeyboardInteractive

          +
          +public java.lang.String[] promptKeyboardInteractive(java.lang.String destination,
+                                                    java.lang.String name,
+                                                    java.lang.String instruction,
+                                                    java.lang.String[] prompt,
+                                                    boolean[] echo)
          +
          +
          Implementation of UIKeyboardInteractive#promptKeyboardInteractive. +

          +

          +
          Specified by:
          promptKeyboardInteractive in interface com.jcraft.jsch.UIKeyboardInteractive
          +
          +
          +
          Parameters:
          destination - not used.
          name - not used.
          instruction - not used.
          prompt - the method checks if this is one in length.
          echo - the method checks if the first element is false. +
          Returns:
          the password in an size one array if there is a password + and if the prompt and echo checks pass.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Scp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Scp.html new file mode 100644 index 000000000..5c3c76788 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/Scp.html @@ -0,0 +1,630 @@ + + + + + + +Scp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class Scp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
+              extended by org.apache.tools.ant.taskdefs.optional.ssh.Scp
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, LogListener
          +
          +
          +
          +
          public class Scp
          extends SSHBase
          + + +

          +Ant task for sending files to remote machine over ssh/scp. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Scp() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          Adds a FileSet tranfer to remote host.
          + voidexecute() + +
          +          Execute this task.
          + voidinit() + +
          +          Initialize this task.
          + voidsetFile(java.lang.String aFromUri) + +
          +          Sets the file to be transferred.
          + voidsetLocalFile(java.lang.String aFromUri) + +
          +          Similiar to setFile but explicitly states that + the file is a local file.
          + voidsetLocalTodir(java.lang.String aToUri) + +
          +          Similiar to setTodir but explicitly states + that the directory is a local.
          + voidsetLocalTofile(java.lang.String aToUri) + +
          +          Changes the file name to the given name while receiving it, + only useful if receiving a single file.
          + voidsetPreservelastmodified(boolean yesOrNo) + +
          +          Sets flag to determine if file timestamp from + remote system is to be preserved during copy.
          + voidsetRemoteFile(java.lang.String aFromUri) + +
          +          Similiar to setFile but explicitly states that + the file is a remote file.
          + voidsetRemoteTodir(java.lang.String aToUri) + +
          +          Similiar to setTodir but explicitly states + that the directory is a remote.
          + voidsetRemoteTofile(java.lang.String aToUri) + +
          +          Changes the file name to the given name while sending it, + only useful if sending a single file.
          + voidsetSftp(boolean yesOrNo) + +
          +          Setting this to true to use sftp protocol.
          + voidsetTodir(java.lang.String aToUri) + +
          +          Sets the location where files will be transferred to.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.SSHBase
          getFailonerror, getHost, getPort, getUserInfo, getVerbose, openSession, setFailonerror, setHost, setKeyfile, setKnownhosts, setPassphrase, setPassword, setPort, setTrust, setUsername, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.optional.ssh.LogListener
          log
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Scp

          +
          +public Scp()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public void setFile(java.lang.String aFromUri)
          +
          +
          Sets the file to be transferred. This can either be a remote + file or a local file. Remote files take the form:
          + user:password@host:/directory/path/file.example
          + Files to transfer can also include a wildcard to include all + files in a remote directory. For example:
          + user:password@host:/directory/path/*
          +

          +

          +
          Parameters:
          aFromUri - a string representing the file to transfer.
          +
          +
          +
          + +

          +setTodir

          +
          +public void setTodir(java.lang.String aToUri)
          +
          +
          Sets the location where files will be transferred to. + This can either be a remote directory or a local directory. + Remote directories take the form of:
          + user:password@host:/directory/path/
          + This parameter is required. +

          +

          +
          Parameters:
          aToUri - a string representing the target of the copy.
          +
          +
          +
          + +

          +setLocalFile

          +
          +public void setLocalFile(java.lang.String aFromUri)
          +
          +
          Similiar to setFile but explicitly states that + the file is a local file. This is the only way to specify a + local file with a @ character. +

          +

          +
          Parameters:
          aFromUri - a string representing the source of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setRemoteFile

          +
          +public void setRemoteFile(java.lang.String aFromUri)
          +
          +
          Similiar to setFile but explicitly states that + the file is a remote file. +

          +

          +
          Parameters:
          aFromUri - a string representing the source of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setLocalTodir

          +
          +public void setLocalTodir(java.lang.String aToUri)
          +
          +
          Similiar to setTodir but explicitly states + that the directory is a local. This is the only way to specify + a local directory with a @ character. +

          +

          +
          Parameters:
          aToUri - a string representing the target of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setPreservelastmodified

          +
          +public void setPreservelastmodified(boolean yesOrNo)
          +
          +
          Sets flag to determine if file timestamp from + remote system is to be preserved during copy. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setRemoteTodir

          +
          +public void setRemoteTodir(java.lang.String aToUri)
          +
          +
          Similiar to setTodir but explicitly states + that the directory is a remote. +

          +

          +
          Parameters:
          aToUri - a string representing the target of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setLocalTofile

          +
          +public void setLocalTofile(java.lang.String aToUri)
          +
          +
          Changes the file name to the given name while receiving it, + only useful if receiving a single file. +

          +

          +
          Parameters:
          aToUri - a string representing the target of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setRemoteTofile

          +
          +public void setRemoteTofile(java.lang.String aToUri)
          +
          +
          Changes the file name to the given name while sending it, + only useful if sending a single file. +

          +

          +
          Parameters:
          aToUri - a string representing the target of the copy.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +setSftp

          +
          +public void setSftp(boolean yesOrNo)
          +
          +
          Setting this to true to use sftp protocol. +

          +

          +
          Parameters:
          yesOrNo - if true sftp protocol will be used.
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          Adds a FileSet tranfer to remote host. NOTE: Either + addFileSet() or setFile() are required. But, not both. +

          +

          +
          Parameters:
          set - FileSet to send to remote host.
          +
          +
          +
          + +

          +init

          +
          +public void init()
+          throws BuildException
          +
          +
          Initialize this task. +

          +

          +
          Overrides:
          init in class SSHBase
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Execute this task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html new file mode 100644 index 000000000..80b80922a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessage.html @@ -0,0 +1,402 @@ + + + + + + +ScpFromMessage (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class ScpFromMessage

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
+      extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage
+
          +
          +
          Direct Known Subclasses:
          ScpFromMessageBySftp
          +
          +
          +
          +
          public class ScpFromMessage
          extends AbstractSshMessage
          + + +

          +A helper object representing an scp download. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ScpFromMessage(boolean verbose, + com.jcraft.jsch.Session session) + +
          +          Constructor for ScpFromMessage
          ScpFromMessage(boolean verbose, + com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive) + +
          +          Constructor for ScpFromMessage.
          ScpFromMessage(boolean verbose, + com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive, + boolean preserveLastModified) + +
          +          Constructor for ScpFromMessage.
          ScpFromMessage(com.jcraft.jsch.Session session) + +
          +          Constructor for ScpFromMessage
          ScpFromMessage(com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive) + +
          +          Constructor for ScpFromMessage.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Carry out the transfer.
          +protected  booleangetPreserveLastModified() + +
          +           
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
          getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScpFromMessage

          +
          +public ScpFromMessage(com.jcraft.jsch.Session session)
          +
          +
          Constructor for ScpFromMessage +

          +

          +
          Parameters:
          session - the ssh session to use
          +
          +
          + +

          +ScpFromMessage

          +
          +public ScpFromMessage(boolean verbose,
+                      com.jcraft.jsch.Session session)
          +
          +
          Constructor for ScpFromMessage +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the ssh session to use
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +ScpFromMessage

          +
          +public ScpFromMessage(boolean verbose,
+                      com.jcraft.jsch.Session session,
+                      java.lang.String aRemoteFile,
+                      java.io.File aLocalFile,
+                      boolean recursive)
          +
          +
          Constructor for ScpFromMessage. +

          +

          +
          Parameters:
          verbose - if true log extra information
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion (-r option to scp)
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          + +

          +ScpFromMessage

          +
          +public ScpFromMessage(com.jcraft.jsch.Session session,
+                      java.lang.String aRemoteFile,
+                      java.io.File aLocalFile,
+                      boolean recursive)
          +
          +
          Constructor for ScpFromMessage. +

          +

          +
          Parameters:
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion (-r option to scp)
          +
          +
          + +

          +ScpFromMessage

          +
          +public ScpFromMessage(boolean verbose,
+                      com.jcraft.jsch.Session session,
+                      java.lang.String aRemoteFile,
+                      java.io.File aLocalFile,
+                      boolean recursive,
+                      boolean preserveLastModified)
          +
          +
          Constructor for ScpFromMessage. +

          +

          +
          Parameters:
          verbose - if true log extra information
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion (-r option to scp)
          preserveLastModified - whether to preserve file + modification times
          Since:
          +
          Ant 1.8.0
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws java.io.IOException,
+                    com.jcraft.jsch.JSchException
          +
          +
          Carry out the transfer. +

          +

          +
          Specified by:
          execute in class AbstractSshMessage
          +
          +
          + +
          Throws: +
          java.io.IOException - on i/o errors +
          com.jcraft.jsch.JSchException - on errors detected by scp
          +
          +
          +
          + +

          +getPreserveLastModified

          +
          +protected boolean getPreserveLastModified()
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.html new file mode 100644 index 000000000..dcd59d243 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpFromMessageBySftp.html @@ -0,0 +1,350 @@ + + + + + + +ScpFromMessageBySftp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class ScpFromMessageBySftp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
+      extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessageBySftp
+
          +
          +
          +
          public class ScpFromMessageBySftp
          extends ScpFromMessage
          + + +

          +A helper object representing an scp download. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ScpFromMessageBySftp(boolean verbose, + com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive) + +
          +          Constructor for ScpFromMessageBySftp.
          ScpFromMessageBySftp(boolean verbose, + com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive, + boolean preserveLastModified) + +
          +          Constructor for ScpFromMessageBySftp.
          ScpFromMessageBySftp(com.jcraft.jsch.Session session, + java.lang.String aRemoteFile, + java.io.File aLocalFile, + boolean recursive) + +
          +          Constructor for ScpFromMessageBySftp.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Carry out the transfer.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.ScpFromMessage
          getPreserveLastModified
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
          getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScpFromMessageBySftp

          +
          +public ScpFromMessageBySftp(boolean verbose,
+                            com.jcraft.jsch.Session session,
+                            java.lang.String aRemoteFile,
+                            java.io.File aLocalFile,
+                            boolean recursive)
          +
          +
          Constructor for ScpFromMessageBySftp. +

          +

          +
          Parameters:
          verbose - if true log extra information
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +ScpFromMessageBySftp

          +
          +public ScpFromMessageBySftp(com.jcraft.jsch.Session session,
+                            java.lang.String aRemoteFile,
+                            java.io.File aLocalFile,
+                            boolean recursive)
          +
          +
          Constructor for ScpFromMessageBySftp. +

          +

          +
          Parameters:
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion
          +
          +
          + +

          +ScpFromMessageBySftp

          +
          +public ScpFromMessageBySftp(boolean verbose,
+                            com.jcraft.jsch.Session session,
+                            java.lang.String aRemoteFile,
+                            java.io.File aLocalFile,
+                            boolean recursive,
+                            boolean preserveLastModified)
          +
          +
          Constructor for ScpFromMessageBySftp. +

          +

          +
          Parameters:
          verbose - if true log extra information
          session - the Scp session to use
          aRemoteFile - the remote file name
          aLocalFile - the local file
          recursive - if true use recursion
          preserveLastModified - whether to preserve file + modification times
          Since:
          +
          Ant 1.8.0
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws java.io.IOException,
+                    com.jcraft.jsch.JSchException
          +
          +
          Carry out the transfer. +

          +

          +
          Overrides:
          execute in class ScpFromMessage
          +
          +
          + +
          Throws: +
          java.io.IOException - on i/o errors +
          com.jcraft.jsch.JSchException - on errors detected by scp
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html new file mode 100644 index 000000000..db7214f75 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessage.html @@ -0,0 +1,440 @@ + + + + + + +ScpToMessage (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class ScpToMessage

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
+      extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage
+
          +
          +
          Direct Known Subclasses:
          ScpToMessageBySftp
          +
          +
          +
          +
          public class ScpToMessage
          extends AbstractSshMessage
          + + +

          +Utility class to carry out an upload scp transfer. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ScpToMessage(boolean verbose, + com.jcraft.jsch.Session session) + +
          +          Constructor for ScpToMessage
          ScpToMessage(boolean verbose, + com.jcraft.jsch.Session session, + java.io.File aLocalFile, + java.lang.String aRemotePath) + +
          +          Constructor for a local file to remote.
          ScpToMessage(boolean verbose, + com.jcraft.jsch.Session session, + java.util.List aDirectoryList, + java.lang.String aRemotePath) + +
          +          Constructor for a local directories to remote.
          ScpToMessage(com.jcraft.jsch.Session session) + +
          +          Constructor for ScpToMessage
          ScpToMessage(com.jcraft.jsch.Session session, + java.io.File aLocalFile, + java.lang.String aRemotePath) + +
          +          Constructor for ScpToMessage.
          ScpToMessage(com.jcraft.jsch.Session session, + java.util.List aDirectoryList, + java.lang.String aRemotePath) + +
          +          Constructor for ScpToMessage.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Carry out the transfer.
          + java.io.FilegetLocalFile() + +
          +          Get the local file
          + java.lang.StringgetRemotePath() + +
          +          Get the remote path
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
          getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScpToMessage

          +
          +public ScpToMessage(com.jcraft.jsch.Session session)
          +
          +
          Constructor for ScpToMessage +

          +

          +
          Parameters:
          session - the ssh session to use
          +
          +
          + +

          +ScpToMessage

          +
          +public ScpToMessage(boolean verbose,
+                    com.jcraft.jsch.Session session)
          +
          +
          Constructor for ScpToMessage +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the ssh session to use
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +ScpToMessage

          +
          +public ScpToMessage(boolean verbose,
+                    com.jcraft.jsch.Session session,
+                    java.io.File aLocalFile,
+                    java.lang.String aRemotePath)
          +
          +
          Constructor for a local file to remote. +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the scp session to use
          aLocalFile - the local file
          aRemotePath - the remote path
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          + +

          +ScpToMessage

          +
          +public ScpToMessage(boolean verbose,
+                    com.jcraft.jsch.Session session,
+                    java.util.List aDirectoryList,
+                    java.lang.String aRemotePath)
          +
          +
          Constructor for a local directories to remote. +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the scp session to use
          aDirectoryList - a list of directories
          aRemotePath - the remote path
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          + +

          +ScpToMessage

          +
          +public ScpToMessage(com.jcraft.jsch.Session session,
+                    java.io.File aLocalFile,
+                    java.lang.String aRemotePath)
          +
          +
          Constructor for ScpToMessage. +

          +

          +
          Parameters:
          session - the scp session to use
          aLocalFile - the local file
          aRemotePath - the remote path
          +
          +
          + +

          +ScpToMessage

          +
          +public ScpToMessage(com.jcraft.jsch.Session session,
+                    java.util.List aDirectoryList,
+                    java.lang.String aRemotePath)
          +
          +
          Constructor for ScpToMessage. +

          +

          +
          Parameters:
          session - the scp session to use
          aDirectoryList - a list of directories
          aRemotePath - the remote path
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws java.io.IOException,
+                    com.jcraft.jsch.JSchException
          +
          +
          Carry out the transfer. +

          +

          +
          Specified by:
          execute in class AbstractSshMessage
          +
          +
          + +
          Throws: +
          java.io.IOException - on i/o errors +
          com.jcraft.jsch.JSchException - on errors detected by scp
          +
          +
          +
          + +

          +getLocalFile

          +
          +public java.io.File getLocalFile()
          +
          +
          Get the local file +

          +

          + +
          Returns:
          the local file
          +
          +
          +
          + +

          +getRemotePath

          +
          +public java.lang.String getRemotePath()
          +
          +
          Get the remote path +

          +

          + +
          Returns:
          the remote path
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.html new file mode 100644 index 000000000..3f7af1053 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/ScpToMessageBySftp.html @@ -0,0 +1,404 @@ + + + + + + +ScpToMessageBySftp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.ssh +
          +Class ScpToMessageBySftp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
+      extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessage
+          extended by org.apache.tools.ant.taskdefs.optional.ssh.ScpToMessageBySftp
+
          +
          +
          +
          public class ScpToMessageBySftp
          extends ScpToMessage
          + + +

          +Utility class to carry out an upload by sftp. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ScpToMessageBySftp(boolean verbose, + com.jcraft.jsch.Session session, + java.io.File aLocalFile, + java.lang.String aRemotePath) + +
          +          Constructor for a local file to remote.
          ScpToMessageBySftp(boolean verbose, + com.jcraft.jsch.Session session, + java.util.List aDirectoryList, + java.lang.String aRemotePath) + +
          +          Constructor for a local directories to remote.
          ScpToMessageBySftp(com.jcraft.jsch.Session session, + java.io.File aLocalFile, + java.lang.String aRemotePath) + +
          +          Constructor for ScpToMessage.
          ScpToMessageBySftp(com.jcraft.jsch.Session session, + java.util.List aDirectoryList, + java.lang.String aRemotePath) + +
          +          Constructor for ScpToMessage.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Carry out the transfer.
          + java.io.FilegetLocalFile() + +
          +          Get the local file.
          + java.lang.StringgetRemotePath() + +
          +          Get the remote path.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.ssh.AbstractSshMessage
          getProgressMonitor, getVerbose, log, logStats, openExecChannel, openSftpChannel, sendAck, setLogListener, trackProgress, waitForAck
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScpToMessageBySftp

          +
          +public ScpToMessageBySftp(boolean verbose,
+                          com.jcraft.jsch.Session session,
+                          java.io.File aLocalFile,
+                          java.lang.String aRemotePath)
          +
          +
          Constructor for a local file to remote. +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the scp session to use
          aLocalFile - the local file
          aRemotePath - the remote path
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +ScpToMessageBySftp

          +
          +public ScpToMessageBySftp(boolean verbose,
+                          com.jcraft.jsch.Session session,
+                          java.util.List aDirectoryList,
+                          java.lang.String aRemotePath)
          +
          +
          Constructor for a local directories to remote. +

          +

          +
          Parameters:
          verbose - if true do verbose logging
          session - the scp session to use
          aDirectoryList - a list of directories
          aRemotePath - the remote path
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +

          +ScpToMessageBySftp

          +
          +public ScpToMessageBySftp(com.jcraft.jsch.Session session,
+                          java.io.File aLocalFile,
+                          java.lang.String aRemotePath)
          +
          +
          Constructor for ScpToMessage. +

          +

          +
          Parameters:
          session - the scp session to use
          aLocalFile - the local file
          aRemotePath - the remote path
          +
          +
          + +

          +ScpToMessageBySftp

          +
          +public ScpToMessageBySftp(com.jcraft.jsch.Session session,
+                          java.util.List aDirectoryList,
+                          java.lang.String aRemotePath)
          +
          +
          Constructor for ScpToMessage. +

          +

          +
          Parameters:
          session - the scp session to use
          aDirectoryList - a list of directories
          aRemotePath - the remote path
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute()
+             throws java.io.IOException,
+                    com.jcraft.jsch.JSchException
          +
          +
          Carry out the transfer. +

          +

          +
          Overrides:
          execute in class ScpToMessage
          +
          +
          + +
          Throws: +
          java.io.IOException - on i/o errors +
          com.jcraft.jsch.JSchException - on errors detected by scp
          +
          +
          +
          + +

          +getLocalFile

          +
          +public java.io.File getLocalFile()
          +
          +
          Get the local file. +

          +

          +
          Overrides:
          getLocalFile in class ScpToMessage
          +
          +
          + +
          Returns:
          the local file.
          +
          +
          +
          + +

          +getRemotePath

          +
          +public java.lang.String getRemotePath()
          +
          +
          Get the remote path. +

          +

          +
          Overrides:
          getRemotePath in class ScpToMessage
          +
          +
          + +
          Returns:
          the remote path.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-frame.html new file mode 100644 index 000000000..8799577fe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-frame.html @@ -0,0 +1,65 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ssh (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.ssh + + + + +
          +Interfaces  + +
          +LogListener
          + + + + + + +
          +Classes  + +
          +AbstractSshMessage +
          +Directory +
          +Scp +
          +ScpFromMessage +
          +ScpFromMessageBySftp +
          +ScpToMessage +
          +ScpToMessageBySftp +
          +SSHBase +
          +SSHExec +
          +SSHSession +
          +SSHSession.NestedSequential +
          +SSHUserInfo
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-summary.html new file mode 100644 index 000000000..88c7ea74e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-summary.html @@ -0,0 +1,212 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ssh (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.ssh +

          + + + + + + + + + +
          +Interface Summary
          LogListenerInterface for ssh log listeners to implement.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractSshMessageAbstract class for ssh upload and download
          DirectoryA helper object for Scp representing a directory in a file system.
          ScpAnt task for sending files to remote machine over ssh/scp.
          ScpFromMessageA helper object representing an scp download.
          ScpFromMessageBySftpA helper object representing an scp download.
          ScpToMessageUtility class to carry out an upload scp transfer.
          ScpToMessageBySftpUtility class to carry out an upload by sftp.
          SSHBaseBase class for Ant tasks using jsch.
          SSHExecExecutes a command on a remote machine via ssh.
          SSHSessionEstablishes an ssh session with a remote machine, optionally + establishing port forwarding, then executes any nested task(s) + before closing the session.
          SSHSession.NestedSequentialThe class corresponding to the sequential nested element.
          SSHUserInfoClass containing information on an SSH user.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-tree.html new file mode 100644 index 000000000..c313cedf9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ssh/package-tree.html @@ -0,0 +1,168 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.ssh Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.ssh +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          +
            +
          • org.apache.tools.ant.taskdefs.optional.ssh.LogListener
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BlockFor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BlockFor.html new file mode 100644 index 000000000..fbecf977e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BlockFor.html @@ -0,0 +1,379 @@ + + + + + + +BlockFor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.testing +
          +Class BlockFor

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.taskdefs.condition.ConditionBase
+          extended by org.apache.tools.ant.taskdefs.WaitFor
+              extended by org.apache.tools.ant.taskdefs.optional.testing.BlockFor
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class BlockFor
          extends WaitFor
          + + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.WaitFor
          WaitFor.Unit
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.WaitFor
          DEFAULT_CHECK_MILLIS, DEFAULT_MAX_WAIT_MILLIS, ONE_DAY, ONE_HOUR, ONE_MILLISECOND, ONE_MINUTE, ONE_SECOND, ONE_WEEK
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          BlockFor() + +
          +          Constructor that takes the name of the task in the task name.
          BlockFor(java.lang.String taskName) + +
          +          Constructor that takes the name of the task in the task name.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String message) + +
          +          Set the error text; all properties are expanded in the message.
          +protected  voidprocessTimeout() + +
          +          If the wait fails, a BuildException is thrown.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.WaitFor
          calculateCheckEveryMillis, calculateMaxWaitMillis, execute, processSuccess, setCheckEvery, setCheckEveryUnit, setMaxWait, setMaxWaitUnit, setTimeoutProperty
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.condition.ConditionBase
          add, addAnd, addAvailable, addChecksum, addContains, addEquals, addFilesMatch, addHttp, addIsFalse, addIsFileSelected, addIsReference, addIsSet, addIsTrue, addNot, addOr, addOs, addSocket, addUptodate, countConditions, getConditions, getTaskName, setTaskName
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BlockFor

          +
          +public BlockFor()
          +
          +
          Constructor that takes the name of the task in the task name. +

          +

          +
          + +

          +BlockFor

          +
          +public BlockFor(java.lang.String taskName)
          +
          +
          Constructor that takes the name of the task in the task name. +

          +

          +
          Parameters:
          taskName - the name of the task.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +processTimeout

          +
          +protected void processTimeout()
+                       throws BuildTimeoutException
          +
          +
          If the wait fails, a BuildException is thrown. All the superclasses actions are called first. +

          +

          +
          Overrides:
          processTimeout in class WaitFor
          +
          +
          + +
          Throws: +
          BuildTimeoutException - on timeout, using the text in text
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String message)
          +
          +
          Set the error text; all properties are expanded in the message. +

          +

          +
          Parameters:
          message - the text to use in a failure message
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BuildTimeoutException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BuildTimeoutException.html new file mode 100644 index 000000000..266ff1aa3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/BuildTimeoutException.html @@ -0,0 +1,391 @@ + + + + + + +BuildTimeoutException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.testing +
          +Class BuildTimeoutException

          +
          +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.apache.tools.ant.BuildException
+                  extended by org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable
          +
          +
          +
          +
          public class BuildTimeoutException
          extends BuildException
          + + +

          +This exception is used to indicate timeouts. +

          + +

          +

          +
          Since:
          +
          Ant1.8
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          BuildTimeoutException() + +
          +          Constructs a build exception with no descriptive information.
          BuildTimeoutException(java.lang.String message) + +
          +          Constructs an exception with the given descriptive message.
          BuildTimeoutException(java.lang.String message, + Location location) + +
          +          Constructs an exception with the given descriptive message and a + location in a file.
          BuildTimeoutException(java.lang.String message, + java.lang.Throwable cause) + +
          +          Constructs an exception with the given message and exception as + a root cause.
          BuildTimeoutException(java.lang.String msg, + java.lang.Throwable cause, + Location location) + +
          +          Constructs an exception with the given message and exception as + a root cause and a location in a file.
          BuildTimeoutException(java.lang.Throwable cause) + +
          +          Constructs an exception with the given exception as a root cause.
          BuildTimeoutException(java.lang.Throwable cause, + Location location) + +
          +          Constructs an exception with the given exception as + a root cause and a location in a file.
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.BuildException
          getException, getLocation, setLocation, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Throwable
          fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException()
          +
          +
          Constructs a build exception with no descriptive information. +

          +

          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.String message)
          +
          +
          Constructs an exception with the given descriptive message. +

          +

          +
          Parameters:
          message - A description of or information about the exception. + Should not be null.
          +
          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.String message,
+                             java.lang.Throwable cause)
          +
          +
          Constructs an exception with the given message and exception as + a root cause. +

          +

          +
          Parameters:
          message - A description of or information about the exception. + Should not be null unless a cause is specified.
          cause - The exception that might have caused this one. + May be null.
          +
          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.String msg,
+                             java.lang.Throwable cause,
+                             Location location)
          +
          +
          Constructs an exception with the given message and exception as + a root cause and a location in a file. +

          +

          +
          Parameters:
          msg - A description of or information about the exception. + Should not be null unless a cause is specified.
          cause - The exception that might have caused this one. + May be null.
          location - The location in the project file where the error + occurred. Must not be null.
          +
          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.Throwable cause)
          +
          +
          Constructs an exception with the given exception as a root cause. +

          +

          +
          Parameters:
          cause - The exception that might have caused this one. + Should not be null.
          +
          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.String message,
+                             Location location)
          +
          +
          Constructs an exception with the given descriptive message and a + location in a file. +

          +

          +
          Parameters:
          message - A description of or information about the exception. + Should not be null.
          location - The location in the project file where the error + occurred. Must not be null.
          +
          +
          + +

          +BuildTimeoutException

          +
          +public BuildTimeoutException(java.lang.Throwable cause,
+                             Location location)
          +
          +
          Constructs an exception with the given exception as + a root cause and a location in a file. +

          +

          +
          Parameters:
          cause - The exception that might have caused this one. + Should not be null.
          location - The location in the project file where the error + occurred. Must not be null.
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/Funtest.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/Funtest.html new file mode 100644 index 000000000..c7e772e87 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/Funtest.html @@ -0,0 +1,911 @@ + + + + + + +Funtest (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.testing +
          +Class Funtest

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.testing.Funtest
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Funtest
          extends Task
          + + +

          +Task to provide functional testing under Ant, with a fairly complex worflow of: + +

            +
          • Conditional execution
            • +
          • Application to start
            • +
          • A probe to "waitfor" before running tests
            • +
          • A tests sequence
            • +
          • A reporting sequence that runs after the tests have finished
            • +
          • A "teardown" clause that runs after the rest.
            • +
          • Automated termination of the program it executes, if a timeout is not met
            • +
          • Checking of a failure property and automatic raising of a fault + (with the text in failureText) + if test shutdown and reporting succeeded
            • +
          + + The task is designed to be framework neutral; it will work with JUnit, + TestNG and other test frameworks That can be + executed from Ant. It bears a resemblance to the FunctionalTest task from + SmartFrog, as the attribute names were + chosen to make migration easier. However, this task benefits from the + ability to tweak Ant's internals, and so + simplify the workflow, and from the experience of using the SmartFrog task. + No code has been shared. +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringAPPLICATION_EXCEPTION + +
          +          Application exception : "Application Exception"
          +static java.lang.StringAPPLICATION_FORCIBLY_SHUT_DOWN + +
          +          "Application forcibly shut down"
          +static java.lang.StringSHUTDOWN_INTERRUPTED + +
          +          "Shutdown interrupted"
          +static java.lang.StringSKIPPING_TESTS + +
          +          "Condition failed -skipping tests"
          +static java.lang.StringTEARDOWN_EXCEPTION + +
          +          Teardown exception : "Teardown Exception"
          +static java.lang.StringWARN_OVERRIDING + +
          +          "Overriding previous definition of "
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Funtest() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddApplication(Sequential sequence) + +
          +          Add an application.
          + voidaddBlock(BlockFor sequence) + +
          +          Add a block.
          + voidaddReporting(Sequential sequence) + +
          +          set reporting sequence of tasks.
          + voidaddSetup(Sequential sequence) + +
          +          Add a setup sequence.
          + voidaddTeardown(Sequential sequence) + +
          +          set teardown sequence of tasks.
          + voidaddTests(Sequential sequence) + +
          +          add tests.
          + ConditionBasecreateCondition() + +
          +          Add a condition element.
          + voidexecute() + +
          +          Run the functional test sequence.
          + BuildExceptiongetApplicationException() + +
          +          Get the application exception.
          + BuildExceptiongetTaskException() + +
          +          Get the task exception.
          + BuildExceptiongetTeardownException() + +
          +          Get the teardown exception.
          + BuildExceptiongetTestException() + +
          +          Get the test exception.
          +protected  voidignoringThrowable(java.lang.String type, + java.lang.Throwable thrown) + +
          +          log that we are ignoring something rather than rethrowing it.
          +protected  voidprocessExceptions() + +
          +          Now faults are analysed.
          + voidsetFailOnTeardownErrors(boolean failOnTeardownErrors) + +
          +          Set the failOnTeardownErrors attribute.
          + voidsetFailureMessage(java.lang.String failureMessage) + +
          +          Set the failureMessage attribute.
          + voidsetFailureProperty(java.lang.String failureProperty) + +
          +          Set the failureProperty attribute.
          + voidsetShutdownTime(long shutdownTime) + +
          +          Set the shutdownTime attribute.
          + voidsetShutdownUnit(WaitFor.Unit unit) + +
          +          Set the shutdownunit attribute.
          + voidsetTimeout(long timeout) + +
          +          Set the timeout attribute.
          + voidsetTimeoutUnit(WaitFor.Unit unit) + +
          +          Set the timeoutunit attribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +WARN_OVERRIDING

          +
          +public static final java.lang.String WARN_OVERRIDING
          +
          +
          "Overriding previous definition of " +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +APPLICATION_FORCIBLY_SHUT_DOWN

          +
          +public static final java.lang.String APPLICATION_FORCIBLY_SHUT_DOWN
          +
          +
          "Application forcibly shut down" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SHUTDOWN_INTERRUPTED

          +
          +public static final java.lang.String SHUTDOWN_INTERRUPTED
          +
          +
          "Shutdown interrupted" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SKIPPING_TESTS

          +
          +public static final java.lang.String SKIPPING_TESTS
          +
          +
          "Condition failed -skipping tests" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +APPLICATION_EXCEPTION

          +
          +public static final java.lang.String APPLICATION_EXCEPTION
          +
          +
          Application exception : "Application Exception" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TEARDOWN_EXCEPTION

          +
          +public static final java.lang.String TEARDOWN_EXCEPTION
          +
          +
          Teardown exception : "Teardown Exception" +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Funtest

          +
          +public Funtest()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createCondition

          +
          +public ConditionBase createCondition()
          +
          +
          Add a condition element. +

          +

          + +
          Returns:
          ConditionBase.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +addApplication

          +
          +public void addApplication(Sequential sequence)
          +
          +
          Add an application. +

          +

          +
          Parameters:
          sequence - the application to add.
          +
          +
          +
          + +

          +addSetup

          +
          +public void addSetup(Sequential sequence)
          +
          +
          Add a setup sequence. +

          +

          +
          Parameters:
          sequence - the setup sequence to add.
          +
          +
          +
          + +

          +addBlock

          +
          +public void addBlock(BlockFor sequence)
          +
          +
          Add a block. +

          +

          +
          Parameters:
          sequence - the block for to add.
          +
          +
          +
          + +

          +addTests

          +
          +public void addTests(Sequential sequence)
          +
          +
          add tests. +

          +

          +
          Parameters:
          sequence - a sequence to add.
          +
          +
          +
          + +

          +addReporting

          +
          +public void addReporting(Sequential sequence)
          +
          +
          set reporting sequence of tasks. +

          +

          +
          Parameters:
          sequence - a reporting sequence to use.
          +
          +
          +
          + +

          +addTeardown

          +
          +public void addTeardown(Sequential sequence)
          +
          +
          set teardown sequence of tasks. +

          +

          +
          Parameters:
          sequence - a teardown sequence to use.
          +
          +
          +
          + +

          +setFailOnTeardownErrors

          +
          +public void setFailOnTeardownErrors(boolean failOnTeardownErrors)
          +
          +
          Set the failOnTeardownErrors attribute. +

          +

          +
          Parameters:
          failOnTeardownErrors - the value to use.
          +
          +
          +
          + +

          +setFailureMessage

          +
          +public void setFailureMessage(java.lang.String failureMessage)
          +
          +
          Set the failureMessage attribute. +

          +

          +
          Parameters:
          failureMessage - the value to use.
          +
          +
          +
          + +

          +setFailureProperty

          +
          +public void setFailureProperty(java.lang.String failureProperty)
          +
          +
          Set the failureProperty attribute. +

          +

          +
          Parameters:
          failureProperty - the value to use.
          +
          +
          +
          + +

          +setShutdownTime

          +
          +public void setShutdownTime(long shutdownTime)
          +
          +
          Set the shutdownTime attribute. +

          +

          +
          Parameters:
          shutdownTime - the value to use.
          +
          +
          +
          + +

          +setTimeout

          +
          +public void setTimeout(long timeout)
          +
          +
          Set the timeout attribute. +

          +

          +
          Parameters:
          timeout - the value to use.
          +
          +
          +
          + +

          +setTimeoutUnit

          +
          +public void setTimeoutUnit(WaitFor.Unit unit)
          +
          +
          Set the timeoutunit attribute. +

          +

          +
          Parameters:
          unit - the value to use.
          +
          +
          +
          + +

          +setShutdownUnit

          +
          +public void setShutdownUnit(WaitFor.Unit unit)
          +
          +
          Set the shutdownunit attribute. +

          +

          +
          Parameters:
          unit - the value to use.
          +
          +
          +
          + +

          +getApplicationException

          +
          +public BuildException getApplicationException()
          +
          +
          Get the application exception. +

          +

          + +
          Returns:
          the application exception.
          +
          +
          +
          + +

          +getTeardownException

          +
          +public BuildException getTeardownException()
          +
          +
          Get the teardown exception. +

          +

          + +
          Returns:
          the teardown exception.
          +
          +
          +
          + +

          +getTestException

          +
          +public BuildException getTestException()
          +
          +
          Get the test exception. +

          +

          + +
          Returns:
          the test exception.
          +
          +
          +
          + +

          +getTaskException

          +
          +public BuildException getTaskException()
          +
          +
          Get the task exception. +

          +

          + +
          Returns:
          the task exception.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Run the functional test sequence. +

          + This is a fairly complex workflow -what is going on is that we try to clean up + no matter how the run ended, and to retain the innermost exception that got thrown + during cleanup. That is, if teardown fails after the tests themselves failed, it is the + test failing that is more important. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if something was caught during the run or teardown.
          +
          +
          +
          + +

          +processExceptions

          +
          +protected void processExceptions()
          +
          +
          Now faults are analysed. +

          The priority is +

            +
          1. testexceptions, except those indicating a build timeout when the application itself + failed.
            + (because often it is the application fault that is more interesting than the probe + failure, which is usually triggered by the application not starting +
          2. + Application exceptions (above test timeout exceptions) +
          3. + Teardown exceptions -except when they are being ignored +
          4. + Test failures as indicated by the failure property +
          +

          +

          +
          +
          +
          +
          + +

          +ignoringThrowable

          +
          +protected void ignoringThrowable(java.lang.String type,
+                                 java.lang.Throwable thrown)
          +
          +
          log that we are ignoring something rather than rethrowing it. +

          +

          +
          Parameters:
          type - name of exception
          thrown - what was thrown
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-frame.html new file mode 100644 index 000000000..083f6a720 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.testing (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.testing + + + + +
          +Classes  + +
          +BlockFor +
          +Funtest
          + + + + + + +
          +Exceptions  + +
          +BuildTimeoutException
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-summary.html new file mode 100644 index 000000000..c29548627 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.testing (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.testing +

          + + + + + + + + + + + + + +
          +Class Summary
          BlockFor 
          FuntestTask to provide functional testing under Ant, with a fairly complex worflow of: + + + Conditional execution + Application to start + A probe to "waitfor" before running tests + A tests sequence + A reporting sequence that runs after the tests have finished + A "teardown" clause that runs after the rest. + Automated termination of the program it executes, if a timeout is not met + Checking of a failure property and automatic raising of a fault + (with the text in failureText) + if test shutdown and reporting succeeded + + + The task is designed to be framework neutral; it will work with JUnit, + TestNG and other test frameworks That can be + executed from Ant.
          +  + +

          + + + + + + + + + +
          +Exception Summary
          BuildTimeoutExceptionThis exception is used to indicate timeouts.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-tree.html new file mode 100644 index 000000000..9dbf105b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/testing/package-tree.html @@ -0,0 +1,165 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.testing Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.testing +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.taskdefs.condition.ConditionBase
                  +
                • org.apache.tools.ant.taskdefs.WaitFor
                    +
                  • org.apache.tools.ant.taskdefs.optional.testing.BlockFor
                  +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.optional.testing.Funtest
                +
              +
            • java.lang.Throwable (implements java.io.Serializable) + +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.html new file mode 100644 index 000000000..9c0f5ac2f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/AbstractAccessTask.html @@ -0,0 +1,463 @@ + + + + + + +AbstractAccessTask (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.unix +
          +Class AbstractAccessTask

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          Chgrp, Chown
          +
          +
          +
          +
          public abstract class AbstractAccessTask
          extends ExecuteOn
          + + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          ExecuteOn.FileDirBoth
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
          cmdl, failOnError, newEnvironment, redirector, redirectorElement
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractAccessTask() + +
          +          Chmod task for setting file and directory permissions.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  booleanisValidOs() + +
          +          Automatically approve Unix OS's.
          + voidsetAddsourcefile(boolean b) + +
          +          Prevent the use of the addsourcefile atribute.
          + voidsetCommand(Commandline cmdl) + +
          +          Prevent the user from specifying a different command.
          + voidsetFile(java.io.File src) + +
          +          Set the file which should have its access attributes modified.
          + voidsetSkipEmptyFilesets(boolean skip) + +
          +          Prevent the skipping of empty filesets
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          add, add, addDirset, addFilelist, addFileset, checkConfiguration, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setType, setupRedirector, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
          addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setDir, setError, setErrorProperty, setExecutable, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractAccessTask

          +
          +public AbstractAccessTask()
          +
          +
          Chmod task for setting file and directory permissions. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public void setFile(java.io.File src)
          +
          +
          Set the file which should have its access attributes modified. +

          +

          +
          Parameters:
          src - the file to modify
          +
          +
          +
          + +

          +setCommand

          +
          +public void setCommand(Commandline cmdl)
          +
          +
          Prevent the user from specifying a different command. +

          +

          +
          Overrides:
          setCommand in class ExecTask
          +
          +
          +
          Parameters:
          cmdl - A user supplied command line that we won't accept.
          +
          +
          +
          + +

          +setSkipEmptyFilesets

          +
          +public void setSkipEmptyFilesets(boolean skip)
          +
          +
          Prevent the skipping of empty filesets +

          +

          +
          Overrides:
          setSkipEmptyFilesets in class ExecuteOn
          +
          +
          +
          Parameters:
          skip - A user supplied boolean we won't accept.
          +
          +
          +
          + +

          +setAddsourcefile

          +
          +public void setAddsourcefile(boolean b)
          +
          +
          Prevent the use of the addsourcefile atribute. +

          +

          +
          Overrides:
          setAddsourcefile in class ExecuteOn
          +
          +
          +
          Parameters:
          b - A user supplied boolean we won't accept.
          +
          +
          +
          + +

          +isValidOs

          +
          +protected boolean isValidOs()
          +
          +
          Automatically approve Unix OS's. +

          +

          +
          Overrides:
          isValidOs in class ExecTask
          +
          +
          + +
          Returns:
          true if a valid OS, for unix this is always true, otherwise + use the superclasses' test (user set).
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.html new file mode 100644 index 000000000..41b057196 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chgrp.html @@ -0,0 +1,426 @@ + + + + + + +Chgrp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.unix +
          +Class Chgrp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
+                      extended by org.apache.tools.ant.taskdefs.optional.unix.Chgrp
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Chgrp
          extends AbstractAccessTask
          + + +

          +Chgrp equivalent for unix-like environments. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          ExecuteOn.FileDirBoth
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
          cmdl, failOnError, newEnvironment, redirector, redirectorElement
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Chgrp() + +
          +          Chgrp task for setting unix group of a file.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcheckConfiguration() + +
          +          Ensure that all the required arguments and other conditions have + been set.
          + voidsetExecutable(java.lang.String e) + +
          +          We don't want to expose the executable atribute, so overide it.
          + voidsetGroup(java.lang.String group) + +
          +          Set the group atribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
          isValidOs, setAddsourcefile, setCommand, setFile, setSkipEmptyFilesets
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          add, add, addDirset, addFilelist, addFileset, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setType, setupRedirector, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
          addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setDir, setError, setErrorProperty, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Chgrp

          +
          +public Chgrp()
          +
          +
          Chgrp task for setting unix group of a file. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setGroup

          +
          +public void setGroup(java.lang.String group)
          +
          +
          Set the group atribute. +

          +

          +
          Parameters:
          group - The new group for the file(s) or directory(ies)
          +
          +
          +
          + +

          +checkConfiguration

          +
          +protected void checkConfiguration()
          +
          +
          Ensure that all the required arguments and other conditions have + been set. +

          +

          +
          Overrides:
          checkConfiguration in class ExecuteOn
          +
          +
          +
          +
          +
          +
          + +

          +setExecutable

          +
          +public void setExecutable(java.lang.String e)
          +
          +
          We don't want to expose the executable atribute, so overide it. +

          +

          +
          Overrides:
          setExecutable in class ExecTask
          +
          +
          +
          Parameters:
          e - User supplied executable that we won't accept.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chown.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chown.html new file mode 100644 index 000000000..3f5ee14b1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Chown.html @@ -0,0 +1,426 @@ + + + + + + +Chown (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.unix +
          +Class Chown

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
+                      extended by org.apache.tools.ant.taskdefs.optional.unix.Chown
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Chown
          extends AbstractAccessTask
          + + +

          +Chown equivalent for unix-like environments. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          ExecuteOn.FileDirBoth
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
          cmdl, failOnError, newEnvironment, redirector, redirectorElement
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Chown() + +
          +          Chown task for setting file and directory permissions.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcheckConfiguration() + +
          +          Ensure that all the required arguments and other conditions have + been set.
          + voidsetExecutable(java.lang.String e) + +
          +          We don't want to expose the executable atribute, so overide it.
          + voidsetOwner(java.lang.String owner) + +
          +          Set the owner atribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
          isValidOs, setAddsourcefile, setCommand, setFile, setSkipEmptyFilesets
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          add, add, addDirset, addFilelist, addFileset, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setMaxParallel, setParallel, setRelative, setType, setupRedirector, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
          addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setDir, setError, setErrorProperty, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Chown

          +
          +public Chown()
          +
          +
          Chown task for setting file and directory permissions. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setOwner

          +
          +public void setOwner(java.lang.String owner)
          +
          +
          Set the owner atribute. +

          +

          +
          Parameters:
          owner - The new owner for the file(s) or directory(ies)
          +
          +
          +
          + +

          +checkConfiguration

          +
          +protected void checkConfiguration()
          +
          +
          Ensure that all the required arguments and other conditions have + been set. +

          +

          +
          Overrides:
          checkConfiguration in class ExecuteOn
          +
          +
          +
          +
          +
          +
          + +

          +setExecutable

          +
          +public void setExecutable(java.lang.String e)
          +
          +
          We don't want to expose the executable atribute, so overide it. +

          +

          +
          Overrides:
          setExecutable in class ExecTask
          +
          +
          +
          Parameters:
          e - User supplied executable that we won't accept.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Symlink.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Symlink.html new file mode 100644 index 000000000..056c4dcad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/Symlink.html @@ -0,0 +1,744 @@ + + + + + + +Symlink (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.unix +
          +Class Symlink

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.dispatch.DispatchTask
+              extended by org.apache.tools.ant.taskdefs.optional.unix.Symlink
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Dispatchable
          +
          +
          +
          +
          public class Symlink
          extends DispatchTask
          + + +

          +Creates, Deletes, Records and Restores Symlinks. + +

          This task performs several related operations. In the most trivial + and default usage, it creates a link specified in the link attribute to + a resource specified in the resource attribute. The second usage of this + task is to traverse a directory structure specified by a fileset, + and write a properties file in each included directory describing the + links found in that directory. The third usage is to traverse a + directory structure specified by a fileset, looking for properties files + (also specified as included in the fileset) and recreate the links + that have been previously recorded for each directory. Finally, it can be + used to remove a symlink without deleting the associated resource. + +

          Usage examples: + +

          Make a link named "foo" to a resource named + "bar.foo" in subdir: + 

          + <symlink link="${dir.top}/foo" resource="${dir.top}/subdir/bar.foo"/>
+
          + +

          Record all links in subdir and its descendants in files named + "dir.links": + 

          + <symlink action="record" linkfilename="dir.links">
+    <fileset dir="${dir.top}" includes="subdir/**" />
+ </symlink>
+
          + +

          Recreate the links recorded in the previous example: + 

          + <symlink action="recreate">
+    <fileset dir="${dir.top}" includes="subdir/**/dir.links" />
+ </symlink>
+
          + +

          Delete a link named "foo" to a resource named + "bar.foo" in subdir: + 

          + <symlink action="delete" link="${dir.top}/foo"/>
+
          + +

          LIMITATIONS: Because Java has no direct support for + handling symlinks this task divines them by comparing canonical and + absolute paths. On non-unix systems this may cause false positives. + Furthermore, any operating system on which the command + ln -s link resource is not a valid command on the command line + will not be able to use action="delete", action="single" + or action="recreate", but action="record" should still + work. Finally, the lack of support for symlinks in Java means that all links + are recorded as links to the canonical resource name. + Therefore the link: link --> subdir/dir/../foo.bar will be + recorded as link=subdir/foo.bar and restored as + link --> subdir/foo.bar. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Symlink() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFileset(FileSet set) + +
          +          Add a fileset to this task.
          + voiddelete() + +
          +          Delete a symlink.
          +static voiddeleteSymlink(java.io.File linkfil) + +
          +          Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead
          +static voiddeleteSymlink(java.lang.String path) + +
          +          Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead
          + voidexecute() + +
          +          The standard method for executing any task.
          + voidinit() + +
          +          Initialize the task.
          + voidrecord() + +
          +          Record symlinks.
          + voidrecreate() + +
          +          Restore symlinks.
          + voidsetAction(java.lang.String action) + +
          +          Set the action to be performed.
          + voidsetFailOnError(boolean foe) + +
          +          Set failonerror mode.
          + voidsetLink(java.lang.String lnk) + +
          +          Set the name of the link.
          + voidsetLinkfilename(java.lang.String lf) + +
          +          Set the name of the file to which links will be written.
          + voidsetOverwrite(boolean owrite) + +
          +          Set overwrite mode.
          + voidsetResource(java.lang.String src) + +
          +          Set the name of the resource to which a link should be created.
          + voidsingle() + +
          +          Create a symlink.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.dispatch.DispatchTask
          getAction, getActionParameterName
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Symlink

          +
          +public Symlink()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +init

          +
          +public void init()
+          throws BuildException
          +
          +
          Initialize the task. +

          +

          +
          Overrides:
          init in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          The standard method for executing any task. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +single

          +
          +public void single()
+            throws BuildException
          +
          +
          Create a symlink. +

          +

          + +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +delete

          +
          +public void delete()
+            throws BuildException
          +
          +
          Delete a symlink. +

          +

          + +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +recreate

          +
          +public void recreate()
+              throws BuildException
          +
          +
          Restore symlinks. +

          +

          + +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +record

          +
          +public void record()
+            throws BuildException
          +
          +
          Record symlinks. +

          +

          + +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setOverwrite

          +
          +public void setOverwrite(boolean owrite)
          +
          +
          Set overwrite mode. If set to false (default) + the task will not overwrite existing links, and may stop the build + if a link already exists depending on the setting of failonerror. +

          +

          +
          Parameters:
          owrite - If true overwrite existing links.
          +
          +
          +
          + +

          +setFailOnError

          +
          +public void setFailOnError(boolean foe)
          +
          +
          Set failonerror mode. If set to true (default) the entire build fails + upon error; otherwise the error is logged and the build will continue. +

          +

          +
          Parameters:
          foe - If true throw BuildException on error, else log it.
          +
          +
          +
          + +

          +setAction

          +
          +public void setAction(java.lang.String action)
          +
          +
          Set the action to be performed. May be "single", + "delete", "recreate" or "record". +

          +

          +
          Overrides:
          setAction in class DispatchTask
          +
          +
          +
          Parameters:
          action - The action to perform.
          +
          +
          +
          + +

          +setLink

          +
          +public void setLink(java.lang.String lnk)
          +
          +
          Set the name of the link. Used when action = "single". +

          +

          +
          Parameters:
          lnk - The name for the link.
          +
          +
          +
          + +

          +setResource

          +
          +public void setResource(java.lang.String src)
          +
          +
          Set the name of the resource to which a link should be created. + Used when action = "single". +

          +

          +
          Parameters:
          src - The resource to be linked.
          +
          +
          +
          + +

          +setLinkfilename

          +
          +public void setLinkfilename(java.lang.String lf)
          +
          +
          Set the name of the file to which links will be written. + Used when action = "record". +

          +

          +
          Parameters:
          lf - The name of the file to write links to.
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet set)
          +
          +
          Add a fileset to this task. +

          +

          +
          Parameters:
          set - The fileset to add.
          +
          +
          +
          + +

          +deleteSymlink

          +
          +public static void deleteSymlink(java.lang.String path)
+                          throws java.io.IOException,
+                                 java.io.FileNotFoundException
          +
          +
          Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead +

          +

          Delete a symlink (without deleting the associated resource). + +

          This is a convenience method that simply invokes + deleteSymlink(java.io.File). +

          +

          +
          Parameters:
          path - A string containing the path of the symlink to delete. +
          Throws: +
          java.io.FileNotFoundException - When the path results in a + File that doesn't exist. +
          java.io.IOException - If calls to File.rename + or File.delete fail.
          +
          +
          +
          + +

          +deleteSymlink

          +
          +public static void deleteSymlink(java.io.File linkfil)
+                          throws java.io.IOException
          +
          +
          Deprecated. use + org.apache.tools.ant.util.SymbolicLinkUtils#deleteSymbolicLink + instead +

          +

          Delete a symlink (without deleting the associated resource). + +

          This is a utility method that removes a unix symlink without removing + the resource that the symlink points to. If it is accidentally invoked + on a real file, the real file will not be harmed.

          + +

          This method works by + getting the canonical path of the link, using the canonical path to + rename the resource (breaking the link) and then deleting the link. + The resource is then returned to its original name inside a finally + block to ensure that the resource is unharmed even in the event of + an exception.

          + +

          Since Ant 1.8.0 this method will try to delete the File object if + it reports it wouldn't exist (as symlinks pointing nowhere usually do). + Prior version would throw a FileNotFoundException in that case.

          +

          +

          +
          Parameters:
          linkfil - A File object of the symlink to delete. +
          Throws: +
          java.io.IOException - If calls to File.rename, + File.delete or + File.getCanonicalPath + fail.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-frame.html new file mode 100644 index 000000000..723fc9769 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.unix (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.unix + + + + +
          +Classes  + +
          +AbstractAccessTask +
          +Chgrp +
          +Chown +
          +Symlink
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-summary.html new file mode 100644 index 000000000..7b3bfa3ed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-summary.html @@ -0,0 +1,164 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.unix (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.unix +

          + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractAccessTask 
          ChgrpChgrp equivalent for unix-like environments.
          ChownChown equivalent for unix-like environments.
          SymlinkCreates, Deletes, Records and Restores Symlinks.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-tree.html new file mode 100644 index 000000000..f281310f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/unix/package-tree.html @@ -0,0 +1,161 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.unix Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.unix +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.dispatch.DispatchTask (implements org.apache.tools.ant.dispatch.Dispatchable) +
                    +
                  • org.apache.tools.ant.taskdefs.optional.unix.Symlink
                  +
                • org.apache.tools.ant.taskdefs.ExecTask
                    +
                  • org.apache.tools.ant.taskdefs.ExecuteOn
                      +
                    • org.apache.tools.ant.taskdefs.optional.unix.AbstractAccessTask
                        +
                      • org.apache.tools.ant.taskdefs.optional.unix.Chgrp
                      • org.apache.tools.ant.taskdefs.optional.unix.Chown
                      +
                    +
                  +
                +
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.CurrentModUpdated.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.CurrentModUpdated.html new file mode 100644 index 000000000..e5f354403 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.CurrentModUpdated.html @@ -0,0 +1,288 @@ + + + + + + +MSVSS.CurrentModUpdated (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSS.CurrentModUpdated

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS.CurrentModUpdated
+
          +
          +
          Enclosing class:
          MSVSS
          +
          +
          +
          +
          public static class MSVSS.CurrentModUpdated
          extends EnumeratedAttribute
          + + +

          +Extention of EnumeratedAttribute to hold the values for file time stamp. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSS.CurrentModUpdated() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Gets the list of allowable values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSS.CurrentModUpdated

          +
          +public MSVSS.CurrentModUpdated()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Gets the list of allowable values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          The values.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.WritableFiles.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.WritableFiles.html new file mode 100644 index 000000000..ef93e4e56 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.WritableFiles.html @@ -0,0 +1,288 @@ + + + + + + +MSVSS.WritableFiles (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSS.WritableFiles

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS.WritableFiles
+
          +
          +
          Enclosing class:
          MSVSS
          +
          +
          +
          +
          public static class MSVSS.WritableFiles
          extends EnumeratedAttribute
          + + +

          +Extention of EnumeratedAttribute to hold the values for writable filess. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSS.WritableFiles() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Gets the list of allowable values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSS.WritableFiles

          +
          +public MSVSS.WritableFiles()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Gets the list of allowable values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          The values.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.html new file mode 100644 index 000000000..ad904de9f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSS.html @@ -0,0 +1,1525 @@ + + + + + + +MSVSS (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSS

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          Direct Known Subclasses:
          MSVSSADD, MSVSSCHECKIN, MSVSSCHECKOUT, MSVSSCP, MSVSSCREATE, MSVSSGET, MSVSSHISTORY, MSVSSLABEL
          +
          +
          +
          +
          public abstract class MSVSS
          extends Task
          implements MSVSSConstants
          + + +

          +A base class for creating tasks for executing commands on Visual SourceSafe. +

          + The class extends the 'exec' task as it operates by executing the ss.exe program + supplied with SourceSafe. By default the task expects ss.exe to be in the path, + you can override this be specifying the ssdir attribute. +

          +

          + This class provides set and get methods for 'login' and 'vsspath' attributes. It + also contains constants for the flags that can be passed to SS. +

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classMSVSS.CurrentModUpdated + +
          +          Extention of EnumeratedAttribute to hold the values for file time stamp.
          +static classMSVSS.WritableFiles + +
          +          Extention of EnumeratedAttribute to hold the values for writable filess.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSS() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Executes the task.
          +protected  java.lang.StringgetAutoresponse() + +
          +          Gets the auto response string.
          +protected  java.lang.StringgetComment() + +
          +          Gets the comment string.
          + java.lang.StringgetFileTimeStamp() + +
          +          Gets the value set for the FileTimeStamp.
          +protected  java.lang.StringgetGetLocalCopy() + +
          +          Builds and returns the -G- flag if required.
          +protected  java.lang.StringgetLabel() + +
          +          Gets the label string.
          +protected  java.lang.StringgetLocalpath() + +
          +          Gets the localpath string.
          +protected  java.lang.StringgetLogin() + +
          +          Gets the login string.
          +protected  java.lang.StringgetOutput() + +
          +          Gets the output file string.
          +protected  java.lang.StringgetQuiet() + +
          +          Gets the quiet string.
          +protected  java.lang.StringgetRecursive() + +
          +          Gets the recursive string.
          +protected  java.lang.StringgetSSCommand() + +
          +          Gets the sscommand string.
          +protected  java.lang.StringgetStyle() + +
          +          Gets the style string.
          +protected  java.lang.StringgetUser() + +
          +          Gets the user string.
          +protected  java.lang.StringgetVersion() + +
          +          Gets the version string.
          +protected  java.lang.StringgetVersionDate() + +
          +          Gets the Version date string.
          +protected  java.lang.StringgetVersionDateLabel() + +
          +          Gets the version string.
          +protected  java.lang.StringgetVersionLabel() + +
          +          Gets the version string.
          +protected  java.lang.StringgetVsspath() + +
          +          Gets the vssserverpath string.
          +protected  java.lang.StringgetWritable() + +
          +          Gets the writable string.
          + java.lang.StringgetWritableFiles() + +
          +          Gets the value to determine the behaviour when encountering writable files.
          + voidsetFailOnError(boolean failOnError) + +
          +          Indicates if the build should fail if the Sourcesafe command does.
          +protected  voidsetInternalAutoResponse(java.lang.String autoResponse) + +
          +          Set the auto response attribute.
          +protected  voidsetInternalComment(java.lang.String comment) + +
          +          Set the internal comment attribute.
          +protected  voidsetInternalDate(java.lang.String date) + +
          +          Set the date attribute.
          +protected  voidsetInternalDateFormat(java.text.DateFormat dateFormat) + +
          +          Set the date format attribute.
          +protected  voidsetInternalFailOnError(boolean failOnError) + +
          +          Set the failOnError attribute.
          +protected  voidsetInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp) + +
          +          Set the timestamp attribute.
          +protected  voidsetInternalFromDate(java.lang.String fromDate) + +
          +          Set the from date attribute.
          +protected  voidsetInternalFromLabel(java.lang.String fromLabel) + +
          +          Set the from label attribute.
          +protected  voidsetInternalGetLocalCopy(boolean getLocalCopy) + +
          +          Set the getLocalCopy attribute.
          +protected  voidsetInternalLabel(java.lang.String label) + +
          +          Set the label attribute.
          +protected  voidsetInternalLocalPath(java.lang.String localPath) + +
          +          Set the local path comment attribute.
          +protected  voidsetInternalNumDays(int numDays) + +
          +          Set the num days attribute.
          +protected  voidsetInternalOutputFilename(java.lang.String outputFileName) + +
          +          Set the outputFileName comment attribute.
          +protected  voidsetInternalQuiet(boolean quiet) + +
          +          Set the quiet attribute.
          +protected  voidsetInternalRecursive(boolean recursive) + +
          +          Set the recursive attribute.
          +protected  voidsetInternalStyle(java.lang.String style) + +
          +          Set the style attribute.
          +protected  voidsetInternalToDate(java.lang.String toDate) + +
          +          Set the to date attribute.
          +protected  voidsetInternalToLabel(java.lang.String toLabel) + +
          +          Set the to label attribute.
          +protected  voidsetInternalUser(java.lang.String user) + +
          +          Set the user attribute.
          +protected  voidsetInternalVersion(java.lang.String version) + +
          +          Set the version attribute.
          +protected  voidsetInternalWritable(boolean writable) + +
          +          Set the writable attribute.
          +protected  voidsetInternalWritableFiles(MSVSS.WritableFiles writableFiles) + +
          +          Set the writableFiles attribute.
          + voidsetLogin(java.lang.String vssLogin) + +
          +          Login to use when accessing VSS, formatted as "username,password".
          + voidsetServerpath(java.lang.String serverPath) + +
          +          Directory where srssafe.ini resides.
          + voidsetSsdir(java.lang.String dir) + +
          +          Directory where ss.exe resides.
          + voidsetVsspath(java.lang.String vssPath) + +
          +          SourceSafe path which specifies the project/file(s) you wish to perform + the action on.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSS

          +
          +public MSVSS()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setSsdir

          +
          +public final void setSsdir(java.lang.String dir)
          +
          +
          Directory where ss.exe resides. + By default the task expects it to be in the PATH. +

          +

          +
          +
          +
          +
          Parameters:
          dir - The directory containing ss.exe.
          +
          +
          +
          + +

          +setLogin

          +
          +public final void setLogin(java.lang.String vssLogin)
          +
          +
          Login to use when accessing VSS, formatted as "username,password". +

          + You can omit the password if your database is not password protected. + If you have a password and omit it, Ant will hang. +

          +

          +
          +
          +
          +
          Parameters:
          vssLogin - The login string to use.
          +
          +
          +
          + +

          +setVsspath

          +
          +public final void setVsspath(java.lang.String vssPath)
          +
          +
          SourceSafe path which specifies the project/file(s) you wish to perform + the action on. +

          + A prefix of 'vss://' will be removed if specified. +

          +

          +
          +
          +
          +
          Parameters:
          vssPath - The VSS project path.
          +
          +
          +
          + +

          +setServerpath

          +
          +public final void setServerpath(java.lang.String serverPath)
          +
          +
          Directory where srssafe.ini resides. +

          +

          +
          +
          +
          +
          Parameters:
          serverPath - The path to the VSS server.
          +
          +
          +
          + +

          +setFailOnError

          +
          +public final void setFailOnError(boolean failOnError)
          +
          +
          Indicates if the build should fail if the Sourcesafe command does. Defaults to true. +

          +

          +
          +
          +
          +
          Parameters:
          failOnError - True if task should fail on any error.
          +
          +
          +
          + +

          +execute

          +
          +public void execute()
+             throws BuildException
          +
          +
          Executes the task.
          + Builds a command line to execute ss.exe and then calls Exec's run method + to execute the command line. +

          +

          +
          Overrides:
          execute in class Task
          +
          +
          + +
          Throws: +
          BuildException - if the command cannot execute.
          +
          +
          +
          + +

          +setInternalComment

          +
          +protected void setInternalComment(java.lang.String comment)
          +
          +
          Set the internal comment attribute. +

          +

          +
          +
          +
          +
          Parameters:
          comment - the value to use.
          +
          +
          +
          + +

          +setInternalAutoResponse

          +
          +protected void setInternalAutoResponse(java.lang.String autoResponse)
          +
          +
          Set the auto response attribute. +

          +

          +
          +
          +
          +
          Parameters:
          autoResponse - the value to use.
          +
          +
          +
          + +

          +setInternalDate

          +
          +protected void setInternalDate(java.lang.String date)
          +
          +
          Set the date attribute. +

          +

          +
          +
          +
          +
          Parameters:
          date - the value to use.
          +
          +
          +
          + +

          +setInternalDateFormat

          +
          +protected void setInternalDateFormat(java.text.DateFormat dateFormat)
          +
          +
          Set the date format attribute. +

          +

          +
          +
          +
          +
          Parameters:
          dateFormat - the value to use.
          +
          +
          +
          + +

          +setInternalFailOnError

          +
          +protected void setInternalFailOnError(boolean failOnError)
          +
          +
          Set the failOnError attribute. +

          +

          +
          +
          +
          +
          Parameters:
          failOnError - the value to use.
          +
          +
          +
          + +

          +setInternalFromDate

          +
          +protected void setInternalFromDate(java.lang.String fromDate)
          +
          +
          Set the from date attribute. +

          +

          +
          +
          +
          +
          Parameters:
          fromDate - the value to use.
          +
          +
          +
          + +

          +setInternalFromLabel

          +
          +protected void setInternalFromLabel(java.lang.String fromLabel)
          +
          +
          Set the from label attribute. +

          +

          +
          +
          +
          +
          Parameters:
          fromLabel - the value to use.
          +
          +
          +
          + +

          +setInternalLabel

          +
          +protected void setInternalLabel(java.lang.String label)
          +
          +
          Set the label attribute. +

          +

          +
          +
          +
          +
          Parameters:
          label - the value to use.
          +
          +
          +
          + +

          +setInternalLocalPath

          +
          +protected void setInternalLocalPath(java.lang.String localPath)
          +
          +
          Set the local path comment attribute. +

          +

          +
          +
          +
          +
          Parameters:
          localPath - the value to use.
          +
          +
          +
          + +

          +setInternalNumDays

          +
          +protected void setInternalNumDays(int numDays)
          +
          +
          Set the num days attribute. +

          +

          +
          +
          +
          +
          Parameters:
          numDays - the value to use.
          +
          +
          +
          + +

          +setInternalOutputFilename

          +
          +protected void setInternalOutputFilename(java.lang.String outputFileName)
          +
          +
          Set the outputFileName comment attribute. +

          +

          +
          +
          +
          +
          Parameters:
          outputFileName - the value to use.
          +
          +
          +
          + +

          +setInternalQuiet

          +
          +protected void setInternalQuiet(boolean quiet)
          +
          +
          Set the quiet attribute. +

          +

          +
          +
          +
          +
          Parameters:
          quiet - the value to use.
          +
          +
          +
          + +

          +setInternalRecursive

          +
          +protected void setInternalRecursive(boolean recursive)
          +
          +
          Set the recursive attribute. +

          +

          +
          +
          +
          +
          Parameters:
          recursive - the value to use.
          +
          +
          +
          + +

          +setInternalStyle

          +
          +protected void setInternalStyle(java.lang.String style)
          +
          +
          Set the style attribute. +

          +

          +
          +
          +
          +
          Parameters:
          style - the value to use.
          +
          +
          +
          + +

          +setInternalToDate

          +
          +protected void setInternalToDate(java.lang.String toDate)
          +
          +
          Set the to date attribute. +

          +

          +
          +
          +
          +
          Parameters:
          toDate - the value to use.
          +
          +
          +
          + +

          +setInternalToLabel

          +
          +protected void setInternalToLabel(java.lang.String toLabel)
          +
          +
          Set the to label attribute. +

          +

          +
          +
          +
          +
          Parameters:
          toLabel - the value to use.
          +
          +
          +
          + +

          +setInternalUser

          +
          +protected void setInternalUser(java.lang.String user)
          +
          +
          Set the user attribute. +

          +

          +
          +
          +
          +
          Parameters:
          user - the value to use.
          +
          +
          +
          + +

          +setInternalVersion

          +
          +protected void setInternalVersion(java.lang.String version)
          +
          +
          Set the version attribute. +

          +

          +
          +
          +
          +
          Parameters:
          version - the value to use.
          +
          +
          +
          + +

          +setInternalWritable

          +
          +protected void setInternalWritable(boolean writable)
          +
          +
          Set the writable attribute. +

          +

          +
          +
          +
          +
          Parameters:
          writable - the value to use.
          +
          +
          +
          + +

          +setInternalFileTimeStamp

          +
          +protected void setInternalFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
          +
          +
          Set the timestamp attribute. +

          +

          +
          +
          +
          +
          Parameters:
          timestamp - the value to use.
          +
          +
          +
          + +

          +setInternalWritableFiles

          +
          +protected void setInternalWritableFiles(MSVSS.WritableFiles writableFiles)
          +
          +
          Set the writableFiles attribute. +

          +

          +
          +
          +
          +
          Parameters:
          writableFiles - the value to use.
          +
          +
          +
          + +

          +setInternalGetLocalCopy

          +
          +protected void setInternalGetLocalCopy(boolean getLocalCopy)
          +
          +
          Set the getLocalCopy attribute. +

          +

          +
          +
          +
          +
          Parameters:
          getLocalCopy - the value to use.
          +
          +
          +
          + +

          +getSSCommand

          +
          +protected java.lang.String getSSCommand()
          +
          +
          Gets the sscommand string. "ss" or "c:\path\to\ss" +

          +

          +
          +
          +
          + +
          Returns:
          The path to ss.exe or just ss if sscommand is not set.
          +
          +
          +
          + +

          +getVsspath

          +
          +protected java.lang.String getVsspath()
          +
          +
          Gets the vssserverpath string. +

          +

          +
          +
          +
          + +
          Returns:
          null if vssserverpath is not set.
          +
          +
          +
          + +

          +getQuiet

          +
          +protected java.lang.String getQuiet()
          +
          +
          Gets the quiet string. -O- +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if quiet is not set or is false.
          +
          +
          +
          + +

          +getRecursive

          +
          +protected java.lang.String getRecursive()
          +
          +
          Gets the recursive string. "-R" +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if recursive is not set or is false.
          +
          +
          +
          + +

          +getWritable

          +
          +protected java.lang.String getWritable()
          +
          +
          Gets the writable string. "-W" +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if writable is not set or is false.
          +
          +
          +
          + +

          +getLabel

          +
          +protected java.lang.String getLabel()
          +
          +
          Gets the label string. "-Lbuild1" + Max label length is 32 chars +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if label is not set.
          +
          +
          +
          + +

          +getStyle

          +
          +protected java.lang.String getStyle()
          +
          +
          Gets the style string. "-Lbuild1" +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if label is not set.
          +
          +
          +
          + +

          +getVersionDateLabel

          +
          +protected java.lang.String getVersionDateLabel()
          +
          +
          Gets the version string. Returns the first specified of version "-V1.0", + date "-Vd01.01.01", label "-Vlbuild1". +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if a version, date and label are not set.
          +
          +
          +
          + +

          +getVersion

          +
          +protected java.lang.String getVersion()
          +
          +
          Gets the version string. +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if a version is not set.
          +
          +
          +
          + +

          +getLocalpath

          +
          +protected java.lang.String getLocalpath()
          +
          +
          Gets the localpath string. "-GLc:\source"

          + The localpath is created if it didn't exist. +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if localpath is not set.
          +
          +
          +
          + +

          +getComment

          +
          +protected java.lang.String getComment()
          +
          +
          Gets the comment string. "-Ccomment text" +

          +

          +
          +
          +
          + +
          Returns:
          A comment of "-" if comment is not set.
          +
          +
          +
          + +

          +getAutoresponse

          +
          +protected java.lang.String getAutoresponse()
          +
          +
          Gets the auto response string. This can be Y "-I-Y" or N "-I-N". +

          +

          +
          +
          +
          + +
          Returns:
          The default value "-I-" if autoresponse is not set.
          +
          +
          +
          + +

          +getLogin

          +
          +protected java.lang.String getLogin()
          +
          +
          Gets the login string. This can be user and password, "-Yuser,password" + or just user "-Yuser". +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if login is not set.
          +
          +
          +
          + +

          +getOutput

          +
          +protected java.lang.String getOutput()
          +
          +
          Gets the output file string. "-Ooutput.file" +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if user is not set.
          +
          +
          +
          + +

          +getUser

          +
          +protected java.lang.String getUser()
          +
          +
          Gets the user string. "-Uusername" +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if user is not set.
          +
          +
          +
          + +

          +getVersionLabel

          +
          +protected java.lang.String getVersionLabel()
          +
          +
          Gets the version string. This can be to-from "-VLbuild2~Lbuild1", from + "~Lbuild1" or to "-VLbuild2". +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if neither tolabel or fromlabel are set.
          +
          +
          +
          + +

          +getVersionDate

          +
          +protected java.lang.String getVersionDate()
+                                   throws BuildException
          +
          +
          Gets the Version date string. +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if neither Todate or from date are set. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +getGetLocalCopy

          +
          +protected java.lang.String getGetLocalCopy()
          +
          +
          Builds and returns the -G- flag if required. +

          +

          +
          +
          +
          + +
          Returns:
          An empty string if get local copy is true.
          +
          +
          +
          + +

          +getFileTimeStamp

          +
          +public java.lang.String getFileTimeStamp()
          +
          +
          Gets the value set for the FileTimeStamp. + if it equals "current" then we return -GTC + if it equals "modified" then we return -GTM + if it equals "updated" then we return -GTU + otherwise we return -GTC +

          +

          +
          +
          +
          + +
          Returns:
          The default file time flag, if not set.
          +
          +
          +
          + +

          +getWritableFiles

          +
          +public java.lang.String getWritableFiles()
          +
          +
          Gets the value to determine the behaviour when encountering writable files. +

          +

          +
          +
          +
          + +
          Returns:
          An empty String, if not set.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.html new file mode 100644 index 000000000..6372b7272 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSADD.html @@ -0,0 +1,477 @@ + + + + + + +MSVSSADD (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSADD

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSADD
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSADD
          extends MSVSS
          + + +

          +Performs Add commands to Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSADD() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Builds a command line to execute ss.
          +protected  java.lang.StringgetLocalpath() + +
          +          Returns the local path without the flag.; required
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetComment(java.lang.String comment) + +
          +          Comment to apply to files added to SourceSafe.
          + voidsetLocalpath(Path localPath) + +
          +          Override the project working directory.
          + voidsetRecursive(boolean recursive) + +
          +          Add files recursively.
          + voidsetWritable(boolean writable) + +
          +          Unset the READ-ONLY flag on local copies of files added to VSS.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSADD

          +
          +public MSVSSADD()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Builds a command line to execute ss. +

          +

          +
          +
          +
          + +
          Returns:
          The constructed commandline.
          +
          +
          +
          + +

          +getLocalpath

          +
          +protected java.lang.String getLocalpath()
          +
          +
          Returns the local path without the flag.; required +

          +

          +
          Overrides:
          getLocalpath in class MSVSS
          +
          +
          + +
          Returns:
          The local path value.
          To do:
          +
          See why this returns the local path without the flag.
          +
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Add files recursively. Defaults to false. +

          +

          +
          Parameters:
          recursive - The boolean value for recursive.
          +
          +
          +
          + +

          +setWritable

          +
          +public final void setWritable(boolean writable)
          +
          +
          Unset the READ-ONLY flag on local copies of files added to VSS. Defaults to false. +

          +

          +
          Parameters:
          writable - The boolean value for writable.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          Comment to apply to files added to SourceSafe. +

          +

          +
          Parameters:
          comment - The comment to apply in SourceSafe
          +
          +
          +
          + +

          +setLocalpath

          +
          +public void setLocalpath(Path localPath)
          +
          +
          Override the project working directory. +

          +

          +
          Parameters:
          localPath - The path on disk.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.html new file mode 100644 index 000000000..2b422157e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKIN.html @@ -0,0 +1,451 @@ + + + + + + +MSVSSCHECKIN (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSCHECKIN

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKIN
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSCHECKIN
          extends MSVSS
          + + +

          +Performs CheckIn commands to Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSCHECKIN() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Builds a command line to execute ss.
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetComment(java.lang.String comment) + +
          +          Comment to apply to files checked-in to SourceSafe.
          + voidsetLocalpath(Path localPath) + +
          +          Override the project working directory.
          + voidsetRecursive(boolean recursive) + +
          +          Check-in files recursively.
          + voidsetWritable(boolean writable) + +
          +          Unset the READ-ONLY flag on local copies of files checked-in to VSS.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSCHECKIN

          +
          +public MSVSSCHECKIN()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Builds a command line to execute ss. +

          +

          +
          +
          +
          + +
          Returns:
          The constructed commandline.
          +
          +
          +
          + +

          +setLocalpath

          +
          +public void setLocalpath(Path localPath)
          +
          +
          Override the project working directory. +

          +

          +
          Parameters:
          localPath - The path on disk.
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Check-in files recursively. Defaults to false. +

          +

          +
          Parameters:
          recursive - The boolean value for recursive.
          +
          +
          +
          + +

          +setWritable

          +
          +public final void setWritable(boolean writable)
          +
          +
          Unset the READ-ONLY flag on local copies of files checked-in to VSS. + Defaults to false. +

          +

          +
          Parameters:
          writable - The boolean value for writable.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          Comment to apply to files checked-in to SourceSafe. +

          +

          +
          Parameters:
          comment - The comment to apply in SourceSafe
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.html new file mode 100644 index 000000000..5f5290bf7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCHECKOUT.html @@ -0,0 +1,539 @@ + + + + + + +MSVSSCHECKOUT (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSCHECKOUT

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSCHECKOUT
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSCHECKOUT
          extends MSVSS
          + + +

          +Performs CheckOut commands to Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSCHECKOUT() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Builds a command line to execute ss.
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetDate(java.lang.String date) + +
          +          Date to check-out.
          + voidsetFileTimeStamp(MSVSS.CurrentModUpdated timestamp) + +
          +          Date and time stamp given to the local copy.
          + voidsetGetLocalCopy(boolean get) + +
          +          Retrieve a local copy during a checkout.
          + voidsetLabel(java.lang.String label) + +
          +          Label to check-out.
          + voidsetLocalpath(Path localPath) + +
          +          Override the project working directory.
          + voidsetRecursive(boolean recursive) + +
          +          Check-out files recursively.
          + voidsetVersion(java.lang.String version) + +
          +          Version to check-out.
          + voidsetWritableFiles(MSVSS.WritableFiles files) + +
          +          Action taken when local files are writable.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSCHECKOUT

          +
          +public MSVSSCHECKOUT()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Builds a command line to execute ss. +

          +

          +
          +
          +
          + +
          Returns:
          The constructed commandline.
          +
          +
          +
          + +

          +setLocalpath

          +
          +public void setLocalpath(Path localPath)
          +
          +
          Override the project working directory. +

          +

          +
          Parameters:
          localPath - The path on disk.
          +
          +
          +
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Check-out files recursively. Defaults to false. +

          +

          +
          Parameters:
          recursive - The boolean value for recursive.
          +
          +
          +
          + +

          +setVersion

          +
          +public void setVersion(java.lang.String version)
          +
          +
          Version to check-out. +

          +

          +
          Parameters:
          version - The version to check-out.
          +
          +
          +
          + +

          +setDate

          +
          +public void setDate(java.lang.String date)
          +
          +
          Date to check-out. +

          +

          +
          Parameters:
          date - The date to check-out.
          +
          +
          +
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
          +
          +
          Label to check-out. +

          +

          +
          Parameters:
          label - The label to check-out.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          +
          + +

          +setFileTimeStamp

          +
          +public void setFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
          +
          +
          Date and time stamp given to the local copy. Defaults to current. +

          +

          +
          Parameters:
          timestamp - The file time stamping behaviour.
          +
          +
          +
          + +

          +setWritableFiles

          +
          +public void setWritableFiles(MSVSS.WritableFiles files)
          +
          +
          Action taken when local files are writable. Defaults to fail. +

          + Due to ss.exe returning with an exit code of '100' for both errors and when + a file has been skipped, failonerror is set to false when using + the skip option. +

          +

          +

          +
          Parameters:
          files - The writable files behaviour
          +
          +
          +
          + +

          +setGetLocalCopy

          +
          +public void setGetLocalCopy(boolean get)
          +
          +
          Retrieve a local copy during a checkout. Defaults to true. +

          +

          +
          Parameters:
          get - The get local copy behaviour
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.html new file mode 100644 index 000000000..c01786c94 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCP.html @@ -0,0 +1,367 @@ + + + + + + +MSVSSCP (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSCP

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSCP
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSCP
          extends MSVSS
          + + +

          +Performs CP (Change Project) commands to Microsoft Visual SourceSafe. +

          This task is typically used before a VssAdd in order to set the target project

          +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSCP() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinebuildCmdLine() + +
          +          Builds a command line to execute ss.
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSCP

          +
          +public MSVSSCP()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +buildCmdLine

          +
          +protected Commandline buildCmdLine()
          +
          +
          Builds a command line to execute ss. +

          +

          +
          +
          +
          + +
          Returns:
          The constructed commandline.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.html new file mode 100644 index 000000000..04deb2718 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSCREATE.html @@ -0,0 +1,383 @@ + + + + + + +MSVSSCREATE (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSCREATE

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSCREATE
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSCREATE
          extends MSVSS
          + + +

          +Creates a new project in Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSCREATE() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetComment(java.lang.String comment) + +
          +          Comment to apply to the project created in SourceSafe.
          + voidsetQuiet(boolean quiet) + +
          +          Enable quiet mode.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSCREATE

          +
          +public MSVSSCREATE()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          Comment to apply to the project created in SourceSafe. +

          +

          +
          Parameters:
          comment - The comment to apply in SourceSafe
          +
          +
          +
          + +

          +setQuiet

          +
          +public final void setQuiet(boolean quiet)
          +
          +
          Enable quiet mode. Defaults to false. +

          +

          +
          Parameters:
          quiet - The boolean value for quiet.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSConstants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSConstants.html new file mode 100644 index 000000000..4b6ce4dd4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSConstants.html @@ -0,0 +1,1148 @@ + + + + + + +MSVSSConstants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Interface MSVSSConstants

          +
          +
          All Known Implementing Classes:
          MSVSS, MSVSSADD, MSVSSCHECKIN, MSVSSCHECKOUT, MSVSSCP, MSVSSCREATE, MSVSSGET, MSVSSHISTORY, MSVSSLABEL
          +
          +
          +
          +
          public interface MSVSSConstants
          + + +

          +Holds all the constants for the VSS tasks. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMMAND_ADD + +
          +          The 'Add' command
          +static java.lang.StringCOMMAND_CHECKIN + +
          +          The 'Checkin' command
          +static java.lang.StringCOMMAND_CHECKOUT + +
          +          The 'Checkout' command
          +static java.lang.StringCOMMAND_CP + +
          +          The 'CP' command
          +static java.lang.StringCOMMAND_CREATE + +
          +          The 'Create' command
          +static java.lang.StringCOMMAND_GET + +
          +          The 'Get' command
          +static java.lang.StringCOMMAND_HISTORY + +
          +          The 'History' command
          +static java.lang.StringCOMMAND_LABEL + +
          +          The 'Label' command
          +static java.lang.StringFLAG_AUTORESPONSE_DEF + +
          +          -I- flag
          +static java.lang.StringFLAG_AUTORESPONSE_NO + +
          +          -I-N flag
          +static java.lang.StringFLAG_AUTORESPONSE_YES + +
          +          -I-Y flag
          +static java.lang.StringFLAG_BRIEF + +
          +          -B flag
          +static java.lang.StringFLAG_CODEDIFF + +
          +          -D flag
          +static java.lang.StringFLAG_COMMENT + +
          +          -C flag
          +static java.lang.StringFLAG_FILETIME_DEF + +
          +          -GTC flag
          +static java.lang.StringFLAG_FILETIME_MODIFIED + +
          +          -GTM flag
          +static java.lang.StringFLAG_FILETIME_UPDATED + +
          +          -GTU flag
          +static java.lang.StringFLAG_LABEL + +
          +          -L flag
          +static java.lang.StringFLAG_LOGIN + +
          +          -Y flag
          +static java.lang.StringFLAG_NO_FILE + +
          +          -F- flag
          +static java.lang.StringFLAG_NO_GET + +
          +          -G- flag
          +static java.lang.StringFLAG_OUTPUT + +
          +          -O flag
          +static java.lang.StringFLAG_OVERRIDE_WORKING_DIR + +
          +          -GL flag
          +static java.lang.StringFLAG_QUIET + +
          +          -O- flag
          +static java.lang.StringFLAG_RECURSION + +
          +          -R flag
          +static java.lang.StringFLAG_REPLACE_WRITABLE + +
          +          -GWR flag
          +static java.lang.StringFLAG_SKIP_WRITABLE + +
          +          -GWS flag
          +static java.lang.StringFLAG_USER + +
          +          -U flag
          +static java.lang.StringFLAG_VERSION + +
          +          -V flag
          +static java.lang.StringFLAG_VERSION_DATE + +
          +          -Vd flag
          +static java.lang.StringFLAG_VERSION_LABEL + +
          +          -VL flag
          +static java.lang.StringFLAG_WRITABLE + +
          +          -W flag
          +static java.lang.StringPROJECT_PREFIX + +
          +          Dollar Sigh to prefix the project path
          +static java.lang.StringSS_EXE + +
          +          Constant for the thing to execute
          +static java.lang.StringSTYLE_BRIEF + +
          +          The brief style flag
          +static java.lang.StringSTYLE_CODEDIFF + +
          +          The codediff style flag
          +static java.lang.StringSTYLE_DEFAULT + +
          +          The default style flag
          +static java.lang.StringSTYLE_NOFILE + +
          +          The nofile style flag
          +static java.lang.StringTIME_CURRENT + +
          +          The text for current (default) timestamp
          +static java.lang.StringTIME_MODIFIED + +
          +          The text for modified timestamp
          +static java.lang.StringTIME_UPDATED + +
          +          The text for updated timestamp
          +static java.lang.StringVALUE_FROMDATE + +
          +          ~d flag
          +static java.lang.StringVALUE_FROMLABEL + +
          +          ~L flag
          +static java.lang.StringVALUE_NO + +
          +          -N flag
          +static java.lang.StringVALUE_YES + +
          +          -Y flag
          +static java.lang.StringWRITABLE_FAIL + +
          +          The text for failing on writable files
          +static java.lang.StringWRITABLE_REPLACE + +
          +          The text for replacing writable files
          +static java.lang.StringWRITABLE_SKIP + +
          +          The text for skiping writable files
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +SS_EXE

          +
          +static final java.lang.String SS_EXE
          +
          +
          Constant for the thing to execute +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PROJECT_PREFIX

          +
          +static final java.lang.String PROJECT_PREFIX
          +
          +
          Dollar Sigh to prefix the project path +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CP

          +
          +static final java.lang.String COMMAND_CP
          +
          +
          The 'CP' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_ADD

          +
          +static final java.lang.String COMMAND_ADD
          +
          +
          The 'Add' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_GET

          +
          +static final java.lang.String COMMAND_GET
          +
          +
          The 'Get' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKOUT

          +
          +static final java.lang.String COMMAND_CHECKOUT
          +
          +
          The 'Checkout' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CHECKIN

          +
          +static final java.lang.String COMMAND_CHECKIN
          +
          +
          The 'Checkin' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_LABEL

          +
          +static final java.lang.String COMMAND_LABEL
          +
          +
          The 'Label' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_HISTORY

          +
          +static final java.lang.String COMMAND_HISTORY
          +
          +
          The 'History' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMMAND_CREATE

          +
          +static final java.lang.String COMMAND_CREATE
          +
          +
          The 'Create' command +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STYLE_BRIEF

          +
          +static final java.lang.String STYLE_BRIEF
          +
          +
          The brief style flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STYLE_CODEDIFF

          +
          +static final java.lang.String STYLE_CODEDIFF
          +
          +
          The codediff style flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STYLE_NOFILE

          +
          +static final java.lang.String STYLE_NOFILE
          +
          +
          The nofile style flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STYLE_DEFAULT

          +
          +static final java.lang.String STYLE_DEFAULT
          +
          +
          The default style flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TIME_CURRENT

          +
          +static final java.lang.String TIME_CURRENT
          +
          +
          The text for current (default) timestamp +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TIME_MODIFIED

          +
          +static final java.lang.String TIME_MODIFIED
          +
          +
          The text for modified timestamp +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TIME_UPDATED

          +
          +static final java.lang.String TIME_UPDATED
          +
          +
          The text for updated timestamp +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WRITABLE_REPLACE

          +
          +static final java.lang.String WRITABLE_REPLACE
          +
          +
          The text for replacing writable files +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WRITABLE_SKIP

          +
          +static final java.lang.String WRITABLE_SKIP
          +
          +
          The text for skiping writable files +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WRITABLE_FAIL

          +
          +static final java.lang.String WRITABLE_FAIL
          +
          +
          The text for failing on writable files +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_LOGIN

          +
          +static final java.lang.String FLAG_LOGIN
          +
          +
          -Y flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_OVERRIDE_WORKING_DIR

          +
          +static final java.lang.String FLAG_OVERRIDE_WORKING_DIR
          +
          +
          -GL flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_AUTORESPONSE_DEF

          +
          +static final java.lang.String FLAG_AUTORESPONSE_DEF
          +
          +
          -I- flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_AUTORESPONSE_YES

          +
          +static final java.lang.String FLAG_AUTORESPONSE_YES
          +
          +
          -I-Y flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_AUTORESPONSE_NO

          +
          +static final java.lang.String FLAG_AUTORESPONSE_NO
          +
          +
          -I-N flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_RECURSION

          +
          +static final java.lang.String FLAG_RECURSION
          +
          +
          -R flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VERSION

          +
          +static final java.lang.String FLAG_VERSION
          +
          +
          -V flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VERSION_DATE

          +
          +static final java.lang.String FLAG_VERSION_DATE
          +
          +
          -Vd flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_VERSION_LABEL

          +
          +static final java.lang.String FLAG_VERSION_LABEL
          +
          +
          -VL flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_WRITABLE

          +
          +static final java.lang.String FLAG_WRITABLE
          +
          +
          -W flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VALUE_NO

          +
          +static final java.lang.String VALUE_NO
          +
          +
          -N flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VALUE_YES

          +
          +static final java.lang.String VALUE_YES
          +
          +
          -Y flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_QUIET

          +
          +static final java.lang.String FLAG_QUIET
          +
          +
          -O- flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_COMMENT

          +
          +static final java.lang.String FLAG_COMMENT
          +
          +
          -C flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_LABEL

          +
          +static final java.lang.String FLAG_LABEL
          +
          +
          -L flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VALUE_FROMDATE

          +
          +static final java.lang.String VALUE_FROMDATE
          +
          +
          ~d flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VALUE_FROMLABEL

          +
          +static final java.lang.String VALUE_FROMLABEL
          +
          +
          ~L flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_OUTPUT

          +
          +static final java.lang.String FLAG_OUTPUT
          +
          +
          -O flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_USER

          +
          +static final java.lang.String FLAG_USER
          +
          +
          -U flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_NO_FILE

          +
          +static final java.lang.String FLAG_NO_FILE
          +
          +
          -F- flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_BRIEF

          +
          +static final java.lang.String FLAG_BRIEF
          +
          +
          -B flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_CODEDIFF

          +
          +static final java.lang.String FLAG_CODEDIFF
          +
          +
          -D flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_FILETIME_DEF

          +
          +static final java.lang.String FLAG_FILETIME_DEF
          +
          +
          -GTC flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_FILETIME_MODIFIED

          +
          +static final java.lang.String FLAG_FILETIME_MODIFIED
          +
          +
          -GTM flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_FILETIME_UPDATED

          +
          +static final java.lang.String FLAG_FILETIME_UPDATED
          +
          +
          -GTU flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_REPLACE_WRITABLE

          +
          +static final java.lang.String FLAG_REPLACE_WRITABLE
          +
          +
          -GWR flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_SKIP_WRITABLE

          +
          +static final java.lang.String FLAG_SKIP_WRITABLE
          +
          +
          -GWS flag +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FLAG_NO_GET

          +
          +static final java.lang.String FLAG_NO_GET
          +
          +
          -G- flag +

          +

          +
          See Also:
          Constant Field Values
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.html new file mode 100644 index 000000000..3b7826f53 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSGET.html @@ -0,0 +1,534 @@ + + + + + + +MSVSSGET (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSGET

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSGET
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSGET
          extends MSVSS
          + + +

          +Perform Get commands from Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSGET() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetDate(java.lang.String date) + +
          +          Date to get.
          + voidsetFileTimeStamp(MSVSS.CurrentModUpdated timestamp) + +
          +          Date and time stamp given to the local copy.
          + voidsetLabel(java.lang.String label) + +
          +          Label to get.
          + voidsetLocalpath(Path localPath) + +
          +          Override the project working directory.
          + voidsetQuiet(boolean quiet) + +
          +          Enable quiet mode.
          + voidsetRecursive(boolean recursive) + +
          +          Get files recursively.
          + voidsetVersion(java.lang.String version) + +
          +          Version to get.
          + voidsetWritable(boolean writable) + +
          +          Unset the READ-ONLY flag on files retrieved from VSS.
          + voidsetWritableFiles(MSVSS.WritableFiles files) + +
          +          Action taken when local files are writable.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSGET

          +
          +public MSVSSGET()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLocalpath

          +
          +public void setLocalpath(Path localPath)
          +
          +
          Override the project working directory. +

          +

          +
          Parameters:
          localPath - The path on disk.
          +
          +
          +
          + +

          +setRecursive

          +
          +public final void setRecursive(boolean recursive)
          +
          +
          Get files recursively. Defaults to false. +

          +

          +
          Parameters:
          recursive - The boolean value for recursive.
          +
          +
          +
          + +

          +setQuiet

          +
          +public final void setQuiet(boolean quiet)
          +
          +
          Enable quiet mode. Defaults to false. +

          +

          +
          Parameters:
          quiet - The boolean value for quiet.
          +
          +
          +
          + +

          +setWritable

          +
          +public final void setWritable(boolean writable)
          +
          +
          Unset the READ-ONLY flag on files retrieved from VSS. Defaults to false. +

          +

          +
          Parameters:
          writable - The boolean value for writable.
          +
          +
          +
          + +

          +setVersion

          +
          +public void setVersion(java.lang.String version)
          +
          +
          Version to get. +

          +

          +
          Parameters:
          version - The version to get.
          +
          +
          +
          + +

          +setDate

          +
          +public void setDate(java.lang.String date)
          +
          +
          Date to get. +

          +

          +
          Parameters:
          date - The date to get.
          +
          +
          +
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
          +
          +
          Label to get. +

          +

          +
          Parameters:
          label - The label to get.
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          +
          + +

          +setFileTimeStamp

          +
          +public void setFileTimeStamp(MSVSS.CurrentModUpdated timestamp)
          +
          +
          Date and time stamp given to the local copy. Defaults to current. +

          +

          +
          Parameters:
          timestamp - The file time stamping behaviour.
          +
          +
          +
          + +

          +setWritableFiles

          +
          +public void setWritableFiles(MSVSS.WritableFiles files)
          +
          +
          Action taken when local files are writable. Defaults to fail. +

          + Due to ss.exe returning with an exit code of '100' for both errors and when + a file has been skipped, failonerror is set to false when using + the skip option. +

          +

          +
          Parameters:
          files - The action to take.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.BriefCodediffNofile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.BriefCodediffNofile.html new file mode 100644 index 000000000..8685bfc1e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.BriefCodediffNofile.html @@ -0,0 +1,288 @@ + + + + + + +MSVSSHISTORY.BriefCodediffNofile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSHISTORY.BriefCodediffNofile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY.BriefCodediffNofile
+
          +
          +
          Enclosing class:
          MSVSSHISTORY
          +
          +
          +
          +
          public static class MSVSSHISTORY.BriefCodediffNofile
          extends EnumeratedAttribute
          + + +

          +Extention of EnumeratedAttribute to hold the values for style. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSHISTORY.BriefCodediffNofile() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Gets the list of allowable values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSHISTORY.BriefCodediffNofile

          +
          +public MSVSSHISTORY.BriefCodediffNofile()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Gets the list of allowable values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          The values.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.html new file mode 100644 index 000000000..65f77aca5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSHISTORY.html @@ -0,0 +1,548 @@ + + + + + + +MSVSSHISTORY (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSHISTORY

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSHISTORY
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSHISTORY
          extends MSVSS
          + + +

          +Performs History commands to Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classMSVSSHISTORY.BriefCodediffNofile + +
          +          Extention of EnumeratedAttribute to hold the values for style.
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSHISTORY() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetDateFormat(java.lang.String dateFormat) + +
          +          Format of dates in fromDatetoDate.
          + voidsetFromDate(java.lang.String fromDate) + +
          +          Date representing the 'start' of the range.
          + voidsetFromLabel(java.lang.String fromLabel) + +
          +          Label representing the 'start' of the range.
          + voidsetNumdays(int numd) + +
          +          Number of days for comparison.
          + voidsetOutput(java.io.File outfile) + +
          +          Output file name for the history.
          + voidsetRecursive(boolean recursive) + +
          +          Retrieve history recursively.
          + voidsetStyle(MSVSSHISTORY.BriefCodediffNofile attr) + +
          +          Output style.
          + voidsetToDate(java.lang.String toDate) + +
          +          Date representing the 'end' of the range.
          + voidsetToLabel(java.lang.String toLabel) + +
          +          Label representing the 'end' of the range.
          + voidsetUser(java.lang.String user) + +
          +          Name of the user whose change history is generated.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSHISTORY

          +
          +public MSVSSHISTORY()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRecursive

          +
          +public void setRecursive(boolean recursive)
          +
          +
          Retrieve history recursively. Defaults to false. +

          +

          +
          Parameters:
          recursive - The boolean value for recursive.
          +
          +
          +
          + +

          +setUser

          +
          +public void setUser(java.lang.String user)
          +
          +
          Name of the user whose change history is generated. +

          +

          +
          Parameters:
          user - The username.
          +
          +
          +
          + +

          +setFromDate

          +
          +public void setFromDate(java.lang.String fromDate)
          +
          +
          Date representing the 'start' of the range. +

          +

          +
          Parameters:
          fromDate - The start date.
          +
          +
          +
          + +

          +setToDate

          +
          +public void setToDate(java.lang.String toDate)
          +
          +
          Date representing the 'end' of the range. +

          +

          +
          Parameters:
          toDate - The end date.
          +
          +
          +
          + +

          +setFromLabel

          +
          +public void setFromLabel(java.lang.String fromLabel)
          +
          +
          Label representing the 'start' of the range. +

          +

          +
          Parameters:
          fromLabel - The start label.
          +
          +
          +
          + +

          +setToLabel

          +
          +public void setToLabel(java.lang.String toLabel)
          +
          +
          Label representing the 'end' of the range. +

          +

          +
          Parameters:
          toLabel - The end label.
          +
          +
          +
          + +

          +setNumdays

          +
          +public void setNumdays(int numd)
          +
          +
          Number of days for comparison. + Defaults to 2 days. +

          +

          +
          Parameters:
          numd - The number of days.
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.File outfile)
          +
          +
          Output file name for the history. +

          +

          +
          Parameters:
          outfile - The output file name.
          +
          +
          +
          + +

          +setDateFormat

          +
          +public void setDateFormat(java.lang.String dateFormat)
          +
          +
          Format of dates in fromDatetoDate. + Used when calculating dates with the numdays attribute. + This string uses the formatting rules of SimpleDateFormat. + Defaults to DateFormat.SHORT. +

          +

          +
          Parameters:
          dateFormat - The date format.
          +
          +
          +
          + +

          +setStyle

          +
          +public void setStyle(MSVSSHISTORY.BriefCodediffNofile attr)
          +
          +
          Output style. Valid options are: +
            +
          • brief: -B Display a brief history. +
          • codediff: -D Display line-by-line file changes. +
          • nofile: -F- Do not display individual file updates in the project history. +
          • default: No option specified. Display in Source Safe's default format. +
          +

          +

          +
          Parameters:
          attr - The history style:
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.html new file mode 100644 index 000000000..3d043f69b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/MSVSSLABEL.html @@ -0,0 +1,404 @@ + + + + + + +MSVSSLABEL (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.vss +
          +Class MSVSSLABEL

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSS
+              extended by org.apache.tools.ant.taskdefs.optional.vss.MSVSSLABEL
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, MSVSSConstants
          +
          +
          +
          +
          public class MSVSSLABEL
          extends MSVSS
          + + +

          +Performs Label commands to Microsoft Visual SourceSafe. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          MSVSS.CurrentModUpdated, MSVSS.WritableFiles
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.taskdefs.optional.vss.MSVSSConstants
          COMMAND_ADD, COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CP, COMMAND_CREATE, COMMAND_GET, COMMAND_HISTORY, COMMAND_LABEL, FLAG_AUTORESPONSE_DEF, FLAG_AUTORESPONSE_NO, FLAG_AUTORESPONSE_YES, FLAG_BRIEF, FLAG_CODEDIFF, FLAG_COMMENT, FLAG_FILETIME_DEF, FLAG_FILETIME_MODIFIED, FLAG_FILETIME_UPDATED, FLAG_LABEL, FLAG_LOGIN, FLAG_NO_FILE, FLAG_NO_GET, FLAG_OUTPUT, FLAG_OVERRIDE_WORKING_DIR, FLAG_QUIET, FLAG_RECURSION, FLAG_REPLACE_WRITABLE, FLAG_SKIP_WRITABLE, FLAG_USER, FLAG_VERSION, FLAG_VERSION_DATE, FLAG_VERSION_LABEL, FLAG_WRITABLE, PROJECT_PREFIX, SS_EXE, STYLE_BRIEF, STYLE_CODEDIFF, STYLE_DEFAULT, STYLE_NOFILE, TIME_CURRENT, TIME_MODIFIED, TIME_UPDATED, VALUE_FROMDATE, VALUE_FROMLABEL, VALUE_NO, VALUE_YES, WRITABLE_FAIL, WRITABLE_REPLACE, WRITABLE_SKIP
          +  + + + + + + + + + + +
          +Constructor Summary
          MSVSSLABEL() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetAutoresponse(java.lang.String response) + +
          +          Autoresponce behaviour.
          + voidsetComment(java.lang.String comment) + +
          +          Comment to apply to files labeled in SourceSafe.
          + voidsetLabel(java.lang.String label) + +
          +          Label to apply in SourceSafe.
          + voidsetVersion(java.lang.String version) + +
          +          Version to label.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.optional.vss.MSVSS
          execute, getAutoresponse, getComment, getFileTimeStamp, getGetLocalCopy, getLabel, getLocalpath, getLogin, getOutput, getQuiet, getRecursive, getSSCommand, getStyle, getUser, getVersion, getVersionDate, getVersionDateLabel, getVersionLabel, getVsspath, getWritable, getWritableFiles, setFailOnError, setInternalAutoResponse, setInternalComment, setInternalDate, setInternalDateFormat, setInternalFailOnError, setInternalFileTimeStamp, setInternalFromDate, setInternalFromLabel, setInternalGetLocalCopy, setInternalLabel, setInternalLocalPath, setInternalNumDays, setInternalOutputFilename, setInternalQuiet, setInternalRecursive, setInternalStyle, setInternalToDate, setInternalToLabel, setInternalUser, setInternalVersion, setInternalWritable, setInternalWritableFiles, setLogin, setServerpath, setSsdir, setVsspath
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MSVSSLABEL

          +
          +public MSVSSLABEL()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLabel

          +
          +public void setLabel(java.lang.String label)
          +
          +
          Label to apply in SourceSafe. +

          +

          +
          Parameters:
          label - The label to apply.
          +
          +
          +
          + +

          +setVersion

          +
          +public void setVersion(java.lang.String version)
          +
          +
          Version to label. +

          +

          +
          Parameters:
          version - The version to label.
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          Comment to apply to files labeled in SourceSafe. +

          +

          +
          Parameters:
          comment - The comment to apply in SourceSafe
          +
          +
          +
          + +

          +setAutoresponse

          +
          +public void setAutoresponse(java.lang.String response)
          +
          +
          Autoresponce behaviour. Valid options are Y and N. +

          +

          +
          Parameters:
          response - The auto response value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-frame.html new file mode 100644 index 000000000..5a4e612d9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-frame.html @@ -0,0 +1,65 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.vss (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.vss + + + + +
          +Interfaces  + +
          +MSVSSConstants
          + + + + + + +
          +Classes  + +
          +MSVSS +
          +MSVSS.CurrentModUpdated +
          +MSVSS.WritableFiles +
          +MSVSSADD +
          +MSVSSCHECKIN +
          +MSVSSCHECKOUT +
          +MSVSSCP +
          +MSVSSCREATE +
          +MSVSSGET +
          +MSVSSHISTORY +
          +MSVSSHISTORY.BriefCodediffNofile +
          +MSVSSLABEL
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-summary.html new file mode 100644 index 000000000..15f899a85 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-summary.html @@ -0,0 +1,210 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.vss (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.vss +

          + + + + + + + + + +
          +Interface Summary
          MSVSSConstantsHolds all the constants for the VSS tasks.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          MSVSSA base class for creating tasks for executing commands on Visual SourceSafe.
          MSVSS.CurrentModUpdatedExtention of EnumeratedAttribute to hold the values for file time stamp.
          MSVSS.WritableFilesExtention of EnumeratedAttribute to hold the values for writable filess.
          MSVSSADDPerforms Add commands to Microsoft Visual SourceSafe.
          MSVSSCHECKINPerforms CheckIn commands to Microsoft Visual SourceSafe.
          MSVSSCHECKOUTPerforms CheckOut commands to Microsoft Visual SourceSafe.
          MSVSSCPPerforms CP (Change Project) commands to Microsoft Visual SourceSafe.
          MSVSSCREATECreates a new project in Microsoft Visual SourceSafe.
          MSVSSGETPerform Get commands from Microsoft Visual SourceSafe.
          MSVSSHISTORYPerforms History commands to Microsoft Visual SourceSafe.
          MSVSSHISTORY.BriefCodediffNofileExtention of EnumeratedAttribute to hold the values for style.
          MSVSSLABELPerforms Label commands to Microsoft Visual SourceSafe.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-tree.html new file mode 100644 index 000000000..53366b405 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/vss/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.vss Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.vss +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/Attrib.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/Attrib.html new file mode 100644 index 000000000..c385708fd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/Attrib.html @@ -0,0 +1,648 @@ + + + + + + +Attrib (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.optional.windows +
          +Class Attrib

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.Task
+          extended by org.apache.tools.ant.taskdefs.ExecTask
+              extended by org.apache.tools.ant.taskdefs.ExecuteOn
+                  extended by org.apache.tools.ant.taskdefs.optional.windows.Attrib
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Attrib
          extends ExecuteOn
          + + +

          +Attrib equivalent for Win32 environments. + Note: Attrib parameters /S and /D are not handled. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          ExecuteOn.FileDirBoth
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          destDir, filesets, mapper, mapperElement, srcFilePos, srcIsFirst, targetFilePos, type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.ExecTask
          cmdl, failOnError, newEnvironment, redirector, redirectorElement
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.Task
          target, taskName, taskType, wrapper
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Attrib() + +
          +          Constructor for Attrib.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcheckConfiguration() + +
          +          Check the attributes.
          +protected  booleanisValidOs() + +
          +          Check if the os is valid.
          + voidsetAddsourcefile(boolean b) + +
          +          Add source file.
          + voidsetArchive(boolean value) + +
          +          Set the Archive file attribute.
          + voidsetCommand(java.lang.String e) + +
          +          Set the executable.
          + voidsetExecutable(java.lang.String e) + +
          +          Set the executable.
          + voidsetFile(java.io.File src) + +
          +          A file to be attribed.
          + voidsetHidden(boolean value) + +
          +          Set the Hidden file attribute.
          + voidsetMaxParallel(int max) + +
          +          Set max parallel.
          + voidsetParallel(boolean parallel) + +
          +          Set parallel.
          + voidsetReadonly(boolean value) + +
          +          Set the ReadOnly file attribute.
          + voidsetSkipEmptyFilesets(boolean skip) + +
          +          Set skip empty file sets.
          + voidsetSystem(boolean value) + +
          +          Set the System file attribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecuteOn
          add, add, addDirset, addFilelist, addFileset, createHandler, createMapper, createSrcfile, createTargetfile, getCommandline, getCommandline, getDirs, getFiles, getFilesAndDirs, runExec, runParallel, setDest, setForce, setForwardslash, setIgnoremissing, setRelative, setType, setupRedirector, setVerbose
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.ExecTask
          addConfiguredRedirector, addEnv, createArg, createWatchdog, execute, getOs, getOsFamily, getResolveExecutable, logFlush, maybeSetResultPropertyValue, prepareExec, resolveExecutable, runExecute, setAppend, setCommand, setDir, setError, setErrorProperty, setFailIfExecutionFails, setFailonerror, setInput, setInputString, setLogError, setNewenvironment, setOs, setOsFamily, setOutput, setOutputproperty, setResolveExecutable, setResultProperty, setSearchPath, setSpawn, setTimeout, setTimeout, setVMLauncher
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.Task
          bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Attrib

          +
          +public Attrib()
          +
          +
          Constructor for Attrib. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public void setFile(java.io.File src)
          +
          +
          A file to be attribed. +

          +

          +
          Parameters:
          src - a file
          +
          +
          +
          + +

          +setReadonly

          +
          +public void setReadonly(boolean value)
          +
          +
          Set the ReadOnly file attribute. +

          +

          +
          Parameters:
          value - a boolean value
          +
          +
          +
          + +

          +setArchive

          +
          +public void setArchive(boolean value)
          +
          +
          Set the Archive file attribute. +

          +

          +
          Parameters:
          value - a boolean value
          +
          +
          +
          + +

          +setSystem

          +
          +public void setSystem(boolean value)
          +
          +
          Set the System file attribute. +

          +

          +
          Parameters:
          value - a boolean value
          +
          +
          +
          + +

          +setHidden

          +
          +public void setHidden(boolean value)
          +
          +
          Set the Hidden file attribute. +

          +

          +
          Parameters:
          value - a boolean value
          +
          +
          +
          + +

          +checkConfiguration

          +
          +protected void checkConfiguration()
          +
          +
          Check the attributes. +

          +

          +
          Overrides:
          checkConfiguration in class ExecuteOn
          +
          +
          +
          +
          +
          +
          + +

          +setExecutable

          +
          +public void setExecutable(java.lang.String e)
          +
          +
          Set the executable. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Overrides:
          setExecutable in class ExecTask
          +
          +
          +
          Parameters:
          e - ignored
          +
          +
          +
          + +

          +setCommand

          +
          +public void setCommand(java.lang.String e)
          +
          +
          Set the executable. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Parameters:
          e - ignored
          +
          +
          +
          + +

          +setAddsourcefile

          +
          +public void setAddsourcefile(boolean b)
          +
          +
          Add source file. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Overrides:
          setAddsourcefile in class ExecuteOn
          +
          +
          +
          Parameters:
          b - ignored
          +
          +
          +
          + +

          +setSkipEmptyFilesets

          +
          +public void setSkipEmptyFilesets(boolean skip)
          +
          +
          Set skip empty file sets. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Overrides:
          setSkipEmptyFilesets in class ExecuteOn
          +
          +
          +
          Parameters:
          skip - ignored
          +
          +
          +
          + +

          +setParallel

          +
          +public void setParallel(boolean parallel)
          +
          +
          Set parallel. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Overrides:
          setParallel in class ExecuteOn
          +
          +
          +
          Parameters:
          parallel - ignored
          +
          +
          +
          + +

          +setMaxParallel

          +
          +public void setMaxParallel(int max)
          +
          +
          Set max parallel. + This is not allowed, and it always throws a BuildException. +

          +

          +
          Overrides:
          setMaxParallel in class ExecuteOn
          +
          +
          +
          Parameters:
          max - ignored
          +
          +
          +
          + +

          +isValidOs

          +
          +protected boolean isValidOs()
          +
          +
          Check if the os is valid. + Defauls is to allow windows +

          +

          +
          Overrides:
          isValidOs in class ExecTask
          +
          +
          + +
          Returns:
          true if the os is valid.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-frame.html new file mode 100644 index 000000000..2fd5c7b4a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.windows (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.optional.windows + + + + +
          +Classes  + +
          +Attrib
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-summary.html new file mode 100644 index 000000000..fce71a7fa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-summary.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.windows (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.optional.windows +

          + + + + + + + + + +
          +Class Summary
          AttribAttrib equivalent for Win32 environments.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-tree.html new file mode 100644 index 000000000..ea4c4dc6c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/optional/windows/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.taskdefs.optional.windows Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.optional.windows +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.Task
                  +
                • org.apache.tools.ant.taskdefs.ExecTask
                    +
                  • org.apache.tools.ant.taskdefs.ExecuteOn
                      +
                    • org.apache.tools.ant.taskdefs.optional.windows.Attrib
                    +
                  +
                +
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-frame.html new file mode 100644 index 000000000..f179a2ca6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-frame.html @@ -0,0 +1,440 @@ + + + + + + +org.apache.tools.ant.taskdefs (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs + + + + +
          +Interfaces  + +
          +AntStructure.StructurePrinter +
          +ExecuteStreamHandler +
          +Get.DownloadProgress +
          +Touch.DateFormatFactory +
          +XSLTLiaison +
          +XSLTLiaison2 +
          +XSLTLiaison3 +
          +XSLTLogger +
          +XSLTLoggerAware
          + + + + + + +
          +Classes  + +
          +AbstractCvsTask +
          +AbstractCvsTask.Module +
          +AbstractJarSignerTask +
          +Ant +
          +Ant.Reference +
          +Ant.TargetElement +
          +Antlib +
          +AntlibDefinition +
          +AntStructure +
          +Apt +
          +Apt.Option +
          +AugmentReference +
          +Available +
          +Available.FileDir +
          +Basename +
          +BindTargets +
          +BuildNumber +
          +BUnzip2 +
          +BZip2 +
          +CallTarget +
          +Checksum +
          +Checksum.FormatElement +
          +Chmod +
          +Classloader +
          +CloseResources +
          +Componentdef +
          +Concat +
          +Concat.TextElement +
          +ConditionTask +
          +Copy +
          +Copydir +
          +Copyfile +
          +CopyPath +
          +Cvs +
          +CVSPass +
          +DefaultExcludes +
          +DefBase +
          +Definer +
          +Definer.Format +
          +Definer.OnError +
          +Delete +
          +Deltree +
          +DependSet +
          +DiagnosticsTask +
          +Dirname +
          +Ear +
          +Echo +
          +Echo.EchoLevel +
          +EchoXML +
          +EchoXML.NamespacePolicy +
          +Exec +
          +ExecTask +
          +Execute +
          +ExecuteJava +
          +ExecuteOn +
          +ExecuteOn.FileDirBoth +
          +ExecuteWatchdog +
          +Exit +
          +Expand +
          +Filter +
          +FixCRLF +
          +FixCRLF.AddAsisRemove +
          +FixCRLF.CrLf +
          +GenerateKey +
          +GenerateKey.DistinguishedName +
          +GenerateKey.DnameParam +
          +Get +
          +Get.Base64Converter +
          +Get.NullProgress +
          +Get.VerboseProgress +
          +GUnzip +
          +GZip +
          +HostInfo +
          +ImportTask +
          +Input +
          +Input.HandlerType +
          +Jar +
          +Jar.FilesetManifestConfig +
          +Jar.StrictMode +
          +Java +
          +Javac +
          +Javadoc +
          +Javadoc.AccessType +
          +Javadoc.ExtensionInfo +
          +Javadoc.Html +
          +Javadoc.PackageName +
          +Javadoc.SourceFile +
          +JDBCTask +
          +Jikes +
          +JikesOutputParser +
          +KeySubst +
          +Length +
          +Length.FileMode +
          +Length.When +
          +LoadFile +
          +LoadProperties +
          +LoadResource +
          +Local +
          +LogOutputStream +
          +LogStreamHandler +
          +MacroDef +
          +MacroDef.Attribute +
          +MacroDef.NestedSequential +
          +MacroDef.TemplateElement +
          +MacroDef.Text +
          +MacroInstance +
          +MacroInstance.Element +
          +MakeUrl +
          +Manifest +
          +Manifest.Attribute +
          +Manifest.Section +
          +ManifestClassPath +
          +ManifestTask +
          +ManifestTask.Mode +
          +MatchingTask +
          +Mkdir +
          +Move +
          +Nice +
          +Pack +
          +Parallel +
          +Parallel.TaskList +
          +Patch +
          +PathConvert +
          +PathConvert.TargetOs +
          +PreSetDef +
          +PreSetDef.PreSetDefinition +
          +ProjectHelperTask +
          +Property +
          +PropertyHelperTask +
          +PumpStreamHandler +
          +PumpStreamHandler.ThreadWithPumper +
          +Recorder +
          +Recorder.ActionChoices +
          +Recorder.VerbosityLevelChoices +
          +RecorderEntry +
          +Redirector +
          +Rename +
          +Replace +
          +ResourceCount +
          +Retry +
          +Rmic +
          +SendEmail +
          +Sequential +
          +SignJar +
          +Sleep +
          +SQLExec +
          +SQLExec.DelimiterType +
          +SQLExec.OnError +
          +StreamPumper +
          +SubAnt +
          +Sync +
          +Sync.MyCopy +
          +Sync.SyncTarget +
          +Tar +
          +Tar.TarCompressionMethod +
          +Tar.TarFileSet +
          +Tar.TarLongFileMode +
          +Taskdef +
          +TaskOutputStream +
          +TempFile +
          +Touch +
          +Transform +
          +Truncate +
          +Tstamp +
          +Tstamp.Unit +
          +Typedef +
          +Unpack +
          +Untar +
          +Untar.UntarCompressionMethod +
          +UpToDate +
          +VerifyJar +
          +WaitFor +
          +WaitFor.Unit +
          +War +
          +WhichResource +
          +XmlProperty +
          +XSLTProcess +
          +XSLTProcess.Factory +
          +XSLTProcess.Factory.Attribute +
          +XSLTProcess.OutputProperty +
          +XSLTProcess.Param +
          +Zip +
          +Zip.ArchiveState +
          +Zip.Duplicate +
          +Zip.UnicodeExtraField +
          +Zip.WhenEmpty
          + + + + + + +
          +Exceptions  + +
          +ManifestException
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-summary.html new file mode 100644 index 000000000..2a6ad056c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-summary.html @@ -0,0 +1,1021 @@ + + + + + + +org.apache.tools.ant.taskdefs (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Interface Summary
          AntStructure.StructurePrinterWrites the actual structure information.
          ExecuteStreamHandlerUsed by Execute to handle input and output stream of + subprocesses.
          Get.DownloadProgressInterface implemented for reporting + progess of downloading.
          Touch.DateFormatFactory 
          XSLTLiaisonProxy interface for XSLT processors.
          XSLTLiaison2Extended Proxy interface for XSLT processors.
          XSLTLiaison3Extends Proxy interface for XSLT processors.
          XSLTLoggerInterface to log messages for XSLT
          XSLTLoggerAwareInterface for a class that one can set an XSLTLogger on.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractCvsTaskoriginal Cvs.java 1.20 + + NOTE: This implementation has been moved here from Cvs.java with + the addition of some accessors for extensibility.
          AbstractCvsTask.Module 
          AbstractJarSignerTaskThis is factored out from SignJar; a base class that can be used + for both signing and verifying JAR files using jarsigner
          AntBuild a sub-project.
          Ant.ReferenceHelper class that implements the nested <reference> + element of <ant> and <antcall>.
          Ant.TargetElementHelper class that implements the nested <target> + element of <ant> and <antcall>.
          AntlibAntlib task.
          AntlibDefinitionBase class for tasks that that can be used in antlibs.
          AntStructureCreates a partial DTD for Ant from the currently known tasks.
          AptApt Task for running the Annotation processing tool for JDK 1.5.
          Apt.OptionThe nested option element.
          AugmentReferenceAnt task to dynamically augment a previously declared reference.
          AvailableWill set the given property if the requested resource is available at + runtime.
          Available.FileDirEnumeratedAttribute covering the file types to be checked for, either + file or dir.
          BasenameSets a property to the base name of a specified file, optionally minus a + suffix.
          BindTargetsSimple task which bind some targets to some defined extension point
          BuildNumberRead, increment, and write a build number in a file + It will first + attempt to read a build number from a file, then set the property + "build.number" to the value that was read in (or 0 if no such value).
          BUnzip2Expands a file that has been compressed with the BZIP2 + algorithm.
          BZip2Compresses a file with the BZIP2 algorithm.
          CallTargetCall another target in the same project.
          ChecksumUsed to create or verify file checksums.
          Checksum.FormatElementHelper class for the format attribute.
          ChmodChmod equivalent for unix-like environments.
          ClassloaderEXPERIMENTAL + Create or modifies ClassLoader.
          CloseResourcesNot a real task but used during tests.
          ComponentdefAdds a compenent definition to the current project.
          ConcatThis class contains the 'concat' task, used to concatenate a series + of files into a single stream.
          Concat.TextElementsub element points to a file or contains text
          ConditionTaskTask to set a property conditionally using <uptodate>, <available>, + and many other supported conditions.
          CopyCopies a file or directory to a new file + or directory.
          CopydirDeprecated. The copydir task is deprecated since Ant 1.2.
          CopyfileDeprecated. The copyfile task is deprecated since Ant 1.2.
          CopyPathDeprecated. this task should have never been released and was + obsoleted by ResourceCollection support in Copy available since Ant + 1.7.0.
          CvsPerforms operations on a CVS repository.
          CVSPassAdds an new entry to a CVS password file.
          DefaultExcludesAlters the default excludes for the entire build..
          DefBaseBase class for Definitions handling uri and class loading.
          DefinerBase class for Taskdef and Typedef - handles all + the attributes for Typedef.
          Definer.FormatEnumerated type for format attribute
          Definer.OnErrorEnumerated type for onError attribute
          DeleteDeletes a file or directory, or set of files defined by a fileset.
          DeltreeDeprecated. The deltree task is deprecated since Ant 1.2.
          DependSetExamines and removes out of date target files.
          DiagnosticsTaskThis is a task that hands off work to the Diagnostics module.
          DirnameDetermines the directory name of the specified file.
          EarCreates a EAR archive.
          EchoWrites a message to the Ant logging facilities.
          Echo.EchoLevelThe enumerated values for the level attribute.
          EchoXMLEcho XML.
          EchoXML.NamespacePolicy 
          ExecDeprecated. since 1.2.
          ExecTaskExecutes a given command if the os platform is appropriate.
          ExecuteRuns an external program.
          ExecuteJavaExecute a Java class.
          ExecuteOnExecutes a given command, supplying a set of files as arguments.
          ExecuteOn.FileDirBothEnumerated attribute with the values "file", "dir" and "both" + for the type attribute.
          ExecuteWatchdogDestroys a process running for too long.
          ExitExits the active build, giving an additional message + if available.
          ExpandUnzip a file.
          FilterSets a token filter that is used by the file copy tasks + to do token substitution.
          FixCRLFConverts text source files to local OS formatting conventions, as + well as repair text files damaged by misconfigured or misguided editors or + file transfer programs.
          FixCRLF.AddAsisRemoveEnumerated attribute with the values "asis", "add" and "remove".
          FixCRLF.CrLfEnumerated attribute with the values "asis", "cr", "lf" and "crlf".
          GenerateKeyGenerates a key in a keystore.
          GenerateKey.DistinguishedNameA class corresponding to the dname nested element.
          GenerateKey.DnameParamA DistinguishedName parameter.
          GetGets a particular file from a URL source.
          Get.Base64ConverterProvide this for Backward Compatibility.
          Get.NullProgressdo nothing with progress info
          Get.VerboseProgressverbose progress system prints to some output stream
          GUnzipExpands a file that has been compressed with the GZIP + algorithm.
          GZipCompresses a file with the GZIP algorithm.
          HostInfoSets properties to the host provided, or localhost if no information is + provided.
          ImportTaskTask to import another build file into the current project.
          InputReads an input line from the console.
          Input.HandlerTypeEnumeratedAttribute representing the built-in input handler types: + "default", "propertyfile", "greedy", "secure" (since Ant 1.8).
          JarCreates a JAR archive.
          Jar.FilesetManifestConfigThe manifest config enumerated type.
          Jar.StrictModeThe strict enumerated type.
          JavaLauncher for Java applications.
          JavacCompiles Java source files.
          JavadocGenerates Javadoc documentation for a collection + of source code.
          Javadoc.AccessTypeEnumeratedAttribute implementation supporting the Javadoc scoping + values.
          Javadoc.ExtensionInfoA project aware class used for Javadoc extensions which take a name + and a path such as doclet and taglet arguments.
          Javadoc.HtmlAn HTML element in the Javadoc.
          Javadoc.PackageNameUsed to track info about the packages to be javadoc'd
          Javadoc.SourceFileThis class is used to manage the source files to be processed.
          JDBCTaskHandles JDBC configuration needed by SQL type tasks.
          JikesDeprecated. since 1.2.
          JikesOutputParserDeprecated. since 1.2.
          KeySubstDeprecated. KeySubst is deprecated since Ant 1.1.
          LengthGets lengths: of files/resources, byte size; of strings, length (optionally trimmed).
          Length.FileModeEnumeratedAttribute operation mode
          Length.WhenEnumeratedAttribute for the when attribute.
          LoadFileLoad a file into a property
          LoadPropertiesLoad a file's contents as Ant properties.
          LoadResourceLoad a resource into a property
          LocalTask to create a local property in the current scope.
          LogOutputStreamLogs each line written to this stream to the log system of ant.
          LogStreamHandlerLogs standard output and error of a subprocess to the log system of ant.
          MacroDefDescribe class MacroDef here.
          MacroDef.AttributeAn attribute for the MacroDef task.
          MacroDef.NestedSequentialThe class corresponding to the sequential nested element.
          MacroDef.TemplateElementA nested element for the MacroDef task.
          MacroDef.TextA nested text element for the MacroDef task.
          MacroInstanceThe class to be placed in the ant type definition.
          MacroInstance.ElementEmbedded element in macro instance
          MakeUrlThis task takes file and turns them into a URL, which it then assigns + to a property.
          ManifestHolds the data of a jar manifest.
          Manifest.AttributeAn attribute for the manifest.
          Manifest.SectionA manifest section - you can nest attribute elements into sections.
          ManifestClassPathConverts a Path into a property suitable as a Manifest classpath.
          ManifestTaskCreates a manifest file for inclusion in a JAR, Ant task wrapper + around Manifest.
          ManifestTask.ModeHelper class for Manifest's mode attribute.
          MatchingTaskThis is an abstract task that should be used by all those tasks that + require to include or exclude files based on pattern matching.
          MkdirCreates a given directory.
          MoveMoves a file or directory to a new file or directory.
          NiceA task to provide "nice-ness" to the current thread, and/or to + query the current value.
          PackAbstract Base class for pack tasks.
          ParallelExecutes the contained tasks in separate threads, continuing + once all are completed.
          Parallel.TaskListClass which holds a list of tasks to execute
          PatchPatches a file by applying a 'diff' file to it; requires "patch" to be + on the execution path.
          PathConvertConverts path and classpath information to a specific target OS + format.
          PathConvert.TargetOsAn enumeration of supported targets: + "windows", "unix", "netware", and "os/2".
          PreSetDefThe preset definition task generates a new definition + based on a current definition with some attributes or + elements preset.
          PreSetDef.PreSetDefinitionThis class contains the unknown element and the object + that is predefined.
          ProjectHelperTaskTask to install project helper into Ant's runtime
          PropertySets a property by name, or set of properties (from file or + resource) in the project.
          PropertyHelperTaskThis task is designed to allow the user to install a different + PropertyHelper on the current Project.
          PumpStreamHandlerCopies standard output and error of subprocesses to standard output and + error of the parent process.
          PumpStreamHandler.ThreadWithPumperSpecialized subclass that allows access to the running StreamPumper.
          RecorderAdds a listener to the current build process that records the + output to a file.
          Recorder.ActionChoicesA list of possible values for the setAction() method.
          Recorder.VerbosityLevelChoicesA list of possible values for the setLoglevel() method.
          RecorderEntryThis is a class that represents a recorder.
          RedirectorThe Redirector class manages the setup and connection of input and output + redirection for an Ant project component.
          RenameDeprecated. The rename task is deprecated since Ant 1.2.
          ReplaceReplaces all occurrences of one or more string tokens with given + values in the indicated files.
          ResourceCountCount resources from a ResourceCollection, storing to a property or + writing to the log.
          RetryRetries the nested task a set number of times
          RmicRuns the rmic compiler against classes.
          SendEmailA task to send SMTP email.
          SequentialSequential is a container task - it can contain other Ant tasks.
          SignJarSigns JAR or ZIP files with the javasign command line tool.
          SleepSleep, or pause, for a period of time.
          SQLExecExecutes a series of SQL statements on a database using JDBC.
          SQLExec.DelimiterTypedelimiters we support, "normal" and "row"
          SQLExec.OnErrorThe action a task should perform on an error, + one of "continue", "stop" and "abort"
          StreamPumperCopies all data from an input stream to an output stream.
          SubAntCalls a given target for all defined sub-builds.
          SyncSynchronize a local target directory from the files defined + in one or more filesets.
          Sync.MyCopySubclass Copy in order to access it's file/dir maps.
          Sync.SyncTargetInner class used to hold exclude patterns and selectors to save + stuff that happens to live in the target directory but should + not get removed.
          TarCreates a tar archive.
          Tar.TarCompressionMethodValid Modes for Compression attribute to Tar Task
          Tar.TarFileSetThis is a FileSet with the option to specify permissions + and other attributes.
          Tar.TarLongFileModeSet of options for long file handling in the task.
          TaskdefAdds a task definition to the current project, such that this new task can be + used in the current project.
          TaskOutputStreamDeprecated. since 1.2.x.
          TempFileThis task sets a property to the name of a temporary file.
          TouchTouch a file and/or fileset(s) and/or filelist(s); + corresponds to the Unix touch command.
          TransformHas been merged into ExecuteOn, empty class for backwards compatibility.
          TruncateSet the length of one or more files, as the intermittently available + truncate Unix utility/function.
          TstampSets properties to the current time, or offsets from the current time.
          Tstamp.Unitset of valid units to use for time offsets.
          TypedefAdds a data type definition to the current project.
          UnpackAbstract Base class for unpack tasks.
          UntarUntar a file.
          Untar.UntarCompressionMethodValid Modes for Compression attribute to Untar Task
          UpToDateSets the given property if the specified target has a timestamp + greater than all of the source files.
          VerifyJarJAR verification task.
          WaitForWait for an external event to occur.
          WaitFor.UnitThe enumeration of units: + millisecond, second, minute, hour, day, week
          WarAn extension of <jar> to create a WAR archive.
          WhichResourceFind a class or resource on the supplied classpath, or the + system classpath if none is supplied.
          XmlPropertyLoads property values from a valid XML file, generating the + property names from the file's element and attribute names.
          XSLTProcessProcesses a set of XML documents via XSLT.
          XSLTProcess.FactoryThe factory element to configure a transformer factory
          XSLTProcess.Factory.AttributeA JAXP factory attribute.
          XSLTProcess.OutputPropertySpecify how the result tree should be output as specified + in the + specification.
          XSLTProcess.ParamThe Param inner class used to store XSL parameters
          ZipCreate a Zip file.
          Zip.ArchiveStateHolds the up-to-date status and the out-of-date resources of + the original archive.
          Zip.DuplicatePossible behaviors when a duplicate file is added: + "add", "preserve" or "fail"
          Zip.UnicodeExtraFieldPoliciy for creation of Unicode extra fields: never, always or + not-encodeable.
          Zip.WhenEmptyPossible behaviors when there are no matching files for the task: + "fail", "skip", or "create".
          +  + +

          + + + + + + + + + +
          +Exception Summary
          ManifestExceptionException thrown indicating problems in a JAR Manifest
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-tree.html new file mode 100644 index 000000000..fbe12ef89 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/package-tree.html @@ -0,0 +1,280 @@ + + + + + + +org.apache.tools.ant.taskdefs Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.html new file mode 100644 index 000000000..16f9127c0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/DefaultRmicAdapter.html @@ -0,0 +1,826 @@ + + + + + + +DefaultRmicAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class DefaultRmicAdapter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          Direct Known Subclasses:
          ForkingSunRmic, KaffeRmic, SunRmic, WLRmic
          +
          +
          +
          +
          public abstract class DefaultRmicAdapter
          extends java.lang.Object
          implements RmicAdapter
          + + +

          +This is the default implementation for the RmicAdapter interface. + Currently, this is a cut-and-paste of the original rmic task and + DefaultCopmpilerAdapter. +

          + +

          +

          +
          Since:
          +
          Ant 1.4
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringRMI_SKEL_SUFFIX + +
          +          suffix denoting a skel file: "_Skel"
          +static java.lang.StringRMI_STUB_SUFFIX + +
          +          suffix denoting a stub file: "_Stub"
          +static java.lang.StringRMI_TIE_SUFFIX + +
          +          suffix denoting a tie file: "_Tie"
          +static java.lang.StringSTUB_1_1 + +
          +          arg for 1.1: "-v1.1"
          +static java.lang.StringSTUB_1_2 + +
          +          arg for 1.2: "-v1.2"
          +static java.lang.StringSTUB_COMPAT + +
          +          arg for compat: "-vcompat"
          +static java.lang.StringSTUB_OPTION_1_1 + +
          +          option for stub 1.1 in the rmic task: "1.1"
          +static java.lang.StringSTUB_OPTION_1_2 + +
          +          option for stub 1.2 in the rmic task: "1.2"
          +static java.lang.StringSTUB_OPTION_COMPAT + +
          +          option for stub compat in the rmic task: "compat"
          +  + + + + + + + + + + +
          +Constructor Summary
          DefaultRmicAdapter() + +
          +          Default constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringaddStubVersionOptions() + +
          +          This is an override point; get the stub version off the rmic command and + translate that into a compiler-specific argument
          +protected  java.lang.String[]filterJvmCompilerArgs(java.lang.String[] compilerArgs) + +
          +          Strip out all -J args from the command list.
          + PathgetClasspath() + +
          +          Gets the CLASSPATH this rmic process will use.
          +protected  PathgetCompileClasspath() + +
          +          Builds the compilation classpath.
          + FileNameMappergetMapper() + +
          +          This implementation returns a mapper that may return up to two + file names.
          + RmicgetRmic() + +
          +          Get the Rmic attributes
          +protected  java.lang.StringgetSkelClassSuffix() + +
          +          Gets the skeleton class suffix
          +protected  java.lang.StringgetStubClassSuffix() + +
          +          Gets the stub class suffix
          +protected  java.lang.StringgetTieClassSuffix() + +
          +          Gets the tie class suffix
          +protected  voidlogAndAddFilesToCompile(Commandline cmd) + +
          +          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList"
          +protected  java.lang.String[]preprocessCompilerArgs(java.lang.String[] compilerArgs) + +
          +          Preprocess the compiler arguments in any way you see fit.
          + voidsetRmic(Rmic attributes) + +
          +          Sets Rmic attributes
          +protected  CommandlinesetupRmicCommand() + +
          +          Setup rmic argument for rmic.
          +protected  CommandlinesetupRmicCommand(java.lang.String[] options) + +
          +          Setup rmic argument for rmic.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.taskdefs.rmic.RmicAdapter
          execute
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +RMI_STUB_SUFFIX

          +
          +public static final java.lang.String RMI_STUB_SUFFIX
          +
          +
          suffix denoting a stub file: "_Stub" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RMI_SKEL_SUFFIX

          +
          +public static final java.lang.String RMI_SKEL_SUFFIX
          +
          +
          suffix denoting a skel file: "_Skel" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RMI_TIE_SUFFIX

          +
          +public static final java.lang.String RMI_TIE_SUFFIX
          +
          +
          suffix denoting a tie file: "_Tie" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_COMPAT

          +
          +public static final java.lang.String STUB_COMPAT
          +
          +
          arg for compat: "-vcompat" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_1_1

          +
          +public static final java.lang.String STUB_1_1
          +
          +
          arg for 1.1: "-v1.1" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_1_2

          +
          +public static final java.lang.String STUB_1_2
          +
          +
          arg for 1.2: "-v1.2" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_OPTION_1_1

          +
          +public static final java.lang.String STUB_OPTION_1_1
          +
          +
          option for stub 1.1 in the rmic task: "1.1" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_OPTION_1_2

          +
          +public static final java.lang.String STUB_OPTION_1_2
          +
          +
          option for stub 1.2 in the rmic task: "1.2" +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STUB_OPTION_COMPAT

          +
          +public static final java.lang.String STUB_OPTION_COMPAT
          +
          +
          option for stub compat in the rmic task: "compat" +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DefaultRmicAdapter

          +
          +public DefaultRmicAdapter()
          +
          +
          Default constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setRmic

          +
          +public void setRmic(Rmic attributes)
          +
          +
          Sets Rmic attributes +

          +

          +
          Specified by:
          setRmic in interface RmicAdapter
          +
          +
          +
          Parameters:
          attributes - the rmic attributes
          +
          +
          +
          + +

          +getRmic

          +
          +public Rmic getRmic()
          +
          +
          Get the Rmic attributes +

          +

          +
          +
          +
          + +
          Returns:
          the attributes as a Rmic taskdef
          +
          +
          +
          + +

          +getStubClassSuffix

          +
          +protected java.lang.String getStubClassSuffix()
          +
          +
          Gets the stub class suffix +

          +

          +
          +
          +
          + +
          Returns:
          the stub suffix "_Stub"
          +
          +
          +
          + +

          +getSkelClassSuffix

          +
          +protected java.lang.String getSkelClassSuffix()
          +
          +
          Gets the skeleton class suffix +

          +

          +
          +
          +
          + +
          Returns:
          the skeleton suffix "_Skel"
          +
          +
          +
          + +

          +getTieClassSuffix

          +
          +protected java.lang.String getTieClassSuffix()
          +
          +
          Gets the tie class suffix +

          +

          +
          +
          +
          + +
          Returns:
          the tie suffix "_Tie"
          +
          +
          +
          + +

          +getMapper

          +
          +public FileNameMapper getMapper()
          +
          +
          This implementation returns a mapper that may return up to two + file names. + +
            +
          • for JRMP it will return *_getStubClassSuffix (and + *_getSkelClassSuffix if JDK 1.1 is used)
            • + +
          • for IDL it will return a random name, causing <rmic> to + always recompile.
            • + +
          • for IIOP it will return _*_getStubClassSuffix for + interfaces and _*_getStubClassSuffix for non-interfaces (and + determine the interface and create _*_Stub from that).
            • +
          +

          +

          +
          Specified by:
          getMapper in interface RmicAdapter
          +
          +
          + +
          Returns:
          a FileNameMapper
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          Gets the CLASSPATH this rmic process will use. +

          +

          +
          Specified by:
          getClasspath in interface RmicAdapter
          +
          +
          + +
          Returns:
          the classpath
          +
          +
          +
          + +

          +getCompileClasspath

          +
          +protected Path getCompileClasspath()
          +
          +
          Builds the compilation classpath. +

          +

          +
          +
          +
          + +
          Returns:
          the classpath
          +
          +
          +
          + +

          +setupRmicCommand

          +
          +protected Commandline setupRmicCommand()
          +
          +
          Setup rmic argument for rmic. +

          +

          +
          +
          +
          + +
          Returns:
          the command line
          +
          +
          +
          + +

          +setupRmicCommand

          +
          +protected Commandline setupRmicCommand(java.lang.String[] options)
          +
          +
          Setup rmic argument for rmic. +

          +

          +
          +
          +
          +
          Parameters:
          options - additional parameters needed by a specific + implementation. +
          Returns:
          the command line
          +
          +
          +
          + +

          +addStubVersionOptions

          +
          +protected java.lang.String addStubVersionOptions()
          +
          +
          This is an override point; get the stub version off the rmic command and + translate that into a compiler-specific argument +

          +

          +
          +
          +
          + +
          Returns:
          a string to use for the stub version; can be null
          Since:
          +
          Ant1.7.1
          +
          +
          +
          +
          + +

          +preprocessCompilerArgs

          +
          +protected java.lang.String[] preprocessCompilerArgs(java.lang.String[] compilerArgs)
          +
          +
          Preprocess the compiler arguments in any way you see fit. + This is to allow compiler adapters to validate or filter the arguments. + The base implementation returns the original compiler arguments unchanged. +

          +

          +
          +
          +
          +
          Parameters:
          compilerArgs - the original compiler arguments +
          Returns:
          the filtered set.
          +
          +
          +
          + +

          +filterJvmCompilerArgs

          +
          +protected java.lang.String[] filterJvmCompilerArgs(java.lang.String[] compilerArgs)
          +
          +
          Strip out all -J args from the command list. Invoke this from + preprocessCompilerArgs(String[]) if you have a non-forking + compiler. +

          +

          +
          +
          +
          +
          Parameters:
          compilerArgs - the original compiler arguments +
          Returns:
          the filtered set.
          +
          +
          +
          + +

          +logAndAddFilesToCompile

          +
          +protected void logAndAddFilesToCompile(Commandline cmd)
          +
          +
          Logs the compilation parameters, adds the files to compile and logs the + "niceSourceList" +

          +

          +
          +
          +
          +
          Parameters:
          cmd - the commandline args
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/ForkingSunRmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/ForkingSunRmic.html new file mode 100644 index 000000000..38c417d53 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/ForkingSunRmic.html @@ -0,0 +1,351 @@ + + + + + + +ForkingSunRmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class ForkingSunRmic

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+      extended by org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          Direct Known Subclasses:
          XNewRmic
          +
          +
          +
          +
          public class ForkingSunRmic
          extends DefaultRmicAdapter
          + + +

          +This is an extension of the sun rmic compiler, which forks rather than + executes it inline. Why so? Because rmic is dog slow, but if you fork the + compiler you can have multiple copies compiling different bits of your project + at the same time. Which, on a multi-cpu system results in significant speedups. + + Also, Java1.6 behaves oddly with -XNew, so we switch it on here if needed. +

          + +

          +

          +
          Since:
          +
          ant1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMPILER_NAME + +
          +          the name of this adapter for users to select
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT
          +  + + + + + + + + + + +
          +Constructor Summary
          ForkingSunRmic() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexecute() + +
          +          exec by creating a new command
          +protected  java.lang.StringgetExecutableName() + +
          +          Override point.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          addStubVersionOptions, filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getSkelClassSuffix, getStubClassSuffix, getTieClassSuffix, logAndAddFilesToCompile, preprocessCompilerArgs, setRmic, setupRmicCommand, setupRmicCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +COMPILER_NAME

          +
          +public static final java.lang.String COMPILER_NAME
          +
          +
          the name of this adapter for users to select +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ForkingSunRmic

          +
          +public ForkingSunRmic()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public boolean execute()
+                throws BuildException
          +
          +
          exec by creating a new command +

          +

          + +
          Returns:
          true if the command ran successfully +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getExecutableName

          +
          +protected java.lang.String getExecutableName()
          +
          +
          Override point. +

          +

          + +
          Returns:
          the executable name.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.html new file mode 100644 index 000000000..ca0ac9e69 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/KaffeRmic.html @@ -0,0 +1,343 @@ + + + + + + +KaffeRmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class KaffeRmic

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+      extended by org.apache.tools.ant.taskdefs.rmic.KaffeRmic
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          +
          public class KaffeRmic
          extends DefaultRmicAdapter
          + + +

          +The implementation of the rmic for Kaffe +

          + +

          +

          +
          Since:
          +
          Ant 1.4
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMPILER_NAME + +
          +          the name of this adapter for users to select
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT
          +  + + + + + + + + + + +
          +Constructor Summary
          KaffeRmic() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexecute() + +
          +          Call the rmic compiler.
          +static booleanisAvailable() + +
          +          test for kaffe being on the system
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          addStubVersionOptions, filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getSkelClassSuffix, getStubClassSuffix, getTieClassSuffix, logAndAddFilesToCompile, preprocessCompilerArgs, setRmic, setupRmicCommand, setupRmicCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +COMPILER_NAME

          +
          +public static final java.lang.String COMPILER_NAME
          +
          +
          the name of this adapter for users to select +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +KaffeRmic

          +
          +public KaffeRmic()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public boolean execute()
+                throws BuildException
          +
          +
          Call the rmic compiler. +

          +

          + +
          Returns:
          true if has the compilation been successful +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +isAvailable

          +
          +public static boolean isAvailable()
          +
          +
          test for kaffe being on the system +

          +

          + +
          Returns:
          true if kaffe is on the current classpath
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.html new file mode 100644 index 000000000..1947e278d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapter.html @@ -0,0 +1,292 @@ + + + + + + +RmicAdapter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Interface RmicAdapter

          +
          +
          All Known Implementing Classes:
          DefaultRmicAdapter, ForkingSunRmic, KaffeRmic, SunRmic, WLRmic, XNewRmic
          +
          +
          +
          +
          public interface RmicAdapter
          + + +

          +The interface that all rmic adapters must adhere to. + +

          A rmic adapter is an adapter that interprets the rmic's + parameters in preperation to be passed off to the compiler this + adapter represents. As all the necessary values are stored in the + Rmic task itself, the only thing all adapters need is the rmic + task, the execute command and a parameterless constructor (for + reflection).

          +

          + +

          +

          +
          Since:
          +
          Ant 1.4
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexecute() + +
          +          Call the rmic compiler.
          + PathgetClasspath() + +
          +          The CLASSPATH this rmic process will use.
          + FileNameMappergetMapper() + +
          +          Maps source class files to the files generated by this rmic + implementation.
          + voidsetRmic(Rmic attributes) + +
          +          Sets the rmic attributes, which are stored in the Rmic task.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setRmic

          +
          +void setRmic(Rmic attributes)
          +
          +
          Sets the rmic attributes, which are stored in the Rmic task. +

          +

          +
          Parameters:
          attributes - the rmic attributes to use
          +
          +
          +
          + +

          +execute

          +
          +boolean execute()
+                throws BuildException
          +
          +
          Call the rmic compiler. +

          +

          + +
          Returns:
          true if has the compilation been successful +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getMapper

          +
          +FileNameMapper getMapper()
          +
          +
          Maps source class files to the files generated by this rmic + implementation. +

          +

          + +
          Returns:
          the filename mapper used by this implementation
          +
          +
          +
          + +

          +getClasspath

          +
          +Path getClasspath()
          +
          +
          The CLASSPATH this rmic process will use. +

          +

          + +
          Returns:
          the classpaht this rmic process will use
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.html new file mode 100644 index 000000000..fb4f3e9bf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/RmicAdapterFactory.html @@ -0,0 +1,366 @@ + + + + + + +RmicAdapterFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class RmicAdapterFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.RmicAdapterFactory
+
          +
          +
          +
          public final class RmicAdapterFactory
          extends java.lang.Object
          + + +

          +Creates the necessary rmic adapter, given basic criteria. +

          + +

          +

          +
          Since:
          +
          1.4
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_COMPILER + +
          +          If the compiler has this name use a default compiler.
          +static java.lang.StringERROR_NOT_RMIC_ADAPTER + +
          +          The error message to be used when the class is not an rmic adapter.
          +static java.lang.StringERROR_UNKNOWN_COMPILER + +
          +          The error message to be used when the compiler cannot be found.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +static RmicAdaptergetRmic(java.lang.String rmicType, + Task task) + +
          +          Based on the parameter passed in, this method creates the necessary + factory desired.
          +static RmicAdaptergetRmic(java.lang.String rmicType, + Task task, + Path classpath) + +
          +          Based on the parameter passed in, this method creates the necessary + factory desired.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ERROR_UNKNOWN_COMPILER

          +
          +public static final java.lang.String ERROR_UNKNOWN_COMPILER
          +
          +
          The error message to be used when the compiler cannot be found. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR_NOT_RMIC_ADAPTER

          +
          +public static final java.lang.String ERROR_NOT_RMIC_ADAPTER
          +
          +
          The error message to be used when the class is not an rmic adapter. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_COMPILER

          +
          +public static final java.lang.String DEFAULT_COMPILER
          +
          +
          If the compiler has this name use a default compiler. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getRmic

          +
          +public static RmicAdapter getRmic(java.lang.String rmicType,
+                                  Task task)
+                           throws BuildException
          +
          +
          Based on the parameter passed in, this method creates the necessary + factory desired. + +

          The current mapping for rmic names are as follows:

          +
          • sun = SUN's rmic +
          • kaffe = Kaffe's rmic +
          • a fully qualified classname = the name of a rmic + adapter +
          • weblogic = weblogic compiler +
          • forking = Sun's RMIC by forking a new JVM +
          +

          +

          +
          Parameters:
          rmicType - either the name of the desired rmic, or the + full classname of the rmic's adapter.
          task - a task to log through. +
          Returns:
          the compiler adapter +
          Throws: +
          BuildException - if the rmic type could not be resolved into + a rmic adapter.
          +
          +
          +
          + +

          +getRmic

          +
          +public static RmicAdapter getRmic(java.lang.String rmicType,
+                                  Task task,
+                                  Path classpath)
+                           throws BuildException
          +
          +
          Based on the parameter passed in, this method creates the necessary + factory desired. + +

          The current mapping for rmic names are as follows:

          +
          • sun = SUN's rmic +
          • kaffe = Kaffe's rmic +
          • a fully qualified classname = the name of a rmic + adapter +
          • weblogic = weblogic compiler +
          • forking = Sun's RMIC by forking a new JVM +
          +

          +

          +
          Parameters:
          rmicType - either the name of the desired rmic, or the + full classname of the rmic's adapter.
          task - a task to log through.
          classpath - the classpath to use when looking up an + adapter class +
          Returns:
          the compiler adapter +
          Throws: +
          BuildException - if the rmic type could not be resolved into + a rmic adapter.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/SunRmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/SunRmic.html new file mode 100644 index 000000000..a1f372b4a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/SunRmic.html @@ -0,0 +1,426 @@ + + + + + + +SunRmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class SunRmic

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+      extended by org.apache.tools.ant.taskdefs.rmic.SunRmic
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          +
          public class SunRmic
          extends DefaultRmicAdapter
          + + +

          +The implementation of the rmic for SUN's JDK. +

          + +

          +

          +
          Since:
          +
          Ant 1.4
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMPILER_NAME + +
          +          the name of this adapter for users to select
          +static java.lang.StringERROR_NO_RMIC_ON_CLASSPATH + +
          +          Error message to use with the sun rmic is not the classpath.
          +static java.lang.StringERROR_RMIC_FAILED + +
          +          Error message to use when there is an error starting the sun rmic compiler
          +static java.lang.StringRMIC_CLASSNAME + +
          +          name of the class
          +static java.lang.StringRMIC_EXECUTABLE + +
          +          name of the executable
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT
          +  + + + + + + + + + + +
          +Constructor Summary
          SunRmic() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanexecute() + +
          +          Run the rmic compiler.
          +protected  java.lang.String[]preprocessCompilerArgs(java.lang.String[] compilerArgs) + +
          +          Strip out all -J args from the command list.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          addStubVersionOptions, filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getSkelClassSuffix, getStubClassSuffix, getTieClassSuffix, logAndAddFilesToCompile, setRmic, setupRmicCommand, setupRmicCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +RMIC_CLASSNAME

          +
          +public static final java.lang.String RMIC_CLASSNAME
          +
          +
          name of the class +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMPILER_NAME

          +
          +public static final java.lang.String COMPILER_NAME
          +
          +
          the name of this adapter for users to select +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RMIC_EXECUTABLE

          +
          +public static final java.lang.String RMIC_EXECUTABLE
          +
          +
          name of the executable +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR_NO_RMIC_ON_CLASSPATH

          +
          +public static final java.lang.String ERROR_NO_RMIC_ON_CLASSPATH
          +
          +
          Error message to use with the sun rmic is not the classpath. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR_RMIC_FAILED

          +
          +public static final java.lang.String ERROR_RMIC_FAILED
          +
          +
          Error message to use when there is an error starting the sun rmic compiler +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SunRmic

          +
          +public SunRmic()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public boolean execute()
+                throws BuildException
          +
          +
          Run the rmic compiler. +

          +

          + +
          Returns:
          true if the compilation succeeded +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +preprocessCompilerArgs

          +
          +protected java.lang.String[] preprocessCompilerArgs(java.lang.String[] compilerArgs)
          +
          +
          Strip out all -J args from the command list. +

          +

          +
          Overrides:
          preprocessCompilerArgs in class DefaultRmicAdapter
          +
          +
          +
          Parameters:
          compilerArgs - the original compiler arguments +
          Returns:
          the filtered set.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/WLRmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/WLRmic.html new file mode 100644 index 000000000..3e8cac143 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/WLRmic.html @@ -0,0 +1,542 @@ + + + + + + +WLRmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class WLRmic

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+      extended by org.apache.tools.ant.taskdefs.rmic.WLRmic
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          +
          public class WLRmic
          extends DefaultRmicAdapter
          + + +

          +The implementation of the rmic for WebLogic +

          + +

          +

          +
          Since:
          +
          Ant 1.4
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMPILER_NAME + +
          +          the name of this adapter for users to select
          +static java.lang.StringERROR_NO_WLRMIC_ON_CLASSPATH + +
          +          The error string to use if not able to find the weblogic rmic
          +static java.lang.StringERROR_WLRMIC_FAILED + +
          +          The error string to use if not able to start the weblogic rmic
          +static java.lang.StringUNSUPPORTED_STUB_OPTION + +
          +          upsupported error message
          +static java.lang.StringWL_RMI_SKEL_SUFFIX + +
          +          The skeleton suffix
          +static java.lang.StringWL_RMI_STUB_SUFFIX + +
          +          The stub suffix
          +static java.lang.StringWLRMIC_CLASSNAME + +
          +          The classname of the weblogic rmic
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT
          +  + + + + + + + + + + +
          +Constructor Summary
          WLRmic() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringaddStubVersionOptions() + +
          +          This is an override point; no stub version is returned.
          + booleanexecute() + +
          +          Carry out the rmic compilation.
          + java.lang.StringgetSkelClassSuffix() + +
          +          Get the suffix for the rmic skeleton classes
          + java.lang.StringgetStubClassSuffix() + +
          +          Get the suffix for the rmic stub classes
          +protected  java.lang.String[]preprocessCompilerArgs(java.lang.String[] compilerArgs) + +
          +          Strip out all -J args from the command list.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getTieClassSuffix, logAndAddFilesToCompile, setRmic, setupRmicCommand, setupRmicCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +WLRMIC_CLASSNAME

          +
          +public static final java.lang.String WLRMIC_CLASSNAME
          +
          +
          The classname of the weblogic rmic +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COMPILER_NAME

          +
          +public static final java.lang.String COMPILER_NAME
          +
          +
          the name of this adapter for users to select +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR_NO_WLRMIC_ON_CLASSPATH

          +
          +public static final java.lang.String ERROR_NO_WLRMIC_ON_CLASSPATH
          +
          +
          The error string to use if not able to find the weblogic rmic +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ERROR_WLRMIC_FAILED

          +
          +public static final java.lang.String ERROR_WLRMIC_FAILED
          +
          +
          The error string to use if not able to start the weblogic rmic +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WL_RMI_STUB_SUFFIX

          +
          +public static final java.lang.String WL_RMI_STUB_SUFFIX
          +
          +
          The stub suffix +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WL_RMI_SKEL_SUFFIX

          +
          +public static final java.lang.String WL_RMI_SKEL_SUFFIX
          +
          +
          The skeleton suffix +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UNSUPPORTED_STUB_OPTION

          +
          +public static final java.lang.String UNSUPPORTED_STUB_OPTION
          +
          +
          upsupported error message +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +WLRmic

          +
          +public WLRmic()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public boolean execute()
+                throws BuildException
          +
          +
          Carry out the rmic compilation. +

          +

          + +
          Returns:
          true if the compilation succeeded +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getStubClassSuffix

          +
          +public java.lang.String getStubClassSuffix()
          +
          +
          Get the suffix for the rmic stub classes +

          +

          +
          Overrides:
          getStubClassSuffix in class DefaultRmicAdapter
          +
          +
          + +
          Returns:
          the stub suffix
          +
          +
          +
          + +

          +getSkelClassSuffix

          +
          +public java.lang.String getSkelClassSuffix()
          +
          +
          Get the suffix for the rmic skeleton classes +

          +

          +
          Overrides:
          getSkelClassSuffix in class DefaultRmicAdapter
          +
          +
          + +
          Returns:
          the skeleton suffix
          +
          +
          +
          + +

          +preprocessCompilerArgs

          +
          +protected java.lang.String[] preprocessCompilerArgs(java.lang.String[] compilerArgs)
          +
          +
          Strip out all -J args from the command list. +

          +

          +
          Overrides:
          preprocessCompilerArgs in class DefaultRmicAdapter
          +
          +
          +
          Parameters:
          compilerArgs - the original compiler arguments +
          Returns:
          the filtered set.
          +
          +
          +
          + +

          +addStubVersionOptions

          +
          +protected java.lang.String addStubVersionOptions()
          +
          +
          This is an override point; no stub version is returned. If any + stub option is set, a warning is printed. +

          +

          +
          Overrides:
          addStubVersionOptions in class DefaultRmicAdapter
          +
          +
          + +
          Returns:
          null, for no stub version
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/XNewRmic.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/XNewRmic.html new file mode 100644 index 000000000..7ef2fdd3a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/XNewRmic.html @@ -0,0 +1,333 @@ + + + + + + +XNewRmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.taskdefs.rmic +
          +Class XNewRmic

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
+      extended by org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic
+          extended by org.apache.tools.ant.taskdefs.rmic.XNewRmic
+
          +
          +
          All Implemented Interfaces:
          RmicAdapter
          +
          +
          +
          +
          public class XNewRmic
          extends ForkingSunRmic
          + + +

          +Run rmic in a new process with -Xnew set. + This switches rmic to use a new compiler, one that doesnt work in-process + on ant on java1.6. + see: + http://issues.apache.org/bugzilla/show_bug.cgi?id=38732 +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOMPILER_NAME + +
          +          the name of this adapter for users to select
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT
          +  + + + + + + + + + + +
          +Constructor Summary
          XNewRmic() + +
          +          No-arg constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  CommandlinesetupRmicCommand() + +
          +          Create a normal command line, then with -Xnew at the front
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.ForkingSunRmic
          execute, getExecutableName
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
          addStubVersionOptions, filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getSkelClassSuffix, getStubClassSuffix, getTieClassSuffix, logAndAddFilesToCompile, preprocessCompilerArgs, setRmic, setupRmicCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +COMPILER_NAME

          +
          +public static final java.lang.String COMPILER_NAME
          +
          +
          the name of this adapter for users to select +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +XNewRmic

          +
          +public XNewRmic()
          +
          +
          No-arg constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setupRmicCommand

          +
          +protected Commandline setupRmicCommand()
          +
          +
          Create a normal command line, then with -Xnew at the front +

          +

          +
          Overrides:
          setupRmicCommand in class DefaultRmicAdapter
          +
          +
          + +
          Returns:
          a command line that hands off to thw
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-frame.html new file mode 100644 index 000000000..804a12549 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-frame.html @@ -0,0 +1,55 @@ + + + + + + +org.apache.tools.ant.taskdefs.rmic (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.taskdefs.rmic + + + + +
          +Interfaces  + +
          +RmicAdapter
          + + + + + + +
          +Classes  + +
          +DefaultRmicAdapter +
          +ForkingSunRmic +
          +KaffeRmic +
          +RmicAdapterFactory +
          +SunRmic +
          +WLRmic +
          +XNewRmic
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-summary.html new file mode 100644 index 000000000..6ae579606 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-summary.html @@ -0,0 +1,191 @@ + + + + + + +org.apache.tools.ant.taskdefs.rmic (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.taskdefs.rmic +

          + + + + + + + + + +
          +Interface Summary
          RmicAdapterThe interface that all rmic adapters must adhere to.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          DefaultRmicAdapterThis is the default implementation for the RmicAdapter interface.
          ForkingSunRmicThis is an extension of the sun rmic compiler, which forks rather than + executes it inline.
          KaffeRmicThe implementation of the rmic for Kaffe
          RmicAdapterFactoryCreates the necessary rmic adapter, given basic criteria.
          SunRmicThe implementation of the rmic for SUN's JDK.
          WLRmicThe implementation of the rmic for WebLogic
          XNewRmicRun rmic in a new process with -Xnew set.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-tree.html new file mode 100644 index 000000000..e5ad87b04 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/taskdefs/rmic/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.taskdefs.rmic Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.taskdefs.rmic +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AbstractFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AbstractFileSet.html new file mode 100644 index 000000000..e952ed69f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AbstractFileSet.html @@ -0,0 +1,1969 @@ + + + + + + +AbstractFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class AbstractFileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          DirSet, FileSet, Sync.SyncTarget
          +
          +
          +
          +
          public abstract class AbstractFileSet
          extends DataType
          implements java.lang.Cloneable, SelectorContainer
          + + +

          +Class that holds an implicit patternset and supports nested + patternsets and creates a DirectoryScanner using these patterns. + +

          Common base class for DirSet and FileSet.

          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + AbstractFileSet() + +
          +          Construct a new AbstractFileSet.
          +protected AbstractFileSet(AbstractFileSet fileset) + +
          +          Construct a new AbstractFileSet, shallowly cloned + from the specified AbstractFileSet.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileSelector selector) + +
          +          Add an arbitary selector.
          + voidaddAnd(AndSelector selector) + +
          +          Add an "And" selector entry on the selector list.
          + voidaddContains(ContainsSelector selector) + +
          +          Add a contains selector entry on the selector list.
          + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
          +          Add a regular expression selector entry on the selector list.
          + voidaddCustom(ExtendSelector selector) + +
          +          Add an extended selector entry on the selector list.
          + voidaddDate(DateSelector selector) + +
          +          Add a selector date entry on the selector list.
          + voidaddDepend(DependSelector selector) + +
          +          Add a depends selector entry on the selector list.
          + voidaddDepth(DepthSelector selector) + +
          +          Add a depth selector entry on the selector list.
          + voidaddDifferent(DifferentSelector selector) + +
          +          Add a DifferentSelector entry on the selector list.
          + voidaddFilename(FilenameSelector selector) + +
          +          Add a selector filename entry on the selector list.
          + voidaddMajority(MajoritySelector selector) + +
          +          Add a majority selector entry on the selector list.
          + voidaddModified(ModifiedSelector selector) + +
          +          Add the modified selector.
          + voidaddNone(NoneSelector selector) + +
          +          Add a "None" selector entry on the selector list.
          + voidaddNot(NotSelector selector) + +
          +          Add a "Not" selector entry on the selector list.
          + voidaddOr(OrSelector selector) + +
          +          Add an "Or" selector entry on the selector list.
          + voidaddPresent(PresentSelector selector) + +
          +          Add a present selector entry on the selector list.
          + voidaddReadable(ReadableSelector r) + +
          +           
          + voidaddSelector(SelectSelector selector) + +
          +          Add a "Select" selector entry on the selector list.
          + voidaddSize(SizeSelector selector) + +
          +          Add a selector size entry on the selector list.
          + voidaddType(TypeSelector selector) + +
          +          Add a selector type entry on the selector list.
          + voidaddWritable(WritableSelector w) + +
          +           
          + voidappendExcludes(java.lang.String[] excludes) + +
          +          Appends excludes to the current list of include + patterns.
          + voidappendIncludes(java.lang.String[] includes) + +
          +          Appends includes to the current list of include + patterns.
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          + java.lang.Objectclone() + +
          +          Creates a deep clone of this instance, except for the nested + selectors (the list of selectors is a shallow clone of this + instance's list).
          + PatternSet.NameEntrycreateExclude() + +
          +          Add a name entry to the exclude list.
          + PatternSet.NameEntrycreateExcludesFile() + +
          +          Add a name entry to the excludes files list.
          + PatternSet.NameEntrycreateInclude() + +
          +          Add a name entry to the include list.
          + PatternSet.NameEntrycreateIncludesFile() + +
          +          Add a name entry to the include files list.
          + PatternSetcreatePatternSet() + +
          +          Creates a nested patternset.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + booleangetDefaultexcludes() + +
          +          Whether default exclusions should be used or not.
          + java.io.FilegetDir() + +
          +          Retrieves the base-directory for this instance.
          + java.io.FilegetDir(Project p) + +
          +          Retrieves the base-directory for this instance.
          + DirectoryScannergetDirectoryScanner() + +
          +          Returns the directory scanner needed to access the files to process.
          + DirectoryScannergetDirectoryScanner(Project p) + +
          +          Returns the directory scanner needed to access the files to process.
          + booleangetErrorOnMissingDir() + +
          +          Gets whether an error is/shold be thrown if the base directory + does not exist.
          + intgetMaxLevelsOfSymlinks() + +
          +          The maximum number of times a symbolic link may be followed + during a scan.
          +protected  AbstractFileSetgetRef(Project p) + +
          +          Performs the check for circular references and returns the + referenced FileSet.
          + FileSelector[]getSelectors(Project p) + +
          +          Returns the set of selectors as an array.
          + booleanhasPatterns() + +
          +          Indicates whether there are any patterns here.
          + booleanhasSelectors() + +
          +          Indicates whether there are any selectors here.
          + booleanisCaseSensitive() + +
          +          Find out if the fileset is case sensitive.
          + booleanisFollowSymlinks() + +
          +          Find out if the fileset wants to follow symbolic links.
          + java.lang.String[]mergeExcludes(Project p) + +
          +          Get the merged exclude patterns for this AbstractFileSet.
          + java.lang.String[]mergeIncludes(Project p) + +
          +          Get the merged include patterns for this AbstractFileSet.
          + PatternSetmergePatterns(Project p) + +
          +          Get the merged patterns for this AbstractFileSet.
          + intselectorCount() + +
          +          Gives the count of the number of selectors in this container.
          + java.util.EnumerationselectorElements() + +
          +          Returns an enumerator for accessing the set of selectors.
          + voidsetCaseSensitive(boolean caseSensitive) + +
          +          Sets case sensitivity of the file system.
          + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
          +          Sets whether default exclusions should be used or not.
          + voidsetDir(java.io.File dir) + +
          +          Sets the base-directory for this instance.
          + voidsetErrorOnMissingDir(boolean errorOnMissingDir) + +
          +          Sets whether an error is thrown if a directory does not exist.
          + voidsetExcludes(java.lang.String excludes) + +
          +          Appends excludes to the current list of exclude + patterns.
          + voidsetExcludesfile(java.io.File excl) + +
          +          Sets the File containing the excludes patterns.
          + voidsetFile(java.io.File file) + +
          +          Creates a single file fileset.
          + voidsetFollowSymlinks(boolean followSymlinks) + +
          +          Sets whether or not symbolic links should be followed.
          + voidsetIncludes(java.lang.String includes) + +
          +          Appends includes to the current list of include + patterns.
          + voidsetIncludesfile(java.io.File incl) + +
          +          Sets the File containing the includes patterns.
          + voidsetMaxLevelsOfSymlinks(int max) + +
          +          The maximum number of times a symbolic link may be followed + during a scan.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another instance.
          + voidsetupDirectoryScanner(FileScanner ds) + +
          +          Set up the specified directory scanner against this + AbstractFileSet's Project.
          + voidsetupDirectoryScanner(FileScanner ds, + Project p) + +
          +          Set up the specified directory scanner against the specified project.
          + java.lang.StringtoString() + +
          +          Returns included files as a list of semicolon-separated filenames.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractFileSet

          +
          +public AbstractFileSet()
          +
          +
          Construct a new AbstractFileSet. +

          +

          +
          + +

          +AbstractFileSet

          +
          +protected AbstractFileSet(AbstractFileSet fileset)
          +
          +
          Construct a new AbstractFileSet, shallowly cloned + from the specified AbstractFileSet. +

          +

          +
          Parameters:
          fileset - the AbstractFileSet to use as a template.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the Reference to use. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setDir

          +
          +public void setDir(java.io.File dir)
+            throws BuildException
          +
          +
          Sets the base-directory for this instance. +

          +

          +
          +
          +
          +
          Parameters:
          dir - the directory's File instance. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getDir

          +
          +public java.io.File getDir()
          +
          +
          Retrieves the base-directory for this instance. +

          +

          +
          +
          +
          + +
          Returns:
          File.
          +
          +
          +
          + +

          +getDir

          +
          +public java.io.File getDir(Project p)
          +
          +
          Retrieves the base-directory for this instance. +

          +

          +
          +
          +
          +
          Parameters:
          p - the Project against which the + reference is resolved, if set. +
          Returns:
          File.
          +
          +
          +
          + +

          +createPatternSet

          +
          +public PatternSet createPatternSet()
          +
          +
          Creates a nested patternset. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.
          +
          +
          +
          + +

          +createInclude

          +
          +public PatternSet.NameEntry createInclude()
          +
          +
          Add a name entry to the include list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createIncludesFile

          +
          +public PatternSet.NameEntry createIncludesFile()
          +
          +
          Add a name entry to the include files list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createExclude

          +
          +public PatternSet.NameEntry createExclude()
          +
          +
          Add a name entry to the exclude list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createExcludesFile

          +
          +public PatternSet.NameEntry createExcludesFile()
          +
          +
          Add a name entry to the excludes files list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +setFile

          +
          +public void setFile(java.io.File file)
          +
          +
          Creates a single file fileset. +

          +

          +
          +
          +
          +
          Parameters:
          file - the single File included in this + AbstractFileSet.
          +
          +
          +
          + +

          +setIncludes

          +
          +public void setIncludes(java.lang.String includes)
          +
          +
          Appends includes to the current list of include + patterns. + +

          Patterns may be separated by a comma or a space.

          +

          +

          +
          +
          +
          +
          Parameters:
          includes - the String containing the include patterns.
          +
          +
          +
          + +

          +appendIncludes

          +
          +public void appendIncludes(java.lang.String[] includes)
          +
          +
          Appends includes to the current list of include + patterns. +

          +

          +
          +
          +
          +
          Parameters:
          includes - array containing the include patterns.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setExcludes

          +
          +public void setExcludes(java.lang.String excludes)
          +
          +
          Appends excludes to the current list of exclude + patterns. + +

          Patterns may be separated by a comma or a space.

          +

          +

          +
          +
          +
          +
          Parameters:
          excludes - the String containing the exclude patterns.
          +
          +
          +
          + +

          +appendExcludes

          +
          +public void appendExcludes(java.lang.String[] excludes)
          +
          +
          Appends excludes to the current list of include + patterns. +

          +

          +
          +
          +
          +
          Parameters:
          excludes - array containing the exclude patterns.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setIncludesfile

          +
          +public void setIncludesfile(java.io.File incl)
+                     throws BuildException
          +
          +
          Sets the File containing the includes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          incl - File instance. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setExcludesfile

          +
          +public void setExcludesfile(java.io.File excl)
+                     throws BuildException
          +
          +
          Sets the File containing the excludes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          excl - File instance. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setDefaultexcludes

          +
          +public void setDefaultexcludes(boolean useDefaultExcludes)
          +
          +
          Sets whether default exclusions should be used or not. +

          +

          +
          +
          +
          +
          Parameters:
          useDefaultExcludes - boolean.
          +
          +
          +
          + +

          +getDefaultexcludes

          +
          +public boolean getDefaultexcludes()
          +
          +
          Whether default exclusions should be used or not. +

          +

          +
          +
          +
          + +
          Returns:
          the default exclusions value.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean caseSensitive)
          +
          +
          Sets case sensitivity of the file system. +

          +

          +
          +
          +
          +
          Parameters:
          caseSensitive - boolean.
          +
          +
          +
          + +

          +isCaseSensitive

          +
          +public boolean isCaseSensitive()
          +
          +
          Find out if the fileset is case sensitive. +

          +

          +
          +
          +
          + +
          Returns:
          boolean indicating whether the fileset is + case sensitive.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setFollowSymlinks

          +
          +public void setFollowSymlinks(boolean followSymlinks)
          +
          +
          Sets whether or not symbolic links should be followed. +

          +

          +
          +
          +
          +
          Parameters:
          followSymlinks - whether or not symbolic links should be followed.
          +
          +
          +
          + +

          +isFollowSymlinks

          +
          +public boolean isFollowSymlinks()
          +
          +
          Find out if the fileset wants to follow symbolic links. +

          +

          +
          +
          +
          + +
          Returns:
          boolean indicating whether symbolic links + should be followed.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +setMaxLevelsOfSymlinks

          +
          +public void setMaxLevelsOfSymlinks(int max)
          +
          +
          The maximum number of times a symbolic link may be followed + during a scan. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getMaxLevelsOfSymlinks

          +
          +public int getMaxLevelsOfSymlinks()
          +
          +
          The maximum number of times a symbolic link may be followed + during a scan. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setErrorOnMissingDir

          +
          +public void setErrorOnMissingDir(boolean errorOnMissingDir)
          +
          +
          Sets whether an error is thrown if a directory does not exist. +

          +

          +
          +
          +
          +
          Parameters:
          errorOnMissingDir - true if missing directories cause errors, + false if not.
          +
          +
          +
          + +

          +getErrorOnMissingDir

          +
          +public boolean getErrorOnMissingDir()
          +
          +
          Gets whether an error is/shold be thrown if the base directory + does not exist. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +getDirectoryScanner

          +
          +public DirectoryScanner getDirectoryScanner()
          +
          +
          Returns the directory scanner needed to access the files to process. +

          +

          +
          +
          +
          + +
          Returns:
          a DirectoryScanner instance.
          +
          +
          +
          + +

          +getDirectoryScanner

          +
          +public DirectoryScanner getDirectoryScanner(Project p)
          +
          +
          Returns the directory scanner needed to access the files to process. +

          +

          +
          +
          +
          +
          Parameters:
          p - the Project against which the DirectoryScanner should be configured. +
          Returns:
          a DirectoryScanner instance.
          +
          +
          +
          + +

          +setupDirectoryScanner

          +
          +public void setupDirectoryScanner(FileScanner ds)
          +
          +
          Set up the specified directory scanner against this + AbstractFileSet's Project. +

          +

          +
          +
          +
          +
          Parameters:
          ds - a FileScanner instance.
          +
          +
          +
          + +

          +setupDirectoryScanner

          +
          +public void setupDirectoryScanner(FileScanner ds,
+                                  Project p)
          +
          +
          Set up the specified directory scanner against the specified project. +

          +

          +
          +
          +
          +
          Parameters:
          ds - a FileScanner instance.
          p - an Ant Project instance.
          +
          +
          +
          + +

          +getRef

          +
          +protected AbstractFileSet getRef(Project p)
          +
          +
          Performs the check for circular references and returns the + referenced FileSet. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          the referenced FileSet
          +
          +
          +
          + +

          +hasSelectors

          +
          +public boolean hasSelectors()
          +
          +
          Indicates whether there are any selectors here. +

          +

          +
          Specified by:
          hasSelectors in interface SelectorContainer
          +
          +
          + +
          Returns:
          whether any selectors are in this container.
          +
          +
          +
          + +

          +hasPatterns

          +
          +public boolean hasPatterns()
          +
          +
          Indicates whether there are any patterns here. +

          +

          +
          +
          +
          + +
          Returns:
          whether any patterns are in this container.
          +
          +
          +
          + +

          +selectorCount

          +
          +public int selectorCount()
          +
          +
          Gives the count of the number of selectors in this container. +

          +

          +
          Specified by:
          selectorCount in interface SelectorContainer
          +
          +
          + +
          Returns:
          the number of selectors in this container as an int.
          +
          +
          +
          + +

          +getSelectors

          +
          +public FileSelector[] getSelectors(Project p)
          +
          +
          Returns the set of selectors as an array. +

          +

          +
          Specified by:
          getSelectors in interface SelectorContainer
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          a FileSelector[] of the selectors in this container.
          +
          +
          +
          + +

          +selectorElements

          +
          +public java.util.Enumeration selectorElements()
          +
          +
          Returns an enumerator for accessing the set of selectors. +

          +

          +
          Specified by:
          selectorElements in interface SelectorContainer
          +
          +
          + +
          Returns:
          an Enumeration of selectors.
          +
          +
          +
          + +

          +appendSelector

          +
          +public void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Specified by:
          appendSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the new FileSelector to add.
          +
          +
          +
          + +

          +addSelector

          +
          +public void addSelector(SelectSelector selector)
          +
          +
          Add a "Select" selector entry on the selector list. +

          +

          +
          Specified by:
          addSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the SelectSelector to add.
          +
          +
          +
          + +

          +addAnd

          +
          +public void addAnd(AndSelector selector)
          +
          +
          Add an "And" selector entry on the selector list. +

          +

          +
          Specified by:
          addAnd in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the AndSelector to add.
          +
          +
          +
          + +

          +addOr

          +
          +public void addOr(OrSelector selector)
          +
          +
          Add an "Or" selector entry on the selector list. +

          +

          +
          Specified by:
          addOr in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the OrSelector to add.
          +
          +
          +
          + +

          +addNot

          +
          +public void addNot(NotSelector selector)
          +
          +
          Add a "Not" selector entry on the selector list. +

          +

          +
          Specified by:
          addNot in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the NotSelector to add.
          +
          +
          +
          + +

          +addNone

          +
          +public void addNone(NoneSelector selector)
          +
          +
          Add a "None" selector entry on the selector list. +

          +

          +
          Specified by:
          addNone in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the NoneSelector to add.
          +
          +
          +
          + +

          +addMajority

          +
          +public void addMajority(MajoritySelector selector)
          +
          +
          Add a majority selector entry on the selector list. +

          +

          +
          Specified by:
          addMajority in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the MajoritySelector to add.
          +
          +
          +
          + +

          +addDate

          +
          +public void addDate(DateSelector selector)
          +
          +
          Add a selector date entry on the selector list. +

          +

          +
          Specified by:
          addDate in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the DateSelector to add.
          +
          +
          +
          + +

          +addSize

          +
          +public void addSize(SizeSelector selector)
          +
          +
          Add a selector size entry on the selector list. +

          +

          +
          Specified by:
          addSize in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the SizeSelector to add.
          +
          +
          +
          + +

          +addDifferent

          +
          +public void addDifferent(DifferentSelector selector)
          +
          +
          Add a DifferentSelector entry on the selector list. +

          +

          +
          Specified by:
          addDifferent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the DifferentSelector to add.
          +
          +
          +
          + +

          +addFilename

          +
          +public void addFilename(FilenameSelector selector)
          +
          +
          Add a selector filename entry on the selector list. +

          +

          +
          Specified by:
          addFilename in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the FilenameSelector to add.
          +
          +
          +
          + +

          +addType

          +
          +public void addType(TypeSelector selector)
          +
          +
          Add a selector type entry on the selector list. +

          +

          +
          Specified by:
          addType in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the TypeSelector to add.
          +
          +
          +
          + +

          +addCustom

          +
          +public void addCustom(ExtendSelector selector)
          +
          +
          Add an extended selector entry on the selector list. +

          +

          +
          Specified by:
          addCustom in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the ExtendSelector to add.
          +
          +
          +
          + +

          +addContains

          +
          +public void addContains(ContainsSelector selector)
          +
          +
          Add a contains selector entry on the selector list. +

          +

          +
          Specified by:
          addContains in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the ContainsSelector to add.
          +
          +
          +
          + +

          +addPresent

          +
          +public void addPresent(PresentSelector selector)
          +
          +
          Add a present selector entry on the selector list. +

          +

          +
          Specified by:
          addPresent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the PresentSelector to add.
          +
          +
          +
          + +

          +addDepth

          +
          +public void addDepth(DepthSelector selector)
          +
          +
          Add a depth selector entry on the selector list. +

          +

          +
          Specified by:
          addDepth in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the DepthSelector to add.
          +
          +
          +
          + +

          +addDepend

          +
          +public void addDepend(DependSelector selector)
          +
          +
          Add a depends selector entry on the selector list. +

          +

          +
          Specified by:
          addDepend in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the DependSelector to add.
          +
          +
          +
          + +

          +addContainsRegexp

          +
          +public void addContainsRegexp(ContainsRegexpSelector selector)
          +
          +
          Add a regular expression selector entry on the selector list. +

          +

          +
          Specified by:
          addContainsRegexp in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the ContainsRegexpSelector to add.
          +
          +
          +
          + +

          +addModified

          +
          +public void addModified(ModifiedSelector selector)
          +
          +
          Add the modified selector. +

          +

          +
          Specified by:
          addModified in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the ModifiedSelector to add.
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +addReadable

          +
          +public void addReadable(ReadableSelector r)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +addWritable

          +
          +public void addWritable(WritableSelector w)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(FileSelector selector)
          +
          +
          Add an arbitary selector. +

          +

          +
          Specified by:
          add in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the FileSelector to add.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Returns included files as a list of semicolon-separated filenames. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a String of included filenames.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Creates a deep clone of this instance, except for the nested + selectors (the list of selectors is a shallow clone of this + instance's list). +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          the cloned object
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +mergeIncludes

          +
          +public java.lang.String[] mergeIncludes(Project p)
          +
          +
          Get the merged include patterns for this AbstractFileSet. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use. +
          Returns:
          the include patterns of the default pattern set and all + nested patternsets.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +mergeExcludes

          +
          +public java.lang.String[] mergeExcludes(Project p)
          +
          +
          Get the merged exclude patterns for this AbstractFileSet. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use. +
          Returns:
          the exclude patterns of the default pattern set and all + nested patternsets.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +mergePatterns

          +
          +public PatternSet mergePatterns(Project p)
          +
          +
          Get the merged patterns for this AbstractFileSet. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use. +
          Returns:
          the default patternset merged with the additional sets + in a new PatternSet instance.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AntFilterReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AntFilterReader.html new file mode 100644 index 000000000..6aacb871d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/AntFilterReader.html @@ -0,0 +1,558 @@ + + + + + + +AntFilterReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class AntFilterReader

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AntFilterReader
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public final class AntFilterReader
          extends DataType
          implements java.lang.Cloneable
          + + +

          +An AntFilterReader is a wrapper class that encloses the classname + and configuration of a Configurable FilterReader. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AntFilterReader() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddParam(Parameter param) + +
          +          Add a Parameter.
          + PathcreateClasspath() + +
          +          Set the classpath to load the FilterReader through (nested element).
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + java.lang.StringgetClassName() + +
          +          Get the className attribute.
          + PathgetClasspath() + +
          +          Get the classpath.
          + Parameter[]getParams() + +
          +          The parameters for this filter.
          + voidsetClassName(java.lang.String className) + +
          +          Set the className attribute.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to load the FilterReader through (attribute).
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath to load the FilterReader through via + reference (attribute).
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another AntFilterReader + instance.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AntFilterReader

          +
          +public AntFilterReader()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setClassName

          +
          +public void setClassName(java.lang.String className)
          +
          +
          Set the className attribute. +

          +

          +
          +
          +
          +
          Parameters:
          className - a String value
          +
          +
          +
          + +

          +getClassName

          +
          +public java.lang.String getClassName()
          +
          +
          Get the className attribute. +

          +

          +
          +
          +
          + +
          Returns:
          a String value
          +
          +
          +
          + +

          +addParam

          +
          +public void addParam(Parameter param)
          +
          +
          Add a Parameter. +

          +

          +
          +
          +
          +
          Parameters:
          param - a Parameter value
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to load the FilterReader through (attribute). +

          +

          +
          +
          +
          +
          Parameters:
          classpath - a classpath
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Set the classpath to load the FilterReader through (nested element). +

          +

          +
          +
          +
          + +
          Returns:
          a classpath to be configured
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          Get the classpath. +

          +

          +
          +
          +
          + +
          Returns:
          the classpath
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath to load the FilterReader through via + reference (attribute). +

          +

          +
          +
          +
          +
          Parameters:
          r - a reference to a classpath
          +
          +
          +
          + +

          +getParams

          +
          +public Parameter[] getParams()
          +
          +
          The parameters for this filter. +

          +

          +
          +
          +
          + +
          Returns:
          a Parameter[] value
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another AntFilterReader + instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to which this instance is associated +
          Throws: +
          BuildException - if this instance already has been configured.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveFileSet.html new file mode 100644 index 000000000..52fb7582a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveFileSet.html @@ -0,0 +1,1233 @@ + + + + + + +ArchiveFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class ArchiveFileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.ArchiveFileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          TarFileSet, ZipFileSet
          +
          +
          +
          +
          public abstract class ArchiveFileSet
          extends FileSet
          + + +

          +A ArchiveFileSet is a FileSet with extra attributes useful in the + context of archiving tasks. + + It includes a prefix attribute which is prepended to each entry in + the output archive file as well as a fullpath attribute. It also + supports Unix file permissions for files and directories. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static intDEFAULT_DIR_MODE + +
          +          Default value for the dirmode attribute.
          +static intDEFAULT_FILE_MODE + +
          +          Default value for the filemode attribute.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          + ArchiveFileSet() + +
          +          Constructor for ArchiveFileSet
          +protected ArchiveFileSet(ArchiveFileSet fileset) + +
          +          Constructor using a archive fileset arguement.
          +protected ArchiveFileSet(FileSet fileset) + +
          +          Constructor using a fileset arguement.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(ResourceCollection a) + +
          +          Set the source Archive file for the archivefileset.
          + java.lang.Objectclone() + +
          +          Return a ArchiveFileSet that has the same properties + as this one.
          +protected  voidconfigureFileSet(ArchiveFileSet zfs) + +
          +          A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          +protected  java.lang.ObjectgetCheckedRef(Project p) + +
          +          Performs the check for circular references and returns the + referenced object.
          + DirectoryScannergetDirectoryScanner(Project p) + +
          +          Return the DirectoryScanner associated with this FileSet.
          + intgetDirMode() + +
          +          Deprecated. since 1.7.
          + intgetDirMode(Project p) + +
          +          Get the dir mode of the archive fileset
          + intgetFileMode() + +
          +          Deprecated. since 1.7.
          + intgetFileMode(Project p) + +
          +          Get the mode of the archive fileset
          + java.lang.StringgetFullpath() + +
          +          Deprecated. since 1.7.
          + java.lang.StringgetFullpath(Project p) + +
          +          Return the full pathname of the single entry in this fileset.
          + java.lang.StringgetPrefix() + +
          +          Deprecated. since 1.7.
          + java.lang.StringgetPrefix(Project p) + +
          +          Return the prefix prepended to entries in the archive file.
          + java.io.FilegetSrc() + +
          +          Get the archive file from which entries will be extracted.
          + java.io.FilegetSrc(Project p) + +
          +          Get the archive from which entries will be extracted.
          + booleanhasDirModeBeenSet() + +
          +          Whether the user has specified the mode explicitly.
          + booleanhasFileModeBeenSet() + +
          +          Whether the user has specified the mode explicitly.
          + voidintegerSetDirMode(int mode) + +
          +          specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755
          + voidintegerSetFileMode(int mode) + +
          +          specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644
          + booleanisFilesystemOnly() + +
          +          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          +protected abstract  ArchiveScannernewArchiveScanner() + +
          +          Creates a scanner for this type of archive.
          + voidsetDir(java.io.File dir) + +
          +          Set the directory for the fileset.
          + voidsetDirMode(java.lang.String octalString) + +
          +          A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755
          + voidsetErrorOnMissingArchive(boolean errorOnMissingArchive) + +
          +          Sets whether an error is thrown if an archive does not exist.
          + voidsetFileMode(java.lang.String octalString) + +
          +          A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644
          + voidsetFullpath(java.lang.String fullpath) + +
          +          Set the full pathname of the single entry in this fileset.
          + voidsetPrefix(java.lang.String prefix) + +
          +          Prepend this prefix to the path for each archive entry.
          + voidsetSrc(java.io.File srcFile) + +
          +          Set the source Archive file for the archivefileset.
          + voidsetSrcResource(Resource src) + +
          +          Set the source Archive file for the archivefileset.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          For file-based archivefilesets, return the same as for normal filesets; + else just return the path of the zip.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_DIR_MODE

          +
          +public static final int DEFAULT_DIR_MODE
          +
          +
          Default value for the dirmode attribute. +

          +

          +
          Since:
          +
          Ant 1.5.2
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FILE_MODE

          +
          +public static final int DEFAULT_FILE_MODE
          +
          +
          Default value for the filemode attribute. +

          +

          +
          Since:
          +
          Ant 1.5.2
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ArchiveFileSet

          +
          +public ArchiveFileSet()
          +
          +
          Constructor for ArchiveFileSet +

          +

          +
          + +

          +ArchiveFileSet

          +
          +protected ArchiveFileSet(FileSet fileset)
          +
          +
          Constructor using a fileset arguement. +

          +

          +
          Parameters:
          fileset - the fileset to use
          +
          +
          + +

          +ArchiveFileSet

          +
          +protected ArchiveFileSet(ArchiveFileSet fileset)
          +
          +
          Constructor using a archive fileset arguement. +

          +

          +
          Parameters:
          fileset - the archivefileset to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDir

          +
          +public void setDir(java.io.File dir)
+            throws BuildException
          +
          +
          Set the directory for the fileset. +

          +

          +
          Overrides:
          setDir in class AbstractFileSet
          +
          +
          +
          Parameters:
          dir - the directory for the fileset +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(ResourceCollection a)
          +
          +
          Set the source Archive file for the archivefileset. Prevents both + "dir" and "src" from being specified. +

          +

          +
          Parameters:
          a - the archive as a single element Resource collection.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File srcFile)
          +
          +
          Set the source Archive file for the archivefileset. Prevents both + "dir" and "src" from being specified. +

          +

          +
          Parameters:
          srcFile - The archive from which to extract entries.
          +
          +
          +
          + +

          +setSrcResource

          +
          +public void setSrcResource(Resource src)
          +
          +
          Set the source Archive file for the archivefileset. Prevents both + "dir" and "src" from being specified. +

          +

          +
          Parameters:
          src - The archive from which to extract entries.
          +
          +
          +
          + +

          +getSrc

          +
          +public java.io.File getSrc(Project p)
          +
          +
          Get the archive from which entries will be extracted. +

          +

          +
          Parameters:
          p - the project to use +
          Returns:
          the source file
          +
          +
          +
          + +

          +setErrorOnMissingArchive

          +
          +public void setErrorOnMissingArchive(boolean errorOnMissingArchive)
          +
          +
          Sets whether an error is thrown if an archive does not exist. +

          +

          +
          Parameters:
          errorOnMissingArchive - true if missing archives cause errors, + false if not.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getSrc

          +
          +public java.io.File getSrc()
          +
          +
          Get the archive file from which entries will be extracted. +

          +

          + +
          Returns:
          the archive in case the archive is a file, null otherwise.
          +
          +
          +
          + +

          +getCheckedRef

          +
          +protected java.lang.Object getCheckedRef(Project p)
          +
          +
          Performs the check for circular references and returns the + referenced object. + This is an override which does not delegate to the superclass; instead it invokes + AbstractFileSet.getRef(Project), because that conains the special support for fileset + references, which can be handled by all ArchiveFileSets. +

          +

          +
          Overrides:
          getCheckedRef in class DataType
          +
          +
          +
          Parameters:
          p - the Ant Project instance against which to resolve references. +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference is invalid (circular ref, wrong class, etc).
          Since:
          +
          Ant 1.8
          +
          +
          +
          +
          + +

          +setPrefix

          +
          +public void setPrefix(java.lang.String prefix)
          +
          +
          Prepend this prefix to the path for each archive entry. + Prevents both prefix and fullpath from being specified +

          +

          +
          Parameters:
          prefix - The prefix to prepend to entries in the archive file.
          +
          +
          +
          + +

          +getPrefix

          +
          +public java.lang.String getPrefix(Project p)
          +
          +
          Return the prefix prepended to entries in the archive file. +

          +

          +
          Parameters:
          p - the project to use +
          Returns:
          the prefix
          +
          +
          +
          + +

          +setFullpath

          +
          +public void setFullpath(java.lang.String fullpath)
          +
          +
          Set the full pathname of the single entry in this fileset. + Prevents both prefix and fullpath from being specified +

          +

          +
          Parameters:
          fullpath - the full pathname of the single entry in this fileset.
          +
          +
          +
          + +

          +getFullpath

          +
          +public java.lang.String getFullpath(Project p)
          +
          +
          Return the full pathname of the single entry in this fileset. +

          +

          +
          Parameters:
          p - the project to use +
          Returns:
          the full path
          +
          +
          +
          + +

          +newArchiveScanner

          +
          +protected abstract ArchiveScanner newArchiveScanner()
          +
          +
          Creates a scanner for this type of archive. +

          +

          + +
          Returns:
          the scanner.
          +
          +
          +
          + +

          +getDirectoryScanner

          +
          +public DirectoryScanner getDirectoryScanner(Project p)
          +
          +
          Return the DirectoryScanner associated with this FileSet. + If the ArchiveFileSet defines a source Archive file, then an ArchiveScanner + is returned instead. +

          +

          +
          Overrides:
          getDirectoryScanner in class AbstractFileSet
          +
          +
          +
          Parameters:
          p - the project to use +
          Returns:
          a directory scanner
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          Overrides:
          iterator in class FileSet
          +
          +
          + +
          Returns:
          Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          Overrides:
          size in class FileSet
          +
          +
          + +
          Returns:
          size of the collection as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. If true, + all Resources returned from this ResourceCollection should be + instances of FileResource. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          Overrides:
          isFilesystemOnly in class FileSet
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setFileMode

          +
          +public void setFileMode(java.lang.String octalString)
          +
          +
          A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 +

          +

          +
          Parameters:
          octalString - a String value
          +
          +
          +
          + +

          +integerSetFileMode

          +
          +public void integerSetFileMode(int mode)
          +
          +
          specify the user, group and + other modes in the standard Unix fashion; + optional, default=0644 + +

          We use the strange name so this method doesn't appear in + IntrospectionHelpers list of attribute setters.

          +

          +

          +
          Parameters:
          mode - a int value
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getFileMode

          +
          +public int getFileMode(Project p)
          +
          +
          Get the mode of the archive fileset +

          +

          +
          Parameters:
          p - the project to use +
          Returns:
          the mode
          +
          +
          +
          + +

          +hasFileModeBeenSet

          +
          +public boolean hasFileModeBeenSet()
          +
          +
          Whether the user has specified the mode explicitly. +

          +

          + +
          Returns:
          true if it has been set
          +
          +
          +
          + +

          +setDirMode

          +
          +public void setDirMode(java.lang.String octalString)
          +
          +
          A 3 digit octal string, specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755 +

          +

          +
          Parameters:
          octalString - a String value
          +
          +
          +
          + +

          +integerSetDirMode

          +
          +public void integerSetDirMode(int mode)
          +
          +
          specify the user, group and + other modes in the standard Unix fashion; + optional, default=0755 +

          We use the strange name so this method doesn't appear in + IntrospectionHelpers list of attribute setters.

          +

          +

          +
          Parameters:
          mode - a int value
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getDirMode

          +
          +public int getDirMode(Project p)
          +
          +
          Get the dir mode of the archive fileset +

          +

          +
          Parameters:
          p - the project to use +
          Returns:
          the mode
          +
          +
          +
          + +

          +hasDirModeBeenSet

          +
          +public boolean hasDirModeBeenSet()
          +
          +
          Whether the user has specified the mode explicitly. +

          +

          + +
          Returns:
          true if it has been set
          +
          +
          +
          + +

          +configureFileSet

          +
          +protected void configureFileSet(ArchiveFileSet zfs)
          +
          +
          A ArchiveFileset accepts another ArchiveFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +

          +

          +
          Parameters:
          zfs - the project to use
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Return a ArchiveFileSet that has the same properties + as this one. +

          +

          +
          Overrides:
          clone in class FileSet
          +
          +
          + +
          Returns:
          the cloned archiveFileSet
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          For file-based archivefilesets, return the same as for normal filesets; + else just return the path of the zip. +

          +

          +
          Overrides:
          toString in class AbstractFileSet
          +
          +
          + +
          Returns:
          for file based archivefilesets, included files as a list + of semicolon-separated filenames. else just the name of the zip.
          +
          +
          +
          + +

          +getPrefix

          +
          +public java.lang.String getPrefix()
          +
          +
          Deprecated. since 1.7. +

          +

          Return the prefix prepended to entries in the archive file. +

          +

          + +
          Returns:
          the prefix.
          +
          +
          +
          + +

          +getFullpath

          +
          +public java.lang.String getFullpath()
          +
          +
          Deprecated. since 1.7. +

          +

          Return the full pathname of the single entryZ in this fileset. +

          +

          + +
          Returns:
          the full pathname.
          +
          +
          +
          + +

          +getFileMode

          +
          +public int getFileMode()
          +
          +
          Deprecated. since 1.7. +

          +

          + +
          Returns:
          the file mode.
          +
          +
          +
          + +

          +getDirMode

          +
          +public int getDirMode()
          +
          +
          Deprecated. since 1.7. +

          +

          + +
          Returns:
          the dir mode.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class AbstractFileSet
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveScanner.html new file mode 100644 index 000000000..591997e17 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ArchiveScanner.html @@ -0,0 +1,664 @@ + + + + + + +ArchiveScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class ArchiveScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.types.ArchiveScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          Direct Known Subclasses:
          TarScanner, ZipScanner
          +
          +
          +
          +
          public abstract class ArchiveScanner
          extends DirectoryScanner
          + + +

          +ArchiveScanner accesses the pattern matching algorithm in DirectoryScanner, + which are protected methods that can only be accessed by subclassing. + + This implementation of FileScanner defines getIncludedFiles to return + the matching archive entries. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.io.FilesrcFile + +
          +          The archive file which should be scanned.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          ArchiveScanner() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected abstract  voidfillMapsFromArchive(Resource archive, + java.lang.String encoding, + java.util.Map fileEntries, + java.util.Map matchFileEntries, + java.util.Map dirEntries, + java.util.Map matchDirEntries) + +
          +          Fills the file and directory maps with resources read from the archive.
          + java.lang.String[]getIncludedDirectories() + +
          +          Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
          + intgetIncludedDirsCount() + +
          +          Override parent implementation.
          + java.lang.String[]getIncludedFiles() + +
          +          Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
          + intgetIncludedFilesCount() + +
          +          Override parent implementation.
          + ResourcegetResource(java.lang.String name) + +
          +          Get the named Resource.
          + voidinit() + +
          +          Initialize DirectoryScanner data structures.
          + booleanmatch(java.lang.String path) + +
          +          Matches a jar entry against the includes/excludes list, + normalizing the path separator.
          + voidscan() + +
          +          Don't scan when we have no zipfile.
          + voidsetEncoding(java.lang.String encoding) + +
          +          Sets encoding of file names.
          + voidsetErrorOnMissingArchive(boolean errorOnMissingArchive) + +
          +          Sets whether an error is thrown if an archive does not exist.
          + voidsetSrc(java.io.File srcFile) + +
          +          Sets the srcFile for scanning.
          + voidsetSrc(Resource src) + +
          +          Sets the src for scanning.
          +protected static java.lang.StringtrimSeparator(java.lang.String s) + +
          +          Remove trailing slash if present.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +srcFile

          +
          +protected java.io.File srcFile
          +
          +
          The archive file which should be scanned. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ArchiveScanner

          +
          +public ArchiveScanner()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setErrorOnMissingArchive

          +
          +public void setErrorOnMissingArchive(boolean errorOnMissingArchive)
          +
          +
          Sets whether an error is thrown if an archive does not exist. +

          +

          +
          Parameters:
          errorOnMissingArchive - true if missing archives cause errors, + false if not.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +scan

          +
          +public void scan()
          +
          +
          Don't scan when we have no zipfile. +

          +

          +
          Specified by:
          scan in interface FileScanner
          Overrides:
          scan in class DirectoryScanner
          +
          +
          +
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File srcFile)
          +
          +
          Sets the srcFile for scanning. This is the jar or zip file that + is scanned for matching entries. +

          +

          +
          Parameters:
          srcFile - the (non-null) archive file name for scanning
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(Resource src)
          +
          +
          Sets the src for scanning. This is the jar or zip file that + is scanned for matching entries. +

          +

          +
          Parameters:
          src - the (non-null) archive resource
          +
          +
          +
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String encoding)
          +
          +
          Sets encoding of file names. +

          +

          +
          Parameters:
          encoding - the encoding format
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getIncludedFiles

          +
          +public java.lang.String[] getIncludedFiles()
          +
          +
          Returns the names of the files which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

          +

          +
          Specified by:
          getIncludedFiles in interface FileScanner
          Overrides:
          getIncludedFiles in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the files which matched at least one of the + include patterns and none of the exclude patterns.
          +
          +
          +
          + +

          +getIncludedFilesCount

          +
          +public int getIncludedFilesCount()
          +
          +
          Override parent implementation. +

          +

          +
          Overrides:
          getIncludedFilesCount in class DirectoryScanner
          +
          +
          + +
          Returns:
          count of included files.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getIncludedDirectories

          +
          +public java.lang.String[] getIncludedDirectories()
          +
          +
          Returns the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory. +

          +

          +
          Specified by:
          getIncludedDirectories in interface FileScanner
          Overrides:
          getIncludedDirectories in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
          +
          +
          +
          + +

          +getIncludedDirsCount

          +
          +public int getIncludedDirsCount()
          +
          +
          Override parent implementation. +

          +

          +
          Overrides:
          getIncludedDirsCount in class DirectoryScanner
          +
          +
          + +
          Returns:
          count of included directories.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +init

          +
          +public void init()
          +
          +
          Initialize DirectoryScanner data structures. +

          +

          +
          +
          +
          +
          + +

          +match

          +
          +public boolean match(java.lang.String path)
          +
          +
          Matches a jar entry against the includes/excludes list, + normalizing the path separator. +

          +

          +
          Parameters:
          path - the (non-null) path name to test for inclusion +
          Returns:
          true if the path should be included + false otherwise.
          +
          +
          +
          + +

          +getResource

          +
          +public Resource getResource(java.lang.String name)
          +
          +
          Get the named Resource. +

          +

          +
          Specified by:
          getResource in interface ResourceFactory
          Overrides:
          getResource in class DirectoryScanner
          +
          +
          +
          Parameters:
          name - path name of the file sought in the archive +
          Returns:
          the resource
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +fillMapsFromArchive

          +
          +protected abstract void fillMapsFromArchive(Resource archive,
+                                            java.lang.String encoding,
+                                            java.util.Map fileEntries,
+                                            java.util.Map matchFileEntries,
+                                            java.util.Map dirEntries,
+                                            java.util.Map matchDirEntries)
          +
          +
          Fills the file and directory maps with resources read from the archive. +

          +

          +
          Parameters:
          archive - the archive to scan.
          encoding - encoding used to encode file names inside the archive.
          fileEntries - Map (name to resource) of non-directory + resources found inside the archive.
          matchFileEntries - Map (name to resource) of non-directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          dirEntries - Map (name to resource) of directory + resources found inside the archive.
          matchDirEntries - Map (name to resource) of directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          +
          +
          +
          + +

          +trimSeparator

          +
          +protected static final java.lang.String trimSeparator(java.lang.String s)
          +
          +
          Remove trailing slash if present. +

          +

          +
          Parameters:
          s - the file name to trim. +
          Returns:
          the trimed file name.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.BaseAssertion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.BaseAssertion.html new file mode 100644 index 000000000..8d6af502b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.BaseAssertion.html @@ -0,0 +1,370 @@ + + + + + + +Assertions.BaseAssertion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Assertions.BaseAssertion

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Assertions.BaseAssertion
+
          +
          +
          Direct Known Subclasses:
          Assertions.DisabledAssertion, Assertions.EnabledAssertion
          +
          +
          +
          Enclosing class:
          Assertions
          +
          +
          +
          +
          public abstract static class Assertions.BaseAssertion
          extends java.lang.Object
          + + +

          +base class for our assertion elements. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Assertions.BaseAssertion() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringgetClassName() + +
          +          what is the class name?
          +abstract  java.lang.StringgetCommandPrefix() + +
          +          get the prefix used to begin the command; -ea or -da.
          +protected  java.lang.StringgetPackageName() + +
          +          what is the package name?
          + voidsetClass(java.lang.String className) + +
          +          name a class
          + voidsetPackage(java.lang.String packageName) + +
          +          name a package
          + java.lang.StringtoCommand() + +
          +          create a full command string from this class
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Assertions.BaseAssertion

          +
          +public Assertions.BaseAssertion()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setClass

          +
          +public void setClass(java.lang.String className)
          +
          +
          name a class +

          +

          +
          Parameters:
          className - a class name
          +
          +
          +
          + +

          +setPackage

          +
          +public void setPackage(java.lang.String packageName)
          +
          +
          name a package +

          +

          +
          Parameters:
          packageName - a package name
          +
          +
          +
          + +

          +getClassName

          +
          +protected java.lang.String getClassName()
          +
          +
          what is the class name? +

          +

          + +
          Returns:
          classname or null
          See Also:
          setClass(java.lang.String)
          +
          +
          +
          + +

          +getPackageName

          +
          +protected java.lang.String getPackageName()
          +
          +
          what is the package name? +

          +

          + +
          Returns:
          package name or null
          See Also:
          setPackage(java.lang.String)
          +
          +
          +
          + +

          +getCommandPrefix

          +
          +public abstract java.lang.String getCommandPrefix()
          +
          +
          get the prefix used to begin the command; -ea or -da. +

          +

          + +
          Returns:
          prefix
          +
          +
          +
          + +

          +toCommand

          +
          +public java.lang.String toCommand()
          +
          +
          create a full command string from this class +

          +

          + +
          Returns:
          The command string +
          Throws: +
          BuildException - in case of trouble
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.DisabledAssertion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.DisabledAssertion.html new file mode 100644 index 000000000..2487853e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.DisabledAssertion.html @@ -0,0 +1,270 @@ + + + + + + +Assertions.DisabledAssertion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Assertions.DisabledAssertion

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Assertions.BaseAssertion
+      extended by org.apache.tools.ant.types.Assertions.DisabledAssertion
+
          +
          +
          Enclosing class:
          Assertions
          +
          +
          +
          +
          public static class Assertions.DisabledAssertion
          extends Assertions.BaseAssertion
          + + +

          +A disabled assertion disables things +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Assertions.DisabledAssertion() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetCommandPrefix() + +
          +          get the prefix used to begin the command; -ea or -da.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Assertions.BaseAssertion
          getClassName, getPackageName, setClass, setPackage, toCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Assertions.DisabledAssertion

          +
          +public Assertions.DisabledAssertion()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCommandPrefix

          +
          +public java.lang.String getCommandPrefix()
          +
          +
          get the prefix used to begin the command; -ea or -da. +

          +

          +
          Specified by:
          getCommandPrefix in class Assertions.BaseAssertion
          +
          +
          + +
          Returns:
          prefix
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.EnabledAssertion.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.EnabledAssertion.html new file mode 100644 index 000000000..d417f9cce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.EnabledAssertion.html @@ -0,0 +1,270 @@ + + + + + + +Assertions.EnabledAssertion (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Assertions.EnabledAssertion

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Assertions.BaseAssertion
+      extended by org.apache.tools.ant.types.Assertions.EnabledAssertion
+
          +
          +
          Enclosing class:
          Assertions
          +
          +
          +
          +
          public static class Assertions.EnabledAssertion
          extends Assertions.BaseAssertion
          + + +

          +an enabled assertion enables things +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Assertions.EnabledAssertion() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetCommandPrefix() + +
          +          get the prefix used to begin the command; -ea or -da.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Assertions.BaseAssertion
          getClassName, getPackageName, setClass, setPackage, toCommand
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Assertions.EnabledAssertion

          +
          +public Assertions.EnabledAssertion()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCommandPrefix

          +
          +public java.lang.String getCommandPrefix()
          +
          +
          get the prefix used to begin the command; -ea or -da. +

          +

          +
          Specified by:
          getCommandPrefix in class Assertions.BaseAssertion
          +
          +
          + +
          Returns:
          prefix
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.html new file mode 100644 index 000000000..869355957 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Assertions.html @@ -0,0 +1,589 @@ + + + + + + +Assertions (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Assertions

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Assertions
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Assertions
          extends DataType
          implements java.lang.Cloneable
          + + +

          +The assertion datatype. This type describes + assertion settings for the <java> task and others. + One can set the system assertions, and enable/disable those in + packages and classes. + Assertions can only be enabled or disabled when forking Java. + + Example: set system assertions and all org.apache packages except + for ant, and the class org.apache.tools.ant.Main. + 

          + <assertions enableSystemAssertions="true" >
+   <enable package="org.apache" />
+   <disable package="org.apache.ant" />
+   <enable class="org.apache.tools.ant.Main"/>
+ </assertions>
+
          + Disable system assertions; enable those in the anonymous package + 
          + <assertions enableSystemAssertions="false" >
+   <enable package="..." />
+ </assertions>
+
          + enable assertions in a class called Test + 
          + <assertions >
+   <enable class="Test" />
+ </assertions>
+
          + This type is a datatype, so you can declare assertions and use them later + + 
          + <assertions id="project.assertions" >
+   <enable project="org.apache.test" />
+ </assertions>
+
+ <assertions refid="project.assertions" />
+
+
          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classAssertions.BaseAssertion + +
          +          base class for our assertion elements.
          +static classAssertions.DisabledAssertion + +
          +          A disabled assertion disables things
          +static classAssertions.EnabledAssertion + +
          +          an enabled assertion enables things
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Assertions() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddDisable(Assertions.DisabledAssertion assertion) + +
          +          disable assertions
          + voidaddEnable(Assertions.EnabledAssertion assertion) + +
          +          enable assertions
          + voidapplyAssertions(CommandlineJava command) + +
          +          apply all the assertions to the command.
          + voidapplyAssertions(java.util.List commandList) + +
          +          add the assertions to a list in a format suitable + for adding to a command line
          + voidapplyAssertions(java.util.ListIterator commandIterator) + +
          +          add the assertions to a list in a format suitable + for adding to a command line
          + java.lang.Objectclone() + +
          +          clone the objects.
          + voidsetEnableSystemAssertions(java.lang.Boolean enableSystemAssertions) + +
          +          enable or disable system assertions.
          + voidsetRefid(Reference ref) + +
          +          Set the value of the refid attribute.
          + intsize() + +
          +          how many assertions are made...will resolve references before returning
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Assertions

          +
          +public Assertions()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addEnable

          +
          +public void addEnable(Assertions.EnabledAssertion assertion)
          +
          +
          enable assertions +

          +

          +
          +
          +
          +
          Parameters:
          assertion - an enable assertion nested element
          +
          +
          +
          + +

          +addDisable

          +
          +public void addDisable(Assertions.DisabledAssertion assertion)
          +
          +
          disable assertions +

          +

          +
          +
          +
          +
          Parameters:
          assertion - a disable assertion nested element
          +
          +
          +
          + +

          +setEnableSystemAssertions

          +
          +public void setEnableSystemAssertions(java.lang.Boolean enableSystemAssertions)
          +
          +
          enable or disable system assertions. + Default is not set (neither -enablesystemassersions or -disablesytemassertions + are used on the command line). +

          +

          +
          +
          +
          +
          Parameters:
          enableSystemAssertions - if true enable system assertions
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference ref)
          +
          +
          Set the value of the refid attribute. + +

          Subclasses may need to check whether any other attributes + have been set as well or child elements have been created and + thus override this method. if they do the must call + super.setRefid.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          ref - the reference to use
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          how many assertions are made...will resolve references before returning +

          +

          +
          +
          +
          + +
          Returns:
          total # of commands to make
          +
          +
          +
          + +

          +applyAssertions

          +
          +public void applyAssertions(java.util.List commandList)
          +
          +
          add the assertions to a list in a format suitable + for adding to a command line +

          +

          +
          +
          +
          +
          Parameters:
          commandList - the command line to format
          +
          +
          +
          + +

          +applyAssertions

          +
          +public void applyAssertions(CommandlineJava command)
          +
          +
          apply all the assertions to the command. +

          +

          +
          +
          +
          +
          Parameters:
          command - the command line to format
          +
          +
          +
          + +

          +applyAssertions

          +
          +public void applyAssertions(java.util.ListIterator commandIterator)
          +
          +
          add the assertions to a list in a format suitable + for adding to a command line +

          +

          +
          +
          +
          +
          Parameters:
          commandIterator - list of commands
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
+                       throws java.lang.CloneNotSupportedException
          +
          +
          clone the objects. + This is not a full depth clone; the list of assertions is cloned, + but it does not clone the underlying assertions. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a cli +
          Throws: +
          java.lang.CloneNotSupportedException - if the super class does not support cloning
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Argument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Argument.html new file mode 100644 index 000000000..0314b2b71 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Argument.html @@ -0,0 +1,456 @@ + + + + + + +Commandline.Argument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Commandline.Argument

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.Commandline.Argument
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          ImplementationSpecificArgument
          +
          +
          +
          Enclosing class:
          Commandline
          +
          +
          +
          +
          public static class Commandline.Argument
          extends ProjectComponent
          + + +

          +Used for nested xml command line definitions. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Commandline.Argument() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getParts() + +
          +          Return the constituent parts of this Argument.
          + voidsetFile(java.io.File value) + +
          +          Set a single commandline argument to the absolute filename + of the given file.
          + voidsetLine(java.lang.String line) + +
          +          Set the line to split into several commandline arguments.
          + voidsetPath(Path value) + +
          +          Set a single commandline argument and treats it like a + PATH--ensuring the right separator for the local platform + is used.
          + voidsetPathref(Reference value) + +
          +          Set a single commandline argument from a reference to a + path--ensuring the right separator for the local platform + is used.
          + voidsetPrefix(java.lang.String prefix) + +
          +          Set the prefix to be placed in front of every part of the + argument.
          + voidsetSuffix(java.lang.String suffix) + +
          +          Set the suffix to be placed at the end of every part of the + argument.
          + voidsetValue(java.lang.String value) + +
          +          Set a single commandline argument.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Commandline.Argument

          +
          +public Commandline.Argument()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setValue

          +
          +public void setValue(java.lang.String value)
          +
          +
          Set a single commandline argument. +

          +

          +
          Parameters:
          value - a single commandline argument.
          +
          +
          +
          + +

          +setLine

          +
          +public void setLine(java.lang.String line)
          +
          +
          Set the line to split into several commandline arguments. +

          +

          +
          Parameters:
          line - line to split into several commandline arguments.
          +
          +
          +
          + +

          +setPath

          +
          +public void setPath(Path value)
          +
          +
          Set a single commandline argument and treats it like a + PATH--ensuring the right separator for the local platform + is used. +

          +

          +
          Parameters:
          value - a single commandline argument.
          +
          +
          +
          + +

          +setPathref

          +
          +public void setPathref(Reference value)
          +
          +
          Set a single commandline argument from a reference to a + path--ensuring the right separator for the local platform + is used. +

          +

          +
          Parameters:
          value - a single commandline argument.
          +
          +
          +
          + +

          +setFile

          +
          +public void setFile(java.io.File value)
          +
          +
          Set a single commandline argument to the absolute filename + of the given file. +

          +

          +
          Parameters:
          value - a single commandline argument.
          +
          +
          +
          + +

          +setPrefix

          +
          +public void setPrefix(java.lang.String prefix)
          +
          +
          Set the prefix to be placed in front of every part of the + argument. +

          +

          +
          Parameters:
          prefix - fixed prefix string.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setSuffix

          +
          +public void setSuffix(java.lang.String suffix)
          +
          +
          Set the suffix to be placed at the end of every part of the + argument. +

          +

          +
          Parameters:
          suffix - fixed suffix string.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getParts

          +
          +public java.lang.String[] getParts()
          +
          +
          Return the constituent parts of this Argument. +

          +

          + +
          Returns:
          an array of strings.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Marker.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Marker.html new file mode 100644 index 000000000..77650a04e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.Marker.html @@ -0,0 +1,322 @@ + + + + + + +Commandline.Marker (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Commandline.Marker

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Commandline.Marker
+
          +
          +
          Enclosing class:
          Commandline
          +
          +
          +
          +
          public class Commandline.Marker
          extends java.lang.Object
          + + +

          +Class to keep track of the position of an Argument. + +

          This class is there to support the srcfile and targetfile + elements of <apply>.

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetPosition() + +
          +          Return the number of arguments that preceded this marker.
          + java.lang.StringgetPrefix() + +
          +          Get the prefix to be placed in front of the inserted argument.
          + java.lang.StringgetSuffix() + +
          +          Get the suffix to be placed at the end of the inserted argument.
          + voidsetPrefix(java.lang.String prefix) + +
          +          Set the prefix to be placed in front of the inserted argument.
          + voidsetSuffix(java.lang.String suffix) + +
          +          Set the suffix to be placed at the end of the inserted argument.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getPosition

          +
          +public int getPosition()
          +
          +
          Return the number of arguments that preceded this marker. + +

          The name of the executable -- if set -- is counted as the + first argument.

          +

          +

          + +
          Returns:
          the position of this marker.
          +
          +
          +
          + +

          +setPrefix

          +
          +public void setPrefix(java.lang.String prefix)
          +
          +
          Set the prefix to be placed in front of the inserted argument. +

          +

          +
          Parameters:
          prefix - fixed prefix string.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getPrefix

          +
          +public java.lang.String getPrefix()
          +
          +
          Get the prefix to be placed in front of the inserted argument. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setSuffix

          +
          +public void setSuffix(java.lang.String suffix)
          +
          +
          Set the suffix to be placed at the end of the inserted argument. +

          +

          +
          Parameters:
          suffix - fixed suffix string.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getSuffix

          +
          +public java.lang.String getSuffix()
          +
          +
          Get the suffix to be placed at the end of the inserted argument. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.html new file mode 100644 index 000000000..ced15d967 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Commandline.html @@ -0,0 +1,1045 @@ + + + + + + +Commandline (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Commandline

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Commandline
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Commandline
          extends java.lang.Object
          implements java.lang.Cloneable
          + + +

          +Commandline objects help handling command lines specifying processes to + execute. + + The class can be used to define a command line as nested elements or as a + helper to define a command line by an application. +

          + + <someelement>
          +   <acommandline executable="/executable/to/run">
          +     <argument value="argument 1" />
          +     <argument line="argument_1 argument_2 argument_3" />
          +     <argument value="argument 4" />
          +   </acommandline>
          + </someelement>
          +           + The element someelement must provide a method + createAcommandline which returns an instance of this class. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classCommandline.Argument + +
          +          Used for nested xml command line definitions.
          + classCommandline.Marker + +
          +          Class to keep track of the position of an Argument.
          +  + + + + + + + + + + +
          +Field Summary
          +protected static java.lang.StringDISCLAIMER + +
          +           
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Commandline() + +
          +          Create an empty command line.
          Commandline(java.lang.String toProcess) + +
          +          Create a command line from a string.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddArguments(java.lang.String[] line) + +
          +          Append the arguments to the existing command.
          + voidaddArgumentsToList(java.util.ListIterator list) + +
          +          Append all the arguments to the tail of a supplied list.
          + voidaddCommandToList(java.util.ListIterator list) + +
          +          Add the entire command, including (optional) executable to a list.
          + voidclear() + +
          +          Clear out the whole command line.
          + voidclearArgs() + +
          +          Clear out the arguments but leave the executable in place for + another operation.
          + java.lang.Objectclone() + +
          +          Generate a deep clone of the contained object.
          + Commandline.ArgumentcreateArgument() + +
          +          Create an argument object.
          + Commandline.ArgumentcreateArgument(boolean insertAtStart) + +
          +          Create an argument object and add it to our list of args.
          + Commandline.MarkercreateMarker() + +
          +          Return a marker.
          + java.lang.StringdescribeArguments() + +
          +          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          +static java.lang.StringdescribeArguments(Commandline line) + +
          +          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          +static java.lang.StringdescribeArguments(java.lang.String[] args) + +
          +          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          +protected static java.lang.StringdescribeArguments(java.lang.String[] args, + int offset) + +
          +          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          + java.lang.StringdescribeCommand() + +
          +          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          +static java.lang.StringdescribeCommand(Commandline line) + +
          +          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          +static java.lang.StringdescribeCommand(java.lang.String[] args) + +
          +          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          + java.lang.String[]getArguments() + +
          +          Returns all arguments defined by addLine, + addValue or the argument object.
          + java.lang.String[]getCommandline() + +
          +          Return the executable and all defined arguments.
          + java.lang.StringgetExecutable() + +
          +          Get the executable.
          + java.util.Iteratoriterator() + +
          +          Get an iterator to the arguments list.
          +static java.lang.StringquoteArgument(java.lang.String argument) + +
          +          Put quotes around the given String if necessary.
          + voidsetExecutable(java.lang.String executable) + +
          +          Set the executable to run.
          + intsize() + +
          +          Size operator.
          + java.lang.StringtoString() + +
          +          Return the command line as a string.
          +static java.lang.StringtoString(java.lang.String[] line) + +
          +          Quote the parts of the given array in way that makes them + usable as command line arguments.
          +static java.lang.String[]translateCommandline(java.lang.String toProcess) + +
          +          Crack a command line.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DISCLAIMER

          +
          +protected static final java.lang.String DISCLAIMER
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Commandline

          +
          +public Commandline(java.lang.String toProcess)
          +
          +
          Create a command line from a string. +

          +

          +
          Parameters:
          toProcess - the line: the first element becomes the executable, the rest + the arguments.
          +
          +
          + +

          +Commandline

          +
          +public Commandline()
          +
          +
          Create an empty command line. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +createArgument

          +
          +public Commandline.Argument createArgument()
          +
          +
          Create an argument object. + +

          Each commandline object has at most one instance of the + argument class. This method calls + this.createArgument(false).

          +

          +

          +
          +
          +
          + +
          Returns:
          the argument object.
          See Also:
          createArgument(boolean)
          +
          +
          +
          + +

          +createArgument

          +
          +public Commandline.Argument createArgument(boolean insertAtStart)
          +
          +
          Create an argument object and add it to our list of args. + +

          Each commandline object has at most one instance of the + argument class.

          +

          +

          +
          +
          +
          +
          Parameters:
          insertAtStart - if true, the argument is inserted at the + beginning of the list of args, otherwise it is appended. +
          Returns:
          an argument to be configured
          +
          +
          +
          + +

          +setExecutable

          +
          +public void setExecutable(java.lang.String executable)
          +
          +
          Set the executable to run. All file separators in the string + are converted to the platform specific value. +

          +

          +
          +
          +
          +
          Parameters:
          executable - the String executable name.
          +
          +
          +
          + +

          +getExecutable

          +
          +public java.lang.String getExecutable()
          +
          +
          Get the executable. +

          +

          +
          +
          +
          + +
          Returns:
          the program to run--null if not yet set.
          +
          +
          +
          + +

          +addArguments

          +
          +public void addArguments(java.lang.String[] line)
          +
          +
          Append the arguments to the existing command. +

          +

          +
          +
          +
          +
          Parameters:
          line - an array of arguments to append.
          +
          +
          +
          + +

          +getCommandline

          +
          +public java.lang.String[] getCommandline()
          +
          +
          Return the executable and all defined arguments. +

          +

          +
          +
          +
          + +
          Returns:
          the commandline as an array of strings.
          +
          +
          +
          + +

          +addCommandToList

          +
          +public void addCommandToList(java.util.ListIterator list)
          +
          +
          Add the entire command, including (optional) executable to a list. +

          +

          +
          +
          +
          +
          Parameters:
          list - the list to add to.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getArguments

          +
          +public java.lang.String[] getArguments()
          +
          +
          Returns all arguments defined by addLine, + addValue or the argument object. +

          +

          +
          +
          +
          + +
          Returns:
          the arguments as an array of strings.
          +
          +
          +
          + +

          +addArgumentsToList

          +
          +public void addArgumentsToList(java.util.ListIterator list)
          +
          +
          Append all the arguments to the tail of a supplied list. +

          +

          +
          +
          +
          +
          Parameters:
          list - the list of arguments.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Return the command line as a string. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the command line.
          +
          +
          +
          + +

          +quoteArgument

          +
          +public static java.lang.String quoteArgument(java.lang.String argument)
          +
          +
          Put quotes around the given String if necessary. + +

          If the argument doesn't include spaces or quotes, return it + as is. If it contains double quotes, use single quotes - else + surround the argument by double quotes.

          +

          +

          +
          +
          +
          +
          Parameters:
          argument - the argument to quote if necessary. +
          Returns:
          the quoted argument. +
          Throws: +
          BuildException - if the argument contains both, single + and double quotes.
          +
          +
          +
          + +

          +toString

          +
          +public static java.lang.String toString(java.lang.String[] line)
          +
          +
          Quote the parts of the given array in way that makes them + usable as command line arguments. +

          +

          +
          +
          +
          +
          Parameters:
          line - the list of arguments to quote. +
          Returns:
          empty string for null or no command, else every argument split + by spaces and quoted by quoting rules.
          +
          +
          +
          + +

          +translateCommandline

          +
          +public static java.lang.String[] translateCommandline(java.lang.String toProcess)
          +
          +
          Crack a command line. +

          +

          +
          +
          +
          +
          Parameters:
          toProcess - the command line to process. +
          Returns:
          the command line broken into strings. + An empty or null toProcess parameter results in a zero sized array.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Size operator. This actually creates the command line, so it is not + a zero cost operation. +

          +

          +
          +
          +
          + +
          Returns:
          number of elements in the command, including the executable.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Generate a deep clone of the contained object. +

          +

          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          + +
          Returns:
          a clone of the contained object
          +
          +
          +
          + +

          +clear

          +
          +public void clear()
          +
          +
          Clear out the whole command line. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +clearArgs

          +
          +public void clearArgs()
          +
          +
          Clear out the arguments but leave the executable in place for + another operation. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +createMarker

          +
          +public Commandline.Marker createMarker()
          +
          +
          Return a marker. + +

          This marker can be used to locate a position on the + commandline--to insert something for example--when all + parameters have been set.

          +

          +

          +
          +
          +
          + +
          Returns:
          a marker
          +
          +
          +
          + +

          +describeCommand

          +
          +public java.lang.String describeCommand()
          +
          +
          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          + +
          Returns:
          a string that describes the command and arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeArguments

          +
          +public java.lang.String describeArguments()
          +
          +
          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          + +
          Returns:
          a string that describes the arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeCommand

          +
          +public static java.lang.String describeCommand(Commandline line)
          +
          +
          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          +
          Parameters:
          line - the Commandline to describe. +
          Returns:
          a string that describes the command and arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeArguments

          +
          +public static java.lang.String describeArguments(Commandline line)
          +
          +
          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          +
          Parameters:
          line - the Commandline whose arguments to describe. +
          Returns:
          a string that describes the arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeCommand

          +
          +public static java.lang.String describeCommand(java.lang.String[] args)
          +
          +
          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). + +

          This method assumes that the first entry in the array is the + executable to run.

          +

          +

          +
          +
          +
          +
          Parameters:
          args - the command line to describe as an array of strings +
          Returns:
          a string that describes the command and arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeArguments

          +
          +public static java.lang.String describeArguments(java.lang.String[] args)
          +
          +
          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          +
          Parameters:
          args - the command line to describe as an array of strings. +
          Returns:
          a string that describes the arguments.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeArguments

          +
          +protected static java.lang.String describeArguments(java.lang.String[] args,
+                                                    int offset)
          +
          +
          Return a String that describes the arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          +
          Parameters:
          args - the command line to describe as an array of strings.
          offset - ignore entries before this index. +
          Returns:
          a string that describes the arguments
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Get an iterator to the arguments list. +

          +

          +
          +
          +
          + +
          Returns:
          an Iterator.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.SysProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.SysProperties.html new file mode 100644 index 000000000..a486f1e46 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.SysProperties.html @@ -0,0 +1,500 @@ + + + + + + +CommandlineJava.SysProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class CommandlineJava.SysProperties

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Environment
+      extended by org.apache.tools.ant.types.CommandlineJava.SysProperties
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Enclosing class:
          CommandlineJava
          +
          +
          +
          +
          public static class CommandlineJava.SysProperties
          extends Environment
          implements java.lang.Cloneable
          + + +

          +Specialized Environment class for System properties. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.types.Environment
          Environment.Variable
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Environment
          variables
          +  + + + + + + + + + + +
          +Constructor Summary
          CommandlineJava.SysProperties() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddDefinitionsToList(java.util.ListIterator listIt) + +
          +          Add all definitions (including property sets) to a list.
          + voidaddSysproperties(CommandlineJava.SysProperties ps) + +
          +          Add a propertyset to the total set.
          + voidaddSyspropertyset(PropertySet ps) + +
          +          Add a propertyset to the total set.
          + java.lang.Objectclone() + +
          +          Create a deep clone.
          + java.lang.String[]getVariables() + +
          +          Get the properties as an array; this is an override of the + superclass, as it evaluates all the properties.
          + voidrestoreSystem() + +
          +          Restore the system properties to the cached value.
          + voidsetSystem() + +
          +          Cache the system properties and set the system properties to the + new values.
          + intsize() + +
          +          Get the size of the sysproperties instance.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Environment
          addVariable, getVariablesVector
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CommandlineJava.SysProperties

          +
          +public CommandlineJava.SysProperties()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getVariables

          +
          +public java.lang.String[] getVariables()
+                                throws BuildException
          +
          +
          Get the properties as an array; this is an override of the + superclass, as it evaluates all the properties. +

          +

          +
          Overrides:
          getVariables in class Environment
          +
          +
          + +
          Returns:
          the array of definitions; may be null. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +addDefinitionsToList

          +
          +public void addDefinitionsToList(java.util.ListIterator listIt)
          +
          +
          Add all definitions (including property sets) to a list. +

          +

          +
          +
          +
          +
          Parameters:
          listIt - list iterator supporting add method.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Get the size of the sysproperties instance. This merges all + property sets, so is not an O(1) operation. +

          +

          +
          +
          +
          + +
          Returns:
          the size of the sysproperties instance.
          +
          +
          +
          + +

          +setSystem

          +
          +public void setSystem()
+               throws BuildException
          +
          +
          Cache the system properties and set the system properties to the + new values. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if Security prevented this operation.
          +
          +
          +
          + +

          +restoreSystem

          +
          +public void restoreSystem()
+                   throws BuildException
          +
          +
          Restore the system properties to the cached value. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if Security prevented this operation, or + there were no system properties to restore.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
+                       throws java.lang.CloneNotSupportedException
          +
          +
          Create a deep clone. +

          +

          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          + +
          Returns:
          a cloned instance of SysProperties. +
          Throws: +
          java.lang.CloneNotSupportedException - for signature.
          +
          +
          +
          + +

          +addSyspropertyset

          +
          +public void addSyspropertyset(PropertySet ps)
          +
          +
          Add a propertyset to the total set. +

          +

          +
          +
          +
          +
          Parameters:
          ps - the new property set.
          +
          +
          +
          + +

          +addSysproperties

          +
          +public void addSysproperties(CommandlineJava.SysProperties ps)
          +
          +
          Add a propertyset to the total set. +

          +

          +
          +
          +
          +
          Parameters:
          ps - the new property set.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.html new file mode 100644 index 000000000..6cfbba61d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/CommandlineJava.html @@ -0,0 +1,1172 @@ + + + + + + +CommandlineJava (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class CommandlineJava

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.CommandlineJava
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class CommandlineJava
          extends java.lang.Object
          implements java.lang.Cloneable
          + + +

          +A representation of a Java command line that is + a composite of 2 Commandlines. One is used for the + vm/options and one for the classname/arguments. It provides + specific methods for a Java command line. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classCommandlineJava.SysProperties + +
          +          Specialized Environment class for System properties.
          +  + + + + + + + + + + +
          +Constructor Summary
          CommandlineJava() + +
          +          Constructor uses the VM we are running on now.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddSysproperties(CommandlineJava.SysProperties sysp) + +
          +          Add a set of system properties.
          + voidaddSysproperty(Environment.Variable sysp) + +
          +          Add a system property.
          + voidaddSyspropertyset(PropertySet sysp) + +
          +          Add a set of system properties.
          + voidclearJavaArgs() + +
          +          Clear out the java arguments.
          + java.lang.Objectclone() + +
          +          Deep clone the object.
          + Commandline.ArgumentcreateArgument() + +
          +          Create a new argument to the java program.
          + PathcreateBootclasspath(Project p) + +
          +          Create a boot classpath.
          + PathcreateClasspath(Project p) + +
          +          Create a classpath.
          + Commandline.ArgumentcreateVmArgument() + +
          +          Create a new JVM argument.
          + java.lang.StringdescribeCommand() + +
          +          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]).
          + java.lang.StringdescribeJavaCommand() + +
          +          Return a String that describes the java command and arguments + for in-VM executions.
          +protected  CommandlinegetActualVMCommand() + +
          +          Get the VM command parameters, including memory settings.
          + AssertionsgetAssertions() + +
          +          Get the current assertions.
          + PathgetBootclasspath() + +
          +          Get the boot classpath.
          + java.lang.StringgetClassname() + +
          +          Get the name of the class to be run.
          + PathgetClasspath() + +
          +          Get the classpath for the command.
          + java.lang.String[]getCommandline() + +
          +          Get the command line to run a Java vm.
          + java.lang.StringgetJar() + +
          +          Get the name of the jar to be run.
          + CommandlinegetJavaCommand() + +
          +          Get the Java command to be used.
          + CommandlineJava.SysPropertiesgetSystemProperties() + +
          +          Get the system properties object.
          + CommandlinegetVmCommand() + +
          +          Get the VM command, including memory.
          + java.lang.StringgetVmversion() + +
          +          Get the vm version.
          +protected  booleanhaveBootclasspath(boolean log) + +
          +          Determine whether the bootclasspath has been specified, and whether it + shall really be used (build.sysclasspath could be set or the VM may not + support it).
          + booleanhaveClasspath() + +
          +          Determine whether the classpath has been specified, and whether it shall + really be used or be nulled by build.sysclasspath.
          + voidrestoreSystemProperties() + +
          +          Restore the cached system properties.
          + voidsetAssertions(Assertions assertions) + +
          +          Add an assertion set to the command.
          + voidsetClassname(java.lang.String classname) + +
          +          Set the classname to execute.
          + voidsetCloneVm(boolean cloneVm) + +
          +          Set whether system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclasspath.
          + voidsetJar(java.lang.String jarpathname) + +
          +          Set a jar file to execute via the -jar option.
          + voidsetMaxmemory(java.lang.String max) + +
          +          Specify max memory of the JVM.
          + voidsetSystemProperties() + +
          +          Cache current system properties and set them to those in this + Java command.
          + voidsetVm(java.lang.String vm) + +
          +          Set the executable used to start the new JVM.
          + voidsetVmversion(java.lang.String value) + +
          +          Set the JVM version required.
          + intsize() + +
          +          Deprecated. since 1.7. + Please dont use this, it effectively creates the + entire command.
          + java.lang.StringtoString() + +
          +          Get a string description.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CommandlineJava

          +
          +public CommandlineJava()
          +
          +
          Constructor uses the VM we are running on now. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +createArgument

          +
          +public Commandline.Argument createArgument()
          +
          +
          Create a new argument to the java program. +

          +

          +
          +
          +
          + +
          Returns:
          an argument to be configured.
          +
          +
          +
          + +

          +createVmArgument

          +
          +public Commandline.Argument createVmArgument()
          +
          +
          Create a new JVM argument. +

          +

          +
          +
          +
          + +
          Returns:
          an argument to be configured.
          +
          +
          +
          + +

          +addSysproperty

          +
          +public void addSysproperty(Environment.Variable sysp)
          +
          +
          Add a system property. +

          +

          +
          +
          +
          +
          Parameters:
          sysp - a property to be set in the JVM.
          +
          +
          +
          + +

          +addSyspropertyset

          +
          +public void addSyspropertyset(PropertySet sysp)
          +
          +
          Add a set of system properties. +

          +

          +
          +
          +
          +
          Parameters:
          sysp - a set of properties.
          +
          +
          +
          + +

          +addSysproperties

          +
          +public void addSysproperties(CommandlineJava.SysProperties sysp)
          +
          +
          Add a set of system properties. +

          +

          +
          +
          +
          +
          Parameters:
          sysp - a set of properties.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setVm

          +
          +public void setVm(java.lang.String vm)
          +
          +
          Set the executable used to start the new JVM. +

          +

          +
          +
          +
          +
          Parameters:
          vm - the executable to use.
          +
          +
          +
          + +

          +setVmversion

          +
          +public void setVmversion(java.lang.String value)
          +
          +
          Set the JVM version required. +

          +

          +
          +
          +
          +
          Parameters:
          value - the version required.
          +
          +
          +
          + +

          +setCloneVm

          +
          +public void setCloneVm(boolean cloneVm)
          +
          +
          Set whether system properties will be copied to the cloned VM--as + well as the bootclasspath unless you have explicitly specified + a bootclasspath. +

          +

          +
          +
          +
          +
          Parameters:
          cloneVm - if true copy the system properties.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getAssertions

          +
          +public Assertions getAssertions()
          +
          +
          Get the current assertions. +

          +

          +
          +
          +
          + +
          Returns:
          assertions or null.
          +
          +
          +
          + +

          +setAssertions

          +
          +public void setAssertions(Assertions assertions)
          +
          +
          Add an assertion set to the command. +

          +

          +
          +
          +
          +
          Parameters:
          assertions - assertions to make.
          +
          +
          +
          + +

          +setJar

          +
          +public void setJar(java.lang.String jarpathname)
          +
          +
          Set a jar file to execute via the -jar option. +

          +

          +
          +
          +
          +
          Parameters:
          jarpathname - the pathname of the jar to execute.
          +
          +
          +
          + +

          +getJar

          +
          +public java.lang.String getJar()
          +
          +
          Get the name of the jar to be run. +

          +

          +
          +
          +
          + +
          Returns:
          the pathname of the jar file to run via -jar option + or null if there is no jar to run.
          See Also:
          getClassname()
          +
          +
          +
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String classname)
          +
          +
          Set the classname to execute. +

          +

          +
          +
          +
          +
          Parameters:
          classname - the fully qualified classname.
          +
          +
          +
          + +

          +getClassname

          +
          +public java.lang.String getClassname()
          +
          +
          Get the name of the class to be run. +

          +

          +
          +
          +
          + +
          Returns:
          the name of the class to run or null if there is no class.
          See Also:
          getJar()
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath(Project p)
          +
          +
          Create a classpath. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use to create the path. +
          Returns:
          a path to be configured.
          +
          +
          +
          + +

          +createBootclasspath

          +
          +public Path createBootclasspath(Project p)
          +
          +
          Create a boot classpath. +

          +

          +
          +
          +
          +
          Parameters:
          p - the project to use to create the path. +
          Returns:
          a path to be configured.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getVmversion

          +
          +public java.lang.String getVmversion()
          +
          +
          Get the vm version. +

          +

          +
          +
          +
          + +
          Returns:
          the vm version.
          +
          +
          +
          + +

          +getCommandline

          +
          +public java.lang.String[] getCommandline()
          +
          +
          Get the command line to run a Java vm. +

          +

          +
          +
          +
          + +
          Returns:
          the list of all arguments necessary to run the vm.
          +
          +
          +
          + +

          +setMaxmemory

          +
          +public void setMaxmemory(java.lang.String max)
          +
          +
          Specify max memory of the JVM. + -mx or -Xmx depending on VM version. +

          +

          +
          +
          +
          +
          Parameters:
          max - the string to pass to the jvm to specifiy the max memory.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get a string description. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the command line as a string.
          +
          +
          +
          + +

          +describeCommand

          +
          +public java.lang.String describeCommand()
          +
          +
          Return a String that describes the command and arguments suitable for + verbose output before a call to Runtime.exec(String[]). +

          +

          +
          +
          +
          + +
          Returns:
          the description string.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +describeJavaCommand

          +
          +public java.lang.String describeJavaCommand()
          +
          +
          Return a String that describes the java command and arguments + for in-VM executions. + +

          The class name is the executable in this context.

          +

          +

          +
          +
          +
          + +
          Returns:
          the description string.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +getActualVMCommand

          +
          +protected Commandline getActualVMCommand()
          +
          +
          Get the VM command parameters, including memory settings. +

          +

          +
          +
          +
          + +
          Returns:
          the VM command parameters.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Deprecated. since 1.7. + Please dont use this, it effectively creates the + entire command. +

          +

          Get the size of the java command line. This is a fairly intensive + operation, as it has to evaluate the size of many components. +

          +

          +
          +
          +
          + +
          Returns:
          the total number of arguments in the java command line.
          See Also:
          getCommandline()
          +
          +
          +
          + +

          +getJavaCommand

          +
          +public Commandline getJavaCommand()
          +
          +
          Get the Java command to be used. +

          +

          +
          +
          +
          + +
          Returns:
          the java command--not a clone.
          +
          +
          +
          + +

          +getVmCommand

          +
          +public Commandline getVmCommand()
          +
          +
          Get the VM command, including memory. +

          +

          +
          +
          +
          + +
          Returns:
          A deep clone of the instance's VM command, with memory settings added.
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          Get the classpath for the command. +

          +

          +
          +
          +
          + +
          Returns:
          the classpath or null.
          +
          +
          +
          + +

          +getBootclasspath

          +
          +public Path getBootclasspath()
          +
          +
          Get the boot classpath. +

          +

          +
          +
          +
          + +
          Returns:
          boot classpath or null.
          +
          +
          +
          + +

          +setSystemProperties

          +
          +public void setSystemProperties()
+                         throws BuildException
          +
          +
          Cache current system properties and set them to those in this + Java command. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if Security prevented this operation.
          +
          +
          +
          + +

          +restoreSystemProperties

          +
          +public void restoreSystemProperties()
+                             throws BuildException
          +
          +
          Restore the cached system properties. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if Security prevented this operation, or + there was no system properties to restore
          +
          +
          +
          + +

          +getSystemProperties

          +
          +public CommandlineJava.SysProperties getSystemProperties()
          +
          +
          Get the system properties object. +

          +

          +
          +
          +
          + +
          Returns:
          The system properties object.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
+                       throws java.lang.CloneNotSupportedException
          +
          +
          Deep clone the object. +

          +

          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          + +
          Returns:
          a CommandlineJava object. +
          Throws: +
          BuildException - if anything went wrong. +
          java.lang.CloneNotSupportedException - never.
          +
          +
          +
          + +

          +clearJavaArgs

          +
          +public void clearJavaArgs()
          +
          +
          Clear out the java arguments. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +haveClasspath

          +
          +public boolean haveClasspath()
          +
          +
          Determine whether the classpath has been specified, and whether it shall + really be used or be nulled by build.sysclasspath. +

          +

          +
          +
          +
          + +
          Returns:
          true if the classpath is to be used.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +haveBootclasspath

          +
          +protected boolean haveBootclasspath(boolean log)
          +
          +
          Determine whether the bootclasspath has been specified, and whether it + shall really be used (build.sysclasspath could be set or the VM may not + support it). +

          +

          +
          +
          +
          +
          Parameters:
          log - whether to log a warning if a bootclasspath has been + specified but will be ignored. +
          Returns:
          true if the bootclasspath is to be used.
          Since:
          +
          Ant 1.6
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Comparison.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Comparison.html new file mode 100644 index 000000000..573644bbd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Comparison.html @@ -0,0 +1,466 @@ + + + + + + +Comparison (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Comparison

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.Comparison
+
          +
          +
          Direct Known Subclasses:
          Length.When, SizeSelector.SizeComparisons
          +
          +
          +
          +
          public class Comparison
          extends EnumeratedAttribute
          + + +

          +EnumeratedAttribute for generic comparisons. Accepts values + "equal", "greater", "more", "less", "ne" (not equal), + "ge" (greater or equal), "le" (less or equal), "eq" (equal), + "gt" (greater), "lt" (less). +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static ComparisonEQUAL + +
          +          Equal Comparison.
          +static ComparisonGREATER + +
          +          Greater Comparison.
          +static ComparisonGREATER_EQUAL + +
          +          Greater-or-Equal Comparison.
          +static ComparisonLESS + +
          +          Less Comparison.
          +static ComparisonLESS_EQUAL + +
          +          Less-or-Equal Comparison.
          +static ComparisonNOT_EQUAL + +
          +          Not-Equal Comparison.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Comparison() + +
          +          Default constructor.
          Comparison(java.lang.String value) + +
          +          Construct a new Comparison with the specified value.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanevaluate(int comparisonResult) + +
          +          Evaluate a comparison result as from Comparator.compare() or Comparable.compareTo().
          + java.lang.String[]getValues() + +
          +          Return the possible values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EQUAL

          +
          +public static final Comparison EQUAL
          +
          +
          Equal Comparison. +

          +

          +
          +
          +
          + +

          +NOT_EQUAL

          +
          +public static final Comparison NOT_EQUAL
          +
          +
          Not-Equal Comparison. +

          +

          +
          +
          +
          + +

          +GREATER

          +
          +public static final Comparison GREATER
          +
          +
          Greater Comparison. +

          +

          +
          +
          +
          + +

          +LESS

          +
          +public static final Comparison LESS
          +
          +
          Less Comparison. +

          +

          +
          +
          +
          + +

          +GREATER_EQUAL

          +
          +public static final Comparison GREATER_EQUAL
          +
          +
          Greater-or-Equal Comparison. +

          +

          +
          +
          +
          + +

          +LESS_EQUAL

          +
          +public static final Comparison LESS_EQUAL
          +
          +
          Less-or-Equal Comparison. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Comparison

          +
          +public Comparison()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Comparison

          +
          +public Comparison(java.lang.String value)
          +
          +
          Construct a new Comparison with the specified value. +

          +

          +
          Parameters:
          value - the EnumeratedAttribute value.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Return the possible values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          String[] of EnumeratedAttribute values.
          +
          +
          +
          + +

          +evaluate

          +
          +public boolean evaluate(int comparisonResult)
          +
          +
          Evaluate a comparison result as from Comparator.compare() or Comparable.compareTo(). +

          +

          +
          Parameters:
          comparisonResult - the result to evaluate. +
          Returns:
          true if the comparison result fell within the parameters of this Comparison.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DTDLocation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DTDLocation.html new file mode 100644 index 000000000..bac1b1b0e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DTDLocation.html @@ -0,0 +1,245 @@ + + + + + + +DTDLocation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class DTDLocation

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.ResourceLocation
+      extended by org.apache.tools.ant.types.DTDLocation
+
          +
          +
          Direct Known Subclasses:
          EjbJar.DTDLocation
          +
          +
          +
          +
          public class DTDLocation
          extends ResourceLocation
          + + +

          +

          Helper class to handle the DTD nested element. Instances of + this class correspond to the PUBLIC catalog entry type + of the + OASIS "Open Catalog" standard.

          + +

          Possible Future Enhancement: Bring the Ant element name into + conformance with the OASIS standard.

          +

          + +

          +

          +
          See Also:
          Catalog
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          DTDLocation() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.ResourceLocation
          getBase, getLocation, getPublicId, setBase, setLocation, setPublicId
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DTDLocation

          +
          +public DTDLocation()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DataType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DataType.html new file mode 100644 index 000000000..0ff9362c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DataType.html @@ -0,0 +1,978 @@ + + + + + + +DataType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class DataType

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          AbstractFileSet, AbstractResourceCollectionWrapper, AbstractSelectorContainer, AntFilterReader, Archives, Assertions, BaseResourceCollectionContainer, BaseSelector, Compare, Description, ExtensionAdapter, ExtensionSet, FileList, FilterChain, FilterSet, ImageOperation, IsSigned, MappedResourceCollection, Mapper, Path, PatternSet, PropertySet, RedirectorElement, RegularExpression, Resource, ResourceComparator, ResourceList, Resources, ResourceSelectorContainer, SignedSelector, Substitution, XMLCatalog
          +
          +
          +
          +
          public abstract class DataType
          extends ProjectComponent
          implements java.lang.Cloneable
          + + +

          +Base class for those classes that can appear inside the build file + as stand alone data types. + +

          This class handles the common description attribute and provides + a default implementation for reference handling and checking for + circular references that is appropriate for types that can not be + nested inside elements of the same type (i.e. <patternset> + but not <path>).

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  booleanchecked + +
          +          Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use setChecked(boolean) or + isChecked() instead.
          +protected  Referenceref + +
          +          Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use getRefid() instead.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DataType() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidcheckAttributesAllowed() + +
          +          check that it is ok to set attributes, i.e that no reference is defined
          +protected  voidcheckChildrenAllowed() + +
          +          check that it is ok to add children, i.e that no reference is defined
          +protected  BuildExceptioncircularReference() + +
          +          Creates an exception that indicates the user has generated a + loop of data types referencing each other.
          + java.lang.Objectclone() + +
          +           
          +protected  voiddieOnCircularReference() + +
          +          Convenience method.
          +protected  voiddieOnCircularReference(Project p) + +
          +          Convenience method.
          +protected  voiddieOnCircularReference(java.util.Stack stack, + Project project) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          +protected  java.lang.ObjectgetCheckedRef() + +
          +          Performs the check for circular references and returns the + referenced object.
          +protected  java.lang.ObjectgetCheckedRef(java.lang.Class requiredClass, + java.lang.String dataTypeName) + +
          +          Performs the check for circular references and returns the + referenced object.
          +protected  java.lang.ObjectgetCheckedRef(java.lang.Class requiredClass, + java.lang.String dataTypeName, + Project project) + +
          +          Performs the check for circular references and returns the + referenced object.
          +protected  java.lang.ObjectgetCheckedRef(Project p) + +
          +          Performs the check for circular references and returns the + referenced object.
          +protected  java.lang.StringgetDataTypeName() + +
          +          Gets as descriptive as possible a name used for this datatype instance.
          + ReferencegetRefid() + +
          +          get the reference set on this object
          +static voidinvokeCircularReferenceCheck(DataType dt, + java.util.Stack stk, + Project p) + +
          +          Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes.
          +protected  booleanisChecked() + +
          +          The flag that is used to indicate that circular references have been checked.
          + booleanisReference() + +
          +          Has the refid attribute of this element been set?
          +protected  BuildExceptionnoChildrenAllowed() + +
          +          Creates an exception that indicates that this XML element must + not have child elements if the refid attribute is set.
          +static voidpushAndInvokeCircularReferenceCheck(DataType dt, + java.util.Stack stk, + Project p) + +
          +          Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes.
          +protected  voidsetChecked(boolean checked) + +
          +          Set the flag that is used to indicate that circular references have been checked.
          + voidsetRefid(Reference ref) + +
          +          Set the value of the refid attribute.
          +protected  BuildExceptiontooManyAttributes() + +
          +          Creates an exception that indicates that refid has to be the + only attribute if it is set.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ref

          +
          +protected Reference ref
          +
          +
          Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use getRefid() instead.
          Value to the refid attribute. +

          +

          +
          +
          +
          + +

          +checked

          +
          +protected boolean checked
          +
          +
          Deprecated. since 1.7. + The user should not be directly referencing + variable. Please use setChecked(boolean) or + isChecked() instead.
          Are we sure we don't hold circular references? + +

          Subclasses are responsible for setting this value to false + if we'd need to investigate this condition (usually because a + child element has been added that is a subclass of + DataType).

          +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DataType

          +
          +public DataType()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isReference

          +
          +public boolean isReference()
          +
          +
          Has the refid attribute of this element been set? +

          +

          +
          +
          +
          + +
          Returns:
          true if the refid attribute has been set
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference ref)
          +
          +
          Set the value of the refid attribute. + +

          Subclasses may need to check whether any other attributes + have been set as well or child elements have been created and + thus override this method. if they do the must call + super.setRefid.

          +

          +

          +
          +
          +
          +
          Parameters:
          ref - the reference to use
          +
          +
          +
          + +

          +getDataTypeName

          +
          +protected java.lang.String getDataTypeName()
          +
          +
          Gets as descriptive as possible a name used for this datatype instance. +

          +

          +
          +
          +
          + +
          Returns:
          String name.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference()
          +
          +
          Convenience method. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(Project p)
          +
          +
          Convenience method. +

          +

          +
          +
          +
          +
          Parameters:
          p - the Ant Project instance against which to resolve references.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stack,
+                                      Project project)
+                               throws BuildException
          +
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          +
          +
          +
          Parameters:
          stack - the stack of references to check.
          project - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +invokeCircularReferenceCheck

          +
          +public static void invokeCircularReferenceCheck(DataType dt,
+                                                java.util.Stack stk,
+                                                Project p)
          +
          +
          Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes. +

          +

          +
          +
          +
          +
          Parameters:
          dt - the DataType to check.
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +pushAndInvokeCircularReferenceCheck

          +
          +public static void pushAndInvokeCircularReferenceCheck(DataType dt,
+                                                       java.util.Stack stk,
+                                                       Project p)
          +
          +
          Allow DataTypes outside org.apache.tools.ant.types to indirectly call + dieOnCircularReference on nested DataTypes. + +

          Pushes dt on the stack, runs dieOnCircularReference and pops + it again.

          +

          +

          +
          +
          +
          +
          Parameters:
          dt - the DataType to check.
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getCheckedRef

          +
          +protected java.lang.Object getCheckedRef()
          +
          +
          Performs the check for circular references and returns the + referenced object. +

          +

          +
          +
          +
          + +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference is invalid (circular ref, wrong class, etc).
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getCheckedRef

          +
          +protected java.lang.Object getCheckedRef(Project p)
          +
          +
          Performs the check for circular references and returns the + referenced object. +

          +

          +
          +
          +
          +
          Parameters:
          p - the Ant Project instance against which to resolve references. +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference is invalid (circular ref, wrong class, etc).
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getCheckedRef

          +
          +protected java.lang.Object getCheckedRef(java.lang.Class requiredClass,
+                                         java.lang.String dataTypeName)
          +
          +
          Performs the check for circular references and returns the + referenced object. +

          +

          +
          +
          +
          +
          Parameters:
          requiredClass - the class that this reference should be a subclass of.
          dataTypeName - the name of the datatype that the reference should be + (error message use only). +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference is invalid (circular ref, wrong class, etc).
          +
          +
          +
          + +

          +getCheckedRef

          +
          +protected java.lang.Object getCheckedRef(java.lang.Class requiredClass,
+                                         java.lang.String dataTypeName,
+                                         Project project)
          +
          +
          Performs the check for circular references and returns the + referenced object. This version allows the fallback Project instance to be specified. +

          +

          +
          +
          +
          +
          Parameters:
          requiredClass - the class that this reference should be a subclass of.
          dataTypeName - the name of the datatype that the reference should be + (error message use only).
          project - the fallback Project instance for dereferencing. +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference is invalid (circular ref, wrong class, etc), + or if project is null.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +tooManyAttributes

          +
          +protected BuildException tooManyAttributes()
          +
          +
          Creates an exception that indicates that refid has to be the + only attribute if it is set. +

          +

          +
          +
          +
          + +
          Returns:
          the exception to throw
          +
          +
          +
          + +

          +noChildrenAllowed

          +
          +protected BuildException noChildrenAllowed()
          +
          +
          Creates an exception that indicates that this XML element must + not have child elements if the refid attribute is set. +

          +

          +
          +
          +
          + +
          Returns:
          the exception to throw
          +
          +
          +
          + +

          +circularReference

          +
          +protected BuildException circularReference()
          +
          +
          Creates an exception that indicates the user has generated a + loop of data types referencing each other. +

          +

          +
          +
          +
          + +
          Returns:
          the exception to throw
          +
          +
          +
          + +

          +isChecked

          +
          +protected boolean isChecked()
          +
          +
          The flag that is used to indicate that circular references have been checked. +

          +

          +
          +
          +
          + +
          Returns:
          true if circular references have been checked
          +
          +
          +
          + +

          +setChecked

          +
          +protected void setChecked(boolean checked)
          +
          +
          Set the flag that is used to indicate that circular references have been checked. +

          +

          +
          +
          +
          +
          Parameters:
          checked - if true, if circular references have been checked
          +
          +
          +
          + +

          +getRefid

          +
          +public Reference getRefid()
          +
          +
          get the reference set on this object +

          +

          +
          +
          +
          + +
          Returns:
          the reference or null
          +
          +
          +
          + +

          +checkAttributesAllowed

          +
          +protected void checkAttributesAllowed()
          +
          +
          check that it is ok to set attributes, i.e that no reference is defined +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if not allowed
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +checkChildrenAllowed

          +
          +protected void checkChildrenAllowed()
          +
          +
          check that it is ok to add children, i.e that no reference is defined +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if not allowed
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          this DataType formatted as a String.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
+                       throws java.lang.CloneNotSupportedException
          +
          +
          +
          Overrides:
          clone in class ProjectComponent
          +
          +
          + +
          Returns:
          a shallow copy of this DataType. +
          Throws: +
          java.lang.CloneNotSupportedException - if there is a problem.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Description.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Description.html new file mode 100644 index 000000000..1e6c8b7d0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Description.html @@ -0,0 +1,335 @@ + + + + + + +Description (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Description

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Description
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Description
          extends DataType
          + + +

          +Description is used to provide a project-wide description element + (that is, a description that applies to a buildfile as a whole). + If present, the <description> element is printed out before the + target descriptions. + + Description has no attributes, only text. There can only be one + project description per project. A second description element will + overwrite the first. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Description() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          Adds descriptive text to the project.
          +static java.lang.StringgetDescription(Project project) + +
          +          Return the descriptions from all the targets of + a project.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Description

          +
          +public Description()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Adds descriptive text to the project. +

          +

          +
          Parameters:
          text - the descriptive text
          +
          +
          +
          + +

          +getDescription

          +
          +public static java.lang.String getDescription(Project project)
          +
          +
          Return the descriptions from all the targets of + a project. +

          +

          +
          Parameters:
          project - the project to get the descriptions for. +
          Returns:
          a string containing the concatenated descriptions of + the targets.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DirSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DirSet.html new file mode 100644 index 000000000..2ebe825c8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/DirSet.html @@ -0,0 +1,454 @@ + + + + + + +DirSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class DirSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.DirSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          +
          public class DirSet
          extends AbstractFileSet
          implements ResourceCollection
          + + +

          +Subclass as hint for supporting tasks that the included directories + instead of files should be used. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + DirSet() + +
          +          Constructor for DirSet.
          +protected DirSet(DirSet dirset) + +
          +          Constructor for DirSet, with DirSet to shallowly clone.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +          Return a DirSet that has the same basedir and same patternsets + as this one.
          + booleanisFilesystemOnly() + +
          +          Always returns true.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Returns included directories as a list of semicolon-separated paths.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DirSet

          +
          +public DirSet()
          +
          +
          Constructor for DirSet. +

          +

          +
          + +

          +DirSet

          +
          +protected DirSet(DirSet dirset)
          +
          +
          Constructor for DirSet, with DirSet to shallowly clone. +

          +

          +
          Parameters:
          dirset - the dirset to clone.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Return a DirSet that has the same basedir and same patternsets + as this one. +

          +

          +
          Overrides:
          clone in class AbstractFileSet
          +
          +
          + +
          Returns:
          the cloned dirset.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Always returns true. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true indicating that all elements will be FileResources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Returns included directories as a list of semicolon-separated paths. +

          +

          +
          Overrides:
          toString in class AbstractFileSet
          +
          +
          + +
          Returns:
          a String of included directories.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/EnumeratedAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/EnumeratedAttribute.html new file mode 100644 index 000000000..a3815fb10 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/EnumeratedAttribute.html @@ -0,0 +1,470 @@ + + + + + + +EnumeratedAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class EnumeratedAttribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+
          +
          +
          Direct Known Subclasses:
          AggregateTransformer.Format, Available.FileDir, Checksum.FormatElement, Comparison, Definer.Format, Definer.OnError, EchoProperties.FormatAttribute, EchoXML.NamespacePolicy, EjbJar.CMPVersion, EjbJar.NamingScheme, EmailTask.Encoding, ExecuteOn.FileDirBoth, FilterSet.OnMissing, FixCRLF.AddAsisRemove, FixCRLF.CrLf, FixCrLfFilter.AddAsisRemove, FixCrLfFilter.CrLf, FormatterElement.TypeAttribute, FTP.Action, FTP.FTPSystemType, FTP.Granularity, FTP.LanguageCode, FTPTask.Action, FTPTask.FTPSystemType, FTPTask.Granularity, Input.HandlerType, IsLastModified.CompareMode, Jar.FilesetManifestConfig, Jar.StrictMode, Javadoc.AccessType, JDependTask.FormatAttribute, JUnitTask.ForkMode, JUnitTask.SummaryAttribute, Length.FileMode, LogLevel, ManifestTask.Mode, Mapper.MapperType, ModifiedSelector.AlgorithmName, ModifiedSelector.CacheName, ModifiedSelector.ComparatorName, MSVSS.CurrentModUpdated, MSVSS.WritableFiles, MSVSSHISTORY.BriefCodediffNofile, NetRexxC.TraceAttr, NetRexxC.VerboseAttr, PathConvert.TargetOs, PresentSelector.FilePresence, PropertyFile.Entry.Operation, PropertyFile.Entry.Type, PropertyFile.Unit, PropertySet.BuiltinPropertySetName, Quantifier, Recorder.ActionChoices, Scale.ProportionsAttribute, SizeSelector.ByteUnits, SQLExec.DelimiterType, SQLExec.OnError, Tar.TarCompressionMethod, Tar.TarLongFileMode, TimeComparison, Tstamp.Unit, Type.FileDir, TypeSelector.FileType, Untar.UntarCompressionMethod, WaitFor.Unit, Zip.Duplicate, Zip.UnicodeExtraField, Zip.WhenEmpty
          +
          +
          +
          +
          public abstract class EnumeratedAttribute
          extends java.lang.Object
          + + +

          +Helper class for attributes that can only take one of a fixed list + of values. + +

          See FixCRLF for an + example. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringvalue + +
          +          The selected value in this enumeration.
          +  + + + + + + + + + + + +
          +Constructor Summary
          +protected EnumeratedAttribute() + +
          +          bean constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleancontainsValue(java.lang.String value) + +
          +          Is this value included in the enumeration?
          + intgetIndex() + +
          +           
          +static EnumeratedAttributegetInstance(java.lang.Class clazz, + java.lang.String value) + +
          +          Factory method for instantiating EAs via API in a more + developer friendly way.
          + java.lang.StringgetValue() + +
          +           
          +abstract  java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          + intindexOfValue(java.lang.String value) + +
          +          get the index of a value in this enumeration.
          + voidsetValue(java.lang.String value) + +
          +          Invoked by IntrospectionHelper.
          + java.lang.StringtoString() + +
          +          Convert the value to its string form.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +value

          +
          +protected java.lang.String value
          +
          +
          The selected value in this enumeration. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +EnumeratedAttribute

          +
          +protected EnumeratedAttribute()
          +
          +
          bean constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public abstract java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement. +

          +

          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          +
          + +

          +getInstance

          +
          +public static EnumeratedAttribute getInstance(java.lang.Class clazz,
+                                              java.lang.String value)
+                                       throws BuildException
          +
          +
          Factory method for instantiating EAs via API in a more + developer friendly way. +

          +

          +
          Parameters:
          clazz - Class, extending EA, which to instantiate
          value - The value to set on that EA +
          Returns:
          Configured EA +
          Throws: +
          BuildException - If the class could not be found or the value + is not valid for the given EA-class.
          See Also:
          + http://issues.apache.org/bugzilla/show_bug.cgi?id=14831
          +
          +
          +
          + +

          +setValue

          +
          +public final void setValue(java.lang.String value)
+                    throws BuildException
          +
          +
          Invoked by IntrospectionHelper. +

          +

          +
          Parameters:
          value - the String value of the attribute +
          Throws: +
          BuildException - if the value is not valid for the attribute
          +
          +
          +
          + +

          +containsValue

          +
          +public final boolean containsValue(java.lang.String value)
          +
          +
          Is this value included in the enumeration? +

          +

          +
          Parameters:
          value - the String value to look up +
          Returns:
          true if the value is valid
          +
          +
          +
          + +

          +indexOfValue

          +
          +public final int indexOfValue(java.lang.String value)
          +
          +
          get the index of a value in this enumeration. +

          +

          +
          Parameters:
          value - the string value to look for. +
          Returns:
          the index of the value in the array of strings + or -1 if it cannot be found.
          See Also:
          getValues()
          +
          +
          +
          + +

          +getValue

          +
          +public final java.lang.String getValue()
          +
          +
          + +
          Returns:
          the selected value.
          +
          +
          +
          + +

          +getIndex

          +
          +public final int getIndex()
          +
          +
          + +
          Returns:
          the index of the selected value in the array.
          See Also:
          getValues()
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Convert the value to its string form. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the string form of the value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.Variable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.Variable.html new file mode 100644 index 000000000..f785e39d2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.Variable.html @@ -0,0 +1,419 @@ + + + + + + +Environment.Variable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Environment.Variable

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Environment.Variable
+
          +
          +
          Enclosing class:
          Environment
          +
          +
          +
          +
          public static class Environment.Variable
          extends java.lang.Object
          + + +

          +representation of a single env value +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Environment.Variable() + +
          +          Constructor for variable
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetContent() + +
          +          get the assigment string + This is not ready for insertion into a property file without following + the escaping rules of the properties class.
          + java.lang.StringgetKey() + +
          +          key accessor
          + java.lang.StringgetValue() + +
          +          value accessor
          + voidsetFile(java.io.File file) + +
          +          get the absolute path of a file and assign it to the value
          + voidsetKey(java.lang.String key) + +
          +          set the key
          + voidsetPath(Path path) + +
          +          stringify path and assign to the value.
          + voidsetValue(java.lang.String value) + +
          +          set the value
          + voidvalidate() + +
          +          checks whether all required attributes have been specified.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Environment.Variable

          +
          +public Environment.Variable()
          +
          +
          Constructor for variable +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setKey

          +
          +public void setKey(java.lang.String key)
          +
          +
          set the key +

          +

          +
          Parameters:
          key - string
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(java.lang.String value)
          +
          +
          set the value +

          +

          +
          Parameters:
          value - string value
          +
          +
          +
          + +

          +getKey

          +
          +public java.lang.String getKey()
          +
          +
          key accessor +

          +

          + +
          Returns:
          key
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue()
          +
          +
          value accessor +

          +

          + +
          Returns:
          value
          +
          +
          +
          + +

          +setPath

          +
          +public void setPath(Path path)
          +
          +
          stringify path and assign to the value. + The value will contain all path elements separated by the appropriate + separator +

          +

          +
          Parameters:
          path - path
          +
          +
          +
          + +

          +setFile

          +
          +public void setFile(java.io.File file)
          +
          +
          get the absolute path of a file and assign it to the value +

          +

          +
          Parameters:
          file - file to use as the value
          +
          +
          +
          + +

          +getContent

          +
          +public java.lang.String getContent()
+                            throws BuildException
          +
          +
          get the assigment string + This is not ready for insertion into a property file without following + the escaping rules of the properties class. +

          +

          + +
          Returns:
          a string of the form key=value. +
          Throws: +
          BuildException - if key or value are unassigned
          +
          +
          +
          + +

          +validate

          +
          +public void validate()
          +
          +
          checks whether all required attributes have been specified. +

          +

          + +
          Throws: +
          BuildException - if key or value are unassigned
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.html new file mode 100644 index 000000000..272ca1ac6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Environment.html @@ -0,0 +1,365 @@ + + + + + + +Environment (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Environment

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Environment
+
          +
          +
          Direct Known Subclasses:
          CommandlineJava.SysProperties
          +
          +
          +
          +
          public class Environment
          extends java.lang.Object
          + + +

          +Wrapper for environment variables. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classEnvironment.Variable + +
          +          representation of a single env value
          +  + + + + + + + + + + +
          +Field Summary
          +protected  java.util.Vectorvariables + +
          +          a vector of type Enviromment.Variable
          +  + + + + + + + + + + +
          +Constructor Summary
          Environment() + +
          +          constructor
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddVariable(Environment.Variable var) + +
          +          add a variable.
          + java.lang.String[]getVariables() + +
          +          get the variable list as an array
          + java.util.VectorgetVariablesVector() + +
          +          Get the raw vector of variables.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +variables

          +
          +protected java.util.Vector variables
          +
          +
          a vector of type Enviromment.Variable +

          +

          +
          See Also:
          Environment.Variable
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Environment

          +
          +public Environment()
          +
          +
          constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +addVariable

          +
          +public void addVariable(Environment.Variable var)
          +
          +
          add a variable. + Validity checking is not performed at this point. Duplicates + are not caught either. +

          +

          +
          Parameters:
          var - new variable.
          +
          +
          +
          + +

          +getVariables

          +
          +public java.lang.String[] getVariables()
+                                throws BuildException
          +
          +
          get the variable list as an array +

          +

          + +
          Returns:
          array of key=value assignment strings +
          Throws: +
          BuildException - if any variable is misconfigured
          +
          +
          +
          + +

          +getVariablesVector

          +
          +public java.util.Vector getVariablesVector()
          +
          +
          Get the raw vector of variables. This is not a clone. +

          +

          + +
          Returns:
          a potentially empty (but never null) vector of elements of type + Variable
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.FileName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.FileName.html new file mode 100644 index 000000000..0ad2a445f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.FileName.html @@ -0,0 +1,276 @@ + + + + + + +FileList.FileName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FileList.FileName

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.FileList.FileName
+
          +
          +
          Enclosing class:
          FileList
          +
          +
          +
          +
          public static class FileList.FileName
          extends java.lang.Object
          + + +

          +Inner class corresponding to the <file> nested element. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FileList.FileName() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetName() + +
          +           
          + voidsetName(java.lang.String name) + +
          +          The name attribute of the file element.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileList.FileName

          +
          +public FileList.FileName()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          The name attribute of the file element. +

          +

          +
          Parameters:
          name - the name of a file to add to the file list.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          + +
          Returns:
          the name of the file for this element.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.html new file mode 100644 index 000000000..60c8c7a6c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileList.html @@ -0,0 +1,593 @@ + + + + + + +FileList (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FileList

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.FileList
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class FileList
          extends DataType
          implements ResourceCollection
          + + +

          +FileList represents an explicitly named list of files. FileLists + are useful when you want to capture a list of files regardless of + whether they currently exist. By contrast, FileSet operates as a + filter, only returning the name of a matched file if it currently + exists in the file system. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classFileList.FileName + +
          +          Inner class corresponding to the <file> nested element.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + FileList() + +
          +          The default constructor.
          +protected FileList(FileList filelist) + +
          +          A copy constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredFile(FileList.FileName name) + +
          +          Add a nested <file> nested element.
          + java.io.FilegetDir(Project p) + +
          +           
          + java.lang.String[]getFiles(Project p) + +
          +          Returns the list of files represented by this FileList.
          +protected  FileListgetRef(Project p) + +
          +          Performs the check for circular references and returns the + referenced FileList.
          + booleanisFilesystemOnly() + +
          +          Always returns true.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetDir(java.io.File dir) + +
          +          Set the dir attribute.
          + voidsetFiles(java.lang.String filenames) + +
          +          Set the filenames attribute.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another FileList + instance.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileList

          +
          +public FileList()
          +
          +
          The default constructor. +

          +

          +
          + +

          +FileList

          +
          +protected FileList(FileList filelist)
          +
          +
          A copy constructor. +

          +

          +
          Parameters:
          filelist - a FileList value
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another FileList + instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to another filelist. +
          Throws: +
          BuildException - if an error occurs.
          +
          +
          +
          + +

          +setDir

          +
          +public void setDir(java.io.File dir)
+            throws BuildException
          +
          +
          Set the dir attribute. +

          +

          +
          +
          +
          +
          Parameters:
          dir - the directory this filelist is relative to. +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +getDir

          +
          +public java.io.File getDir(Project p)
          +
          +
          +
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          the directory attribute
          +
          +
          +
          + +

          +setFiles

          +
          +public void setFiles(java.lang.String filenames)
          +
          +
          Set the filenames attribute. +

          +

          +
          +
          +
          +
          Parameters:
          filenames - a string contains filenames, separated by , or + by whitespace.
          +
          +
          +
          + +

          +getFiles

          +
          +public java.lang.String[] getFiles(Project p)
          +
          +
          Returns the list of files represented by this FileList. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          the list of files represented by this FileList.
          +
          +
          +
          + +

          +getRef

          +
          +protected FileList getRef(Project p)
          +
          +
          Performs the check for circular references and returns the + referenced FileList. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          the FileList represented by a referenced filelist.
          +
          +
          +
          + +

          +addConfiguredFile

          +
          +public void addConfiguredFile(FileList.FileName name)
          +
          +
          Add a nested <file> nested element. +

          +

          +
          +
          +
          +
          Parameters:
          name - a configured file element with a name.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Always returns true. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true indicating that all elements will be FileResources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileSet.html new file mode 100644 index 000000000..5e2f143d4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FileSet.html @@ -0,0 +1,428 @@ + + + + + + +FileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          ArchiveFileSet, BCFileSet, ClassfileSet, Javadoc.TagArgument, LibFileSet
          +
          +
          +
          +
          public class FileSet
          extends AbstractFileSet
          implements ResourceCollection
          + + +

          +Moved out of MatchingTask to make it a standalone object that could + be referenced (by scripts for example). +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + FileSet() + +
          +          Constructor for FileSet.
          +protected FileSet(FileSet fileset) + +
          +          Constructor for FileSet, with FileSet to shallowly clone.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +          Return a FileSet that has the same basedir and same patternsets + as this one.
          + booleanisFilesystemOnly() + +
          +          Always returns true.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileSet

          +
          +public FileSet()
          +
          +
          Constructor for FileSet. +

          +

          +
          + +

          +FileSet

          +
          +protected FileSet(FileSet fileset)
          +
          +
          Constructor for FileSet, with FileSet to shallowly clone. +

          +

          +
          Parameters:
          fileset - the fileset to clone
          +
          + + + + + + + + +
          +Method Detail
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Return a FileSet that has the same basedir and same patternsets + as this one. +

          +

          +
          Overrides:
          clone in class AbstractFileSet
          +
          +
          + +
          Returns:
          the cloned fileset
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Always returns true. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true indicating that all elements will be FileResources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterChain.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterChain.html new file mode 100644 index 000000000..c6010087a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterChain.html @@ -0,0 +1,957 @@ + + + + + + +FilterChain (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterChain

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.FilterChain
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          FilterMapper
          +
          +
          +
          +
          public class FilterChain
          extends DataType
          implements java.lang.Cloneable
          + + +

          +FilterChain may contain a chained set of filter readers. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FilterChain() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ChainableReader filter) + +
          +          Add a chainfilter filter.
          + voidaddClassConstants(ClassConstants classConstants) + +
          +          Add a ClassConstants filter.
          + voidaddContainsRegex(TokenFilter.ContainsRegex filter) + +
          +          Add a containsregex filter.
          + voidaddDeleteCharacters(TokenFilter.DeleteCharacters filter) + +
          +          Add a delete characters filter.
          + voidaddEscapeUnicode(EscapeUnicode escapeUnicode) + +
          +          Add an EscapeUnicode filter.
          + voidaddExpandProperties(ExpandProperties expandProperties) + +
          +          Add an ExpandProperties filter.
          + voidaddFilterReader(AntFilterReader filterReader) + +
          +          Add an AntFilterReader filter.
          + voidaddHeadFilter(HeadFilter headFilter) + +
          +          Add a HeadFilter filter.
          + voidaddIgnoreBlank(TokenFilter.IgnoreBlank filter) + +
          +          Add an ignoreBlank filter.
          + voidaddLineContains(LineContains lineContains) + +
          +          Add a LineContains filter.
          + voidaddLineContainsRegExp(LineContainsRegExp lineContainsRegExp) + +
          +          Add a LineContainsRegExp filter.
          + voidaddPrefixLines(PrefixLines prefixLines) + +
          +          Add a PrefixLines filter.
          + voidaddReplaceRegex(TokenFilter.ReplaceRegex filter) + +
          +          Add a replaceregex filter.
          + voidaddReplaceString(TokenFilter.ReplaceString filter) + +
          +          Add a replacestring filter.
          + voidaddReplaceTokens(ReplaceTokens replaceTokens) + +
          +          Add a ReplaceTokens filter.
          + voidaddStripJavaComments(StripJavaComments stripJavaComments) + +
          +          Add a StripJavaCommands filter.
          + voidaddStripLineBreaks(StripLineBreaks stripLineBreaks) + +
          +          Add a StripLineBreaks filter.
          + voidaddStripLineComments(StripLineComments stripLineComments) + +
          +          Add a StripLineComments filter.
          + voidaddSuffixLines(SuffixLines suffixLines) + +
          +          Add a SuffixLines filter.
          + voidaddTabsToSpaces(TabsToSpaces tabsToSpaces) + +
          +          Add a TabsToSpaces filter.
          + voidaddTailFilter(TailFilter tailFilter) + +
          +          Add a TailFilter filter.
          + voidaddTokenFilter(TokenFilter tokenFilter) + +
          +          Add a TokenFilter filter.
          + voidaddTrim(TokenFilter.Trim filter) + +
          +          Add a trim filter.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + java.util.VectorgetFilterReaders() + +
          +          Return the filters.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another FilterChain + instance.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterChain

          +
          +public FilterChain()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addFilterReader

          +
          +public void addFilterReader(AntFilterReader filterReader)
          +
          +
          Add an AntFilterReader filter. +

          +

          +
          +
          +
          +
          Parameters:
          filterReader - an AntFilterReader value
          +
          +
          +
          + +

          +getFilterReaders

          +
          +public java.util.Vector getFilterReaders()
          +
          +
          Return the filters. +

          +

          +
          +
          +
          + +
          Returns:
          a Vector value containing the filters
          +
          +
          +
          + +

          +addClassConstants

          +
          +public void addClassConstants(ClassConstants classConstants)
          +
          +
          Add a ClassConstants filter. +

          +

          +
          +
          +
          +
          Parameters:
          classConstants - a ClassConstants value
          +
          +
          +
          + +

          +addExpandProperties

          +
          +public void addExpandProperties(ExpandProperties expandProperties)
          +
          +
          Add an ExpandProperties filter. +

          +

          +
          +
          +
          +
          Parameters:
          expandProperties - an ExpandProperties value
          +
          +
          +
          + +

          +addHeadFilter

          +
          +public void addHeadFilter(HeadFilter headFilter)
          +
          +
          Add a HeadFilter filter. +

          +

          +
          +
          +
          +
          Parameters:
          headFilter - a HeadFilter value
          +
          +
          +
          + +

          +addLineContains

          +
          +public void addLineContains(LineContains lineContains)
          +
          +
          Add a LineContains filter. +

          +

          +
          +
          +
          +
          Parameters:
          lineContains - a LineContains value
          +
          +
          +
          + +

          +addLineContainsRegExp

          +
          +public void addLineContainsRegExp(LineContainsRegExp lineContainsRegExp)
          +
          +
          Add a LineContainsRegExp filter. +

          +

          +
          +
          +
          +
          Parameters:
          lineContainsRegExp - a LineContainsRegExp value
          +
          +
          +
          + +

          +addPrefixLines

          +
          +public void addPrefixLines(PrefixLines prefixLines)
          +
          +
          Add a PrefixLines filter. +

          +

          +
          +
          +
          +
          Parameters:
          prefixLines - a PrefixLines value
          +
          +
          +
          + +

          +addSuffixLines

          +
          +public void addSuffixLines(SuffixLines suffixLines)
          +
          +
          Add a SuffixLines filter. +

          +

          +
          +
          +
          +
          Parameters:
          suffixLines - a SuffixLines value
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +addReplaceTokens

          +
          +public void addReplaceTokens(ReplaceTokens replaceTokens)
          +
          +
          Add a ReplaceTokens filter. +

          +

          +
          +
          +
          +
          Parameters:
          replaceTokens - a ReplaceTokens value
          +
          +
          +
          + +

          +addStripJavaComments

          +
          +public void addStripJavaComments(StripJavaComments stripJavaComments)
          +
          +
          Add a StripJavaCommands filter. +

          +

          +
          +
          +
          +
          Parameters:
          stripJavaComments - a StripJavaComments value
          +
          +
          +
          + +

          +addStripLineBreaks

          +
          +public void addStripLineBreaks(StripLineBreaks stripLineBreaks)
          +
          +
          Add a StripLineBreaks filter. +

          +

          +
          +
          +
          +
          Parameters:
          stripLineBreaks - a StripLineBreaks value
          +
          +
          +
          + +

          +addStripLineComments

          +
          +public void addStripLineComments(StripLineComments stripLineComments)
          +
          +
          Add a StripLineComments filter. +

          +

          +
          +
          +
          +
          Parameters:
          stripLineComments - a StripLineComments value
          +
          +
          +
          + +

          +addTabsToSpaces

          +
          +public void addTabsToSpaces(TabsToSpaces tabsToSpaces)
          +
          +
          Add a TabsToSpaces filter. +

          +

          +
          +
          +
          +
          Parameters:
          tabsToSpaces - a TabsToSpaces value
          +
          +
          +
          + +

          +addTailFilter

          +
          +public void addTailFilter(TailFilter tailFilter)
          +
          +
          Add a TailFilter filter. +

          +

          +
          +
          +
          +
          Parameters:
          tailFilter - a TailFilter value
          +
          +
          +
          + +

          +addEscapeUnicode

          +
          +public void addEscapeUnicode(EscapeUnicode escapeUnicode)
          +
          +
          Add an EscapeUnicode filter. +

          +

          +
          +
          +
          +
          Parameters:
          escapeUnicode - an EscapeUnicode value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addTokenFilter

          +
          +public void addTokenFilter(TokenFilter tokenFilter)
          +
          +
          Add a TokenFilter filter. +

          +

          +
          +
          +
          +
          Parameters:
          tokenFilter - a TokenFilter value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addDeleteCharacters

          +
          +public void addDeleteCharacters(TokenFilter.DeleteCharacters filter)
          +
          +
          Add a delete characters filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.DeleteCharacters value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addContainsRegex

          +
          +public void addContainsRegex(TokenFilter.ContainsRegex filter)
          +
          +
          Add a containsregex filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.ContainsRegex value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addReplaceRegex

          +
          +public void addReplaceRegex(TokenFilter.ReplaceRegex filter)
          +
          +
          Add a replaceregex filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.ReplaceRegex value
          +
          +
          +
          + +

          +addTrim

          +
          +public void addTrim(TokenFilter.Trim filter)
          +
          +
          Add a trim filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.Trim value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addReplaceString

          +
          +public void addReplaceString(TokenFilter.ReplaceString filter)
          +
          +
          Add a replacestring filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.ReplaceString value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addIgnoreBlank

          +
          +public void addIgnoreBlank(TokenFilter.IgnoreBlank filter)
          +
          +
          Add an ignoreBlank filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a TokenFilter.IgnoreBlank value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another FilterChain + instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to which this instance is associated +
          Throws: +
          BuildException - if this instance already has been configured.
          +
          +
          +
          + +

          +add

          +
          +public void add(ChainableReader filter)
          +
          +
          Add a chainfilter filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - a ChainableReader value
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.Filter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.Filter.html new file mode 100644 index 000000000..5f6872e88 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.Filter.html @@ -0,0 +1,343 @@ + + + + + + +FilterSet.Filter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterSet.Filter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.FilterSet.Filter
+
          +
          +
          Enclosing class:
          FilterSet
          +
          +
          +
          +
          public static class FilterSet.Filter
          extends java.lang.Object
          + + +

          +Individual filter component of filterset. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          FilterSet.Filter() + +
          +          No-argument conmstructor.
          FilterSet.Filter(java.lang.String token, + java.lang.String value) + +
          +          Constructor for the Filter object.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetToken() + +
          +          Gets the Token attribute of the Filter object.
          + java.lang.StringgetValue() + +
          +          Gets the Value attribute of the Filter object.
          + voidsetToken(java.lang.String token) + +
          +          Sets the Token attribute of the Filter object.
          + voidsetValue(java.lang.String value) + +
          +          Sets the Value attribute of the Filter object.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterSet.Filter

          +
          +public FilterSet.Filter(java.lang.String token,
+                        java.lang.String value)
          +
          +
          Constructor for the Filter object. +

          +

          +
          Parameters:
          token - The token which will be replaced when filtering.
          value - The value which will replace the token when filtering.
          +
          +
          + +

          +FilterSet.Filter

          +
          +public FilterSet.Filter()
          +
          +
          No-argument conmstructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setToken

          +
          +public void setToken(java.lang.String token)
          +
          +
          Sets the Token attribute of the Filter object. +

          +

          +
          Parameters:
          token - The new Token value.
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(java.lang.String value)
          +
          +
          Sets the Value attribute of the Filter object. +

          +

          +
          Parameters:
          value - The new Value value.
          +
          +
          +
          + +

          +getToken

          +
          +public java.lang.String getToken()
          +
          +
          Gets the Token attribute of the Filter object. +

          +

          + +
          Returns:
          The Token value.
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue()
          +
          +
          Gets the Value attribute of the Filter object. +

          +

          + +
          Returns:
          The Value value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.FiltersFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.FiltersFile.html new file mode 100644 index 000000000..2e7471602 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.FiltersFile.html @@ -0,0 +1,258 @@ + + + + + + +FilterSet.FiltersFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterSet.FiltersFile

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.FilterSet.FiltersFile
+
          +
          +
          Enclosing class:
          FilterSet
          +
          +
          +
          +
          public class FilterSet.FiltersFile
          extends java.lang.Object
          + + +

          +The filtersfile nested element. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FilterSet.FiltersFile() + +
          +          Constructor for the FiltersFile object.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidsetFile(java.io.File file) + +
          +          Sets the file from which filters will be read.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterSet.FiltersFile

          +
          +public FilterSet.FiltersFile()
          +
          +
          Constructor for the FiltersFile object. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public void setFile(java.io.File file)
          +
          +
          Sets the file from which filters will be read. +

          +

          +
          Parameters:
          file - the file from which filters will be read.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.OnMissing.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.OnMissing.html new file mode 100644 index 000000000..63dd17496 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.OnMissing.html @@ -0,0 +1,384 @@ + + + + + + +FilterSet.OnMissing (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterSet.OnMissing

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.FilterSet.OnMissing
+
          +
          +
          Enclosing class:
          FilterSet
          +
          +
          +
          +
          public static class FilterSet.OnMissing
          extends EnumeratedAttribute
          + + +

          +EnumeratedAttribute to set behavior WRT missing filtersfiles: + "fail" (default), "warn", "ignore". +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static FilterSet.OnMissingFAIL + +
          +          Fail value
          +static FilterSet.OnMissingIGNORE + +
          +          Ignore value
          +static FilterSet.OnMissingWARN + +
          +          Warn value
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          FilterSet.OnMissing() + +
          +          Default constructor.
          FilterSet.OnMissing(java.lang.String value) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +FAIL

          +
          +public static final FilterSet.OnMissing FAIL
          +
          +
          Fail value +

          +

          +
          +
          +
          + +

          +WARN

          +
          +public static final FilterSet.OnMissing WARN
          +
          +
          Warn value +

          +

          +
          +
          +
          + +

          +IGNORE

          +
          +public static final FilterSet.OnMissing IGNORE
          +
          +
          Ignore value +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterSet.OnMissing

          +
          +public FilterSet.OnMissing()
          +
          +
          Default constructor. +

          +

          +
          + +

          +FilterSet.OnMissing

          +
          +public FilterSet.OnMissing(java.lang.String value)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          value - the value to set.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement.. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.html new file mode 100644 index 000000000..692f248ac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSet.html @@ -0,0 +1,898 @@ + + + + + + +FilterSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.FilterSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class FilterSet
          extends DataType
          implements java.lang.Cloneable
          + + +

          +A set of filters to be applied to something. + + A filter set may have begintoken and endtokens defined. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classFilterSet.Filter + +
          +          Individual filter component of filterset.
          + classFilterSet.FiltersFile + +
          +          The filtersfile nested element.
          +static classFilterSet.OnMissing + +
          +          EnumeratedAttribute to set behavior WRT missing filtersfiles: + "fail" (default), "warn", "ignore".
          +  + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_TOKEN_END + +
          +          The default token end string
          +static java.lang.StringDEFAULT_TOKEN_START + +
          +          The default token start string
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + FilterSet() + +
          +          Default constructor.
          +protected FilterSet(FilterSet filterset) + +
          +          Create a Filterset from another filterset.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredFilterSet(FilterSet filterSet) + +
          +          Add a Filterset to this filter set.
          + voidaddFilter(FilterSet.Filter filter) + +
          +          Add a new filter.
          + voidaddFilter(java.lang.String token, + java.lang.String value) + +
          +          Add a new filter made from the given token and value.
          + java.lang.Objectclone() + +
          +          Clone the filterset.
          + FilterSet.FiltersFilecreateFiltersfile() + +
          +          Create a new FiltersFile.
          + java.lang.StringgetBeginToken() + +
          +          Get the begin token for this filterset.
          + java.lang.StringgetEndToken() + +
          +          Get the end token for this filterset.
          + java.util.HashtablegetFilterHash() + +
          +          Gets the filter hash of the FilterSet.
          +protected  java.util.VectorgetFilters() + +
          +          Get the filters in the filter set.
          + FilterSet.OnMissinggetOnMissingFiltersFile() + +
          +          Get the onMissingFiltersFile setting.
          +protected  FilterSetgetRef() + +
          +          Get the referenced filter set.
          + booleanhasFilters() + +
          +          Test to see if this filter set has filters.
          + booleanisRecurse() + +
          +          Get whether recursive token expansion is enabled.
          + voidreadFiltersFromFile(java.io.File filtersFile) + +
          +          Read the filters from the given file.
          + java.lang.StringreplaceTokens(java.lang.String line) + +
          +          Does replacement on the given string with token matching.
          + voidsetBeginToken(java.lang.String startOfToken) + +
          +          Set the string used to id the beginning of a token.
          + voidsetEndToken(java.lang.String endOfToken) + +
          +          Set the string used to id the end of a token.
          + voidsetFiltersfile(java.io.File filtersFile) + +
          +          Set the file containing the filters for this filterset.
          + voidsetOnMissingFiltersFile(FilterSet.OnMissing onMissingFiltersFile) + +
          +          Set the behavior WRT missing filtersfiles.
          + voidsetRecurse(boolean recurse) + +
          +          Set whether recursive token expansion is enabled.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_TOKEN_START

          +
          +public static final java.lang.String DEFAULT_TOKEN_START
          +
          +
          The default token start string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_TOKEN_END

          +
          +public static final java.lang.String DEFAULT_TOKEN_END
          +
          +
          The default token end string +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterSet

          +
          +public FilterSet()
          +
          +
          Default constructor. +

          +

          +
          + +

          +FilterSet

          +
          +protected FilterSet(FilterSet filterset)
          +
          +
          Create a Filterset from another filterset. +

          +

          +
          Parameters:
          filterset - the filterset upon which this filterset will be based.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getFilters

          +
          +protected java.util.Vector getFilters()
          +
          +
          Get the filters in the filter set. +

          +

          +
          +
          +
          + +
          Returns:
          a Vector of Filter instances.
          +
          +
          +
          + +

          +getRef

          +
          +protected FilterSet getRef()
          +
          +
          Get the referenced filter set. +

          +

          +
          +
          +
          + +
          Returns:
          the filterset from the reference.
          +
          +
          +
          + +

          +getFilterHash

          +
          +public java.util.Hashtable getFilterHash()
          +
          +
          Gets the filter hash of the FilterSet. +

          +

          +
          +
          +
          + +
          Returns:
          The hash of the tokens and values for quick lookup.
          +
          +
          +
          + +

          +setFiltersfile

          +
          +public void setFiltersfile(java.io.File filtersFile)
+                    throws BuildException
          +
          +
          Set the file containing the filters for this filterset. +

          +

          +
          +
          +
          +
          Parameters:
          filtersFile - sets the filter file from which to read filters + for this filter set. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +setBeginToken

          +
          +public void setBeginToken(java.lang.String startOfToken)
          +
          +
          Set the string used to id the beginning of a token. +

          +

          +
          +
          +
          +
          Parameters:
          startOfToken - The new Begintoken value.
          +
          +
          +
          + +

          +getBeginToken

          +
          +public java.lang.String getBeginToken()
          +
          +
          Get the begin token for this filterset. +

          +

          +
          +
          +
          + +
          Returns:
          the filter set's begin token for filtering.
          +
          +
          +
          + +

          +setEndToken

          +
          +public void setEndToken(java.lang.String endOfToken)
          +
          +
          Set the string used to id the end of a token. +

          +

          +
          +
          +
          +
          Parameters:
          endOfToken - The new Endtoken value.
          +
          +
          +
          + +

          +getEndToken

          +
          +public java.lang.String getEndToken()
          +
          +
          Get the end token for this filterset. +

          +

          +
          +
          +
          + +
          Returns:
          the filter set's end token for replacement delimiting.
          +
          +
          +
          + +

          +setRecurse

          +
          +public void setRecurse(boolean recurse)
          +
          +
          Set whether recursive token expansion is enabled. +

          +

          +
          +
          +
          +
          Parameters:
          recurse - boolean whether to recurse.
          +
          +
          +
          + +

          +isRecurse

          +
          +public boolean isRecurse()
          +
          +
          Get whether recursive token expansion is enabled. +

          +

          +
          +
          +
          + +
          Returns:
          boolean whether enabled.
          +
          +
          +
          + +

          +readFiltersFromFile

          +
          +public void readFiltersFromFile(java.io.File filtersFile)
+                         throws BuildException
          +
          +
          Read the filters from the given file. +

          +

          +
          +
          +
          +
          Parameters:
          filtersFile - the file from which filters are read. +
          Throws: +
          BuildException - when the file cannot be read.
          +
          +
          +
          + +

          +replaceTokens

          +
          +public java.lang.String replaceTokens(java.lang.String line)
          +
          +
          Does replacement on the given string with token matching. + This uses the defined begintoken and endtoken values which default + to @ for both. + This resets the passedTokens and calls iReplaceTokens to + do the actual replacements. +

          +

          +
          +
          +
          +
          Parameters:
          line - The line in which to process embedded tokens. +
          Returns:
          The input string after token replacement.
          +
          +
          +
          + +

          +addFilter

          +
          +public void addFilter(FilterSet.Filter filter)
          +
          +
          Add a new filter. +

          +

          +
          +
          +
          +
          Parameters:
          filter - the filter to be added.
          +
          +
          +
          + +

          +createFiltersfile

          +
          +public FilterSet.FiltersFile createFiltersfile()
          +
          +
          Create a new FiltersFile. +

          +

          +
          +
          +
          + +
          Returns:
          The filtersfile that was created.
          +
          +
          +
          + +

          +addFilter

          +
          +public void addFilter(java.lang.String token,
+                      java.lang.String value)
          +
          +
          Add a new filter made from the given token and value. +

          +

          +
          +
          +
          +
          Parameters:
          token - The token for the new filter.
          value - The value for the new filter.
          +
          +
          +
          + +

          +addConfiguredFilterSet

          +
          +public void addConfiguredFilterSet(FilterSet filterSet)
          +
          +
          Add a Filterset to this filter set. +

          +

          +
          +
          +
          +
          Parameters:
          filterSet - the filterset to be added to this filterset
          +
          +
          +
          + +

          +hasFilters

          +
          +public boolean hasFilters()
          +
          +
          Test to see if this filter set has filters. +

          +

          +
          +
          +
          + +
          Returns:
          Return true if there are filters in this set.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
+                       throws BuildException
          +
          +
          Clone the filterset. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a deep clone of this filterset. +
          Throws: +
          BuildException - if the clone cannot be performed.
          +
          +
          +
          + +

          +setOnMissingFiltersFile

          +
          +public void setOnMissingFiltersFile(FilterSet.OnMissing onMissingFiltersFile)
          +
          +
          Set the behavior WRT missing filtersfiles. +

          +

          +
          +
          +
          +
          Parameters:
          onMissingFiltersFile - the OnMissing describing the behavior.
          +
          +
          +
          + +

          +getOnMissingFiltersFile

          +
          +public FilterSet.OnMissing getOnMissingFiltersFile()
          +
          +
          Get the onMissingFiltersFile setting. +

          +

          +
          +
          +
          + +
          Returns:
          the OnMissing instance.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSetCollection.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSetCollection.html new file mode 100644 index 000000000..b26abcb12 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FilterSetCollection.html @@ -0,0 +1,319 @@ + + + + + + +FilterSetCollection (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FilterSetCollection

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.FilterSetCollection
+
          +
          +
          +
          public class FilterSetCollection
          extends java.lang.Object
          + + +

          +A FilterSetCollection is a collection of filtersets each of which may have + a different start/end token settings. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          FilterSetCollection() + +
          +          Constructor for a FilterSetCollection.
          FilterSetCollection(FilterSet filterSet) + +
          +          Constructor for a FilterSetCollection.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFilterSet(FilterSet filterSet) + +
          +          Add a filterset to the collection.
          + booleanhasFilters() + +
          +          Test to see if this filter set it empty.
          + java.lang.StringreplaceTokens(java.lang.String line) + +
          +          Does replacement on the given string with token matching.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterSetCollection

          +
          +public FilterSetCollection()
          +
          +
          Constructor for a FilterSetCollection. +

          +

          +
          + +

          +FilterSetCollection

          +
          +public FilterSetCollection(FilterSet filterSet)
          +
          +
          Constructor for a FilterSetCollection. +

          +

          +
          Parameters:
          filterSet - a filterset to start the collection with
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addFilterSet

          +
          +public void addFilterSet(FilterSet filterSet)
          +
          +
          Add a filterset to the collection. +

          +

          +
          Parameters:
          filterSet - a FilterSet value
          +
          +
          +
          + +

          +replaceTokens

          +
          +public java.lang.String replaceTokens(java.lang.String line)
          +
          +
          Does replacement on the given string with token matching. + This uses the defined begintoken and endtoken values which default to @ for both. +

          +

          +
          Parameters:
          line - The line to process the tokens in. +
          Returns:
          The string with the tokens replaced.
          +
          +
          +
          + +

          +hasFilters

          +
          +public boolean hasFilters()
          +
          +
          Test to see if this filter set it empty. +

          +

          + +
          Returns:
          Return true if there are filter in this set otherwise false.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FlexInteger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FlexInteger.html new file mode 100644 index 000000000..0544c7351 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/FlexInteger.html @@ -0,0 +1,287 @@ + + + + + + +FlexInteger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class FlexInteger

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.FlexInteger
+
          +
          +
          +
          public class FlexInteger
          extends java.lang.Object
          + + +

          +Helper class which can be used for Ant task attribute setter methods to allow + the build file to specify an integer in either decimal, octal, or hexadecimal + format. +

          + +

          +

          +
          See Also:
          Integer.decode(String)
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FlexInteger(java.lang.String value) + +
          +          Constructor used by Ant's introspection mechanism for attribute population
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intintValue() + +
          +          Returns the decimal integer value
          + java.lang.StringtoString() + +
          +          Overridden method to return the decimal value for display
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FlexInteger

          +
          +public FlexInteger(java.lang.String value)
          +
          +
          Constructor used by Ant's introspection mechanism for attribute population +

          +

          +
          Parameters:
          value - the value to decode
          +
          + + + + + + + + +
          +Method Detail
          + +

          +intValue

          +
          +public int intValue()
          +
          +
          Returns the decimal integer value +

          +

          + +
          Returns:
          the integer value
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Overridden method to return the decimal value for display +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          a string version of the integer
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/LogLevel.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/LogLevel.html new file mode 100644 index 000000000..68dc42085 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/LogLevel.html @@ -0,0 +1,422 @@ + + + + + + +LogLevel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class LogLevel

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.LogLevel
+
          +
          +
          Direct Known Subclasses:
          Echo.EchoLevel, Recorder.VerbosityLevelChoices
          +
          +
          +
          +
          public class LogLevel
          extends EnumeratedAttribute
          + + +

          +The enumerated values for Ant's log level. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static LogLevelDEBUG + +
          +          DEBUG loglevel constant.
          +static LogLevelERR + +
          +          ERR loglevel constant.
          +static LogLevelINFO + +
          +          INFO loglevel constant.
          +static LogLevelVERBOSE + +
          +          VERBOSE loglevel constant.
          +static LogLevelWARN + +
          +          WARN loglevel constant.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          LogLevel() + +
          +          Public constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetLevel() + +
          +          get the level of the echo of the current value
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ERR

          +
          +public static final LogLevel ERR
          +
          +
          ERR loglevel constant. +

          +

          +
          +
          +
          + +

          +WARN

          +
          +public static final LogLevel WARN
          +
          +
          WARN loglevel constant. +

          +

          +
          +
          +
          + +

          +INFO

          +
          +public static final LogLevel INFO
          +
          +
          INFO loglevel constant. +

          +

          +
          +
          +
          + +

          +VERBOSE

          +
          +public static final LogLevel VERBOSE
          +
          +
          VERBOSE loglevel constant. +

          +

          +
          +
          +
          + +

          +DEBUG

          +
          +public static final LogLevel DEBUG
          +
          +
          DEBUG loglevel constant. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +LogLevel

          +
          +public LogLevel()
          +
          +
          Public constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the strings allowed for the level attribute
          See Also:
          EnumeratedAttribute.getValues()
          +
          +
          +
          + +

          +getLevel

          +
          +public int getLevel()
          +
          +
          get the level of the echo of the current value +

          +

          + +
          Returns:
          the level
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.MapperType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.MapperType.html new file mode 100644 index 000000000..ddffdd435 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.MapperType.html @@ -0,0 +1,311 @@ + + + + + + +Mapper.MapperType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Mapper.MapperType

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.Mapper.MapperType
+
          +
          +
          Enclosing class:
          Mapper
          +
          +
          +
          +
          public static class Mapper.MapperType
          extends EnumeratedAttribute
          + + +

          +Class as Argument to FileNameMapper.setType. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          Mapper.MapperType() + +
          +          Constructor for the MapperType enumeration
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetImplementation() + +
          +           
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Mapper.MapperType

          +
          +public Mapper.MapperType()
          +
          +
          Constructor for the MapperType enumeration +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the filenamemapper names
          +
          +
          +
          + +

          +getImplementation

          +
          +public java.lang.String getImplementation()
          +
          +
          + +
          Returns:
          the classname for the filenamemapper name
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.html new file mode 100644 index 000000000..7002a2fdd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Mapper.html @@ -0,0 +1,763 @@ + + + + + + +Mapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Mapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Mapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Mapper
          extends DataType
          implements java.lang.Cloneable
          + + +

          +Element to define a FileNameMapper. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classMapper.MapperType + +
          +          Class as Argument to FileNameMapper.setType.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringclassname + +
          +           
          +protected  Pathclasspath + +
          +           
          +protected  java.lang.Stringfrom + +
          +           
          +protected  java.lang.Stringto + +
          +           
          +protected  Mapper.MapperTypetype + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Mapper(Project p) + +
          +          Construct a new Mapper element.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileNameMapper fileNameMapper) + +
          +          Add a nested FileNameMapper.
          + voidaddConfigured(FileNameMapper fileNameMapper) + +
          +          Cannot mix add and addconfigured in same type, so + provide this to override the add method.
          + voidaddConfiguredMapper(Mapper mapper) + +
          +          Add a Mapper
          + PathcreateClasspath() + +
          +          Set the classpath to load the FileNameMapper through (nested element).
          + FileNameMappergetImplementation() + +
          +          Returns a fully configured FileNameMapper implementation.
          +protected  java.lang.ClassgetImplementationClass() + +
          +          Gets the Class object associated with the mapper implementation.
          +protected  MappergetRef() + +
          +          Deprecated. since Ant 1.7.1 because a mapper might ref a + FileNameMapper implementation directly.
          + voidsetClassname(java.lang.String classname) + +
          +          Set the class name of the FileNameMapper to use.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to load the FileNameMapper through (attribute).
          + voidsetClasspathRef(Reference ref) + +
          +          Set the classpath to load the FileNameMapper through via + reference (attribute).
          + voidsetFrom(java.lang.String from) + +
          +          Set the argument to FileNameMapper.setFrom
          + voidsetRefid(Reference r) + +
          +          Make this Mapper instance a reference to another Mapper.
          + voidsetTo(java.lang.String to) + +
          +          Set the argument to FileNameMapper.setTo
          + voidsetType(Mapper.MapperType type) + +
          +          Set the type of FileNameMapper to use.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +type

          +
          +protected Mapper.MapperType type
          +
          +
          +
          +
          +
          + +

          +classname

          +
          +protected java.lang.String classname
          +
          +
          +
          +
          +
          + +

          +classpath

          +
          +protected Path classpath
          +
          +
          +
          +
          +
          + +

          +from

          +
          +protected java.lang.String from
          +
          +
          +
          +
          +
          + +

          +to

          +
          +protected java.lang.String to
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Mapper

          +
          +public Mapper(Project p)
          +
          +
          Construct a new Mapper element. +

          +

          +
          Parameters:
          p - the owning Ant Project.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setType

          +
          +public void setType(Mapper.MapperType type)
          +
          +
          Set the type of FileNameMapper to use. +

          +

          +
          +
          +
          +
          Parameters:
          type - the MapperType enumerated attribute.
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(FileNameMapper fileNameMapper)
          +
          +
          Cannot mix add and addconfigured in same type, so + provide this to override the add method. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - the FileNameMapper to add.
          +
          +
          +
          + +

          +add

          +
          +public void add(FileNameMapper fileNameMapper)
          +
          +
          Add a nested FileNameMapper. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - the FileNameMapper to add.
          +
          +
          +
          + +

          +addConfiguredMapper

          +
          +public void addConfiguredMapper(Mapper mapper)
          +
          +
          Add a Mapper +

          +

          +
          +
          +
          +
          Parameters:
          mapper - the mapper to add
          +
          +
          +
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String classname)
          +
          +
          Set the class name of the FileNameMapper to use. +

          +

          +
          +
          +
          +
          Parameters:
          classname - the name of the class
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to load the FileNameMapper through (attribute). +

          +

          +
          +
          +
          +
          Parameters:
          classpath - the classpath
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Set the classpath to load the FileNameMapper through (nested element). +

          +

          +
          +
          +
          + +
          Returns:
          a path object to be configured
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference ref)
          +
          +
          Set the classpath to load the FileNameMapper through via + reference (attribute). +

          +

          +
          +
          +
          +
          Parameters:
          ref - the reference to the FileNameMapper
          +
          +
          +
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Set the argument to FileNameMapper.setFrom +

          +

          +
          +
          +
          +
          Parameters:
          from - the from attribute to pass to the FileNameMapper
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Set the argument to FileNameMapper.setTo +

          +

          +
          +
          +
          +
          Parameters:
          to - the to attribute to pass to the FileNameMapper
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Make this Mapper instance a reference to another Mapper. + +

          You must not set any other attribute if you make it a + reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to another mapper +
          Throws: +
          BuildException - if other attributes are set
          +
          +
          +
          + +

          +getImplementation

          +
          +public FileNameMapper getImplementation()
+                                 throws BuildException
          +
          +
          Returns a fully configured FileNameMapper implementation. +

          +

          +
          +
          +
          + +
          Returns:
          a FileNameMapper object to be configured +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getImplementationClass

          +
          +protected java.lang.Class getImplementationClass()
+                                          throws java.lang.ClassNotFoundException
          +
          +
          Gets the Class object associated with the mapper implementation. +

          +

          +
          +
          +
          + +
          Returns:
          Class. +
          Throws: +
          java.lang.ClassNotFoundException - if the class cannot be found
          +
          +
          +
          + +

          +getRef

          +
          +protected Mapper getRef()
          +
          +
          Deprecated. since Ant 1.7.1 because a mapper might ref a + FileNameMapper implementation directly. +

          +

          Performs the check for circular references and returns the + referenced Mapper. +

          +

          +
          +
          +
          + +
          Returns:
          the referenced Mapper
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameter.html new file mode 100644 index 000000000..7bd2dd460 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameter.html @@ -0,0 +1,361 @@ + + + + + + +Parameter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Parameter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Parameter
+
          +
          +
          +
          public final class Parameter
          extends java.lang.Object
          + + +

          +A parameter is composed of a name, type and value. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Parameter() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetName() + +
          +          Get the name attribute.
          + java.lang.StringgetType() + +
          +          Get the type attribute.
          + java.lang.StringgetValue() + +
          +          Get the value attribute.
          + voidsetName(java.lang.String name) + +
          +          Set the name attribute.
          + voidsetType(java.lang.String type) + +
          +          Set the type attribute.
          + voidsetValue(java.lang.String value) + +
          +          Set the value attribute.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Parameter

          +
          +public Parameter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set the name attribute. +

          +

          +
          Parameters:
          name - a String value
          +
          +
          +
          + +

          +setType

          +
          +public void setType(java.lang.String type)
          +
          +
          Set the type attribute. +

          +

          +
          Parameters:
          type - a String value
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(java.lang.String value)
          +
          +
          Set the value attribute. +

          +

          +
          Parameters:
          value - a String value
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name attribute. +

          +

          + +
          Returns:
          a String value
          +
          +
          +
          + +

          +getType

          +
          +public java.lang.String getType()
          +
          +
          Get the type attribute. +

          +

          + +
          Returns:
          a String value
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue()
          +
          +
          Get the value attribute. +

          +

          + +
          Returns:
          a String value
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameterizable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameterizable.html new file mode 100644 index 000000000..439385295 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Parameterizable.html @@ -0,0 +1,213 @@ + + + + + + +Parameterizable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Interface Parameterizable

          +
          +
          All Known Subinterfaces:
          ExtendFileSelector
          +
          +
          +
          All Known Implementing Classes:
          BaseExtendSelector, BaseParamFilterReader, ConcatFilter, ContainsRegexpSelector, ContainsSelector, DateSelector, DepthSelector, EscapeUnicode, FilenameSelector, FixCrLfFilter, HeadFilter, LineContains, LineContainsRegExp, ModifiedSelector, PrefixLines, ReplaceTokens, SizeSelector, SortFilter, StripLineBreaks, StripLineComments, SuffixLines, TabsToSpaces, TailFilter, TypeSelector
          +
          +
          +
          +
          public interface Parameterizable
          + + +

          +Parameterizable objects take genric key value pairs. +

          + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidsetParameters(Parameter[] parameters) + +
          +          Set the parameters
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setParameters

          +
          +void setParameters(Parameter[] parameters)
          +
          +
          Set the parameters +

          +

          +
          Parameters:
          parameters - an array of name/type/value parameters.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.PathElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.PathElement.html new file mode 100644 index 000000000..327db6a50 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.PathElement.html @@ -0,0 +1,386 @@ + + + + + + +Path.PathElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Path.PathElement

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Path.PathElement
+
          +
          +
          All Implemented Interfaces:
          ResourceCollection
          +
          +
          +
          Enclosing class:
          Path
          +
          +
          +
          +
          public class Path.PathElement
          extends java.lang.Object
          implements ResourceCollection
          + + +

          +Helper class, holds the nested <pathelement> values. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Path.PathElement() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getParts() + +
          +          Return the converted pathelements.
          + booleanisFilesystemOnly() + +
          +          Check if this resource is only for filesystems.
          + java.util.Iteratoriterator() + +
          +          Create an iterator.
          + voidsetLocation(java.io.File loc) + +
          +          Set the location.
          + voidsetPath(java.lang.String path) + +
          +          Set the path.
          + intsize() + +
          +          Get the number of resources.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Path.PathElement

          +
          +public Path.PathElement()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLocation

          +
          +public void setLocation(java.io.File loc)
          +
          +
          Set the location. +

          +

          +
          +
          +
          +
          Parameters:
          loc - a File value
          +
          +
          +
          + +

          +setPath

          +
          +public void setPath(java.lang.String path)
          +
          +
          Set the path. +

          +

          +
          +
          +
          +
          Parameters:
          path - a String value
          +
          +
          +
          + +

          +getParts

          +
          +public java.lang.String[] getParts()
          +
          +
          Return the converted pathelements. +

          +

          +
          +
          +
          + +
          Returns:
          a String[] value
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Create an iterator. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an iterator.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Check if this resource is only for filesystems. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Get the number of resources. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          the number of parts.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.html new file mode 100644 index 000000000..c97a20d41 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Path.html @@ -0,0 +1,1246 @@ + + + + + + +Path (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Path

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Path
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Path
          extends DataType
          implements java.lang.Cloneable, ResourceCollection
          + + +

          +This object represents a path as used by CLASSPATH or PATH + environment variable. A path might also be described as a collection + of unique filesystem resources. +

          + + <sometask>
          +   <somepath>
          +     <pathelement location="/path/to/file.jar" />
          +     <pathelement + path="/path/to/file2.jar:/path/to/class2;/path/to/class3" /> +
          +     <pathelement location="/path/to/file3.jar" />
          +     <pathelement location="/path/to/file4.jar" />
          +   </somepath>
          + </sometask>
          +           +

          + The object implemention sometask must provide a method called + createSomepath which returns an instance of Path. + Nested path definitions are handled by the Path object and must be labeled + pathelement.

          + + The path element takes a parameter path which will be parsed + and split into single elements. It will usually be used + to define a path from an environment variable. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          + classPath.PathElement + +
          +          Helper class, holds the nested <pathelement> values.
          +  + + + + + + + + + + + + + + +
          +Field Summary
          +static PathsystemBootClasspath + +
          +          The system bootclasspath as a Path object.
          +static PathsystemClasspath + +
          +          The system classpath as a Path object
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Path(Project project) + +
          +          Construct an empty Path.
          Path(Project p, + java.lang.String path) + +
          +          Invoked by IntrospectionHelper for setXXX(Path p) + attribute setters.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(Path path) + +
          +          Adds a nested path
          + voidadd(ResourceCollection c) + +
          +          Add a nested ResourceCollection.
          + voidaddDirset(DirSet dset) + +
          +          Adds a nested <dirset> element.
          + voidaddExisting(Path source) + +
          +          Adds the components on the given path which exist to this + Path.
          + voidaddExisting(Path source, + boolean tryUserDir) + +
          +          Same as addExisting, but support classpath behavior if tryUserDir + is true.
          + voidaddExtdirs(Path extdirs) + +
          +          Emulation of extdirs feature in java >= 1.2.
          + voidaddFilelist(FileList fl) + +
          +          Adds a nested <filelist> element.
          + voidaddFileset(FileSet fs) + +
          +          Adds a nested <fileset> element.
          + voidaddJavaRuntime() + +
          +          Add the Java Runtime classes to this Path instance.
          + voidappend(Path other) + +
          +          Append the contents of the other Path instance to this.
          +protected  ResourceCollectionassertFilesystemOnly(ResourceCollection rc) + +
          +          Verify the specified ResourceCollection is filesystem-only.
          + java.lang.Objectclone() + +
          +          Clone this Path.
          + PathconcatSystemBootClasspath(java.lang.String defValue) + +
          +          Concatenates the system boot class path in the order specified + by the ${build.sysclasspath} property - using the supplied + value if ${build.sysclasspath} has not been set.
          + PathconcatSystemClasspath() + +
          +          Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using "last" as + default value.
          + PathconcatSystemClasspath(java.lang.String defValue) + +
          +          Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using the supplied value + if ${build.sysclasspath} has not been set.
          + PathcreatePath() + +
          +          Creates a nested <path> element.
          + Path.PathElementcreatePathElement() + +
          +          Creates the nested <pathelement> element.
          +protected  booleandelegateIteratorToList() + +
          +          Helps determine whether to preserve BC by calling list() on subclasses.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.String[]list() + +
          +          Returns all path elements defined by this and nested path objects.
          + voidsetCache(boolean b) + +
          +          Whether to cache the current path.
          + voidsetLocation(java.io.File location) + +
          +          Adds a element definition to the path.
          + voidsetPath(java.lang.String path) + +
          +          Parses a path definition and creates single PathElements.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another Path instance.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Returns a textual representation of the path, which can be used as + CLASSPATH or PATH environment variable definition.
          +static java.lang.StringtranslateFile(java.lang.String source) + +
          +          Returns its argument with all file separator characters + replaced so that they match the local OS conventions.
          +protected static booleantranslateFileSep(java.lang.StringBuffer buffer, + int pos) + +
          +          Translates occurrences at a position of / or \ to correct separator of the + current platform and returns whether it had to do a + replacement.
          +static java.lang.String[]translatePath(Project project, + java.lang.String source) + +
          +          Splits a PATH (with : or ; as separators) into its parts.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +systemClasspath

          +
          +public static Path systemClasspath
          +
          +
          The system classpath as a Path object +

          +

          +
          +
          +
          + +

          +systemBootClasspath

          +
          +public static Path systemBootClasspath
          +
          +
          The system bootclasspath as a Path object. +

          +

          +
          Since:
          +
          Ant 1.6.2
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Path

          +
          +public Path(Project p,
+            java.lang.String path)
          +
          +
          Invoked by IntrospectionHelper for setXXX(Path p) + attribute setters. +

          +

          +
          Parameters:
          p - the Project for this path.
          path - the String path definition.
          +
          +
          + +

          +Path

          +
          +public Path(Project project)
          +
          +
          Construct an empty Path. +

          +

          +
          Parameters:
          project - the Project for this path.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLocation

          +
          +public void setLocation(java.io.File location)
+                 throws BuildException
          +
          +
          Adds a element definition to the path. +

          +

          +
          +
          +
          +
          Parameters:
          location - the location of the element to add (must not be + null nor empty. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setPath

          +
          +public void setPath(java.lang.String path)
+             throws BuildException
          +
          +
          Parses a path definition and creates single PathElements. +

          +

          +
          +
          +
          +
          Parameters:
          path - the String path definition. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another Path instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to another Path +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +createPathElement

          +
          +public Path.PathElement createPathElement()
+                                   throws BuildException
          +
          +
          Creates the nested <pathelement> element. +

          +

          +
          +
          +
          + +
          Returns:
          the PathElement to be configured +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +addFileset

          +
          +public void addFileset(FileSet fs)
+                throws BuildException
          +
          +
          Adds a nested <fileset> element. +

          +

          +
          +
          +
          +
          Parameters:
          fs - a FileSet to be added to the path +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +addFilelist

          +
          +public void addFilelist(FileList fl)
+                 throws BuildException
          +
          +
          Adds a nested <filelist> element. +

          +

          +
          +
          +
          +
          Parameters:
          fl - a FileList to be added to the path +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +addDirset

          +
          +public void addDirset(DirSet dset)
+               throws BuildException
          +
          +
          Adds a nested <dirset> element. +

          +

          +
          +
          +
          +
          Parameters:
          dset - a DirSet to be added to the path +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +add

          +
          +public void add(Path path)
+         throws BuildException
          +
          +
          Adds a nested path +

          +

          +
          +
          +
          +
          Parameters:
          path - a Path to be added to the path +
          Throws: +
          BuildException - on error
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection c)
          +
          +
          Add a nested ResourceCollection. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +createPath

          +
          +public Path createPath()
+                throws BuildException
          +
          +
          Creates a nested <path> element. +

          +

          +
          +
          +
          + +
          Returns:
          a Path to be configured +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +append

          +
          +public void append(Path other)
          +
          +
          Append the contents of the other Path instance to this. +

          +

          +
          +
          +
          +
          Parameters:
          other - a Path to be added to the path
          +
          +
          +
          + +

          +addExisting

          +
          +public void addExisting(Path source)
          +
          +
          Adds the components on the given path which exist to this + Path. Components that don't exist aren't added. +

          +

          +
          +
          +
          +
          Parameters:
          source - - source path whose components are examined for existence
          +
          +
          +
          + +

          +addExisting

          +
          +public void addExisting(Path source,
+                        boolean tryUserDir)
          +
          +
          Same as addExisting, but support classpath behavior if tryUserDir + is true. Classpaths are relative to user dir, not the project base. + That used to break jspc test +

          +

          +
          +
          +
          +
          Parameters:
          source - the source path
          tryUserDir - if true try the user directory if the file is not present
          +
          +
          +
          + +

          +setCache

          +
          +public void setCache(boolean b)
          +
          +
          Whether to cache the current path. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +list

          +
          +public java.lang.String[] list()
          +
          +
          Returns all path elements defined by this and nested path objects. +

          +

          +
          +
          +
          + +
          Returns:
          list of path elements.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Returns a textual representation of the path, which can be used as + CLASSPATH or PATH environment variable definition. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a textual representation of the path.
          +
          +
          +
          + +

          +translatePath

          +
          +public static java.lang.String[] translatePath(Project project,
+                                               java.lang.String source)
          +
          +
          Splits a PATH (with : or ; as separators) into its parts. +

          +

          +
          +
          +
          +
          Parameters:
          project - the project to use
          source - a String value +
          Returns:
          an array of strings, one for each path element
          +
          +
          +
          + +

          +translateFile

          +
          +public static java.lang.String translateFile(java.lang.String source)
          +
          +
          Returns its argument with all file separator characters + replaced so that they match the local OS conventions. +

          +

          +
          +
          +
          +
          Parameters:
          source - the path to convert +
          Returns:
          the converted path
          +
          +
          +
          + +

          +translateFileSep

          +
          +protected static boolean translateFileSep(java.lang.StringBuffer buffer,
+                                          int pos)
          +
          +
          Translates occurrences at a position of / or \ to correct separator of the + current platform and returns whether it had to do a + replacement. +

          +

          +
          +
          +
          +
          Parameters:
          buffer - a buffer containing a string
          pos - the position in the string buffer to convert +
          Returns:
          true if the character was a / or \
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Clone this Path. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          Path with shallowly cloned Resource children.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +concatSystemClasspath

          +
          +public Path concatSystemClasspath()
          +
          +
          Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using "last" as + default value. +

          +

          +
          +
          +
          + +
          Returns:
          the concatenated path
          +
          +
          +
          + +

          +concatSystemClasspath

          +
          +public Path concatSystemClasspath(java.lang.String defValue)
          +
          +
          Concatenates the system class path in the order specified by + the ${build.sysclasspath} property - using the supplied value + if ${build.sysclasspath} has not been set. +

          +

          +
          +
          +
          +
          Parameters:
          defValue - the order ("first", "last", "only") +
          Returns:
          the concatenated path
          +
          +
          +
          + +

          +concatSystemBootClasspath

          +
          +public Path concatSystemBootClasspath(java.lang.String defValue)
          +
          +
          Concatenates the system boot class path in the order specified + by the ${build.sysclasspath} property - using the supplied + value if ${build.sysclasspath} has not been set. +

          +

          +
          +
          +
          +
          Parameters:
          defValue - the order ("first", "last", "only") +
          Returns:
          the concatenated path
          +
          +
          +
          + +

          +addJavaRuntime

          +
          +public void addJavaRuntime()
          +
          +
          Add the Java Runtime classes to this Path instance. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +addExtdirs

          +
          +public void addExtdirs(Path extdirs)
          +
          +
          Emulation of extdirs feature in java >= 1.2. + This method adds all files in the given + directories (but not in sub-directories!) to the classpath, + so that you don't have to specify them all one by one. +

          +

          +
          +
          +
          +
          Parameters:
          extdirs - - Path to append files to
          +
          +
          +
          + +

          +iterator

          +
          +public final java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. The Iterator returned + will throw ConcurrentModificationExceptions if ResourceCollections + are added to this container while the Iterator is in use. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          a "fail-fast" Iterator.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +assertFilesystemOnly

          +
          +protected ResourceCollection assertFilesystemOnly(ResourceCollection rc)
          +
          +
          Verify the specified ResourceCollection is filesystem-only. +

          +

          +
          +
          +
          +
          Parameters:
          rc - the ResourceCollection to check. +
          Returns:
          the passed in ResourceCollection. +
          Throws: +
          BuildException - if rc is not filesystem-only.
          +
          +
          +
          + +

          +delegateIteratorToList

          +
          +protected boolean delegateIteratorToList()
          +
          +
          Helps determine whether to preserve BC by calling list() on subclasses. + The default behavior of this method is to return true for any subclass + that implements list(); this can, of course, be avoided by overriding + this method to return false. It is not expected that the result of this + method should change over time, thus it is called only once. +

          +

          +
          +
          +
          + +
          Returns:
          true if iterator() should delegate to list().
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.NameEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.NameEntry.html new file mode 100644 index 000000000..2dc999222 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.NameEntry.html @@ -0,0 +1,436 @@ + + + + + + +PatternSet.NameEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class PatternSet.NameEntry

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.PatternSet.NameEntry
+
          +
          +
          Enclosing class:
          PatternSet
          +
          +
          +
          +
          public class PatternSet.NameEntry
          extends java.lang.Object
          + + +

          +inner class to hold a name on list. "If" and "Unless" attributes + may be used to invalidate the entry based on the existence of a + property (typically set thru the use of the Available task) + or value of an expression. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          PatternSet.NameEntry() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringevalName(Project p) + +
          +          This validates the name - checks the if and unless + properties.
          + java.lang.StringgetName() + +
          +           
          + voidsetIf(java.lang.Object cond) + +
          +          Sets the if attribute.
          + voidsetIf(java.lang.String cond) + +
          +          Sets the if attribute.
          + voidsetName(java.lang.String name) + +
          +          Sets the name pattern.
          + voidsetUnless(java.lang.Object cond) + +
          +          Sets the unless attribute.
          + voidsetUnless(java.lang.String cond) + +
          +          Sets the unless attribute.
          + java.lang.StringtoString() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PatternSet.NameEntry

          +
          +public PatternSet.NameEntry()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Sets the name pattern. +

          +

          +
          Parameters:
          name - The pattern string.
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.Object cond)
          +
          +
          Sets the if attribute. This attribute and the "unless" + attribute are used to validate the name, based on the + existence of the property or the value of the evaluated + property expression. +

          +

          +
          Parameters:
          cond - A property name or expression. If the + expression evaluates to false or no property of + its value is present, the name is invalid.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.String cond)
          +
          +
          Sets the if attribute. This attribute and the "unless" + attribute are used to validate the name, based on the + existence of the property or the value of the evaluated + property expression. +

          +

          +
          Parameters:
          cond - A property name or expression. If the + expression evaluates to false or no property of + its value is present, the name is invalid.
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.Object cond)
          +
          +
          Sets the unless attribute. This attribute and the "if" + attribute are used to validate the name, based on the + existence of the property or the value of the evaluated + property expression. +

          +

          +
          Parameters:
          cond - A property name or expression. If the + expression evaluates to true or a property of + its value is present, the name is invalid.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.String cond)
          +
          +
          Sets the unless attribute. This attribute and the "if" + attribute are used to validate the name, based on the + existence of the property or the value of the evaluated + property expression. +

          +

          +
          Parameters:
          cond - A property name or expression. If the + expression evaluates to true or a property of + its value is present, the name is invalid.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          + +
          Returns:
          the name attribute.
          +
          +
          +
          + +

          +evalName

          +
          +public java.lang.String evalName(Project p)
          +
          +
          This validates the name - checks the if and unless + properties. +

          +

          +
          Parameters:
          p - the current project, used to check the presence or + absence of a property. +
          Returns:
          the name attribute or null if the "if" or "unless" + properties are not/are set.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          a printable form of this object.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.html new file mode 100644 index 000000000..1f8039c19 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PatternSet.html @@ -0,0 +1,741 @@ + + + + + + +PatternSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class PatternSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.PatternSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class PatternSet
          extends DataType
          implements java.lang.Cloneable
          + + +

          +Named collection of include/exclude tags. + +

          Moved out of MatchingTask to make it a standalone object that + could be referenced (by scripts for example). +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          + classPatternSet.NameEntry + +
          +          inner class to hold a name on list.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          PatternSet() + +
          +          Creates a new PatternSet instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredInvert(PatternSet p) + +
          +          Add an inverted patternset.
          + voidaddConfiguredPatternset(PatternSet p) + +
          +          This is a patternset nested element.
          + voidappend(PatternSet other, + Project p) + +
          +          Adds the patterns of the other instance to this set.
          + java.lang.Objectclone() + +
          +           
          + PatternSet.NameEntrycreateExclude() + +
          +          add a name entry on the exclude list
          + PatternSet.NameEntrycreateExcludesFile() + +
          +          add a name entry on the exclude files list
          + PatternSet.NameEntrycreateInclude() + +
          +          add a name entry on the include list
          + PatternSet.NameEntrycreateIncludesFile() + +
          +          add a name entry on the include files list
          + java.lang.String[]getExcludePatterns(Project p) + +
          +          Returns the filtered include patterns.
          + java.lang.String[]getIncludePatterns(Project p) + +
          +          Returns the filtered include patterns.
          + booleanhasPatterns(Project p) + +
          +          Helper for FileSet classes.
          + voidsetExcludes(java.lang.String excludes) + +
          +          Appends excludes to the current list of exclude patterns.
          + voidsetExcludesfile(java.io.File excludesFile) + +
          +          Sets the name of the file containing the excludes patterns.
          + voidsetIncludes(java.lang.String includes) + +
          +          Appends includes to the current list of include patterns.
          + voidsetIncludesfile(java.io.File includesFile) + +
          +          Sets the name of the file containing the includes patterns.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another PatternSet + instance.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PatternSet

          +
          +public PatternSet()
          +
          +
          Creates a new PatternSet instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another PatternSet + instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to another patternset. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +addConfiguredPatternset

          +
          +public void addConfiguredPatternset(PatternSet p)
          +
          +
          This is a patternset nested element. +

          +

          +
          +
          +
          +
          Parameters:
          p - a configured patternset nested element.
          +
          +
          +
          + +

          +createInclude

          +
          +public PatternSet.NameEntry createInclude()
          +
          +
          add a name entry on the include list +

          +

          +
          +
          +
          + +
          Returns:
          a nested include element to be configured.
          +
          +
          +
          + +

          +createIncludesFile

          +
          +public PatternSet.NameEntry createIncludesFile()
          +
          +
          add a name entry on the include files list +

          +

          +
          +
          +
          + +
          Returns:
          a nested includesfile element to be configured.
          +
          +
          +
          + +

          +createExclude

          +
          +public PatternSet.NameEntry createExclude()
          +
          +
          add a name entry on the exclude list +

          +

          +
          +
          +
          + +
          Returns:
          a nested exclude element to be configured.
          +
          +
          +
          + +

          +createExcludesFile

          +
          +public PatternSet.NameEntry createExcludesFile()
          +
          +
          add a name entry on the exclude files list +

          +

          +
          +
          +
          + +
          Returns:
          a nested excludesfile element to be configured.
          +
          +
          +
          + +

          +setIncludes

          +
          +public void setIncludes(java.lang.String includes)
          +
          +
          Appends includes to the current list of include patterns. + Patterns may be separated by a comma or a space. +

          +

          +
          +
          +
          +
          Parameters:
          includes - the string containing the include patterns
          +
          +
          +
          + +

          +setExcludes

          +
          +public void setExcludes(java.lang.String excludes)
          +
          +
          Appends excludes to the current list of exclude patterns. + Patterns may be separated by a comma or a space. +

          +

          +
          +
          +
          +
          Parameters:
          excludes - the string containing the exclude patterns
          +
          +
          +
          + +

          +setIncludesfile

          +
          +public void setIncludesfile(java.io.File includesFile)
+                     throws BuildException
          +
          +
          Sets the name of the file containing the includes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          includesFile - The file to fetch the include patterns from. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +setExcludesfile

          +
          +public void setExcludesfile(java.io.File excludesFile)
+                     throws BuildException
          +
          +
          Sets the name of the file containing the excludes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          excludesFile - The file to fetch the exclude patterns from. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +append

          +
          +public void append(PatternSet other,
+                   Project p)
          +
          +
          Adds the patterns of the other instance to this set. +

          +

          +
          +
          +
          +
          Parameters:
          other - the other PatternSet instance.
          p - the current project.
          +
          +
          +
          + +

          +getIncludePatterns

          +
          +public java.lang.String[] getIncludePatterns(Project p)
          +
          +
          Returns the filtered include patterns. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project. +
          Returns:
          the filtered included patterns.
          +
          +
          +
          + +

          +getExcludePatterns

          +
          +public java.lang.String[] getExcludePatterns(Project p)
          +
          +
          Returns the filtered include patterns. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project. +
          Returns:
          the filtered excluded patterns.
          +
          +
          +
          + +

          +hasPatterns

          +
          +public boolean hasPatterns(Project p)
          +
          +
          Helper for FileSet classes. + Check if there are patterns defined. +

          +

          +
          +
          +
          +
          Parameters:
          p - the current project. +
          Returns:
          true if there are patterns.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a printable form of this object.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a clone of this patternset.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +addConfiguredInvert

          +
          +public void addConfiguredInvert(PatternSet p)
          +
          +
          Add an inverted patternset. +

          +

          +
          +
          +
          +
          Parameters:
          p - the pattern to invert and add.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.Permission.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.Permission.html new file mode 100644 index 000000000..46806c4ca --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.Permission.html @@ -0,0 +1,389 @@ + + + + + + +Permissions.Permission (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Permissions.Permission

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Permissions.Permission
+
          +
          +
          Enclosing class:
          Permissions
          +
          +
          +
          +
          public static class Permissions.Permission
          extends java.lang.Object
          + + +

          +Represents a permission. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Permissions.Permission() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetActions() + +
          +          Get the actions.
          + java.lang.StringgetClassName() + +
          +          Get the class of the permission.
          + java.lang.StringgetName() + +
          +          Get the name of the permission.
          + voidsetActions(java.lang.String actions) + +
          +          Set the actions.
          + voidsetClass(java.lang.String aClass) + +
          +          Set the class, mandatory.
          + voidsetName(java.lang.String aName) + +
          +          Set the name of the permission.
          + java.lang.StringtoString() + +
          +          Get a string description of the permissions.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Permissions.Permission

          +
          +public Permissions.Permission()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setClass

          +
          +public void setClass(java.lang.String aClass)
          +
          +
          Set the class, mandatory. +

          +

          +
          Parameters:
          aClass - The class name of the permission.
          +
          +
          +
          + +

          +getClassName

          +
          +public java.lang.String getClassName()
          +
          +
          Get the class of the permission. +

          +

          + +
          Returns:
          The class name of the permission.
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String aName)
          +
          +
          Set the name of the permission. +

          +

          +
          Parameters:
          aName - The name of the permission.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of the permission. +

          +

          + +
          Returns:
          The name of the permission.
          +
          +
          +
          + +

          +setActions

          +
          +public void setActions(java.lang.String actions)
          +
          +
          Set the actions. +

          +

          +
          Parameters:
          actions - The actions of the permission.
          +
          +
          +
          + +

          +getActions

          +
          +public java.lang.String getActions()
          +
          +
          Get the actions. +

          +

          + +
          Returns:
          The actions of the permission.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get a string description of the permissions. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          string description of the permissions.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.html new file mode 100644 index 000000000..1fb8bc34d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Permissions.html @@ -0,0 +1,375 @@ + + + + + + +Permissions (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Permissions

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Permissions
+
          +
          +
          +
          public class Permissions
          extends java.lang.Object
          + + +

          +This class implements a security manager meant for usage by tasks that run inside the + Ant VM. An examples are the Java Task and JUnitTask. + + The basic functionality is that nothing (except for a base set of permissions) is allowed, unless + the permission is granted either explicitly or implicitly. + If a permission is granted this can be overruled by explicitly revoking the permission. + + It is not permissible to add permissions (either granted or revoked) while the Security Manager + is active (after calling setSecurityManager() but before calling restoreSecurityManager()). +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classPermissions.Permission + +
          +          Represents a permission.
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Permissions() + +
          +          Create a set of Permissions.
          Permissions(boolean delegateToOldSM) + +
          +          Create a set of permissions.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredGrant(Permissions.Permission perm) + +
          +          Adds a permission to be granted.
          + voidaddConfiguredRevoke(Permissions.Permission perm) + +
          +          Adds a permission to be revoked.
          + voidrestoreSecurityManager() + +
          +          To be used by tasks that just finished executing the parts subject to these permissions.
          + voidsetSecurityManager() + +
          +          To be used by tasks wishing to use this security model before executing the part to be + subject to these Permissions.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Permissions

          +
          +public Permissions()
          +
          +
          Create a set of Permissions. Equivalent to calling + new Permissions(false). +

          +

          +
          + +

          +Permissions

          +
          +public Permissions(boolean delegateToOldSM)
          +
          +
          Create a set of permissions. +

          +

          +
          Parameters:
          delegateToOldSM - if true the old security manager + will be used if the permission has not been explicitly granted or revoked + in this instance.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addConfiguredGrant

          +
          +public void addConfiguredGrant(Permissions.Permission perm)
          +
          +
          Adds a permission to be granted. +

          +

          +
          Parameters:
          perm - The Permissions.Permission to be granted.
          +
          +
          +
          + +

          +addConfiguredRevoke

          +
          +public void addConfiguredRevoke(Permissions.Permission perm)
          +
          +
          Adds a permission to be revoked. +

          +

          +
          Parameters:
          perm - The Permissions.Permission to be revoked
          +
          +
          +
          + +

          +setSecurityManager

          +
          +public void setSecurityManager()
+                        throws BuildException
          +
          +
          To be used by tasks wishing to use this security model before executing the part to be + subject to these Permissions. Note that setting the SecurityManager too early may + prevent your part from starting, as for instance changing classloaders may be prohibited. + The classloader for the new situation is supposed to be present. +

          +

          + +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +restoreSecurityManager

          +
          +public void restoreSecurityManager()
          +
          +
          To be used by tasks that just finished executing the parts subject to these permissions. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html new file mode 100644 index 000000000..7475f1b10 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.BuiltinPropertySetName.html @@ -0,0 +1,290 @@ + + + + + + +PropertySet.BuiltinPropertySetName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class PropertySet.BuiltinPropertySetName

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.PropertySet.BuiltinPropertySetName
+
          +
          +
          Enclosing class:
          PropertySet
          +
          +
          +
          +
          public static class PropertySet.BuiltinPropertySetName
          extends EnumeratedAttribute
          + + +

          +Used for propertyref's builtin attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          PropertySet.BuiltinPropertySetName() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertySet.BuiltinPropertySetName

          +
          +public PropertySet.BuiltinPropertySetName()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement.. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.PropertyRef.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.PropertyRef.html new file mode 100644 index 000000000..508dbd56c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.PropertyRef.html @@ -0,0 +1,345 @@ + + + + + + +PropertySet.PropertyRef (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class PropertySet.PropertyRef

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.PropertySet.PropertyRef
+
          +
          +
          Enclosing class:
          PropertySet
          +
          +
          +
          +
          public static class PropertySet.PropertyRef
          extends java.lang.Object
          + + +

          +This is a nested class containing a reference to some properties + and optionally a source of properties. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          PropertySet.PropertyRef() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetBuiltin(PropertySet.BuiltinPropertySetName b) + +
          +          Builtin property names - all, system or commandline.
          + voidsetName(java.lang.String name) + +
          +          Set the name.
          + voidsetPrefix(java.lang.String prefix) + +
          +          Set the prefix to use.
          + voidsetRegex(java.lang.String regex) + +
          +          Set the regular expression to use to filter the properties.
          + java.lang.StringtoString() + +
          +          A debug toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertySet.PropertyRef

          +
          +public PropertySet.PropertyRef()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set the name. +

          +

          +
          Parameters:
          name - a String value.
          +
          +
          +
          + +

          +setRegex

          +
          +public void setRegex(java.lang.String regex)
          +
          +
          Set the regular expression to use to filter the properties. +

          +

          +
          Parameters:
          regex - a regular expression.
          +
          +
          +
          + +

          +setPrefix

          +
          +public void setPrefix(java.lang.String prefix)
          +
          +
          Set the prefix to use. +

          +

          +
          Parameters:
          prefix - a String value.
          +
          +
          +
          + +

          +setBuiltin

          +
          +public void setBuiltin(PropertySet.BuiltinPropertySetName b)
          +
          +
          Builtin property names - all, system or commandline. +

          +

          +
          Parameters:
          b - an enumerated BuildinPropertySetName value.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          A debug toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          a string version of this object.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.html new file mode 100644 index 000000000..5c1d5646d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/PropertySet.html @@ -0,0 +1,899 @@ + + + + + + +PropertySet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class PropertySet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.PropertySet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class PropertySet
          extends DataType
          implements ResourceCollection
          + + +

          +A set of properties. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classPropertySet.BuiltinPropertySetName + +
          +          Used for propertyref's builtin attribute.
          +static classPropertySet.PropertyRef + +
          +          This is a nested class containing a reference to some properties + and optionally a source of properties.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          PropertySet() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileNameMapper fileNameMapper) + +
          +          Add a nested FileNameMapper.
          + voidaddPropertyref(PropertySet.PropertyRef ref) + +
          +          Add a property reference (nested element) to the references to be used.
          + voidaddPropertyset(PropertySet ref) + +
          +          Add another property set to this set.
          + voidappendBuiltin(PropertySet.BuiltinPropertySetName b) + +
          +          Allow builtin (all, system or commandline) properties in the set.
          + voidappendName(java.lang.String name) + +
          +          Allow properties of a particular name in the set.
          + voidappendPrefix(java.lang.String prefix) + +
          +          Allow properties whose names start with a prefix in the set.
          + voidappendRegex(java.lang.String regex) + +
          +          Allow properties whose names match a regex in the set.
          +protected  voidassertNotReference() + +
          +          Ensures this data type is not a reference.
          + MappercreateMapper() + +
          +          Create a mapper to map the property names.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + booleangetDynamic() + +
          +          Get the dynamic attribute.
          + MappergetMapper() + +
          +          Get the mapper attribute.
          + java.util.PropertiesgetProperties() + +
          +          This is the operation to get the existing or recalculated properties.
          +protected  PropertySetgetRef() + +
          +          Performs the check for circular references and returns the + referenced PropertySet.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection interface.
          + voidsetDynamic(boolean dynamic) + +
          +          Set whether to reevaluate the set everytime the set is used.
          + voidsetMapper(java.lang.String type, + java.lang.String from, + java.lang.String to) + +
          +          Set a mapper to change property names.
          + voidsetNegate(boolean negate) + +
          +          Set whether to negate results.
          + voidsetRefid(Reference r) + +
          +          Sets the value of the refid attribute.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          A debug toString.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertySet

          +
          +public PropertySet()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +appendName

          +
          +public void appendName(java.lang.String name)
          +
          +
          Allow properties of a particular name in the set. +

          +

          +
          +
          +
          +
          Parameters:
          name - the property name to allow.
          +
          +
          +
          + +

          +appendRegex

          +
          +public void appendRegex(java.lang.String regex)
          +
          +
          Allow properties whose names match a regex in the set. +

          +

          +
          +
          +
          +
          Parameters:
          regex - the regular expression to use.
          +
          +
          +
          + +

          +appendPrefix

          +
          +public void appendPrefix(java.lang.String prefix)
          +
          +
          Allow properties whose names start with a prefix in the set. +

          +

          +
          +
          +
          +
          Parameters:
          prefix - the prefix to use.
          +
          +
          +
          + +

          +appendBuiltin

          +
          +public void appendBuiltin(PropertySet.BuiltinPropertySetName b)
          +
          +
          Allow builtin (all, system or commandline) properties in the set. +

          +

          +
          +
          +
          +
          Parameters:
          b - the type of builtin properties.
          +
          +
          +
          + +

          +setMapper

          +
          +public void setMapper(java.lang.String type,
+                      java.lang.String from,
+                      java.lang.String to)
          +
          +
          Set a mapper to change property names. +

          +

          +
          +
          +
          +
          Parameters:
          type - mapper type.
          from - source pattern.
          to - output pattern.
          +
          +
          +
          + +

          +addPropertyref

          +
          +public void addPropertyref(PropertySet.PropertyRef ref)
          +
          +
          Add a property reference (nested element) to the references to be used. +

          +

          +
          +
          +
          +
          Parameters:
          ref - a property reference.
          +
          +
          +
          + +

          +addPropertyset

          +
          +public void addPropertyset(PropertySet ref)
          +
          +
          Add another property set to this set. +

          +

          +
          +
          +
          +
          Parameters:
          ref - another property set.
          +
          +
          +
          + +

          +createMapper

          +
          +public Mapper createMapper()
          +
          +
          Create a mapper to map the property names. +

          +

          +
          +
          +
          + +
          Returns:
          a mapper to be configured.
          +
          +
          +
          + +

          +add

          +
          +public void add(FileNameMapper fileNameMapper)
          +
          +
          Add a nested FileNameMapper. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - the mapper to add.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setDynamic

          +
          +public void setDynamic(boolean dynamic)
          +
          +
          Set whether to reevaluate the set everytime the set is used. + Default is true. +

          +

          +
          +
          +
          +
          Parameters:
          dynamic - if true, reevaluate the property set each time + the set is used. if false cache the property set + the first time and use the cached set on subsequent + occasions.
          +
          +
          +
          + +

          +setNegate

          +
          +public void setNegate(boolean negate)
          +
          +
          Set whether to negate results. + If "true", all properties not selected by nested elements will be returned. + Default is "false". +

          +

          +
          +
          +
          +
          Parameters:
          negate - if true, negate the selection criteria.
          +
          +
          +
          + +

          +getDynamic

          +
          +public boolean getDynamic()
          +
          +
          Get the dynamic attribute. +

          +

          +
          +
          +
          + +
          Returns:
          true if the property set is to be evalulated each time it is used.
          +
          +
          +
          + +

          +getMapper

          +
          +public Mapper getMapper()
          +
          +
          Get the mapper attribute. +

          +

          +
          +
          +
          + +
          Returns:
          the mapper attribute.
          +
          +
          +
          + +

          +getProperties

          +
          +public java.util.Properties getProperties()
          +
          +
          This is the operation to get the existing or recalculated properties. +

          +

          +
          +
          +
          + +
          Returns:
          the properties for this propertyset.
          +
          +
          +
          + +

          +getRef

          +
          +protected PropertySet getRef()
          +
          +
          Performs the check for circular references and returns the + referenced PropertySet. +

          +

          +
          +
          +
          + +
          Returns:
          the referenced PropertySet.
          +
          +
          +
          + +

          +setRefid

          +
          +public final void setRefid(Reference r)
          +
          +
          Sets the value of the refid attribute. +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference this datatype should point to. +
          Throws: +
          BuildException - if another attribute was set, since + refid and all other attributes are mutually exclusive.
          +
          +
          +
          + +

          +assertNotReference

          +
          +protected final void assertNotReference()
          +
          +
          Ensures this data type is not a reference. + +

          Calling this method as the first line of every bean method of + this data type (setXyz, addXyz, createXyz) ensure proper handling + of the refid attribute.

          +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - if the refid attribute was already set, since + refid and all other attributes are mutually exclusive.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          A debug toString. + This gets a comma separated list of key=value pairs for + the properties in the set. + The output order is sorted according to the keys' natural order. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string rep of this object.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection interface. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          the size of this ResourceCollection.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Quantifier.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Quantifier.html new file mode 100644 index 000000000..06ef660b5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Quantifier.html @@ -0,0 +1,476 @@ + + + + + + +Quantifier (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Quantifier

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.Quantifier
+
          +
          +
          +
          public class Quantifier
          extends EnumeratedAttribute
          + + +

          +EnumeratedAttribute for quantifier comparisons. Evaluates a + boolean[] or raw true and false + counts. Accepts the following values:

            +
          • "all"
            • - none false +
          • "each"
            • - none false +
          • "every"
            • - none false +
          • "any"
            • - at least one true +
          • "some"
            • - at least one true +
          • "one"
            • - exactly one true +
          • "majority"
            • - more true than false +
          • "most"
            • - more true than false +
          • "none"
            • - none true +
          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static QuantifierALL + +
          +          ALL instance
          +static QuantifierANY + +
          +          ANY instance
          +static QuantifierMAJORITY + +
          +          MAJORITY instance
          +static QuantifierNONE + +
          +          NONE instance
          +static QuantifierONE + +
          +          ONE instance
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Quantifier() + +
          +          Default constructor.
          Quantifier(java.lang.String value) + +
          +          Construct a new Quantifier with the specified value.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanevaluate(boolean[] b) + +
          +          Evaluate a boolean array.
          + booleanevaluate(int t, + int f) + +
          +          Evaluate integer true vs.
          + java.lang.String[]getValues() + +
          +          Return the possible values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ALL

          +
          +public static final Quantifier ALL
          +
          +
          ALL instance +

          +

          +
          +
          +
          + +

          +ANY

          +
          +public static final Quantifier ANY
          +
          +
          ANY instance +

          +

          +
          +
          +
          + +

          +ONE

          +
          +public static final Quantifier ONE
          +
          +
          ONE instance +

          +

          +
          +
          +
          + +

          +MAJORITY

          +
          +public static final Quantifier MAJORITY
          +
          +
          MAJORITY instance +

          +

          +
          +
          +
          + +

          +NONE

          +
          +public static final Quantifier NONE
          +
          +
          NONE instance +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Quantifier

          +
          +public Quantifier()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Quantifier

          +
          +public Quantifier(java.lang.String value)
          +
          +
          Construct a new Quantifier with the specified value. +

          +

          +
          Parameters:
          value - the EnumeratedAttribute value.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Return the possible values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          String[] of EnumeratedAttribute values.
          +
          +
          +
          + +

          +evaluate

          +
          +public boolean evaluate(boolean[] b)
          +
          +
          Evaluate a boolean array. +

          +

          +
          Parameters:
          b - the boolean[] to evaluate. +
          Returns:
          true if the argument fell within the parameters of this Quantifier.
          +
          +
          +
          + +

          +evaluate

          +
          +public boolean evaluate(int t,
+                        int f)
          +
          +
          Evaluate integer true vs. false counts. +

          +

          +
          Parameters:
          t - the number of true values.
          f - the number of false values. +
          Returns:
          true if the arguments fell within the parameters of this Quantifier.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RedirectorElement.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RedirectorElement.html new file mode 100644 index 000000000..5943e8949 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RedirectorElement.html @@ -0,0 +1,882 @@ + + + + + + +RedirectorElement (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class RedirectorElement

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.RedirectorElement
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class RedirectorElement
          extends DataType
          + + +

          +Element representation of a Redirector. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.2
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          RedirectorElement() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredErrorMapper(Mapper errorMapper) + +
          +          Add the error file mapper.
          + voidaddConfiguredInputMapper(Mapper inputMapper) + +
          +          Add the input file mapper.
          + voidaddConfiguredOutputMapper(Mapper outputMapper) + +
          +          Add the output file mapper.
          + voidconfigure(Redirector redirector) + +
          +          Configure the specified Redirector.
          + voidconfigure(Redirector redirector, + java.lang.String sourcefile) + +
          +          Configure the specified Redirector + for the specified sourcefile.
          + FilterChaincreateErrorFilterChain() + +
          +          Create a nested error FilterChain.
          + FilterChaincreateInputFilterChain() + +
          +          Create a nested input FilterChain.
          +protected  MappercreateMergeMapper(java.io.File destfile) + +
          +          Create a merge mapper pointing to the specified destination file.
          + FilterChaincreateOutputFilterChain() + +
          +          Create a nested output FilterChain.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          + voidsetAlwaysLog(boolean alwaysLog) + +
          +          If true, (error and non-error) output will be "teed", redirected + as specified while being sent to Ant's logging mechanism as if no + redirection had taken place.
          + voidsetAppend(boolean append) + +
          +          Whether output should be appended to or overwrite an existing file.
          + voidsetCreateEmptyFiles(boolean createEmptyFiles) + +
          +          Whether output and error files should be created even when empty.
          + voidsetError(java.io.File error) + +
          +          Set the file to which standard error is to be redirected.
          + voidsetErrorEncoding(java.lang.String errorEncoding) + +
          +          Set the error encoding.
          + voidsetErrorProperty(java.lang.String errorProperty) + +
          +          Property name whose value should be set to the error of + the process.
          + voidsetInput(java.io.File input) + +
          +          Set the input to use for the task.
          + voidsetInputEncoding(java.lang.String inputEncoding) + +
          +          Set the input encoding.
          + voidsetInputString(java.lang.String inputString) + +
          +          Set the string to use as input
          + voidsetLogError(boolean logError) + +
          +          Controls whether error output of exec is logged.
          + voidsetLogInputString(boolean logInputString) + +
          +          Set whether to include the value of the input string in log messages.
          + voidsetOutput(java.io.File out) + +
          +          File the output of the process is redirected to.
          + voidsetOutputEncoding(java.lang.String outputEncoding) + +
          +          Set the output encoding.
          + voidsetOutputProperty(java.lang.String outputProperty) + +
          +          Property name whose value should be set to the output of + the process.
          + voidsetRefid(Reference r) + +
          +          Make this instance in effect a reference to another instance.
          +protected  java.io.File[]toFileArray(java.lang.String[] name) + +
          +          Return a File[] from the specified set of filenames.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RedirectorElement

          +
          +public RedirectorElement()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addConfiguredInputMapper

          +
          +public void addConfiguredInputMapper(Mapper inputMapper)
          +
          +
          Add the input file mapper. +

          +

          +
          Parameters:
          inputMapper - Mapper.
          +
          +
          +
          + +

          +addConfiguredOutputMapper

          +
          +public void addConfiguredOutputMapper(Mapper outputMapper)
          +
          +
          Add the output file mapper. +

          +

          +
          Parameters:
          outputMapper - Mapper.
          +
          +
          +
          + +

          +addConfiguredErrorMapper

          +
          +public void addConfiguredErrorMapper(Mapper errorMapper)
          +
          +
          Add the error file mapper. +

          +

          +
          Parameters:
          errorMapper - Mapper.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Make this instance in effect a reference to another instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to use. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +setInput

          +
          +public void setInput(java.io.File input)
          +
          +
          Set the input to use for the task. +

          +

          +
          Parameters:
          input - the file from which input is read.
          +
          +
          +
          + +

          +setInputString

          +
          +public void setInputString(java.lang.String inputString)
          +
          +
          Set the string to use as input +

          +

          +
          Parameters:
          inputString - the string which is used as the input source
          +
          +
          +
          + +

          +setLogInputString

          +
          +public void setLogInputString(boolean logInputString)
          +
          +
          Set whether to include the value of the input string in log messages. + Defaults to true. +

          +

          +
          Parameters:
          logInputString - true or false.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setOutput

          +
          +public void setOutput(java.io.File out)
          +
          +
          File the output of the process is redirected to. If error is not + redirected, it too will appear in the output. +

          +

          +
          Parameters:
          out - the file to which output stream is written.
          +
          +
          +
          + +

          +setOutputEncoding

          +
          +public void setOutputEncoding(java.lang.String outputEncoding)
          +
          +
          Set the output encoding. +

          +

          +
          Parameters:
          outputEncoding - String.
          +
          +
          +
          + +

          +setErrorEncoding

          +
          +public void setErrorEncoding(java.lang.String errorEncoding)
          +
          +
          Set the error encoding. +

          +

          +
          Parameters:
          errorEncoding - String.
          +
          +
          +
          + +

          +setInputEncoding

          +
          +public void setInputEncoding(java.lang.String inputEncoding)
          +
          +
          Set the input encoding. +

          +

          +
          Parameters:
          inputEncoding - String.
          +
          +
          +
          + +

          +setLogError

          +
          +public void setLogError(boolean logError)
          +
          +
          Controls whether error output of exec is logged. This is only useful + when output is being redirected and error output is desired in the + Ant log. +

          +

          +
          Parameters:
          logError - if true the standard error is sent to the Ant log system + and not sent to output.
          +
          +
          +
          + +

          +setError

          +
          +public void setError(java.io.File error)
          +
          +
          Set the file to which standard error is to be redirected. +

          +

          +
          Parameters:
          error - the file to which error is to be written.
          +
          +
          +
          + +

          +setOutputProperty

          +
          +public void setOutputProperty(java.lang.String outputProperty)
          +
          +
          Property name whose value should be set to the output of + the process. +

          +

          +
          Parameters:
          outputProperty - the name of the property to be set with the + task's output.
          +
          +
          +
          + +

          +setAppend

          +
          +public void setAppend(boolean append)
          +
          +
          Whether output should be appended to or overwrite an existing file. + Defaults to false. +

          +

          +
          Parameters:
          append - if true output and error streams are appended to their + respective files, if specified.
          +
          +
          +
          + +

          +setAlwaysLog

          +
          +public void setAlwaysLog(boolean alwaysLog)
          +
          +
          If true, (error and non-error) output will be "teed", redirected + as specified while being sent to Ant's logging mechanism as if no + redirection had taken place. Defaults to false. +

          +

          +
          Parameters:
          alwaysLog - boolean
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setCreateEmptyFiles

          +
          +public void setCreateEmptyFiles(boolean createEmptyFiles)
          +
          +
          Whether output and error files should be created even when empty. + Defaults to true. +

          +

          +
          Parameters:
          createEmptyFiles - boolean.
          +
          +
          +
          + +

          +setErrorProperty

          +
          +public void setErrorProperty(java.lang.String errorProperty)
          +
          +
          Property name whose value should be set to the error of + the process. +

          +

          +
          Parameters:
          errorProperty - the name of the property to be set + with the error output.
          +
          +
          +
          + +

          +createInputFilterChain

          +
          +public FilterChain createInputFilterChain()
          +
          +
          Create a nested input FilterChain. +

          +

          + +
          Returns:
          FilterChain.
          +
          +
          +
          + +

          +createOutputFilterChain

          +
          +public FilterChain createOutputFilterChain()
          +
          +
          Create a nested output FilterChain. +

          +

          + +
          Returns:
          FilterChain.
          +
          +
          +
          + +

          +createErrorFilterChain

          +
          +public FilterChain createErrorFilterChain()
          +
          +
          Create a nested error FilterChain. +

          +

          + +
          Returns:
          FilterChain.
          +
          +
          +
          + +

          +configure

          +
          +public void configure(Redirector redirector)
          +
          +
          Configure the specified Redirector. +

          +

          +
          Parameters:
          redirector - Redirector.
          +
          +
          +
          + +

          +configure

          +
          +public void configure(Redirector redirector,
+                      java.lang.String sourcefile)
          +
          +
          Configure the specified Redirector + for the specified sourcefile. +

          +

          +
          Parameters:
          redirector - Redirector.
          sourcefile - String.
          +
          +
          +
          + +

          +createMergeMapper

          +
          +protected Mapper createMergeMapper(java.io.File destfile)
          +
          +
          Create a merge mapper pointing to the specified destination file. +

          +

          +
          Parameters:
          destfile - File +
          Returns:
          Mapper.
          +
          +
          +
          + +

          +toFileArray

          +
          +protected java.io.File[] toFileArray(java.lang.String[] name)
          +
          +
          Return a File[] from the specified set of filenames. +

          +

          +
          Parameters:
          name - String[] +
          Returns:
          File[].
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Reference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Reference.html new file mode 100644 index 000000000..1682b98fd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Reference.html @@ -0,0 +1,436 @@ + + + + + + +Reference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Reference

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.Reference
+
          +
          +
          Direct Known Subclasses:
          Ant.Reference
          +
          +
          +
          +
          public class Reference
          extends java.lang.Object
          + + +

          +Class to hold a reference to another object in the project. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          Reference() + +
          +          Deprecated. since 1.7. + Please use Reference(Project,String) + instead.
          Reference(Project p, + java.lang.String id) + +
          +          Create a reference to a named ID in a particular project.
          Reference(java.lang.String id) + +
          +          Deprecated. since 1.7. + Please use Reference(Project,String) + instead.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + ProjectgetProject() + +
          +          Get the associated project, if any; may be null.
          + java.lang.ObjectgetReferencedObject() + +
          +          Resolve the reference, looking in the associated project.
          + java.lang.ObjectgetReferencedObject(Project fallback) + +
          +          Resolve the reference, using the associated project if + it set, otherwise use the passed in project.
          + java.lang.StringgetRefId() + +
          +          Get the reference id of this reference.
          + voidsetProject(Project p) + +
          +          Set the associated project.
          + voidsetRefId(java.lang.String id) + +
          +          Set the reference id.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Reference

          +
          +public Reference()
          +
          +
          Deprecated. since 1.7. + Please use Reference(Project,String) + instead. +

          +

          Create a reference. +

          +

          +
          + +

          +Reference

          +
          +public Reference(java.lang.String id)
          +
          +
          Deprecated. since 1.7. + Please use Reference(Project,String) + instead. +

          +

          Create a reference to a named ID. +

          +

          +
          Parameters:
          id - the name of this reference
          +
          +
          + +

          +Reference

          +
          +public Reference(Project p,
+                 java.lang.String id)
          +
          +
          Create a reference to a named ID in a particular project. +

          +

          +
          Parameters:
          p - the project this reference is associated with
          id - the name of this reference
          Since:
          +
          Ant 1.6.3
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRefId

          +
          +public void setRefId(java.lang.String id)
          +
          +
          Set the reference id. Should not normally be necessary; + use Reference(Project, String). +

          +

          +
          Parameters:
          id - the reference id to use
          +
          +
          +
          + +

          +getRefId

          +
          +public java.lang.String getRefId()
          +
          +
          Get the reference id of this reference. +

          +

          + +
          Returns:
          the reference id
          +
          +
          +
          + +

          +setProject

          +
          +public void setProject(Project p)
          +
          +
          Set the associated project. Should not normally be necessary; + use Reference(Project,String). +

          +

          +
          Parameters:
          p - the project to use
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +getProject

          +
          +public Project getProject()
          +
          +
          Get the associated project, if any; may be null. +

          +

          + +
          Returns:
          the associated project
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +getReferencedObject

          +
          +public java.lang.Object getReferencedObject(Project fallback)
+                                     throws BuildException
          +
          +
          Resolve the reference, using the associated project if + it set, otherwise use the passed in project. +

          +

          +
          Parameters:
          fallback - the fallback project to use if the project attribute of + reference is not set. +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the reference cannot be dereferenced.
          +
          +
          +
          + +

          +getReferencedObject

          +
          +public java.lang.Object getReferencedObject()
+                                     throws BuildException
          +
          +
          Resolve the reference, looking in the associated project. +

          +

          + +
          Returns:
          the dereferenced object. +
          Throws: +
          BuildException - if the project is null or the reference cannot be dereferenced
          Since:
          +
          Ant 1.6.3
          +
          See Also:
          Project.getReference(java.lang.String)
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RegularExpression.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RegularExpression.html new file mode 100644 index 000000000..3cbb6a459 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/RegularExpression.html @@ -0,0 +1,433 @@ + + + + + + +RegularExpression (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class RegularExpression

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.RegularExpression
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class RegularExpression
          extends DataType
          + + +

          +A regular expression datatype. Keeps an instance of the + compiled expression for speed purposes. This compiled + expression is lazily evaluated (it is compiled the first + time it is needed). The syntax is the dependent on which + regular expression type you are using. The system property + "ant.regexp.regexpimpl" will be the classname of the implementation + that will be used. + + 

          + Available implementations:
+
+   org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp (default)
+        Based on the JDK's built-in regular expression package
+
+   org.apache.tools.ant.util.regexp.JakartaOroRegexp
+        Based on the jakarta-oro package
+
+   org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
+        Based on the jakarta-regexp package
+
          + + 
          +   <regexp [ [id="id"] pattern="expression" | refid="id" ]
+   />
+
          +

          + +

          +

          +
          See Also:
          Perl5Compiler, +RE, +Pattern, +Regexp
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDATA_TYPE_NAME + +
          +          Name of this data type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          RegularExpression() + +
          +          default constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetPattern(Project p) + +
          +          Gets the pattern string for this RegularExpression in the + given project.
          + RegularExpressiongetRef(Project p) + +
          +          Get the RegularExpression this reference refers to in + the given project.
          + RegexpgetRegexp(Project p) + +
          +          provides a reference to the Regexp contained in this
          + voidsetPattern(java.lang.String pattern) + +
          +          sets the regular expression pattern
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DATA_TYPE_NAME

          +
          +public static final java.lang.String DATA_TYPE_NAME
          +
          +
          Name of this data type +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +RegularExpression

          +
          +public RegularExpression()
          +
          +
          default constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String pattern)
          +
          +
          sets the regular expression pattern +

          +

          +
          Parameters:
          pattern - regular expression pattern
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern(Project p)
          +
          +
          Gets the pattern string for this RegularExpression in the + given project. +

          +

          +
          Parameters:
          p - project +
          Returns:
          pattern
          +
          +
          +
          + +

          +getRegexp

          +
          +public Regexp getRegexp(Project p)
          +
          +
          provides a reference to the Regexp contained in this +

          +

          +
          Parameters:
          p - project +
          Returns:
          Regexp instance associated with this RegularExpression instance
          +
          +
          +
          + +

          +getRef

          +
          +public RegularExpression getRef(Project p)
          +
          +
          Get the RegularExpression this reference refers to in + the given project. Check for circular references too +

          +

          +
          Parameters:
          p - project +
          Returns:
          resolved RegularExpression instance
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Resource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Resource.html new file mode 100644 index 000000000..bb28210bc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Resource.html @@ -0,0 +1,1120 @@ + + + + + + +Resource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Resource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          AbstractClasspathResource, ArchiveResource, FileResource, LogOutputResource, PropertyResource, ResourceDecorator, StringResource, URLResource
          +
          +
          +
          +
          public class Resource
          extends DataType
          implements java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          + + +

          +Describes a "File-like" resource (File, ZipEntry, etc.). + + This class is meant to be used by classes needing to record path + and date/time information about a file, a zip entry or some similar + resource (URL, archive in a version control repository, ...). +

          + +

          +

          +
          Since:
          +
          Ant 1.5.2
          +
          See Also:
          Touchable
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static intMAGIC + +
          +          Magic number
          +static longUNKNOWN_DATETIME + +
          +          Constant unknown datetime for getLastModified
          +static longUNKNOWN_SIZE + +
          +          Constant unknown size
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          Resource() + +
          +          Default constructor.
          Resource(java.lang.String name) + +
          +          Only sets the name.
          Resource(java.lang.String name, + boolean exists, + long lastmodified) + +
          +          Sets the name, lastmodified flag, and exists flag.
          Resource(java.lang.String name, + boolean exists, + long lastmodified, + boolean directory) + +
          +          Sets the name, lastmodified flag, exists flag, and directory flag.
          Resource(java.lang.String name, + boolean exists, + long lastmodified, + boolean directory, + long size) + +
          +          Sets the name, lastmodified flag, exists flag, directory flag, and size.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectas(java.lang.Class clazz) + +
          +          Returns a view of this resource that implements the interface + given as the argument or null if there is no such view.
          + java.lang.Objectclone() + +
          +          Clone this Resource.
          + intcompareTo(java.lang.Object other) + +
          +          Delegates to a comparison of names.
          + booleanequals(java.lang.Object other) + +
          +          Implement basic Resource equality.
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + longgetLastModified() + +
          +          Tells the modification time in milliseconds since 01.01.1970 (the "epoch").
          +protected static intgetMagicNumber(byte[] seed) + +
          +          Create a "magic number" for use in hashCode calculations.
          + java.lang.StringgetName() + +
          +          Name attribute will contain the path of a file relative to the + root directory of its fileset or the recorded path of a zip + entry.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + longgetSize() + +
          +          Get the size of this Resource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisDirectory() + +
          +          Tells if the resource is a directory.
          + booleanisExists() + +
          +          The exists attribute tells whether a resource exists.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetDirectory(boolean directory) + +
          +          Set the directory attribute.
          + voidsetExists(boolean exists) + +
          +          Set the exists attribute.
          + voidsetLastModified(long lastmodified) + +
          +          Set the last modification attribute.
          + voidsetName(java.lang.String name) + +
          +          Set the name of this Resource.
          + voidsetRefid(Reference r) + +
          +          Overrides the base version.
          + voidsetSize(long size) + +
          +          Set the size of this Resource.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoLongString() + +
          +          Get a long String representation of this Resource.
          + java.lang.StringtoString() + +
          +          Get the string representation of this Resource.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +UNKNOWN_SIZE

          +
          +public static final long UNKNOWN_SIZE
          +
          +
          Constant unknown size +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UNKNOWN_DATETIME

          +
          +public static final long UNKNOWN_DATETIME
          +
          +
          Constant unknown datetime for getLastModified +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAGIC

          +
          +protected static final int MAGIC
          +
          +
          Magic number +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Resource

          +
          +public Resource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Resource

          +
          +public Resource(java.lang.String name)
          +
          +
          Only sets the name. + +

          This is a dummy, used for not existing resources.

          +

          +

          +
          Parameters:
          name - relative path of the resource. Expects + "/" to be used as the directory separator.
          +
          +
          + +

          +Resource

          +
          +public Resource(java.lang.String name,
+                boolean exists,
+                long lastmodified)
          +
          +
          Sets the name, lastmodified flag, and exists flag. +

          +

          +
          Parameters:
          name - relative path of the resource. Expects + "/" to be used as the directory separator.
          exists - if true, this resource exists.
          lastmodified - the last modification time of this resource.
          +
          +
          + +

          +Resource

          +
          +public Resource(java.lang.String name,
+                boolean exists,
+                long lastmodified,
+                boolean directory)
          +
          +
          Sets the name, lastmodified flag, exists flag, and directory flag. +

          +

          +
          Parameters:
          name - relative path of the resource. Expects + "/" to be used as the directory separator.
          exists - if true the resource exists
          lastmodified - the last modification time of the resource
          directory - if true, this resource is a directory
          +
          +
          + +

          +Resource

          +
          +public Resource(java.lang.String name,
+                boolean exists,
+                long lastmodified,
+                boolean directory,
+                long size)
          +
          +
          Sets the name, lastmodified flag, exists flag, directory flag, and size. +

          +

          +
          Parameters:
          name - relative path of the resource. Expects + "/" to be used as the directory separator.
          exists - if true the resource exists
          lastmodified - the last modification time of the resource
          directory - if true, this resource is a directory
          size - the size of this resource.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getMagicNumber

          +
          +protected static int getMagicNumber(byte[] seed)
          +
          +
          Create a "magic number" for use in hashCode calculations. +

          +

          +
          +
          +
          +
          Parameters:
          seed - byte[] to seed with. +
          Returns:
          a magic number as int.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Name attribute will contain the path of a file relative to the + root directory of its fileset or the recorded path of a zip + entry. + +

          example for a file with fullpath /var/opt/adm/resource.txt + in a file set with root dir /var/opt it will be + adm/resource.txt.

          + +

          "/" will be used as the directory separator.

          +

          +

          +
          +
          +
          + +
          Returns:
          the name of this resource.
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set the name of this Resource. +

          +

          +
          +
          +
          +
          Parameters:
          name - relative path of the resource. Expects + "/" to be used as the directory separator.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          The exists attribute tells whether a resource exists. +

          +

          +
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +setExists

          +
          +public void setExists(boolean exists)
          +
          +
          Set the exists attribute. +

          +

          +
          +
          +
          +
          Parameters:
          exists - if true, this resource exists.
          +
          +
          +
          + +

          +getLastModified

          +
          +public long getLastModified()
          +
          +
          Tells the modification time in milliseconds since 01.01.1970 (the "epoch"). +

          +

          +
          +
          +
          + +
          Returns:
          the modification time, if that is meaningful + (e.g. for a file resource which exists); + 0 if the resource does not exist, to mirror the behavior + of File.lastModified(); + or 0 if the notion of modification time is meaningless for this class + of resource (e.g. an inline string)
          +
          +
          +
          + +

          +setLastModified

          +
          +public void setLastModified(long lastmodified)
          +
          +
          Set the last modification attribute. +

          +

          +
          +
          +
          +
          Parameters:
          lastmodified - the modification time in milliseconds since 01.01.1970.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Tells if the resource is a directory. +

          +

          +
          +
          +
          + +
          Returns:
          boolean flag indicating if the resource is a directory.
          +
          +
          +
          + +

          +setDirectory

          +
          +public void setDirectory(boolean directory)
          +
          +
          Set the directory attribute. +

          +

          +
          +
          +
          +
          Parameters:
          directory - if true, this resource is a directory.
          +
          +
          +
          + +

          +setSize

          +
          +public void setSize(long size)
          +
          +
          Set the size of this Resource. +

          +

          +
          +
          +
          +
          Parameters:
          size - the size, as a long.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Clone this Resource. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          copy of this.
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object other)
          +
          +
          Delegates to a comparison of names. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          +
          +
          +
          Parameters:
          other - the object to compare to. +
          Returns:
          a negative integer, zero, or a positive integer as this Resource + is less than, equal to, or greater than the specified Resource.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object other)
          +
          +
          Implement basic Resource equality. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          other - the object to check against. +
          Returns:
          true if the specified Object is equal to this Resource.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          hash code as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          the size of this ResourceCollection.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this Resource is a FileProvider.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the string representation of this Resource. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          this Resource formatted as a String.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +toLongString

          +
          +public final java.lang.String toLongString()
          +
          +
          Get a long String representation of this Resource. + This typically should be the value of toString() + prefixed by a type description. +

          +

          +
          +
          +
          + +
          Returns:
          this Resource formatted as a long String.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the base version. +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +as

          +
          +public java.lang.Object as(java.lang.Class clazz)
          +
          +
          Returns a view of this resource that implements the interface + given as the argument or null if there is no such view. + +

          This allows extension interfaces to be added to resources + without growing the number of permutations of interfaces + decorators/adapters need to implement.

          + +

          This implementation of the method will return the current + instance itself if it can be assigned to the given class.

          +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceCollection.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceCollection.html new file mode 100644 index 000000000..4a57e447b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceCollection.html @@ -0,0 +1,265 @@ + + + + + + +ResourceCollection (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Interface ResourceCollection

          +
          +
          All Known Implementing Classes:
          AbstractClasspathResource, AbstractResourceCollectionWrapper, ArchiveFileSet, ArchiveResource, Archives, BaseResourceCollectionContainer, BaseResourceCollectionWrapper, BCFileSet, BZip2Resource, ClassfileSet, CompressedResource, Concat, ContentTransformingResource, Difference, DirSet, FileList, FileResource, Files, FileSet, First, GZipResource, Intersect, JavaConstantResource, Javadoc.TagArgument, JavaResource, Last, LazyResourceCollectionWrapper, LibFileSet, LogOutputResource, MappedResource, MappedResourceCollection, Path, Path.PathElement, PropertyResource, PropertySet, Resource, ResourceDecorator, ResourceList, Resources, Restrict, SizeLimitCollection, Sort, StringResource, Tar.TarFileSet, TarFileSet, TarResource, Tokens, Union, URLResource, ZipFileSet, ZipResource
          +
          +
          +
          +
          public interface ResourceCollection
          + + +

          +Interface describing a collection of Resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisFilesystemOnly() + +
          +          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions.
          + java.util.Iteratoriterator() + +
          +          Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances.
          + intsize() + +
          +          Learn the number of contained Resources.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +iterator

          +
          +java.util.Iterator iterator()
          +
          +
          Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances. +

          +

          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +size

          +
          +int size()
          +
          +
          Learn the number of contained Resources. +

          +

          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +boolean isFilesystemOnly()
          +
          +
          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. If true, + all Resources returned from this ResourceCollection should be + instances of FileResource. +

          +

          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceFactory.html new file mode 100644 index 000000000..98e68661c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceFactory.html @@ -0,0 +1,219 @@ + + + + + + +ResourceFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Interface ResourceFactory

          +
          +
          All Known Implementing Classes:
          ArchiveScanner, DependScanner, DirectoryScanner, FileResource, FTP.FTPDirectoryScanner, FTPTaskMirrorImpl.FTPDirectoryScanner, Project, SourceFileScanner, TarScanner, ZipScanner
          +
          +
          +
          +
          public interface ResourceFactory
          + + +

          +this interface should be implemented by classes (Scanners) needing + to deliver information about resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.5.2
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + ResourcegetResource(java.lang.String name) + +
          +          Query a resource (file, zipentry, ...) by name
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getResource

          +
          +Resource getResource(java.lang.String name)
          +
          +
          Query a resource (file, zipentry, ...) by name +

          +

          +
          Parameters:
          name - relative path of the resource about which + information is sought. Expects "/" to be used as the + directory separator. +
          Returns:
          instance of Resource; the exists attribute of Resource + will tell whether the sought resource exists
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceLocation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceLocation.html new file mode 100644 index 000000000..e77f99840 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ResourceLocation.html @@ -0,0 +1,372 @@ + + + + + + +ResourceLocation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class ResourceLocation

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.ResourceLocation
+
          +
          +
          Direct Known Subclasses:
          DTDLocation
          +
          +
          +
          +
          public class ResourceLocation
          extends java.lang.Object
          + + +

          +

          Helper class to handle the <dtd> and + <entity> nested elements. These correspond to + the PUBLIC and URI catalog entry types, + respectively, as defined in the + OASIS "Open Catalog" standard.

          + +

          Possible Future Enhancements: +

            +
          • Bring the Ant element names into conformance with the OASIS standard
            • +
          • Add support for additional OASIS catalog entry types
            • +
          +

          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          See Also:
          Catalog
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ResourceLocation() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.net.URLgetBase() + +
          +           
          + java.lang.StringgetLocation() + +
          +           
          + java.lang.StringgetPublicId() + +
          +           
          + voidsetBase(java.net.URL base) + +
          +           
          + voidsetLocation(java.lang.String location) + +
          +           
          + voidsetPublicId(java.lang.String publicId) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceLocation

          +
          +public ResourceLocation()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setPublicId

          +
          +public void setPublicId(java.lang.String publicId)
          +
          +
          +
          Parameters:
          publicId - uniquely identifies the resource.
          +
          +
          +
          + +

          +setLocation

          +
          +public void setLocation(java.lang.String location)
          +
          +
          +
          Parameters:
          location - the location of the resource associated with the + publicId.
          +
          +
          +
          + +

          +setBase

          +
          +public void setBase(java.net.URL base)
          +
          +
          +
          Parameters:
          base - the base URL of the resource associated with the + publicId. If the location specifies a relative URL/pathname, + it is resolved using the base. The default base for an + external catalog file is the directory in which it is located.
          +
          +
          +
          + +

          +getPublicId

          +
          +public java.lang.String getPublicId()
          +
          +
          + +
          Returns:
          the publicId of the resource.
          +
          +
          +
          + +

          +getLocation

          +
          +public java.lang.String getLocation()
          +
          +
          + +
          Returns:
          the location of the resource identified by the publicId.
          +
          +
          +
          + +

          +getBase

          +
          +public java.net.URL getBase()
          +
          +
          + +
          Returns:
          the base of the resource identified by the publicId.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Substitution.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Substitution.html new file mode 100644 index 000000000..3388c2abb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/Substitution.html @@ -0,0 +1,391 @@ + + + + + + +Substitution (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class Substitution

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Substitution
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Substitution
          extends DataType
          + + +

          +A regular expression substitution datatype. It is an expression + that is meant to replace a regular expression. + + 

          +   <substitution [ [id="id"] expression="expression" | refid="id" ]
+   />
+
          +

          + +

          +

          +
          See Also:
          Perl5Substitution
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDATA_TYPE_NAME + +
          +          The name of this data type
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Substitution() + +
          +          Constructor for Substitution.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetExpression(Project p) + +
          +          Gets the pattern string for this RegularExpression in the + given project.
          + SubstitutiongetRef(Project p) + +
          +          Get the RegularExpression this reference refers to in + the given project.
          + voidsetExpression(java.lang.String expression) + +
          +          Set the pattern string for this regular expression substitution.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DATA_TYPE_NAME

          +
          +public static final java.lang.String DATA_TYPE_NAME
          +
          +
          The name of this data type +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Substitution

          +
          +public Substitution()
          +
          +
          Constructor for Substitution. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setExpression

          +
          +public void setExpression(java.lang.String expression)
          +
          +
          Set the pattern string for this regular expression substitution. +

          +

          +
          Parameters:
          expression - the regular expression to use
          +
          +
          +
          + +

          +getExpression

          +
          +public java.lang.String getExpression(Project p)
          +
          +
          Gets the pattern string for this RegularExpression in the + given project. +

          +

          +
          Parameters:
          p - the project to look for the regular expression if this object is + a reference +
          Returns:
          the pattern string
          +
          +
          +
          + +

          +getRef

          +
          +public Substitution getRef(Project p)
          +
          +
          Get the RegularExpression this reference refers to in + the given project. Check for circular references too. +

          +

          +
          Parameters:
          p - the project to look for the regular expression reference +
          Returns:
          the resolved reference
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarFileSet.html new file mode 100644 index 000000000..6bd29561e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarFileSet.html @@ -0,0 +1,751 @@ + + + + + + +TarFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class TarFileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.ArchiveFileSet
+                      extended by org.apache.tools.ant.types.TarFileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          Tar.TarFileSet
          +
          +
          +
          +
          public class TarFileSet
          extends ArchiveFileSet
          + + +

          +A TarFileSet is a FileSet with extra attributes useful in the context of + Tar/Jar tasks. + + A TarFileSet extends FileSets with the ability to extract a subset of the + entries of a Tar file for inclusion in another Tar file. It also includes + a prefix attribute which is prepended to each entry in the output Tar file. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.ArchiveFileSet
          DEFAULT_DIR_MODE, DEFAULT_FILE_MODE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          + TarFileSet() + +
          +          Constructor for TarFileSet
          +protected TarFileSet(FileSet fileset) + +
          +          Constructor using a fileset arguement.
          +protected TarFileSet(TarFileSet fileset) + +
          +          Constructor using a tarfileset arguement.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +          Return a TarFileSet that has the same properties + as this one.
          +protected  voidconfigureFileSet(ArchiveFileSet zfs) + +
          +          Configure a fileset based on this fileset.
          + intgetGid() + +
          +           
          + java.lang.StringgetGroup() + +
          +           
          +protected  AbstractFileSetgetRef(Project p) + +
          +          A TarFileset accepts another TarFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute
          + intgetUid() + +
          +           
          + java.lang.StringgetUserName() + +
          +           
          + booleanhasGroupBeenSet() + +
          +           
          + booleanhasGroupIdBeenSet() + +
          +           
          + booleanhasUserIdBeenSet() + +
          +           
          + booleanhasUserNameBeenSet() + +
          +           
          +protected  ArchiveScannernewArchiveScanner() + +
          +          Create a new scanner.
          + voidsetGid(int gid) + +
          +          The GID for the tar entry; optional, default="0" + This is not the same as the group name.
          + voidsetGroup(java.lang.String groupName) + +
          +          The groupname for the tar entry; optional, default="" + This is not the same as the GID.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another instance.
          + voidsetUid(int uid) + +
          +          The uid for the tar entry + This is not the same as the User name.
          + voidsetUserName(java.lang.String userName) + +
          +          The username for the tar entry + This is not the same as the UID.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet
          addConfigured, dieOnCircularReference, getCheckedRef, getDirectoryScanner, getDirMode, getDirMode, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, setDir, setDirMode, setErrorOnMissingArchive, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setupDirectoryScanner, setupDirectoryScanner
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TarFileSet

          +
          +public TarFileSet()
          +
          +
          Constructor for TarFileSet +

          +

          +
          + +

          +TarFileSet

          +
          +protected TarFileSet(FileSet fileset)
          +
          +
          Constructor using a fileset arguement. +

          +

          +
          Parameters:
          fileset - the fileset to use
          +
          +
          + +

          +TarFileSet

          +
          +protected TarFileSet(TarFileSet fileset)
          +
          +
          Constructor using a tarfileset arguement. +

          +

          +
          Parameters:
          fileset - the tarfileset to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setUserName

          +
          +public void setUserName(java.lang.String userName)
          +
          +
          The username for the tar entry + This is not the same as the UID. +

          +

          +
          Parameters:
          userName - the user name for the tar entry.
          +
          +
          +
          + +

          +getUserName

          +
          +public java.lang.String getUserName()
          +
          +
          + +
          Returns:
          the user name for the tar entry
          +
          +
          +
          + +

          +hasUserNameBeenSet

          +
          +public boolean hasUserNameBeenSet()
          +
          +
          + +
          Returns:
          whether the user name has been explicitly set.
          +
          +
          +
          + +

          +setUid

          +
          +public void setUid(int uid)
          +
          +
          The uid for the tar entry + This is not the same as the User name. +

          +

          +
          Parameters:
          uid - the id of the user for the tar entry.
          +
          +
          +
          + +

          +getUid

          +
          +public int getUid()
          +
          +
          + +
          Returns:
          the uid for the tar entry
          +
          +
          +
          + +

          +hasUserIdBeenSet

          +
          +public boolean hasUserIdBeenSet()
          +
          +
          + +
          Returns:
          whether the user id has been explicitly set.
          +
          +
          +
          + +

          +setGroup

          +
          +public void setGroup(java.lang.String groupName)
          +
          +
          The groupname for the tar entry; optional, default="" + This is not the same as the GID. +

          +

          +
          Parameters:
          groupName - the group name string.
          +
          +
          +
          + +

          +getGroup

          +
          +public java.lang.String getGroup()
          +
          +
          + +
          Returns:
          the group name string.
          +
          +
          +
          + +

          +hasGroupBeenSet

          +
          +public boolean hasGroupBeenSet()
          +
          +
          + +
          Returns:
          whether the group name has been explicitly set.
          +
          +
          +
          + +

          +setGid

          +
          +public void setGid(int gid)
          +
          +
          The GID for the tar entry; optional, default="0" + This is not the same as the group name. +

          +

          +
          Parameters:
          gid - the group id.
          +
          +
          +
          + +

          +getGid

          +
          +public int getGid()
          +
          +
          + +
          Returns:
          the group identifier.
          +
          +
          +
          + +

          +hasGroupIdBeenSet

          +
          +public boolean hasGroupIdBeenSet()
          +
          +
          + +
          Returns:
          whether the group id has been explicitly set.
          +
          +
          +
          + +

          +newArchiveScanner

          +
          +protected ArchiveScanner newArchiveScanner()
          +
          +
          Create a new scanner. +

          +

          +
          Specified by:
          newArchiveScanner in class ArchiveFileSet
          +
          +
          + +
          Returns:
          the created scanner.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class AbstractFileSet
          +
          +
          +
          Parameters:
          r - the Reference to use. +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getRef

          +
          +protected AbstractFileSet getRef(Project p)
          +
          +
          A TarFileset accepts another TarFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +

          +

          +
          Overrides:
          getRef in class AbstractFileSet
          +
          +
          +
          Parameters:
          p - the project to use +
          Returns:
          the abstract fileset instance
          +
          +
          +
          + +

          +configureFileSet

          +
          +protected void configureFileSet(ArchiveFileSet zfs)
          +
          +
          Configure a fileset based on this fileset. + If the fileset is a TarFileSet copy in the tarfileset + specific attributes. +

          +

          +
          Overrides:
          configureFileSet in class ArchiveFileSet
          +
          +
          +
          Parameters:
          zfs - the archive fileset to configure.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Return a TarFileSet that has the same properties + as this one. +

          +

          +
          Overrides:
          clone in class ArchiveFileSet
          +
          +
          + +
          Returns:
          the cloned tarFileSet
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarScanner.html new file mode 100644 index 000000000..8b36cef48 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TarScanner.html @@ -0,0 +1,324 @@ + + + + + + +TarScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class TarScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.types.ArchiveScanner
+          extended by org.apache.tools.ant.types.TarScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          +
          public class TarScanner
          extends ArchiveScanner
          + + +

          +Scans tar archives for resources. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.ArchiveScanner
          srcFile
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          TarScanner() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  voidfillMapsFromArchive(Resource src, + java.lang.String encoding, + java.util.Map fileEntries, + java.util.Map matchFileEntries, + java.util.Map dirEntries, + java.util.Map matchDirEntries) + +
          +          Fills the file and directory maps with resources read from the + archive.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.ArchiveScanner
          getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getResource, init, match, scan, setEncoding, setErrorOnMissingArchive, setSrc, setSrc, trimSeparator
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TarScanner

          +
          +public TarScanner()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +fillMapsFromArchive

          +
          +protected void fillMapsFromArchive(Resource src,
+                                   java.lang.String encoding,
+                                   java.util.Map fileEntries,
+                                   java.util.Map matchFileEntries,
+                                   java.util.Map dirEntries,
+                                   java.util.Map matchDirEntries)
          +
          +
          Fills the file and directory maps with resources read from the + archive. +

          +

          +
          Specified by:
          fillMapsFromArchive in class ArchiveScanner
          +
          +
          +
          Parameters:
          src - the archive to scan.
          encoding - encoding used to encode file names inside the archive.
          fileEntries - Map (name to resource) of non-directory + resources found inside the archive.
          matchFileEntries - Map (name to resource) of non-directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          dirEntries - Map (name to resource) of directory + resources found inside the archive.
          matchDirEntries - Map (name to resource) of directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TimeComparison.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TimeComparison.html new file mode 100644 index 000000000..750f7c7a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/TimeComparison.html @@ -0,0 +1,484 @@ + + + + + + +TimeComparison (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class TimeComparison

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.TimeComparison
+
          +
          +
          Direct Known Subclasses:
          DateSelector.TimeComparisons
          +
          +
          +
          +
          public class TimeComparison
          extends EnumeratedAttribute
          + + +

          +EnumeratedAttribute for time comparisons. Accepts values + "before", "after", "equal". +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static TimeComparisonAFTER + +
          +          After Comparison.
          +static TimeComparisonBEFORE + +
          +          Before Comparison.
          +static TimeComparisonEQUAL + +
          +          Equal Comparison.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          TimeComparison() + +
          +          Default constructor.
          TimeComparison(java.lang.String value) + +
          +          Construct a new TimeComparison with the specified value.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static intcompare(long t1, + long t2) + +
          +          Compare two times.
          +static intcompare(long t1, + long t2, + long g) + +
          +          Compare two times.
          + booleanevaluate(long t1, + long t2) + +
          +          Evaluate two times against this TimeComparison.
          + booleanevaluate(long t1, + long t2, + long g) + +
          +          Evaluate two times against this TimeComparison.
          + java.lang.String[]getValues() + +
          +          Return the possible values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +BEFORE

          +
          +public static final TimeComparison BEFORE
          +
          +
          Before Comparison. +

          +

          +
          +
          +
          + +

          +AFTER

          +
          +public static final TimeComparison AFTER
          +
          +
          After Comparison. +

          +

          +
          +
          +
          + +

          +EQUAL

          +
          +public static final TimeComparison EQUAL
          +
          +
          Equal Comparison. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TimeComparison

          +
          +public TimeComparison()
          +
          +
          Default constructor. +

          +

          +
          + +

          +TimeComparison

          +
          +public TimeComparison(java.lang.String value)
          +
          +
          Construct a new TimeComparison with the specified value. +

          +

          +
          Parameters:
          value - the EnumeratedAttribute value.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Return the possible values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          String[] of EnumeratedAttribute values.
          +
          +
          +
          + +

          +evaluate

          +
          +public boolean evaluate(long t1,
+                        long t2)
          +
          +
          Evaluate two times against this TimeComparison. +

          +

          +
          Parameters:
          t1 - the first time to compare.
          t2 - the second time to compare. +
          Returns:
          true if the comparison result fell within the parameters of this TimeComparison.
          +
          +
          +
          + +

          +evaluate

          +
          +public boolean evaluate(long t1,
+                        long t2,
+                        long g)
          +
          +
          Evaluate two times against this TimeComparison. +

          +

          +
          Parameters:
          t1 - the first time to compare.
          t2 - the second time to compare.
          g - the timestamp granularity. +
          Returns:
          true if the comparison result fell within the parameters of this TimeComparison.
          +
          +
          +
          + +

          +compare

          +
          +public static int compare(long t1,
+                          long t2)
          +
          +
          Compare two times. +

          +

          +
          Parameters:
          t1 - the first time to compare.
          t2 - the second time to compare. +
          Returns:
          a negative integer, a positive integer, or zero as t1 is + before, after, or equal to t2 accounting for the default granularity.
          +
          +
          +
          + +

          +compare

          +
          +public static int compare(long t1,
+                          long t2,
+                          long g)
          +
          +
          Compare two times. +

          +

          +
          Parameters:
          t1 - the first time to compare.
          t2 - the second time to compare.
          g - the timestamp granularity. +
          Returns:
          a negative integer, a positive integer, or zero as t1 is + before, after, or equal to t2 accounting for the specified granularity.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/XMLCatalog.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/XMLCatalog.html new file mode 100644 index 000000000..168aedca6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/XMLCatalog.html @@ -0,0 +1,798 @@ + + + + + + +XMLCatalog (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class XMLCatalog

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.XMLCatalog
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, javax.xml.transform.URIResolver, org.xml.sax.EntityResolver
          +
          +
          +
          +
          public class XMLCatalog
          extends DataType
          implements java.lang.Cloneable, org.xml.sax.EntityResolver, javax.xml.transform.URIResolver
          + + +

          +

          This data type provides a catalog of resource locations (such as + DTDs and XML entities), based on the + OASIS "Open Catalog" standard. The catalog entries are used + both for Entity resolution and URI resolution, in accordance with + the EntityResolver and URIResolver interfaces as defined + in the Java API for XML + Processing Specification.

          + +

          Resource locations can be specified either in-line or in + external catalog file(s), or both. In order to use an external + catalog file, the xml-commons resolver library ("resolver.jar") + must be in your classpath. External catalog files may be either + plain text format or + XML format. If the xml-commons resolver library is not found + in the classpath, external catalog files, specified in + <catalogpath> paths, will be ignored and a warning will + be logged. In this case, however, processing of inline entries will proceed + normally.

          + +

          Currently, only <dtd> and + <entity> elements may be specified inline; these + correspond to OASIS catalog entry types PUBLIC and + URI respectively.

          + +

          The following is a usage example:

          + + + <xmlcatalog>
          +   <dtd publicId="" location="/path/to/file.jar" />
          +   <dtd publicId="" location="/path/to/file2.jar" />
          +   <entity publicId="" location="/path/to/file3.jar" />
          +   <entity publicId="" location="/path/to/file4.jar" />
          +   <catalogpath>
          +     <pathelement location="/etc/sgml/catalog"/>
          +   </catalogpath>
          +   <catalogfiles dir="/opt/catalogs/" includes="**\catalog.xml" />
          + </xmlcatalog>
          +           +

          + Tasks wishing to use <xmlcatalog> must provide a method called + createXMLCatalog which returns an instance of + XMLCatalog. Nested DTD and entity definitions are handled by + the XMLCatalog object and must be labeled dtd and + entity respectively.

          + +

          The following is a description of the resolution algorithm: + entities/URIs/dtds are looked up in each of the following contexts, + stopping when a valid and readable resource is found: +

            +
          1. In the local filesystem
            2. +
          2. In the classpath
            3. +
          3. Using the Apache xml-commons resolver (if it is available)
            4. +
          4. In URL-space
            5. +
          +

          + +

          See XMLValidateTask for an example of a task that has integrated + support for XMLCatalogs.

          + +

          Possible future extension could provide for additional OASIS + entry types to be specified inline.

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringAPACHE_RESOLVER + +
          +          The name of the bridge to the Apache xml-commons resolver + class, used to determine whether resolver.jar is present in the + classpath.
          +static java.lang.StringCATALOG_RESOLVER + +
          +          Resolver base class
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          XMLCatalog() + +
          +          Default constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredXMLCatalog(XMLCatalog catalog) + +
          +          Loads a nested <xmlcatalog> into our + definition.
          + voidaddDTD(ResourceLocation dtd) + +
          +          Creates the nested <dtd> element.
          + voidaddEntity(ResourceLocation entity) + +
          +          Creates the nested <entity> element.
          + PathcreateCatalogPath() + +
          +          Creates a nested <catalogpath> element.
          + PathcreateClasspath() + +
          +          Allows nested classpath elements.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + PathgetCatalogPath() + +
          +          Returns the catalog path in which to attempt to resolve DTDs.
          + javax.xml.transform.Sourceresolve(java.lang.String href, + java.lang.String base) + +
          +          Implements the URIResolver.resolve() interface method.
          + org.xml.sax.InputSourceresolveEntity(java.lang.String publicId, + java.lang.String systemId) + +
          +          Implements the EntityResolver.resolveEntity() interface method.
          + voidsetCatalogPathRef(Reference r) + +
          +          Allows catalogpath reference.
          + voidsetClasspath(Path classpath) + +
          +          Allows simple classpath string.
          + voidsetClasspathRef(Reference r) + +
          +          Allows classpath reference.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another XMLCatalog + instance.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +APACHE_RESOLVER

          +
          +public static final java.lang.String APACHE_RESOLVER
          +
          +
          The name of the bridge to the Apache xml-commons resolver + class, used to determine whether resolver.jar is present in the + classpath. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CATALOG_RESOLVER

          +
          +public static final java.lang.String CATALOG_RESOLVER
          +
          +
          Resolver base class +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +XMLCatalog

          +
          +public XMLCatalog()
          +
          +
          Default constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Allows nested classpath elements. Not allowed if this catalog + is itself a reference to another catalog -- that is, a catalog + cannot both refer to another and contain elements or + other attributes. +

          +

          +
          +
          +
          + +
          Returns:
          a Path instance to be configured.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Allows simple classpath string. Not allowed if this catalog is + itself a reference to another catalog -- that is, a catalog + cannot both refer to another and contain elements or + other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          classpath - the classpath to use to look up entities.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Allows classpath reference. Not allowed if this catalog is + itself a reference to another catalog -- that is, a catalog + cannot both refer to another and contain elements or + other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          r - an Ant reference containing a classpath.
          +
          +
          +
          + +

          +createCatalogPath

          +
          +public Path createCatalogPath()
          +
          +
          Creates a nested <catalogpath> element. + Not allowed if this catalog is itself a reference to another + catalog -- that is, a catalog cannot both refer to another + and contain elements or other attributes. +

          +

          +
          +
          +
          + +
          Returns:
          a path to be configured as the catalog path. +
          Throws: +
          BuildException - if this is a reference and no nested elements are allowed.
          +
          +
          +
          + +

          +setCatalogPathRef

          +
          +public void setCatalogPathRef(Reference r)
          +
          +
          Allows catalogpath reference. Not allowed if this catalog is + itself a reference to another catalog -- that is, a catalog + cannot both refer to another and contain elements or + other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          r - an Ant reference containing a classpath to be used as + the catalog path.
          +
          +
          +
          + +

          +getCatalogPath

          +
          +public Path getCatalogPath()
          +
          +
          Returns the catalog path in which to attempt to resolve DTDs. +

          +

          +
          +
          +
          + +
          Returns:
          the catalog path
          +
          +
          +
          + +

          +addDTD

          +
          +public void addDTD(ResourceLocation dtd)
+            throws BuildException
          +
          +
          Creates the nested <dtd> element. Not + allowed if this catalog is itself a reference to another + catalog -- that is, a catalog cannot both refer to another + and contain elements or other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          dtd - the information about the PUBLIC resource mapping to + be added to the catalog +
          Throws: +
          BuildException - if this is a reference and no nested + elements are allowed.
          +
          +
          +
          + +

          +addEntity

          +
          +public void addEntity(ResourceLocation entity)
+               throws BuildException
          +
          +
          Creates the nested <entity> element. Not + allowed if this catalog is itself a reference to another + catalog -- that is, a catalog cannot both refer to another + and contain elements or other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          entity - the information about the URI resource mapping to be + added to the catalog. +
          Throws: +
          BuildException - if this is a reference and no nested + elements are allowed.
          +
          +
          +
          + +

          +addConfiguredXMLCatalog

          +
          +public void addConfiguredXMLCatalog(XMLCatalog catalog)
          +
          +
          Loads a nested <xmlcatalog> into our + definition. Not allowed if this catalog is itself a reference + to another catalog -- that is, a catalog cannot both refer to + another and contain elements or other attributes. +

          +

          +
          +
          +
          +
          Parameters:
          catalog - Nested XMLCatalog
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another XMLCatalog + instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference. That is, a catalog + cannot both refer to another and contain elements or + attributes.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to which this catalog instance is associated +
          Throws: +
          BuildException - if this instance already has been configured.
          +
          +
          +
          + +

          +resolveEntity

          +
          +public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
+                                             java.lang.String systemId)
+                                      throws org.xml.sax.SAXException,
+                                             java.io.IOException
          +
          +
          Implements the EntityResolver.resolveEntity() interface method. +

          +

          +
          Specified by:
          resolveEntity in interface org.xml.sax.EntityResolver
          +
          +
          +
          Parameters:
          publicId - the public id to resolve.
          systemId - the system id to resolve. +
          Returns:
          the resolved entity. +
          Throws: +
          org.xml.sax.SAXException - if there is a parsing problem. +
          java.io.IOException - if there is an IO problem.
          See Also:
          EntityResolver.resolveEntity(java.lang.String, java.lang.String)
          +
          +
          +
          + +

          +resolve

          +
          +public javax.xml.transform.Source resolve(java.lang.String href,
+                                          java.lang.String base)
+                                   throws javax.xml.transform.TransformerException
          +
          +
          Implements the URIResolver.resolve() interface method. +

          +

          +
          Specified by:
          resolve in interface javax.xml.transform.URIResolver
          +
          +
          +
          Parameters:
          href - an href attribute.
          base - the base URI. +
          Returns:
          a Source object, or null if href cannot be resolved. +
          Throws: +
          javax.xml.transform.TransformerException - if an error occurs.
          See Also:
          URIResolver.resolve(java.lang.String, java.lang.String)
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipFileSet.html new file mode 100644 index 000000000..ba4ad2527 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipFileSet.html @@ -0,0 +1,489 @@ + + + + + + +ZipFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class ZipFileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.ArchiveFileSet
+                      extended by org.apache.tools.ant.types.ZipFileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          +
          public class ZipFileSet
          extends ArchiveFileSet
          + + +

          +A ZipFileSet is a FileSet with extra attributes useful in the context of + Zip/Jar tasks. + + A ZipFileSet extends FileSets with the ability to extract a subset of the + entries of a Zip file for inclusion in another Zip file. It also includes + a prefix attribute which is prepended to each entry in the output Zip file. + + Since ant 1.6 ZipFileSet can be defined with an id and referenced in packaging tasks +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.ArchiveFileSet
          DEFAULT_DIR_MODE, DEFAULT_FILE_MODE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          + ZipFileSet() + +
          +          Constructor for ZipFileSet
          +protected ZipFileSet(FileSet fileset) + +
          +          Constructor using a fileset arguement.
          +protected ZipFileSet(ZipFileSet fileset) + +
          +          Constructor using a zipfileset arguement.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +          Return a ZipFileSet that has the same properties + as this one.
          + java.lang.StringgetEncoding() + +
          +          Get the encoding used for this ZipFileSet.
          +protected  AbstractFileSetgetRef(Project p) + +
          +          A ZipFileset accepts another ZipFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute
          +protected  ArchiveScannernewArchiveScanner() + +
          +          Return a new archive scanner based on this one.
          + voidsetEncoding(java.lang.String enc) + +
          +          Set the encoding used for this ZipFileSet.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet
          addConfigured, configureFileSet, dieOnCircularReference, getCheckedRef, getDirectoryScanner, getDirMode, getDirMode, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, setDir, setDirMode, setErrorOnMissingArchive, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipFileSet

          +
          +public ZipFileSet()
          +
          +
          Constructor for ZipFileSet +

          +

          +
          + +

          +ZipFileSet

          +
          +protected ZipFileSet(FileSet fileset)
          +
          +
          Constructor using a fileset arguement. +

          +

          +
          Parameters:
          fileset - the fileset to use
          +
          +
          + +

          +ZipFileSet

          +
          +protected ZipFileSet(ZipFileSet fileset)
          +
          +
          Constructor using a zipfileset arguement. +

          +

          +
          Parameters:
          fileset - the zipfileset to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String enc)
          +
          +
          Set the encoding used for this ZipFileSet. +

          +

          +
          Parameters:
          enc - encoding as String.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getEncoding

          +
          +public java.lang.String getEncoding()
          +
          +
          Get the encoding used for this ZipFileSet. +

          +

          + +
          Returns:
          String encoding.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +newArchiveScanner

          +
          +protected ArchiveScanner newArchiveScanner()
          +
          +
          Return a new archive scanner based on this one. +

          +

          +
          Specified by:
          newArchiveScanner in class ArchiveFileSet
          +
          +
          + +
          Returns:
          a new ZipScanner with the same encoding as this one.
          +
          +
          +
          + +

          +getRef

          +
          +protected AbstractFileSet getRef(Project p)
          +
          +
          A ZipFileset accepts another ZipFileSet or a FileSet as reference + FileSets are often used by the war task for the lib attribute +

          +

          +
          Overrides:
          getRef in class AbstractFileSet
          +
          +
          +
          Parameters:
          p - the project to use +
          Returns:
          the abstract fileset instance
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Return a ZipFileSet that has the same properties + as this one. +

          +

          +
          Overrides:
          clone in class ArchiveFileSet
          +
          +
          + +
          Returns:
          the cloned zipFileSet
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipScanner.html new file mode 100644 index 000000000..d2331ba65 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/ZipScanner.html @@ -0,0 +1,324 @@ + + + + + + +ZipScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types +
          +Class ZipScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.types.ArchiveScanner
+          extended by org.apache.tools.ant.types.ZipScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          +
          public class ZipScanner
          extends ArchiveScanner
          + + +

          +Scans zip archives for resources. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.ArchiveScanner
          srcFile
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          ZipScanner() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  voidfillMapsFromArchive(Resource src, + java.lang.String encoding, + java.util.Map fileEntries, + java.util.Map matchFileEntries, + java.util.Map dirEntries, + java.util.Map matchDirEntries) + +
          +          Fills the file and directory maps with resources read from the + archive.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.ArchiveScanner
          getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getResource, init, match, scan, setEncoding, setErrorOnMissingArchive, setSrc, setSrc, trimSeparator
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipScanner

          +
          +public ZipScanner()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +fillMapsFromArchive

          +
          +protected void fillMapsFromArchive(Resource src,
+                                   java.lang.String encoding,
+                                   java.util.Map fileEntries,
+                                   java.util.Map matchFileEntries,
+                                   java.util.Map dirEntries,
+                                   java.util.Map matchDirEntries)
          +
          +
          Fills the file and directory maps with resources read from the + archive. +

          +

          +
          Specified by:
          fillMapsFromArchive in class ArchiveScanner
          +
          +
          +
          Parameters:
          src - the archive to scan.
          encoding - encoding used to encode file names inside the archive.
          fileEntries - Map (name to resource) of non-directory + resources found inside the archive.
          matchFileEntries - Map (name to resource) of non-directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          dirEntries - Map (name to resource) of directory + resources found inside the archive.
          matchDirEntries - Map (name to resource) of directory + resources found inside the archive that matched all include + patterns and didn't match any exclude patterns.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/CutDirsMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/CutDirsMapper.html new file mode 100644 index 000000000..f2d2b4bbf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/CutDirsMapper.html @@ -0,0 +1,347 @@ + + + + + + +CutDirsMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.mappers +
          +Class CutDirsMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.mappers.CutDirsMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class CutDirsMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +A mapper that strips of the a configurable number of leading + directories from a file name. + +

          This mapper was inspired by a user-list thread that mentioned + wget's --cut-dirs option.

          +

          + +

          +

          +
          See Also:
          + simplify copy with regexpmapper
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          CutDirsMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the + given source file..
          + voidsetDirs(int dirs) + +
          +          The number of leading directories to cut.
          + voidsetFrom(java.lang.String ignore) + +
          +          Empty implementation.
          + voidsetTo(java.lang.String ignore) + +
          +          Empty implementation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CutDirsMapper

          +
          +public CutDirsMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDirs

          +
          +public void setDirs(int dirs)
          +
          +
          The number of leading directories to cut. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String ignore)
          +
          +
          Empty implementation. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          ignore - ignored.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String ignore)
          +
          +
          Empty implementation. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          ignore - ignored.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the + given source file. + +

          if the given rule doesn't apply to the source file, + implementation must return null. SourceFileScanner will then + omit the source file in question.

          . +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the name of the source file relative to + some given basedirectory. +
          Returns:
          an array of strings if the ruld applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/FilterMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/FilterMapper.html new file mode 100644 index 000000000..9d3df0c94 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/FilterMapper.html @@ -0,0 +1,370 @@ + + + + + + +FilterMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.mappers +
          +Class FilterMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.FilterChain
+              extended by org.apache.tools.ant.types.mappers.FilterMapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileNameMapper
          +
          +
          +
          +
          public class FilterMapper
          extends FilterChain
          implements FileNameMapper
          + + +

          +This is a FileNameMapper based on a FilterChain. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FilterMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Return the result of the filters on the sourcefilename.
          + voidsetFrom(java.lang.String from) + +
          +          From attribute not supported.
          + voidsetTo(java.lang.String to) + +
          +          From attribute not supported.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.FilterChain
          add, addClassConstants, addContainsRegex, addDeleteCharacters, addEscapeUnicode, addExpandProperties, addFilterReader, addHeadFilter, addIgnoreBlank, addLineContains, addLineContainsRegExp, addPrefixLines, addReplaceRegex, addReplaceString, addReplaceTokens, addStripJavaComments, addStripLineBreaks, addStripLineComments, addSuffixLines, addTabsToSpaces, addTailFilter, addTokenFilter, addTrim, dieOnCircularReference, getFilterReaders, setRefid
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FilterMapper

          +
          +public FilterMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          From attribute not supported. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - a string +
          Throws: +
          BuildException - always
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          From attribute not supported. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - a string +
          Throws: +
          BuildException - always
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Return the result of the filters on the sourcefilename. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the filename to map +
          Returns:
          a one-element array of converted filenames, or null if + the filterchain returns an empty string.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-frame.html new file mode 100644 index 000000000..9315cb449 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.types.mappers (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.mappers + + + + +
          +Classes  + +
          +CutDirsMapper +
          +FilterMapper
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-summary.html new file mode 100644 index 000000000..3889706e9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-summary.html @@ -0,0 +1,157 @@ + + + + + + +org.apache.tools.ant.types.mappers (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.mappers +

          + + + + + + + + + + + + + +
          +Class Summary
          CutDirsMapperA mapper that strips of the a configurable number of leading + directories from a file name.
          FilterMapperThis is a FileNameMapper based on a FilterChain.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-tree.html new file mode 100644 index 000000000..56550e39a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/mappers/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +org.apache.tools.ant.types.mappers Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.mappers +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/AbstractScriptComponent.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/AbstractScriptComponent.html new file mode 100644 index 000000000..795800427 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/AbstractScriptComponent.html @@ -0,0 +1,533 @@ + + + + + + +AbstractScriptComponent (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional +
          +Class AbstractScriptComponent

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.optional.AbstractScriptComponent
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          ScriptCondition, ScriptMapper
          +
          +
          +
          +
          public abstract class AbstractScriptComponent
          extends ProjectComponent
          + + +

          +This is a ProjectComponent that has script support built in + Use it as a foundation for scriptable things. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractScriptComponent() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          The script text.
          + PathcreateClasspath() + +
          +          Classpath to be used when searching for classes and resources.
          +protected  voidexecuteScript(java.lang.String execName) + +
          +          Run a script
          + ScriptRunnerBasegetRunner() + +
          +          Get our script runner
          +protected  voidinitScriptRunner() + +
          +          Initialize the script runner.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used when searching for classes and resources.
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath by reference.
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetManager(java.lang.String manager) + +
          +          Defines the manager.
          + voidsetProject(Project project) + +
          +          Set the project.
          + voidsetSetBeans(boolean setBeans) + +
          +          Set the setbeans attribute.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file ; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractScriptComponent

          +
          +public AbstractScriptComponent()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Set the project. +

          +

          +
          Overrides:
          setProject in class ProjectComponent
          +
          +
          +
          Parameters:
          project - the owner of this component.
          +
          +
          +
          + +

          +getRunner

          +
          +public ScriptRunnerBase getRunner()
          +
          +
          Get our script runner +

          +

          + +
          Returns:
          the runner
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file ; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          The script text. +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +setManager

          +
          +public void setManager(java.lang.String manager)
          +
          +
          Defines the manager. +

          +

          +
          Parameters:
          manager - the scripting manager.
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +initScriptRunner

          +
          +protected void initScriptRunner()
          +
          +
          Initialize the script runner. Calls this before running the system +

          +

          +
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used when searching for classes and resources. +

          +

          +
          Parameters:
          classpath - an Ant Path object containing the search path.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Classpath to be used when searching for classes and resources. +

          +

          + +
          Returns:
          an empty Path instance to be configured by Ant.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath by reference. +

          +

          +
          Parameters:
          r - a Reference to a Path instance to be used as the classpath + value.
          +
          +
          +
          + +

          +executeScript

          +
          +protected void executeScript(java.lang.String execName)
          +
          +
          Run a script +

          +

          +
          Parameters:
          execName - name of the script
          +
          +
          +
          + +

          +setSetBeans

          +
          +public void setSetBeans(boolean setBeans)
          +
          +
          Set the setbeans attribute. + If this is true, <script> will create variables in the + script instance for all + properties, targets and references of the current project. + It this is false, only the project and self variables will + be set. + The default is true. +

          +

          +
          Parameters:
          setBeans - the value to set.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptCondition.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptCondition.html new file mode 100644 index 000000000..f028fd69e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptCondition.html @@ -0,0 +1,356 @@ + + + + + + +ScriptCondition (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional +
          +Class ScriptCondition

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.optional.AbstractScriptComponent
+          extended by org.apache.tools.ant.types.optional.ScriptCondition
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Condition
          +
          +
          +
          +
          public class ScriptCondition
          extends AbstractScriptComponent
          implements Condition
          + + +

          +A condition that lets you include script. + The condition component sets a bean "self", whose attribute "value" + must be set to true for the condition to succeed, false to fail. + The default is 'false' +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptCondition() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleaneval() + +
          +          Is this condition true?
          + booleangetValue() + +
          +          get the current value of the conditon
          + voidsetValue(boolean value) + +
          +          set the value of the condition.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.AbstractScriptComponent
          addText, createClasspath, executeScript, getRunner, initScriptRunner, setClasspath, setClasspathRef, setLanguage, setManager, setProject, setSetBeans, setSrc
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptCondition

          +
          +public ScriptCondition()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +eval

          +
          +public boolean eval()
+             throws BuildException
          +
          +
          Is this condition true? +

          +

          +
          Specified by:
          eval in interface Condition
          +
          +
          + +
          Returns:
          true if the condition is true +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +getValue

          +
          +public boolean getValue()
          +
          +
          get the current value of the conditon +

          +

          +
          +
          +
          + +
          Returns:
          true if the condition
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(boolean value)
          +
          +
          set the value of the condition. + This is used by the script to pass the return value. + It can be used by an attribute, in which case it sets the default + value +

          +

          +
          +
          +
          +
          Parameters:
          value - the value to set the condition to
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptFilter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptFilter.html new file mode 100644 index 000000000..53bec8a14 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptFilter.html @@ -0,0 +1,552 @@ + + + + + + +ScriptFilter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional +
          +Class ScriptFilter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
+          extended by org.apache.tools.ant.types.optional.ScriptFilter
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ChainableReader, TokenFilter.Filter
          +
          +
          +
          +
          public class ScriptFilter
          extends TokenFilter.ChainableReaderFilter
          + + +

          +Most of this is CAP (Cut And Paste) from the Script task + ScriptFilter class, implements TokenFilter.Filter + for scripts to use. + This provides the same beans as the Script Task + to a script. + The script is meant to use get self.token and + set self.token in the reply. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptFilter() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          The script text.
          + PathcreateClasspath() + +
          +          Classpath to be used when searching for classes and resources.
          + java.lang.Stringfilter(java.lang.String token) + +
          +          Called filter the token.
          + java.lang.StringgetToken() + +
          +          The current token
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used when searching for classes and resources.
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath by reference.
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetManager(java.lang.String manager) + +
          +          Defines the manager.
          + voidsetProject(Project project) + +
          +          Set the project.
          + voidsetSetBeans(boolean setBeans) + +
          +          Set the setbeans attribute.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file ; optional.
          + voidsetToken(java.lang.String token) + +
          +          The current token
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.filters.TokenFilter.ChainableReaderFilter
          chain, setByLine
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptFilter

          +
          +public ScriptFilter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Set the project. +

          +

          +
          Overrides:
          setProject in class ProjectComponent
          +
          +
          +
          Parameters:
          project - the owner of this component.
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +setToken

          +
          +public void setToken(java.lang.String token)
          +
          +
          The current token +

          +

          +
          Parameters:
          token - the string filtered by the script
          +
          +
          +
          + +

          +getToken

          +
          +public java.lang.String getToken()
          +
          +
          The current token +

          +

          + +
          Returns:
          the string filtered by the script
          +
          +
          +
          + +

          +filter

          +
          +public java.lang.String filter(java.lang.String token)
          +
          +
          Called filter the token. + This sets the token in this object, calls + the script and returns the token. +

          +

          +
          Parameters:
          token - the token to be filtered +
          Returns:
          the filtered token
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file ; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          The script text. +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +setManager

          +
          +public void setManager(java.lang.String manager)
          +
          +
          Defines the manager. +

          +

          +
          Parameters:
          manager - the scripting manager.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used when searching for classes and resources. +

          +

          +
          Parameters:
          classpath - an Ant Path object containing the search path.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Classpath to be used when searching for classes and resources. +

          +

          + +
          Returns:
          an empty Path instance to be configured by Ant.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath by reference. +

          +

          +
          Parameters:
          r - a Reference to a Path instance to be used as the classpath + value.
          +
          +
          +
          + +

          +setSetBeans

          +
          +public void setSetBeans(boolean setBeans)
          +
          +
          Set the setbeans attribute. + If this is true, <script> will create variables in the + script instance for all + properties, targets and references of the current project. + It this is false, only the project and self variables will + be set. + The default is true. +

          +

          +
          Parameters:
          setBeans - the value to set.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptMapper.html new file mode 100644 index 000000000..7a520638f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptMapper.html @@ -0,0 +1,406 @@ + + + + + + +ScriptMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional +
          +Class ScriptMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.optional.AbstractScriptComponent
+          extended by org.apache.tools.ant.types.optional.ScriptMapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileNameMapper
          +
          +
          +
          +
          public class ScriptMapper
          extends AbstractScriptComponent
          implements FileNameMapper
          + + +

          +Script support at map time. +

          + +

          +

          +
          Since:
          +
          Ant1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddMappedName(java.lang.String mapping) + +
          +          Add a mapped name
          + voidclear() + +
          +          Reset the list of files
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the given source + file.
          + voidsetFrom(java.lang.String from) + +
          +          Sets the from part of the transformation rule.
          + voidsetTo(java.lang.String to) + +
          +          Sets the to part of the transformation rule.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.AbstractScriptComponent
          addText, createClasspath, executeScript, getRunner, initScriptRunner, setClasspath, setClasspathRef, setLanguage, setManager, setProject, setSetBeans, setSrc
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptMapper

          +
          +public ScriptMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Sets the from part of the transformation rule. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - a string.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Sets the to part of the transformation rule. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - a string.
          +
          +
          +
          + +

          +clear

          +
          +public void clear()
          +
          +
          Reset the list of files +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +addMappedName

          +
          +public void addMappedName(java.lang.String mapping)
          +
          +
          Add a mapped name +

          +

          +
          +
          +
          +
          Parameters:
          mapping - the value to use.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the given source + file. +

          +

          if the given rule doesn't apply to the source file, implementation + must return null. SourceFileScanner will then omit the source file in + question.

          +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the name of the source file relative to some given + basedirectory. +
          Returns:
          an array of strings if the rule applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptSelector.html new file mode 100644 index 000000000..4094663ad --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/ScriptSelector.html @@ -0,0 +1,639 @@ + + + + + + +ScriptSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional +
          +Class ScriptSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.optional.ScriptSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class ScriptSelector
          extends BaseSelector
          + + +

          +Selector that lets you run a script with selection logic inline +

          + +

          +

          +
          Since:
          +
          Ant1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ScriptSelector() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          The script text.
          + PathcreateClasspath() + +
          +          Classpath to be used when searching for classes and resources.
          + java.io.FilegetBasedir() + +
          +          get the base directory
          + java.io.FilegetFile() + +
          +          get the file that is currently to be tested
          + java.lang.StringgetFilename() + +
          +          get the filename of the file
          + booleanisSelected() + +
          +          get state of selected flag
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their selection + behaviour.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used when searching for classes and resources.
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath by reference.
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetManager(java.lang.String manager) + +
          +          Defines the manager.
          + voidsetProject(Project project) + +
          +          Set the project.
          + voidsetSelected(boolean selected) + +
          +          set the selected state + Intended for script use, not as an Ant attribute
          + voidsetSetBeans(boolean setBeans) + +
          +          Set the setbeans attribute.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file ; optional.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptSelector

          +
          +public ScriptSelector()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Set the project. +

          +

          +
          Overrides:
          setProject in class ProjectComponent
          +
          +
          +
          Parameters:
          project - the owner of this component.
          +
          +
          +
          + +

          +setManager

          +
          +public void setManager(java.lang.String manager)
          +
          +
          Defines the manager. +

          +

          +
          Parameters:
          manager - the scripting manager.
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file ; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          The script text. +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used when searching for classes and resources. +

          +

          +
          Parameters:
          classpath - an Ant Path object containing the search path.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Classpath to be used when searching for classes and resources. +

          +

          + +
          Returns:
          an empty Path instance to be configured by Ant.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath by reference. +

          +

          +
          Parameters:
          r - a Reference to a Path instance to be used as the classpath + value.
          +
          +
          +
          + +

          +setSetBeans

          +
          +public void setSetBeans(boolean setBeans)
          +
          +
          Set the setbeans attribute. + If this is true, <script> will create variables in the + script instance for all + properties, targets and references of the current project. + It this is false, only the project and self variables will + be set. + The default is true. +

          +

          +
          Parameters:
          setBeans - the value to set.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Method that each selector will implement to create their selection + behaviour. If there is a problem with the setup of a selector, it can + throw a BuildException to indicate the problem. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +getBasedir

          +
          +public java.io.File getBasedir()
          +
          +
          get the base directory +

          +

          + +
          Returns:
          the base directory
          +
          +
          +
          + +

          +getFilename

          +
          +public java.lang.String getFilename()
          +
          +
          get the filename of the file +

          +

          + +
          Returns:
          the filename of the file that is currently been tested
          +
          +
          +
          + +

          +getFile

          +
          +public java.io.File getFile()
          +
          +
          get the file that is currently to be tested +

          +

          + +
          Returns:
          the file that is currently been tested
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected()
          +
          +
          get state of selected flag +

          +

          + +
          Returns:
          the selected flag
          +
          +
          +
          + +

          +setSelected

          +
          +public void setSelected(boolean selected)
          +
          +
          set the selected state + Intended for script use, not as an Ant attribute +

          +

          +
          Parameters:
          selected - the selected state
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.ClassRoot.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.ClassRoot.html new file mode 100644 index 000000000..777e1acc7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.ClassRoot.html @@ -0,0 +1,278 @@ + + + + + + +ClassfileSet.ClassRoot (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.depend +
          +Class ClassfileSet.ClassRoot

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.optional.depend.ClassfileSet.ClassRoot
+
          +
          +
          Enclosing class:
          ClassfileSet
          +
          +
          +
          +
          public static class ClassfileSet.ClassRoot
          extends java.lang.Object
          + + +

          +Inner class used to contain info about root classes. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ClassfileSet.ClassRoot() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetClassname() + +
          +          Get the name of the root class.
          + voidsetClassname(java.lang.String name) + +
          +          Set the root class name.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ClassfileSet.ClassRoot

          +
          +public ClassfileSet.ClassRoot()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String name)
          +
          +
          Set the root class name. +

          +

          +
          Parameters:
          name - the name of the root class.
          +
          +
          +
          + +

          +getClassname

          +
          +public java.lang.String getClassname()
          +
          +
          Get the name of the root class. +

          +

          + +
          Returns:
          the name of the root class.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.html new file mode 100644 index 000000000..069fcc7ff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/ClassfileSet.html @@ -0,0 +1,505 @@ + + + + + + +ClassfileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.depend +
          +Class ClassfileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.optional.depend.ClassfileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          +
          public class ClassfileSet
          extends FileSet
          + + +

          +A ClassfileSet is a FileSet that enlists all classes that depend on a + certain set of root classes. + + ClassfileSet extends FileSet, its inherited properties + defining the domain searched for dependent classes. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classClassfileSet.ClassRoot + +
          +          Inner class used to contain info about root classes.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + ClassfileSet() + +
          +          Default constructor.
          +protected ClassfileSet(ClassfileSet s) + +
          +          Create a ClassfileSet from another ClassfileSet.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredRoot(ClassfileSet.ClassRoot root) + +
          +          Add a nested root class definition to this class file set.
          + voidaddRootFileset(FileSet rootFileSet) + +
          +          Add a fileset to which contains a collection of root classes used to + drive the search from classes.
          + java.lang.Objectclone() + +
          +          Clone this data type.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + DirectoryScannergetDirectoryScanner(Project p) + +
          +          Return the DirectoryScanner associated with this FileSet.
          + voidsetRootClass(java.lang.String rootClass) + +
          +          Set the root class attribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.FileSet
          isFilesystemOnly, iterator, size
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ClassfileSet

          +
          +public ClassfileSet()
          +
          +
          Default constructor. +

          +

          +
          + +

          +ClassfileSet

          +
          +protected ClassfileSet(ClassfileSet s)
          +
          +
          Create a ClassfileSet from another ClassfileSet. +

          +

          +
          Parameters:
          s - the other classfileset.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addRootFileset

          +
          +public void addRootFileset(FileSet rootFileSet)
          +
          +
          Add a fileset to which contains a collection of root classes used to + drive the search from classes. +

          +

          +
          Parameters:
          rootFileSet - a root file set to be used to search for dependent + classes.
          +
          +
          +
          + +

          +setRootClass

          +
          +public void setRootClass(java.lang.String rootClass)
          +
          +
          Set the root class attribute. +

          +

          +
          Parameters:
          rootClass - the name of the root class.
          +
          +
          +
          + +

          +getDirectoryScanner

          +
          +public DirectoryScanner getDirectoryScanner(Project p)
          +
          +
          Return the DirectoryScanner associated with this FileSet. +

          +

          +
          Overrides:
          getDirectoryScanner in class AbstractFileSet
          +
          +
          +
          Parameters:
          p - the project used to resolve dirs, etc. +
          Returns:
          a dependency scanner.
          +
          +
          +
          + +

          +addConfiguredRoot

          +
          +public void addConfiguredRoot(ClassfileSet.ClassRoot root)
          +
          +
          Add a nested root class definition to this class file set. +

          +

          +
          Parameters:
          root - the configured class root.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Clone this data type. +

          +

          +
          Overrides:
          clone in class FileSet
          +
          +
          + +
          Returns:
          a clone of the class file set.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class AbstractFileSet
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/DependScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/DependScanner.html new file mode 100644 index 000000000..d66f8ec87 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/DependScanner.html @@ -0,0 +1,703 @@ + + + + + + +DependScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.depend +
          +Class DependScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.DirectoryScanner
+      extended by org.apache.tools.ant.types.optional.depend.DependScanner
+
          +
          +
          All Implemented Interfaces:
          FileScanner, ResourceFactory, SelectorScanner
          +
          +
          +
          +
          public class DependScanner
          extends DirectoryScanner
          + + +

          +DirectoryScanner for finding class dependencies. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_ANALYZER_CLASS + +
          +          The name of the analyzer to use by default.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.DirectoryScanner
          basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors
          +  + + + + + + + + + + +
          +Constructor Summary
          DependScanner(DirectoryScanner parentScanner) + +
          +          Create a DependScanner, using the given scanner to provide the basic + set of files from which class files come.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddBasedir(java.io.File baseDir) + +
          +           
          + voidaddDefaultExcludes() + +
          +          Add default exclusions to the current exclusions set.
          + java.lang.String[]getExcludedDirectories() + +
          +          Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns..
          + java.lang.String[]getExcludedFiles() + +
          +          Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns..
          + java.lang.String[]getIncludedDirectories() + +
          +          Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns..
          + intgetIncludedDirsCount() + +
          +          Return the count of included directories..
          + java.lang.String[]getIncludedFiles() + +
          +          Get the names of the class files on which baseClass depends.
          + intgetIncludedFilesCount() + +
          +          Return the count of included files..
          + java.lang.String[]getNotIncludedDirectories() + +
          +          Return the names of the directories which matched none of the include + patterns..
          + java.lang.String[]getNotIncludedFiles() + +
          +          Return the names of the files which matched none of the include + patterns..
          + voidscan() + +
          +          Scans the base directory for files on which baseClass depends.
          + voidsetCaseSensitive(boolean isCaseSensitive) + +
          +          Set whether or not include and exclude patterns are matched + in a case sensitive way..
          + voidsetExcludes(java.lang.String[] excludes) + +
          +          Set the list of exclude patterns to use..
          + voidsetIncludes(java.lang.String[] includes) + +
          +          Set the list of include patterns to use..
          + voidsetRootClasses(java.util.Vector rootClasses) + +
          +          Sets the root classes to be used to drive the scan.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.DirectoryScanner
          addDefaultExclude, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getNotFollowedSymlinks, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setErrorOnMissingDir, setFollowSymlinks, setMaxLevelsOfSymlinks, setSelectors, slowScan
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_ANALYZER_CLASS

          +
          +public static final java.lang.String DEFAULT_ANALYZER_CLASS
          +
          +
          The name of the analyzer to use by default. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DependScanner

          +
          +public DependScanner(DirectoryScanner parentScanner)
          +
          +
          Create a DependScanner, using the given scanner to provide the basic + set of files from which class files come. +

          +

          +
          Parameters:
          parentScanner - the DirectoryScanner which returns the files from + which class files must come.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRootClasses

          +
          +public void setRootClasses(java.util.Vector rootClasses)
          +
          +
          Sets the root classes to be used to drive the scan. +

          +

          +
          Parameters:
          rootClasses - the rootClasses to be used for this scan.
          +
          +
          +
          + +

          +getIncludedFiles

          +
          +public java.lang.String[] getIncludedFiles()
          +
          +
          Get the names of the class files on which baseClass depends. +

          +

          +
          Specified by:
          getIncludedFiles in interface FileScanner
          Overrides:
          getIncludedFiles in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the files.
          +
          +
          +
          + +

          +getIncludedFilesCount

          +
          +public int getIncludedFilesCount()
          +
          +
          Return the count of included files.. +

          +

          +
          Overrides:
          getIncludedFilesCount in class DirectoryScanner
          +
          +
          + +
          Returns:
          int.
          +
          +
          +
          + +

          +scan

          +
          +public void scan()
+          throws java.lang.IllegalStateException
          +
          +
          Scans the base directory for files on which baseClass depends. +

          +

          +
          Specified by:
          scan in interface FileScanner
          Overrides:
          scan in class DirectoryScanner
          +
          +
          + +
          Throws: +
          java.lang.IllegalStateException - when basedir was set incorrectly.
          +
          +
          +
          + +

          +addDefaultExcludes

          +
          +public void addDefaultExcludes()
          +
          +
          Description copied from class: DirectoryScanner
          +
          Add default exclusions to the current exclusions set. +

          +

          +
          Specified by:
          addDefaultExcludes in interface FileScanner
          Overrides:
          addDefaultExcludes in class DirectoryScanner
          +
          +
          +
          See Also:
          DirectoryScanner.addDefaultExcludes()
          +
          +
          +
          + +

          +getExcludedDirectories

          +
          +public java.lang.String[] getExcludedDirectories()
          +
          +
          Return the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.. +

          +

          +
          Specified by:
          getExcludedDirectories in interface FileScanner
          Overrides:
          getExcludedDirectories in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the directories which matched at least one of the + include patterns and at least one of the exclude patterns.
          See Also:
          DirectoryScanner.slowScan()
          +
          +
          +
          + +

          +getExcludedFiles

          +
          +public java.lang.String[] getExcludedFiles()
          +
          +
          Return the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns. + The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.. +

          +

          +
          Specified by:
          getExcludedFiles in interface FileScanner
          Overrides:
          getExcludedFiles in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the files which matched at least one of the + include patterns and at least one of the exclude patterns.
          See Also:
          DirectoryScanner.slowScan()
          +
          +
          +
          + +

          +getIncludedDirectories

          +
          +public java.lang.String[] getIncludedDirectories()
          +
          +
          Return the names of the directories which matched at least one of the + include patterns and none of the exclude patterns. + The names are relative to the base directory.. +

          +

          +
          Specified by:
          getIncludedDirectories in interface FileScanner
          Overrides:
          getIncludedDirectories in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the directories which matched at least one of the + include patterns and none of the exclude patterns.
          +
          +
          +
          + +

          +getIncludedDirsCount

          +
          +public int getIncludedDirsCount()
          +
          +
          Return the count of included directories.. +

          +

          +
          Overrides:
          getIncludedDirsCount in class DirectoryScanner
          +
          +
          + +
          Returns:
          int.
          +
          +
          +
          + +

          +getNotIncludedDirectories

          +
          +public java.lang.String[] getNotIncludedDirectories()
          +
          +
          Return the names of the directories which matched none of the include + patterns. The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.. +

          +

          +
          Specified by:
          getNotIncludedDirectories in interface FileScanner
          Overrides:
          getNotIncludedDirectories in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the directories which matched none of the include + patterns.
          See Also:
          DirectoryScanner.slowScan()
          +
          +
          +
          + +

          +getNotIncludedFiles

          +
          +public java.lang.String[] getNotIncludedFiles()
          +
          +
          Return the names of the files which matched none of the include + patterns. The names are relative to the base directory. This involves + performing a slow scan if one has not already been completed.. +

          +

          +
          Specified by:
          getNotIncludedFiles in interface FileScanner
          Overrides:
          getNotIncludedFiles in class DirectoryScanner
          +
          +
          + +
          Returns:
          the names of the files which matched none of the include + patterns.
          See Also:
          DirectoryScanner.slowScan()
          +
          +
          +
          + +

          +setExcludes

          +
          +public void setExcludes(java.lang.String[] excludes)
          +
          +
          Set the list of exclude patterns to use. All '/' and '\' characters + are replaced by File.separatorChar, so the separator used + need not match File.separatorChar. +

          + When a pattern ends with a '/' or '\', "**" is appended.. +

          +

          +
          Specified by:
          setExcludes in interface FileScanner
          Overrides:
          setExcludes in class DirectoryScanner
          +
          +
          +
          Parameters:
          excludes - A list of exclude patterns. + May be null, indicating that no files + should be excluded. If a non-null list is + given, all elements must be non-null.
          +
          +
          +
          + +

          +setIncludes

          +
          +public void setIncludes(java.lang.String[] includes)
          +
          +
          Set the list of include patterns to use. All '/' and '\' characters + are replaced by File.separatorChar, so the separator used + need not match File.separatorChar. +

          + When a pattern ends with a '/' or '\', "**" is appended.. +

          +

          +
          Specified by:
          setIncludes in interface FileScanner
          Overrides:
          setIncludes in class DirectoryScanner
          +
          +
          +
          Parameters:
          includes - A list of include patterns. + May be null, indicating that all files + should be included. If a non-null + list is given, all elements must be + non-null.
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean isCaseSensitive)
          +
          +
          Set whether or not include and exclude patterns are matched + in a case sensitive way.. +

          +

          +
          Specified by:
          setCaseSensitive in interface FileScanner
          Overrides:
          setCaseSensitive in class DirectoryScanner
          +
          +
          +
          Parameters:
          isCaseSensitive - whether or not the file system should be + regarded as a case sensitive one.
          +
          +
          +
          + +

          +addBasedir

          +
          +public void addBasedir(java.io.File baseDir)
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-frame.html new file mode 100644 index 000000000..bfd851152 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +org.apache.tools.ant.types.optional.depend (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.optional.depend + + + + +
          +Classes  + +
          +ClassfileSet +
          +ClassfileSet.ClassRoot +
          +DependScanner
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-summary.html new file mode 100644 index 000000000..28c967688 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-summary.html @@ -0,0 +1,161 @@ + + + + + + +org.apache.tools.ant.types.optional.depend (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.optional.depend +

          + + + + + + + + + + + + + + + + + +
          +Class Summary
          ClassfileSetA ClassfileSet is a FileSet that enlists all classes that depend on a + certain set of root classes.
          ClassfileSet.ClassRootInner class used to contain info about root classes.
          DependScannerDirectoryScanner for finding class dependencies.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-tree.html new file mode 100644 index 000000000..de1567286 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/depend/package-tree.html @@ -0,0 +1,162 @@ + + + + + + +org.apache.tools.ant.types.optional.depend Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.optional.depend +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Arc.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Arc.html new file mode 100644 index 000000000..e2100eff3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Arc.html @@ -0,0 +1,569 @@ + + + + + + +Arc (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Arc

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.BasicShape
+                  extended by org.apache.tools.ant.types.optional.image.Arc
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Arc
          extends BasicShape
          implements DrawOperation
          + + +

          +Draw an arc. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  intheight + +
          +           
          +protected  intstart + +
          +           
          +protected  intstop + +
          +           
          +protected  inttype + +
          +           
          +protected  intwidth + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          fill, stroke, stroke_width
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Arc() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object..
          + voidsetHeight(int height) + +
          +          Set the height.
          + voidsetStart(int start) + +
          +          Set the start of the arc.
          + voidsetStop(int stop) + +
          +          Set the stop of the arc.
          + voidsetType(java.lang.String strType) + +
          +          Set the type of arc.
          + voidsetWidth(int width) + +
          +          Set the width.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          setFill, setStroke, setStrokewidth
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRectangle, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +width

          +
          +protected int width
          +
          +
          +
          +
          +
          + +

          +height

          +
          +protected int height
          +
          +
          +
          +
          +
          + +

          +start

          +
          +protected int start
          +
          +
          +
          +
          +
          + +

          +stop

          +
          +protected int stop
          +
          +
          +
          +
          +
          + +

          +type

          +
          +protected int type
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Arc

          +
          +public Arc()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setWidth

          +
          +public void setWidth(int width)
          +
          +
          Set the width. +

          +

          +
          +
          +
          +
          Parameters:
          width - the width of the arc.
          +
          +
          +
          + +

          +setHeight

          +
          +public void setHeight(int height)
          +
          +
          Set the height. +

          +

          +
          +
          +
          +
          Parameters:
          height - the height of the arc.
          +
          +
          +
          + +

          +setStart

          +
          +public void setStart(int start)
          +
          +
          Set the start of the arc. +

          +

          +
          +
          +
          +
          Parameters:
          start - the start of the arc.
          +
          +
          +
          + +

          +setStop

          +
          +public void setStop(int stop)
          +
          +
          Set the stop of the arc. +

          +

          +
          +
          +
          +
          Parameters:
          stop - the stop of the arc.
          +
          +
          +
          + +

          +setType

          +
          +public void setType(java.lang.String strType)
          +
          +
          Set the type of arc. +

          +

          +
          +
          +
          +
          Parameters:
          strType - the type to use - open, pie or chord.
          To do:
          +
          refactor using an EnumeratedAttribute
          +
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. Use + an Alpha channel for a "transparent" background.. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          a planar image
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/BasicShape.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/BasicShape.html new file mode 100644 index 000000000..b2e451b8d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/BasicShape.html @@ -0,0 +1,448 @@ + + + + + + +BasicShape (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class BasicShape

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.BasicShape
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          Direct Known Subclasses:
          Arc, Ellipse, Rectangle
          +
          +
          +
          +
          public abstract class BasicShape
          extends ImageOperation
          implements DrawOperation
          + + +

          +Draw a basic shape +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.Stringfill + +
          +           
          +protected  java.lang.Stringstroke + +
          +           
          +protected  intstroke_width + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          BasicShape() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidsetFill(java.lang.String col) + +
          +          Set the fill attribute.
          + voidsetStroke(java.lang.String col) + +
          +          Set the stroke attribute.
          + voidsetStrokewidth(int width) + +
          +          Set the stroke width attribute.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRectangle, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.types.optional.image.DrawOperation
          executeDrawOperation
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +stroke_width

          +
          +protected int stroke_width
          +
          +
          +
          +
          +
          + +

          +fill

          +
          +protected java.lang.String fill
          +
          +
          +
          +
          +
          + +

          +stroke

          +
          +protected java.lang.String stroke
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +BasicShape

          +
          +public BasicShape()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFill

          +
          +public void setFill(java.lang.String col)
          +
          +
          Set the fill attribute. +

          +

          +
          +
          +
          +
          Parameters:
          col - the color value to use.
          +
          +
          +
          + +

          +setStroke

          +
          +public void setStroke(java.lang.String col)
          +
          +
          Set the stroke attribute. +

          +

          +
          +
          +
          +
          Parameters:
          col - the color value to use.
          +
          +
          +
          + +

          +setStrokewidth

          +
          +public void setStrokewidth(int width)
          +
          +
          Set the stroke width attribute. +

          +

          +
          +
          +
          +
          Parameters:
          width - the value to use.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ColorMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ColorMapper.html new file mode 100644 index 000000000..fcfa18151 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ColorMapper.html @@ -0,0 +1,559 @@ + + + + + + +ColorMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class ColorMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.optional.image.ColorMapper
+
          +
          +
          +
          public final class ColorMapper
          extends java.lang.Object
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCOLOR_BLACK + +
          +          black string
          +static java.lang.StringCOLOR_BLUE + +
          +          blue string
          +static java.lang.StringCOLOR_CYAN + +
          +          cyan string
          +static java.lang.StringCOLOR_DARKGRAY + +
          +          black string
          +static java.lang.StringCOLOR_DARKGREY + +
          +          darkgrey string
          +static java.lang.StringCOLOR_GRAY + +
          +          gray string
          +static java.lang.StringCOLOR_GREEN + +
          +          green string
          +static java.lang.StringCOLOR_GREY + +
          +          grey string
          +static java.lang.StringCOLOR_LIGHTGRAY + +
          +          lightgray string
          +static java.lang.StringCOLOR_LIGHTGREY + +
          +          lightgrey string
          +static java.lang.StringCOLOR_MAGENTA + +
          +          magenta string
          +static java.lang.StringCOLOR_ORANGE + +
          +          orange string
          +static java.lang.StringCOLOR_PINK + +
          +          pink string
          +static java.lang.StringCOLOR_RED + +
          +          reg string
          +static java.lang.StringCOLOR_WHITE + +
          +          white string
          +static java.lang.StringCOLOR_YELLOW + +
          +          yellow string
          +  + + + + + + + + + + + +
          +Method Summary
          +static java.awt.ColorgetColorByName(java.lang.String colorName) + +
          +          Convert a color name to a color value.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +COLOR_BLACK

          +
          +public static final java.lang.String COLOR_BLACK
          +
          +
          black string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_BLUE

          +
          +public static final java.lang.String COLOR_BLUE
          +
          +
          blue string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_CYAN

          +
          +public static final java.lang.String COLOR_CYAN
          +
          +
          cyan string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_DARKGRAY

          +
          +public static final java.lang.String COLOR_DARKGRAY
          +
          +
          black string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_GRAY

          +
          +public static final java.lang.String COLOR_GRAY
          +
          +
          gray string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_LIGHTGRAY

          +
          +public static final java.lang.String COLOR_LIGHTGRAY
          +
          +
          lightgray string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_DARKGREY

          +
          +public static final java.lang.String COLOR_DARKGREY
          +
          +
          darkgrey string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_GREY

          +
          +public static final java.lang.String COLOR_GREY
          +
          +
          grey string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_LIGHTGREY

          +
          +public static final java.lang.String COLOR_LIGHTGREY
          +
          +
          lightgrey string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_GREEN

          +
          +public static final java.lang.String COLOR_GREEN
          +
          +
          green string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_MAGENTA

          +
          +public static final java.lang.String COLOR_MAGENTA
          +
          +
          magenta string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_ORANGE

          +
          +public static final java.lang.String COLOR_ORANGE
          +
          +
          orange string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_PINK

          +
          +public static final java.lang.String COLOR_PINK
          +
          +
          pink string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_RED

          +
          +public static final java.lang.String COLOR_RED
          +
          +
          reg string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_WHITE

          +
          +public static final java.lang.String COLOR_WHITE
          +
          +
          white string +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +COLOR_YELLOW

          +
          +public static final java.lang.String COLOR_YELLOW
          +
          +
          yellow string +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getColorByName

          +
          +public static java.awt.Color getColorByName(java.lang.String colorName)
          +
          +
          Convert a color name to a color value. +

          +

          +
          Parameters:
          colorName - a string repr of the color. +
          Returns:
          the color value.
          To do:
          +
          refactor to use an EnumeratedAttribute (maybe?)
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Draw.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Draw.html new file mode 100644 index 000000000..dafa6092d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Draw.html @@ -0,0 +1,502 @@ + + + + + + +Draw (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Draw

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.TransformOperation
+                  extended by org.apache.tools.ant.types.optional.image.Draw
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Draw
          extends TransformOperation
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  intxloc + +
          +           
          +protected  intyloc + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Draw() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddArc(Arc arc) + +
          +          Add an arc.
          + voidaddEllipse(Ellipse elip) + +
          +          Add an ellipse.
          + voidaddRectangle(Rectangle rect) + +
          +          Add a rectangle to the operation...
          + voidaddText(Text text) + +
          +          Add text to the operation..
          + javax.media.jai.PlanarImageexecuteTransformOperation(javax.media.jai.PlanarImage image) + +
          +          Performs the transformations..
          + voidsetXloc(int x) + +
          +          Set the X location.
          + voidsetYloc(int y) + +
          +          Set the Y location.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRotate, addScale
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +xloc

          +
          +protected int xloc
          +
          +
          +
          +
          +
          + +

          +yloc

          +
          +protected int yloc
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Draw

          +
          +public Draw()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setXloc

          +
          +public void setXloc(int x)
          +
          +
          Set the X location. +

          +

          +
          Parameters:
          x - the value to use.
          +
          +
          +
          + +

          +setYloc

          +
          +public void setYloc(int y)
          +
          +
          Set the Y location. +

          +

          +
          Parameters:
          y - the value to use.
          +
          +
          +
          + +

          +addRectangle

          +
          +public void addRectangle(Rectangle rect)
          +
          +
          Add a rectangle to the operation... +

          +

          +
          Overrides:
          addRectangle in class TransformOperation
          +
          +
          +
          Parameters:
          rect - the rectangle to add.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(Text text)
          +
          +
          Add text to the operation.. +

          +

          +
          Overrides:
          addText in class ImageOperation
          +
          +
          +
          Parameters:
          text - the text to add.
          +
          +
          +
          + +

          +addEllipse

          +
          +public void addEllipse(Ellipse elip)
          +
          +
          Add an ellipse. +

          +

          +
          Parameters:
          elip - the ellipse to add.
          +
          +
          +
          + +

          +addArc

          +
          +public void addArc(Arc arc)
          +
          +
          Add an arc. +

          +

          +
          Parameters:
          arc - the arc to add.
          +
          +
          +
          + +

          +executeTransformOperation

          +
          +public javax.media.jai.PlanarImage executeTransformOperation(javax.media.jai.PlanarImage image)
          +
          +
          Performs the transformations.. +

          +

          +
          Specified by:
          executeTransformOperation in class TransformOperation
          +
          +
          +
          Parameters:
          image - The image to perform the transformation on. +
          Returns:
          the transformed image.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/DrawOperation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/DrawOperation.html new file mode 100644 index 000000000..1e62dbe9c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/DrawOperation.html @@ -0,0 +1,220 @@ + + + + + + +DrawOperation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Interface DrawOperation

          +
          +
          All Known Implementing Classes:
          Arc, BasicShape, Ellipse, Rectangle, Rotate, Scale, Text
          +
          +
          +
          +
          public interface DrawOperation
          + + +

          +Interface which represents an Operation which is "drawable", such + as a Rectangle, Circle or Text. The Operation is responsible for + creating its own image buffer and drawing itself into it, then + wrapping and returning it as a PlanarImage. This allows multible + "drawable" objects to be nested. +

          + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +executeDrawOperation

          +
          +javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. Use + an Alpha channel for a "transparent" background. +

          +

          + +
          Returns:
          a planar image
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Ellipse.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Ellipse.html new file mode 100644 index 000000000..cddad9e4f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Ellipse.html @@ -0,0 +1,443 @@ + + + + + + +Ellipse (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Ellipse

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.BasicShape
+                  extended by org.apache.tools.ant.types.optional.image.Ellipse
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Ellipse
          extends BasicShape
          implements DrawOperation
          + + +

          +Draw an ellipse. +

          + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  intheight + +
          +           
          +protected  intwidth + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          fill, stroke, stroke_width
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Ellipse() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object..
          + voidsetHeight(int height) + +
          +          Set the height.
          + voidsetWidth(int width) + +
          +          Set the width.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          setFill, setStroke, setStrokewidth
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRectangle, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +width

          +
          +protected int width
          +
          +
          +
          +
          +
          + +

          +height

          +
          +protected int height
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Ellipse

          +
          +public Ellipse()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setWidth

          +
          +public void setWidth(int width)
          +
          +
          Set the width. +

          +

          +
          +
          +
          +
          Parameters:
          width - the width of the elipse.
          +
          +
          +
          + +

          +setHeight

          +
          +public void setHeight(int height)
          +
          +
          Set the height. +

          +

          +
          +
          +
          +
          Parameters:
          height - the height of the elipse.
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. Use + an Alpha channel for a "transparent" background.. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          a planar image
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ImageOperation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ImageOperation.html new file mode 100644 index 000000000..4896515ae --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/ImageOperation.html @@ -0,0 +1,415 @@ + + + + + + +ImageOperation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class ImageOperation

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          BasicShape, Text, TransformOperation
          +
          +
          +
          +
          public abstract class ImageOperation
          extends DataType
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.util.Vectorinstructions + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ImageOperation() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddDraw(Draw instr) + +
          +          Add a draw to the operation.
          + voidaddRectangle(Rectangle instr) + +
          +          Add a rectangle to the operation.
          + voidaddRotate(Rotate instr) + +
          +          Add a rotate to the operation.
          + voidaddScale(Scale instr) + +
          +          Add a scale to the operation.
          + voidaddText(Text instr) + +
          +          Add text to the operation.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +instructions

          +
          +protected java.util.Vector instructions
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ImageOperation

          +
          +public ImageOperation()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addRotate

          +
          +public void addRotate(Rotate instr)
          +
          +
          Add a rotate to the operation. +

          +

          +
          Parameters:
          instr - the rotate to add.
          +
          +
          +
          + +

          +addDraw

          +
          +public void addDraw(Draw instr)
          +
          +
          Add a draw to the operation. +

          +

          +
          Parameters:
          instr - the draw to add.
          +
          +
          +
          + +

          +addRectangle

          +
          +public void addRectangle(Rectangle instr)
          +
          +
          Add a rectangle to the operation. +

          +

          +
          Parameters:
          instr - the rectangle to add.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(Text instr)
          +
          +
          Add text to the operation. +

          +

          +
          Parameters:
          instr - the text to add.
          +
          +
          +
          + +

          +addScale

          +
          +public void addScale(Scale instr)
          +
          +
          Add a scale to the operation. +

          +

          +
          Parameters:
          instr - the scale to add.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rectangle.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rectangle.html new file mode 100644 index 000000000..6d41f2b5b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rectangle.html @@ -0,0 +1,523 @@ + + + + + + +Rectangle (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Rectangle

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.BasicShape
+                  extended by org.apache.tools.ant.types.optional.image.Rectangle
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Rectangle
          extends BasicShape
          implements DrawOperation
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  intarcheight + +
          +           
          +protected  intarcwidth + +
          +           
          +protected  intheight + +
          +           
          +protected  intwidth + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          fill, stroke, stroke_width
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Rectangle() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object..
          + voidsetArcheight(int h) + +
          +          Set the arc height.
          + voidsetArcwidth(int w) + +
          +          Set the arc width.
          + voidsetHeight(int h) + +
          +          Set the height.
          + voidsetWidth(int w) + +
          +          Set the width.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.BasicShape
          setFill, setStroke, setStrokewidth
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRectangle, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +width

          +
          +protected int width
          +
          +
          +
          +
          +
          + +

          +height

          +
          +protected int height
          +
          +
          +
          +
          +
          + +

          +arcwidth

          +
          +protected int arcwidth
          +
          +
          +
          +
          +
          + +

          +archeight

          +
          +protected int archeight
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Rectangle

          +
          +public Rectangle()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setWidth

          +
          +public void setWidth(int w)
          +
          +
          Set the width. +

          +

          +
          +
          +
          +
          Parameters:
          w - the value to use.
          +
          +
          +
          + +

          +setHeight

          +
          +public void setHeight(int h)
          +
          +
          Set the height. +

          +

          +
          +
          +
          +
          Parameters:
          h - the value to use.
          +
          +
          +
          + +

          +setArcwidth

          +
          +public void setArcwidth(int w)
          +
          +
          Set the arc width. +

          +

          +
          +
          +
          +
          Parameters:
          w - the value to use.
          +
          +
          +
          + +

          +setArcheight

          +
          +public void setArcheight(int h)
          +
          +
          Set the arc height. +

          +

          +
          +
          +
          +
          Parameters:
          h - the value to use.
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. Use + an Alpha channel for a "transparent" background.. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          a planar image
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rotate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rotate.html new file mode 100644 index 000000000..32992d3ed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Rotate.html @@ -0,0 +1,442 @@ + + + + + + +Rotate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Rotate

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.TransformOperation
+                  extended by org.apache.tools.ant.types.optional.image.Rotate
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Rotate
          extends TransformOperation
          implements DrawOperation
          + + +

          +ImageOperation to rotate an image by a certain degree +

          + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  floatangle + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Rotate() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Performs the image rotation when being handled as a DrawOperation.
          + javax.media.jai.PlanarImageexecuteTransformOperation(javax.media.jai.PlanarImage image) + +
          +          Performs the image rotation when being handled as a TransformOperation.
          + javax.media.jai.PlanarImageperformRotate(javax.media.jai.PlanarImage image) + +
          +          Rotate an image.
          + voidsetAngle(java.lang.String ang) + +
          +          Sets the angle of rotation in degrees.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.TransformOperation
          addRectangle
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +angle

          +
          +protected float angle
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Rotate

          +
          +public Rotate()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setAngle

          +
          +public void setAngle(java.lang.String ang)
          +
          +
          Sets the angle of rotation in degrees. +

          +

          +
          +
          +
          +
          Parameters:
          ang - The angle at which to rotate the image
          +
          +
          +
          + +

          +performRotate

          +
          +public javax.media.jai.PlanarImage performRotate(javax.media.jai.PlanarImage image)
          +
          +
          Rotate an image. +

          +

          +
          +
          +
          +
          Parameters:
          image - the image to rotate. +
          Returns:
          the rotated image.
          +
          +
          +
          + +

          +executeTransformOperation

          +
          +public javax.media.jai.PlanarImage executeTransformOperation(javax.media.jai.PlanarImage image)
          +
          +
          Performs the image rotation when being handled as a TransformOperation. +

          +

          +
          Specified by:
          executeTransformOperation in class TransformOperation
          +
          +
          +
          Parameters:
          image - The image to perform the transformation on. +
          Returns:
          the transformed image.
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Performs the image rotation when being handled as a DrawOperation. + It absolutely requires that there be a DrawOperation nested beneath it, + but only the FIRST DrawOperation will be handled since it can only return + ONE image. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          the image.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.ProportionsAttribute.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.ProportionsAttribute.html new file mode 100644 index 000000000..b87404905 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.ProportionsAttribute.html @@ -0,0 +1,290 @@ + + + + + + +Scale.ProportionsAttribute (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Scale.ProportionsAttribute

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.optional.image.Scale.ProportionsAttribute
+
          +
          +
          Enclosing class:
          Scale
          +
          +
          +
          +
          public static class Scale.ProportionsAttribute
          extends EnumeratedAttribute
          + + +

          +Enumerated class for proportions attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          Scale.ProportionsAttribute() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Scale.ProportionsAttribute

          +
          +public Scale.ProportionsAttribute()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement.. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.html new file mode 100644 index 000000000..8aa651ea0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Scale.html @@ -0,0 +1,527 @@ + + + + + + +Scale (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Scale

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.TransformOperation
+                  extended by org.apache.tools.ant.types.optional.image.Scale
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Scale
          extends TransformOperation
          implements DrawOperation
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classScale.ProportionsAttribute + +
          +          Enumerated class for proportions attribute.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Scale() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object..
          + javax.media.jai.PlanarImageexecuteTransformOperation(javax.media.jai.PlanarImage image) + +
          +          Performs the transformations..
          + floatgetHeight() + +
          +          Get the height.
          + floatgetWidth() + +
          +          Get the width.
          + javax.media.jai.PlanarImageperformScale(javax.media.jai.PlanarImage image) + +
          +          Scale an image.
          + voidsetHeight(java.lang.String height) + +
          +          Sets the height of the image, either as an integer or a %.
          + voidsetProportions(Scale.ProportionsAttribute pa) + +
          +          Sets the behaviour regarding the image proportions.
          + voidsetWidth(java.lang.String width) + +
          +          Sets the width of the image, either as an integer or a %.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.TransformOperation
          addRectangle
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Scale

          +
          +public Scale()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProportions

          +
          +public void setProportions(Scale.ProportionsAttribute pa)
          +
          +
          Sets the behaviour regarding the image proportions. +

          +

          +
          +
          +
          +
          Parameters:
          pa - the enumerated value.
          +
          +
          +
          + +

          +setWidth

          +
          +public void setWidth(java.lang.String width)
          +
          +
          Sets the width of the image, either as an integer or a %. + Defaults to 100%. +

          +

          +
          +
          +
          +
          Parameters:
          width - the value to use.
          +
          +
          +
          + +

          +setHeight

          +
          +public void setHeight(java.lang.String height)
          +
          +
          Sets the height of the image, either as an integer or a %. Defaults to 100%. +

          +

          +
          +
          +
          +
          Parameters:
          height - the value to use.
          +
          +
          +
          + +

          +getWidth

          +
          +public float getWidth()
          +
          +
          Get the width. +

          +

          +
          +
          +
          + +
          Returns:
          the value converted from the width string.
          +
          +
          +
          + +

          +getHeight

          +
          +public float getHeight()
          +
          +
          Get the height. +

          +

          +
          +
          +
          + +
          Returns:
          the value converted from the height string.
          +
          +
          +
          + +

          +performScale

          +
          +public javax.media.jai.PlanarImage performScale(javax.media.jai.PlanarImage image)
          +
          +
          Scale an image. +

          +

          +
          +
          +
          +
          Parameters:
          image - the image to scale. +
          Returns:
          the scaled image.
          +
          +
          +
          + +

          +executeTransformOperation

          +
          +public javax.media.jai.PlanarImage executeTransformOperation(javax.media.jai.PlanarImage image)
          +
          +
          Performs the transformations.. +

          +

          +
          Specified by:
          executeTransformOperation in class TransformOperation
          +
          +
          +
          Parameters:
          image - The image to perform the transformation on. +
          Returns:
          the transformed image.
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Abstract method which is intended to create an image buffer + and return it so it can be drawn into another object. Use + an Alpha channel for a "transparent" background.. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          a planar image
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Text.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Text.html new file mode 100644 index 000000000..cb50e5882 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/Text.html @@ -0,0 +1,468 @@ + + + + + + +Text (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class Text

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.Text
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DrawOperation
          +
          +
          +
          +
          public class Text
          extends ImageOperation
          implements DrawOperation
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Text() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + javax.media.jai.PlanarImageexecuteDrawOperation() + +
          +          Draw the text.
          + voidsetBold(boolean state) + +
          +           
          + voidsetColor(java.lang.String c) + +
          +          Set the color of the text.
          + voidsetFont(java.lang.String f) + +
          +          Set the font to be used to draw the text.
          + voidsetItalic(boolean state) + +
          +           
          + voidsetPoint(java.lang.String p) + +
          +          Set the number of points to be used.
          + voidsetString(java.lang.String str) + +
          +          Set the string to be used as text.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRectangle, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Text

          +
          +public Text()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setString

          +
          +public void setString(java.lang.String str)
          +
          +
          Set the string to be used as text. +

          +

          +
          +
          +
          +
          Parameters:
          str - the string to be used.
          +
          +
          +
          + +

          +setFont

          +
          +public void setFont(java.lang.String f)
          +
          +
          Set the font to be used to draw the text. +

          +

          +
          +
          +
          +
          Parameters:
          f - the font to be used.
          +
          +
          +
          + +

          +setPoint

          +
          +public void setPoint(java.lang.String p)
          +
          +
          Set the number of points to be used. +

          +

          +
          +
          +
          +
          Parameters:
          p - an integer value as a string.
          +
          +
          +
          + +

          +setColor

          +
          +public void setColor(java.lang.String c)
          +
          +
          Set the color of the text. +

          +

          +
          +
          +
          +
          Parameters:
          c - the color name.
          +
          +
          +
          + +

          +setBold

          +
          +public void setBold(boolean state)
          +
          +
          +
          +
          +
          +
          Parameters:
          state - not used at the moment.
          To do:
          +
          is this used?
          +
          +
          +
          +
          + +

          +setItalic

          +
          +public void setItalic(boolean state)
          +
          +
          +
          +
          +
          +
          Parameters:
          state - not used at the moment.
          To do:
          +
          is this used?
          +
          +
          +
          +
          + +

          +executeDrawOperation

          +
          +public javax.media.jai.PlanarImage executeDrawOperation()
          +
          +
          Draw the text. +

          +

          +
          Specified by:
          executeDrawOperation in interface DrawOperation
          +
          +
          + +
          Returns:
          the resultant image.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/TransformOperation.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/TransformOperation.html new file mode 100644 index 000000000..e94fe8821 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/TransformOperation.html @@ -0,0 +1,348 @@ + + + + + + +TransformOperation (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.optional.image +
          +Class TransformOperation

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.optional.image.ImageOperation
+              extended by org.apache.tools.ant.types.optional.image.TransformOperation
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          Draw, Rotate, Scale
          +
          +
          +
          +
          public abstract class TransformOperation
          extends ImageOperation
          + + +

          +

          +
          See Also:
          Image
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          instructions
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          TransformOperation() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddRectangle(Rectangle instr) + +
          +          Add a rectangle to the operation..
          +abstract  javax.media.jai.PlanarImageexecuteTransformOperation(javax.media.jai.PlanarImage img) + +
          +          Performs the transformations.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.optional.image.ImageOperation
          addDraw, addRotate, addScale, addText
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TransformOperation

          +
          +public TransformOperation()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +executeTransformOperation

          +
          +public abstract javax.media.jai.PlanarImage executeTransformOperation(javax.media.jai.PlanarImage img)
          +
          +
          Performs the transformations. +

          +

          +
          Parameters:
          img - The image to perform the transformation on. +
          Returns:
          the transformed image.
          +
          +
          +
          + +

          +addRectangle

          +
          +public void addRectangle(Rectangle instr)
          +
          +
          Add a rectangle to the operation.. +

          +

          +
          Overrides:
          addRectangle in class ImageOperation
          +
          +
          +
          Parameters:
          instr - the rectangle to add.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-frame.html new file mode 100644 index 000000000..e880d3461 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-frame.html @@ -0,0 +1,65 @@ + + + + + + +org.apache.tools.ant.types.optional.image (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.optional.image + + + + +
          +Interfaces  + +
          +DrawOperation
          + + + + + + +
          +Classes  + +
          +Arc +
          +BasicShape +
          +ColorMapper +
          +Draw +
          +Ellipse +
          +ImageOperation +
          +Rectangle +
          +Rotate +
          +Scale +
          +Scale.ProportionsAttribute +
          +Text +
          +TransformOperation
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-summary.html new file mode 100644 index 000000000..829f5a18a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-summary.html @@ -0,0 +1,211 @@ + + + + + + +org.apache.tools.ant.types.optional.image (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.optional.image +

          + + + + + + + + + +
          +Interface Summary
          DrawOperationInterface which represents an Operation which is "drawable", such + as a Rectangle, Circle or Text.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          ArcDraw an arc.
          BasicShapeDraw a basic shape
          ColorMapper 
          Draw 
          EllipseDraw an ellipse.
          ImageOperation 
          Rectangle 
          RotateImageOperation to rotate an image by a certain degree
          Scale 
          Scale.ProportionsAttributeEnumerated class for proportions attribute.
          Text 
          TransformOperation 
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-tree.html new file mode 100644 index 000000000..ea9d459df --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/image/package-tree.html @@ -0,0 +1,173 @@ + + + + + + +org.apache.tools.ant.types.optional.image Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.optional.image +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.types.optional.image.ColorMapper
            • org.apache.tools.ant.types.EnumeratedAttribute +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.types.DataType (implements java.lang.Cloneable) +
                  +
                • org.apache.tools.ant.types.optional.image.ImageOperation
                    +
                  • org.apache.tools.ant.types.optional.image.BasicShape (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                      +
                    • org.apache.tools.ant.types.optional.image.Arc (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                    • org.apache.tools.ant.types.optional.image.Ellipse (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                    • org.apache.tools.ant.types.optional.image.Rectangle (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                    +
                  • org.apache.tools.ant.types.optional.image.Text (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                  • org.apache.tools.ant.types.optional.image.TransformOperation
                      +
                    • org.apache.tools.ant.types.optional.image.Draw
                    • org.apache.tools.ant.types.optional.image.Rotate (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                    • org.apache.tools.ant.types.optional.image.Scale (implements org.apache.tools.ant.types.optional.image.DrawOperation) +
                    +
                  +
                +
              +
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-frame.html new file mode 100644 index 000000000..8168c06b3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-frame.html @@ -0,0 +1,40 @@ + + + + + + +org.apache.tools.ant.types.optional (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.optional + + + + +
          +Classes  + +
          +AbstractScriptComponent +
          +ScriptCondition +
          +ScriptFilter +
          +ScriptMapper +
          +ScriptSelector
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-summary.html new file mode 100644 index 000000000..52201eb46 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +org.apache.tools.ant.types.optional (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.optional +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractScriptComponentThis is a ProjectComponent that has script support built in + Use it as a foundation for scriptable things.
          ScriptConditionA condition that lets you include script.
          ScriptFilterMost of this is CAP (Cut And Paste) from the Script task + ScriptFilter class, implements TokenFilter.Filter + for scripts to use.
          ScriptMapperScript support at map time.
          ScriptSelectorSelector that lets you run a script with selection logic inline
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-tree.html new file mode 100644 index 000000000..15077cf95 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/optional/package-tree.html @@ -0,0 +1,163 @@ + + + + + + +org.apache.tools.ant.types.optional Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.optional +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-frame.html new file mode 100644 index 000000000..1d5f408ba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-frame.html @@ -0,0 +1,151 @@ + + + + + + +org.apache.tools.ant.types (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types + + + + +
          +Interfaces  + +
          +Parameterizable +
          +ResourceCollection +
          +ResourceFactory
          + + + + + + +
          +Classes  + +
          +AbstractFileSet +
          +AntFilterReader +
          +ArchiveFileSet +
          +ArchiveScanner +
          +Assertions +
          +Assertions.BaseAssertion +
          +Assertions.DisabledAssertion +
          +Assertions.EnabledAssertion +
          +Commandline +
          +Commandline.Argument +
          +CommandlineJava +
          +CommandlineJava.SysProperties +
          +Comparison +
          +DataType +
          +Description +
          +DirSet +
          +DTDLocation +
          +EnumeratedAttribute +
          +Environment +
          +Environment.Variable +
          +FileList +
          +FileList.FileName +
          +FileSet +
          +FilterChain +
          +FilterSet +
          +FilterSet.Filter +
          +FilterSet.OnMissing +
          +FilterSetCollection +
          +FlexInteger +
          +LogLevel +
          +Mapper +
          +Mapper.MapperType +
          +Parameter +
          +Path +
          +PatternSet +
          +Permissions +
          +Permissions.Permission +
          +PropertySet +
          +PropertySet.BuiltinPropertySetName +
          +PropertySet.PropertyRef +
          +Quantifier +
          +RedirectorElement +
          +Reference +
          +RegularExpression +
          +Resource +
          +ResourceLocation +
          +Substitution +
          +TarFileSet +
          +TarScanner +
          +TimeComparison +
          +XMLCatalog +
          +ZipFileSet +
          +ZipScanner
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-summary.html new file mode 100644 index 000000000..5bf458242 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-summary.html @@ -0,0 +1,407 @@ + + + + + + +org.apache.tools.ant.types (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types +

          + + + + + + + + + + + + + + + + + +
          +Interface Summary
          ParameterizableParameterizable objects take genric key value pairs.
          ResourceCollectionInterface describing a collection of Resources.
          ResourceFactorythis interface should be implemented by classes (Scanners) needing + to deliver information about resources.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractFileSetClass that holds an implicit patternset and supports nested + patternsets and creates a DirectoryScanner using these patterns.
          AntFilterReaderAn AntFilterReader is a wrapper class that encloses the classname + and configuration of a Configurable FilterReader.
          ArchiveFileSetA ArchiveFileSet is a FileSet with extra attributes useful in the + context of archiving tasks.
          ArchiveScannerArchiveScanner accesses the pattern matching algorithm in DirectoryScanner, + which are protected methods that can only be accessed by subclassing.
          AssertionsThe assertion datatype.
          Assertions.BaseAssertionbase class for our assertion elements.
          Assertions.DisabledAssertionA disabled assertion disables things
          Assertions.EnabledAssertionan enabled assertion enables things
          CommandlineCommandline objects help handling command lines specifying processes to + execute.
          Commandline.ArgumentUsed for nested xml command line definitions.
          CommandlineJavaA representation of a Java command line that is + a composite of 2 Commandlines.
          CommandlineJava.SysPropertiesSpecialized Environment class for System properties.
          ComparisonEnumeratedAttribute for generic comparisons.
          DataTypeBase class for those classes that can appear inside the build file + as stand alone data types.
          DescriptionDescription is used to provide a project-wide description element + (that is, a description that applies to a buildfile as a whole).
          DirSetSubclass as hint for supporting tasks that the included directories + instead of files should be used.
          DTDLocationHelper class to handle the DTD nested element.
          EnumeratedAttributeHelper class for attributes that can only take one of a fixed list + of values.
          EnvironmentWrapper for environment variables.
          Environment.Variablerepresentation of a single env value
          FileListFileList represents an explicitly named list of files.
          FileList.FileNameInner class corresponding to the <file> nested element.
          FileSetMoved out of MatchingTask to make it a standalone object that could + be referenced (by scripts for example).
          FilterChainFilterChain may contain a chained set of filter readers.
          FilterSetA set of filters to be applied to something.
          FilterSet.FilterIndividual filter component of filterset.
          FilterSet.OnMissingEnumeratedAttribute to set behavior WRT missing filtersfiles: + "fail" (default), "warn", "ignore".
          FilterSetCollectionA FilterSetCollection is a collection of filtersets each of which may have + a different start/end token settings.
          FlexIntegerHelper class which can be used for Ant task attribute setter methods to allow + the build file to specify an integer in either decimal, octal, or hexadecimal + format.
          LogLevelThe enumerated values for Ant's log level.
          MapperElement to define a FileNameMapper.
          Mapper.MapperTypeClass as Argument to FileNameMapper.setType.
          ParameterA parameter is composed of a name, type and value.
          PathThis object represents a path as used by CLASSPATH or PATH + environment variable.
          PatternSetNamed collection of include/exclude tags.
          PermissionsThis class implements a security manager meant for usage by tasks that run inside the + Ant VM.
          Permissions.PermissionRepresents a permission.
          PropertySetA set of properties.
          PropertySet.BuiltinPropertySetNameUsed for propertyref's builtin attribute.
          PropertySet.PropertyRefThis is a nested class containing a reference to some properties + and optionally a source of properties.
          QuantifierEnumeratedAttribute for quantifier comparisons.
          RedirectorElementElement representation of a Redirector.
          ReferenceClass to hold a reference to another object in the project.
          RegularExpressionA regular expression datatype.
          ResourceDescribes a "File-like" resource (File, ZipEntry, etc.).
          ResourceLocationHelper class to handle the <dtd> and + <entity> nested elements.
          SubstitutionA regular expression substitution datatype.
          TarFileSetA TarFileSet is a FileSet with extra attributes useful in the context of + Tar/Jar tasks.
          TarScannerScans tar archives for resources.
          TimeComparisonEnumeratedAttribute for time comparisons.
          XMLCatalogThis data type provides a catalog of resource locations (such as + DTDs and XML entities), based on the + OASIS "Open Catalog" standard.
          ZipFileSetA ZipFileSet is a FileSet with extra attributes useful in the context of + Zip/Jar tasks.
          ZipScannerScans zip archives for resources.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-tree.html new file mode 100644 index 000000000..e6fa4b76b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/package-tree.html @@ -0,0 +1,195 @@ + + + + + + +org.apache.tools.ant.types Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalog.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalog.html new file mode 100644 index 000000000..bec0f178b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalog.html @@ -0,0 +1,364 @@ + + + + + + +ApacheCatalog (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resolver +
          +Class ApacheCatalog

          +
          +java.lang.Object
+  extended by org.apache.xml.resolver.Catalog
+      extended by org.apache.tools.ant.types.resolver.ApacheCatalog
+
          +
          +
          +
          public class ApacheCatalog
          extends org.apache.xml.resolver.Catalog
          + + +

          +This class extends the Catalog class provided by Norman Walsh's + resolver library in xml-commons in order to add classpath entity + and URI resolution. Since XMLCatalog already does classpath + resolution, we simply add all CatalogEntry instances back to the + controlling XMLCatalog instance. This is done via a callback + mechanism. ApacheCatalog is only used for external + catalog files. Inline entries (currently <dtd> + and <entity>) are not added to ApacheCatalog. + See XMLCatalog.java for the details of the entity and URI + resolution algorithms. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          See Also:
          XMLCatalog.CatalogResolver
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.xml.resolver.Catalog
          base, BASE, CATALOG, catalogCwd, catalogEntries, catalogFiles, catalogManager, catalogs, default_override, DELEGATE_PUBLIC, DELEGATE_SYSTEM, DELEGATE_URI, DOCTYPE, DOCUMENT, DTDDECL, ENTITY, LINKTYPE, localCatalogFiles, localDelegate, NOTATION, OVERRIDE, PUBLIC, readerArr, readerMap, REWRITE_SYSTEM, REWRITE_URI, SGMLDECL, SYSTEM, SYSTEM_SUFFIX, URI, URI_SUFFIX
          +  + + + + + + + + + + +
          +Constructor Summary
          ApacheCatalog() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddEntry(org.apache.xml.resolver.CatalogEntry entry) + +
          +          This method overrides the superclass method of the same name + in order to add catalog entries back to the controlling + XMLCatalog instance.
          +protected  org.apache.xml.resolver.CatalognewCatalog() + +
          +          Create a new ApacheCatalog instance.
          + voidsetResolver(ApacheCatalogResolver resolver) + +
          +          Set the resolver object to callback.
          +  + + + + + + + +
          Methods inherited from class org.apache.xml.resolver.Catalog
          addDelegate, addReader, copyReaders, encodedByte, fixSlashes, getCatalogManager, getCurrentBase, getDefaultOverride, loadSystemCatalogs, makeAbsolute, normalizeURI, parseAllCatalogs, parseCatalog, parseCatalog, parseCatalog, parseCatalogFile, parsePendingCatalogs, resolveDoctype, resolveDocument, resolveEntity, resolveLocalPublic, resolveLocalSystem, resolveLocalURI, resolveNotation, resolvePublic, resolveSubordinateCatalogs, resolveSystem, resolveURI, setCatalogManager, setupReaders, unknownEntry
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ApacheCatalog

          +
          +public ApacheCatalog()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +newCatalog

          +
          +protected org.apache.xml.resolver.Catalog newCatalog()
          +
          +

          Create a new ApacheCatalog instance.

          + +

          This method overrides the superclass method of the same name + in order to set the resolver object for callbacks. The reason + we have to do this is that internally Catalog creates a new + instance of itself for each external catalog file processed. + That is, if two external catalog files are processed, there + will be a total of two ApacheCatalog instances, and so on.

          +

          +

          +
          Overrides:
          newCatalog in class org.apache.xml.resolver.Catalog
          +
          +
          + +
          Returns:
          the catalog.
          +
          +
          +
          + +

          +setResolver

          +
          +public void setResolver(ApacheCatalogResolver resolver)
          +
          +
          Set the resolver object to callback. +

          +

          +
          Parameters:
          resolver - the apache catalog resolver.
          +
          +
          +
          + +

          +addEntry

          +
          +public void addEntry(org.apache.xml.resolver.CatalogEntry entry)
          +
          +

          This method overrides the superclass method of the same name + in order to add catalog entries back to the controlling + XMLCatalog instance. In this way, we can add classpath lookup + for these entries.

          + +

          When we add an external catalog file, the entries inside it + get parsed by this method. Therefore, we override it to add + each of them back to the controlling XMLCatalog instance. This + is done by performing a callback to the ApacheCatalogResolver, + which in turn calls the XMLCatalog.

          + +

          XMLCatalog currently only understands PUBLIC + and URI entry types, so we ignore the other types.

          +

          +

          +
          Overrides:
          addEntry in class org.apache.xml.resolver.Catalog
          +
          +
          +
          Parameters:
          entry - The CatalogEntry to process.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html new file mode 100644 index 000000000..bf81b6bd9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html @@ -0,0 +1,391 @@ + + + + + + +ApacheCatalogResolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resolver +
          +Class ApacheCatalogResolver

          +
          +java.lang.Object
+  extended by org.apache.xml.resolver.tools.CatalogResolver
+      extended by org.apache.tools.ant.types.resolver.ApacheCatalogResolver
+
          +
          +
          All Implemented Interfaces:
          javax.xml.transform.URIResolver, org.xml.sax.EntityResolver
          +
          +
          +
          +
          public class ApacheCatalogResolver
          extends org.apache.xml.resolver.tools.CatalogResolver
          + + +

          +

          This class extends the CatalogResolver class provided by Norman + Walsh's resolver library in xml-commons. It provides the bridge + between the Ant XMLCatalog datatype and the xml-commons Catalog + class. XMLCatalog calls methods in this class using Reflection in + order to avoid requiring the xml-commons resolver library in the + path.

          + +

          The ApacheCatalog class is used to parse external catalog files, which + can be in either + plain text format or + XML format.

          + +

          For each entry found in an external catalog file, if any, an + instance of ResourceLocation is created and added to the controlling + XMLCatalog datatype. In this way, these entries will be included + in XMLCatalog's lookup algorithm. See XMLCatalog.java for more + details.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          See Also:
          XMLCatalog.CatalogResolver, +CatalogManager
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.xml.resolver.tools.CatalogResolver
          namespaceAware, validating
          +  + + + + + + + + + + +
          +Constructor Summary
          ApacheCatalogResolver() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddPublicEntry(java.lang.String publicid, + java.lang.String systemid, + java.net.URL base) + +
          +          Add a PUBLIC catalog entry to the controlling XMLCatalog instance.
          + voidaddURIEntry(java.lang.String uri, + java.lang.String altURI, + java.net.URL base) + +
          +          Add a URI catalog entry to the controlling XMLCatalog instance.
          + voidparseCatalog(java.lang.String file) + +
          +          XMLCatalog calls this to add an external catalog file for each + file within a <catalogfiles> fileset.
          + voidsetXMLCatalog(XMLCatalog xmlCatalog) + +
          +          Set the XMLCatalog object to callback.
          +  + + + + + + + +
          Methods inherited from class org.apache.xml.resolver.tools.CatalogResolver
          getCatalog, getResolvedEntity, resolve, resolveEntity
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ApacheCatalogResolver

          +
          +public ApacheCatalogResolver()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setXMLCatalog

          +
          +public void setXMLCatalog(XMLCatalog xmlCatalog)
          +
          +
          Set the XMLCatalog object to callback. +

          +

          +
          Parameters:
          xmlCatalog - the XMLCatalog to use.
          +
          +
          +
          + +

          +parseCatalog

          +
          +public void parseCatalog(java.lang.String file)
          +
          +
          XMLCatalog calls this to add an external catalog file for each + file within a <catalogfiles> fileset. +

          +

          +
          Parameters:
          file - the external catalog file.
          +
          +
          +
          + +

          +addPublicEntry

          +
          +public void addPublicEntry(java.lang.String publicid,
+                           java.lang.String systemid,
+                           java.net.URL base)
          +
          +

          Add a PUBLIC catalog entry to the controlling XMLCatalog instance. + ApacheCatalog calls this for each PUBLIC entry found in an external + catalog file.

          +

          +

          +
          Parameters:
          publicid - The public ID of the resource
          systemid - The system ID (aka location) of the resource
          base - The base URL of the resource. If the systemid + specifies a relative URL/pathname, it is resolved using the + base. The default base for an external catalog file is the + directory in which the catalog is located.
          +
          +
          +
          + +

          +addURIEntry

          +
          +public void addURIEntry(java.lang.String uri,
+                        java.lang.String altURI,
+                        java.net.URL base)
          +
          +

          Add a URI catalog entry to the controlling XMLCatalog instance. + ApacheCatalog calls this for each URI entry found in an external + catalog file.

          +

          +

          +
          Parameters:
          uri - The URI of the resource
          altURI - The URI to which the resource should be mapped + (aka the location)
          base - The base URL of the resource. If the altURI + specifies a relative URL/pathname, it is resolved using the + base. The default base for an external catalog file is the + directory in which the catalog is located.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-frame.html new file mode 100644 index 000000000..673f564e4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.types.resolver (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.resolver + + + + +
          +Classes  + +
          +ApacheCatalog +
          +ApacheCatalogResolver
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-summary.html new file mode 100644 index 000000000..b090e7740 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-summary.html @@ -0,0 +1,186 @@ + + + + + + +org.apache.tools.ant.types.resolver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.resolver +

          +Ant integration with xml-commons resolver. +

          +See: +
          +          Description +

          + + + + + + + + + + + + + +
          +Class Summary
          ApacheCatalogThis class extends the Catalog class provided by Norman Walsh's + resolver library in xml-commons in order to add classpath entity + and URI resolution.
          ApacheCatalogResolverThis class extends the CatalogResolver class provided by Norman + Walsh's resolver library in xml-commons.
          +  + +

          +

          +Package org.apache.tools.ant.types.resolver Description +

          + +

          +Ant integration with xml-commons resolver. + +

          These classes enhance the <xmlcatalog> datatype +to support external catalog files using the xml-commons resolver, in +accordance with the + +OASIS "Open Catalog" standard. They will be used if and only if +the xml-commons resolver library is available on the classpath.

          +

          + +

          +

          +
          Author:
          +
          Craeg Strong
          +
          See Also:
          Apache xml-commons Project, +XMLCatalog, +ApacheCatalogResolver, +ApacheCatalog
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-tree.html new file mode 100644 index 000000000..b3e57a631 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resolver/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.types.resolver Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.resolver +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.xml.resolver.Catalog +
            • org.apache.xml.resolver.tools.CatalogResolver (implements org.xml.sax.EntityResolver, javax.xml.transform.URIResolver) + +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.ClassLoaderWithFlag.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.ClassLoaderWithFlag.html new file mode 100644 index 000000000..d18ec4997 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.ClassLoaderWithFlag.html @@ -0,0 +1,255 @@ + + + + + + +AbstractClasspathResource.ClassLoaderWithFlag (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class AbstractClasspathResource.ClassLoaderWithFlag

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.AbstractClasspathResource.ClassLoaderWithFlag
+
          +
          +
          Enclosing class:
          AbstractClasspathResource
          +
          +
          +
          +
          public static class AbstractClasspathResource.ClassLoaderWithFlag
          extends java.lang.Object
          + + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidcleanup() + +
          +           
          + java.lang.ClassLoadergetLoader() + +
          +           
          + booleanneedsCleanup() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getLoader

          +
          +public java.lang.ClassLoader getLoader()
          +
          +
          +
          +
          +
          +
          + +

          +needsCleanup

          +
          +public boolean needsCleanup()
          +
          +
          +
          +
          +
          +
          + +

          +cleanup

          +
          +public void cleanup()
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.html new file mode 100644 index 000000000..a5ca6da22 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractClasspathResource.html @@ -0,0 +1,658 @@ + + + + + + +AbstractClasspathResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class AbstractClasspathResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.AbstractClasspathResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          JavaConstantResource, JavaResource
          +
          +
          +
          +
          public abstract class AbstractClasspathResource
          extends Resource
          + + +

          +A Resource representation of anything that is accessed via a Java classloader. + The core methods to set/resolve the classpath are provided. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classAbstractClasspathResource.ClassLoaderWithFlag + +
          +           
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractClasspathResource() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateClasspath() + +
          +          Add a classpath to use when looking up a resource.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          +protected  AbstractClasspathResource.ClassLoaderWithFlaggetClassLoader() + +
          +          combines the various ways that could specify a ClassLoader and + potentially creates one that needs to be cleaned up when it is + no longer needed so that classes can get garbage collected.
          + PathgetClasspath() + +
          +          get the classpath used by this LoadProperties.
          + java.io.InputStreamgetInputStream() + +
          +          Return an InputStream for reading the contents of this Resource.
          + ReferencegetLoader() + +
          +          Get the loader.
          + booleanisExists() + +
          +          Learn whether this resource exists.
          +protected abstract  java.io.InputStreamopenInputStream(java.lang.ClassLoader cl) + +
          +          open the inpout stream from a specific classloader
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to use when looking up a resource.
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere
          + voidsetLoaderRef(Reference r) + +
          +          Use the reference to locate the loader.
          + voidsetParentFirst(boolean b) + +
          +          Whether to consult the parent classloader first.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, equals, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractClasspathResource

          +
          +public AbstractClasspathResource()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to use when looking up a resource. +

          +

          +
          Parameters:
          classpath - to add to any existing classpath
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Add a classpath to use when looking up a resource. +

          +

          + +
          Returns:
          The classpath to be configured
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath to use when looking up a resource, + given as reference to a <path> defined elsewhere +

          +

          +
          Parameters:
          r - The reference value
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          get the classpath used by this LoadProperties. +

          +

          + +
          Returns:
          The classpath
          +
          +
          +
          + +

          +getLoader

          +
          +public Reference getLoader()
          +
          +
          Get the loader. +

          +

          + +
          Returns:
          the loader.
          +
          +
          +
          + +

          +setLoaderRef

          +
          +public void setLoaderRef(Reference r)
          +
          +
          Use the reference to locate the loader. If the loader is not + found, taskdef will use the specified classpath and register it + with the specified name. + + This allow multiple taskdef/typedef to use the same class loader, + so they can be used together. It eliminate the need to + put them in the CLASSPATH. +

          +

          +
          Parameters:
          r - the reference to locate the loader.
          +
          +
          +
          + +

          +setParentFirst

          +
          +public void setParentFirst(boolean b)
          +
          +
          Whether to consult the parent classloader first. + +

          Only relevant if a classpath has been specified.

          +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          Learn whether this resource exists. This implementation opens the input stream + as the test. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Return an InputStream for reading the contents of this Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream object. +
          Throws: +
          java.io.IOException - if an error occurs.
          +
          +
          +
          + +

          +getClassLoader

          +
          +protected AbstractClasspathResource.ClassLoaderWithFlag getClassLoader()
          +
          +
          combines the various ways that could specify a ClassLoader and + potentially creates one that needs to be cleaned up when it is + no longer needed so that classes can get garbage collected. +

          +

          +
          +
          +
          +
          + +

          +openInputStream

          +
          +protected abstract java.io.InputStream openInputStream(java.lang.ClassLoader cl)
+                                                throws java.io.IOException
          +
          +
          open the inpout stream from a specific classloader +

          +

          +
          Parameters:
          cl - the classloader to use. Will be null if the system classloader is used +
          Returns:
          an open input stream for the resource +
          Throws: +
          java.io.IOException - if an error occurs.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.html new file mode 100644 index 000000000..06fa65456 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/AbstractResourceCollectionWrapper.html @@ -0,0 +1,578 @@ + + + + + + +AbstractResourceCollectionWrapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class AbstractResourceCollectionWrapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          BaseResourceCollectionWrapper, LazyResourceCollectionWrapper
          +
          +
          +
          +
          public abstract class AbstractResourceCollectionWrapper
          extends DataType
          implements ResourceCollection, java.lang.Cloneable
          + + +

          +Base class for a ResourceCollection that wraps a single nested + ResourceCollection. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.2
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractResourceCollectionWrapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection c) + +
          +          Add a ResourceCollection to the container.
          +protected abstract  java.util.IteratorcreateIterator() + +
          +          Do create an iterator on the resource collection.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          +protected  ResourceCollectiongetResourceCollection() + +
          +          Get the nested ResourceCollection.
          +protected abstract  intgetSize() + +
          +          Do compute the size of the resource collection.
          + booleanisCache() + +
          +          Learn whether to cache collections.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetCache(boolean b) + +
          +          Set whether to cache collections.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Format this BaseResourceCollectionWrapper as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractResourceCollectionWrapper

          +
          +public AbstractResourceCollectionWrapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCache

          +
          +public void setCache(boolean b)
          +
          +
          Set whether to cache collections. +

          +

          +
          +
          +
          +
          Parameters:
          b - boolean cache flag.
          +
          +
          +
          + +

          +isCache

          +
          +public boolean isCache()
          +
          +
          Learn whether to cache collections. Default is true. +

          +

          +
          +
          +
          + +
          Returns:
          boolean cache flag.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection c)
+         throws BuildException
          +
          +
          Add a ResourceCollection to the container. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +iterator

          +
          +public final java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +createIterator

          +
          +protected abstract java.util.Iterator createIterator()
          +
          +
          Do create an iterator on the resource collection. The creation + of the iterator is allowed to not be thread safe whereas the iterator + itself should. The returned iterator will be wrapped into the FailFast + one. +

          +

          +
          +
          +
          + +
          Returns:
          the iterator on the resource collection
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +getSize

          +
          +protected abstract int getSize()
          +
          +
          Do compute the size of the resource collection. The implementation of + this function is allowed to be not thread safe. +

          +

          +
          +
          +
          + +
          Returns:
          size of resource collection.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +getResourceCollection

          +
          +protected final ResourceCollection getResourceCollection()
          +
          +
          Get the nested ResourceCollection. +

          +

          +
          +
          +
          + +
          Returns:
          a ResourceCollection. +
          Throws: +
          BuildException - if no nested ResourceCollection has been provided.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this BaseResourceCollectionWrapper as a String. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a descriptive String.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Appendable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Appendable.html new file mode 100644 index 000000000..d05638fa9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Appendable.html @@ -0,0 +1,218 @@ + + + + + + +Appendable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Interface Appendable

          +
          +
          All Known Implementing Classes:
          FileResource, LogOutputResource
          +
          +
          +
          +
          public interface Appendable
          + + +

          +Interface to be implemented by "appendable" resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + java.io.OutputStreamgetAppendOutputStream() + +
          +          Get an appending OutputStream.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getAppendOutputStream

          +
          +java.io.OutputStream getAppendOutputStream()
+                                           throws java.io.IOException
          +
          +
          Get an appending OutputStream. +

          +

          + +
          Returns:
          OutputStream +
          Throws: +
          java.io.IOException - if anything goes wrong
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ArchiveResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ArchiveResource.html new file mode 100644 index 000000000..3a1662b22 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ArchiveResource.html @@ -0,0 +1,805 @@ + + + + + + +ArchiveResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ArchiveResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ArchiveResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          TarResource, ZipResource
          +
          +
          +
          +
          public abstract class ArchiveResource
          extends Resource
          + + +

          +A Resource representation of an entry inside an archive. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected ArchiveResource() + +
          +          Default constructor.
          +protected ArchiveResource(java.io.File a) + +
          +          Construct a ArchiveResource representing the specified + entry in the specified archive.
          +protected ArchiveResource(java.io.File a, + boolean withEntry) + +
          +          Construct a ArchiveResource representing the specified + entry in the specified archive.
          +protected ArchiveResource(Resource a, + boolean withEntry) + +
          +          Construct a ArchiveResource representing the specified + entry in the specified archive.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(ResourceCollection a) + +
          +          Sets the archive that holds this as a single element Resource + collection.
          +protected  voidcheckEntry() + +
          +          Validate settings and ensure that the represented "archive entry" + has been established.
          + intcompareTo(java.lang.Object another) + +
          +          Compare this ArchiveResource to another Resource.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + booleanequals(java.lang.Object another) + +
          +          Compare another Object to this ArchiveResource for equality.
          +protected abstract  voidfetchEntry() + +
          +          Fetch information from the named entry inside the archive.
          + ResourcegetArchive() + +
          +          Get the archive that holds this Resource.
          + longgetLastModified() + +
          +          Get the last modified date of this Resource.
          + intgetMode() + +
          +          Get the file or dir mode for this Resource.
          + longgetSize() + +
          +          Get the size of this Resource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisDirectory() + +
          +          Learn whether this Resource represents a directory.
          + booleanisExists() + +
          +          Find out whether this Resource represents an existing Resource.
          + voidsetArchive(java.io.File a) + +
          +          Set the archive that holds this Resource.
          + voidsetMode(int mode) + +
          +          Sets the file or dir mode for this resource.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          + java.lang.StringtoString() + +
          +          Format this Resource as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, getInputStream, getMagicNumber, getName, getOutputStream, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ArchiveResource

          +
          +protected ArchiveResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +ArchiveResource

          +
          +protected ArchiveResource(java.io.File a)
          +
          +
          Construct a ArchiveResource representing the specified + entry in the specified archive. +

          +

          +
          Parameters:
          a - the archive as File.
          +
          +
          + +

          +ArchiveResource

          +
          +protected ArchiveResource(java.io.File a,
+                          boolean withEntry)
          +
          +
          Construct a ArchiveResource representing the specified + entry in the specified archive. +

          +

          +
          Parameters:
          a - the archive as File.
          withEntry - if the entry has been specified.
          +
          +
          + +

          +ArchiveResource

          +
          +protected ArchiveResource(Resource a,
+                          boolean withEntry)
          +
          +
          Construct a ArchiveResource representing the specified + entry in the specified archive. +

          +

          +
          Parameters:
          a - the archive as Resource.
          withEntry - if the entry has been specified.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setArchive

          +
          +public void setArchive(java.io.File a)
          +
          +
          Set the archive that holds this Resource. +

          +

          +
          Parameters:
          a - the archive as a File.
          +
          +
          +
          + +

          +setMode

          +
          +public void setMode(int mode)
          +
          +
          Sets the file or dir mode for this resource. +

          +

          +
          Parameters:
          mode - integer representation of Unix permission mask.
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(ResourceCollection a)
          +
          +
          Sets the archive that holds this as a single element Resource + collection. +

          +

          +
          Parameters:
          a - the archive as a single element Resource collection.
          +
          +
          +
          + +

          +getArchive

          +
          +public Resource getArchive()
          +
          +
          Get the archive that holds this Resource. +

          +

          + +
          Returns:
          the archive as a Resource.
          +
          +
          +
          + +

          +getLastModified

          +
          +public long getLastModified()
          +
          +
          Get the last modified date of this Resource. +

          +

          +
          Overrides:
          getLastModified in class Resource
          +
          +
          + +
          Returns:
          the last modification date.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the long size of this Resource.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Learn whether this Resource represents a directory. +

          +

          +
          Overrides:
          isDirectory in class Resource
          +
          +
          + +
          Returns:
          boolean flag indicating whether the entry is a directory.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          Find out whether this Resource represents an existing Resource. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          boolean existence flag.
          +
          +
          +
          + +

          +getMode

          +
          +public int getMode()
          +
          +
          Get the file or dir mode for this Resource. +

          +

          + +
          Returns:
          integer representation of Unix permission mask.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object another)
          +
          +
          Compare this ArchiveResource to another Resource. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          Overrides:
          compareTo in class Resource
          +
          +
          +
          Parameters:
          another - the other Resource against which to compare. +
          Returns:
          a negative integer, zero, or a positive integer as this Resource + is less than, equal to, or greater than the specified Resource.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object another)
          +
          +
          Compare another Object to this ArchiveResource for equality. +

          +

          +
          Overrides:
          equals in class Resource
          +
          +
          +
          Parameters:
          another - the other Object to compare. +
          Returns:
          true if another is a Resource representing + the same entry in the same archive.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this Resource as a String. +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          String representatation of this Resource.
          +
          +
          +
          + +

          +checkEntry

          +
          +protected final void checkEntry()
+                         throws BuildException
          +
          +
          Validate settings and ensure that the represented "archive entry" + has been established. +

          +

          + +
          Throws: +
          BuildException
          +
          +
          +
          + +

          +fetchEntry

          +
          +protected abstract void fetchEntry()
          +
          +
          Fetch information from the named entry inside the archive. +

          +

          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
          +
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Archives.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Archives.html new file mode 100644 index 000000000..28d8ceaa3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Archives.html @@ -0,0 +1,554 @@ + + + + + + +Archives (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Archives

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.Archives
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Archives
          extends DataType
          implements ResourceCollection, java.lang.Cloneable
          + + +

          +A resource collection that treats all nested resources as archives + and returns the contents of the archives as its content. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Archives() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +          Implement clone.
          +protected  ArchiveFileSetconfigureArchive(ArchiveFileSet afs, + Resource src) + +
          +          Configures the archivefileset based on this type's settings, + set the source.
          + UnioncreateTars() + +
          +          Wrapper to identify nested resource collections as ZIP + archives.
          + UnioncreateZips() + +
          +          Wrapper to identify nested resource collections as ZIP + archives.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          +protected  java.util.IteratorgrabArchives() + +
          +          Turns all nested resources into corresponding ArchiveFileSets + and returns an iterator over the collected archives.
          + booleanisFilesystemOnly() + +
          +          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions.
          + java.util.Iteratoriterator() + +
          +          Merges the nested collections.
          + voidsetRefid(Reference r) + +
          +          Overrides the base version.
          + intsize() + +
          +          Sums the sizes of nested archives.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Archives

          +
          +public Archives()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createZips

          +
          +public Union createZips()
          +
          +
          Wrapper to identify nested resource collections as ZIP + archives. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +createTars

          +
          +public Union createTars()
          +
          +
          Wrapper to identify nested resource collections as ZIP + archives. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Sums the sizes of nested archives. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Merges the nested collections. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Description copied from interface: ResourceCollection
          +
          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. If true, + all Resources returned from this ResourceCollection should be + instances of FileResource. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          false
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the base version. +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Implement clone. The nested resource collections are cloned as + well. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a cloned instance.
          +
          +
          +
          + +

          +grabArchives

          +
          +protected java.util.Iterator grabArchives()
          +
          +
          Turns all nested resources into corresponding ArchiveFileSets + and returns an iterator over the collected archives. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +configureArchive

          +
          +protected ArchiveFileSet configureArchive(ArchiveFileSet afs,
+                                          Resource src)
          +
          +
          Configures the archivefileset based on this type's settings, + set the source. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BCFileSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BCFileSet.html new file mode 100644 index 000000000..9526d3f34 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BCFileSet.html @@ -0,0 +1,381 @@ + + + + + + +BCFileSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class BCFileSet

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.AbstractFileSet
+              extended by org.apache.tools.ant.types.FileSet
+                  extended by org.apache.tools.ant.types.resources.BCFileSet
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          +
          public class BCFileSet
          extends FileSet
          + + +

          +Utility FileSet that includes directories for backwards-compatibility + with certain tasks e.g. Delete. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          BCFileSet() + +
          +          Default constructor.
          BCFileSet(FileSet fs) + +
          +          Construct a new BCFileSet from the specified FileSet.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.FileSet
          clone, isFilesystemOnly
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, dieOnCircularReference, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BCFileSet

          +
          +public BCFileSet()
          +
          +
          Default constructor. +

          +

          +
          + +

          +BCFileSet

          +
          +public BCFileSet(FileSet fs)
          +
          +
          Construct a new BCFileSet from the specified FileSet. +

          +

          +
          Parameters:
          fs - the FileSet from which to inherit config.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          Overrides:
          iterator in class FileSet
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          Overrides:
          size in class FileSet
          +
          +
          + +
          Returns:
          number of elements as int.
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BZip2Resource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BZip2Resource.html new file mode 100644 index 000000000..1bf845971 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BZip2Resource.html @@ -0,0 +1,439 @@ + + + + + + +BZip2Resource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class BZip2Resource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+                  extended by org.apache.tools.ant.types.resources.ContentTransformingResource
+                      extended by org.apache.tools.ant.types.resources.CompressedResource
+                          extended by org.apache.tools.ant.types.resources.BZip2Resource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class BZip2Resource
          extends CompressedResource
          + + +

          +A Bzip2 compressed resource. + +

          Wraps around another resource, delegates all quries to that + other resource but uncompresses/compresses streams on the fly.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          BZip2Resource() + +
          +          A no-arg constructor
          BZip2Resource(ResourceCollection other) + +
          +          Constructor with another resource to wrap.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringgetCompressionName() + +
          +          Get the name of the compression method.
          +protected  java.io.InputStreamwrapStream(java.io.InputStream in) + +
          +          Decompress on the fly using CBZip2InputStream.
          +protected  java.io.OutputStreamwrapStream(java.io.OutputStream out) + +
          +          Compress on the fly using CBZip2OutputStream.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.CompressedResource
          toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ContentTransformingResource
          as, getInputStream, getOutputStream, getSize, isAppendSupported
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ResourceDecorator
          addConfigured, compareTo, dieOnCircularReference, getLastModified, getName, getResource, hashCode, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setRefid, setSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, equals, getMagicNumber, iterator, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BZip2Resource

          +
          +public BZip2Resource()
          +
          +
          A no-arg constructor +

          +

          +
          + +

          +BZip2Resource

          +
          +public BZip2Resource(ResourceCollection other)
          +
          +
          Constructor with another resource to wrap. +

          +

          +
          Parameters:
          other - the resource to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +wrapStream

          +
          +protected java.io.InputStream wrapStream(java.io.InputStream in)
+                                  throws java.io.IOException
          +
          +
          Decompress on the fly using CBZip2InputStream. +

          +

          +
          Specified by:
          wrapStream in class ContentTransformingResource
          +
          +
          +
          Parameters:
          in - the stream to wrap. +
          Returns:
          the wrapped stream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +wrapStream

          +
          +protected java.io.OutputStream wrapStream(java.io.OutputStream out)
+                                   throws java.io.IOException
          +
          +
          Compress on the fly using CBZip2OutputStream. +

          +

          +
          Specified by:
          wrapStream in class ContentTransformingResource
          +
          +
          +
          Parameters:
          out - the stream to wrap. +
          Returns:
          the wrapped stream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +getCompressionName

          +
          +protected java.lang.String getCompressionName()
          +
          +
          Get the name of the compression method. +

          +

          +
          Specified by:
          getCompressionName in class CompressedResource
          +
          +
          + +
          Returns:
          the string "Bzip2".
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.html new file mode 100644 index 000000000..ccc89e6dd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionContainer.html @@ -0,0 +1,650 @@ + + + + + + +BaseResourceCollectionContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class BaseResourceCollectionContainer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          Difference, Intersect, Union
          +
          +
          +
          +
          public abstract class BaseResourceCollectionContainer
          extends DataType
          implements ResourceCollection, java.lang.Cloneable
          + + +

          +Base class for ResourceCollections that nest multiple ResourceCollections. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          BaseResourceCollectionContainer() + +
          +          Create a new BaseResourceCollectionContainer.
          BaseResourceCollectionContainer(Project project) + +
          +          Create a new BaseResourceCollectionContainer.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection c) + +
          +          Add a ResourceCollection to the container.
          + voidaddAll(java.util.Collection c) + +
          +          Add the Collection of ResourceCollections to the container.
          + voidclear() + +
          +          Clear the container.
          + java.lang.Objectclone() + +
          +          Implement clone.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          +protected abstract  java.util.CollectiongetCollection() + +
          +          Template method for subclasses to return a Collection object of Resources.
          + java.util.ListgetResourceCollections() + +
          +          Get the nested ResourceCollections.
          + booleanisCache() + +
          +          Learn whether to cache collections.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetCache(boolean b) + +
          +          Set whether to cache collections.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Format this BaseResourceCollectionContainer as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseResourceCollectionContainer

          +
          +public BaseResourceCollectionContainer()
          +
          +
          Create a new BaseResourceCollectionContainer. +

          +

          +
          + +

          +BaseResourceCollectionContainer

          +
          +public BaseResourceCollectionContainer(Project project)
          +
          +
          Create a new BaseResourceCollectionContainer. +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCache

          +
          +public void setCache(boolean b)
          +
          +
          Set whether to cache collections. +

          +

          +
          +
          +
          +
          Parameters:
          b - boolean cache flag.
          +
          +
          +
          + +

          +isCache

          +
          +public boolean isCache()
          +
          +
          Learn whether to cache collections. Default is true. +

          +

          +
          +
          +
          + +
          Returns:
          boolean cache flag.
          +
          +
          +
          + +

          +clear

          +
          +public void clear()
+           throws BuildException
          +
          +
          Clear the container. +

          +

          +
          +
          +
          + +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection c)
+         throws BuildException
          +
          +
          Add a ResourceCollection to the container. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +addAll

          +
          +public void addAll(java.util.Collection c)
+            throws BuildException
          +
          +
          Add the Collection of ResourceCollections to the container. +

          +

          +
          +
          +
          +
          Parameters:
          c - the Collection whose elements to add. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +iterator

          +
          +public final java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. The Iterator returned + will throw ConcurrentModificationExceptions if ResourceCollections + are added to this container while the Iterator is in use. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          a "fail-fast" Iterator.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +getResourceCollections

          +
          +public final java.util.List getResourceCollections()
          +
          +
          Get the nested ResourceCollections. +

          +

          +
          +
          +
          + +
          Returns:
          List.
          +
          +
          +
          + +

          +getCollection

          +
          +protected abstract java.util.Collection getCollection()
          +
          +
          Template method for subclasses to return a Collection object of Resources. +

          +

          +
          +
          +
          + +
          Returns:
          Collection.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Implement clone. The set of nested resource + collections is shallowly cloned. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a cloned instance.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this BaseResourceCollectionContainer as a String. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a descriptive String.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionWrapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionWrapper.html new file mode 100644 index 000000000..255efae4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/BaseResourceCollectionWrapper.html @@ -0,0 +1,378 @@ + + + + + + +BaseResourceCollectionWrapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class BaseResourceCollectionWrapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          SizeLimitCollection, Sort, Tokens
          +
          +
          +
          +
          public abstract class BaseResourceCollectionWrapper
          extends AbstractResourceCollectionWrapper
          + + +

          +Base class for a ResourceCollection that wraps a single nested + ResourceCollection. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          BaseResourceCollectionWrapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.IteratorcreateIterator() + +
          +          Do create an iterator on the resource collection.
          +protected abstract  java.util.CollectiongetCollection() + +
          +          Template method for subclasses to return a Collection of Resources.
          +protected  intgetSize() + +
          +          Do compute the size of the resource collection.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, dieOnCircularReference, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseResourceCollectionWrapper

          +
          +public BaseResourceCollectionWrapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createIterator

          +
          +protected java.util.Iterator createIterator()
          +
          +
          Description copied from class: AbstractResourceCollectionWrapper
          +
          Do create an iterator on the resource collection. The creation + of the iterator is allowed to not be thread safe whereas the iterator + itself should. The returned iterator will be wrapped into the FailFast + one. +

          +

          +
          Specified by:
          createIterator in class AbstractResourceCollectionWrapper
          +
          +
          + +
          Returns:
          the iterator on the resource collection
          +
          +
          +
          + +

          +getSize

          +
          +protected int getSize()
          +
          +
          Description copied from class: AbstractResourceCollectionWrapper
          +
          Do compute the size of the resource collection. The implementation of + this function is allowed to be not thread safe. +

          +

          +
          Specified by:
          getSize in class AbstractResourceCollectionWrapper
          +
          +
          + +
          Returns:
          size of resource collection.
          +
          +
          +
          + +

          +getCollection

          +
          +protected abstract java.util.Collection getCollection()
          +
          +
          Template method for subclasses to return a Collection of Resources. +

          +

          + +
          Returns:
          Collection.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/CompressedResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/CompressedResource.html new file mode 100644 index 000000000..c6348e2d1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/CompressedResource.html @@ -0,0 +1,405 @@ + + + + + + +CompressedResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class CompressedResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+                  extended by org.apache.tools.ant.types.resources.ContentTransformingResource
+                      extended by org.apache.tools.ant.types.resources.CompressedResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          BZip2Resource, GZipResource
          +
          +
          +
          +
          public abstract class CompressedResource
          extends ContentTransformingResource
          + + +

          +A compressed resource. + +

          Wraps around another resource, delegates all queries (except + getSize) to that other resource but uncompresses/compresses streams + on the fly.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected CompressedResource() + +
          +          no arg constructor
          +protected CompressedResource(ResourceCollection other) + +
          +          Constructor with another resource to wrap.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected abstract  java.lang.StringgetCompressionName() + +
          +          Get the name of the compression method used.
          + java.lang.StringtoString() + +
          +          Get the string representation of this Resource.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ContentTransformingResource
          as, getInputStream, getOutputStream, getSize, isAppendSupported, wrapStream, wrapStream
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ResourceDecorator
          addConfigured, compareTo, dieOnCircularReference, getLastModified, getName, getResource, hashCode, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setRefid, setSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, equals, getMagicNumber, iterator, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CompressedResource

          +
          +protected CompressedResource()
          +
          +
          no arg constructor +

          +

          +
          + +

          +CompressedResource

          +
          +protected CompressedResource(ResourceCollection other)
          +
          +
          Constructor with another resource to wrap. +

          +

          +
          Parameters:
          other - the resource to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the string representation of this Resource. +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          this Resource formatted as a String.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getCompressionName

          +
          +protected abstract java.lang.String getCompressionName()
          +
          +
          Get the name of the compression method used. +

          +

          + +
          Returns:
          the name of the compression method.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ContentTransformingResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ContentTransformingResource.html new file mode 100644 index 000000000..47b23cad3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ContentTransformingResource.html @@ -0,0 +1,534 @@ + + + + + + +ContentTransformingResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ContentTransformingResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+                  extended by org.apache.tools.ant.types.resources.ContentTransformingResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          CompressedResource
          +
          +
          +
          +
          public abstract class ContentTransformingResource
          extends ResourceDecorator
          + + +

          +A resource that transforms the content of another resource. + +

          Wraps around another resource, delegates all queries (except + getSize) to that other resource but transforms stream content + on the fly.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected ContentTransformingResource() + +
          +          no arg constructor
          +protected ContentTransformingResource(ResourceCollection other) + +
          +          Constructor with another resource to wrap.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectas(java.lang.Class clazz) + +
          +          Suppress FileProvider, re-implement Appendable
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + longgetSize() + +
          +          Get the size of this Resource.
          +protected  booleanisAppendSupported() + +
          +          Learn whether the transformation performed allows appends.
          +protected abstract  java.io.InputStreamwrapStream(java.io.InputStream in) + +
          +          Get a content-filtering/transforming InputStream.
          +protected abstract  java.io.OutputStreamwrapStream(java.io.OutputStream out) + +
          +          Get a content-filtering/transforming OutputStream.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ResourceDecorator
          addConfigured, compareTo, dieOnCircularReference, getLastModified, getName, getResource, hashCode, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setRefid, setSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, equals, getMagicNumber, iterator, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ContentTransformingResource

          +
          +protected ContentTransformingResource()
          +
          +
          no arg constructor +

          +

          +
          + +

          +ContentTransformingResource

          +
          +protected ContentTransformingResource(ResourceCollection other)
          +
          +
          Constructor with another resource to wrap. +

          +

          +
          Parameters:
          other - the resource to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class ResourceDecorator
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          Overrides:
          getInputStream in class ResourceDecorator
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class ResourceDecorator
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +as

          +
          +public java.lang.Object as(java.lang.Class clazz)
          +
          +
          Suppress FileProvider, re-implement Appendable +

          +

          +
          Overrides:
          as in class ResourceDecorator
          +
          +
          +
          +
          +
          +
          + +

          +isAppendSupported

          +
          +protected boolean isAppendSupported()
          +
          +
          Learn whether the transformation performed allows appends. + +

          In general compressed outputs will become invalid if they + are appended to, for example.

          + +

          This implementations returns false.

          +

          +

          +
          +
          +
          +
          + +

          +wrapStream

          +
          +protected abstract java.io.InputStream wrapStream(java.io.InputStream in)
+                                           throws java.io.IOException
          +
          +
          Get a content-filtering/transforming InputStream. +

          +

          +
          Parameters:
          in - InputStream to wrap, will never be null. +
          Returns:
          a compressed inputstream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +wrapStream

          +
          +protected abstract java.io.OutputStream wrapStream(java.io.OutputStream out)
+                                            throws java.io.IOException
          +
          +
          Get a content-filtering/transforming OutputStream. +

          +

          +
          Parameters:
          out - OutputStream to wrap, will never be null. +
          Returns:
          a compressed outputstream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Difference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Difference.html new file mode 100644 index 000000000..d57df88a1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Difference.html @@ -0,0 +1,322 @@ + + + + + + +Difference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Difference

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
+              extended by org.apache.tools.ant.types.resources.Difference
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Difference
          extends BaseResourceCollectionContainer
          + + +

          +ResourceCollection representing the difference between + two or more nested ResourceCollections. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Difference() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.CollectiongetCollection() + +
          +          Calculate the difference of the nested ResourceCollections.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
          add, addAll, clear, clone, dieOnCircularReference, getResourceCollections, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Difference

          +
          +public Difference()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Calculate the difference of the nested ResourceCollections. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionContainer
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileProvider.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileProvider.html new file mode 100644 index 000000000..e2a849d3a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileProvider.html @@ -0,0 +1,218 @@ + + + + + + +FileProvider (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Interface FileProvider

          +
          +
          All Known Implementing Classes:
          FileResource
          +
          +
          +
          +
          public interface FileProvider
          + + +

          +This is an interface that resources that can provide a file should implement. + This is a refactoring of FileResource, to allow other resources + to act as sources of files (and to make components that only support + file-based resources from only support FileResource resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + java.io.FilegetFile() + +
          +          Get the file represented by this Resource.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getFile

          +
          +java.io.File getFile()
          +
          +
          Get the file represented by this Resource. +

          +

          + +
          Returns:
          the file.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResource.html new file mode 100644 index 000000000..433647f54 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResource.html @@ -0,0 +1,930 @@ + + + + + + +FileResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class FileResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.FileResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection, ResourceFactory, Appendable, FileProvider, Touchable
          +
          +
          +
          +
          public class FileResource
          extends Resource
          implements Touchable, FileProvider, ResourceFactory, Appendable
          + + +

          +A Resource representation of a File. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          FileResource() + +
          +          Default constructor.
          FileResource(java.io.File f) + +
          +          Construct a new FileResource from a File.
          FileResource(java.io.File b, + java.lang.String name) + +
          +          Construct a new FileResource using the specified basedir and relative name.
          FileResource(Project p, + java.io.File f) + +
          +          Create a new FileResource.
          FileResource(Project p, + java.lang.String s) + +
          +          Constructor for Ant attribute introspection.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intcompareTo(java.lang.Object another) + +
          +          Compare this FileResource to another Resource.
          + booleanequals(java.lang.Object another) + +
          +          Compare another Object to this FileResource for equality.
          + java.io.OutputStreamgetAppendOutputStream() + +
          +          Get an appending OutputStream.
          + java.io.FilegetBaseDir() + +
          +          Return the basedir to which the name is relative.
          + java.io.FilegetFile() + +
          +          Get the file represented by this FileResource.
          + java.io.InputStreamgetInputStream() + +
          +          Return an InputStream for reading the contents of this Resource.
          + longgetLastModified() + +
          +          Get the modification time in milliseconds since 01.01.1970 .
          + java.lang.StringgetName() + +
          +          Get the name of this FileResource.
          +protected  java.io.FilegetNotNullFile() + +
          +          Get the file represented by this FileResource, ensuring it is not null.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + ResourcegetResource(java.lang.String path) + +
          +          Create a new resource that matches a relative or absolute path.
          + longgetSize() + +
          +          Get the size of this Resource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisDirectory() + +
          +          Learn whether the resource is a directory.
          + booleanisExists() + +
          +          Learn whether this file exists.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetBaseDir(java.io.File b) + +
          +          Set the basedir for this FileResource.
          + voidsetFile(java.io.File f) + +
          +          Set the File for this FileResource.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          + java.lang.StringtoString() + +
          +          Get the string representation of this Resource.
          + voidtouch(long modTime) + +
          +          Implement the Touchable interface.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, getMagicNumber, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileResource

          +
          +public FileResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +FileResource

          +
          +public FileResource(java.io.File b,
+                    java.lang.String name)
          +
          +
          Construct a new FileResource using the specified basedir and relative name. +

          +

          +
          Parameters:
          b - the basedir as File.
          name - the relative filename.
          +
          +
          + +

          +FileResource

          +
          +public FileResource(java.io.File f)
          +
          +
          Construct a new FileResource from a File. +

          +

          +
          Parameters:
          f - the File represented.
          +
          +
          + +

          +FileResource

          +
          +public FileResource(Project p,
+                    java.io.File f)
          +
          +
          Create a new FileResource. +

          +

          +
          Parameters:
          p - Project
          f - File represented
          Since:
          +
          Ant 1.8
          +
          +
          +
          + +

          +FileResource

          +
          +public FileResource(Project p,
+                    java.lang.String s)
          +
          +
          Constructor for Ant attribute introspection. +

          +

          +
          Parameters:
          p - the Project against which to resolve s.
          s - the absolute or Project-relative filename as a String.
          See Also:
          IntrospectionHelper
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFile

          +
          +public void setFile(java.io.File f)
          +
          +
          Set the File for this FileResource. +

          +

          +
          +
          +
          +
          Parameters:
          f - the File to be represented.
          +
          +
          +
          + +

          +getFile

          +
          +public java.io.File getFile()
          +
          +
          Get the file represented by this FileResource. +

          +

          +
          Specified by:
          getFile in interface FileProvider
          +
          +
          + +
          Returns:
          the File.
          +
          +
          +
          + +

          +setBaseDir

          +
          +public void setBaseDir(java.io.File b)
          +
          +
          Set the basedir for this FileResource. +

          +

          +
          +
          +
          +
          Parameters:
          b - the basedir as File.
          +
          +
          +
          + +

          +getBaseDir

          +
          +public java.io.File getBaseDir()
          +
          +
          Return the basedir to which the name is relative. +

          +

          +
          +
          +
          + +
          Returns:
          the basedir as File.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of this FileResource. If the basedir is set, + the name will be relative to that. Otherwise the basename + only will be returned. +

          +

          +
          Overrides:
          getName in class Resource
          +
          +
          + +
          Returns:
          the name of this resource.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          Learn whether this file exists. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +getLastModified

          +
          +public long getLastModified()
          +
          +
          Get the modification time in milliseconds since 01.01.1970 . +

          +

          +
          Overrides:
          getLastModified in class Resource
          +
          +
          + +
          Returns:
          0 if the resource does not exist.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Learn whether the resource is a directory. +

          +

          +
          Overrides:
          isDirectory in class Resource
          +
          +
          + +
          Returns:
          boolean flag indicating if the resource is a directory.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Return an InputStream for reading the contents of this Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream object. +
          Throws: +
          java.io.IOException - if an error occurs.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getAppendOutputStream

          +
          +public java.io.OutputStream getAppendOutputStream()
+                                           throws java.io.IOException
          +
          +
          Get an appending OutputStream. +

          +

          +
          Specified by:
          getAppendOutputStream in interface Appendable
          +
          +
          + +
          Returns:
          OutputStream +
          Throws: +
          java.io.IOException - if anything goes wrong
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object another)
          +
          +
          Compare this FileResource to another Resource. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          Overrides:
          compareTo in class Resource
          +
          +
          +
          Parameters:
          another - the other Resource against which to compare. +
          Returns:
          a negative integer, zero, or a positive integer as this FileResource + is less than, equal to, or greater than the specified Resource.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object another)
          +
          +
          Compare another Object to this FileResource for equality. +

          +

          +
          Overrides:
          equals in class Resource
          +
          +
          +
          Parameters:
          another - the other Object to compare. +
          Returns:
          true if another is a FileResource representing the same file.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the string representation of this Resource. +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          this FileResource formatted as a String.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          Overrides:
          isFilesystemOnly in class Resource
          +
          +
          + +
          Returns:
          whether this Resource is a FileResource.
          +
          +
          +
          + +

          +touch

          +
          +public void touch(long modTime)
          +
          +
          Implement the Touchable interface. +

          +

          +
          Specified by:
          touch in interface Touchable
          +
          +
          +
          Parameters:
          modTime - new last modification time.
          +
          +
          +
          + +

          +getNotNullFile

          +
          +protected java.io.File getNotNullFile()
          +
          +
          Get the file represented by this FileResource, ensuring it is not null. +

          +

          +
          +
          +
          + +
          Returns:
          the not-null File. +
          Throws: +
          BuildException - if file is null.
          +
          +
          +
          + +

          +getResource

          +
          +public Resource getResource(java.lang.String path)
          +
          +
          Create a new resource that matches a relative or absolute path. + If the current instance has a baseDir attribute, it is copied. +

          +

          +
          Specified by:
          getResource in interface ResourceFactory
          +
          +
          +
          Parameters:
          path - relative/absolute path to a resource +
          Returns:
          a new resource of type FileResource +
          Throws: +
          BuildException - if desired
          Since:
          +
          Ant1.8
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResourceIterator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResourceIterator.html new file mode 100644 index 000000000..3ab01b4b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/FileResourceIterator.html @@ -0,0 +1,480 @@ + + + + + + +FileResourceIterator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class FileResourceIterator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.FileResourceIterator
+
          +
          +
          All Implemented Interfaces:
          java.util.Iterator
          +
          +
          +
          +
          public class FileResourceIterator
          extends java.lang.Object
          implements java.util.Iterator
          + + +

          +Iterator of FileResources from filenames. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          FileResourceIterator() + +
          +          Deprecated. in favor of FileResourceIterator(Project)
          FileResourceIterator(java.io.File basedir) + +
          +          Deprecated. in favor of FileResourceIterator(Project, File)
          FileResourceIterator(java.io.File basedir, + java.lang.String[] filenames) + +
          +          Deprecated. in favor of FileResourceIterator(Project, File, String[])
          FileResourceIterator(Project project) + +
          +          Create a new FileResourceIterator.
          FileResourceIterator(Project project, + java.io.File basedir) + +
          +          Construct a new FileResourceIterator relative to the specified + base directory.
          FileResourceIterator(Project project, + java.io.File basedir, + java.lang.String[] filenames) + +
          +          Construct a new FileResourceIterator over the specified filenames, + relative to the specified base directory.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddFiles(java.lang.String[] s) + +
          +          Add an array of filenames to this FileResourceIterator.
          + booleanhasNext() + +
          +          Find out whether this FileResourceIterator has more elements.
          + java.lang.Objectnext() + +
          +          Get the next element from this FileResourceIterator.
          + FileResourcenextResource() + +
          +          Convenience method to return the next resource.
          + voidremove() + +
          +          Not implemented.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator()
          +
          +
          Deprecated. in favor of FileResourceIterator(Project) +

          +

          Construct a new FileResourceIterator. +

          +

          +
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator(Project project)
          +
          +
          Create a new FileResourceIterator. +

          +

          +
          Parameters:
          project - associated Project instance
          Since:
          +
          Ant 1.8
          +
          +
          +
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator(java.io.File basedir)
          +
          +
          Deprecated. in favor of FileResourceIterator(Project, File) +

          +

          Construct a new FileResourceIterator relative to the specified + base directory. +

          +

          +
          Parameters:
          basedir - the base directory of this instance.
          +
          +
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator(Project project,
+                            java.io.File basedir)
          +
          +
          Construct a new FileResourceIterator relative to the specified + base directory. +

          +

          +
          Parameters:
          project - associated Project instance
          basedir - the base directory of this instance.
          Since:
          +
          Ant 1.8
          +
          +
          +
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator(java.io.File basedir,
+                            java.lang.String[] filenames)
          +
          +
          Deprecated. in favor of FileResourceIterator(Project, File, String[]) +

          +

          Construct a new FileResourceIterator over the specified filenames, + relative to the specified base directory. +

          +

          +
          Parameters:
          basedir - the base directory of this instance.
          filenames - the String[] of filenames.
          +
          +
          + +

          +FileResourceIterator

          +
          +public FileResourceIterator(Project project,
+                            java.io.File basedir,
+                            java.lang.String[] filenames)
          +
          +
          Construct a new FileResourceIterator over the specified filenames, + relative to the specified base directory. +

          +

          +
          Parameters:
          project - associated Project instance
          basedir - the base directory of this instance.
          filenames - the String[] of filenames.
          Since:
          +
          Ant 1.8
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addFiles

          +
          +public void addFiles(java.lang.String[] s)
          +
          +
          Add an array of filenames to this FileResourceIterator. +

          +

          +
          +
          +
          +
          Parameters:
          s - the filenames to add.
          +
          +
          +
          + +

          +hasNext

          +
          +public boolean hasNext()
          +
          +
          Find out whether this FileResourceIterator has more elements. +

          +

          +
          Specified by:
          hasNext in interface java.util.Iterator
          +
          +
          + +
          Returns:
          whether there are more Resources to iterate over.
          +
          +
          +
          + +

          +next

          +
          +public java.lang.Object next()
          +
          +
          Get the next element from this FileResourceIterator. +

          +

          +
          Specified by:
          next in interface java.util.Iterator
          +
          +
          + +
          Returns:
          the next Object.
          +
          +
          +
          + +

          +remove

          +
          +public void remove()
          +
          +
          Not implemented. +

          +

          +
          Specified by:
          remove in interface java.util.Iterator
          +
          +
          +
          +
          +
          +
          + +

          +nextResource

          +
          +public FileResource nextResource()
          +
          +
          Convenience method to return the next resource. +

          +

          +
          +
          +
          + +
          Returns:
          the next File.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Files.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Files.html new file mode 100644 index 000000000..49df1c34f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Files.html @@ -0,0 +1,1070 @@ + + + + + + +Files (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Files

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.AbstractSelectorContainer
+              extended by org.apache.tools.ant.types.resources.Files
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection, SelectorContainer
          +
          +
          +
          +
          public class Files
          extends AbstractSelectorContainer
          implements ResourceCollection
          + + +

          +ResourceCollection implementation; like AbstractFileSet with absolute paths. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          + Files() + +
          +          Construct a new Files collection.
          +protected Files(Files f) + +
          +          Construct a new Files collection, shallowly cloned + from the specified Files.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidappendExcludes(java.lang.String[] excludes) + +
          +          Append excludes to the current list of include + patterns.
          + voidappendIncludes(java.lang.String[] includes) + +
          +          Append includes to the current list of include + patterns.
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          + java.lang.Objectclone() + +
          +          Create a deep clone of this instance, except for the nested selectors + (the list of selectors is a shallow clone of this instance's list).
          + PatternSet.NameEntrycreateExclude() + +
          +          Add a name entry to the exclude list.
          + PatternSet.NameEntrycreateExcludesFile() + +
          +          Add a name entry to the excludes files list.
          + PatternSet.NameEntrycreateInclude() + +
          +          Add a name entry to the include list.
          + PatternSet.NameEntrycreateIncludesFile() + +
          +          Add a name entry to the include files list.
          + PatternSetcreatePatternSet() + +
          +          Create a nested patternset.
          + booleangetDefaultexcludes() + +
          +          Get whether default exclusions should be used or not.
          +protected  FilesgetRef() + +
          +          Perform the check for circular references and return the + referenced Files collection.
          + booleanhasPatterns() + +
          +          Find out whether this Files collection has patterns.
          + booleanisCaseSensitive() + +
          +          Find out if this Files collection is case-sensitive.
          + booleanisFilesystemOnly() + +
          +          Always returns true.
          + booleanisFollowSymlinks() + +
          +          Find out whether symbolic links should be followed.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.String[]mergeExcludes(Project p) + +
          +          Get the merged exclude patterns for this Files collection.
          + java.lang.String[]mergeIncludes(Project p) + +
          +          Get the merged include patterns for this Files collection.
          + PatternSetmergePatterns(Project p) + +
          +          Get the merged patterns for this Files collection.
          + voidsetCaseSensitive(boolean caseSensitive) + +
          +          Set case-sensitivity of the Files collection.
          + voidsetDefaultexcludes(boolean useDefaultExcludes) + +
          +          Set whether default exclusions should be used or not.
          + voidsetExcludes(java.lang.String excludes) + +
          +          Append excludes to the current list of exclude + patterns.
          + voidsetExcludesfile(java.io.File excl) + +
          +          Set the File containing the excludes patterns.
          + voidsetFollowSymlinks(boolean followSymlinks) + +
          +          Set whether or not symbolic links should be followed.
          + voidsetIncludes(java.lang.String includes) + +
          +          Append includes to the current list of include + patterns.
          + voidsetIncludesfile(java.io.File incl) + +
          +          Set the File containing the includes patterns.
          + voidsetRefid(Reference r) + +
          +          Make this instance in effect a reference to another instance.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Format this Files collection as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.AbstractSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Files

          +
          +public Files()
          +
          +
          Construct a new Files collection. +

          +

          +
          + +

          +Files

          +
          +protected Files(Files f)
          +
          +
          Construct a new Files collection, shallowly cloned + from the specified Files. +

          +

          +
          Parameters:
          f - the Files to use as a template.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Make this instance in effect a reference to another instance. + +

          You must not set another attribute or nest elements inside + this element if you make it a reference.

          +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the Reference to use. +
          Throws: +
          BuildException - if there is a problem.
          +
          +
          +
          + +

          +createPatternSet

          +
          +public PatternSet createPatternSet()
          +
          +
          Create a nested patternset. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.
          +
          +
          +
          + +

          +createInclude

          +
          +public PatternSet.NameEntry createInclude()
          +
          +
          Add a name entry to the include list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createIncludesFile

          +
          +public PatternSet.NameEntry createIncludesFile()
          +
          +
          Add a name entry to the include files list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createExclude

          +
          +public PatternSet.NameEntry createExclude()
          +
          +
          Add a name entry to the exclude list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +createExcludesFile

          +
          +public PatternSet.NameEntry createExcludesFile()
          +
          +
          Add a name entry to the excludes files list. +

          +

          +
          +
          +
          + +
          Returns:
          PatternSet.NameEntry.
          +
          +
          +
          + +

          +setIncludes

          +
          +public void setIncludes(java.lang.String includes)
          +
          +
          Append includes to the current list of include + patterns. + +

          Patterns may be separated by a comma or a space.

          +

          +

          +
          +
          +
          +
          Parameters:
          includes - the String containing the include patterns.
          +
          +
          +
          + +

          +appendIncludes

          +
          +public void appendIncludes(java.lang.String[] includes)
          +
          +
          Append includes to the current list of include + patterns. +

          +

          +
          +
          +
          +
          Parameters:
          includes - array containing the include patterns.
          +
          +
          +
          + +

          +setExcludes

          +
          +public void setExcludes(java.lang.String excludes)
          +
          +
          Append excludes to the current list of exclude + patterns. + +

          Patterns may be separated by a comma or a space.

          +

          +

          +
          +
          +
          +
          Parameters:
          excludes - the String containing the exclude patterns.
          +
          +
          +
          + +

          +appendExcludes

          +
          +public void appendExcludes(java.lang.String[] excludes)
          +
          +
          Append excludes to the current list of include + patterns. +

          +

          +
          +
          +
          +
          Parameters:
          excludes - array containing the exclude patterns.
          +
          +
          +
          + +

          +setIncludesfile

          +
          +public void setIncludesfile(java.io.File incl)
+                     throws BuildException
          +
          +
          Set the File containing the includes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          incl - File instance. +
          Throws: +
          BuildException - if there is a problem.
          +
          +
          +
          + +

          +setExcludesfile

          +
          +public void setExcludesfile(java.io.File excl)
+                     throws BuildException
          +
          +
          Set the File containing the excludes patterns. +

          +

          +
          +
          +
          +
          Parameters:
          excl - File instance. +
          Throws: +
          BuildException - if there is a problem.
          +
          +
          +
          + +

          +setDefaultexcludes

          +
          +public void setDefaultexcludes(boolean useDefaultExcludes)
          +
          +
          Set whether default exclusions should be used or not. +

          +

          +
          +
          +
          +
          Parameters:
          useDefaultExcludes - boolean.
          +
          +
          +
          + +

          +getDefaultexcludes

          +
          +public boolean getDefaultexcludes()
          +
          +
          Get whether default exclusions should be used or not. +

          +

          +
          +
          +
          + +
          Returns:
          the defaultexclusions value.
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean caseSensitive)
          +
          +
          Set case-sensitivity of the Files collection. +

          +

          +
          +
          +
          +
          Parameters:
          caseSensitive - boolean.
          +
          +
          +
          + +

          +isCaseSensitive

          +
          +public boolean isCaseSensitive()
          +
          +
          Find out if this Files collection is case-sensitive. +

          +

          +
          +
          +
          + +
          Returns:
          boolean indicating whether the Files + collection is case-sensitive.
          +
          +
          +
          + +

          +setFollowSymlinks

          +
          +public void setFollowSymlinks(boolean followSymlinks)
          +
          +
          Set whether or not symbolic links should be followed. +

          +

          +
          +
          +
          +
          Parameters:
          followSymlinks - whether or not symbolic links should be followed.
          +
          +
          +
          + +

          +isFollowSymlinks

          +
          +public boolean isFollowSymlinks()
          +
          +
          Find out whether symbolic links should be followed. +

          +

          +
          +
          +
          + +
          Returns:
          boolean indicating whether symbolic links + should be followed.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +hasPatterns

          +
          +public boolean hasPatterns()
          +
          +
          Find out whether this Files collection has patterns. +

          +

          +
          +
          +
          + +
          Returns:
          whether any patterns are in this container.
          +
          +
          +
          + +

          +appendSelector

          +
          +public void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Specified by:
          appendSelector in interface SelectorContainer
          Overrides:
          appendSelector in class AbstractSelectorContainer
          +
          +
          +
          Parameters:
          selector - the new FileSelector to add.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this Files collection as a String. +

          +

          +
          Overrides:
          toString in class AbstractSelectorContainer
          +
          +
          + +
          Returns:
          a descriptive String.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Create a deep clone of this instance, except for the nested selectors + (the list of selectors is a shallow clone of this instance's list). +

          +

          +
          Overrides:
          clone in class AbstractSelectorContainer
          +
          +
          + +
          Returns:
          a cloned Object.
          +
          +
          +
          + +

          +mergeIncludes

          +
          +public java.lang.String[] mergeIncludes(Project p)
          +
          +
          Get the merged include patterns for this Files collection. +

          +

          +
          +
          +
          +
          Parameters:
          p - Project instance. +
          Returns:
          the include patterns of the default pattern set and all + nested patternsets.
          +
          +
          +
          + +

          +mergeExcludes

          +
          +public java.lang.String[] mergeExcludes(Project p)
          +
          +
          Get the merged exclude patterns for this Files collection. +

          +

          +
          +
          +
          +
          Parameters:
          p - Project instance. +
          Returns:
          the exclude patterns of the default pattern set and all + nested patternsets.
          +
          +
          +
          + +

          +mergePatterns

          +
          +public PatternSet mergePatterns(Project p)
          +
          +
          Get the merged patterns for this Files collection. +

          +

          +
          +
          +
          +
          Parameters:
          p - Project instance. +
          Returns:
          the default patternset merged with the additional sets + in a new PatternSet instance.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Always returns true. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true indicating that all elements of a Files collection + will be FileResources.
          +
          +
          +
          + +

          +getRef

          +
          +protected Files getRef()
          +
          +
          Perform the check for circular references and return the + referenced Files collection. +

          +

          +
          +
          +
          + +
          Returns:
          FileCollection.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/First.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/First.html new file mode 100644 index 000000000..b0be0128b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/First.html @@ -0,0 +1,342 @@ + + + + + + +First (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class First

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+                  extended by org.apache.tools.ant.types.resources.SizeLimitCollection
+                      extended by org.apache.tools.ant.types.resources.First
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class First
          extends SizeLimitCollection
          + + +

          +ResourceCollection that contains the first count elements of + another ResourceCollection, a la the UNIX head command. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          First() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.CollectiongetCollection() + +
          +          Take the first count elements.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.SizeLimitCollection
          getCount, getValidCount, setCount, size
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
          createIterator, getSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, dieOnCircularReference, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +First

          +
          +public First()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Take the first count elements. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionWrapper
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/GZipResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/GZipResource.html new file mode 100644 index 000000000..28c6978b0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/GZipResource.html @@ -0,0 +1,439 @@ + + + + + + +GZipResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class GZipResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+                  extended by org.apache.tools.ant.types.resources.ContentTransformingResource
+                      extended by org.apache.tools.ant.types.resources.CompressedResource
+                          extended by org.apache.tools.ant.types.resources.GZipResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class GZipResource
          extends CompressedResource
          + + +

          +A GZip compressed resource. + +

          Wraps around another resource, delegates all queries to that + other resource but uncompresses/compresses streams on the fly.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          GZipResource() + +
          +          A no-arg constructor
          GZipResource(ResourceCollection other) + +
          +          Constructor with another resource to wrap.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringgetCompressionName() + +
          +          Get the name of the compression method.
          +protected  java.io.InputStreamwrapStream(java.io.InputStream in) + +
          +          Decompress on the fly using java.util.zip.GZIPInputStream.
          +protected  java.io.OutputStreamwrapStream(java.io.OutputStream out) + +
          +          Compress on the fly using java.util.zip.GZIPOutStream.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.CompressedResource
          toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ContentTransformingResource
          as, getInputStream, getOutputStream, getSize, isAppendSupported
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ResourceDecorator
          addConfigured, compareTo, dieOnCircularReference, getLastModified, getName, getResource, hashCode, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setRefid, setSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, equals, getMagicNumber, iterator, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +GZipResource

          +
          +public GZipResource()
          +
          +
          A no-arg constructor +

          +

          +
          + +

          +GZipResource

          +
          +public GZipResource(ResourceCollection other)
          +
          +
          Constructor with another resource to wrap. +

          +

          +
          Parameters:
          other - the resource to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +wrapStream

          +
          +protected java.io.InputStream wrapStream(java.io.InputStream in)
+                                  throws java.io.IOException
          +
          +
          Decompress on the fly using java.util.zip.GZIPInputStream. +

          +

          +
          Specified by:
          wrapStream in class ContentTransformingResource
          +
          +
          +
          Parameters:
          in - the stream to wrap. +
          Returns:
          the wrapped stream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +wrapStream

          +
          +protected java.io.OutputStream wrapStream(java.io.OutputStream out)
+                                   throws java.io.IOException
          +
          +
          Compress on the fly using java.util.zip.GZIPOutStream. +

          +

          +
          Specified by:
          wrapStream in class ContentTransformingResource
          +
          +
          +
          Parameters:
          out - the stream to wrap. +
          Returns:
          the wrapped stream. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +getCompressionName

          +
          +protected java.lang.String getCompressionName()
          +
          +
          Get the name of the compression method. +

          +

          +
          Specified by:
          getCompressionName in class CompressedResource
          +
          +
          + +
          Returns:
          the string "GZip".
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ImmutableResourceException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ImmutableResourceException.html new file mode 100644 index 000000000..b78e95f1f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ImmutableResourceException.html @@ -0,0 +1,263 @@ + + + + + + +ImmutableResourceException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ImmutableResourceException

          +
          +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.apache.tools.ant.types.resources.ImmutableResourceException
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable
          +
          +
          +
          +
          public class ImmutableResourceException
          extends java.io.IOException
          + + +

          +Exception thrown when an attempt is made to get an OutputStream + from an immutable Resource. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          ImmutableResourceException() + +
          +          Default constructor.
          ImmutableResourceException(java.lang.String s) + +
          +          Construct a new ImmutableResourceException with the specified message.
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Throwable
          fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ImmutableResourceException

          +
          +public ImmutableResourceException()
          +
          +
          Default constructor. +

          +

          +
          + +

          +ImmutableResourceException

          +
          +public ImmutableResourceException(java.lang.String s)
          +
          +
          Construct a new ImmutableResourceException with the specified message. +

          +

          +
          Parameters:
          s - the message String.
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Intersect.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Intersect.html new file mode 100644 index 000000000..ce7377430 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Intersect.html @@ -0,0 +1,322 @@ + + + + + + +Intersect (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Intersect

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
+              extended by org.apache.tools.ant.types.resources.Intersect
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Intersect
          extends BaseResourceCollectionContainer
          + + +

          +ResourceCollection representing the intersection + of multiple nested ResourceCollections. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Intersect() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.CollectiongetCollection() + +
          +          Calculate the intersection of the nested ResourceCollections.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
          add, addAll, clear, clone, dieOnCircularReference, getResourceCollections, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Intersect

          +
          +public Intersect()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Calculate the intersection of the nested ResourceCollections. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionContainer
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaConstantResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaConstantResource.html new file mode 100644 index 000000000..94c6df443 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaConstantResource.html @@ -0,0 +1,363 @@ + + + + + + +JavaConstantResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class JavaConstantResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.AbstractClasspathResource
+                  extended by org.apache.tools.ant.types.resources.JavaConstantResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class JavaConstantResource
          extends AbstractClasspathResource
          + + +

          +A resource that is a java constant. + This lets you extract values off the classpath and use them elsewhere +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.types.resources.AbstractClasspathResource
          AbstractClasspathResource.ClassLoaderWithFlag
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          JavaConstantResource() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.io.InputStreamopenInputStream(java.lang.ClassLoader cl) + +
          +          open the input stream from a specific classloader
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractClasspathResource
          createClasspath, dieOnCircularReference, getClassLoader, getClasspath, getInputStream, getLoader, isExists, setClasspath, setClasspathRef, setLoaderRef, setParentFirst, setRefid
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, equals, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JavaConstantResource

          +
          +public JavaConstantResource()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +openInputStream

          +
          +protected java.io.InputStream openInputStream(java.lang.ClassLoader cl)
+                                       throws java.io.IOException
          +
          +
          open the input stream from a specific classloader +

          +

          +
          Specified by:
          openInputStream in class AbstractClasspathResource
          +
          +
          +
          Parameters:
          cl - the classloader to use. Will be null if the system classloader is used +
          Returns:
          an open input stream for the resource +
          Throws: +
          java.io.IOException - if an error occurs.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaResource.html new file mode 100644 index 000000000..b6a1ee6f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/JavaResource.html @@ -0,0 +1,441 @@ + + + + + + +JavaResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class JavaResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.AbstractClasspathResource
+                  extended by org.apache.tools.ant.types.resources.JavaResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection, URLProvider
          +
          +
          +
          +
          public class JavaResource
          extends AbstractClasspathResource
          implements URLProvider
          + + +

          +A Resource representation of something loadable via a Java classloader. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.types.resources.AbstractClasspathResource
          AbstractClasspathResource.ClassLoaderWithFlag
          +  + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          JavaResource() + +
          +          Default constructor.
          JavaResource(java.lang.String name, + Path path) + +
          +          Construct a new JavaResource using the specified name and + classpath.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intcompareTo(java.lang.Object another) + +
          +          Compare this JavaResource to another Resource.
          + java.net.URLgetURL() + +
          +          Get the URL represented by this Resource.
          +protected  java.io.InputStreamopenInputStream(java.lang.ClassLoader cl) + +
          +          open the input stream from a specific classloader
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractClasspathResource
          createClasspath, dieOnCircularReference, getClassLoader, getClasspath, getInputStream, getLoader, isExists, setClasspath, setClasspathRef, setLoaderRef, setParentFirst, setRefid
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, equals, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JavaResource

          +
          +public JavaResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +JavaResource

          +
          +public JavaResource(java.lang.String name,
+                    Path path)
          +
          +
          Construct a new JavaResource using the specified name and + classpath. +

          +

          +
          Parameters:
          name - the resource name.
          path - the classpath.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +openInputStream

          +
          +protected java.io.InputStream openInputStream(java.lang.ClassLoader cl)
+                                       throws java.io.IOException
          +
          +
          open the input stream from a specific classloader +

          +

          +
          Specified by:
          openInputStream in class AbstractClasspathResource
          +
          +
          +
          Parameters:
          cl - the classloader to use. Will be null if the system + classloader is used +
          Returns:
          an open input stream for the resource +
          Throws: +
          java.io.IOException - if an error occurs.
          +
          +
          +
          + +

          +getURL

          +
          +public java.net.URL getURL()
          +
          +
          Get the URL represented by this Resource. +

          +

          +
          Specified by:
          getURL in interface URLProvider
          +
          +
          + +
          Returns:
          the file.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object another)
          +
          +
          Compare this JavaResource to another Resource. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          Overrides:
          compareTo in class Resource
          +
          +
          +
          Parameters:
          another - the other Resource against which to compare. +
          Returns:
          a negative integer, zero, or a positive integer as this + JavaResource is less than, equal to, or greater than the + specified Resource.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Last.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Last.html new file mode 100644 index 000000000..dde0016fc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Last.html @@ -0,0 +1,342 @@ + + + + + + +Last (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Last

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+                  extended by org.apache.tools.ant.types.resources.SizeLimitCollection
+                      extended by org.apache.tools.ant.types.resources.Last
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Last
          extends SizeLimitCollection
          + + +

          +ResourceCollection that contains the last count elements of + another ResourceCollection, a la the UNIX tail command. +

          + +

          +

          +
          Since:
          +
          Ant 1.7.1
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Last() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.CollectiongetCollection() + +
          +          Take the last count elements.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.SizeLimitCollection
          getCount, getValidCount, setCount, size
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
          createIterator, getSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, dieOnCircularReference, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Last

          +
          +public Last()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Take the last count elements. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionWrapper
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.html new file mode 100644 index 000000000..fa72a7a6e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LazyResourceCollectionWrapper.html @@ -0,0 +1,372 @@ + + + + + + +LazyResourceCollectionWrapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class LazyResourceCollectionWrapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.LazyResourceCollectionWrapper
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class LazyResourceCollectionWrapper
          extends AbstractResourceCollectionWrapper
          + + +

          +Resource collection which load underlying resource collection only on demand + with support for caching +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          LazyResourceCollectionWrapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.IteratorcreateIterator() + +
          +          Do create an iterator on the resource collection.
          +protected  booleanfilterResource(Resource r) + +
          +          Specify if the resource should be filtered or not.
          +protected  intgetSize() + +
          +          Do compute the size of the resource collection.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, dieOnCircularReference, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LazyResourceCollectionWrapper

          +
          +public LazyResourceCollectionWrapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createIterator

          +
          +protected java.util.Iterator createIterator()
          +
          +
          Description copied from class: AbstractResourceCollectionWrapper
          +
          Do create an iterator on the resource collection. The creation + of the iterator is allowed to not be thread safe whereas the iterator + itself should. The returned iterator will be wrapped into the FailFast + one. +

          +

          +
          Specified by:
          createIterator in class AbstractResourceCollectionWrapper
          +
          +
          + +
          Returns:
          the iterator on the resource collection
          +
          +
          +
          + +

          +getSize

          +
          +protected int getSize()
          +
          +
          Description copied from class: AbstractResourceCollectionWrapper
          +
          Do compute the size of the resource collection. The implementation of + this function is allowed to be not thread safe. +

          +

          +
          Specified by:
          getSize in class AbstractResourceCollectionWrapper
          +
          +
          + +
          Returns:
          size of resource collection.
          +
          +
          +
          + +

          +filterResource

          +
          +protected boolean filterResource(Resource r)
          +
          +
          Specify if the resource should be filtered or not. This function should + be overrided in order to define the filtering algorithm +

          +

          +
          Parameters:
          r - resource considered for filtration +
          Returns:
          whether the resource should be filtered or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LogOutputResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LogOutputResource.html new file mode 100644 index 000000000..fb234cc95 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/LogOutputResource.html @@ -0,0 +1,386 @@ + + + + + + +LogOutputResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class LogOutputResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.LogOutputResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection, Appendable
          +
          +
          +
          +
          public class LogOutputResource
          extends Resource
          implements Appendable
          + + +

          +Output-only Resource that always appends to Ant's log. +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          LogOutputResource(ProjectComponent managingComponent) + +
          +          Create a new LogOutputResource.
          LogOutputResource(ProjectComponent managingComponent, + int level) + +
          +          Create a new LogOutputResource.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.io.OutputStreamgetAppendOutputStream() + +
          +          Get an appending OutputStream.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, equals, getInputStream, getLastModified, getMagicNumber, getName, getSize, hashCode, isDirectory, isExists, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setRefid, setSize, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LogOutputResource

          +
          +public LogOutputResource(ProjectComponent managingComponent)
          +
          +
          Create a new LogOutputResource. +

          +

          +
          Parameters:
          managingComponent -
          +
          +
          + +

          +LogOutputResource

          +
          +public LogOutputResource(ProjectComponent managingComponent,
+                         int level)
          +
          +
          Create a new LogOutputResource. +

          +

          +
          Parameters:
          managingComponent - owning log content
          level - log level
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getAppendOutputStream

          +
          +public java.io.OutputStream getAppendOutputStream()
+                                           throws java.io.IOException
          +
          +
          Get an appending OutputStream. +

          +

          +
          Specified by:
          getAppendOutputStream in interface Appendable
          +
          +
          + +
          Returns:
          OutputStream +
          Throws: +
          java.io.IOException - if anything goes wrong
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResource.html new file mode 100644 index 000000000..077cd1483 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResource.html @@ -0,0 +1,454 @@ + + + + + + +MappedResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class MappedResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+                  extended by org.apache.tools.ant.types.resources.MappedResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class MappedResource
          extends ResourceDecorator
          + + +

          +A decorator around a different resource that uses a mapper to + dynamically remap the resource's name. + +

          Strips the FileProvider interface from decorated resources since + it may be used to circumvent name mapping.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          MappedResource(Resource r, + FileNameMapper m) + +
          +          Wraps an existing resource.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectas(java.lang.Class clazz) + +
          +          Suppress FileProvider
          + booleanequals(java.lang.Object other) + +
          +          Equality check based on the resource's name in addition to the + resource itself.
          + java.lang.StringgetName() + +
          +          Maps the name.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + voidsetRefid(Reference r) + +
          +          Not really supported since mapper is never null.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ResourceDecorator
          addConfigured, compareTo, dieOnCircularReference, getInputStream, getLastModified, getOutputStream, getResource, getSize, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, getMagicNumber, iterator, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MappedResource

          +
          +public MappedResource(Resource r,
+                      FileNameMapper m)
          +
          +
          Wraps an existing resource. +

          +

          +
          Parameters:
          r - Resource to wrap
          m - FileNameMapper that handles mapping
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Maps the name. +

          +

          +
          Overrides:
          getName in class ResourceDecorator
          +
          +
          + +
          Returns:
          the name of the wrapped resource.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Not really supported since mapper is never null. +

          +

          +
          Overrides:
          setRefid in class ResourceDecorator
          +
          +
          +
          Parameters:
          r - reference to set
          +
          +
          +
          + +

          +as

          +
          +public java.lang.Object as(java.lang.Class clazz)
          +
          +
          Suppress FileProvider +

          +

          +
          Overrides:
          as in class ResourceDecorator
          +
          +
          +
          Parameters:
          clazz - the type to implement
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class ResourceDecorator
          +
          +
          + +
          Returns:
          hash code as int.
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object other)
          +
          +
          Equality check based on the resource's name in addition to the + resource itself. +

          +

          +
          Overrides:
          equals in class Resource
          +
          +
          +
          Parameters:
          other - the object to check against. +
          Returns:
          true if the specified Object is equal to this Resource.
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResourceCollection.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResourceCollection.html new file mode 100644 index 000000000..b2d1a04aa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/MappedResourceCollection.html @@ -0,0 +1,588 @@ + + + + + + +MappedResourceCollection (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class MappedResourceCollection

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.MappedResourceCollection
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class MappedResourceCollection
          extends DataType
          implements ResourceCollection, java.lang.Cloneable
          + + +

          +Wrapper around a resource collections that maps the names of the + other collection using a configured mapper. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          MappedResourceCollection() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileNameMapper fileNameMapper) + +
          +          Add a nested filenamemapper.
          + voidadd(ResourceCollection c) + +
          +          Adds the required nested ResourceCollection.
          + java.lang.Objectclone() + +
          +          Implement clone.
          + MappercreateMapper() + +
          +          Define the mapper to map source to destination files.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          + booleanisFilesystemOnly() + +
          +          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions.
          + java.util.Iteratoriterator() + +
          +          Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances.
          + voidsetCache(boolean cache) + +
          +          Set whether to cache collections.
          + voidsetEnableMultipleMappings(boolean enableMultipleMappings) + +
          +          Set method of handling mappers that return multiple + mappings for a given source path.
          + voidsetRefid(Reference r) + +
          +          Overrides the base version.
          + intsize() + +
          +          Learn the number of contained Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MappedResourceCollection

          +
          +public MappedResourceCollection()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceCollection c)
+         throws BuildException
          +
          +
          Adds the required nested ResourceCollection. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +createMapper

          +
          +public Mapper createMapper()
+                    throws BuildException
          +
          +
          Define the mapper to map source to destination files. +

          +

          +
          +
          +
          + +
          Returns:
          a mapper to be configured. +
          Throws: +
          BuildException - if more than one mapper is defined.
          +
          +
          +
          + +

          +add

          +
          +public void add(FileNameMapper fileNameMapper)
          +
          +
          Add a nested filenamemapper. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - the mapper to add.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setEnableMultipleMappings

          +
          +public void setEnableMultipleMappings(boolean enableMultipleMappings)
          +
          +
          Set method of handling mappers that return multiple + mappings for a given source path. +

          +

          +
          +
          +
          +
          Parameters:
          enableMultipleMappings - If true the type will + use all the mappings for a given source path, if + false, only the first mapped name is + processed. + By default, this setting is false to provide backward + compatibility with earlier releases.
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          +
          + +

          +setCache

          +
          +public void setCache(boolean cache)
          +
          +
          Set whether to cache collections. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Indicate whether this ResourceCollection is composed entirely of + Resources accessible via local filesystem conventions. If true, + all Resources returned from this ResourceCollection should be + instances of FileResource. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Learn the number of contained Resources. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Get an Iterator over the contents of this ResourceCollection, whose elements + are org.apache.tools.ant.types.Resource instances. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the base version. +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Implement clone. The nested resource collection and mapper are copied. +

          +

          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a cloned instance.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/PropertyResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/PropertyResource.html new file mode 100644 index 000000000..abfb9a56f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/PropertyResource.html @@ -0,0 +1,612 @@ + + + + + + +PropertyResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class PropertyResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.PropertyResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class PropertyResource
          extends Resource
          + + +

          +Exposes an Ant property as a Resource. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          PropertyResource() + +
          +          Default constructor.
          PropertyResource(Project p, + java.lang.String n) + +
          +          Construct a new PropertyResource with the specified name.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanequals(java.lang.Object o) + +
          +          Override to implement equality with equivalent Resources, + since we are capable of proxying them.
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + java.lang.ObjectgetObjectValue() + +
          +          Get the Object value of this PropertyResource.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          +protected  ResourcegetReferencedOrProxied() + +
          +          Get the referenced or proxied Resource, if applicable.
          + longgetSize() + +
          +          Get the size of this Resource.
          + java.lang.StringgetValue() + +
          +          Get the value of this PropertyResource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisExists() + +
          +          Find out whether this Resource exists.
          +protected  booleanisReferenceOrProxy() + +
          +          Learn whether this PropertyResource either refers to another Resource + or proxies another Resource due to its object property value being said Resource.
          + java.lang.StringtoString() + +
          +          Get the string representation of this Resource.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, getLastModified, getMagicNumber, getName, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setRefid, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertyResource

          +
          +public PropertyResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +PropertyResource

          +
          +public PropertyResource(Project p,
+                        java.lang.String n)
          +
          +
          Construct a new PropertyResource with the specified name. +

          +

          +
          Parameters:
          p - the project to use.
          n - the String name of this PropertyResource (Ant property name/key).
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValue

          +
          +public java.lang.String getValue()
          +
          +
          Get the value of this PropertyResource. +

          +

          + +
          Returns:
          the value of the specified Property.
          +
          +
          +
          + +

          +getObjectValue

          +
          +public java.lang.Object getObjectValue()
          +
          +
          Get the Object value of this PropertyResource. +

          +

          + +
          Returns:
          the Object value of the specified Property.
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          Find out whether this Resource exists. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if the Property is set, false otherwise.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          Override to implement equality with equivalent Resources, + since we are capable of proxying them. +

          +

          +
          Overrides:
          equals in class Resource
          +
          +
          +
          Parameters:
          o - object to compare +
          Returns:
          true if equal to o
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the string representation of this Resource. +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          this Resource formatted as a String.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +isReferenceOrProxy

          +
          +protected boolean isReferenceOrProxy()
          +
          +
          Learn whether this PropertyResource either refers to another Resource + or proxies another Resource due to its object property value being said Resource. +

          +

          + +
          Returns:
          boolean
          +
          +
          +
          + +

          +getReferencedOrProxied

          +
          +protected Resource getReferencedOrProxied()
          +
          +
          Get the referenced or proxied Resource, if applicable. +

          +

          + +
          Returns:
          Resource +
          Throws: +
          java.lang.IllegalStateException - if this PropertyResource neither proxies nor + references another Resource.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceDecorator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceDecorator.html new file mode 100644 index 000000000..e39037d73 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceDecorator.html @@ -0,0 +1,877 @@ + + + + + + +ResourceDecorator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ResourceDecorator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ResourceDecorator
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          ContentTransformingResource, MappedResource
          +
          +
          +
          +
          public abstract class ResourceDecorator
          extends Resource
          + + +

          +Abstract class that delegates all reading methods of Resource to + its wrapped resource and deals with reference handling. + +

          Overwrites all setters to throw exceptions.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected ResourceDecorator() + +
          +          no arg constructor
          +protected ResourceDecorator(ResourceCollection other) + +
          +          Constructor with another resource to wrap.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(ResourceCollection a) + +
          +          Sets the resource to wrap using a single-element collection.
          + java.lang.Objectas(java.lang.Class clazz) + +
          +          Returns a view of this resource that implements the interface + given as the argument or null if there is no such view.
          + intcompareTo(java.lang.Object other) + +
          +          Delegates to a comparison of names.
          +protected  voiddieOnCircularReference(java.util.Stack stack, + Project project) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + longgetLastModified() + +
          +          Tells the modification time in milliseconds since 01.01.1970 .
          + java.lang.StringgetName() + +
          +          Get the name of the resource.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          +protected  ResourcegetResource() + +
          +          De-references refids if any, ensures a wrapped resource has + been specified.
          + longgetSize() + +
          +          Get the size of this Resource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisDirectory() + +
          +          Tells if the resource is a directory.
          + booleanisExists() + +
          +          The exists attribute tells whether a file exists.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetDirectory(boolean directory) + +
          +          Override setDirectory.
          + voidsetExists(boolean exists) + +
          +          Set the exists attribute.
          + voidsetLastModified(long lastmodified) + +
          +          Override setLastModified.
          + voidsetName(java.lang.String name) + +
          +          Overridden, not allowed to set the name of the resource.
          + voidsetRefid(Reference r) + +
          +          Overrides the base version.
          + voidsetSize(long size) + +
          +          Override setSize.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          clone, equals, getMagicNumber, iterator, size, toLongString, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceDecorator

          +
          +protected ResourceDecorator()
          +
          +
          no arg constructor +

          +

          +
          + +

          +ResourceDecorator

          +
          +protected ResourceDecorator(ResourceCollection other)
          +
          +
          Constructor with another resource to wrap. +

          +

          +
          Parameters:
          other - the resource to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addConfigured

          +
          +public final void addConfigured(ResourceCollection a)
          +
          +
          Sets the resource to wrap using a single-element collection. +

          +

          +
          Parameters:
          a - the resource to wrap as a single element Resource collection.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of the resource. +

          +

          +
          Overrides:
          getName in class Resource
          +
          +
          + +
          Returns:
          the name of the wrapped resource.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          The exists attribute tells whether a file exists. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +getLastModified

          +
          +public long getLastModified()
          +
          +
          Tells the modification time in milliseconds since 01.01.1970 . +

          +

          +
          Overrides:
          getLastModified in class Resource
          +
          +
          + +
          Returns:
          0 if the resource does not exist to mirror the behavior + of File.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Tells if the resource is a directory. +

          +

          +
          Overrides:
          isDirectory in class Resource
          +
          +
          + +
          Returns:
          boolean flag indicating if the resource is a directory.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          Overrides:
          isFilesystemOnly in class Resource
          +
          +
          + +
          Returns:
          whether this Resource is a FileProvider.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the base version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +as

          +
          +public java.lang.Object as(java.lang.Class clazz)
          +
          +
          Returns a view of this resource that implements the interface + given as the argument or null if there is no such view. + +

          This allows extension interfaces to be added to resources + without growing the number of permutations of interfaces + decorators/adapters need to implement.

          + +

          This implementation of the method will return the current + instance itself if it can be assigned to the given class.

          +

          +

          +
          Overrides:
          as in class Resource
          +
          +
          +
          +
          +
          +
          + +

          +compareTo

          +
          +public int compareTo(java.lang.Object other)
          +
          +
          Delegates to a comparison of names. +

          +

          +
          Specified by:
          compareTo in interface java.lang.Comparable
          Overrides:
          compareTo in class Resource
          +
          +
          +
          Parameters:
          other - the object to compare to. +
          Returns:
          a negative integer, zero, or a positive integer as this Resource + is less than, equal to, or greater than the specified Resource.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +getResource

          +
          +protected final Resource getResource()
          +
          +
          De-references refids if any, ensures a wrapped resource has + been specified. +

          +

          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stack,
+                                      Project project)
+                               throws BuildException
          +
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stack - the stack of references to check.
          project - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
+             throws BuildException
          +
          +
          Overridden, not allowed to set the name of the resource. +

          +

          +
          Overrides:
          setName in class Resource
          +
          +
          +
          Parameters:
          name - not used. +
          Throws: +
          BuildException - always.
          +
          +
          +
          + +

          +setExists

          +
          +public void setExists(boolean exists)
          +
          +
          Set the exists attribute. +

          +

          +
          Overrides:
          setExists in class Resource
          +
          +
          +
          Parameters:
          exists - if true, this resource exists.
          +
          +
          +
          + +

          +setLastModified

          +
          +public void setLastModified(long lastmodified)
+                     throws BuildException
          +
          +
          Override setLastModified. +

          +

          +
          Overrides:
          setLastModified in class Resource
          +
          +
          +
          Parameters:
          lastmodified - not used. +
          Throws: +
          BuildException - always.
          +
          +
          +
          + +

          +setDirectory

          +
          +public void setDirectory(boolean directory)
+                  throws BuildException
          +
          +
          Override setDirectory. +

          +

          +
          Overrides:
          setDirectory in class Resource
          +
          +
          +
          Parameters:
          directory - not used. +
          Throws: +
          BuildException - always.
          +
          +
          +
          + +

          +setSize

          +
          +public void setSize(long size)
+             throws BuildException
          +
          +
          Override setSize. +

          +

          +
          Overrides:
          setSize in class Resource
          +
          +
          +
          Parameters:
          size - not used. +
          Throws: +
          BuildException - always.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceList.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceList.html new file mode 100644 index 000000000..83c972090 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ResourceList.html @@ -0,0 +1,503 @@ + + + + + + +ResourceList (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ResourceList

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.ResourceList
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class ResourceList
          extends DataType
          implements ResourceCollection
          + + +

          +Reads a resource as text document and creates a resource for each + line. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ResourceList() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection rc) + +
          +          Adds a source.
          + voidaddFilterChain(FilterChain filter) + +
          +          Adds a FilterChain.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetEncoding(java.lang.String encoding) + +
          +          Encoding to use for input, defaults to the platform's default + encoding.
          + voidsetRefid(Reference r) + +
          +          Makes this instance in effect a reference to another ResourceList + instance.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceList

          +
          +public ResourceList()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceCollection rc)
          +
          +
          Adds a source. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +addFilterChain

          +
          +public final void addFilterChain(FilterChain filter)
          +
          +
          Adds a FilterChain. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +setEncoding

          +
          +public final void setEncoding(java.lang.String encoding)
          +
          +
          Encoding to use for input, defaults to the platform's default + encoding.

          + + For a list of possible values see + + http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html + .

          +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
+              throws BuildException
          +
          +
          Makes this instance in effect a reference to another ResourceList + instance. +

          +

          +
          Overrides:
          setRefid in class DataType
          +
          +
          +
          Parameters:
          r - the reference to use +
          Throws: +
          BuildException
          +
          +
          +
          + +

          +iterator

          +
          +public final java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. The Iterator returned + will throw ConcurrentModificationExceptions if ResourceCollections + are added to this container while the Iterator is in use. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          a "fail-fast" Iterator.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Resources.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Resources.html new file mode 100644 index 000000000..239831d62 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Resources.html @@ -0,0 +1,563 @@ + + + + + + +Resources (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Resources

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.Resources
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Resources
          extends DataType
          implements ResourceCollection
          + + +

          +Generic ResourceCollection: Either stores nested ResourceCollections, + making no attempt to remove duplicates, or references another ResourceCollection. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.util.IteratorEMPTY_ITERATOR + +
          +          static empty Iterator
          +static ResourceCollectionNONE + +
          +          static empty ResourceCollection
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Resources() + +
          +          Create a new Resources.
          Resources(Project project) + +
          +          Create a new Resources.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection c) + +
          +          Add a ResourceCollection.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version of DataType to recurse on all DataType + child elements that may have been added.
          +protected  voidinvalidateExistingIterators() + +
          +          Allow subclasses to notify existing Iterators they have experienced concurrent modification.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetCache(boolean b) + +
          +          Set whether to cache collections.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Format this Resources as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +NONE

          +
          +public static final ResourceCollection NONE
          +
          +
          static empty ResourceCollection +

          +

          +
          +
          +
          + +

          +EMPTY_ITERATOR

          +
          +public static final java.util.Iterator EMPTY_ITERATOR
          +
          +
          static empty Iterator +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Resources

          +
          +public Resources()
          +
          +
          Create a new Resources. +

          +

          +
          + +

          +Resources

          +
          +public Resources(Project project)
          +
          +
          Create a new Resources. +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCache

          +
          +public void setCache(boolean b)
          +
          +
          Set whether to cache collections. +

          +

          +
          +
          +
          +
          Parameters:
          b - boolean cache flag.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection c)
          +
          +
          Add a ResourceCollection. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add.
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          true if all Resources represent files.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this Resources as a String. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a descriptive String.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version of DataType to recurse on all DataType + child elements that may have been added. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +invalidateExistingIterators

          +
          +protected void invalidateExistingIterators()
          +
          +
          Allow subclasses to notify existing Iterators they have experienced concurrent modification. +

          +

          +
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Restrict.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Restrict.html new file mode 100644 index 000000000..afda2fbf0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Restrict.html @@ -0,0 +1,522 @@ + + + + + + +Restrict (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Restrict

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+              extended by org.apache.tools.ant.types.resources.Restrict
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Restrict
          extends ResourceSelectorContainer
          implements ResourceCollection
          + + +

          +ResourceCollection that allows a number of selectors to be + applied to a single ResourceCollection for the purposes of + restricting or narrowing results. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Restrict() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection c) + +
          +          Add the ResourceCollection.
          + voidadd(ResourceSelector s) + +
          +          Add a ResourceSelector.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version from DataType to recurse on nested ResourceSelectors.
          + booleanisCache() + +
          +          Learn whether to cache collections.
          + booleanisFilesystemOnly() + +
          +          Fulfill the ResourceCollection contract.
          + java.util.Iteratoriterator() + +
          +          Fulfill the ResourceCollection contract.
          + voidsetCache(boolean b) + +
          +          Set whether to cache collections.
          + intsize() + +
          +          Fulfill the ResourceCollection contract.
          + java.lang.StringtoString() + +
          +          Format this Restrict collection as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
          getSelectors, hasSelectors, selectorCount
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Restrict

          +
          +public Restrict()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceCollection c)
          +
          +
          Add the ResourceCollection. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceCollection to add.
          +
          +
          +
          + +

          +setCache

          +
          +public void setCache(boolean b)
          +
          +
          Set whether to cache collections. +

          +

          +
          +
          +
          +
          Parameters:
          b - boolean cache flag.
          +
          +
          +
          + +

          +isCache

          +
          +public boolean isCache()
          +
          +
          Learn whether to cache collections. Default is true. +

          +

          +
          +
          +
          + +
          Returns:
          boolean cache flag.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceSelector s)
          +
          +
          Add a ResourceSelector. +

          +

          +
          Overrides:
          add in class ResourceSelectorContainer
          +
          +
          +
          Parameters:
          s - the ResourceSelector to add.
          +
          +
          +
          + +

          +iterator

          +
          +public final java.util.Iterator iterator()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          iterator in interface ResourceCollection
          +
          +
          + +
          Returns:
          an Iterator of Resources.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          +
          +
          + +
          Returns:
          number of elements as int.
          +
          +
          +
          + +

          +isFilesystemOnly

          +
          +public boolean isFilesystemOnly()
          +
          +
          Fulfill the ResourceCollection contract. +

          +

          +
          Specified by:
          isFilesystemOnly in interface ResourceCollection
          +
          +
          + +
          Returns:
          whether this is a filesystem-only resource collection.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Format this Restrict collection as a String. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          the String value of this collection.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
          +
          +
          Description copied from class: ResourceSelectorContainer
          +
          Overrides the version from DataType to recurse on nested ResourceSelectors. +

          +

          +
          Overrides:
          dieOnCircularReference in class ResourceSelectorContainer
          +
          +
          +
          Parameters:
          stk - the Stack of references.
          p - the Project to resolve against.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/SizeLimitCollection.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/SizeLimitCollection.html new file mode 100644 index 000000000..5e20782a6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/SizeLimitCollection.html @@ -0,0 +1,399 @@ + + + + + + +SizeLimitCollection (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class SizeLimitCollection

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+                  extended by org.apache.tools.ant.types.resources.SizeLimitCollection
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          Direct Known Subclasses:
          First, Last
          +
          +
          +
          +
          public abstract class SizeLimitCollection
          extends BaseResourceCollectionWrapper
          + + +

          +ResourceCollection that imposes a size limit on another ResourceCollection. +

          + +

          +

          +
          Since:
          +
          Ant 1.7.1
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SizeLimitCollection() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intgetCount() + +
          +          Get the number of resources to be included.
          +protected  intgetValidCount() + +
          +          Get the count, verifying it is >= 0.
          + voidsetCount(int i) + +
          +          Set the number of resources to be included.
          + intsize() + +
          +          Efficient size implementation.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
          createIterator, getCollection, getSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, dieOnCircularReference, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SizeLimitCollection

          +
          +public SizeLimitCollection()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCount

          +
          +public void setCount(int i)
          +
          +
          Set the number of resources to be included. +

          +

          +
          Parameters:
          i - the count as int.
          +
          +
          +
          + +

          +getCount

          +
          +public int getCount()
          +
          +
          Get the number of resources to be included. Default is 1. +

          +

          + +
          Returns:
          the count as int.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Efficient size implementation. +

          +

          +
          Specified by:
          size in interface ResourceCollection
          Overrides:
          size in class AbstractResourceCollectionWrapper
          +
          +
          + +
          Returns:
          int size
          +
          +
          +
          + +

          +getValidCount

          +
          +protected int getValidCount()
          +
          +
          Get the count, verifying it is >= 0. +

          +

          + +
          Returns:
          int count
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Sort.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Sort.html new file mode 100644 index 000000000..e1d909352 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Sort.html @@ -0,0 +1,387 @@ + + + + + + +Sort (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Sort

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+                  extended by org.apache.tools.ant.types.resources.Sort
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Sort
          extends BaseResourceCollectionWrapper
          + + +

          +ResourceCollection that sorts another ResourceCollection. + + Note that Sort must not be used in cases where the ordering of the objects + being sorted might change during the sorting process. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Sort() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceComparator c) + +
          +          Add a ResourceComparator to this Sort ResourceCollection.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the BaseResourceCollectionContainer version + to recurse on nested ResourceComparators.
          +protected  java.util.CollectiongetCollection() + +
          +          Sort the contained elements.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
          createIterator, getSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Sort

          +
          +public Sort()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Sort the contained elements. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionWrapper
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceComparator c)
          +
          +
          Add a ResourceComparator to this Sort ResourceCollection. + If multiple ResourceComparators are added, they will be processed in LIFO order. +

          +

          +
          Parameters:
          c - the ResourceComparator to add.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the BaseResourceCollectionContainer version + to recurse on nested ResourceComparators. +

          +

          +
          Overrides:
          dieOnCircularReference in class AbstractResourceCollectionWrapper
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/StringResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/StringResource.html new file mode 100644 index 000000000..6c4173f70 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/StringResource.html @@ -0,0 +1,717 @@ + + + + + + +StringResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class StringResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.StringResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class StringResource
          extends Resource
          + + +

          +Exposes a string as a Resource. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          StringResource() + +
          +          Default constructor.
          StringResource(Project project, + java.lang.String value) + +
          +          Construct a StringResource with the supplied project and value, + doing property replacement against the project if non-null.
          StringResource(java.lang.String value) + +
          +          Construct a StringResource with the supplied value.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String text) + +
          +          Add nested text to this resource.
          +protected  java.lang.StringgetContent() + +
          +          Get the content of this StringResource.
          + java.lang.StringgetEncoding() + +
          +          Get the encoding used by this StringResource.
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + java.lang.StringgetName() + +
          +          Synchronize access.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + longgetSize() + +
          +          Get the size of this Resource.
          + java.lang.StringgetValue() + +
          +          Get the value of this StringResource, resolving to the root reference if needed.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisExists() + +
          +          The exists attribute tells whether a resource exists.
          + voidsetEncoding(java.lang.String s) + +
          +          Set the encoding to be used for this StringResource.
          + voidsetName(java.lang.String s) + +
          +          Enforce String immutability.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          + voidsetValue(java.lang.String s) + +
          +          The value attribute is a semantically superior alias for the name attribute.
          + java.lang.StringtoString() + +
          +          Get the string.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, equals, getLastModified, getMagicNumber, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +StringResource

          +
          +public StringResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +StringResource

          +
          +public StringResource(java.lang.String value)
          +
          +
          Construct a StringResource with the supplied value. +

          +

          +
          Parameters:
          value - the value of this StringResource.
          +
          +
          + +

          +StringResource

          +
          +public StringResource(Project project,
+                      java.lang.String value)
          +
          +
          Construct a StringResource with the supplied project and value, + doing property replacement against the project if non-null. +

          +

          +
          Parameters:
          project - the owning Project.
          value - the value of this StringResource.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String s)
          +
          +
          Enforce String immutability. +

          +

          +
          Overrides:
          setName in class Resource
          +
          +
          +
          Parameters:
          s - the new name/value for this StringResource.
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(java.lang.String s)
          +
          +
          The value attribute is a semantically superior alias for the name attribute. +

          +

          +
          Parameters:
          s - the String's value.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Synchronize access. +

          +

          +
          Overrides:
          getName in class Resource
          +
          +
          + +
          Returns:
          the name/value of this StringResource.
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue()
          +
          +
          Get the value of this StringResource, resolving to the root reference if needed. +

          +

          + +
          Returns:
          the represented String.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          The exists attribute tells whether a resource exists. +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Add nested text to this resource. + Properties will be expanded during this process. +

          +

          +
          Parameters:
          text - text to use as the string resource
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String s)
          +
          +
          Set the encoding to be used for this StringResource. +

          +

          +
          Parameters:
          s - the encoding name.
          +
          +
          +
          + +

          +getEncoding

          +
          +public java.lang.String getEncoding()
          +
          +
          Get the encoding used by this StringResource. +

          +

          + +
          Returns:
          the encoding name.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the string. See getContent() +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          the string contents of the resource.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +getContent

          +
          +protected java.lang.String getContent()
          +
          +
          Get the content of this StringResource. See getValue() +

          +

          + +
          Returns:
          a String or null if there is no value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/TarResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/TarResource.html new file mode 100644 index 000000000..97cbd65a1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/TarResource.html @@ -0,0 +1,525 @@ + + + + + + +TarResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class TarResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ArchiveResource
+                  extended by org.apache.tools.ant.types.resources.TarResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class TarResource
          extends ArchiveResource
          + + +

          +A Resource representation of an entry in a tar archive. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          TarResource() + +
          +          Default constructor.
          TarResource(java.io.File a, + TarEntry e) + +
          +          Construct a TarResource representing the specified + entry in the specified archive.
          TarResource(Resource a, + TarEntry e) + +
          +          Construct a TarResource representing the specified + entry in the specified archive.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidfetchEntry() + +
          +          fetches information from the named entry inside the archive.
          + intgetGid() + +
          +           
          + java.lang.StringgetGroup() + +
          +           
          + java.io.InputStreamgetInputStream() + +
          +          Return an InputStream for reading the contents of this Resource.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + intgetUid() + +
          +           
          + java.lang.StringgetUserName() + +
          +           
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ArchiveResource
          addConfigured, checkEntry, compareTo, dieOnCircularReference, equals, getArchive, getLastModified, getMode, getSize, hashCode, isDirectory, isExists, setArchive, setMode, setRefid, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, getMagicNumber, getName, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TarResource

          +
          +public TarResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +TarResource

          +
          +public TarResource(java.io.File a,
+                   TarEntry e)
          +
          +
          Construct a TarResource representing the specified + entry in the specified archive. +

          +

          +
          Parameters:
          a - the archive as File.
          e - the TarEntry.
          +
          +
          + +

          +TarResource

          +
          +public TarResource(Resource a,
+                   TarEntry e)
          +
          +
          Construct a TarResource representing the specified + entry in the specified archive. +

          +

          +
          Parameters:
          a - the archive as Resource.
          e - the TarEntry.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Return an InputStream for reading the contents of this Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream object. +
          Throws: +
          java.io.IOException - if the tar file cannot be opened, + or the entry cannot be read.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getUserName

          +
          +public java.lang.String getUserName()
          +
          +
          + +
          Returns:
          the user name for the tar entry
          +
          +
          +
          + +

          +getGroup

          +
          +public java.lang.String getGroup()
          +
          +
          + +
          Returns:
          the group name for the tar entry
          +
          +
          +
          + +

          +getUid

          +
          +public int getUid()
          +
          +
          + +
          Returns:
          the uid for the tar entry
          +
          +
          +
          + +

          +getGid

          +
          +public int getGid()
          +
          +
          + +
          Returns:
          the gid for the tar entry
          +
          +
          +
          + +

          +fetchEntry

          +
          +protected void fetchEntry()
          +
          +
          fetches information from the named entry inside the archive. +

          +

          +
          Specified by:
          fetchEntry in class ArchiveResource
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Tokens.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Tokens.html new file mode 100644 index 000000000..4a11714d1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Tokens.html @@ -0,0 +1,406 @@ + + + + + + +Tokens (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Tokens

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
+              extended by org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
+                  extended by org.apache.tools.ant.types.resources.Tokens
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Tokens
          extends BaseResourceCollectionWrapper
          + + +

          +ResourceCollection consisting of StringResources gathered from tokenizing + another ResourceCollection with a Tokenizer implementation. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Tokens() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(Tokenizer tokenizer) + +
          +          Add the nested Tokenizer to this Tokens ResourceCollection.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the BaseResourceCollectionContainer version + to check the nested Tokenizer.
          +protected  java.util.CollectiongetCollection() + +
          +          Sort the contained elements.
          + voidsetEncoding(java.lang.String encoding) + +
          +          Set the encoding used to create the tokens.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionWrapper
          createIterator, getSize
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.AbstractResourceCollectionWrapper
          add, getResourceCollection, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Tokens

          +
          +public Tokens()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Sort the contained elements. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionWrapper
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          +
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String encoding)
          +
          +
          Set the encoding used to create the tokens. +

          +

          +
          Parameters:
          encoding - the encoding to use.
          +
          +
          +
          + +

          +add

          +
          +public void add(Tokenizer tokenizer)
          +
          +
          Add the nested Tokenizer to this Tokens ResourceCollection. + A LineTokenizer will be used by default. +

          +

          +
          Parameters:
          tokenizer - the tokenizer to add.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the BaseResourceCollectionContainer version + to check the nested Tokenizer. +

          +

          +
          Overrides:
          dieOnCircularReference in class AbstractResourceCollectionWrapper
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Touchable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Touchable.html new file mode 100644 index 000000000..75cb2585f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Touchable.html @@ -0,0 +1,216 @@ + + + + + + +Touchable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Interface Touchable

          +
          +
          All Known Implementing Classes:
          FileResource
          +
          +
          +
          +
          public interface Touchable
          + + +

          +Interface to be implemented by "touchable" resources; + that is, those whose modification time can be altered. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidtouch(long modTime) + +
          +          Method called to "touch" the resource.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +touch

          +
          +void touch(long modTime)
          +
          +
          Method called to "touch" the resource. +

          +

          +
          Parameters:
          modTime - the time to set the modified "field" of the resource, + measured in milliseconds since the epoch.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLProvider.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLProvider.html new file mode 100644 index 000000000..9dc052e89 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLProvider.html @@ -0,0 +1,217 @@ + + + + + + +URLProvider (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Interface URLProvider

          +
          +
          All Known Implementing Classes:
          JavaResource, URLResource
          +
          +
          +
          +
          public interface URLProvider
          + + +

          +This is an interface that resources that can provide an URL should implement. + This is a refactoring of URLResource, to allow other resources + to act as sources of URLs. +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + java.net.URLgetURL() + +
          +          Get the URL represented by this Resource.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getURL

          +
          +java.net.URL getURL()
          +
          +
          Get the URL represented by this Resource. +

          +

          + +
          Returns:
          the file.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLResource.html new file mode 100644 index 000000000..f31c0ea27 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/URLResource.html @@ -0,0 +1,826 @@ + + + + + + +URLResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class URLResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.URLResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection, URLProvider
          +
          +
          +
          +
          public class URLResource
          extends Resource
          implements URLProvider
          + + +

          +Exposes a URL as a Resource. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          URLResource() + +
          +          Default constructor.
          URLResource(java.io.File f) + +
          +          Convenience constructor.
          URLResource(java.lang.String u) + +
          +          String constructor for Ant attribute introspection.
          URLResource(java.net.URL u) + +
          +          Convenience constructor.
          URLResource(URLProvider u) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voidconnect() + +
          +          Ensure that we have a connection.
          + booleanequals(java.lang.Object another) + +
          +          Test whether an Object equals this URLResource.
          + java.io.InputStreamgetInputStream() + +
          +          Get an InputStream for the Resource.
          + longgetLastModified() + +
          +          Tells the modification time in milliseconds since 01.01.1970 .
          + java.lang.StringgetName() + +
          +          Get the name of this URLResource + (its file component minus the leading separator).
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + longgetSize() + +
          +          Get the size of this Resource.
          + java.net.URLgetURL() + +
          +          Get the URL used by this URLResource.
          + inthashCode() + +
          +          Get the hash code for this Resource.
          + booleanisDirectory() + +
          +          Tells if the resource is a directory.
          + booleanisExists() + +
          +          Find out whether the URL exists .
          + voidsetBaseURL(java.net.URL base) + +
          +          Base URL which combined with the relativePath attribute defines + the URL.
          + voidsetFile(java.io.File f) + +
          +          Set the URL from a File.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          + voidsetRelativePath(java.lang.String r) + +
          +          Relative path which combined with the baseURL attribute defines + the URL.
          + voidsetURL(java.net.URL u) + +
          +          Set the URL for this URLResource.
          + java.lang.StringtoString() + +
          +          Return this URLResource formatted as a String.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, compareTo, getMagicNumber, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +URLResource

          +
          +public URLResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +URLResource

          +
          +public URLResource(java.net.URL u)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          u - the URL to expose.
          +
          +
          + +

          +URLResource

          +
          +public URLResource(URLProvider u)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          u - holds the URL to expose.
          +
          +
          + +

          +URLResource

          +
          +public URLResource(java.io.File f)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          f - the File to set as a URL.
          +
          +
          + +

          +URLResource

          +
          +public URLResource(java.lang.String u)
          +
          +
          String constructor for Ant attribute introspection. +

          +

          +
          Parameters:
          u - String representation of this URL.
          See Also:
          IntrospectionHelper
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setURL

          +
          +public void setURL(java.net.URL u)
          +
          +
          Set the URL for this URLResource. +

          +

          +
          +
          +
          +
          Parameters:
          u - the URL to expose.
          +
          +
          +
          + +

          +setFile

          +
          +public void setFile(java.io.File f)
          +
          +
          Set the URL from a File. +

          +

          +
          +
          +
          +
          Parameters:
          f - the File to set as a URL.
          +
          +
          +
          + +

          +setBaseURL

          +
          +public void setBaseURL(java.net.URL base)
          +
          +
          Base URL which combined with the relativePath attribute defines + the URL. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setRelativePath

          +
          +public void setRelativePath(java.lang.String r)
          +
          +
          Relative path which combined with the baseURL attribute defines + the URL. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getURL

          +
          +public java.net.URL getURL()
          +
          +
          Get the URL used by this URLResource. +

          +

          +
          Specified by:
          getURL in interface URLProvider
          +
          +
          + +
          Returns:
          a URL object.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class Resource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of this URLResource + (its file component minus the leading separator). +

          +

          +
          Overrides:
          getName in class Resource
          +
          +
          + +
          Returns:
          the name of this resource.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Return this URLResource formatted as a String. +

          +

          +
          Overrides:
          toString in class Resource
          +
          +
          + +
          Returns:
          a String representation of this URLResource.
          +
          +
          +
          + +

          +isExists

          +
          +public boolean isExists()
          +
          +
          Find out whether the URL exists . +

          +

          +
          Overrides:
          isExists in class Resource
          +
          +
          + +
          Returns:
          true if this resource exists.
          +
          +
          +
          + +

          +getLastModified

          +
          +public long getLastModified()
          +
          +
          Tells the modification time in milliseconds since 01.01.1970 . +

          +

          +
          Overrides:
          getLastModified in class Resource
          +
          +
          + +
          Returns:
          0 if the resource does not exist to mirror the behavior + of File.
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Tells if the resource is a directory. +

          +

          +
          Overrides:
          isDirectory in class Resource
          +
          +
          + +
          Returns:
          boolean whether the resource is a directory.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size of this Resource. +

          +

          +
          Overrides:
          getSize in class Resource
          +
          +
          + +
          Returns:
          the size, as a long, 0 if the Resource does not exist (for + compatibility with java.io.File), or UNKNOWN_SIZE if not known.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object another)
          +
          +
          Test whether an Object equals this URLResource. +

          +

          +
          Overrides:
          equals in class Resource
          +
          +
          +
          Parameters:
          another - the other Object to compare. +
          Returns:
          true if the specified Object is equal to this Resource.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hash code for this Resource. +

          +

          +
          Overrides:
          hashCode in class Resource
          +
          +
          + +
          Returns:
          hash code as int.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Get an InputStream for the Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream containing this Resource's content. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if InputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type. +
          java.io.IOException - if the URL cannot be opened.
          +
          +
          +
          + +

          +connect

          +
          +protected void connect()
+                throws java.io.IOException
          +
          +
          Ensure that we have a connection. +

          +

          +
          +
          +
          + +
          Throws: +
          java.io.IOException - if the connection cannot be established.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Union.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Union.html new file mode 100644 index 000000000..9c6ff5733 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/Union.html @@ -0,0 +1,469 @@ + + + + + + +Union (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class Union

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
+              extended by org.apache.tools.ant.types.resources.Union
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceCollection
          +
          +
          +
          +
          public class Union
          extends BaseResourceCollectionContainer
          + + +

          +ResourceCollection representing the union of multiple nested ResourceCollections. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          Union() + +
          +          Default constructor.
          Union(Project project) + +
          +          Create a new Union.
          Union(Project project, + ResourceCollection rc) + +
          +          Convenience constructor.
          Union(ResourceCollection rc) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.CollectiongetCollection() + +
          +          Unify the contained Resources.
          +protected  java.util.CollectiongetCollection(boolean asString) + +
          +          Unify the contained Resources.
          +static UniongetInstance(ResourceCollection rc) + +
          +          Static convenience method to union an arbitrary set of Resources.
          + java.lang.String[]list() + +
          +          Returns all Resources in String format.
          + Resource[]listResources() + +
          +          Convenience method.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.BaseResourceCollectionContainer
          add, addAll, clear, clone, dieOnCircularReference, getResourceCollections, isCache, isFilesystemOnly, iterator, setCache, size, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Union

          +
          +public Union()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Union

          +
          +public Union(Project project)
          +
          +
          Create a new Union. +

          +

          +
          Parameters:
          project - owning Project
          +
          +
          + +

          +Union

          +
          +public Union(ResourceCollection rc)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          rc - the ResourceCollection to add.
          +
          +
          + +

          +Union

          +
          +public Union(Project project,
+             ResourceCollection rc)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          project - owning Project
          rc - the ResourceCollection to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getInstance

          +
          +public static Union getInstance(ResourceCollection rc)
          +
          +
          Static convenience method to union an arbitrary set of Resources. +

          +

          +
          Parameters:
          rc - a ResourceCollection. +
          Returns:
          a Union.
          +
          +
          +
          + +

          +list

          +
          +public java.lang.String[] list()
          +
          +
          Returns all Resources in String format. Provided for + convenience in implementing Path. +

          +

          + +
          Returns:
          String array of Resources.
          +
          +
          +
          + +

          +listResources

          +
          +public Resource[] listResources()
          +
          +
          Convenience method. +

          +

          + +
          Returns:
          Resource[]
          +
          +
          +
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection()
          +
          +
          Unify the contained Resources. +

          +

          +
          Specified by:
          getCollection in class BaseResourceCollectionContainer
          +
          +
          + +
          Returns:
          a Collection of Resources.
          +
          +
          +
          + +

          +getCollection

          +
          +protected java.util.Collection getCollection(boolean asString)
          +
          +
          Unify the contained Resources. +

          +

          +
          Parameters:
          asString - indicates whether the resulting Collection + should contain Strings instead of Resources. +
          Returns:
          a Collection of Resources.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ZipResource.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ZipResource.html new file mode 100644 index 000000000..28d3ce537 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/ZipResource.html @@ -0,0 +1,608 @@ + + + + + + +ZipResource (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources +
          +Class ZipResource

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.Resource
+              extended by org.apache.tools.ant.types.resources.ArchiveResource
+                  extended by org.apache.tools.ant.types.resources.ZipResource
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.lang.Comparable, ResourceCollection
          +
          +
          +
          +
          public class ZipResource
          extends ArchiveResource
          + + +

          +A Resource representation of an entry in a zipfile. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Resource
          MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          ZipResource() + +
          +          Default constructor.
          ZipResource(java.io.File z, + java.lang.String enc, + ZipEntry e) + +
          +          Construct a ZipResource representing the specified + entry in the specified zipfile.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(ResourceCollection a) + +
          +          Sets the archive that holds this as a single element Resource + collection.
          +protected  voidfetchEntry() + +
          +          fetches information from the named entry inside the archive.
          + java.lang.StringgetEncoding() + +
          +          Get the encoding to use with the zipfile.
          + ZipExtraField[]getExtraFields() + +
          +          Retrieves extra fields.
          + java.io.InputStreamgetInputStream() + +
          +          Return an InputStream for reading the contents of this Resource.
          + intgetMethod() + +
          +          The compression method that has been used.
          + java.io.OutputStreamgetOutputStream() + +
          +          Get an OutputStream for the Resource.
          + java.io.FilegetZipfile() + +
          +          Get the zipfile that holds this ZipResource.
          + voidsetEncoding(java.lang.String enc) + +
          +          Set the encoding to use with the zipfile.
          + voidsetRefid(Reference r) + +
          +          Overrides the super version.
          + voidsetZipfile(java.io.File z) + +
          +          Set the zipfile that holds this ZipResource.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.ArchiveResource
          checkEntry, compareTo, dieOnCircularReference, equals, getArchive, getLastModified, getMode, getSize, hashCode, isDirectory, isExists, setArchive, setMode, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Resource
          as, clone, getMagicNumber, getName, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipResource

          +
          +public ZipResource()
          +
          +
          Default constructor. +

          +

          +
          + +

          +ZipResource

          +
          +public ZipResource(java.io.File z,
+                   java.lang.String enc,
+                   ZipEntry e)
          +
          +
          Construct a ZipResource representing the specified + entry in the specified zipfile. +

          +

          +
          Parameters:
          z - the zipfile as File.
          enc - the encoding used for filenames.
          e - the ZipEntry.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setZipfile

          +
          +public void setZipfile(java.io.File z)
          +
          +
          Set the zipfile that holds this ZipResource. +

          +

          +
          Parameters:
          z - the zipfile as a File.
          +
          +
          +
          + +

          +getZipfile

          +
          +public java.io.File getZipfile()
          +
          +
          Get the zipfile that holds this ZipResource. +

          +

          + +
          Returns:
          the zipfile as a File.
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(ResourceCollection a)
          +
          +
          Sets the archive that holds this as a single element Resource + collection. +

          +

          +
          Overrides:
          addConfigured in class ArchiveResource
          +
          +
          +
          Parameters:
          a - the archive as a single element Resource collection.
          +
          +
          +
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String enc)
          +
          +
          Set the encoding to use with the zipfile. +

          +

          +
          Parameters:
          enc - the String encoding.
          +
          +
          +
          + +

          +getEncoding

          +
          +public java.lang.String getEncoding()
          +
          +
          Get the encoding to use with the zipfile. +

          +

          + +
          Returns:
          String encoding.
          +
          +
          +
          + +

          +setRefid

          +
          +public void setRefid(Reference r)
          +
          +
          Overrides the super version. +

          +

          +
          Overrides:
          setRefid in class ArchiveResource
          +
          +
          +
          Parameters:
          r - the Reference to set.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream()
+                                   throws java.io.IOException
          +
          +
          Return an InputStream for reading the contents of this Resource. +

          +

          +
          Overrides:
          getInputStream in class Resource
          +
          +
          + +
          Returns:
          an InputStream object. +
          Throws: +
          java.io.IOException - if the zip file cannot be opened, + or the entry cannot be read.
          +
          +
          +
          + +

          +getOutputStream

          +
          +public java.io.OutputStream getOutputStream()
+                                     throws java.io.IOException
          +
          +
          Get an OutputStream for the Resource. +

          +

          +
          Overrides:
          getOutputStream in class Resource
          +
          +
          + +
          Returns:
          an OutputStream to which content can be written. +
          Throws: +
          java.io.IOException - if unable to provide the content of this + Resource as a stream. +
          java.lang.UnsupportedOperationException - if OutputStreams are not + supported for this Resource type.
          +
          +
          +
          + +

          +getExtraFields

          +
          +public ZipExtraField[] getExtraFields()
          +
          +
          Retrieves extra fields. +

          +

          + +
          Returns:
          an array of the extra fields
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getMethod

          +
          +public int getMethod()
          +
          +
          The compression method that has been used. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +fetchEntry

          +
          +protected void fetchEntry()
          +
          +
          fetches information from the named entry inside the archive. +

          +

          +
          Specified by:
          fetchEntry in class ArchiveResource
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Content.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Content.html new file mode 100644 index 000000000..c572b0a15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Content.html @@ -0,0 +1,372 @@ + + + + + + +Content (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Content

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Content
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Content
          extends ResourceComparator
          + + +

          +Compares Resources by content. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Content() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisBinary() + +
          +          Learn whether this Content ResourceComparator is operating in binary mode.
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources by content.
          + voidsetBinary(boolean b) + +
          +          Set binary mode for this Content ResourceComparator.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Content

          +
          +public Content()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setBinary

          +
          +public void setBinary(boolean b)
          +
          +
          Set binary mode for this Content ResourceComparator. If this + attribute is set to false, Resource content will be compared + ignoring platform line-ending conventions. + Default is true. +

          +

          +
          Parameters:
          b - whether to compare content in binary mode.
          +
          +
          +
          + +

          +isBinary

          +
          +public boolean isBinary()
          +
          +
          Learn whether this Content ResourceComparator is operating in binary mode. +

          +

          + +
          Returns:
          boolean binary flag.
          +
          +
          +
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources by content. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second. +
          Throws: +
          BuildException - if I/O errors occur.
          See Also:
          ResourceUtils.compareContent(Resource, Resource, boolean).
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Date.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Date.html new file mode 100644 index 000000000..2591d8d07 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Date.html @@ -0,0 +1,324 @@ + + + + + + +Date (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Date

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Date
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Date
          extends ResourceComparator
          + + +

          +Compares Resources by last modification date. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Date() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Date

          +
          +public Date()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/DelegatedResourceComparator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/DelegatedResourceComparator.html new file mode 100644 index 000000000..76b972c4b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/DelegatedResourceComparator.html @@ -0,0 +1,429 @@ + + + + + + +DelegatedResourceComparator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class DelegatedResourceComparator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class DelegatedResourceComparator
          extends ResourceComparator
          + + +

          +Delegates to other ResourceComparators or, if none specified, + uses Resources' natural ordering. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DelegatedResourceComparator() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceComparator c) + +
          +          Add a delegate ResourceComparator.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version from DataType to recurse on nested ResourceSelector +s.
          + booleanequals(java.lang.Object o) + +
          +          Equality method based on the vector of resources, + or if a reference, the referredto object.
          + inthashCode() + +
          +          Hashcode based on the rules for equality.
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DelegatedResourceComparator

          +
          +public DelegatedResourceComparator()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceComparator c)
          +
          +
          Add a delegate ResourceComparator. +

          +

          +
          Parameters:
          c - the next delegate ResourceComparator.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          Equality method based on the vector of resources, + or if a reference, the referredto object. +

          +

          +
          Specified by:
          equals in interface java.util.Comparator
          Overrides:
          equals in class ResourceComparator
          +
          +
          +
          Parameters:
          o - the object to check against. +
          Returns:
          true if there is equality.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Hashcode based on the rules for equality. +

          +

          +
          Overrides:
          hashCode in class ResourceComparator
          +
          +
          + +
          Returns:
          a hashcode.
          +
          +
          +
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version from DataType to recurse on nested ResourceSelector +s. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the Stack of references.
          p - the Project to resolve against. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Exists.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Exists.html new file mode 100644 index 000000000..e7512d83f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Exists.html @@ -0,0 +1,324 @@ + + + + + + +Exists (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Exists

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Exists
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Exists
          extends ResourceComparator
          + + +

          +Compares Resources by existence. Not existing is "less than" existing. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Exists() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Exists

          +
          +public Exists()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/FileSystem.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/FileSystem.html new file mode 100644 index 000000000..396ca24c4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/FileSystem.html @@ -0,0 +1,326 @@ + + + + + + +FileSystem (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class FileSystem

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.FileSystem
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class FileSystem
          extends ResourceComparator
          + + +

          +Compares filesystem Resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FileSystem() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileSystem

          +
          +public FileSystem()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second. +
          Throws: +
          java.lang.ClassCastException - if either resource is not an instance of FileResource.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Name.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Name.html new file mode 100644 index 000000000..afb47bd76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Name.html @@ -0,0 +1,324 @@ + + + + + + +Name (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Name

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Name
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Name
          extends ResourceComparator
          + + +

          +Compares Resources by name. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Name() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Name

          +
          +public Name()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/ResourceComparator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/ResourceComparator.html new file mode 100644 index 000000000..c01f6fd48 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/ResourceComparator.html @@ -0,0 +1,397 @@ + + + + + + +ResourceComparator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class ResourceComparator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          Direct Known Subclasses:
          Content, Date, DelegatedResourceComparator, Exists, FileSystem, Name, Reverse, Size, Type
          +
          +
          +
          +
          public abstract class ResourceComparator
          extends DataType
          implements java.util.Comparator
          + + +

          +Abstract Resource Comparator. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ResourceComparator() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intcompare(java.lang.Object foo, + java.lang.Object bar) + +
          +          Compare two objects.
          + booleanequals(java.lang.Object o) + +
          +          Test for equality with this ResourceComparator.
          + inthashCode() + +
          +          Hashcode based on the rules for equality.
          +protected abstract  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceComparator

          +
          +public ResourceComparator()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +compare

          +
          +public final int compare(java.lang.Object foo,
+                         java.lang.Object bar)
          +
          +
          Compare two objects. +

          +

          +
          Specified by:
          compare in interface java.util.Comparator
          +
          +
          +
          Parameters:
          foo - the first Object.
          bar - the second Object. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second. +
          Throws: +
          java.lang.ClassCastException - if either argument is null.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          Test for equality with this ResourceComparator. +

          +

          +
          Specified by:
          equals in interface java.util.Comparator
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          o - the Object to compare against. +
          Returns:
          true if the specified Object equals this one.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Hashcode based on the rules for equality. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          a hashcode.
          +
          +
          +
          + +

          +resourceCompare

          +
          +protected abstract int resourceCompare(Resource foo,
+                                       Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Reverse.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Reverse.html new file mode 100644 index 000000000..453f27e79 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Reverse.html @@ -0,0 +1,411 @@ + + + + + + +Reverse (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Reverse

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Reverse
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Reverse
          extends ResourceComparator
          + + +

          +Reverses another ResourceComparator. If no nested ResourceComparator + is supplied, the compared Resources' natural order will be reversed. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Reverse() + +
          +          Default constructor.
          Reverse(ResourceComparator c) + +
          +          Construct a new Reverse, supplying the ResourceComparator to be reversed.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceComparator c) + +
          +          Add the ResourceComparator to reverse.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Reverse

          +
          +public Reverse()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Reverse

          +
          +public Reverse(ResourceComparator c)
          +
          +
          Construct a new Reverse, supplying the ResourceComparator to be reversed. +

          +

          +
          Parameters:
          c - the ResourceComparator to reverse.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceComparator c)
          +
          +
          Add the ResourceComparator to reverse. +

          +

          +
          Parameters:
          c - the ResourceComparator to add.
          +
          +
          +
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is greater than, equal to, or less than the second.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Size.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Size.html new file mode 100644 index 000000000..576182922 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Size.html @@ -0,0 +1,324 @@ + + + + + + +Size (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Size

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Size
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Size
          extends ResourceComparator
          + + +

          +Compares Resources by size. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Size() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Size

          +
          +public Size()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Type.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Type.html new file mode 100644 index 000000000..912862513 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/Type.html @@ -0,0 +1,325 @@ + + + + + + +Type (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.comparators +
          +Class Type

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.comparators.ResourceComparator
+              extended by org.apache.tools.ant.types.resources.comparators.Type
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.Comparator
          +
          +
          +
          +
          public class Type
          extends ResourceComparator
          + + +

          +Compares Resources by is-directory status. As a container + of files, a directory is deemed "greater" than a file. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Type() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  intresourceCompare(Resource foo, + Resource bar) + +
          +          Compare two Resources.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.comparators.ResourceComparator
          compare, equals, hashCode
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Type

          +
          +public Type()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +resourceCompare

          +
          +protected int resourceCompare(Resource foo,
+                              Resource bar)
          +
          +
          Compare two Resources. +

          +

          +
          Specified by:
          resourceCompare in class ResourceComparator
          +
          +
          +
          Parameters:
          foo - the first Resource.
          bar - the second Resource. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-frame.html new file mode 100644 index 000000000..c3adce90d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-frame.html @@ -0,0 +1,50 @@ + + + + + + +org.apache.tools.ant.types.resources.comparators (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.resources.comparators + + + + +
          +Classes  + +
          +Content +
          +Date +
          +DelegatedResourceComparator +
          +Exists +
          +FileSystem +
          +Name +
          +ResourceComparator +
          +Reverse +
          +Size +
          +Type
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-summary.html new file mode 100644 index 000000000..b96935848 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-summary.html @@ -0,0 +1,189 @@ + + + + + + +org.apache.tools.ant.types.resources.comparators (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.resources.comparators +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          ContentCompares Resources by content.
          DateCompares Resources by last modification date.
          DelegatedResourceComparatorDelegates to other ResourceComparators or, if none specified, + uses Resources' natural ordering.
          ExistsCompares Resources by existence.
          FileSystemCompares filesystem Resources.
          NameCompares Resources by name.
          ResourceComparatorAbstract Resource Comparator.
          ReverseReverses another ResourceComparator.
          SizeCompares Resources by size.
          TypeCompares Resources by is-directory status.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-tree.html new file mode 100644 index 000000000..afee4d8f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/comparators/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +org.apache.tools.ant.types.resources.comparators Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.resources.comparators +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.types.DataType (implements java.lang.Cloneable) +
                  +
                • org.apache.tools.ant.types.resources.comparators.ResourceComparator (implements java.util.Comparator<T>) +
                    +
                  • org.apache.tools.ant.types.resources.comparators.Content
                  • org.apache.tools.ant.types.resources.comparators.Date
                  • org.apache.tools.ant.types.resources.comparators.DelegatedResourceComparator
                  • org.apache.tools.ant.types.resources.comparators.Exists
                  • org.apache.tools.ant.types.resources.comparators.FileSystem
                  • org.apache.tools.ant.types.resources.comparators.Name
                  • org.apache.tools.ant.types.resources.comparators.Reverse
                  • org.apache.tools.ant.types.resources.comparators.Size
                  • org.apache.tools.ant.types.resources.comparators.Type
                  +
                +
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-frame.html new file mode 100644 index 000000000..747056db2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-frame.html @@ -0,0 +1,134 @@ + + + + + + +org.apache.tools.ant.types.resources (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.resources + + + + +
          +Interfaces  + +
          +Appendable +
          +FileProvider +
          +Touchable +
          +URLProvider
          + + + + + + +
          +Classes  + +
          +AbstractClasspathResource +
          +AbstractClasspathResource.ClassLoaderWithFlag +
          +AbstractResourceCollectionWrapper +
          +ArchiveResource +
          +Archives +
          +BaseResourceCollectionContainer +
          +BaseResourceCollectionWrapper +
          +BCFileSet +
          +BZip2Resource +
          +CompressedResource +
          +ContentTransformingResource +
          +Difference +
          +FileResource +
          +FileResourceIterator +
          +Files +
          +First +
          +GZipResource +
          +Intersect +
          +JavaConstantResource +
          +JavaResource +
          +Last +
          +LazyResourceCollectionWrapper +
          +LogOutputResource +
          +MappedResource +
          +MappedResourceCollection +
          +PropertyResource +
          +ResourceDecorator +
          +ResourceList +
          +Resources +
          +Restrict +
          +SizeLimitCollection +
          +Sort +
          +StringResource +
          +TarResource +
          +Tokens +
          +Union +
          +URLResource +
          +ZipResource
          + + + + + + +
          +Exceptions  + +
          +ImmutableResourceException
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-summary.html new file mode 100644 index 000000000..518575ae1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-summary.html @@ -0,0 +1,359 @@ + + + + + + +org.apache.tools.ant.types.resources (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.resources +

          + + + + + + + + + + + + + + + + + + + + + +
          +Interface Summary
          AppendableInterface to be implemented by "appendable" resources.
          FileProviderThis is an interface that resources that can provide a file should implement.
          TouchableInterface to be implemented by "touchable" resources; + that is, those whose modification time can be altered.
          URLProviderThis is an interface that resources that can provide an URL should implement.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractClasspathResourceA Resource representation of anything that is accessed via a Java classloader.
          AbstractClasspathResource.ClassLoaderWithFlag 
          AbstractResourceCollectionWrapperBase class for a ResourceCollection that wraps a single nested + ResourceCollection.
          ArchiveResourceA Resource representation of an entry inside an archive.
          ArchivesA resource collection that treats all nested resources as archives + and returns the contents of the archives as its content.
          BaseResourceCollectionContainerBase class for ResourceCollections that nest multiple ResourceCollections.
          BaseResourceCollectionWrapperBase class for a ResourceCollection that wraps a single nested + ResourceCollection.
          BCFileSetUtility FileSet that includes directories for backwards-compatibility + with certain tasks e.g.
          BZip2ResourceA Bzip2 compressed resource.
          CompressedResourceA compressed resource.
          ContentTransformingResourceA resource that transforms the content of another resource.
          DifferenceResourceCollection representing the difference between + two or more nested ResourceCollections.
          FileResourceA Resource representation of a File.
          FileResourceIteratorIterator of FileResources from filenames.
          FilesResourceCollection implementation; like AbstractFileSet with absolute paths.
          FirstResourceCollection that contains the first count elements of + another ResourceCollection, a la the UNIX head command.
          GZipResourceA GZip compressed resource.
          IntersectResourceCollection representing the intersection + of multiple nested ResourceCollections.
          JavaConstantResourceA resource that is a java constant.
          JavaResourceA Resource representation of something loadable via a Java classloader.
          LastResourceCollection that contains the last count elements of + another ResourceCollection, a la the UNIX tail command.
          LazyResourceCollectionWrapperResource collection which load underlying resource collection only on demand + with support for caching
          LogOutputResourceOutput-only Resource that always appends to Ant's log.
          MappedResourceA decorator around a different resource that uses a mapper to + dynamically remap the resource's name.
          MappedResourceCollectionWrapper around a resource collections that maps the names of the + other collection using a configured mapper.
          PropertyResourceExposes an Ant property as a Resource.
          ResourceDecoratorAbstract class that delegates all reading methods of Resource to + its wrapped resource and deals with reference handling.
          ResourceListReads a resource as text document and creates a resource for each + line.
          ResourcesGeneric ResourceCollection: Either stores nested ResourceCollections, + making no attempt to remove duplicates, or references another ResourceCollection.
          RestrictResourceCollection that allows a number of selectors to be + applied to a single ResourceCollection for the purposes of + restricting or narrowing results.
          SizeLimitCollectionResourceCollection that imposes a size limit on another ResourceCollection.
          SortResourceCollection that sorts another ResourceCollection.
          StringResourceExposes a string as a Resource.
          TarResourceA Resource representation of an entry in a tar archive.
          TokensResourceCollection consisting of StringResources gathered from tokenizing + another ResourceCollection with a Tokenizer implementation.
          UnionResourceCollection representing the union of multiple nested ResourceCollections.
          URLResourceExposes a URL as a Resource.
          ZipResourceA Resource representation of an entry in a zipfile.
          +  + +

          + + + + + + + + + +
          +Exception Summary
          ImmutableResourceExceptionException thrown when an attempt is made to get an OutputStream + from an immutable Resource.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-tree.html new file mode 100644 index 000000000..b7ee534aa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/package-tree.html @@ -0,0 +1,210 @@ + + + + + + +org.apache.tools.ant.types.resources Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.resources +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/And.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/And.html new file mode 100644 index 000000000..f2d8fc99b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/And.html @@ -0,0 +1,341 @@ + + + + + + +And (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class And

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+              extended by org.apache.tools.ant.types.resources.selectors.And
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceSelector
          +
          +
          +
          +
          public class And
          extends ResourceSelectorContainer
          implements ResourceSelector
          + + +

          +And ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          And() + +
          +          Default constructor.
          And(ResourceSelector[] r) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
          add, dieOnCircularReference, getSelectors, hasSelectors, selectorCount
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +And

          +
          +public And()
          +
          +
          Default constructor. +

          +

          +
          + +

          +And

          +
          +public And(ResourceSelector[] r)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          r - the ResourceSelector[] to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Compare.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Compare.html new file mode 100644 index 000000000..d17234a2b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Compare.html @@ -0,0 +1,442 @@ + + + + + + +Compare (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Compare

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.Compare
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceSelector
          +
          +
          +
          +
          public class Compare
          extends DataType
          implements ResourceSelector
          + + +

          +ResourceSelector that compares against "control" Resource(s) + using ResourceComparators. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Compare() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceComparator c) + +
          +          Add a ResourceComparator to this Compare selector.
          + ResourceCollectioncreateControl() + +
          +          Create the nested control element.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version from DataType + to recurse on nested ResourceComparators.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetAgainst(Quantifier against) + +
          +          Set the quantifier to be used.
          + voidsetWhen(Comparison when) + +
          +          Set the comparison to be used.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Compare

          +
          +public Compare()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceComparator c)
          +
          +
          Add a ResourceComparator to this Compare selector. + If multiple ResourceComparators are added, they will be processed in LIFO order. +

          +

          +
          +
          +
          +
          Parameters:
          c - the ResourceComparator to add.
          +
          +
          +
          + +

          +setAgainst

          +
          +public void setAgainst(Quantifier against)
          +
          +
          Set the quantifier to be used. Default "all". +

          +

          +
          +
          +
          +
          Parameters:
          against - the Quantifier EnumeratedAttribute to use.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(Comparison when)
          +
          +
          Set the comparison to be used. Default "equal". +

          +

          +
          +
          +
          +
          Parameters:
          when - the Comparison EnumeratedAttribute to use.
          +
          +
          +
          + +

          +createControl

          +
          +public ResourceCollection createControl()
          +
          +
          Create the nested control element. These are the + resources to compare against. +

          +

          +
          +
          +
          + +
          Returns:
          ResourceCollection.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version from DataType + to recurse on nested ResourceComparators. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of data types to use (recursively).
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Date.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Date.html new file mode 100644 index 000000000..921598cc7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Date.html @@ -0,0 +1,513 @@ + + + + + + +Date (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Date

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Date
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Date
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Date ResourceSelector. Based on the date FileSelector, with the most + notable difference being the lack of support for the includedirs attribute. + It is recommended that the effect of includeDirs = "false" be achieved for + resources by enclosing a "dir" Type ResourceSelector and a Date + ResourceSelector in an Or ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Date() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetDatetime() + +
          +          Get the date & time in String format.
          + longgetGranularity() + +
          +          Get the timestamp granularity used by this ResourceSelector.
          + longgetMillis() + +
          +          Get the date/time in ms.
          + java.lang.StringgetPattern() + +
          +          Get the pattern for use with the datetime attribute.
          + TimeComparisongetWhen() + +
          +          Get the comparison mode.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetDateTime(java.lang.String s) + +
          +          Set the date and time as a String.
          + voidsetGranularity(long g) + +
          +          Set the granularity to use for this ResourceSelector.
          + voidsetMillis(long m) + +
          +          Set the date/time in milliseconds since 1970.
          + voidsetPattern(java.lang.String p) + +
          +          Set the optional pattern to use with the datetime attribute.
          + voidsetWhen(TimeComparison c) + +
          +          Set the comparison mode.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Date

          +
          +public Date()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setMillis

          +
          +public void setMillis(long m)
          +
          +
          Set the date/time in milliseconds since 1970. +

          +

          +
          +
          +
          +
          Parameters:
          m - the number of millis.
          +
          +
          +
          + +

          +getMillis

          +
          +public long getMillis()
          +
          +
          Get the date/time in ms. +

          +

          +
          +
          +
          + +
          Returns:
          long number of millis since 1970.
          +
          +
          +
          + +

          +setDateTime

          +
          +public void setDateTime(java.lang.String s)
          +
          +
          Set the date and time as a String. +

          +

          +
          +
          +
          +
          Parameters:
          s - the date & time to use.
          +
          +
          +
          + +

          +getDatetime

          +
          +public java.lang.String getDatetime()
          +
          +
          Get the date & time in String format. +

          +

          +
          +
          +
          + +
          Returns:
          a String representing a date & time.
          +
          +
          +
          + +

          +setGranularity

          +
          +public void setGranularity(long g)
          +
          +
          Set the granularity to use for this ResourceSelector. +

          +

          +
          +
          +
          +
          Parameters:
          g - the timestamp granularity.
          +
          +
          +
          + +

          +getGranularity

          +
          +public long getGranularity()
          +
          +
          Get the timestamp granularity used by this ResourceSelector. +

          +

          +
          +
          +
          + +
          Returns:
          the long granularity.
          +
          +
          +
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String p)
          +
          +
          Set the optional pattern to use with the datetime attribute. +

          +

          +
          +
          +
          +
          Parameters:
          p - the SimpleDateFormat-compatible pattern string.
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern()
          +
          +
          Get the pattern for use with the datetime attribute. +

          +

          +
          +
          +
          + +
          Returns:
          a SimpleDateFormat-compatible pattern string.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(TimeComparison c)
          +
          +
          Set the comparison mode. +

          +

          +
          +
          +
          +
          Parameters:
          c - a TimeComparison object.
          +
          +
          +
          + +

          +getWhen

          +
          +public TimeComparison getWhen()
          +
          +
          Get the comparison mode. +

          +

          +
          +
          +
          + +
          Returns:
          a TimeComparison object.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Exists.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Exists.html new file mode 100644 index 000000000..97e706961 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Exists.html @@ -0,0 +1,264 @@ + + + + + + +Exists (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Exists

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Exists
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Exists
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Exists ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Exists() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Exists

          +
          +public Exists()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/InstanceOf.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/InstanceOf.html new file mode 100644 index 000000000..e178dc36b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/InstanceOf.html @@ -0,0 +1,437 @@ + + + + + + +InstanceOf (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class InstanceOf

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.InstanceOf
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class InstanceOf
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +InstanceOf ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          InstanceOf() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.ClassgetCheckClass() + +
          +          Get the comparison class.
          + java.lang.StringgetType() + +
          +          Get the comparison type.
          + java.lang.StringgetURI() + +
          +          Get the type's URI.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetClass(java.lang.Class c) + +
          +          Set the class to compare against.
          + voidsetProject(Project p) + +
          +          Set the Project instance for this InstanceOf selector.
          + voidsetType(java.lang.String s) + +
          +          Set the Ant type to compare against.
          + voidsetURI(java.lang.String u) + +
          +          Set the URI in which the Ant type, if specified, should be defined.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +InstanceOf

          +
          +public InstanceOf()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project p)
          +
          +
          Set the Project instance for this InstanceOf selector. +

          +

          +
          +
          +
          +
          Parameters:
          p - the Project instance used for type comparisons.
          +
          +
          +
          + +

          +setClass

          +
          +public void setClass(java.lang.Class c)
          +
          +
          Set the class to compare against. +

          +

          +
          +
          +
          +
          Parameters:
          c - the class.
          +
          +
          +
          + +

          +setType

          +
          +public void setType(java.lang.String s)
          +
          +
          Set the Ant type to compare against. +

          +

          +
          +
          +
          +
          Parameters:
          s - the type name.
          +
          +
          +
          + +

          +setURI

          +
          +public void setURI(java.lang.String u)
          +
          +
          Set the URI in which the Ant type, if specified, should be defined. +

          +

          +
          +
          +
          +
          Parameters:
          u - the URI.
          +
          +
          +
          + +

          +getCheckClass

          +
          +public java.lang.Class getCheckClass()
          +
          +
          Get the comparison class. +

          +

          +
          +
          +
          + +
          Returns:
          the Class object.
          +
          +
          +
          + +

          +getType

          +
          +public java.lang.String getType()
          +
          +
          Get the comparison type. +

          +

          +
          +
          +
          + +
          Returns:
          the String typename.
          +
          +
          +
          + +

          +getURI

          +
          +public java.lang.String getURI()
          +
          +
          Get the type's URI. +

          +

          +
          +
          +
          + +
          Returns:
          the String URI.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected. +
          Throws: +
          BuildException - if an error occurs.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Majority.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Majority.html new file mode 100644 index 000000000..477805c57 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Majority.html @@ -0,0 +1,365 @@ + + + + + + +Majority (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Majority

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+              extended by org.apache.tools.ant.types.resources.selectors.Majority
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceSelector
          +
          +
          +
          +
          public class Majority
          extends ResourceSelectorContainer
          implements ResourceSelector
          + + +

          +Majority ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Majority() + +
          +          Default constructor.
          Majority(ResourceSelector[] r) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetAllowtie(boolean b) + +
          +          Set whether ties are allowed.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
          add, dieOnCircularReference, getSelectors, hasSelectors, selectorCount
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Majority

          +
          +public Majority()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Majority

          +
          +public Majority(ResourceSelector[] r)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          r - the ResourceSelector[] to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setAllowtie

          +
          +public void setAllowtie(boolean b)
          +
          +
          Set whether ties are allowed. +

          +

          +
          +
          +
          +
          Parameters:
          b - whether a tie is a pass.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Name.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Name.html new file mode 100644 index 000000000..4def43461 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Name.html @@ -0,0 +1,493 @@ + + + + + + +Name (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Name

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Name
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Name
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Name ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Name() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleandoesHandledirSep() + +
          +          Whether the difference between / and \ (the two common + directory characters) is ignored.
          + java.lang.StringgetName() + +
          +          Get the pattern used by this Name ResourceSelector.
          + java.lang.StringgetRegex() + +
          +          Get the regular expression used by this Name ResourceSelector.
          + booleanisCaseSensitive() + +
          +          Learn whether this Name ResourceSelector is case-sensitive.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetCaseSensitive(boolean b) + +
          +          Set whether the name comparisons are case-sensitive.
          + voidsetHandleDirSep(boolean handleDirSep) + +
          +          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters).
          + voidsetName(java.lang.String n) + +
          +          Set the pattern to compare names against.
          + voidsetProject(Project p) + +
          +           
          + voidsetRegex(java.lang.String r) + +
          +          Set the regular expression to compare names against.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Name

          +
          +public Name()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProject

          +
          +public void setProject(Project p)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String n)
          +
          +
          Set the pattern to compare names against. +

          +

          +
          +
          +
          +
          Parameters:
          n - the pattern String to set.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the pattern used by this Name ResourceSelector. +

          +

          +
          +
          +
          + +
          Returns:
          the String selection pattern.
          +
          +
          +
          + +

          +setRegex

          +
          +public void setRegex(java.lang.String r)
          +
          +
          Set the regular expression to compare names against. +

          +

          +
          +
          +
          +
          Parameters:
          r - the regex to set.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getRegex

          +
          +public java.lang.String getRegex()
          +
          +
          Get the regular expression used by this Name ResourceSelector. +

          +

          +
          +
          +
          + +
          Returns:
          the String selection pattern.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean b)
          +
          +
          Set whether the name comparisons are case-sensitive. +

          +

          +
          +
          +
          +
          Parameters:
          b - boolean case-sensitivity flag.
          +
          +
          +
          + +

          +isCaseSensitive

          +
          +public boolean isCaseSensitive()
          +
          +
          Learn whether this Name ResourceSelector is case-sensitive. +

          +

          +
          +
          +
          + +
          Returns:
          boolean case-sensitivity flag.
          +
          +
          +
          + +

          +setHandleDirSep

          +
          +public void setHandleDirSep(boolean handleDirSep)
          +
          +
          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +

          +

          +
          +
          +
          +
          Parameters:
          handleDirSep - a boolean, default is false.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +doesHandledirSep

          +
          +public boolean doesHandledirSep()
          +
          +
          Whether the difference between / and \ (the two common + directory characters) is ignored. +

          +

          +
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/None.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/None.html new file mode 100644 index 000000000..43c108d51 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/None.html @@ -0,0 +1,341 @@ + + + + + + +None (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class None

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+              extended by org.apache.tools.ant.types.resources.selectors.None
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceSelector
          +
          +
          +
          +
          public class None
          extends ResourceSelectorContainer
          implements ResourceSelector
          + + +

          +None ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          None() + +
          +          Default constructor.
          None(ResourceSelector[] r) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
          add, dieOnCircularReference, getSelectors, hasSelectors, selectorCount
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +None

          +
          +public None()
          +
          +
          Default constructor. +

          +

          +
          + +

          +None

          +
          +public None(ResourceSelector[] r)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          r - the ResourceSelector[] to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Not.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Not.html new file mode 100644 index 000000000..571cc378d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Not.html @@ -0,0 +1,310 @@ + + + + + + +Not (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Not

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Not
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Not
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Not ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          Not() + +
          +          Default constructor.
          Not(ResourceSelector s) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceSelector s) + +
          +          Set the ResourceSelector.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Not

          +
          +public Not()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Not

          +
          +public Not(ResourceSelector s)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          s - the ResourceSelector to negate.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceSelector s)
          +
          +
          Set the ResourceSelector. +

          +

          +
          +
          +
          +
          Parameters:
          s - the ResourceSelector to negate. +
          Throws: +
          java.lang.IllegalStateException - if already set.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Or.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Or.html new file mode 100644 index 000000000..a695abb47 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Or.html @@ -0,0 +1,341 @@ + + + + + + +Or (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Or

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+              extended by org.apache.tools.ant.types.resources.selectors.Or
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, ResourceSelector
          +
          +
          +
          +
          public class Or
          extends ResourceSelectorContainer
          implements ResourceSelector
          + + +

          +Or ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Or() + +
          +          Default constructor.
          Or(ResourceSelector[] r) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
          add, dieOnCircularReference, getSelectors, hasSelectors, selectorCount
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Or

          +
          +public Or()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Or

          +
          +public Or(ResourceSelector[] r)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          r - the ResourceSelector[] to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelector.html new file mode 100644 index 000000000..067970c80 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelector.html @@ -0,0 +1,215 @@ + + + + + + +ResourceSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Interface ResourceSelector

          +
          +
          All Known Implementing Classes:
          And, Compare, ContainsRegexpSelector, ContainsSelector, Date, Exists, InstanceOf, Majority, ModifiedSelector, Name, None, Not, Or, ReadableSelector, Size, Type, WritableSelector
          +
          +
          +
          +
          public interface ResourceSelector
          + + +

          +Interface for a Resource selector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.html new file mode 100644 index 000000000..a3918041f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/ResourceSelectorContainer.html @@ -0,0 +1,425 @@ + + + + + + +ResourceSelectorContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class ResourceSelectorContainer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          And, Majority, None, Or, Restrict
          +
          +
          +
          +
          public class ResourceSelectorContainer
          extends DataType
          + + +

          +ResourceSelector container. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          ResourceSelectorContainer() + +
          +          Default constructor.
          ResourceSelectorContainer(ResourceSelector[] r) + +
          +          Construct a new ResourceSelectorContainer with the specified array of selectors.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceSelector s) + +
          +          Add a ResourceSelector to the container.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Overrides the version from DataType to recurse on nested ResourceSelectors.
          + java.util.IteratorgetSelectors() + +
          +          Return an Iterator over the nested selectors.
          + booleanhasSelectors() + +
          +          Learn whether this ResourceSelectorContainer has selectors.
          + intselectorCount() + +
          +          Get the count of nested selectors.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceSelectorContainer

          +
          +public ResourceSelectorContainer()
          +
          +
          Default constructor. +

          +

          +
          + +

          +ResourceSelectorContainer

          +
          +public ResourceSelectorContainer(ResourceSelector[] r)
          +
          +
          Construct a new ResourceSelectorContainer with the specified array of selectors. +

          +

          +
          Parameters:
          r - the ResourceSelector[] to add.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public void add(ResourceSelector s)
          +
          +
          Add a ResourceSelector to the container. +

          +

          +
          Parameters:
          s - the ResourceSelector to add.
          +
          +
          +
          + +

          +hasSelectors

          +
          +public boolean hasSelectors()
          +
          +
          Learn whether this ResourceSelectorContainer has selectors. +

          +

          + +
          Returns:
          boolean indicating whether selectors have been added to the container.
          +
          +
          +
          + +

          +selectorCount

          +
          +public int selectorCount()
          +
          +
          Get the count of nested selectors. +

          +

          + +
          Returns:
          the selector count as int.
          +
          +
          +
          + +

          +getSelectors

          +
          +public java.util.Iterator getSelectors()
          +
          +
          Return an Iterator over the nested selectors. +

          +

          + +
          Returns:
          Iterator of ResourceSelectors.
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Overrides the version from DataType to recurse on nested ResourceSelectors. +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the Stack of references.
          p - the Project to resolve against. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Size.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Size.html new file mode 100644 index 000000000..eb2018043 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Size.html @@ -0,0 +1,362 @@ + + + + + + +Size (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Size

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Size
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Size
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Size ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          Size() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + longgetSize() + +
          +          Get the size compared to by this Size ResourceSelector.
          + ComparisongetWhen() + +
          +          Get the comparison mode.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetSize(long l) + +
          +          Set the size to compare against.
          + voidsetWhen(Comparison c) + +
          +          Set the comparison mode.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Size

          +
          +public Size()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setSize

          +
          +public void setSize(long l)
          +
          +
          Set the size to compare against. +

          +

          +
          +
          +
          +
          Parameters:
          l - the long resource size.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get the size compared to by this Size ResourceSelector. +

          +

          +
          +
          +
          + +
          Returns:
          the long resource size.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(Comparison c)
          +
          +
          Set the comparison mode. +

          +

          +
          +
          +
          +
          Parameters:
          c - a Comparison object.
          +
          +
          +
          + +

          +getWhen

          +
          +public Comparison getWhen()
          +
          +
          Get the comparison mode. +

          +

          +
          +
          +
          + +
          Returns:
          a Comparison object.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.FileDir.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.FileDir.html new file mode 100644 index 000000000..01feec9c1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.FileDir.html @@ -0,0 +1,308 @@ + + + + + + +Type.FileDir (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Type.FileDir

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.resources.selectors.Type.FileDir
+
          +
          +
          Enclosing class:
          Type
          +
          +
          +
          +
          public static class Type.FileDir
          extends EnumeratedAttribute
          + + +

          +Implements the type attribute. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Type.FileDir() + +
          +          Default constructor.
          Type.FileDir(java.lang.String value) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          Return the possible values.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Type.FileDir

          +
          +public Type.FileDir()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Type.FileDir

          +
          +public Type.FileDir(java.lang.String value)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          value - the String EnumeratedAttribute value.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Return the possible values. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          a String array.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.html new file mode 100644 index 000000000..b27950ded --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/Type.html @@ -0,0 +1,403 @@ + + + + + + +Type (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.resources.selectors +
          +Class Type

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.resources.selectors.Type
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector
          +
          +
          +
          +
          public class Type
          extends java.lang.Object
          implements ResourceSelector
          + + +

          +Type file/dir ResourceSelector. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classType.FileDir + +
          +          Implements the type attribute.
          +  + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static TypeANY + +
          +          Static any type selector.
          +static TypeDIR + +
          +          Static dir type selector.
          +static TypeFILE + +
          +          Static file type selector.
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          Type() + +
          +          Default constructor.
          Type(Type.FileDir fd) + +
          +          Convenience constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          + voidsetType(Type.FileDir fd) + +
          +          Set type; file|dir.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +FILE

          +
          +public static final Type FILE
          +
          +
          Static file type selector. +

          +

          +
          +
          +
          + +

          +DIR

          +
          +public static final Type DIR
          +
          +
          Static dir type selector. +

          +

          +
          +
          +
          + +

          +ANY

          +
          +public static final Type ANY
          +
          +
          Static any type selector. Since Ant 1.8. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Type

          +
          +public Type()
          +
          +
          Default constructor. +

          +

          +
          + +

          +Type

          +
          +public Type(Type.FileDir fd)
          +
          +
          Convenience constructor. +

          +

          +
          Parameters:
          fd - the FileDir type.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setType

          +
          +public void setType(Type.FileDir fd)
          +
          +
          Set type; file|dir. +

          +

          +
          +
          +
          +
          Parameters:
          fd - a FileDir object.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-frame.html new file mode 100644 index 000000000..6ab4baaa7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-frame.html @@ -0,0 +1,69 @@ + + + + + + +org.apache.tools.ant.types.resources.selectors (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.resources.selectors + + + + +
          +Interfaces  + +
          +ResourceSelector
          + + + + + + +
          +Classes  + +
          +And +
          +Compare +
          +Date +
          +Exists +
          +InstanceOf +
          +Majority +
          +Name +
          +None +
          +Not +
          +Or +
          +ResourceSelectorContainer +
          +Size +
          +Type +
          +Type.FileDir
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-summary.html new file mode 100644 index 000000000..e39d0fa6e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-summary.html @@ -0,0 +1,219 @@ + + + + + + +org.apache.tools.ant.types.resources.selectors (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.resources.selectors +

          + + + + + + + + + +
          +Interface Summary
          ResourceSelectorInterface for a Resource selector.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AndAnd ResourceSelector.
          CompareResourceSelector that compares against "control" Resource(s) + using ResourceComparators.
          DateDate ResourceSelector.
          ExistsExists ResourceSelector.
          InstanceOfInstanceOf ResourceSelector.
          MajorityMajority ResourceSelector.
          NameName ResourceSelector.
          NoneNone ResourceSelector.
          NotNot ResourceSelector.
          OrOr ResourceSelector.
          ResourceSelectorContainerResourceSelector container.
          SizeSize ResourceSelector.
          TypeType file/dir ResourceSelector.
          Type.FileDirImplements the type attribute.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-tree.html new file mode 100644 index 000000000..b53ca2211 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/resources/selectors/package-tree.html @@ -0,0 +1,174 @@ + + + + + + +org.apache.tools.ant.types.resources.selectors Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.resources.selectors +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.types.resources.selectors.Date (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.types.EnumeratedAttribute
                +
              • org.apache.tools.ant.types.resources.selectors.Type.FileDir
              +
            • org.apache.tools.ant.types.resources.selectors.Exists (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.types.resources.selectors.InstanceOf (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.types.resources.selectors.Name (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.types.resources.selectors.Not (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.types.DataType (implements java.lang.Cloneable) +
                  +
                • org.apache.tools.ant.types.resources.selectors.Compare (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
                • org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
                    +
                  • org.apache.tools.ant.types.resources.selectors.And (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
                  • org.apache.tools.ant.types.resources.selectors.Majority (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
                  • org.apache.tools.ant.types.resources.selectors.None (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
                  • org.apache.tools.ant.types.resources.selectors.Or (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
                  +
                +
              +
            • org.apache.tools.ant.types.resources.selectors.Size (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            • org.apache.tools.ant.types.resources.selectors.Type (implements org.apache.tools.ant.types.resources.selectors.ResourceSelector) +
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.html new file mode 100644 index 000000000..e8062cd7d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AbstractSelectorContainer.html @@ -0,0 +1,1049 @@ + + + + + + +AbstractSelectorContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class AbstractSelectorContainer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.AbstractSelectorContainer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          Files, IsFileSelected
          +
          +
          +
          +
          public abstract class AbstractSelectorContainer
          extends DataType
          implements java.lang.Cloneable, SelectorContainer
          + + +

          +This is the a base class a container of selectors - it does + not need do be a selector itself. +

          + +

          +

          +
          Since:
          +
          1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AbstractSelectorContainer() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileSelector selector) + +
          +          add an arbitary selector
          + voidaddAnd(AndSelector selector) + +
          +          add an "And" selector entry on the selector list
          + voidaddContains(ContainsSelector selector) + +
          +          add a contains selector entry on the selector list
          + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
          +          add a regular expression selector entry on the selector list
          + voidaddCustom(ExtendSelector selector) + +
          +          add an extended selector entry on the selector list
          + voidaddDate(DateSelector selector) + +
          +          add a selector date entry on the selector list
          + voidaddDepend(DependSelector selector) + +
          +          add a depends selector entry on the selector list
          + voidaddDepth(DepthSelector selector) + +
          +          add a depth selector entry on the selector list
          + voidaddDifferent(DifferentSelector selector) + +
          +          adds a different selector to the selector list
          + voidaddFilename(FilenameSelector selector) + +
          +          add a selector filename entry on the selector list
          + voidaddMajority(MajoritySelector selector) + +
          +          add a majority selector entry on the selector list
          + voidaddModified(ModifiedSelector selector) + +
          +          add the modified selector
          + voidaddNone(NoneSelector selector) + +
          +          add a "None" selector entry on the selector list
          + voidaddNot(NotSelector selector) + +
          +          add a "Not" selector entry on the selector list
          + voidaddOr(OrSelector selector) + +
          +          add an "Or" selector entry on the selector list
          + voidaddPresent(PresentSelector selector) + +
          +          add a present selector entry on the selector list
          + voidaddReadable(ReadableSelector r) + +
          +           
          + voidaddSelector(SelectSelector selector) + +
          +          add a "Select" selector entry on the selector list
          + voidaddSize(SizeSelector selector) + +
          +          add a selector size entry on the selector list
          + voidaddType(TypeSelector selector) + +
          +          adds a type selector to the selector list
          + voidaddWritable(WritableSelector w) + +
          +           
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          + java.lang.Objectclone() + +
          +           
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + FileSelector[]getSelectors(Project p) + +
          +          Returns the set of selectors as an array.
          + booleanhasSelectors() + +
          +          Indicates whether there are any selectors here.
          + intselectorCount() + +
          +          Gives the count of the number of selectors in this container
          + java.util.EnumerationselectorElements() + +
          +          Returns an enumerator for accessing the set of selectors.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          + voidvalidate() + +
          +           + This validates each contained selector + provided that the selector implements the validate interface.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractSelectorContainer

          +
          +public AbstractSelectorContainer()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +hasSelectors

          +
          +public boolean hasSelectors()
          +
          +
          Indicates whether there are any selectors here. +

          +

          +
          Specified by:
          hasSelectors in interface SelectorContainer
          +
          +
          + +
          Returns:
          true if there are selectors
          +
          +
          +
          + +

          +selectorCount

          +
          +public int selectorCount()
          +
          +
          Gives the count of the number of selectors in this container +

          +

          +
          Specified by:
          selectorCount in interface SelectorContainer
          +
          +
          + +
          Returns:
          the number of selectors
          +
          +
          +
          + +

          +getSelectors

          +
          +public FileSelector[] getSelectors(Project p)
          +
          +
          Returns the set of selectors as an array. +

          +

          +
          Specified by:
          getSelectors in interface SelectorContainer
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          an array of selectors
          +
          +
          +
          + +

          +selectorElements

          +
          +public java.util.Enumeration selectorElements()
          +
          +
          Returns an enumerator for accessing the set of selectors. +

          +

          +
          Specified by:
          selectorElements in interface SelectorContainer
          +
          +
          + +
          Returns:
          an enumerator for the selectors
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          comma separated list of Selectors contained in this one
          +
          +
          +
          + +

          +appendSelector

          +
          +public void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Specified by:
          appendSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the new selector to add
          +
          +
          +
          + +

          +validate

          +
          +public void validate()
          +
          +

          + This validates each contained selector + provided that the selector implements the validate interface. +

          +

          Ordinarily, this will validate all the elements of a selector + container even if the isSelected() method of some elements is + never called. This has two effects:

          +
            +
          • Validation will often occur twice. +
          • Since it is not required that selectors derive from + BaseSelector, there could be selectors in the container whose + error conditions are not detected if their isSelected() call + is never made. +
          +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +addSelector

          +
          +public void addSelector(SelectSelector selector)
          +
          +
          add a "Select" selector entry on the selector list +

          +

          +
          Specified by:
          addSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addAnd

          +
          +public void addAnd(AndSelector selector)
          +
          +
          add an "And" selector entry on the selector list +

          +

          +
          Specified by:
          addAnd in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addOr

          +
          +public void addOr(OrSelector selector)
          +
          +
          add an "Or" selector entry on the selector list +

          +

          +
          Specified by:
          addOr in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNot

          +
          +public void addNot(NotSelector selector)
          +
          +
          add a "Not" selector entry on the selector list +

          +

          +
          Specified by:
          addNot in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNone

          +
          +public void addNone(NoneSelector selector)
          +
          +
          add a "None" selector entry on the selector list +

          +

          +
          Specified by:
          addNone in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addMajority

          +
          +public void addMajority(MajoritySelector selector)
          +
          +
          add a majority selector entry on the selector list +

          +

          +
          Specified by:
          addMajority in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDate

          +
          +public void addDate(DateSelector selector)
          +
          +
          add a selector date entry on the selector list +

          +

          +
          Specified by:
          addDate in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addSize

          +
          +public void addSize(SizeSelector selector)
          +
          +
          add a selector size entry on the selector list +

          +

          +
          Specified by:
          addSize in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addFilename

          +
          +public void addFilename(FilenameSelector selector)
          +
          +
          add a selector filename entry on the selector list +

          +

          +
          Specified by:
          addFilename in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addCustom

          +
          +public void addCustom(ExtendSelector selector)
          +
          +
          add an extended selector entry on the selector list +

          +

          +
          Specified by:
          addCustom in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContains

          +
          +public void addContains(ContainsSelector selector)
          +
          +
          add a contains selector entry on the selector list +

          +

          +
          Specified by:
          addContains in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addPresent

          +
          +public void addPresent(PresentSelector selector)
          +
          +
          add a present selector entry on the selector list +

          +

          +
          Specified by:
          addPresent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepth

          +
          +public void addDepth(DepthSelector selector)
          +
          +
          add a depth selector entry on the selector list +

          +

          +
          Specified by:
          addDepth in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepend

          +
          +public void addDepend(DependSelector selector)
          +
          +
          add a depends selector entry on the selector list +

          +

          +
          Specified by:
          addDepend in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDifferent

          +
          +public void addDifferent(DifferentSelector selector)
          +
          +
          adds a different selector to the selector list +

          +

          +
          Specified by:
          addDifferent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addType

          +
          +public void addType(TypeSelector selector)
          +
          +
          adds a type selector to the selector list +

          +

          +
          Specified by:
          addType in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContainsRegexp

          +
          +public void addContainsRegexp(ContainsRegexpSelector selector)
          +
          +
          add a regular expression selector entry on the selector list +

          +

          +
          Specified by:
          addContainsRegexp in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addModified

          +
          +public void addModified(ModifiedSelector selector)
          +
          +
          add the modified selector +

          +

          +
          Specified by:
          addModified in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +addReadable

          +
          +public void addReadable(ReadableSelector r)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +addWritable

          +
          +public void addWritable(WritableSelector w)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(FileSelector selector)
          +
          +
          add an arbitary selector +

          +

          +
          Specified by:
          add in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references.
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class DataType
          +
          +
          + +
          Returns:
          a shallow copy of this DataType.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AndSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AndSelector.html new file mode 100644 index 000000000..5631d9756 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/AndSelector.html @@ -0,0 +1,369 @@ + + + + + + +AndSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class AndSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.AndSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          +
          public class AndSelector
          extends BaseSelectorContainer
          + + +

          +This selector has a collection of other selectors, all of which have to + select a file in order for this selector to select it. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          AndSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Returns true (the file is selected) only if all other selectors + agree that the file should be selected.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AndSelector

          +
          +public AndSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          a string representation of the selector
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Returns true (the file is selected) only if all other selectors + agree that the file should be selected. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - the name of the file to check
          file - a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseExtendSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseExtendSelector.html new file mode 100644 index 000000000..a5a897d1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseExtendSelector.html @@ -0,0 +1,422 @@ + + + + + + +BaseExtendSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class BaseExtendSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          Direct Known Subclasses:
          ContainsRegexpSelector, ContainsSelector, DateSelector, DepthSelector, FilenameSelector, ModifiedSelector, SizeSelector, TypeSelector
          +
          +
          +
          +
          public abstract class BaseExtendSelector
          extends BaseSelector
          implements ExtendFileSelector
          + + +

          +Convenience base class for all selectors accessed through ExtendSelector. + It provides support for gathering the parameters together as well as for + assigning an error message and throwing a build exception if an error is + detected. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  Parameter[]parameters + +
          +          The passed in parameter array.
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          BaseExtendSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  Parameter[]getParameters() + +
          +          Allows access to the parameters gathered and set within the + <custom> tag.
          +abstract  booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their + selection behaviour.
          + voidsetParameters(Parameter[] parameters) + +
          +          Set all the Parameters for this custom selector, collected by + the ExtendSelector class.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +parameters

          +
          +protected Parameter[] parameters
          +
          +
          The passed in parameter array. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseExtendSelector

          +
          +public BaseExtendSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          Set all the Parameters for this custom selector, collected by + the ExtendSelector class. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +getParameters

          +
          +protected Parameter[] getParameters()
          +
          +
          Allows access to the parameters gathered and set within the + <custom> tag. +

          +

          +
          +
          +
          + +
          Returns:
          the set of parameters defined for this selector
          +
          +
          +
          + +

          +isSelected

          +
          +public abstract boolean isSelected(java.io.File basedir,
+                                   java.lang.String filename,
+                                   java.io.File file)
+                            throws BuildException
          +
          +
          Method that each selector will implement to create their + selection behaviour. If there is a problem with the setup + of a selector, it can throw a BuildException to indicate + the problem. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not +
          Throws: +
          BuildException - if an error occurs
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelector.html new file mode 100644 index 000000000..7c8b3cdfe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelector.html @@ -0,0 +1,432 @@ + + + + + + +BaseSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class BaseSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          Direct Known Subclasses:
          BaseExtendSelector, BaseSelectorContainer, ExtendSelector, MappingSelector, PresentSelector, ScriptSelector
          +
          +
          +
          +
          public abstract class BaseSelector
          extends DataType
          implements FileSelector
          + + +

          +A convenience base class that you can subclass Selectors from. It + provides some helpful common behaviour. Note that there is no need + for Selectors to inherit from this class, it is only necessary that + they implement FileSelector. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          BaseSelector() + +
          +          Do nothing constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetError() + +
          +          Returns any error messages that have been set.
          +abstract  booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their + selection behaviour.
          + voidsetError(java.lang.String msg) + +
          +          Allows all selectors to indicate a setup error.
          + voidvalidate() + +
          +          Subclasses can use this to throw the requisite exception + in isSelected() in the case of an error condition.
          + voidverifySettings() + +
          +          Subclasses can override this method to provide checking of their + state.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseSelector

          +
          +public BaseSelector()
          +
          +
          Do nothing constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setError

          +
          +public void setError(java.lang.String msg)
          +
          +
          Allows all selectors to indicate a setup error. Note that only + the first error message is recorded. +

          +

          +
          +
          +
          +
          Parameters:
          msg - The error message any BuildException should throw.
          +
          +
          +
          + +

          +getError

          +
          +public java.lang.String getError()
          +
          +
          Returns any error messages that have been set. +

          +

          +
          +
          +
          + +
          Returns:
          the error condition
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +

          Subclasses can override this method to provide checking of their + state. So long as they call validate() from isSelected(), this will + be called automatically (unless they override validate()).

          +

          Implementations should check for incorrect settings and call + setError() as necessary.

          +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +validate

          +
          +public void validate()
          +
          +
          Subclasses can use this to throw the requisite exception + in isSelected() in the case of an error condition. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public abstract boolean isSelected(java.io.File basedir,
+                                   java.lang.String filename,
+                                   java.io.File file)
          +
          +
          Method that each selector will implement to create their + selection behaviour. If there is a problem with the setup + of a selector, it can throw a BuildException to indicate + the problem. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelectorContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelectorContainer.html new file mode 100644 index 000000000..3a7f48424 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/BaseSelectorContainer.html @@ -0,0 +1,1072 @@ + + + + + + +BaseSelectorContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class BaseSelectorContainer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          AndSelector, MajoritySelector, NoneSelector, OrSelector, SelectSelector
          +
          +
          +
          +
          public abstract class BaseSelectorContainer
          extends BaseSelector
          implements SelectorContainer
          + + +

          +This is the base class for selectors that can contain other selectors. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          BaseSelectorContainer() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileSelector selector) + +
          +          add an arbitary selector
          + voidaddAnd(AndSelector selector) + +
          +          add an "And" selector entry on the selector list
          + voidaddContains(ContainsSelector selector) + +
          +          add a contains selector entry on the selector list
          + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
          +          add a regular expression selector entry on the selector list
          + voidaddCustom(ExtendSelector selector) + +
          +          add an extended selector entry on the selector list
          + voidaddDate(DateSelector selector) + +
          +          add a selector date entry on the selector list
          + voidaddDepend(DependSelector selector) + +
          +          add a depends selector entry on the selector list
          + voidaddDepth(DepthSelector selector) + +
          +          add a depth selector entry on the selector list
          + voidaddDifferent(DifferentSelector selector) + +
          +          adds a different selector to the selector list
          + voidaddFilename(FilenameSelector selector) + +
          +          add a selector filename entry on the selector list
          + voidaddMajority(MajoritySelector selector) + +
          +          add a majority selector entry on the selector list
          + voidaddModified(ModifiedSelector selector) + +
          +          add the modified selector
          + voidaddNone(NoneSelector selector) + +
          +          add a "None" selector entry on the selector list
          + voidaddNot(NotSelector selector) + +
          +          add a "Not" selector entry on the selector list
          + voidaddOr(OrSelector selector) + +
          +          add an "Or" selector entry on the selector list
          + voidaddPresent(PresentSelector selector) + +
          +          add a present selector entry on the selector list
          + voidaddReadable(ReadableSelector r) + +
          +           
          + voidaddSelector(SelectSelector selector) + +
          +          add a "Select" selector entry on the selector list
          + voidaddSize(SizeSelector selector) + +
          +          add a selector size entry on the selector list
          + voidaddType(TypeSelector selector) + +
          +          adds a type selector to the selector list
          + voidaddWritable(WritableSelector w) + +
          +           
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          +protected  voiddieOnCircularReference(java.util.Stack stk, + Project p) + +
          +          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself).
          + FileSelector[]getSelectors(Project p) + +
          +          Returns the set of selectors as an array.
          + booleanhasSelectors() + +
          +          Indicates whether there are any selectors here.
          +abstract  booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their selection + behaviour.
          + intselectorCount() + +
          +          Gives the count of the number of selectors in this container
          + java.util.EnumerationselectorElements() + +
          +          Returns an enumerator for accessing the set of selectors.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          + voidvalidate() + +
          +          This implementation validates the container by calling + verifySettings() and then validates each contained selector + provided that the selector implements the validate interface.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +BaseSelectorContainer

          +
          +public BaseSelectorContainer()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +hasSelectors

          +
          +public boolean hasSelectors()
          +
          +
          Indicates whether there are any selectors here. +

          +

          +
          Specified by:
          hasSelectors in interface SelectorContainer
          +
          +
          + +
          Returns:
          true if there are selectors
          +
          +
          +
          + +

          +selectorCount

          +
          +public int selectorCount()
          +
          +
          Gives the count of the number of selectors in this container +

          +

          +
          Specified by:
          selectorCount in interface SelectorContainer
          +
          +
          + +
          Returns:
          the number of selectors
          +
          +
          +
          + +

          +getSelectors

          +
          +public FileSelector[] getSelectors(Project p)
          +
          +
          Returns the set of selectors as an array. +

          +

          +
          Specified by:
          getSelectors in interface SelectorContainer
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          an array of selectors
          +
          +
          +
          + +

          +selectorElements

          +
          +public java.util.Enumeration selectorElements()
          +
          +
          Returns an enumerator for accessing the set of selectors. +

          +

          +
          Specified by:
          selectorElements in interface SelectorContainer
          +
          +
          + +
          Returns:
          an enumerator for the selectors
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          comma separated list of Selectors contained in this one
          +
          +
          +
          + +

          +appendSelector

          +
          +public void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Specified by:
          appendSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the new selector to add
          +
          +
          +
          + +

          +validate

          +
          +public void validate()
          +
          +

          This implementation validates the container by calling + verifySettings() and then validates each contained selector + provided that the selector implements the validate interface. +

          +

          Ordinarily, this will validate all the elements of a selector + container even if the isSelected() method of some elements is + never called. This has two effects:

          +
            +
          • Validation will often occur twice. +
          • Since it is not required that selectors derive from + BaseSelector, there could be selectors in the container whose + error conditions are not detected if their isSelected() call + is never made. +
          +

          +

          +
          Overrides:
          validate in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public abstract boolean isSelected(java.io.File basedir,
+                                   java.lang.String filename,
+                                   java.io.File file)
          +
          +
          Method that each selector will implement to create their selection + behaviour. This is what makes SelectorContainer abstract. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - the name of the file to check
          file - a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +addSelector

          +
          +public void addSelector(SelectSelector selector)
          +
          +
          add a "Select" selector entry on the selector list +

          +

          +
          Specified by:
          addSelector in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addAnd

          +
          +public void addAnd(AndSelector selector)
          +
          +
          add an "And" selector entry on the selector list +

          +

          +
          Specified by:
          addAnd in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addOr

          +
          +public void addOr(OrSelector selector)
          +
          +
          add an "Or" selector entry on the selector list +

          +

          +
          Specified by:
          addOr in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNot

          +
          +public void addNot(NotSelector selector)
          +
          +
          add a "Not" selector entry on the selector list +

          +

          +
          Specified by:
          addNot in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNone

          +
          +public void addNone(NoneSelector selector)
          +
          +
          add a "None" selector entry on the selector list +

          +

          +
          Specified by:
          addNone in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addMajority

          +
          +public void addMajority(MajoritySelector selector)
          +
          +
          add a majority selector entry on the selector list +

          +

          +
          Specified by:
          addMajority in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDate

          +
          +public void addDate(DateSelector selector)
          +
          +
          add a selector date entry on the selector list +

          +

          +
          Specified by:
          addDate in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addSize

          +
          +public void addSize(SizeSelector selector)
          +
          +
          add a selector size entry on the selector list +

          +

          +
          Specified by:
          addSize in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addFilename

          +
          +public void addFilename(FilenameSelector selector)
          +
          +
          add a selector filename entry on the selector list +

          +

          +
          Specified by:
          addFilename in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addCustom

          +
          +public void addCustom(ExtendSelector selector)
          +
          +
          add an extended selector entry on the selector list +

          +

          +
          Specified by:
          addCustom in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContains

          +
          +public void addContains(ContainsSelector selector)
          +
          +
          add a contains selector entry on the selector list +

          +

          +
          Specified by:
          addContains in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addPresent

          +
          +public void addPresent(PresentSelector selector)
          +
          +
          add a present selector entry on the selector list +

          +

          +
          Specified by:
          addPresent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepth

          +
          +public void addDepth(DepthSelector selector)
          +
          +
          add a depth selector entry on the selector list +

          +

          +
          Specified by:
          addDepth in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepend

          +
          +public void addDepend(DependSelector selector)
          +
          +
          add a depends selector entry on the selector list +

          +

          +
          Specified by:
          addDepend in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDifferent

          +
          +public void addDifferent(DifferentSelector selector)
          +
          +
          adds a different selector to the selector list +

          +

          +
          Specified by:
          addDifferent in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addType

          +
          +public void addType(TypeSelector selector)
          +
          +
          adds a type selector to the selector list +

          +

          +
          Specified by:
          addType in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContainsRegexp

          +
          +public void addContainsRegexp(ContainsRegexpSelector selector)
          +
          +
          add a regular expression selector entry on the selector list +

          +

          +
          Specified by:
          addContainsRegexp in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addModified

          +
          +public void addModified(ModifiedSelector selector)
          +
          +
          add the modified selector +

          +

          +
          Specified by:
          addModified in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +addReadable

          +
          +public void addReadable(ReadableSelector r)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +addWritable

          +
          +public void addWritable(WritableSelector w)
          +
          +
          +
          +
          +
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(FileSelector selector)
          +
          +
          add an arbitary selector +

          +

          +
          Specified by:
          add in interface SelectorContainer
          +
          +
          +
          Parameters:
          selector - the selector to add
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +dieOnCircularReference

          +
          +protected void dieOnCircularReference(java.util.Stack stk,
+                                      Project p)
+                               throws BuildException
          +
          +
          Description copied from class: DataType
          +
          Check to see whether any DataType we hold references to is + included in the Stack (which holds all DataType instances that + directly or indirectly reference this instance, including this + instance itself). + +

          If one is included, throw a BuildException created by circularReference.

          + +

          This implementation is appropriate only for a DataType that + cannot hold other DataTypes as children.

          + +

          The general contract of this method is that it shouldn't do + anything if checked is true and + set it to true on exit.

          +

          +

          +
          Overrides:
          dieOnCircularReference in class DataType
          +
          +
          +
          Parameters:
          stk - the stack of references to check.
          p - the project to use to dereference the references. +
          Throws: +
          BuildException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsRegexpSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsRegexpSelector.html new file mode 100644 index 000000000..ecad80a75 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsRegexpSelector.html @@ -0,0 +1,578 @@ + + + + + + +ContainsRegexpSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class ContainsRegexpSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.ContainsRegexpSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class ContainsRegexpSelector
          extends BaseExtendSelector
          implements ResourceSelector
          + + +

          +Selector that filters files based on a regular expression. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringEXPRESSION_KEY + +
          +          Key to used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ContainsRegexpSelector() + +
          +          Creates a new ContainsRegexpSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Tests a regular expression against each line of text in the file.
          + booleanisSelected(Resource r) + +
          +          Tests a regular expression against each line of text in a Resource.
          + voidsetCaseSensitive(boolean b) + +
          +          Whether to ignore case or not.
          + voidsetExpression(java.lang.String theexpression) + +
          +          The regular expression used to search the file.
          + voidsetMultiLine(boolean b) + +
          +          Whether to match should be multiline.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetSingleLine(boolean b) + +
          +          Whether to treat input as singleline ('.' matches newline).
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks that an expression was specified.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EXPRESSION_KEY

          +
          +public static final java.lang.String EXPRESSION_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ContainsRegexpSelector

          +
          +public ContainsRegexpSelector()
          +
          +
          Creates a new ContainsRegexpSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setExpression

          +
          +public void setExpression(java.lang.String theexpression)
          +
          +
          The regular expression used to search the file. +

          +

          +
          +
          +
          +
          Parameters:
          theexpression - this must match a line in the file to be selected.
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean b)
          +
          +
          Whether to ignore case or not. +

          +

          +
          +
          +
          +
          Parameters:
          b - if false, ignore case.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +setMultiLine

          +
          +public void setMultiLine(boolean b)
          +
          +
          Whether to match should be multiline. +

          +

          +
          +
          +
          +
          Parameters:
          b - the value to set.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +setSingleLine

          +
          +public void setSingleLine(boolean b)
          +
          +
          Whether to treat input as singleline ('.' matches newline). + Corresponsds to java.util.regex.Pattern.DOTALL. +

          +

          +
          +
          +
          +
          Parameters:
          b - the value to set.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks that an expression was specified. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Tests a regular expression against each line of text in the file. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Tests a regular expression against each line of text in a Resource. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource is selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsSelector.html new file mode 100644 index 000000000..e54bfd621 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ContainsSelector.html @@ -0,0 +1,612 @@ + + + + + + +ContainsSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class ContainsSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.ContainsSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class ContainsSelector
          extends BaseExtendSelector
          implements ResourceSelector
          + + +

          +Selector that filters files/resources based on whether they contain a + particular string. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCASE_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringCONTAINS_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringEXPRESSION_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringWHITESPACE_KEY + +
          +          Used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ContainsSelector() + +
          +          Creates a new ContainsSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + booleanisSelected(Resource r) + +
          +          The heart of the matter.
          + voidsetCasesensitive(boolean casesensitive) + +
          +          Whether to ignore case in the string being searched.
          + voidsetIgnorewhitespace(boolean ignorewhitespace) + +
          +          Whether to ignore whitespace in the string being searched.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetText(java.lang.String contains) + +
          +          The string to search for within a file.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EXPRESSION_KEY

          +
          +public static final java.lang.String EXPRESSION_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CONTAINS_KEY

          +
          +public static final java.lang.String CONTAINS_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CASE_KEY

          +
          +public static final java.lang.String CASE_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WHITESPACE_KEY

          +
          +public static final java.lang.String WHITESPACE_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ContainsSelector

          +
          +public ContainsSelector()
          +
          +
          Creates a new ContainsSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setText

          +
          +public void setText(java.lang.String contains)
          +
          +
          The string to search for within a file. +

          +

          +
          +
          +
          +
          Parameters:
          contains - the string that a file must contain to be selected.
          +
          +
          +
          + +

          +setCasesensitive

          +
          +public void setCasesensitive(boolean casesensitive)
          +
          +
          Whether to ignore case in the string being searched. +

          +

          +
          +
          +
          +
          Parameters:
          casesensitive - whether to pay attention to case sensitivity
          +
          +
          +
          + +

          +setIgnorewhitespace

          +
          +public void setIgnorewhitespace(boolean ignorewhitespace)
          +
          +
          Whether to ignore whitespace in the string being searched. +

          +

          +
          +
          +
          +
          Parameters:
          ignorewhitespace - whether to ignore any whitespace + (spaces, tabs, etc.) in the searchstring
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the pattern attribute has been set. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a Resource. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource is selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.TimeComparisons.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.TimeComparisons.html new file mode 100644 index 000000000..7993df2de --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.TimeComparisons.html @@ -0,0 +1,274 @@ + + + + + + +DateSelector.TimeComparisons (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class DateSelector.TimeComparisons

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.TimeComparison
+          extended by org.apache.tools.ant.types.selectors.DateSelector.TimeComparisons
+
          +
          +
          Enclosing class:
          DateSelector
          +
          +
          +
          +
          public static class DateSelector.TimeComparisons
          extends TimeComparison
          + + +

          +Enumerated attribute with the values for time comparison. +

          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.TimeComparison
          AFTER, BEFORE, EQUAL
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          DateSelector.TimeComparisons() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.TimeComparison
          compare, compare, evaluate, evaluate, getValues
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DateSelector.TimeComparisons

          +
          +public DateSelector.TimeComparisons()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.html new file mode 100644 index 000000000..923a1b11b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DateSelector.html @@ -0,0 +1,745 @@ + + + + + + +DateSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class DateSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.DateSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class DateSelector
          extends BaseExtendSelector
          + + +

          +Selector that chooses files based on their last modified date. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classDateSelector.TimeComparisons + +
          +          Enumerated attribute with the values for time comparison.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCHECKDIRS_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringDATETIME_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringGRANULARITY_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringMILLIS_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringPATTERN_KEY + +
          +          Key to used for parameterized custom selector
          +static java.lang.StringWHEN_KEY + +
          +          Key to used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DateSelector() + +
          +          Creates a new DateSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + longgetMillis() + +
          +          Returns the millisecond value the selector is set for.
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetCheckdirs(boolean includeDirs) + +
          +          Set whether to check dates on directories.
          + voidsetDatetime(java.lang.String dateTime) + +
          +          Sets the date.
          + voidsetGranularity(int granularity) + +
          +          Sets the number of milliseconds leeway we will give before we consider + a file not to have matched a date.
          + voidsetMillis(long millis) + +
          +          Set the time; for users who prefer to express time in ms since 1970.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetPattern(java.lang.String pattern) + +
          +          Sets the pattern to be used for the SimpleDateFormat.
          + voidsetWhen(DateSelector.TimeComparisons tcmp) + +
          +          Sets the type of comparison to be done on the file's last modified + date.
          + voidsetWhen(TimeComparison t) + +
          +          Set the comparison type.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          This is a consistency check to ensure the selector's required + values have been set.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MILLIS_KEY

          +
          +public static final java.lang.String MILLIS_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DATETIME_KEY

          +
          +public static final java.lang.String DATETIME_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CHECKDIRS_KEY

          +
          +public static final java.lang.String CHECKDIRS_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GRANULARITY_KEY

          +
          +public static final java.lang.String GRANULARITY_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WHEN_KEY

          +
          +public static final java.lang.String WHEN_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PATTERN_KEY

          +
          +public static final java.lang.String PATTERN_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DateSelector

          +
          +public DateSelector()
          +
          +
          Creates a new DateSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setMillis

          +
          +public void setMillis(long millis)
          +
          +
          Set the time; for users who prefer to express time in ms since 1970. +

          +

          +
          Parameters:
          millis - the time to compare file's last modified date to, + expressed in milliseconds.
          +
          +
          +
          + +

          +getMillis

          +
          +public long getMillis()
          +
          +
          Returns the millisecond value the selector is set for. +

          +

          + +
          Returns:
          the millisecond value.
          +
          +
          +
          + +

          +setDatetime

          +
          +public void setDatetime(java.lang.String dateTime)
          +
          +
          Sets the date. The user must supply it in MM/DD/YYYY HH:MM AM_PM format, + unless an alternate pattern is specified via the pattern attribute. +

          +

          +
          Parameters:
          dateTime - a formatted date String.
          +
          +
          +
          + +

          +setCheckdirs

          +
          +public void setCheckdirs(boolean includeDirs)
          +
          +
          Set whether to check dates on directories. +

          +

          +
          Parameters:
          includeDirs - whether to check the timestamp on directories.
          +
          +
          +
          + +

          +setGranularity

          +
          +public void setGranularity(int granularity)
          +
          +
          Sets the number of milliseconds leeway we will give before we consider + a file not to have matched a date. +

          +

          +
          Parameters:
          granularity - the number of milliseconds leeway.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(DateSelector.TimeComparisons tcmp)
          +
          +
          Sets the type of comparison to be done on the file's last modified + date. +

          +

          +
          Parameters:
          tcmp - The comparison to perform, an EnumeratedAttribute.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(TimeComparison t)
          +
          +
          Set the comparison type. +

          +

          +
          Parameters:
          t - TimeComparison object.
          +
          +
          +
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String pattern)
          +
          +
          Sets the pattern to be used for the SimpleDateFormat. +

          +

          +
          Parameters:
          pattern - the pattern that defines the date format.
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector.
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          This is a consistency check to ensure the selector's required + values have been set. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory from which the scan is being performed.
          filename - is the name of the file to check.
          file - is a java.io.File object the selector can use. +
          Returns:
          whether the file is selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DependSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DependSelector.html new file mode 100644 index 000000000..e9fc368e9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DependSelector.html @@ -0,0 +1,373 @@ + + + + + + +DependSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class DependSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.MappingSelector
+                  extended by org.apache.tools.ant.types.selectors.DependSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class DependSelector
          extends MappingSelector
          + + +

          +Selector that filters files based on whether they are newer than + a matching file in another directory tree. It can contain a mapper + element, so isn't available as an ExtendSelector (since those + parameters can't hold other elements). +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.MappingSelector
          granularity, map, mapperElement, targetdir
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DependSelector() + +
          +          Creates a new DependSelector instance.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanselectionTest(java.io.File srcfile, + java.io.File destfile) + +
          +          this test is our selection test that compared the file with the destfile
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.MappingSelector
          addConfigured, createMapper, isSelected, setGranularity, setTargetdir, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DependSelector

          +
          +public DependSelector()
          +
          +
          Creates a new DependSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +selectionTest

          +
          +public boolean selectionTest(java.io.File srcfile,
+                             java.io.File destfile)
          +
          +
          this test is our selection test that compared the file with the destfile +

          +

          +
          Specified by:
          selectionTest in class MappingSelector
          +
          +
          +
          Parameters:
          srcfile - the source file
          destfile - the destination file +
          Returns:
          true if destination is out of date
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DepthSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DepthSelector.html new file mode 100644 index 000000000..89a5bb137 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DepthSelector.html @@ -0,0 +1,558 @@ + + + + + + +DepthSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class DepthSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.DepthSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class DepthSelector
          extends BaseExtendSelector
          + + +

          +Selector that filters files based on the how deep in the directory + tree they are. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          + intmax + +
          +          max attribute
          +static java.lang.StringMAX_KEY + +
          +          Used for parameterized custom selector
          + intmin + +
          +          min attribute
          +static java.lang.StringMIN_KEY + +
          +          Used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DepthSelector() + +
          +          Creates a new DepthSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetMax(int max) + +
          +          The minimum depth below the basedir before a file is selected.
          + voidsetMin(int min) + +
          +          The minimum depth below the basedir before a file is selected.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +min

          +
          +public int min
          +
          +
          min attribute +

          +

          +
          +
          +
          + +

          +max

          +
          +public int max
          +
          +
          max attribute +

          +

          +
          +
          +
          + +

          +MIN_KEY

          +
          +public static final java.lang.String MIN_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAX_KEY

          +
          +public static final java.lang.String MAX_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DepthSelector

          +
          +public DepthSelector()
          +
          +
          Creates a new DepthSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setMin

          +
          +public void setMin(int min)
          +
          +
          The minimum depth below the basedir before a file is selected. +

          +

          +
          Parameters:
          min - minimum directory levels below basedir to go
          +
          +
          +
          + +

          +setMax

          +
          +public void setMax(int max)
          +
          +
          The minimum depth below the basedir before a file is selected. +

          +

          +
          Parameters:
          max - maximum directory levels below basedir to go
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the max depth is not lower than the min depth. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. Most of the work + for this selector is offloaded into SelectorUtils, a static class + that provides the same services for both FilenameSelector and + DirectoryScanner. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DifferentSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DifferentSelector.html new file mode 100644 index 000000000..c0b57718a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/DifferentSelector.html @@ -0,0 +1,401 @@ + + + + + + +DifferentSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class DifferentSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.MappingSelector
+                  extended by org.apache.tools.ant.types.selectors.DifferentSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class DifferentSelector
          extends MappingSelector
          + + +

          +This selector selects files against a mapped set of target files, selecting + all those files which are different. + Files with different lengths are deemed different + automatically + Files with identical timestamps are viewed as matching by + default, unless you specify otherwise. + Contents are compared if the lengths are the same + and the timestamps are ignored or the same, + except if you decide to ignore contents to gain speed. +

          + This is a useful selector to work with programs and tasks that don't handle + dependency checking properly; Even if a predecessor task always creates its + output files, followup tasks can be driven off copies made with a different + selector, so their dependencies are driven on the absolute state of the + files, not a timestamp. +

          + Clearly, however, bulk file comparisons is inefficient; anything that can + use timestamps is to be preferred. If this selector must be used, use it + over as few files as possible, perhaps following it with an <uptodate;> + to keep the descendent routines conditional. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.MappingSelector
          granularity, map, mapperElement, targetdir
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          DifferentSelector() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  booleanselectionTest(java.io.File srcfile, + java.io.File destfile) + +
          +          this test is our selection test that compared the file with the destfile
          + voidsetIgnoreContents(boolean ignoreContents) + +
          +          This flag tells the selector to ignore contents
          + voidsetIgnoreFileTimes(boolean ignoreFileTimes) + +
          +          This flag tells the selector to ignore file times in the comparison
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.MappingSelector
          addConfigured, createMapper, isSelected, setGranularity, setTargetdir, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DifferentSelector

          +
          +public DifferentSelector()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setIgnoreFileTimes

          +
          +public void setIgnoreFileTimes(boolean ignoreFileTimes)
          +
          +
          This flag tells the selector to ignore file times in the comparison +

          +

          +
          Parameters:
          ignoreFileTimes - if true ignore file times
          +
          +
          +
          + +

          +setIgnoreContents

          +
          +public void setIgnoreContents(boolean ignoreContents)
          +
          +
          This flag tells the selector to ignore contents +

          +

          +
          Parameters:
          ignoreContents - if true ignore contents
          Since:
          +
          ant 1.6.3
          +
          +
          +
          +
          + +

          +selectionTest

          +
          +protected boolean selectionTest(java.io.File srcfile,
+                                java.io.File destfile)
          +
          +
          this test is our selection test that compared the file with the destfile +

          +

          +
          Specified by:
          selectionTest in class MappingSelector
          +
          +
          +
          Parameters:
          srcfile - the source file
          destfile - the destination file +
          Returns:
          true if the files are different
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendFileSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendFileSelector.html new file mode 100644 index 000000000..6245a02a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendFileSelector.html @@ -0,0 +1,211 @@ + + + + + + +ExtendFileSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Interface ExtendFileSelector

          +
          +
          All Superinterfaces:
          FileSelector, Parameterizable
          +
          +
          +
          All Known Implementing Classes:
          BaseExtendSelector, ContainsRegexpSelector, ContainsSelector, DateSelector, DepthSelector, FilenameSelector, ModifiedSelector, SizeSelector, TypeSelector
          +
          +
          +
          +
          public interface ExtendFileSelector
          extends FileSelector, Parameterizable
          + + +

          +This is the interface to be used by all custom selectors, those that are + called through the <custom> tag. It is the amalgamation of two + interfaces, the FileSelector and the Paramterizable interface. Note that + you will almost certainly want the default behaviour for handling + Parameters, so you probably want to use the BaseExtendSelector class + as the base class for your custom selector rather than implementing + this interface from scratch. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.types.selectors.FileSelector
          isSelected
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.types.Parameterizable
          setParameters
          +  +

          + +

          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendSelector.html new file mode 100644 index 000000000..9a0c3c0c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ExtendSelector.html @@ -0,0 +1,511 @@ + + + + + + +ExtendSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class ExtendSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.ExtendSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class ExtendSelector
          extends BaseSelector
          + + +

          +Selector that selects files by forwarding the request on to other classes. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ExtendSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddParam(Parameter p) + +
          +          Create new parameters to pass to custom selector.
          + PathcreateClasspath() + +
          +          Specify the classpath to use to load the Selector (nested element).
          + PathgetClasspath() + +
          +          Get the classpath
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Allows the custom selector to choose whether to select a file.
          + voidselectorCreate() + +
          +          Instantiates the identified custom selector class.
          + voidsetClassname(java.lang.String classname) + +
          +          Sets the classname of the custom selector.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to load the classname specified using an attribute.
          + voidsetClasspathref(Reference r) + +
          +          Set the classpath to use for loading a custom selector by using + a reference.
          + voidverifySettings() + +
          +          These are errors specific to ExtendSelector only.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ExtendSelector

          +
          +public ExtendSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String classname)
          +
          +
          Sets the classname of the custom selector. +

          +

          +
          Parameters:
          classname - is the class which implements this selector
          +
          +
          +
          + +

          +selectorCreate

          +
          +public void selectorCreate()
          +
          +
          Instantiates the identified custom selector class. +

          +

          +
          +
          +
          +
          + +

          +addParam

          +
          +public void addParam(Parameter p)
          +
          +
          Create new parameters to pass to custom selector. +

          +

          +
          Parameters:
          p - The new Parameter object
          +
          +
          +
          + +

          +setClasspath

          +
          +public final void setClasspath(Path classpath)
          +
          +
          Set the classpath to load the classname specified using an attribute. +

          +

          +
          Parameters:
          classpath - the classpath to use
          +
          +
          +
          + +

          +createClasspath

          +
          +public final Path createClasspath()
          +
          +
          Specify the classpath to use to load the Selector (nested element). +

          +

          + +
          Returns:
          a classpath to be configured
          +
          +
          +
          + +

          +getClasspath

          +
          +public final Path getClasspath()
          +
          +
          Get the classpath +

          +

          + +
          Returns:
          the classpath
          +
          +
          +
          + +

          +setClasspathref

          +
          +public void setClasspathref(Reference r)
          +
          +
          Set the classpath to use for loading a custom selector by using + a reference. +

          +

          +
          Parameters:
          r - a reference to the classpath
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          These are errors specific to ExtendSelector only. If there are + errors in the custom selector, it should throw a BuildException + when isSelected() is called. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
+                   throws BuildException
          +
          +
          Allows the custom selector to choose whether to select a file. This + is also where the Parameters are passed to the custom selector, + since we know we must have them all by now. And since we must know + both classpath and classname, creating the class is deferred to here + as well. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - The the base directory.
          filename - The name of the file to check.
          file - A File object for this filename. +
          Returns:
          whether the file should be selected or not. +
          Throws: +
          BuildException - if an error occurs.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FileSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FileSelector.html new file mode 100644 index 000000000..1cd764663 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FileSelector.html @@ -0,0 +1,229 @@ + + + + + + +FileSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Interface FileSelector

          +
          +
          All Known Subinterfaces:
          ExtendFileSelector
          +
          +
          +
          All Known Implementing Classes:
          AndSelector, BaseExtendSelector, BaseSelector, BaseSelectorContainer, ContainsRegexpSelector, ContainsSelector, DateSelector, DependSelector, DepthSelector, DifferentSelector, ExtendSelector, FilenameSelector, MajoritySelector, MappingSelector, ModifiedSelector, NoneSelector, NotSelector, OrSelector, PresentSelector, ReadableSelector, ScriptSelector, SelectSelector, SignedSelector, SizeSelector, TypeSelector, WritableSelector
          +
          +
          +
          +
          public interface FileSelector
          + + +

          +This is the interface to be used by all selectors. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their + selection behaviour.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +boolean isSelected(java.io.File basedir,
+                   java.lang.String filename,
+                   java.io.File file)
+                   throws BuildException
          +
          +
          Method that each selector will implement to create their + selection behaviour. If there is a problem with the setup + of a selector, it can throw a BuildException to indicate + the problem. +

          +

          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not +
          Throws: +
          BuildException - if the selector was not configured correctly
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FilenameSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FilenameSelector.html new file mode 100644 index 000000000..d5a965d4b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/FilenameSelector.html @@ -0,0 +1,608 @@ + + + + + + +FilenameSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class FilenameSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.FilenameSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class FilenameSelector
          extends BaseExtendSelector
          + + +

          +Selector that filters files based on the filename. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringCASE_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringNAME_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringNEGATE_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringREGEX_KEY + +
          +          Used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FilenameSelector() + +
          +          Creates a new FilenameSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetCasesensitive(boolean casesensitive) + +
          +          Whether to ignore case when checking filenames.
          + voidsetName(java.lang.String pattern) + +
          +          The name of the file, or the pattern for the name, that + should be used for selection.
          + voidsetNegate(boolean negated) + +
          +          You can optionally reverse the selection of this selector, + thereby emulating an <exclude> tag, by setting the attribute + negate to true.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetRegex(java.lang.String pattern) + +
          +          The regular expression the file name will be matched against.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +NAME_KEY

          +
          +public static final java.lang.String NAME_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CASE_KEY

          +
          +public static final java.lang.String CASE_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +NEGATE_KEY

          +
          +public static final java.lang.String NEGATE_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +REGEX_KEY

          +
          +public static final java.lang.String REGEX_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FilenameSelector

          +
          +public FilenameSelector()
          +
          +
          Creates a new FilenameSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String pattern)
          +
          +
          The name of the file, or the pattern for the name, that + should be used for selection. +

          +

          +
          Parameters:
          pattern - the file pattern that any filename must match + against in order to be selected.
          +
          +
          +
          + +

          +setRegex

          +
          +public void setRegex(java.lang.String pattern)
          +
          +
          The regular expression the file name will be matched against. +

          +

          +
          Parameters:
          pattern - the regular expression that any filename must match + against in order to be selected.
          +
          +
          +
          + +

          +setCasesensitive

          +
          +public void setCasesensitive(boolean casesensitive)
          +
          +
          Whether to ignore case when checking filenames. +

          +

          +
          Parameters:
          casesensitive - whether to pay attention to case sensitivity
          +
          +
          +
          + +

          +setNegate

          +
          +public void setNegate(boolean negated)
          +
          +
          You can optionally reverse the selection of this selector, + thereby emulating an <exclude> tag, by setting the attribute + negate to true. This is identical to surrounding the selector + with <not></not>. +

          +

          +
          Parameters:
          negated - whether to negate this selection
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the name attribute has been set. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. Most of the work + for this selector is offloaded into SelectorUtils, a static class + that provides the same services for both FilenameSelector and + DirectoryScanner. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MajoritySelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MajoritySelector.html new file mode 100644 index 000000000..c89cfde39 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MajoritySelector.html @@ -0,0 +1,400 @@ + + + + + + +MajoritySelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class MajoritySelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.MajoritySelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          +
          public class MajoritySelector
          extends BaseSelectorContainer
          + + +

          +This selector is here just to shake up your thinking a bit. Don't get + too caught up in boolean, there are other ways you can evaluate a + collection of selectors. This one takes a vote of the selectors it + contains, and majority wins. You could also have an "all-but-one" + selector, a "weighted-average" selector, and so on. These are left + as exercises for the reader (as are the usecases where this would + be necessary). +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          MajoritySelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Returns true (the file is selected) if most of the other selectors + agree.
          + voidsetAllowtie(boolean tiebreaker) + +
          +          A attribute to specify what will happen if number + of yes votes is the same as the number of no votes + defaults to true
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +MajoritySelector

          +
          +public MajoritySelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setAllowtie

          +
          +public void setAllowtie(boolean tiebreaker)
          +
          +
          A attribute to specify what will happen if number + of yes votes is the same as the number of no votes + defaults to true +

          +

          +
          Parameters:
          tiebreaker - the value to give if there is a tie
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Returns true (the file is selected) if most of the other selectors + agree. In case of a tie, go by the allowtie setting. That defaults + to true, meaning in case of a tie, the file is selected. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MappingSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MappingSelector.html new file mode 100644 index 000000000..0af30902a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/MappingSelector.html @@ -0,0 +1,555 @@ + + + + + + +MappingSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class MappingSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.MappingSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          Direct Known Subclasses:
          DependSelector, DifferentSelector
          +
          +
          +
          +
          public abstract class MappingSelector
          extends BaseSelector
          + + +

          +A mapping selector is an abstract class adding mapping support to the base + selector +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  intgranularity + +
          +           
          +protected  FileNameMappermap + +
          +           
          +protected  MappermapperElement + +
          +           
          +protected  java.io.Filetargetdir + +
          +           
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          MappingSelector() + +
          +          Creates a new MappingSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(FileNameMapper fileNameMapper) + +
          +          Add a configured FileNameMapper instance.
          + MappercreateMapper() + +
          +          Defines the FileNameMapper to use (nested mapper element).
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          +protected abstract  booleanselectionTest(java.io.File srcfile, + java.io.File destfile) + +
          +          this test is our selection test that compared the file with the destfile
          + voidsetGranularity(int granularity) + +
          +          Sets the number of milliseconds leeway we will give before we consider + a file out of date.
          + voidsetTargetdir(java.io.File targetdir) + +
          +          The name of the file or directory which is checked for out-of-date + files.
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +targetdir

          +
          +protected java.io.File targetdir
          +
          +
          +
          +
          +
          + +

          +mapperElement

          +
          +protected Mapper mapperElement
          +
          +
          +
          +
          +
          + +

          +map

          +
          +protected FileNameMapper map
          +
          +
          +
          +
          +
          + +

          +granularity

          +
          +protected int granularity
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +MappingSelector

          +
          +public MappingSelector()
          +
          +
          Creates a new MappingSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setTargetdir

          +
          +public void setTargetdir(java.io.File targetdir)
          +
          +
          The name of the file or directory which is checked for out-of-date + files. +

          +

          +
          Parameters:
          targetdir - the directory to scan looking for files.
          +
          +
          +
          + +

          +createMapper

          +
          +public Mapper createMapper()
+                    throws BuildException
          +
          +
          Defines the FileNameMapper to use (nested mapper element). +

          +

          + +
          Returns:
          a mapper to be configured +
          Throws: +
          BuildException - if more than one mapper defined
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(FileNameMapper fileNameMapper)
          +
          +
          Add a configured FileNameMapper instance. +

          +

          +
          Parameters:
          fileNameMapper - the FileNameMapper to add +
          Throws: +
          BuildException - if more than one mapper defined
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the dest attribute has been set and we have a mapper. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +selectionTest

          +
          +protected abstract boolean selectionTest(java.io.File srcfile,
+                                         java.io.File destfile)
          +
          +
          this test is our selection test that compared the file with the destfile +

          +

          +
          Parameters:
          srcfile - file to test; may be null
          destfile - destination file +
          Returns:
          true if source file compares with destination file
          +
          +
          +
          + +

          +setGranularity

          +
          +public void setGranularity(int granularity)
          +
          +
          Sets the number of milliseconds leeway we will give before we consider + a file out of date. Defaults to 2000 on MS-DOS derivatives and 1000 on + others. +

          +

          +
          Parameters:
          granularity - the leeway in milliseconds
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NoneSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NoneSelector.html new file mode 100644 index 000000000..09a3e6c47 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NoneSelector.html @@ -0,0 +1,373 @@ + + + + + + +NoneSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class NoneSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.NoneSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          Direct Known Subclasses:
          NotSelector
          +
          +
          +
          +
          public class NoneSelector
          extends BaseSelectorContainer
          + + +

          +This selector has a collection of other selectors. All of those selectors + must refuse to select a file before the file is considered selected by + this selector. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          NoneSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Returns true (the file is selected) only if all other selectors + agree that the file should not be selected.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +NoneSelector

          +
          +public NoneSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          a string representation of the selector
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Returns true (the file is selected) only if all other selectors + agree that the file should not be selected. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NotSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NotSelector.html new file mode 100644 index 000000000..0b17aabbc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/NotSelector.html @@ -0,0 +1,395 @@ + + + + + + +NotSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class NotSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.NoneSelector
+                      extended by org.apache.tools.ant.types.selectors.NotSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          +
          public class NotSelector
          extends NoneSelector
          + + +

          +This selector has one other selectors whose meaning it inverts. It + actually relies on NoneSelector for its implementation of the + isSelected() method, but it adds a check to ensure there is only one + other selector contained within. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          NotSelector() + +
          +          Default constructor.
          NotSelector(FileSelector other) + +
          +          Constructor that inverts the meaning of its argument.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          + voidverifySettings() + +
          +          Makes sure that there is only one entry, sets an error message if + not.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.NoneSelector
          isSelected
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +NotSelector

          +
          +public NotSelector()
          +
          +
          Default constructor. +

          +

          +
          + +

          +NotSelector

          +
          +public NotSelector(FileSelector other)
          +
          +
          Constructor that inverts the meaning of its argument. +

          +

          +
          Parameters:
          other - the selector to invert
          Since:
          +
          Ant 1.7
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class NoneSelector
          +
          +
          + +
          Returns:
          a string representation of the selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Makes sure that there is only one entry, sets an error message if + not. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/OrSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/OrSelector.html new file mode 100644 index 000000000..e4345b97b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/OrSelector.html @@ -0,0 +1,369 @@ + + + + + + +OrSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class OrSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.OrSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          +
          public class OrSelector
          extends BaseSelectorContainer
          + + +

          +This selector has a collection of other selectors, any of which have to + select a file in order for this selector to select it. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          OrSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Returns true (the file is selected) if any of the other selectors + agree that the file should be selected.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendSelector, dieOnCircularReference, getSelectors, hasSelectors, selectorCount, selectorElements, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, verifySettings
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +OrSelector

          +
          +public OrSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          a string representation of the selector
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Returns true (the file is selected) if any of the other selectors + agree that the file should be selected. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - the name of the file to check
          file - a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html new file mode 100644 index 000000000..af04c690e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.FilePresence.html @@ -0,0 +1,290 @@ + + + + + + +PresentSelector.FilePresence (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class PresentSelector.FilePresence

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.PresentSelector.FilePresence
+
          +
          +
          Enclosing class:
          PresentSelector
          +
          +
          +
          +
          public static class PresentSelector.FilePresence
          extends EnumeratedAttribute
          + + +

          +Enumerated attribute with the values for indicating where a file's + presence is allowed and required. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          PresentSelector.FilePresence() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PresentSelector.FilePresence

          +
          +public PresentSelector.FilePresence()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the values as an array of strings
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.html new file mode 100644 index 000000000..40df9a079 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/PresentSelector.html @@ -0,0 +1,501 @@ + + + + + + +PresentSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class PresentSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.PresentSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class PresentSelector
          extends BaseSelector
          + + +

          +Selector that filters files based on whether they appear in another + directory tree. It can contain a mapper element, so isn't available + as an ExtendSelector (since those parameters can't hold other + elements). +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classPresentSelector.FilePresence + +
          +          Enumerated attribute with the values for indicating where a file's + presence is allowed and required.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          PresentSelector() + +
          +          Creates a new PresentSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfigured(FileNameMapper fileNameMapper) + +
          +          Add a configured FileNameMapper instance.
          + MappercreateMapper() + +
          +          Defines the FileNameMapper to use (nested mapper element).
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetPresent(PresentSelector.FilePresence fp) + +
          +          This sets whether to select a file if its dest file is present.
          + voidsetTargetdir(java.io.File targetdir) + +
          +          The name of the file or directory which is checked for matching + files.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PresentSelector

          +
          +public PresentSelector()
          +
          +
          Creates a new PresentSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setTargetdir

          +
          +public void setTargetdir(java.io.File targetdir)
          +
          +
          The name of the file or directory which is checked for matching + files. +

          +

          +
          Parameters:
          targetdir - the directory to scan looking for matching files.
          +
          +
          +
          + +

          +createMapper

          +
          +public Mapper createMapper()
+                    throws BuildException
          +
          +
          Defines the FileNameMapper to use (nested mapper element). +

          +

          + +
          Returns:
          a mapper to be configured +
          Throws: +
          BuildException - if more than one mapper defined
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(FileNameMapper fileNameMapper)
          +
          +
          Add a configured FileNameMapper instance. +

          +

          +
          Parameters:
          fileNameMapper - the FileNameMapper to add +
          Throws: +
          BuildException - if more than one mapper defined
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setPresent

          +
          +public void setPresent(PresentSelector.FilePresence fp)
          +
          +
          This sets whether to select a file if its dest file is present. + It could be a negate boolean, but by doing things + this way, we get some documentation on how the system works. + A user looking at the documentation should clearly understand + that the ONLY files whose presence is being tested are those + that already exist in the source directory, hence the lack of + a destonly option. +

          +

          +
          Parameters:
          fp - An attribute set to either srconlyboth.
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the targetdir attribute has been set and we have a mapper. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ReadableSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ReadableSelector.html new file mode 100644 index 000000000..b7b688ae5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/ReadableSelector.html @@ -0,0 +1,303 @@ + + + + + + +ReadableSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class ReadableSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.ReadableSelector
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector, FileSelector
          +
          +
          +
          +
          public class ReadableSelector
          extends java.lang.Object
          implements FileSelector, ResourceSelector
          + + +

          +A selector that selects readable files. + +

          Readable is definied in terms of java.io.File#canRead, this + means the selector will accept any file that exists and is readable + by the application.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ReadableSelector() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their + selection behaviour.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ReadableSelector

          +
          +public ReadableSelector()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Description copied from interface: FileSelector
          +
          Method that each selector will implement to create their + selection behaviour. If there is a problem with the setup + of a selector, it can throw a BuildException to indicate + the problem. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Description copied from interface: ResourceSelector
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectSelector.html new file mode 100644 index 000000000..e30f3b6a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectSelector.html @@ -0,0 +1,655 @@ + + + + + + +SelectSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SelectSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseSelectorContainer
+                  extended by org.apache.tools.ant.types.selectors.SelectSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector, SelectorContainer
          +
          +
          +
          +
          public class SelectSelector
          extends BaseSelectorContainer
          + + +

          +This selector just holds one other selector and forwards all + requests to it. It exists so that there is a single selector + type that can exist outside of any targets, as an element of + project. It overrides all of the reference stuff so that it + works as expected. Note that this is the only selector you + can reference. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SelectSelector() + +
          +          Default constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          + FileSelector[]getSelectors(Project p) + +
          +          Returns the set of selectors as an array.
          + booleanhasSelectors() + +
          +          Indicates whether there are any selectors here.
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Returns true (the file is selected) only if the if property (if any) + exists, the unless property (if any) doesn't exist, and the + contained selector (if any) selects the file.
          + booleanpassesConditions() + +
          +          Ensures that the selector passes the conditions placed + on it with if and unless.
          + intselectorCount() + +
          +          Gives the count of the number of selectors in this container
          + java.util.EnumerationselectorElements() + +
          +          Returns an enumerator for accessing the set of selectors.
          + voidsetIf(java.lang.Object ifProperty) + +
          +          Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files.
          + voidsetIf(java.lang.String ifProperty) + +
          +          Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files.
          + voidsetUnless(java.lang.Object unlessProperty) + +
          +          Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files.
          + voidsetUnless(java.lang.String unlessProperty) + +
          +          Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files.
          + java.lang.StringtoString() + +
          +          Convert the Selectors within this container to a string.
          + voidverifySettings() + +
          +          Makes sure that there is only one entry, sets an error message if + not.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorContainer
          add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, dieOnCircularReference, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SelectSelector

          +
          +public SelectSelector()
          +
          +
          Default constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: BaseSelectorContainer
          +
          Convert the Selectors within this container to a string. This will + just be a helper class for the subclasses that put their own name + around the contents listed here. +

          +

          +
          Overrides:
          toString in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +hasSelectors

          +
          +public boolean hasSelectors()
          +
          +
          Indicates whether there are any selectors here. +

          +

          +
          Specified by:
          hasSelectors in interface SelectorContainer
          Overrides:
          hasSelectors in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          whether any selectors are in this container
          +
          +
          +
          + +

          +selectorCount

          +
          +public int selectorCount()
          +
          +
          Gives the count of the number of selectors in this container +

          +

          +
          Specified by:
          selectorCount in interface SelectorContainer
          Overrides:
          selectorCount in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          the number of selectors in this container
          +
          +
          +
          + +

          +getSelectors

          +
          +public FileSelector[] getSelectors(Project p)
          +
          +
          Returns the set of selectors as an array. +

          +

          +
          Specified by:
          getSelectors in interface SelectorContainer
          Overrides:
          getSelectors in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          p - the current project +
          Returns:
          an array of selectors in this container
          +
          +
          +
          + +

          +selectorElements

          +
          +public java.util.Enumeration selectorElements()
          +
          +
          Returns an enumerator for accessing the set of selectors. +

          +

          +
          Specified by:
          selectorElements in interface SelectorContainer
          Overrides:
          selectorElements in class BaseSelectorContainer
          +
          +
          + +
          Returns:
          an enumerator that goes through each of the selectors
          +
          +
          +
          + +

          +appendSelector

          +
          +public void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Specified by:
          appendSelector in interface SelectorContainer
          Overrides:
          appendSelector in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          selector - the new selector to add
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Makes sure that there is only one entry, sets an error message if + not. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +passesConditions

          +
          +public boolean passesConditions()
          +
          +
          Ensures that the selector passes the conditions placed + on it with if and unless. +

          +

          + +
          Returns:
          true if conditions are passed
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.Object ifProperty)
          +
          +
          Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files. +

          +

          +
          Parameters:
          ifProperty - the expression to check
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setIf

          +
          +public void setIf(java.lang.String ifProperty)
          +
          +
          Sets the if attribute to an expression which must evaluate to + true or the name of an existing property for the + selector to select any files. +

          +

          +
          Parameters:
          ifProperty - the expression to check
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.Object unlessProperty)
          +
          +
          Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files. +

          +

          +
          Parameters:
          unlessProperty - the expression to check
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +setUnless

          +
          +public void setUnless(java.lang.String unlessProperty)
          +
          +
          Sets the unless attribute to an expression which must evaluate to + false or the name of a property which cannot exist for the + selector to select any files. +

          +

          +
          Parameters:
          unlessProperty - the expression to check
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Returns true (the file is selected) only if the if property (if any) + exists, the unless property (if any) doesn't exist, and the + contained selector (if any) selects the file. If there is no contained + selector, return true (because we assume that the point was to test + the if and unless conditions). +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseSelectorContainer
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - the name of the file to check
          file - a java.io.File object for the filename that the selector + can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorContainer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorContainer.html new file mode 100644 index 000000000..41388e8d9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorContainer.html @@ -0,0 +1,709 @@ + + + + + + +SelectorContainer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Interface SelectorContainer

          +
          +
          All Known Implementing Classes:
          AbstractFileSet, AbstractSelectorContainer, AndSelector, Apt, ArchiveFileSet, BaseSelectorContainer, BCFileSet, Cab, Checksum, ClassfileSet, Copydir, Delete, Depend, DependSet, DirSet, Ear, EjbJar, Files, FileSet, FixCRLF, Image, IsFileSelected, Jar, Javac, Javadoc.TagArgument, JlinkTask, JspC, LibFileSet, MajoritySelector, MatchingTask, Native2Ascii, NetRexxC, NoneSelector, NotSelector, OrSelector, RenameExtensions, Replace, Rmic, SelectSelector, Sync.SyncTarget, Tar, Tar.TarFileSet, TarFileSet, Translate, War, WLJspc, XSLTProcess, Zip, ZipFileSet
          +
          +
          +
          +
          public interface SelectorContainer
          + + +

          +This is the interface for selectors that can contain other selectors. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileSelector selector) + +
          +          add an arbitary selector
          + voidaddAnd(AndSelector selector) + +
          +          add an "And" selector entry on the selector list
          + voidaddContains(ContainsSelector selector) + +
          +          add a contains selector entry on the selector list
          + voidaddContainsRegexp(ContainsRegexpSelector selector) + +
          +          add a regular expression selector entry on the selector list
          + voidaddCustom(ExtendSelector selector) + +
          +          add an extended selector entry on the selector list
          + voidaddDate(DateSelector selector) + +
          +          add a selector date entry on the selector list
          + voidaddDepend(DependSelector selector) + +
          +          add a depends selector entry on the selector list
          + voidaddDepth(DepthSelector selector) + +
          +          add a depth selector entry on the selector list
          + voidaddDifferent(DifferentSelector selector) + +
          +          add the different selector
          + voidaddFilename(FilenameSelector selector) + +
          +          add a selector filename entry on the selector list
          + voidaddMajority(MajoritySelector selector) + +
          +          add a majority selector entry on the selector list
          + voidaddModified(ModifiedSelector selector) + +
          +          add the modified selector
          + voidaddNone(NoneSelector selector) + +
          +          add a "None" selector entry on the selector list
          + voidaddNot(NotSelector selector) + +
          +          add a "Not" selector entry on the selector list
          + voidaddOr(OrSelector selector) + +
          +          add an "Or" selector entry on the selector list
          + voidaddPresent(PresentSelector selector) + +
          +          add a present selector entry on the selector list
          + voidaddSelector(SelectSelector selector) + +
          +          add a "Select" selector entry on the selector list
          + voidaddSize(SizeSelector selector) + +
          +          add a selector size entry on the selector list
          + voidaddType(TypeSelector selector) + +
          +          add the type selector
          + voidappendSelector(FileSelector selector) + +
          +          Add a new selector into this container.
          + FileSelector[]getSelectors(Project p) + +
          +          Returns the set of selectors as an array.
          + booleanhasSelectors() + +
          +          Indicates whether there are any selectors here.
          + intselectorCount() + +
          +          Gives the count of the number of selectors in this container
          + java.util.EnumerationselectorElements() + +
          +          Returns an enumerator for accessing the set of selectors.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +hasSelectors

          +
          +boolean hasSelectors()
          +
          +
          Indicates whether there are any selectors here. +

          +

          + +
          Returns:
          whether any selectors are in this container
          +
          +
          +
          + +

          +selectorCount

          +
          +int selectorCount()
          +
          +
          Gives the count of the number of selectors in this container +

          +

          + +
          Returns:
          the number of selectors in this container
          +
          +
          +
          + +

          +getSelectors

          +
          +FileSelector[] getSelectors(Project p)
          +
          +
          Returns the set of selectors as an array. +

          +

          +
          Parameters:
          p - the current project +
          Returns:
          an array of selectors in this container
          +
          +
          +
          + +

          +selectorElements

          +
          +java.util.Enumeration selectorElements()
          +
          +
          Returns an enumerator for accessing the set of selectors. +

          +

          + +
          Returns:
          an enumerator that goes through each of the selectors
          +
          +
          +
          + +

          +appendSelector

          +
          +void appendSelector(FileSelector selector)
          +
          +
          Add a new selector into this container. +

          +

          +
          Parameters:
          selector - the new selector to add
          +
          +
          +
          + +

          +addSelector

          +
          +void addSelector(SelectSelector selector)
          +
          +
          add a "Select" selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addAnd

          +
          +void addAnd(AndSelector selector)
          +
          +
          add an "And" selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addOr

          +
          +void addOr(OrSelector selector)
          +
          +
          add an "Or" selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNot

          +
          +void addNot(NotSelector selector)
          +
          +
          add a "Not" selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addNone

          +
          +void addNone(NoneSelector selector)
          +
          +
          add a "None" selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addMajority

          +
          +void addMajority(MajoritySelector selector)
          +
          +
          add a majority selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDate

          +
          +void addDate(DateSelector selector)
          +
          +
          add a selector date entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addSize

          +
          +void addSize(SizeSelector selector)
          +
          +
          add a selector size entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addFilename

          +
          +void addFilename(FilenameSelector selector)
          +
          +
          add a selector filename entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addCustom

          +
          +void addCustom(ExtendSelector selector)
          +
          +
          add an extended selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContains

          +
          +void addContains(ContainsSelector selector)
          +
          +
          add a contains selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addPresent

          +
          +void addPresent(PresentSelector selector)
          +
          +
          add a present selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepth

          +
          +void addDepth(DepthSelector selector)
          +
          +
          add a depth selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addDepend

          +
          +void addDepend(DependSelector selector)
          +
          +
          add a depends selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addContainsRegexp

          +
          +void addContainsRegexp(ContainsRegexpSelector selector)
          +
          +
          add a regular expression selector entry on the selector list +

          +

          +
          Parameters:
          selector - the selector to add
          +
          +
          +
          + +

          +addType

          +
          +void addType(TypeSelector selector)
          +
          +
          add the type selector +

          +

          +
          Parameters:
          selector - the selector to add
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +addDifferent

          +
          +void addDifferent(DifferentSelector selector)
          +
          +
          add the different selector +

          +

          +
          Parameters:
          selector - the selector to add
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +addModified

          +
          +void addModified(ModifiedSelector selector)
          +
          +
          add the modified selector +

          +

          +
          Parameters:
          selector - the selector to add
          Since:
          +
          ant 1.6
          +
          +
          +
          +
          + +

          +add

          +
          +void add(FileSelector selector)
          +
          +
          add an arbitary selector +

          +

          +
          Parameters:
          selector - the selector to add
          Since:
          +
          Ant 1.6
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorScanner.html new file mode 100644 index 000000000..963353f84 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorScanner.html @@ -0,0 +1,259 @@ + + + + + + +SelectorScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Interface SelectorScanner

          +
          +
          All Known Implementing Classes:
          ArchiveScanner, DependScanner, DirectoryScanner, FTP.FTPDirectoryScanner, FTPTaskMirrorImpl.FTPDirectoryScanner, TarScanner, ZipScanner
          +
          +
          +
          +
          public interface SelectorScanner
          + + +

          +An interface used to describe the actions required by any type of + directory scanner that supports Selecters. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getDeselectedDirectories() + +
          +          Directories which were selected out of a scan.
          + java.lang.String[]getDeselectedFiles() + +
          +          Files which were selected out of a scan.
          + voidsetSelectors(FileSelector[] selectors) + +
          +          Sets the selectors the scanner should use.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setSelectors

          +
          +void setSelectors(FileSelector[] selectors)
          +
          +
          Sets the selectors the scanner should use. +

          +

          +
          Parameters:
          selectors - the list of selectors
          +
          +
          +
          + +

          +getDeselectedDirectories

          +
          +java.lang.String[] getDeselectedDirectories()
          +
          +
          Directories which were selected out of a scan. +

          +

          + +
          Returns:
          list of directories not selected
          +
          +
          +
          + +

          +getDeselectedFiles

          +
          +java.lang.String[] getDeselectedFiles()
          +
          +
          Files which were selected out of a scan. +

          +

          + +
          Returns:
          list of files not selected
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorUtils.html new file mode 100644 index 000000000..23f88d6ab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SelectorUtils.html @@ -0,0 +1,680 @@ + + + + + + +SelectorUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SelectorUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.SelectorUtils
+
          +
          +
          +
          public final class SelectorUtils
          extends java.lang.Object
          + + +

          +

          This is a utility class used by selectors and DirectoryScanner. The + functionality more properly belongs just to selectors, but unfortunately + DirectoryScanner exposed these as protected methods. Thus we have to + support any subclasses of DirectoryScanner that may access these methods. +

          +

          This is a Singleton.

          +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEEP_TREE_MATCH + +
          +          The pattern that matches an arbitrary number of directories.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static SelectorUtilsgetInstance() + +
          +          Retrieves the instance of the Singleton.
          +static booleanhasWildcards(java.lang.String input) + +
          +          Tests if a string contains stars or question marks
          +static booleanisOutOfDate(java.io.File src, + java.io.File target, + int granularity) + +
          +          Returns dependency information on these two files.
          +static booleanisOutOfDate(Resource src, + Resource target, + int granularity) + +
          +          Returns dependency information on these two resources.
          +static booleanisOutOfDate(Resource src, + Resource target, + long granularity) + +
          +          Returns dependency information on these two resources.
          +static booleanmatch(java.lang.String pattern, + java.lang.String str) + +
          +          Tests whether or not a string matches against a pattern.
          +static booleanmatch(java.lang.String pattern, + java.lang.String str, + boolean caseSensitive) + +
          +          Tests whether or not a string matches against a pattern.
          +static booleanmatchPath(java.lang.String pattern, + java.lang.String str) + +
          +          Tests whether or not a given path matches a given pattern.
          +static booleanmatchPath(java.lang.String pattern, + java.lang.String str, + boolean isCaseSensitive) + +
          +          Tests whether or not a given path matches a given pattern.
          +static booleanmatchPatternStart(java.lang.String pattern, + java.lang.String str) + +
          +          Tests whether or not a given path matches the start of a given + pattern up to the first "**".
          +static booleanmatchPatternStart(java.lang.String pattern, + java.lang.String str, + boolean isCaseSensitive) + +
          +          Tests whether or not a given path matches the start of a given + pattern up to the first "**".
          +static java.lang.StringremoveWhitespace(java.lang.String input) + +
          +          "Flattens" a string by removing all whitespace (space, tab, linefeed, + carriage return, and formfeed).
          +static java.lang.StringrtrimWildcardTokens(java.lang.String input) + +
          +          removes from a pattern all tokens to the right containing wildcards
          +static java.util.VectortokenizePath(java.lang.String path) + +
          +          Breaks a path up into a Vector of path elements, tokenizing on + File.separator.
          +static java.util.VectortokenizePath(java.lang.String path, + java.lang.String separator) + +
          +          Breaks a path up into a Vector of path elements, tokenizing on
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEEP_TREE_MATCH

          +
          +public static final java.lang.String DEEP_TREE_MATCH
          +
          +
          The pattern that matches an arbitrary number of directories. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getInstance

          +
          +public static SelectorUtils getInstance()
          +
          +
          Retrieves the instance of the Singleton. +

          +

          + +
          Returns:
          singleton instance
          +
          +
          +
          + +

          +matchPatternStart

          +
          +public static boolean matchPatternStart(java.lang.String pattern,
+                                        java.lang.String str)
          +
          +
          Tests whether or not a given path matches the start of a given + pattern up to the first "**". +

          + This is not a general purpose test and should only be used if you + can live with false positives. For example, pattern=**\a + and str=b will yield true. +

          +

          +
          Parameters:
          pattern - The pattern to match against. Must not be + null.
          str - The path to match, as a String. Must not be + null. +
          Returns:
          whether or not a given path matches the start of a given + pattern up to the first "**".
          +
          +
          +
          + +

          +matchPatternStart

          +
          +public static boolean matchPatternStart(java.lang.String pattern,
+                                        java.lang.String str,
+                                        boolean isCaseSensitive)
          +
          +
          Tests whether or not a given path matches the start of a given + pattern up to the first "**". +

          + This is not a general purpose test and should only be used if you + can live with false positives. For example, pattern=**\a + and str=b will yield true. +

          +

          +
          Parameters:
          pattern - The pattern to match against. Must not be + null.
          str - The path to match, as a String. Must not be + null.
          isCaseSensitive - Whether or not matching should be performed + case sensitively. +
          Returns:
          whether or not a given path matches the start of a given + pattern up to the first "**".
          +
          +
          +
          + +

          +matchPath

          +
          +public static boolean matchPath(java.lang.String pattern,
+                                java.lang.String str)
          +
          +
          Tests whether or not a given path matches a given pattern. + + If you need to call this method multiple times with the same + pattern you should rather use TokenizedPath +

          +

          +
          Parameters:
          pattern - The pattern to match against. Must not be + null.
          str - The path to match, as a String. Must not be + null. +
          Returns:
          true if the pattern matches against the string, + or false otherwise.
          See Also:
          TokenizedPath
          +
          +
          +
          + +

          +matchPath

          +
          +public static boolean matchPath(java.lang.String pattern,
+                                java.lang.String str,
+                                boolean isCaseSensitive)
          +
          +
          Tests whether or not a given path matches a given pattern. + + If you need to call this method multiple times with the same + pattern you should rather use TokenizedPattern +

          +

          +
          Parameters:
          pattern - The pattern to match against. Must not be + null.
          str - The path to match, as a String. Must not be + null.
          isCaseSensitive - Whether or not matching should be performed + case sensitively. +
          Returns:
          true if the pattern matches against the string, + or false otherwise.
          See Also:
          TokenizedPattern
          +
          +
          +
          + +

          +match

          +
          +public static boolean match(java.lang.String pattern,
+                            java.lang.String str)
          +
          +
          Tests whether or not a string matches against a pattern. + The pattern may contain two special characters:
          + '*' means zero or more characters
          + '?' means one and only one character +

          +

          +
          Parameters:
          pattern - The pattern to match against. + Must not be null.
          str - The string which must be matched against the pattern. + Must not be null. +
          Returns:
          true if the string matches against the pattern, + or false otherwise.
          +
          +
          +
          + +

          +match

          +
          +public static boolean match(java.lang.String pattern,
+                            java.lang.String str,
+                            boolean caseSensitive)
          +
          +
          Tests whether or not a string matches against a pattern. + The pattern may contain two special characters:
          + '*' means zero or more characters
          + '?' means one and only one character +

          +

          +
          Parameters:
          pattern - The pattern to match against. + Must not be null.
          str - The string which must be matched against the pattern. + Must not be null.
          caseSensitive - Whether or not matching should be performed + case sensitively. +
          Returns:
          true if the string matches against the pattern, + or false otherwise.
          +
          +
          +
          + +

          +tokenizePath

          +
          +public static java.util.Vector tokenizePath(java.lang.String path)
          +
          +
          Breaks a path up into a Vector of path elements, tokenizing on + File.separator. +

          +

          +
          Parameters:
          path - Path to tokenize. Must not be null. +
          Returns:
          a Vector of path elements from the tokenized path
          +
          +
          +
          + +

          +tokenizePath

          +
          +public static java.util.Vector tokenizePath(java.lang.String path,
+                                            java.lang.String separator)
          +
          +
          Breaks a path up into a Vector of path elements, tokenizing on +

          +

          +
          Parameters:
          path - Path to tokenize. Must not be null.
          separator - the separator against which to tokenize. +
          Returns:
          a Vector of path elements from the tokenized path
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +isOutOfDate

          +
          +public static boolean isOutOfDate(java.io.File src,
+                                  java.io.File target,
+                                  int granularity)
          +
          +
          Returns dependency information on these two files. If src has been + modified later than target, it returns true. If target doesn't exist, + it likewise returns true. Otherwise, target is newer than src and + is not out of date, thus the method returns false. It also returns + false if the src file doesn't even exist, since how could the + target then be out of date. +

          +

          +
          Parameters:
          src - the original file
          target - the file being compared against
          granularity - the amount in seconds of slack we will give in + determining out of dateness +
          Returns:
          whether the target is out of date
          +
          +
          +
          + +

          +isOutOfDate

          +
          +public static boolean isOutOfDate(Resource src,
+                                  Resource target,
+                                  int granularity)
          +
          +
          Returns dependency information on these two resources. If src has been + modified later than target, it returns true. If target doesn't exist, + it likewise returns true. Otherwise, target is newer than src and + is not out of date, thus the method returns false. It also returns + false if the src file doesn't even exist, since how could the + target then be out of date. +

          +

          +
          Parameters:
          src - the original resource
          target - the resource being compared against
          granularity - the int amount in seconds of slack we will give in + determining out of dateness +
          Returns:
          whether the target is out of date
          +
          +
          +
          + +

          +isOutOfDate

          +
          +public static boolean isOutOfDate(Resource src,
+                                  Resource target,
+                                  long granularity)
          +
          +
          Returns dependency information on these two resources. If src has been + modified later than target, it returns true. If target doesn't exist, + it likewise returns true. Otherwise, target is newer than src and + is not out of date, thus the method returns false. It also returns + false if the src file doesn't even exist, since how could the + target then be out of date. +

          +

          +
          Parameters:
          src - the original resource
          target - the resource being compared against
          granularity - the long amount in seconds of slack we will give in + determining out of dateness +
          Returns:
          whether the target is out of date
          +
          +
          +
          + +

          +removeWhitespace

          +
          +public static java.lang.String removeWhitespace(java.lang.String input)
          +
          +
          "Flattens" a string by removing all whitespace (space, tab, linefeed, + carriage return, and formfeed). This uses StringTokenizer and the + default set of tokens as documented in the single arguement constructor. +

          +

          +
          Parameters:
          input - a String to remove all whitespace. +
          Returns:
          a String that has had all whitespace removed.
          +
          +
          +
          + +

          +hasWildcards

          +
          +public static boolean hasWildcards(java.lang.String input)
          +
          +
          Tests if a string contains stars or question marks +

          +

          +
          Parameters:
          input - a String which one wants to test for containing wildcard +
          Returns:
          true if the string contains at least a star or a question mark
          +
          +
          +
          + +

          +rtrimWildcardTokens

          +
          +public static java.lang.String rtrimWildcardTokens(java.lang.String input)
          +
          +
          removes from a pattern all tokens to the right containing wildcards +

          +

          +
          Parameters:
          input - the input string +
          Returns:
          the leftmost part of the pattern without wildcards
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SignedSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SignedSelector.html new file mode 100644 index 000000000..a47ef49b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SignedSelector.html @@ -0,0 +1,340 @@ + + + + + + +SignedSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SignedSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.SignedSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, FileSelector
          +
          +
          +
          +
          public class SignedSelector
          extends DataType
          implements FileSelector
          + + +

          +Selector that chooses files based on whether they are signed or not. +

          + +

          +

          +
          Since:
          +
          1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SignedSelector() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetName(java.lang.String name) + +
          +          The signature name to check jarfile for.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SignedSelector

          +
          +public SignedSelector()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          The signature name to check jarfile for. +

          +

          +
          +
          +
          +
          Parameters:
          name - signature to look for.
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          +
          +
          +
          Parameters:
          basedir - not used by this selector
          filename - not used by this selector
          file - path to file to be selected +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html new file mode 100644 index 000000000..13423e3e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html @@ -0,0 +1,304 @@ + + + + + + +SizeSelector.ByteUnits (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SizeSelector.ByteUnits

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.SizeSelector.ByteUnits
+
          +
          +
          Enclosing class:
          SizeSelector
          +
          +
          +
          +
          public static class SizeSelector.ByteUnits
          extends EnumeratedAttribute
          + + +

          +Enumerated attribute with the values for units. +

          + This treats the standard SI units as representing powers of ten, + as they should. If you want the powers of 2 that approximate + the SI units, use the first two characters followed by a + bi. So 1024 (2^10) becomes kibi, + 1048576 (2^20) becomes mebi, 1073741824 (2^30) + becomes gibi, and so on. The symbols are also + accepted, and these are the first letter capitalized followed + by an i. Ki, Mi, + Gi, and so on. Capitalization variations on these + are also accepted. +

          + This binary prefix system is approved by the IEC and appears on + its way for approval by other agencies, but it is not an SI + standard. It disambiguates things for us, though. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          SizeSelector.ByteUnits() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SizeSelector.ByteUnits

          +
          +public SizeSelector.ByteUnits()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the values as an array of strings
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html new file mode 100644 index 000000000..adeea0c8b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html @@ -0,0 +1,273 @@ + + + + + + +SizeSelector.SizeComparisons (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SizeSelector.SizeComparisons

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.Comparison
+          extended by org.apache.tools.ant.types.selectors.SizeSelector.SizeComparisons
+
          +
          +
          Enclosing class:
          SizeSelector
          +
          +
          +
          +
          public static class SizeSelector.SizeComparisons
          extends Comparison
          + + +

          +Enumerated attribute with the values for size comparison. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.Comparison
          EQUAL, GREATER, GREATER_EQUAL, LESS, LESS_EQUAL, NOT_EQUAL
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          SizeSelector.SizeComparisons() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Comparison
          evaluate, getValues
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SizeSelector.SizeComparisons

          +
          +public SizeSelector.SizeComparisons()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.html new file mode 100644 index 000000000..c56902a07 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.html @@ -0,0 +1,615 @@ + + + + + + +SizeSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class SizeSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.SizeSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class SizeSelector
          extends BaseExtendSelector
          + + +

          +Selector that filters files based on their size. +

          + +

          +

          +
          Since:
          +
          1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classSizeSelector.ByteUnits + +
          +          Enumerated attribute with the values for units.
          +static classSizeSelector.SizeComparisons + +
          +          Enumerated attribute with the values for size comparison.
          +  + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringSIZE_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringUNITS_KEY + +
          +          Used for parameterized custom selector
          +static java.lang.StringWHEN_KEY + +
          +          Used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          SizeSelector() + +
          +          Creates a new SizeSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetUnits(SizeSelector.ByteUnits units) + +
          +          Sets the units to use for the comparison.
          + voidsetValue(long size) + +
          +          A size selector needs to know what size to base its selecting on.
          + voidsetWhen(SizeSelector.SizeComparisons when) + +
          +          This specifies when the file should be selected, whether it be + when the file matches a particular size, when it is smaller, + or whether it is larger.
          + java.lang.StringtoString() + +
          +          Returns a String object representing the specified + SizeSelector.
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +SIZE_KEY

          +
          +public static final java.lang.String SIZE_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UNITS_KEY

          +
          +public static final java.lang.String UNITS_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WHEN_KEY

          +
          +public static final java.lang.String WHEN_KEY
          +
          +
          Used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SizeSelector

          +
          +public SizeSelector()
          +
          +
          Creates a new SizeSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Returns a String object representing the specified + SizeSelector. This is "{sizeselector value: " + <"compare", + "less", "more", "equal"> + "}". +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setValue

          +
          +public void setValue(long size)
          +
          +
          A size selector needs to know what size to base its selecting on. + This will be further modified by the multiplier to get an + actual size limit. +

          +

          +
          Parameters:
          size - the size to select against expressed in units.
          +
          +
          +
          + +

          +setUnits

          +
          +public void setUnits(SizeSelector.ByteUnits units)
          +
          +
          Sets the units to use for the comparison. This is a little + complicated because common usage has created standards that + play havoc with capitalization rules. Thus, some people will + use "K" for indicating 1000's, when the SI standard calls for + "k". Others have tried to introduce "K" as a multiple of 1024, + but that falls down when you reach "M", since "m" is already + defined as 0.001. +

          + To get around this complexity, a number of standards bodies + have proposed the 2^10 standard, and at least one has adopted + it. But we are still left with a populace that isn't clear on + how capitalization should work. +

          + We therefore ignore capitalization as much as possible. + Completely mixed case is not possible, but all upper and lower + forms are accepted for all long and short forms. Since we have + no need to work with the 0.001 case, this practice works here. +

          + This function translates all the long and short forms that a + unit prefix can occur in and translates them into a single + multiplier. +

          +

          +
          Parameters:
          units - The units to compare the size to, using an + EnumeratedAttribute.
          +
          +
          +
          + +

          +setWhen

          +
          +public void setWhen(SizeSelector.SizeComparisons when)
          +
          +
          This specifies when the file should be selected, whether it be + when the file matches a particular size, when it is smaller, + or whether it is larger. +

          +

          +
          Parameters:
          when - The comparison to perform, an EnumeratedAttribute.
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector.
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +

          Checks to make sure all settings are kosher. In this case, it + means that the size attribute has been set (to a positive value), + that the multiplier has a valid setting, and that the size limit + is valid. Since the latter is a calculated value, this can only + fail due to a programming error. +

          +

          If a problem is detected, the setError() method is called. +

          +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory.
          filename - The name of the file to check.
          file - A File object for this filename. +
          Returns:
          whether the file should be selected or not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPath.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPath.html new file mode 100644 index 000000000..1025aca74 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPath.html @@ -0,0 +1,461 @@ + + + + + + +TokenizedPath (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class TokenizedPath

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.TokenizedPath
+
          +
          +
          +
          public class TokenizedPath
          extends java.lang.Object
          + + +

          +Container for a path that has been split into its components. +

          + +

          +

          +
          Since:
          +
          1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static TokenizedPathEMPTY_PATH + +
          +          Instance that holds no tokens at all.
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          TokenizedPath(java.lang.String path) + +
          +          Initialize the TokenizedPath by parsing it.
          TokenizedPath(TokenizedPath parent, + java.lang.String child) + +
          +          Creates a new path as a child of another path.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intdepth() + +
          +          The depth (or length) of a path.
          + booleanequals(java.lang.Object o) + +
          +          true if the original paths are equal.
          + java.io.FilefindFile(java.io.File base, + boolean cs) + +
          +          From base traverse the filesystem in order to find + a file that matches the given name.
          + inthashCode() + +
          +           
          + booleanisSymlink(java.io.File base) + +
          +          Do we have to traverse a symlink when trying to reach path from + basedir?
          + TokenizedPatterntoPattern() + +
          +          Creates a TokenizedPattern from the same tokens that make up + this path.
          + java.lang.StringtoString() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EMPTY_PATH

          +
          +public static final TokenizedPath EMPTY_PATH
          +
          +
          Instance that holds no tokens at all. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TokenizedPath

          +
          +public TokenizedPath(java.lang.String path)
          +
          +
          Initialize the TokenizedPath by parsing it. +

          +

          +
          Parameters:
          path - The path to tokenize. Must not be + null.
          +
          +
          + +

          +TokenizedPath

          +
          +public TokenizedPath(TokenizedPath parent,
+                     java.lang.String child)
          +
          +
          Creates a new path as a child of another path. +

          +

          +
          Parameters:
          parent - the parent path
          child - the child, must not contain the file separator
          +
          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          The original path String
          +
          +
          +
          + +

          +depth

          +
          +public int depth()
          +
          +
          The depth (or length) of a path. +

          +

          +
          +
          +
          +
          + +

          +findFile

          +
          +public java.io.File findFile(java.io.File base,
+                             boolean cs)
          +
          +
          From base traverse the filesystem in order to find + a file that matches the given name. +

          +

          +
          Parameters:
          base - base File (dir).
          cs - whether to scan case-sensitively. +
          Returns:
          File object that points to the file in question or null.
          +
          +
          +
          + +

          +isSymlink

          +
          +public boolean isSymlink(java.io.File base)
          +
          +
          Do we have to traverse a symlink when trying to reach path from + basedir? +

          +

          +
          Parameters:
          base - base File (dir).
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          true if the original paths are equal. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          +
          +
          +
          +
          + +

          +toPattern

          +
          +public TokenizedPattern toPattern()
          +
          +
          Creates a TokenizedPattern from the same tokens that make up + this path. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPattern.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPattern.html new file mode 100644 index 000000000..7a53fbf66 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TokenizedPattern.html @@ -0,0 +1,531 @@ + + + + + + +TokenizedPattern (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class TokenizedPattern

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.TokenizedPattern
+
          +
          +
          +
          public class TokenizedPattern
          extends java.lang.Object
          + + +

          +Provides reusable path pattern matching. PathPattern is preferable + to equivalent SelectorUtils methods if you need to execute multiple + matching with the same pattern because here the pattern itself will + be parsed only once. +

          + +

          +

          +
          Since:
          +
          1.8.0
          +
          See Also:
          SelectorUtils.matchPath(String, String), +SelectorUtils.matchPath(String, String, boolean)
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static TokenizedPatternEMPTY_PATTERN + +
          +          Instance that holds no tokens at all.
          +  + + + + + + + + + + +
          +Constructor Summary
          TokenizedPattern(java.lang.String pattern) + +
          +          Initialize the PathPattern by parsing it.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleancontainsPattern(java.lang.String pat) + +
          +          Does the tokenized pattern contain the given string?
          + intdepth() + +
          +          The depth (or length) of a pattern.
          + booleanendsWith(java.lang.String s) + +
          +          true if the last token equals the given string.
          + booleanequals(java.lang.Object o) + +
          +          true if the original patterns are equal.
          + java.lang.StringgetPattern() + +
          +           
          + inthashCode() + +
          +           
          + booleanmatchPath(TokenizedPath path, + boolean isCaseSensitive) + +
          +          Tests whether or not a given path matches a given pattern.
          + booleanmatchStartOf(TokenizedPath path, + boolean caseSensitive) + +
          +          Tests whether or not this pattern matches the start of + a path.
          + TokenizedPathrtrimWildcardTokens() + +
          +          Returns a new TokenizedPath where all tokens of this pattern to + the right containing wildcards have been removed
          + java.lang.StringtoString() + +
          +           
          + TokenizedPatternwithoutLastToken() + +
          +          Returns a new pattern without the last token of this pattern.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EMPTY_PATTERN

          +
          +public static final TokenizedPattern EMPTY_PATTERN
          +
          +
          Instance that holds no tokens at all. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TokenizedPattern

          +
          +public TokenizedPattern(java.lang.String pattern)
          +
          +
          Initialize the PathPattern by parsing it. +

          +

          +
          Parameters:
          pattern - The pattern to match against. Must not be + null.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +matchPath

          +
          +public boolean matchPath(TokenizedPath path,
+                         boolean isCaseSensitive)
          +
          +
          Tests whether or not a given path matches a given pattern. +

          +

          +
          Parameters:
          path - The path to match, as a String. Must not be + null.
          isCaseSensitive - Whether or not matching should be performed + case sensitively. +
          Returns:
          true if the pattern matches against the string, + or false otherwise.
          +
          +
          +
          + +

          +matchStartOf

          +
          +public boolean matchStartOf(TokenizedPath path,
+                            boolean caseSensitive)
          +
          +
          Tests whether or not this pattern matches the start of + a path. +

          +

          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          The pattern String
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern()
          +
          +
          +
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          true if the original patterns are equal. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          +
          +
          +
          +
          + +

          +depth

          +
          +public int depth()
          +
          +
          The depth (or length) of a pattern. +

          +

          +
          +
          +
          +
          + +

          +containsPattern

          +
          +public boolean containsPattern(java.lang.String pat)
          +
          +
          Does the tokenized pattern contain the given string? +

          +

          +
          +
          +
          +
          + +

          +rtrimWildcardTokens

          +
          +public TokenizedPath rtrimWildcardTokens()
          +
          +
          Returns a new TokenizedPath where all tokens of this pattern to + the right containing wildcards have been removed +

          +

          + +
          Returns:
          the leftmost part of the pattern without wildcards
          +
          +
          +
          + +

          +endsWith

          +
          +public boolean endsWith(java.lang.String s)
          +
          +
          true if the last token equals the given string. +

          +

          +
          +
          +
          +
          + +

          +withoutLastToken

          +
          +public TokenizedPattern withoutLastToken()
          +
          +
          Returns a new pattern without the last token of this pattern. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.FileType.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.FileType.html new file mode 100644 index 000000000..aa07545b2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.FileType.html @@ -0,0 +1,338 @@ + + + + + + +TypeSelector.FileType (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class TypeSelector.FileType

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.TypeSelector.FileType
+
          +
          +
          Enclosing class:
          TypeSelector
          +
          +
          +
          +
          public static class TypeSelector.FileType
          extends EnumeratedAttribute
          + + +

          +Enumerated attribute with the values for types of file +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDIR + +
          +          the string value for dir
          +static java.lang.StringFILE + +
          +          the string value for file
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          TypeSelector.FileType() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +FILE

          +
          +public static final java.lang.String FILE
          +
          +
          the string value for file +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DIR

          +
          +public static final java.lang.String DIR
          +
          +
          the string value for dir +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TypeSelector.FileType

          +
          +public TypeSelector.FileType()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          Description copied from class: EnumeratedAttribute
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          the values as an array of strings
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.html new file mode 100644 index 000000000..988eb96dd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/TypeSelector.html @@ -0,0 +1,490 @@ + + + + + + +TypeSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class TypeSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.TypeSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Parameterizable, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class TypeSelector
          extends BaseExtendSelector
          + + +

          +Selector that selects a certain kind of file: directory or regular. +

          + +

          +

          +
          Since:
          +
          1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classTypeSelector.FileType + +
          +          Enumerated attribute with the values for types of file
          +  + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringTYPE_KEY + +
          +          Key to used for parameterized custom selector
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          TypeSelector() + +
          +          Creates a new TypeSelector instance.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          The heart of the matter.
          + voidsetParameters(Parameter[] parameters) + +
          +          When using this as a custom selector, this method will be called.
          + voidsetType(TypeSelector.FileType fileTypes) + +
          +          Set the type of file to require.
          + java.lang.StringtoString() + +
          +          Basic DataType toString().
          + voidverifySettings() + +
          +          Checks to make sure all settings are kosher.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +TYPE_KEY

          +
          +public static final java.lang.String TYPE_KEY
          +
          +
          Key to used for parameterized custom selector +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TypeSelector

          +
          +public TypeSelector()
          +
          +
          Creates a new TypeSelector instance. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Description copied from class: DataType
          +
          Basic DataType toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          a string describing this object
          +
          +
          +
          + +

          +setType

          +
          +public void setType(TypeSelector.FileType fileTypes)
          +
          +
          Set the type of file to require. +

          +

          +
          Parameters:
          fileTypes - the type of file - file or dir
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          When using this as a custom selector, this method will be called. + It translates each parameter into the appropriate setXXX() call. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the complete set of parameters for this selector
          +
          +
          +
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Checks to make sure all settings are kosher. In this case, it + means that the pattern attribute has been set. +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          The heart of the matter. This is where the selector gets to decide + on the inclusion of a file in a particular fileset. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - the base directory the scan is being done from
          filename - is the name of the file to check
          file - is a java.io.File object the selector can use +
          Returns:
          whether the file should be selected or not
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/WritableSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/WritableSelector.html new file mode 100644 index 000000000..d1c9b138f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/WritableSelector.html @@ -0,0 +1,303 @@ + + + + + + +WritableSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors +
          +Class WritableSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.WritableSelector
+
          +
          +
          All Implemented Interfaces:
          ResourceSelector, FileSelector
          +
          +
          +
          +
          public class WritableSelector
          extends java.lang.Object
          implements FileSelector, ResourceSelector
          + + +

          +A selector that selects writable files. + +

          Writable is definied in terms of java.io.File#canWrite, this + means the selector will accept any file that exists and is + writable by the application.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          WritableSelector() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Method that each selector will implement to create their + selection behaviour.
          + booleanisSelected(Resource r) + +
          +          Return true if this Resource is selected.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +WritableSelector

          +
          +public WritableSelector()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Description copied from interface: FileSelector
          +
          Method that each selector will implement to create their + selection behaviour. If there is a problem with the setup + of a selector, it can throw a BuildException to indicate + the problem. +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          +
          +
          +
          Parameters:
          basedir - A java.io.File object for the base directory
          filename - The name of the file to check
          file - A File object for this filename +
          Returns:
          whether the file should be selected or not
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource r)
          +
          +
          Description copied from interface: ResourceSelector
          +
          Return true if this Resource is selected. +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          r - the Resource to check. +
          Returns:
          whether the Resource was selected.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Algorithm.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Algorithm.html new file mode 100644 index 000000000..243ea877e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Algorithm.html @@ -0,0 +1,242 @@ + + + + + + +Algorithm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Interface Algorithm

          +
          +
          All Known Implementing Classes:
          ChecksumAlgorithm, DigestAlgorithm, HashvalueAlgorithm
          +
          +
          +
          +
          public interface Algorithm
          + + +

          +The Algorithm defines how a value for a file is computed. + It must be sure that multiple calls for the same file results in the + same value. + The implementing class should implement a useful toString() method. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2003-09-13
          +
          +
          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetValue(java.io.File file) + +
          +          Get the value for a file.
          + booleanisValid() + +
          +          Checks its prerequisites.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +isValid

          +
          +boolean isValid()
          +
          +
          Checks its prerequisites. +

          +

          + +
          Returns:
          true if all is ok, otherwise false.
          +
          +
          +
          + +

          +getValue

          +
          +java.lang.String getValue(java.io.File file)
          +
          +
          Get the value for a file. +

          +

          +
          Parameters:
          file - File object for which the value should be evaluated. +
          Returns:
          The value for that file
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Cache.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Cache.html new file mode 100644 index 000000000..7211387b7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/Cache.html @@ -0,0 +1,352 @@ + + + + + + +Cache (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Interface Cache

          +
          +
          All Known Implementing Classes:
          PropertiesfileCache
          +
          +
          +
          +
          public interface Cache
          + + +

          +A Cache let the user store key-value-pairs in a permanent manner and access + them. + It is possible that a client uses get() before load() therefore the + implementation must ensure that no error occurred because of the wrong + order. + The implementing class should implement a useful toString() method. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2003-09-13
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voiddelete() + +
          +          Deletes the cache.
          + java.lang.Objectget(java.lang.Object key) + +
          +          Returns a value for a given key from the cache.
          + booleanisValid() + +
          +          Checks its prerequisites.
          + java.util.Iteratoriterator() + +
          +          Returns an iterator over the keys in the cache.
          + voidload() + +
          +          Loads the cache, must handle not existing cache.
          + voidput(java.lang.Object key, + java.lang.Object value) + +
          +          Saves a key-value-pair in the cache.
          + voidsave() + +
          +          Saves modification of the cache.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +isValid

          +
          +boolean isValid()
          +
          +
          Checks its prerequisites. +

          +

          + +
          Returns:
          true if all is ok, otherwise false.
          +
          +
          +
          + +

          +delete

          +
          +void delete()
          +
          +
          Deletes the cache. If file based the file has to be deleted also. +

          +

          +
          +
          +
          +
          + +

          +load

          +
          +void load()
          +
          +
          Loads the cache, must handle not existing cache. +

          +

          +
          +
          +
          +
          + +

          +save

          +
          +void save()
          +
          +
          Saves modification of the cache. +

          +

          +
          +
          +
          +
          + +

          +get

          +
          +java.lang.Object get(java.lang.Object key)
          +
          +
          Returns a value for a given key from the cache. +

          +

          +
          Parameters:
          key - the key +
          Returns:
          the stored value
          +
          +
          +
          + +

          +put

          +
          +void put(java.lang.Object key,
+         java.lang.Object value)
          +
          +
          Saves a key-value-pair in the cache. +

          +

          +
          Parameters:
          key - the key
          value - the value
          +
          +
          +
          + +

          +iterator

          +
          +java.util.Iterator iterator()
          +
          +
          Returns an iterator over the keys in the cache. +

          +

          + +
          Returns:
          An iterator over the keys.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.html new file mode 100644 index 000000000..ebae04ade --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ChecksumAlgorithm.html @@ -0,0 +1,379 @@ + + + + + + +ChecksumAlgorithm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class ChecksumAlgorithm

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.modifiedselector.ChecksumAlgorithm
+
          +
          +
          All Implemented Interfaces:
          Algorithm
          +
          +
          +
          +
          public class ChecksumAlgorithm
          extends java.lang.Object
          implements Algorithm
          + + +

          +Computes a 'checksum' for the content of file using + java.util.zip.CRC32 and java.util.zip.Adler32. + Use of this algorithm doesn't require any additional nested s. + Supported s are: + + + + + + + + + + +
          namevaluesdescriptionrequired
          algorithm.algorithm ADLER | CRC ( default ) name of the algorithm the checksum should use no, defaults to CRC
          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          Version:
          +
          2004-06-17
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ChecksumAlgorithm() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetValue(java.io.File file) + +
          +          Computes a value for a file content with the specified checksum algorithm.
          + voidinitChecksum() + +
          +          Initialize the checksum interface.
          + booleanisValid() + +
          +          This algorithm supports only CRC and Adler.
          + voidsetAlgorithm(java.lang.String algorithm) + +
          +          Specifies the algorithm to be used to compute the checksum.
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ChecksumAlgorithm

          +
          +public ChecksumAlgorithm()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setAlgorithm

          +
          +public void setAlgorithm(java.lang.String algorithm)
          +
          +
          Specifies the algorithm to be used to compute the checksum. + Defaults to "CRC". Other popular algorithms like "ADLER" may be used as well. +

          +

          +
          +
          +
          +
          Parameters:
          algorithm - the digest algorithm to use
          +
          +
          +
          + +

          +initChecksum

          +
          +public void initChecksum()
          +
          +
          Initialize the checksum interface. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +isValid

          +
          +public boolean isValid()
          +
          +
          This algorithm supports only CRC and Adler. +

          +

          +
          Specified by:
          isValid in interface Algorithm
          +
          +
          + +
          Returns:
          true if all is ok, otherwise false.
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue(java.io.File file)
          +
          +
          Computes a value for a file content with the specified checksum algorithm. +

          +

          +
          Specified by:
          getValue in interface Algorithm
          +
          +
          +
          Parameters:
          file - File object for which the value should be evaluated. +
          Returns:
          The value for that file
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          some information about this algorithm.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.html new file mode 100644 index 000000000..7df3236ce --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/DigestAlgorithm.html @@ -0,0 +1,411 @@ + + + + + + +DigestAlgorithm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class DigestAlgorithm

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.modifiedselector.DigestAlgorithm
+
          +
          +
          All Implemented Interfaces:
          Algorithm
          +
          +
          +
          +
          public class DigestAlgorithm
          extends java.lang.Object
          implements Algorithm
          + + +

          +Computes a 'hashvalue' for the content of file using + java.security.MessageDigest. + Use of this algorithm doesn't require any additional nested s. + Supported s are: + + + + + + + + + + + + + + + + +
          namevaluesdescriptionrequired
          algorithm.algorithm MD5 | SHA (default provider) name of the algorithm the provider should use no, defaults to MD5
          algorithm.provider name of the provider to use no, defaults to null
          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2004-07-08
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          DigestAlgorithm() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetValue(java.io.File file) + +
          +          Computes a value for a file content with the specified digest algorithm.
          + voidinitMessageDigest() + +
          +          Initialize the security message digest.
          + booleanisValid() + +
          +          This algorithm supports only MD5 and SHA.
          + voidsetAlgorithm(java.lang.String algorithm) + +
          +          Specifies the algorithm to be used to compute the checksum.
          + voidsetProvider(java.lang.String provider) + +
          +          Sets the MessageDigest algorithm provider to be used + to calculate the checksum.
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DigestAlgorithm

          +
          +public DigestAlgorithm()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setAlgorithm

          +
          +public void setAlgorithm(java.lang.String algorithm)
          +
          +
          Specifies the algorithm to be used to compute the checksum. + Defaults to "MD5". Other popular algorithms like "SHA" may be used as well. +

          +

          +
          +
          +
          +
          Parameters:
          algorithm - the digest algorithm to use
          +
          +
          +
          + +

          +setProvider

          +
          +public void setProvider(java.lang.String provider)
          +
          +
          Sets the MessageDigest algorithm provider to be used + to calculate the checksum. +

          +

          +
          +
          +
          +
          Parameters:
          provider - provider to use
          +
          +
          +
          + +

          +initMessageDigest

          +
          +public void initMessageDigest()
          +
          +
          Initialize the security message digest. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +isValid

          +
          +public boolean isValid()
          +
          +
          This algorithm supports only MD5 and SHA. +

          +

          +
          Specified by:
          isValid in interface Algorithm
          +
          +
          + +
          Returns:
          true if all is ok, otherwise false.
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue(java.io.File file)
          +
          +
          Computes a value for a file content with the specified digest algorithm. +

          +

          +
          Specified by:
          getValue in interface Algorithm
          +
          +
          +
          Parameters:
          file - File object for which the value should be evaluated. +
          Returns:
          The value for that file
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          some information about this algorithm.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/EqualComparator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/EqualComparator.html new file mode 100644 index 000000000..fe969707d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/EqualComparator.html @@ -0,0 +1,304 @@ + + + + + + +EqualComparator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class EqualComparator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.modifiedselector.EqualComparator
+
          +
          +
          All Implemented Interfaces:
          java.util.Comparator
          +
          +
          +
          +
          public class EqualComparator
          extends java.lang.Object
          implements java.util.Comparator
          + + +

          +Simple implementation of Comparator for use in CacheSelector. + compare() returns '0' (should not be selected) if both parameter + are equal otherwise '1' (should be selected). +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2003-09-13
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          EqualComparator() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + intcompare(java.lang.Object o1, + java.lang.Object o2) + +
          +          Implements Comparator.compare().
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface java.util.Comparator
          equals
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +EqualComparator

          +
          +public EqualComparator()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +compare

          +
          +public int compare(java.lang.Object o1,
+                   java.lang.Object o2)
          +
          +
          Implements Comparator.compare(). +

          +

          +
          Specified by:
          compare in interface java.util.Comparator
          +
          +
          +
          Parameters:
          o1 - the first object
          o2 - the second object +
          Returns:
          0, if both are equal, otherwise 1
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          information about this comparator
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.html new file mode 100644 index 000000000..65feab55d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/HashvalueAlgorithm.html @@ -0,0 +1,321 @@ + + + + + + +HashvalueAlgorithm (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class HashvalueAlgorithm

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.modifiedselector.HashvalueAlgorithm
+
          +
          +
          All Implemented Interfaces:
          Algorithm
          +
          +
          +
          +
          public class HashvalueAlgorithm
          extends java.lang.Object
          implements Algorithm
          + + +

          +Computes a 'hashvalue' for the content of file using String.hashValue(). + Use of this algorithm doesn't require any additional nested s and + doesn't support any. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2003-09-13
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          HashvalueAlgorithm() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetValue(java.io.File file) + +
          +          Computes a 'hashvalue' for a file content.
          + booleanisValid() + +
          +          This algorithm doesn't need any configuration.
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +HashvalueAlgorithm

          +
          +public HashvalueAlgorithm()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isValid

          +
          +public boolean isValid()
          +
          +
          This algorithm doesn't need any configuration. + Therefore it's always valid. +

          +

          +
          Specified by:
          isValid in interface Algorithm
          +
          +
          + +
          Returns:
          always true
          +
          +
          +
          + +

          +getValue

          +
          +public java.lang.String getValue(java.io.File file)
          +
          +
          Computes a 'hashvalue' for a file content. + It reads the content of a file, convert that to String and use the + String.hashCode() method. +

          +

          +
          Specified by:
          getValue in interface Algorithm
          +
          +
          +
          Parameters:
          file - The file for which the value should be computed +
          Returns:
          the hashvalue or null if the file couldn't be read
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          information about this comparator
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.AlgorithmName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.AlgorithmName.html new file mode 100644 index 000000000..2909f2bf9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.AlgorithmName.html @@ -0,0 +1,291 @@ + + + + + + +ModifiedSelector.AlgorithmName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class ModifiedSelector.AlgorithmName

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.AlgorithmName
+
          +
          +
          Enclosing class:
          ModifiedSelector
          +
          +
          +
          +
          public static class ModifiedSelector.AlgorithmName
          extends EnumeratedAttribute
          + + +

          +The enumerated type for algorithm. + The values are "hashValue", "digest" and "checksum". +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          ModifiedSelector.AlgorithmName() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ModifiedSelector.AlgorithmName

          +
          +public ModifiedSelector.AlgorithmName()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          See Also:
          EnumeratedAttribute.getValues()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.CacheName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.CacheName.html new file mode 100644 index 000000000..ffd6f06d5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.CacheName.html @@ -0,0 +1,291 @@ + + + + + + +ModifiedSelector.CacheName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class ModifiedSelector.CacheName

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.CacheName
+
          +
          +
          Enclosing class:
          ModifiedSelector
          +
          +
          +
          +
          public static class ModifiedSelector.CacheName
          extends EnumeratedAttribute
          + + +

          +The enumerated type for cache. + The values are "propertyfile". +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          ModifiedSelector.CacheName() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ModifiedSelector.CacheName

          +
          +public ModifiedSelector.CacheName()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          See Also:
          EnumeratedAttribute.getValues()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.ComparatorName.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.ComparatorName.html new file mode 100644 index 000000000..4b1cc7ac1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.ComparatorName.html @@ -0,0 +1,291 @@ + + + + + + +ModifiedSelector.ComparatorName (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class ModifiedSelector.ComparatorName

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.EnumeratedAttribute
+      extended by org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector.ComparatorName
+
          +
          +
          Enclosing class:
          ModifiedSelector
          +
          +
          +
          +
          public static class ModifiedSelector.ComparatorName
          extends EnumeratedAttribute
          + + +

          +The enumerated type for algorithm. + The values are "equal" and "rule". +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          value
          +  + + + + + + + + + + +
          +Constructor Summary
          ModifiedSelector.ComparatorName() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getValues() + +
          +          This is the only method a subclass needs to implement.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.EnumeratedAttribute
          containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ModifiedSelector.ComparatorName

          +
          +public ModifiedSelector.ComparatorName()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getValues

          +
          +public java.lang.String[] getValues()
          +
          +
          This is the only method a subclass needs to implement. +

          +

          +
          Specified by:
          getValues in class EnumeratedAttribute
          +
          +
          + +
          Returns:
          an array holding all possible values of the enumeration. + The order of elements must be fixed so that indexOfValue(String) + always return the same index for the same value.
          See Also:
          EnumeratedAttribute.getValues()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.html new file mode 100644 index 000000000..4d2c2ea12 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/ModifiedSelector.html @@ -0,0 +1,1413 @@ + + + + + + +ModifiedSelector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class ModifiedSelector

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.DataType
+          extended by org.apache.tools.ant.types.selectors.BaseSelector
+              extended by org.apache.tools.ant.types.selectors.BaseExtendSelector
+                  extended by org.apache.tools.ant.types.selectors.modifiedselector.ModifiedSelector
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, java.util.EventListener, BuildListener, Parameterizable, ResourceSelector, ExtendFileSelector, FileSelector
          +
          +
          +
          +
          public class ModifiedSelector
          extends BaseExtendSelector
          implements BuildListener, ResourceSelector
          + + +

          +

          Selector class that uses Algorithm, Cache and Comparator + for its work. + The Algorithm is used for computing a hashvalue for a file. + The Comparator decides whether to select or not. + The Cache stores the other value for comparison by the Comparator + in a persistent manner.

          + +

          The ModifiedSelector is implemented as a CoreSelector and uses default + values for all its attributes therefore the simpliest example is 

          +   <copy todir="dest">
+       <filelist dir="src">
+           <modified/>
+       </filelist>
+   </copy>
+

          + +

          The same example rewritten as CoreSelector with setting the all values + (same as defaults are) would be 

          +   <copy todir="dest">
+       <filelist dir="src">
+           <modified update="true"
+                     cache="propertyfile"
+                     algorithm="digest"
+                     comparator="equal">
+               <param name="cache.cachefile"     value="cache.properties"/>
+               <param name="algorithm.algorithm" value="MD5"/>
+           </modified>
+       </filelist>
+   </copy>
+

          + +

          And the same rewritten as CustomSelector would be

          +   <copy todir="dest">
+       <filelist dir="src">
+           <custom class="org.apache.tools.ant.type.selectors.ModifiedSelector">
+               <param name="update"     value="true"/>
+               <param name="cache"      value="propertyfile"/>
+               <param name="algorithm"  value="digest"/>
+               <param name="comparator" value="equal"/>
+               <param name="cache.cachefile"     value="cache.properties"/>
+               <param name="algorithm.algorithm" value="MD5"/>
+           </custom>
+       </filelist>
+   </copy>
+

          + +

          If you want to provide your own interface implementation you can do + that via the *classname attributes. If the classes are not on Ant's core + classpath, you will have to provide the path via nested <classpath> + element, so that the selector can find the classes. 

          +   <modified cacheclassname="com.mycompany.MyCache">
+       <classpath>
+           <pathelement location="lib/mycompony-antutil.jar"/>
+       </classpath>
+   </modified>
+

          + +

          All these three examples copy the files from src to dest + using the ModifiedSelector. The ModifiedSelector uses the PropertyfileCache + , the DigestAlgorithm and the EqualComparator for its + work. The PropertyfileCache stores key-value-pairs in a simple java + properties file. The filename is cache.properties. The update + flag lets the selector update the values in the cache (and on first call + creates the cache). The DigestAlgorithm computes a hashvalue using the + java.security.MessageDigest class with its MD5-Algorithm and its standard + provider. The new computed hashvalue and the stored one are compared by + the EqualComparator which returns 'true' (more correct a value not + equals zero (1)) if the values are not the same using simple String + comparison.

          + +

          A useful scenario for this selector is inside a build environment + for homepage generation (e.g. with + Apache Forrest). 

          + <target name="generate-and-upload-site">
+     <echo> generate the site using forrest </echo>
+     <antcall target="site"/>
+
+     <echo> upload the changed files </echo>
+     <ftp server="${ftp.server}" userid="${ftp.user}" password="${ftp.pwd}">
+         <fileset dir="htdocs/manual">
+             <modified/>
+         </fileset>
+     </ftp>
+ </target>
+
          Here all changed files are uploaded to the server. The + ModifiedSelector saves therefore much upload time.

          + + +

          This selector uses reflection for setting the values of its three interfaces + (using org.apache.tools.ant.IntrospectionHelper) therefore no special + 'configuration interfaces' has to be implemented by new caches, algorithms or + comparators. All present setXX methods can be used. E.g. the DigestAlgorithm + can use a specified provider for computing its value. For selecting this + there is a setProvider(String providername) method. So you can use + a nested <param name="algorithm.provider" value="MyProvider"/>. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Nested Class Summary
          +static classModifiedSelector.AlgorithmName + +
          +          The enumerated type for algorithm.
          +static classModifiedSelector.CacheName + +
          +          The enumerated type for cache.
          +static classModifiedSelector.ComparatorName + +
          +          The enumerated type for algorithm.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          parameters
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.types.DataType
          checked, ref
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ModifiedSelector() + +
          +          Bean-Constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddClasspath(Path path) + +
          +          Add the classpath.
          + voidaddParam(Parameter parameter) + +
          +          Support for nested <param> tags.
          + voidaddParam(java.lang.String key, + java.lang.Object value) + +
          +          Support for nested <param> tags.
          + voidbuildFinished(BuildEvent event) + +
          +          Signals that the last target has finished.
          + voidbuildStarted(BuildEvent event) + +
          +          Signals that a build has started.
          + voidconfigure() + +
          +          Configures this Selector.
          + AlgorithmgetAlgorithm() + +
          +          Get the algorithm type to use.
          + CachegetCache() + +
          +          Get the cache type to use.
          + java.lang.ClassLoadergetClassLoader() + +
          +          Returns and initializes the classloader for this class.
          + java.util.ComparatorgetComparator() + +
          +          Get the comparator type to use.
          + booleangetDelayUpdate() + +
          +          Getter for the delay update
          + intgetModified() + +
          +          Getter for the modified count
          + booleanisSelected(java.io.File basedir, + java.lang.String filename, + java.io.File file) + +
          +          Implementation of BaseExtendSelector.isSelected().
          + booleanisSelected(Resource resource) + +
          +          Implementation of ResourceSelector.isSelected().
          +protected  java.lang.ObjectloadClass(java.lang.String classname, + java.lang.String msg, + java.lang.Class type) + +
          +          Loads the specified class and initializes an object of that class.
          + voidmessageLogged(BuildEvent event) + +
          +          Signals a message logging event.
          +protected  voidsaveCache() + +
          +          save the cache file
          + voidsetAlgorithm(ModifiedSelector.AlgorithmName name) + +
          +          Set the algorithm type to use.
          + voidsetAlgorithmClass(java.lang.String classname) + +
          +          Setter for algorithmClass.
          + voidsetCache(ModifiedSelector.CacheName name) + +
          +          Set the cache type to use.
          + voidsetCacheClass(java.lang.String classname) + +
          +          Setter for cacheClass.
          + voidsetClassLoader(java.lang.ClassLoader loader) + +
          +          Set the used ClassLoader.
          + voidsetComparator(ModifiedSelector.ComparatorName name) + +
          +          Set the comparator type to use.
          + voidsetComparatorClass(java.lang.String classname) + +
          +          Setter for comparatorClass.
          + voidsetDelayUpdate(boolean delayUpdate) + +
          +          Setter for the delay update
          + voidsetModified(int modified) + +
          +          Setter for the modified count
          + voidsetParameters(Parameter[] parameters) + +
          +          Defined in org.apache.tools.ant.types.Parameterizable.
          + voidsetSeldirs(boolean seldirs) + +
          +          Support for seldirs attribute.
          + voidsetSelres(boolean newValue) + +
          +          Support for selres attribute.
          + voidsetUpdate(boolean update) + +
          +          Support for update attribute.
          + voidtargetFinished(BuildEvent event) + +
          +          Signals that a target has finished.
          + voidtargetStarted(BuildEvent event) + +
          +          Signals that a target is starting.
          + voidtaskFinished(BuildEvent event) + +
          +          Signals that a task has finished.
          + voidtaskStarted(BuildEvent event) + +
          +          Signals that a task is starting.
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +protected  voidtryToSetAParameter(java.lang.Object obj, + java.lang.String name, + java.lang.String value) + +
          +          Try to set a value on an object using reflection.
          + voiduseParameter(Parameter parameter) + +
          +          Support for nested tags.
          + voidverifySettings() + +
          +          Overrides BaseSelector.verifySettings().
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
          getParameters
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
          getError, setError, validate
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.DataType
          checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ModifiedSelector

          +
          +public ModifiedSelector()
          +
          +
          Bean-Constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +verifySettings

          +
          +public void verifySettings()
          +
          +
          Overrides BaseSelector.verifySettings(). +

          +

          +
          Overrides:
          verifySettings in class BaseSelector
          +
          +
          +
          +
          +
          +
          + +

          +configure

          +
          +public void configure()
          +
          +
          Configures this Selector. + Does this work only once per Selector object. +

          Because some problems while configuring from Selector + the configuration is done in the following order:

            +
          1. collect the configuration data
            2. +
          2. wait for the first isSelected() call
            3. +
          3. set the default values
            4. +
          4. set values for name pattern '*': update, cache, algorithm, comparator
            5. +
          5. set values for name pattern '*.*: cache.cachefile, ...
            6. +

          +

          This configuration algorithm is needed because you don't know + the order of arriving config-data. E.g. if you first set the + cache.cachefilename and after that the cache itself, + the default value for cachefilename is used, because setting the + cache implies creating a new Cache instance - with its defaults.

          +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +loadClass

          +
          +protected java.lang.Object loadClass(java.lang.String classname,
+                                     java.lang.String msg,
+                                     java.lang.Class type)
          +
          +
          Loads the specified class and initializes an object of that class. + Throws a BuildException using the given message if an error occurs during + loading/instantiation or if the object is not from the given type. +

          +

          +
          +
          +
          +
          Parameters:
          classname - the classname
          msg - the message-part for the BuildException
          type - the type to check against +
          Returns:
          a castable object
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(Resource resource)
          +
          +
          Implementation of ResourceSelector.isSelected(). +

          +

          +
          Specified by:
          isSelected in interface ResourceSelector
          +
          +
          +
          Parameters:
          resource - The resource to check +
          Returns:
          whether the resource is selected
          See Also:
          ResourceSelector.isSelected(Resource)
          +
          +
          +
          + +

          +isSelected

          +
          +public boolean isSelected(java.io.File basedir,
+                          java.lang.String filename,
+                          java.io.File file)
          +
          +
          Implementation of BaseExtendSelector.isSelected(). +

          +

          +
          Specified by:
          isSelected in interface FileSelector
          Specified by:
          isSelected in class BaseExtendSelector
          +
          +
          +
          Parameters:
          basedir - as described in BaseExtendSelector
          filename - as described in BaseExtendSelector
          file - as described in BaseExtendSelector +
          Returns:
          as described in BaseExtendSelector
          +
          +
          +
          + +

          +saveCache

          +
          +protected void saveCache()
          +
          +
          save the cache file +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +setAlgorithmClass

          +
          +public void setAlgorithmClass(java.lang.String classname)
          +
          +
          Setter for algorithmClass. +

          +

          +
          +
          +
          +
          Parameters:
          classname - new value
          +
          +
          +
          + +

          +setComparatorClass

          +
          +public void setComparatorClass(java.lang.String classname)
          +
          +
          Setter for comparatorClass. +

          +

          +
          +
          +
          +
          Parameters:
          classname - new value
          +
          +
          +
          + +

          +setCacheClass

          +
          +public void setCacheClass(java.lang.String classname)
          +
          +
          Setter for cacheClass. +

          +

          +
          +
          +
          +
          Parameters:
          classname - new value
          +
          +
          +
          + +

          +setUpdate

          +
          +public void setUpdate(boolean update)
          +
          +
          Support for update attribute. +

          +

          +
          +
          +
          +
          Parameters:
          update - new value
          +
          +
          +
          + +

          +setSeldirs

          +
          +public void setSeldirs(boolean seldirs)
          +
          +
          Support for seldirs attribute. +

          +

          +
          +
          +
          +
          Parameters:
          seldirs - new value
          +
          +
          +
          + +

          +setSelres

          +
          +public void setSelres(boolean newValue)
          +
          +
          Support for selres attribute. +

          +

          +
          +
          +
          +
          Parameters:
          newValue - the new value
          +
          +
          +
          + +

          +getModified

          +
          +public int getModified()
          +
          +
          Getter for the modified count +

          +

          +
          +
          +
          + +
          Returns:
          modified count
          +
          +
          +
          + +

          +setModified

          +
          +public void setModified(int modified)
          +
          +
          Setter for the modified count +

          +

          +
          +
          +
          +
          Parameters:
          modified - count
          +
          +
          +
          + +

          +getDelayUpdate

          +
          +public boolean getDelayUpdate()
          +
          +
          Getter for the delay update +

          +

          +
          +
          +
          + +
          Returns:
          true if we should delay for performance
          +
          +
          +
          + +

          +setDelayUpdate

          +
          +public void setDelayUpdate(boolean delayUpdate)
          +
          +
          Setter for the delay update +

          +

          +
          +
          +
          +
          Parameters:
          delayUpdate - true if we should delay for performance
          +
          +
          +
          + +

          +addClasspath

          +
          +public void addClasspath(Path path)
          +
          +
          Add the classpath. +

          +

          +
          +
          +
          +
          Parameters:
          path - the classpath
          +
          +
          +
          + +

          +getClassLoader

          +
          +public java.lang.ClassLoader getClassLoader()
          +
          +
          Returns and initializes the classloader for this class. +

          +

          +
          +
          +
          + +
          Returns:
          the classloader
          +
          +
          +
          + +

          +setClassLoader

          +
          +public void setClassLoader(java.lang.ClassLoader loader)
          +
          +
          Set the used ClassLoader. + If you invoke this selector by API (e.g. inside some testcases) the selector + will use a different classloader for loading the interface implementations than + the caller. Therefore you will get a ClassCastException if you get the + implementations from the selector and cast them. +

          +

          +
          +
          +
          +
          Parameters:
          loader - the ClassLoader to use
          +
          +
          +
          + +

          +addParam

          +
          +public void addParam(java.lang.String key,
+                     java.lang.Object value)
          +
          +
          Support for nested <param> tags. +

          +

          +
          +
          +
          +
          Parameters:
          key - the key of the parameter
          value - the value of the parameter
          +
          +
          +
          + +

          +addParam

          +
          +public void addParam(Parameter parameter)
          +
          +
          Support for nested <param> tags. +

          +

          +
          +
          +
          +
          Parameters:
          parameter - the parameter object
          +
          +
          +
          + +

          +setParameters

          +
          +public void setParameters(Parameter[] parameters)
          +
          +
          Defined in org.apache.tools.ant.types.Parameterizable. + Overwrite implementation in superclass because only special + parameters are valid. +

          +

          +
          Specified by:
          setParameters in interface Parameterizable
          Overrides:
          setParameters in class BaseExtendSelector
          +
          +
          +
          Parameters:
          parameters - the parameters to set.
          See Also:
          addParam(String,Object).
          +
          +
          +
          + +

          +useParameter

          +
          +public void useParameter(Parameter parameter)
          +
          +
          Support for nested tags. + Parameter named cache, algorithm, + comparator or update are mapped to + the respective set-Method. + Parameter which names starts with cache. or + algorithm. or comparator. are tried + to set on the appropriate object via its set-methods. + Other parameters are invalid and an BuildException will + be thrown. +

          +

          +
          +
          +
          +
          Parameters:
          parameter - Key and value as parameter object
          +
          +
          +
          + +

          +tryToSetAParameter

          +
          +protected void tryToSetAParameter(java.lang.Object obj,
+                                  java.lang.String name,
+                                  java.lang.String value)
          +
          +
          Try to set a value on an object using reflection. + Helper method for easier access to IntrospectionHelper.setAttribute(). +

          +

          +
          +
          +
          +
          Parameters:
          obj - the object on which the attribute should be set
          name - the attributename
          value - the new value
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class DataType
          +
          +
          + +
          Returns:
          information about this selector
          +
          +
          +
          + +

          +buildFinished

          +
          +public void buildFinished(BuildEvent event)
          +
          +
          Signals that the last target has finished. +

          +

          +
          Specified by:
          buildFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +targetFinished

          +
          +public void targetFinished(BuildEvent event)
          +
          +
          Signals that a target has finished. +

          +

          +
          Specified by:
          targetFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +taskFinished

          +
          +public void taskFinished(BuildEvent event)
          +
          +
          Signals that a task has finished. +

          +

          +
          Specified by:
          taskFinished in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          See Also:
          BuildEvent.getException()
          +
          +
          +
          + +

          +buildStarted

          +
          +public void buildStarted(BuildEvent event)
          +
          +
          Signals that a build has started. +

          +

          +
          Specified by:
          buildStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          +
          +
          +
          + +

          +targetStarted

          +
          +public void targetStarted(BuildEvent event)
          +
          +
          Signals that a target is starting. +

          +

          +
          Specified by:
          targetStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - received BuildEvent
          See Also:
          BuildEvent.getTarget()
          +
          +
          +
          + +

          +taskStarted

          +
          +public void taskStarted(BuildEvent event)
          +
          +
          Signals that a task is starting. +

          +

          +
          Specified by:
          taskStarted in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          See Also:
          BuildEvent.getTask()
          +
          +
          +
          + +

          +messageLogged

          +
          +public void messageLogged(BuildEvent event)
          +
          +
          Signals a message logging event. +

          +

          +
          Specified by:
          messageLogged in interface BuildListener
          +
          +
          +
          Parameters:
          event - recieved BuildEvent
          See Also:
          BuildEvent.getMessage(), +BuildEvent.getException(), +BuildEvent.getPriority()
          +
          +
          +
          + +

          +getCache

          +
          +public Cache getCache()
          +
          +
          Get the cache type to use. +

          +

          +
          +
          +
          + +
          Returns:
          the enumerated cache type
          +
          +
          +
          + +

          +setCache

          +
          +public void setCache(ModifiedSelector.CacheName name)
          +
          +
          Set the cache type to use. +

          +

          +
          +
          +
          +
          Parameters:
          name - an enumerated cache type.
          +
          +
          +
          + +

          +getAlgorithm

          +
          +public Algorithm getAlgorithm()
          +
          +
          Get the algorithm type to use. +

          +

          +
          +
          +
          + +
          Returns:
          the enumerated algorithm type
          +
          +
          +
          + +

          +setAlgorithm

          +
          +public void setAlgorithm(ModifiedSelector.AlgorithmName name)
          +
          +
          Set the algorithm type to use. +

          +

          +
          +
          +
          +
          Parameters:
          name - an enumerated algorithm type.
          +
          +
          +
          + +

          +getComparator

          +
          +public java.util.Comparator getComparator()
          +
          +
          Get the comparator type to use. +

          +

          +
          +
          +
          + +
          Returns:
          the enumerated comparator type
          +
          +
          +
          + +

          +setComparator

          +
          +public void setComparator(ModifiedSelector.ComparatorName name)
          +
          +
          Set the comparator type to use. +

          +

          +
          +
          +
          +
          Parameters:
          name - an enumerated comparator type.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.html new file mode 100644 index 000000000..f556060ff --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/PropertiesfileCache.html @@ -0,0 +1,531 @@ + + + + + + +PropertiesfileCache (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.selectors.modifiedselector +
          +Class PropertiesfileCache

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.types.selectors.modifiedselector.PropertiesfileCache
+
          +
          +
          All Implemented Interfaces:
          Cache
          +
          +
          +
          +
          public class PropertiesfileCache
          extends java.lang.Object
          implements Cache
          + + +

          +Use java.util.Properties for storing the values. + The use of this Cache-implementation requires the use of the parameter + for defining, where to store the + properties file. + + The ModifiedSelector sets the cachefile to the default value + cache.properties. + + Supported s are: + + + + + + + + + + +
          namevaluesdescriptionrequired
          cache.cachefile path to file the name of the properties file yes
          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          Version:
          +
          2003-09-13
          +
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          PropertiesfileCache() + +
          +          Bean-Constructor.
          PropertiesfileCache(java.io.File cachefile) + +
          +          Constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voiddelete() + +
          +          Deletes the cache and its underlying file.
          + java.lang.Objectget(java.lang.Object key) + +
          +          Returns a value for a given key from the cache.
          + java.io.FilegetCachefile() + +
          +          Getter.
          + booleanisValid() + +
          +          This cache is valid if the cachefile is set.
          + java.util.Iteratoriterator() + +
          +          Returns an iterator over the keys in the cache.
          + voidload() + +
          +          Load the cache from underlying properties file.
          + voidput(java.lang.Object key, + java.lang.Object value) + +
          +          Saves a key-value-pair in the cache.
          + voidsave() + +
          +          Saves modification of the cache.
          + voidsetCachefile(java.io.File file) + +
          +          Setter.
          + java.lang.StringtoString() + +
          +          Override Object.toString().
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertiesfileCache

          +
          +public PropertiesfileCache()
          +
          +
          Bean-Constructor. +

          +

          +
          + +

          +PropertiesfileCache

          +
          +public PropertiesfileCache(java.io.File cachefile)
          +
          +
          Constructor. +

          +

          +
          Parameters:
          cachefile - set the cachefile
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setCachefile

          +
          +public void setCachefile(java.io.File file)
          +
          +
          Setter. +

          +

          +
          +
          +
          +
          Parameters:
          file - new value
          +
          +
          +
          + +

          +getCachefile

          +
          +public java.io.File getCachefile()
          +
          +
          Getter. +

          +

          +
          +
          +
          + +
          Returns:
          the cachefile
          +
          +
          +
          + +

          +isValid

          +
          +public boolean isValid()
          +
          +
          This cache is valid if the cachefile is set. +

          +

          +
          Specified by:
          isValid in interface Cache
          +
          +
          + +
          Returns:
          true if all is ok false otherwise
          +
          +
          +
          + +

          +load

          +
          +public void load()
          +
          +
          Load the cache from underlying properties file. +

          +

          +
          Specified by:
          load in interface Cache
          +
          +
          +
          +
          +
          +
          + +

          +save

          +
          +public void save()
          +
          +
          Saves modification of the cache. + Cache is only saved if there is one ore more entries. + Because entries can not be deleted by this API, this Cache + implementation checks the existence of entries before creating the file + for performance optimisation. +

          +

          +
          Specified by:
          save in interface Cache
          +
          +
          +
          +
          +
          +
          + +

          +delete

          +
          +public void delete()
          +
          +
          Deletes the cache and its underlying file. +

          +

          +
          Specified by:
          delete in interface Cache
          +
          +
          +
          +
          +
          +
          + +

          +get

          +
          +public java.lang.Object get(java.lang.Object key)
          +
          +
          Returns a value for a given key from the cache. +

          +

          +
          Specified by:
          get in interface Cache
          +
          +
          +
          Parameters:
          key - the key +
          Returns:
          the stored value
          +
          +
          +
          + +

          +put

          +
          +public void put(java.lang.Object key,
+                java.lang.Object value)
          +
          +
          Saves a key-value-pair in the cache. +

          +

          +
          Specified by:
          put in interface Cache
          +
          +
          +
          Parameters:
          key - the key
          value - the value
          +
          +
          +
          + +

          +iterator

          +
          +public java.util.Iterator iterator()
          +
          +
          Returns an iterator over the keys in the cache. +

          +

          +
          Specified by:
          iterator in interface Cache
          +
          +
          + +
          Returns:
          An iterator over the keys.
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Override Object.toString(). +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          information about this cache
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-frame.html new file mode 100644 index 000000000..59ea89998 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-frame.html @@ -0,0 +1,61 @@ + + + + + + +org.apache.tools.ant.types.selectors.modifiedselector (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.selectors.modifiedselector + + + + +
          +Interfaces  + +
          +Algorithm +
          +Cache
          + + + + + + +
          +Classes  + +
          +ChecksumAlgorithm +
          +DigestAlgorithm +
          +EqualComparator +
          +HashvalueAlgorithm +
          +ModifiedSelector +
          +ModifiedSelector.AlgorithmName +
          +ModifiedSelector.CacheName +
          +ModifiedSelector.ComparatorName +
          +PropertiesfileCache
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-summary.html new file mode 100644 index 000000000..4ceca9b91 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-summary.html @@ -0,0 +1,206 @@ + + + + + + +org.apache.tools.ant.types.selectors.modifiedselector (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.selectors.modifiedselector +

          + + + + + + + + + + + + + +
          +Interface Summary
          AlgorithmThe Algorithm defines how a value for a file is computed.
          CacheA Cache let the user store key-value-pairs in a permanent manner and access + them.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          ChecksumAlgorithmComputes a 'checksum' for the content of file using + java.util.zip.CRC32 and java.util.zip.Adler32.
          DigestAlgorithmComputes a 'hashvalue' for the content of file using + java.security.MessageDigest.
          EqualComparatorSimple implementation of Comparator for use in CacheSelector.
          HashvalueAlgorithmComputes a 'hashvalue' for the content of file using String.hashValue().
          ModifiedSelectorSelector class that uses Algorithm, Cache and Comparator + for its work.
          ModifiedSelector.AlgorithmNameThe enumerated type for algorithm.
          ModifiedSelector.CacheNameThe enumerated type for cache.
          ModifiedSelector.ComparatorNameThe enumerated type for algorithm.
          PropertiesfileCacheUse java.util.Properties for storing the values.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-tree.html new file mode 100644 index 000000000..189e231ac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/modifiedselector/package-tree.html @@ -0,0 +1,172 @@ + + + + + + +org.apache.tools.ant.types.selectors.modifiedselector Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.selectors.modifiedselector +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          +
            +
          • org.apache.tools.ant.types.selectors.modifiedselector.Algorithm
          • org.apache.tools.ant.types.selectors.modifiedselector.Cache
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-frame.html new file mode 100644 index 000000000..f2e3a1a53 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-frame.html @@ -0,0 +1,113 @@ + + + + + + +org.apache.tools.ant.types.selectors (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.selectors + + + + +
          +Interfaces  + +
          +ExtendFileSelector +
          +FileSelector +
          +SelectorContainer +
          +SelectorScanner
          + + + + + + +
          +Classes  + +
          +AbstractSelectorContainer +
          +AndSelector +
          +BaseExtendSelector +
          +BaseSelector +
          +BaseSelectorContainer +
          +ContainsRegexpSelector +
          +ContainsSelector +
          +DateSelector +
          +DateSelector.TimeComparisons +
          +DependSelector +
          +DepthSelector +
          +DifferentSelector +
          +ExtendSelector +
          +FilenameSelector +
          +MajoritySelector +
          +MappingSelector +
          +NoneSelector +
          +NotSelector +
          +OrSelector +
          +PresentSelector +
          +PresentSelector.FilePresence +
          +ReadableSelector +
          +SelectorUtils +
          +SelectSelector +
          +SignedSelector +
          +SizeSelector +
          +SizeSelector.ByteUnits +
          +SizeSelector.SizeComparisons +
          +TokenizedPath +
          +TokenizedPattern +
          +TypeSelector +
          +TypeSelector.FileType +
          +WritableSelector
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-summary.html new file mode 100644 index 000000000..ec575537c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-summary.html @@ -0,0 +1,319 @@ + + + + + + +org.apache.tools.ant.types.selectors (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.selectors +

          + + + + + + + + + + + + + + + + + + + + + +
          +Interface Summary
          ExtendFileSelectorThis is the interface to be used by all custom selectors, those that are + called through the <custom> tag.
          FileSelectorThis is the interface to be used by all selectors.
          SelectorContainerThis is the interface for selectors that can contain other selectors.
          SelectorScannerAn interface used to describe the actions required by any type of + directory scanner that supports Selecters.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractSelectorContainerThis is the a base class a container of selectors - it does + not need do be a selector itself.
          AndSelectorThis selector has a collection of other selectors, all of which have to + select a file in order for this selector to select it.
          BaseExtendSelectorConvenience base class for all selectors accessed through ExtendSelector.
          BaseSelectorA convenience base class that you can subclass Selectors from.
          BaseSelectorContainerThis is the base class for selectors that can contain other selectors.
          ContainsRegexpSelectorSelector that filters files based on a regular expression.
          ContainsSelectorSelector that filters files/resources based on whether they contain a + particular string.
          DateSelectorSelector that chooses files based on their last modified date.
          DateSelector.TimeComparisonsEnumerated attribute with the values for time comparison.
          DependSelectorSelector that filters files based on whether they are newer than + a matching file in another directory tree.
          DepthSelectorSelector that filters files based on the how deep in the directory + tree they are.
          DifferentSelectorThis selector selects files against a mapped set of target files, selecting + all those files which are different.
          ExtendSelectorSelector that selects files by forwarding the request on to other classes.
          FilenameSelectorSelector that filters files based on the filename.
          MajoritySelectorThis selector is here just to shake up your thinking a bit.
          MappingSelectorA mapping selector is an abstract class adding mapping support to the base + selector
          NoneSelectorThis selector has a collection of other selectors.
          NotSelectorThis selector has one other selectors whose meaning it inverts.
          OrSelectorThis selector has a collection of other selectors, any of which have to + select a file in order for this selector to select it.
          PresentSelectorSelector that filters files based on whether they appear in another + directory tree.
          PresentSelector.FilePresenceEnumerated attribute with the values for indicating where a file's + presence is allowed and required.
          ReadableSelectorA selector that selects readable files.
          SelectorUtilsThis is a utility class used by selectors and DirectoryScanner.
          SelectSelectorThis selector just holds one other selector and forwards all + requests to it.
          SignedSelectorSelector that chooses files based on whether they are signed or not.
          SizeSelectorSelector that filters files based on their size.
          SizeSelector.ByteUnitsEnumerated attribute with the values for units.
          SizeSelector.SizeComparisonsEnumerated attribute with the values for size comparison.
          TokenizedPathContainer for a path that has been split into its components.
          TokenizedPatternProvides reusable path pattern matching.
          TypeSelectorSelector that selects a certain kind of file: directory or regular.
          TypeSelector.FileTypeEnumerated attribute with the values for types of file
          WritableSelectorA selector that selects writable files.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-tree.html new file mode 100644 index 000000000..794f82e7c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/selectors/package-tree.html @@ -0,0 +1,189 @@ + + + + + + +org.apache.tools.ant.types.selectors Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.selectors +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Provider.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Provider.html new file mode 100644 index 000000000..004b662a8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Provider.html @@ -0,0 +1,331 @@ + + + + + + +Provider (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.spi +
          +Class Provider

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.spi.Provider
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Provider
          extends ProjectComponent
          + + +

          +ANT Jar-Task SPI extension + This class corresponds to the nested element + <provider type="type"> in the <service type=""> + nested element of the jar task. +

          + +

          +

          +
          See Also:
          + http://issues.apache.org/bugzilla/show_bug.cgi?id=31520
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Provider() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidcheck() + +
          +          Check if the component has been configured correctly.
          + java.lang.StringgetClassName() + +
          +           
          + voidsetClassName(java.lang.String type) + +
          +          Set the provider classname.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Provider

          +
          +public Provider()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getClassName

          +
          +public java.lang.String getClassName()
          +
          +
          + +
          Returns:
          the class name for
          +
          +
          +
          + +

          +setClassName

          +
          +public void setClassName(java.lang.String type)
          +
          +
          Set the provider classname. +

          +

          +
          Parameters:
          type - the value to set.
          +
          +
          +
          + +

          +check

          +
          +public void check()
          +
          +
          Check if the component has been configured correctly. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Service.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Service.html new file mode 100644 index 000000000..1ada468e6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/Service.html @@ -0,0 +1,402 @@ + + + + + + +Service (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.types.spi +
          +Class Service

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.spi.Service
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class Service
          extends ProjectComponent
          + + +

          +ANT Jar-Task SPI extension +

          + +

          +

          +
          See Also:
          + http://issues.apache.org/bugzilla/show_bug.cgi?id=31520
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          Service() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddConfiguredProvider(Provider provider) + +
          +          Add a nested provider element.
          + voidcheck() + +
          +          Check if this object is configured correctly as a nested + element.
          + java.io.InputStreamgetAsStream() + +
          +          Return the implementations of this + services as an inputstream.
          + java.lang.StringgetType() + +
          +           
          + voidsetProvider(java.lang.String className) + +
          +          Set the provider classname.
          + voidsetType(java.lang.String type) + +
          +          Set the service type.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Service

          +
          +public Service()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProvider

          +
          +public void setProvider(java.lang.String className)
          +
          +
          Set the provider classname. +

          +

          +
          Parameters:
          className - the classname of a provider of this service.
          +
          +
          +
          + +

          +addConfiguredProvider

          +
          +public void addConfiguredProvider(Provider provider)
          +
          +
          Add a nested provider element. +

          +

          +
          Parameters:
          provider - a provider element.
          +
          +
          +
          + +

          +getType

          +
          +public java.lang.String getType()
          +
          +
          + +
          Returns:
          the service type.
          +
          +
          +
          + +

          +setType

          +
          +public void setType(java.lang.String type)
          +
          +
          Set the service type. +

          +

          +
          Parameters:
          type - the service type, a classname of + an interface or a class (normally + abstract).
          +
          +
          +
          + +

          +getAsStream

          +
          +public java.io.InputStream getAsStream()
+                                throws java.io.IOException
          +
          +
          Return the implementations of this + services as an inputstream. +

          +

          + +
          Returns:
          an inputstream of the classname names + encoded as UTF-8. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +check

          +
          +public void check()
          +
          +
          Check if this object is configured correctly as a nested + element. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-frame.html new file mode 100644 index 000000000..68ae32b52 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.types.spi (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.types.spi + + + + +
          +Classes  + +
          +Provider +
          +Service
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-summary.html new file mode 100644 index 000000000..bec4616aa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-summary.html @@ -0,0 +1,159 @@ + + + + + + +org.apache.tools.ant.types.spi (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.types.spi +

          + + + + + + + + + + + + + +
          +Class Summary
          ProviderANT Jar-Task SPI extension + This class corresponds to the nested element + <provider type="type"> in the <service type=""> + nested element of the jar task.
          ServiceANT Jar-Task SPI extension
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-tree.html new file mode 100644 index 000000000..4115e3cde --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/types/spi/package-tree.html @@ -0,0 +1,150 @@ + + + + + + +org.apache.tools.ant.types.spi Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.types.spi +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • org.apache.tools.ant.ProjectComponent (implements java.lang.Cloneable) +
                +
              • org.apache.tools.ant.types.spi.Provider
              • org.apache.tools.ant.types.spi.Service
              +
            +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Base64Converter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Base64Converter.html new file mode 100644 index 000000000..b969523a1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Base64Converter.html @@ -0,0 +1,319 @@ + + + + + + +Base64Converter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class Base64Converter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.Base64Converter
+
          +
          +
          Direct Known Subclasses:
          Get.Base64Converter
          +
          +
          +
          +
          public class Base64Converter
          extends java.lang.Object
          + + +

          +BASE 64 encoding of a String or an array of bytes. + + Based on RFC 1421. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static char[]alphabet + +
          +          Provided for BC purposes
          +  + + + + + + + + + + +
          +Constructor Summary
          Base64Converter() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Stringencode(byte[] octetString) + +
          +          Encode a byte array into base64 encoding.
          + java.lang.Stringencode(java.lang.String s) + +
          +          Encode a string into base64 encoding.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +alphabet

          +
          +public static final char[] alphabet
          +
          +
          Provided for BC purposes +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Base64Converter

          +
          +public Base64Converter()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +encode

          +
          +public java.lang.String encode(java.lang.String s)
          +
          +
          Encode a string into base64 encoding. +

          +

          +
          Parameters:
          s - the string to encode. +
          Returns:
          the encoded string.
          +
          +
          +
          + +

          +encode

          +
          +public java.lang.String encode(byte[] octetString)
          +
          +
          Encode a byte array into base64 encoding. +

          +

          +
          Parameters:
          octetString - the byte array to encode. +
          Returns:
          the encoded string.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ChainedMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ChainedMapper.html new file mode 100644 index 000000000..6f98846a7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ChainedMapper.html @@ -0,0 +1,278 @@ + + + + + + +ChainedMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ChainedMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ContainerMapper
+      extended by org.apache.tools.ant.util.ChainedMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class ChainedMapper
          extends ContainerMapper
          + + +

          +A ContainerMapper that chains the results of the first + nested FileNameMappers into sourcefiles for the second, + the second to the third, and so on, returning the resulting mapped + filenames from the last nested FileNameMapper. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ChainedMapper() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the + given source file..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ContainerMapper
          add, addConfigured, addConfiguredMapper, contains, getMappers, setFrom, setTo
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ChainedMapper

          +
          +public ChainedMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the + given source file. + +

          if the given rule doesn't apply to the source file, + implementation must return null. SourceFileScanner will then + omit the source file in question.

          . +

          +

          +
          Parameters:
          sourceFileName - the name of the source file relative to + some given basedirectory. +
          Returns:
          an array of strings if the ruld applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.Delegate.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.Delegate.html new file mode 100644 index 000000000..c2af14a9b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.Delegate.html @@ -0,0 +1,479 @@ + + + + + + +ClasspathUtils.Delegate (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ClasspathUtils.Delegate

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ClasspathUtils.Delegate
+
          +
          +
          Enclosing class:
          ClasspathUtils
          +
          +
          +
          +
          public static class ClasspathUtils.Delegate
          extends java.lang.Object
          + + +

          +Delegate that helps out any specific ProjectComponent that needs + dynamic classloading. + +

          Ant ProjectComponents that need a to be able to dynamically load + Classes and instantiate them often expose the following ant syntax + sugar:

          + +
          • nested <classpath>
            • +
          • attribute @classpathref
            • +
          • attribute @classname
          + +

          This class functions as a delegate handling the configuration + issues for this recurring pattern. Its usage pattern, as the name + suggests, is delegation rather than inheritance.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + PathcreateClasspath() + +
          +          Delegate method handling the <classpath> tag.
          + java.lang.ClassLoadergetClassLoader() + +
          +          Finds or creates the classloader for this object.
          + java.lang.StringgetClassLoadId() + +
          +          Computes the loaderId based on the configuration of the component.
          + PathgetClasspath() + +
          +          The classpath.
          + booleanisReverseLoader() + +
          +          Get the reverseLoader setting.
          + java.lang.ObjectnewInstance() + +
          +          Helper method obtaining a fresh instance of the class specified + in the @classname and using the specified classpath.
          + voidsetClassname(java.lang.String fcqn) + +
          +          Delegate method handling the @classname attribute.
          + voidsetClasspath(Path classpath) + +
          +          This method is a Delegate method handling the @classpath attribute.
          + voidsetClasspathref(Reference r) + +
          +          Delegate method handling the @classpathref attribute.
          + voidsetLoaderRef(Reference r) + +
          +          Sets the loaderRef.
          + voidsetReverseLoader(boolean reverseLoader) + +
          +          Delegate method handling the @reverseLoader attribute.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          This method is a Delegate method handling the @classpath attribute. + +

          This attribute can set a path to add to the classpath.

          +

          +

          +
          Parameters:
          classpath - the path to use for the classpath.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Delegate method handling the <classpath> tag. + +

          This nested path-like structure can set a path to add to the + classpath.

          +

          +

          + +
          Returns:
          the created path.
          +
          +
          +
          + +

          +setClassname

          +
          +public void setClassname(java.lang.String fcqn)
          +
          +
          Delegate method handling the @classname attribute. + +

          This attribute sets the full qualified class name of the class + to load and instantiate.

          +

          +

          +
          Parameters:
          fcqn - the name of the class to load.
          +
          +
          +
          + +

          +setClasspathref

          +
          +public void setClasspathref(Reference r)
          +
          +
          Delegate method handling the @classpathref attribute. + +

          This attribute can add a referenced path-like structure to the + classpath.

          +

          +

          +
          Parameters:
          r - the reference to the classpath.
          +
          +
          +
          + +

          +setReverseLoader

          +
          +public void setReverseLoader(boolean reverseLoader)
          +
          +
          Delegate method handling the @reverseLoader attribute. + +

          This attribute can set a boolean indicating that the used + classloader should NOT follow the classical parent-first scheme. +

          + +

          By default this is supposed to be false.

          + +

          Caution: this behaviour is contradictory to the normal way + classloaders work. Do not let your ProjectComponent use it if + you are not really sure.

          +

          +

          +
          Parameters:
          reverseLoader - if true reverse the order of looking up a class.
          +
          +
          +
          + +

          +setLoaderRef

          +
          +public void setLoaderRef(Reference r)
          +
          +
          Sets the loaderRef. +

          +

          +
          Parameters:
          r - the reference to the loader.
          +
          +
          +
          + +

          +getClassLoader

          +
          +public java.lang.ClassLoader getClassLoader()
          +
          +
          Finds or creates the classloader for this object. +

          +

          + +
          Returns:
          The class loader.
          +
          +
          +
          + +

          +getClassLoadId

          +
          +public java.lang.String getClassLoadId()
          +
          +
          Computes the loaderId based on the configuration of the component. +

          +

          + +
          Returns:
          a loader identifier.
          +
          +
          +
          + +

          +newInstance

          +
          +public java.lang.Object newInstance()
          +
          +
          Helper method obtaining a fresh instance of the class specified + in the @classname and using the specified classpath. +

          +

          + +
          Returns:
          the fresh instantiated object.
          +
          +
          +
          + +

          +getClasspath

          +
          +public Path getClasspath()
          +
          +
          The classpath. +

          +

          + +
          Returns:
          the classpath.
          +
          +
          +
          + +

          +isReverseLoader

          +
          +public boolean isReverseLoader()
          +
          +
          Get the reverseLoader setting. +

          +

          + +
          Returns:
          true if looking up in reverse order.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.html new file mode 100644 index 000000000..fc33bf6fc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ClasspathUtils.html @@ -0,0 +1,608 @@ + + + + + + +ClasspathUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ClasspathUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ClasspathUtils
+
          +
          +
          +
          public class ClasspathUtils
          extends java.lang.Object
          + + +

          +Offers some helper methods on the Path structure in ant. + +

          The basic idea behind this utility class is to use it from inside the + different Ant objects (and user defined objects) that need classLoading + for their operation. + Normally those would have a setClasspathRef() {for the @classpathref} + and/or a createClasspath() {for the nested <classpath>} + Typically one would have in your Ant Task or DataType

          + + 
          
+ ClasspathUtils.Delegate cpDelegate;
+
+ public void init() {
+     this.cpDelegate = ClasspathUtils.getDelegate(this);
+     super.init();
+ }
+
+ public void setClasspathRef(Reference r) {
+     this.cpDelegate.setClasspathRef(r);
+ }
+
+ public Path createClasspath() {
+     return this.cpDelegate.createClasspath();
+ }
+
+ public void setClassname(String fqcn) {
+     this.cpDelegate.setClassname(fqcn);
+ }
+
          + +

          At execution time, when you actually need the classloading + you can just:

          + + 
          
+     Object o = this.cpDelegate.newInstance();
+
          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classClasspathUtils.Delegate + +
          +          Delegate that helps out any specific ProjectComponent that needs + dynamic classloading.
          +  + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringREUSE_LOADER_REF + +
          +          Name of the magic property that controls classloader reuse in Ant 1.4.
          +  + + + + + + + + + + +
          +Constructor Summary
          ClasspathUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.lang.ClassLoadergetClassLoaderForPath(Project p, + Path path, + java.lang.String loaderId) + +
          +          Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean).
          +static java.lang.ClassLoadergetClassLoaderForPath(Project p, + Path path, + java.lang.String loaderId, + boolean reverseLoader) + +
          +          Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean, boolean).
          +static java.lang.ClassLoadergetClassLoaderForPath(Project p, + Path path, + java.lang.String loaderId, + boolean reverseLoader, + boolean reuseLoader) + +
          +          Gets a classloader that loads classes from the classpath + defined in the path argument.
          +static java.lang.ClassLoadergetClassLoaderForPath(Project p, + Reference ref) + +
          +          Convenience overloaded version of getClassLoaderForPath(Project, Reference, boolean).
          +static java.lang.ClassLoadergetClassLoaderForPath(Project p, + Reference ref, + boolean reverseLoader) + +
          +          Convenience overloaded version of getClassLoaderForPath(Project, Path, + String, boolean).
          +static ClasspathUtils.DelegategetDelegate(ProjectComponent component) + +
          +          Obtains a delegate that helps out with classic classpath configuration.
          +static java.lang.ClassLoadergetUniqueClassLoaderForPath(Project p, + Path path, + boolean reverseLoader) + +
          +          Gets a fresh, different, previously unused classloader that uses the + passed path as its classpath.
          +static java.lang.ObjectnewInstance(java.lang.String className, + java.lang.ClassLoader userDefinedLoader) + +
          +          Creates a fresh object instance of the specified classname.
          +static java.lang.ObjectnewInstance(java.lang.String className, + java.lang.ClassLoader userDefinedLoader, + java.lang.Class expectedType) + +
          +          Creates a fresh object instance of the specified classname.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +REUSE_LOADER_REF

          +
          +public static final java.lang.String REUSE_LOADER_REF
          +
          +
          Name of the magic property that controls classloader reuse in Ant 1.4. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ClasspathUtils

          +
          +public ClasspathUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getClassLoaderForPath

          +
          +public static java.lang.ClassLoader getClassLoaderForPath(Project p,
+                                                          Reference ref)
          +
          +
          Convenience overloaded version of getClassLoaderForPath(Project, Reference, boolean). + +

          Assumes the logical 'false' for the reverseLoader.

          +

          +

          +
          Parameters:
          p - the project
          ref - the reference +
          Returns:
          The class loader
          +
          +
          +
          + +

          +getClassLoaderForPath

          +
          +public static java.lang.ClassLoader getClassLoaderForPath(Project p,
+                                                          Reference ref,
+                                                          boolean reverseLoader)
          +
          +
          Convenience overloaded version of getClassLoaderForPath(Project, Path, + String, boolean). + +

          Delegates to the other one after extracting the referenced + Path from the Project. This checks also that the passed + Reference is pointing to a Path all right.

          +

          +

          +
          Parameters:
          p - current Ant project
          ref - Reference to Path structure
          reverseLoader - if set to true this new loader will take + precedence over its parent (which is contra the regular + classloader behaviour) +
          Returns:
          The class loader
          +
          +
          +
          + +

          +getClassLoaderForPath

          +
          +public static java.lang.ClassLoader getClassLoaderForPath(Project p,
+                                                          Path path,
+                                                          java.lang.String loaderId)
          +
          +
          Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean). + +

          Assumes the logical 'false' for the reverseLoader.

          +

          +

          +
          Parameters:
          p - current Ant project
          path - the path
          loaderId - the loader id string +
          Returns:
          The class loader
          +
          +
          +
          + +

          +getClassLoaderForPath

          +
          +public static java.lang.ClassLoader getClassLoaderForPath(Project p,
+                                                          Path path,
+                                                          java.lang.String loaderId,
+                                                          boolean reverseLoader)
          +
          +
          Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean, boolean). + +

          Sets value for 'reuseLoader' to true if the magic property + has been set.

          +

          +

          +
          Parameters:
          p - the project
          path - the path
          loaderId - the loader id string
          reverseLoader - if set to true this new loader will take + precedence over its parent (which is contra the regular + classloader behaviour) +
          Returns:
          The class loader
          +
          +
          +
          + +

          +getClassLoaderForPath

          +
          +public static java.lang.ClassLoader getClassLoaderForPath(Project p,
+                                                          Path path,
+                                                          java.lang.String loaderId,
+                                                          boolean reverseLoader,
+                                                          boolean reuseLoader)
          +
          +
          Gets a classloader that loads classes from the classpath + defined in the path argument. + +

          Based on the setting of the magic property + 'ant.reuse.loader' this will try to reuse the previously + created loader with that id, and of course store it there upon + creation.

          +

          +

          +
          Parameters:
          p - Ant Project where the handled components are living in.
          path - Path object to be used as classpath for this classloader
          loaderId - identification for this Loader,
          reverseLoader - if set to true this new loader will take + precedence over its parent (which is contra the regular + classloader behaviour)
          reuseLoader - if true reuse the loader if it is found +
          Returns:
          ClassLoader that uses the Path as its classpath.
          +
          +
          +
          + +

          +getUniqueClassLoaderForPath

          +
          +public static java.lang.ClassLoader getUniqueClassLoaderForPath(Project p,
+                                                                Path path,
+                                                                boolean reverseLoader)
          +
          +
          Gets a fresh, different, previously unused classloader that uses the + passed path as its classpath. + +

          This method completely ignores the ant.reuse.loader magic + property and should be used with caution.

          +

          +

          +
          Parameters:
          p - Ant Project where the handled components are living in.
          path - the classpath for this loader
          reverseLoader - if set to true this new loader will take + precedence over its parent (which is contra the regular + classloader behaviour) +
          Returns:
          The fresh, different, previously unused class loader.
          +
          +
          +
          + +

          +newInstance

          +
          +public static java.lang.Object newInstance(java.lang.String className,
+                                           java.lang.ClassLoader userDefinedLoader)
          +
          +
          Creates a fresh object instance of the specified classname. + +

          This uses the userDefinedLoader to load the specified class, + and then makes an instance using the default no-argument constructor. +

          +

          +

          +
          Parameters:
          className - the full qualified class name to load.
          userDefinedLoader - the classloader to use. +
          Returns:
          The fresh object instance +
          Throws: +
          BuildException - when loading or instantiation failed.
          +
          +
          +
          + +

          +newInstance

          +
          +public static java.lang.Object newInstance(java.lang.String className,
+                                           java.lang.ClassLoader userDefinedLoader,
+                                           java.lang.Class expectedType)
          +
          +
          Creates a fresh object instance of the specified classname. + +

          This uses the userDefinedLoader to load the specified class, + and then makes an instance using the default no-argument constructor. +

          +

          +

          +
          Parameters:
          className - the full qualified class name to load.
          userDefinedLoader - the classloader to use.
          expectedType - the Class that the result should be assignment + compatible with. (No ClassCastException will be thrown in case + the result of this method is casted to the expectedType) +
          Returns:
          The fresh object instance +
          Throws: +
          BuildException - when loading or instantiation failed.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getDelegate

          +
          +public static ClasspathUtils.Delegate getDelegate(ProjectComponent component)
          +
          +
          Obtains a delegate that helps out with classic classpath configuration. +

          +

          +
          Parameters:
          component - your projectComponent that needs the assistence +
          Returns:
          the helper, delegate.
          See Also:
          ClasspathUtils.Delegate
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.EmptyEnumeration.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.EmptyEnumeration.html new file mode 100644 index 000000000..abdebba1b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.EmptyEnumeration.html @@ -0,0 +1,293 @@ + + + + + + +CollectionUtils.EmptyEnumeration (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class CollectionUtils.EmptyEnumeration

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.CollectionUtils.EmptyEnumeration
+
          +
          +
          All Implemented Interfaces:
          java.util.Enumeration
          +
          +
          +
          Enclosing class:
          CollectionUtils
          +
          +
          +
          +
          public static final class CollectionUtils.EmptyEnumeration
          extends java.lang.Object
          implements java.util.Enumeration
          + + +

          +An empty enumeration. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          CollectionUtils.EmptyEnumeration() + +
          +          Constructor for the EmptyEnumeration
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanhasMoreElements() + +
          +           
          + java.lang.ObjectnextElement() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CollectionUtils.EmptyEnumeration

          +
          +public CollectionUtils.EmptyEnumeration()
          +
          +
          Constructor for the EmptyEnumeration +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +hasMoreElements

          +
          +public boolean hasMoreElements()
          +
          +
          +
          Specified by:
          hasMoreElements in interface java.util.Enumeration
          +
          +
          + +
          Returns:
          false always.
          +
          +
          +
          + +

          +nextElement

          +
          +public java.lang.Object nextElement()
+                             throws java.util.NoSuchElementException
          +
          +
          +
          Specified by:
          nextElement in interface java.util.Enumeration
          +
          +
          + +
          Returns:
          nothing. +
          Throws: +
          java.util.NoSuchElementException - always.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.html new file mode 100644 index 000000000..777df2c72 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CollectionUtils.html @@ -0,0 +1,523 @@ + + + + + + +CollectionUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class CollectionUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.CollectionUtils
+
          +
          +
          +
          public class CollectionUtils
          extends java.lang.Object
          + + +

          +A set of helper methods related to collection manipulation. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classCollectionUtils.EmptyEnumeration + +
          +          An empty enumeration.
          +  + + + + + + + + + + +
          +Field Summary
          +static java.util.ListEMPTY_LIST + +
          +          Collections.emptyList() is Java5+.
          +  + + + + + + + + + + +
          +Constructor Summary
          CollectionUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.util.Enumerationappend(java.util.Enumeration e1, + java.util.Enumeration e2) + +
          +          Append one enumeration to another.
          +static java.util.CollectionasCollection(java.util.Iterator iter) + +
          +          Returns a collection containing all elements of the iterator.
          +static java.util.EnumerationasEnumeration(java.util.Iterator iter) + +
          +          Adapt the specified Iterator to the Enumeration interface.
          +static java.util.IteratorasIterator(java.util.Enumeration e) + +
          +          Adapt the specified Enumeration to the Iterator interface.
          +static booleanequals(java.util.Dictionary d1, + java.util.Dictionary d2) + +
          +          Deprecated. since 1.6.x.
          +static booleanequals(java.util.Vector v1, + java.util.Vector v2) + +
          +          Deprecated. since 1.6.x.
          +static java.lang.StringflattenToString(java.util.Collection c) + +
          +          Creates a comma separated list of all values held in the given + collection.
          +static intfrequency(java.util.Collection c, + java.lang.Object o) + +
          +          Counts how often the given Object occurs in the given + collection using equals() for comparison.
          +static voidputAll(java.util.Dictionary m1, + java.util.Dictionary m2) + +
          +          Deprecated. since 1.6.x.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +EMPTY_LIST

          +
          +public static final java.util.List EMPTY_LIST
          +
          +
          Collections.emptyList() is Java5+. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +CollectionUtils

          +
          +public CollectionUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +equals

          +
          +public static boolean equals(java.util.Vector v1,
+                             java.util.Vector v2)
          +
          +
          Deprecated. since 1.6.x. +

          +

          Please use Vector.equals() or List.equals(). +

          +

          +
          Parameters:
          v1 - the first vector.
          v2 - the second vector. +
          Returns:
          true if the vectors are equal.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +equals

          +
          +public static boolean equals(java.util.Dictionary d1,
+                             java.util.Dictionary d2)
          +
          +
          Deprecated. since 1.6.x. +

          +

          Dictionary does not have an equals. + Please use Map.equals(). + +

          Follows the equals contract of Java 2's Map.

          +

          +

          +
          Parameters:
          d1 - the first directory.
          d2 - the second directory. +
          Returns:
          true if the directories are equal.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +flattenToString

          +
          +public static java.lang.String flattenToString(java.util.Collection c)
          +
          +
          Creates a comma separated list of all values held in the given + collection. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +putAll

          +
          +public static void putAll(java.util.Dictionary m1,
+                          java.util.Dictionary m2)
          +
          +
          Deprecated. since 1.6.x. +

          +

          Dictionary does not know the putAll method. Please use Map.putAll(). +

          +

          +
          Parameters:
          m1 - the to directory.
          m2 - the from directory.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +append

          +
          +public static java.util.Enumeration append(java.util.Enumeration e1,
+                                           java.util.Enumeration e2)
          +
          +
          Append one enumeration to another. + Elements are evaluated lazily. +

          +

          +
          Parameters:
          e1 - the first enumeration.
          e2 - the subsequent enumeration. +
          Returns:
          an enumeration representing e1 followed by e2.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +asEnumeration

          +
          +public static java.util.Enumeration asEnumeration(java.util.Iterator iter)
          +
          +
          Adapt the specified Iterator to the Enumeration interface. +

          +

          +
          Parameters:
          iter - the Iterator to adapt. +
          Returns:
          an Enumeration.
          +
          +
          +
          + +

          +asIterator

          +
          +public static java.util.Iterator asIterator(java.util.Enumeration e)
          +
          +
          Adapt the specified Enumeration to the Iterator interface. +

          +

          +
          Parameters:
          e - the Enumeration to adapt. +
          Returns:
          an Iterator.
          +
          +
          +
          + +

          +asCollection

          +
          +public static java.util.Collection asCollection(java.util.Iterator iter)
          +
          +
          Returns a collection containing all elements of the iterator. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +frequency

          +
          +public static int frequency(java.util.Collection c,
+                            java.lang.Object o)
          +
          +
          Counts how often the given Object occurs in the given + collection using equals() for comparison. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CompositeMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CompositeMapper.html new file mode 100644 index 000000000..82fbd4bed --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/CompositeMapper.html @@ -0,0 +1,276 @@ + + + + + + +CompositeMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class CompositeMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ContainerMapper
+      extended by org.apache.tools.ant.util.CompositeMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class CompositeMapper
          extends ContainerMapper
          + + +

          +A ContainerMapper that unites the results of its constituent + FileNameMappers into a single set of result filenames. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          CompositeMapper() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the + given source file..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ContainerMapper
          add, addConfigured, addConfiguredMapper, contains, getMappers, setFrom, setTo
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CompositeMapper

          +
          +public CompositeMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the + given source file. + +

          if the given rule doesn't apply to the source file, + implementation must return null. SourceFileScanner will then + omit the source file in question.

          . +

          +

          +
          Parameters:
          sourceFileName - the name of the source file relative to + some given basedirectory. +
          Returns:
          an array of strings if the ruld applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatFileInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatFileInputStream.html new file mode 100644 index 000000000..95f9fd6bd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatFileInputStream.html @@ -0,0 +1,379 @@ + + + + + + +ConcatFileInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ConcatFileInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.ant.util.ConcatFileInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          +
          public class ConcatFileInputStream
          extends java.io.InputStream
          + + +

          +Special InputStream that will + concatenate the contents of an array of files. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ConcatFileInputStream(java.io.File[] file) + +
          +          Construct a new ConcatFileInputStream + with the specified File[].
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close the stream.
          + voidlog(java.lang.String message, + int loglevel) + +
          +          Log a message with the specified logging level.
          + intread() + +
          +          Read a byte.
          + voidsetManagingComponent(ProjectComponent pc) + +
          +          Set a managing Task for + this ConcatFileInputStream.
          + voidsetManagingTask(Task task) + +
          +          Set a managing Task for + this ConcatFileInputStream.
          +  + + + + + + + +
          Methods inherited from class java.io.InputStream
          available, mark, markSupported, read, read, reset, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ConcatFileInputStream

          +
          +public ConcatFileInputStream(java.io.File[] file)
+                      throws java.io.IOException
          +
          +
          Construct a new ConcatFileInputStream + with the specified File[]. +

          +

          +
          Parameters:
          file - File[]. +
          Throws: +
          java.io.IOException - if I/O errors occur.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Close the stream. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          Read a byte. +

          +

          +
          Specified by:
          read in class java.io.InputStream
          +
          +
          + +
          Returns:
          the byte (0 - 255) or -1 if this is the end of the stream. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +setManagingTask

          +
          +public void setManagingTask(Task task)
          +
          +
          Set a managing Task for + this ConcatFileInputStream. +

          +

          +
          Parameters:
          task - the managing Task.
          +
          +
          +
          + +

          +setManagingComponent

          +
          +public void setManagingComponent(ProjectComponent pc)
          +
          +
          Set a managing Task for + this ConcatFileInputStream. +

          +

          +
          Parameters:
          pc - the managing Task.
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String message,
+                int loglevel)
          +
          +
          Log a message with the specified logging level. +

          +

          +
          Parameters:
          message - the String message.
          loglevel - the int logging level.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatResourceInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatResourceInputStream.html new file mode 100644 index 000000000..862beb54a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ConcatResourceInputStream.html @@ -0,0 +1,400 @@ + + + + + + +ConcatResourceInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ConcatResourceInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.ant.util.ConcatResourceInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          +
          public class ConcatResourceInputStream
          extends java.io.InputStream
          + + +

          +Special InputStream that will + concatenate the contents of Resources from a single ResourceCollection. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ConcatResourceInputStream(ResourceCollection rc) + +
          +          Construct a new ConcatResourceInputStream + for the specified ResourceCollection.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close the stream.
          + booleanisIgnoreErrors() + +
          +          Find out whether this ConcatResourceInputStream ignores errors.
          + voidlog(java.lang.String message, + int loglevel) + +
          +          Log a message with the specified logging level.
          + intread() + +
          +          Read a byte.
          + voidsetIgnoreErrors(boolean b) + +
          +          Set whether this ConcatResourceInputStream ignores errors.
          + voidsetManagingComponent(ProjectComponent pc) + +
          +          Set a managing ProjectComponent for + this ConcatResourceInputStream.
          +  + + + + + + + +
          Methods inherited from class java.io.InputStream
          available, mark, markSupported, read, read, reset, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ConcatResourceInputStream

          +
          +public ConcatResourceInputStream(ResourceCollection rc)
          +
          +
          Construct a new ConcatResourceInputStream + for the specified ResourceCollection. +

          +

          +
          Parameters:
          rc - the ResourceCollection to combine.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setIgnoreErrors

          +
          +public void setIgnoreErrors(boolean b)
          +
          +
          Set whether this ConcatResourceInputStream ignores errors. +

          +

          +
          Parameters:
          b - whether to ignore errors.
          +
          +
          +
          + +

          +isIgnoreErrors

          +
          +public boolean isIgnoreErrors()
          +
          +
          Find out whether this ConcatResourceInputStream ignores errors. +

          +

          + +
          Returns:
          boolean ignore-errors flag.
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Close the stream. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          Read a byte. +

          +

          +
          Specified by:
          read in class java.io.InputStream
          +
          +
          + +
          Returns:
          the byte (0 - 255) or -1 if this is the end of the stream. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +setManagingComponent

          +
          +public void setManagingComponent(ProjectComponent pc)
          +
          +
          Set a managing ProjectComponent for + this ConcatResourceInputStream. +

          +

          +
          Parameters:
          pc - the managing ProjectComponent.
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String message,
+                int loglevel)
          +
          +
          Log a message with the specified logging level. +

          +

          +
          Parameters:
          message - the String message.
          loglevel - the int logging level.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ContainerMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ContainerMapper.html new file mode 100644 index 000000000..4e823f5c1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ContainerMapper.html @@ -0,0 +1,432 @@ + + + + + + +ContainerMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ContainerMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ContainerMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          Direct Known Subclasses:
          ChainedMapper, CompositeMapper, FirstMatchMapper
          +
          +
          +
          +
          public abstract class ContainerMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +A FileNameMapper that contains + other FileNameMappers. +

          + +

          +

          +
          See Also:
          FileNameMapper
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ContainerMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(FileNameMapper fileNameMapper) + +
          +          Add a FileNameMapper.
          + voidaddConfigured(FileNameMapper fileNameMapper) + +
          +          An add configured version of the add method.
          + voidaddConfiguredMapper(Mapper mapper) + +
          +          Add a Mapper.
          +protected  booleancontains(FileNameMapper fileNameMapper) + +
          +          Return true if this ContainerMapper or any of + its sub-elements contains the specified FileNameMapper.
          + java.util.ListgetMappers() + +
          +          Get the List of FileNameMappers.
          + voidsetFrom(java.lang.String ignore) + +
          +          Empty implementation.
          + voidsetTo(java.lang.String ignore) + +
          +          Empty implementation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.util.FileNameMapper
          mapFileName
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ContainerMapper

          +
          +public ContainerMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addConfiguredMapper

          +
          +public void addConfiguredMapper(Mapper mapper)
          +
          +
          Add a Mapper. +

          +

          +
          +
          +
          +
          Parameters:
          mapper - the Mapper to add.
          +
          +
          +
          + +

          +addConfigured

          +
          +public void addConfigured(FileNameMapper fileNameMapper)
          +
          +
          An add configured version of the add method. + This class used to contain an add method and an + addConfiguredMapper method. Dur to ordering, + the add method was always called first. This + addConfigued method has been added to allow + chaining to work correctly. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - a FileNameMapper.
          +
          +
          +
          + +

          +add

          +
          +public void add(FileNameMapper fileNameMapper)
          +
          +
          Add a FileNameMapper. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - a FileNameMapper. +
          Throws: +
          java.lang.IllegalArgumentException - if attempting to add this + ContainerMapper to itself, or if the specified + FileNameMapper is itself a ContainerMapper + that contains this ContainerMapper.
          +
          +
          +
          + +

          +contains

          +
          +protected boolean contains(FileNameMapper fileNameMapper)
          +
          +
          Return true if this ContainerMapper or any of + its sub-elements contains the specified FileNameMapper. +

          +

          +
          +
          +
          +
          Parameters:
          fileNameMapper - the FileNameMapper to search for. +
          Returns:
          boolean.
          +
          +
          +
          + +

          +getMappers

          +
          +public java.util.List getMappers()
          +
          +
          Get the List of FileNameMappers. +

          +

          +
          +
          +
          + +
          Returns:
          List.
          +
          +
          +
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String ignore)
          +
          +
          Empty implementation. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          ignore - ignored.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String ignore)
          +
          +
          Empty implementation. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          ignore - ignored.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.XmlNamespacePolicy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.XmlNamespacePolicy.html new file mode 100644 index 000000000..fdc8ec503 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.XmlNamespacePolicy.html @@ -0,0 +1,312 @@ + + + + + + +DOMElementWriter.XmlNamespacePolicy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class DOMElementWriter.XmlNamespacePolicy

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.DOMElementWriter.XmlNamespacePolicy
+
          +
          +
          Enclosing class:
          DOMElementWriter
          +
          +
          +
          +
          public static class DOMElementWriter.XmlNamespacePolicy
          extends java.lang.Object
          + + +

          +Whether namespaces should be ignored for elements and attributes. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static DOMElementWriter.XmlNamespacePolicyIGNORE + +
          +          Ignores namespaces for elements and attributes, the default.
          +static DOMElementWriter.XmlNamespacePolicyONLY_QUALIFY_ELEMENTS + +
          +          Ignores namespaces for attributes.
          +static DOMElementWriter.XmlNamespacePolicyQUALIFY_ALL + +
          +          Qualifies namespaces for elements and attributes.
          +  + + + + + + + + + + +
          +Constructor Summary
          DOMElementWriter.XmlNamespacePolicy(boolean qualifyElements, + boolean qualifyAttributes) + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +IGNORE

          +
          +public static final DOMElementWriter.XmlNamespacePolicy IGNORE
          +
          +
          Ignores namespaces for elements and attributes, the default. +

          +

          +
          +
          +
          + +

          +ONLY_QUALIFY_ELEMENTS

          +
          +public static final DOMElementWriter.XmlNamespacePolicy ONLY_QUALIFY_ELEMENTS
          +
          +
          Ignores namespaces for attributes. +

          +

          +
          +
          +
          + +

          +QUALIFY_ALL

          +
          +public static final DOMElementWriter.XmlNamespacePolicy QUALIFY_ALL
          +
          +
          Qualifies namespaces for elements and attributes. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DOMElementWriter.XmlNamespacePolicy

          +
          +public DOMElementWriter.XmlNamespacePolicy(boolean qualifyElements,
+                                           boolean qualifyAttributes)
          +
          +
          +
          Parameters:
          qualifyElements - whether to qualify elements
          qualifyAttributes - whether to qualify elements
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.html new file mode 100644 index 000000000..a25a48057 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMElementWriter.html @@ -0,0 +1,665 @@ + + + + + + +DOMElementWriter (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class DOMElementWriter

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.DOMElementWriter
+
          +
          +
          +
          public class DOMElementWriter
          extends java.lang.Object
          + + +

          +Writes a DOM tree to a given Writer. + warning: this utility currently does not declare XML Namespaces. +

          Utility class used by XmlLogger and + org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter + XMLJUnitResultFormatter}.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classDOMElementWriter.XmlNamespacePolicy + +
          +          Whether namespaces should be ignored for elements and attributes.
          +  + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.String[]knownEntities + +
          +          Don't try to be too smart but at least recognize the predefined + entities.
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          DOMElementWriter() + +
          +          Create an element writer.
          DOMElementWriter(boolean xmlDeclaration) + +
          +          Create an element writer + XML namespaces will be ignored.
          DOMElementWriter(boolean xmlDeclaration, + DOMElementWriter.XmlNamespacePolicy namespacePolicy) + +
          +          Create an element writer + XML namespaces will be ignored.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidcloseElement(org.w3c.dom.Element element, + java.io.Writer out, + int indent, + java.lang.String indentWith, + boolean hasChildren) + +
          +          Writes a DOM tree to a stream.
          + java.lang.Stringencode(java.lang.String value) + +
          +          Escape <, > & ', " as their entities and + drop characters that are illegal in XML documents.
          + java.lang.StringencodeAttributeValue(java.lang.String value) + +
          +          Escape <, > & ', " as their entities, \n, + \r and \t as numeric entities and drop characters that are + illegal in XML documents.
          + java.lang.Stringencodedata(java.lang.String value) + +
          +          Drop characters that are illegal in XML documents.
          + booleanisLegalCharacter(char c) + +
          +          Is the given character allowed inside an XML document?
          + booleanisReference(java.lang.String ent) + +
          +          Is the given argument a character or entity reference?
          + voidopenElement(org.w3c.dom.Element element, + java.io.Writer out, + int indent, + java.lang.String indentWith) + +
          +          Writes the opening tag - including all attributes - + corresponding to a DOM element.
          + voidopenElement(org.w3c.dom.Element element, + java.io.Writer out, + int indent, + java.lang.String indentWith, + boolean hasChildren) + +
          +          Writes the opening tag - including all attributes - + corresponding to a DOM element.
          + voidwrite(org.w3c.dom.Element root, + java.io.OutputStream out) + +
          +          Writes a DOM tree to a stream in UTF8 encoding.
          + voidwrite(org.w3c.dom.Element element, + java.io.Writer out, + int indent, + java.lang.String indentWith) + +
          +          Writes a DOM tree to a stream.
          + voidwriteXMLDeclaration(java.io.Writer wri) + +
          +          Writes the XML declaration if xmlDeclaration is true.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +knownEntities

          +
          +protected java.lang.String[] knownEntities
          +
          +
          Don't try to be too smart but at least recognize the predefined + entities. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +DOMElementWriter

          +
          +public DOMElementWriter()
          +
          +
          Create an element writer. + The ?xml? declaration will be included, namespaces ignored. +

          +

          +
          + +

          +DOMElementWriter

          +
          +public DOMElementWriter(boolean xmlDeclaration)
          +
          +
          Create an element writer + XML namespaces will be ignored. +

          +

          +
          Parameters:
          xmlDeclaration - flag to indicate whether the ?xml? declaration + should be included.
          Since:
          +
          Ant1.7
          +
          +
          +
          + +

          +DOMElementWriter

          +
          +public DOMElementWriter(boolean xmlDeclaration,
+                        DOMElementWriter.XmlNamespacePolicy namespacePolicy)
          +
          +
          Create an element writer + XML namespaces will be ignored. +

          +

          +
          Parameters:
          xmlDeclaration - flag to indicate whether the ?xml? declaration + should be included.
          namespacePolicy - the policy to use.
          Since:
          +
          Ant1.7
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +write

          +
          +public void write(org.w3c.dom.Element root,
+                  java.io.OutputStream out)
+           throws java.io.IOException
          +
          +
          Writes a DOM tree to a stream in UTF8 encoding. Note that + it prepends the <?xml version='1.0' encoding='UTF-8'?> if + the xmlDeclaration field is true. + The indent number is set to 0 and a 2-space indent. +

          +

          +
          Parameters:
          root - the root element of the DOM tree.
          out - the outputstream to write to. +
          Throws: +
          java.io.IOException - if an error happens while writing to the stream.
          +
          +
          +
          + +

          +writeXMLDeclaration

          +
          +public void writeXMLDeclaration(java.io.Writer wri)
+                         throws java.io.IOException
          +
          +
          Writes the XML declaration if xmlDeclaration is true. +

          +

          +
          Parameters:
          wri - the writer to write to. +
          Throws: +
          java.io.IOException - if there is an error.
          Since:
          +
          Ant 1.7.0
          +
          +
          +
          +
          + +

          +write

          +
          +public void write(org.w3c.dom.Element element,
+                  java.io.Writer out,
+                  int indent,
+                  java.lang.String indentWith)
+           throws java.io.IOException
          +
          +
          Writes a DOM tree to a stream. +

          +

          +
          Parameters:
          element - the Root DOM element of the tree
          out - where to send the output
          indent - number of
          indentWith - string that should be used to indent the + corresponding tag. +
          Throws: +
          java.io.IOException - if an error happens while writing to the stream.
          +
          +
          +
          + +

          +openElement

          +
          +public void openElement(org.w3c.dom.Element element,
+                        java.io.Writer out,
+                        int indent,
+                        java.lang.String indentWith)
+                 throws java.io.IOException
          +
          +
          Writes the opening tag - including all attributes - + corresponding to a DOM element. +

          +

          +
          Parameters:
          element - the DOM element to write
          out - where to send the output
          indent - number of
          indentWith - string that should be used to indent the + corresponding tag. +
          Throws: +
          java.io.IOException - if an error happens while writing to the stream.
          +
          +
          +
          + +

          +openElement

          +
          +public void openElement(org.w3c.dom.Element element,
+                        java.io.Writer out,
+                        int indent,
+                        java.lang.String indentWith,
+                        boolean hasChildren)
+                 throws java.io.IOException
          +
          +
          Writes the opening tag - including all attributes - + corresponding to a DOM element. +

          +

          +
          Parameters:
          element - the DOM element to write
          out - where to send the output
          indent - number of
          indentWith - string that should be used to indent the + corresponding tag.
          hasChildren - whether this element has children. +
          Throws: +
          java.io.IOException - if an error happens while writing to the stream.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +closeElement

          +
          +public void closeElement(org.w3c.dom.Element element,
+                         java.io.Writer out,
+                         int indent,
+                         java.lang.String indentWith,
+                         boolean hasChildren)
+                  throws java.io.IOException
          +
          +
          Writes a DOM tree to a stream. +

          +

          +
          Parameters:
          element - the Root DOM element of the tree
          out - where to send the output
          indent - number of
          indentWith - string that should be used to indent the + corresponding tag.
          hasChildren - if true indent. +
          Throws: +
          java.io.IOException - if an error happens while writing to the stream.
          +
          +
          +
          + +

          +encode

          +
          +public java.lang.String encode(java.lang.String value)
          +
          +
          Escape <, > & ', " as their entities and + drop characters that are illegal in XML documents. +

          +

          +
          Parameters:
          value - the string to encode. +
          Returns:
          the encoded string.
          +
          +
          +
          + +

          +encodeAttributeValue

          +
          +public java.lang.String encodeAttributeValue(java.lang.String value)
          +
          +
          Escape <, > & ', " as their entities, \n, + \r and \t as numeric entities and drop characters that are + illegal in XML documents. +

          +

          +
          Parameters:
          value - the string to encode. +
          Returns:
          the encoded string.
          +
          +
          +
          + +

          +encodedata

          +
          +public java.lang.String encodedata(java.lang.String value)
          +
          +
          Drop characters that are illegal in XML documents. + +

          Also ensure that we are not including an ]]> + marker by replacing that sequence with + &#x5d;&#x5d;&gt;.

          + +

          See XML 1.0 2.2 + http://www.w3.org/TR/1998/REC-xml-19980210#charsets and + 2.7 http://www.w3.org/TR/1998/REC-xml-19980210#sec-cdata-sect.

          +

          +

          +
          Parameters:
          value - the value to be encoded. +
          Returns:
          the encoded value.
          +
          +
          +
          + +

          +isReference

          +
          +public boolean isReference(java.lang.String ent)
          +
          +
          Is the given argument a character or entity reference? +

          +

          +
          Parameters:
          ent - the value to be checked. +
          Returns:
          true if it is an entity.
          +
          +
          +
          + +

          +isLegalCharacter

          +
          +public boolean isLegalCharacter(char c)
          +
          +
          Is the given character allowed inside an XML document? + +

          See XML 1.0 2.2 + http://www.w3.org/TR/1998/REC-xml-19980210#charsets.

          +

          +

          +
          Parameters:
          c - the character to test. +
          Returns:
          true if the character is allowed.
          Since:
          +
          1.10, Ant 1.5
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMUtils.html new file mode 100644 index 000000000..1842c3bf0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DOMUtils.html @@ -0,0 +1,441 @@ + + + + + + +DOMUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class DOMUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.DOMUtils
+
          +
          +
          +
          public class DOMUtils
          extends java.lang.Object
          + + +

          +Some utility methods for common tasks when building DOM trees in memory. + +

          In this documentation <a> means an Element instance with name a.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          DOMUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static voidappendCDATA(org.w3c.dom.Element parent, + java.lang.String content) + +
          +          Adds a nested CDATA section.
          +static voidappendCDATAElement(org.w3c.dom.Element parent, + java.lang.String name, + java.lang.String content) + +
          +          Adds a nested CDATA section in a new child element.
          +static voidappendText(org.w3c.dom.Element parent, + java.lang.String content) + +
          +          Adds nested text.
          +static voidappendTextElement(org.w3c.dom.Element parent, + java.lang.String name, + java.lang.String content) + +
          +          Adds nested text in a new child element.
          +static org.w3c.dom.ElementcreateChildElement(org.w3c.dom.Element parent, + java.lang.String name) + +
          +          Creates a named Element and appends it to the given element, + returns it.
          +static org.w3c.dom.DocumentnewDocument() + +
          +          Get a new Document instance,
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DOMUtils

          +
          +public DOMUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +newDocument

          +
          +public static org.w3c.dom.Document newDocument()
          +
          +
          Get a new Document instance, +

          +

          + +
          Returns:
          the document.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +createChildElement

          +
          +public static org.w3c.dom.Element createChildElement(org.w3c.dom.Element parent,
+                                                     java.lang.String name)
          +
          +
          Creates a named Element and appends it to the given element, + returns it. + +

          This means + 

          createChildElement(<a>, "b")
          + creates + 
          + <a>
+   <b/>
+ </a>
+
          + and returns <b>.

          +

          +

          +
          Parameters:
          parent - element that will receive the new element as child.
          name - name of the new element. +
          Returns:
          the new element.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +appendText

          +
          +public static void appendText(org.w3c.dom.Element parent,
+                              java.lang.String content)
          +
          +
          Adds nested text. + +

          This means + 

          appendText(<a>, "b")
          + creates + 
          + <a>b</a>
+
          +

          +

          +

          +
          Parameters:
          parent - element that will receive the new element as child.
          content - text content.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +appendCDATA

          +
          +public static void appendCDATA(org.w3c.dom.Element parent,
+                               java.lang.String content)
          +
          +
          Adds a nested CDATA section. + +

          This means + 

          appendCDATA(<a>, "b")
          + creates + 
          + <a><[!CDATA[b]]></a>
+
          +

          +

          +

          +
          Parameters:
          parent - element that will receive the new element as child.
          content - text content.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +appendTextElement

          +
          +public static void appendTextElement(org.w3c.dom.Element parent,
+                                     java.lang.String name,
+                                     java.lang.String content)
          +
          +
          Adds nested text in a new child element. + +

          This means + 

          appendTextElement(<a>, "b", "c")
          + creates + 
          + <a>
+   <b>c</b>
+ </a>
+
          +

          +

          +

          +
          Parameters:
          parent - element that will receive the new element as child.
          name - of the child element.
          content - text content.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +appendCDATAElement

          +
          +public static void appendCDATAElement(org.w3c.dom.Element parent,
+                                      java.lang.String name,
+                                      java.lang.String content)
          +
          +
          Adds a nested CDATA section in a new child element. + +

          This means + 

          appendCDATAElement(<a>, "b", "c")
          + creates + 
          + <a>
+   <b><![CDATA[c]]></b>
+ </a>
+
          + +

          +

          +

          +
          Parameters:
          parent - element that will receive the new element as child.
          name - of the child element.
          content - text content.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DateUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DateUtils.html new file mode 100644 index 000000000..1eee42b6a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DateUtils.html @@ -0,0 +1,578 @@ + + + + + + +DateUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class DateUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.DateUtils
+
          +
          +
          +
          public final class DateUtils
          extends java.lang.Object
          + + +

          +Helper methods to deal with date/time formatting with a specific + defined format (ISO8601) + or a plurialization correct elapsed time in minutes and seconds. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.text.DateFormatDATE_HEADER_FORMAT + +
          +          Deprecated. DateFormat is not thread safe, and we cannot guarantee that + some other code is using the format in parallel. + Deprecated since ant 1.8
          +static java.lang.StringISO8601_DATE_PATTERN + +
          +          ISO8601-like pattern for date.
          +static java.lang.StringISO8601_DATETIME_PATTERN + +
          +          ISO8601-like pattern for date-time.
          +static java.lang.StringISO8601_TIME_PATTERN + +
          +          ISO8601-like pattern for time.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.lang.Stringformat(java.util.Date date, + java.lang.String pattern) + +
          +          Format a date/time into a specific pattern.
          +static java.lang.Stringformat(long date, + java.lang.String pattern) + +
          +          Format a date/time into a specific pattern.
          +static java.lang.StringformatElapsedTime(long millis) + +
          +          Format an elapsed time into a plurialization correct string.
          +static java.lang.StringgetDateForHeader() + +
          +          Returns the current Date in a format suitable for a SMTP date + header.
          +static intgetPhaseOfMoon(java.util.Calendar cal) + +
          +          Calculate the phase of the moon for a given date.
          +static java.util.DateparseDateFromHeader(java.lang.String datestr) + +
          +          Parses the string in a format suitable for a SMTP date header.
          +static java.util.DateparseIso8601Date(java.lang.String datestr) + +
          +          Parse a string as a date using the ISO8601_DATE format which is + yyyy-MM-dd
          +static java.util.DateparseIso8601DateTime(java.lang.String datestr) + +
          +          Parse a string as a datetime using the ISO8601_DATETIME format which is + yyyy-MM-dd'T'HH:mm:ss
          +static java.util.DateparseIso8601DateTimeOrDate(java.lang.String datestr) + +
          +          Parse a string as a date using the either the ISO8601_DATETIME + or ISO8601_DATE formats.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ISO8601_DATETIME_PATTERN

          +
          +public static final java.lang.String ISO8601_DATETIME_PATTERN
          +
          +
          ISO8601-like pattern for date-time. It does not support timezone. + yyyy-MM-ddTHH:mm:ss +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ISO8601_DATE_PATTERN

          +
          +public static final java.lang.String ISO8601_DATE_PATTERN
          +
          +
          ISO8601-like pattern for date. yyyy-MM-dd +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ISO8601_TIME_PATTERN

          +
          +public static final java.lang.String ISO8601_TIME_PATTERN
          +
          +
          ISO8601-like pattern for time. HH:mm:ss +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DATE_HEADER_FORMAT

          +
          +public static final java.text.DateFormat DATE_HEADER_FORMAT
          +
          +
          Deprecated. DateFormat is not thread safe, and we cannot guarantee that + some other code is using the format in parallel. + Deprecated since ant 1.8
          Format used for SMTP (and probably other) Date headers. +

          +

          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +format

          +
          +public static java.lang.String format(long date,
+                                      java.lang.String pattern)
          +
          +
          Format a date/time into a specific pattern. +

          +

          +
          Parameters:
          date - the date to format expressed in milliseconds.
          pattern - the pattern to use to format the date. +
          Returns:
          the formatted date.
          +
          +
          +
          + +

          +format

          +
          +public static java.lang.String format(java.util.Date date,
+                                      java.lang.String pattern)
          +
          +
          Format a date/time into a specific pattern. +

          +

          +
          Parameters:
          date - the date to format expressed in milliseconds.
          pattern - the pattern to use to format the date. +
          Returns:
          the formatted date.
          +
          +
          +
          + +

          +formatElapsedTime

          +
          +public static java.lang.String formatElapsedTime(long millis)
          +
          +
          Format an elapsed time into a plurialization correct string. + It is limited only to report elapsed time in minutes and + seconds and has the following behavior. +
            +
          • minutes are not displayed when 0. (ie: "45 seconds")
            • +
          • seconds are always displayed in plural form (ie "0 seconds" or + "10 seconds") except for 1 (ie "1 second")
            • +
          +

          +

          +
          Parameters:
          millis - the elapsed time to report in milliseconds. +
          Returns:
          the formatted text in minutes/seconds.
          +
          +
          +
          + +

          +getPhaseOfMoon

          +
          +public static int getPhaseOfMoon(java.util.Calendar cal)
          +
          +
          Calculate the phase of the moon for a given date. + +

          Code heavily influenced by hacklib.c in Nethack

          + +

          The Algorithm: + + 

          + moon period = 29.53058 days ~= 30, year = 365.2422 days
+
+ days moon phase advances on first day of year compared to preceding year
+  = 365.2422 - 12*29.53058 ~= 11
+
+ years in Metonic cycle (time until same phases fall on the same days of
+  the month) = 18.6 ~= 19
+
+ moon phase on first day of year (epact) ~= (11*(year%19) + 18) % 30
+  (18 as initial condition for 1900)
+
+ current phase in days = first day phase + days elapsed in year
+
+ 6 moons ~= 177 days
+ 177 ~= 8 reported phases * 22
+ + 11/22 for rounding
+
          +

          +

          +
          Parameters:
          cal - the calander. +
          Returns:
          The phase of the moon as a number between 0 and 7 with + 0 meaning new moon and 4 meaning full moon.
          Since:
          +
          1.2, Ant 1.5
          +
          +
          +
          +
          + +

          +getDateForHeader

          +
          +public static java.lang.String getDateForHeader()
          +
          +
          Returns the current Date in a format suitable for a SMTP date + header. +

          +

          + +
          Returns:
          the current date.
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +parseDateFromHeader

          +
          +public static java.util.Date parseDateFromHeader(java.lang.String datestr)
+                                          throws java.text.ParseException
          +
          +
          Parses the string in a format suitable for a SMTP date header. +

          +

          +
          Parameters:
          datestr - string to be parsed +
          Returns:
          a java.util.Date object as parsed by the format. +
          Throws: +
          java.text.ParseException - if the supplied string cannot be parsed by + this pattern.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +parseIso8601DateTime

          +
          +public static java.util.Date parseIso8601DateTime(java.lang.String datestr)
+                                           throws java.text.ParseException
          +
          +
          Parse a string as a datetime using the ISO8601_DATETIME format which is + yyyy-MM-dd'T'HH:mm:ss +

          +

          +
          Parameters:
          datestr - string to be parsed +
          Returns:
          a java.util.Date object as parsed by the format. +
          Throws: +
          java.text.ParseException - if the supplied string cannot be parsed by + this pattern.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +parseIso8601Date

          +
          +public static java.util.Date parseIso8601Date(java.lang.String datestr)
+                                       throws java.text.ParseException
          +
          +
          Parse a string as a date using the ISO8601_DATE format which is + yyyy-MM-dd +

          +

          +
          Parameters:
          datestr - string to be parsed +
          Returns:
          a java.util.Date object as parsed by the format. +
          Throws: +
          java.text.ParseException - if the supplied string cannot be parsed by + this pattern.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +parseIso8601DateTimeOrDate

          +
          +public static java.util.Date parseIso8601DateTimeOrDate(java.lang.String datestr)
+                                                 throws java.text.ParseException
          +
          +
          Parse a string as a date using the either the ISO8601_DATETIME + or ISO8601_DATE formats. +

          +

          +
          Parameters:
          datestr - string to be parsed +
          Returns:
          a java.util.Date object as parsed by the formats. +
          Throws: +
          java.text.ParseException - if the supplied string cannot be parsed by + either of these patterns.
          Since:
          +
          Ant 1.6
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DeweyDecimal.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DeweyDecimal.html new file mode 100644 index 000000000..2176b11f6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/DeweyDecimal.html @@ -0,0 +1,454 @@ + + + + + + +DeweyDecimal (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class DeweyDecimal

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.DeweyDecimal
+
          +
          +
          Direct Known Subclasses:
          DeweyDecimal
          +
          +
          +
          +
          public class DeweyDecimal
          extends java.lang.Object
          + + +

          +Utility class to contain version numbers in "Dewey Decimal" + syntax. Numbers in the "Dewey Decimal" syntax consist of positive + decimal integers separated by periods ".". For example, "2.0" or + "1.2.3.4.5.6.7". This allows an extensible number to be used to + represent major, minor, micro, etc versions. The version number + must begin with a number. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          DeweyDecimal(int[] components) + +
          +          Construct a DeweyDecimal from an array of integer components.
          DeweyDecimal(java.lang.String string) + +
          +          Construct a DeweyDecimal from string in DeweyDecimal format.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intget(int index) + +
          +          Return the component at specified index.
          + intgetSize() + +
          +          Return number of components in DeweyDecimal.
          + booleanisEqual(DeweyDecimal other) + +
          +          Return true if this DeweyDecimal is + equal to the other DeweyDecimal.
          + booleanisGreaterThan(DeweyDecimal other) + +
          +          Return true if this DeweyDecimal is + greater than the other DeweyDecimal.
          + booleanisGreaterThanOrEqual(DeweyDecimal other) + +
          +          Return true if this DeweyDecimal is + greater than or equal to the other DeweyDecimal.
          + booleanisLessThan(DeweyDecimal other) + +
          +          Return true if this DeweyDecimal is + less than the other DeweyDecimal.
          + booleanisLessThanOrEqual(DeweyDecimal other) + +
          +          Return true if this DeweyDecimal is + less than or equal to the other DeweyDecimal.
          + java.lang.StringtoString() + +
          +          Return string representation of DeweyDecimal.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DeweyDecimal

          +
          +public DeweyDecimal(int[] components)
          +
          +
          Construct a DeweyDecimal from an array of integer components. +

          +

          +
          Parameters:
          components - an array of integer components.
          +
          +
          + +

          +DeweyDecimal

          +
          +public DeweyDecimal(java.lang.String string)
+             throws java.lang.NumberFormatException
          +
          +
          Construct a DeweyDecimal from string in DeweyDecimal format. +

          +

          +
          Parameters:
          string - the string in dewey decimal format +
          Throws: +
          java.lang.NumberFormatException - if string is malformed
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getSize

          +
          +public int getSize()
          +
          +
          Return number of components in DeweyDecimal. +

          +

          + +
          Returns:
          the number of components in dewey decimal
          +
          +
          +
          + +

          +get

          +
          +public int get(int index)
          +
          +
          Return the component at specified index. +

          +

          +
          Parameters:
          index - the index of components +
          Returns:
          the value of component at index
          +
          +
          +
          + +

          +isEqual

          +
          +public boolean isEqual(DeweyDecimal other)
          +
          +
          Return true if this DeweyDecimal is + equal to the other DeweyDecimal. +

          +

          +
          Parameters:
          other - the other DeweyDecimal +
          Returns:
          true if equal to other DeweyDecimal, false otherwise
          +
          +
          +
          + +

          +isLessThan

          +
          +public boolean isLessThan(DeweyDecimal other)
          +
          +
          Return true if this DeweyDecimal is + less than the other DeweyDecimal. +

          +

          +
          Parameters:
          other - the other DeweyDecimal +
          Returns:
          true if less than other DeweyDecimal, false otherwise
          +
          +
          +
          + +

          +isLessThanOrEqual

          +
          +public boolean isLessThanOrEqual(DeweyDecimal other)
          +
          +
          Return true if this DeweyDecimal is + less than or equal to the other DeweyDecimal. +

          +

          +
          Parameters:
          other - the other DeweyDecimal +
          Returns:
          true if less than or equal to other DeweyDecimal, false otherwise
          +
          +
          +
          + +

          +isGreaterThan

          +
          +public boolean isGreaterThan(DeweyDecimal other)
          +
          +
          Return true if this DeweyDecimal is + greater than the other DeweyDecimal. +

          +

          +
          Parameters:
          other - the other DeweyDecimal +
          Returns:
          true if greater than other DeweyDecimal, false otherwise
          +
          +
          +
          + +

          +isGreaterThanOrEqual

          +
          +public boolean isGreaterThanOrEqual(DeweyDecimal other)
          +
          +
          Return true if this DeweyDecimal is + greater than or equal to the other DeweyDecimal. +

          +

          +
          Parameters:
          other - the other DeweyDecimal +
          Returns:
          true if greater than or equal to other DeweyDecimal, false otherwise
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Return string representation of DeweyDecimal. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the string representation of DeweyDecimal.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileNameMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileNameMapper.html new file mode 100644 index 000000000..5ea614e03 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileNameMapper.html @@ -0,0 +1,268 @@ + + + + + + +FileNameMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Interface FileNameMapper

          +
          +
          All Known Implementing Classes:
          ChainedMapper, CompositeMapper, ContainerMapper, CutDirsMapper, FilterMapper, FirstMatchMapper, FlatFileNameMapper, GlobPatternMapper, IdentityMapper, MergingMapper, PackageNameMapper, RegexpPatternMapper, ScriptMapper, UnPackageNameMapper
          +
          +
          +
          +
          public interface FileNameMapper
          + + +

          +Interface to be used by SourceFileScanner. + +

          Used to find the name of the target file(s) corresponding to a + source file.

          + +

          The rule by which the file names are transformed is specified + via the setFrom and setTo methods. The exact meaning of these is + implementation dependent.

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the + given source file.
          + voidsetFrom(java.lang.String from) + +
          +          Sets the from part of the transformation rule.
          + voidsetTo(java.lang.String to) + +
          +          Sets the to part of the transformation rule.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +void setFrom(java.lang.String from)
          +
          +
          Sets the from part of the transformation rule. +

          +

          +
          Parameters:
          from - a string.
          +
          +
          +
          + +

          +setTo

          +
          +void setTo(java.lang.String to)
          +
          +
          Sets the to part of the transformation rule. +

          +

          +
          Parameters:
          to - a string.
          +
          +
          +
          + +

          +mapFileName

          +
          +java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the + given source file. + +

          if the given rule doesn't apply to the source file, + implementation must return null. SourceFileScanner will then + omit the source file in question.

          +

          +

          +
          Parameters:
          sourceFileName - the name of the source file relative to + some given basedirectory. +
          Returns:
          an array of strings if the ruld applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileTokenizer.html new file mode 100644 index 000000000..b5356fe12 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileTokenizer.html @@ -0,0 +1,323 @@ + + + + + + +FileTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class FileTokenizer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.FileTokenizer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Tokenizer
          +
          +
          +
          Direct Known Subclasses:
          TokenFilter.FileTokenizer
          +
          +
          +
          +
          public class FileTokenizer
          extends ProjectComponent
          implements Tokenizer
          + + +

          +Class to read the complete input into a string. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          FileTokenizer() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetPostToken() + +
          +          Return the intra-token string
          + java.lang.StringgetToken(java.io.Reader in) + +
          +          Get the complete input as a string
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FileTokenizer

          +
          +public FileTokenizer()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getToken

          +
          +public java.lang.String getToken(java.io.Reader in)
+                          throws java.io.IOException
          +
          +
          Get the complete input as a string +

          +

          +
          Specified by:
          getToken in interface Tokenizer
          +
          +
          +
          Parameters:
          in - the reader object +
          Returns:
          the complete input +
          Throws: +
          java.io.IOException - if error reading
          +
          +
          +
          + +

          +getPostToken

          +
          +public java.lang.String getPostToken()
          +
          +
          Return the intra-token string +

          +

          +
          Specified by:
          getPostToken in interface Tokenizer
          +
          +
          + +
          Returns:
          an empty string always
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileUtils.html new file mode 100644 index 000000000..32353e728 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FileUtils.html @@ -0,0 +1,2443 @@ + + + + + + +FileUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class FileUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.FileUtils
+
          +
          +
          +
          public class FileUtils
          extends java.lang.Object
          + + +

          +This class also encapsulates methods which allow Files to be + referred to using abstract path names which are translated to native + system file paths at runtime as well as copying files or setting + their last modification time. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static longFAT_FILE_TIMESTAMP_GRANULARITY + +
          +          The granularity of timestamps under FAT.
          +static longNTFS_FILE_TIMESTAMP_GRANULARITY + +
          +          The granularity of timestamps under the NT File System.
          +static longUNIX_FILE_TIMESTAMP_GRANULARITY + +
          +          The granularity of timestamps under Unix.
          +  + + + + + + + + + + + +
          +Constructor Summary
          +protected FileUtils() + +
          +          Empty constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanareSame(java.io.File f1, + java.io.File f2) + +
          +          Are the two File instances pointing to the same object on the + file system?
          +static voidclose(java.nio.channels.Channel device) + +
          +          Close a Channel without throwing any exception if something went wrong.
          +static voidclose(java.io.InputStream device) + +
          +          Close a stream without throwing any exception if something went wrong.
          +static voidclose(java.io.OutputStream device) + +
          +          Close a stream without throwing any exception if something went wrong.
          +static voidclose(java.io.Reader device) + +
          +          Close a Reader without throwing any exception if something went wrong.
          +static voidclose(java.net.URLConnection conn) + +
          +          Closes an URLConnection if its concrete implementation provides + a way to close it that Ant knows of.
          +static voidclose(java.io.Writer device) + +
          +          Close a Writer without throwing any exception if something went wrong.
          + booleancontentEquals(java.io.File f1, + java.io.File f2) + +
          +          Compares the contents of two files.
          + booleancontentEquals(java.io.File f1, + java.io.File f2, + boolean textfile) + +
          +          Compares the contents of two files.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile) + +
          +          Convenience method to copy a file from a source to a destination.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters) + +
          +          Convenience method to copy a file from a source to a destination + specifying if token filtering must be used.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + boolean overwrite) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used and if + source files may overwrite newer destination files.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + boolean overwrite, + boolean preserveLastModified) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + source files may overwrite newer destination files and the + last modified time of destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + boolean overwrite, + boolean preserveLastModified, + java.lang.String encoding) + +
          +          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files, the last + modified time of destFile file should be made equal to the last modified time + of sourceFile and which character encoding to assume.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + boolean append, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + boolean append, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project, + boolean force) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + java.lang.String encoding, + Project project) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.io.File sourceFile, + java.io.File destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile) + +
          +          Convenience method to copy a file from a source to a destination.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters) + +
          +          Convenience method to copy a file from a source to a destination + specifying if token filtering must be used.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters, + boolean overwrite) + +
          +          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used and if source files may overwrite newer destination files.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters, + boolean overwrite, + boolean preserveLastModified) + +
          +          Convenience method to copy a file from a source to a destination + specifying if token + filtering must be used, if source files may overwrite newer destination + files and the last + modified time of destFile file should be made equal to + the last modified time + of sourceFile.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters, + boolean overwrite, + boolean preserveLastModified, + java.lang.String encoding) + +
          +          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files and the last + modified time of destFile file should be made equal to the last modified time + of sourceFile.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + java.lang.String encoding, + Project project) + +
          +          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile.
          + voidcopyFile(java.lang.String sourceFile, + java.lang.String destFile, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project) + +
          +          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if filter chains must be used, if source files may overwrite newer + destination files and the last modified time of destFile file should be made + equal to the last modified time of sourceFile.
          + booleancreateNewFile(java.io.File f) + +
          +          This was originally an emulation of File.createNewFile for JDK 1.1, + but it is now implemented using that method (Ant 1.6.3 onwards).
          + booleancreateNewFile(java.io.File f, + boolean mkdirs) + +
          +          Create a new file, optionally creating parent directories.
          + java.io.FilecreateTempFile(java.lang.String prefix, + java.lang.String suffix, + java.io.File parentDir) + +
          +          Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead.
          + java.io.FilecreateTempFile(java.lang.String prefix, + java.lang.String suffix, + java.io.File parentDir, + boolean deleteOnExit) + +
          +          Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead.
          + java.io.FilecreateTempFile(java.lang.String prefix, + java.lang.String suffix, + java.io.File parentDir, + boolean deleteOnExit, + boolean createFile) + +
          +          Create a temporary file in a given directory.
          +static voiddelete(java.io.File file) + +
          +          Delete the file with File.delete() if the argument is not null.
          + java.lang.String[]dissect(java.lang.String path) + +
          +          Dissect the specified absolute path.
          + booleanfileNameEquals(java.io.File f1, + java.io.File f2) + +
          +          Compares two filenames.
          + java.lang.StringfromURI(java.lang.String uri) + +
          +          Constructs a file path from a file: URI.
          + java.lang.StringgetDefaultEncoding() + +
          +          Get the default encoding.
          + longgetFileTimestampGranularity() + +
          +          Get the granularity of file timestamps.
          + java.net.URLgetFileURL(java.io.File file) + +
          +          Get the URL for a file taking into account # characters.
          +static FileUtilsgetFileUtils() + +
          +          Method to retrieve The FileUtils, which is shared by all users of this + method.
          + java.io.FilegetParentFile(java.io.File f) + +
          +          Deprecated. since 1.7. Just use File.getParentFile() directly.
          +static java.lang.StringgetPath(java.util.List pathStack) + +
          +          Gets path from a List of Strings.
          +static java.lang.StringgetPath(java.util.List pathStack, + char separatorChar) + +
          +          Gets path from a List of Strings.
          +static java.lang.String[]getPathStack(java.lang.String path) + +
          +          Gets all names of the path as an array of Strings.
          +static java.lang.StringgetRelativePath(java.io.File fromFile, + java.io.File toFile) + +
          +          Calculates the relative path between two files.
          + booleanhasErrorInCase(java.io.File localFile) + +
          +          test whether a file or directory exists, with an error in the + upper/lower case spelling of the name.
          +static booleanisAbsolutePath(java.lang.String filename) + +
          +          Verifies that the specified filename represents an absolute path.
          +static booleanisContextRelativePath(java.lang.String filename) + +
          +          On DOS and NetWare, the evaluation of certain file + specifications is context-dependent.
          + booleanisLeadingPath(java.io.File leading, + java.io.File path) + +
          +          Learn whether one path "leads" another.
          + booleanisSymbolicLink(java.io.File parent, + java.lang.String name) + +
          +          Deprecated. use SymbolicLinkUtils instead
          + booleanisUpToDate(java.io.File source, + java.io.File dest) + +
          +          Returns true if the source is older than the dest.
          + booleanisUpToDate(java.io.File source, + java.io.File dest, + long granularity) + +
          +          Returns true if the source is older than the dest.
          + booleanisUpToDate(long sourceTime, + long destTime) + +
          +          Compare two timestamps for being up to date using the + current granularity.
          + booleanisUpToDate(long sourceTime, + long destTime, + long granularity) + +
          +          Compare two timestamps for being up to date using + the specified granularity.
          +static FileUtilsnewFileUtils() + +
          +          Deprecated. since 1.7. + Use getFileUtils instead, + FileUtils do not have state.
          + java.io.Filenormalize(java.lang.String path) + +
          +          "Normalize" the given absolute path.
          +static java.lang.StringreadFully(java.io.Reader rdr) + +
          +          Read from reader till EOF.
          +static java.lang.StringreadFully(java.io.Reader rdr, + int bufferSize) + +
          +          Read from reader till EOF.
          + java.lang.StringremoveLeadingPath(java.io.File leading, + java.io.File path) + +
          +          Removes a leading path from a second path.
          + voidrename(java.io.File from, + java.io.File to) + +
          +          Renames a file, even if that involves crossing file system boundaries.
          + java.io.FileresolveFile(java.io.File file, + java.lang.String filename) + +
          +          Interpret the filename as a file relative to the given file + unless the filename already represents an absolute filename.
          +static java.lang.StringsafeReadFully(java.io.Reader reader) + +
          +          Safe read fully - do not return a null for an empty reader.
          + voidsetFileLastModified(java.io.File file, + long time) + +
          +          Calls File.setLastModified(long time).
          + java.lang.StringtoURI(java.lang.String path) + +
          +          Constructs a file: URI that represents the + external form of the given pathname.
          + java.lang.StringtoVMSPath(java.io.File f) + +
          +          Returns a VMS String representation of a File object.
          +static java.lang.StringtranslatePath(java.lang.String toProcess) + +
          +          Translate a path into its native (platform specific) format.
          + booleantryHardToDelete(java.io.File f) + +
          +          Accommodate Windows bug encountered in both Sun and IBM JDKs.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +FAT_FILE_TIMESTAMP_GRANULARITY

          +
          +public static final long FAT_FILE_TIMESTAMP_GRANULARITY
          +
          +
          The granularity of timestamps under FAT. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UNIX_FILE_TIMESTAMP_GRANULARITY

          +
          +public static final long UNIX_FILE_TIMESTAMP_GRANULARITY
          +
          +
          The granularity of timestamps under Unix. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +NTFS_FILE_TIMESTAMP_GRANULARITY

          +
          +public static final long NTFS_FILE_TIMESTAMP_GRANULARITY
          +
          +
          The granularity of timestamps under the NT File System. + NTFS has a granularity of 100 nanoseconds, which is less + than 1 millisecond, so we round this up to 1 millisecond. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +FileUtils

          +
          +protected FileUtils()
          +
          +
          Empty constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +newFileUtils

          +
          +public static FileUtils newFileUtils()
          +
          +
          Deprecated. since 1.7. + Use getFileUtils instead, + FileUtils do not have state. +

          +

          Factory method. +

          +

          + +
          Returns:
          a new instance of FileUtils.
          +
          +
          +
          + +

          +getFileUtils

          +
          +public static FileUtils getFileUtils()
          +
          +
          Method to retrieve The FileUtils, which is shared by all users of this + method. +

          +

          + +
          Returns:
          an instance of FileUtils.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +getFileURL

          +
          +public java.net.URL getFileURL(java.io.File file)
+                        throws java.net.MalformedURLException
          +
          +
          Get the URL for a file taking into account # characters. +

          +

          +
          Parameters:
          file - the file whose URL representation is required. +
          Returns:
          The FileURL value. +
          Throws: +
          java.net.MalformedURLException - if the URL representation cannot be + formed.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination. + No filtering is performed. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. + Must not be null.
          destFile - Name of file to copy to. + Must not be null. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination + specifying if token filtering must be used. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. + Must not be null.
          destFile - Name of file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used and if source files may overwrite newer destination files. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. Must not be null.
          destFile - Name of file to copy to. Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be overwritten if it already + exists. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite,
+                     boolean preserveLastModified)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination + specifying if token + filtering must be used, if source files may overwrite newer destination + files and the last + modified time of destFile file should be made equal to + the last modified time + of sourceFile. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. Must not be null.
          destFile - Name of file to copy to. Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file + should be set to that of the source file. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String encoding)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files and the last + modified time of destFile file should be made equal to the last modified time + of sourceFile. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. Must not be null.
          destFile - Name of file to copy to. Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be overwritten if it already + exists.
          preserveLastModified - Whether or not the last modified time of the resulting file + should be set to that of the source file.
          encoding - the encoding used to read and write the files. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String encoding,
+                     Project project)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. + Must not be null.
          destFile - Name of file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file.
          encoding - the encoding used to read and write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.lang.String sourceFile,
+                     java.lang.String destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String inputEncoding,
+                     java.lang.String outputEncoding,
+                     Project project)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if filter chains must be used, if source files may overwrite newer + destination files and the last modified time of destFile file should be made + equal to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - Name of file to copy from. Must not be null.
          destFile - Name of file to copy to. Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be overwritten if it already + exists.
          preserveLastModified - Whether or not the last modified time of the resulting file + should be set to that of the source file.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination. No filtering is performed. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. Must not be null.
          destFile - the file to copy to. Must not be null. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination + specifying if token filtering must be used. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used and if + source files may overwrite newer destination files. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite,
+                     boolean preserveLastModified)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + source files may overwrite newer destination files and the + last modified time of destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file. +
          Throws: +
          java.io.IOException - if the copying fails.
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String encoding)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a destination specifying if token + filtering must be used, if source files may overwrite newer destination files, the last + modified time of destFile file should be made equal to the last modified time + of sourceFile and which character encoding to assume. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. Must not be null.
          destFile - the file to copy to. Must not be null.
          filters - the collection of filters to apply to this copy.
          overwrite - Whether or not the destination file should be overwritten if it already + exists.
          preserveLastModified - Whether or not the last modified time of the resulting file + should be set to that of the source file.
          encoding - the encoding used to read and write the files. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String encoding,
+                     Project project)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file.
          encoding - the encoding used to read and write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     java.lang.String inputEncoding,
+                     java.lang.String outputEncoding,
+                     Project project)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     boolean append,
+                     java.lang.String inputEncoding,
+                     java.lang.String outputEncoding,
+                     Project project)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file.
          append - whether to append to the destination file.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.8
          +
          +
          +
          +
          + +

          +copyFile

          +
          +public void copyFile(java.io.File sourceFile,
+                     java.io.File destFile,
+                     FilterSetCollection filters,
+                     java.util.Vector filterChains,
+                     boolean overwrite,
+                     boolean preserveLastModified,
+                     boolean append,
+                     java.lang.String inputEncoding,
+                     java.lang.String outputEncoding,
+                     Project project,
+                     boolean force)
+              throws java.io.IOException
          +
          +
          Convenience method to copy a file from a source to a + destination specifying if token filtering must be used, if + filter chains must be used, if source files may overwrite + newer destination files and the last modified time of + destFile file should be made equal + to the last modified time of sourceFile. +

          +

          +
          Parameters:
          sourceFile - the file to copy from. + Must not be null.
          destFile - the file to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination file should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the resulting file should be set to that + of the source file.
          append - whether to append to the destination file.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance.
          force - whether to overwrite read-only destination files. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +setFileLastModified

          +
          +public void setFileLastModified(java.io.File file,
+                                long time)
          +
          +
          Calls File.setLastModified(long time). Originally written to + to dynamically bind to that call on Java1.2+. +

          +

          +
          Parameters:
          file - the file whose modified time is to be set
          time - the time to which the last modified time is to be set. + if this is -1, the current time is used.
          +
          +
          +
          + +

          +resolveFile

          +
          +public java.io.File resolveFile(java.io.File file,
+                                java.lang.String filename)
          +
          +
          Interpret the filename as a file relative to the given file + unless the filename already represents an absolute filename. + Differs from new File(file, filename) in that + the resulting File's path will always be a normalized, + absolute pathname. Also, if it is determined that + filename is context-relative, file + will be discarded and the reference will be resolved using + available context/state information about the filesystem. +

          +

          +
          Parameters:
          file - the "reference" file for relative paths. This + instance must be an absolute file and must not contain + "./" or "../" sequences (same for \ instead + of /). If it is null, this call is equivalent to + new java.io.File(filename).getAbsoluteFile().
          filename - a file name. +
          Returns:
          an absolute file. +
          Throws: +
          java.lang.NullPointerException - if filename is null.
          +
          +
          +
          + +

          +isContextRelativePath

          +
          +public static boolean isContextRelativePath(java.lang.String filename)
          +
          +
          On DOS and NetWare, the evaluation of certain file + specifications is context-dependent. These are filenames + beginning with a single separator (relative to current root directory) + and filenames with a drive specification and no intervening separator + (relative to current directory of the specified root). +

          +

          +
          Parameters:
          filename - the filename to evaluate. +
          Returns:
          true if the filename is relative to system context. +
          Throws: +
          java.lang.NullPointerException - if filename is null.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isAbsolutePath

          +
          +public static boolean isAbsolutePath(java.lang.String filename)
          +
          +
          Verifies that the specified filename represents an absolute path. + Differs from new java.io.File("filename").isAbsolute() in that a path + beginning with a double file separator--signifying a Windows UNC--must + at minimum match "\\a\b" to be considered an absolute path. +

          +

          +
          Parameters:
          filename - the filename to be checked. +
          Returns:
          true if the filename represents an absolute path. +
          Throws: +
          java.lang.NullPointerException - if filename is null.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +translatePath

          +
          +public static java.lang.String translatePath(java.lang.String toProcess)
          +
          +
          Translate a path into its native (platform specific) format. +

          + This method uses PathTokenizer to separate the input path + into its components. This handles DOS style paths in a relatively + sensible way. The file separators are then converted to their platform + specific versions. +

          +

          +
          Parameters:
          toProcess - The path to be translated. + May be null. +
          Returns:
          the native version of the specified path or + an empty string if the path is null or empty.
          Since:
          +
          ant 1.7
          +
          See Also:
          PathTokenizer
          +
          +
          +
          + +

          +normalize

          +
          +public java.io.File normalize(java.lang.String path)
          +
          +
          "Normalize" the given absolute path. + +

          This includes: +

            +
          • Uppercase the drive letter if there is one.
            • +
          • Remove redundant slashes after the drive spec.
            • +
          • Resolve all ./, .\, ../ and ..\ sequences.
            • +
          • DOS style paths that start with a drive letter will have + \ as the separator.
            • +
          + Unlike File.getCanonicalPath() this method + specifically does not resolve symbolic links. +

          +

          +
          Parameters:
          path - the path to be normalized. +
          Returns:
          the normalized version of the path. +
          Throws: +
          java.lang.NullPointerException - if path is null.
          +
          +
          +
          + +

          +dissect

          +
          +public java.lang.String[] dissect(java.lang.String path)
          +
          +
          Dissect the specified absolute path. +

          +

          +
          Parameters:
          path - the path to dissect. +
          Returns:
          String[] {root, remaining path}. +
          Throws: +
          java.lang.NullPointerException - if path is null.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +toVMSPath

          +
          +public java.lang.String toVMSPath(java.io.File f)
          +
          +
          Returns a VMS String representation of a File object. + This is useful since the JVM by default internally converts VMS paths + to Unix style. + The returned String is always an absolute path. +

          +

          +
          Parameters:
          f - The File to get the VMS path for. +
          Returns:
          The absolute VMS path to f.
          +
          +
          +
          + +

          +createTempFile

          +
          +public java.io.File createTempFile(java.lang.String prefix,
+                                   java.lang.String suffix,
+                                   java.io.File parentDir)
          +
          +
          Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. +

          +

          Create a File object for a temporary file in a given directory. Without + actually creating the file. + +

          + The file denoted by the returned abstract pathname did not exist before + this method was invoked, any subsequent invocation of this method will + yield a different file name. +

          +

          + The filename is prefixNNNNNsuffix where NNNN is a random number. +

          +

          +

          +
          Parameters:
          prefix - prefix before the random number.
          suffix - file extension; include the '.'.
          parentDir - Directory to create the temporary file in; java.io.tmpdir used + if not specified. +
          Returns:
          a File reference to the new, nonexistent temporary file.
          +
          +
          +
          + +

          +createTempFile

          +
          +public java.io.File createTempFile(java.lang.String prefix,
+                                   java.lang.String suffix,
+                                   java.io.File parentDir,
+                                   boolean deleteOnExit,
+                                   boolean createFile)
          +
          +
          Create a temporary file in a given directory. + +

          The file denoted by the returned abstract pathname did not + exist before this method was invoked, any subsequent invocation + of this method will yield a different file name.

          +

          +

          +
          Parameters:
          prefix - prefix before the random number.
          suffix - file extension; include the '.'.
          parentDir - Directory to create the temporary file in; + java.io.tmpdir used if not specified.
          deleteOnExit - whether to set the tempfile for deletion on + normal VM exit.
          createFile - true if the file must actually be created. If false + chances exist that a file with the same name is created in the time + between invoking this method and the moment the file is actually created. + If possible set to true. +
          Returns:
          a File reference to the new temporary file.
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +createTempFile

          +
          +public java.io.File createTempFile(java.lang.String prefix,
+                                   java.lang.String suffix,
+                                   java.io.File parentDir,
+                                   boolean deleteOnExit)
          +
          +
          Deprecated. since ant 1.7.1 use createTempFile(String, String, File, + boolean, boolean) instead. +

          +

          Create a File object for a temporary file in a given directory. Without + actually creating the file. + +

          + The file denoted by the returned abstract pathname did not exist before + this method was invoked, any subsequent invocation of this method will + yield a different file name. +

          +

          + The filename is prefixNNNNNsuffix where NNNN is a random number. +

          +

          +

          +
          Parameters:
          prefix - prefix before the random number.
          suffix - file extension; include the '.'.
          parentDir - Directory to create the temporary file in; java.io.tmpdir used + if not specified.
          deleteOnExit - whether to set the tempfile for deletion on normal VM exit. +
          Returns:
          a File reference to the new, nonexistent temporary file.
          +
          +
          +
          + +

          +contentEquals

          +
          +public boolean contentEquals(java.io.File f1,
+                             java.io.File f2)
+                      throws java.io.IOException
          +
          +
          Compares the contents of two files. +

          +

          +
          Parameters:
          f1 - the file whose content is to be compared.
          f2 - the other file whose content is to be compared. +
          Returns:
          true if the content of the files is the same. +
          Throws: +
          java.io.IOException - if the files cannot be read.
          +
          +
          +
          + +

          +contentEquals

          +
          +public boolean contentEquals(java.io.File f1,
+                             java.io.File f2,
+                             boolean textfile)
+                      throws java.io.IOException
          +
          +
          Compares the contents of two files. +

          +

          +
          Parameters:
          f1 - the file whose content is to be compared.
          f2 - the other file whose content is to be compared.
          textfile - true if the file is to be treated as a text file and + differences in kind of line break are to be ignored. +
          Returns:
          true if the content of the files is the same. +
          Throws: +
          java.io.IOException - if the files cannot be read.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +getParentFile

          +
          +public java.io.File getParentFile(java.io.File f)
          +
          +
          Deprecated. since 1.7. Just use File.getParentFile() directly. +

          +

          This was originally an emulation of File.getParentFile() for JDK 1.1, but it is now + implemented using that method (Ant 1.6.3 onwards). +

          +

          +
          Parameters:
          f - the file whose parent is required. +
          Returns:
          the given file's parent, or null if the file does not have a parent.
          Since:
          +
          1.10
          +
          +
          +
          +
          + +

          +readFully

          +
          +public static java.lang.String readFully(java.io.Reader rdr)
+                                  throws java.io.IOException
          +
          +
          Read from reader till EOF. +

          +

          +
          Parameters:
          rdr - the reader from which to read. +
          Returns:
          the contents read out of the given reader. +
          Throws: +
          java.io.IOException - if the contents could not be read out from the + reader.
          +
          +
          +
          + +

          +readFully

          +
          +public static java.lang.String readFully(java.io.Reader rdr,
+                                         int bufferSize)
+                                  throws java.io.IOException
          +
          +
          Read from reader till EOF. +

          +

          +
          Parameters:
          rdr - the reader from which to read.
          bufferSize - the buffer size to use when reading. +
          Returns:
          the contents read out of the given reader. +
          Throws: +
          java.io.IOException - if the contents could not be read out from the + reader.
          +
          +
          +
          + +

          +safeReadFully

          +
          +public static java.lang.String safeReadFully(java.io.Reader reader)
+                                      throws java.io.IOException
          +
          +
          Safe read fully - do not return a null for an empty reader. +

          +

          +
          Parameters:
          reader - the input to read from. +
          Returns:
          the string. +
          Throws: +
          java.io.IOException - if unable to read from reader.
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +createNewFile

          +
          +public boolean createNewFile(java.io.File f)
+                      throws java.io.IOException
          +
          +
          This was originally an emulation of File.createNewFile for JDK 1.1, + but it is now implemented using that method (Ant 1.6.3 onwards). + +

          This method has historically not guaranteed that the + operation was atomic. In its current implementation it is. +

          +

          +
          Parameters:
          f - the file to be created. +
          Returns:
          true if the file did not exist already. +
          Throws: +
          java.io.IOException - on error.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +createNewFile

          +
          +public boolean createNewFile(java.io.File f,
+                             boolean mkdirs)
+                      throws java.io.IOException
          +
          +
          Create a new file, optionally creating parent directories. +

          +

          +
          Parameters:
          f - the file to be created.
          mkdirs - boolean whether to create parent directories. +
          Returns:
          true if the file did not exist already. +
          Throws: +
          java.io.IOException - on error.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink(java.io.File parent,
+                              java.lang.String name)
+                       throws java.io.IOException
          +
          +
          Deprecated. use SymbolicLinkUtils instead +

          +

          Checks whether a given file is a symbolic link. + +

          It doesn't really test for symbolic links but whether the + canonical and absolute paths of the file are identical--this + may lead to false positives on some platforms.

          +

          +

          +
          Parameters:
          parent - the parent directory of the file to test
          name - the name of the file to test. +
          Returns:
          true if the file is a symbolic link. +
          Throws: +
          java.io.IOException - on error.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +removeLeadingPath

          +
          +public java.lang.String removeLeadingPath(java.io.File leading,
+                                          java.io.File path)
          +
          +
          Removes a leading path from a second path. +

          +

          +
          Parameters:
          leading - The leading path, must not be null, must be absolute.
          path - The path to remove from, must not be null, must be absolute. +
          Returns:
          path's normalized absolute if it doesn't start with + leading; path's path with leading's path removed otherwise.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +isLeadingPath

          +
          +public boolean isLeadingPath(java.io.File leading,
+                             java.io.File path)
          +
          +
          Learn whether one path "leads" another. +

          +

          +
          Parameters:
          leading - The leading path, must not be null, must be absolute.
          path - The path to remove from, must not be null, must be absolute. +
          Returns:
          true if path starts with leading; false otherwise.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +toURI

          +
          +public java.lang.String toURI(java.lang.String path)
          +
          +
          Constructs a file: URI that represents the + external form of the given pathname. + +

          Will be an absolute URI if the given path is absolute.

          + +

          This code encodes non ASCII characters too.

          + +

          The coding of the output is the same as what File.toURI().toASCIIString() produces

          + + See dt-sysid + which makes some mention of how + characters not supported by URI Reference syntax should be escaped. +

          +

          +
          Parameters:
          path - the path in the local file system. +
          Returns:
          the URI version of the local path.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +fromURI

          +
          +public java.lang.String fromURI(java.lang.String uri)
          +
          +
          Constructs a file path from a file: URI. + +

          Will be an absolute path if the given URI is absolute.

          + +

          Swallows '%' that are not followed by two characters, + doesn't deal with non-ASCII characters.

          +

          +

          +
          Parameters:
          uri - the URI designating a file in the local filesystem. +
          Returns:
          the local file system path for the file.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +fileNameEquals

          +
          +public boolean fileNameEquals(java.io.File f1,
+                              java.io.File f2)
          +
          +
          Compares two filenames. + +

          Unlike java.io.File#equals this method will try to compare + the absolute paths and "normalize" the filenames + before comparing them.

          +

          +

          +
          Parameters:
          f1 - the file whose name is to be compared.
          f2 - the other file whose name is to be compared. +
          Returns:
          true if the file are for the same file.
          Since:
          +
          Ant 1.5.3
          +
          +
          +
          +
          + +

          +areSame

          +
          +public boolean areSame(java.io.File f1,
+                       java.io.File f2)
+                throws java.io.IOException
          +
          +
          Are the two File instances pointing to the same object on the + file system? +

          +

          + +
          Throws: +
          java.io.IOException
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +rename

          +
          +public void rename(java.io.File from,
+                   java.io.File to)
+            throws java.io.IOException
          +
          +
          Renames a file, even if that involves crossing file system boundaries. + +

          This will remove to (if it exists), ensure that + to's parent directory exists and move + from, which involves deleting from as + well.

          +

          +

          +
          Parameters:
          from - the file to move.
          to - the new file name. +
          Throws: +
          java.io.IOException - if anything bad happens during this + process. Note that to may have been deleted + already when this happens.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getFileTimestampGranularity

          +
          +public long getFileTimestampGranularity()
          +
          +
          Get the granularity of file timestamps. The choice is made based on OS, which is + incorrect--it should really be by filesystem. We do not have an easy way to probe for file + systems, however, so this heuristic gives us a decent default. +

          +

          + +
          Returns:
          the difference, in milliseconds, which two file timestamps must have in order for the + two files to be considered to have different timestamps.
          +
          +
          +
          + +

          +hasErrorInCase

          +
          +public boolean hasErrorInCase(java.io.File localFile)
          +
          +
          test whether a file or directory exists, with an error in the + upper/lower case spelling of the name. + Using this method is only interesting on case insensitive file systems + (Windows).
          + It will return true only if 3 conditions are met : +
          +
            +
          • operating system is case insensitive
            • +
          • file exists
            • +
          • actual name from directory reading is different from the + supplied argument
            • +
          +
          + the purpose is to identify files or directories on case-insensitive + filesystems whose case is not what is expected.
          + Possibly to rename them afterwards to the desired upper/lowercase + combination. +
          +

          +

          +
          Parameters:
          localFile - file to test +
          Returns:
          true if the file exists and the case of the actual file + is not the case of the parameter
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +isUpToDate

          +
          +public boolean isUpToDate(java.io.File source,
+                          java.io.File dest,
+                          long granularity)
          +
          +
          Returns true if the source is older than the dest. + If the dest file does not exist, then the test returns false; it is + implicitly not up do date. +

          +

          +
          Parameters:
          source - source file (should be the older).
          dest - dest file (should be the newer).
          granularity - an offset added to the source time. +
          Returns:
          true if the source is older than the dest after accounting + for granularity.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +isUpToDate

          +
          +public boolean isUpToDate(java.io.File source,
+                          java.io.File dest)
          +
          +
          Returns true if the source is older than the dest. +

          +

          +
          Parameters:
          source - source file (should be the older).
          dest - dest file (should be the newer). +
          Returns:
          true if the source is older than the dest, taking the granularity into account.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +isUpToDate

          +
          +public boolean isUpToDate(long sourceTime,
+                          long destTime,
+                          long granularity)
          +
          +
          Compare two timestamps for being up to date using + the specified granularity. +

          +

          +
          Parameters:
          sourceTime - timestamp of source file.
          destTime - timestamp of dest file.
          granularity - os/filesys granularity. +
          Returns:
          true if the dest file is considered up to date.
          +
          +
          +
          + +

          +isUpToDate

          +
          +public boolean isUpToDate(long sourceTime,
+                          long destTime)
          +
          +
          Compare two timestamps for being up to date using the + current granularity. +

          +

          +
          Parameters:
          sourceTime - timestamp of source file.
          destTime - timestamp of dest file. +
          Returns:
          true if the dest file is considered up to date.
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.io.Writer device)
          +
          +
          Close a Writer without throwing any exception if something went wrong. + Do not attempt to close it if the argument is null. +

          +

          +
          Parameters:
          device - output writer, can be null.
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.io.Reader device)
          +
          +
          Close a Reader without throwing any exception if something went wrong. + Do not attempt to close it if the argument is null. +

          +

          +
          Parameters:
          device - Reader, can be null.
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.io.OutputStream device)
          +
          +
          Close a stream without throwing any exception if something went wrong. + Do not attempt to close it if the argument is null. +

          +

          +
          Parameters:
          device - stream, can be null.
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.io.InputStream device)
          +
          +
          Close a stream without throwing any exception if something went wrong. + Do not attempt to close it if the argument is null. +

          +

          +
          Parameters:
          device - stream, can be null.
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.nio.channels.Channel device)
          +
          +
          Close a Channel without throwing any exception if something went wrong. + Do not attempt to close it if the argument is null. +

          +

          +
          Parameters:
          device - channel, can be null.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +close

          +
          +public static void close(java.net.URLConnection conn)
          +
          +
          Closes an URLConnection if its concrete implementation provides + a way to close it that Ant knows of. +

          +

          +
          Parameters:
          conn - connection, can be null
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +delete

          +
          +public static void delete(java.io.File file)
          +
          +
          Delete the file with File.delete() if the argument is not null. + Do nothing on a null argument. +

          +

          +
          Parameters:
          file - file to delete.
          +
          +
          +
          + +

          +tryHardToDelete

          +
          +public boolean tryHardToDelete(java.io.File f)
          +
          +
          Accommodate Windows bug encountered in both Sun and IBM JDKs. + Others possible. If the delete does not work, call System.gc(), + wait a little and try again. +

          +

          + +
          Returns:
          whether deletion was successful
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +getRelativePath

          +
          +public static java.lang.String getRelativePath(java.io.File fromFile,
+                                               java.io.File toFile)
+                                        throws java.lang.Exception
          +
          +
          Calculates the relative path between two files. +

          + Implementation note:
          This function may throw an IOException if an I/O error occurs + because its use of the canonical pathname may require filesystem queries. +

          +

          +

          +
          Parameters:
          fromFile - the File to calculate the path from
          toFile - the File to calculate the path to +
          Returns:
          the relative path between the files +
          Throws: +
          java.lang.Exception - for undocumented reasons
          Since:
          +
          Ant 1.7
          +
          See Also:
          File.getCanonicalPath()
          +
          +
          +
          + +

          +getPathStack

          +
          +public static java.lang.String[] getPathStack(java.lang.String path)
          +
          +
          Gets all names of the path as an array of Strings. +

          +

          +
          Parameters:
          path - to get names from +
          Returns:
          Strings, never null
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getPath

          +
          +public static java.lang.String getPath(java.util.List pathStack)
          +
          +
          Gets path from a List of Strings. +

          +

          +
          Parameters:
          pathStack - List of Strings to be concatenated as a path. +
          Returns:
          String, never null
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getPath

          +
          +public static java.lang.String getPath(java.util.List pathStack,
+                                       char separatorChar)
          +
          +
          Gets path from a List of Strings. +

          +

          +
          Parameters:
          pathStack - List of Strings to be concated as a path.
          separatorChar - char to be used as separator between names in path +
          Returns:
          String, never null
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +getDefaultEncoding

          +
          +public java.lang.String getDefaultEncoding()
          +
          +
          Get the default encoding. + This is done by opening an InputStreamReader on + a dummy InputStream and getting the encoding. + Could use System.getProperty("file.encoding"), but cannot + see where this is documented. +

          +

          + +
          Returns:
          the default file encoding.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FirstMatchMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FirstMatchMapper.html new file mode 100644 index 000000000..c931ec350 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FirstMatchMapper.html @@ -0,0 +1,280 @@ + + + + + + +FirstMatchMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class FirstMatchMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ContainerMapper
+      extended by org.apache.tools.ant.util.FirstMatchMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class FirstMatchMapper
          extends ContainerMapper
          + + +

          +A ContainerMapper that returns the results of its + first constituent FileNameMappers that matches. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FirstMatchMapper() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an array containing the target filename(s) for the + given source file..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ContainerMapper
          add, addConfigured, addConfiguredMapper, contains, getMappers, setFrom, setTo
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FirstMatchMapper

          +
          +public FirstMatchMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an array containing the target filename(s) for the + given source file. + +

          if the given rule doesn't apply to the source file, + implementation must return null. SourceFileScanner will then + omit the source file in question.

          . +

          +

          +
          Parameters:
          sourceFileName - the name of the source file relative to + some given basedirectory. +
          Returns:
          an array of strings if the ruld applies to the source file, or + null if it does not.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FlatFileNameMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FlatFileNameMapper.html new file mode 100644 index 000000000..a3dbacec7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/FlatFileNameMapper.html @@ -0,0 +1,314 @@ + + + + + + +FlatFileNameMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class FlatFileNameMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.FlatFileNameMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class FlatFileNameMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +Implementation of FileNameMapper that always returns the source + file name without any leading directory information. + +

          This is the default FileNameMapper for the copy and move + tasks if the flatten attribute has been set.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          FlatFileNameMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an one-element array containing the source file name + without any leading directory information.
          + voidsetFrom(java.lang.String from) + +
          +          Ignored.
          + voidsetTo(java.lang.String to) + +
          +          Ignored.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FlatFileNameMapper

          +
          +public FlatFileNameMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Ignored. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - ignored.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Ignored. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - ignored.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an one-element array containing the source file name + without any leading directory information. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the name to map. +
          Returns:
          the file name in a one-element array.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/GlobPatternMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/GlobPatternMapper.html new file mode 100644 index 000000000..c75de0444 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/GlobPatternMapper.html @@ -0,0 +1,545 @@ + + + + + + +GlobPatternMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class GlobPatternMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.GlobPatternMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          Direct Known Subclasses:
          PackageNameMapper, UnPackageNameMapper
          +
          +
          +
          +
          public class GlobPatternMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +Implementation of FileNameMapper that does simple wildcard pattern + replacements. + +

          This does simple translations like *.foo -> *.bar where the + prefix to .foo will be left unchanged. It only handles a single * + character, use regular expressions for more complicated + situations.

          + +

          This is one of the more useful Mappers, it is used by javac for + example.

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.StringfromPostfix + +
          +          Part of "from" pattern after the *.
          +protected  java.lang.StringfromPrefix + +
          +          Part of "from" pattern before the *.
          +protected  intpostfixLength + +
          +          Length of the postfix ("from" pattern).
          +protected  intprefixLength + +
          +          Length of the prefix ("from" pattern).
          +protected  java.lang.StringtoPostfix + +
          +          Part of "to" pattern after the *.
          +protected  java.lang.StringtoPrefix + +
          +          Part of "to" pattern before the *.
          +  + + + + + + + + + + +
          +Constructor Summary
          GlobPatternMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringextractVariablePart(java.lang.String name) + +
          +          Returns the part of the given string that matches the * in the + "from" pattern.
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise.
          + voidsetCaseSensitive(boolean caseSensitive) + +
          +          Attribute specifing whether to ignore the case difference + in the names.
          + voidsetFrom(java.lang.String from) + +
          +          Sets the "from" pattern.
          + voidsetHandleDirSep(boolean handleDirSep) + +
          +          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters).
          + voidsetTo(java.lang.String to) + +
          +          Sets the "to" pattern.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +fromPrefix

          +
          +protected java.lang.String fromPrefix
          +
          +
          Part of "from" pattern before the *. +

          +

          +
          +
          +
          + +

          +fromPostfix

          +
          +protected java.lang.String fromPostfix
          +
          +
          Part of "from" pattern after the *. +

          +

          +
          +
          +
          + +

          +prefixLength

          +
          +protected int prefixLength
          +
          +
          Length of the prefix ("from" pattern). +

          +

          +
          +
          +
          + +

          +postfixLength

          +
          +protected int postfixLength
          +
          +
          Length of the postfix ("from" pattern). +

          +

          +
          +
          +
          + +

          +toPrefix

          +
          +protected java.lang.String toPrefix
          +
          +
          Part of "to" pattern before the *. +

          +

          +
          +
          +
          + +

          +toPostfix

          +
          +protected java.lang.String toPostfix
          +
          +
          Part of "to" pattern after the *. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +GlobPatternMapper

          +
          +public GlobPatternMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setHandleDirSep

          +
          +public void setHandleDirSep(boolean handleDirSep)
          +
          +
          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +

          +

          +
          +
          +
          +
          Parameters:
          handleDirSep - a boolean, default is false.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean caseSensitive)
          +
          +
          Attribute specifing whether to ignore the case difference + in the names. +

          +

          +
          +
          +
          +
          Parameters:
          caseSensitive - a boolean, default is false.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Sets the "from" pattern. Required. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - a string
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Sets the "to" pattern. Required. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - a string
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the filename to map +
          Returns:
          a list of converted filenames
          +
          +
          +
          + +

          +extractVariablePart

          +
          +protected java.lang.String extractVariablePart(java.lang.String name)
          +
          +
          Returns the part of the given string that matches the * in the + "from" pattern. +

          +

          +
          +
          +
          +
          Parameters:
          name - the source file name +
          Returns:
          the variable part of the name
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityMapper.html new file mode 100644 index 000000000..c2a7e034d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityMapper.html @@ -0,0 +1,311 @@ + + + + + + +IdentityMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class IdentityMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.IdentityMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class IdentityMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +Implementation of FileNameMapper that always returns the source file name. + +

          This is the default FileNameMapper for the copy and move + tasks.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          IdentityMapper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an one-element array containing the source file name.
          + voidsetFrom(java.lang.String from) + +
          +          Ignored.
          + voidsetTo(java.lang.String to) + +
          +          Ignored.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +IdentityMapper

          +
          +public IdentityMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Ignored. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - ignored.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Ignored. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - ignored.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an one-element array containing the source file name. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the name to map. +
          Returns:
          the source filename in a one-element array.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityStack.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityStack.html new file mode 100644 index 000000000..4494ff425 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/IdentityStack.html @@ -0,0 +1,429 @@ + + + + + + +IdentityStack (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class IdentityStack

          +
          +java.lang.Object
+  extended by java.util.AbstractCollection<E>
+      extended by java.util.AbstractList<E>
+          extended by java.util.Vector<E>
+              extended by java.util.Stack
+                  extended by org.apache.tools.ant.util.IdentityStack
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess
          +
          +
          +
          +
          public class IdentityStack
          extends java.util.Stack
          + + +

          +Identity Stack. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.util.Vector
          capacityIncrement, elementCount, elementData
          +  + + + + + + + +
          Fields inherited from class java.util.AbstractList
          modCount
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          IdentityStack() + +
          +          Default constructor.
          IdentityStack(java.lang.Object o) + +
          +          Construct a new IdentityStack with the specified Object + as the bottom element.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleancontains(java.lang.Object o) + +
          +          Override methods that use .equals() comparisons on elements.
          +static IdentityStackgetInstance(java.util.Stack s) + +
          +          Get an IdentityStack containing the contents of the specified Stack.
          + intindexOf(java.lang.Object o, + int pos) + +
          +          Override methods that use .equals() comparisons on elements.
          + intlastIndexOf(java.lang.Object o, + int pos) + +
          +          Override methods that use .equals() comparisons on elements.
          +  + + + + + + + +
          Methods inherited from class java.util.Stack
          empty, peek, pop, push, search
          +  + + + + + + + +
          Methods inherited from class java.util.Vector
          add, add, addAll, addAll, addElement, capacity, clear, clone, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
          +  + + + + + + + +
          Methods inherited from class java.util.AbstractList
          iterator, listIterator, listIterator
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface java.util.List
          iterator, listIterator, listIterator
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +IdentityStack

          +
          +public IdentityStack()
          +
          +
          Default constructor. +

          +

          +
          + +

          +IdentityStack

          +
          +public IdentityStack(java.lang.Object o)
          +
          +
          Construct a new IdentityStack with the specified Object + as the bottom element. +

          +

          +
          Parameters:
          o - the bottom element.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getInstance

          +
          +public static IdentityStack getInstance(java.util.Stack s)
          +
          +
          Get an IdentityStack containing the contents of the specified Stack. +

          +

          +
          Parameters:
          s - the Stack to copy; ignored if null. +
          Returns:
          an IdentityStack instance.
          +
          +
          +
          + +

          +contains

          +
          +public boolean contains(java.lang.Object o)
          +
          +
          Override methods that use .equals() comparisons on elements. +

          +

          +
          Specified by:
          contains in interface java.util.Collection
          Specified by:
          contains in interface java.util.List
          Overrides:
          contains in class java.util.Vector
          +
          +
          +
          Parameters:
          o - the Object to search for. +
          Returns:
          true if the stack contains the object.
          See Also:
          Vector.contains(Object)
          +
          +
          +
          + +

          +indexOf

          +
          +public int indexOf(java.lang.Object o,
+                   int pos)
          +
          +
          Override methods that use .equals() comparisons on elements. +

          +

          +
          Overrides:
          indexOf in class java.util.Vector
          +
          +
          +
          Parameters:
          o - the Object to search for.
          pos - the position from which to search. +
          Returns:
          the position of the object, -1 if not found.
          See Also:
          Vector.indexOf(Object, int)
          +
          +
          +
          + +

          +lastIndexOf

          +
          +public int lastIndexOf(java.lang.Object o,
+                       int pos)
          +
          +
          Override methods that use .equals() comparisons on elements. +

          +

          +
          Overrides:
          lastIndexOf in class java.util.Vector
          +
          +
          +
          Parameters:
          o - the Object to search for.
          pos - the position from which to search (backward). +
          Returns:
          the position of the object, -1 if not found.
          See Also:
          Vector.indexOf(Object, int)
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JAXPUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JAXPUtils.html new file mode 100644 index 000000000..9df9c7dcd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JAXPUtils.html @@ -0,0 +1,462 @@ + + + + + + +JAXPUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class JAXPUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.JAXPUtils
+
          +
          +
          +
          public class JAXPUtils
          extends java.lang.Object
          + + +

          +Collection of helper methods that retrieve a ParserFactory or + Parsers and Readers. + +

          This class will create only a single factory instance.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JAXPUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static javax.xml.parsers.DocumentBuildergetDocumentBuilder() + +
          +          Returns a newly created DocumentBuilder.
          +static org.xml.sax.XMLReadergetNamespaceXMLReader() + +
          +          Returns a newly created SAX 2 XMLReader, which is namespace aware
          +static javax.xml.parsers.SAXParserFactorygetNSParserFactory() + +
          +          Returns the parser factory to use to create namespace aware parsers.
          +static org.xml.sax.ParsergetParser() + +
          +          Returns a newly created SAX 1 Parser, using the default parser + factory.
          +static javax.xml.parsers.SAXParserFactorygetParserFactory() + +
          +          Returns the parser factory to use.
          +static java.lang.StringgetSystemId(java.io.File file) + +
          +          This is a best attempt to provide a URL.toExternalForm() from + a file URL.
          +static org.xml.sax.XMLReadergetXMLReader() + +
          +          Returns a newly created SAX 2 XMLReader, using the default parser + factory.
          +static javax.xml.parsers.SAXParserFactorynewParserFactory() + +
          +          Returns a new parser factory instance.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JAXPUtils

          +
          +public JAXPUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getParserFactory

          +
          +public static javax.xml.parsers.SAXParserFactory getParserFactory()
+                                                           throws BuildException
          +
          +
          Returns the parser factory to use. Only one parser factory is + ever created by this method and is then cached for future use. +

          +

          + +
          Returns:
          a SAXParserFactory to use. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +getNSParserFactory

          +
          +public static javax.xml.parsers.SAXParserFactory getNSParserFactory()
+                                                             throws BuildException
          +
          +
          Returns the parser factory to use to create namespace aware parsers. +

          +

          + +
          Returns:
          a SAXParserFactory to use which supports manufacture of + namespace aware parsers. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +newParserFactory

          +
          +public static javax.xml.parsers.SAXParserFactory newParserFactory()
+                                                           throws BuildException
          +
          +
          Returns a new parser factory instance. +

          +

          + +
          Returns:
          the parser factory. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +getParser

          +
          +public static org.xml.sax.Parser getParser()
+                                    throws BuildException
          +
          +
          Returns a newly created SAX 1 Parser, using the default parser + factory. +

          +

          + +
          Returns:
          a SAX 1 Parser. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.5
          +
          See Also:
          getParserFactory()
          +
          +
          +
          + +

          +getXMLReader

          +
          +public static org.xml.sax.XMLReader getXMLReader()
+                                          throws BuildException
          +
          +
          Returns a newly created SAX 2 XMLReader, using the default parser + factory. +

          +

          + +
          Returns:
          a SAX 2 XMLReader. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.5
          +
          See Also:
          getParserFactory()
          +
          +
          +
          + +

          +getNamespaceXMLReader

          +
          +public static org.xml.sax.XMLReader getNamespaceXMLReader()
+                                                   throws BuildException
          +
          +
          Returns a newly created SAX 2 XMLReader, which is namespace aware +

          +

          + +
          Returns:
          a SAX 2 XMLReader. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.6
          +
          See Also:
          getParserFactory()
          +
          +
          +
          + +

          +getSystemId

          +
          +public static java.lang.String getSystemId(java.io.File file)
          +
          +
          This is a best attempt to provide a URL.toExternalForm() from + a file URL. Some parsers like Crimson choke on uri that are made of + backslashed paths (ie windows) as it is does not conform + URI specifications. +

          +

          +
          Parameters:
          file - the file to create the system id from. +
          Returns:
          the systemid corresponding to the given file.
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +getDocumentBuilder

          +
          +public static javax.xml.parsers.DocumentBuilder getDocumentBuilder()
+                                                            throws BuildException
          +
          +
          Returns a newly created DocumentBuilder. +

          +

          + +
          Returns:
          a DocumentBuilder. +
          Throws: +
          BuildException - on error.
          Since:
          +
          Ant 1.6
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JavaEnvUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JavaEnvUtils.html new file mode 100644 index 000000000..48c4ea888 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/JavaEnvUtils.html @@ -0,0 +1,885 @@ + + + + + + +JavaEnvUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class JavaEnvUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.JavaEnvUtils
+
          +
          +
          +
          public final class JavaEnvUtils
          extends java.lang.Object
          + + +

          +A set of helper methods related to locating executables or checking + conditons of a given Java installation. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringJAVA_1_0 + +
          +          Version constant for Java 1.0
          +static java.lang.StringJAVA_1_1 + +
          +          Version constant for Java 1.1
          +static java.lang.StringJAVA_1_2 + +
          +          Version constant for Java 1.2
          +static java.lang.StringJAVA_1_3 + +
          +          Version constant for Java 1.3
          +static java.lang.StringJAVA_1_4 + +
          +          Version constant for Java 1.4
          +static java.lang.StringJAVA_1_5 + +
          +          Version constant for Java 1.5
          +static java.lang.StringJAVA_1_6 + +
          +          Version constant for Java 1.6
          +static java.lang.StringJAVA_1_7 + +
          +          Version constant for Java 1.7
          +static intVERSION_1_0 + +
          +          Number Version constant for Java 1.0
          +static intVERSION_1_1 + +
          +          Number Version constant for Java 1.1
          +static intVERSION_1_2 + +
          +          Number Version constant for Java 1.2
          +static intVERSION_1_3 + +
          +          Number Version constant for Java 1.3
          +static intVERSION_1_4 + +
          +          Number Version constant for Java 1.4
          +static intVERSION_1_5 + +
          +          Number Version constant for Java 1.5
          +static intVERSION_1_6 + +
          +          Number Version constant for Java 1.6
          +static intVERSION_1_7 + +
          +          Number Version constant for Java 1.7
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.io.FilecreateVmsJavaOptionFile(java.lang.String[] cmd) + +
          +          Writes the command into a temporary DCL script and returns the + corresponding File object.
          +static java.lang.StringgetJavaHome() + +
          +          Return the value of ${java.home}
          +static java.lang.StringgetJavaVersion() + +
          +          Returns the version of Java this class is running under.
          +static intgetJavaVersionNumber() + +
          +          Returns the version of Java this class is running under.
          +static java.lang.StringgetJdkExecutable(java.lang.String command) + +
          +          Finds an executable that is part of a JDK installation based on + the java.home system property.
          +static java.lang.StringgetJreExecutable(java.lang.String command) + +
          +          Finds an executable that is part of a JRE installation based on + the java.home system property.
          +static java.util.VectorgetJrePackages() + +
          +          get a vector of strings of packages built into + that platforms runtime jar(s)
          +static java.util.VectorgetJrePackageTestCases() + +
          +          Testing helper method; kept here for unification of changes.
          +static booleanisApacheHarmony() + +
          +          Checks whether the current VM is Apache Harmony.
          +static booleanisAtLeastJavaVersion(java.lang.String version) + +
          +          Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class.
          +static booleanisGij() + +
          +          Checks whether the current Java VM is the GNU interpreter gij + or we are running in a gcj precompiled binary.
          +static booleanisJavaVersion(java.lang.String version) + +
          +          Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class.
          +static booleanisKaffe() + +
          +          Checks whether the current Java VM is Kaffe.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +JAVA_1_0

          +
          +public static final java.lang.String JAVA_1_0
          +
          +
          Version constant for Java 1.0 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_0

          +
          +public static final int VERSION_1_0
          +
          +
          Number Version constant for Java 1.0 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_1

          +
          +public static final java.lang.String JAVA_1_1
          +
          +
          Version constant for Java 1.1 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_1

          +
          +public static final int VERSION_1_1
          +
          +
          Number Version constant for Java 1.1 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_2

          +
          +public static final java.lang.String JAVA_1_2
          +
          +
          Version constant for Java 1.2 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_2

          +
          +public static final int VERSION_1_2
          +
          +
          Number Version constant for Java 1.2 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_3

          +
          +public static final java.lang.String JAVA_1_3
          +
          +
          Version constant for Java 1.3 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_3

          +
          +public static final int VERSION_1_3
          +
          +
          Number Version constant for Java 1.3 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_4

          +
          +public static final java.lang.String JAVA_1_4
          +
          +
          Version constant for Java 1.4 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_4

          +
          +public static final int VERSION_1_4
          +
          +
          Number Version constant for Java 1.4 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_5

          +
          +public static final java.lang.String JAVA_1_5
          +
          +
          Version constant for Java 1.5 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_5

          +
          +public static final int VERSION_1_5
          +
          +
          Number Version constant for Java 1.5 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_6

          +
          +public static final java.lang.String JAVA_1_6
          +
          +
          Version constant for Java 1.6 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_6

          +
          +public static final int VERSION_1_6
          +
          +
          Number Version constant for Java 1.6 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +JAVA_1_7

          +
          +public static final java.lang.String JAVA_1_7
          +
          +
          Version constant for Java 1.7 +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +VERSION_1_7

          +
          +public static final int VERSION_1_7
          +
          +
          Number Version constant for Java 1.7 +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getJavaVersion

          +
          +public static java.lang.String getJavaVersion()
          +
          +
          Returns the version of Java this class is running under. +

          +

          + +
          Returns:
          the version of Java as a String, e.g. "1.6"
          +
          +
          +
          + +

          +getJavaVersionNumber

          +
          +public static int getJavaVersionNumber()
          +
          +
          Returns the version of Java this class is running under. + This number can be used for comparisions; it will always be +

          +

          + +
          Returns:
          the version of Java as a number 10x the major/minor, + e.g Java1.5 has a value of 15
          +
          +
          +
          + +

          +isJavaVersion

          +
          +public static boolean isJavaVersion(java.lang.String version)
          +
          +
          Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class. + Note that Ant now requires JDK 1.4+ so JAVA_1_0 through + JAVA_1_3 need no longer be tested for. +

          +

          +
          Parameters:
          version - the version to check against the current version. +
          Returns:
          true if the version of Java is the same as the given version.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +isAtLeastJavaVersion

          +
          +public static boolean isAtLeastJavaVersion(java.lang.String version)
          +
          +
          Compares the current Java version to the passed in String - + assumes the argument is one of the constants defined in this + class. + Note that Ant now requires JDK 1.4+ so JAVA_1_0 through + JAVA_1_3 need no longer be tested for. +

          +

          +
          Parameters:
          version - the version to check against the current version. +
          Returns:
          true if the version of Java is the same or higher than the + given version.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +isKaffe

          +
          +public static boolean isKaffe()
          +
          +
          Checks whether the current Java VM is Kaffe. +

          +

          + +
          Returns:
          true if the current Java VM is Kaffe.
          Since:
          +
          Ant 1.6.3
          +
          See Also:
          http://www.kaffe.org/
          +
          +
          +
          + +

          +isGij

          +
          +public static boolean isGij()
          +
          +
          Checks whether the current Java VM is the GNU interpreter gij + or we are running in a gcj precompiled binary. +

          +

          + +
          Returns:
          true if the current Java VM is gcj/gij.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +isApacheHarmony

          +
          +public static boolean isApacheHarmony()
          +
          +
          Checks whether the current VM is Apache Harmony. +

          +

          + +
          Returns:
          true if the current VM is Apache Harmony.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +getJreExecutable

          +
          +public static java.lang.String getJreExecutable(java.lang.String command)
          +
          +
          Finds an executable that is part of a JRE installation based on + the java.home system property. + +

          java, keytool, + policytool, orbd, rmid, + rmiregistry, servertool and + tnameserv are JRE executables on Sun based + JRE's.

          + +

          You typically find them in JAVA_HOME/jre/bin if + JAVA_HOME points to your JDK installation. JDK + < 1.2 has them in the same directory as the JDK + executables.

          +

          +

          +
          Parameters:
          command - the java executable to find. +
          Returns:
          the path to the command.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +getJdkExecutable

          +
          +public static java.lang.String getJdkExecutable(java.lang.String command)
          +
          +
          Finds an executable that is part of a JDK installation based on + the java.home system property. + +

          You typically find them in JAVA_HOME/bin if + JAVA_HOME points to your JDK installation.

          +

          +

          +
          Parameters:
          command - the java executable to find. +
          Returns:
          the path to the command.
          Since:
          +
          Ant 1.5
          +
          +
          +
          +
          + +

          +getJrePackageTestCases

          +
          +public static java.util.Vector getJrePackageTestCases()
          +
          +
          Testing helper method; kept here for unification of changes. +

          +

          + +
          Returns:
          a list of test classes depending on the java version.
          +
          +
          +
          + +

          +getJrePackages

          +
          +public static java.util.Vector getJrePackages()
          +
          +
          get a vector of strings of packages built into + that platforms runtime jar(s) +

          +

          + +
          Returns:
          list of packages.
          +
          +
          +
          + +

          +createVmsJavaOptionFile

          +
          +public static java.io.File createVmsJavaOptionFile(java.lang.String[] cmd)
+                                            throws java.io.IOException
          +
          +
          Writes the command into a temporary DCL script and returns the + corresponding File object. + It is the job of the caller to delete the file on exit. +

          +

          +
          Parameters:
          cmd - the command. +
          Returns:
          the file containing the command. +
          Throws: +
          java.io.IOException - if there is an error writing to the file.
          +
          +
          +
          + +

          +getJavaHome

          +
          +public static java.lang.String getJavaHome()
          +
          +
          Return the value of ${java.home} +

          +

          + +
          Returns:
          the java home value.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveInputStream.html new file mode 100644 index 000000000..15393ea8a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveInputStream.html @@ -0,0 +1,334 @@ + + + + + + +KeepAliveInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class KeepAliveInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by java.io.FilterInputStream
+          extended by org.apache.tools.ant.util.KeepAliveInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          +
          public class KeepAliveInputStream
          extends java.io.FilterInputStream
          + + +

          +Class that can be used to wrap System.in + without getting anxious about any client closing the stream. + +

          + In code-language it means that it is not necessary to do: + 

          + if (out != System.in) {
+   in.close();
+ }
+
          +

          +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.FilterInputStream
          in
          +  + + + + + + + + + + +
          +Constructor Summary
          KeepAliveInputStream(java.io.InputStream in) + +
          +          Constructor of KeepAliveInputStream.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          This method does nothing.
          +static java.io.InputStreamwrapSystemIn() + +
          +          Convenience factory method that returns a non-closing + InputStream around System.in.
          +  + + + + + + + +
          Methods inherited from class java.io.FilterInputStream
          available, mark, markSupported, read, read, read, reset, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +KeepAliveInputStream

          +
          +public KeepAliveInputStream(java.io.InputStream in)
          +
          +
          Constructor of KeepAliveInputStream. +

          +

          +
          Parameters:
          in - an InputStream value, it should be standard input.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          This method does nothing. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.FilterInputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - as we are overridding FilterInputStream.
          +
          +
          +
          + +

          +wrapSystemIn

          +
          +public static java.io.InputStream wrapSystemIn()
          +
          +
          Convenience factory method that returns a non-closing + InputStream around System.in. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveOutputStream.html new file mode 100644 index 000000000..be9fca072 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/KeepAliveOutputStream.html @@ -0,0 +1,355 @@ + + + + + + +KeepAliveOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class KeepAliveOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by java.io.FilterOutputStream
+          extended by org.apache.tools.ant.util.KeepAliveOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class KeepAliveOutputStream
          extends java.io.FilterOutputStream
          + + +

          +Class that can be used to wrap System.out and System.err + without getting anxious about any client closing the stream. + +

          + In code-language it means that it is not necessary to do: + 

          + if (out != System.out && out!= System.err) {
+   out.close();
+ }
+
          +

          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.FilterOutputStream
          out
          +  + + + + + + + + + + +
          +Constructor Summary
          KeepAliveOutputStream(java.io.OutputStream out) + +
          +          Constructor of KeepAliveOutputStream.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          This method does nothing.
          +static java.io.PrintStreamwrapSystemErr() + +
          +          Convenience factory method that returns a non-closing + PrintStream around System.err.
          +static java.io.PrintStreamwrapSystemOut() + +
          +          Convenience factory method that returns a non-closing + PrintStream around System.out.
          +  + + + + + + + +
          Methods inherited from class java.io.FilterOutputStream
          flush, write, write, write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +KeepAliveOutputStream

          +
          +public KeepAliveOutputStream(java.io.OutputStream out)
          +
          +
          Constructor of KeepAliveOutputStream. +

          +

          +
          Parameters:
          out - an OutputStream value, it shoudl be standard output.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          This method does nothing. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.FilterOutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - as we are overridding FilterOutputStream.
          +
          +
          +
          + +

          +wrapSystemOut

          +
          +public static java.io.PrintStream wrapSystemOut()
          +
          +
          Convenience factory method that returns a non-closing + PrintStream around System.out. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +wrapSystemErr

          +
          +public static java.io.PrintStream wrapSystemErr()
          +
          +
          Convenience factory method that returns a non-closing + PrintStream around System.err. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LayoutPreservingProperties.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LayoutPreservingProperties.html new file mode 100644 index 000000000..e6efb8fe4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LayoutPreservingProperties.html @@ -0,0 +1,610 @@ + + + + + + +LayoutPreservingProperties (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LayoutPreservingProperties

          +
          +java.lang.Object
+  extended by java.util.Dictionary<K,V>
+      extended by java.util.Hashtable<java.lang.Object,java.lang.Object>
+          extended by java.util.Properties
+              extended by org.apache.tools.ant.util.LayoutPreservingProperties
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>
          +
          +
          +
          +
          public class LayoutPreservingProperties
          extends java.util.Properties
          + + +

          +

          A Properties collection which preserves comments and whitespace + present in the input stream from which it was loaded.

          +

          The class defers the usual work of the java.util.Properties + class to there, but it also keeps track of the contents of the + input stream from which it was loaded (if applicable), so that it can + write out the properties in as close a form as possible to the input.

          + If no changes occur to property values, the output should be the same + as the input, except for the leading date stamp, as normal for a + properties file. Properties added are appended to the file. Properties + whose values are changed are changed in place. Properties that are + removed are excised. If the removeComments flag is set, + then the comments immediately preceding the property are also removed.

          +

          If a second set of properties is loaded into an existing set, the + lines of the second set are added to the end. Note however, that if a + property already stored is present in a stream subsequently loaded, then + that property is removed before the new value is set. For example, + consider the file

          + 
           # the first line
+ alpha=one
+
+ # the second line
+ beta=two
          +

          This file is loaded, and then the following is also loaded into the + same LayoutPreservingProperties object

          + 
           # association
+ beta=band
+
+ # and finally
+ gamma=rays
          +

          The resulting collection sequence of logical lines depends on whether + or not removeComments was set at the time the second stream + is loaded. If it is set, then the resulting list of lines is

          + 
           # the first line
+ alpha=one
+
+ # association
+ beta=band
+
+ # and finally
+ gamma=rays
          +

          If the flag is not set, then the comment "the second line" is retained, + although the key-value pair beta=two is removed.

          +

          + +

          +

          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.util.Properties
          defaults
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          LayoutPreservingProperties() + +
          +          Create a new, empty, Properties collection, with no defaults.
          LayoutPreservingProperties(java.util.Properties defaults) + +
          +          Create a new, empty, Properties collection, with the specified defaults.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclear() + +
          +           
          + java.lang.Objectclone() + +
          +           
          + booleanisRemoveComments() + +
          +          Returns true if comments are removed along with + properties, or false otherwise.
          + voidlistLines(java.io.PrintStream out) + +
          +          Echo the lines of the properties (including blanks and comments) to the + stream.
          + voidload(java.io.InputStream inStream) + +
          +           
          + java.lang.Objectput(java.lang.Object key, + java.lang.Object value) + +
          +           
          + java.lang.Objectremove(java.lang.Object key) + +
          +           
          + voidsaveAs(java.io.File dest) + +
          +          Save the properties to a file.
          + java.lang.ObjectsetProperty(java.lang.String key, + java.lang.String value) + +
          +           
          + voidsetRemoveComments(boolean val) + +
          +          Sets the behaviour for comments accompanying properties that + are being removed.
          + voidstore(java.io.OutputStream out, + java.lang.String header) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.util.Properties
          getProperty, getProperty, list, list, loadFromXML, propertyNames, save, storeToXML, storeToXML
          +  + + + + + + + +
          Methods inherited from class java.util.Hashtable
          contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, putAll, rehash, size, toString, values
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LayoutPreservingProperties

          +
          +public LayoutPreservingProperties()
          +
          +
          Create a new, empty, Properties collection, with no defaults. +

          +

          +
          + +

          +LayoutPreservingProperties

          +
          +public LayoutPreservingProperties(java.util.Properties defaults)
          +
          +
          Create a new, empty, Properties collection, with the specified defaults. +

          +

          +
          Parameters:
          defaults - the default property values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isRemoveComments

          +
          +public boolean isRemoveComments()
          +
          +
          Returns true if comments are removed along with + properties, or false otherwise. If + true, then when a property is removed, the comment + preceding it in the original file is removed also. +

          +

          + +
          Returns:
          true if leading comments are removed when + a property is removed; false otherwise
          +
          +
          +
          + +

          +setRemoveComments

          +
          +public void setRemoveComments(boolean val)
          +
          +
          Sets the behaviour for comments accompanying properties that + are being removed. If true, then when a property + is removed, the comment preceding it in the original file is + removed also. +

          +

          +
          Parameters:
          val - true if leading comments are to be + removed when a property is removed; false + otherwise
          +
          +
          +
          + +

          +load

          +
          +public void load(java.io.InputStream inStream)
+          throws java.io.IOException
          +
          +
          +
          Overrides:
          load in class java.util.Properties
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +put

          +
          +public java.lang.Object put(java.lang.Object key,
+                            java.lang.Object value)
+                     throws java.lang.NullPointerException
          +
          +
          +
          Specified by:
          put in interface java.util.Map<java.lang.Object,java.lang.Object>
          Overrides:
          put in class java.util.Hashtable<java.lang.Object,java.lang.Object>
          +
          +
          + +
          Throws: +
          java.lang.NullPointerException
          +
          +
          +
          + +

          +setProperty

          +
          +public java.lang.Object setProperty(java.lang.String key,
+                                    java.lang.String value)
+                             throws java.lang.NullPointerException
          +
          +
          +
          Overrides:
          setProperty in class java.util.Properties
          +
          +
          + +
          Throws: +
          java.lang.NullPointerException
          +
          +
          +
          + +

          +clear

          +
          +public void clear()
          +
          +
          +
          Specified by:
          clear in interface java.util.Map<java.lang.Object,java.lang.Object>
          Overrides:
          clear in class java.util.Hashtable<java.lang.Object,java.lang.Object>
          +
          +
          +
          +
          +
          +
          + +

          +remove

          +
          +public java.lang.Object remove(java.lang.Object key)
          +
          +
          +
          Specified by:
          remove in interface java.util.Map<java.lang.Object,java.lang.Object>
          Overrides:
          remove in class java.util.Hashtable<java.lang.Object,java.lang.Object>
          +
          +
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.util.Hashtable<java.lang.Object,java.lang.Object>
          +
          +
          +
          +
          +
          +
          + +

          +listLines

          +
          +public void listLines(java.io.PrintStream out)
          +
          +
          Echo the lines of the properties (including blanks and comments) to the + stream. +

          +

          +
          Parameters:
          out - the stream to write to
          +
          +
          +
          + +

          +saveAs

          +
          +public void saveAs(java.io.File dest)
+            throws java.io.IOException
          +
          +
          Save the properties to a file. +

          +

          +
          Parameters:
          dest - the file to write to +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +store

          +
          +public void store(java.io.OutputStream out,
+                  java.lang.String header)
+           throws java.io.IOException
          +
          +
          +
          Overrides:
          store in class java.util.Properties
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyFileOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyFileOutputStream.html new file mode 100644 index 000000000..1d886379b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyFileOutputStream.html @@ -0,0 +1,489 @@ + + + + + + +LazyFileOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LazyFileOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.util.LazyFileOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class LazyFileOutputStream
          extends java.io.OutputStream
          + + +

          +Class that delays opening the output file until the first bytes + shall be written or the method open has been invoked + explicitly. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          LazyFileOutputStream(java.io.File f) + +
          +          Creates a stream that will eventually write to the file with + the given name and replace it.
          LazyFileOutputStream(java.io.File file, + boolean append) + +
          +          Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it.
          LazyFileOutputStream(java.io.File file, + boolean append, + boolean alwaysCreate) + +
          +          Creates a stream that will eventually write to the file with + the given name, optionally append to instead of replacing + it, and optionally always create a file (even if zero length).
          LazyFileOutputStream(java.lang.String name) + +
          +          Creates a stream that will eventually write to the file with + the given name and replace it.
          LazyFileOutputStream(java.lang.String name, + boolean append) + +
          +          Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close the file.
          + voidopen() + +
          +          Explicitly open the file for writing.
          + voidwrite(byte[] b) + +
          +          Delegates to the three-arg version.
          + voidwrite(byte[] b, + int offset, + int len) + +
          +          Write part of a byte array.
          + voidwrite(int b) + +
          +          Write a byte.
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          flush
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LazyFileOutputStream

          +
          +public LazyFileOutputStream(java.lang.String name)
          +
          +
          Creates a stream that will eventually write to the file with + the given name and replace it. +

          +

          +
          Parameters:
          name - the filename.
          +
          +
          + +

          +LazyFileOutputStream

          +
          +public LazyFileOutputStream(java.lang.String name,
+                            boolean append)
          +
          +
          Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it. +

          +

          +
          Parameters:
          name - the filename.
          append - if true append rather than replace.
          +
          +
          + +

          +LazyFileOutputStream

          +
          +public LazyFileOutputStream(java.io.File f)
          +
          +
          Creates a stream that will eventually write to the file with + the given name and replace it. +

          +

          +
          Parameters:
          f - the file to create.
          +
          +
          + +

          +LazyFileOutputStream

          +
          +public LazyFileOutputStream(java.io.File file,
+                            boolean append)
          +
          +
          Creates a stream that will eventually write to the file with + the given name and optionally append to instead of replacing + it. +

          +

          +
          Parameters:
          file - the file to create.
          append - if true append rather than replace.
          +
          +
          + +

          +LazyFileOutputStream

          +
          +public LazyFileOutputStream(java.io.File file,
+                            boolean append,
+                            boolean alwaysCreate)
          +
          +
          Creates a stream that will eventually write to the file with + the given name, optionally append to instead of replacing + it, and optionally always create a file (even if zero length). +

          +

          +
          Parameters:
          file - the file to create.
          append - if true append rather than replace.
          alwaysCreate - if true create the file even if nothing to write.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +open

          +
          +public void open()
+          throws java.io.IOException
          +
          +
          Explicitly open the file for writing. + +

          Returns silently if the file has already been opened.

          +

          +

          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Close the file. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] b)
+           throws java.io.IOException
          +
          +
          Delegates to the three-arg version. +

          +

          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the bytearray to write. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] b,
+                  int offset,
+                  int len)
+           throws java.io.IOException
          +
          +
          Write part of a byte array. +

          +

          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the byte array.
          offset - write from this index.
          len - the number of bytes to write. +
          Throws: +
          java.io.IOException - if there is a probem.
          +
          +
          +
          + +

          +write

          +
          +public void write(int b)
+           throws java.io.IOException
          +
          +
          Write a byte. +

          +

          +
          Specified by:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the byte to write. +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyHashtable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyHashtable.html new file mode 100644 index 000000000..eac94a087 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LazyHashtable.html @@ -0,0 +1,490 @@ + + + + + + +LazyHashtable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LazyHashtable

          +
          +java.lang.Object
+  extended by java.util.Dictionary<K,V>
+      extended by java.util.Hashtable
+          extended by org.apache.tools.ant.util.LazyHashtable
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.util.Map
          +
          +
          +
          +
          public class LazyHashtable
          extends java.util.Hashtable
          + + +

          +Hashtable implementation that allows delayed construction + of expensive objects + + All operations that need access to the full list of objects + will call initAll() first. Get and put are cheap. +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  booleaninitAllDone + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          LazyHashtable() + +
          +          No arg constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleancontains(java.lang.Object value) + +
          +          Check if the table contains a particular value.
          + booleancontainsKey(java.lang.Object value) + +
          +          Check if the table contains a particular key.
          + booleancontainsValue(java.lang.Object value) + +
          +          Delegates to contains.
          + java.util.Enumerationelements() + +
          +          Get a enumeration over the elements.
          +protected  voidinitAll() + +
          +          Used to be part of init.
          + booleanisEmpty() + +
          +          Check if the table is empty.
          + java.util.Enumerationkeys() + +
          +          Get an enumeration over the keys.
          + intsize() + +
          +          Get the size of the table.
          +  + + + + + + + +
          Methods inherited from class java.util.Hashtable
          clear, clone, entrySet, equals, get, hashCode, keySet, put, putAll, rehash, remove, toString, values
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +initAllDone

          +
          +protected boolean initAllDone
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +LazyHashtable

          +
          +public LazyHashtable()
          +
          +
          No arg constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +initAll

          +
          +protected void initAll()
          +
          +
          Used to be part of init. It must be done once - but + we delay it until we do need _all_ tasks. Otherwise we + just get the tasks that we need, and avoid costly init. +

          +

          +
          +
          +
          +
          + +

          +elements

          +
          +public java.util.Enumeration elements()
          +
          +
          Get a enumeration over the elements. +

          +

          +
          Overrides:
          elements in class java.util.Hashtable
          +
          +
          + +
          Returns:
          an enumeration.
          +
          +
          +
          + +

          +isEmpty

          +
          +public boolean isEmpty()
          +
          +
          Check if the table is empty. +

          +

          +
          Specified by:
          isEmpty in interface java.util.Map
          Overrides:
          isEmpty in class java.util.Hashtable
          +
          +
          + +
          Returns:
          true if it is.
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          Get the size of the table. +

          +

          +
          Specified by:
          size in interface java.util.Map
          Overrides:
          size in class java.util.Hashtable
          +
          +
          + +
          Returns:
          the size.
          +
          +
          +
          + +

          +contains

          +
          +public boolean contains(java.lang.Object value)
          +
          +
          Check if the table contains a particular value. +

          +

          +
          Overrides:
          contains in class java.util.Hashtable
          +
          +
          +
          Parameters:
          value - the value to look for. +
          Returns:
          true if the table contains the value.
          +
          +
          +
          + +

          +containsKey

          +
          +public boolean containsKey(java.lang.Object value)
          +
          +
          Check if the table contains a particular key. +

          +

          +
          Specified by:
          containsKey in interface java.util.Map
          Overrides:
          containsKey in class java.util.Hashtable
          +
          +
          +
          Parameters:
          value - the key to look for. +
          Returns:
          true if the table contains key.
          +
          +
          +
          + +

          +containsValue

          +
          +public boolean containsValue(java.lang.Object value)
          +
          +
          Delegates to contains. +

          +

          +
          Specified by:
          containsValue in interface java.util.Map
          Overrides:
          containsValue in class java.util.Hashtable
          +
          +
          +
          Parameters:
          value - the value to look for. +
          Returns:
          true if the table contains the value.
          +
          +
          +
          + +

          +keys

          +
          +public java.util.Enumeration keys()
          +
          +
          Get an enumeration over the keys. +

          +

          +
          Overrides:
          keys in class java.util.Hashtable
          +
          +
          + +
          Returns:
          an enumeration.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LeadPipeInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LeadPipeInputStream.html new file mode 100644 index 000000000..3e2406bbe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LeadPipeInputStream.html @@ -0,0 +1,468 @@ + + + + + + +LeadPipeInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LeadPipeInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by java.io.PipedInputStream
+          extended by org.apache.tools.ant.util.LeadPipeInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          +
          public class LeadPipeInputStream
          extends java.io.PipedInputStream
          + + +

          +Special PipedInputStream that will not die + when the writing Thread is no longer alive. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.2
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.PipedInputStream
          buffer, in, out, PIPE_SIZE
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          LeadPipeInputStream() + +
          +          Construct a new LeadPipeInputStream.
          LeadPipeInputStream(int size) + +
          +          Construct a new LeadPipeInputStream + with the specified buffer size.
          LeadPipeInputStream(java.io.PipedOutputStream src) + +
          +          Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream.
          LeadPipeInputStream(java.io.PipedOutputStream src, + int size) + +
          +          Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream, using a + circular buffer of the specified size.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidlog(java.lang.String message, + int loglevel) + +
          +          Log a message with the specified logging level.
          + intread() + +
          +          Read a byte from the stream.
          + voidsetBufferSize(int size) + +
          +          Set the size of the buffer.
          + voidsetManagingComponent(ProjectComponent pc) + +
          +          Set a managing ProjectComponent for + this LeadPipeInputStream.
          + voidsetManagingTask(Task task) + +
          +          Set a managing Task for + this LeadPipeInputStream.
          +  + + + + + + + +
          Methods inherited from class java.io.PipedInputStream
          available, close, connect, read, receive
          +  + + + + + + + +
          Methods inherited from class java.io.InputStream
          mark, markSupported, read, reset, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LeadPipeInputStream

          +
          +public LeadPipeInputStream()
          +
          +
          Construct a new LeadPipeInputStream. +

          +

          +
          + +

          +LeadPipeInputStream

          +
          +public LeadPipeInputStream(int size)
          +
          +
          Construct a new LeadPipeInputStream + with the specified buffer size. +

          +

          +
          Parameters:
          size - the size of the circular buffer.
          +
          +
          + +

          +LeadPipeInputStream

          +
          +public LeadPipeInputStream(java.io.PipedOutputStream src)
+                    throws java.io.IOException
          +
          +
          Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream. +

          +

          +
          Parameters:
          src - the PipedOutputStream source. +
          Throws: +
          java.io.IOException - if unable to construct the stream.
          +
          +
          + +

          +LeadPipeInputStream

          +
          +public LeadPipeInputStream(java.io.PipedOutputStream src,
+                           int size)
+                    throws java.io.IOException
          +
          +
          Construct a new LeadPipeInputStream to pull + from the specified PipedOutputStream, using a + circular buffer of the specified size. +

          +

          +
          Parameters:
          src - the PipedOutputStream source.
          size - the size of the circular buffer. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          Read a byte from the stream. +

          +

          +
          Overrides:
          read in class java.io.PipedInputStream
          +
          +
          + +
          Returns:
          the byte (0 to 255) or -1 if there are no more. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +setBufferSize

          +
          +public void setBufferSize(int size)
          +
          +
          Set the size of the buffer. +

          +

          +
          Parameters:
          size - the new buffer size. Ignored if <= current size.
          +
          +
          +
          + +

          +setManagingTask

          +
          +public void setManagingTask(Task task)
          +
          +
          Set a managing Task for + this LeadPipeInputStream. +

          +

          +
          Parameters:
          task - the managing Task.
          +
          +
          +
          + +

          +setManagingComponent

          +
          +public void setManagingComponent(ProjectComponent pc)
          +
          +
          Set a managing ProjectComponent for + this LeadPipeInputStream. +

          +

          +
          Parameters:
          pc - the managing ProjectComponent.
          +
          +
          +
          + +

          +log

          +
          +public void log(java.lang.String message,
+                int loglevel)
          +
          +
          Log a message with the specified logging level. +

          +

          +
          Parameters:
          message - the String message.
          loglevel - the int logging level.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineOrientedOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineOrientedOutputStream.html new file mode 100644 index 000000000..dfdfa2fd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineOrientedOutputStream.html @@ -0,0 +1,415 @@ + + + + + + +LineOrientedOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LineOrientedOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.util.LineOrientedOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          Direct Known Subclasses:
          LogOutputStream
          +
          +
          +
          +
          public abstract class LineOrientedOutputStream
          extends java.io.OutputStream
          + + +

          +Invokes processLine whenever a full line has + been written to this stream. + +

          Tries to be smart about line separators.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          LineOrientedOutputStream() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Writes all remaining
          + voidflush() + +
          +          Flush this log stream
          +protected  voidprocessBuffer() + +
          +          Converts the buffer to a string and sends it to + processLine
          +protected abstract  voidprocessLine(java.lang.String line) + +
          +          Processes a line.
          + voidwrite(byte[] b, + int off, + int len) + +
          +          Write a block of characters to the output stream
          + voidwrite(int cc) + +
          +          Write the data to the buffer and flush the buffer, if a line + separator is detected.
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LineOrientedOutputStream

          +
          +public LineOrientedOutputStream()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +write

          +
          +public final void write(int cc)
+                 throws java.io.IOException
          +
          +
          Write the data to the buffer and flush the buffer, if a line + separator is detected. +

          +

          +
          Specified by:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          cc - data to log (byte). +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +flush

          +
          +public final void flush()
+                 throws java.io.IOException
          +
          +
          Flush this log stream +

          +

          +
          Specified by:
          flush in interface java.io.Flushable
          Overrides:
          flush in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +processBuffer

          +
          +protected void processBuffer()
+                      throws java.io.IOException
          +
          +
          Converts the buffer to a string and sends it to + processLine +

          +

          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +processLine

          +
          +protected abstract void processLine(java.lang.String line)
+                             throws java.io.IOException
          +
          +
          Processes a line. +

          +

          +
          Parameters:
          line - the line to log. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +close

          +
          +public final void close()
+                 throws java.io.IOException
          +
          +
          Writes all remaining +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          +
          + +

          +write

          +
          +public final void write(byte[] b,
+                        int off,
+                        int len)
+                 throws java.io.IOException
          +
          +
          Write a block of characters to the output stream +

          +

          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the array containing the data
          off - the offset into the array where data starts
          len - the length of block +
          Throws: +
          java.io.IOException - if the data cannot be written into the stream.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineTokenizer.html new file mode 100644 index 000000000..63fbeb0c7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LineTokenizer.html @@ -0,0 +1,354 @@ + + + + + + +LineTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LineTokenizer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.LineTokenizer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Tokenizer
          +
          +
          +
          +
          public class LineTokenizer
          extends ProjectComponent
          implements Tokenizer
          + + +

          +class to tokenize the input as lines seperated + by \r (mac style), \r\n (dos/windows style) or \n (unix style) +

          + +

          +

          +
          Since:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          LineTokenizer() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetPostToken() + +
          +          return the string between tokens, after the + previous token.
          + java.lang.StringgetToken(java.io.Reader in) + +
          +          get the next line from the input
          + voidsetIncludeDelims(boolean includeDelims) + +
          +          attribute includedelims - whether to include + the line ending with the line, or to return + it in the posttoken + default false
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LineTokenizer

          +
          +public LineTokenizer()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setIncludeDelims

          +
          +public void setIncludeDelims(boolean includeDelims)
          +
          +
          attribute includedelims - whether to include + the line ending with the line, or to return + it in the posttoken + default false +

          +

          +
          +
          +
          +
          Parameters:
          includeDelims - if true include /r and /n in the line
          +
          +
          +
          + +

          +getToken

          +
          +public java.lang.String getToken(java.io.Reader in)
+                          throws java.io.IOException
          +
          +
          get the next line from the input +

          +

          +
          Specified by:
          getToken in interface Tokenizer
          +
          +
          +
          Parameters:
          in - the input reader +
          Returns:
          the line excluding /r or /n, unless includedelims is set +
          Throws: +
          java.io.IOException - if an error occurs reading
          +
          +
          +
          + +

          +getPostToken

          +
          +public java.lang.String getPostToken()
          +
          +
          Description copied from interface: Tokenizer
          +
          return the string between tokens, after the + previous token. +

          +

          +
          Specified by:
          getPostToken in interface Tokenizer
          +
          +
          + +
          Returns:
          the line ending character(s) for the current line
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LinkedHashtable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LinkedHashtable.html new file mode 100644 index 000000000..cfd2aca66 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LinkedHashtable.html @@ -0,0 +1,699 @@ + + + + + + +LinkedHashtable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LinkedHashtable

          +
          +java.lang.Object
+  extended by java.util.Dictionary<K,V>
+      extended by java.util.Hashtable
+          extended by org.apache.tools.ant.util.LinkedHashtable
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.util.Map
          +
          +
          +
          +
          public class LinkedHashtable
          extends java.util.Hashtable
          + + +

          +Subclass of Hashtable that wraps a LinkedHashMap to provide + predictable iteration order. + +

          This is not a general purpose class but has been written because + the protected members of Copy prohibited later revisions from using a more predictable + collection.

          + +

          Methods are synchronized to keep Hashtable's contract.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.2
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          LinkedHashtable() + +
          +           
          LinkedHashtable(int initialCapacity) + +
          +           
          LinkedHashtable(int initialCapacity, + float loadFactor) + +
          +           
          LinkedHashtable(java.util.Map m) + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclear() + +
          +           
          + booleancontains(java.lang.Object value) + +
          +           
          + booleancontainsKey(java.lang.Object value) + +
          +           
          + booleancontainsValue(java.lang.Object value) + +
          +           
          + java.util.Enumerationelements() + +
          +           
          + java.util.SetentrySet() + +
          +           
          + booleanequals(java.lang.Object o) + +
          +           
          + java.lang.Objectget(java.lang.Object k) + +
          +           
          + inthashCode() + +
          +           
          + booleanisEmpty() + +
          +           
          + java.util.Enumerationkeys() + +
          +           
          + java.util.SetkeySet() + +
          +           
          + java.lang.Objectput(java.lang.Object k, + java.lang.Object v) + +
          +           
          + voidputAll(java.util.Map m) + +
          +           
          + java.lang.Objectremove(java.lang.Object k) + +
          +           
          + intsize() + +
          +           
          + java.lang.StringtoString() + +
          +           
          + java.util.Collectionvalues() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.util.Hashtable
          clone, rehash
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LinkedHashtable

          +
          +public LinkedHashtable()
          +
          +
          +
          + +

          +LinkedHashtable

          +
          +public LinkedHashtable(int initialCapacity)
          +
          +
          +
          + +

          +LinkedHashtable

          +
          +public LinkedHashtable(int initialCapacity,
+                       float loadFactor)
          +
          +
          +
          + +

          +LinkedHashtable

          +
          +public LinkedHashtable(java.util.Map m)
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +clear

          +
          +public void clear()
          +
          +
          +
          Specified by:
          clear in interface java.util.Map
          Overrides:
          clear in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +contains

          +
          +public boolean contains(java.lang.Object value)
          +
          +
          +
          Overrides:
          contains in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +containsKey

          +
          +public boolean containsKey(java.lang.Object value)
          +
          +
          +
          Specified by:
          containsKey in interface java.util.Map
          Overrides:
          containsKey in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +containsValue

          +
          +public boolean containsValue(java.lang.Object value)
          +
          +
          +
          Specified by:
          containsValue in interface java.util.Map
          Overrides:
          containsValue in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +elements

          +
          +public java.util.Enumeration elements()
          +
          +
          +
          Overrides:
          elements in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +entrySet

          +
          +public java.util.Set entrySet()
          +
          +
          +
          Specified by:
          entrySet in interface java.util.Map
          Overrides:
          entrySet in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          +
          Specified by:
          equals in interface java.util.Map
          Overrides:
          equals in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +get

          +
          +public java.lang.Object get(java.lang.Object k)
          +
          +
          +
          Specified by:
          get in interface java.util.Map
          Overrides:
          get in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          +
          Specified by:
          hashCode in interface java.util.Map
          Overrides:
          hashCode in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +isEmpty

          +
          +public boolean isEmpty()
          +
          +
          +
          Specified by:
          isEmpty in interface java.util.Map
          Overrides:
          isEmpty in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +keys

          +
          +public java.util.Enumeration keys()
          +
          +
          +
          Overrides:
          keys in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +keySet

          +
          +public java.util.Set keySet()
          +
          +
          +
          Specified by:
          keySet in interface java.util.Map
          Overrides:
          keySet in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +put

          +
          +public java.lang.Object put(java.lang.Object k,
+                            java.lang.Object v)
          +
          +
          +
          Specified by:
          put in interface java.util.Map
          Overrides:
          put in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +putAll

          +
          +public void putAll(java.util.Map m)
          +
          +
          +
          Specified by:
          putAll in interface java.util.Map
          Overrides:
          putAll in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +remove

          +
          +public java.lang.Object remove(java.lang.Object k)
          +
          +
          +
          Specified by:
          remove in interface java.util.Map
          Overrides:
          remove in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +size

          +
          +public int size()
          +
          +
          +
          Specified by:
          size in interface java.util.Map
          Overrides:
          size in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.util.Hashtable
          +
          +
          +
          +
          +
          +
          + +

          +values

          +
          +public java.util.Collection values()
          +
          +
          +
          Specified by:
          values in interface java.util.Map
          Overrides:
          values in class java.util.Hashtable
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LoaderUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LoaderUtils.html new file mode 100644 index 000000000..29b2ba8d2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/LoaderUtils.html @@ -0,0 +1,402 @@ + + + + + + +LoaderUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class LoaderUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.LoaderUtils
+
          +
          +
          +
          public class LoaderUtils
          extends java.lang.Object
          + + +

          +ClassLoader utility methods +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          LoaderUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static booleanclassExists(java.lang.ClassLoader loader, + java.lang.String className) + +
          +          Check if a classloader has a classname resource.
          +static java.lang.StringclassNameToResource(java.lang.String className) + +
          +          Return the resource name of a class name.
          +static java.io.FilegetClassSource(java.lang.Class c) + +
          +          Find the directory or jar file the class has been loaded from.
          +static java.lang.ClassLoadergetContextClassLoader() + +
          +          JDK1.1 compatible access to set the context class loader.
          +static java.io.FilegetResourceSource(java.lang.ClassLoader c, + java.lang.String resource) + +
          +          Find the directory or a give resource has been loaded from.
          +static booleanisContextLoaderAvailable() + +
          +          Indicates if the context class loader methods are available
          +static voidsetContextClassLoader(java.lang.ClassLoader loader) + +
          +          Set the context classloader
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +LoaderUtils

          +
          +public LoaderUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setContextClassLoader

          +
          +public static void setContextClassLoader(java.lang.ClassLoader loader)
          +
          +
          Set the context classloader +

          +

          +
          Parameters:
          loader - the ClassLoader to be used as the context class loader + on the current thread.
          +
          +
          +
          + +

          +getContextClassLoader

          +
          +public static java.lang.ClassLoader getContextClassLoader()
          +
          +
          JDK1.1 compatible access to set the context class loader. +

          +

          + +
          Returns:
          the ClassLoader instance being used as the context + classloader on the current thread. Returns null on JDK 1.1
          +
          +
          +
          + +

          +isContextLoaderAvailable

          +
          +public static boolean isContextLoaderAvailable()
          +
          +
          Indicates if the context class loader methods are available +

          +

          + +
          Returns:
          true if the get and set methods dealing with the context + classloader are available.
          +
          +
          +
          + +

          +getClassSource

          +
          +public static java.io.File getClassSource(java.lang.Class c)
          +
          +
          Find the directory or jar file the class has been loaded from. +

          +

          +
          Parameters:
          c - the class whose location is required. +
          Returns:
          the file or jar with the class or null if we cannot + determine the location.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getResourceSource

          +
          +public static java.io.File getResourceSource(java.lang.ClassLoader c,
+                                             java.lang.String resource)
          +
          +
          Find the directory or a give resource has been loaded from. +

          +

          +
          Parameters:
          c - the classloader to be consulted for the source
          resource - the resource whose location is required. +
          Returns:
          the file with the resource source or null if + we cannot determine the location.
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +classNameToResource

          +
          +public static java.lang.String classNameToResource(java.lang.String className)
          +
          +
          Return the resource name of a class name. +

          +

          +
          Parameters:
          className - the name of the class to convert. +
          Returns:
          the corresponding resource name.
          Since:
          +
          Ant 1.7.0.
          +
          +
          +
          +
          + +

          +classExists

          +
          +public static boolean classExists(java.lang.ClassLoader loader,
+                                  java.lang.String className)
          +
          +
          Check if a classloader has a classname resource. +

          +

          +
          Parameters:
          loader - the classloader to look it.
          className - the name of the class to look for. +
          Returns:
          true if the classexists, false otherwise
          Since:
          +
          Ant 1.7.0.
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/MergingMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/MergingMapper.html new file mode 100644 index 000000000..11b6b67e8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/MergingMapper.html @@ -0,0 +1,366 @@ + + + + + + +MergingMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class MergingMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.MergingMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class MergingMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +Implementation of FileNameMapper that always returns the same + target file name. + +

          This is the default FileNameMapper for the archiving tasks and + uptodate.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.lang.String[]mergedFile + +
          +           
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          MergingMapper() + +
          +           
          MergingMapper(java.lang.String to) + +
          +           
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns an one-element array containing the file name set via setTo.
          + voidsetFrom(java.lang.String from) + +
          +          Ignored.
          + voidsetTo(java.lang.String to) + +
          +          Sets the name of the merged file.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +mergedFile

          +
          +protected java.lang.String[] mergedFile
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +MergingMapper

          +
          +public MergingMapper()
          +
          +
          +
          + +

          +MergingMapper

          +
          +public MergingMapper(java.lang.String to)
          +
          +
          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
          +
          +
          Ignored. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - ignored.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Sets the name of the merged file. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - the name of the merged file.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns an one-element array containing the file name set via setTo. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - ignored. +
          Returns:
          a one-element array containing the merged filename.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/OutputStreamFunneler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/OutputStreamFunneler.html new file mode 100644 index 000000000..12cf20ea6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/OutputStreamFunneler.html @@ -0,0 +1,358 @@ + + + + + + +OutputStreamFunneler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class OutputStreamFunneler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.OutputStreamFunneler
+
          +
          +
          +
          public class OutputStreamFunneler
          extends java.lang.Object
          + + +

          +Manages a set of OutputStreams to + write to a single underlying stream, which is + closed only when the last "funnel" + has been closed. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static longDEFAULT_TIMEOUT_MILLIS + +
          +          Default timeout.
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          OutputStreamFunneler(java.io.OutputStream out) + +
          +          Create a new OutputStreamFunneler for + the specified OutputStream.
          OutputStreamFunneler(java.io.OutputStream out, + long timeoutMillis) + +
          +          Create a new OutputStreamFunneler for + the specified OutputStream, with the + specified timeout value.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.io.OutputStreamgetFunnelInstance() + +
          +          Get a "funnel" OutputStream instance to + write to this OutputStreamFunneler's underlying + OutputStream.
          + voidsetTimeout(long timeoutMillis) + +
          +          Set the timeout for this OutputStreamFunneler.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_TIMEOUT_MILLIS

          +
          +public static final long DEFAULT_TIMEOUT_MILLIS
          +
          +
          Default timeout. +

          +

          +
          See Also:
          setTimeout(long), +Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +OutputStreamFunneler

          +
          +public OutputStreamFunneler(java.io.OutputStream out)
          +
          +
          Create a new OutputStreamFunneler for + the specified OutputStream. +

          +

          +
          Parameters:
          out - OutputStream.
          +
          +
          + +

          +OutputStreamFunneler

          +
          +public OutputStreamFunneler(java.io.OutputStream out,
+                            long timeoutMillis)
          +
          +
          Create a new OutputStreamFunneler for + the specified OutputStream, with the + specified timeout value. +

          +

          +
          Parameters:
          out - OutputStream.
          timeoutMillis - long.
          See Also:
          setTimeout(long)
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setTimeout

          +
          +public void setTimeout(long timeoutMillis)
          +
          +
          Set the timeout for this OutputStreamFunneler. + This is the maximum time that may elapse between the closure + of the last "funnel" and the next call to + getOutputStream() without closing the + underlying stream. +

          +

          +
          Parameters:
          timeoutMillis - long timeout value.
          +
          +
          +
          + +

          +getFunnelInstance

          +
          +public java.io.OutputStream getFunnelInstance()
+                                       throws java.io.IOException
          +
          +
          Get a "funnel" OutputStream instance to + write to this OutputStreamFunneler's underlying + OutputStream. +

          +

          + +
          Returns:
          OutputStream. +
          Throws: +
          java.io.IOException - if unable to create the funnel.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PackageNameMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PackageNameMapper.html new file mode 100644 index 000000000..ed2002691 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PackageNameMapper.html @@ -0,0 +1,296 @@ + + + + + + +PackageNameMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class PackageNameMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.GlobPatternMapper
+      extended by org.apache.tools.ant.util.PackageNameMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class PackageNameMapper
          extends GlobPatternMapper
          + + +

          +Maps directory name matches into a dotted package name. This is + useful for matching JUnit test cases againt their XML formatter + results. + 

          + <mapper classname="org.apache.tools.ant.util.PackageNameMapper"
+         from="*Test.java" to="${test.data.dir}/TEST-*Test.xml"/>
+
          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.util.GlobPatternMapper
          fromPostfix, fromPrefix, postfixLength, prefixLength, toPostfix, toPrefix
          +  + + + + + + + + + + +
          +Constructor Summary
          PackageNameMapper() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringextractVariablePart(java.lang.String name) + +
          +          Returns the part of the given string that matches the * in the + "from" pattern replacing file separators with dots
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.GlobPatternMapper
          mapFileName, setCaseSensitive, setFrom, setHandleDirSep, setTo
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PackageNameMapper

          +
          +public PackageNameMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +extractVariablePart

          +
          +protected java.lang.String extractVariablePart(java.lang.String name)
          +
          +
          Returns the part of the given string that matches the * in the + "from" pattern replacing file separators with dots +

          +

          +
          Overrides:
          extractVariablePart in class GlobPatternMapper
          +
          +
          +
          Parameters:
          name - Source filename +
          Returns:
          Replaced variable part
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PropertyOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PropertyOutputStream.html new file mode 100644 index 000000000..83ddf5bc0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/PropertyOutputStream.html @@ -0,0 +1,334 @@ + + + + + + +PropertyOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class PropertyOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by java.io.ByteArrayOutputStream
+          extended by org.apache.tools.ant.util.PropertyOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class PropertyOutputStream
          extends java.io.ByteArrayOutputStream
          + + +

          +Exception thrown when an attempt is made to get an OutputStream + from an immutable Resource. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.io.ByteArrayOutputStream
          buf, count
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          PropertyOutputStream(Project p, + java.lang.String s) + +
          +          Construct a new PropertyOutputStream for the specified Project + and property name, trimming the property value.
          PropertyOutputStream(Project p, + java.lang.String s, + boolean b) + +
          +          Construct a new PropertyOutputStream for + the specified Project, property name, and trim mode.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close the PropertyOutputStream, storing the property.
          +  + + + + + + + +
          Methods inherited from class java.io.ByteArrayOutputStream
          reset, size, toByteArray, toString, toString, toString, write, write, writeTo
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          flush, write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +PropertyOutputStream

          +
          +public PropertyOutputStream(Project p,
+                            java.lang.String s)
          +
          +
          Construct a new PropertyOutputStream for the specified Project + and property name, trimming the property value. +

          +

          +
          Parameters:
          p - the associated Ant Project.
          s - the String property name.
          +
          +
          + +

          +PropertyOutputStream

          +
          +public PropertyOutputStream(Project p,
+                            java.lang.String s,
+                            boolean b)
          +
          +
          Construct a new PropertyOutputStream for + the specified Project, property name, and trim mode. +

          +

          +
          Parameters:
          p - the associated Ant Project.
          s - the String property name.
          b - the boolean trim mode.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +close

          +
          +public void close()
          +
          +
          Close the PropertyOutputStream, storing the property. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.ByteArrayOutputStream
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ProxySetup.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ProxySetup.html new file mode 100644 index 000000000..198f28c58 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ProxySetup.html @@ -0,0 +1,626 @@ + + + + + + +ProxySetup (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ProxySetup

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ProxySetup
+
          +
          +
          +
          public class ProxySetup
          extends java.lang.Object
          + + +

          +Code to do proxy setup. This is just factored out of the main system just to + keep everything else less convoluted. +

          + +

          +

          +
          Since:
          +
          Ant1.7
          +
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringFTP_NON_PROXY_HOSTS + +
          +          the ftp hosts not to be proxied property
          +static java.lang.StringFTP_PROXY_HOST + +
          +          the ftp proxyhost property
          +static java.lang.StringFTP_PROXY_PORT + +
          +          the ftp proxyport property
          +static java.lang.StringHTTP_NON_PROXY_HOSTS + +
          +          the ftp proxyport property
          +static java.lang.StringHTTP_PROXY_HOST + +
          +          the http proxyhost property
          +static java.lang.StringHTTP_PROXY_PASSWORD + +
          +          the http proxy password property
          +static java.lang.StringHTTP_PROXY_PORT + +
          +          the http proxyport property
          +static java.lang.StringHTTP_PROXY_USERNAME + +
          +          the http proxy username property
          +static java.lang.StringHTTPS_NON_PROXY_HOSTS + +
          +          the http hosts not to be proxied property
          +static java.lang.StringHTTPS_PROXY_HOST + +
          +          the https proxyhost property
          +static java.lang.StringHTTPS_PROXY_PORT + +
          +          the https proxyport property
          +static java.lang.StringSOCKS_PROXY_HOST + +
          +          the socks proxy host property
          +static java.lang.StringSOCKS_PROXY_PASSWORD + +
          +          the socks proxy password property
          +static java.lang.StringSOCKS_PROXY_PORT + +
          +          the socks proxy port property
          +static java.lang.StringSOCKS_PROXY_USERNAME + +
          +          the socks proxy username property
          +static java.lang.StringUSE_SYSTEM_PROXIES + +
          +          Java1.5 property that enables use of system proxies.
          +  + + + + + + + + + + +
          +Constructor Summary
          ProxySetup(Project owner) + +
          +          create a proxy setup class bound to this project
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidenableProxies() + +
          +          turn proxies on; + if the proxy key is already set to some value: leave alone.
          +static java.lang.StringgetSystemProxySetting() + +
          +          Get the current system property settings
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +USE_SYSTEM_PROXIES

          +
          +public static final java.lang.String USE_SYSTEM_PROXIES
          +
          +
          Java1.5 property that enables use of system proxies. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTP_PROXY_HOST

          +
          +public static final java.lang.String HTTP_PROXY_HOST
          +
          +
          the http proxyhost property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTP_PROXY_PORT

          +
          +public static final java.lang.String HTTP_PROXY_PORT
          +
          +
          the http proxyport property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTPS_PROXY_HOST

          +
          +public static final java.lang.String HTTPS_PROXY_HOST
          +
          +
          the https proxyhost property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTPS_PROXY_PORT

          +
          +public static final java.lang.String HTTPS_PROXY_PORT
          +
          +
          the https proxyport property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FTP_PROXY_HOST

          +
          +public static final java.lang.String FTP_PROXY_HOST
          +
          +
          the ftp proxyhost property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FTP_PROXY_PORT

          +
          +public static final java.lang.String FTP_PROXY_PORT
          +
          +
          the ftp proxyport property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTP_NON_PROXY_HOSTS

          +
          +public static final java.lang.String HTTP_NON_PROXY_HOSTS
          +
          +
          the ftp proxyport property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTPS_NON_PROXY_HOSTS

          +
          +public static final java.lang.String HTTPS_NON_PROXY_HOSTS
          +
          +
          the http hosts not to be proxied property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FTP_NON_PROXY_HOSTS

          +
          +public static final java.lang.String FTP_NON_PROXY_HOSTS
          +
          +
          the ftp hosts not to be proxied property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTP_PROXY_USERNAME

          +
          +public static final java.lang.String HTTP_PROXY_USERNAME
          +
          +
          the http proxy username property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +HTTP_PROXY_PASSWORD

          +
          +public static final java.lang.String HTTP_PROXY_PASSWORD
          +
          +
          the http proxy password property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SOCKS_PROXY_HOST

          +
          +public static final java.lang.String SOCKS_PROXY_HOST
          +
          +
          the socks proxy host property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SOCKS_PROXY_PORT

          +
          +public static final java.lang.String SOCKS_PROXY_PORT
          +
          +
          the socks proxy port property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SOCKS_PROXY_USERNAME

          +
          +public static final java.lang.String SOCKS_PROXY_USERNAME
          +
          +
          the socks proxy username property +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SOCKS_PROXY_PASSWORD

          +
          +public static final java.lang.String SOCKS_PROXY_PASSWORD
          +
          +
          the socks proxy password property +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ProxySetup

          +
          +public ProxySetup(Project owner)
          +
          +
          create a proxy setup class bound to this project +

          +

          +
          Parameters:
          owner - the project that owns this setup.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getSystemProxySetting

          +
          +public static java.lang.String getSystemProxySetting()
          +
          +
          Get the current system property settings +

          +

          + +
          Returns:
          current value; null for none or no access
          +
          +
          +
          + +

          +enableProxies

          +
          +public void enableProxies()
          +
          +
          turn proxies on; + if the proxy key is already set to some value: leave alone. + if an ant property of the value USE_SYSTEM_PROXIES + is set, use that instead. Else set to "true". +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReaderInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReaderInputStream.html new file mode 100644 index 000000000..0a77d79c0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReaderInputStream.html @@ -0,0 +1,468 @@ + + + + + + +ReaderInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ReaderInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.ant.util.ReaderInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          Direct Known Subclasses:
          StringInputStream
          +
          +
          +
          +
          public class ReaderInputStream
          extends java.io.InputStream
          + + +

          +Adapts a Reader as an InputStream. + Adapted from StringInputStream. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          ReaderInputStream(java.io.Reader reader) + +
          +          Construct a ReaderInputStream + for the specified Reader.
          ReaderInputStream(java.io.Reader reader, + java.lang.String encoding) + +
          +          Construct a ReaderInputStream + for the specified Reader, + with the specified encoding.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intavailable() + +
          +           
          + voidclose() + +
          +          Closes the Reader.
          + voidmark(int limit) + +
          +          Marks the read limit of the Reader.
          + booleanmarkSupported() + +
          +           
          + intread() + +
          +          Reads from the Reader, returning the same value.
          + intread(byte[] b, + int off, + int len) + +
          +          Reads from the Reader into a byte array
          + voidreset() + +
          +          Resets the Reader.
          +  + + + + + + + +
          Methods inherited from class java.io.InputStream
          read, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ReaderInputStream

          +
          +public ReaderInputStream(java.io.Reader reader)
          +
          +
          Construct a ReaderInputStream + for the specified Reader. +

          +

          +
          Parameters:
          reader - Reader. Must not be null.
          +
          +
          + +

          +ReaderInputStream

          +
          +public ReaderInputStream(java.io.Reader reader,
+                         java.lang.String encoding)
          +
          +
          Construct a ReaderInputStream + for the specified Reader, + with the specified encoding. +

          +

          +
          Parameters:
          reader - non-null Reader.
          encoding - non-null String encoding.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          Reads from the Reader, returning the same value. +

          +

          +
          Specified by:
          read in class java.io.InputStream
          +
          +
          + +
          Returns:
          the value of the next character in the Reader. +
          Throws: +
          java.io.IOException - if the original Reader fails to be read
          +
          +
          +
          + +

          +read

          +
          +public int read(byte[] b,
+                int off,
+                int len)
+         throws java.io.IOException
          +
          +
          Reads from the Reader into a byte array +

          +

          +
          Overrides:
          read in class java.io.InputStream
          +
          +
          +
          Parameters:
          b - the byte array to read into
          off - the offset in the byte array
          len - the length in the byte array to fill +
          Returns:
          the actual number read into the byte array, -1 at + the end of the stream +
          Throws: +
          java.io.IOException - if an error occurs
          +
          +
          +
          + +

          +mark

          +
          +public void mark(int limit)
          +
          +
          Marks the read limit of the Reader. +

          +

          +
          Overrides:
          mark in class java.io.InputStream
          +
          +
          +
          Parameters:
          limit - the maximum limit of bytes that can be read before the + mark position becomes invalid
          +
          +
          +
          + +

          +available

          +
          +public int available()
+              throws java.io.IOException
          +
          +
          +
          Overrides:
          available in class java.io.InputStream
          +
          +
          + +
          Returns:
          the current number of bytes ready for reading +
          Throws: +
          java.io.IOException - if an error occurs
          +
          +
          +
          + +

          +markSupported

          +
          +public boolean markSupported()
          +
          +
          +
          Overrides:
          markSupported in class java.io.InputStream
          +
          +
          + +
          Returns:
          false - mark is not supported
          +
          +
          +
          + +

          +reset

          +
          +public void reset()
+           throws java.io.IOException
          +
          +
          Resets the Reader. +

          +

          +
          Overrides:
          reset in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if the Reader fails to be reset
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Closes the Reader. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if the original Reader fails to be closed
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectUtil.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectUtil.html new file mode 100644 index 000000000..63a167bd2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectUtil.html @@ -0,0 +1,449 @@ + + + + + + +ReflectUtil (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ReflectUtil

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ReflectUtil
+
          +
          +
          +
          public class ReflectUtil
          extends java.lang.Object
          + + +

          +Utility class to handle reflection on java objects. + The class contains static methods to call reflection + methods, catch any exceptions, converting them + to BuildExceptions. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static java.lang.ObjectgetField(java.lang.Object obj, + java.lang.String fieldName) + +
          +          Get the value of a field in an object.
          +static java.lang.Objectinvoke(java.lang.Object obj, + java.lang.String methodName) + +
          +          Call a method on the object with no parameters.
          +static java.lang.Objectinvoke(java.lang.Object obj, + java.lang.String methodName, + java.lang.Class argType, + java.lang.Object arg) + +
          +          Call a method on the object with one argument.
          +static java.lang.Objectinvoke(java.lang.Object obj, + java.lang.String methodName, + java.lang.Class argType1, + java.lang.Object arg1, + java.lang.Class argType2, + java.lang.Object arg2) + +
          +          Call a method on the object with two argument.
          +static java.lang.ObjectinvokeStatic(java.lang.Object obj, + java.lang.String methodName) + +
          +          Call a method on the object with no parameters.
          +static java.lang.ObjectnewInstance(java.lang.Class ofClass, + java.lang.Class[] argTypes, + java.lang.Object[] args) + +
          +          Create an instance of a class using the constructor matching + the given arguments.
          +static booleanrespondsTo(java.lang.Object o, + java.lang.String methodName) + +
          +          A method to test if an object responds to a given + message (method call)
          +static voidthrowBuildException(java.lang.Exception t) + +
          +          A method to convert an invocationTargetException to + a buildexception and throw it.
          +static BuildExceptiontoBuildException(java.lang.Exception t) + +
          +          A method to convert an invocationTargetException to + a buildexception.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +newInstance

          +
          +public static java.lang.Object newInstance(java.lang.Class ofClass,
+                                           java.lang.Class[] argTypes,
+                                           java.lang.Object[] args)
          +
          +
          Create an instance of a class using the constructor matching + the given arguments. +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +invoke

          +
          +public static java.lang.Object invoke(java.lang.Object obj,
+                                      java.lang.String methodName)
          +
          +
          Call a method on the object with no parameters. +

          +

          +
          Parameters:
          obj - the object to invoke the method on.
          methodName - the name of the method to call +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +invokeStatic

          +
          +public static java.lang.Object invokeStatic(java.lang.Object obj,
+                                            java.lang.String methodName)
          +
          +
          Call a method on the object with no parameters. + Note: Unlike the invoke method above, this + calls class or static methods, not instance methods. +

          +

          +
          Parameters:
          obj - the object to invoke the method on.
          methodName - the name of the method to call +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +invoke

          +
          +public static java.lang.Object invoke(java.lang.Object obj,
+                                      java.lang.String methodName,
+                                      java.lang.Class argType,
+                                      java.lang.Object arg)
          +
          +
          Call a method on the object with one argument. +

          +

          +
          Parameters:
          obj - the object to invoke the method on.
          methodName - the name of the method to call
          argType - the type of argument.
          arg - the value of the argument. +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +invoke

          +
          +public static java.lang.Object invoke(java.lang.Object obj,
+                                      java.lang.String methodName,
+                                      java.lang.Class argType1,
+                                      java.lang.Object arg1,
+                                      java.lang.Class argType2,
+                                      java.lang.Object arg2)
          +
          +
          Call a method on the object with two argument. +

          +

          +
          Parameters:
          obj - the object to invoke the method on.
          methodName - the name of the method to call
          argType1 - the type of the first argument.
          arg1 - the value of the first argument.
          argType2 - the type of the second argument.
          arg2 - the value of the second argument. +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +getField

          +
          +public static java.lang.Object getField(java.lang.Object obj,
+                                        java.lang.String fieldName)
+                                 throws BuildException
          +
          +
          Get the value of a field in an object. +

          +

          +
          Parameters:
          obj - the object to look at.
          fieldName - the name of the field in the object. +
          Returns:
          the value of the field. +
          Throws: +
          BuildException - if there is an error.
          +
          +
          +
          + +

          +throwBuildException

          +
          +public static void throwBuildException(java.lang.Exception t)
+                                throws BuildException
          +
          +
          A method to convert an invocationTargetException to + a buildexception and throw it. +

          +

          +
          Parameters:
          t - the invocation target exception. +
          Throws: +
          BuildException - the converted exception.
          +
          +
          +
          + +

          +toBuildException

          +
          +public static BuildException toBuildException(java.lang.Exception t)
          +
          +
          A method to convert an invocationTargetException to + a buildexception. +

          +

          +
          Parameters:
          t - the invocation target exception. +
          Returns:
          the converted exception.
          Since:
          +
          ant 1.7.1
          +
          +
          +
          +
          + +

          +respondsTo

          +
          +public static boolean respondsTo(java.lang.Object o,
+                                 java.lang.String methodName)
+                          throws BuildException
          +
          +
          A method to test if an object responds to a given + message (method call) +

          +

          +
          Parameters:
          o - the object
          methodName - the method to check for +
          Returns:
          true if the object has the method. +
          Throws: +
          BuildException - if there is a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectWrapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectWrapper.html new file mode 100644 index 000000000..a00e1db3c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ReflectWrapper.html @@ -0,0 +1,357 @@ + + + + + + +ReflectWrapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ReflectWrapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ReflectWrapper
+
          +
          +
          +
          public class ReflectWrapper
          extends java.lang.Object
          + + +

          +Utility class to handle reflection on java objects. + The class is a holder class for an object and + uses java reflection to call methods on the objects. + If things go wrong, BuildExceptions are thrown. +

          + +

          +

          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          ReflectWrapper(java.lang.ClassLoader loader, + java.lang.String name) + +
          +          Construct a wrapped object using the no arg constructor.
          ReflectWrapper(java.lang.Object obj) + +
          +          Constructor using a passed in object.
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.ObjectgetObject() + +
          +           
          + java.lang.Objectinvoke(java.lang.String methodName) + +
          +          Call a method on the object with no parameters.
          + java.lang.Objectinvoke(java.lang.String methodName, + java.lang.Class argType, + java.lang.Object arg) + +
          +          Call a method on the object with one argument.
          + java.lang.Objectinvoke(java.lang.String methodName, + java.lang.Class argType1, + java.lang.Object arg1, + java.lang.Class argType2, + java.lang.Object arg2) + +
          +          Call a method on the object with one argument.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ReflectWrapper

          +
          +public ReflectWrapper(java.lang.ClassLoader loader,
+                      java.lang.String name)
          +
          +
          Construct a wrapped object using the no arg constructor. +

          +

          +
          Parameters:
          loader - the classloader to use to construct the class.
          name - the classname of the object to construct.
          +
          +
          + +

          +ReflectWrapper

          +
          +public ReflectWrapper(java.lang.Object obj)
          +
          +
          Constructor using a passed in object. +

          +

          +
          Parameters:
          obj - the object to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getObject

          +
          +public java.lang.Object getObject()
          +
          +
          + +
          Returns:
          the wrapped object.
          +
          +
          +
          + +

          +invoke

          +
          +public java.lang.Object invoke(java.lang.String methodName)
          +
          +
          Call a method on the object with no parameters. +

          +

          +
          Parameters:
          methodName - the name of the method to call +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +invoke

          +
          +public java.lang.Object invoke(java.lang.String methodName,
+                               java.lang.Class argType,
+                               java.lang.Object arg)
          +
          +
          Call a method on the object with one argument. +

          +

          +
          Parameters:
          methodName - the name of the method to call
          argType - the type of argument.
          arg - the value of the argument. +
          Returns:
          the object returned by the method
          +
          +
          +
          + +

          +invoke

          +
          +public java.lang.Object invoke(java.lang.String methodName,
+                               java.lang.Class argType1,
+                               java.lang.Object arg1,
+                               java.lang.Class argType2,
+                               java.lang.Object arg2)
          +
          +
          Call a method on the object with one argument. +

          +

          +
          Parameters:
          methodName - the name of the method to call
          argType1 - the type of the first argument.
          arg1 - the value of the first argument.
          argType2 - the type of the second argument.
          arg2 - the value of the second argument. +
          Returns:
          the object returned by the method
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RegexpPatternMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RegexpPatternMapper.html new file mode 100644 index 000000000..040752415 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RegexpPatternMapper.html @@ -0,0 +1,481 @@ + + + + + + +RegexpPatternMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class RegexpPatternMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.RegexpPatternMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class RegexpPatternMapper
          extends java.lang.Object
          implements FileNameMapper
          + + +

          +Implementation of FileNameMapper that does regular expression + replacements. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  RegexpMatcherreg + +
          +           
          +protected  java.lang.StringBufferresult + +
          +           
          +protected  char[]to + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          RegexpPatternMapper() + +
          +          Constructor for RegexpPatternMapper.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]mapFileName(java.lang.String sourceFileName) + +
          +          Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise.
          +protected  java.lang.StringreplaceReferences(java.lang.String source) + +
          +          Replace all backreferences in the to pattern with the matched + groups of the source.
          + voidsetCaseSensitive(boolean caseSensitive) + +
          +          Attribute specifing whether to ignore the case difference + in the names.
          + voidsetFrom(java.lang.String from) + +
          +          Sets the "from" pattern.
          + voidsetHandleDirSep(boolean handleDirSep) + +
          +          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters).
          + voidsetTo(java.lang.String to) + +
          +          Sets the "to" pattern.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +reg

          +
          +protected RegexpMatcher reg
          +
          +
          +
          +
          +
          + +

          +to

          +
          +protected char[] to
          +
          +
          +
          +
          +
          + +

          +result

          +
          +protected java.lang.StringBuffer result
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +RegexpPatternMapper

          +
          +public RegexpPatternMapper()
+                    throws BuildException
          +
          +
          Constructor for RegexpPatternMapper. +

          +

          + +
          Throws: +
          BuildException - on error.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setHandleDirSep

          +
          +public void setHandleDirSep(boolean handleDirSep)
          +
          +
          Attribute specifing whether to ignore the difference + between / and \ (the two common directory characters). +

          +

          +
          +
          +
          +
          Parameters:
          handleDirSep - a boolean, default is false.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setCaseSensitive

          +
          +public void setCaseSensitive(boolean caseSensitive)
          +
          +
          Attribute specifing whether to ignore the case difference + in the names. +

          +

          +
          +
          +
          +
          Parameters:
          caseSensitive - a boolean, default is false.
          Since:
          +
          Ant 1.6.3
          +
          +
          +
          +
          + +

          +setFrom

          +
          +public void setFrom(java.lang.String from)
+             throws BuildException
          +
          +
          Sets the "from" pattern. Required. +

          +

          +
          Specified by:
          setFrom in interface FileNameMapper
          +
          +
          +
          Parameters:
          from - the from pattern. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +setTo

          +
          +public void setTo(java.lang.String to)
          +
          +
          Sets the "to" pattern. Required. +

          +

          +
          Specified by:
          setTo in interface FileNameMapper
          +
          +
          +
          Parameters:
          to - the to pattern. +
          Throws: +
          BuildException - on error.
          +
          +
          +
          + +

          +mapFileName

          +
          +public java.lang.String[] mapFileName(java.lang.String sourceFileName)
          +
          +
          Returns null if the source file name doesn't match the + "from" pattern, an one-element array containing the + translated file otherwise. +

          +

          +
          Specified by:
          mapFileName in interface FileNameMapper
          +
          +
          +
          Parameters:
          sourceFileName - the source file name +
          Returns:
          a one-element array containing the translated file or + null if the to pattern did not match
          +
          +
          +
          + +

          +replaceReferences

          +
          +protected java.lang.String replaceReferences(java.lang.String source)
          +
          +
          Replace all backreferences in the to pattern with the matched + groups of the source. +

          +

          +
          +
          +
          +
          Parameters:
          source - the source file name. +
          Returns:
          the translated file name.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.ResourceSelectorProvider.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.ResourceSelectorProvider.html new file mode 100644 index 000000000..3a987b679 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.ResourceSelectorProvider.html @@ -0,0 +1,204 @@ + + + + + + +ResourceUtils.ResourceSelectorProvider (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Interface ResourceUtils.ResourceSelectorProvider

          +
          +
          Enclosing class:
          ResourceUtils
          +
          +
          +
          +
          public static interface ResourceUtils.ResourceSelectorProvider
          + + +

          +

          + +

          + + + + + + + + + + + + +
          +Method Summary
          + ResourceSelectorgetTargetSelectorForSource(Resource source) + +
          +           
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getTargetSelectorForSource

          +
          +ResourceSelector getTargetSelectorForSource(Resource source)
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.html new file mode 100644 index 000000000..52187b04d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ResourceUtils.html @@ -0,0 +1,798 @@ + + + + + + +ResourceUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ResourceUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ResourceUtils
+
          +
          +
          +
          public class ResourceUtils
          extends java.lang.Object
          + + +

          +This class provides utility methods to process Resources. +

          + +

          +

          +
          Since:
          +
          Ant 1.5.2
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static interfaceResourceUtils.ResourceSelectorProvider + +
          +           
          +  + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringISO_8859_1 + +
          +          Name of charset "ISO Latin Alphabet No.
          +  + + + + + + + + + + +
          +Constructor Summary
          ResourceUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static FileResourceasFileResource(FileProvider fileProvider) + +
          +          Convenience method to turn any fileProvider into a basic + FileResource with the file's immediate parent as the basedir, + for tasks that need one.
          +static intcompareContent(Resource r1, + Resource r2, + boolean text) + +
          +          Compare the content of two Resources.
          +static booleancontentEquals(Resource r1, + Resource r2, + boolean text) + +
          +          Compares the contents of two Resources.
          +static voidcopyResource(Resource source, + Resource dest) + +
          +          Convenience method to copy content from one Resource to another.
          +static voidcopyResource(Resource source, + Resource dest, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + boolean append, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project) + +
          +          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source.
          +static voidcopyResource(Resource source, + Resource dest, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + boolean append, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project, + boolean force) + +
          +          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source.
          +static voidcopyResource(Resource source, + Resource dest, + FilterSetCollection filters, + java.util.Vector filterChains, + boolean overwrite, + boolean preserveLastModified, + java.lang.String inputEncoding, + java.lang.String outputEncoding, + Project project) + +
          +          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source.
          +static voidcopyResource(Resource source, + Resource dest, + Project project) + +
          +          Convenience method to copy content from one Resource to another.
          +static Resource[]selectOutOfDateSources(ProjectComponent logTo, + Resource[] source, + FileNameMapper mapper, + ResourceFactory targets) + +
          +          Tells which source files should be reprocessed based on the + last modification date of target files.
          +static Resource[]selectOutOfDateSources(ProjectComponent logTo, + Resource[] source, + FileNameMapper mapper, + ResourceFactory targets, + long granularity) + +
          +          Tells which source files should be reprocessed based on the + last modification date of target files.
          +static ResourceCollectionselectOutOfDateSources(ProjectComponent logTo, + ResourceCollection source, + FileNameMapper mapper, + ResourceFactory targets, + long granularity) + +
          +          Tells which sources should be reprocessed based on the + last modification date of targets.
          +static ResourceCollectionselectSources(ProjectComponent logTo, + ResourceCollection source, + FileNameMapper mapper, + ResourceFactory targets, + ResourceUtils.ResourceSelectorProvider selector) + +
          +          Tells which sources should be reprocessed because the given + selector selects at least one target.
          +static voidsetLastModified(Touchable t, + long time) + +
          +          Set the last modified time of an object implementing + org.apache.tools.ant.types.resources.Touchable .
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ISO_8859_1

          +
          +public static final java.lang.String ISO_8859_1
          +
          +
          Name of charset "ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1". +

          +

          +
          Since:
          +
          Ant 1.8.1
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ResourceUtils

          +
          +public ResourceUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +selectOutOfDateSources

          +
          +public static Resource[] selectOutOfDateSources(ProjectComponent logTo,
+                                                Resource[] source,
+                                                FileNameMapper mapper,
+                                                ResourceFactory targets)
          +
          +
          Tells which source files should be reprocessed based on the + last modification date of target files. +

          +

          +
          Parameters:
          logTo - where to send (more or less) interesting output.
          source - array of resources bearing relative path and last + modification date.
          mapper - filename mapper indicating how to find the target + files.
          targets - object able to map as a resource a relative path + at destination. +
          Returns:
          array containing the source files which need to be + copied or processed, because the targets are out of date or do + not exist.
          +
          +
          +
          + +

          +selectOutOfDateSources

          +
          +public static Resource[] selectOutOfDateSources(ProjectComponent logTo,
+                                                Resource[] source,
+                                                FileNameMapper mapper,
+                                                ResourceFactory targets,
+                                                long granularity)
          +
          +
          Tells which source files should be reprocessed based on the + last modification date of target files. +

          +

          +
          Parameters:
          logTo - where to send (more or less) interesting output.
          source - array of resources bearing relative path and last + modification date.
          mapper - filename mapper indicating how to find the target + files.
          targets - object able to map as a resource a relative path + at destination.
          granularity - The number of milliseconds leeway to give + before deciding a target is out of date. +
          Returns:
          array containing the source files which need to be + copied or processed, because the targets are out of date or do + not exist.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +selectOutOfDateSources

          +
          +public static ResourceCollection selectOutOfDateSources(ProjectComponent logTo,
+                                                        ResourceCollection source,
+                                                        FileNameMapper mapper,
+                                                        ResourceFactory targets,
+                                                        long granularity)
          +
          +
          Tells which sources should be reprocessed based on the + last modification date of targets. +

          +

          +
          Parameters:
          logTo - where to send (more or less) interesting output.
          source - ResourceCollection.
          mapper - filename mapper indicating how to find the target Resources.
          targets - object able to map a relative path as a Resource.
          granularity - The number of milliseconds leeway to give + before deciding a target is out of date. +
          Returns:
          ResourceCollection.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +selectSources

          +
          +public static ResourceCollection selectSources(ProjectComponent logTo,
+                                               ResourceCollection source,
+                                               FileNameMapper mapper,
+                                               ResourceFactory targets,
+                                               ResourceUtils.ResourceSelectorProvider selector)
          +
          +
          Tells which sources should be reprocessed because the given + selector selects at least one target. +

          +

          +
          Parameters:
          logTo - where to send (more or less) interesting output.
          source - ResourceCollection.
          mapper - filename mapper indicating how to find the target Resources.
          targets - object able to map a relative path as a Resource.
          selector - returns a selector that is applied to target + files. If it selects at least one target the source will be + added to the returned collection. +
          Returns:
          ResourceCollection.
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          +
          + +

          +copyResource

          +
          +public static void copyResource(Resource source,
+                                Resource dest)
+                         throws java.io.IOException
          +
          +
          Convenience method to copy content from one Resource to another. + No filtering is performed. +

          +

          +
          Parameters:
          source - the Resource to copy from. + Must not be null.
          dest - the Resource to copy to. + Must not be null. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +copyResource

          +
          +public static void copyResource(Resource source,
+                                Resource dest,
+                                Project project)
+                         throws java.io.IOException
          +
          +
          Convenience method to copy content from one Resource to another. + No filtering is performed. +

          +

          +
          Parameters:
          source - the Resource to copy from. + Must not be null.
          dest - the Resource to copy to. + Must not be null.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +copyResource

          +
          +public static void copyResource(Resource source,
+                                Resource dest,
+                                FilterSetCollection filters,
+                                java.util.Vector filterChains,
+                                boolean overwrite,
+                                boolean preserveLastModified,
+                                java.lang.String inputEncoding,
+                                java.lang.String outputEncoding,
+                                Project project)
+                         throws java.io.IOException
          +
          +
          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +

          +

          +
          Parameters:
          source - the Resource to copy from. + Must not be null.
          dest - the Resource to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination Resource should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the destination Resource should be set to that + of the source.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +copyResource

          +
          +public static void copyResource(Resource source,
+                                Resource dest,
+                                FilterSetCollection filters,
+                                java.util.Vector filterChains,
+                                boolean overwrite,
+                                boolean preserveLastModified,
+                                boolean append,
+                                java.lang.String inputEncoding,
+                                java.lang.String outputEncoding,
+                                Project project)
+                         throws java.io.IOException
          +
          +
          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +

          +

          +
          Parameters:
          source - the Resource to copy from. + Must not be null.
          dest - the Resource to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination Resource should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the destination Resource should be set to that + of the source.
          append - Whether to append to an Appendable Resource.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance. +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.8
          +
          +
          +
          +
          + +

          +copyResource

          +
          +public static void copyResource(Resource source,
+                                Resource dest,
+                                FilterSetCollection filters,
+                                java.util.Vector filterChains,
+                                boolean overwrite,
+                                boolean preserveLastModified,
+                                boolean append,
+                                java.lang.String inputEncoding,
+                                java.lang.String outputEncoding,
+                                Project project,
+                                boolean force)
+                         throws java.io.IOException
          +
          +
          Convenience method to copy content from one Resource to another + specifying whether token filtering must be used, whether filter chains + must be used, whether newer destination files may be overwritten and + whether the last modified time of dest file should be made + equal to the last modified time of source. +

          +

          +
          Parameters:
          source - the Resource to copy from. + Must not be null.
          dest - the Resource to copy to. + Must not be null.
          filters - the collection of filters to apply to this copy.
          filterChains - filterChains to apply during the copy.
          overwrite - Whether or not the destination Resource should be + overwritten if it already exists.
          preserveLastModified - Whether or not the last modified time of + the destination Resource should be set to that + of the source.
          append - Whether to append to an Appendable Resource.
          inputEncoding - the encoding used to read the files.
          outputEncoding - the encoding used to write the files.
          project - the project instance.
          force - whether read-only taret files will be overwritten +
          Throws: +
          java.io.IOException - if the copying fails.
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +setLastModified

          +
          +public static void setLastModified(Touchable t,
+                                   long time)
          +
          +
          Set the last modified time of an object implementing + org.apache.tools.ant.types.resources.Touchable . +

          +

          +
          Parameters:
          t - the Touchable whose modified time is to be set.
          time - the time to which the last modified time is to be set. + if this is -1, the current time is used.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +contentEquals

          +
          +public static boolean contentEquals(Resource r1,
+                                    Resource r2,
+                                    boolean text)
+                             throws java.io.IOException
          +
          +
          Compares the contents of two Resources. +

          +

          +
          Parameters:
          r1 - the Resource whose content is to be compared.
          r2 - the other Resource whose content is to be compared.
          text - true if the content is to be treated as text and + differences in kind of line break are to be ignored. +
          Returns:
          true if the content of the Resources is the same. +
          Throws: +
          java.io.IOException - if the Resources cannot be read.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +compareContent

          +
          +public static int compareContent(Resource r1,
+                                 Resource r2,
+                                 boolean text)
+                          throws java.io.IOException
          +
          +
          Compare the content of two Resources. A nonexistent Resource's + content is "less than" that of an existing Resource; a directory-type + Resource's content is "less than" that of a file-type Resource. +

          +

          +
          Parameters:
          r1 - the Resource whose content is to be compared.
          r2 - the other Resource whose content is to be compared.
          text - true if the content is to be treated as text and + differences in kind of line break are to be ignored. +
          Returns:
          a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second. +
          Throws: +
          java.io.IOException - if the Resources cannot be read.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +asFileResource

          +
          +public static FileResource asFileResource(FileProvider fileProvider)
          +
          +
          Convenience method to turn any fileProvider into a basic + FileResource with the file's immediate parent as the basedir, + for tasks that need one. +

          +

          +
          Parameters:
          fileProvider - input +
          Returns:
          fileProvider if it is a FileResource instance, or a new + FileResource with fileProvider's file.
          Since:
          +
          Ant 1.8
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RetryHandler.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RetryHandler.html new file mode 100644 index 000000000..9fb99c633 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/RetryHandler.html @@ -0,0 +1,266 @@ + + + + + + +RetryHandler (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class RetryHandler

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.RetryHandler
+
          +
          +
          +
          public class RetryHandler
          extends java.lang.Object
          + + +

          +A simple utility class to take a piece of code (that implements + Retryable interface) and executes that with possibility to + retry the execution in case of IOException. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          RetryHandler(int retriesAllowed, + Task task) + +
          +          Create a new RetryingHandler.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidexecute(Retryable exe, + java.lang.String desc) + +
          +          Execute the Retryable code with specified number of retries.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RetryHandler

          +
          +public RetryHandler(int retriesAllowed,
+                    Task task)
          +
          +
          Create a new RetryingHandler. +

          +

          +
          Parameters:
          retriesAllowed - how many times to retry
          task - the Ant task that is is executed from, used for logging only
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +public void execute(Retryable exe,
+                    java.lang.String desc)
+             throws java.io.IOException
          +
          +
          Execute the Retryable code with specified number of retries. +

          +

          +
          Parameters:
          exe - the code to execute
          desc - some descriptive text for this piece of code, used for logging +
          Throws: +
          java.io.IOException - if the number of retries has exceeded the allowed limit
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Retryable.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Retryable.html new file mode 100644 index 000000000..89a283918 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Retryable.html @@ -0,0 +1,251 @@ + + + + + + +Retryable (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Interface Retryable

          +
          +
          +
          public interface Retryable
          + + +

          +Simple interface for executing a piece of code. Used for writing anonymous inner + classes in FTP task for retry-on-IOException behaviour. +

          + +

          +

          +
          See Also:
          RetryHandler
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static intRETRY_FOREVER + +
          +          The value to use to never give up.
          +  + + + + + + + + + + + +
          +Method Summary
          + voidexecute() + +
          +          Called to execute the code.
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +RETRY_FOREVER

          +
          +static final int RETRY_FOREVER
          +
          +
          The value to use to never give up. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +execute

          +
          +void execute()
+             throws java.io.IOException
          +
          +
          Called to execute the code. +

          +

          + +
          Throws: +
          java.io.IOException - if there is a problem.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptFixBSFPath.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptFixBSFPath.html new file mode 100644 index 000000000..95dfd6c65 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptFixBSFPath.html @@ -0,0 +1,270 @@ + + + + + + +ScriptFixBSFPath (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ScriptFixBSFPath

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptFixBSFPath
+
          +
          +
          +
          public class ScriptFixBSFPath
          extends java.lang.Object
          + + +

          +A class to modify a classloader to + support BSF language support. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptFixBSFPath() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          + voidfixClassLoader(java.lang.ClassLoader loader, + java.lang.String language) + +
          +          Check if need to mess about with the classloader.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptFixBSFPath

          +
          +public ScriptFixBSFPath()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +fixClassLoader

          +
          +public void fixClassLoader(java.lang.ClassLoader loader,
+                           java.lang.String language)
          +
          +
          Check if need to mess about with the classloader. + The class loader will need to be modified for two + reasons: +
            +
          1. language is at a higher level than bsf for engines in bsf, + move bsf. +
            2. +
          2. bsf is at a higher level than oata.util.optional.ScriptRunner +
            3. +
          + + Assume a simple model for the loader: + thisloader<-customloader + or + thisloader +

          +

          +
          Parameters:
          loader - the classloader to fix.
          language - the language to use.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunner.html new file mode 100644 index 000000000..22e9f3683 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunner.html @@ -0,0 +1,246 @@ + + + + + + +ScriptRunner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ScriptRunner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerBase
+      extended by org.apache.tools.ant.util.optional.ScriptRunner
+          extended by org.apache.tools.ant.util.ScriptRunner
+
          +
          +Deprecated. Implementation moved to another location. Use + that org.apache.tools.ant.types.optional.ScriptRunner instead. +

          +

          +
          public class ScriptRunner
          extends ScriptRunner
          + + +

          +This class is here for backwards compatiblity. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptRunner() + +
          +          Deprecated.  
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.optional.ScriptRunner
          evaluateScript, executeScript, getManagerName, supportsLanguage
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ScriptRunnerBase
          addBean, addBeans, addText, bindToComponent, bindToComponentMinimum, checkLanguage, clearScript, getBeans, getKeepEngine, getLanguage, getProject, getScript, getScriptClassLoader, loadResource, loadResources, replaceContextLoader, restoreContextLoader, setKeepEngine, setLanguage, setProject, setScriptClassLoader, setSrc
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptRunner

          +
          +public ScriptRunner()
          +
          +
          Deprecated. 
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerBase.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerBase.html new file mode 100644 index 000000000..a8bd36ea0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerBase.html @@ -0,0 +1,824 @@ + + + + + + +ScriptRunnerBase (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ScriptRunnerBase

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerBase
+
          +
          +
          Direct Known Subclasses:
          JavaxScriptRunner, ScriptRunner
          +
          +
          +
          +
          public abstract class ScriptRunnerBase
          extends java.lang.Object
          + + +

          +This is a common abstract base case for script runners. + These classes need to implement executeScript, evaluateScript + and supportsLanguage. +

          + +

          +

          +
          Since:
          +
          Ant 1.7.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptRunnerBase() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddBean(java.lang.String key, + java.lang.Object bean) + +
          +          Add a single object into the script context.
          + voidaddBeans(java.util.Map dictionary) + +
          +          Add a list of named objects to the list to be exported to the script
          + voidaddText(java.lang.String text) + +
          +          Set the script text.
          + voidbindToComponent(ProjectComponent component) + +
          +          Bind the runner to a project component.
          + voidbindToComponentMinimum(ProjectComponent component) + +
          +          Bind the runner to a project component.
          +protected  voidcheckLanguage() + +
          +          Check if the language attribute is set.
          + voidclearScript() + +
          +          Clear the current script text content.
          +abstract  java.lang.ObjectevaluateScript(java.lang.String execName) + +
          +          Evaluate the script.
          +abstract  voidexecuteScript(java.lang.String execName) + +
          +          Do the work.
          +protected  java.util.MapgetBeans() + +
          +          Get the beans used for the script.
          + booleangetKeepEngine() + +
          +          Get the keep engine attribute.
          + java.lang.StringgetLanguage() + +
          +          Get the script language
          +abstract  java.lang.StringgetManagerName() + +
          +          Get the name of the manager prefix used for this + scriptrunner.
          + ProjectgetProject() + +
          +          Get the project for this runner.
          + java.lang.StringgetScript() + +
          +          Get the current script text content.
          +protected  java.lang.ClassLoadergetScriptClassLoader() + +
          +          Get the classloader used to load the script engine.
          + voidloadResource(Resource sourceResource) + +
          +          Add a resource to the source list.
          + voidloadResources(ResourceCollection collection) + +
          +          Add all resources in a resource collection to the source list.
          +protected  java.lang.ClassLoaderreplaceContextLoader() + +
          +          Replace the current context classloader with the + script context classloader.
          +protected  voidrestoreContextLoader(java.lang.ClassLoader origLoader) + +
          +          Restore the context loader with the original context classloader.
          + voidsetKeepEngine(boolean keepEngine) + +
          +          Whether to keep the script engine between calls.
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetProject(Project project) + +
          +          Set the project for this runner.
          + voidsetScriptClassLoader(java.lang.ClassLoader classLoader) + +
          +          Set the script classloader.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file; optional.
          +abstract  booleansupportsLanguage() + +
          +          Check if a script engine can be created for + this language.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptRunnerBase

          +
          +public ScriptRunnerBase()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addBeans

          +
          +public void addBeans(java.util.Map dictionary)
          +
          +
          Add a list of named objects to the list to be exported to the script +

          +

          +
          Parameters:
          dictionary - a map of objects to be placed into the script context + indexed by String names.
          +
          +
          +
          + +

          +addBean

          +
          +public void addBean(java.lang.String key,
+                    java.lang.Object bean)
          +
          +
          Add a single object into the script context. +

          +

          +
          Parameters:
          key - the name in the context this object is to stored under.
          bean - the object to be stored in the script context.
          +
          +
          +
          + +

          +getBeans

          +
          +protected java.util.Map getBeans()
          +
          +
          Get the beans used for the script. +

          +

          + +
          Returns:
          the map of beans.
          +
          +
          +
          + +

          +executeScript

          +
          +public abstract void executeScript(java.lang.String execName)
          +
          +
          Do the work. +

          +

          +
          Parameters:
          execName - the name that will be passed to BSF for this script + execution.
          +
          +
          +
          + +

          +evaluateScript

          +
          +public abstract java.lang.Object evaluateScript(java.lang.String execName)
          +
          +
          Evaluate the script. +

          +

          +
          Parameters:
          execName - the name that will be passed to the + scripting engine for this script execution. +
          Returns:
          the result of evaluating the script.
          +
          +
          +
          + +

          +supportsLanguage

          +
          +public abstract boolean supportsLanguage()
          +
          +
          Check if a script engine can be created for + this language. +

          +

          + +
          Returns:
          true if a script engine can be created, false + otherwise.
          +
          +
          +
          + +

          +getManagerName

          +
          +public abstract java.lang.String getManagerName()
          +
          +
          Get the name of the manager prefix used for this + scriptrunner. +

          +

          + +
          Returns:
          the prefix string.
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +getLanguage

          +
          +public java.lang.String getLanguage()
          +
          +
          Get the script language +

          +

          + +
          Returns:
          the script language
          +
          +
          +
          + +

          +setScriptClassLoader

          +
          +public void setScriptClassLoader(java.lang.ClassLoader classLoader)
          +
          +
          Set the script classloader. +

          +

          +
          Parameters:
          classLoader - the classloader to use.
          +
          +
          +
          + +

          +getScriptClassLoader

          +
          +protected java.lang.ClassLoader getScriptClassLoader()
          +
          +
          Get the classloader used to load the script engine. +

          +

          + +
          Returns:
          the classloader.
          +
          +
          +
          + +

          +setKeepEngine

          +
          +public void setKeepEngine(boolean keepEngine)
          +
          +
          Whether to keep the script engine between calls. +

          +

          +
          Parameters:
          keepEngine - if true, keep the engine.
          +
          +
          +
          + +

          +getKeepEngine

          +
          +public boolean getKeepEngine()
          +
          +
          Get the keep engine attribute. +

          +

          + +
          Returns:
          the attribute.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +loadResource

          +
          +public void loadResource(Resource sourceResource)
          +
          +
          Add a resource to the source list. +

          +

          +
          Parameters:
          sourceResource - the resource to load +
          Throws: +
          BuildException - if the resource cannot be read
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +loadResources

          +
          +public void loadResources(ResourceCollection collection)
          +
          +
          Add all resources in a resource collection to the source list. +

          +

          +
          Parameters:
          collection - the resource to load +
          Throws: +
          BuildException - if a resource cannot be read
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Set the script text. Properties in the text are not expanded! +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +getScript

          +
          +public java.lang.String getScript()
          +
          +
          Get the current script text content. +

          +

          + +
          Returns:
          the script text.
          +
          +
          +
          + +

          +clearScript

          +
          +public void clearScript()
          +
          +
          Clear the current script text content. +

          +

          +
          +
          +
          +
          + +

          +setProject

          +
          +public void setProject(Project project)
          +
          +
          Set the project for this runner. +

          +

          +
          Parameters:
          project - the project.
          +
          +
          +
          + +

          +getProject

          +
          +public Project getProject()
          +
          +
          Get the project for this runner. +

          +

          + +
          Returns:
          the project.
          +
          +
          +
          + +

          +bindToComponent

          +
          +public void bindToComponent(ProjectComponent component)
          +
          +
          Bind the runner to a project component. + Properties, targets and references are all added as beans; + project is bound to project, and self to the component. +

          +

          +
          Parameters:
          component - to become self
          +
          +
          +
          + +

          +bindToComponentMinimum

          +
          +public void bindToComponentMinimum(ProjectComponent component)
          +
          +
          Bind the runner to a project component. + The project and self are the only beans set. +

          +

          +
          Parameters:
          component - to become self
          +
          +
          +
          + +

          +checkLanguage

          +
          +protected void checkLanguage()
          +
          +
          Check if the language attribute is set. +

          +

          + +
          Throws: +
          BuildException - if it is not.
          +
          +
          +
          + +

          +replaceContextLoader

          +
          +protected java.lang.ClassLoader replaceContextLoader()
          +
          +
          Replace the current context classloader with the + script context classloader. +

          +

          + +
          Returns:
          the current context classloader.
          +
          +
          +
          + +

          +restoreContextLoader

          +
          +protected void restoreContextLoader(java.lang.ClassLoader origLoader)
          +
          +
          Restore the context loader with the original context classloader. + + script context loader. +

          +

          +
          Parameters:
          origLoader - the original context classloader.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerCreator.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerCreator.html new file mode 100644 index 000000000..8088c3131 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerCreator.html @@ -0,0 +1,265 @@ + + + + + + +ScriptRunnerCreator (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ScriptRunnerCreator

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerCreator
+
          +
          +
          +
          public class ScriptRunnerCreator
          extends java.lang.Object
          + + +

          +This is a helper class used by ScriptRunnerHelper to + create a ScriptRunner based on a classloader and on a language. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptRunnerCreator(Project project) + +
          +          Constructor for creator.
          +  + + + + + + + + + + + +
          +Method Summary
          + ScriptRunnerBasecreateRunner(java.lang.String manager, + java.lang.String language, + java.lang.ClassLoader classLoader) + +
          +          Create a ScriptRunner.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptRunnerCreator

          +
          +public ScriptRunnerCreator(Project project)
          +
          +
          Constructor for creator. +

          +

          +
          Parameters:
          project - the current project.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +createRunner

          +
          +public ScriptRunnerBase createRunner(java.lang.String manager,
+                                     java.lang.String language,
+                                     java.lang.ClassLoader classLoader)
          +
          +
          Create a ScriptRunner. +

          +

          +
          Parameters:
          manager - the script manager ("auto" | "bsf" | "javax")
          language - the language.
          classLoader - the classloader to use +
          Returns:
          the created script runner. +
          Throws: +
          BuildException - if unable to create the ScriptRunner.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerHelper.html new file mode 100644 index 000000000..64eae3e4f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/ScriptRunnerHelper.html @@ -0,0 +1,517 @@ + + + + + + +ScriptRunnerHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class ScriptRunnerHelper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerHelper
+
          +
          +
          +
          public class ScriptRunnerHelper
          extends java.lang.Object
          + + +

          +A class to help in creating, setting and getting script runners. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptRunnerHelper() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(ResourceCollection resource) + +
          +          Add any source resource.
          + voidaddText(java.lang.String text) + +
          +          Add script text.
          + PathcreateClasspath() + +
          +          Classpath to be used when searching for classes and resources.
          + java.lang.StringgetLanguage() + +
          +          Get the language.
          + ScriptRunnerBasegetScriptRunner() + +
          +          Create and set text on a script.
          + voidsetClassLoader(java.lang.ClassLoader loader) + +
          +          Used when called by scriptdef.
          + voidsetClasspath(Path classpath) + +
          +          Set the classpath to be used when searching for classes and resources.
          + voidsetClasspathRef(Reference r) + +
          +          Set the classpath by reference.
          + voidsetLanguage(java.lang.String language) + +
          +          Defines the language (required).
          + voidsetManager(java.lang.String manager) + +
          +          Defines the script manager - defaults to "auto".
          + voidsetProjectComponent(ProjectComponent component) + +
          +          Set the project component associated with this helper.
          + voidsetSetBeans(boolean setBeans) + +
          +          Set the setbeans attribute.
          + voidsetSrc(java.io.File file) + +
          +          Load the script from an external file ; optional.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptRunnerHelper

          +
          +public ScriptRunnerHelper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setProjectComponent

          +
          +public void setProjectComponent(ProjectComponent component)
          +
          +
          Set the project component associated with this helper. +

          +

          +
          Parameters:
          component - the project component that owns this helper.
          +
          +
          +
          + +

          +getScriptRunner

          +
          +public ScriptRunnerBase getScriptRunner()
          +
          +
          Create and set text on a script. +

          +

          + +
          Returns:
          the created or reused script runner.
          +
          +
          +
          + +

          +createClasspath

          +
          +public Path createClasspath()
          +
          +
          Classpath to be used when searching for classes and resources. +

          +

          + +
          Returns:
          an empty Path instance to be configured by Ant.
          +
          +
          +
          + +

          +setClasspath

          +
          +public void setClasspath(Path classpath)
          +
          +
          Set the classpath to be used when searching for classes and resources. +

          +

          +
          Parameters:
          classpath - an Ant Path object containing the search path.
          +
          +
          +
          + +

          +setClasspathRef

          +
          +public void setClasspathRef(Reference r)
          +
          +
          Set the classpath by reference. +

          +

          +
          Parameters:
          r - a Reference to a Path instance to be used as the classpath + value.
          +
          +
          +
          + +

          +setSrc

          +
          +public void setSrc(java.io.File file)
          +
          +
          Load the script from an external file ; optional. +

          +

          +
          Parameters:
          file - the file containing the script source.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String text)
          +
          +
          Add script text. +

          +

          +
          Parameters:
          text - a component of the script text to be added.
          +
          +
          +
          + +

          +setManager

          +
          +public void setManager(java.lang.String manager)
          +
          +
          Defines the script manager - defaults to "auto". +

          +

          +
          Parameters:
          manager - the scripting manager - "bsf" or "javax" or "auto"
          +
          +
          +
          + +

          +setLanguage

          +
          +public void setLanguage(java.lang.String language)
          +
          +
          Defines the language (required). +

          +

          +
          Parameters:
          language - the scripting language name for the script.
          +
          +
          +
          + +

          +getLanguage

          +
          +public java.lang.String getLanguage()
          +
          +
          Get the language. +

          +

          + +
          Returns:
          the scripting language.
          +
          +
          +
          + +

          +setSetBeans

          +
          +public void setSetBeans(boolean setBeans)
          +
          +
          Set the setbeans attribute. + If this is true, <script> will create variables in the + script instance for all + properties, targets and references of the current project. + It this is false, only the project and self variables will + be set. + The default is true. +

          +

          +
          Parameters:
          setBeans - the value to set.
          +
          +
          +
          + +

          +setClassLoader

          +
          +public void setClassLoader(java.lang.ClassLoader loader)
          +
          +
          Used when called by scriptdef. +

          +

          +
          Parameters:
          loader - the loader used by scriptdef.
          +
          +
          +
          + +

          +add

          +
          +public void add(ResourceCollection resource)
          +
          +
          Add any source resource. +

          +

          +
          Parameters:
          resource - source of script
          Since:
          +
          Ant 1.7.1
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SourceFileScanner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SourceFileScanner.html new file mode 100644 index 000000000..55305a602 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SourceFileScanner.html @@ -0,0 +1,461 @@ + + + + + + +SourceFileScanner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class SourceFileScanner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.SourceFileScanner
+
          +
          +
          All Implemented Interfaces:
          ResourceFactory
          +
          +
          +
          +
          public class SourceFileScanner
          extends java.lang.Object
          implements ResourceFactory
          + + +

          +Utility class that collects the functionality of the various + scanDir methods that have been scattered in several tasks before. + +

          The only method returns an array of source files. The array is a + subset of the files given as a parameter and holds only those that + are newer than their corresponding target files.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  Tasktask + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          SourceFileScanner(Task task) + +
          +          Construct a new SourceFileScanner.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + ResourcegetResource(java.lang.String name) + +
          +          Returns resource information for a file at destination.
          + java.lang.String[]restrict(java.lang.String[] files, + java.io.File srcDir, + java.io.File destDir, + FileNameMapper mapper) + +
          +          Restrict the given set of files to those that are newer than + their corresponding target files.
          + java.lang.String[]restrict(java.lang.String[] files, + java.io.File srcDir, + java.io.File destDir, + FileNameMapper mapper, + long granularity) + +
          +          Restrict the given set of files to those that are newer than + their corresponding target files.
          + java.io.File[]restrictAsFiles(java.lang.String[] files, + java.io.File srcDir, + java.io.File destDir, + FileNameMapper mapper) + +
          +          Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute).
          + java.io.File[]restrictAsFiles(java.lang.String[] files, + java.io.File srcDir, + java.io.File destDir, + FileNameMapper mapper, + long granularity) + +
          +          Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute).
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +task

          +
          +protected Task task
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SourceFileScanner

          +
          +public SourceFileScanner(Task task)
          +
          +
          Construct a new SourceFileScanner. +

          +

          +
          Parameters:
          task - The task we should log messages through.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +restrict

          +
          +public java.lang.String[] restrict(java.lang.String[] files,
+                                   java.io.File srcDir,
+                                   java.io.File destDir,
+                                   FileNameMapper mapper)
          +
          +
          Restrict the given set of files to those that are newer than + their corresponding target files. +

          +

          +
          +
          +
          +
          Parameters:
          files - the original set of files.
          srcDir - all files are relative to this directory.
          destDir - target files live here. if null file names + returned by the mapper are assumed to be absolute.
          mapper - knows how to construct a target file names from + source file names. +
          Returns:
          an array of filenames.
          +
          +
          +
          + +

          +restrict

          +
          +public java.lang.String[] restrict(java.lang.String[] files,
+                                   java.io.File srcDir,
+                                   java.io.File destDir,
+                                   FileNameMapper mapper,
+                                   long granularity)
          +
          +
          Restrict the given set of files to those that are newer than + their corresponding target files. +

          +

          +
          +
          +
          +
          Parameters:
          files - the original set of files.
          srcDir - all files are relative to this directory.
          destDir - target files live here. If null file names + returned by the mapper are assumed to be absolute.
          mapper - knows how to construct a target file names from + source file names.
          granularity - The number of milliseconds leeway to give + before deciding a target is out of date. +
          Returns:
          an array of filenames.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +restrictAsFiles

          +
          +public java.io.File[] restrictAsFiles(java.lang.String[] files,
+                                      java.io.File srcDir,
+                                      java.io.File destDir,
+                                      FileNameMapper mapper)
          +
          +
          Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute). +

          +

          +
          +
          +
          +
          Parameters:
          files - the original set of files.
          srcDir - all files are relative to this directory.
          destDir - target files live here. If null file names + returned by the mapper are assumed to be absolute.
          mapper - knows how to construct a target file names from + source file names. +
          Returns:
          an array of files.
          +
          +
          +
          + +

          +restrictAsFiles

          +
          +public java.io.File[] restrictAsFiles(java.lang.String[] files,
+                                      java.io.File srcDir,
+                                      java.io.File destDir,
+                                      FileNameMapper mapper,
+                                      long granularity)
          +
          +
          Convenience layer on top of restrict that returns the source + files as File objects (containing absolute paths if srcDir is + absolute). +

          +

          +
          +
          +
          +
          Parameters:
          files - the original set of files.
          srcDir - all files are relative to this directory.
          destDir - target files live here. If null file names + returned by the mapper are assumed to be absolute.
          mapper - knows how to construct a target file names from + source file names.
          granularity - The number of milliseconds leeway to give + before deciding a target is out of date. +
          Returns:
          an array of files.
          Since:
          +
          Ant 1.6.2
          +
          +
          +
          +
          + +

          +getResource

          +
          +public Resource getResource(java.lang.String name)
          +
          +
          Returns resource information for a file at destination. +

          +

          +
          Specified by:
          getResource in interface ResourceFactory
          +
          +
          +
          Parameters:
          name - relative path of file at destination. +
          Returns:
          data concerning a file whose relative path to destDir is name.
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SplitClassLoader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SplitClassLoader.html new file mode 100644 index 000000000..22c8d3ee4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SplitClassLoader.html @@ -0,0 +1,307 @@ + + + + + + +SplitClassLoader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class SplitClassLoader

          +
          +java.lang.Object
+  extended by java.lang.ClassLoader
+      extended by org.apache.tools.ant.AntClassLoader
+          extended by org.apache.tools.ant.util.SplitClassLoader
+
          +
          +
          All Implemented Interfaces:
          java.util.EventListener, BuildListener, SubBuildListener
          +
          +
          +
          +
          public final class SplitClassLoader
          extends AntClassLoader
          + + +

          +Specialized classloader for tasks that need finer grained control + over which classes are to be loaded via Ant's classloader and which + should not even if they are available. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          SplitClassLoader(java.lang.ClassLoader parent, + Path path, + Project project, + java.lang.String[] splitClasses) + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.ClassloadClass(java.lang.String classname, + boolean resolve) + +
          +          Loads a class with this class loader.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.AntClassLoader
          addJavaLibraries, addLoaderPackageRoot, addPathComponent, addPathElement, addPathFile, addSystemPackageRoot, buildFinished, buildStarted, cleanup, defineClassFromData, definePackage, definePackage, findClass, findResources, findResources, forceLoadClass, forceLoadSystemClass, getClasspath, getConfiguredParent, getNamedResources, getResource, getResourceAsStream, getResourceURL, initializeClass, isInPath, log, messageLogged, newAntClassLoader, resetThreadContextLoader, setClassPath, setIsolated, setParent, setParentFirst, setProject, setThreadContextLoader, subBuildFinished, subBuildStarted, targetFinished, targetStarted, taskFinished, taskStarted, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.ClassLoader
          clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findResource, findSystemClass, getPackage, getPackages, getParent, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SplitClassLoader

          +
          +public SplitClassLoader(java.lang.ClassLoader parent,
+                        Path path,
+                        Project project,
+                        java.lang.String[] splitClasses)
          +
          +
          +
          Parameters:
          splitClasses - classes contained herin will not be loaded + via Ant's classloader
          +
          + + + + + + + + +
          +Method Detail
          + +

          +loadClass

          +
          +protected java.lang.Class loadClass(java.lang.String classname,
+                                    boolean resolve)
+                             throws java.lang.ClassNotFoundException
          +
          +
          Description copied from class: AntClassLoader
          +
          Loads a class with this class loader. + + This class attempts to load the class in an order determined by whether + or not the class matches the system/loader package lists, with the + loader package list taking priority. If the classloader is in isolated + mode, failure to load the class in this loader will result in a + ClassNotFoundException. +

          +

          +
          Overrides:
          loadClass in class AntClassLoader
          +
          +
          +
          Parameters:
          classname - The name of the class to be loaded. + Must not be null.
          resolve - true if all classes upon which this class + depends are to be loaded. +
          Returns:
          the required Class object +
          Throws: +
          java.lang.ClassNotFoundException - if the requested class does not exist + on the system classpath (when not in isolated mode) or this loader's + classpath.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringTokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringTokenizer.html new file mode 100644 index 000000000..6a7c082dd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringTokenizer.html @@ -0,0 +1,433 @@ + + + + + + +StringTokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class StringTokenizer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.StringTokenizer
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, Tokenizer
          +
          +
          +
          Direct Known Subclasses:
          TokenFilter.StringTokenizer
          +
          +
          +
          +
          public class StringTokenizer
          extends ProjectComponent
          implements Tokenizer
          + + +

          +Class to tokenize the input as areas separated + by white space, or by a specified list of + delim characters. Behaves like java.util.StringTokenizer. + If the stream starts with delim characters, the first + token will be an empty string (unless the treat delims + as tokens flag is set). +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          StringTokenizer() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetPostToken() + +
          +          return the string between tokens, after the + previous token.
          + java.lang.StringgetToken(java.io.Reader in) + +
          +          find and return the next token
          + voidsetDelims(java.lang.String delims) + +
          +          attribute delims - the delimiter characters
          + voidsetDelimsAreTokens(boolean delimsAreTokens) + +
          +          attribute delimsaretokens - treat delimiters as + separate tokens.
          + voidsetIncludeDelims(boolean includeDelims) + +
          +          attribute includedelims - treat delimiters as part + of the token.
          + voidsetSuppressDelims(boolean suppressDelims) + +
          +          attribute suppressdelims - suppress delimiters.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +StringTokenizer

          +
          +public StringTokenizer()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDelims

          +
          +public void setDelims(java.lang.String delims)
          +
          +
          attribute delims - the delimiter characters +

          +

          +
          +
          +
          +
          Parameters:
          delims - a string containing the delimiter characters
          +
          +
          +
          + +

          +setDelimsAreTokens

          +
          +public void setDelimsAreTokens(boolean delimsAreTokens)
          +
          +
          attribute delimsaretokens - treat delimiters as + separate tokens. +

          +

          +
          +
          +
          +
          Parameters:
          delimsAreTokens - true if delimiters are to be separate
          +
          +
          +
          + +

          +setSuppressDelims

          +
          +public void setSuppressDelims(boolean suppressDelims)
          +
          +
          attribute suppressdelims - suppress delimiters. + default - false +

          +

          +
          +
          +
          +
          Parameters:
          suppressDelims - if true do not report delimiters
          +
          +
          +
          + +

          +setIncludeDelims

          +
          +public void setIncludeDelims(boolean includeDelims)
          +
          +
          attribute includedelims - treat delimiters as part + of the token. + default - false +

          +

          +
          +
          +
          +
          Parameters:
          includeDelims - if true add delimiters to the token
          +
          +
          +
          + +

          +getToken

          +
          +public java.lang.String getToken(java.io.Reader in)
+                          throws java.io.IOException
          +
          +
          find and return the next token +

          +

          +
          Specified by:
          getToken in interface Tokenizer
          +
          +
          +
          Parameters:
          in - the input stream +
          Returns:
          the token +
          Throws: +
          java.io.IOException - if an error occurs reading
          +
          +
          +
          + +

          +getPostToken

          +
          +public java.lang.String getPostToken()
          +
          +
          Description copied from interface: Tokenizer
          +
          return the string between tokens, after the + previous token. +

          +

          +
          Specified by:
          getPostToken in interface Tokenizer
          +
          +
          + +
          Returns:
          the intratoken string
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringUtils.html new file mode 100644 index 000000000..67f49b861 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/StringUtils.html @@ -0,0 +1,475 @@ + + + + + + +StringUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class StringUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.StringUtils
+
          +
          +
          +
          public final class StringUtils
          extends java.lang.Object
          + + +

          +A set of helper methods related to string manipulation. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringLINE_SEP + +
          +          the line separator for this OS
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static booleanendsWith(java.lang.StringBuffer buffer, + java.lang.String suffix) + +
          +          Checks that a string buffer ends up with a given string.
          +static java.lang.StringgetStackTrace(java.lang.Throwable t) + +
          +          Convenient method to retrieve the full stacktrace from a given exception.
          +static java.util.VectorlineSplit(java.lang.String data) + +
          +          Splits up a string into a list of lines.
          +static longparseHumanSizes(java.lang.String humanSize) + +
          +          Takes a human readable size representation eg 10K + a long value.
          +static java.lang.StringremovePrefix(java.lang.String string, + java.lang.String prefix) + +
          +          Removes the prefix from a given string, if the string contains + that prefix.
          +static java.lang.StringremoveSuffix(java.lang.String string, + java.lang.String suffix) + +
          +          Removes the suffix from a given string, if the string contains + that suffix.
          +static java.lang.Stringreplace(java.lang.String data, + java.lang.String from, + java.lang.String to) + +
          +          Replace occurrences into a string.
          +static java.lang.StringresolveBackSlash(java.lang.String input) + +
          +          xml does not do "c" like interpretation of strings.
          +static java.util.Vectorsplit(java.lang.String data, + int ch) + +
          +          Splits up a string where elements are separated by a specific + character and return all elements.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +LINE_SEP

          +
          +public static final java.lang.String LINE_SEP
          +
          +
          the line separator for this OS +

          +

          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +lineSplit

          +
          +public static java.util.Vector lineSplit(java.lang.String data)
          +
          +
          Splits up a string into a list of lines. It is equivalent + to split(data, '\n'). +

          +

          +
          Parameters:
          data - the string to split up into lines. +
          Returns:
          the list of lines available in the string.
          +
          +
          +
          + +

          +split

          +
          +public static java.util.Vector split(java.lang.String data,
+                                     int ch)
          +
          +
          Splits up a string where elements are separated by a specific + character and return all elements. +

          +

          +
          Parameters:
          data - the string to split up.
          ch - the separator character. +
          Returns:
          the list of elements.
          +
          +
          +
          + +

          +replace

          +
          +public static java.lang.String replace(java.lang.String data,
+                                       java.lang.String from,
+                                       java.lang.String to)
          +
          +
          Replace occurrences into a string. +

          +

          +
          Parameters:
          data - the string to replace occurrences into
          from - the occurrence to replace.
          to - the occurrence to be used as a replacement. +
          Returns:
          the new string with replaced occurrences.
          +
          +
          +
          + +

          +getStackTrace

          +
          +public static java.lang.String getStackTrace(java.lang.Throwable t)
          +
          +
          Convenient method to retrieve the full stacktrace from a given exception. +

          +

          +
          Parameters:
          t - the exception to get the stacktrace from. +
          Returns:
          the stacktrace from the given exception.
          +
          +
          +
          + +

          +endsWith

          +
          +public static boolean endsWith(java.lang.StringBuffer buffer,
+                               java.lang.String suffix)
          +
          +
          Checks that a string buffer ends up with a given string. It may sound + trivial with the existing + JDK API but the various implementation among JDKs can make those + methods extremely resource intensive + and perform poorly due to massive memory allocation and copying. See +

          +

          +
          Parameters:
          buffer - the buffer to perform the check on
          suffix - the suffix +
          Returns:
          true if the character sequence represented by the + argument is a suffix of the character sequence represented by + the StringBuffer object; false otherwise. Note that the + result will be true if the argument is the + empty string.
          +
          +
          +
          + +

          +resolveBackSlash

          +
          +public static java.lang.String resolveBackSlash(java.lang.String input)
          +
          +
          xml does not do "c" like interpretation of strings. + i.e. \n\r\t etc. + this method processes \n, \r, \t, \f, \\ + also subs \s -> " \n\r\t\f" + a trailing '\' will be ignored +

          +

          +
          Parameters:
          input - raw string with possible embedded '\'s +
          Returns:
          converted string
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +parseHumanSizes

          +
          +public static long parseHumanSizes(java.lang.String humanSize)
+                            throws java.lang.Exception
          +
          +
          Takes a human readable size representation eg 10K + a long value. Doesn't support 1.1K or other rational values. +

          +

          +
          Parameters:
          humanSize - the amount as a human readable string. +
          Returns:
          a long value representation +
          Throws: +
          java.lang.Exception - if there is a problem.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +removeSuffix

          +
          +public static java.lang.String removeSuffix(java.lang.String string,
+                                            java.lang.String suffix)
          +
          +
          Removes the suffix from a given string, if the string contains + that suffix. +

          +

          +
          Parameters:
          string - String for check
          suffix - Suffix to remove +
          Returns:
          the string with the suffix
          +
          +
          +
          + +

          +removePrefix

          +
          +public static java.lang.String removePrefix(java.lang.String string,
+                                            java.lang.String prefix)
          +
          +
          Removes the prefix from a given string, if the string contains + that prefix. +

          +

          +
          Parameters:
          string - String for check
          prefix - Prefix to remove +
          Returns:
          the string with the prefix
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SymbolicLinkUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SymbolicLinkUtils.html new file mode 100644 index 000000000..dd9a81e8f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/SymbolicLinkUtils.html @@ -0,0 +1,503 @@ + + + + + + +SymbolicLinkUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class SymbolicLinkUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.SymbolicLinkUtils
+
          +
          +
          +
          public class SymbolicLinkUtils
          extends java.lang.Object
          + + +

          +Contains methods related to symbolic links - or what Ant thinks is + a symbolic link based on the absent support for them in Java. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + + +
          +Constructor Summary
          +protected SymbolicLinkUtils() + +
          +          Empty constructor.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voiddeleteSymbolicLink(java.io.File link, + Task task) + +
          +          Delete a symlink (without deleting the associated resource).
          +static SymbolicLinkUtilsgetSymbolicLinkUtils() + +
          +          Method to retrieve The SymbolicLinkUtils, which is shared by + all users of this method.
          + booleanisDanglingSymbolicLink(java.io.File file) + +
          +          Checks whether a given file is a broken symbolic link.
          + booleanisDanglingSymbolicLink(java.io.File parent, + java.lang.String name) + +
          +          Checks whether a given file is a broken symbolic link.
          + booleanisDanglingSymbolicLink(java.lang.String name) + +
          +          Checks whether a given file is a broken symbolic link.
          + booleanisSymbolicLink(java.io.File file) + +
          +          Checks whether a given file is a symbolic link.
          + booleanisSymbolicLink(java.io.File parent, + java.lang.String name) + +
          +          Checks whether a given file is a symbolic link.
          + booleanisSymbolicLink(java.lang.String name) + +
          +          Checks whether a given file is a symbolic link.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +SymbolicLinkUtils

          +
          +protected SymbolicLinkUtils()
          +
          +
          Empty constructor. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getSymbolicLinkUtils

          +
          +public static SymbolicLinkUtils getSymbolicLinkUtils()
          +
          +
          Method to retrieve The SymbolicLinkUtils, which is shared by + all users of this method. +

          +

          + +
          Returns:
          an instance of SymbolicLinkUtils.
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink(java.io.File file)
+                       throws java.io.IOException
          +
          +
          Checks whether a given file is a symbolic link. + +

          It doesn't really test for symbolic links but whether the + canonical and absolute paths of the file are identical--this + may lead to false positives on some platforms.

          +

          +

          +
          Parameters:
          file - the file to test. Must not be null. +
          Returns:
          true if the file is a symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink(java.lang.String name)
+                       throws java.io.IOException
          +
          +
          Checks whether a given file is a symbolic link. + +

          It doesn't really test for symbolic links but whether the + canonical and absolute paths of the file are identical--this + may lead to false positives on some platforms.

          +

          +

          +
          Parameters:
          name - the name of the file to test. +
          Returns:
          true if the file is a symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +isSymbolicLink

          +
          +public boolean isSymbolicLink(java.io.File parent,
+                              java.lang.String name)
+                       throws java.io.IOException
          +
          +
          Checks whether a given file is a symbolic link. + +

          It doesn't really test for symbolic links but whether the + canonical and absolute paths of the file are identical--this + may lead to false positives on some platforms.

          +

          +

          +
          Parameters:
          parent - the parent directory of the file to test
          name - the name of the file to test. +
          Returns:
          true if the file is a symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +isDanglingSymbolicLink

          +
          +public boolean isDanglingSymbolicLink(java.lang.String name)
+                               throws java.io.IOException
          +
          +
          Checks whether a given file is a broken symbolic link. + +

          It doesn't really test for symbolic links but whether Java + reports that the File doesn't exist but its parent's child list + contains it--this may lead to false positives on some + platforms.

          + +

          Note that #isSymbolicLink returns false if this method + returns true since Java won't produce a canonical name + different from the abolute one if the link is broken.

          +

          +

          +
          Parameters:
          name - the name of the file to test. +
          Returns:
          true if the file is a broken symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +isDanglingSymbolicLink

          +
          +public boolean isDanglingSymbolicLink(java.io.File file)
+                               throws java.io.IOException
          +
          +
          Checks whether a given file is a broken symbolic link. + +

          It doesn't really test for symbolic links but whether Java + reports that the File doesn't exist but its parent's child list + contains it--this may lead to false positives on some + platforms.

          + +

          Note that #isSymbolicLink returns false if this method + returns true since Java won't produce a canonical name + different from the abolute one if the link is broken.

          +

          +

          +
          Parameters:
          file - the file to test. +
          Returns:
          true if the file is a broken symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +isDanglingSymbolicLink

          +
          +public boolean isDanglingSymbolicLink(java.io.File parent,
+                                      java.lang.String name)
+                               throws java.io.IOException
          +
          +
          Checks whether a given file is a broken symbolic link. + +

          It doesn't really test for symbolic links but whether Java + reports that the File doesn't exist but its parent's child list + contains it--this may lead to false positives on some + platforms.

          + +

          Note that #isSymbolicLink returns false if this method + returns true since Java won't produce a canonical name + different from the abolute one if the link is broken.

          +

          +

          +
          Parameters:
          parent - the parent directory of the file to test
          name - the name of the file to test. +
          Returns:
          true if the file is a broken symbolic link. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +deleteSymbolicLink

          +
          +public void deleteSymbolicLink(java.io.File link,
+                               Task task)
+                        throws java.io.IOException
          +
          +
          Delete a symlink (without deleting the associated resource). + +

          This is a utility method that removes a unix symlink without + removing the resource that the symlink points to. If it is + accidentally invoked on a real file, the real file will not be + harmed, but silently ignored.

          + +

          Normaly this method works by + getting the canonical path of the link, using the canonical path to + rename the resource (breaking the link) and then deleting the link. + The resource is then returned to its original name inside a finally + block to ensure that the resource is unharmed even in the event of + an exception.

          + +

          There may be cases where the algorithm described above doesn't work, + in that case the method tries to use the native "rm" command on + the symlink instead.

          +

          +

          +
          Parameters:
          link - A File object of the symlink to delete.
          task - An Ant Task required if "rm" needs to be invoked. +
          Throws: +
          java.io.IOException - If calls to File.rename, + File.delete or File.getCanonicalPath + fail. +
          BuildException - if the execution of "rm" failed.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TaskLogger.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TaskLogger.html new file mode 100644 index 000000000..d5e844e9a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TaskLogger.html @@ -0,0 +1,341 @@ + + + + + + +TaskLogger (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class TaskLogger

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.TaskLogger
+
          +
          +
          +
          public final class TaskLogger
          extends java.lang.Object
          + + +

          +A facade that makes logging nicer to use. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          TaskLogger(Task task) + +
          +          Constructor for the TaskLogger
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voiddebug(java.lang.String message) + +
          +          Log a message with MSG_DEBUG priority
          + voiderror(java.lang.String message) + +
          +          Log a message with MSG_ERR priority
          + voidinfo(java.lang.String message) + +
          +          Log a message with MSG_INFO priority
          + voidverbose(java.lang.String message) + +
          +          Log a message with MSG_VERBOSE priority
          + voidwarning(java.lang.String message) + +
          +          Log a message with MSG_WARN priority
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TaskLogger

          +
          +public TaskLogger(Task task)
          +
          +
          Constructor for the TaskLogger +

          +

          +
          Parameters:
          task - the task
          +
          + + + + + + + + +
          +Method Detail
          + +

          +info

          +
          +public void info(java.lang.String message)
          +
          +
          Log a message with MSG_INFO priority +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          +
          + +

          +error

          +
          +public void error(java.lang.String message)
          +
          +
          Log a message with MSG_ERR priority +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          +
          + +

          +warning

          +
          +public void warning(java.lang.String message)
          +
          +
          Log a message with MSG_WARN priority +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          +
          + +

          +verbose

          +
          +public void verbose(java.lang.String message)
          +
          +
          Log a message with MSG_VERBOSE priority +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          +
          + +

          +debug

          +
          +public void debug(java.lang.String message)
          +
          +
          Log a message with MSG_DEBUG priority +

          +

          +
          Parameters:
          message - the message to log
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TeeOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TeeOutputStream.html new file mode 100644 index 000000000..585850cbc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TeeOutputStream.html @@ -0,0 +1,381 @@ + + + + + + +TeeOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class TeeOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.ant.util.TeeOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class TeeOutputStream
          extends java.io.OutputStream
          + + +

          +A simple T-piece to replicate an output stream into two separate streams +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          TeeOutputStream(java.io.OutputStream left, + java.io.OutputStream right) + +
          +          Constructor for TeeOutputStream.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close both output streams.
          + voidflush() + +
          +          Flush both output streams.
          + voidwrite(byte[] b) + +
          +          Write a byte array to both output streams.
          + voidwrite(byte[] b, + int off, + int len) + +
          +          Write a byte array to both output streams.
          + voidwrite(int b) + +
          +          Write a byte to both output streams.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TeeOutputStream

          +
          +public TeeOutputStream(java.io.OutputStream left,
+                       java.io.OutputStream right)
          +
          +
          Constructor for TeeOutputStream. +

          +

          +
          Parameters:
          left - one of the output streams.
          right - the other output stream.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Close both output streams. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +flush

          +
          +public void flush()
+           throws java.io.IOException
          +
          +
          Flush both output streams. +

          +

          +
          Specified by:
          flush in interface java.io.Flushable
          Overrides:
          flush in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] b)
+           throws java.io.IOException
          +
          +
          Write a byte array to both output streams. +

          +

          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - an array of bytes. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] b,
+                  int off,
+                  int len)
+           throws java.io.IOException
          +
          +
          Write a byte array to both output streams. +

          +

          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the data.
          off - the start offset in the data.
          len - the number of bytes to write. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +write

          +
          +public void write(int b)
+           throws java.io.IOException
          +
          +
          Write a byte to both output streams. +

          +

          +
          Specified by:
          write in class java.io.OutputStream
          +
          +
          +
          Parameters:
          b - the byte to write. +
          Throws: +
          java.io.IOException - on error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TimeoutObserver.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TimeoutObserver.html new file mode 100644 index 000000000..c7a14ad69 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/TimeoutObserver.html @@ -0,0 +1,214 @@ + + + + + + +TimeoutObserver (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Interface TimeoutObserver

          +
          +
          All Known Implementing Classes:
          ExecuteJava, ExecuteWatchdog
          +
          +
          +
          +
          public interface TimeoutObserver
          + + +

          +Interface for classes that want to be notified by Watchdog. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          See Also:
          Watchdog
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidtimeoutOccured(Watchdog w) + +
          +          Called when the watchdow times out.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +timeoutOccured

          +
          +void timeoutOccured(Watchdog w)
          +
          +
          Called when the watchdow times out. +

          +

          +
          Parameters:
          w - the watchdog that timed out.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Tokenizer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Tokenizer.html new file mode 100644 index 000000000..99553d337 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Tokenizer.html @@ -0,0 +1,243 @@ + + + + + + +Tokenizer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Interface Tokenizer

          +
          +
          All Known Implementing Classes:
          FileTokenizer, LineTokenizer, StringTokenizer, TokenFilter.FileTokenizer, TokenFilter.StringTokenizer
          +
          +
          +
          +
          public interface Tokenizer
          + + +

          +input stream tokenizers implement this interface +

          + +

          +

          +
          Version:
          +
          Ant 1.6
          +
          +
          + +

          + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringgetPostToken() + +
          +          return the string between tokens, after the + previous token.
          + java.lang.StringgetToken(java.io.Reader in) + +
          +          get the next token from the input stream
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getToken

          +
          +java.lang.String getToken(java.io.Reader in)
+                          throws java.io.IOException
          +
          +
          get the next token from the input stream +

          +

          +
          Parameters:
          in - the input stream +
          Returns:
          the next token, or null for the end + of the stream +
          Throws: +
          java.io.IOException - if an error occurs
          +
          +
          +
          + +

          +getPostToken

          +
          +java.lang.String getPostToken()
          +
          +
          return the string between tokens, after the + previous token. +

          +

          + +
          Returns:
          the intra-token string
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UUEncoder.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UUEncoder.html new file mode 100644 index 000000000..45fd18674 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UUEncoder.html @@ -0,0 +1,310 @@ + + + + + + +UUEncoder (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class UUEncoder

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.UUEncoder
+
          +
          +
          +
          public class UUEncoder
          extends java.lang.Object
          + + +

          +UUEncoding of an input stream placed into an outputstream. + This class is meant to be a drop in replacement for + sun.misc.UUEncoder, which was previously used by Ant. + The uuencode algorithm code has been copied from the + geronimo project. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected static intDEFAULT_MODE + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          UUEncoder(java.lang.String name) + +
          +          Constructor specifing a name for the encoded buffer, begin + line will be:
          +  + + + + + + + + + + + +
          +Method Summary
          + voidencode(java.io.InputStream is, + java.io.OutputStream out) + +
          +          UUEncode bytes from the input stream, and write them as text characters + to the output stream.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_MODE

          +
          +protected static final int DEFAULT_MODE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +UUEncoder

          +
          +public UUEncoder(java.lang.String name)
          +
          +
          Constructor specifing a name for the encoded buffer, begin + line will be: + 
          +   begin 644 [NAME]
+
          +

          +

          +
          Parameters:
          name - the name of the encoded buffer.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +encode

          +
          +public void encode(java.io.InputStream is,
+                   java.io.OutputStream out)
+            throws java.io.IOException
          +
          +
          UUEncode bytes from the input stream, and write them as text characters + to the output stream. This method will run until it exhausts the + input stream. +

          +

          +
          Parameters:
          is - the input stream.
          out - the output stream. +
          Throws: +
          java.io.IOException - if there is an error.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UnPackageNameMapper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UnPackageNameMapper.html new file mode 100644 index 000000000..8e1d6d5dc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/UnPackageNameMapper.html @@ -0,0 +1,297 @@ + + + + + + +UnPackageNameMapper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class UnPackageNameMapper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.GlobPatternMapper
+      extended by org.apache.tools.ant.util.UnPackageNameMapper
+
          +
          +
          All Implemented Interfaces:
          FileNameMapper
          +
          +
          +
          +
          public class UnPackageNameMapper
          extends GlobPatternMapper
          + + +

          +Maps dotted package name matches to a directory name. + This is the inverse of the package mapper. + This is useful for matching XML formatter results against their JUnit test + cases. + 

          + <mapper classname="org.apache.tools.ant.util.UnPackageNameMapper"
+         from="${test.data.dir}/TEST-*Test.xml" to="*Test.java">
+
          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.util.GlobPatternMapper
          fromPostfix, fromPrefix, postfixLength, prefixLength, toPostfix, toPrefix
          +  + + + + + + + + + + +
          +Constructor Summary
          UnPackageNameMapper() + +
          +           
          +  + + + + + + + + + + + +
          +Method Summary
          +protected  java.lang.StringextractVariablePart(java.lang.String name) + +
          +          Returns the part of the given string that matches the * in the + "from" pattern replacing dots with file separators
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.GlobPatternMapper
          mapFileName, setCaseSensitive, setFrom, setHandleDirSep, setTo
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +UnPackageNameMapper

          +
          +public UnPackageNameMapper()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +extractVariablePart

          +
          +protected java.lang.String extractVariablePart(java.lang.String name)
          +
          +
          Returns the part of the given string that matches the * in the + "from" pattern replacing dots with file separators +

          +

          +
          Overrides:
          extractVariablePart in class GlobPatternMapper
          +
          +
          +
          Parameters:
          name - Source filename +
          Returns:
          Replaced variable part
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/VectorSet.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/VectorSet.html new file mode 100644 index 000000000..164fe1b29 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/VectorSet.html @@ -0,0 +1,808 @@ + + + + + + +VectorSet (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class VectorSet

          +
          +java.lang.Object
+  extended by java.util.AbstractCollection<E>
+      extended by java.util.AbstractList<E>
+          extended by java.util.Vector
+              extended by org.apache.tools.ant.util.VectorSet
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess
          +
          +
          +
          +
          public final class VectorSet
          extends java.util.Vector
          + + +

          +Subclass of Vector that won't store duplicate entries and shows + HashSet's constant time performance characteristics for the + contains method. + +

          This is not a general purpose class but has been written because + the protected members of DirectoryScanner prohibited + later revisions from using a more efficient collection.

          + +

          Methods are synchronized to keep Vector's contract.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.util.Vector
          capacityIncrement, elementCount, elementData
          +  + + + + + + + +
          Fields inherited from class java.util.AbstractList
          modCount
          +  + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          VectorSet() + +
          +           
          VectorSet(java.util.Collection c) + +
          +           
          VectorSet(int initialCapacity) + +
          +           
          VectorSet(int initialCapacity, + int capacityIncrement) + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidadd(int index, + java.lang.Object o) + +
          +          This implementation may not add the element at the given index + if it is already contained in the collection.
          + booleanadd(java.lang.Object o) + +
          +           
          + booleanaddAll(java.util.Collection c) + +
          +           
          + booleanaddAll(int index, + java.util.Collection c) + +
          +          This implementation may not add all elements at the given index + if any of them are already contained in the collection.
          + voidaddElement(java.lang.Object o) + +
          +           
          + voidclear() + +
          +           
          + java.lang.Objectclone() + +
          +           
          + booleancontains(java.lang.Object o) + +
          +           
          + booleancontainsAll(java.util.Collection c) + +
          +           
          + voidinsertElementAt(java.lang.Object o, + int index) + +
          +           
          + java.lang.Objectremove(int index) + +
          +           
          + booleanremove(java.lang.Object o) + +
          +           
          + booleanremoveAll(java.util.Collection c) + +
          +           
          + voidremoveAllElements() + +
          +           
          + booleanremoveElement(java.lang.Object o) + +
          +           
          + voidremoveElementAt(int index) + +
          +           
          + voidremoveRange(int fromIndex, + int toIndex) + +
          +           
          + booleanretainAll(java.util.Collection c) + +
          +           
          + java.lang.Objectset(int index, + java.lang.Object o) + +
          +           
          + voidsetElementAt(java.lang.Object o, + int index) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.util.Vector
          capacity, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, isEmpty, lastElement, lastIndexOf, lastIndexOf, setSize, size, subList, toArray, toArray, toString, trimToSize
          +  + + + + + + + +
          Methods inherited from class java.util.AbstractList
          iterator, listIterator, listIterator
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface java.util.List
          iterator, listIterator, listIterator
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +VectorSet

          +
          +public VectorSet()
          +
          +
          +
          + +

          +VectorSet

          +
          +public VectorSet(int initialCapacity)
          +
          +
          +
          + +

          +VectorSet

          +
          +public VectorSet(int initialCapacity,
+                 int capacityIncrement)
          +
          +
          +
          + +

          +VectorSet

          +
          +public VectorSet(java.util.Collection c)
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +add

          +
          +public boolean add(java.lang.Object o)
          +
          +
          +
          Specified by:
          add in interface java.util.Collection
          Specified by:
          add in interface java.util.List
          Overrides:
          add in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +add

          +
          +public void add(int index,
+                java.lang.Object o)
          +
          +
          This implementation may not add the element at the given index + if it is already contained in the collection. +

          +

          +
          Specified by:
          add in interface java.util.List
          Overrides:
          add in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +addElement

          +
          +public void addElement(java.lang.Object o)
          +
          +
          +
          Overrides:
          addElement in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +addAll

          +
          +public boolean addAll(java.util.Collection c)
          +
          +
          +
          Specified by:
          addAll in interface java.util.Collection
          Specified by:
          addAll in interface java.util.List
          Overrides:
          addAll in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +addAll

          +
          +public boolean addAll(int index,
+                      java.util.Collection c)
          +
          +
          This implementation may not add all elements at the given index + if any of them are already contained in the collection. +

          +

          +
          Specified by:
          addAll in interface java.util.List
          Overrides:
          addAll in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +clear

          +
          +public void clear()
          +
          +
          +
          Specified by:
          clear in interface java.util.Collection
          Specified by:
          clear in interface java.util.List
          Overrides:
          clear in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +contains

          +
          +public boolean contains(java.lang.Object o)
          +
          +
          +
          Specified by:
          contains in interface java.util.Collection
          Specified by:
          contains in interface java.util.List
          Overrides:
          contains in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +containsAll

          +
          +public boolean containsAll(java.util.Collection c)
          +
          +
          +
          Specified by:
          containsAll in interface java.util.Collection
          Specified by:
          containsAll in interface java.util.List
          Overrides:
          containsAll in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +insertElementAt

          +
          +public void insertElementAt(java.lang.Object o,
+                            int index)
          +
          +
          +
          Overrides:
          insertElementAt in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +remove

          +
          +public java.lang.Object remove(int index)
          +
          +
          +
          Specified by:
          remove in interface java.util.List
          Overrides:
          remove in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +remove

          +
          +public boolean remove(java.lang.Object o)
          +
          +
          +
          Specified by:
          remove in interface java.util.Collection
          Specified by:
          remove in interface java.util.List
          Overrides:
          remove in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +removeAll

          +
          +public boolean removeAll(java.util.Collection c)
          +
          +
          +
          Specified by:
          removeAll in interface java.util.Collection
          Specified by:
          removeAll in interface java.util.List
          Overrides:
          removeAll in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +removeAllElements

          +
          +public void removeAllElements()
          +
          +
          +
          Overrides:
          removeAllElements in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +removeElement

          +
          +public boolean removeElement(java.lang.Object o)
          +
          +
          +
          Overrides:
          removeElement in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +removeElementAt

          +
          +public void removeElementAt(int index)
          +
          +
          +
          Overrides:
          removeElementAt in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +removeRange

          +
          +public void removeRange(int fromIndex,
+                        int toIndex)
          +
          +
          +
          Overrides:
          removeRange in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +retainAll

          +
          +public boolean retainAll(java.util.Collection c)
          +
          +
          +
          Specified by:
          retainAll in interface java.util.Collection
          Specified by:
          retainAll in interface java.util.List
          Overrides:
          retainAll in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +set

          +
          +public java.lang.Object set(int index,
+                            java.lang.Object o)
          +
          +
          +
          Specified by:
          set in interface java.util.List
          Overrides:
          set in class java.util.Vector
          +
          +
          +
          +
          +
          +
          + +

          +setElementAt

          +
          +public void setElementAt(java.lang.Object o,
+                         int index)
          +
          +
          +
          Overrides:
          setElementAt in class java.util.Vector
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Watchdog.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Watchdog.html new file mode 100644 index 000000000..01e0c37cf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/Watchdog.html @@ -0,0 +1,430 @@ + + + + + + +Watchdog (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class Watchdog

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.Watchdog
+
          +
          +
          All Implemented Interfaces:
          java.lang.Runnable
          +
          +
          +
          +
          public class Watchdog
          extends java.lang.Object
          implements java.lang.Runnable
          + + +

          +Generalization of ExecuteWatchdog +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          See Also:
          ExecuteWatchdog
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringERROR_INVALID_TIMEOUT + +
          +          Error string.
          +  + + + + + + + + + + +
          +Constructor Summary
          Watchdog(long timeout) + +
          +          Constructor for Watchdog.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddTimeoutObserver(TimeoutObserver to) + +
          +          Add a timeout observer.
          +protected  voidfireTimeoutOccured() + +
          +          Inform the observers that a timeout has occurred.
          + voidremoveTimeoutObserver(TimeoutObserver to) + +
          +          Remove a timeout observer.
          + voidrun() + +
          +          The run method of the watch dog thread.
          + voidstart() + +
          +          Start the watch dog.
          + voidstop() + +
          +          Stop the watch dog.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ERROR_INVALID_TIMEOUT

          +
          +public static final java.lang.String ERROR_INVALID_TIMEOUT
          +
          +
          Error string. + "timeout less than 1." +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +Watchdog

          +
          +public Watchdog(long timeout)
          +
          +
          Constructor for Watchdog. +

          +

          +
          Parameters:
          timeout - the timeout to use in milliseconds (must be >= 1).
          +
          + + + + + + + + +
          +Method Detail
          + +

          +addTimeoutObserver

          +
          +public void addTimeoutObserver(TimeoutObserver to)
          +
          +
          Add a timeout observer. +

          +

          +
          +
          +
          +
          Parameters:
          to - the timeout observer to add.
          +
          +
          +
          + +

          +removeTimeoutObserver

          +
          +public void removeTimeoutObserver(TimeoutObserver to)
          +
          +
          Remove a timeout observer. +

          +

          +
          +
          +
          +
          Parameters:
          to - the timeout observer to remove.
          +
          +
          +
          + +

          +fireTimeoutOccured

          +
          +protected final void fireTimeoutOccured()
          +
          +
          Inform the observers that a timeout has occurred. + This happens in the watchdog thread. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +start

          +
          +public void start()
          +
          +
          Start the watch dog. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +stop

          +
          +public void stop()
          +
          +
          Stop the watch dog. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +run

          +
          +public void run()
          +
          +
          The run method of the watch dog thread. + This simply does a wait for the timeout time, and + if the stop flag has not been set when the wait has returned or + has been interrupted, the watch dog listeners are informed. +

          +

          +
          Specified by:
          run in interface java.lang.Runnable
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.HardReference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.HardReference.html new file mode 100644 index 000000000..c2fc6de15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.HardReference.html @@ -0,0 +1,265 @@ + + + + + + +WeakishReference.HardReference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class WeakishReference.HardReference

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.WeakishReference
+      extended by org.apache.tools.ant.util.WeakishReference.HardReference
+
          +
          +
          Direct Known Subclasses:
          WeakishReference12
          +
          +
          +
          Enclosing class:
          WeakishReference
          +
          +
          +Deprecated. since 1.7. + Hopefully nobody is using this. +

          +

          +
          public static class WeakishReference.HardReference
          extends WeakishReference
          + + +

          +This was a hard reference for Java 1.1. Since Ant1.7, +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.util.WeakishReference
          WeakishReference.HardReference
          +  + + + + + + + + + + + +
          +Constructor Summary
          WeakishReference.HardReference(java.lang.Object object) + +
          +          Deprecated. constructor.
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.WeakishReference
          createReference, get
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +WeakishReference.HardReference

          +
          +public WeakishReference.HardReference(java.lang.Object object)
          +
          +
          Deprecated. 
          constructor. +

          +

          +
          Parameters:
          object - the object that the reference will refer to.
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.html new file mode 100644 index 000000000..00b293be0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WeakishReference.html @@ -0,0 +1,279 @@ + + + + + + +WeakishReference (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class WeakishReference

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.WeakishReference
+
          +
          +
          Direct Known Subclasses:
          WeakishReference.HardReference
          +
          +
          +Deprecated. deprecated 1.7; will be removed in Ant1.8 + Just use WeakReference directly. +

          +

          +
          public class WeakishReference
          extends java.lang.Object
          + + +

          +These classes are part of some code to reduce memory leaks by only + retaining weak references to things + on Java1.2+, and yet still work (with leaky hard references) on Java1.1. + Now that Ant is 1.2+ only, + life is simpler and none of the classes are needed any more. + + They are only retained in case a third-party task uses them +

          + +

          +

          +
          Since:
          +
          ant1.6
          +
          See Also:
          WeakishReference12
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classWeakishReference.HardReference + +
          +          Deprecated. since 1.7. + Hopefully nobody is using this.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +static WeakishReferencecreateReference(java.lang.Object object) + +
          +          Deprecated. create the appropriate type of reference for the java version
          + java.lang.Objectget() + +
          +          Deprecated. Returns this reference object's referent.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +get

          +
          +public java.lang.Object get()
          +
          +
          Deprecated. 
          Returns this reference object's referent. If this reference object has + been cleared, then this method returns null. +

          +

          + +
          Returns:
          The object to which this reference refers, or + null if this reference object has been cleared.
          +
          +
          +
          + +

          +createReference

          +
          +public static WeakishReference createReference(java.lang.Object object)
          +
          +
          Deprecated. 
          create the appropriate type of reference for the java version +

          +

          +
          Parameters:
          object - the object that the reference will refer to. +
          Returns:
          reference to the Object.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WorkerAnt.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WorkerAnt.html new file mode 100644 index 000000000..652810a31 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/WorkerAnt.html @@ -0,0 +1,516 @@ + + + + + + +WorkerAnt (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class WorkerAnt

          +
          +java.lang.Object
+  extended by java.lang.Thread
+      extended by org.apache.tools.ant.util.WorkerAnt
+
          +
          +
          All Implemented Interfaces:
          java.lang.Runnable
          +
          +
          +
          +
          public class WorkerAnt
          extends java.lang.Thread
          + + +

          +A worker ant executes a single task in a background thread. + After the run, any exception thrown is turned into a buildexception, which can be + rethrown, the finished attribute is set, then notifyAll() is called, + so that anyone waiting on the same notify object gets woken up. +

          + This class is effectively a superset of + Parallel.TaskRunnable +

          + +

          +

          +
          Since:
          +
          Ant 1.8
          +
          +
          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class java.lang.Thread
          java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
          +  + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringERROR_NO_TASK + +
          +          Error message if invoked with no task
          +  + + + + + + + +
          Fields inherited from class java.lang.Thread
          MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          WorkerAnt(Task task) + +
          +          Create the worker, using the worker as the notification point.
          WorkerAnt(Task task, + java.lang.Object notify) + +
          +          Create the worker.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + BuildExceptiongetBuildException() + +
          +          Get any build exception.
          + java.lang.ThrowablegetException() + +
          +          Get whatever was thrown, which may or may not be a buildException.
          + TaskgetTask() + +
          +          Get the task
          + booleanisFinished() + +
          +          Query the task/thread for being finished.
          + voidrethrowAnyBuildException() + +
          +          Raise an exception if one was caught
          + voidrun() + +
          +          Run the task, which is skipped if null.
          + voidwaitUntilFinished(long timeout) + +
          +          Block on the notify object and so wait until the thread is finished.
          +  + + + + + + + +
          Methods inherited from class java.lang.Thread
          activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ERROR_NO_TASK

          +
          +public static final java.lang.String ERROR_NO_TASK
          +
          +
          Error message if invoked with no task +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +WorkerAnt

          +
          +public WorkerAnt(Task task,
+                 java.lang.Object notify)
          +
          +
          Create the worker. +

          + This does not start the thread, merely configures it. +

          +

          +
          Parameters:
          task - the task
          notify - what to notify
          +
          +
          + +

          +WorkerAnt

          +
          +public WorkerAnt(Task task)
          +
          +
          Create the worker, using the worker as the notification point. +

          + This does not start the thread, merely configures it. +

          +

          +
          Parameters:
          task - the task
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getBuildException

          +
          +public BuildException getBuildException()
          +
          +
          Get any build exception. + This would seem to be oversynchronised, but know that Java pre-1.5 can + reorder volatile access. + The synchronized attribute is to force an ordering. +

          +

          + +
          Returns:
          the exception or null
          +
          +
          +
          + +

          +getException

          +
          +public java.lang.Throwable getException()
          +
          +
          Get whatever was thrown, which may or may not be a buildException. + Assertion: getException() instanceof BuildException <=> getBuildException()==getException() +

          +

          + +
          Returns:
          the exception.
          +
          +
          +
          + +

          +getTask

          +
          +public Task getTask()
          +
          +
          Get the task +

          +

          + +
          Returns:
          the task
          +
          +
          +
          + +

          +isFinished

          +
          +public boolean isFinished()
          +
          +
          Query the task/thread for being finished. + This would seem to be oversynchronised, but know that Java pre-1.5 can + reorder volatile access. + The synchronized attribute is to force an ordering. +

          +

          + +
          Returns:
          true if the task is finished.
          +
          +
          +
          + +

          +waitUntilFinished

          +
          +public void waitUntilFinished(long timeout)
+                       throws java.lang.InterruptedException
          +
          +
          Block on the notify object and so wait until the thread is finished. +

          +

          +
          Parameters:
          timeout - timeout in milliseconds +
          Throws: +
          java.lang.InterruptedException - if the execution was interrupted
          +
          +
          +
          + +

          +rethrowAnyBuildException

          +
          +public void rethrowAnyBuildException()
          +
          +
          Raise an exception if one was caught +

          +

          + +
          Throws: +
          BuildException - if one has been picked up
          +
          +
          +
          + +

          +run

          +
          +public void run()
          +
          +
          Run the task, which is skipped if null. + When invoked again, the task is re-run. +

          +

          +
          Specified by:
          run in interface java.lang.Runnable
          Overrides:
          run in class java.lang.Thread
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.Child.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.Child.html new file mode 100644 index 000000000..c560124b7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.Child.html @@ -0,0 +1,288 @@ + + + + + + +XMLFragment.Child (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class XMLFragment.Child

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.XMLFragment.Child
+
          +
          +
          All Implemented Interfaces:
          DynamicAttributeNS, DynamicConfiguratorNS, DynamicElementNS
          +
          +
          +
          Enclosing class:
          XMLFragment
          +
          +
          +
          +
          public class XMLFragment.Child
          extends java.lang.Object
          implements DynamicConfiguratorNS
          + + +

          +An object to handle (recursively) nested elements. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String s) + +
          +          Add nested text.
          + java.lang.ObjectcreateDynamicElement(java.lang.String uri, + java.lang.String name, + java.lang.String qName) + +
          +          Creates a nested element.
          + voidsetDynamicAttribute(java.lang.String uri, + java.lang.String name, + java.lang.String qName, + java.lang.String value) + +
          +          Sets the attribute
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +addText

          +
          +public void addText(java.lang.String s)
          +
          +
          Add nested text. +

          +

          +
          +
          +
          +
          Parameters:
          s - the text to add
          +
          +
          +
          + +

          +setDynamicAttribute

          +
          +public void setDynamicAttribute(java.lang.String uri,
+                                java.lang.String name,
+                                java.lang.String qName,
+                                java.lang.String value)
          +
          +
          Sets the attribute +

          +

          +
          Specified by:
          setDynamicAttribute in interface DynamicAttributeNS
          +
          +
          +
          Parameters:
          uri - the uri of the attribute
          name - the localname of the attribute
          qName - the qualified name of the attribute
          value - the value of the attribute
          +
          +
          +
          + +

          +createDynamicElement

          +
          +public java.lang.Object createDynamicElement(java.lang.String uri,
+                                             java.lang.String name,
+                                             java.lang.String qName)
          +
          +
          Creates a nested element. +

          +

          +
          Specified by:
          createDynamicElement in interface DynamicElementNS
          +
          +
          +
          Parameters:
          uri - the uri of the nested element
          name - the localname of the nested element
          qName - the qualified name of the nested element +
          Returns:
          an object that the element is applied to
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.html new file mode 100644 index 000000000..8c74d775e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XMLFragment.html @@ -0,0 +1,372 @@ + + + + + + +XMLFragment (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class XMLFragment

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.util.XMLFragment
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, DynamicElementNS
          +
          +
          +
          Direct Known Subclasses:
          EchoXML
          +
          +
          +
          +
          public class XMLFragment
          extends ProjectComponent
          implements DynamicElementNS
          + + +

          +Use this class as a nested element if you want to get a literal DOM + fragment of something nested into your task/type. + +

          This is useful for tasks that want to deal with the "real" XML + from the build file instead of objects.

          + +

          Code heavily influenced by code written by Dominique Devienne.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          + classXMLFragment.Child + +
          +          An object to handle (recursively) nested elements.
          +  + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          XMLFragment() + +
          +          Constructor for XMLFragment object.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddText(java.lang.String s) + +
          +          Add nested text, expanding properties as we go
          + java.lang.ObjectcreateDynamicElement(java.lang.String uri, + java.lang.String name, + java.lang.String qName) + +
          +          Creates a nested element.
          + org.w3c.dom.DocumentFragmentgetFragment() + +
          +           
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +XMLFragment

          +
          +public XMLFragment()
          +
          +
          Constructor for XMLFragment object. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getFragment

          +
          +public org.w3c.dom.DocumentFragment getFragment()
          +
          +
          +
          +
          +
          + +
          Returns:
          the DocumentFragment that corresponds to the nested + structure.
          +
          +
          +
          + +

          +addText

          +
          +public void addText(java.lang.String s)
          +
          +
          Add nested text, expanding properties as we go +

          +

          +
          +
          +
          +
          Parameters:
          s - the text to add
          +
          +
          +
          + +

          +createDynamicElement

          +
          +public java.lang.Object createDynamicElement(java.lang.String uri,
+                                             java.lang.String name,
+                                             java.lang.String qName)
          +
          +
          Creates a nested element. +

          +

          +
          Specified by:
          createDynamicElement in interface DynamicElementNS
          +
          +
          +
          Parameters:
          uri - the uri of the nested element
          name - the localname of the nested element
          qName - the qualified name of the nested element +
          Returns:
          an object that the element is applied to
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XmlConstants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XmlConstants.html new file mode 100644 index 000000000..9706f56d5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/XmlConstants.html @@ -0,0 +1,467 @@ + + + + + + +XmlConstants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util +
          +Class XmlConstants

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.XmlConstants
+
          +
          +
          +
          public class XmlConstants
          extends java.lang.Object
          + + +

          +XML Parser constants, all kept in one place for ease of reuse +

          + +

          +

          +
          See Also:
          Xerces features, +Xerces properties, +SAX.
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringFEATURE_DISALLOW_DTD + +
          +          the apache.org/xml disalllow doctype decl feature
          +static java.lang.StringFEATURE_EXTERNAL_ENTITIES + +
          +          the sax external entities feature
          +static java.lang.StringFEATURE_JAXP12_SCHEMA_LANGUAGE + +
          +          property for schema language
          +static java.lang.StringFEATURE_JAXP12_SCHEMA_SOURCE + +
          +          property for schema source
          +static java.lang.StringFEATURE_NAMESPACES + +
          +          property for namespace support
          +static java.lang.StringFEATURE_VALIDATION + +
          +          property for validation
          +static java.lang.StringFEATURE_XSD + +
          +          property for xsd
          +static java.lang.StringFEATURE_XSD_FULL_VALIDATION + +
          +          property for full validation
          +static java.lang.StringPROPERTY_NO_NAMESPACE_SCHEMA_LOCATION + +
          +          property for location of no-name schema
          +static java.lang.StringPROPERTY_SCHEMA_LOCATION + +
          +          property for location of xml schema
          +static java.lang.StringURI_XSD + +
          +          the namespace for XML schema
          +  + + + + + + + + + + +
          +Constructor Summary
          XmlConstants() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +PROPERTY_SCHEMA_LOCATION

          +
          +public static final java.lang.String PROPERTY_SCHEMA_LOCATION
          +
          +
          property for location of xml schema +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PROPERTY_NO_NAMESPACE_SCHEMA_LOCATION

          +
          +public static final java.lang.String PROPERTY_NO_NAMESPACE_SCHEMA_LOCATION
          +
          +
          property for location of no-name schema +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_XSD_FULL_VALIDATION

          +
          +public static final java.lang.String FEATURE_XSD_FULL_VALIDATION
          +
          +
          property for full validation +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_XSD

          +
          +public static final java.lang.String FEATURE_XSD
          +
          +
          property for xsd +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_VALIDATION

          +
          +public static final java.lang.String FEATURE_VALIDATION
          +
          +
          property for validation +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_NAMESPACES

          +
          +public static final java.lang.String FEATURE_NAMESPACES
          +
          +
          property for namespace support +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_JAXP12_SCHEMA_LANGUAGE

          +
          +public static final java.lang.String FEATURE_JAXP12_SCHEMA_LANGUAGE
          +
          +
          property for schema language +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_JAXP12_SCHEMA_SOURCE

          +
          +public static final java.lang.String FEATURE_JAXP12_SCHEMA_SOURCE
          +
          +
          property for schema source +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +URI_XSD

          +
          +public static final java.lang.String URI_XSD
          +
          +
          the namespace for XML schema +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_EXTERNAL_ENTITIES

          +
          +public static final java.lang.String FEATURE_EXTERNAL_ENTITIES
          +
          +
          the sax external entities feature +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FEATURE_DISALLOW_DTD

          +
          +public static final java.lang.String FEATURE_DISALLOW_DTD
          +
          +
          the apache.org/xml disalllow doctype decl feature +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +XmlConstants

          +
          +public XmlConstants()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/AbstractAnalyzer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/AbstractAnalyzer.html new file mode 100644 index 000000000..00a2be1cc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/AbstractAnalyzer.html @@ -0,0 +1,661 @@ + + + + + + +AbstractAnalyzer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.depend +
          +Class AbstractAnalyzer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.depend.AbstractAnalyzer
+
          +
          +
          All Implemented Interfaces:
          DependencyAnalyzer
          +
          +
          +
          Direct Known Subclasses:
          AncestorAnalyzer, AntAnalyzer, FullAnalyzer
          +
          +
          +
          +
          public abstract class AbstractAnalyzer
          extends java.lang.Object
          implements DependencyAnalyzer
          + + +

          +An abstract implementation of the analyzer interface providing support + for the bulk of interface methods. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static intMAX_LOOPS + +
          +          Maximum number of loops for looking for indirect dependencies.
          +  + + + + + + + + + + + +
          +Constructor Summary
          +protected AbstractAnalyzer() + +
          +          Setup the analyzer
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddClassPath(Path classPath) + +
          +          Add a classpath to the classpath being used by the analyzer.
          + voidaddRootClass(java.lang.String className) + +
          +          Add a root class.
          + voidaddSourcePath(Path sourcePath) + +
          +          Add a source path to the source path used by this analyzer.
          + voidconfig(java.lang.String name, + java.lang.Object info) + +
          +          Configure an aspect of the analyzer.
          +protected abstract  voiddetermineDependencies(java.util.Vector files, + java.util.Vector classes) + +
          +          Determine the dependencies of the current set of root classes
          + java.io.FilegetClassContainer(java.lang.String classname) + +
          +          Get the file that contains the class definition
          + java.util.EnumerationgetClassDependencies() + +
          +          Get the list of classes upon which root classes depend.
          + java.util.EnumerationgetFileDependencies() + +
          +          Get the list of files in the file system upon which the root classes + depend.
          +protected  java.util.EnumerationgetRootClasses() + +
          +          Get an enumeration of the root classes
          + java.io.FilegetSourceContainer(java.lang.String classname) + +
          +          Get the file that contains the class source.
          +protected  booleanisClosureRequired() + +
          +          Indicate if the analyzer is required to follow + indirect class relationships.
          + voidreset() + +
          +          Reset the dependency list.
          + voidsetClosure(boolean closure) + +
          +          Set the closure flag.
          +protected abstract  booleansupportsFileDependencies() + +
          +          Indicate if the particular subclass supports file dependency + information.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MAX_LOOPS

          +
          +public static final int MAX_LOOPS
          +
          +
          Maximum number of loops for looking for indirect dependencies. +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractAnalyzer

          +
          +protected AbstractAnalyzer()
          +
          +
          Setup the analyzer +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setClosure

          +
          +public void setClosure(boolean closure)
          +
          +
          Set the closure flag. If this flag is true the analyzer will traverse + all class relationships until it has collected the entire set of + direct and indirect dependencies +

          +

          +
          Specified by:
          setClosure in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          closure - true if dependencies should be traversed to determine + indirect dependencies.
          +
          +
          +
          + +

          +getFileDependencies

          +
          +public java.util.Enumeration getFileDependencies()
          +
          +
          Get the list of files in the file system upon which the root classes + depend. The files will be either the classfiles or jar files upon + which the root classes depend. +

          +

          +
          Specified by:
          getFileDependencies in interface DependencyAnalyzer
          +
          +
          + +
          Returns:
          an enumeration of File instances.
          +
          +
          +
          + +

          +getClassDependencies

          +
          +public java.util.Enumeration getClassDependencies()
          +
          +
          Get the list of classes upon which root classes depend. This is a + list of Java classnames in dot notation. +

          +

          +
          Specified by:
          getClassDependencies in interface DependencyAnalyzer
          +
          +
          + +
          Returns:
          an enumeration of Strings, each being the name of a Java + class in dot notation.
          +
          +
          +
          + +

          +getClassContainer

          +
          +public java.io.File getClassContainer(java.lang.String classname)
+                               throws java.io.IOException
          +
          +
          Get the file that contains the class definition +

          +

          +
          Specified by:
          getClassContainer in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          classname - the name of the required class +
          Returns:
          the file instance, zip or class, containing the + class or null if the class could not be found. +
          Throws: +
          java.io.IOException - if the files in the classpath cannot be read.
          +
          +
          +
          + +

          +getSourceContainer

          +
          +public java.io.File getSourceContainer(java.lang.String classname)
+                                throws java.io.IOException
          +
          +
          Get the file that contains the class source. +

          +

          +
          Specified by:
          getSourceContainer in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          classname - the name of the required class +
          Returns:
          the file instance, zip or java, containing the + source or null if the source for the class could not be found. +
          Throws: +
          java.io.IOException - if the files in the sourcepath cannot be read.
          +
          +
          +
          + +

          +addSourcePath

          +
          +public void addSourcePath(Path sourcePath)
          +
          +
          Add a source path to the source path used by this analyzer. The + elements in the given path contain the source files for the classes + being analyzed. Not all analyzers will use this information. +

          +

          +
          Specified by:
          addSourcePath in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          sourcePath - The Path instance specifying the source path + elements.
          +
          +
          +
          + +

          +addClassPath

          +
          +public void addClassPath(Path classPath)
          +
          +
          Add a classpath to the classpath being used by the analyzer. The + classpath contains the binary classfiles for the classes being + analyzed The elements may either be the directories or jar files.Not + all analyzers will use this information. +

          +

          +
          Specified by:
          addClassPath in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          classPath - the Path instance specifying the classpath elements
          +
          +
          +
          + +

          +addRootClass

          +
          +public void addRootClass(java.lang.String className)
          +
          +
          Add a root class. The root classes are used to drive the + determination of dependency information. The analyzer will start at + the root classes and add dependencies from there. +

          +

          +
          Specified by:
          addRootClass in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          className - the name of the class in Java dot notation.
          +
          +
          +
          + +

          +config

          +
          +public void config(java.lang.String name,
+                   java.lang.Object info)
          +
          +
          Configure an aspect of the analyzer. The set of aspects that are + supported is specific to each analyzer instance. +

          +

          +
          Specified by:
          config in interface DependencyAnalyzer
          +
          +
          +
          Parameters:
          name - the name of the aspect being configured
          info - the configuration info.
          +
          +
          +
          + +

          +reset

          +
          +public void reset()
          +
          +
          Reset the dependency list. This will reset the determined + dependencies and the also list of root classes. +

          +

          +
          Specified by:
          reset in interface DependencyAnalyzer
          +
          +
          +
          +
          +
          +
          + +

          +getRootClasses

          +
          +protected java.util.Enumeration getRootClasses()
          +
          +
          Get an enumeration of the root classes +

          +

          +
          +
          +
          + +
          Returns:
          an enumeration of Strings, each of which is a class name + for a root class.
          +
          +
          +
          + +

          +isClosureRequired

          +
          +protected boolean isClosureRequired()
          +
          +
          Indicate if the analyzer is required to follow + indirect class relationships. +

          +

          +
          +
          +
          + +
          Returns:
          true if indirect relationships should be followed.
          +
          +
          +
          + +

          +determineDependencies

          +
          +protected abstract void determineDependencies(java.util.Vector files,
+                                              java.util.Vector classes)
          +
          +
          Determine the dependencies of the current set of root classes +

          +

          +
          +
          +
          +
          Parameters:
          files - a vector into which Files upon which the root classes + depend should be placed.
          classes - a vector of Strings into which the names of classes + upon which the root classes depend should be placed.
          +
          +
          +
          + +

          +supportsFileDependencies

          +
          +protected abstract boolean supportsFileDependencies()
          +
          +
          Indicate if the particular subclass supports file dependency + information. +

          +

          +
          +
          +
          + +
          Returns:
          true if file dependencies are supported.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/DependencyAnalyzer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/DependencyAnalyzer.html new file mode 100644 index 000000000..f73ce07e7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/DependencyAnalyzer.html @@ -0,0 +1,437 @@ + + + + + + +DependencyAnalyzer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.depend +
          +Interface DependencyAnalyzer

          +
          +
          All Known Implementing Classes:
          AbstractAnalyzer, AncestorAnalyzer, AntAnalyzer, FullAnalyzer
          +
          +
          +
          +
          public interface DependencyAnalyzer
          + + +

          +A dependency analyzer analyzes dependencies between Java classes to + determine the minimal set of classes which are required by a set of + "root" classes. Different implementations of this interface can + use different strategies and libraries to determine the required set. For + example, some analyzers will use class files while others might use + source files. Analyzer specific configuration is catered for through a + generic configure method +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddClassPath(Path classpath) + +
          +          Add a classpath to the classpath being used by the analyzer.
          + voidaddRootClass(java.lang.String classname) + +
          +          Add a root class.
          + voidaddSourcePath(Path sourcePath) + +
          +          Add a source path to the source path used by this analyzer.
          + voidconfig(java.lang.String name, + java.lang.Object info) + +
          +          Configure an aspect of the analyzer.
          + java.io.FilegetClassContainer(java.lang.String classname) + +
          +          Get the file that contains the class definition
          + java.util.EnumerationgetClassDependencies() + +
          +          Get the list of classes upon which root classes depend.
          + java.util.EnumerationgetFileDependencies() + +
          +          Get the list of files in the file system upon which the root classes + depend.
          + java.io.FilegetSourceContainer(java.lang.String classname) + +
          +          Get the file that contains the class source.
          + voidreset() + +
          +          Reset the dependency list.
          + voidsetClosure(boolean closure) + +
          +          Set the closure flag.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +addSourcePath

          +
          +void addSourcePath(Path sourcePath)
          +
          +
          Add a source path to the source path used by this analyzer. The + elements in the given path contain the source files for the classes + being analyzed. Not all analyzers will use this information. +

          +

          +
          Parameters:
          sourcePath - The Path instance specifying the source path + elements.
          +
          +
          +
          + +

          +addClassPath

          +
          +void addClassPath(Path classpath)
          +
          +
          Add a classpath to the classpath being used by the analyzer. The + classpath contains the binary classfiles for the classes being + analyzed The elements may either be the directories or jar files.Not + all analyzers will use this information. +

          +

          +
          Parameters:
          classpath - the Path instance specifying the classpath elements
          +
          +
          +
          + +

          +addRootClass

          +
          +void addRootClass(java.lang.String classname)
          +
          +
          Add a root class. The root classes are used to drive the + determination of dependency information. The analyzer will start at + the root classes and add dependencies from there. +

          +

          +
          Parameters:
          classname - the name of the class in Java dot notation.
          +
          +
          +
          + +

          +getFileDependencies

          +
          +java.util.Enumeration getFileDependencies()
          +
          +
          Get the list of files in the file system upon which the root classes + depend. The files will be either the classfiles or jar files upon + which the root classes depend. +

          +

          + +
          Returns:
          an enumeration of File instances.
          +
          +
          +
          + +

          +getClassDependencies

          +
          +java.util.Enumeration getClassDependencies()
          +
          +
          Get the list of classes upon which root classes depend. This is a + list of Java classnames in dot notation. +

          +

          + +
          Returns:
          an enumeration of Strings, each being the name of a Java + class in dot notation.
          +
          +
          +
          + +

          +reset

          +
          +void reset()
          +
          +
          Reset the dependency list. This will reset the determined + dependencies and the also list of root classes. +

          +

          +
          +
          +
          +
          + +

          +config

          +
          +void config(java.lang.String name,
+            java.lang.Object info)
          +
          +
          Configure an aspect of the analyzer. The set of aspects that are + supported is specific to each analyzer instance. +

          +

          +
          Parameters:
          name - the name of the aspect being configured
          info - the configuration information.
          +
          +
          +
          + +

          +setClosure

          +
          +void setClosure(boolean closure)
          +
          +
          Set the closure flag. If this flag is true the analyzer will traverse + all class relationships until it has collected the entire set of + direct and indirect dependencies +

          +

          +
          Parameters:
          closure - true if dependencies should be traversed to determine + indirect dependencies.
          +
          +
          +
          + +

          +getClassContainer

          +
          +java.io.File getClassContainer(java.lang.String classname)
+                               throws java.io.IOException
          +
          +
          Get the file that contains the class definition +

          +

          +
          Parameters:
          classname - the name of the required class +
          Returns:
          the file instance, zip or class, containing the + class or null if the class could not be found. +
          Throws: +
          java.io.IOException - if the files in the classpath cannot be read.
          +
          +
          +
          + +

          +getSourceContainer

          +
          +java.io.File getSourceContainer(java.lang.String classname)
+                                throws java.io.IOException
          +
          +
          Get the file that contains the class source. +

          +

          +
          Parameters:
          classname - the name of the required class +
          Returns:
          the file instance, zip or java, containing the + source or null if the source for the class could not be found. +
          Throws: +
          java.io.IOException - if the files in the sourcepath cannot be read.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.html new file mode 100644 index 000000000..bbcb3d4d6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.html @@ -0,0 +1,325 @@ + + + + + + +AncestorAnalyzer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.depend.bcel +
          +Class AncestorAnalyzer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.depend.AbstractAnalyzer
+      extended by org.apache.tools.ant.util.depend.bcel.AncestorAnalyzer
+
          +
          +
          All Implemented Interfaces:
          DependencyAnalyzer
          +
          +
          +
          +
          public class AncestorAnalyzer
          extends AbstractAnalyzer
          + + +

          +A dependency analyzer which returns superclass and superinterface + dependencies. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
          MAX_LOOPS
          +  + + + + + + + + + + +
          +Constructor Summary
          AncestorAnalyzer() + +
          +          Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voiddetermineDependencies(java.util.Vector files, + java.util.Vector classes) + +
          +          Determine the dependencies of the configured root classes.
          +protected  booleansupportsFileDependencies() + +
          +          Indicate if this analyzer can determine dependent files.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
          addClassPath, addRootClass, addSourcePath, config, getClassContainer, getClassDependencies, getFileDependencies, getRootClasses, getSourceContainer, isClosureRequired, reset, setClosure
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AncestorAnalyzer

          +
          +public AncestorAnalyzer()
          +
          +
          Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +determineDependencies

          +
          +protected void determineDependencies(java.util.Vector files,
+                                     java.util.Vector classes)
          +
          +
          Determine the dependencies of the configured root classes. +

          +

          +
          Specified by:
          determineDependencies in class AbstractAnalyzer
          +
          +
          +
          Parameters:
          files - a vector to be populated with the files which contain + the dependency classes
          classes - a vector to be populated with the names of the + depencency classes.
          +
          +
          +
          + +

          +supportsFileDependencies

          +
          +protected boolean supportsFileDependencies()
          +
          +
          Indicate if this analyzer can determine dependent files. +

          +

          +
          Specified by:
          supportsFileDependencies in class AbstractAnalyzer
          +
          +
          + +
          Returns:
          true if the analyzer provides dependency file information.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.html new file mode 100644 index 000000000..cb3634cbc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/DependencyVisitor.html @@ -0,0 +1,437 @@ + + + + + + +DependencyVisitor (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.depend.bcel +
          +Class DependencyVisitor

          +
          +java.lang.Object
+  extended by org.apache.bcel.classfile.EmptyVisitor
+      extended by org.apache.tools.ant.util.depend.bcel.DependencyVisitor
+
          +
          +
          All Implemented Interfaces:
          org.apache.bcel.classfile.Visitor
          +
          +
          +
          +
          public class DependencyVisitor
          extends org.apache.bcel.classfile.EmptyVisitor
          + + +

          +A BCEL visitor implementation to collect class dependency information +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          DependencyVisitor() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclearDependencies() + +
          +          Clear the curretn set of collected dependencies.
          + java.util.EnumerationgetDependencies() + +
          +          Get the dependencies collected by this visitor
          + voidvisitConstantClass(org.apache.bcel.classfile.ConstantClass constantClass) + +
          +          Visit a class reference
          + voidvisitConstantNameAndType(org.apache.bcel.classfile.ConstantNameAndType obj) + +
          +          Visit a name and type ref + + Look for class references in this
          + voidvisitConstantPool(org.apache.bcel.classfile.ConstantPool constantPool) + +
          +          Visit the constant pool of a class
          + voidvisitField(org.apache.bcel.classfile.Field field) + +
          +          Visit a field of the class.
          + voidvisitJavaClass(org.apache.bcel.classfile.JavaClass javaClass) + +
          +          Visit a Java class
          + voidvisitMethod(org.apache.bcel.classfile.Method method) + +
          +          Visit a method of the current class
          +  + + + + + + + +
          Methods inherited from class org.apache.bcel.classfile.EmptyVisitor
          visitCode, visitCodeException, visitConstantDouble, visitConstantFieldref, visitConstantFloat, visitConstantInteger, visitConstantInterfaceMethodref, visitConstantLong, visitConstantMethodref, visitConstantString, visitConstantUtf8, visitConstantValue, visitDeprecated, visitExceptionTable, visitInnerClass, visitInnerClasses, visitLineNumber, visitLineNumberTable, visitLocalVariable, visitLocalVariableTable, visitSignature, visitSourceFile, visitStackMap, visitStackMapEntry, visitSynthetic, visitUnknown
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +DependencyVisitor

          +
          +public DependencyVisitor()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getDependencies

          +
          +public java.util.Enumeration getDependencies()
          +
          +
          Get the dependencies collected by this visitor +

          +

          + +
          Returns:
          a Enumeration of classnames, being the classes upon which the + visited classes depend.
          +
          +
          +
          + +

          +clearDependencies

          +
          +public void clearDependencies()
          +
          +
          Clear the curretn set of collected dependencies. +

          +

          +
          +
          +
          +
          + +

          +visitConstantPool

          +
          +public void visitConstantPool(org.apache.bcel.classfile.ConstantPool constantPool)
          +
          +
          Visit the constant pool of a class +

          +

          +
          Specified by:
          visitConstantPool in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitConstantPool in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          constantPool - the constant pool of the class being visited.
          +
          +
          +
          + +

          +visitConstantClass

          +
          +public void visitConstantClass(org.apache.bcel.classfile.ConstantClass constantClass)
          +
          +
          Visit a class reference +

          +

          +
          Specified by:
          visitConstantClass in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitConstantClass in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          constantClass - the constantClass entry for the class reference
          +
          +
          +
          + +

          +visitConstantNameAndType

          +
          +public void visitConstantNameAndType(org.apache.bcel.classfile.ConstantNameAndType obj)
          +
          +
          Visit a name and type ref + + Look for class references in this +

          +

          +
          Specified by:
          visitConstantNameAndType in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitConstantNameAndType in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          obj - the name and type reference being visited.
          +
          +
          +
          + +

          +visitField

          +
          +public void visitField(org.apache.bcel.classfile.Field field)
          +
          +
          Visit a field of the class. +

          +

          +
          Specified by:
          visitField in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitField in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          field - the field being visited
          +
          +
          +
          + +

          +visitJavaClass

          +
          +public void visitJavaClass(org.apache.bcel.classfile.JavaClass javaClass)
          +
          +
          Visit a Java class +

          +

          +
          Specified by:
          visitJavaClass in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitJavaClass in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          javaClass - the class being visited.
          +
          +
          +
          + +

          +visitMethod

          +
          +public void visitMethod(org.apache.bcel.classfile.Method method)
          +
          +
          Visit a method of the current class +

          +

          +
          Specified by:
          visitMethod in interface org.apache.bcel.classfile.Visitor
          Overrides:
          visitMethod in class org.apache.bcel.classfile.EmptyVisitor
          +
          +
          +
          Parameters:
          method - the method being visited.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.html new file mode 100644 index 000000000..ea95386f0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/FullAnalyzer.html @@ -0,0 +1,324 @@ + + + + + + +FullAnalyzer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.depend.bcel +
          +Class FullAnalyzer

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.depend.AbstractAnalyzer
+      extended by org.apache.tools.ant.util.depend.bcel.FullAnalyzer
+
          +
          +
          All Implemented Interfaces:
          DependencyAnalyzer
          +
          +
          +
          +
          public class FullAnalyzer
          extends AbstractAnalyzer
          + + +

          +An analyzer capable fo traversing all class - class relationships. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
          MAX_LOOPS
          +  + + + + + + + + + + +
          +Constructor Summary
          FullAnalyzer() + +
          +          Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  voiddetermineDependencies(java.util.Vector files, + java.util.Vector classes) + +
          +          Determine the dependencies of the configured root classes.
          +protected  booleansupportsFileDependencies() + +
          +          Indicate if this analyzer can determine dependent files.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.depend.AbstractAnalyzer
          addClassPath, addRootClass, addSourcePath, config, getClassContainer, getClassDependencies, getFileDependencies, getRootClasses, getSourceContainer, isClosureRequired, reset, setClosure
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FullAnalyzer

          +
          +public FullAnalyzer()
          +
          +
          Default constructor + + Causes the BCEL classes to load to ensure BCEL dependencies can + be satisfied +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +determineDependencies

          +
          +protected void determineDependencies(java.util.Vector files,
+                                     java.util.Vector classes)
          +
          +
          Determine the dependencies of the configured root classes. +

          +

          +
          Specified by:
          determineDependencies in class AbstractAnalyzer
          +
          +
          +
          Parameters:
          files - a vector to be populated with the files which contain + the dependency classes
          classes - a vector to be populated with the names of the + depencency classes.
          +
          +
          +
          + +

          +supportsFileDependencies

          +
          +protected boolean supportsFileDependencies()
          +
          +
          Indicate if this analyzer can determine dependent files. +

          +

          +
          Specified by:
          supportsFileDependencies in class AbstractAnalyzer
          +
          +
          + +
          Returns:
          true if the analyzer provides dependency file information.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-frame.html new file mode 100644 index 000000000..070dfde3c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +org.apache.tools.ant.util.depend.bcel (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.depend.bcel + + + + +
          +Classes  + +
          +AncestorAnalyzer +
          +DependencyVisitor +
          +FullAnalyzer
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-summary.html new file mode 100644 index 000000000..01baa2436 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-summary.html @@ -0,0 +1,161 @@ + + + + + + +org.apache.tools.ant.util.depend.bcel (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.depend.bcel +

          + + + + + + + + + + + + + + + + + +
          +Class Summary
          AncestorAnalyzerA dependency analyzer which returns superclass and superinterface + dependencies.
          DependencyVisitorA BCEL visitor implementation to collect class dependency information
          FullAnalyzerAn analyzer capable fo traversing all class - class relationships.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-tree.html new file mode 100644 index 000000000..7fb70527b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/bcel/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +org.apache.tools.ant.util.depend.bcel Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.depend.bcel +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-frame.html new file mode 100644 index 000000000..e34e5f533 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +org.apache.tools.ant.util.depend (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.depend + + + + +
          +Interfaces  + +
          +DependencyAnalyzer
          + + + + + + +
          +Classes  + +
          +AbstractAnalyzer
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-summary.html new file mode 100644 index 000000000..33a13dba8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-summary.html @@ -0,0 +1,169 @@ + + + + + + +org.apache.tools.ant.util.depend (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.depend +

          + + + + + + + + + +
          +Interface Summary
          DependencyAnalyzerA dependency analyzer analyzes dependencies between Java classes to + determine the minimal set of classes which are required by a set of + "root" classes.
          +  + +

          + + + + + + + + + +
          +Class Summary
          AbstractAnalyzerAn abstract implementation of the analyzer interface providing support + for the bulk of interface methods.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-tree.html new file mode 100644 index 000000000..a2d0912c2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/depend/package-tree.html @@ -0,0 +1,153 @@ + + + + + + +org.apache.tools.ant.util.depend Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.depend +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/FacadeTaskHelper.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/FacadeTaskHelper.html new file mode 100644 index 000000000..608093f19 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/FacadeTaskHelper.html @@ -0,0 +1,442 @@ + + + + + + +FacadeTaskHelper (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.facade +
          +Class FacadeTaskHelper

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.facade.FacadeTaskHelper
+
          +
          +
          +
          public class FacadeTaskHelper
          extends java.lang.Object
          + + +

          +Helper class for facade implementations - encapsulates treatment of + explicit implementation choices, magic properties and + implementation specific command line arguments. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + + + + + + + + +
          +Constructor Summary
          FacadeTaskHelper(java.lang.String defaultValue) + +
          +           
          FacadeTaskHelper(java.lang.String defaultValue, + java.lang.String magicValue) + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddImplementationArgument(ImplementationSpecificArgument arg) + +
          +          Command line argument.
          + java.lang.String[]getArgs() + +
          +          Retrieves the command line arguments enabled for the current + facade implementation.
          + java.lang.StringgetExplicitChoice() + +
          +          Retrieves the explicit user choice.
          + java.lang.StringgetImplementation() + +
          +          Retrieves the implementation.
          + PathgetImplementationClasspath(Project project) + +
          +          The classpath to use when loading the implementation.
          + booleanhasBeenSet() + +
          +          Tests whether the implementation has been chosen by the user + (either via a magic property or explicitly.
          + voidsetImplementation(java.lang.String userChoice) + +
          +          Used for explicit user choices.
          + voidsetMagicValue(java.lang.String magicValue) + +
          +          Used to set the value of the magic property.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +FacadeTaskHelper

          +
          +public FacadeTaskHelper(java.lang.String defaultValue)
          +
          +
          +
          Parameters:
          defaultValue - The default value for the implementation. + Must not be null.
          +
          +
          + +

          +FacadeTaskHelper

          +
          +public FacadeTaskHelper(java.lang.String defaultValue,
+                        java.lang.String magicValue)
          +
          +
          +
          Parameters:
          defaultValue - The default value for the implementation. + Must not be null.
          magicValue - the value of a magic property that may hold a user. + choice. May be null.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setMagicValue

          +
          +public void setMagicValue(java.lang.String magicValue)
          +
          +
          Used to set the value of the magic property. +

          +

          +
          Parameters:
          magicValue - the value of a magic property that may hold a user.
          +
          +
          +
          + +

          +setImplementation

          +
          +public void setImplementation(java.lang.String userChoice)
          +
          +
          Used for explicit user choices. +

          +

          +
          Parameters:
          userChoice - the explicitly chosen implementation.
          +
          +
          +
          + +

          +getImplementation

          +
          +public java.lang.String getImplementation()
          +
          +
          Retrieves the implementation. +

          +

          + +
          Returns:
          the implementation.
          +
          +
          +
          + +

          +getExplicitChoice

          +
          +public java.lang.String getExplicitChoice()
          +
          +
          Retrieves the explicit user choice. +

          +

          + +
          Returns:
          the explicit user choice.
          +
          +
          +
          + +

          +addImplementationArgument

          +
          +public void addImplementationArgument(ImplementationSpecificArgument arg)
          +
          +
          Command line argument. +

          +

          +
          Parameters:
          arg - an argument to add.
          +
          +
          +
          + +

          +getArgs

          +
          +public java.lang.String[] getArgs()
          +
          +
          Retrieves the command line arguments enabled for the current + facade implementation. +

          +

          + +
          Returns:
          an array of command line arguements.
          +
          +
          +
          + +

          +hasBeenSet

          +
          +public boolean hasBeenSet()
          +
          +
          Tests whether the implementation has been chosen by the user + (either via a magic property or explicitly. +

          +

          + +
          Returns:
          true if magic or user choice has be set.
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +getImplementationClasspath

          +
          +public Path getImplementationClasspath(Project project)
          +
          +
          The classpath to use when loading the implementation. +

          +

          +
          Parameters:
          project - the current project +
          Returns:
          a Path instance that may be appended to
          Since:
          +
          Ant 1.8.0
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html new file mode 100644 index 000000000..a7aed8874 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/ImplementationSpecificArgument.html @@ -0,0 +1,329 @@ + + + + + + +ImplementationSpecificArgument (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.facade +
          +Class ImplementationSpecificArgument

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.ProjectComponent
+      extended by org.apache.tools.ant.types.Commandline.Argument
+          extended by org.apache.tools.ant.util.facade.ImplementationSpecificArgument
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          Direct Known Subclasses:
          Javac.ImplementationSpecificArgument, Rmic.ImplementationSpecificArgument
          +
          +
          +
          +
          public class ImplementationSpecificArgument
          extends Commandline.Argument
          + + +

          +Extension of Commandline.Argument with a new attribute that choses + a specific implementation of the facade. +

          + +

          +

          +
          Since:
          +
          Ant 1.5
          +
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.ProjectComponent
          description, location, project
          +  + + + + + + + + + + +
          +Constructor Summary
          ImplementationSpecificArgument() + +
          +          Constructor for ImplementationSpecificArgument.
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.String[]getParts(java.lang.String chosenImpl) + +
          +          Return the parts this Argument consists of, if the + implementation matches the chosen implementation.
          + voidsetImplementation(java.lang.String impl) + +
          +          Set the implementation this argument is for.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.types.Commandline.Argument
          getParts, setFile, setLine, setPath, setPathref, setPrefix, setSuffix, setValue
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.ProjectComponent
          clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ImplementationSpecificArgument

          +
          +public ImplementationSpecificArgument()
          +
          +
          Constructor for ImplementationSpecificArgument. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setImplementation

          +
          +public void setImplementation(java.lang.String impl)
          +
          +
          Set the implementation this argument is for. +

          +

          +
          Parameters:
          impl - the implementation this command line argument is for.
          +
          +
          +
          + +

          +getParts

          +
          +public final java.lang.String[] getParts(java.lang.String chosenImpl)
          +
          +
          Return the parts this Argument consists of, if the + implementation matches the chosen implementation. +

          +

          +
          Parameters:
          chosenImpl - the implementation to check against. +
          Returns:
          the parts if the implemention matches or an zero length + array if not.
          See Also:
          Commandline.Argument.getParts()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-frame.html new file mode 100644 index 000000000..2a88a3cd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-frame.html @@ -0,0 +1,34 @@ + + + + + + +org.apache.tools.ant.util.facade (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.facade + + + + +
          +Classes  + +
          +FacadeTaskHelper +
          +ImplementationSpecificArgument
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-summary.html new file mode 100644 index 000000000..79cf501e2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-summary.html @@ -0,0 +1,159 @@ + + + + + + +org.apache.tools.ant.util.facade (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.facade +

          + + + + + + + + + + + + + +
          +Class Summary
          FacadeTaskHelperHelper class for facade implementations - encapsulates treatment of + explicit implementation choices, magic properties and + implementation specific command line arguments.
          ImplementationSpecificArgumentExtension of Commandline.Argument with a new attribute that choses + a specific implementation of the facade.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-tree.html new file mode 100644 index 000000000..27ddf8d15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/facade/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +org.apache.tools.ant.util.facade Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.facade +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/ProxyDiagnostics.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/ProxyDiagnostics.html new file mode 100644 index 000000000..bd6f19371 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/ProxyDiagnostics.html @@ -0,0 +1,327 @@ + + + + + + +ProxyDiagnostics (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.java15 +
          +Class ProxyDiagnostics

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.java15.ProxyDiagnostics
+
          +
          +
          +
          public class ProxyDiagnostics
          extends java.lang.Object
          + + +

          +This class exists to create a string that tells diagnostics about the current + state of proxy diagnostics. + It does this in its toString operator. + Java1.5+ is needed to compile this class; its interface is classic typeless + Java. +

          + +

          +

          +
          Since:
          +
          Ant 1.7
          +
          +
          + +

          + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_DESTINATION + +
          +          "http://ant.apache.org/"
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          ProxyDiagnostics() + +
          +          create a proxy diagnostics tool bound to + DEFAULT_DESTINATION
          ProxyDiagnostics(java.lang.String destination) + +
          +          create a diagnostics binding for a specific URI
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringtoString() + +
          +          Get the diagnostics for proxy information.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_DESTINATION

          +
          +public static final java.lang.String DEFAULT_DESTINATION
          +
          +
          "http://ant.apache.org/" +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ProxyDiagnostics

          +
          +public ProxyDiagnostics(java.lang.String destination)
          +
          +
          create a diagnostics binding for a specific URI +

          +

          +
          Parameters:
          destination - dest to bind to +
          Throws: +
          BuildException - if the URI is malformed.
          +
          +
          + +

          +ProxyDiagnostics

          +
          +public ProxyDiagnostics()
          +
          +
          create a proxy diagnostics tool bound to + DEFAULT_DESTINATION +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          Get the diagnostics for proxy information. +

          +

          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          + +
          Returns:
          the information.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-frame.html new file mode 100644 index 000000000..377e0c0c4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +org.apache.tools.ant.util.java15 (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.java15 + + + + +
          +Classes  + +
          +ProxyDiagnostics
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-summary.html new file mode 100644 index 000000000..3254e98c5 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-summary.html @@ -0,0 +1,153 @@ + + + + + + +org.apache.tools.ant.util.java15 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.java15 +

          + + + + + + + + + +
          +Class Summary
          ProxyDiagnosticsThis class exists to create a string that tells diagnostics about the current + state of proxy diagnostics.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-tree.html new file mode 100644 index 000000000..229b1429a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/java15/package-tree.html @@ -0,0 +1,147 @@ + + + + + + +org.apache.tools.ant.util.java15 Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.java15 +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/JavaxScriptRunner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/JavaxScriptRunner.html new file mode 100644 index 000000000..0d97d6d22 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/JavaxScriptRunner.html @@ -0,0 +1,356 @@ + + + + + + +JavaxScriptRunner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.optional +
          +Class JavaxScriptRunner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerBase
+      extended by org.apache.tools.ant.util.optional.JavaxScriptRunner
+
          +
          +
          +
          public class JavaxScriptRunner
          extends ScriptRunnerBase
          + + +

          +This class is used to run scripts using JSR 223. +

          + +

          +

          +
          Since:
          +
          Ant 1.7.0
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JavaxScriptRunner() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.ObjectevaluateScript(java.lang.String execName) + +
          +          Do the work to eval the script.
          + voidexecuteScript(java.lang.String execName) + +
          +          Do the work to run the script.
          + java.lang.StringgetManagerName() + +
          +          Get the name of the manager prefix.
          + booleansupportsLanguage() + +
          +          Check if a script engine can be created for + this language..
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ScriptRunnerBase
          addBean, addBeans, addText, bindToComponent, bindToComponentMinimum, checkLanguage, clearScript, getBeans, getKeepEngine, getLanguage, getProject, getScript, getScriptClassLoader, loadResource, loadResources, replaceContextLoader, restoreContextLoader, setKeepEngine, setLanguage, setProject, setScriptClassLoader, setSrc
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JavaxScriptRunner

          +
          +public JavaxScriptRunner()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getManagerName

          +
          +public java.lang.String getManagerName()
          +
          +
          Get the name of the manager prefix. +

          +

          +
          Specified by:
          getManagerName in class ScriptRunnerBase
          +
          +
          + +
          Returns:
          "javax"
          +
          +
          +
          + +

          +supportsLanguage

          +
          +public boolean supportsLanguage()
          +
          +
          Check if a script engine can be created for + this language.. +

          +

          +
          Specified by:
          supportsLanguage in class ScriptRunnerBase
          +
          +
          + +
          Returns:
          true if a script engine can be created, false + otherwise.
          +
          +
          +
          + +

          +executeScript

          +
          +public void executeScript(java.lang.String execName)
+                   throws BuildException
          +
          +
          Do the work to run the script. +

          +

          +
          Specified by:
          executeScript in class ScriptRunnerBase
          +
          +
          +
          Parameters:
          execName - the name that will be passed to the + scripting engine for this script execution. +
          Throws: +
          BuildException - if someting goes wrong exectuing the script.
          +
          +
          +
          + +

          +evaluateScript

          +
          +public java.lang.Object evaluateScript(java.lang.String execName)
+                                throws BuildException
          +
          +
          Do the work to eval the script. +

          +

          +
          Specified by:
          evaluateScript in class ScriptRunnerBase
          +
          +
          +
          Parameters:
          execName - the name that will be passed to the + scripting engine for this script execution. +
          Returns:
          the result of the evaluation +
          Throws: +
          BuildException - if something goes wrong executing the script.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/NoExitSecurityManager.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/NoExitSecurityManager.html new file mode 100644 index 000000000..c823e77b3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/NoExitSecurityManager.html @@ -0,0 +1,315 @@ + + + + + + +NoExitSecurityManager (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.optional +
          +Class NoExitSecurityManager

          +
          +java.lang.Object
+  extended by java.lang.SecurityManager
+      extended by org.apache.tools.ant.util.optional.NoExitSecurityManager
+
          +
          +
          +
          public class NoExitSecurityManager
          extends java.lang.SecurityManager
          + + +

          +This is intended as a replacement for the default system manager. + The goal is to intercept System.exit calls and make it throw an + exception instead so that a System.exit in a task does not + fully terminate Ant. +

          + +

          +

          +
          See Also:
          ExitException
          +
          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class java.lang.SecurityManager
          inCheck
          +  + + + + + + + + + + +
          +Constructor Summary
          NoExitSecurityManager() + +
          +           
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          + voidcheckExit(int status) + +
          +          Override SecurityManager#checkExit.
          + voidcheckPermission(java.security.Permission perm) + +
          +          Override SecurityManager#checkPermission.
          +  + + + + + + + +
          Methods inherited from class java.lang.SecurityManager
          checkAccept, checkAccess, checkAccess, checkAwtEventQueueAccess, checkConnect, checkConnect, checkCreateClassLoader, checkDelete, checkExec, checkLink, checkListen, checkMemberAccess, checkMulticast, checkMulticast, checkPackageAccess, checkPackageDefinition, checkPermission, checkPrintJobAccess, checkPropertiesAccess, checkPropertyAccess, checkRead, checkRead, checkRead, checkSecurityAccess, checkSetFactory, checkSystemClipboardAccess, checkTopLevelWindow, checkWrite, checkWrite, classDepth, classLoaderDepth, currentClassLoader, currentLoadedClass, getClassContext, getInCheck, getSecurityContext, getThreadGroup, inClass, inClassLoader
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +NoExitSecurityManager

          +
          +public NoExitSecurityManager()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +checkExit

          +
          +public void checkExit(int status)
          +
          +
          Override SecurityManager#checkExit. + This throws an ExitException(status) exception. +

          +

          +
          Overrides:
          checkExit in class java.lang.SecurityManager
          +
          +
          +
          Parameters:
          status - the exit status
          +
          +
          +
          + +

          +checkPermission

          +
          +public void checkPermission(java.security.Permission perm)
          +
          +
          Override SecurityManager#checkPermission. + This does nothing. +

          +

          +
          Overrides:
          checkPermission in class java.lang.SecurityManager
          +
          +
          +
          Parameters:
          perm - the requested permission.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/ScriptRunner.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/ScriptRunner.html new file mode 100644 index 000000000..eb4e18430 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/ScriptRunner.html @@ -0,0 +1,350 @@ + + + + + + +ScriptRunner (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.optional +
          +Class ScriptRunner

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.ScriptRunnerBase
+      extended by org.apache.tools.ant.util.optional.ScriptRunner
+
          +
          +
          Direct Known Subclasses:
          ScriptRunner
          +
          +
          +
          +
          public class ScriptRunner
          extends ScriptRunnerBase
          + + +

          +This class is used to run BSF scripts +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ScriptRunner() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.ObjectevaluateScript(java.lang.String execName) + +
          +          Evaluate the script.
          + voidexecuteScript(java.lang.String execName) + +
          +          Do the work.
          + java.lang.StringgetManagerName() + +
          +          Get the name of the manager prefix.
          + booleansupportsLanguage() + +
          +          Check if bsf supports the language.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.ScriptRunnerBase
          addBean, addBeans, addText, bindToComponent, bindToComponentMinimum, checkLanguage, clearScript, getBeans, getKeepEngine, getLanguage, getProject, getScript, getScriptClassLoader, loadResource, loadResources, replaceContextLoader, restoreContextLoader, setKeepEngine, setLanguage, setProject, setScriptClassLoader, setSrc
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ScriptRunner

          +
          +public ScriptRunner()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getManagerName

          +
          +public java.lang.String getManagerName()
          +
          +
          Get the name of the manager prefix. +

          +

          +
          Specified by:
          getManagerName in class ScriptRunnerBase
          +
          +
          + +
          Returns:
          "bsf"
          +
          +
          +
          + +

          +supportsLanguage

          +
          +public boolean supportsLanguage()
          +
          +
          Check if bsf supports the language. +

          +

          +
          Specified by:
          supportsLanguage in class ScriptRunnerBase
          +
          +
          + +
          Returns:
          true if bsf can create an engine for this language.
          +
          +
          +
          + +

          +executeScript

          +
          +public void executeScript(java.lang.String execName)
+                   throws BuildException
          +
          +
          Do the work. +

          +

          +
          Specified by:
          executeScript in class ScriptRunnerBase
          +
          +
          +
          Parameters:
          execName - the name that will be passed to BSF for this script execution. +
          Throws: +
          BuildException - if something goes wrong executing the script.
          +
          +
          +
          + +

          +evaluateScript

          +
          +public java.lang.Object evaluateScript(java.lang.String execName)
+                                throws BuildException
          +
          +
          Evaluate the script. +

          +

          +
          Specified by:
          evaluateScript in class ScriptRunnerBase
          +
          +
          +
          Parameters:
          execName - the name that will be passed to BSF for this script execution. +
          Returns:
          the result of the evaluation +
          Throws: +
          BuildException - if something goes wrong executing the script.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/WeakishReference12.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/WeakishReference12.html new file mode 100644 index 000000000..eaf830a5f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/WeakishReference12.html @@ -0,0 +1,267 @@ + + + + + + +WeakishReference12 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.optional +
          +Class WeakishReference12

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.WeakishReference
+      extended by org.apache.tools.ant.util.WeakishReference.HardReference
+          extended by org.apache.tools.ant.util.optional.WeakishReference12
+
          +
          +Deprecated. since 1.7. + Just use WeakReference directly. + Note that in ant1.7 is parent was changed to extend HardReference. + This is because the latter has access to the (package scoped) + WeakishReference(Object) constructor, and both that and this are thin + facades on the underlying no-longer-abstract base class. +

          +

          +
          public class WeakishReference12
          extends WeakishReference.HardReference
          + + +

          +This is a reference that really is is Weak, as it uses the + appropriate java.lang.ref class. +

          + +

          +

          + +

          + + + + + + + +
          +Nested Class Summary
          +  + + + + + + + +
          Nested classes/interfaces inherited from class org.apache.tools.ant.util.WeakishReference
          WeakishReference.HardReference
          +  + + + + + + + + + + + +
          +Constructor Summary
          WeakishReference12(java.lang.Object reference) + +
          +          Deprecated. create a new soft reference, which is bound to a + Weak reference inside
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.WeakishReference
          createReference, get
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +WeakishReference12

          +
          +public WeakishReference12(java.lang.Object reference)
          +
          +
          Deprecated. 
          create a new soft reference, which is bound to a + Weak reference inside +

          +

          +
          Parameters:
          reference - the object to reference.
          See Also:
          WeakReference
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-frame.html new file mode 100644 index 000000000..28673ac4e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +org.apache.tools.ant.util.optional (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.optional + + + + +
          +Classes  + +
          +JavaxScriptRunner +
          +NoExitSecurityManager +
          +ScriptRunner +
          +WeakishReference12
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-summary.html new file mode 100644 index 000000000..0bb150e91 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-summary.html @@ -0,0 +1,164 @@ + + + + + + +org.apache.tools.ant.util.optional (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.optional +

          + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          JavaxScriptRunnerThis class is used to run scripts using JSR 223.
          NoExitSecurityManagerThis is intended as a replacement for the default system manager.
          ScriptRunnerThis class is used to run BSF scripts
          WeakishReference12Deprecated. since 1.7.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-tree.html new file mode 100644 index 000000000..3955d74b9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/optional/package-tree.html @@ -0,0 +1,155 @@ + + + + + + +org.apache.tools.ant.util.optional Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.optional +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-frame.html new file mode 100644 index 000000000..4509fad60 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-frame.html @@ -0,0 +1,181 @@ + + + + + + +org.apache.tools.ant.util (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util + + + + +
          +Interfaces  + +
          +FileNameMapper +
          +ResourceUtils.ResourceSelectorProvider +
          +Retryable +
          +TimeoutObserver +
          +Tokenizer
          + + + + + + +
          +Classes  + +
          +Base64Converter +
          +ChainedMapper +
          +ClasspathUtils +
          +ClasspathUtils.Delegate +
          +CollectionUtils +
          +CollectionUtils.EmptyEnumeration +
          +CompositeMapper +
          +ConcatFileInputStream +
          +ConcatResourceInputStream +
          +ContainerMapper +
          +DateUtils +
          +DeweyDecimal +
          +DOMElementWriter +
          +DOMElementWriter.XmlNamespacePolicy +
          +DOMUtils +
          +FileTokenizer +
          +FileUtils +
          +FirstMatchMapper +
          +FlatFileNameMapper +
          +GlobPatternMapper +
          +IdentityMapper +
          +IdentityStack +
          +JavaEnvUtils +
          +JAXPUtils +
          +KeepAliveInputStream +
          +KeepAliveOutputStream +
          +LayoutPreservingProperties +
          +LazyFileOutputStream +
          +LazyHashtable +
          +LeadPipeInputStream +
          +LineOrientedOutputStream +
          +LineTokenizer +
          +LinkedHashtable +
          +LoaderUtils +
          +MergingMapper +
          +OutputStreamFunneler +
          +PackageNameMapper +
          +PropertyOutputStream +
          +ProxySetup +
          +ReaderInputStream +
          +ReflectUtil +
          +ReflectWrapper +
          +RegexpPatternMapper +
          +ResourceUtils +
          +RetryHandler +
          +ScriptFixBSFPath +
          +ScriptRunner +
          +ScriptRunnerBase +
          +ScriptRunnerCreator +
          +ScriptRunnerHelper +
          +SourceFileScanner +
          +SplitClassLoader +
          +StringTokenizer +
          +StringUtils +
          +SymbolicLinkUtils +
          +TaskLogger +
          +TeeOutputStream +
          +UnPackageNameMapper +
          +UUEncoder +
          +VectorSet +
          +Watchdog +
          +WeakishReference +
          +WeakishReference.HardReference +
          +WorkerAnt +
          +XmlConstants +
          +XMLFragment
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-summary.html new file mode 100644 index 000000000..8b7f72fdf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-summary.html @@ -0,0 +1,494 @@ + + + + + + +org.apache.tools.ant.util (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Interface Summary
          FileNameMapperInterface to be used by SourceFileScanner.
          ResourceUtils.ResourceSelectorProvider 
          RetryableSimple interface for executing a piece of code.
          TimeoutObserverInterface for classes that want to be notified by Watchdog.
          Tokenizerinput stream tokenizers implement this interface
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          Base64ConverterBASE 64 encoding of a String or an array of bytes.
          ChainedMapperA ContainerMapper that chains the results of the first + nested FileNameMappers into sourcefiles for the second, + the second to the third, and so on, returning the resulting mapped + filenames from the last nested FileNameMapper.
          ClasspathUtilsOffers some helper methods on the Path structure in ant.
          ClasspathUtils.DelegateDelegate that helps out any specific ProjectComponent that needs + dynamic classloading.
          CollectionUtilsA set of helper methods related to collection manipulation.
          CollectionUtils.EmptyEnumerationAn empty enumeration.
          CompositeMapperA ContainerMapper that unites the results of its constituent + FileNameMappers into a single set of result filenames.
          ConcatFileInputStreamSpecial InputStream that will + concatenate the contents of an array of files.
          ConcatResourceInputStreamSpecial InputStream that will + concatenate the contents of Resources from a single ResourceCollection.
          ContainerMapperA FileNameMapper that contains + other FileNameMappers.
          DateUtilsHelper methods to deal with date/time formatting with a specific + defined format (ISO8601) + or a plurialization correct elapsed time in minutes and seconds.
          DeweyDecimalUtility class to contain version numbers in "Dewey Decimal" + syntax.
          DOMElementWriterWrites a DOM tree to a given Writer.
          DOMElementWriter.XmlNamespacePolicyWhether namespaces should be ignored for elements and attributes.
          DOMUtilsSome utility methods for common tasks when building DOM trees in memory.
          FileTokenizerClass to read the complete input into a string.
          FileUtilsThis class also encapsulates methods which allow Files to be + referred to using abstract path names which are translated to native + system file paths at runtime as well as copying files or setting + their last modification time.
          FirstMatchMapperA ContainerMapper that returns the results of its + first constituent FileNameMappers that matches.
          FlatFileNameMapperImplementation of FileNameMapper that always returns the source + file name without any leading directory information.
          GlobPatternMapperImplementation of FileNameMapper that does simple wildcard pattern + replacements.
          IdentityMapperImplementation of FileNameMapper that always returns the source file name.
          IdentityStackIdentity Stack.
          JavaEnvUtilsA set of helper methods related to locating executables or checking + conditons of a given Java installation.
          JAXPUtilsCollection of helper methods that retrieve a ParserFactory or + Parsers and Readers.
          KeepAliveInputStreamClass that can be used to wrap System.in + without getting anxious about any client closing the stream.
          KeepAliveOutputStreamClass that can be used to wrap System.out and System.err + without getting anxious about any client closing the stream.
          LayoutPreservingPropertiesA Properties collection which preserves comments and whitespace + present in the input stream from which it was loaded.
          LazyFileOutputStreamClass that delays opening the output file until the first bytes + shall be written or the method open has been invoked + explicitly.
          LazyHashtableHashtable implementation that allows delayed construction + of expensive objects + + All operations that need access to the full list of objects + will call initAll() first.
          LeadPipeInputStreamSpecial PipedInputStream that will not die + when the writing Thread is no longer alive.
          LineOrientedOutputStreamInvokes processLine whenever a full line has + been written to this stream.
          LineTokenizerclass to tokenize the input as lines seperated + by \r (mac style), \r\n (dos/windows style) or \n (unix style)
          LinkedHashtableSubclass of Hashtable that wraps a LinkedHashMap to provide + predictable iteration order.
          LoaderUtilsClassLoader utility methods
          MergingMapperImplementation of FileNameMapper that always returns the same + target file name.
          OutputStreamFunnelerManages a set of OutputStreams to + write to a single underlying stream, which is + closed only when the last "funnel" + has been closed.
          PackageNameMapperMaps directory name matches into a dotted package name.
          PropertyOutputStreamException thrown when an attempt is made to get an OutputStream + from an immutable Resource.
          ProxySetupCode to do proxy setup.
          ReaderInputStreamAdapts a Reader as an InputStream.
          ReflectUtilUtility class to handle reflection on java objects.
          ReflectWrapperUtility class to handle reflection on java objects.
          RegexpPatternMapperImplementation of FileNameMapper that does regular expression + replacements.
          ResourceUtilsThis class provides utility methods to process Resources.
          RetryHandlerA simple utility class to take a piece of code (that implements + Retryable interface) and executes that with possibility to + retry the execution in case of IOException.
          ScriptFixBSFPathA class to modify a classloader to + support BSF language support.
          ScriptRunnerDeprecated. Implementation moved to another location.
          ScriptRunnerBaseThis is a common abstract base case for script runners.
          ScriptRunnerCreatorThis is a helper class used by ScriptRunnerHelper to + create a ScriptRunner based on a classloader and on a language.
          ScriptRunnerHelperA class to help in creating, setting and getting script runners.
          SourceFileScannerUtility class that collects the functionality of the various + scanDir methods that have been scattered in several tasks before.
          SplitClassLoaderSpecialized classloader for tasks that need finer grained control + over which classes are to be loaded via Ant's classloader and which + should not even if they are available.
          StringTokenizerClass to tokenize the input as areas separated + by white space, or by a specified list of + delim characters.
          StringUtilsA set of helper methods related to string manipulation.
          SymbolicLinkUtilsContains methods related to symbolic links - or what Ant thinks is + a symbolic link based on the absent support for them in Java.
          TaskLoggerA facade that makes logging nicer to use.
          TeeOutputStreamA simple T-piece to replicate an output stream into two separate streams
          UnPackageNameMapperMaps dotted package name matches to a directory name.
          UUEncoderUUEncoding of an input stream placed into an outputstream.
          VectorSetSubclass of Vector that won't store duplicate entries and shows + HashSet's constant time performance characteristics for the + contains method.
          WatchdogGeneralization of ExecuteWatchdog
          WeakishReferenceDeprecated. deprecated 1.7; will be removed in Ant1.8 + Just use WeakReference directly.
          WeakishReference.HardReferenceDeprecated. since 1.7.
          WorkerAntA worker ant executes a single task in a background thread.
          XmlConstantsXML Parser constants, all kept in one place for ease of reuse
          XMLFragmentUse this class as a nested element if you want to get a literal DOM + fragment of something nested into your task/type.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-tree.html new file mode 100644 index 000000000..6bc54473c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/package-tree.html @@ -0,0 +1,219 @@ + + + + + + +org.apache.tools.ant.util Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroMatcher.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroMatcher.html new file mode 100644 index 000000000..be2a87e5b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroMatcher.html @@ -0,0 +1,529 @@ + + + + + + +JakartaOroMatcher (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class JakartaOroMatcher

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.JakartaOroMatcher
+
          +
          +
          All Implemented Interfaces:
          RegexpMatcher
          +
          +
          +
          Direct Known Subclasses:
          JakartaOroRegexp
          +
          +
          +
          +
          public class JakartaOroMatcher
          extends java.lang.Object
          implements RegexpMatcher
          + + +

          +Implementation of RegexpMatcher for Jakarta-ORO. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  org.apache.oro.text.regex.Perl5Compilercompiler + +
          +           
          +protected  org.apache.oro.text.regex.Perl5Matchermatcher + +
          +           
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          JakartaOroMatcher() + +
          +          Constructor for JakartaOroMatcher.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  org.apache.oro.text.regex.PatterngetCompiledPattern(int options) + +
          +          Get a compiled representation of the regexp pattern
          +protected  intgetCompilerOptions(int options) + +
          +          Convert the generic options to the regex compiler specific options.
          + java.util.VectorgetGroups(java.lang.String argument) + +
          +          Returns a Vector of matched groups found in the argument + using default options.
          + java.util.VectorgetGroups(java.lang.String input, + int options) + +
          +          Returns a Vector of matched groups found in the argument.
          + java.lang.StringgetPattern() + +
          +          Get a String representation of the regexp pattern
          + booleanmatches(java.lang.String argument) + +
          +          Does the given argument match the pattern using default options?
          + booleanmatches(java.lang.String input, + int options) + +
          +          Does the given argument match the pattern?
          + voidsetPattern(java.lang.String pattern) + +
          +          Set the regexp pattern from the String description.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +compiler

          +
          +protected final org.apache.oro.text.regex.Perl5Compiler compiler
          +
          +
          +
          +
          +
          + +

          +matcher

          +
          +protected final org.apache.oro.text.regex.Perl5Matcher matcher
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +JakartaOroMatcher

          +
          +public JakartaOroMatcher()
          +
          +
          Constructor for JakartaOroMatcher. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String pattern)
          +
          +
          Set the regexp pattern from the String description. +

          +

          +
          Specified by:
          setPattern in interface RegexpMatcher
          +
          +
          +
          Parameters:
          pattern - the pattern to match
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern()
          +
          +
          Get a String representation of the regexp pattern +

          +

          +
          Specified by:
          getPattern in interface RegexpMatcher
          +
          +
          + +
          Returns:
          the pattern
          +
          +
          +
          + +

          +getCompiledPattern

          +
          +protected org.apache.oro.text.regex.Pattern getCompiledPattern(int options)
+                                                        throws BuildException
          +
          +
          Get a compiled representation of the regexp pattern +

          +

          +
          +
          +
          +
          Parameters:
          options - the options +
          Returns:
          the compiled pattern +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String argument)
+                throws BuildException
          +
          +
          Does the given argument match the pattern using default options? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String input,
+                       int options)
+                throws BuildException
          +
          +
          Does the given argument match the pattern? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String argument)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument + using default options. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String input,
+                                  int options)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getCompilerOptions

          +
          +protected int getCompilerOptions(int options)
          +
          +
          Convert the generic options to the regex compiler specific options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the generic options +
          Returns:
          the specific options
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroRegexp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroRegexp.html new file mode 100644 index 000000000..e017b2699 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaOroRegexp.html @@ -0,0 +1,349 @@ + + + + + + +JakartaOroRegexp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class JakartaOroRegexp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.JakartaOroMatcher
+      extended by org.apache.tools.ant.util.regexp.JakartaOroRegexp
+
          +
          +
          All Implemented Interfaces:
          Regexp, RegexpMatcher
          +
          +
          +
          +
          public class JakartaOroRegexp
          extends JakartaOroMatcher
          implements Regexp
          + + +

          +Regular expression implementation using the Jakarta Oro package +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from class org.apache.tools.ant.util.regexp.JakartaOroMatcher
          compiler, matcher
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.Regexp
          REPLACE_ALL, REPLACE_FIRST
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          JakartaOroRegexp() + +
          +          Constructor for JakartaOroRegexp
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  intgetSubsOptions(int options) + +
          +          Convert ant regexp substitution option to oro options.
          + java.lang.Stringsubstitute(java.lang.String input, + java.lang.String argument, + int options) + +
          +          Perform a substitution on the regular expression.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.regexp.JakartaOroMatcher
          getCompiledPattern, getCompilerOptions, getGroups, getGroups, getPattern, matches, matches, setPattern
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          getGroups, getGroups, getPattern, matches, matches, setPattern
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JakartaOroRegexp

          +
          +public JakartaOroRegexp()
          +
          +
          Constructor for JakartaOroRegexp +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +substitute

          +
          +public java.lang.String substitute(java.lang.String input,
+                                   java.lang.String argument,
+                                   int options)
+                            throws BuildException
          +
          +
          Perform a substitution on the regular expression. +

          +

          +
          Specified by:
          substitute in interface Regexp
          +
          +
          +
          Parameters:
          input - The string to substitute on
          argument - The string which defines the substitution
          options - The list of options for the match and replace. +
          Returns:
          the result of the operation +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getSubsOptions

          +
          +protected int getSubsOptions(int options)
          +
          +
          Convert ant regexp substitution option to oro options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the ant regexp options +
          Returns:
          the oro substition options
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpMatcher.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpMatcher.html new file mode 100644 index 000000000..9c098177d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpMatcher.html @@ -0,0 +1,482 @@ + + + + + + +JakartaRegexpMatcher (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class JakartaRegexpMatcher

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.JakartaRegexpMatcher
+
          +
          +
          All Implemented Interfaces:
          RegexpMatcher
          +
          +
          +
          Direct Known Subclasses:
          JakartaRegexpRegexp
          +
          +
          +
          +
          public class JakartaRegexpMatcher
          extends java.lang.Object
          implements RegexpMatcher
          + + +

          +Implementation of RegexpMatcher for Jakarta-Regexp. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          JakartaRegexpMatcher() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  org.apache.regexp.REgetCompiledPattern(int options) + +
          +          Compile the pattern.
          +protected  intgetCompilerOptions(int options) + +
          +          Convert the generic options to the regex compiler specific options.
          + java.util.VectorgetGroups(java.lang.String argument) + +
          +          Returns a Vector of matched groups found in the argument + using default options.
          + java.util.VectorgetGroups(java.lang.String input, + int options) + +
          +          Returns a Vector of matched groups found in the argument.
          + java.lang.StringgetPattern() + +
          +          Get a String representation of the regexp pattern
          + booleanmatches(java.lang.String argument) + +
          +          Does the given argument match the pattern?
          + booleanmatches(java.lang.String input, + int options) + +
          +          Does the given argument match the pattern?
          + voidsetPattern(java.lang.String pattern) + +
          +          Set the regexp pattern from the String description.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JakartaRegexpMatcher

          +
          +public JakartaRegexpMatcher()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String pattern)
          +
          +
          Set the regexp pattern from the String description. +

          +

          +
          Specified by:
          setPattern in interface RegexpMatcher
          +
          +
          +
          Parameters:
          pattern - the pattern to match
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern()
          +
          +
          Get a String representation of the regexp pattern +

          +

          +
          Specified by:
          getPattern in interface RegexpMatcher
          +
          +
          + +
          Returns:
          the pattern
          +
          +
          +
          + +

          +getCompiledPattern

          +
          +protected org.apache.regexp.RE getCompiledPattern(int options)
+                                           throws BuildException
          +
          +
          Compile the pattern. +

          +

          +
          +
          +
          +
          Parameters:
          options - the ant regexp options +
          Returns:
          a compiled pattern +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String argument)
+                throws BuildException
          +
          +
          Does the given argument match the pattern? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String input,
+                       int options)
+                throws BuildException
          +
          +
          Does the given argument match the pattern? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String argument)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument + using default options. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String input,
+                                  int options)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getCompilerOptions

          +
          +protected int getCompilerOptions(int options)
          +
          +
          Convert the generic options to the regex compiler specific options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the generic options +
          Returns:
          the specific options
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.html new file mode 100644 index 000000000..49842da4d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/JakartaRegexpRegexp.html @@ -0,0 +1,340 @@ + + + + + + +JakartaRegexpRegexp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class JakartaRegexpRegexp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.JakartaRegexpMatcher
+      extended by org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
+
          +
          +
          All Implemented Interfaces:
          Regexp, RegexpMatcher
          +
          +
          +
          +
          public class JakartaRegexpRegexp
          extends JakartaRegexpMatcher
          implements Regexp
          + + +

          +Regular expression implementation using the Jakarta Regexp package +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.Regexp
          REPLACE_ALL, REPLACE_FIRST
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          JakartaRegexpRegexp() + +
          +          Constructor for JakartaRegexpRegexp
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  intgetSubsOptions(int options) + +
          +          Convert ant regexp substitution option to apache regex options.
          + java.lang.Stringsubstitute(java.lang.String input, + java.lang.String argument, + int options) + +
          +          Perform a substitution on the regular expression.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.regexp.JakartaRegexpMatcher
          getCompiledPattern, getCompilerOptions, getGroups, getGroups, getPattern, matches, matches, setPattern
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          getGroups, getGroups, getPattern, matches, matches, setPattern
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JakartaRegexpRegexp

          +
          +public JakartaRegexpRegexp()
          +
          +
          Constructor for JakartaRegexpRegexp +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getSubsOptions

          +
          +protected int getSubsOptions(int options)
          +
          +
          Convert ant regexp substitution option to apache regex options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the ant regexp options +
          Returns:
          the apache regex substition options
          +
          +
          +
          + +

          +substitute

          +
          +public java.lang.String substitute(java.lang.String input,
+                                   java.lang.String argument,
+                                   int options)
+                            throws BuildException
          +
          +
          Perform a substitution on the regular expression. +

          +

          +
          Specified by:
          substitute in interface Regexp
          +
          +
          +
          Parameters:
          input - The string to substitute on
          argument - The string which defines the substitution
          options - The list of options for the match and replace. +
          Returns:
          the result of the operation +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpMatcher.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpMatcher.html new file mode 100644 index 000000000..79e3f837d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpMatcher.html @@ -0,0 +1,487 @@ + + + + + + +Jdk14RegexpMatcher (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class Jdk14RegexpMatcher

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher
+
          +
          +
          All Implemented Interfaces:
          RegexpMatcher
          +
          +
          +
          Direct Known Subclasses:
          Jdk14RegexpRegexp
          +
          +
          +
          +
          public class Jdk14RegexpMatcher
          extends java.lang.Object
          implements RegexpMatcher
          + + +

          +Implementation of RegexpMatcher for the built-in regexp matcher of + JDK 1.4. UNIX_LINES option is enabled as a default. +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          Jdk14RegexpMatcher() + +
          +          Constructor for JakartaOroRegexp
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  java.util.regex.PatterngetCompiledPattern(int options) + +
          +          Get a compiled representation of the regexp pattern
          +protected  intgetCompilerOptions(int options) + +
          +          Convert the generic options to the regex compiler specific options.
          + java.util.VectorgetGroups(java.lang.String argument) + +
          +          Returns a Vector of matched groups found in the argument + using default options.
          + java.util.VectorgetGroups(java.lang.String input, + int options) + +
          +          Returns a Vector of matched groups found in the argument.
          + java.lang.StringgetPattern() + +
          +          Get a String representation of the regexp pattern
          + booleanmatches(java.lang.String argument) + +
          +          Does the given argument match the pattern using default options?
          + booleanmatches(java.lang.String input, + int options) + +
          +          Does the given argument match the pattern?
          + voidsetPattern(java.lang.String pattern) + +
          +          Set the regexp pattern from the String description.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Jdk14RegexpMatcher

          +
          +public Jdk14RegexpMatcher()
          +
          +
          Constructor for JakartaOroRegexp +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +setPattern

          +
          +public void setPattern(java.lang.String pattern)
          +
          +
          Set the regexp pattern from the String description. +

          +

          +
          Specified by:
          setPattern in interface RegexpMatcher
          +
          +
          +
          Parameters:
          pattern - the pattern to match
          +
          +
          +
          + +

          +getPattern

          +
          +public java.lang.String getPattern()
          +
          +
          Get a String representation of the regexp pattern +

          +

          +
          Specified by:
          getPattern in interface RegexpMatcher
          +
          +
          + +
          Returns:
          the pattern +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getCompiledPattern

          +
          +protected java.util.regex.Pattern getCompiledPattern(int options)
+                                              throws BuildException
          +
          +
          Get a compiled representation of the regexp pattern +

          +

          +
          +
          +
          +
          Parameters:
          options - the options +
          Returns:
          the compiled pattern +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String argument)
+                throws BuildException
          +
          +
          Does the given argument match the pattern using default options? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +public boolean matches(java.lang.String input,
+                       int options)
+                throws BuildException
          +
          +
          Does the given argument match the pattern? +

          +

          +
          Specified by:
          matches in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String argument)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument + using default options. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          argument - the string to match against +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +public java.util.Vector getGroups(java.lang.String input,
+                                  int options)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Specified by:
          getGroups in interface RegexpMatcher
          +
          +
          +
          Parameters:
          input - the string to match against
          options - the regex options to use +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getCompilerOptions

          +
          +protected int getCompilerOptions(int options)
          +
          +
          Convert the generic options to the regex compiler specific options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the generic options +
          Returns:
          the specific options
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.html new file mode 100644 index 000000000..8d94140a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Jdk14RegexpRegexp.html @@ -0,0 +1,340 @@ + + + + + + +Jdk14RegexpRegexp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class Jdk14RegexpRegexp

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher
+      extended by org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp
+
          +
          +
          All Implemented Interfaces:
          Regexp, RegexpMatcher
          +
          +
          +
          +
          public class Jdk14RegexpRegexp
          extends Jdk14RegexpMatcher
          implements Regexp
          + + +

          +Regular expression implementation using the JDK 1.4 regular expression package +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.Regexp
          REPLACE_ALL, REPLACE_FIRST
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + +
          +Constructor Summary
          Jdk14RegexpRegexp() + +
          +          Constructor for Jdk14RegexpRegexp
          +  + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  intgetSubsOptions(int options) + +
          +          Convert ant regexp substitution option to jdk1.4 options.
          + java.lang.Stringsubstitute(java.lang.String input, + java.lang.String argument, + int options) + +
          +          Perform a substitution on the regular expression.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.regexp.Jdk14RegexpMatcher
          getCompiledPattern, getCompilerOptions, getGroups, getGroups, getPattern, matches, matches, setPattern
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          getGroups, getGroups, getPattern, matches, matches, setPattern
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +Jdk14RegexpRegexp

          +
          +public Jdk14RegexpRegexp()
          +
          +
          Constructor for Jdk14RegexpRegexp +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getSubsOptions

          +
          +protected int getSubsOptions(int options)
          +
          +
          Convert ant regexp substitution option to jdk1.4 options. +

          +

          +
          +
          +
          +
          Parameters:
          options - the ant regexp options +
          Returns:
          the jdk14 substition options
          +
          +
          +
          + +

          +substitute

          +
          +public java.lang.String substitute(java.lang.String input,
+                                   java.lang.String argument,
+                                   int options)
+                            throws BuildException
          +
          +
          Perform a substitution on the regular expression. +

          +

          +
          Specified by:
          substitute in interface Regexp
          +
          +
          +
          Parameters:
          input - The string to substitute on
          argument - The string which defines the substitution
          options - The list of options for the match and replace. +
          Returns:
          the result of the operation +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Regexp.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Regexp.html new file mode 100644 index 000000000..00826a85b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/Regexp.html @@ -0,0 +1,302 @@ + + + + + + +Regexp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Interface Regexp

          +
          +
          All Superinterfaces:
          RegexpMatcher
          +
          +
          +
          All Known Implementing Classes:
          JakartaOroRegexp, JakartaRegexpRegexp, Jdk14RegexpRegexp
          +
          +
          +
          +
          public interface Regexp
          extends RegexpMatcher
          + + +

          +Interface which represents a regular expression, and the operations + that can be performed on it. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static intREPLACE_ALL + +
          +          Replace all occurrences of the regular expression
          +static intREPLACE_FIRST + +
          +          Replace only the first occurrence of the regular expression
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.Stringsubstitute(java.lang.String input, + java.lang.String argument, + int options) + +
          +          Perform a substitution on the regular expression.
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher
          getGroups, getGroups, getPattern, matches, matches, setPattern
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +REPLACE_FIRST

          +
          +static final int REPLACE_FIRST
          +
          +
          Replace only the first occurrence of the regular expression +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +REPLACE_ALL

          +
          +static final int REPLACE_ALL
          +
          +
          Replace all occurrences of the regular expression +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +substitute

          +
          +java.lang.String substitute(java.lang.String input,
+                            java.lang.String argument,
+                            int options)
+                            throws BuildException
          +
          +
          Perform a substitution on the regular expression. +

          +

          +
          +
          +
          +
          Parameters:
          input - The string to substitute on
          argument - The string which defines the substitution
          options - The list of options for the match and replace. See the + MATCH_ and REPLACE_ constants above. +
          Returns:
          the result of the operation +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpFactory.html new file mode 100644 index 000000000..ae22fb9a9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpFactory.html @@ -0,0 +1,325 @@ + + + + + + +RegexpFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class RegexpFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.RegexpMatcherFactory
+      extended by org.apache.tools.ant.util.regexp.RegexpFactory
+
          +
          +
          +
          public class RegexpFactory
          extends RegexpMatcherFactory
          + + +

          +Regular expression factory, which will create Regexp objects. The + actual implementation class depends on the System or Ant Property: + ant.regexp.regexpimpl. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          RegexpFactory() + +
          +          Constructor for RegexpFactory
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  RegexpcreateRegexpInstance(java.lang.String classname) + +
          +          Wrapper over RegexpMatcherFactory.createInstance that ensures that + we are dealing with a Regexp implementation.
          + RegexpnewRegexp() + +
          +          Create a new regular expression matcher instance.
          + RegexpnewRegexp(Project p) + +
          +          Create a new regular expression matcher instance.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.ant.util.regexp.RegexpMatcherFactory
          createInstance, newRegexpMatcher, newRegexpMatcher, regexpMatcherPresent, testAvailability
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RegexpFactory

          +
          +public RegexpFactory()
          +
          +
          Constructor for RegexpFactory +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +newRegexp

          +
          +public Regexp newRegexp()
+                 throws BuildException
          +
          +
          Create a new regular expression matcher instance. +

          +

          + +
          Returns:
          the matcher instance +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +newRegexp

          +
          +public Regexp newRegexp(Project p)
+                 throws BuildException
          +
          +
          Create a new regular expression matcher instance. +

          +

          +
          Parameters:
          p - Project whose ant.regexp.regexpimpl property will be used. +
          Returns:
          the matcher instance +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +createRegexpInstance

          +
          +protected Regexp createRegexpInstance(java.lang.String classname)
+                               throws BuildException
          +
          +
          Wrapper over RegexpMatcherFactory.createInstance that ensures that + we are dealing with a Regexp implementation. +

          +

          +
          Parameters:
          classname - the name of the class to use. +
          Returns:
          the instance. +
          Throws: +
          BuildException - if there is a problem.
          Since:
          +
          1.3
          +
          See Also:
          RegexpMatcherFactory.createInstance(String)
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcher.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcher.html new file mode 100644 index 000000000..a99c7bb39 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcher.html @@ -0,0 +1,455 @@ + + + + + + +RegexpMatcher (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Interface RegexpMatcher

          +
          +
          All Known Subinterfaces:
          Regexp
          +
          +
          +
          All Known Implementing Classes:
          JakartaOroMatcher, JakartaOroRegexp, JakartaRegexpMatcher, JakartaRegexpRegexp, Jdk14RegexpMatcher, Jdk14RegexpRegexp
          +
          +
          +
          +
          public interface RegexpMatcher
          + + +

          +Interface describing a regular expression matcher. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intMATCH_CASE_INSENSITIVE + +
          +          Perform a case insenstive match
          +static intMATCH_DEFAULT + +
          +          Default Mask (case insensitive, neither multiline nor + singleline specified).
          +static intMATCH_MULTILINE + +
          +          Treat the input as a multiline input
          +static intMATCH_SINGLELINE + +
          +          Treat the input as singleline input ('.' matches newline)
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.util.VectorgetGroups(java.lang.String argument) + +
          +          Returns a Vector of matched groups found in the argument + using default options.
          + java.util.VectorgetGroups(java.lang.String input, + int options) + +
          +          Get the match groups from this regular expression.
          + java.lang.StringgetPattern() + +
          +          Get a String representation of the regexp pattern
          + booleanmatches(java.lang.String argument) + +
          +          Does the given argument match the pattern?
          + booleanmatches(java.lang.String input, + int options) + +
          +          Does this regular expression match the input, given + certain options
          + voidsetPattern(java.lang.String pattern) + +
          +          Set the regexp pattern from the String description.
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MATCH_DEFAULT

          +
          +static final int MATCH_DEFAULT
          +
          +
          Default Mask (case insensitive, neither multiline nor + singleline specified). +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MATCH_CASE_INSENSITIVE

          +
          +static final int MATCH_CASE_INSENSITIVE
          +
          +
          Perform a case insenstive match +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MATCH_MULTILINE

          +
          +static final int MATCH_MULTILINE
          +
          +
          Treat the input as a multiline input +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MATCH_SINGLELINE

          +
          +static final int MATCH_SINGLELINE
          +
          +
          Treat the input as singleline input ('.' matches newline) +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setPattern

          +
          +void setPattern(java.lang.String pattern)
+                throws BuildException
          +
          +
          Set the regexp pattern from the String description. +

          +

          +
          Parameters:
          pattern - the pattern to match +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getPattern

          +
          +java.lang.String getPattern()
+                            throws BuildException
          +
          +
          Get a String representation of the regexp pattern +

          +

          + +
          Returns:
          the pattern +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +boolean matches(java.lang.String argument)
+                throws BuildException
          +
          +
          Does the given argument match the pattern? +

          +

          +
          Parameters:
          argument - the string to match against +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +java.util.Vector getGroups(java.lang.String argument)
+                           throws BuildException
          +
          +
          Returns a Vector of matched groups found in the argument + using default options. + +

          Group 0 will be the full match, the rest are the + parenthesized subexpressions

          . +

          +

          +
          Parameters:
          argument - the string to match against +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +matches

          +
          +boolean matches(java.lang.String input,
+                int options)
+                throws BuildException
          +
          +
          Does this regular expression match the input, given + certain options +

          +

          +
          Parameters:
          input - The string to check for a match
          options - The list of options for the match. See the + MATCH_ constants above. +
          Returns:
          true if the pattern matches +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +getGroups

          +
          +java.util.Vector getGroups(java.lang.String input,
+                           int options)
+                           throws BuildException
          +
          +
          Get the match groups from this regular expression. The return + type of the elements is always String. +

          +

          +
          Parameters:
          input - The string to check for a match
          options - The list of options for the match. See the + MATCH_ constants above. +
          Returns:
          the vector of groups +
          Throws: +
          BuildException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.html new file mode 100644 index 000000000..c4560f94b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpMatcherFactory.html @@ -0,0 +1,363 @@ + + + + + + +RegexpMatcherFactory (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class RegexpMatcherFactory

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.RegexpMatcherFactory
+
          +
          +
          Direct Known Subclasses:
          RegexpFactory
          +
          +
          +
          +
          public class RegexpMatcherFactory
          extends java.lang.Object
          + + +

          +Simple Factory Class that produces an implementation of RegexpMatcher based on the system + property ant.regexp.regexpimpl and the classes available. + +

          + In a more general framework this class would be abstract and have a static newInstance method. +

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          RegexpMatcherFactory() + +
          +          Constructor for RegexpMatcherFactory.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected  RegexpMatchercreateInstance(java.lang.String className) + +
          +          Create an instance of a matcher from a classname.
          + RegexpMatchernewRegexpMatcher() + +
          +          Create a new regular expression instance.
          + RegexpMatchernewRegexpMatcher(Project p) + +
          +          Create a new regular expression instance.
          +static booleanregexpMatcherPresent(Project project) + +
          +          Checks if a RegExp-Matcher is available.
          +protected  voidtestAvailability(java.lang.String className) + +
          +          Test if a particular class is available to be used.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RegexpMatcherFactory

          +
          +public RegexpMatcherFactory()
          +
          +
          Constructor for RegexpMatcherFactory. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +newRegexpMatcher

          +
          +public RegexpMatcher newRegexpMatcher()
+                               throws BuildException
          +
          +
          Create a new regular expression instance. +

          +

          + +
          Returns:
          the matcher +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +newRegexpMatcher

          +
          +public RegexpMatcher newRegexpMatcher(Project p)
+                               throws BuildException
          +
          +
          Create a new regular expression instance. +

          +

          +
          Parameters:
          p - Project whose ant.regexp.regexpimpl property will be used. +
          Returns:
          the matcher +
          Throws: +
          BuildException - on error
          +
          +
          +
          + +

          +createInstance

          +
          +protected RegexpMatcher createInstance(java.lang.String className)
+                                throws BuildException
          +
          +
          Create an instance of a matcher from a classname. +

          +

          +
          Parameters:
          className - a String value +
          Returns:
          a RegexpMatcher value +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +testAvailability

          +
          +protected void testAvailability(java.lang.String className)
+                         throws BuildException
          +
          +
          Test if a particular class is available to be used. +

          +

          +
          Parameters:
          className - a String value +
          Throws: +
          BuildException - if an error occurs
          +
          +
          +
          + +

          +regexpMatcherPresent

          +
          +public static boolean regexpMatcherPresent(Project project)
          +
          +
          Checks if a RegExp-Matcher is available. +

          +

          +
          Parameters:
          project - The project to check for (may be null) +
          Returns:
          true if available otherwise false
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpUtil.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpUtil.html new file mode 100644 index 000000000..277ed27d8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/RegexpUtil.html @@ -0,0 +1,368 @@ + + + + + + +RegexpUtil (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.ant.util.regexp +
          +Class RegexpUtil

          +
          +java.lang.Object
+  extended by org.apache.tools.ant.util.regexp.RegexpUtil
+
          +
          +
          +
          public class RegexpUtil
          extends java.lang.Object
          + + +

          +Regular expression utilities class which handles flag operations. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          RegexpUtil() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static intasOptions(boolean caseSensitive) + +
          +          Convert flag to regex options.
          +static intasOptions(boolean caseSensitive, + boolean multiLine, + boolean singleLine) + +
          +          Convert flags to regex options.
          +static intasOptions(java.lang.String flags) + +
          +          convert regex option flag characters to regex options + + g - Regexp.REPLACE_ALL + i - RegexpMatcher.MATCH_CASE_INSENSITIVE + m - RegexpMatcher.MATCH_MULTILINE + s - RegexpMatcher.MATCH_SINGLELINE +
          +static booleanhasFlag(int options, + int flag) + +
          +          Check the options has a particular flag set.
          +static intremoveFlag(int options, + int flag) + +
          +          Remove a particular flag from an int value contains the option flags.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +RegexpUtil

          +
          +public RegexpUtil()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +hasFlag

          +
          +public static boolean hasFlag(int options,
+                              int flag)
          +
          +
          Check the options has a particular flag set. +

          +

          +
          Parameters:
          options - an int value
          flag - an int value +
          Returns:
          true if the flag is set
          +
          +
          +
          + +

          +removeFlag

          +
          +public static int removeFlag(int options,
+                             int flag)
          +
          +
          Remove a particular flag from an int value contains the option flags. +

          +

          +
          Parameters:
          options - an int value
          flag - an int value +
          Returns:
          the options with the flag unset
          +
          +
          +
          + +

          +asOptions

          +
          +public static int asOptions(java.lang.String flags)
          +
          +
          convert regex option flag characters to regex options +
          +
        5. g - Regexp.REPLACE_ALL
          6. +
        6. i - RegexpMatcher.MATCH_CASE_INSENSITIVE
          7. +
        7. m - RegexpMatcher.MATCH_MULTILINE
          8. +
        8. s - RegexpMatcher.MATCH_SINGLELINE
          9. +
          +

          +

          +
          Parameters:
          flags - the string containing the flags +
          Returns:
          the Regexp option bits
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +asOptions

          +
          +public static int asOptions(boolean caseSensitive)
          +
          +
          Convert flag to regex options. +

          +

          +
          Parameters:
          caseSensitive - opposite of RegexpMatcher.MATCH_CASE_INSENSITIVE +
          Returns:
          the Regexp option bits
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          +
          + +

          +asOptions

          +
          +public static int asOptions(boolean caseSensitive,
+                            boolean multiLine,
+                            boolean singleLine)
          +
          +
          Convert flags to regex options. +

          +

          +
          Parameters:
          caseSensitive - opposite of RegexpMatcher.MATCH_CASE_INSENSITIVE
          multiLine - RegexpMatcher.MATCH_MULTILINE
          singleLine - RegexpMatcher.MATCH_SINGLELINE +
          Returns:
          the Regexp option bits
          Since:
          +
          Ant 1.8.2
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-frame.html new file mode 100644 index 000000000..c494aade6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-frame.html @@ -0,0 +1,61 @@ + + + + + + +org.apache.tools.ant.util.regexp (Apache Ant API) + + + + + + + + + + + +org.apache.tools.ant.util.regexp + + + + +
          +Interfaces  + +
          +Regexp +
          +RegexpMatcher
          + + + + + + +
          +Classes  + +
          +JakartaOroMatcher +
          +JakartaOroRegexp +
          +JakartaRegexpMatcher +
          +JakartaRegexpRegexp +
          +Jdk14RegexpMatcher +
          +Jdk14RegexpRegexp +
          +RegexpFactory +
          +RegexpMatcherFactory +
          +RegexpUtil
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-summary.html new file mode 100644 index 000000000..d94b8291f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-summary.html @@ -0,0 +1,205 @@ + + + + + + +org.apache.tools.ant.util.regexp (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.ant.util.regexp +

          + + + + + + + + + + + + + +
          +Interface Summary
          RegexpInterface which represents a regular expression, and the operations + that can be performed on it.
          RegexpMatcherInterface describing a regular expression matcher.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          JakartaOroMatcherImplementation of RegexpMatcher for Jakarta-ORO.
          JakartaOroRegexpRegular expression implementation using the Jakarta Oro package
          JakartaRegexpMatcherImplementation of RegexpMatcher for Jakarta-Regexp.
          JakartaRegexpRegexpRegular expression implementation using the Jakarta Regexp package
          Jdk14RegexpMatcherImplementation of RegexpMatcher for the built-in regexp matcher of + JDK 1.4.
          Jdk14RegexpRegexpRegular expression implementation using the JDK 1.4 regular expression package
          RegexpFactoryRegular expression factory, which will create Regexp objects.
          RegexpMatcherFactorySimple Factory Class that produces an implementation of RegexpMatcher based on the system + property ant.regexp.regexpimpl and the classes available.
          RegexpUtilRegular expression utilities class which handles flag operations.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-tree.html new file mode 100644 index 000000000..b5edad0f0 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/ant/util/regexp/package-tree.html @@ -0,0 +1,168 @@ + + + + + + +org.apache.tools.ant.util.regexp Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.ant.util.regexp +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/BZip2Constants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/BZip2Constants.html new file mode 100644 index 000000000..78ddc4be1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/BZip2Constants.html @@ -0,0 +1,397 @@ + + + + + + +BZip2Constants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.bzip2 +
          +Interface BZip2Constants

          +
          +
          All Known Implementing Classes:
          CBZip2InputStream, CBZip2OutputStream
          +
          +
          +
          +
          public interface BZip2Constants
          + + +

          +Base class for both the compress and decompress classes. + Holds common arrays, and static data. +

          + This interface is public for historical purposes. + You should have no need to use it. +

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intbaseBlockSize + +
          +           
          +static intG_SIZE + +
          +           
          +static intMAX_ALPHA_SIZE + +
          +           
          +static intMAX_CODE_LEN + +
          +           
          +static intMAX_SELECTORS + +
          +           
          +static intN_GROUPS + +
          +           
          +static intN_ITERS + +
          +           
          +static intNUM_OVERSHOOT_BYTES + +
          +           
          +static int[]rNums + +
          +          This array really shouldn't be here.
          +static intRUNA + +
          +           
          +static intRUNB + +
          +           
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +baseBlockSize

          +
          +static final int baseBlockSize
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAX_ALPHA_SIZE

          +
          +static final int MAX_ALPHA_SIZE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAX_CODE_LEN

          +
          +static final int MAX_CODE_LEN
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RUNA

          +
          +static final int RUNA
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +RUNB

          +
          +static final int RUNB
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +N_GROUPS

          +
          +static final int N_GROUPS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +G_SIZE

          +
          +static final int G_SIZE
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +N_ITERS

          +
          +static final int N_ITERS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAX_SELECTORS

          +
          +static final int MAX_SELECTORS
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +NUM_OVERSHOOT_BYTES

          +
          +static final int NUM_OVERSHOOT_BYTES
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +rNums

          +
          +static final int[] rNums
          +
          +
          This array really shouldn't be here. + Again, for historical purposes it is. + +

          FIXME: This array should be in a private or package private + location, since it could be modified by malicious code.

          +

          +

          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2InputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2InputStream.html new file mode 100644 index 000000000..62f028f13 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2InputStream.html @@ -0,0 +1,370 @@ + + + + + + +CBZip2InputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.bzip2 +
          +Class CBZip2InputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by org.apache.tools.bzip2.CBZip2InputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, BZip2Constants
          +
          +
          +
          +
          public class CBZip2InputStream
          extends java.io.InputStream
          implements BZip2Constants
          + + +

          +An input stream that decompresses from the BZip2 format (without the file + header chars) to be read as any other stream. + +

          The decompression requires large amounts of memory. Thus you + should call the close() method as soon as + possible, to force CBZip2InputStream to release the + allocated memory. See CBZip2OutputStream for information about memory usage.

          + +

          CBZip2InputStream reads bytes from the compressed + source stream via the single byte read() method exclusively. Thus you should consider to use a + buffered source stream.

          + +

          Instances of this class are not threadsafe.

          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.bzip2.BZip2Constants
          baseBlockSize, G_SIZE, MAX_ALPHA_SIZE, MAX_CODE_LEN, MAX_SELECTORS, N_GROUPS, N_ITERS, NUM_OVERSHOOT_BYTES, rNums, RUNA, RUNB
          +  + + + + + + + + + + +
          +Constructor Summary
          CBZip2InputStream(java.io.InputStream in) + +
          +          Constructs a new CBZip2InputStream which decompresses bytes read from + the specified stream.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +           
          + intread() + +
          +           
          + intread(byte[] dest, + int offs, + int len) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.io.InputStream
          available, mark, markSupported, read, reset, skip
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +CBZip2InputStream

          +
          +public CBZip2InputStream(java.io.InputStream in)
+                  throws java.io.IOException
          +
          +
          Constructs a new CBZip2InputStream which decompresses bytes read from + the specified stream. + +

          Although BZip2 headers are marked with the magic + "Bz" this constructor expects the next byte in the + stream to be the first one after the magic. Thus callers have + to skip the first two bytes. Otherwise this constructor will + throw an exception.

          +

          +

          + +
          Throws: +
          java.io.IOException - if the stream content is malformed or an I/O error occurs. +
          java.lang.NullPointerException - if in == null
          +
          + + + + + + + + +
          +Method Detail
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          +
          Specified by:
          read in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +read

          +
          +public int read(byte[] dest,
+                int offs,
+                int len)
+         throws java.io.IOException
          +
          +
          +
          Overrides:
          read in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.InputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2OutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2OutputStream.html new file mode 100644 index 000000000..730993af3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/CBZip2OutputStream.html @@ -0,0 +1,886 @@ + + + + + + +CBZip2OutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.bzip2 +
          +Class CBZip2OutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by org.apache.tools.bzip2.CBZip2OutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable, BZip2Constants
          +
          +
          +
          +
          public class CBZip2OutputStream
          extends java.io.OutputStream
          implements BZip2Constants
          + + +

          +An output stream that compresses into the BZip2 format (without the file + header chars) into another stream. + +

          + The compression requires large amounts of memory. Thus you should call the + close() method as soon as possible, to force + CBZip2OutputStream to release the allocated memory. +

          + +

          You can shrink the amount of allocated memory and maybe raise + the compression speed by choosing a lower blocksize, which in turn + may cause a lower compression ratio. You can avoid unnecessary + memory allocation by avoiding using a blocksize which is bigger + than the size of the input.

          + +

          You can compute the memory usage for compressing by the + following formula:

          + + 
          + <code>400k + (9 * blocksize)</code>.
+
          + +

          To get the memory required for decompression by CBZip2InputStream use

          + + 
          + <code>65k + (5 * blocksize)</code>.
+
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Memory usage by blocksize
          Blocksize Compression
          + memory usage          		 Decompression
          + memory usage
          100k1300k565k
          200k2200k1065k
          300k3100k1565k
          400k4000k2065k
          500k4900k2565k
          600k5800k3065k
          700k6700k3565k
          800k7600k4065k
          900k8500k4565k
          + +

          + For decompression CBZip2InputStream allocates less memory if the + bzipped input is smaller than one block. +

          + +

          + Instances of this class are not threadsafe. +

          + +

          + TODO: Update to BZip2 1.0.1 +

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected static intCLEARMASK + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intDEPTH_THRESH + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intGREATER_ICOST + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intLESSER_ICOST + +
          +          This constant is accessible by subclasses for historical + purposes.
          +static intMAX_BLOCKSIZE + +
          +          The maximum supported blocksize == 9.
          +static intMIN_BLOCKSIZE + +
          +          The minimum supported blocksize == 1.
          +protected static intQSORT_STACK_SIZE + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intSETMASK + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intSMALL_THRESH + +
          +          This constant is accessible by subclasses for historical + purposes.
          +protected static intWORK_FACTOR + +
          +          This constant is accessible by subclasses for historical + purposes.
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.bzip2.BZip2Constants
          baseBlockSize, G_SIZE, MAX_ALPHA_SIZE, MAX_CODE_LEN, MAX_SELECTORS, N_GROUPS, N_ITERS, NUM_OVERSHOOT_BYTES, rNums, RUNA, RUNB
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          CBZip2OutputStream(java.io.OutputStream out) + +
          +          Constructs a new CBZip2OutputStream with a blocksize of 900k.
          CBZip2OutputStream(java.io.OutputStream out, + int blockSize) + +
          +          Constructs a new CBZip2OutputStream with specified blocksize.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static intchooseBlockSize(long inputLength) + +
          +          Chooses a blocksize based on the given length of the data to compress.
          + voidclose() + +
          +           
          +protected  voidfinalize() + +
          +          Overriden to close the stream.
          + voidfinish() + +
          +           
          + voidflush() + +
          +           
          + intgetBlockSize() + +
          +          Returns the blocksize parameter specified at construction time.
          +protected static voidhbMakeCodeLengths(char[] len, + int[] freq, + int alphaSize, + int maxLen) + +
          +          This method is accessible by subclasses for historical + purposes.
          + voidwrite(byte[] buf, + int offs, + int len) + +
          +           
          + voidwrite(int b) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.io.OutputStream
          write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MIN_BLOCKSIZE

          +
          +public static final int MIN_BLOCKSIZE
          +
          +
          The minimum supported blocksize == 1. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAX_BLOCKSIZE

          +
          +public static final int MAX_BLOCKSIZE
          +
          +
          The maximum supported blocksize == 9. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SETMASK

          +
          +protected static final int SETMASK
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CLEARMASK

          +
          +protected static final int CLEARMASK
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GREATER_ICOST

          +
          +protected static final int GREATER_ICOST
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LESSER_ICOST

          +
          +protected static final int LESSER_ICOST
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SMALL_THRESH

          +
          +protected static final int SMALL_THRESH
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEPTH_THRESH

          +
          +protected static final int DEPTH_THRESH
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +WORK_FACTOR

          +
          +protected static final int WORK_FACTOR
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +QSORT_STACK_SIZE

          +
          +protected static final int QSORT_STACK_SIZE
          +
          +
          This constant is accessible by subclasses for historical + purposes. If you don't know what it means then you don't need + it. +

          If you are ever unlucky/improbable enough to get a stack + overflow whilst sorting, increase the following constant and + try again. In practice I have never seen the stack go above 27 + elems, so the following limit seems very generous.

          +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +CBZip2OutputStream

          +
          +public CBZip2OutputStream(java.io.OutputStream out)
+                   throws java.io.IOException
          +
          +
          Constructs a new CBZip2OutputStream with a blocksize of 900k. + +

          + Attention: The caller is resonsible to write the two BZip2 magic + bytes "BZ" to the specified stream prior to calling this + constructor. +

          +

          +

          +
          Parameters:
          out - * + the destination stream. +
          Throws: +
          java.io.IOException - if an I/O error occurs in the specified stream. +
          java.lang.NullPointerException - if out == null.
          +
          +
          + +

          +CBZip2OutputStream

          +
          +public CBZip2OutputStream(java.io.OutputStream out,
+                          int blockSize)
+                   throws java.io.IOException
          +
          +
          Constructs a new CBZip2OutputStream with specified blocksize. + +

          + Attention: The caller is resonsible to write the two BZip2 magic + bytes "BZ" to the specified stream prior to calling this + constructor. +

          +

          +

          +
          Parameters:
          out - the destination stream.
          blockSize - the blockSize as 100k units. +
          Throws: +
          java.io.IOException - if an I/O error occurs in the specified stream. +
          java.lang.IllegalArgumentException - if (blockSize < 1) || (blockSize > 9). +
          java.lang.NullPointerException - if out == null.
          See Also:
          MIN_BLOCKSIZE, +MAX_BLOCKSIZE
          +
          + + + + + + + + +
          +Method Detail
          + +

          +hbMakeCodeLengths

          +
          +protected static void hbMakeCodeLengths(char[] len,
+                                        int[] freq,
+                                        int alphaSize,
+                                        int maxLen)
          +
          +
          This method is accessible by subclasses for historical + purposes. If you don't know what it does then you don't need + it. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +chooseBlockSize

          +
          +public static int chooseBlockSize(long inputLength)
          +
          +
          Chooses a blocksize based on the given length of the data to compress. +

          +

          +
          +
          +
          +
          Parameters:
          inputLength - The length of the data which will be compressed by + CBZip2OutputStream. +
          Returns:
          The blocksize, between MIN_BLOCKSIZE and + MAX_BLOCKSIZE both inclusive. For a negative + inputLength this method returns MAX_BLOCKSIZE + always.
          +
          +
          +
          + +

          +write

          +
          +public void write(int b)
+           throws java.io.IOException
          +
          +
          +
          Specified by:
          write in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +finalize

          +
          +protected void finalize()
+                 throws java.lang.Throwable
          +
          +
          Overriden to close the stream. +

          +

          +
          Overrides:
          finalize in class java.lang.Object
          +
          +
          + +
          Throws: +
          java.lang.Throwable
          +
          +
          +
          + +

          +finish

          +
          +public void finish()
+            throws java.io.IOException
          +
          +
          +
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +flush

          +
          +public void flush()
+           throws java.io.IOException
          +
          +
          +
          Specified by:
          flush in interface java.io.Flushable
          Overrides:
          flush in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          +
          + +

          +getBlockSize

          +
          +public final int getBlockSize()
          +
          +
          Returns the blocksize parameter specified at construction time. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] buf,
+                  int offs,
+                  int len)
+           throws java.io.IOException
          +
          +
          +
          Overrides:
          write in class java.io.OutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-frame.html new file mode 100644 index 000000000..4dcca1c62 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +org.apache.tools.bzip2 (Apache Ant API) + + + + + + + + + + + +org.apache.tools.bzip2 + + + + +
          +Interfaces  + +
          +BZip2Constants
          + + + + + + +
          +Classes  + +
          +CBZip2InputStream +
          +CBZip2OutputStream
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-summary.html new file mode 100644 index 000000000..ef36f9334 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-summary.html @@ -0,0 +1,172 @@ + + + + + + +org.apache.tools.bzip2 (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.bzip2 +

          + + + + + + + + + +
          +Interface Summary
          BZip2ConstantsBase class for both the compress and decompress classes.
          +  + +

          + + + + + + + + + + + + + +
          +Class Summary
          CBZip2InputStreamAn input stream that decompresses from the BZip2 format (without the file + header chars) to be read as any other stream.
          CBZip2OutputStreamAn output stream that compresses into the BZip2 format (without the file + header chars) into another stream.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-tree.html new file mode 100644 index 000000000..bbdfffd5a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/bzip2/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +org.apache.tools.bzip2 Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.bzip2 +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • java.io.InputStream (implements java.io.Closeable) + +
            • java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) + +
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/ErrorInQuitException.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/ErrorInQuitException.html new file mode 100644 index 000000000..685233f2b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/ErrorInQuitException.html @@ -0,0 +1,249 @@ + + + + + + +ErrorInQuitException (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.mail +
          +Class ErrorInQuitException

          +
          +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.apache.tools.mail.ErrorInQuitException
+
          +
          +
          All Implemented Interfaces:
          java.io.Serializable
          +
          +
          +
          +
          public class ErrorInQuitException
          extends java.io.IOException
          + + +

          +Specialized IOException that get thrown if SMPT's QUIT command fails. + +

          This seems to happen with some version of MS Exchange that + doesn't respond with a 221 code immediately. See Bug + report 5273.

          +

          + +

          +

          +
          See Also:
          Serialized Form
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ErrorInQuitException(java.io.IOException e) + +
          +          Initialise from an IOException
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Throwable
          fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ErrorInQuitException

          +
          +public ErrorInQuitException(java.io.IOException e)
          +
          +
          Initialise from an IOException +

          +

          +
          Parameters:
          e - the IO Exception.
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/MailMessage.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/MailMessage.html new file mode 100644 index 000000000..750d576a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/MailMessage.html @@ -0,0 +1,644 @@ + + + + + + +MailMessage (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.mail +
          +Class MailMessage

          +
          +java.lang.Object
+  extended by org.apache.tools.mail.MailMessage
+
          +
          +
          +
          public class MailMessage
          extends java.lang.Object
          + + +

          +A class to help send SMTP email. + This class is an improvement on the sun.net.smtp.SmtpClient class + found in the JDK. This version has extra functionality, and can be used + with JVMs that did not extend from the JDK. It's not as robust as + the JavaMail Standard Extension classes, but it's easier to use and + easier to install, and has an Open Source license. +

          + It can be used like this: + 

          + String mailhost = "localhost";  // or another mail host
+ String from = "Mail Message Servlet <MailMessage@server.com>";
+ String to = "to@you.com";
+ String cc1 = "cc1@you.com";
+ String cc2 = "cc2@you.com";
+ String bcc = "bcc@you.com";
+  
+ MailMessage msg = new MailMessage(mailhost);
+ msg.setPort(25);
+ msg.from(from);
+ msg.to(to);
+ msg.cc(cc1);
+ msg.cc(cc2);
+ msg.bcc(bcc);
+ msg.setSubject("Test subject");
+ PrintStream out = msg.getPrintStream();
+  
+ Enumeration enum = req.getParameterNames();
+ while (enum.hasMoreElements()) {
+   String name = (String)enum.nextElement();
+   String value = req.getParameter(name);
+   out.println(name + " = " + value);
+ }
+  
+ msg.sendAndClose();
+
          +

          + Be sure to set the from address, then set the recepient + addresses, then set the subject and other headers, then get the + PrintStream, then write the message, and finally send and close. + The class does minimal error checking internally; it counts on the mail + host to complain if there's any malformatted input or out of order + execution. +

          + An attachment mechanism based on RFC 1521 could be implemented on top of + this class. In the meanwhile, JavaMail is the best solution for sending + email with attachments. +

          + Still to do: +

            +
          • Figure out how to close the connection in case of error +
          +

          + +

          +

          +
          Version:
          +
          1.1, 2000/03/19, added angle brackets to address, helps some servers + version 1.0, 1999/12/29
          +
          +
          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static java.lang.StringDEFAULT_HOST + +
          +          default mailhost
          +static intDEFAULT_PORT + +
          +          default port for SMTP: 25
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          MailMessage() + +
          +          Constructs a new MailMessage to send an email.
          MailMessage(java.lang.String host) + +
          +          Constructs a new MailMessage to send an email.
          MailMessage(java.lang.String host, + int port) + +
          +          Constructs a new MailMessage to send an email.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidbcc(java.lang.String bcc) + +
          +          Sets the bcc address.
          + voidcc(java.lang.String cc) + +
          +          Sets the cc address.
          + voidfrom(java.lang.String from) + +
          +          Sets the from address.
          + java.io.PrintStreamgetPrintStream() + +
          +          Returns a PrintStream that can be used to write the body of the message.
          + voidreplyto(java.lang.String rto) + +
          +          Sets the replyto address + This method may be + called multiple times.
          + voidsendAndClose() + +
          +          Sends the message and closes the connection to the server.
          + voidsetHeader(java.lang.String name, + java.lang.String value) + +
          +          Sets the named header to the given value.
          + voidsetPort(int port) + +
          +          Set the port to connect to the SMTP host.
          + voidsetSubject(java.lang.String subj) + +
          +          Sets the subject of the mail message.
          + voidto(java.lang.String to) + +
          +          Sets the to address.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_HOST

          +
          +public static final java.lang.String DEFAULT_HOST
          +
          +
          default mailhost +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_PORT

          +
          +public static final int DEFAULT_PORT
          +
          +
          default port for SMTP: 25 +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +MailMessage

          +
          +public MailMessage()
+            throws java.io.IOException
          +
          +
          Constructs a new MailMessage to send an email. + Use localhost as the mail server with port 25. +

          +

          + +
          Throws: +
          java.io.IOException - if there's any problem contacting the mail server
          +
          +
          + +

          +MailMessage

          +
          +public MailMessage(java.lang.String host)
+            throws java.io.IOException
          +
          +
          Constructs a new MailMessage to send an email. + Use the given host as the mail server with port 25. +

          +

          +
          Parameters:
          host - the mail server to use +
          Throws: +
          java.io.IOException - if there's any problem contacting the mail server
          +
          +
          + +

          +MailMessage

          +
          +public MailMessage(java.lang.String host,
+                   int port)
+            throws java.io.IOException
          +
          +
          Constructs a new MailMessage to send an email. + Use the given host and port as the mail server. +

          +

          +
          Parameters:
          host - the mail server to use
          port - the port to connect to +
          Throws: +
          java.io.IOException - if there's any problem contacting the mail server
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setPort

          +
          +public void setPort(int port)
          +
          +
          Set the port to connect to the SMTP host. +

          +

          +
          Parameters:
          port - the port to use for connection.
          See Also:
          DEFAULT_PORT
          +
          +
          +
          + +

          +from

          +
          +public void from(java.lang.String from)
+          throws java.io.IOException
          +
          +
          Sets the from address. Also sets the "From" header. This method should + be called only once. +

          +

          +
          Parameters:
          from - the from address +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          +
          +
          +
          + +

          +replyto

          +
          +public void replyto(java.lang.String rto)
          +
          +
          Sets the replyto address + This method may be + called multiple times. +

          +

          +
          Parameters:
          rto - the replyto address
          +
          +
          +
          + +

          +to

          +
          +public void to(java.lang.String to)
+        throws java.io.IOException
          +
          +
          Sets the to address. Also sets the "To" header. This method may be + called multiple times. +

          +

          +
          Parameters:
          to - the to address +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          +
          +
          +
          + +

          +cc

          +
          +public void cc(java.lang.String cc)
+        throws java.io.IOException
          +
          +
          Sets the cc address. Also sets the "Cc" header. This method may be + called multiple times. +

          +

          +
          Parameters:
          cc - the cc address +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          +
          +
          +
          + +

          +bcc

          +
          +public void bcc(java.lang.String bcc)
+         throws java.io.IOException
          +
          +
          Sets the bcc address. Does NOT set any header since it's a *blind* copy. + This method may be called multiple times. +

          +

          +
          Parameters:
          bcc - the bcc address +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          +
          +
          +
          + +

          +setSubject

          +
          +public void setSubject(java.lang.String subj)
          +
          +
          Sets the subject of the mail message. Actually sets the "Subject" + header. +

          +

          +
          Parameters:
          subj - the subject of the mail message
          +
          +
          +
          + +

          +setHeader

          +
          +public void setHeader(java.lang.String name,
+                      java.lang.String value)
          +
          +
          Sets the named header to the given value. RFC 822 provides the rules for + what text may constitute a header name and value. +

          +

          +
          Parameters:
          name - name of the header
          value - contents of the header
          +
          +
          +
          + +

          +getPrintStream

          +
          +public java.io.PrintStream getPrintStream()
+                                   throws java.io.IOException
          +
          +
          Returns a PrintStream that can be used to write the body of the message. + A stream is used since email bodies are byte-oriented. A writer can + be wrapped on top if necessary for internationalization. + This is actually done in Message.java +

          +

          + +
          Returns:
          a printstream containing the data and the headers of the email +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          See Also:
          Message
          +
          +
          +
          + +

          +sendAndClose

          +
          +public void sendAndClose()
+                  throws java.io.IOException
          +
          +
          Sends the message and closes the connection to the server. + The MailMessage object cannot be reused. +

          +

          + +
          Throws: +
          java.io.IOException - if there's any problem reported by the mail server
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/SmtpResponseReader.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/SmtpResponseReader.html new file mode 100644 index 000000000..4006b5f64 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/SmtpResponseReader.html @@ -0,0 +1,349 @@ + + + + + + +SmtpResponseReader (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.mail +
          +Class SmtpResponseReader

          +
          +java.lang.Object
+  extended by org.apache.tools.mail.SmtpResponseReader
+
          +
          +
          +
          public class SmtpResponseReader
          extends java.lang.Object
          + + +

          +A wrapper around the raw input from the SMTP server that assembles + multi line responses into a single String. + +

          The same rules used here would apply to FTP and other Telnet + based protocols as well.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +protected  java.io.BufferedReaderreader + +
          +           
          +  + + + + + + + + + + +
          +Constructor Summary
          SmtpResponseReader(java.io.InputStream in) + +
          +          Wrap this input stream.
          +  + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Closes the underlying stream.
          + java.lang.StringgetResponse() + +
          +          Read until the server indicates that the response is complete.
          +protected  booleanhasMoreLines(java.lang.String line) + +
          +          Should we expect more input?
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +reader

          +
          +protected java.io.BufferedReader reader
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +SmtpResponseReader

          +
          +public SmtpResponseReader(java.io.InputStream in)
          +
          +
          Wrap this input stream. +

          +

          +
          Parameters:
          in - the stream to wrap.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getResponse

          +
          +public java.lang.String getResponse()
+                             throws java.io.IOException
          +
          +
          Read until the server indicates that the response is complete. +

          +

          + +
          Returns:
          Responsecode (3 digits) + Blank + Text from all + response line concatenated (with blanks replacing the \r\n + sequences). +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Closes the underlying stream. +

          +

          + +
          Throws: +
          java.io.IOException - on error.
          +
          +
          +
          + +

          +hasMoreLines

          +
          +protected boolean hasMoreLines(java.lang.String line)
          +
          +
          Should we expect more input? +

          +

          +
          Parameters:
          line - the line to check. +
          Returns:
          true if there are more lines to check.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-frame.html new file mode 100644 index 000000000..f00693ba8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-frame.html @@ -0,0 +1,45 @@ + + + + + + +org.apache.tools.mail (Apache Ant API) + + + + + + + + + + + +org.apache.tools.mail + + + + +
          +Classes  + +
          +MailMessage +
          +SmtpResponseReader
          + + + + + + +
          +Exceptions  + +
          +ErrorInQuitException
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-summary.html new file mode 100644 index 000000000..db94b445c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-summary.html @@ -0,0 +1,171 @@ + + + + + + +org.apache.tools.mail (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.mail +

          + + + + + + + + + + + + + +
          +Class Summary
          MailMessageA class to help send SMTP email.
          SmtpResponseReaderA wrapper around the raw input from the SMTP server that assembles + multi line responses into a single String.
          +  + +

          + + + + + + + + + +
          +Exception Summary
          ErrorInQuitExceptionSpecialized IOException that get thrown if SMPT's QUIT command fails.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-tree.html new file mode 100644 index 000000000..62dc32dcd --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/mail/package-tree.html @@ -0,0 +1,154 @@ + + + + + + +org.apache.tools.mail Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.mail +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarBuffer.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarBuffer.html new file mode 100644 index 000000000..6e718378c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarBuffer.html @@ -0,0 +1,664 @@ + + + + + + +TarBuffer (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Class TarBuffer

          +
          +java.lang.Object
+  extended by org.apache.tools.tar.TarBuffer
+
          +
          +
          +
          public class TarBuffer
          extends java.lang.Object
          + + +

          +The TarBuffer class implements the tar archive concept + of a buffered input stream. This concept goes back to the + days of blocked tape drives and special io devices. In the + Java universe, the only real function that this class + performs is to ensure that files have the correct "block" + size, or other tars will complain. +

          + You should never have a need to access this class directly. + TarBuffers are created by Tar IO Streams. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + +
          +Field Summary
          +static intDEFAULT_BLKSIZE + +
          +          Default block size
          +static intDEFAULT_RCDSIZE + +
          +          Default record size
          +  + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          TarBuffer(java.io.InputStream inStream) + +
          +          Constructor for a TarBuffer on an input stream.
          TarBuffer(java.io.InputStream inStream, + int blockSize) + +
          +          Constructor for a TarBuffer on an input stream.
          TarBuffer(java.io.InputStream inStream, + int blockSize, + int recordSize) + +
          +          Constructor for a TarBuffer on an input stream.
          TarBuffer(java.io.OutputStream outStream) + +
          +          Constructor for a TarBuffer on an output stream.
          TarBuffer(java.io.OutputStream outStream, + int blockSize) + +
          +          Constructor for a TarBuffer on an output stream.
          TarBuffer(java.io.OutputStream outStream, + int blockSize, + int recordSize) + +
          +          Constructor for a TarBuffer on an output stream.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Close the TarBuffer.
          + intgetBlockSize() + +
          +          Get the TAR Buffer's block size.
          + intgetCurrentBlockNum() + +
          +          Get the current block number, zero based.
          + intgetCurrentRecordNum() + +
          +          Get the current record number, within the current block, zero based.
          + intgetRecordSize() + +
          +          Get the TAR Buffer's record size.
          + booleanisEOFRecord(byte[] record) + +
          +          Determine if an archive record indicate End of Archive.
          + byte[]readRecord() + +
          +          Read a record from the input stream and return the data.
          + voidsetDebug(boolean debug) + +
          +          Set the debugging flag for the buffer.
          + voidskipRecord() + +
          +          Skip over a record on the input stream.
          + voidwriteRecord(byte[] record) + +
          +          Write an archive record to the archive.
          + voidwriteRecord(byte[] buf, + int offset) + +
          +          Write an archive record to the archive, where the record may be + inside of a larger array buffer.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFAULT_RCDSIZE

          +
          +public static final int DEFAULT_RCDSIZE
          +
          +
          Default record size +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_BLKSIZE

          +
          +public static final int DEFAULT_BLKSIZE
          +
          +
          Default block size +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.InputStream inStream)
          +
          +
          Constructor for a TarBuffer on an input stream. +

          +

          +
          Parameters:
          inStream - the input stream to use
          +
          +
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.InputStream inStream,
+                 int blockSize)
          +
          +
          Constructor for a TarBuffer on an input stream. +

          +

          +
          Parameters:
          inStream - the input stream to use
          blockSize - the block size to use
          +
          +
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.InputStream inStream,
+                 int blockSize,
+                 int recordSize)
          +
          +
          Constructor for a TarBuffer on an input stream. +

          +

          +
          Parameters:
          inStream - the input stream to use
          blockSize - the block size to use
          recordSize - the record size to use
          +
          +
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.OutputStream outStream)
          +
          +
          Constructor for a TarBuffer on an output stream. +

          +

          +
          Parameters:
          outStream - the output stream to use
          +
          +
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.OutputStream outStream,
+                 int blockSize)
          +
          +
          Constructor for a TarBuffer on an output stream. +

          +

          +
          Parameters:
          outStream - the output stream to use
          blockSize - the block size to use
          +
          +
          + +

          +TarBuffer

          +
          +public TarBuffer(java.io.OutputStream outStream,
+                 int blockSize,
+                 int recordSize)
          +
          +
          Constructor for a TarBuffer on an output stream. +

          +

          +
          Parameters:
          outStream - the output stream to use
          blockSize - the block size to use
          recordSize - the record size to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getBlockSize

          +
          +public int getBlockSize()
          +
          +
          Get the TAR Buffer's block size. Blocks consist of multiple records. +

          +

          + +
          Returns:
          the block size
          +
          +
          +
          + +

          +getRecordSize

          +
          +public int getRecordSize()
          +
          +
          Get the TAR Buffer's record size. +

          +

          + +
          Returns:
          the record size
          +
          +
          +
          + +

          +setDebug

          +
          +public void setDebug(boolean debug)
          +
          +
          Set the debugging flag for the buffer. +

          +

          +
          Parameters:
          debug - If true, print debugging output.
          +
          +
          +
          + +

          +isEOFRecord

          +
          +public boolean isEOFRecord(byte[] record)
          +
          +
          Determine if an archive record indicate End of Archive. End of + archive is indicated by a record that consists entirely of null bytes. +

          +

          +
          Parameters:
          record - The record data to check. +
          Returns:
          true if the record data is an End of Archive
          +
          +
          +
          + +

          +skipRecord

          +
          +public void skipRecord()
+                throws java.io.IOException
          +
          +
          Skip over a record on the input stream. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +readRecord

          +
          +public byte[] readRecord()
+                  throws java.io.IOException
          +
          +
          Read a record from the input stream and return the data. +

          +

          + +
          Returns:
          The record data. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +getCurrentBlockNum

          +
          +public int getCurrentBlockNum()
          +
          +
          Get the current block number, zero based. +

          +

          + +
          Returns:
          The current zero based block number.
          +
          +
          +
          + +

          +getCurrentRecordNum

          +
          +public int getCurrentRecordNum()
          +
          +
          Get the current record number, within the current block, zero based. + Thus, current offset = (currentBlockNum * recsPerBlk) + currentRecNum. +

          +

          + +
          Returns:
          The current zero based record number.
          +
          +
          +
          + +

          +writeRecord

          +
          +public void writeRecord(byte[] record)
+                 throws java.io.IOException
          +
          +
          Write an archive record to the archive. +

          +

          +
          Parameters:
          record - The record data to write to the archive. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +writeRecord

          +
          +public void writeRecord(byte[] buf,
+                        int offset)
+                 throws java.io.IOException
          +
          +
          Write an archive record to the archive, where the record may be + inside of a larger array buffer. The buffer must be "offset plus + record size" long. +

          +

          +
          Parameters:
          buf - The buffer containing the record data to write.
          offset - The offset of the record data within buf. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Close the TarBuffer. If this is an output buffer, also flush the + current block before closing. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarConstants.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarConstants.html new file mode 100644 index 000000000..dd3b3e307 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarConstants.html @@ -0,0 +1,690 @@ + + + + + + +TarConstants (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Interface TarConstants

          +
          +
          All Known Implementing Classes:
          TarEntry
          +
          +
          +
          +
          public interface TarConstants
          + + +

          +This interface contains all the definitions used in the package. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intCHKSUMLEN + +
          +          The length of the checksum field in a header buffer.
          +static intDEVLEN + +
          +          The length of the devices field in a header buffer.
          +static intGIDLEN + +
          +          The length of the group id field in a header buffer.
          +static intGNAMELEN + +
          +          The length of the group name field in a header buffer.
          +static java.lang.StringGNU_LONGLINK + +
          +          The namr of the GNU tar entry which contains a long name.
          +static java.lang.StringGNU_TMAGIC + +
          +          The magic tag representing a GNU tar archive.
          +static byteLF_BLK + +
          +          Block device file type.
          +static byteLF_CHR + +
          +          Character device file type.
          +static byteLF_CONTIG + +
          +          Contiguous file type.
          +static byteLF_DIR + +
          +          Directory file type.
          +static byteLF_FIFO + +
          +          FIFO (pipe) file type.
          +static byteLF_GNUTYPE_LONGNAME + +
          +          Identifies the *next* file on the tape as having a long name.
          +static byteLF_LINK + +
          +          Link file type.
          +static byteLF_NORMAL + +
          +          Normal file type.
          +static byteLF_OLDNORM + +
          +          LF_ constants represent the "link flag" of an entry, or more commonly, + the "entry type".
          +static byteLF_SYMLINK + +
          +          Symbolic link file type.
          +static intMAGICLEN + +
          +          The length of the magic field in a header buffer.
          +static longMAXSIZE + +
          +          The maximum size of a file in a tar archive (That's 11 sevens, octal).
          +static intMODELEN + +
          +          The length of the mode field in a header buffer.
          +static intMODTIMELEN + +
          +          The length of the modification time field in a header buffer.
          +static intNAMELEN + +
          +          The length of the name field in a header buffer.
          +static intSIZELEN + +
          +          The length of the size field in a header buffer.
          +static java.lang.StringTMAGIC + +
          +          The magic tag representing a POSIX tar archive.
          +static intUIDLEN + +
          +          The length of the user id field in a header buffer.
          +static intUNAMELEN + +
          +          The length of the user name field in a header buffer.
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +NAMELEN

          +
          +static final int NAMELEN
          +
          +
          The length of the name field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MODELEN

          +
          +static final int MODELEN
          +
          +
          The length of the mode field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UIDLEN

          +
          +static final int UIDLEN
          +
          +
          The length of the user id field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GIDLEN

          +
          +static final int GIDLEN
          +
          +
          The length of the group id field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CHKSUMLEN

          +
          +static final int CHKSUMLEN
          +
          +
          The length of the checksum field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SIZELEN

          +
          +static final int SIZELEN
          +
          +
          The length of the size field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAXSIZE

          +
          +static final long MAXSIZE
          +
          +
          The maximum size of a file in a tar archive (That's 11 sevens, octal). +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MAGICLEN

          +
          +static final int MAGICLEN
          +
          +
          The length of the magic field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MODTIMELEN

          +
          +static final int MODTIMELEN
          +
          +
          The length of the modification time field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UNAMELEN

          +
          +static final int UNAMELEN
          +
          +
          The length of the user name field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GNAMELEN

          +
          +static final int GNAMELEN
          +
          +
          The length of the group name field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEVLEN

          +
          +static final int DEVLEN
          +
          +
          The length of the devices field in a header buffer. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_OLDNORM

          +
          +static final byte LF_OLDNORM
          +
          +
          LF_ constants represent the "link flag" of an entry, or more commonly, + the "entry type". This is the "old way" of indicating a normal file. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_NORMAL

          +
          +static final byte LF_NORMAL
          +
          +
          Normal file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_LINK

          +
          +static final byte LF_LINK
          +
          +
          Link file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_SYMLINK

          +
          +static final byte LF_SYMLINK
          +
          +
          Symbolic link file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_CHR

          +
          +static final byte LF_CHR
          +
          +
          Character device file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_BLK

          +
          +static final byte LF_BLK
          +
          +
          Block device file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_DIR

          +
          +static final byte LF_DIR
          +
          +
          Directory file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_FIFO

          +
          +static final byte LF_FIFO
          +
          +
          FIFO (pipe) file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_CONTIG

          +
          +static final byte LF_CONTIG
          +
          +
          Contiguous file type. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +TMAGIC

          +
          +static final java.lang.String TMAGIC
          +
          +
          The magic tag representing a POSIX tar archive. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GNU_TMAGIC

          +
          +static final java.lang.String GNU_TMAGIC
          +
          +
          The magic tag representing a GNU tar archive. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +GNU_LONGLINK

          +
          +static final java.lang.String GNU_LONGLINK
          +
          +
          The namr of the GNU tar entry which contains a long name. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LF_GNUTYPE_LONGNAME

          +
          +static final byte LF_GNUTYPE_LONGNAME
          +
          +
          Identifies the *next* file on the tape as having a long name. +

          +

          +
          See Also:
          Constant Field Values
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarEntry.html new file mode 100644 index 000000000..8501ddd0a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarEntry.html @@ -0,0 +1,1219 @@ + + + + + + +TarEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Class TarEntry

          +
          +java.lang.Object
+  extended by org.apache.tools.tar.TarEntry
+
          +
          +
          All Implemented Interfaces:
          TarConstants
          +
          +
          +
          +
          public class TarEntry
          extends java.lang.Object
          implements TarConstants
          + + +

          +This class represents an entry in a Tar archive. It consists + of the entry's header, as well as the entry's File. Entries + can be instantiated in one of three ways, depending on how + they are to be used. +

          + TarEntries that are created from the header bytes read from + an archive are instantiated with the TarEntry( byte[] ) + constructor. These entries will be used when extracting from + or listing the contents of an archive. These entries have their + header filled in using the header bytes. They also set the File + to null, since they reference an archive entry not a file. +

          + TarEntries that are created from Files that are to be written + into an archive are instantiated with the TarEntry( File ) + constructor. These entries have their header filled in using + the File's information. They also keep a reference to the File + for convenience when writing entries. +

          + Finally, TarEntries can be constructed from nothing but a name. + This allows the programmer to construct the entry by hand, for + instance when only an InputStream is available for writing to + the archive, and the header information is constructed from + other information. In this case the header fields are set to + defaults and the File is set to null. + +

          + The C structure for a Tar Entry's header is: + 

          + struct header {
+ char name[NAMSIZ];
+ char mode[8];
+ char uid[8];
+ char gid[8];
+ char size[12];
+ char mtime[12];
+ char chksum[8];
+ char linkflag;
+ char linkname[NAMSIZ];
+ char magic[8];
+ char uname[TUNMLEN];
+ char gname[TGNMLEN];
+ char devmajor[8];
+ char devminor[8];
+ } header;
+
          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intDEFAULT_DIR_MODE + +
          +          Default permissions bits for directories
          +static intDEFAULT_FILE_MODE + +
          +          Default permissions bits for files
          +static intMAX_NAMELEN + +
          +          Maximum length of a user's name in the tar file
          +static intMILLIS_PER_SECOND + +
          +          Convert millis to seconds
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.tar.TarConstants
          CHKSUMLEN, DEVLEN, GIDLEN, GNAMELEN, GNU_LONGLINK, GNU_TMAGIC, LF_BLK, LF_CHR, LF_CONTIG, LF_DIR, LF_FIFO, LF_GNUTYPE_LONGNAME, LF_LINK, LF_NORMAL, LF_OLDNORM, LF_SYMLINK, MAGICLEN, MAXSIZE, MODELEN, MODTIMELEN, NAMELEN, SIZELEN, TMAGIC, UIDLEN, UNAMELEN
          +  + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          TarEntry(byte[] headerBuf) + +
          +          Construct an entry from an archive's header bytes.
          TarEntry(java.io.File file) + +
          +          Construct an entry for a file.
          TarEntry(java.lang.String name) + +
          +          Construct an entry with only a name.
          TarEntry(java.lang.String name, + boolean preserveLeadingSlashes) + +
          +          Construct an entry with only a name.
          TarEntry(java.lang.String name, + byte linkFlag) + +
          +          Construct an entry with a name and a link flag.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + booleanequals(java.lang.Object it) + +
          +          Determine if the two entries are equal.
          + booleanequals(TarEntry it) + +
          +          Determine if the two entries are equal.
          + TarEntry[]getDirectoryEntries() + +
          +          If this entry represents a file, and the file is a directory, return + an array of TarEntries for this entry's children.
          + java.io.FilegetFile() + +
          +          Get this entry's file.
          + intgetGroupId() + +
          +          Get this entry's group id.
          + java.lang.StringgetGroupName() + +
          +          Get this entry's group name.
          + java.lang.StringgetLinkName() + +
          +          Get this entry's link name.
          + intgetMode() + +
          +          Get this entry's mode.
          + java.util.DategetModTime() + +
          +          Set this entry's modification time.
          + java.lang.StringgetName() + +
          +          Get this entry's name.
          + longgetSize() + +
          +          Get this entry's file size.
          + intgetUserId() + +
          +          Get this entry's user id.
          + java.lang.StringgetUserName() + +
          +          Get this entry's user name.
          + inthashCode() + +
          +          Hashcodes are based on entry names.
          + booleanisDescendent(TarEntry desc) + +
          +          Determine if the given entry is a descendant of this entry.
          + booleanisDirectory() + +
          +          Return whether or not this entry represents a directory.
          + booleanisGNULongNameEntry() + +
          +          Indicate if this entry is a GNU long name block
          + voidparseTarHeader(byte[] header) + +
          +          Parse an entry's header information from a header buffer.
          + voidsetGroupId(int groupId) + +
          +          Set this entry's group id.
          + voidsetGroupName(java.lang.String groupName) + +
          +          Set this entry's group name.
          + voidsetIds(int userId, + int groupId) + +
          +          Convenience method to set this entry's group and user ids.
          + voidsetMode(int mode) + +
          +          Set the mode for this entry
          + voidsetModTime(java.util.Date time) + +
          +          Set this entry's modification time.
          + voidsetModTime(long time) + +
          +          Set this entry's modification time.
          + voidsetName(java.lang.String name) + +
          +          Set this entry's name.
          + voidsetNames(java.lang.String userName, + java.lang.String groupName) + +
          +          Convenience method to set this entry's group and user names.
          + voidsetSize(long size) + +
          +          Set this entry's file size.
          + voidsetUserId(int userId) + +
          +          Set this entry's user id.
          + voidsetUserName(java.lang.String userName) + +
          +          Set this entry's user name.
          + voidwriteEntryHeader(byte[] outbuf) + +
          +          Write an entry's header information to a header buffer.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +MAX_NAMELEN

          +
          +public static final int MAX_NAMELEN
          +
          +
          Maximum length of a user's name in the tar file +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_DIR_MODE

          +
          +public static final int DEFAULT_DIR_MODE
          +
          +
          Default permissions bits for directories +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FILE_MODE

          +
          +public static final int DEFAULT_FILE_MODE
          +
          +
          Default permissions bits for files +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +MILLIS_PER_SECOND

          +
          +public static final int MILLIS_PER_SECOND
          +
          +
          Convert millis to seconds +

          +

          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TarEntry

          +
          +public TarEntry(java.lang.String name)
          +
          +
          Construct an entry with only a name. This allows the programmer + to construct the entry's header "by hand". File is set to null. +

          +

          +
          Parameters:
          name - the entry name
          +
          +
          + +

          +TarEntry

          +
          +public TarEntry(java.lang.String name,
+                boolean preserveLeadingSlashes)
          +
          +
          Construct an entry with only a name. This allows the programmer + to construct the entry's header "by hand". File is set to null. +

          +

          +
          Parameters:
          name - the entry name
          preserveLeadingSlashes - whether to allow leading slashes + in the name.
          +
          +
          + +

          +TarEntry

          +
          +public TarEntry(java.lang.String name,
+                byte linkFlag)
          +
          +
          Construct an entry with a name and a link flag. +

          +

          +
          Parameters:
          name - the entry name
          linkFlag - the entry link flag.
          +
          +
          + +

          +TarEntry

          +
          +public TarEntry(java.io.File file)
          +
          +
          Construct an entry for a file. File is set to file, and the + header is constructed from information from the file. +

          +

          +
          Parameters:
          file - The file that the entry represents.
          +
          +
          + +

          +TarEntry

          +
          +public TarEntry(byte[] headerBuf)
          +
          +
          Construct an entry from an archive's header bytes. File is set + to null. +

          +

          +
          Parameters:
          headerBuf - The header bytes from a tar archive entry.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +equals

          +
          +public boolean equals(TarEntry it)
          +
          +
          Determine if the two entries are equal. Equality is determined + by the header names being equal. +

          +

          +
          +
          +
          +
          Parameters:
          it - Entry to be checked for equality. +
          Returns:
          True if the entries are equal.
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object it)
          +
          +
          Determine if the two entries are equal. Equality is determined + by the header names being equal. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          it - Entry to be checked for equality. +
          Returns:
          True if the entries are equal.
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Hashcodes are based on entry names. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          the entry hashcode
          +
          +
          +
          + +

          +isDescendent

          +
          +public boolean isDescendent(TarEntry desc)
          +
          +
          Determine if the given entry is a descendant of this entry. + Descendancy is determined by the name of the descendant + starting with this entry's name. +

          +

          +
          +
          +
          +
          Parameters:
          desc - Entry to be checked as a descendent of this. +
          Returns:
          True if entry is a descendant of this.
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get this entry's name. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's name.
          +
          +
          +
          + +

          +setName

          +
          +public void setName(java.lang.String name)
          +
          +
          Set this entry's name. +

          +

          +
          +
          +
          +
          Parameters:
          name - This entry's new name.
          +
          +
          +
          + +

          +setMode

          +
          +public void setMode(int mode)
          +
          +
          Set the mode for this entry +

          +

          +
          +
          +
          +
          Parameters:
          mode - the mode for this entry
          +
          +
          +
          + +

          +getLinkName

          +
          +public java.lang.String getLinkName()
          +
          +
          Get this entry's link name. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's link name.
          +
          +
          +
          + +

          +getUserId

          +
          +public int getUserId()
          +
          +
          Get this entry's user id. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's user id.
          +
          +
          +
          + +

          +setUserId

          +
          +public void setUserId(int userId)
          +
          +
          Set this entry's user id. +

          +

          +
          +
          +
          +
          Parameters:
          userId - This entry's new user id.
          +
          +
          +
          + +

          +getGroupId

          +
          +public int getGroupId()
          +
          +
          Get this entry's group id. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's group id.
          +
          +
          +
          + +

          +setGroupId

          +
          +public void setGroupId(int groupId)
          +
          +
          Set this entry's group id. +

          +

          +
          +
          +
          +
          Parameters:
          groupId - This entry's new group id.
          +
          +
          +
          + +

          +getUserName

          +
          +public java.lang.String getUserName()
          +
          +
          Get this entry's user name. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's user name.
          +
          +
          +
          + +

          +setUserName

          +
          +public void setUserName(java.lang.String userName)
          +
          +
          Set this entry's user name. +

          +

          +
          +
          +
          +
          Parameters:
          userName - This entry's new user name.
          +
          +
          +
          + +

          +getGroupName

          +
          +public java.lang.String getGroupName()
          +
          +
          Get this entry's group name. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's group name.
          +
          +
          +
          + +

          +setGroupName

          +
          +public void setGroupName(java.lang.String groupName)
          +
          +
          Set this entry's group name. +

          +

          +
          +
          +
          +
          Parameters:
          groupName - This entry's new group name.
          +
          +
          +
          + +

          +setIds

          +
          +public void setIds(int userId,
+                   int groupId)
          +
          +
          Convenience method to set this entry's group and user ids. +

          +

          +
          +
          +
          +
          Parameters:
          userId - This entry's new user id.
          groupId - This entry's new group id.
          +
          +
          +
          + +

          +setNames

          +
          +public void setNames(java.lang.String userName,
+                     java.lang.String groupName)
          +
          +
          Convenience method to set this entry's group and user names. +

          +

          +
          +
          +
          +
          Parameters:
          userName - This entry's new user name.
          groupName - This entry's new group name.
          +
          +
          +
          + +

          +setModTime

          +
          +public void setModTime(long time)
          +
          +
          Set this entry's modification time. The parameter passed + to this method is in "Java time". +

          +

          +
          +
          +
          +
          Parameters:
          time - This entry's new modification time.
          +
          +
          +
          + +

          +setModTime

          +
          +public void setModTime(java.util.Date time)
          +
          +
          Set this entry's modification time. +

          +

          +
          +
          +
          +
          Parameters:
          time - This entry's new modification time.
          +
          +
          +
          + +

          +getModTime

          +
          +public java.util.Date getModTime()
          +
          +
          Set this entry's modification time. +

          +

          +
          +
          +
          + +
          Returns:
          time This entry's new modification time.
          +
          +
          +
          + +

          +getFile

          +
          +public java.io.File getFile()
          +
          +
          Get this entry's file. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's file.
          +
          +
          +
          + +

          +getMode

          +
          +public int getMode()
          +
          +
          Get this entry's mode. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's mode.
          +
          +
          +
          + +

          +getSize

          +
          +public long getSize()
          +
          +
          Get this entry's file size. +

          +

          +
          +
          +
          + +
          Returns:
          This entry's file size.
          +
          +
          +
          + +

          +setSize

          +
          +public void setSize(long size)
          +
          +
          Set this entry's file size. +

          +

          +
          +
          +
          +
          Parameters:
          size - This entry's new file size.
          +
          +
          +
          + +

          +isGNULongNameEntry

          +
          +public boolean isGNULongNameEntry()
          +
          +
          Indicate if this entry is a GNU long name block +

          +

          +
          +
          +
          + +
          Returns:
          true if this is a long name extension provided by GNU tar
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Return whether or not this entry represents a directory. +

          +

          +
          +
          +
          + +
          Returns:
          True if this entry is a directory.
          +
          +
          +
          + +

          +getDirectoryEntries

          +
          +public TarEntry[] getDirectoryEntries()
          +
          +
          If this entry represents a file, and the file is a directory, return + an array of TarEntries for this entry's children. +

          +

          +
          +
          +
          + +
          Returns:
          An array of TarEntry's for this entry's children.
          +
          +
          +
          + +

          +writeEntryHeader

          +
          +public void writeEntryHeader(byte[] outbuf)
          +
          +
          Write an entry's header information to a header buffer. +

          +

          +
          +
          +
          +
          Parameters:
          outbuf - The tar entry header buffer to fill in.
          +
          +
          +
          + +

          +parseTarHeader

          +
          +public void parseTarHeader(byte[] header)
          +
          +
          Parse an entry's header information from a header buffer. +

          +

          +
          +
          +
          +
          Parameters:
          header - The tar entry header buffer to get information from.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarInputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarInputStream.html new file mode 100644 index 000000000..03e9d0d9d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarInputStream.html @@ -0,0 +1,805 @@ + + + + + + +TarInputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Class TarInputStream

          +
          +java.lang.Object
+  extended by java.io.InputStream
+      extended by java.io.FilterInputStream
+          extended by org.apache.tools.tar.TarInputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable
          +
          +
          +
          +
          public class TarInputStream
          extends java.io.FilterInputStream
          + + +

          +The TarInputStream reads a UNIX tar archive as an InputStream. + methods are provided to position at each successive entry in + the archive, and the read each entry as a normal input stream + using read(). +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  TarBufferbuffer + +
          +           
          +protected  TarEntrycurrEntry + +
          +           
          +protected  booleandebug + +
          +           
          +protected  longentryOffset + +
          +           
          +protected  longentrySize + +
          +           
          +protected  booleanhasHitEOF + +
          +           
          +protected  byte[]oneBuf + +
          +          This contents of this array is not used at all in this class, + it is only here to avoid repreated object creation during calls + to the no-arg read method.
          +protected  byte[]readBuf + +
          +           
          +  + + + + + + + +
          Fields inherited from class java.io.FilterInputStream
          in
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          TarInputStream(java.io.InputStream is) + +
          +          Constructor for TarInputStream.
          TarInputStream(java.io.InputStream is, + int blockSize) + +
          +          Constructor for TarInputStream.
          TarInputStream(java.io.InputStream is, + int blockSize, + int recordSize) + +
          +          Constructor for TarInputStream.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + intavailable() + +
          +          Get the available data that can be read from the current + entry in the archive.
          + voidclose() + +
          +          Closes this stream.
          + voidcopyEntryContents(java.io.OutputStream out) + +
          +          Copies the contents of the current tar archive entry directly into + an output stream.
          + TarEntrygetNextEntry() + +
          +          Get the next entry in this tar archive.
          + intgetRecordSize() + +
          +          Get the record size being used by this stream's TarBuffer.
          + voidmark(int markLimit) + +
          +          Since we do not support marking just yet, we do nothing.
          + booleanmarkSupported() + +
          +          Since we do not support marking just yet, we return false.
          + intread() + +
          +          Reads a byte from the current tar archive entry.
          + intread(byte[] buf, + int offset, + int numToRead) + +
          +          Reads bytes from the current tar archive entry.
          + voidreset() + +
          +          Since we do not support marking just yet, we do nothing.
          + voidsetDebug(boolean debug) + +
          +          Sets the debugging flag.
          + longskip(long numToSkip) + +
          +          Skip bytes in the input buffer.
          +  + + + + + + + +
          Methods inherited from class java.io.FilterInputStream
          read
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +debug

          +
          +protected boolean debug
          +
          +
          +
          +
          +
          + +

          +hasHitEOF

          +
          +protected boolean hasHitEOF
          +
          +
          +
          +
          +
          + +

          +entrySize

          +
          +protected long entrySize
          +
          +
          +
          +
          +
          + +

          +entryOffset

          +
          +protected long entryOffset
          +
          +
          +
          +
          +
          + +

          +readBuf

          +
          +protected byte[] readBuf
          +
          +
          +
          +
          +
          + +

          +buffer

          +
          +protected TarBuffer buffer
          +
          +
          +
          +
          +
          + +

          +currEntry

          +
          +protected TarEntry currEntry
          +
          +
          +
          +
          +
          + +

          +oneBuf

          +
          +protected byte[] oneBuf
          +
          +
          This contents of this array is not used at all in this class, + it is only here to avoid repreated object creation during calls + to the no-arg read method. +

          +

          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TarInputStream

          +
          +public TarInputStream(java.io.InputStream is)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          is - the input stream to use
          +
          +
          + +

          +TarInputStream

          +
          +public TarInputStream(java.io.InputStream is,
+                      int blockSize)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          is - the input stream to use
          blockSize - the block size to use
          +
          +
          + +

          +TarInputStream

          +
          +public TarInputStream(java.io.InputStream is,
+                      int blockSize,
+                      int recordSize)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          is - the input stream to use
          blockSize - the block size to use
          recordSize - the record size to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setDebug

          +
          +public void setDebug(boolean debug)
          +
          +
          Sets the debugging flag. +

          +

          +
          Parameters:
          debug - True to turn on debugging.
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Closes this stream. Calls the TarBuffer's close() method. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.FilterInputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +getRecordSize

          +
          +public int getRecordSize()
          +
          +
          Get the record size being used by this stream's TarBuffer. +

          +

          + +
          Returns:
          The TarBuffer record size.
          +
          +
          +
          + +

          +available

          +
          +public int available()
+              throws java.io.IOException
          +
          +
          Get the available data that can be read from the current + entry in the archive. This does not indicate how much data + is left in the entire archive, only in the current entry. + This value is determined from the entry's size header field + and the amount of data already read from the current entry. + Integer.MAX_VALUE is returen in case more than Integer.MAX_VALUE + bytes are left in the current entry in the archive. +

          +

          +
          Overrides:
          available in class java.io.FilterInputStream
          +
          +
          + +
          Returns:
          The number of available bytes for the current entry. +
          Throws: +
          java.io.IOException - for signature
          +
          +
          +
          + +

          +skip

          +
          +public long skip(long numToSkip)
+          throws java.io.IOException
          +
          +
          Skip bytes in the input buffer. This skips bytes in the + current entry's data, not the entire archive, and will + stop at the end of the current entry's data if the number + to skip extends beyond that point. +

          +

          +
          Overrides:
          skip in class java.io.FilterInputStream
          +
          +
          +
          Parameters:
          numToSkip - The number of bytes to skip. +
          Returns:
          the number actually skipped +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +markSupported

          +
          +public boolean markSupported()
          +
          +
          Since we do not support marking just yet, we return false. +

          +

          +
          Overrides:
          markSupported in class java.io.FilterInputStream
          +
          +
          + +
          Returns:
          False.
          +
          +
          +
          + +

          +mark

          +
          +public void mark(int markLimit)
          +
          +
          Since we do not support marking just yet, we do nothing. +

          +

          +
          Overrides:
          mark in class java.io.FilterInputStream
          +
          +
          +
          Parameters:
          markLimit - The limit to mark.
          +
          +
          +
          + +

          +reset

          +
          +public void reset()
          +
          +
          Since we do not support marking just yet, we do nothing. +

          +

          +
          Overrides:
          reset in class java.io.FilterInputStream
          +
          +
          +
          +
          +
          +
          + +

          +getNextEntry

          +
          +public TarEntry getNextEntry()
+                      throws java.io.IOException
          +
          +
          Get the next entry in this tar archive. This will skip + over any remaining data in the current entry, if there + is one, and place the input stream at the header of the + next entry, and read the header and instantiate a new + TarEntry from the header bytes and return that entry. + If there are no more entries in the archive, null will + be returned to indicate that the end of the archive has + been reached. +

          +

          + +
          Returns:
          The next TarEntry in the archive, or null. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +read

          +
          +public int read()
+         throws java.io.IOException
          +
          +
          Reads a byte from the current tar archive entry. + + This method simply calls read( byte[], int, int ). +

          +

          +
          Overrides:
          read in class java.io.FilterInputStream
          +
          +
          + +
          Returns:
          The byte read, or -1 at EOF. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +read

          +
          +public int read(byte[] buf,
+                int offset,
+                int numToRead)
+         throws java.io.IOException
          +
          +
          Reads bytes from the current tar archive entry. + + This method is aware of the boundaries of the current + entry in the archive and will deal with them as if they + were this stream's start and EOF. +

          +

          +
          Overrides:
          read in class java.io.FilterInputStream
          +
          +
          +
          Parameters:
          buf - The buffer into which to place bytes read.
          offset - The offset at which to place bytes read.
          numToRead - The number of bytes to read. +
          Returns:
          The number of bytes read, or -1 at EOF. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +copyEntryContents

          +
          +public void copyEntryContents(java.io.OutputStream out)
+                       throws java.io.IOException
          +
          +
          Copies the contents of the current tar archive entry directly into + an output stream. +

          +

          +
          Parameters:
          out - The OutputStream into which to write the entry's data. +
          Throws: +
          java.io.IOException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarOutputStream.html new file mode 100644 index 000000000..d2a8acd94 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarOutputStream.html @@ -0,0 +1,858 @@ + + + + + + +TarOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Class TarOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by java.io.FilterOutputStream
+          extended by org.apache.tools.tar.TarOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class TarOutputStream
          extends java.io.FilterOutputStream
          + + +

          +The TarOutputStream writes a UNIX tar archive as an OutputStream. + Methods are provided to put entries, and then write their contents + by writing to this stream using write(). +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  byte[]assemBuf + +
          +           
          +protected  intassemLen + +
          +           
          +protected  TarBufferbuffer + +
          +           
          +protected  longcurrBytes + +
          +           
          +protected  java.lang.StringcurrName + +
          +           
          +protected  longcurrSize + +
          +           
          +protected  booleandebug + +
          +           
          +static intLONGFILE_ERROR + +
          +          Fail if a long file name is required in the archive.
          +static intLONGFILE_GNU + +
          +          GNU tar extensions are used to store long file names in the archive.
          +static intLONGFILE_TRUNCATE + +
          +          Long paths will be truncated in the archive.
          +protected  intlongFileMode + +
          +           
          +protected  byte[]oneBuf + +
          +           
          +protected  byte[]recordBuf + +
          +           
          +  + + + + + + + +
          Fields inherited from class java.io.FilterOutputStream
          out
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          TarOutputStream(java.io.OutputStream os) + +
          +          Constructor for TarInputStream.
          TarOutputStream(java.io.OutputStream os, + int blockSize) + +
          +          Constructor for TarInputStream.
          TarOutputStream(java.io.OutputStream os, + int blockSize, + int recordSize) + +
          +          Constructor for TarInputStream.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Ends the TAR archive and closes the underlying OutputStream.
          + voidcloseEntry() + +
          +          Close an entry.
          + voidfinish() + +
          +          Ends the TAR archive without closing the underlying OutputStream.
          + intgetRecordSize() + +
          +          Get the record size being used by this stream's TarBuffer.
          + voidputNextEntry(TarEntry entry) + +
          +          Put an entry on the output stream.
          + voidsetBufferDebug(boolean debug) + +
          +          Sets the debugging flag in this stream's TarBuffer.
          + voidsetDebug(boolean debugF) + +
          +          Sets the debugging flag.
          + voidsetLongFileMode(int longFileMode) + +
          +          Set the long file mode.
          + voidwrite(byte[] wBuf) + +
          +          Writes bytes to the current tar archive entry.
          + voidwrite(byte[] wBuf, + int wOffset, + int numToWrite) + +
          +          Writes bytes to the current tar archive entry.
          + voidwrite(int b) + +
          +          Writes a byte to the current tar archive entry.
          +  + + + + + + + +
          Methods inherited from class java.io.FilterOutputStream
          flush
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +LONGFILE_ERROR

          +
          +public static final int LONGFILE_ERROR
          +
          +
          Fail if a long file name is required in the archive. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LONGFILE_TRUNCATE

          +
          +public static final int LONGFILE_TRUNCATE
          +
          +
          Long paths will be truncated in the archive. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LONGFILE_GNU

          +
          +public static final int LONGFILE_GNU
          +
          +
          GNU tar extensions are used to store long file names in the archive. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +debug

          +
          +protected boolean debug
          +
          +
          +
          +
          +
          + +

          +currSize

          +
          +protected long currSize
          +
          +
          +
          +
          +
          + +

          +currName

          +
          +protected java.lang.String currName
          +
          +
          +
          +
          +
          + +

          +currBytes

          +
          +protected long currBytes
          +
          +
          +
          +
          +
          + +

          +oneBuf

          +
          +protected byte[] oneBuf
          +
          +
          +
          +
          +
          + +

          +recordBuf

          +
          +protected byte[] recordBuf
          +
          +
          +
          +
          +
          + +

          +assemLen

          +
          +protected int assemLen
          +
          +
          +
          +
          +
          + +

          +assemBuf

          +
          +protected byte[] assemBuf
          +
          +
          +
          +
          +
          + +

          +buffer

          +
          +protected TarBuffer buffer
          +
          +
          +
          +
          +
          + +

          +longFileMode

          +
          +protected int longFileMode
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +TarOutputStream

          +
          +public TarOutputStream(java.io.OutputStream os)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          os - the output stream to use
          +
          +
          + +

          +TarOutputStream

          +
          +public TarOutputStream(java.io.OutputStream os,
+                       int blockSize)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          os - the output stream to use
          blockSize - the block size to use
          +
          +
          + +

          +TarOutputStream

          +
          +public TarOutputStream(java.io.OutputStream os,
+                       int blockSize,
+                       int recordSize)
          +
          +
          Constructor for TarInputStream. +

          +

          +
          Parameters:
          os - the output stream to use
          blockSize - the block size to use
          recordSize - the record size to use
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setLongFileMode

          +
          +public void setLongFileMode(int longFileMode)
          +
          +
          Set the long file mode. + This can be LONGFILE_ERROR(0), LONGFILE_TRUNCATE(1) or LONGFILE_GNU(2). + This specifies the treatment of long file names (names >= TarConstants.NAMELEN). + Default is LONGFILE_ERROR. +

          +

          +
          Parameters:
          longFileMode - the mode to use
          +
          +
          +
          + +

          +setDebug

          +
          +public void setDebug(boolean debugF)
          +
          +
          Sets the debugging flag. +

          +

          +
          Parameters:
          debugF - True to turn on debugging.
          +
          +
          +
          + +

          +setBufferDebug

          +
          +public void setBufferDebug(boolean debug)
          +
          +
          Sets the debugging flag in this stream's TarBuffer. +

          +

          +
          Parameters:
          debug - True to turn on debugging.
          +
          +
          +
          + +

          +finish

          +
          +public void finish()
+            throws java.io.IOException
          +
          +
          Ends the TAR archive without closing the underlying OutputStream. + The result is that the two EOF records of nulls are written. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Ends the TAR archive and closes the underlying OutputStream. + This means that finish() is called followed by calling the + TarBuffer's close(). +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.FilterOutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +getRecordSize

          +
          +public int getRecordSize()
          +
          +
          Get the record size being used by this stream's TarBuffer. +

          +

          + +
          Returns:
          The TarBuffer record size.
          +
          +
          +
          + +

          +putNextEntry

          +
          +public void putNextEntry(TarEntry entry)
+                  throws java.io.IOException
          +
          +
          Put an entry on the output stream. This writes the entry's + header record and positions the output stream for writing + the contents of the entry. Once this method is called, the + stream is ready for calls to write() to write the entry's + contents. Once the contents are written, closeEntry() + MUST be called to ensure that all buffered data + is completely written to the output stream. +

          +

          +
          Parameters:
          entry - The TarEntry to be written to the archive. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +closeEntry

          +
          +public void closeEntry()
+                throws java.io.IOException
          +
          +
          Close an entry. This method MUST be called for all file + entries that contain data. The reason is that we must + buffer data written to the stream in order to satisfy + the buffer's record based writes. Thus, there may be + data fragments still being assembled that must be written + to the output stream before this entry is closed and the + next entry written. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +write

          +
          +public void write(int b)
+           throws java.io.IOException
          +
          +
          Writes a byte to the current tar archive entry. + + This method simply calls read( byte[], int, int ). +

          +

          +
          Overrides:
          write in class java.io.FilterOutputStream
          +
          +
          +
          Parameters:
          b - The byte written. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] wBuf)
+           throws java.io.IOException
          +
          +
          Writes bytes to the current tar archive entry. + + This method simply calls write( byte[], int, int ). +

          +

          +
          Overrides:
          write in class java.io.FilterOutputStream
          +
          +
          +
          Parameters:
          wBuf - The buffer to write to the archive. +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] wBuf,
+                  int wOffset,
+                  int numToWrite)
+           throws java.io.IOException
          +
          +
          Writes bytes to the current tar archive entry. This method + is aware of the current entry and will throw an exception if + you attempt to write bytes past the length specified for the + current entry. The method is also (painfully) aware of the + record buffering required by TarBuffer, and manages buffers + that are not a multiple of recordsize in length, including + assembling records from small buffers. +

          +

          +
          Overrides:
          write in class java.io.FilterOutputStream
          +
          +
          +
          Parameters:
          wBuf - The buffer to write to the archive.
          wOffset - The offset in the buffer from which to get bytes.
          numToWrite - The number of bytes to write. +
          Throws: +
          java.io.IOException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarUtils.html new file mode 100644 index 000000000..40672f836 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/TarUtils.html @@ -0,0 +1,419 @@ + + + + + + +TarUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.tar +
          +Class TarUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.tar.TarUtils
+
          +
          +
          +
          public class TarUtils
          extends java.lang.Object
          + + +

          +This class provides static utility methods to work with byte streams. +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          TarUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static longcomputeCheckSum(byte[] buf) + +
          +          Compute the checksum of a tar entry header.
          +static intgetCheckSumOctalBytes(long value, + byte[] buf, + int offset, + int length) + +
          +          Parse the checksum octal integer from a header buffer.
          +static intgetLongOctalBytes(long value, + byte[] buf, + int offset, + int length) + +
          +          Parse an octal long integer from a header buffer.
          +static intgetNameBytes(java.lang.StringBuffer name, + byte[] buf, + int offset, + int length) + +
          +          Determine the number of bytes in an entry name.
          +static intgetOctalBytes(long value, + byte[] buf, + int offset, + int length) + +
          +          Parse an octal integer from a header buffer.
          +static java.lang.StringBufferparseName(byte[] header, + int offset, + int length) + +
          +          Parse an entry name from a header buffer.
          +static longparseOctal(byte[] header, + int offset, + int length) + +
          +          Parse an octal string from a header buffer.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +TarUtils

          +
          +public TarUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +parseOctal

          +
          +public static long parseOctal(byte[] header,
+                              int offset,
+                              int length)
          +
          +
          Parse an octal string from a header buffer. This is used for the + file permission mode value. +

          +

          +
          Parameters:
          header - The header buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The long value of the octal string.
          +
          +
          +
          + +

          +parseName

          +
          +public static java.lang.StringBuffer parseName(byte[] header,
+                                               int offset,
+                                               int length)
          +
          +
          Parse an entry name from a header buffer. +

          +

          +
          Parameters:
          header - The header buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The header's entry name.
          +
          +
          +
          + +

          +getNameBytes

          +
          +public static int getNameBytes(java.lang.StringBuffer name,
+                               byte[] buf,
+                               int offset,
+                               int length)
          +
          +
          Determine the number of bytes in an entry name. +

          +

          +
          Parameters:
          name - The header name from which to parse.
          buf - The buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The number of bytes in a header's entry name.
          +
          +
          +
          + +

          +getOctalBytes

          +
          +public static int getOctalBytes(long value,
+                                byte[] buf,
+                                int offset,
+                                int length)
          +
          +
          Parse an octal integer from a header buffer. +

          +

          +
          Parameters:
          value - The header value
          buf - The buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The integer value of the octal bytes.
          +
          +
          +
          + +

          +getLongOctalBytes

          +
          +public static int getLongOctalBytes(long value,
+                                    byte[] buf,
+                                    int offset,
+                                    int length)
          +
          +
          Parse an octal long integer from a header buffer. +

          +

          +
          Parameters:
          value - The header value
          buf - The buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The long value of the octal bytes.
          +
          +
          +
          + +

          +getCheckSumOctalBytes

          +
          +public static int getCheckSumOctalBytes(long value,
+                                        byte[] buf,
+                                        int offset,
+                                        int length)
          +
          +
          Parse the checksum octal integer from a header buffer. +

          +

          +
          Parameters:
          value - The header value
          buf - The buffer from which to parse.
          offset - The offset into the buffer from which to parse.
          length - The number of header bytes to parse. +
          Returns:
          The integer value of the entry's checksum.
          +
          +
          +
          + +

          +computeCheckSum

          +
          +public static long computeCheckSum(byte[] buf)
          +
          +
          Compute the checksum of a tar entry header. +

          +

          +
          Parameters:
          buf - The tar entry's header buffer. +
          Returns:
          The computed checksum.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-frame.html new file mode 100644 index 000000000..97dbd7fd6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-frame.html @@ -0,0 +1,51 @@ + + + + + + +org.apache.tools.tar (Apache Ant API) + + + + + + + + + + + +org.apache.tools.tar + + + + +
          +Interfaces  + +
          +TarConstants
          + + + + + + +
          +Classes  + +
          +TarBuffer +
          +TarEntry +
          +TarInputStream +
          +TarOutputStream +
          +TarUtils
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-summary.html new file mode 100644 index 000000000..e11907603 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-summary.html @@ -0,0 +1,183 @@ + + + + + + +org.apache.tools.tar (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.tar +

          + + + + + + + + + +
          +Interface Summary
          TarConstantsThis interface contains all the definitions used in the package.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          TarBufferThe TarBuffer class implements the tar archive concept + of a buffered input stream.
          TarEntryThis class represents an entry in a Tar archive.
          TarInputStreamThe TarInputStream reads a UNIX tar archive as an InputStream.
          TarOutputStreamThe TarOutputStream writes a UNIX tar archive as an OutputStream.
          TarUtilsThis class provides static utility methods to work with byte streams.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-tree.html new file mode 100644 index 000000000..0d095e672 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/tar/package-tree.html @@ -0,0 +1,163 @@ + + + + + + +org.apache.tools.tar Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.tar +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          +
            +
          • java.lang.Object
              +
            • java.io.InputStream (implements java.io.Closeable) + +
            • java.io.OutputStream (implements java.io.Closeable, java.io.Flushable) + +
            • org.apache.tools.tar.TarBuffer
            • org.apache.tools.tar.TarEntry (implements org.apache.tools.tar.TarConstants) +
            • org.apache.tools.tar.TarUtils
            +
          +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AbstractUnicodeExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AbstractUnicodeExtraField.html new file mode 100644 index 000000000..5a9c941ab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AbstractUnicodeExtraField.html @@ -0,0 +1,541 @@ + + + + + + +AbstractUnicodeExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class AbstractUnicodeExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.AbstractUnicodeExtraField
+
          +
          +
          All Implemented Interfaces:
          ZipExtraField
          +
          +
          +
          Direct Known Subclasses:
          UnicodeCommentExtraField, UnicodePathExtraField
          +
          +
          +
          +
          public abstract class AbstractUnicodeExtraField
          extends java.lang.Object
          implements ZipExtraField
          + + +

          +A common base class for Unicode extra information extra fields. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected AbstractUnicodeExtraField() + +
          +           
          +protected AbstractUnicodeExtraField(java.lang.String text, + byte[] bytes) + +
          +          Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry.
          +protected AbstractUnicodeExtraField(java.lang.String text, + byte[] bytes, + int off, + int len) + +
          +          Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + byte[]getCentralDirectoryData() + +
          +          The actual data to put into central directory - without Header-ID or + length specifier.
          + ZipShortgetCentralDirectoryLength() + +
          +          Length of the extra field in the central directory - without + Header-ID or length specifier.
          + byte[]getLocalFileDataData() + +
          +          The actual data to put into local file data - without Header-ID + or length specifier.
          + ZipShortgetLocalFileDataLength() + +
          +          Length of the extra field in the local file data - without + Header-ID or length specifier.
          + longgetNameCRC32() + +
          +           
          + byte[]getUnicodeName() + +
          +           
          + voidparseFromLocalFileData(byte[] buffer, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          + voidsetNameCRC32(long nameCRC32) + +
          +           
          + voidsetUnicodeName(byte[] unicodeName) + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.zip.ZipExtraField
          getHeaderId
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AbstractUnicodeExtraField

          +
          +protected AbstractUnicodeExtraField()
          +
          +
          +
          + +

          +AbstractUnicodeExtraField

          +
          +protected AbstractUnicodeExtraField(java.lang.String text,
+                                    byte[] bytes,
+                                    int off,
+                                    int len)
          +
          +
          Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry. +

          +

          +
          Parameters:
          text - The file name or comment.
          bytes - The encoded of the filename or comment in the zip + file.
          off - The offset of the encoded filename or comment in + bytes.
          len - The length of the encoded filename or commentin + bytes.
          +
          +
          + +

          +AbstractUnicodeExtraField

          +
          +protected AbstractUnicodeExtraField(java.lang.String text,
+                                    byte[] bytes)
          +
          +
          Assemble as unicode extension from the name/comment and + encoding of the orginal zip entry. +

          +

          +
          Parameters:
          text - The file name or comment.
          bytes - The encoded of the filename or comment in the zip + file.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getNameCRC32

          +
          +public long getNameCRC32()
          +
          +
          +
          +
          +
          + +
          Returns:
          The CRC32 checksum of the filename or comment as + encoded in the central directory of the zip file.
          +
          +
          +
          + +

          +setNameCRC32

          +
          +public void setNameCRC32(long nameCRC32)
          +
          +
          +
          +
          +
          +
          Parameters:
          nameCRC32 - The CRC32 checksum of the filename as encoded + in the central directory of the zip file to set.
          +
          +
          +
          + +

          +getUnicodeName

          +
          +public byte[] getUnicodeName()
          +
          +
          +
          +
          +
          + +
          Returns:
          The utf-8 encoded name.
          +
          +
          +
          + +

          +setUnicodeName

          +
          +public void setUnicodeName(byte[] unicodeName)
          +
          +
          +
          +
          +
          +
          Parameters:
          unicodeName - The utf-8 encoded name to set.
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +public byte[] getCentralDirectoryData()
          +
          +
          Description copied from interface: ZipExtraField
          +
          The actual data to put into central directory - without Header-ID or + length specifier. +

          +

          +
          Specified by:
          getCentralDirectoryData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the data
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +public ZipShort getCentralDirectoryLength()
          +
          +
          Description copied from interface: ZipExtraField
          +
          Length of the extra field in the central directory - without + Header-ID or length specifier. +

          +

          +
          Specified by:
          getCentralDirectoryLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          the length of the field in the central directory
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +public byte[] getLocalFileDataData()
          +
          +
          Description copied from interface: ZipExtraField
          +
          The actual data to put into local file data - without Header-ID + or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the data
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +public ZipShort getLocalFileDataLength()
          +
          +
          Description copied from interface: ZipExtraField
          +
          Length of the extra field in the local file data - without + Header-ID or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          the length of the field in the local file data
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +public void parseFromLocalFileData(byte[] buffer,
+                                   int offset,
+                                   int length)
+                            throws java.util.zip.ZipException
          +
          +
          Description copied from interface: ZipExtraField
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Specified by:
          parseFromLocalFileData in interface ZipExtraField
          +
          +
          +
          Parameters:
          buffer - an array of bytes
          offset - the start offset
          length - the number of bytes in the array from offset +
          Throws: +
          java.util.zip.ZipException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AsiExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AsiExtraField.html new file mode 100644 index 000000000..1bb2cc0d4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/AsiExtraField.html @@ -0,0 +1,791 @@ + + + + + + +AsiExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class AsiExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.AsiExtraField
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable, UnixStat, ZipExtraField
          +
          +
          +
          +
          public class AsiExtraField
          extends java.lang.Object
          implements ZipExtraField, UnixStat, java.lang.Cloneable
          + + +

          +Adds Unix file permission and UID/GID fields as well as symbolic + link handling. + +

          This class uses the ASi extra field in the format: + 

          +         Value         Size            Description
+         -----         ----            -----------
+ (Unix3) 0x756e        Short           tag for this extra block type
+         TSize         Short           total data size for this block
+         CRC           Long            CRC-32 of the remaining data
+         Mode          Short           file permissions
+         SizDev        Long            symlink'd size OR major/minor dev num
+         UID           Short           user ID
+         GID           Short           group ID
+         (var.)        variable        symbolic link filename
+
          + taken from appnote.iz (Info-ZIP note, 981119) found at ftp://ftp.uu.net/pub/archiving/zip/doc/

          + + +

          Short is two bytes and Long is four bytes in big endian byte and + word order, device numbers are currently not supported.

          +

          + +

          +

          + +

          + + + + + + + +
          +Field Summary
          +  + + + + + + + +
          Fields inherited from interface org.apache.tools.zip.UnixStat
          DEFAULT_DIR_PERM, DEFAULT_FILE_PERM, DEFAULT_LINK_PERM, DIR_FLAG, FILE_FLAG, LINK_FLAG, PERM_MASK
          +  + + + + + + + + + + +
          +Constructor Summary
          AsiExtraField() + +
          +          Constructor for AsiExtraField.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +           
          + byte[]getCentralDirectoryData() + +
          +          Delegate to local file data.
          + ZipShortgetCentralDirectoryLength() + +
          +          Delegate to local file data.
          + intgetGroupId() + +
          +          Get the group id.
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          + java.lang.StringgetLinkedFile() + +
          +          Name of linked file
          + byte[]getLocalFileDataData() + +
          +          The actual data to put into local file data - without Header-ID + or length specifier.
          + ZipShortgetLocalFileDataLength() + +
          +          Length of the extra field in the local file data - without + Header-ID or length specifier.
          + intgetMode() + +
          +          File mode of this file.
          +protected  intgetMode(int mode) + +
          +          Get the file mode for given permissions with the correct file type.
          + intgetUserId() + +
          +          Get the user id.
          + booleanisDirectory() + +
          +          Is this entry a directory?
          + booleanisLink() + +
          +          Is this entry a symbolic link?
          + voidparseFromLocalFileData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          + voidsetDirectory(boolean dirFlag) + +
          +          Indicate whether this entry is a directory.
          + voidsetGroupId(int gid) + +
          +          Set the group id.
          + voidsetLinkedFile(java.lang.String name) + +
          +          Indicate that this entry is a symbolic link to the given filename.
          + voidsetMode(int mode) + +
          +          File mode of this file.
          + voidsetUserId(int uid) + +
          +          Set the user id.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +AsiExtraField

          +
          +public AsiExtraField()
          +
          +
          Constructor for AsiExtraField. +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          The Header-ID. +

          +

          +
          Specified by:
          getHeaderId in interface ZipExtraField
          +
          +
          + +
          Returns:
          the value for the header id for this extrafield
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +public ZipShort getLocalFileDataLength()
          +
          +
          Length of the extra field in the local file data - without + Header-ID or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          a ZipShort for the length of the data of this extra field
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +public ZipShort getCentralDirectoryLength()
          +
          +
          Delegate to local file data. +

          +

          +
          Specified by:
          getCentralDirectoryLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          the centralDirectory length
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +public byte[] getLocalFileDataData()
          +
          +
          The actual data to put into local file data - without Header-ID + or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataData in interface ZipExtraField
          +
          +
          + +
          Returns:
          get the data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +public byte[] getCentralDirectoryData()
          +
          +
          Delegate to local file data. +

          +

          +
          Specified by:
          getCentralDirectoryData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the local file data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setUserId

          +
          +public void setUserId(int uid)
          +
          +
          Set the user id. +

          +

          +
          +
          +
          +
          Parameters:
          uid - the user id
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getUserId

          +
          +public int getUserId()
          +
          +
          Get the user id. +

          +

          +
          +
          +
          + +
          Returns:
          the user id
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setGroupId

          +
          +public void setGroupId(int gid)
          +
          +
          Set the group id. +

          +

          +
          +
          +
          +
          Parameters:
          gid - the group id
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getGroupId

          +
          +public int getGroupId()
          +
          +
          Get the group id. +

          +

          +
          +
          +
          + +
          Returns:
          the group id
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setLinkedFile

          +
          +public void setLinkedFile(java.lang.String name)
          +
          +
          Indicate that this entry is a symbolic link to the given filename. +

          +

          +
          +
          +
          +
          Parameters:
          name - Name of the file this entry links to, empty String + if it is not a symbolic link.
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getLinkedFile

          +
          +public java.lang.String getLinkedFile()
          +
          +
          Name of linked file +

          +

          +
          +
          +
          + +
          Returns:
          name of the file this entry links to if it is a + symbolic link, the empty string otherwise.
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +isLink

          +
          +public boolean isLink()
          +
          +
          Is this entry a symbolic link? +

          +

          +
          +
          +
          + +
          Returns:
          true if this is a symbolic link
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setMode

          +
          +public void setMode(int mode)
          +
          +
          File mode of this file. +

          +

          +
          +
          +
          +
          Parameters:
          mode - the file mode
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getMode

          +
          +public int getMode()
          +
          +
          File mode of this file. +

          +

          +
          +
          +
          + +
          Returns:
          the file mode
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setDirectory

          +
          +public void setDirectory(boolean dirFlag)
          +
          +
          Indicate whether this entry is a directory. +

          +

          +
          +
          +
          +
          Parameters:
          dirFlag - if true, this entry is a directory
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Is this entry a directory? +

          +

          +
          +
          +
          + +
          Returns:
          true if this entry is a directory
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +public void parseFromLocalFileData(byte[] data,
+                                   int offset,
+                                   int length)
+                            throws java.util.zip.ZipException
          +
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Specified by:
          parseFromLocalFileData in interface ZipExtraField
          +
          +
          +
          Parameters:
          data - an array of bytes
          offset - the start offset
          length - the number of bytes in the array from offset +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getMode

          +
          +protected int getMode(int mode)
          +
          +
          Get the file mode for given permissions with the correct file type. +

          +

          +
          +
          +
          +
          Parameters:
          mode - the mode +
          Returns:
          the type with the mode
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/CentralDirectoryParsingZipExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/CentralDirectoryParsingZipExtraField.html new file mode 100644 index 000000000..d019b346d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/CentralDirectoryParsingZipExtraField.html @@ -0,0 +1,237 @@ + + + + + + +CentralDirectoryParsingZipExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Interface CentralDirectoryParsingZipExtraField

          +
          +
          All Superinterfaces:
          ZipExtraField
          +
          +
          +
          All Known Implementing Classes:
          UnparseableExtraFieldData, UnrecognizedExtraField
          +
          +
          +
          +
          public interface CentralDirectoryParsingZipExtraField
          extends ZipExtraField
          + + +

          +ZipExtraField that knows how to parse central + directory data. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.0
          +
          +
          + +

          + + + + + + + + + + + + +
          +Method Summary
          + voidparseFromCentralDirectoryData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in central directory data.
          +  + + + + + + + +
          Methods inherited from interface org.apache.tools.zip.ZipExtraField
          getCentralDirectoryData, getCentralDirectoryLength, getHeaderId, getLocalFileDataData, getLocalFileDataLength, parseFromLocalFileData
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +parseFromCentralDirectoryData

          +
          +void parseFromCentralDirectoryData(byte[] data,
+                                   int offset,
+                                   int length)
+                                   throws java.util.zip.ZipException
          +
          +
          Populate data from this array as if it was in central directory data. +

          +

          +
          +
          +
          +
          Parameters:
          data - an array of bytes
          offset - the start offset
          length - the number of bytes in the array from offset +
          Throws: +
          java.util.zip.ZipException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.UnparseableExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.UnparseableExtraField.html new file mode 100644 index 000000000..59e06ba83 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.UnparseableExtraField.html @@ -0,0 +1,364 @@ + + + + + + +ExtraFieldUtils.UnparseableExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ExtraFieldUtils.UnparseableExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ExtraFieldUtils.UnparseableExtraField
+
          +
          +
          Enclosing class:
          ExtraFieldUtils
          +
          +
          +
          +
          public static final class ExtraFieldUtils.UnparseableExtraField
          extends java.lang.Object
          + + +

          +"enum" for the possible actions to take if the extra field + cannot be parsed. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static ExtraFieldUtils.UnparseableExtraFieldREAD + +
          +          Read the extra field data into an instance of UnparseableExtraFieldData.
          +static intREAD_KEY + +
          +          Key for "read" action.
          +static ExtraFieldUtils.UnparseableExtraFieldSKIP + +
          +          Skip the extra field entirely and don't make its data + available - effectively removing the extra field data.
          +static intSKIP_KEY + +
          +          Key for "skip" action.
          +static ExtraFieldUtils.UnparseableExtraFieldTHROW + +
          +          Throw an exception if field cannot be parsed.
          +static intTHROW_KEY + +
          +          Key for "throw an exception" action.
          +  + + + + + + + + + + + +
          +Method Summary
          + intgetKey() + +
          +          Key of the action to take.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +THROW_KEY

          +
          +public static final int THROW_KEY
          +
          +
          Key for "throw an exception" action. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +SKIP_KEY

          +
          +public static final int SKIP_KEY
          +
          +
          Key for "skip" action. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +READ_KEY

          +
          +public static final int READ_KEY
          +
          +
          Key for "read" action. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +THROW

          +
          +public static final ExtraFieldUtils.UnparseableExtraField THROW
          +
          +
          Throw an exception if field cannot be parsed. +

          +

          +
          +
          +
          + +

          +SKIP

          +
          +public static final ExtraFieldUtils.UnparseableExtraField SKIP
          +
          +
          Skip the extra field entirely and don't make its data + available - effectively removing the extra field data. +

          +

          +
          +
          +
          + +

          +READ

          +
          +public static final ExtraFieldUtils.UnparseableExtraField READ
          +
          +
          Read the extra field data into an instance of UnparseableExtraFieldData. +

          +

          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getKey

          +
          +public int getKey()
          +
          +
          Key of the action to take. +

          +

          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.html new file mode 100644 index 000000000..cdd3a61bf --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ExtraFieldUtils.html @@ -0,0 +1,451 @@ + + + + + + +ExtraFieldUtils (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ExtraFieldUtils

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ExtraFieldUtils
+
          +
          +
          +
          public class ExtraFieldUtils
          extends java.lang.Object
          + + +

          +ZipExtraField related methods +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classExtraFieldUtils.UnparseableExtraField + +
          +          "enum" for the possible actions to take if the extra field + cannot be parsed.
          +  + + + + + + + + + + +
          +Constructor Summary
          ExtraFieldUtils() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +static ZipExtraFieldcreateExtraField(ZipShort headerId) + +
          +          Create an instance of the approriate ExtraField, falls back to + UnrecognizedExtraField.
          +static byte[]mergeCentralDirectoryData(ZipExtraField[] data) + +
          +          Merges the central directory fields of the given ZipExtraFields.
          +static byte[]mergeLocalFileDataData(ZipExtraField[] data) + +
          +          Merges the local file data fields of the given ZipExtraFields.
          +static ZipExtraField[]parse(byte[] data) + +
          +          Split the array into ExtraFields and populate them with the + given data as local file data, throwing an exception if the + data cannot be parsed.
          +static ZipExtraField[]parse(byte[] data, + boolean local) + +
          +          Split the array into ExtraFields and populate them with the + given data, throwing an exception if the data cannot be parsed.
          +static ZipExtraField[]parse(byte[] data, + boolean local, + ExtraFieldUtils.UnparseableExtraField onUnparseableData) + +
          +          Split the array into ExtraFields and populate them with the + given data.
          +static voidregister(java.lang.Class c) + +
          +          Register a ZipExtraField implementation.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ExtraFieldUtils

          +
          +public ExtraFieldUtils()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +register

          +
          +public static void register(java.lang.Class c)
          +
          +
          Register a ZipExtraField implementation. + +

          The given class must have a no-arg constructor and implement + the ZipExtraField interface.

          +

          +

          +
          Parameters:
          c - the class to register
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +createExtraField

          +
          +public static ZipExtraField createExtraField(ZipShort headerId)
+                                      throws java.lang.InstantiationException,
+                                             java.lang.IllegalAccessException
          +
          +
          Create an instance of the approriate ExtraField, falls back to + UnrecognizedExtraField. +

          +

          +
          Parameters:
          headerId - the header identifier +
          Returns:
          an instance of the appropiate ExtraField +
          Throws: +
          java.lang.InstantiationException - if unable to instantiate the class +
          java.lang.IllegalAccessException - if not allowed to instatiate the class
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +parse

          +
          +public static ZipExtraField[] parse(byte[] data)
+                             throws java.util.zip.ZipException
          +
          +
          Split the array into ExtraFields and populate them with the + given data as local file data, throwing an exception if the + data cannot be parsed. +

          +

          +
          Parameters:
          data - an array of bytes as it appears in local file data +
          Returns:
          an array of ExtraFields +
          Throws: +
          java.util.zip.ZipException - on error
          +
          +
          +
          + +

          +parse

          +
          +public static ZipExtraField[] parse(byte[] data,
+                                    boolean local)
+                             throws java.util.zip.ZipException
          +
          +
          Split the array into ExtraFields and populate them with the + given data, throwing an exception if the data cannot be parsed. +

          +

          +
          Parameters:
          data - an array of bytes
          local - whether data originates from the local file data + or the central directory +
          Returns:
          an array of ExtraFields +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +parse

          +
          +public static ZipExtraField[] parse(byte[] data,
+                                    boolean local,
+                                    ExtraFieldUtils.UnparseableExtraField onUnparseableData)
+                             throws java.util.zip.ZipException
          +
          +
          Split the array into ExtraFields and populate them with the + given data. +

          +

          +
          Parameters:
          data - an array of bytes
          local - whether data originates from the local file data + or the central directory
          onUnparseableData - what to do if the extra field data + cannot be parsed. +
          Returns:
          an array of ExtraFields +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          Ant 1.8.1
          +
          +
          +
          +
          + +

          +mergeLocalFileDataData

          +
          +public static byte[] mergeLocalFileDataData(ZipExtraField[] data)
          +
          +
          Merges the local file data fields of the given ZipExtraFields. +

          +

          +
          Parameters:
          data - an array of ExtraFiles +
          Returns:
          an array of bytes
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +mergeCentralDirectoryData

          +
          +public static byte[] mergeCentralDirectoryData(ZipExtraField[] data)
          +
          +
          Merges the central directory fields of the given ZipExtraFields. +

          +

          +
          Parameters:
          data - an array of ExtraFields +
          Returns:
          an array of bytes
          Since:
          +
          1.1
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/JarMarker.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/JarMarker.html new file mode 100644 index 000000000..83f6b680f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/JarMarker.html @@ -0,0 +1,433 @@ + + + + + + +JarMarker (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class JarMarker

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.JarMarker
+
          +
          +
          All Implemented Interfaces:
          ZipExtraField
          +
          +
          +
          +
          public final class JarMarker
          extends java.lang.Object
          implements ZipExtraField
          + + +

          +If this extra field is added as the very first extra field of the + archive, Solaris will consider it an executable jar file. +

          + +

          +

          +
          Since:
          +
          Ant 1.6.3
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          JarMarker() + +
          +          No-arg constructor
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + byte[]getCentralDirectoryData() + +
          +          The actual data to put central directory - without Header-ID or + length specifier.
          + ZipShortgetCentralDirectoryLength() + +
          +          Length of the extra field in the central directory - without + Header-ID or length specifier.
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          +static JarMarkergetInstance() + +
          +          Since JarMarker is stateless we can always use the same instance.
          + byte[]getLocalFileDataData() + +
          +          The actual data to put into local file data - without Header-ID + or length specifier.
          + ZipShortgetLocalFileDataLength() + +
          +          Length of the extra field in the local file data - without + Header-ID or length specifier.
          + voidparseFromLocalFileData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +JarMarker

          +
          +public JarMarker()
          +
          +
          No-arg constructor +

          +

          + + + + + + + + +
          +Method Detail
          + +

          +getInstance

          +
          +public static JarMarker getInstance()
          +
          +
          Since JarMarker is stateless we can always use the same instance. +

          +

          +
          +
          +
          + +
          Returns:
          the DEFAULT jarmaker.
          +
          +
          +
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          The Header-ID. +

          +

          +
          Specified by:
          getHeaderId in interface ZipExtraField
          +
          +
          + +
          Returns:
          the header id
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +public ZipShort getLocalFileDataLength()
          +
          +
          Length of the extra field in the local file data - without + Header-ID or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          0
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +public ZipShort getCentralDirectoryLength()
          +
          +
          Length of the extra field in the central directory - without + Header-ID or length specifier. +

          +

          +
          Specified by:
          getCentralDirectoryLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          0
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +public byte[] getLocalFileDataData()
          +
          +
          The actual data to put into local file data - without Header-ID + or length specifier. +

          +

          +
          Specified by:
          getLocalFileDataData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +public byte[] getCentralDirectoryData()
          +
          +
          The actual data to put central directory - without Header-ID or + length specifier. +

          +

          +
          Specified by:
          getCentralDirectoryData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the data
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +public void parseFromLocalFileData(byte[] data,
+                                   int offset,
+                                   int length)
+                            throws java.util.zip.ZipException
          +
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Specified by:
          parseFromLocalFileData in interface ZipExtraField
          +
          +
          +
          Parameters:
          data - an array of bytes
          offset - the start offset
          length - the number of bytes in the array from offset +
          Throws: +
          java.util.zip.ZipException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodeCommentExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodeCommentExtraField.html new file mode 100644 index 000000000..4d6cd8e50 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodeCommentExtraField.html @@ -0,0 +1,366 @@ + + + + + + +UnicodeCommentExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class UnicodeCommentExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.AbstractUnicodeExtraField
+      extended by org.apache.tools.zip.UnicodeCommentExtraField
+
          +
          +
          All Implemented Interfaces:
          ZipExtraField
          +
          +
          +
          +
          public class UnicodeCommentExtraField
          extends AbstractUnicodeExtraField
          + + +

          +Info-ZIP Unicode Comment Extra Field (0x6375): + +

          Stores the UTF-8 version of the file comment as stored in the + central directory header.

          + + 
          +         Value         Size        Description
+         -----         ----        -----------
+  (UCom) 0x6375        Short       tag for this extra block type ("uc")
+         TSize         Short       total data size for this block
+         Version       1 byte      version of this extra field, currently 1
+         ComCRC32      4 bytes     Comment Field CRC32 Checksum
+         UnicodeCom    Variable    UTF-8 version of the entry comment
+
          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static ZipShortUCOM_ID + +
          +           
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          UnicodeCommentExtraField() + +
          +           
          UnicodeCommentExtraField(java.lang.String comment, + byte[] bytes) + +
          +          Assemble as unicode comment extension from the comment given as + text as well as the bytes actually written to the archive.
          UnicodeCommentExtraField(java.lang.String text, + byte[] bytes, + int off, + int len) + +
          +          Assemble as unicode comment extension from the name given as + text as well as the encoded bytes actually written to the archive.
          +  + + + + + + + + + + + +
          +Method Summary
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.zip.AbstractUnicodeExtraField
          getCentralDirectoryData, getCentralDirectoryLength, getLocalFileDataData, getLocalFileDataLength, getNameCRC32, getUnicodeName, parseFromLocalFileData, setNameCRC32, setUnicodeName
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +UCOM_ID

          +
          +public static final ZipShort UCOM_ID
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +UnicodeCommentExtraField

          +
          +public UnicodeCommentExtraField()
          +
          +
          +
          + +

          +UnicodeCommentExtraField

          +
          +public UnicodeCommentExtraField(java.lang.String text,
+                                byte[] bytes,
+                                int off,
+                                int len)
          +
          +
          Assemble as unicode comment extension from the name given as + text as well as the encoded bytes actually written to the archive. +

          +

          +
          Parameters:
          text - The file name
          bytes - the bytes actually written to the archive
          off - The offset of the encoded comment in bytes.
          len - The length of the encoded comment or comment in + bytes.
          +
          +
          + +

          +UnicodeCommentExtraField

          +
          +public UnicodeCommentExtraField(java.lang.String comment,
+                                byte[] bytes)
          +
          +
          Assemble as unicode comment extension from the comment given as + text as well as the bytes actually written to the archive. +

          +

          +
          Parameters:
          comment - The file comment
          bytes - the bytes actually written to the archive
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          Description copied from interface: ZipExtraField
          +
          The Header-ID. +

          +

          + +
          Returns:
          the header id
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodePathExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodePathExtraField.html new file mode 100644 index 000000000..2e09b60f1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnicodePathExtraField.html @@ -0,0 +1,366 @@ + + + + + + +UnicodePathExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class UnicodePathExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.AbstractUnicodeExtraField
+      extended by org.apache.tools.zip.UnicodePathExtraField
+
          +
          +
          All Implemented Interfaces:
          ZipExtraField
          +
          +
          +
          +
          public class UnicodePathExtraField
          extends AbstractUnicodeExtraField
          + + +

          +Info-ZIP Unicode Path Extra Field (0x7075): + +

          Stores the UTF-8 version of the file name field as stored in the + local header and central directory header.

          + + 
          +         Value         Size        Description
+         -----         ----        -----------
+ (UPath) 0x7075        Short       tag for this extra block type ("up")
+         TSize         Short       total data size for this block
+         Version       1 byte      version of this extra field, currently 1
+         NameCRC32     4 bytes     File Name Field CRC32 Checksum
+         UnicodeName   Variable    UTF-8 version of the entry File Name
+
          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Field Summary
          +static ZipShortUPATH_ID + +
          +           
          +  + + + + + + + + + + + + + + + + +
          +Constructor Summary
          UnicodePathExtraField() + +
          +           
          UnicodePathExtraField(java.lang.String name, + byte[] bytes) + +
          +          Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive.
          UnicodePathExtraField(java.lang.String text, + byte[] bytes, + int off, + int len) + +
          +          Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive.
          +  + + + + + + + + + + + +
          +Method Summary
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          +  + + + + + + + +
          Methods inherited from class org.apache.tools.zip.AbstractUnicodeExtraField
          getCentralDirectoryData, getCentralDirectoryLength, getLocalFileDataData, getLocalFileDataLength, getNameCRC32, getUnicodeName, parseFromLocalFileData, setNameCRC32, setUnicodeName
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +UPATH_ID

          +
          +public static final ZipShort UPATH_ID
          +
          +
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +UnicodePathExtraField

          +
          +public UnicodePathExtraField()
          +
          +
          +
          + +

          +UnicodePathExtraField

          +
          +public UnicodePathExtraField(java.lang.String text,
+                             byte[] bytes,
+                             int off,
+                             int len)
          +
          +
          Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive. +

          +

          +
          Parameters:
          text - The file name
          bytes - the bytes actually written to the archive
          off - The offset of the encoded filename in bytes.
          len - The length of the encoded filename or comment in + bytes.
          +
          +
          + +

          +UnicodePathExtraField

          +
          +public UnicodePathExtraField(java.lang.String name,
+                             byte[] bytes)
          +
          +
          Assemble as unicode path extension from the name given as + text as well as the encoded bytes actually written to the archive. +

          +

          +
          Parameters:
          name - The file name
          bytes - the bytes actually written to the archive
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          Description copied from interface: ZipExtraField
          +
          The Header-ID. +

          +

          + +
          Returns:
          the header id
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnixStat.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnixStat.html new file mode 100644 index 000000000..504eb7224 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnixStat.html @@ -0,0 +1,342 @@ + + + + + + +UnixStat (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Interface UnixStat

          +
          +
          All Known Implementing Classes:
          AsiExtraField
          +
          +
          +
          +
          public interface UnixStat
          + + +

          +Constants from stat.h on Unix systems. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intDEFAULT_DIR_PERM + +
          +          Default permissions for directories.
          +static intDEFAULT_FILE_PERM + +
          +          Default permissions for plain files.
          +static intDEFAULT_LINK_PERM + +
          +          Default permissions for symbolic links.
          +static intDIR_FLAG + +
          +          Indicates directories.
          +static intFILE_FLAG + +
          +          Indicates plain files.
          +static intLINK_FLAG + +
          +          Indicates symbolic links.
          +static intPERM_MASK + +
          +          Bits used for permissions (and sticky bit)
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +PERM_MASK

          +
          +static final int PERM_MASK
          +
          +
          Bits used for permissions (and sticky bit) +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LINK_FLAG

          +
          +static final int LINK_FLAG
          +
          +
          Indicates symbolic links. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +FILE_FLAG

          +
          +static final int FILE_FLAG
          +
          +
          Indicates plain files. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DIR_FLAG

          +
          +static final int DIR_FLAG
          +
          +
          Indicates directories. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_LINK_PERM

          +
          +static final int DEFAULT_LINK_PERM
          +
          +
          Default permissions for symbolic links. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_DIR_PERM

          +
          +static final int DEFAULT_DIR_PERM
          +
          +
          Default permissions for directories. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_FILE_PERM

          +
          +static final int DEFAULT_FILE_PERM
          +
          +
          Default permissions for plain files. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnparseableExtraFieldData.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnparseableExtraFieldData.html new file mode 100644 index 000000000..54ff736e1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnparseableExtraFieldData.html @@ -0,0 +1,428 @@ + + + + + + +UnparseableExtraFieldData (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class UnparseableExtraFieldData

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.UnparseableExtraFieldData
+
          +
          +
          All Implemented Interfaces:
          CentralDirectoryParsingZipExtraField, ZipExtraField
          +
          +
          +
          +
          public final class UnparseableExtraFieldData
          extends java.lang.Object
          implements CentralDirectoryParsingZipExtraField
          + + +

          +Wrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data. + +

          The header-id is artificial (and not listed as a know ID in + the .ZIP File Format Specification). + Since it isn't used anywhere except to satisfy the + ZipExtraField contract it shouldn't matter anyway.

          +

          + +

          +

          +
          Since:
          +
          Ant 1.8.1
          +
          See Also:
          .ZIP File Format Specification
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          UnparseableExtraFieldData() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + byte[]getCentralDirectoryData() + +
          +          The actual data to put into central directory.
          + ZipShortgetCentralDirectoryLength() + +
          +          Length of the complete extra field in the central directory.
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          + byte[]getLocalFileDataData() + +
          +          The actual data to put into local file data.
          + ZipShortgetLocalFileDataLength() + +
          +          Length of the complete extra field in the local file data.
          + voidparseFromCentralDirectoryData(byte[] buffer, + int offset, + int length) + +
          +          Populate data from this array as if it was in central directory data.
          + voidparseFromLocalFileData(byte[] buffer, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +UnparseableExtraFieldData

          +
          +public UnparseableExtraFieldData()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          The Header-ID. +

          +

          +
          Specified by:
          getHeaderId in interface ZipExtraField
          +
          +
          + +
          Returns:
          a completely arbitrary value that should be ignored.
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +public ZipShort getLocalFileDataLength()
          +
          +
          Length of the complete extra field in the local file data. +

          +

          +
          Specified by:
          getLocalFileDataLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          The LocalFileDataLength value
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +public ZipShort getCentralDirectoryLength()
          +
          +
          Length of the complete extra field in the central directory. +

          +

          +
          Specified by:
          getCentralDirectoryLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          The CentralDirectoryLength value
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +public byte[] getLocalFileDataData()
          +
          +
          The actual data to put into local file data. +

          +

          +
          Specified by:
          getLocalFileDataData in interface ZipExtraField
          +
          +
          + +
          Returns:
          The LocalFileDataData value
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +public byte[] getCentralDirectoryData()
          +
          +
          The actual data to put into central directory. +

          +

          +
          Specified by:
          getCentralDirectoryData in interface ZipExtraField
          +
          +
          + +
          Returns:
          The CentralDirectoryData value
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +public void parseFromLocalFileData(byte[] buffer,
+                                   int offset,
+                                   int length)
          +
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Specified by:
          parseFromLocalFileData in interface ZipExtraField
          +
          +
          +
          Parameters:
          buffer - the buffer to read data from
          offset - offset into buffer to read data
          length - the length of data
          +
          +
          +
          + +

          +parseFromCentralDirectoryData

          +
          +public void parseFromCentralDirectoryData(byte[] buffer,
+                                          int offset,
+                                          int length)
          +
          +
          Populate data from this array as if it was in central directory data. +

          +

          +
          Specified by:
          parseFromCentralDirectoryData in interface CentralDirectoryParsingZipExtraField
          +
          +
          +
          Parameters:
          buffer - the buffer to read data from
          offset - offset into buffer to read data
          length - the length of data +
          Throws: +
          ZipException - on error
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnrecognizedExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnrecognizedExtraField.html new file mode 100644 index 000000000..1fa5b6008 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/UnrecognizedExtraField.html @@ -0,0 +1,497 @@ + + + + + + +UnrecognizedExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class UnrecognizedExtraField

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.UnrecognizedExtraField
+
          +
          +
          All Implemented Interfaces:
          CentralDirectoryParsingZipExtraField, ZipExtraField
          +
          +
          +
          +
          public class UnrecognizedExtraField
          extends java.lang.Object
          implements CentralDirectoryParsingZipExtraField
          + + +

          +Simple placeholder for all those extra fields we don't want to deal + with. + +

          Assumes local file data and central directory entries are + identical - unless told the opposite.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Constructor Summary
          UnrecognizedExtraField() + +
          +           
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + byte[]getCentralDirectoryData() + +
          +          Get the central data.
          + ZipShortgetCentralDirectoryLength() + +
          +          Get the central data length.
          + ZipShortgetHeaderId() + +
          +          Get the header id.
          + byte[]getLocalFileDataData() + +
          +          Get the local data.
          + ZipShortgetLocalFileDataLength() + +
          +          Get the length of the local data.
          + voidparseFromCentralDirectoryData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in central directory data.
          + voidparseFromLocalFileData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          + voidsetCentralDirectoryData(byte[] data) + +
          +          Set the extra field data in central directory.
          + voidsetHeaderId(ZipShort headerId) + +
          +          Set the header id.
          + voidsetLocalFileDataData(byte[] data) + +
          +          Set the extra field data in the local file data - + without Header-ID or length specifier.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +UnrecognizedExtraField

          +
          +public UnrecognizedExtraField()
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +setHeaderId

          +
          +public void setHeaderId(ZipShort headerId)
          +
          +
          Set the header id. +

          +

          +
          +
          +
          +
          Parameters:
          headerId - the header id to use
          +
          +
          +
          + +

          +getHeaderId

          +
          +public ZipShort getHeaderId()
          +
          +
          Get the header id. +

          +

          +
          Specified by:
          getHeaderId in interface ZipExtraField
          +
          +
          + +
          Returns:
          the header id
          +
          +
          +
          + +

          +setLocalFileDataData

          +
          +public void setLocalFileDataData(byte[] data)
          +
          +
          Set the extra field data in the local file data - + without Header-ID or length specifier. +

          +

          +
          +
          +
          +
          Parameters:
          data - the field data to use
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +public ZipShort getLocalFileDataLength()
          +
          +
          Get the length of the local data. +

          +

          +
          Specified by:
          getLocalFileDataLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          the length of the local data
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +public byte[] getLocalFileDataData()
          +
          +
          Get the local data. +

          +

          +
          Specified by:
          getLocalFileDataData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the local data
          +
          +
          +
          + +

          +setCentralDirectoryData

          +
          +public void setCentralDirectoryData(byte[] data)
          +
          +
          Set the extra field data in central directory. +

          +

          +
          +
          +
          +
          Parameters:
          data - the data to use
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +public ZipShort getCentralDirectoryLength()
          +
          +
          Get the central data length. + If there is no central data, get the local file data length. +

          +

          +
          Specified by:
          getCentralDirectoryLength in interface ZipExtraField
          +
          +
          + +
          Returns:
          the central data length
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +public byte[] getCentralDirectoryData()
          +
          +
          Get the central data. +

          +

          +
          Specified by:
          getCentralDirectoryData in interface ZipExtraField
          +
          +
          + +
          Returns:
          the central data if present, else return the local file data
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +public void parseFromLocalFileData(byte[] data,
+                                   int offset,
+                                   int length)
          +
          +
          Description copied from interface: ZipExtraField
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Specified by:
          parseFromLocalFileData in interface ZipExtraField
          +
          +
          +
          Parameters:
          data - the array of bytes.
          offset - the source location in the data array.
          length - the number of bytes to use in the data array.
          See Also:
          ZipExtraField.parseFromLocalFileData(byte[], int, int)
          +
          +
          +
          + +

          +parseFromCentralDirectoryData

          +
          +public void parseFromCentralDirectoryData(byte[] data,
+                                          int offset,
+                                          int length)
          +
          +
          Description copied from interface: CentralDirectoryParsingZipExtraField
          +
          Populate data from this array as if it was in central directory data. +

          +

          +
          Specified by:
          parseFromCentralDirectoryData in interface CentralDirectoryParsingZipExtraField
          +
          +
          +
          Parameters:
          data - the array of bytes.
          offset - the source location in the data array.
          length - the number of bytes to use in the data array.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipEntry.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipEntry.html new file mode 100644 index 000000000..86b7205ea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipEntry.html @@ -0,0 +1,1919 @@ + + + + + + +ZipEntry (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipEntry

          +
          +java.lang.Object
+  extended by java.util.zip.ZipEntry
+      extended by org.apache.tools.zip.ZipEntry
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public class ZipEntry
          extends java.util.zip.ZipEntry
          implements java.lang.Cloneable
          + + +

          +Extension that adds better handling of extra fields and provides + access to the internal and external file attributes. + +

          The extra data is expected to follow the recommendation of + the .ZIP File Format Specification created by PKWARE Inc. :

          +
            +
          • the extra byte array consists of a sequence of extra fields
            • +
          • each extra fields starts by a two byte header id followed by + a two byte sequence holding the length of the remainder of + data.
            • +
          + +

          Any extra data that cannot be parsed by the rules above will be + consumed as "unparseable" extra data and treated differently by the + methods of this class. Versions prior to Apache Commons Compress + 1.1 would have thrown an exception if any attempt was made to read + or write extra data not conforming to the recommendation.

          +

          + +

          +

          +
          See Also:
          + .ZIP File Format Specification
          +
          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static intCENATT + +
          +           
          +static intCENATX + +
          +           
          +static intCENCOM + +
          +           
          +static intCENCRC + +
          +           
          +static intCENDSK + +
          +           
          +static intCENEXT + +
          +           
          +static intCENFLG + +
          +           
          +static intCENHDR + +
          +           
          +static intCENHOW + +
          +           
          +static intCENLEN + +
          +           
          +static intCENNAM + +
          +           
          +static intCENOFF + +
          +           
          +static longCENSIG + +
          +           
          +static intCENSIZ + +
          +           
          +static intCENTIM + +
          +           
          +static intCENVEM + +
          +           
          +static intCENVER + +
          +           
          +static intENDCOM + +
          +           
          +static intENDHDR + +
          +           
          +static intENDOFF + +
          +           
          +static longENDSIG + +
          +           
          +static intENDSIZ + +
          +           
          +static intENDSUB + +
          +           
          +static intENDTOT + +
          +           
          +static intEXTCRC + +
          +           
          +static intEXTHDR + +
          +           
          +static intEXTLEN + +
          +           
          +static longEXTSIG + +
          +           
          +static intEXTSIZ + +
          +           
          +static intLOCCRC + +
          +           
          +static intLOCEXT + +
          +           
          +static intLOCFLG + +
          +           
          +static intLOCHDR + +
          +           
          +static intLOCHOW + +
          +           
          +static intLOCLEN + +
          +           
          +static intLOCNAM + +
          +           
          +static longLOCSIG + +
          +           
          +static intLOCSIZ + +
          +           
          +static intLOCTIM + +
          +           
          +static intLOCVER + +
          +           
          +static intPLATFORM_FAT + +
          +           
          +static intPLATFORM_UNIX + +
          +           
          +  + + + + + + + +
          Fields inherited from class java.util.zip.ZipEntry
          DEFLATED, STORED
          +  + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          +protected ZipEntry() + +
          +           
          + ZipEntry(java.lang.String name) + +
          +          Creates a new zip entry with the specified name.
          + ZipEntry(java.util.zip.ZipEntry entry) + +
          +          Creates a new zip entry with fields taken from the specified zip entry.
          + ZipEntry(ZipEntry entry) + +
          +          Creates a new zip entry with fields taken from the specified zip entry.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidaddAsFirstExtraField(ZipExtraField ze) + +
          +          Adds an extra field - replacing an already present extra field + of the same type.
          + voidaddExtraField(ZipExtraField ze) + +
          +          Adds an extra field - replacing an already present extra field + of the same type.
          + java.lang.Objectclone() + +
          +          Overwrite clone.
          + booleanequals(java.lang.Object o) + +
          +          The equality method.
          + byte[]getCentralDirectoryExtra() + +
          +          Retrieves the extra data for the central directory.
          + longgetExternalAttributes() + +
          +          Retrieves the external file attributes.
          + ZipExtraFieldgetExtraField(ZipShort type) + +
          +          Looks up an extra field by its header id.
          + ZipExtraField[]getExtraFields() + +
          +          Retrieves all extra fields that have been parsed successfully.
          + ZipExtraField[]getExtraFields(boolean includeUnparseable) + +
          +          Retrieves extra fields.
          + intgetInternalAttributes() + +
          +          Retrieves the internal file attributes.
          + byte[]getLocalFileDataExtra() + +
          +          Retrieves the extra data for the local file data.
          + java.lang.StringgetName() + +
          +          Get the name of the entry.
          + intgetPlatform() + +
          +          Platform specification to put into the "version made + by" part of the central file header.
          + intgetUnixMode() + +
          +          Unix permission.
          + UnparseableExtraFieldDatagetUnparseableExtraFieldData() + +
          +          Looks up extra field data that couldn't be parsed correctly.
          + inthashCode() + +
          +          Get the hashCode of the entry.
          + booleanisDirectory() + +
          +          Is this entry a directory?
          + voidremoveExtraField(ZipShort type) + +
          +          Remove an extra field.
          + voidremoveUnparseableExtraFieldData() + +
          +          Removes unparseable extra field data.
          + voidsetCentralDirectoryExtra(byte[] b) + +
          +          Sets the central directory part of extra fields.
          + voidsetComprSize(long size) + +
          +          Deprecated. since 1.7. + Use setCompressedSize directly.
          + voidsetExternalAttributes(long value) + +
          +          Sets the external file attributes.
          +protected  voidsetExtra() + +
          +          Unfortunately java.util.zip.ZipOutputStream seems to access the extra data + directly, so overriding getExtra doesn't help - we need to + modify super's data directly.
          + voidsetExtra(byte[] extra) + +
          +          Parses the given bytes as extra field data and consumes any + unparseable data as an UnparseableExtraFieldData + instance.
          + voidsetExtraFields(ZipExtraField[] fields) + +
          +          Replaces all currently attached extra fields with the new array.
          + voidsetInternalAttributes(int value) + +
          +          Sets the internal file attributes.
          +protected  voidsetName(java.lang.String name) + +
          +          Set the name of the entry.
          +protected  voidsetPlatform(int platform) + +
          +          Set the platform (UNIX or FAT).
          + voidsetUnixMode(int mode) + +
          +          Sets Unix permissions in a way that is understood by Info-Zip's + unzip command.
          +  + + + + + + + +
          Methods inherited from class java.util.zip.ZipEntry
          getComment, getCompressedSize, getCrc, getExtra, getMethod, getSize, getTime, setComment, setCompressedSize, setCrc, setMethod, setSize, setTime, toString
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +PLATFORM_UNIX

          +
          +public static final int PLATFORM_UNIX
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +PLATFORM_FAT

          +
          +public static final int PLATFORM_FAT
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCSIG

          +
          +public static final long LOCSIG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EXTSIG

          +
          +public static final long EXTSIG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENSIG

          +
          +public static final long CENSIG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDSIG

          +
          +public static final long ENDSIG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCHDR

          +
          +public static final int LOCHDR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EXTHDR

          +
          +public static final int EXTHDR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENHDR

          +
          +public static final int CENHDR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDHDR

          +
          +public static final int ENDHDR
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCVER

          +
          +public static final int LOCVER
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCFLG

          +
          +public static final int LOCFLG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCHOW

          +
          +public static final int LOCHOW
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCTIM

          +
          +public static final int LOCTIM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCCRC

          +
          +public static final int LOCCRC
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCSIZ

          +
          +public static final int LOCSIZ
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCLEN

          +
          +public static final int LOCLEN
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCNAM

          +
          +public static final int LOCNAM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +LOCEXT

          +
          +public static final int LOCEXT
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EXTCRC

          +
          +public static final int EXTCRC
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EXTSIZ

          +
          +public static final int EXTSIZ
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EXTLEN

          +
          +public static final int EXTLEN
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENVEM

          +
          +public static final int CENVEM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENVER

          +
          +public static final int CENVER
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENFLG

          +
          +public static final int CENFLG
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENHOW

          +
          +public static final int CENHOW
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENTIM

          +
          +public static final int CENTIM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENCRC

          +
          +public static final int CENCRC
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENSIZ

          +
          +public static final int CENSIZ
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENLEN

          +
          +public static final int CENLEN
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENNAM

          +
          +public static final int CENNAM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENEXT

          +
          +public static final int CENEXT
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENCOM

          +
          +public static final int CENCOM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENDSK

          +
          +public static final int CENDSK
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENATT

          +
          +public static final int CENATT
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENATX

          +
          +public static final int CENATX
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +CENOFF

          +
          +public static final int CENOFF
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDSUB

          +
          +public static final int ENDSUB
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDTOT

          +
          +public static final int ENDTOT
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDSIZ

          +
          +public static final int ENDSIZ
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDOFF

          +
          +public static final int ENDOFF
          +
          +
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +ENDCOM

          +
          +public static final int ENDCOM
          +
          +
          +
          See Also:
          Constant Field Values
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipEntry

          +
          +public ZipEntry(java.lang.String name)
          +
          +
          Creates a new zip entry with the specified name. +

          +

          +
          Parameters:
          name - the name of the entry
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipEntry

          +
          +public ZipEntry(java.util.zip.ZipEntry entry)
+         throws java.util.zip.ZipException
          +
          +
          Creates a new zip entry with fields taken from the specified zip entry. +

          +

          +
          Parameters:
          entry - the entry to get fields from +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipEntry

          +
          +public ZipEntry(ZipEntry entry)
+         throws java.util.zip.ZipException
          +
          +
          Creates a new zip entry with fields taken from the specified zip entry. +

          +

          +
          Parameters:
          entry - the entry to get fields from +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipEntry

          +
          +protected ZipEntry()
          +
          +
          +
          Since:
          +
          1.9
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          Overwrite clone. +

          +

          +
          Overrides:
          clone in class java.util.zip.ZipEntry
          +
          +
          + +
          Returns:
          a cloned copy of this ZipEntry
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getInternalAttributes

          +
          +public int getInternalAttributes()
          +
          +
          Retrieves the internal file attributes. +

          +

          +
          +
          +
          + +
          Returns:
          the internal file attributes
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setInternalAttributes

          +
          +public void setInternalAttributes(int value)
          +
          +
          Sets the internal file attributes. +

          +

          +
          +
          +
          +
          Parameters:
          value - an int value
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getExternalAttributes

          +
          +public long getExternalAttributes()
          +
          +
          Retrieves the external file attributes. +

          +

          +
          +
          +
          + +
          Returns:
          the external file attributes
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setExternalAttributes

          +
          +public void setExternalAttributes(long value)
          +
          +
          Sets the external file attributes. +

          +

          +
          +
          +
          +
          Parameters:
          value - an long value
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setUnixMode

          +
          +public void setUnixMode(int mode)
          +
          +
          Sets Unix permissions in a way that is understood by Info-Zip's + unzip command. +

          +

          +
          +
          +
          +
          Parameters:
          mode - an int value
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +getUnixMode

          +
          +public int getUnixMode()
          +
          +
          Unix permission. +

          +

          +
          +
          +
          + +
          Returns:
          the unix permissions
          Since:
          +
          Ant 1.6
          +
          +
          +
          +
          + +

          +getPlatform

          +
          +public int getPlatform()
          +
          +
          Platform specification to put into the "version made + by" part of the central file header. +

          +

          +
          +
          +
          + +
          Returns:
          PLATFORM_FAT unless setUnixMode + has been called, in which case PLATORM_UNIX will be returned.
          Since:
          +
          Ant 1.5.2
          +
          +
          +
          +
          + +

          +setPlatform

          +
          +protected void setPlatform(int platform)
          +
          +
          Set the platform (UNIX or FAT). +

          +

          +
          +
          +
          +
          Parameters:
          platform - an int value - 0 is FAT, 3 is UNIX
          Since:
          +
          1.9
          +
          +
          +
          +
          + +

          +setExtraFields

          +
          +public void setExtraFields(ZipExtraField[] fields)
          +
          +
          Replaces all currently attached extra fields with the new array. +

          +

          +
          +
          +
          +
          Parameters:
          fields - an array of extra fields
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getExtraFields

          +
          +public ZipExtraField[] getExtraFields()
          +
          +
          Retrieves all extra fields that have been parsed successfully. +

          +

          +
          +
          +
          + +
          Returns:
          an array of the extra fields
          +
          +
          +
          + +

          +getExtraFields

          +
          +public ZipExtraField[] getExtraFields(boolean includeUnparseable)
          +
          +
          Retrieves extra fields. +

          +

          +
          +
          +
          +
          Parameters:
          includeUnparseable - whether to also return unparseable + extra fields as UnparseableExtraFieldData if such data + exists. +
          Returns:
          an array of the extra fields
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +addExtraField

          +
          +public void addExtraField(ZipExtraField ze)
          +
          +
          Adds an extra field - replacing an already present extra field + of the same type. + +

          If no extra field of the same type exists, the field will be + added as last field.

          +

          +

          +
          +
          +
          +
          Parameters:
          ze - an extra field
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +addAsFirstExtraField

          +
          +public void addAsFirstExtraField(ZipExtraField ze)
          +
          +
          Adds an extra field - replacing an already present extra field + of the same type. + +

          The new extra field will be the first one.

          +

          +

          +
          +
          +
          +
          Parameters:
          ze - an extra field
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +removeExtraField

          +
          +public void removeExtraField(ZipShort type)
          +
          +
          Remove an extra field. +

          +

          +
          +
          +
          +
          Parameters:
          type - the type of extra field to remove
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +removeUnparseableExtraFieldData

          +
          +public void removeUnparseableExtraFieldData()
          +
          +
          Removes unparseable extra field data. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +getExtraField

          +
          +public ZipExtraField getExtraField(ZipShort type)
          +
          +
          Looks up an extra field by its header id. +

          +

          +
          +
          +
          + +
          Returns:
          null if no such field exists.
          +
          +
          +
          + +

          +getUnparseableExtraFieldData

          +
          +public UnparseableExtraFieldData getUnparseableExtraFieldData()
          +
          +
          Looks up extra field data that couldn't be parsed correctly. +

          +

          +
          +
          +
          + +
          Returns:
          null if no such field exists.
          +
          +
          +
          + +

          +setExtra

          +
          +public void setExtra(byte[] extra)
+              throws java.lang.RuntimeException
          +
          +
          Parses the given bytes as extra field data and consumes any + unparseable data as an UnparseableExtraFieldData + instance. +

          +

          +
          Overrides:
          setExtra in class java.util.zip.ZipEntry
          +
          +
          +
          Parameters:
          extra - an array of bytes to be parsed into extra fields +
          Throws: +
          java.lang.RuntimeException - if the bytes cannot be parsed +
          java.lang.RuntimeException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setExtra

          +
          +protected void setExtra()
          +
          +
          Unfortunately java.util.zip.ZipOutputStream seems to access the extra data + directly, so overriding getExtra doesn't help - we need to + modify super's data directly. +

          +

          +
          +
          +
          +
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setCentralDirectoryExtra

          +
          +public void setCentralDirectoryExtra(byte[] b)
          +
          +
          Sets the central directory part of extra fields. +

          +

          +
          +
          +
          +
          +
          +
          +
          + +

          +getLocalFileDataExtra

          +
          +public byte[] getLocalFileDataExtra()
          +
          +
          Retrieves the extra data for the local file data. +

          +

          +
          +
          +
          + +
          Returns:
          the extra data for local file
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryExtra

          +
          +public byte[] getCentralDirectoryExtra()
          +
          +
          Retrieves the extra data for the central directory. +

          +

          +
          +
          +
          + +
          Returns:
          the central directory extra data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setComprSize

          +
          +public void setComprSize(long size)
          +
          +
          Deprecated. since 1.7. + Use setCompressedSize directly. +

          +

          Make this class work in JDK 1.1 like a 1.2 class. + +

          This either stores the size for later usage or invokes + setCompressedSize via reflection.

          +

          +

          +
          +
          +
          +
          Parameters:
          size - the size to use
          Since:
          +
          1.2
          +
          +
          +
          +
          + +

          +getName

          +
          +public java.lang.String getName()
          +
          +
          Get the name of the entry. +

          +

          +
          Overrides:
          getName in class java.util.zip.ZipEntry
          +
          +
          + +
          Returns:
          the entry name
          Since:
          +
          1.9
          +
          +
          +
          +
          + +

          +isDirectory

          +
          +public boolean isDirectory()
          +
          +
          Is this entry a directory? +

          +

          +
          Overrides:
          isDirectory in class java.util.zip.ZipEntry
          +
          +
          + +
          Returns:
          true if the entry is a directory
          Since:
          +
          1.10
          +
          +
          +
          +
          + +

          +setName

          +
          +protected void setName(java.lang.String name)
          +
          +
          Set the name of the entry. +

          +

          +
          +
          +
          +
          Parameters:
          name - the name to use
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Get the hashCode of the entry. + This uses the name as the hashcode. +

          +

          +
          Overrides:
          hashCode in class java.util.zip.ZipEntry
          +
          +
          + +
          Returns:
          a hashcode.
          Since:
          +
          Ant 1.7
          +
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          The equality method. In this case, the implementation returns 'this == o' + which is basically the equals method of the Object class. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          o - the object to compare to +
          Returns:
          true if this object is the same as o
          Since:
          +
          Ant 1.7
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipExtraField.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipExtraField.html new file mode 100644 index 000000000..af7c8d2e2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipExtraField.html @@ -0,0 +1,355 @@ + + + + + + +ZipExtraField (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Interface ZipExtraField

          +
          +
          All Known Subinterfaces:
          CentralDirectoryParsingZipExtraField
          +
          +
          +
          All Known Implementing Classes:
          AbstractUnicodeExtraField, AsiExtraField, JarMarker, UnicodeCommentExtraField, UnicodePathExtraField, UnparseableExtraFieldData, UnrecognizedExtraField
          +
          +
          +
          +
          public interface ZipExtraField
          + + +

          +General format of extra field data. + +

          Extra fields usually appear twice per file, once in the local + file data and once in the central directory. Usually they are the + same, but they don't have to be. java.util.zip.ZipOutputStream will + only use the local file data in both places.

          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + byte[]getCentralDirectoryData() + +
          +          The actual data to put into central directory - without Header-ID or + length specifier.
          + ZipShortgetCentralDirectoryLength() + +
          +          Length of the extra field in the central directory - without + Header-ID or length specifier.
          + ZipShortgetHeaderId() + +
          +          The Header-ID.
          + byte[]getLocalFileDataData() + +
          +          The actual data to put into local file data - without Header-ID + or length specifier.
          + ZipShortgetLocalFileDataLength() + +
          +          Length of the extra field in the local file data - without + Header-ID or length specifier.
          + voidparseFromLocalFileData(byte[] data, + int offset, + int length) + +
          +          Populate data from this array as if it was in local file data.
          +  +

          + + + + + + + + +
          +Method Detail
          + +

          +getHeaderId

          +
          +ZipShort getHeaderId()
          +
          +
          The Header-ID. +

          +

          + +
          Returns:
          the header id
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getLocalFileDataLength

          +
          +ZipShort getLocalFileDataLength()
          +
          +
          Length of the extra field in the local file data - without + Header-ID or length specifier. +

          +

          + +
          Returns:
          the length of the field in the local file data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryLength

          +
          +ZipShort getCentralDirectoryLength()
          +
          +
          Length of the extra field in the central directory - without + Header-ID or length specifier. +

          +

          + +
          Returns:
          the length of the field in the central directory
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getLocalFileDataData

          +
          +byte[] getLocalFileDataData()
          +
          +
          The actual data to put into local file data - without Header-ID + or length specifier. +

          +

          + +
          Returns:
          the data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getCentralDirectoryData

          +
          +byte[] getCentralDirectoryData()
          +
          +
          The actual data to put into central directory - without Header-ID or + length specifier. +

          +

          + +
          Returns:
          the data
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +parseFromLocalFileData

          +
          +void parseFromLocalFileData(byte[] data,
+                            int offset,
+                            int length)
+                            throws java.util.zip.ZipException
          +
          +
          Populate data from this array as if it was in local file data. +

          +

          +
          Parameters:
          data - an array of bytes
          offset - the start offset
          length - the number of bytes in the array from offset +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.1
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipFile.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipFile.html new file mode 100644 index 000000000..8793d206f --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipFile.html @@ -0,0 +1,560 @@ + + + + + + +ZipFile (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipFile

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ZipFile
+
          +
          +
          +
          public class ZipFile
          extends java.lang.Object
          + + +

          +Replacement for java.util.ZipFile. + +

          This class adds support for file name encodings other than UTF-8 + (which is required to work on ZIP files created by native zip tools + and is able to skip a preamble like the one found in self + extracting archives. Furthermore it returns instances of + org.apache.tools.zip.ZipEntry instead of + java.util.zip.ZipEntry.

          + +

          It doesn't extend java.util.zip.ZipFile as it would + have to reimplement all methods anyway. Like + java.util.ZipFile, it uses RandomAccessFile under the + covers and supports compressed and uncompressed entries.

          + +

          The method signatures mimic the ones of + java.util.zip.ZipFile, with a couple of exceptions: + +

            +
          • There is no getName method.
            • +
          • entries has been renamed to getEntries.
            • +
          • getEntries and getEntry return + org.apache.tools.zip.ZipEntry instances.
            • +
          • close is allowed to throw IOException.
            • +
          +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ZipFile(java.io.File f) + +
          +          Opens the given file for reading, assuming the platform's + native encoding for file names.
          ZipFile(java.io.File f, + java.lang.String encoding) + +
          +          Opens the given file for reading, assuming the specified + encoding for file names and scanning for unicode extra fields.
          ZipFile(java.io.File f, + java.lang.String encoding, + boolean useUnicodeExtraFields) + +
          +          Opens the given file for reading, assuming the specified + encoding for file names.
          ZipFile(java.lang.String name) + +
          +          Opens the given file for reading, assuming the platform's + native encoding for file names.
          ZipFile(java.lang.String name, + java.lang.String encoding) + +
          +          Opens the given file for reading, assuming the specified + encoding for file names, scanning unicode extra fields.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + voidclose() + +
          +          Closes the archive.
          +static voidcloseQuietly(ZipFile zipfile) + +
          +          close a zipfile quietly; throw no io fault, do nothing + on a null parameter
          +protected static java.util.DatefromDosTime(ZipLong zipDosTime) + +
          +          Convert a DOS date/time field to a Date object.
          + java.lang.StringgetEncoding() + +
          +          The encoding to use for filenames and the file comment.
          + java.util.EnumerationgetEntries() + +
          +          Returns all entries.
          + ZipEntrygetEntry(java.lang.String name) + +
          +          Returns a named entry - or null if no entry by + that name exists.
          + java.io.InputStreamgetInputStream(ZipEntry ze) + +
          +          Returns an InputStream for reading the contents of the given entry.
          +protected  java.lang.StringgetString(byte[] bytes) + +
          +          Retrieve a String from the given bytes using the encoding set + for this ZipFile.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipFile

          +
          +public ZipFile(java.io.File f)
+        throws java.io.IOException
          +
          +
          Opens the given file for reading, assuming the platform's + native encoding for file names. +

          +

          +
          Parameters:
          f - the archive. +
          Throws: +
          java.io.IOException - if an error occurs while reading the file.
          +
          +
          + +

          +ZipFile

          +
          +public ZipFile(java.lang.String name)
+        throws java.io.IOException
          +
          +
          Opens the given file for reading, assuming the platform's + native encoding for file names. +

          +

          +
          Parameters:
          name - name of the archive. +
          Throws: +
          java.io.IOException - if an error occurs while reading the file.
          +
          +
          + +

          +ZipFile

          +
          +public ZipFile(java.lang.String name,
+               java.lang.String encoding)
+        throws java.io.IOException
          +
          +
          Opens the given file for reading, assuming the specified + encoding for file names, scanning unicode extra fields. +

          +

          +
          Parameters:
          name - name of the archive.
          encoding - the encoding to use for file names +
          Throws: +
          java.io.IOException - if an error occurs while reading the file.
          +
          +
          + +

          +ZipFile

          +
          +public ZipFile(java.io.File f,
+               java.lang.String encoding)
+        throws java.io.IOException
          +
          +
          Opens the given file for reading, assuming the specified + encoding for file names and scanning for unicode extra fields. +

          +

          +
          Parameters:
          f - the archive.
          encoding - the encoding to use for file names, use null + for the platform's default encoding +
          Throws: +
          java.io.IOException - if an error occurs while reading the file.
          +
          +
          + +

          +ZipFile

          +
          +public ZipFile(java.io.File f,
+               java.lang.String encoding,
+               boolean useUnicodeExtraFields)
+        throws java.io.IOException
          +
          +
          Opens the given file for reading, assuming the specified + encoding for file names. +

          +

          +
          Parameters:
          f - the archive.
          encoding - the encoding to use for file names, use null + for the platform's default encoding
          useUnicodeExtraFields - whether to use InfoZIP Unicode + Extra Fields (if present) to set the file names. +
          Throws: +
          java.io.IOException - if an error occurs while reading the file.
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getEncoding

          +
          +public java.lang.String getEncoding()
          +
          +
          The encoding to use for filenames and the file comment. +

          +

          + +
          Returns:
          null if using the platform's default character encoding.
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Closes the archive. +

          +

          + +
          Throws: +
          java.io.IOException - if an error occurs closing the archive.
          +
          +
          +
          + +

          +closeQuietly

          +
          +public static void closeQuietly(ZipFile zipfile)
          +
          +
          close a zipfile quietly; throw no io fault, do nothing + on a null parameter +

          +

          +
          Parameters:
          zipfile - file to close, can be null
          +
          +
          +
          + +

          +getEntries

          +
          +public java.util.Enumeration getEntries()
          +
          +
          Returns all entries. +

          +

          + +
          Returns:
          all entries as ZipEntry instances
          +
          +
          +
          + +

          +getEntry

          +
          +public ZipEntry getEntry(java.lang.String name)
          +
          +
          Returns a named entry - or null if no entry by + that name exists. +

          +

          +
          Parameters:
          name - name of the entry. +
          Returns:
          the ZipEntry corresponding to the given name - or + null if not present.
          +
          +
          +
          + +

          +getInputStream

          +
          +public java.io.InputStream getInputStream(ZipEntry ze)
+                                   throws java.io.IOException,
+                                          java.util.zip.ZipException
          +
          +
          Returns an InputStream for reading the contents of the given entry. +

          +

          +
          Parameters:
          ze - the entry to get the stream for. +
          Returns:
          a stream to read the entry from. +
          Throws: +
          java.io.IOException - if unable to create an input stream from the zipenty +
          java.util.zip.ZipException - if the zipentry has an unsupported + compression method
          +
          +
          +
          + +

          +fromDosTime

          +
          +protected static java.util.Date fromDosTime(ZipLong zipDosTime)
          +
          +
          Convert a DOS date/time field to a Date object. +

          +

          +
          Parameters:
          zipDosTime - contains the stored DOS time. +
          Returns:
          a Date instance corresponding to the given time.
          +
          +
          +
          + +

          +getString

          +
          +protected java.lang.String getString(byte[] bytes)
+                              throws java.util.zip.ZipException
          +
          +
          Retrieve a String from the given bytes using the encoding set + for this ZipFile. +

          +

          +
          Parameters:
          bytes - the byte array to transform +
          Returns:
          String obtained by using the given encoding +
          Throws: +
          java.util.zip.ZipException - if the encoding cannot be recognized.
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipLong.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipLong.html new file mode 100644 index 000000000..c1636d140 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipLong.html @@ -0,0 +1,491 @@ + + + + + + +ZipLong (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipLong

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ZipLong
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public final class ZipLong
          extends java.lang.Object
          implements java.lang.Cloneable
          + + +

          +Utility class that represents a four byte integer with conversion + rules for the big endian byte order of ZIP files. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ZipLong(byte[] bytes) + +
          +          Create instance from bytes.
          ZipLong(byte[] bytes, + int offset) + +
          +          Create instance from the four bytes starting at offset.
          ZipLong(long value) + +
          +          Create instance from a number.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +           
          + booleanequals(java.lang.Object o) + +
          +          Override to make two instances with same value equal.
          + byte[]getBytes() + +
          +          Get value as four bytes in big endian byte order.
          +static byte[]getBytes(long value) + +
          +          Get value as four bytes in big endian byte order.
          + longgetValue() + +
          +          Get value as Java long.
          +static longgetValue(byte[] bytes) + +
          +          Helper method to get the value as a Java long from a four-byte array
          +static longgetValue(byte[] bytes, + int offset) + +
          +          Helper method to get the value as a Java long from four bytes starting at given array offset
          + inthashCode() + +
          +          Override to make two instances with same value equal.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipLong

          +
          +public ZipLong(long value)
          +
          +
          Create instance from a number. +

          +

          +
          Parameters:
          value - the long to store as a ZipLong
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipLong

          +
          +public ZipLong(byte[] bytes)
          +
          +
          Create instance from bytes. +

          +

          +
          Parameters:
          bytes - the bytes to store as a ZipLong
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipLong

          +
          +public ZipLong(byte[] bytes,
+               int offset)
          +
          +
          Create instance from the four bytes starting at offset. +

          +

          +
          Parameters:
          bytes - the bytes to store as a ZipLong
          offset - the offset to start
          Since:
          +
          1.1
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getBytes

          +
          +public byte[] getBytes()
          +
          +
          Get value as four bytes in big endian byte order. +

          +

          +
          +
          +
          + +
          Returns:
          value as four bytes in big endian order
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getValue

          +
          +public long getValue()
          +
          +
          Get value as Java long. +

          +

          +
          +
          +
          + +
          Returns:
          value as a long
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getBytes

          +
          +public static byte[] getBytes(long value)
          +
          +
          Get value as four bytes in big endian byte order. +

          +

          +
          +
          +
          +
          Parameters:
          value - the value to convert +
          Returns:
          value as four bytes in big endian byte order
          +
          +
          +
          + +

          +getValue

          +
          +public static long getValue(byte[] bytes,
+                            int offset)
          +
          +
          Helper method to get the value as a Java long from four bytes starting at given array offset +

          +

          +
          +
          +
          +
          Parameters:
          bytes - the array of bytes
          offset - the offset to start +
          Returns:
          the correspondanding Java long value
          +
          +
          +
          + +

          +getValue

          +
          +public static long getValue(byte[] bytes)
          +
          +
          Helper method to get the value as a Java long from a four-byte array +

          +

          +
          +
          +
          +
          Parameters:
          bytes - the array of bytes +
          Returns:
          the correspondanding Java long value
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          Override to make two instances with same value equal. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          o - an object to compare +
          Returns:
          true if the objects are equal
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Override to make two instances with same value equal. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          the value stored in the ZipLong
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.UnicodeExtraFieldPolicy.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.UnicodeExtraFieldPolicy.html new file mode 100644 index 000000000..c1cc8edea --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.UnicodeExtraFieldPolicy.html @@ -0,0 +1,305 @@ + + + + + + +ZipOutputStream.UnicodeExtraFieldPolicy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipOutputStream.UnicodeExtraFieldPolicy

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ZipOutputStream.UnicodeExtraFieldPolicy
+
          +
          +
          Enclosing class:
          ZipOutputStream
          +
          +
          +
          +
          public static final class ZipOutputStream.UnicodeExtraFieldPolicy
          extends java.lang.Object
          + + +

          +enum that represents the possible policies for creating Unicode + extra fields. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +static ZipOutputStream.UnicodeExtraFieldPolicyALWAYS + +
          +          Always create Unicode extra fields.
          +static ZipOutputStream.UnicodeExtraFieldPolicyNEVER + +
          +          Never create Unicode extra fields.
          +static ZipOutputStream.UnicodeExtraFieldPolicyNOT_ENCODEABLE + +
          +          Create Unicode extra fields for filenames that cannot be + encoded using the specified encoding.
          +  + + + + + + + + + + + +
          +Method Summary
          + java.lang.StringtoString() + +
          +           
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +ALWAYS

          +
          +public static final ZipOutputStream.UnicodeExtraFieldPolicy ALWAYS
          +
          +
          Always create Unicode extra fields. +

          +

          +
          +
          +
          + +

          +NEVER

          +
          +public static final ZipOutputStream.UnicodeExtraFieldPolicy NEVER
          +
          +
          Never create Unicode extra fields. +

          +

          +
          +
          +
          + +

          +NOT_ENCODEABLE

          +
          +public static final ZipOutputStream.UnicodeExtraFieldPolicy NOT_ENCODEABLE
          +
          +
          Create Unicode extra fields for filenames that cannot be + encoded using the specified encoding. +

          +

          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +toString

          +
          +public java.lang.String toString()
          +
          +
          +
          Overrides:
          toString in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.html new file mode 100644 index 000000000..9a7a83cc1 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipOutputStream.html @@ -0,0 +1,1307 @@ + + + + + + +ZipOutputStream (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipOutputStream

          +
          +java.lang.Object
+  extended by java.io.OutputStream
+      extended by java.io.FilterOutputStream
+          extended by org.apache.tools.zip.ZipOutputStream
+
          +
          +
          All Implemented Interfaces:
          java.io.Closeable, java.io.Flushable
          +
          +
          +
          +
          public class ZipOutputStream
          extends java.io.FilterOutputStream
          + + +

          +Reimplementation of java.util.zip.ZipOutputStream that does handle the extended + functionality of this package, especially internal/external file + attributes and extra fields with different layouts for local file + data and central directory entries. + +

          This class will try to use RandomAccessFile when you know that the output is going to go to a + file.

          + +

          If RandomAccessFile cannot be used, this implementation will use + a Data Descriptor to store size and CRC information for DEFLATED entries, this means, you don't need to + calculate them yourself. Unfortunately this is not possible for + the STORED method, here setting the CRC and + uncompressed size information is required before putNextEntry can be called.

          +

          + +

          +

          + +

          + + + + + + + + + + + +
          +Nested Class Summary
          +static classZipOutputStream.UnicodeExtraFieldPolicy + +
          +          enum that represents the possible policies for creating Unicode + extra fields.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Field Summary
          +protected  byte[]buf + +
          +          This buffer servers as a Deflater.
          +protected static byte[]CFH_SIG + +
          +          central file header signature
          +protected static byte[]DD_SIG + +
          +          data descriptor signature
          +protected  java.util.zip.Deflaterdef + +
          +          This Deflater object is used for output.
          +static intDEFAULT_COMPRESSION + +
          +          Default compression level for deflated entries.
          +static intDEFLATED + +
          +          Compression method for deflated entries.
          +static intEFS_FLAG + +
          +          Deprecated. use UFT8_NAMES_FLAG instead
          +protected static byte[]EOCD_SIG + +
          +          end of central dir signature
          +protected static byte[]LFH_SIG + +
          +          local file header signature
          +static intSTORED + +
          +          Compression method for stored entries.
          +static intUFT8_NAMES_FLAG + +
          +          General purpose flag, which indicates that filenames are + written in utf-8.
          +  + + + + + + + +
          Fields inherited from class java.io.FilterOutputStream
          out
          +  + + + + + + + + + + + + + +
          +Constructor Summary
          ZipOutputStream(java.io.File file) + +
          +          Creates a new ZIP OutputStream writing to a File.
          ZipOutputStream(java.io.OutputStream out) + +
          +          Creates a new ZIP OutputStream filtering the underlying stream.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          +protected static longadjustToLong(int i) + +
          +          Assumes a negative integer really is a positive integer that + has wrapped around and re-creates the original value.
          + voidclose() + +
          +          Closes this output stream and releases any system resources + associated with the stream.
          + voidcloseEntry() + +
          +          Writes all necessary data for this entry.
          +protected  voiddeflate() + +
          +          Writes next block of compressed data to the output stream.
          + voidfinish() + +
          +          Finishs writing the contents and closes this as well as the + underlying stream.
          + voidflush() + +
          +          Flushes this output stream and forces any buffered output bytes + to be written out to the stream.
          +protected  byte[]getBytes(java.lang.String name) + +
          +          Retrieve the bytes for the given String in the encoding set for + this Stream.
          + java.lang.StringgetEncoding() + +
          +          The encoding to use for filenames and the file comment.
          + booleanisSeekable() + +
          +          This method indicates whether this archive is writing to a + seekable stream (i.e., to a random access file).
          + voidputNextEntry(ZipEntry ze) + +
          +          Begin writing next entry.
          + voidsetComment(java.lang.String comment) + +
          +          Set the file comment.
          + voidsetCreateUnicodeExtraFields(ZipOutputStream.UnicodeExtraFieldPolicy b) + +
          +          Whether to create Unicode Extra Fields.
          + voidsetEncoding(java.lang.String encoding) + +
          +          The encoding to use for filenames and the file comment.
          + voidsetFallbackToUTF8(boolean b) + +
          +          Whether to fall back to UTF and the language encoding flag if + the file name cannot be encoded using the specified encoding.
          + voidsetLevel(int level) + +
          +          Sets the compression level for subsequent entries.
          + voidsetMethod(int method) + +
          +          Sets the default compression method for subsequent entries.
          + voidsetUseLanguageEncodingFlag(boolean b) + +
          +          Whether to set the language encoding flag if the file name + encoding is UTF-8.
          +protected static ZipLongtoDosTime(java.util.Date time) + +
          +          Convert a Date object to a DOS date/time field.
          +protected static byte[]toDosTime(long t) + +
          +          Convert a Date object to a DOS date/time field.
          + voidwrite(byte[] b, + int offset, + int length) + +
          +          Writes bytes to ZIP entry.
          + voidwrite(int b) + +
          +          Writes a single byte to ZIP entry.
          +protected  voidwriteCentralDirectoryEnd() + +
          +          Writes the "End of central dir record".
          +protected  voidwriteCentralFileHeader(ZipEntry ze) + +
          +          Writes the central file header entry.
          +protected  voidwriteDataDescriptor(ZipEntry ze) + +
          +          Writes the data descriptor entry.
          +protected  voidwriteLocalFileHeader(ZipEntry ze) + +
          +          Writes the local file header entry
          +protected  voidwriteOut(byte[] data) + +
          +          Write bytes to output or random access file.
          +protected  voidwriteOut(byte[] data, + int offset, + int length) + +
          +          Write bytes to output or random access file.
          +  + + + + + + + +
          Methods inherited from class java.io.FilterOutputStream
          write
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Field Detail
          + +

          +DEFLATED

          +
          +public static final int DEFLATED
          +
          +
          Compression method for deflated entries. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +DEFAULT_COMPRESSION

          +
          +public static final int DEFAULT_COMPRESSION
          +
          +
          Default compression level for deflated entries. +

          +

          +
          Since:
          +
          Ant 1.7
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +STORED

          +
          +public static final int STORED
          +
          +
          Compression method for stored entries. +

          +

          +
          Since:
          +
          1.1
          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +UFT8_NAMES_FLAG

          +
          +public static final int UFT8_NAMES_FLAG
          +
          +
          General purpose flag, which indicates that filenames are + written in utf-8. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +EFS_FLAG

          +
          +public static final int EFS_FLAG
          +
          +
          Deprecated. use UFT8_NAMES_FLAG instead
          General purpose flag, which indicates that filenames are + written in utf-8. +

          +

          +
          See Also:
          Constant Field Values
          +
          +
          + +

          +def

          +
          +protected java.util.zip.Deflater def
          +
          +
          This Deflater object is used for output. + +

          This attribute is only protected to provide a level of API + backwards compatibility. This class used to extend DeflaterOutputStream up to + Revision 1.13.

          +

          +

          +
          Since:
          +
          1.14
          +
          +
          +
          + +

          +buf

          +
          +protected byte[] buf
          +
          +
          This buffer servers as a Deflater. + +

          This attribute is only protected to provide a level of API + backwards compatibility. This class used to extend DeflaterOutputStream up to + Revision 1.13.

          +

          +

          +
          Since:
          +
          1.14
          +
          +
          +
          + +

          +LFH_SIG

          +
          +protected static final byte[] LFH_SIG
          +
          +
          local file header signature +

          +

          +
          Since:
          +
          1.1
          +
          +
          +
          + +

          +DD_SIG

          +
          +protected static final byte[] DD_SIG
          +
          +
          data descriptor signature +

          +

          +
          Since:
          +
          1.1
          +
          +
          +
          + +

          +CFH_SIG

          +
          +protected static final byte[] CFH_SIG
          +
          +
          central file header signature +

          +

          +
          Since:
          +
          1.1
          +
          +
          +
          + +

          +EOCD_SIG

          +
          +protected static final byte[] EOCD_SIG
          +
          +
          end of central dir signature +

          +

          +
          Since:
          +
          1.1
          +
          +
          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipOutputStream

          +
          +public ZipOutputStream(java.io.OutputStream out)
          +
          +
          Creates a new ZIP OutputStream filtering the underlying stream. +

          +

          +
          Parameters:
          out - the outputstream to zip
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipOutputStream

          +
          +public ZipOutputStream(java.io.File file)
+                throws java.io.IOException
          +
          +
          Creates a new ZIP OutputStream writing to a File. Will use + random access if possible. +

          +

          +
          Parameters:
          file - the file to zip to +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.14
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +isSeekable

          +
          +public boolean isSeekable()
          +
          +
          This method indicates whether this archive is writing to a + seekable stream (i.e., to a random access file). + +

          For seekable streams, you don't need to calculate the CRC or + uncompressed size for STORED entries before + invoking putNextEntry(org.apache.tools.zip.ZipEntry). +

          +

          + +
          Returns:
          true if seekable
          Since:
          +
          1.17
          +
          +
          +
          +
          + +

          +setEncoding

          +
          +public void setEncoding(java.lang.String encoding)
          +
          +
          The encoding to use for filenames and the file comment. + +

          For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html. + Defaults to the platform's default character encoding.

          +

          +

          +
          Parameters:
          encoding - the encoding value
          Since:
          +
          1.3
          +
          +
          +
          +
          + +

          +getEncoding

          +
          +public java.lang.String getEncoding()
          +
          +
          The encoding to use for filenames and the file comment. +

          +

          + +
          Returns:
          null if using the platform's default character encoding.
          Since:
          +
          1.3
          +
          +
          +
          +
          + +

          +setUseLanguageEncodingFlag

          +
          +public void setUseLanguageEncodingFlag(boolean b)
          +
          +
          Whether to set the language encoding flag if the file name + encoding is UTF-8. + +

          Defaults to true.

          +

          +

          +
          +
          +
          +
          + +

          +setCreateUnicodeExtraFields

          +
          +public void setCreateUnicodeExtraFields(ZipOutputStream.UnicodeExtraFieldPolicy b)
          +
          +
          Whether to create Unicode Extra Fields. + +

          Defaults to NEVER.

          +

          +

          +
          +
          +
          +
          + +

          +setFallbackToUTF8

          +
          +public void setFallbackToUTF8(boolean b)
          +
          +
          Whether to fall back to UTF and the language encoding flag if + the file name cannot be encoded using the specified encoding. + +

          Defaults to false.

          +

          +

          +
          +
          +
          +
          + +

          +finish

          +
          +public void finish()
+            throws java.io.IOException
          +
          +
          Finishs writing the contents and closes this as well as the + underlying stream. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +closeEntry

          +
          +public void closeEntry()
+                throws java.io.IOException
          +
          +
          Writes all necessary data for this entry. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +putNextEntry

          +
          +public void putNextEntry(ZipEntry ze)
+                  throws java.io.IOException
          +
          +
          Begin writing next entry. +

          +

          +
          Parameters:
          ze - the entry to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setComment

          +
          +public void setComment(java.lang.String comment)
          +
          +
          Set the file comment. +

          +

          +
          Parameters:
          comment - the comment
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setLevel

          +
          +public void setLevel(int level)
          +
          +
          Sets the compression level for subsequent entries. + +

          Default is Deflater.DEFAULT_COMPRESSION.

          +

          +

          +
          Parameters:
          level - the compression level. +
          Throws: +
          java.lang.IllegalArgumentException - if an invalid compression + level is specified.
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +setMethod

          +
          +public void setMethod(int method)
          +
          +
          Sets the default compression method for subsequent entries. + +

          Default is DEFLATED.

          +

          +

          +
          Parameters:
          method - an int from java.util.zip.ZipEntry
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +write

          +
          +public void write(byte[] b,
+                  int offset,
+                  int length)
+           throws java.io.IOException
          +
          +
          Writes bytes to ZIP entry. +

          +

          +
          Overrides:
          write in class java.io.FilterOutputStream
          +
          +
          +
          Parameters:
          b - the byte array to write
          offset - the start position to write from
          length - the number of bytes to write +
          Throws: +
          java.io.IOException - on error
          +
          +
          +
          + +

          +write

          +
          +public void write(int b)
+           throws java.io.IOException
          +
          +
          Writes a single byte to ZIP entry. + +

          Delegates to the three arg method.

          +

          +

          +
          Overrides:
          write in class java.io.FilterOutputStream
          +
          +
          +
          Parameters:
          b - the byte to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +close

          +
          +public void close()
+           throws java.io.IOException
          +
          +
          Closes this output stream and releases any system resources + associated with the stream. +

          +

          +
          Specified by:
          close in interface java.io.Closeable
          Overrides:
          close in class java.io.FilterOutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if an I/O error occurs.
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +flush

          +
          +public void flush()
+           throws java.io.IOException
          +
          +
          Flushes this output stream and forces any buffered output bytes + to be written out to the stream. +

          +

          +
          Specified by:
          flush in interface java.io.Flushable
          Overrides:
          flush in class java.io.FilterOutputStream
          +
          +
          + +
          Throws: +
          java.io.IOException - if an I/O error occurs.
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +deflate

          +
          +protected final void deflate()
+                      throws java.io.IOException
          +
          +
          Writes next block of compressed data to the output stream. +

          +

          + +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +writeLocalFileHeader

          +
          +protected void writeLocalFileHeader(ZipEntry ze)
+                             throws java.io.IOException
          +
          +
          Writes the local file header entry +

          +

          +
          Parameters:
          ze - the entry to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +writeDataDescriptor

          +
          +protected void writeDataDescriptor(ZipEntry ze)
+                            throws java.io.IOException
          +
          +
          Writes the data descriptor entry. +

          +

          +
          Parameters:
          ze - the entry to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +writeCentralFileHeader

          +
          +protected void writeCentralFileHeader(ZipEntry ze)
+                               throws java.io.IOException
          +
          +
          Writes the central file header entry. +

          +

          +
          Parameters:
          ze - the entry to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +writeCentralDirectoryEnd

          +
          +protected void writeCentralDirectoryEnd()
+                                 throws java.io.IOException
          +
          +
          Writes the "End of central dir record". +

          +

          + +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +toDosTime

          +
          +protected static ZipLong toDosTime(java.util.Date time)
          +
          +
          Convert a Date object to a DOS date/time field. +

          +

          +
          Parameters:
          time - the Date to convert +
          Returns:
          the date as a ZipLong
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +toDosTime

          +
          +protected static byte[] toDosTime(long t)
          +
          +
          Convert a Date object to a DOS date/time field. + +

          Stolen from InfoZip's fileio.c

          +

          +

          +
          Parameters:
          t - number of milliseconds since the epoch +
          Returns:
          the date as a byte array
          Since:
          +
          1.26
          +
          +
          +
          +
          + +

          +getBytes

          +
          +protected byte[] getBytes(java.lang.String name)
+                   throws java.util.zip.ZipException
          +
          +
          Retrieve the bytes for the given String in the encoding set for + this Stream. +

          +

          +
          Parameters:
          name - the string to get bytes from +
          Returns:
          the bytes as a byte array +
          Throws: +
          java.util.zip.ZipException - on error
          Since:
          +
          1.3
          +
          +
          +
          +
          + +

          +writeOut

          +
          +protected final void writeOut(byte[] data)
+                       throws java.io.IOException
          +
          +
          Write bytes to output or random access file. +

          +

          +
          Parameters:
          data - the byte array to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +writeOut

          +
          +protected final void writeOut(byte[] data,
+                              int offset,
+                              int length)
+                       throws java.io.IOException
          +
          +
          Write bytes to output or random access file. +

          +

          +
          Parameters:
          data - the byte array to write
          offset - the start position to write from
          length - the number of bytes to write +
          Throws: +
          java.io.IOException - on error
          Since:
          +
          1.14
          +
          +
          +
          +
          + +

          +adjustToLong

          +
          +protected static long adjustToLong(int i)
          +
          +
          Assumes a negative integer really is a positive integer that + has wrapped around and re-creates the original value. +

          +

          +
          Parameters:
          i - the value to treat as unsigned int. +
          Returns:
          the unsigned int as a long.
          Since:
          +
          1.34
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipShort.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipShort.html new file mode 100644 index 000000000..6f63f4d91 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipShort.html @@ -0,0 +1,491 @@ + + + + + + +ZipShort (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipShort

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ZipShort
+
          +
          +
          All Implemented Interfaces:
          java.lang.Cloneable
          +
          +
          +
          +
          public final class ZipShort
          extends java.lang.Object
          implements java.lang.Cloneable
          + + +

          +Utility class that represents a two byte integer with conversion + rules for the big endian byte order of ZIP files. +

          + +

          +

          + +

          + + + + + + + + + + + + + + + + + +
          +Constructor Summary
          ZipShort(byte[] bytes) + +
          +          Create instance from bytes.
          ZipShort(byte[] bytes, + int offset) + +
          +          Create instance from the two bytes starting at offset.
          ZipShort(int value) + +
          +          Create instance from a number.
          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Method Summary
          + java.lang.Objectclone() + +
          +           
          + booleanequals(java.lang.Object o) + +
          +          Override to make two instances with same value equal.
          + byte[]getBytes() + +
          +          Get value as two bytes in big endian byte order.
          +static byte[]getBytes(int value) + +
          +          Get value as two bytes in big endian byte order.
          + intgetValue() + +
          +          Get value as Java int.
          +static intgetValue(byte[] bytes) + +
          +          Helper method to get the value as a java int from a two-byte array
          +static intgetValue(byte[] bytes, + int offset) + +
          +          Helper method to get the value as a java int from two bytes starting at given array offset
          + inthashCode() + +
          +          Override to make two instances with same value equal.
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipShort

          +
          +public ZipShort(int value)
          +
          +
          Create instance from a number. +

          +

          +
          Parameters:
          value - the int to store as a ZipShort
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipShort

          +
          +public ZipShort(byte[] bytes)
          +
          +
          Create instance from bytes. +

          +

          +
          Parameters:
          bytes - the bytes to store as a ZipShort
          Since:
          +
          1.1
          +
          +
          +
          + +

          +ZipShort

          +
          +public ZipShort(byte[] bytes,
+                int offset)
          +
          +
          Create instance from the two bytes starting at offset. +

          +

          +
          Parameters:
          bytes - the bytes to store as a ZipShort
          offset - the offset to start
          Since:
          +
          1.1
          +
          +
          + + + + + + + + +
          +Method Detail
          + +

          +getBytes

          +
          +public byte[] getBytes()
          +
          +
          Get value as two bytes in big endian byte order. +

          +

          +
          +
          +
          + +
          Returns:
          the value as a a two byte array in big endian byte order
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getValue

          +
          +public int getValue()
          +
          +
          Get value as Java int. +

          +

          +
          +
          +
          + +
          Returns:
          value as a Java int
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +getBytes

          +
          +public static byte[] getBytes(int value)
          +
          +
          Get value as two bytes in big endian byte order. +

          +

          +
          +
          +
          +
          Parameters:
          value - the Java int to convert to bytes +
          Returns:
          the converted int as a byte array in big endian byte order
          +
          +
          +
          + +

          +getValue

          +
          +public static int getValue(byte[] bytes,
+                           int offset)
          +
          +
          Helper method to get the value as a java int from two bytes starting at given array offset +

          +

          +
          +
          +
          +
          Parameters:
          bytes - the array of bytes
          offset - the offset to start +
          Returns:
          the correspondanding java int value
          +
          +
          +
          + +

          +getValue

          +
          +public static int getValue(byte[] bytes)
          +
          +
          Helper method to get the value as a java int from a two-byte array +

          +

          +
          +
          +
          +
          Parameters:
          bytes - the array of bytes +
          Returns:
          the correspondanding java int value
          +
          +
          +
          + +

          +equals

          +
          +public boolean equals(java.lang.Object o)
          +
          +
          Override to make two instances with same value equal. +

          +

          +
          Overrides:
          equals in class java.lang.Object
          +
          +
          +
          Parameters:
          o - an object to compare +
          Returns:
          true if the objects are equal
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +hashCode

          +
          +public int hashCode()
          +
          +
          Override to make two instances with same value equal. +

          +

          +
          Overrides:
          hashCode in class java.lang.Object
          +
          +
          + +
          Returns:
          the value stored in the ZipShort
          Since:
          +
          1.1
          +
          +
          +
          +
          + +

          +clone

          +
          +public java.lang.Object clone()
          +
          +
          +
          Overrides:
          clone in class java.lang.Object
          +
          +
          +
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipUtil.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipUtil.html new file mode 100644 index 000000000..d0b861667 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/ZipUtil.html @@ -0,0 +1,227 @@ + + + + + + +ZipUtil (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + +

          + +org.apache.tools.zip +
          +Class ZipUtil

          +
          +java.lang.Object
+  extended by org.apache.tools.zip.ZipUtil
+
          +
          +
          +
          public abstract class ZipUtil
          extends java.lang.Object
          + + +

          +Utility class for handling DOS and Java time conversions. +

          + +

          +

          +
          Since:
          +
          Ant 1.8.1
          +
          +
          + +

          + + + + + + + + + + + +
          +Constructor Summary
          ZipUtil() + +
          +           
          +  + + + + + + + +
          +Method Summary
          +  + + + + + + + +
          Methods inherited from class java.lang.Object
          clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          +  +

          + + + + + + + + +
          +Constructor Detail
          + +

          +ZipUtil

          +
          +public ZipUtil()
          +
          +
          + +
          + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package   Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
          + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-frame.html new file mode 100644 index 000000000..26156ecab --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-frame.html @@ -0,0 +1,77 @@ + + + + + + +org.apache.tools.zip (Apache Ant API) + + + + + + + + + + + +org.apache.tools.zip + + + + +
          +Interfaces  + +
          +CentralDirectoryParsingZipExtraField +
          +UnixStat +
          +ZipExtraField
          + + + + + + +
          +Classes  + +
          +AbstractUnicodeExtraField +
          +AsiExtraField +
          +ExtraFieldUtils +
          +ExtraFieldUtils.UnparseableExtraField +
          +JarMarker +
          +UnicodeCommentExtraField +
          +UnicodePathExtraField +
          +UnparseableExtraFieldData +
          +UnrecognizedExtraField +
          +ZipEntry +
          +ZipFile +
          +ZipLong +
          +ZipOutputStream +
          +ZipOutputStream.UnicodeExtraFieldPolicy +
          +ZipShort +
          +ZipUtil
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-summary.html new file mode 100644 index 000000000..04c17b507 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-summary.html @@ -0,0 +1,246 @@ + + + + + + +org.apache.tools.zip (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +

          +Package org.apache.tools.zip +

          + + + + + + + + + + + + + + + + + +
          +Interface Summary
          CentralDirectoryParsingZipExtraFieldZipExtraField that knows how to parse central + directory data.
          UnixStatConstants from stat.h on Unix systems.
          ZipExtraFieldGeneral format of extra field data.
          +  + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class Summary
          AbstractUnicodeExtraFieldA common base class for Unicode extra information extra fields.
          AsiExtraFieldAdds Unix file permission and UID/GID fields as well as symbolic + link handling.
          ExtraFieldUtilsZipExtraField related methods
          ExtraFieldUtils.UnparseableExtraField"enum" for the possible actions to take if the extra field + cannot be parsed.
          JarMarkerIf this extra field is added as the very first extra field of the + archive, Solaris will consider it an executable jar file.
          UnicodeCommentExtraFieldInfo-ZIP Unicode Comment Extra Field (0x6375):
          UnicodePathExtraFieldInfo-ZIP Unicode Path Extra Field (0x7075):
          UnparseableExtraFieldDataWrapper for extra field data that doesn't conform to the recommended format of header-tag + size + data.
          UnrecognizedExtraFieldSimple placeholder for all those extra fields we don't want to deal + with.
          ZipEntryExtension that adds better handling of extra fields and provides + access to the internal and external file attributes.
          ZipFileReplacement for java.util.ZipFile.
          ZipLongUtility class that represents a four byte integer with conversion + rules for the big endian byte order of ZIP files.
          ZipOutputStreamReimplementation of java.util.zip.ZipOutputStream that does handle the extended + functionality of this package, especially internal/external file + attributes and extra fields with different layouts for local file + data and central directory entries.
          ZipOutputStream.UnicodeExtraFieldPolicyenum that represents the possible policies for creating Unicode + extra fields.
          ZipShortUtility class that represents a two byte integer with conversion + rules for the big endian byte order of ZIP files.
          ZipUtilUtility class for handling DOS and Java time conversions.
          +  + +

          +

          +
          +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview   Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-tree.html new file mode 100644 index 000000000..884e5e008 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/org/apache/tools/zip/package-tree.html @@ -0,0 +1,172 @@ + + + + + + +org.apache.tools.zip Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For Package org.apache.tools.zip +

          +
          +
          +
          Package Hierarchies:
          All Packages
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/overview-frame.html b/tools/apache-ant-1.8.2/docs/manual/api/overview-frame.html new file mode 100644 index 000000000..3f6f88be3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/overview-frame.html @@ -0,0 +1,180 @@ + + + + + + +Overview (Apache Ant API) + + + + + + + + + + + + + + + +
          +
          + + + + + +
          All Classes +

          + +Packages +
          +org.apache.tools.ant +
          +org.apache.tools.ant.dispatch +
          +org.apache.tools.ant.filters +
          +org.apache.tools.ant.filters.util +
          +org.apache.tools.ant.helper +
          +org.apache.tools.ant.input +
          +org.apache.tools.ant.launch +
          +org.apache.tools.ant.listener +
          +org.apache.tools.ant.loader +
          +org.apache.tools.ant.property +
          +org.apache.tools.ant.taskdefs +
          +org.apache.tools.ant.taskdefs.compilers +
          +org.apache.tools.ant.taskdefs.condition +
          +org.apache.tools.ant.taskdefs.cvslib +
          +org.apache.tools.ant.taskdefs.email +
          +org.apache.tools.ant.taskdefs.optional +
          +org.apache.tools.ant.taskdefs.optional.ccm +
          +org.apache.tools.ant.taskdefs.optional.clearcase +
          +org.apache.tools.ant.taskdefs.optional.depend +
          +org.apache.tools.ant.taskdefs.optional.depend.constantpool +
          +org.apache.tools.ant.taskdefs.optional.ejb +
          +org.apache.tools.ant.taskdefs.optional.extension +
          +org.apache.tools.ant.taskdefs.optional.extension.resolvers +
          +org.apache.tools.ant.taskdefs.optional.i18n +
          +org.apache.tools.ant.taskdefs.optional.image +
          +org.apache.tools.ant.taskdefs.optional.j2ee +
          +org.apache.tools.ant.taskdefs.optional.javacc +
          +org.apache.tools.ant.taskdefs.optional.javah +
          +org.apache.tools.ant.taskdefs.optional.jdepend +
          +org.apache.tools.ant.taskdefs.optional.jlink +
          +org.apache.tools.ant.taskdefs.optional.jsp +
          +org.apache.tools.ant.taskdefs.optional.jsp.compilers +
          +org.apache.tools.ant.taskdefs.optional.junit +
          +org.apache.tools.ant.taskdefs.optional.native2ascii +
          +org.apache.tools.ant.taskdefs.optional.net +
          +org.apache.tools.ant.taskdefs.optional.perforce +
          +org.apache.tools.ant.taskdefs.optional.pvcs +
          +org.apache.tools.ant.taskdefs.optional.script +
          +org.apache.tools.ant.taskdefs.optional.sos +
          +org.apache.tools.ant.taskdefs.optional.sound +
          +org.apache.tools.ant.taskdefs.optional.splash +
          +org.apache.tools.ant.taskdefs.optional.ssh +
          +org.apache.tools.ant.taskdefs.optional.testing +
          +org.apache.tools.ant.taskdefs.optional.unix +
          +org.apache.tools.ant.taskdefs.optional.vss +
          +org.apache.tools.ant.taskdefs.optional.windows +
          +org.apache.tools.ant.taskdefs.rmic +
          +org.apache.tools.ant.types +
          +org.apache.tools.ant.types.mappers +
          +org.apache.tools.ant.types.optional +
          +org.apache.tools.ant.types.optional.depend +
          +org.apache.tools.ant.types.optional.image +
          +org.apache.tools.ant.types.resolver +
          +org.apache.tools.ant.types.resources +
          +org.apache.tools.ant.types.resources.comparators +
          +org.apache.tools.ant.types.resources.selectors +
          +org.apache.tools.ant.types.selectors +
          +org.apache.tools.ant.types.selectors.modifiedselector +
          +org.apache.tools.ant.types.spi +
          +org.apache.tools.ant.util +
          +org.apache.tools.ant.util.depend +
          +org.apache.tools.ant.util.depend.bcel +
          +org.apache.tools.ant.util.facade +
          +org.apache.tools.ant.util.java15 +
          +org.apache.tools.ant.util.optional +
          +org.apache.tools.ant.util.regexp +
          +org.apache.tools.bzip2 +
          +org.apache.tools.mail +
          +org.apache.tools.tar +
          +org.apache.tools.zip +
          +

          + +

          +  + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/overview-summary.html b/tools/apache-ant-1.8.2/docs/manual/api/overview-summary.html new file mode 100644 index 000000000..e70998e8a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/overview-summary.html @@ -0,0 +1,482 @@ + + + + + + +Overview (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
           Overview  Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +

          +
          +

          +Apache Ant +

          +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Apache Ant Core
          org.apache.tools.ant 
          org.apache.tools.ant.dispatch 
          org.apache.tools.ant.filters 
          org.apache.tools.ant.filters.util 
          org.apache.tools.ant.helper 
          org.apache.tools.ant.input 
          org.apache.tools.ant.launch 
          org.apache.tools.ant.listener 
          org.apache.tools.ant.loader 
          org.apache.tools.ant.propertyContains helper classes for ant properties.
          + +

          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Core Tasks
          org.apache.tools.ant.taskdefs 
          org.apache.tools.ant.taskdefs.compilers 
          org.apache.tools.ant.taskdefs.condition 
          org.apache.tools.ant.taskdefs.cvslib 
          org.apache.tools.ant.taskdefs.email 
          org.apache.tools.ant.taskdefs.rmic 
          + +

          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Core Types
          org.apache.tools.ant.types 
          org.apache.tools.ant.types.mappers 
          org.apache.tools.ant.types.resolverAnt integration with xml-commons resolver.
          org.apache.tools.ant.types.resources 
          org.apache.tools.ant.types.resources.comparators 
          org.apache.tools.ant.types.resources.selectors 
          org.apache.tools.ant.types.selectors 
          org.apache.tools.ant.types.selectors.modifiedselector 
          org.apache.tools.ant.types.spi 
          + +

          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Optional Tasks
          org.apache.tools.ant.taskdefs.optional 
          org.apache.tools.ant.taskdefs.optional.ccm 
          org.apache.tools.ant.taskdefs.optional.clearcase 
          org.apache.tools.ant.taskdefs.optional.depend 
          org.apache.tools.ant.taskdefs.optional.depend.constantpool 
          org.apache.tools.ant.taskdefs.optional.ejb 
          org.apache.tools.ant.taskdefs.optional.extension 
          org.apache.tools.ant.taskdefs.optional.extension.resolvers 
          org.apache.tools.ant.taskdefs.optional.i18n 
          org.apache.tools.ant.taskdefs.optional.image 
          org.apache.tools.ant.taskdefs.optional.j2ee 
          org.apache.tools.ant.taskdefs.optional.javacc 
          org.apache.tools.ant.taskdefs.optional.javah 
          org.apache.tools.ant.taskdefs.optional.jdepend 
          org.apache.tools.ant.taskdefs.optional.jlink 
          org.apache.tools.ant.taskdefs.optional.jsp 
          org.apache.tools.ant.taskdefs.optional.jsp.compilers 
          org.apache.tools.ant.taskdefs.optional.junit 
          org.apache.tools.ant.taskdefs.optional.native2ascii 
          org.apache.tools.ant.taskdefs.optional.net 
          org.apache.tools.ant.taskdefs.optional.perforceANT Tasks for Perforce integration.
          org.apache.tools.ant.taskdefs.optional.pvcs 
          org.apache.tools.ant.taskdefs.optional.script 
          org.apache.tools.ant.taskdefs.optional.sos + Ant tasks for working with a SourceOffSite source control system.
          org.apache.tools.ant.taskdefs.optional.sound 
          org.apache.tools.ant.taskdefs.optional.splash 
          org.apache.tools.ant.taskdefs.optional.ssh 
          org.apache.tools.ant.taskdefs.optional.testing 
          org.apache.tools.ant.taskdefs.optional.unix 
          org.apache.tools.ant.taskdefs.optional.vss 
          org.apache.tools.ant.taskdefs.optional.windows 
          + +

          +  + + + + + + + + + + + + + + + + +
          +Optional Types
          org.apache.tools.ant.types.optional 
          org.apache.tools.ant.types.optional.depend 
          org.apache.tools.ant.types.optional.image 
          + +

          +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Ant Utilities
          org.apache.tools.ant.util 
          org.apache.tools.ant.util.depend 
          org.apache.tools.ant.util.depend.bcel 
          org.apache.tools.ant.util.facade 
          org.apache.tools.ant.util.java15 
          org.apache.tools.ant.util.optional 
          org.apache.tools.ant.util.regexp 
          + +

          +  + + + + + + + + + + + + + + + + + + + + +
          +Other Packages
          org.apache.tools.bzip2 
          org.apache.tools.mail 
          org.apache.tools.tar 
          org.apache.tools.zip 
          + +

          + 

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
           Overview  Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/overview-tree.html b/tools/apache-ant-1.8.2/docs/manual/api/overview-tree.html new file mode 100644 index 000000000..622ec61f2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/overview-tree.html @@ -0,0 +1,799 @@ + + + + + + +Class Hierarchy (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Hierarchy For All Packages

          +
          +
          +
          Package Hierarchies:
          org.apache.tools.ant, org.apache.tools.ant.dispatch, org.apache.tools.ant.filters, org.apache.tools.ant.filters.util, org.apache.tools.ant.helper, org.apache.tools.ant.input, org.apache.tools.ant.launch, org.apache.tools.ant.listener, org.apache.tools.ant.loader, org.apache.tools.ant.property, org.apache.tools.ant.taskdefs, org.apache.tools.ant.taskdefs.compilers, org.apache.tools.ant.taskdefs.condition, org.apache.tools.ant.taskdefs.cvslib, org.apache.tools.ant.taskdefs.email, org.apache.tools.ant.taskdefs.optional, org.apache.tools.ant.taskdefs.optional.ccm, org.apache.tools.ant.taskdefs.optional.clearcase, org.apache.tools.ant.taskdefs.optional.depend, org.apache.tools.ant.taskdefs.optional.depend.constantpool, org.apache.tools.ant.taskdefs.optional.ejb, org.apache.tools.ant.taskdefs.optional.extension, org.apache.tools.ant.taskdefs.optional.extension.resolvers, org.apache.tools.ant.taskdefs.optional.i18n, org.apache.tools.ant.taskdefs.optional.image, org.apache.tools.ant.taskdefs.optional.j2ee, org.apache.tools.ant.taskdefs.optional.javacc, org.apache.tools.ant.taskdefs.optional.javah, org.apache.tools.ant.taskdefs.optional.jdepend, org.apache.tools.ant.taskdefs.optional.jlink, org.apache.tools.ant.taskdefs.optional.jsp, org.apache.tools.ant.taskdefs.optional.jsp.compilers, org.apache.tools.ant.taskdefs.optional.junit, org.apache.tools.ant.taskdefs.optional.native2ascii, org.apache.tools.ant.taskdefs.optional.net, org.apache.tools.ant.taskdefs.optional.perforce, org.apache.tools.ant.taskdefs.optional.pvcs, org.apache.tools.ant.taskdefs.optional.script, org.apache.tools.ant.taskdefs.optional.sos, org.apache.tools.ant.taskdefs.optional.sound, org.apache.tools.ant.taskdefs.optional.splash, org.apache.tools.ant.taskdefs.optional.ssh, org.apache.tools.ant.taskdefs.optional.testing, org.apache.tools.ant.taskdefs.optional.unix, org.apache.tools.ant.taskdefs.optional.vss, org.apache.tools.ant.taskdefs.optional.windows, org.apache.tools.ant.taskdefs.rmic, org.apache.tools.ant.types, org.apache.tools.ant.types.mappers, org.apache.tools.ant.types.optional, org.apache.tools.ant.types.optional.depend, org.apache.tools.ant.types.optional.image, org.apache.tools.ant.types.resolver, org.apache.tools.ant.types.resources, org.apache.tools.ant.types.resources.comparators, org.apache.tools.ant.types.resources.selectors, org.apache.tools.ant.types.selectors, org.apache.tools.ant.types.selectors.modifiedselector, org.apache.tools.ant.types.spi, org.apache.tools.ant.util, org.apache.tools.ant.util.depend, org.apache.tools.ant.util.depend.bcel, org.apache.tools.ant.util.facade, org.apache.tools.ant.util.java15, org.apache.tools.ant.util.optional, org.apache.tools.ant.util.regexp, org.apache.tools.bzip2, org.apache.tools.mail, org.apache.tools.tar, org.apache.tools.zip
          +
          +

          +Class Hierarchy +

          + +

          +Interface Hierarchy +

          + +
          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class   Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/package-list b/tools/apache-ant-1.8.2/docs/manual/api/package-list new file mode 100644 index 000000000..06924c8a2 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/package-list @@ -0,0 +1,70 @@ +org.apache.tools.ant +org.apache.tools.ant.dispatch +org.apache.tools.ant.filters +org.apache.tools.ant.filters.util +org.apache.tools.ant.helper +org.apache.tools.ant.input +org.apache.tools.ant.launch +org.apache.tools.ant.listener +org.apache.tools.ant.loader +org.apache.tools.ant.property +org.apache.tools.ant.taskdefs +org.apache.tools.ant.taskdefs.compilers +org.apache.tools.ant.taskdefs.condition +org.apache.tools.ant.taskdefs.cvslib +org.apache.tools.ant.taskdefs.email +org.apache.tools.ant.taskdefs.optional +org.apache.tools.ant.taskdefs.optional.ccm +org.apache.tools.ant.taskdefs.optional.clearcase +org.apache.tools.ant.taskdefs.optional.depend +org.apache.tools.ant.taskdefs.optional.depend.constantpool +org.apache.tools.ant.taskdefs.optional.ejb +org.apache.tools.ant.taskdefs.optional.extension +org.apache.tools.ant.taskdefs.optional.extension.resolvers +org.apache.tools.ant.taskdefs.optional.i18n +org.apache.tools.ant.taskdefs.optional.image +org.apache.tools.ant.taskdefs.optional.j2ee +org.apache.tools.ant.taskdefs.optional.javacc +org.apache.tools.ant.taskdefs.optional.javah +org.apache.tools.ant.taskdefs.optional.jdepend +org.apache.tools.ant.taskdefs.optional.jlink +org.apache.tools.ant.taskdefs.optional.jsp +org.apache.tools.ant.taskdefs.optional.jsp.compilers +org.apache.tools.ant.taskdefs.optional.junit +org.apache.tools.ant.taskdefs.optional.native2ascii +org.apache.tools.ant.taskdefs.optional.net +org.apache.tools.ant.taskdefs.optional.perforce +org.apache.tools.ant.taskdefs.optional.pvcs +org.apache.tools.ant.taskdefs.optional.script +org.apache.tools.ant.taskdefs.optional.sos +org.apache.tools.ant.taskdefs.optional.sound +org.apache.tools.ant.taskdefs.optional.splash +org.apache.tools.ant.taskdefs.optional.ssh +org.apache.tools.ant.taskdefs.optional.testing +org.apache.tools.ant.taskdefs.optional.unix +org.apache.tools.ant.taskdefs.optional.vss +org.apache.tools.ant.taskdefs.optional.windows +org.apache.tools.ant.taskdefs.rmic +org.apache.tools.ant.types +org.apache.tools.ant.types.mappers +org.apache.tools.ant.types.optional +org.apache.tools.ant.types.optional.depend +org.apache.tools.ant.types.optional.image +org.apache.tools.ant.types.resolver +org.apache.tools.ant.types.resources +org.apache.tools.ant.types.resources.comparators +org.apache.tools.ant.types.resources.selectors +org.apache.tools.ant.types.selectors +org.apache.tools.ant.types.selectors.modifiedselector +org.apache.tools.ant.types.spi +org.apache.tools.ant.util +org.apache.tools.ant.util.depend +org.apache.tools.ant.util.depend.bcel +org.apache.tools.ant.util.facade +org.apache.tools.ant.util.java15 +org.apache.tools.ant.util.optional +org.apache.tools.ant.util.regexp +org.apache.tools.bzip2 +org.apache.tools.mail +org.apache.tools.tar +org.apache.tools.zip diff --git a/tools/apache-ant-1.8.2/docs/manual/api/resources/inherit.gif b/tools/apache-ant-1.8.2/docs/manual/api/resources/inherit.gif new file mode 100644 index 000000000..c814867a1 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/api/resources/inherit.gif differ diff --git a/tools/apache-ant-1.8.2/docs/manual/api/serialized-form.html b/tools/apache-ant-1.8.2/docs/manual/api/serialized-form.html new file mode 100644 index 000000000..8a71c9146 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/serialized-form.html @@ -0,0 +1,949 @@ + + + + + + +Serialized Form (Apache Ant API) + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          +
          +

          +Serialized Form

          +
          +
          + + + + + +
          +Package org.apache.tools.ant
          + +

          + + + + + +
          +Class org.apache.tools.ant.BuildEvent extends java.util.EventObject implements Serializable
          + +

          +serialVersionUID: 4538050075952288486L + +

          + + + + + +
          +Serialized Fields
          + +

          +project

          +
          +Project project
          +
          +
          Project which emitted the event. +

          +

          +
          +
          +
          +

          +target

          +
          +Target target
          +
          +
          Target which emitted the event, if specified. +

          +

          +
          +
          +
          +

          +task

          +
          +Task task
          +
          +
          Task which emitted the event, if specified. +

          +

          +
          +
          +
          +

          +message

          +
          +java.lang.String message
          +
          +
          Message associated with the event. This is only used for + "messageLogged" events. +

          +

          +
          +
          +
          +

          +priority

          +
          +int priority
          +
          +
          The priority of the message, for "messageLogged" events. +

          +

          +
          +
          +
          +

          +exception

          +
          +java.lang.Throwable exception
          +
          +
          The exception associated with this event, if any. + This is only used for "messageLogged", "taskFinished", "targetFinished", + and "buildFinished" events. +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.BuildException extends java.lang.RuntimeException implements Serializable
          + +

          +serialVersionUID: -5419014565354664240L + +

          + + + + + +
          +Serialized Fields
          + +

          +location

          +
          +Location location
          +
          +
          Location in the build file where the exception occurred +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.ExitException extends java.lang.SecurityException implements Serializable
          + +

          +serialVersionUID: 2772487854280543363L + +

          + + + + + +
          +Serialized Fields
          + +

          +status

          +
          +int status
          +
          +
          Status code +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.ExitStatusException extends BuildException implements Serializable
          + +

          +serialVersionUID: 7760846806886585968L + +

          + + + + + +
          +Serialized Fields
          + +

          +status

          +
          +int status
          +
          +
          Status code +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.Location extends java.lang.Object implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +fileName

          +
          +java.lang.String fileName
          +
          +
          Name of the file. +

          +

          +
          +
          +
          +

          +lineNumber

          +
          +int lineNumber
          +
          +
          Line number within the file. +

          +

          +
          +
          +
          +

          +columnNumber

          +
          +int columnNumber
          +
          +
          Column number within the file. +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.RuntimeConfigurable extends java.lang.Object implements Serializable
          + +

          +serialVersionUID: 1L + +

          + + + + + +
          +Serialized Fields
          + +

          +elementTag

          +
          +java.lang.String elementTag
          +
          +
          Name of the element to configure. +

          +

          +
          +
          +
          +

          +children

          +
          +java.util.List<E> children
          +
          +
          List of child element wrappers. +

          +

          +
          +
          +
          +

          +attributeMap

          +
          +java.util.LinkedHashMap<K,V> attributeMap
          +
          +
          Attribute names and values. While the XML spec doesn't require + preserving the order ( AFAIK ), some ant tests do rely on the + exact order. + The only exception to this order is the treatment of + refid. A number of datatypes check if refid is set + when other attributes are set. This check will not + work if the build script has the other attribute before + the "refid" attribute, so now (ANT 1.7) the refid + attribute will be processed first. +

          +

          +
          +
          +
          +

          +characters

          +
          +java.lang.StringBuffer characters
          +
          +
          Text appearing within the element. +

          +

          +
          +
          +
          +

          +proxyConfigured

          +
          +boolean proxyConfigured
          +
          +
          Indicates if the wrapped object has been configured +

          +

          +
          +
          +
          +

          +polyType

          +
          +java.lang.String polyType
          +
          +
          the polymorphic type +

          +

          +
          +
          +
          +

          +id

          +
          +java.lang.String id
          +
          +
          the "id" of this Element if it has one +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.UnsupportedAttributeException extends BuildException implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +attribute

          +
          +java.lang.String attribute
          +
          +
          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.UnsupportedElementException extends BuildException implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +element

          +
          +java.lang.String element
          +
          +
          +
          +
          +
          + + + + + +
          +Package org.apache.tools.ant.launch
          + +

          + + + + + +
          +Class org.apache.tools.ant.launch.LaunchException extends java.lang.Exception implements Serializable
          + +

          +

          + + + + + +
          +Package org.apache.tools.ant.taskdefs
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.ManifestException extends java.lang.Exception implements Serializable
          + +

          +serialVersionUID: 7685634200457515207L + +

          +

          + + + + + +
          +Package org.apache.tools.ant.taskdefs.optional.ejb
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc.EjbcException extends java.lang.Exception implements Serializable
          + +

          +

          + + + + + +
          +Package org.apache.tools.ant.taskdefs.optional.junit
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.optional.junit.DOMUtil.NodeListImpl extends java.util.Vector implements Serializable
          + +

          +serialVersionUID: 3175749150080946423L + +

          +

          + + + + + +
          +Package org.apache.tools.ant.taskdefs.optional.net
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.optional.net.FTP.FTPFileProxy extends java.io.File implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +file

          +
          +org.apache.commons.net.ftp.FTPFile file
          +
          +
          +
          +
          +
          +

          +parts

          +
          +java.lang.String[] parts
          +
          +
          +
          +
          +
          +

          +name

          +
          +java.lang.String name
          +
          +
          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.optional.net.FTPTaskMirrorImpl.FTPFileProxy extends java.io.File implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +file

          +
          +org.apache.commons.net.ftp.FTPFile file
          +
          +
          +
          +
          +
          +

          +parts

          +
          +java.lang.String[] parts
          +
          +
          +
          +
          +
          +

          +name

          +
          +java.lang.String name
          +
          +
          +
          +
          +
          + + + + + +
          +Package org.apache.tools.ant.taskdefs.optional.testing
          + +

          + + + + + +
          +Class org.apache.tools.ant.taskdefs.optional.testing.BuildTimeoutException extends BuildException implements Serializable
          + +

          +serialVersionUID: -8057644603246297562L + +

          +

          + + + + + +
          +Package org.apache.tools.ant.types.resources
          + +

          + + + + + +
          +Class org.apache.tools.ant.types.resources.ImmutableResourceException extends java.io.IOException implements Serializable
          + +

          +

          + + + + + +
          +Package org.apache.tools.ant.util
          + +

          + + + + + +
          +Class org.apache.tools.ant.util.IdentityStack extends java.util.Stack implements Serializable
          + +

          +serialVersionUID: -5555522620060077046L + +

          + +

          + + + + + +
          +Class org.apache.tools.ant.util.LayoutPreservingProperties extends java.util.Properties implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +LS

          +
          +java.lang.String LS
          +
          +
          +
          +
          +
          +

          +logicalLines

          +
          +java.util.ArrayList<E> logicalLines
          +
          +
          Logical lines have escaping and line continuation taken care + of. Comments and blank lines are logical lines; they are not + removed. +

          +

          +
          +
          +
          +

          +keyedPairLines

          +
          +java.util.HashMap<K,V> keyedPairLines
          +
          +
          Position in the logicalLines list, keyed by property name. +

          +

          +
          +
          +
          +

          +removeComments

          +
          +boolean removeComments
          +
          +
          Flag to indicate that, when we remove a property from the file, we + also want to remove the comments that precede it. +

          +

          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.util.LazyHashtable extends java.util.Hashtable implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +initAllDone

          +
          +boolean initAllDone
          +
          +
          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.util.LinkedHashtable extends java.util.Hashtable implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +map

          +
          +java.util.LinkedHashMap<K,V> map
          +
          +
          +
          +
          + +

          + + + + + +
          +Class org.apache.tools.ant.util.VectorSet extends java.util.Vector implements Serializable
          + +

          + + + + + +
          +Serialized Fields
          + +

          +set

          +
          +java.util.HashSet<E> set
          +
          +
          +
          +
          +
          + + + + + +
          +Package org.apache.tools.mail
          + +

          + + + + + +
          +Class org.apache.tools.mail.ErrorInQuitException extends java.io.IOException implements Serializable
          + +

          + +

          +

          + + + + + + + + + + + + + + + +
          + + + + + + + + + + + +
          Overview  Package  Class  Tree  Deprecated  Index  Help 
          +          		 + +
          + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
          + + + +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/api/stylesheet.css b/tools/apache-ant-1.8.2/docs/manual/api/stylesheet.css new file mode 100644 index 000000000..6d31fdbc7 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/api/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ +.TableRowColor { background: #FFFFFF } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} + diff --git a/tools/apache-ant-1.8.2/docs/manual/base_task_classes.html b/tools/apache-ant-1.8.2/docs/manual/base_task_classes.html new file mode 100644 index 000000000..1b058ebb3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/base_task_classes.html @@ -0,0 +1,114 @@ + + + + + + +Tasks Designed for Extension + + + +

          Tasks Designed for Extension

          + +

          These classes are designed to be extended. Always start here when writing your own task.

          + +

          The links will not work in the online version of this document.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +Class + +Description +
          +Task + +Base class for all tasks. +
          +AbstractCvsTask + +Another task can extend this with some customized output processing +
          +JDBCTask + +Handles JDBC configuration needed by SQL type tasks. +
          +MatchingTask + +This is an abstract task that should be used by all those tasks that require to include or exclude files based on pattern matching. +
          +Pack + +Abstract Base class for pack tasks. +
          +Unpack + +Abstract Base class for unpack tasks. +
          +DispatchTask + +Abstract Base class for tasks that may have multiple actions. +
          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/clonevm.html b/tools/apache-ant-1.8.2/docs/manual/clonevm.html new file mode 100644 index 000000000..b0a534209 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/clonevm.html @@ -0,0 +1,52 @@ + + + + + + +ant.build.clonevm + + + + +

          ant.build.clonevm

          + +

          Since Apache Ant 1.7

          + +

          The value of the ant.build.clonevm system property controls how Ant +instruments forked Java Virtual Machines. The java and junit tasks support clonevm +attributes to control the VMs on a task-by-task basis while the system +property applies to all forked Java VMs.

          + +

          If the value of the property is true, then all system properties of +the forked Java Virtual Machine will be the same as those of the Java +VM running Ant. In addition, if you set ant.build.clonevm to true and build.sysclasspath has not been set, the +bootclasspath of forked Java VMs gets constructed as if +build.sysclasspath had the value "last".

          + +

          Note that this has to be a system property, so it cannot be +specified on the Ant command line. Use the ANT_OPTS environment +variable instead.

          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/conceptstypeslist.html b/tools/apache-ant-1.8.2/docs/manual/conceptstypeslist.html new file mode 100644 index 000000000..95dd79135 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/conceptstypeslist.html @@ -0,0 +1,88 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + +

          Concepts

          + + +

          List of Types

          + + +

          Namespace

          + + +

          Antlib

          + + +

          Custom Components

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/cover.html b/tools/apache-ant-1.8.2/docs/manual/cover.html new file mode 100644 index 000000000..f3f75770a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/cover.html @@ -0,0 +1,53 @@ + + + + + + +Apache Ant 1.8.2 User Manual + + + +
          +

          +

          Apache Ant™ 1.8.2 Manual

          +

          This is the manual for version 1.8.2 of + Apache Ant. + If your version + of Ant (as verified with ant -version) is older or newer than this + version then this is not the correct manual set. Please use the documentation + appropriate to your current version. Also, if you are using a version + older than the most recent release, we recommend an upgrade to fix bugs + as well as provide new functionality.

          +

           

          + +

          Ant's manual and API documentation is part of + the binary + distributions or available as a + separate archive. + Manuals for older releases are available for + download + as + well.

          + +

          Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation.

          +
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/credits.html b/tools/apache-ant-1.8.2/docs/manual/credits.html new file mode 100644 index 000000000..a4091c73e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/credits.html @@ -0,0 +1,70 @@ + + + + + + +Apache Ant User Manual - Credits + + + + +
          +

          Apache Ant User Manual

          +

          by

          +
          + + + +
          +

          Version: 1.8.2

          +
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/develop.html b/tools/apache-ant-1.8.2/docs/manual/develop.html new file mode 100644 index 000000000..3c20cb986 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/develop.html @@ -0,0 +1,546 @@ + + + + + + +Writing Your Own Task + + + +

          Developing with Apache Ant

          + +

          Writing Your Own Task

          +

          It is very easy to write your own task:

          +
            +
          1. Create a Java class that extends org.apache.tools.ant.Task + or another class that was designed to be extended.
            2. +
          2. For each attribute, write a setter method. The setter method must be a + public void method that takes a single argument. The + name of the method must begin with set, followed by the + attribute name, with the first character of the name in uppercase, and the rest in + + lowercase*. That is, to support an attribute named + file you create a method setFile. + Depending on the type of the argument, Ant will perform some + conversions for you, see below.
            3. + +
          3. If your task shall contain other tasks as nested elements (like + parallel), your + class must implement the interface + org.apache.tools.ant.TaskContainer. If you do so, your + task can not support any other nested elements. See + below.
            4. + +
          4. If the task should support character data (text nested between the +start end end tags), write a public void addText(String) +method. Note that Ant does not expand properties on +the text it passes to the task.
            5. + +
          5. For each nested element, write a create, add or +addConfigured method. A create method must be a +public method that takes no arguments and returns an +Object type. The name of the create method must begin +with create, followed by the element name. An add (or +addConfigured) method must be a public void method that +takes a single argument of an Object type with a +no-argument constructor. The name of the add (addConfigured) method +must begin with add (addConfigured), +followed by the element name. For a more complete discussion see +below.
            6. + +
          6. Write a public void execute method, with no arguments, that +throws a BuildException. This method implements the task +itself.
            7. +
          + +
          +

          * Actually the case of the letters after +the first one doesn't really matter to Ant, using all lower case is a +good convention, though.

          + +

          The Life-cycle of a Task

          +
            +
          1. + The xml element that contains the tag corresponding to the + task gets converted to an UnknownElement at parser time. + This UnknownElement gets placed in a list within a target + object, or recursivly within another UnknownElement. +
            2. +
          2. + When the target is executed, each UnknownElement is invoked + using an perform() method. This instantiates + the task. This means that tasks only gets + instantiated at run time. +
            3. + +
          3. The task gets references to its project and location inside the + buildfile via its inherited project and + location variables.
            4. + +
          4. If the user specified an id attribute to this task, + the project + registers a reference to this newly created task, at run + time.
            5. + +
          5. The task gets a reference to the target it belongs to via its + inherited target variable.
            6. + +
          6. init() is called at run time.
            7. + +
          7. All child elements of the XML element corresponding to this task + are created via this task's createXXX() methods or + instantiated and added to this task via its addXXX() + methods, at run time. Child elements corresponding + to addConfiguredXXX() are created at this point but + the actual addCondifgired method is not called.
            8. + +
          8. All attributes of this task get set via their corresponding + setXXX methods, at runtime.
            9. + +
          9. The content character data sections inside the XML element + corresponding to this task is added to the task via its + addText method, at runtime.
            10. + +
          10. All attributes of all child elements get set via their corresponding + setXXX methods, at runtime.
            11. + +
          11. If child elements of the XML element corresponding to this task + have been created for addConfiguredXXX() methods, + those methods get invoked now.
            12. + +
          12. execute() is called at runtime. + If target1 and target2 both depend + on target3, then running + 'ant target1 target2' will run all tasks in + target3 twice.
            13. +
          + +

          Conversions Ant will perform for attributes

          + +

          Ant will always expand properties before it passes the value of an +attribute to the corresponding setter method. Since Ant 1.8, it is +possible to extend Ant's property handling +such that a non-string Object may be the result of the evaluation of a string +containing a single property reference. These will be assigned directly via +setter methods of matching type. Since it requires some beyond-the-basics +intervention to enable this behavior, it may be a good idea to flag attributes +intended to permit this usage paradigm. +

          + +

          The most common way to write an attribute setter is to use a +java.lang.String argument. In this case Ant will pass +the literal value (after property expansion) to your task. But there +is more! If the argument of you setter method is

          + +
            + +
          • boolean, your method will be passed the value + true if the value specified in the build file is one of + true, yes, or on and + false otherwise.
            • + +
          • char or java.lang.Character, your + method will be passed the first character of the value specified in + the build file.
            • + +
          • any other primitive type (int, short + and so on), Ant will convert the value of the attribute into this + type, thus making sure that you'll never receive input that is not a + number for that attribute.
            • + +
          • java.io.File, Ant will first determine whether the + value given in the build file represents an absolute path name. If + not, Ant will interpret the value as a path name relative to the + project's basedir.
            • + +
          • org.apache.tools.ant.types.Resource + org.apache.tools.ant.types.Resource, Ant will + resolve the string as a java.io.File as above, then + pass in as a org.apache.tools.ant.types.resources.FileResource. + Since Ant 1.8 +
            • + +
          • org.apache.tools.ant.types.Path, Ant will tokenize + the value specified in the build file, accepting : and + ; as path separators. Relative path names will be + interpreted as relative to the project's basedir.
            • + +
          • java.lang.Class, Ant will interpret the value + given in the build file as a Java class name and load the named + class from the system class loader.
            • + +
          • any other type that has a constructor with a single + String argument, Ant will use this constructor to + create a new instance from the value given in the build file.
            • + +
          • A subclass of + org.apache.tools.ant.types.EnumeratedAttribute, Ant + will invoke this classes setValue method. Use this if + your task should support enumerated attributes (attributes with + values that must be part of a predefined set of values). See + org/apache/tools/ant/taskdefs/FixCRLF.java and the + inner AddAsisRemove class used in setCr + for an example.
            • + +
          • A (Java 5) enumeration. Ant will call the setter with the enum constant + matching the value given in the build file. This is easier than using + EnumeratedAttribute and can result in cleaner code, but of course + your task will not run on JDK 1.4 or earlier. Note that any override of + toString() in the enumeration is ignored; the build file must use + the declared name (see Enum.getName()). You may wish to use lowercase + enum constant names, in contrast to usual Java style, to look better in build files. + As of Ant 1.7.0.
            • + +
          + +

          What happens if more than one setter method is present for a given +attribute? A method taking a String argument will always +lose against the more specific methods. If there are still more +setters Ant could chose from, only one of them will be called, but we +don't know which, this depends on the implementation of your Java +virtual machine.

          + +

          Supporting nested elements

          + +

          Let's assume your task shall support nested elements with the name +inner. First of all, you need a class that represents +this nested element. Often you simply want to use one of Ant's +classes like org.apache.tools.ant.types.FileSet to +support nested fileset elements.

          + +

          Attributes of the nested elements or nested child elements of them +will be handled using the same mechanism used for tasks (i.e. setter +methods for attributes, addText for nested text and +create/add/addConfigured methods for child elements).

          + +

          Now you have a class NestedElement that is supposed to +be used for your nested <inner> elements, you have +three options:

          + +
            +
          1. public NestedElement createInner()
            2. +
          2. public void addInner(NestedElement anInner)
            3. +
          3. public void addConfiguredInner(NestedElement anInner)
            4. +
          + +

          What is the difference?

          + +

          Option 1 makes the task create the instance of +NestedElement, there are no restrictions on the type. +For the options 2 and 3, Ant has to create an instance of +NestedInner before it can pass it to the task, this +means, NestedInner must have a public no-arg + constructor or a public one-arg constructor + taking a Project class as a parameter. +This is the only difference between options 1 and 2.

          + +

          The difference between 2 and 3 is what Ant has done to the object +before it passes it to the method. addInner will receive +an object directly after the constructor has been called, while +addConfiguredInner gets the object after the +attributes and nested children for this new object have been +handled.

          + +

          What happens if you use more than one of the options? Only one of +the methods will be called, but we don't know which, this depends on +the implementation of your Java virtual machine.

          + +

          Nested Types

          +If your task needs to nest an arbitary type that has been defined + using <typedef> you have two options. +
            +
          1. public void add(Type type)
            2. +
          2. public void addConfigured(Type type)
            3. +
          + The difference between 1 and 2 is the same as between 2 and 3 in the + previous section. +

          + For example suppose one wanted to handle objects object of type + org.apache.tools.ant.taskdefs.condition.Condition, one may + have a class: +

          +
          + 
          +public class MyTask extends Task {
+    private List conditions = new ArrayList();
+    public void add(Condition c) {
+        conditions.add(c);
+    }
+    public void execute() {
+     // iterator over the conditions
+    }
+}
+
          +
          +

          + One may define and use this class like this: +

          +
          + 
          +<taskdef name="mytask" classname="MyTask" classpath="classes"/>
+<typedef name="condition.equals"
+         classname="org.apache.tools.ant.taskdefs.conditions.Equals"/>
+<mytask>
+    <condition.equals arg1="${debug}" arg2="true"/>
+</mytask>
+
          +
          +

          + A more complicated example follows: +

          +
          + 
          +public class Sample {
+    public static class MyFileSelector implements FileSelector {
+         public void setAttrA(int a) {}
+         public void setAttrB(int b) {}
+         public void add(Path path) {}
+         public boolean isSelected(File basedir, String filename, File file) {
+             return true;
+         }
+     }
+
+    interface MyInterface {
+        void setVerbose(boolean val);
+    }        
+
+    public static class BuildPath extends Path {
+        public BuildPath(Project project) {
+            super(project);
+        }
+        
+        public void add(MyInterface inter) {}
+        public void setUrl(String url) {}
+    }
+
+    public static class XInterface implements MyInterface {
+        public void setVerbose(boolean x) {}
+        public void setCount(int c) {}
+    }
+}
+
          +
          +

          + This class defines a number of static classes that implement/extend + Path, MyFileSelector and MyInterface. These may be defined and used + as follows: +

          + 
          +    
          
+<typedef name="myfileselector" classname="Sample$MyFileSelector"
+         classpath="classes" loaderref="classes"/>
+<typedef name="buildpath" classname="Sample$BuildPath"
+         classpath="classes" loaderref="classes"/>
+<typedef name="xinterface" classname="Sample$XInterface"
+         classpath="classes" loaderref="classes"/>
+
+<copy todir="copy-classes">
+   <fileset dir="classes">
+      <myfileselector attra="10" attrB="-10">
+         <buildpath path="." url="abc">
+            <xinterface count="4"/>
+         </buildpath>
+      </myfileselector>
+   </fileset>
+</copy>
+    
          
+
          +

          TaskContainer

          + +

          The TaskContainer consists of a single method, +addTask that basically is the same as an add method for nested elements. The task +instances will be configured (their attributes and nested elements +have been handled) when your task's execute method gets +invoked, but not before that.

          + +

          When we said execute would be +called, we lied ;-). In fact, Ant will call the perform +method in org.apache.tools.ant.Task, which in turn calls +execute. This method makes sure that Build Events will be triggered. If you +execute the task instances nested into your task, you should also +invoke perform on these instances instead of +execute.

          + +

          Example

          +

          Let's write our own task, which prints a message on the +System.out stream. +The +task has one attribute, called message.

          +
          +
          +package com.mydomain;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.Task;
+
+public class MyVeryOwnTask extends Task {
+    private String msg;
+
+    // The method executing the task
+    public void execute() throws BuildException {
+        System.out.println(msg);
+    }
+
+    // The setter for the "message" attribute
+    public void setMessage(String msg) {
+        this.msg = msg;
+    }
+}
+
          +
          +

          It's really this simple ;-)

          +

          Adding your task to the system is rather simple too:

          +
            +
          1. Make sure the class that implements your task is in the classpath when + starting Ant.
            2. +
          2. Add a <taskdef> element to your project. + This actually adds your task to the system.
            3. +
          3. Use your task in the rest of the buildfile.
            4. +
          + +

          Example

          +
          +
          +<?xml version="1.0"?>
+
+<project name="OwnTaskExample" default="main" basedir=".">
+  <taskdef name="mytask" classname="com.mydomain.MyVeryOwnTask"/>
+
+  <target name="main">
+    <mytask message="Hello World! MyVeryOwnTask works!"/>
+  </target>
+</project>
+
          +
          +

          Example 2

          +To use a task directly from the buildfile which created it, place the +<taskdef> declaration inside a target +after the compilation. Use the classpath attribute of +<taskdef> to point to where the code has just been +compiled. +
          +
          +<?xml version="1.0"?>
+
+<project name="OwnTaskExample2" default="main" basedir=".">
+
+  <target name="build" >
+    <mkdir dir="build"/>
+    <javac srcdir="source" destdir="build"/>
+  </target>
+
+  <target name="declare" depends="build">
+    <taskdef name="mytask"
+        classname="com.mydomain.MyVeryOwnTask"
+        classpath="build"/>
+  </target>
+
+  <target name="main" depends="declare">
+    <mytask message="Hello World! MyVeryOwnTask works!"/>
+  </target>
+</project>
+
          +
          + +

          Another way to add a task (more permanently), is to add the task name and +implementing class name to the default.properties file in the +org.apache.tools.ant.taskdefs +package. Then you can use it as if it were a built-in task.

          + +
          +

          Build Events

          +

          Ant is capable of generating build events as it performs the tasks necessary to build a project. +Listeners can be attached to Ant to receive these events. This capability could be used, for example, +to connect Ant to a GUI or to integrate Ant with an IDE. +

          +

          To use build events you need to create an ant Project object. You can then call the +addBuildListener method to add your listener to the project. Your listener must implement +the org.apache.tools.antBuildListener interface. The listener will receive BuildEvents +for the following events

          +
            +
          • Build started
            • +
          • Build finished
            • +
          • Target started
            • +
          • Target finished
            • +
          • Task started
            • +
          • Task finished
            • +
          • Message logged
            • +
          + +

          If the build file invokes another build file via <ant> or <subant> or uses <antcall>, you are creating a +new Ant "project" that will send target and task level events of its +own but never sends build started/finished events. Ant 1.6.2 +introduces an extension of the BuildListener interface named +SubBuildListener that will receive two new events for

          +
            +
          • SubBuild started
            • +
          • SubBuild finished
            • +
          +

          If you are interested in those events, all you need to do is to +implement the new interface instead of BuildListener (and register the +listener, of course).

          + +

          +If you wish to attach a listener from the command line you may use the +-listener option. For example:

          +
          + 
          ant -listener org.apache.tools.ant.XmlLogger
          +
          +

          will run Ant with a listener that generates an XML representation of the build progress. This +listener is included with Ant, as is the default listener, which generates the logging to standard output.

          + +

          Note: A listener must not access System.out and System.err directly since ouput on +these streams is redirected by Ant's core to the build event system. Accessing these +streams can cause an infinite loop in Ant. Depending on the version of Ant, this will +either cause the build to terminate or the Java VM to run out of Stack space. A logger, also, may +not access System.out and System.err directly. It must use the streams with which it has +been configured. +

          + +

          Note2: All methods of a BuildListener except for the "Build + Started" and "Build Finished" events may occur on several threads + simultaneously - for example while Ant is executing + a <parallel> task.

          + +
          +

          Source code integration

          + +The other way to extend Ant through Java is to make changes to existing tasks, which is positively encouraged. +Both changes to the existing source and new tasks can be incorporated back into the Ant codebase, which +benefits all users and spreads the maintenance load around. +

          + +Please consult the +Getting Involved pages on the Jakarta web site +for details on how to fetch the latest source and how to submit changes for reincorporation into the +source tree. +

          +Ant also has some +task guidelines +which provides some advice to people developing and testing tasks. Even if you intend to +keep your tasks to yourself, you should still read this as it should be informative. + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/developlist.html b/tools/apache-ant-1.8.2/docs/manual/developlist.html new file mode 100644 index 000000000..0b90661ac --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/developlist.html @@ -0,0 +1,52 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + +

          Developing with Apache Ant

          + + + +

          Tutorials

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/dirtasks.html b/tools/apache-ant-1.8.2/docs/manual/dirtasks.html new file mode 100644 index 000000000..c11f4df5c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/dirtasks.html @@ -0,0 +1,314 @@ + + + + + + +Directory-based Tasks + + + + +

          Directory-based Tasks

          +

          Some tasks use directory trees for the actions they perform. +For example, the javac task, which +compiles a directory tree with .java files into +.class files, is one of these directory-based tasks. Because +some of these tasks do so much work with a directory tree, the task itself +can act as an implicit FileSet.

          +

          Whether the fileset is implicit or not, it can often be very useful to +work on a subset of the directory tree. This section describes how you can +select a subset of such a directory tree when using one of these +directory-based tasks.

          +

          Apache Ant gives you two ways to create a subset of files in a fileset, both of +which can be used at the same time:

          +
            +
          • Only include files and directories that match any + include patterns and do not match any + exclude patterns in a given + PatternSet.
            • +
          • Select files based on selection criteria defined by a collection of + selector nested elements.
            • +
          +

          Patternset

          + +

          We said that Directory-based tasks can sometimes act as an implicit +<fileset>, +but in addition to that, a FileSet acts as an implicit +<patternset>.

          + +

          The inclusion and exclusion elements of the implicit PatternSet can be +specified inside the directory-based task (or explicit fileset) via +either:

          +
            +
          • the attributes includes and + excludes.
            • +
          • nested elements <include> and + <exclude>.
            • +
          • external files specified with the attributes + includesfile and excludesfile.
            • +
          • external files specified with the nested elements + <includesfile> and <excludesfile>. +
            • +
          +

          +When dealing with an external file, each line of the file +is taken as a pattern that is added to the list of include or exclude +patterns.

          + +

          When both inclusion and exclusion are used, only files/directories that +match at least one of the include patterns and don't match any of the +exclude patterns are used. If no include pattern is given, all files +are assumed to match the include pattern (with the possible exception of +the default excludes).

          + +

          Patterns

          + +

          As described earlier, patterns are used for the inclusion and exclusion +of files. These patterns look very much like the patterns used in DOS and +UNIX:

          +

          '*' matches zero or more characters, '?' matches one character.

          + +

          In general, patterns are considered relative paths, relative to a +task dependent base directory (the dir attribute in the case of +<fileset>). Only files found below that base +directory are considered. So while a pattern like +../foo.java is possible, it will not match anything when +applied since the base directory's parent is never scanned for +files.

          + +

          Examples:

          +

          +*.java  matches  .java, +x.java and FooBar.java, but +not FooBar.xml (does not end with .java).

          +

          +?.java  matches  x.java, +A.java, but not .java or xyz.java +(both don't have one character before .java).

          +

          +Combinations of *'s and ?'s are allowed.

          +

          Matching is done per-directory. This means that first the first directory in +the pattern is matched against the first directory in the path to match. Then +the second directory is matched, and so on. For example, when we have the pattern +/?abc/*/*.java +and the path /xabc/foobar/test.java, +the first ?abc is matched with xabc, +then * is matched with foobar, +and finally *.java is matched with test.java. +They all match, so the path matches the pattern.

          +

          To make things a bit more flexible, we add one extra feature, which makes it +possible to match multiple directory levels. This can be used to match a +complete directory tree, or a file anywhere in the directory tree. +To do this, ** +must be used as the name of a directory. +When ** is used as the name of a +directory in the pattern, it matches zero or more directories. +For example: +/test/** matches all files/directories under /test/, +such as /test/x.java, +or /test/foo/bar/xyz.html, but not /xyz.xml.

          +

          There is one "shorthand": if a pattern ends +with / +or \, then ** +is appended. +For example, mypackage/test/ is interpreted as if it were +mypackage/test/**.

          +

          Example patterns:

          + + + + + + + + + + + + + + + + + +
          **/CVS/*Matches all files in CVS + directories that can be located + anywhere in the directory tree.
          + Matches: + 
          +      CVS/Repository
+      org/apache/CVS/Entries
+      org/apache/jakarta/tools/ant/CVS/Entries
+
          + But not: + 
          +      org/apache/CVS/foo/bar/Entries (foo/bar/
+      part does not match)
+
          +
          org/apache/jakarta/**Matches all files in the org/apache/jakarta + directory tree.
          + Matches: + 
          +      org/apache/jakarta/tools/ant/docs/index.html
+      org/apache/jakarta/test.xml
+
          + But not: + 
          +      org/apache/xyz.java
+
          + (jakarta/ part is missing).
          org/apache/**/CVS/*Matches all files in CVS directories + that are located anywhere in the directory tree under + org/apache.
          + Matches: + 
          +      org/apache/CVS/Entries
+      org/apache/jakarta/tools/ant/CVS/Entries
+
          + But not: + 
          +      org/apache/CVS/foo/bar/Entries
+
          + (foo/bar/ part does not match)
          **/test/**Matches all files that have a test + element in their path, including test as a filename.
          +

          When these patterns are used in inclusion and exclusion, you have a powerful +way to select just the files you want.

          + +

          Selectors

          +

          The <fileset>, +whether implicit or explicit in the +directory-based task, also acts as an +<and> +selector container. This can be used to create arbitrarily complicated +selection criteria for the files the task should work with. See the +Selector documentation for more +information.

          + +

          Standard Tasks/Filesets

          +

          Many of the standard tasks in ant take one or more filesets which follow +the rules given here. This list, a subset of those, is a list of standard ant +tasks that can act as an implicit fileset:

          + + +

          Examples

          +
          +<copy todir="${dist}">
+  <fileset dir="${src}"
+           includes="**/images/*"
+           excludes="**/*.gif"
+  />
+</copy>
          +

          This copies all files in directories called images that are +located in the directory tree defined by ${src} to the +destination directory defined by ${dist}, +but excludes all *.gif files from the copy.

          +
          +<copy todir="${dist}">
+  <fileset dir="${src}">
+    <include name="**/images/*"/>
+    <exclude name="**/*.gif"/>
+  </fileset>
+</copy>
+
          +

          The same as the example above, but expressed using nested elements.

          + +
          +<delete dir="${dist}">
+    <include name="**/images/*"/>
+    <exclude name="**/*.gif"/>
+</delete>
+
          +

          Deleting the original set of files, the delete task can act +as an implicit fileset.

          + +

          Default Excludes

          +

          There are a set of definitions that are excluded by default from all +directory-based tasks. As of Ant 1.8.1 they are:

          +
          +     **/*~
+     **/#*#
+     **/.#*
+     **/%*%
+     **/._*
+     **/CVS
+     **/CVS/**
+     **/.cvsignore
+     **/SCCS
+     **/SCCS/**
+     **/vssver.scc
+     **/.svn
+     **/.svn/**
+     **/.DS_Store
+
          +

          Ant 1.8.2 adds the folllowing default excludes:

          +
          +     **/.git
+     **/.git/**
+     **/.gitattributes
+     **/.gitignore
+     **/.gitmodules
+     **/.hg
+     **/.hg/**
+     **/.hgignore
+     **/.hgsub
+     **/.hgsubstate
+     **/.hgtags
+     **/.bzr
+     **/.bzr/**
+     **/.bzrignore
+
          +

          If you do not want these default excludes applied, you may disable +them with the defaultexcludes="no" +attribute.

          + +

          This is the default list; note that you can modify the list of +default excludes by using the defaultexcludes task.

          + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/favicon.ico b/tools/apache-ant-1.8.2/docs/manual/favicon.ico new file mode 100644 index 000000000..9dbc258f2 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/favicon.ico differ diff --git a/tools/apache-ant-1.8.2/docs/manual/feedback.html b/tools/apache-ant-1.8.2/docs/manual/feedback.html new file mode 100644 index 000000000..70027f661 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/feedback.html @@ -0,0 +1,72 @@ + + + + + + +Apache Ant User Manual - Feedback + + + + +

          Feedback and Troubleshooting

          +

          If things do not work, especially simple things like ant -version, + then something is wrong with your configuration. Before filing bug reports and + emailing all the Apache Ant mailing lists

          +
            +
          1. Check your environment variables. Are ANT_HOME and JAVA_HOME correct? If + they have quotes or trailing slashes, remove them.
            2. +
          2. Unset CLASSPATH; if that is wrong things go horribly wrong. Ant does not + need the CLASSPATH variable defined to anything to work.
            3. +
          3. Make sure there are no versions of crimson.jar or other XML parsers in JRE/ext
            4. +
          4. Is your path correct? is Ant on it? What about JDK/bin? have you tested + this? If you are using Jikes, is it on the path? A createProcess error (especially + with ID=2 on windows) usually means executable not found on the path.
            5. +
          5. Which version of ant are you running? Other applications distribute a copy + -it may be being picked up by accident.
            6. +
          6. If a task is failing to run is optional.jar in ANT_HOME/lib? Are there any + libraries which it depends on missing?
            7. +
          7. If a task doesn't do what you expect, run ant -verbose or ant + -debug to see what is happening
            8. +
          +

          If you can't fix your problem, start with the Ant + User Mailing List . These are other ant users who will help you learn to + use ant. If they cannot fix it then someone may suggest filing a bug report, + which will escalate the issue. Remember of course, that support, like all open + source development tasks, is voluntary. If you haven't invested time in helping + yourself by following the steps above, it is unlikely that anyone will invest + the time in helping you.

          +

          Also, if you don't understand something, the Ant + User Mailing List is the place to ask questions. Not the developer list, + nor the individuals whose names appears in the source and documentation. If + they answered all such emails, nobody would have any time to improve ant.

          +

          To provide feedback on this software, please subscribe to the Ant + User Mailing List

          + +

          If you want to contribute to Ant or stay current with the latest +development, join the +Ant Development Mailing List +

          +

          A searchable archive can be found at http://marc.theaimsgroup.com. +Other archives will be documented online at Mailing Lists Archives

          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/ide.html b/tools/apache-ant-1.8.2/docs/manual/ide.html new file mode 100644 index 000000000..7f2bc6d93 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/ide.html @@ -0,0 +1,105 @@ + + + + + + +IDE Integration + + + + + +

          Table of Contents

          + +

          IDE Integration

          +

          +All the modern Java IDEs support Apache Ant almost out of the box. +

          + +
            +
          • + + AntRunner For JBuilder (unbundled) + +
            • +
          • + + AntWork Plugin for the Jext Java Text Editor (unbundled) + +
            • +
          • + + JDEE (Java Development Environment for Emacs) + has built-in text ANT integration: selection of target through text + field, execution, hyperlink to compilation errors. Installation: built-in + JDEE 2.2.8 or later. Configuration: through customize menu + "Jde Build Function" +
            • +
          • + + IDEA + has built-in GUI ANT integration: GUI selection of targets, execution, + hyperlink to compilation errors +
            • +
          • + + NetBeans + + NetBeans IDE uses Ant as the basis for its project system starting with the 4.0 release. +
            • +
          • + + jEdit + + jEdit is an open source java IDE with some great plugins for Java dev, a + good XML editor and the Antfarm plugin to execute targets in a build + file. +
            • +
          • + + Eclipse + + Eclipse is IBM's counterpoint to NetBeans; an open source IDE with + Java and Ant support. +
            • +
          • + + Virtual Ant GUI allows you to work on a Virtual File System without dealing with the XML. Plugs into Eclipse, Netbeans & Intellij. +
            • +
          • + + WebSphere Studio Application Developer + +
            • +
          • + + JBuilder 9 Personal + + JBuilder supports Ant with the following features. Add Ant nodes to + projects and execute Ant targets from within JBuilder. Add custom Ant-based + build tasks with custom Ant libraries to run Ant from within JBuilder. + Rapid navigation from Ant build error messages to source files. + Customize build menu and toolbar with custom build targets. +
            • +
          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/index.html b/tools/apache-ant-1.8.2/docs/manual/index.html new file mode 100644 index 000000000..9df48a04a --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/index.html @@ -0,0 +1,34 @@ + + + + + + +Apache Ant™ User Manual + + + + + + + +<H2>Apache Ant&trade; User Manual</H2> + +<a href="toc.html">Apache Ant User Manual</a> + + diff --git a/tools/apache-ant-1.8.2/docs/manual/inputhandler.html b/tools/apache-ant-1.8.2/docs/manual/inputhandler.html new file mode 100644 index 000000000..1333157e4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/inputhandler.html @@ -0,0 +1,116 @@ + + + + + + +InputHandler + + + +

          InputHandler

          + +

          Overview

          + +

          When a task wants to prompt a user for input, it doesn't simply +read the input from the console as this would make it impossible to +embed Apache Ant in an IDE. Instead it asks an implementation of the +org.apache.tools.ant.input.InputHandler interface to +prompt the user and hand the user input back to the task.

          + +

          To do this, the task creates an InputRequest object +and passes it to the InputHandler Such an +InputRequest may know whether a given user input is valid +and the InputHandler is supposed to reject all invalid +input.

          + +

          Exactly one InputHandler instance is associated with +every Ant process, users can specify the implementation using the +-inputhandler command line switch.

          + +

          InputHandler

          + +

          The InputHandler interface contains exactly one +method

          + +
          +    void handleInput(InputRequest request) 
+        throws org.apache.tools.ant.BuildException;
+
          + +

          with some pre- and postconditions. The main postcondition is that +this method must not return unless the request considers +the user input valid, it is allowed to throw an exception in this +situation.

          + +

          Ant comes with three built-in implementations of this interface:

          + +

          DefaultInputHandler

          + +

          This is the implementation you get, when you don't use the +-inputhandler command line switch at all. This +implementation will print the prompt encapsulated in the +request object to Ant's logging system and re-prompt for +input until the user enters something that is considered valid input +by the request object. Input will be read from the +console and the user will need to press the Return key.

          + +

          PropertyFileInputHandler

          + +

          This implementation is useful if you want to run unattended build +processes. It reads all input from a properties file and makes the +build fail if it cannot find valid input in this file. The name of +the properties file must be specified in the Java system property +ant.input.properties.

          + +

          The prompt encapsulated in a request will be used as +the key when looking up the input inside the properties file. If no +input can be found, the input is considered invalid and an exception +will be thrown.

          + +

          Note that ant.input.properties must +be a Java system property, not an Ant property. I.e. you cannot +define it as a simple parameter to ant, but you can +define it inside the ANT_OPTS environment variable.

          + +

          GreedyInputHandler

          + +

          Like the default implementation, this InputHandler reads from standard +input. However, it consumes all available input. This behavior is +useful for sending Ant input via an OS pipe. Since Ant 1.7.

          + +

          SecureInputHandler

          + +

          This InputHandler calls System.console().readPassword(), +available since Java 1.6. On earlier platforms it falls back to the +behavior of DefaultInputHandler. Since Ant 1.7.1.

          + +

          InputRequest

          + +

          Instances of org.apache.tools.ant.input.InputRequest +encapsulate the information necessary to ask a user for input and +validate this input.

          + +

          The instances of InputRequest itself will accept any +input, but subclasses may use stricter validations. +org.apache.tools.ant.input.MultipleChoiceInputRequest +should be used if the user input must be part of a predefined set of +choices.

          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/install.html b/tools/apache-ant-1.8.2/docs/manual/install.html new file mode 100644 index 000000000..04c974c6e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/install.html @@ -0,0 +1,1097 @@ + + + + + + +Installing Apache Ant + + + +

          Installing Apache Ant

          +

          Getting Apache Ant

          + +

          The Short Story

          +

          To get up and running with the binary edition of Ant quickly, follow these steps: +

            +
          1. Make sure you have a Java environment installed, See System +Requirements for details.
            2. +
          2. Download Ant. See Binary Edition for details.
            3. +
          3. Uncompress the downloaded file into a directory.
            4. +
          4. Set environmental variables JAVA_HOME to your Java environment, ANT_HOME to +the directory you uncompressed Ant to, and add ${ANT_HOME}/bin (Unix) or +%ANT_HOME%/bin (Windows) to your PATH. See Setup for details.
            5. +
          5. Optionally, from the ANT_HOME directory run ant -f fetch.xml -Ddest=system to get +the library dependencies of most of the Ant tasks that require them. If you don't do this, many of the dependent +Ant tasks will not be available. See Optional Tasks for details and other options +for the -Ddest parameter.
            6. +
          6. Optionally, add any desired Antlibs. See Ant Libraries for a list. +
          +

          +

          +Note that the links in the list above will give more details about each of the steps, +should you need them. Or you can just continue reading the rest of this document. +

          +The short story for working with the Ant source code (not needed if you are working with the binary edition) is: +
            +
          1. Get the source code. See Source Edition for details.
            2. +
          2. Build Ant. See Building Ant for details.
            3. +
          +

          +

          +

          +For the full story, continue reading. +

          + +

          Binary Edition

          + +

          The latest stable version of Ant is available from the Ant web page http://ant.apache.org/ +

          + +

          The binary edition of Ant is shipped with 3 different compression formats: +

            +
          1. .zip - Recommended compression format for Windows, can also be used on other platforms. Supported +by many programs and some operating systems natively.
            2. +
          2. .tar.gz - Uses the tar program to gather files together, and gzip to compress and uncompress.
            3. +
          3. .tar.bz2 - Uses the tar program to gather files together, and bzip2 to compress and uncompress..
            4. +
          +Choose the format that is best supported for your platform. +

          + +

          As a binary in an RPM Package

          + +

          Consult the jpackage section below.

          + +

          Bundled in IDEs

          +

          + All the main Java IDEs ship with Ant, products such as Eclipse, NetBeans + and IntelliJ IDEA. If you install Ant this way you usually get the most recent + release of Ant at the time the IDE was released. Some of the IDEs (Eclipse + and NetBeans in particular) ship with extra tasks that only work if + IDE-specific tools are on Ant's path. To use these on command-line versions + of Ant, the relevant JARs need to be added to the command-line Ant as + extra libraries/tasks. Note that if it is an IDE task or extension that is + not behaving, the Ant team is unable to field bug reports. Try the IDE mailing + lists first, who will cross-file bugs if appropriate. +

          +

          + IDE's can invariably be pointed at different Ant installations. This lets + developers upgrade to a new release of Ant, and eliminate inconsistencies + between command-line and IDE Ant. +

          + +

          Bundled in Java applications

          + +

          + Many Java applications, most particularly application servers, ship with + a version of Ant. These are primarily for internal use by the application, + using the Java APIs to delegate tasks such as JSP page compilation to the Ant + runtime. Such distributions are usually unsupported by everyone. Particularly + troublesome are those products that not only ship with their own Ant release, + they add their own version of ANT.BAT or ant.sh to the PATH. If Ant starts + behaving wierdly after installing something, try the + diagnostics advice. +

          + +

          Source Edition

          + +

          If you prefer the source edition, you can download the source for the latest +Ant release from +http://ant.apache.org/srcdownload.cgi. + +If you prefer the leading-edge code, you can access +the code as it is being developed via SVN. The Ant website has details on +accessing SVN. +All bug fixes will go in against the HEAD of the source tree, and the first +response to many bugreps will be "have you tried the latest version". +Don't be afraid to download and build a prererelease edition, as everything +other than new features are usually stable. +

          +

          + + +See the section Building Ant on how to +build Ant from the source code. +You can also access the + +Ant SVN repository on-line.

          + +

          Archive Download Area Layout

          +

          +Older versions of Ant are available in the archives at http://archive.apache.org/dist/ant/. The +files are organized as follows. +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Filename or PathDescription
          KEYSPGP-Keysfile. It contains the PGP-keys of Ant developers so you can 'trust' the distribution.
          RELEASE-NOTES-{version}.html + Release notes of the given version in HTML format. When upgrading your Ant installation you + should have a look at the Changes that could break older environments section. +
          ant-current-bin.zip + ZIP-Archive containing the compiled version of Ant in the last released version. It is recommended that + you do not download the latest version this way, as the standard way of downloading described above will + redirect you to a mirror closer to you, thus making the download faster for you and reducing the load + on Apache servers. +
          ant-current-src.zip + ZIP-Archive containing the sources of Ant. If you have this you could compile Ant itself. + If you do not have the required dependencies, the classes depeding on them are just not + built. Again, it is preferred to use the standard way of getting the source package described above + to make your download quicker and to reduce the load on Apache servers. +
          ant-current-*.asc + Security file for checking the correctness of the zip file. This one is the + PGP key. +
          ant-current-*.md5 + Security file for checking the correctness of the zip file. This one is the + MD5 key. +
          ant-current-*.sha1 + Security file for checking the correctness of the zip file. This one is the + SHA1 key. +
          antlibs/ + This directory holds the Antlibs that are made of available by the Apache Ant project. + Antlibs are bundles of Ant tasks that are not delivered as part of the Ant core but are + available as optional downloads. +
          binaries/ + The binaries directory holds specific Ant releases bundled in both ZIP and tar.gz compression + formats. The named releases are in contrast to the ant-current-bin.zip file in the parent + directory, which is always guaranteed to be the most current release of Ant. +
          common/ + The common directory holds various files, such as the Apache License file that Ant is licensed + under, that people may wish to examine without having to download the whole Ant distribution. +
          source/ + The source directory holds the source code for specific Ant releases bundled in both ZIP and + tar.gz compression formats. The named releases are in contrast to the ant-current-src.zip file + in the parent directory, which is always guaranteed to hold the source code for the most current + release of Ant. +
          + +
          +

          System Requirements

          +Ant has been used successfully on many platforms, including Linux, +commercial flavours of Unix such as Solaris and HP-UX, +Windows NT-platforms, OS/2 Warp, Novell Netware 6, OpenVMS and MacOS X. +The platforms used most for development are, in no particular order, +Linux, MacOS X, Windows XP and Unix; these are therefore that platforms +that tend to work best. As of Ant1.7, Windows 9x is no longer supported. + +

          +For the current version of Ant, you will also need a JDK installed on +your system, version 1.4 or later required, 1.5 or later strongly recommended. +The later the version of Java , the more Ant tasks you get. +

          +

          + Note: If a JDK is not present, only the JRE runtime, then many tasks will not work. +

          +

          + Note: + Ant 1.8.* works with jdk1.4 and higher, Ant 1.7.* works with jdk1.3 and higher, Ant 1.6.* works with jdk 1.2 and higher, + Ant 1.2 to Ant 1.5.* work with jdk 1.1 and higher. +

          + +

          Open Source Java Runtimes

          +

          + The Ant team strongly supports users running Ant on Kaffe and other + open source Java runtimes, and so strives to have a product that works + well on those platforms. What appears to work well is Kaffe with + Gnu Classpath and the Xerces and Xalan libraries. +

          +
          +

          Installing Ant

          +

          The binary distribution of Ant consists of the following directory layout: +

          +  ant
+   +--- README, LICENSE, fetch.xml, other text files. //basic information
+   +--- bin  // contains launcher scripts
+   |
+   +--- lib  // contains Ant jars plus necessary dependencies
+   |
+   +--- docs // contains documentation
+   |      |
+   |      +--- images  // various logos for html documentation
+   |      |
+   |      +--- manual  // Ant documentation (a must read ;-)
+   |
+   +--- etc // contains xsl goodies to:
+            //   - create an enhanced report from xml output of various tasks.
+            //   - migrate your build files and get rid of 'deprecated' warning
+            //   - ... and more ;-)
+
          + +Only the bin and lib directories are +required to run Ant. + +To install Ant, choose a directory and copy the distribution +files there. This directory will be known as ANT_HOME. +

          + + + + + + + + + + + + + +
          + Windows 95, Windows 98 & Windows ME Note: +
            +Note that current releases of Ant no longer support these systems. If you are using an older +version of Ant, however, the script used to launch Ant will have +problems if ANT_HOME is a long filename (i.e. a filename which is not +of the format known as "8.3"). This is due to +limitations in the OS's handling of the "for" +batch-file statement. It is recommended, therefore, that Ant be +installed in a short, 8.3 path, such as C:\Ant. +
            +

          On these systems you will also need to configure more environment + space to cater for the environment variables used in the Ant lauch script. + To do this, you will need to add or update the following line in + the config.sys file +

          +

          shell=c:\command.com c:\ /p /e:32768

          +
          + +

          Setup

          +

          +Before you can run Ant there is some additional set up you +will need to do unless you are installing the RPM +version from jpackage.org:

          +
            +
          • Add the bin directory to your path.
            • +
          • Set the ANT_HOME environment variable to the +directory where you installed Ant. On some operating systems, Ant's +startup scripts can guess ANT_HOME (Unix dialects and +Windows NT/2000), but it is better to not rely on this behavior.
            • +
          • Optionally, set the JAVA_HOME environment variable +(see the Advanced section below). +This should be set to the directory where your JDK is installed.
            • +
          +

          Operating System-specific instructions for doing this from the command +line are in the Windows, Linux/Unix (bash), +and Linux/Unix (csh) sections. Note that using this method, +the settings will only be valid for the command line session you run them in.

          +

          Note: Do not install Ant's ant.jar file into the lib/ext +directory of the JDK/JRE. Ant is an application, whilst the extension +directory is intended for JDK extensions. In particular there are security +restrictions on the classes which may be loaded by an extension.

          + + + + + + + + + +
          + Windows Note: +
            + The ant.bat script makes use of three environment variables - + ANT_HOME, CLASSPATH and JAVA_HOME. Ensure that ANT_HOME and JAVA_HOME variables are set, + and that they do not have quotes (either + ' or ") and they do not end with \ or with /. CLASSPATH should be unset or + empty. +
          + +

          Check Installation

          +

          You can check the basic installation with opening a new shell and typing ant. You +should get a message like this +

          +Buildfile: build.xml does not exist!
+Build failed
+
          +So Ant works. This message is there because you need to write an individual buildfile for your +project. With a ant -version you should get an output like +
          +Apache Ant version 1.7.1 compiled on June 27 2008
+
          +

          +

          If this does not work ensure your environment variables are set right. They must resolve to: +

            +
          • required: %ANT_HOME%\bin\ant.bat
            • +
          • optional: %JAVA_HOME%\bin\java.exe
            • +
          • required: %PATH%=...maybe-other-entries...;%ANT_HOME%\bin;...maybe-other-entries...
            • +
          +ANT_HOME is used by the launcher script for finding the libraries. +JAVA_HOME is used by the launcher for finding the JDK/JRE to use. (JDK is recommended as some tasks +require the java tools.) If not set, the launcher tries to find one via the %PATH% environment variable. +PATH is set for user convinience. With that set you can just start ant instead of always typing +the/complete/path/to/your/ant/installation/bin/ant. +

          + +

          Optional Tasks

          +

          Ant supports a number of optional tasks. An optional task is a task which +typically requires an external library to function. The optional tasks are +packaged together with the core Ant tasks.

          + +

          The external libraries required by each of the optional tasks is detailed +in the Library Dependencies section. These external +libraries must be added to Ant's classpath, in any of the following ways: +

          +
            +

          • + In ANT_HOME/lib. This makes the JAR files available to all + Ant users and builds. +

            • + +

          • + In ${user.home}/.ant/lib (as of Ant 1.6). This + allows different users to add new libraries to Ant. All JAR files + added to this directory are available to command-line Ant. +

            • + +

          • + On the command line with a -lib parameter. This lets + you add new JAR files on a case-by-case basis. +

            • + +

          • + In the CLASSPATH environment variable. Avoid this; it makes + the JAR files visible to all Java applications, and causes + no end of support calls. See below for details. +

            +
            • + +

          • + In some <classpath> accepted by the task itself. + For example, as of Ant 1.7.0 you can run the <junit> + task without junit.jar in Ant's own classpath, so long as + it is included (along with your program and tests) in the classpath + passed when running the task. +

            + Where possible, this option is generally + to be preferred, as the Ant script itself can determine the best path + to load the library from: via relative path from the basedir (if you + keep the library under version control with your project), according + to Ant properties, environment variables, Ivy downloads, whatever you like. +

            • + +
          + +

          + If you are using the binary version of Ant, or if you are working from source + code, you can easily gather most of the dependencies and install them for use + with your Ant tasks. In your ANT_HOME directory you should see a + file called fetch.xml. This is an Ant script that you can run to + install almost all the dependencies the optional Ant tasks need. +

          + +

          + To do so, change to the ANT_HOME directory and execute the command: +

          + +
          + 
          ant -f fetch.xml -Ddest=[option]
          +
          + where option is one of the following, as described above: +
            +
          • system - store in Ant's lib directory (Recommended)
            • +
          • user - store in the user's home directory
            • +
          • optional - store in Ant's source code lib/optional directory, used if building Ant source code
            • +
          +

          + +

          + You may also need to set proxy settings. See the Proxy Settings section for details. +

          + +

          +Note that not all dependencies are gathered using fetch.xml. Tasks that depend on +commercial software, in particular, will require you to have the commercial software installed +in order to be used. +

          + +

          The Apache Ant Project also provides additional tasks and types that are available as separately +downloaded Ant Libraries. You can see the the list of available Antlibs at +the Ant Libraries page. +

          + +

          You can also find tasks and types provided by third-party projects at the +External Tools and Tasks page. +

          + +

          + IDEs have different ways of adding external JAR files and third-party tasks + to Ant. Usually it is done by some configuration dialog. Sometimes JAR files + added to a project are automatically added to ant's classpath. +

          + +

          The CLASSPATH environment variable

          +

          + +The CLASSPATH environment variable is a source of many Ant support queries. As +the round trip time for diagnosis on the Ant user mailing list can be slow, and +because filing bug reports complaining about 'ant.bat' not working will be +rejected by the developers as WORKSFORME "this is a configuration problem, not a +bug", you can save yourself a lot of time and frustration by following some +simple steps. + +

          +
            + +
          1. Do not ever set CLASSPATH. Ant does not need it, it only causes confusion +and breaks things. + +
            2. + +
          2. If you ignore the previous rule, do not ever, ever, put quotes in the +CLASSPATH, even if there is a space in a directory. This will break Ant, and it +is not needed.
            3. + +
          3. If you ignore the first rule, do not ever, ever, have a trailing backslash +in a CLASSPATH, as it breaks Ant's ability to quote the string. Again, this is +not needed for the correct operation of the CLASSPATH environment variable, even +if a DOS directory is to be added to the path.
            4. + +
          4. You can stop Ant using the CLASSPATH environment variable by setting the +-noclasspath option on the command line. This is an easy way +to test for classpath-related problems.
            5. + +
          + +

          + +The usual symptom of CLASSPATH problems is that ant will not run with some error +about not being able to find org.apache.tools.ant.launch.Launcher, or, if you have got the +quotes/backslashes wrong, some very weird Java startup error. To see if this is +the case, run ant -noclasspath or unset the CLASSPATH environment +variable. + +

          + +

          +You can also make your Ant script reject this environment +variable just by placing the following at the top of the script (or in an init target): +

          +
          +<property environment="env."/>
+<property name="env.CLASSPATH" value=""/>
+<fail message="Unset $CLASSPATH / %CLASSPATH% before running Ant!">
+    <condition>
+        <not>
+            <equals arg1="${env.CLASSPATH}" arg2=""/>
+        </not>
+    </condition>
+</fail>
+
          + +

          Proxy Configuration

          + +

          Many Ant built-in and third-party tasks use network connections to retrieve +files from HTTP servers. If you are behind a firewall with a proxy server, then +Ant needs to be configured with the proxy. Here are the different ways to do +this.

          + +
            + +
          • With Java1.5
            + +

            +When you run Ant on Java1.5, you could try to use the automatic proxy setup +mechanism with -autoproxy. +

            + +
            • + +
          • With explicit JVM properties.
            +

            +These are documented by Oracle, +and control the proxy behaviour of the entire JVM. To set them in Ant, declare +them in the ANT_OPTS environment variable. This is the best option +for a non-mobile system. For a laptop, you have to change these settings as you +roam. To set ANT_OPTS: +

            +
            +

            + For csh/tcsh: +

            +
            +    setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080"
+
            +

            + For bash: +

            +
            +    export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080"
+
            +

            + For Windows, set the environment variable in the appropriate dialog box + and open a new console. or, by hand +

            +
            +    set ANT_OPTS = -Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080
+
            +

            +
            +
            • + +
          • In the build file itself
            + +

            +If you are writing a build file that is always to be used behind the firewall, +the <setproxy> task lets you configure the proxy (which it does by setting +the JVM properties). If you do this, we strongly recommend using ant properties +to define the proxy host, port, etc, so that individuals can override the +defaults.

            • +

            + +
          + +

          The Ant team acknowledges that this is unsatisfactory. Until the JVM +automatic proxy setup works properly everywhere, explicit JVM options via +ANT_ARGS are probably the best solution. Setting properties on Ant's +command line do not work, because those are Ant properties being set, not +JVM options. This means the following does not set up the command line: + +

          + +
          ant -Dhttp.proxyHost=proxy -Dhttp.proxyPort=81
          + +

          All it does is set up two Ant properties.

          + +

          One other troublespot with +proxies is with authenticating proxies. Ant cannot go beyond what the JVM does +here, and as it is very hard to remotely diagnose, test and fix proxy-related +problems, users who work behind a secure proxy will have to spend much time +configuring the JVM properties until they are happy.

          + + +

          Windows and OS/2

          +

          Assume Ant is installed in c:\ant\. The following sets up the +environment:

          +
          set ANT_HOME=c:\ant
+set JAVA_HOME=c:\jdk-1.5.0.05
+set PATH=%PATH%;%ANT_HOME%\bin
          + +

          Linux/Unix (bash)

          +

          Assume Ant is installed in /usr/local/ant. The following sets up +the environment:

          +
          export ANT_HOME=/usr/local/ant
+export JAVA_HOME=/usr/local/jdk-1.5.0.05
+export PATH=${PATH}:${ANT_HOME}/bin
          + +

          Linux/Unix (csh)

          +
          setenv ANT_HOME /usr/local/ant
+setenv JAVA_HOME /usr/local/jdk/jdk-1.5.0.05
+set path=( $path $ANT_HOME/bin )
          + +

          +Having a symbolic link set up to point to the JVM/JDK version makes updates more seamless.

          + +

          RPM version from jpackage.org

          +

          +The JPackage project distributes an RPM version of Ant. +With this version, it is not necessary to set JAVA_HOME or + ANT_HOME environment variables and the RPM installer will correctly +place the Ant executable on your path. +

          +

          + NOTE: Since Ant 1.7.0, if the ANT_HOME + environment variable is set, the jpackage distribution will be + ignored. +

          +

          +Optional jars for the JPackage version are handled in two ways. The easiest, and +best way is to get these external libraries from JPackage if JPackage has them +available. (Note: for each such library, you will have to get both the external +package itself (e.g. oro-2.0.8-2jpp.noarch.rpm) and the small library that links +ant and the external package (e.g. ant-apache-oro-1.6.2-3jpp.noarch.rpm). +

          +However, JPackage does not package proprietary software, and since some of the +optional packages depend on proprietary jars, they must be handled as follows. +This may violate the spirit of JPackage, but it is necessary if you need these proprietary packages. +For example, suppose you want to install support for netrexx, which jpackage does not +support: +

            +
          1. Decide where you want to deploy the extra jars. One option is in $ANT_HOME/lib, +which, for JPackage is usually /usr/share/ant/lib. Another, less messy option +is to create an .ant/lib subdirectory of your home directory and place your +non-jpackage ant jars there, thereby avoiding mixing jpackage +libraries with non-jpackage stuff in the same folder. +More information on where Ant finds its libraries is available +here
            2. +
          2. Download a non-jpackage binary distribution from the regular + Apache Ant site
            3. +
          3. Unzip or untar the distribution into a temporary directory
            4. +
          4. Copy the linking jar, in this case ant-jai.jar, into the library directory you +chose in step 1 above.
            5. +
          5. Copy the proprietary jar itself into the same directory.
            6. +
          +Finally, if for some reason you are running on a system with both the JPackage and Apache versions of Ant +available, if you should want to run the Apache version (which will have to be specified with an absolute file name, +not found on the path), you should use Ant's --noconfig command-line switch to avoid JPackage's classpath mechanism. + + +

          Advanced

          + +

          There are lots of variants that can be used to run Ant. What you need is at +least the following:

          +
            +
          • The classpath for Ant must contain ant.jar and any jars/classes +needed for your chosen JAXP-compliant XML parser.
            • +
          • When you need JDK functionality +(such as for the javac task or the +rmic task), then tools.jar +must be added. The scripts supplied with Ant, +in the bin directory, will add +the required JDK classes automatically, if the JAVA_HOME +environment variable is set.
            • + +
          • When you are executing platform-specific applications, such as the +exec task or the +cvs task, the property ant.home +must be set to the directory containing where you installed Ant. Again +this is set by the Ant scripts to the value of the ANT_HOME environment +variable.
            • +
          +The supplied ant shell scripts all support an ANT_OPTS +environment variable which can be used to supply extra options +to ant. Some of the scripts also read in an extra script stored +in the users home directory, which can be used to set such options. Look +at the source for your platform's invocation script for details. + +
          +

          Building Ant

          +

          To build Ant from source, you can either install the Ant source distribution +or checkout the ant module from SVN. See Source Edition for details.

          +

          Once you have installed the source, change into the installation +directory.

          + +

          Set the JAVA_HOME environment variable +to the directory where the JDK is installed. +See Installing Ant +for examples on how to do this for your operating system.

          + +

          Note: The bootstrap process of Ant requires a greedy +compiler like Sun's javac or jikes. It does not work with gcj or +kjc.

          + +

          Make sure you have downloaded any auxiliary jars required to +build tasks you are interested in. These should be +added to the lib/optional +directory of the source tree. +See Library Dependencies +for a list of JAR requirements for various features. +Note that this will make the auxiliary JAR +available for the building of Ant only. For running Ant you will +still need to +make the JARs available as described under +Installing Ant.

          + +

          You can also get most of the auxiliary jar files (ie. the jar files +that various optional Ant tasks depend on) by running Ant on the +fetch.xml build file. See Optional +Tasks for instructions on how to do this. +

          + +

          As of version 1.7.0 Ant has a hard dependency on JUnit. The fetch.xml build + script will download JUnit automatically, but if you don't use this you must + install it manually into lib/optional (download it from + JUnit.org) if you are + using a source distribution of Ant.

          + +

          Your are now ready to build Ant:

          +
          +

          build -Ddist.dir=<directory_to_contain_Ant_distribution> dist    (Windows)

          +

          sh build.sh -Ddist.dir=<directory_to_contain_Ant_distribution> dist    (Unix)

          +
          + +

          This will create a binary distribution of Ant in the directory you specified.

          + +

          The above action does the following:

          +
            + +
          • If necessary it will bootstrap the Ant code. Bootstrapping involves the manual +compilation of enough Ant code to be able to run Ant. The bootstrapped Ant is +used for the remainder of the build steps.
            • + +
          • Invokes the bootstrapped Ant with the parameters passed to the build script. In +this case, these parameters define an Ant property value and specify the "dist" target +in Ant's own build.xml file.
            • + +
          • Create the ant.jar and ant-launcher.jar JAR files
            • + +
          • Create optional JARs for which the build had the relevant libraries. If +a particular library is missing from ANT_HOME/lib/optional, then the matching +ant- JAR file will not be created. For example, ant-junit.jar is only built +if there is a junit.jar in the optional directory.
            • +
          + +

          On most occasions you will not need to explicitly bootstrap Ant since the build +scripts do that for you. If however, the build file you are using makes use of features +not yet compiled into the bootstrapped Ant, you will need to manually bootstrap. +Run bootstrap.bat (Windows) or bootstrap.sh (UNIX) +to build a new bootstrap version of Ant.

          + +If you wish to install the build into the current ANT_HOME +directory, you can use: +
          +

          build install    (Windows)

          +

          sh build.sh install    (Unix)

          +
          + +You can avoid the lengthy Javadoc step, if desired, with: +
          +

          build install-lite    (Windows)

          +

          sh build.sh install-lite    (Unix)

          +
          +This will only install the bin and lib directories. +

          Both the install and +install-lite targets will overwrite +the current Ant version in ANT_HOME.

          + +

          Ant's build script will try to set executable flags for its shell + scripts on Unix-like systems. There are various reasons why the + chmod-task might fail (like when you are running the build script as + a different user than the one who installed Ant initially). In this + case you can set the Ant property chmod.fail to false + when starting the build like in +

          +

          sh build.sh install -Dchmod.fail=false

          +
          +and any error to change permission will not result in a build failure.

          + +
          +

          Library Dependencies

          +

          The following libraries are needed in Ant's classpath +if you are using the +indicated feature. Note that only one of the regexp libraries is +needed for use with the mappers +(and Java includes a regexp implementation which +Ant will find automatically). +You will also need to install the particular +Ant optional jar containing the task definitions to make these +tasks available. Please refer to the +Installing Ant / Optional Tasks section above.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Jar NameNeeded ForAvailable At
          jakarta-regexp-1.3.jarregexp type with mappers (if you do not wish to use java.util.regex)http://jakarta.apache.org/regexp/
          jakarta-oro-2.0.8.jarregexp type with mappers (if you do not wish to use java.util.regex) and the Perforce tasks
          + To use the FTP task, +you need jakarta-oro 2.0.8 or later, and commons-net          		http://jakarta.apache.org/oro/
          junit.jar<junit> task. May be in classpath passed to task rather than Ant's classpath.http://www.junit.org/
          xalan.jarjunitreport taskhttp://xml.apache.org/xalan-j/
          antlr.jarantlr taskhttp://www.antlr.org/
          bsf.jarscript task +

          + Note: Ant 1.6 and later require Apache BSF, not + the IBM version. I.e. you need BSF 2.3.0-rc1 or later. +

          +

          + Note: BSF 2.4.0 is needed to use a post 1.5R3 version + of rhino's javascript. +

          +

          + Note: BSF 2.4.0 uses jakarata-commons-logging + so it needs the commons-logging.jar. +

          +           		http://jakarta.apache.org/bsf/
          Groovy jarsGroovy with script and scriptdef tasks
          + You need to get the groovy jar and two asm jars from a groovy + installation. The jars are groovy-[version].jar, asm-[vesion].jar and + asm-util-[version].jar and antlr-[version].jar. + As of groovy version 1.0-JSR-06, the jars are + groovy-1.0-JSR-06.jar, antlr-2.7.5.jar, asm-2.2.jar and asm-util-2.2.jar. + Alternatively one may use the embedded groovy jar file. + This is located in the embedded directory of the groovy distribution. + This bundles all the needed jar files into one jar file. + It is called groovy-all-[version].jar. +           		+ http://groovy.codehaus.org/ +
          + The asm jars are also available from the creators of asm - + http://asm.objectweb.org/ +
          netrexx.jarnetrexx task, Rexx with the script task + http://www.ibm.com/software/awdtools/netrexx/download.html
          js.jarJavascript with script task
          + If you use Apache BSF 2.3.0-rc1, you must use rhino 1.5R3 (later + versions of BSF (e.g. version 2.4.0) work with 1.5R4 and higher).          		http://www.mozilla.org/rhino/
          jython.jarPython with script task
          + Warning : jython.jar also contains classes from jakarta-oro. + Remove these classes if you are also using jakarta-oro.          		http://jython.sourceforge.net/
          jpython.jarPython with script task deprecated, jython is the prefered enginehttp://www.jpython.org/
          jacl.jar and tcljava.jarTCL with script taskhttp://www.scriptics.com/software/java/
          BeanShell JAR(s)BeanShell with script task. +
          + Note: Ant requires BeanShell version 1.3 or + later          		http://www.beanshell.org/
          jruby.jarRuby with script taskhttp://jruby.sourceforge.net/
          judo.jarJudoscript with script taskhttp://www.judoscript.org/
          commons-logging.jarCommonsLoggingListenerhttp://jakarta.apache.org/commons/logging/index.html
          log4j.jarLog4jListenerhttp://jakarta.apache.org/log4j/docs/index.html
          commons-net.jarftp, rexec and telnet tasks
          + jakarta-oro 2.0.8 or later is required together with commons-net 1.4.0.
          + For all users, a minimum version of commons-net of 1.4.0 is recommended. Earlier + versions did not support the full range of configuration options, and 1.4.0 is needed + to compile Ant. +           		http://jakarta.apache.org/commons/net/index.html
          bcel.jarclassfileset data type, + JavaClassHelper used by the ClassConstants filter reader and + optionally used by ejbjar for dependency determination + http://jakarta.apache.org/bcel/
          mail.jarMail task with Mime encoding, and the MimeMail taskhttp://www.oracle.com/technetwork/java/index-jsp-139225.html
          activation.jarMail task with Mime encoding, and the MimeMail taskhttp://www.oracle.com/technetwork/java/javase/jaf-135115.html
          jdepend.jarjdepend taskhttp://www.clarkware.com/software/JDepend.html
          resolver.jar 1.1beta or laterxmlcatalog datatype only if support for external catalog files is desiredhttp://xml.apache.org/commons/.
          jsch.jar 0.1.42 or latersshexec and scp taskshttp://www.jcraft.com/jsch/index.html
          JAI - Java Advanced Imagingimage taskhttps://jai.dev.java.net/
          +
          +

          Troubleshooting

          + + +

          Diagnostics

          + +

          Ant has a built in diagnostics feature. If you run ant +-diagnostics ant will look at its internal state and print it out. This +code will check and print the following things.

          + +
            + +
          • Where Ant is running from. Sometimes you can be surprised.
            • + +
          • The version of ant.jar and of the ant-*.jar containing the optional tasks - + and whether they match
            • + +
          • Which JAR files are in ANT_HOME/lib + +
          • Which optional tasks are available. If a task is not listed as being +available, either it is not present, or libraries that it depends on are +absent.
            • + + +
          • XML Parser information
            • + +
          • JVM system properties +
            • + +
          • The status of the temp directory. If this is not writeable, or its clock is +horribly wrong (possible if it is on a network drive), a lot of tasks will fail +with obscure error messages.
            • + +
          • The current time zone as Java sees it. If this is not what it should be for +your location, then dependency logic may get confused. + +
          + +

          + Running ant -diagnostics is a good way to check that ant is + installed. It is also a first step towards self-diagnosis of any problem. + Any configuration problem reported to the user mailing list will probably + result ins someone asking you to run the command and show the results, so + save time by using it yourself. +

          + +

          + For under-IDE diagostics, use the <diagnostics> task to run the same + tests as an ant task. This can be added to a diagnostics target in a build + file to see what tasks are available under the IDE, what the XML parser and + classpath is, etc. +

          + +

          user mailing list

          + +

          If you cannot get Ant installed or working, the Ant user mailing list is the +best place to start with any problem. Please do your homework first, make sure +that it is not a CLASSPATH problem, and run a diagnostics check to see what Ant thinks of its own +state. Why the user list, and not the developer list? +Because there are more users than developers, so more people who can help you.

          + +

          + +Please only file a bug report against Ant for a configuration/startup problem if +there really is a fixable bug in Ant related to configuration, such as it not +working on a particular platform, with a certain JVM version, etc, or if you are +advised to do it by the user mailing list. +

          + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/installlist.html b/tools/apache-ant-1.8.2/docs/manual/installlist.html new file mode 100644 index 000000000..6bbe3dd0e --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/installlist.html @@ -0,0 +1,44 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + +

          Installing Apache Ant

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/intro.html b/tools/apache-ant-1.8.2/docs/manual/intro.html new file mode 100644 index 000000000..e5673ed7b --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/intro.html @@ -0,0 +1,69 @@ + + + + + + +Apache Ant User Manual - Introduction + + + +

          Introduction

          +

          Apache Ant is a Java-based build tool. In theory, it is kind of like +make, without make's wrinkles.

          +

          Why?

          +

          Why another build tool when there is already +make, +gnumake, +nmake, +jam, +and +others? Because all those tools have limitations that Ant's original author +couldn't live with when developing software across multiple platforms. +Make-like +tools are inherently shell-based: they evaluate a set of dependencies, +then execute commands not unlike what you would issue on a shell. +This means that you +can easily extend these tools by using or writing any program for the OS that +you are working on; however, this also means that you limit yourself to the OS, +or at least the OS type, such as Unix, that you are working on.

          +

          Makefiles are inherently evil as well. Anybody who has worked on them for any +time has run into the dreaded tab problem. "Is my command not executing +because I have a space in front of my tab?!!" said the original author of +Ant way too many times. Tools like Jam took care of this to a great degree, but +still have yet another format to use and remember.

          +

          Ant is different. Instead of a model where it is extended with shell-based +commands, Ant is extended using Java classes. Instead of writing shell commands, +the configuration files are XML-based, calling out a target tree where various +tasks get executed. Each task is run by an object that implements a particular +Task interface.

          +

          Granted, this removes some of the expressive power that is inherent in being +able to construct a shell command such as +`find . -name foo -exec rm {}`, but it +gives you the ability to be cross-platform--to work anywhere and +everywhere. And +hey, if you really need to execute a shell command, Ant has an +<exec> task that +allows different commands to be executed based on the OS it is executing +on.

          + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/javacprops.html b/tools/apache-ant-1.8.2/docs/manual/javacprops.html new file mode 100644 index 000000000..6cab07c46 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/javacprops.html @@ -0,0 +1,53 @@ + + + + + + +Properties controlling javac + + + + +

          The source and target attributes of <javac> +don't have any default values for historical reasons. Since the +underlying javac compiler's default depends on the JDK you use, you +may encounter build files that don't explicitly set those attributes +and that will no longer compile using a newer JDK. If you cannot +change the build file, Apache Ant provides two properties that help you +setting default values for these attributes. If the attributes have +been set explicitly, the properties listed here will be ignored.

          + +

          ant.build.javac.source

          + +

          Since Ant 1.7

          + +

          Provides a default value for <javac>'s and +<javadoc>'s source attribute.

          + +

          ant.build.javac.target

          + +

          Since Ant 1.7

          + +

          Provides a default value for <javac>'s target +attribute.

          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/listeners.html b/tools/apache-ant-1.8.2/docs/manual/listeners.html new file mode 100644 index 000000000..7904ca240 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/listeners.html @@ -0,0 +1,570 @@ + + + + + + +Listeners & Loggers + + + +

          Listeners & Loggers

          + +

          Overview

          + +

          Apache Ant has two related features to allow the build process to be monitored: +listeners and loggers.

          + +

          Listeners

          + +

          A listener is alerted of the following events:

          + +
            +
          • build started
            • +
          • build finished
            • +
          • target started
            • +
          • target finished
            • +
          • task started
            • +
          • task finished
            • +
          • message logged
            • +
          + +

          + These are used internally for various recording and housekeeping operations, + however new listeners may registered on the command line through the -listener + argument. +

          + +

          Loggers

          + +

          Loggers extend the capabilities of listeners and add the following features:

          + +
            +
          • Receives a handle to the standard output and error print streams and + therefore can log information to the console or the -logfile specified file.
            • +
          • Logging level (-quiet, -verbose, -debug) aware
            • +
          • Emacs-mode aware
            • +
          + +

          Built-in Listeners/Loggers

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          ClassnameDescriptionType
          org.apache.tools.ant.DefaultLoggerThe logger used implicitly unless overridden with the + -logger command-line switch.BuildLogger
          + org.apache.tools.ant.NoBannerLoggerThis logger omits output of empty target output.BuildLogger
          + org.apache.tools.ant.listener.MailLoggerExtends DefaultLogger such that output is still generated + the same, and when the build is finished an e-mail can be sent.BuildLogger
          + org.apache.tools.ant.listener.AnsiColorLoggerColorifies the build output.BuildLogger
          + org.apache.tools.ant.listener.Log4jListenerPasses events to Log4j for highly customizable logging.BuildListener
          org.apache.tools.ant.XmlLoggerWrites the build information to an XML file.BuildLogger
          org.apache.tools.ant.TimestampedLoggerPrints the time that a build finishedBuildLogger
          org.apache.tools.ant.listener.BigProjectLoggerPrints the project name every targetBuildLogger
          org.apache.tools.ant.listener.ProfileLoggerThe default logger, with start times, end times and + durations added for each task and target.BuildLogger
          + + + +

          DefaultLogger

          +

          Simply run Ant normally, or:

          +
          +

          ant -logger org.apache.tools.ant.DefaultLogger

          +
          + + + +

          NoBannerLogger

          +

          Removes output of empty target output.

          +
          +

          ant -logger org.apache.tools.ant.NoBannerLogger

          +
          + + + +

          MailLogger

          +

          The MailLogger captures all output logged through DefaultLogger (standard Ant +output) and will send success and failure messages to unique e-mail lists, with +control for turning off success or failure messages individually.

          + +

          Properties controlling the operation of MailLogger:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          PropertyDescriptionRequired
          MailLogger.mailhost Mail server to useNo, default "localhost"
          MailLogger.port SMTP Port for the Mail serverNo, default "25"
          MailLogger.useruser name for SMTP authYes, if SMTP auth is required on your SMTP server
          + the email message will be then sent using Mime and requires JavaMail
          MailLogger.passwordpassword for SMTP authYes, if SMTP auth is required on your SMTP server
          + the email message will be then sent using Mime and requires JavaMail
          MailLogger.sslon or true if ssl is needed
          + This feature requires JavaMail          		 + no
          MailLogger.fromMail "from" addressYes, if mail needs to be sent
          MailLogger.replytoMail "replyto" address(es), comma-separatedNo
          MailLogger.failure.notify Send build failure e-mails?No, default "true"
          MailLogger.success.notify Send build success e-mails?No, default "true"
          MailLogger.failure.to Address(es) to send failure messages to, comma-separatedYes, if failure mail is to be sent
          MailLogger.success.to Address(es) to send success messages to, comma-separatedYes, if success mail is to be sent
          MailLogger.failure.subject Subject of failed buildNo, default "Build Failure"
          MailLogger.success.subject Subject of successful buildNo, default "Build Success"
          MailLogger.failure.bodyFixed body of the email for a failed + build. Since Ant 1.8.0No, default is to send the full log output.
          MailLogger.success.bodyFixed body of the email for a successful + build. Since Ant 1.8.0No, default is to send the full log output.
          MailLogger.mimeTypeMIME-Type of the message. Since Ant 1.8.0No, default is text/plain
          MailLogger.charsetCharacter set of the message. Since Ant 1.8.0No
          MailLogger.starttls.enableon or true if STARTTLS should be supported + (requires JavaMail). Since Ant 1.8.0No, default is false
          MailLogger.properties.file Filename of properties file that will override other values.No
          + +
          +

          ant -logger org.apache.tools.ant.listener.MailLogger

          +
          + + + +

          AnsiColorLogger

          + +

          The AnsiColorLogger adds color to the standard Ant output +by prefixing and suffixing ANSI color code escape sequences to +it. It is just an extension of DefaultLogger +and hence provides all features that DefaultLogger does.

          +

          AnsiColorLogger differentiates the output by assigning +different colors depending upon the type of the message.

          +

          If used with the -logfile option, the output file +will contain all the necessary escape codes to +display the text in colorized mode when displayed +in the console using applications like cat, more, etc.

          +

          This is designed to work on terminals that support ANSI +color codes. It works on XTerm, ETerm, Win9x Console +(with ANSI.SYS loaded.), etc.

          +

          NOTE: +It doesn't work on WinNT and successors, even when a COMMAND.COM console loaded with +ANSI.SYS is used.

          +

          If the user wishes to override the default colors +with custom ones, a file containing zero or more of the +custom color key-value pairs must be created. The recognized keys +and their default values are shown below:

          +AnsiColorLogger.ERROR_COLOR=2;31
+AnsiColorLogger.WARNING_COLOR=2;35
+AnsiColorLogger.INFO_COLOR=2;36
+AnsiColorLogger.VERBOSE_COLOR=2;32
+AnsiColorLogger.DEBUG_COLOR=2;34
           +

          Each key takes as value a color combination defined as +Attribute;Foreground;Background. In the above example, background +value has not been used.

          +

          This file must be specfied as the value of a system variable +named ant.logger.defaults and passed as an argument using the -D +option to the java command that invokes the Ant application. +An easy way to achieve this is to add -Dant.logger.defaults= +/path/to/your/file to the ANT_OPTS environment variable. +Ant's launching script recognizes this flag and will pass it to +the java command appropriately.

          +

          Format:

          +AnsiColorLogger.*=Attribute;Foreground;Background
+
+Attribute is one of the following:
+0 -> Reset All Attributes (return to normal mode)
+1 -> Bright (Usually turns on BOLD)
+2 -> Dim
+3 -> Underline
+5 -> link
+7 -> Reverse
+8 -> Hidden
+
+Foreground is one of the following:
+30 -> Black
+31 -> Red
+32 -> Green
+33 -> Yellow
+34 -> Blue
+35 -> Magenta
+36 -> Cyan
+37 -> White
+
+Background is one of the following:
+40 -> Black
+41 -> Red
+42 -> Green
+43 -> Yellow
+44 -> Blue
+45 -> Magenta
+46 -> Cyan
+47 -> White
          + +
          +

          ant -logger org.apache.tools.ant.listener.AnsiColorLogger

          +
          + + + +

          Log4jListener

          +

          Passes build events to Log4j, using the full classname's of the generator of +each build event as the category:

          +
            +
          • build started / build finished - org.apache.tools.ant.Project
            • +
          • target started / target finished - org.apache.tools.ant.Target
            • +
          • task started / task finished - the fully qualified classname of the task
            • +
          • message logged - the classname of one of the above, so if a task logs a + message, its classname is the category used, and so on.
            • +
          +

          All start events are logged as INFO.  Finish events are either logged as +INFO or ERROR depending on whether the build failed during that stage. Message +events are logged according to their Ant logging level, mapping directly to a +corresponding Log4j level.

          + +
          +

          ant -listener org.apache.tools.ant.listener.Log4jListener

          +
          + +

          To use Log4j you will need the Log4j JAR file and a 'log4j.properties' +configuration file. Both should be placed somewhere in your Ant +classpath. If the log4j.properties is in your project root folder you can +add this with -lib option:

          + +
          +
          ant -listener org.apache.tools.ant.listener.Log4jListener -lib .
          +
          + +

          If, for example, you wanted to capture the same information output to the +console by the DefaultLogger and send it to a file named 'build.log', you +could use the following configuration:

          + +
          +
          log4j.rootLogger=ERROR, LogFile
+log4j.logger.org.apache.tools.ant.Project=INFO
+log4j.logger.org.apache.tools.ant.Target=INFO
+log4j.logger.org.apache.tools.ant.taskdefs=INFO
+log4j.logger.org.apache.tools.ant.taskdefs.Echo=WARN
+
+log4j.appender.LogFile=org.apache.log4j.FileAppender
+log4j.appender.LogFile.layout=org.apache.log4j.PatternLayout
+log4j.appender.LogFile.layout.ConversionPattern=[%6r] %8c{1} : %m%n
+log4j.appender.LogFile.file=build.log
+
          +
          + +

          For more information about configuring Log4J see its +documentation page.

          + + + +

          XmlLogger

          +

          Writes all build information out to an XML file named log.xml, or the value +of the XmlLogger.file property if present, when used as a +listener. When used as a logger, it writes all output to either the +console or to the value of -logfile. Whether used as a listener +or logger, the output is not generated until the build is complete, as it +buffers the information in order to provide timing information for task, +targets, and the project.

          +

          By default the XML file creates a reference to an XSLT file "log.xsl" in the current directory; +look in ANT_HOME/etc for one of these. You can set the property +ant.XmlLogger.stylesheet.uri to provide a uri to a style sheet. +this can be a relative or absolute file path, or an http URL. +If you set the property to the empty string, "", no XSLT transform +is declared at all.

          + +
          +

          ant -listener org.apache.tools.ant.XmlLogger
          +ant -logger org.apache.tools.ant.XmlLogger -verbose -logfile build_log.xml

          +
          + + + + +

          TimestampedLogger

          +

          + Acts like the default logger, except that the final success/failure message also includes + the time that the build completed. For example: +

          +
          +  BUILD SUCCESSFUL - at 16/08/05 16:24
+
          +

          To use this listener, use the command:

          + +
          +ant -logger org.apache.tools.ant.listener.TimestampedLogger +
          + + + +

          BigProjectLogger

          +

          + This logger is designed to make examining the logs of a big build easier, + especially those run under continuous integration tools. It +

          +
            +
          1. When entering a child project, prints its name and directory
            2. +
          2. When exiting a child project, prints its name
            3. +
          3. Includes the name of the project when printing a target
            4. +
          4. Omits logging the names of all targets that have no direct task output
            5. +
          5. Includes the build finished timestamp of the TimeStamp logger
            6. +
          +

          + This is useful when using <subant> to build a large project + from many smaller projects -the output shows which particular + project is building. Here is an example in which "clean" is being called + on all a number of child projects, only some of which perform work: +

          +
          +
+======================================================================
+Entering project "xunit"
+In /home/ant/components/xunit
+======================================================================
+
+xunit.clean:
+   [delete] Deleting directory /home/ant/components/xunit/build
+   [delete] Deleting directory /home/ant/components/xunit/dist
+
+======================================================================
+Exiting project "xunit"
+======================================================================
+
+======================================================================
+Entering project "junit"
+In /home/ant/components/junit
+======================================================================
+
+======================================================================
+Exiting project "junit"
+======================================================================
+
          + +

          + The entry and exit messages are very verbose in this example, but in + a big project compiling or testing many child components, the messages + are reduced to becoming clear delimiters of where different projects + are in charge -or more importantly, which project is failing. +

          +

          To use this listener, use the command:

          +
          +ant -logger org.apache.tools.ant.listener.BigProjectLogger +
          + + + +

          ProfileLogger

          +

          This logger stores the time needed for executing a task, target and the whole build and prints +these information. The output contains a timestamp when entering the build, target or task and a timestamp and the needed time when exiting. +

          + +

          since Ant 1.8.0

          +

          Example

          +Having that buildfile +
          +<project>
+    <target name="aTarget">
+        <echo>echo-task</echo>
+        <zip destfile="my.zip">
+            <fileset dir="${ant.home}"/>
+        </zip>
+    </target>
+    <target name="anotherTarget" depends="aTarget">
+        <echo>another-echo-task</echo>
+    </target>
+</project>
+
          +and executing with ant -logger org.apache.tools.ant.listener.ProfileLogger anotherTarget gives that output (with other timestamps and duration of course ;) : +
          +Buildfile: ...\build.xml
+
+Target aTarget: started Thu Jan 22 09:01:00 CET 2009
+
+echo: started Thu Jan 22 09:01:00 CET 2009
+     [echo] echo-task
+
+echo: finishedThu Jan 22 09:01:00 CET 2009 (250ms)
+
+zip: started Thu Jan 22 09:01:00 CET 2009
+      [zip] Building zip: ...\my.zip
+
+zip: finishedThu Jan 22 09:01:01 CET 2009 (1313ms)
+
+Target aTarget: finishedThu Jan 22 09:01:01 CET 2009 (1719ms)
+
+Target anotherTarget: started Thu Jan 22 09:01:01 CET 2009
+
+echo: started Thu Jan 22 09:01:01 CET 2009
+     [echo] another-echo-task
+
+echo: finishedThu Jan 22 09:01:01 CET 2009 (0ms)
+
+Target anotherTarget: finishedThu Jan 22 09:01:01 CET 2009 (0ms)
+
+BUILD SUCCESSFUL
+Total time: 2 seconds
+
          + + + +

          Writing your own

          + +

          See the Build Events section for +developers.

          + +

          Notes:

          + +
            +
          • + A listener or logger should not write to standard output or error in the messageLogged() method; + Ant captures these internally and it will trigger an infinite loop. +
            • +
          • + Logging is synchronous; all listeners and loggers are called one after the other, with the build blocking until + the output is processed. Slow logging means a slow build. +
            • +
          • When a build is started, and BuildListener.buildStarted(BuildEvent event) is called, + the project is not fully functional. The build has started, yes, and the event.getProject() method call + returns the Project instance, but that project is initialized with JVM and ant properties, nor has it + parsed the build file yet. You cannot call Project.getProperty() for property lookup, or + Project.getName() to get the project name (it will return null). +
            • +
          • + Classes that implement org.apache.tools.ant.SubBuildListener receive notifications when child projects + start and stop. +
            • +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/platform.html b/tools/apache-ant-1.8.2/docs/manual/platform.html new file mode 100644 index 000000000..be452fd15 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/platform.html @@ -0,0 +1,178 @@ + + + + + + +Platform Issues + + +

          Platform Issues

          + +

          Java versions

          +

          Java 1.5

          + +You may need a bigger stack than default, especially if you are using the built in +XSLT engine. We recommend you use Apache Xalan; indeed, some tasks (JUnit report in XML, +for example) may not work against the shipping XSL engine. + +

          Unix and Linux

          + +
            +
          • You should use a GNU version of tar to untar the Apache +Ant source tree, if you have downloaded this as a tar file. If you get +wierd errors about missing files, this is the problem. +
            • +
          • Ant does not preserve file permissions when a file is copied, moved or +archived, because Java does not let it read or write the permissions. + Use <chmod> to set permissions, and when creating a +tar archive, use the mode attribute of <tarfileset> +to set the permissions in the tar file, or <apply> the real tar program. +
            • +
          • Ant is not symbolic link aware in moves, deletes and when recursing down a tree +of directories to build up a list of files. Unexpected things can happen. +
            • +
          • Linux on IA-64: apparently you need a larger heap than the default +one (64M) to compile big projects. If you get out of heap +errors, either increase the heap or use a forking javac. Better yet, +use jikes for extra compilation speed. +
            • + +
          + + +

          Microsoft Windows

          +

          +Windows 9x (win95, win98, win98SE and winME) are not supported in Ant1.7, +

          + +

          +The Ant team has retired support for these products because they are outdated and +can expose customers to security risks. We recommend that customers who are +still running Windows 98 or Windows Me upgrade to a newer, more secure +operating system, as soon as possible. +

          +

          +Customers who upgrade to Linux report improved security, richer +functionality, and increased productivity. +

          +

          Microsoft Windows 2K, XP and Server 2K03

          + +

          +Windows 9x (win95, win98, win98SE and winME) has a batch file system which +does not work fully with long file names, so we recommend that ant and the JDK +are installed into directories without spaces, and with 8.3 filenames. +The Perl and Python launcher scripts do not suffer from this limitation. +

          +

          +All versions of windows are usually case insensitive, although mounted +file systems (Unix drives, Clearcase views) can be case sensitive underneath, +confusing patternsets. +

          +

          +Ant can often not delete a directory which is open in an Explorer window. +There is nothing we can do about this short of spawning a program to kill +the shell before deleting directories. +Nor can files that are in use be overwritten. +

          +

          + Finally, if any Ant task fails with an IOError=2, it means that whatever + native program Ant is trying to run, it is not on the path. +

          + +

          Microsoft Windows Vista

          +

          + There are reports of problems with Windows Vista security bringing up + dialog boxes asking if the user wants to run an untrusted executable + during an ant run, such as when the <signjar> task runs the jarsigner.exe + program. This is beyond Ant's control, and stems from the OS trying to provide + some illusion of security by being reluctant to run unsigned native executables. + The latest Java versions appear to resolve this problem by having signed + binaries. +

          + + +

          Cygwin

          + +Cygwin is not an operating system; rather it is an application suite +running under Windows and providing some UNIX like functionality. Sun has +not created any specific Java Development Kit or Java Runtime Environment for +cygwin. See this link : +http://www.inonit.com/cygwin/faq/ . +Only Windows path +names are supported by JDK and JRE tools under Windows or cygwin. Relative path +names such as "src/org/apache/tools" are supported, but Java tools do not +understand /cygdrive/c to mean c:\. +

          +The utility cygpath (used industrially in the ant script to support cygwin) can +convert cygwin path names to Windows. +You can use the <exec> task in ant to convert cygwin paths to Windows path, for +instance like that : +

          +<property name="some.cygwin.path" value="/cygdrive/h/somepath"/>
+<exec executable="cygpath" outputproperty="windows.pathname">
+   <arg value="--windows"/>
+   <arg value="${some.cygwin.path}"/>
+</exec>
+<echo message="${windows.pathname}"/>
+
          + +We get lots of support calls from Cygwin users. Either it is incredibly +popular, or it is trouble. If you do use it, remember that Java is a +Windows application, so Ant is running in a Windows process, not a +Cygwin one. This will save us having to mark your bug reports as invalid. + +

          Apple MacOS X

          + +MacOS X is the first of the Apple platforms that Ant supports completely; +it is treated like any other Unix. + +

          Novell Netware

          + +

          To give the same level of sophisticated control as Ant's startup scripts on other platforms, it was decided to make the main ant startup on NetWare be via a Perl Script, "runant.pl". This is found in the bin directory (for instance - bootstrap\bin or dist\bin).

          + +

          One important item of note is that you need to set up the following to run ant:

          +
          • CLASSPATH - put ant.jar and any other needed jars on the system classpath.
            • +
          • ANT_OPTS - On NetWare, ANT_OPTS needs to include a parameter of the form, "-envCWD=ANT_HOME", with ANT_HOME being the fully expanded location of Ant, not an environment variable. This is due to the fact that the NetWare System Console has no notion of a current working directory.
            • +
          +

          It is suggested that you create up an ant.ncf that sets up these parameters, and calls perl ANT_HOME/dist/bin/runant.pl

          +

          The following is an example of such an NCF file(assuming ant is installed in 'sys:/apache-ant/'):

          + +    envset CLASSPATH=SYS:/apache-ant/bootstrap/lib/ant.jar
          +    envset CLASSPATH=$CLASSPATH;SYS:/apache-ant/lib/optional/junit.jar
          +    envset CLASSPATH=$CLASSPATH;SYS:/apache-ant/bootstrap/lib/optional.jar
          +
          +    setenv ANT_OPTS=-envCWD=sys:/apache-ant
          +    envset ANT_OPTS=-envCWD=sys:/apache-ant
          +    setenv ANT_HOME=sys:/apache-ant/dist/lib
          +    envset ANT_HOME=sys:/apache-ant/dist/lib
          +
          +    perl sys:/apache-ant/dist/bin/runant.pl
          +           + +

          Ant works on JVM version 1.3 or higher. You may have some luck running it on JVM 1.2, but serious problems have been found running Ant on JVM 1.1.7B. These problems are caused by JVM bugs that will not be fixed.

          +

          JVM 1.3 is supported on Novell NetWare versions 5.1 and higher.

          + + +

          Other platforms

          +Support for other platforms is not guaranteed to be complete, as certain +techniques to hide platform details from build files need to be written and +tested on every particular platform. Contributions in this area are welcome. + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/projecthelper.html b/tools/apache-ant-1.8.2/docs/manual/projecthelper.html new file mode 100644 index 000000000..fa07aea44 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/projecthelper.html @@ -0,0 +1,150 @@ + + + + + + +The Apache Ant frontend: ProjectHelper + + + +

          The Apache Ant frontend: ProjectHelper

          + +

          What is a ProjectHelper?

          + +

          +The ProjectHelper in Apache Ant is responsible for parsing the build file +and creating java instances representing the build workflow. It also signals which +kind of file it can parse, and which file name it expects as default input file. +

          + +

          +Ant' default ProjectHelper +(org.apache.tools.ant.helper.ProjectHelper2) parses the +usual build.xml files. And if no build file is specified on the command line, it +will expect to find a file named build.xml. +

          + +

          +The immediate benefit of a such abstraction it that it is possible to make Ant +understand other kind of descriptive languages than XML. Some experiments have +been done around a pure java frontend, and a groovy one too (ask the dev mailing +list for further info about these). +

          + +

          Since Ant 1.8.2, the import task will also +try to use the proper helper to parse the imported file. So it is possible to +write different build files in different languages and have them import each +other. +

          + +

          How is Ant is selecting the proper ProjectHelper

          + +

          +Ant knows about several implementations of ProjectHelper +and has to decide which to use for each build file. +

          + +

          At startup Ant lists the all implementations found and keeps them +in the same order they've been found in an internal 'repository': +

            +
          • the first to be searched for is the one declared by the system property + org.apache.tools.ant.ProjectHelper (see + Java System Properties);
            • +
          • then it searches with its class loader for a ProjectHelper + service declarations in the META-INF: it searches in the classpath for a + file META-INF/services/org.apache.tools.ant.ProjectHelper. + This file will just contain the fully qualified name of the + implementation of ProjectHelper to instanciate;
            • +
          • it will also search with the system class loader for + ProjectHelper service declarations in the META-INF;
            • +
          • last but not least it will add its default ProjectHelper + that can parse classical build.xml files.
            • +
          +In case of an error while trying to instanciate a ProjectHelper, Ant +will log an error but won't stop. If you want further debugging +info about the ProjectHelper internal 'repository', use the system +property ant.project-helper-repo.debug and set it to +true; the full stack trace will then also be printed. +

          + +

          +When Ant is expected to parse a file, it will ask the +ProjectHelper repository to find an implementation that will be +able to parse the input file. Actually it will just iterate over the ordered list +and the first implementation that returns true to +supportsBuildFile(File buildFile) will be selected. +

          + +

          +When Ant is started and no input file has been specified, it will search for +a default input file. It will iterate over list of ProjectHelpers +and will select the first one that expects a default file that actually exist. +

          + +

          Writing your own ProjectHelper

          + +

          +The class org.apache.tools.ant.ProjectHelper is the API expected to +be implemented. So write your own ProjectHelper by extending that +abstract class. You are then expected to implement at least the function +parse(Project project, Object source). Note also that your +implementation will be instanciated by Ant, and it is expecting a default +constructor with no arguments. +

          + +

          +There are some functions that will help you define what your helper is +capable of and what is is expecting: +

            +
          • getDefaultBuildFile(): defines which file name is expected if + none provided
            • +
          • supportsBuildFile(File buildFile): defines if your parser + can parse the input file
            • + +
          • canParseAntlibDescriptor(URL url): whether your + implementation is capable of parsing a given Antlib + descriptor. The base class returns false
            • +
          • parseAntlibDescriptor(Project containingProject, URL + source): invoked to actually parse the Antlib + descriptor if your implementation returned true + for the previous method.
            • +
          +

          + +

          +Now that you have your implementation ready, you have to declare it to Ant. Three +solutions here: +

            +
          • use the system property org.apache.tools.ant.ProjectHelper + (see also the Java System Properties);
            • +
          • use the service file in META-INF: in the jar you will build with your + implementation, add a file + META-INF/services/org.apache.tools.ant.ProjectHelper. + And then in this file just put the fully qualified name of your + implementation
            • +
          • use the projecthelper task (since + Ant 1.8.2) which will install dynamically an helper in the internal helper + 'repository'. Then your helper can be used on the next call to the + import task.
            • +
          +

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/properties.html b/tools/apache-ant-1.8.2/docs/manual/properties.html new file mode 100644 index 000000000..9d488cbfe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/properties.html @@ -0,0 +1,396 @@ + + + + + + + Properties and PropertyHelpers + + + +

          Properties

          + +

          Properties are key-value-pairs where Apache Ant tries to + expand ${key} to value at runtime.

          + +

          There are many tasks that can set properties, the most common one + is the property task. In + addition properties can be defined + via command line arguments or similar + mechanisms from outside of Ant.

          + +

          Normally property values can not be changed, once a property is + set, most tasks will not allow its value to be modified. In + general properties are of global scope, i.e. once they have been + defined they are available for any task or target invoked + subsequently - it is not possible to set a property in a child + build process created via + the ant, antcall or subant tasks + and make it available to the calling build process, though.

          + +

          Starting with Ant 1.8.0 + the local task can be used to + create properties that are locally scoped to a target or + a sequential element like + the one of the macrodef + task.

          + +

          Built-in Properties

          + +

          Ant provides access to all system properties as if they had been + defined using a <property> task. For + example, ${os.name} expands to the name of the + operating system.

          +

          For a list of system properties see + the Javadoc of System.getProperties. +

          + +

          In addition, Ant has some built-in properties:

          +
          
+basedir             the absolute path of the project's basedir (as set
+                    with the basedir attribute of <project>).
+ant.file            the absolute path of the buildfile.
+ant.version         the version of Ant
+ant.project.name    the name of the project that is currently executing;
+                    it is set in the name attribute of <project>.
+ant.project.default-target
+                    the name of the currently executing project's
+                    default target;  it is set via the default
+                    attribute of <project>.
+ant.project.invoked-targets
+                    a comma separated list of the targets that have
+                    been specified on the command line (the IDE,
+                    an <ant> task ...) when invoking the current
+                    project.
+ant.java.version    the JVM version Ant detected; currently it can hold
+                    the values "1.2", "1.3",
+                    "1.4",  "1.5" and "1.6".
+ant.core.lib        the absolute path of the ant.jar file.
+
          + +

          There is also another property, but this is set by the launcher + script and therefore maybe not set inside IDEs:

          +
          +ant.home            home directory of Ant
+
          + +

          The following property is only set if Ant is started via the + Launcher class (which means it may not be set inside IDEs + either):

          +
          +ant.library.dir     the directory that has been used to load Ant's
+                    jars from.  In most cases this is ANT_HOME/lib.
+
          + +

          PropertyHelpers

          + +

          Ant's property handling is accomplished by an instance of + org.apache.tools.ant.PropertyHelper associated with + the current Project. You can learn more about this class by + examining Ant's Java API. In Ant 1.8 the PropertyHelper class was + much reworked and now itself employs a number of helper classes + (actually instances of + the org.apache.tools.ant.PropertyHelper$Delegate + marker interface) to take care of discrete tasks such as property + setting, retrieval, parsing, etc. This makes Ant's property + handling highly extensible; also of interest is the + new propertyhelper + task used to manipulate the PropertyHelper and its delegates from + the context of the Ant buildfile. + +

          There are three sub-interfaces of Delegate that may be + useful to implement.

          + +
            +
          • org.apache.tools.ant.property.PropertyExpander is + responsible for finding the property name inside a string in the + first place (the default extracts foo + from ${foo}). + +

            This is the interface you'd implement if you wanted to invent + your own property syntax - or allow nested property expansions + since the default implementation doesn't balance braces + (see NestedPropertyExpander + in the "props" Antlib for an example).

            +
            • + +
          • org.apache.tools.ant.PropertyHelper$PropertyEvaluator + is used to expand ${some-string} into + an Object. + +

            This is the interface you'd implement if you want to provide + your own storage independent of Ant's project instance - the + interface represents the reading end. An example for this + would + be org.apache.tools.ant.property.LocalProperties + which implements storage + for local properties.

            + +

            Another reason to implement this interface is if you wanted + to provide your own "property protocol" like + expanding toString:foo by looking up the project + reference foo and invoking toString() on it + (which is already implemented in Ant, see below).

            +
            • + +
          • org.apache.tools.ant.PropertyHelper$PropertySetter + is responsible for setting properties. + +

            This is the interface you'd implement if you want to provide + your own storage independent of Ant's project instance - the + interface represents the reading end. An example for this + would + be org.apache.tools.ant.property.LocalProperties + which implements storage + for local properties.

            +
            • + +
          + +

          The default PropertyExpander looks similar to:

          + +
          +public class DefaultExpander implements PropertyExpander {
+    public String parsePropertyName(String s, ParsePosition pos,
+                                    ParseNextProperty notUsed) {
+        int index = pos.getIndex();
+        if (s.indexOf("${", index) == index) {
+            int end = s.indexOf('}', index);
+            if (end < 0) {
+                throw new BuildException("Syntax error in property: " + s);
+            }
+            int start = index + 2;
+            pos.setIndex(end + 1);
+            return s.substring(start, end);
+        }
+        return null;
+    }
+}
+
          + +

          The logic that replaces ${toString:some-id} with the + stringified representation of the object with + id some-id inside the current build is contained in a + PropertyEvaluator similar to the following code:

          + +
          +public class ToStringEvaluator implements PropertyHelper.PropertyEvaluator {
+    private static final String prefix = "toString:";
+    public Object evaluate(String property, PropertyHelper propertyHelper) {
+        Object o = null;
+        if (property.startsWith(prefix) && propertyHelper.getProject() != null) {
+            o = propertyHelper.getProject().getReference(
+                    property.substring(prefix.length()));
+        }
+        return o == null ? null : o.toString();
+    }
+}
+
          + + +

          Property Expansion

          + +

          When Ant encounters a construct ${some-text} the + exact parsing semantics are subject to the configured property + helper delegates.

          + +

          $$ Expansion

          + +

          In its default configuration Ant will expand the + text $$ to a single $ and suppress the + normal property expansion mechanism for the text immediately + following it, i.e. $${key} expands + to ${key} and not value even though a + property named key was defined and had the + value value. This can be used to escape + literal $ characters and is useful in constructs that + only look like property expansions or when you want to provide + diagnostic output like in

          + +
            <echo>$${builddir}=${builddir}</echo>
          + +

          which will echo this message:

          + +
            ${builddir}=build/classes
          + +

          if the property builddir has the + value build/classes.

          + +

          In order to maintain backward compatibility with older Ant + releases, a single '$' character encountered apart from a + property-like construct (including a matched pair of french + braces) will be interpreted literally; that is, as '$'. The + "correct" way to specify this literal character, however, is by + using the escaping mechanism unconditionally, so that "$$" is + obtained by specifying "$$$$". Mixing the two approaches yields + unpredictable results, as "$$$" results in "$$".

          + +

          Nesting of Braces

          + +

          In its default configuration Ant will not try to balance braces + in property expansions, it will only consume the text up to the + first closing brace when creating a property name. I.e. when + expanding something like ${a${b}} it will be + translated into two parts:

          + +
            +
          1. the expansion of property a${b - likely nothing + useful.
            2. +
          2. the literal text } resulting from the second + closing brace
            3. +
          + +

          This means you can't use easily expand properties whose names are + given by properties, but there + are some + workarounds for older versions of Ant. With Ant 1.8.0 and the + the props Antlib + you can configure Ant to use + the NestedPropertyExpander defined there if you need + such a feature.

          + +

          Expanding a "Property Name"

          + +

          In its most simple form ${key} is supposed to look + up a property named key and expand to the value of + the property. Additional PropertyEvaluators may + result in a different interpretation of key, + though.

          + +

          The props + Antlib provides a few interesting evaluators but there are + also a few built-in ones.

          + +

          Getting the value of a Reference with + ${toString:}

          + +

          Any Ant type which has been declared with a reference can also + its string value extracted by using the ${toString:} + operation, with the name of the reference listed after + the toString: text. The toString() + method of the Java class instance that is referenced is invoked + -all built in types strive to produce useful and relevant output + in such an instance.

          + +

          For example, here is how to get a listing of the files in a fileset,

          + +

          +<fileset id="sourcefiles" dir="src" includes="**/*.java" />
+<echo> sourcefiles = ${toString:sourcefiles} </echo>
+
          + +

          There is no guarantee that external types provide meaningful + information in such a situation

          + +

          Getting the value of a Reference with + ${ant.refid:}

          + +

          Any Ant type which has been declared with a reference can also be + used as a property by using the ${ant.refid:} + operation, with the name of the reference listed after + the ant.refid: text. The difference between this + operation and ${toString:} is + that ${ant.refid:} will expand to the referenced + object itself. In most circumstances the toString method will be + invoked anyway, for example if the ${ant.refid:} is + surrounded by other text.

          + +

          This syntax is most useful when using a task with attribute + setters that accept objects other than String. For example if the + setter accepts a Resource object as in

          +
          +public void setAttr(Resource r) { ... }
+
          + +

          then the syntax can be used to pass in resource subclasses + previously defined as references like

          +
          +  <url url="http://ant.apache.org/" id="anturl"/>
+  <my:task attr="${ant.refid:anturl}"/>
+
          + +

          If/Unless Attributes

          +

          + The <target> element and various tasks (such as + <fail>) and task elements (such as <test> + in <junit>) support if and unless + attributes which can be used to control whether the item is run or otherwise + takes effect. +

          +

          + In Ant 1.7.1 and earlier, these attributes could only be property names. + The item was enabled if a property with that name was defined - even to be + the empty string or false - and disabled if the property was not + defined. For example, the following works but there is no way to override + the file existence check negatively (only positively): +

          + 
          +<target name="-check-use-file">
+    <available property="file.exists" file="some-file"/>
+</target>
+<target name="use-file" depends="-check-use-file" if="file.exists">
+    <!-- do something requiring that file... -->
+</target>
+<target name="lots-of-stuff" depends="use-file,other-unconditional-stuff"/>
+
          +

          + As of Ant 1.8.0, you may instead use property expansion; a value of + true (or on or yes) will enable the + item, while false (or off or no) will + disable it. Other values are still assumed to be property + names and so the item is enabled only if the named property is defined. +

          +

          + Compared to the older style, this gives you additional flexibility, because + you can override the condition from the command line or parent scripts: +

          + 
          +<target name="-check-use-file" unless="file.exists">
+    <available property="file.exists" file="some-file"/>
+</target>
+<target name="use-file" depends="-check-use-file" if="${file.exists}">
+    <!-- do something requiring that file... -->
+</target>
+<target name="lots-of-stuff" depends="use-file,other-unconditional-stuff"/>
+
          +

          + Now ant -Dfile.exists=false lots-of-stuff will run + other-unconditional-stuff but not use-file, + as you might expect, and you can disable the condition from another script + too: +

          + 
          +<antcall target="lots-of-stuff">
+    <param name="file.exists" value="false"/>
+</antcall>
+
          +

          + Similarly, an unless attribute disables the item if it is + either the name of property which is defined, or if it evaluates to a + true-like value. For example, the following allows you to define + skip.printing.message=true in my-prefs.properties with + the results you might expect: +

          + 
          +<property file="my-prefs.properties"/>
+<target name="print-message" unless="${skip.printing.message}">
+    <echo>hello!</echo>
+</target>
+
          + + diff --git a/tools/apache-ant-1.8.2/docs/manual/proxy.html b/tools/apache-ant-1.8.2/docs/manual/proxy.html new file mode 100644 index 000000000..864534255 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/proxy.html @@ -0,0 +1,295 @@ + + + + + + +Proxy Configuration + + + +

          Proxy Configuration

          + +

          +This page discussing proxy issues on command-line Apache Ant. +Consult your IDE documentation for IDE-specific information upon proxy setup. +

          + +

          + +All tasks and threads running in Ant's JVM share the same HTTP/FTP/Socks +proxy configuration. +

          + +

          + When any task tries to retrieve content from an HTTP page, including the + <get> task, any automated URL retrieval in + an XML/XSL task, or any third-party task that uses the java.net.URL + classes, the proxy settings may make the difference between success and failure. +

          +

          + Anyone authoring a build file behind a blocking firewall will immediately appreciate + the problems and may want to write a build file to deal with the problem, but + users of third party build build files may find that the build file itself + does not work behind the firewall. +

          +

          + This is a long standing problem with Java and Ant. The only way to fix + it is to explictly configure Ant with the proxy settings, either + by passing down the proxy details as JVM properties, or to + tell Ant on a Java1.5+ system to have the JVM work it out for itself. + +

          + + + +

          Java1.5+ proxy support (new for Ant1.7)

          +

          + When Ant starts up, if the -autoproxy + command is supplied, Ant sets the + java.net.useSystemProxies system property. This tells + a Java1.5+ JVM to use the current set of property settings of the host + environment. Other JVMs, such as the Kaffe and Apache Harmony runtimes, + may also use this property in future. + It is ignored on the Java1.4 and earlier runtimes. +

          +

          + This property maybe enough to give command-line Ant + builds network access, although in practise the results + are inconsistent. +

          +

          + It is has also been reported a breaking the IBM Java 5 JRE on AIX, + and does not always work on Linux (presumably due to missing gconf settings) + Other odd things can go wrong, like Oracle JDBC drivers or pure Java SVN clients. +

          + +

          + To make the -autoproxy option the default, add it to the environment variable + ANT_ARGS, which contains a list of arguments to pass to Ant on every + command line run. +

          + +

          How Autoproxy works

          +

          +We are grateful for some input from Sun as to how the proxy code works under +Java 1.5 and up. The java.net.useSystemProxies is checked only +once, at startup time, the other checks (registry, gconf, system properties) are done +dynamically whenever needed (socket connection, URL connection etc..). +

          +
          Windows
          + +

          +The JVM goes straight to the registry, bypassing WinInet, as it is not +present/consistent on all supported Windows platforms (it is part of IE, +really). Java 7 may use the Windows APIs on the platforms when it is present. +

          + +
          Linux
          + +

          +The JVM uses the gconf library to look at specific entries. +The GConf-2 settings used are: +

          +
          + - /system/http_proxy/use_http_proxy            boolean
+ - /system/http_proxy/use_authentication        boolean
+ - /system/http_proxy/host                      string
+ - /system/http_proxy/authentication_user       string
+ - /system/http_proxy/authentication_password   string
+ - /system/http_proxy/port                      int
+ - /system/proxy/socks_host                     string
+ - /system/proxy/mode                           string
+ - /system/proxy/ftp_host                       string
+ - /system/proxy/secure_host                    string
+ - /system/proxy/socks_port                     int
+ - /system/proxy/ftp_port                       int
+ - /system/proxy/secure_port                    int
+ - /system/proxy/no_proxy_for                   list
+ - /system/proxy/gopher_host                    string
+ - /system/proxy/gopher_port                    int
+
          +

          +If you are using KDE or another GUI than Gnome, you can still use the +gconf-editor tool to add these entries. +

          + + +

          Manual JVM options

          +

          + Any JVM can have its proxy options explicitly configured by passing + the appropriate -D system property options to the runtime. + Ant can be configured through all its shell scripts via the + ANT_OPTS environment variable, which is a list of options to + supply to Ant's JVM: +

          +

          + For bash: +

          +
          +    export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080"
+
          + For csh/tcsh: +
          +    setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080"
+
          +

          +If you insert this line into the Ant shell script itself, it gets picked up +by all continuous integration tools running on the system that call Ant via the +command line. +

          +

          + For Windows, set the ANT_OPTS environment variable in the appropriate "My Computer" + properties dialog box (winXP), "Computer" properties (Vista) +

          +

          + This mechanism works across Java versions, is cross-platform and reliable. + Once set, all build files run via the command line will automatically have + their proxy setup correctly, without needing any build file changes. It also + apparently overrides Ant's automatic proxy settings options. +

          +

          + It is limited in the following ways: +

          +
            +
          1. Does not work under IDEs. These need their own proxy settings changed
            2. +
          2. Not dynamic enough to deal with laptop configuration changes.
            3. +
          + + +

          SetProxy Task

          +

          + The setproxy task can be used to + explicitly set a proxy in a build file. This manipulates the many proxy + configuration properties of a JVM, and controls the proxy settings for all + network operations in the same JVM from that moment. +

          +

          + If you have a build file that is only to be used in-house, behind a firewall, on + an older JVM, and you cannot change Ant's JVM proxy settings, then + this is your best option. It is ugly and brittle, because the build file now contains + system configuration information. It is also hard to get this right across + the many possible proxy options of different users (none, HTTP, SOCKS). +

          + + +

          + Note that proxy configurations set with this task will probably override + any set by other mechanisms. It can also be used with fancy tricks to + only set a proxy if the proxy is considered reachable: +

          + +
          +  <target name="probe-proxy" depends="init">
+    <condition property="proxy.enabled">
+      <and>
+        <isset property="proxy.host"/>
+        <isreachable host="${proxy.host}"/>
+      </and>
+    </condition>
+  </target>
+
+  <target name="proxy" depends="probe-proxy" if="proxy.enabled">
+    <property name="proxy.port" value="80"/>
+    <property name="proxy.user" value=""/>
+    <property name="proxy.pass" value=""/>
+    <setproxy proxyhost="${proxy.host}" proxyport="${proxy.port}"
+      proxyuser="${proxy.user}" proxypassword="${proxy.pass}"/>
+  </target>
+
          + +

          Custom ProxySelector implementations

          +

          + As Java lets developers write their own ProxySelector implementations, it + is theoretically possible for someone to write their own proxy selector class that uses + different policies to determine proxy settings. There is no explicit support + for this in Ant, and it has not, to the team's knowledge, been attempted. +

          +

          + This could be the most flexible of solutions, as one could easily imagine + an Ant-specific proxy selector that was driven off ant properties, rather + than system properties. Developers could set proxy options in their + custom build.properties files, and have this propagate. +

          +

          + One issue here is with concurrency: the default proxy selector is per-JVM, + not per-thread, and so the proxy settings will apply to all sockets opened + on all threads; we also have the problem of how to propagate options from + one build to the JVM-wide selector. +

          + +

          Configuring the Proxy settings of Java programs under Ant

          + +

          + Any program that is executed with <java> without setting + fork="true" will pick up the Ant's settings. If you need + different values, set fork="false" and provide the values + in <sysproperty> elements. +

          + If you wish to have + a forked process pick up the Ant's settings, use the + <syspropertyset> + element to propagate the normal proxy settings. The following propertyset + is a datatype which can be referenced in a <java> task to + pass down the current values. + +

          +
          +<propertyset id="proxy.properties">
+  <propertyref prefix="java.net.useSystemProxies"/>
+  <propertyref prefix="http."/>
+  <propertyref prefix="https."/>
+  <propertyref prefix="ftp."/>
+  <propertyref prefix="socksProxy"/>
+</propertyset>
+
          + +

          Summary and conclusions

          +

          +There are four ways to set up proxies in Ant. +

          +
            +
          1. With Ant1.7 and Java 1.5+ using the -autoproxy parameter.
            2. +
          2. Via JVM system properties -set these in the ANT_ARGS environment variable.
            3. +
          3. Via the <setproxy> task.
            4. +
          4. Custom ProxySelector implementations
            5. +
          +

          +Proxy settings are automatically shared with Java programs started under Ant +that are not forked; to pass proxy settings down to subsidiary programs, use +a propertyset. +

          +

          +Over time, we expect the Java 5+ proxy features to stabilize, and for Java code +to adapt to them. However, given the fact that it currently does break some +builds, it will be some time before Ant enables the automatic proxy feature by +default. Until then, you have to enable the -autoproxy option or +use one of the alternate mechanisms to configure the JVM. + +

          Further reading

          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/running.html b/tools/apache-ant-1.8.2/docs/manual/running.html new file mode 100644 index 000000000..35837e3df --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/running.html @@ -0,0 +1,611 @@ + + + + + + +Running Apache Ant + + + + +

          Running Apache Ant

          +

          Command Line

          +

          If you've installed Apache Ant as described in the + Installing Ant section, +running Ant from the command-line is simple: just type +ant.

          +

          When no arguments are specified, Ant looks for a build.xml +file in the current directory and, if found, uses that file as the +build file and runs the target specified in the default +attribute of the <project> tag. +To make Ant use +a build file other than build.xml, use the command-line +option -buildfile file, +where file is the name of the build file you want to use.

          +If you use the -find [file] option, +Ant will search for a build file first in the current directory, then in +the parent directory, and so on, until either a build file is found or the root +of the filesystem has been reached. By default, it will look for a build file +called build.xml. To have it search for a build file other +than build.xml, specify a file argument. +Note: If you include any other flags or arguments +on the command line after +the -find flag, you must include the file argument +for the -find flag, even if the name of the +build file you want to find is build.xml. + +

          You can also set properties on the +command line. This can be done with +the -Dproperty=value option, +where property is the name of the property, +and value is the value for that property. If you specify a +property that is also set in the build file +(see the property task), +the value specified on the +command line will override the value specified in the +build file. +Defining properties on the command line can also be used to pass in +the value of environment variables; just pass +-DMYVAR=%MYVAR% (Windows) or +-DMYVAR=$MYVAR (Unix) +to Ant. You can then access +these variables inside your build file as ${MYVAR}. +You can also access environment variables using the + property task's +environment attribute. +

          + +

          Options that affect the amount of logging output by Ant are: +-quiet, +which instructs Ant to print less +information to the console; +-verbose, which causes Ant to print +additional information to the console; and -debug, +which causes Ant to print considerably more additional information. +

          + +

          It is also possible to specify one or more targets that should be executed. +When omitted, the target that is specified in the +default attribute of the +project tag is +used.

          + +

          The -projecthelp option prints out a list +of the build file's targets. Targets that include a +description attribute are listed as "Main targets", +those without a description are listed as +"Other targets", then the "Default" target is listed +("Other targets" are only displayed if there are no main +targets, or if Ant is invoked in -verbose or -debug mode). + +

          Command-line Options Summary

          +
          ant [options] [target [target2 [target3] ...]]
+Options:
+  -help, -h              print this message
+  -projecthelp, -p       print project help information
+  -version               print the version information and exit
+  -diagnostics           print information that might be helpful to
+                         diagnose or report problems.
+  -quiet, -q             be extra quiet
+  -verbose, -v           be extra verbose
+  -debug, -d             print debugging information
+  -emacs, -e             produce logging information without adornments
+  -lib <path>            specifies a path to search for jars and classes
+  -logfile <file>        use given file for log
+    -l     <file>                ''
+  -logger <classname>    the class which is to perform logging
+  -listener <classname>  add an instance of class as a project listener
+  -noinput               do not allow interactive input
+  -buildfile <file>      use given buildfile
+    -file    <file>              ''
+    -f       <file>              ''
+  -D<property>=<value>   use value for given property
+  -keep-going, -k        execute all targets that do not depend
+                         on failed target(s)
+  -propertyfile <name>   load all properties from file with -D
+                         properties taking precedence
+  -inputhandler <class>  the class which will handle input requests
+  -find <file>           (s)earch for buildfile towards the root of
+    -s  <file>           the filesystem and use it
+  -nice  number          A niceness value for the main thread:
+                         1 (lowest) to 10 (highest); 5 is the default
+  -nouserlib             Run ant without using the jar files from ${user.home}/.ant/lib
+  -noclasspath           Run ant without using CLASSPATH
+  -autoproxy             Java 1.5+ : use the OS proxies
+  -main <class>          override Ant's normal entry point
+
          +

          For more information about -logger and +-listener see +Loggers & Listeners. +

          For more information about -inputhandler see +InputHandler. +

          Easiest way of changing the exit-behaviour is subclassing the original main class: +

          +public class CustomExitCode extends org.apache.tools.ant.Main {
+    protected void exit(int exitCode) {
+        // implement your own behaviour, e.g. NOT exiting the JVM
+    }
+}
+
          and starting Ant with access (-lib path-to-class) to this class. +

          + +

          Library Directories

          +

          +Prior to Ant 1.6, all jars in the ANT_HOME/lib would be added to the CLASSPATH +used to run Ant. This was done in the scripts that started Ant. From Ant 1.6, +two directories are scanned by default and more can be added as required. The +default directories scanned are ANT_HOME/lib and a user specific directory, +${user.home}/.ant/lib. This arrangement allows the Ant installation to be +shared by many users while still allowing each user to deploy additional jars. +Such additional jars could be support jars for Ant's optional tasks or jars +containing third-party tasks to be used in the build. It also allows the main Ant installation to be locked down which will please system adminstrators. +

          + +

          +Additional directories to be searched may be added by using the -lib option. +The -lib option specifies a search path. Any jars or classes in the directories +of the path will be added to Ant's classloader. The order in which jars are +added to the classpath is as follows: +

          + +
            +
          • -lib jars in the order specified by the -lib elements on the command line
            • +
          • jars from ${user.home}/.ant/lib (unless -nouserlib is set)
            • +
          • jars from ANT_HOME/lib
            • +
          + +

          +Note that the CLASSPATH environment variable is passed to Ant using a -lib +option. Ant itself is started with a very minimalistic classpath. +Ant should work perfectly well with an empty CLASSPATH environment variable, +something the the -noclasspath option actually enforces. We get many more support calls related to classpath problems (especially quoting problems) than +we like. + +

          + +

          +The location of ${user.home}/.ant/lib is somewhat dependent on the JVM. On Unix +systems ${user.home} maps to the user's home directory whilst on recent +versions of Windows it will be somewhere such as +C:\Documents and Settings\username\.ant\lib. You should consult your +JVM documentation for more details. +

          + +

          Examples

          +
          + 
          ant
          +
          +

          runs Ant using the build.xml file in the current directory, on +the default target.

          + +
          + 
          ant -buildfile test.xml
          +
          +

          runs Ant using the test.xml file in the current directory, on +the default target.

          + +
          + 
          ant -buildfile test.xml dist
          +
          +

          runs Ant using the test.xml file in the current directory, on +the target called dist.

          + +
          + 
          ant -buildfile test.xml -Dbuild=build/classes dist
          +
          +

          runs Ant using the test.xml file in the current directory, on +the target called dist, setting the build property +to the value build/classes.

          + +
          + 
          ant -lib /home/ant/extras
          +
          +

          runs Ant picking up additional task and support jars from the +/home/ant/extras location

          + +
          + 
          ant -lib one.jar;another.jar
          + 
          ant -lib one.jar -lib another.jar
          +
          +

          adds two jars to Ants classpath.

          + + + +

          Files

          + +

          The Ant wrapper script for Unix will source (read and evaluate) the +file ~/.antrc before it does anything. On Windows, the Ant +wrapper batch-file invokes %HOME%\antrc_pre.bat at the start and +%HOME%\antrc_post.bat at the end. You can use these +files, for example, to set/unset environment variables that should only be +visible during the execution of Ant. See the next section for examples.

          + +

          Environment Variables

          + +

          The wrapper scripts use the following environment variables (if +set):

          + +
            +
          • JAVACMD - full path of the Java executable. Use this + to invoke a different JVM than JAVA_HOME/bin/java(.exe).
            • + +
          • ANT_OPTS - command-line arguments that should be + passed to the JVM. For example, you can define system properties or set + the maximum Java heap size here.
            • + +
          • ANT_ARGS - Ant command-line arguments. For example, + set ANT_ARGS to point to a different logger, include a + listener, and to include the -find flag.
            • + Note: If you include -find + in ANT_ARGS, you should include the name of the build file + to find, even if the file is called build.xml. +
          + +

          Java System Properties

          +

          Some of Ant's core classes can be configured via system properties.

          +

          Here is the result of a search through the codebase. Because system properties are +available via Project instance, I searched for them with a +

          +    grep -r -n "getPropert" * > ..\grep.txt
+
          +command. After that I filtered out the often-used but not-so-important values (most of them +read-only values): path.separator, ant.home, basedir, user.dir, os.name, +line.separator, java.home, java.version, java.version, user.home, java.class.path
          +And I filtered out the getPropertyHelper access.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          property namevalid values /default valuedescription
          ant.build.javac.sourceSource-level version numberDefault source value for <javac>/<javadoc>
          ant.build.javac.targetClass-compatibility version numberDefault target value for <javac>
          ant.executor.classclassname; default is org. apache. tools. ant. helper. DefaultExecutorSince Ant 1.6.3 Ant will delegate Target invocation to the +org.apache.tools.ant.Executor implementation specified here. +
          ant.fileread only: full filename of the build fileThis is set to the name of the build file. In + + <import>-ed files, this is set to the containing build file. +
          ant.file.*read only: full filename of the build file of Ant projects + This is set to the name of a file by project; + this lets you determine the location of + <import>-ed files, +
          ant.input.propertiesfilename (required)Name of the file holding the values for the + PropertyFileInputHandler. +
          ant.logger.defaultsfilename (optional, default '/org/ apache/ tools/ ant/ listener/ defaults.properties')Name of the file holding the color mappings for the + AnsiColorLogger. +
          ant.netrexxc.*several formatsUse specified values as defaults for netrexxc. +
          ant.PropertyHelperant-reference-name (optional)Specify the PropertyHelper to use. The object must be of the type + org.apache.tools.ant.PropertyHelper. If not defined an object of + org.apache.tools.ant.PropertyHelper will be used as PropertyHelper. +
          ant.regexp.regexpimplclassnameclassname for a RegExp implementation; if not set Ant uses JDK 1.4's implementation; + RegExp-Mapper + "Choice of regular expression implementation" +
          ant.reuse.loaderbooleanallow to reuse classloaders + used in org.apache.tools.ant.util.ClasspathUtil +
          ant.XmlLogger.stylesheet.urifilename (default 'log.xsl')Name for the stylesheet to include in the logfile by + XmlLogger. +
          build.compilernameSpecify the default compiler to use. + see javac, + EJB Tasks + (compiler attribute), + javah +
          build.compiler.emacsboolean (default false)Enable emacs-compatible error messages. + see javac "Jikes Notes" +
          build.compiler.fulldependboolean (default false)Enable full dependency checking + see javac "Jikes Notes" +
          build.compiler.jvc.extensionsboolean (default true)enable Microsoft extensions of their java compiler + see javac "Jvc Notes" +
          build.compiler.pedanticboolean (default false)Enable pedantic warnings. + see javac "Jikes Notes" +
          build.compiler.warningsDeprecated flag see javac "Jikes Notes"
          build.rmicnamecontrol the rmic compiler
          build.sysclasspathsee its dedicated page, no + default valuesee its dedicated page
          file.encodingname of a supported character set (e.g. UTF-8, ISO-8859-1, US-ASCII)use as default character set of email messages; use as default for source-, dest- and bundleencoding + in translate
          + see JavaDoc of java.nio.charset.Charset + for more information about character sets (not used in Ant, but has nice docs). +
          jikes.class.pathpathThe specified path is added to the classpath if jikes is used as compiler.
          MailLogger.properties.file, MailLogger.*filename (optional, defaults derived from Project instance)Name of the file holding properties for sending emails by the + MailLogger. Override properties set + inside the buildfile or via command line. +
          org.apache.tools.ant.ProjectHelperclassname (optional, default 'org.apache.tools.ant.ProjectHelper')specifies the classname to use as ProjectHelper. The class must extend + org.apache.tools.ant.ProjectHelper. +
          p4.port, p4.client, p4.userseveral formatsSpecify defaults for port-, client- and user-setting of the + perforce tasks. +
          websphere.homepathPoints to home directory of websphere. + see EJB Tasks +
          XmlLogger.filefilename (default 'log.xml')Name for the logfile for MailLogger. +
          ant.project-helper-repo.debugboolean (default 'false')Set it to true to enable debuging with Ant's + ProjectHelper internal repository. +
          + +

          +If new properties get added (it happens), expect them to appear under the +"ant." and "org.apache.tools.ant" prefixes, unless the developers have a +very good reason to use another prefix. Accordingly, please avoid using +properties that begin with these prefixes. This protects you from future +Ant releases breaking your build file. +

          +

          return code

          +

          the ant start up scripts (in their Windows and Unix version) return +the return code of the java program. So a successful build returns 0, +failed builds return other values. +

          + +

          Cygwin Users

          +

          The Unix launch script that come with Ant works correctly with Cygwin. You +should not have any problems launching Ant from the Cygwin shell. It is +important to note, however, that once Ant is running it is part of the JDK +which operates as a native Windows application. The JDK is not a Cygwin +executable, and it therefore has no knowledge of Cygwin paths, etc. In +particular when using the <exec> task, executable names such +as "/bin/sh" will not work, even though these work from the Cygwin +shell from which Ant was launched. You can use an executable name such as +"sh" and rely on that command being available in the Windows path. +

          + +

          OS/2 Users

          +

          The OS/2 launch script was developed to perform complex tasks. It has two parts: +ant.cmd which calls Ant and antenv.cmd which sets the environment for Ant. +Most often you will just call ant.cmd using the same command line options as described +above. The behaviour can be modified by a number of ways explained below.

          + +

          Script ant.cmd first verifies whether the Ant environment is set correctly. The +requirements are:

          +
            +
          1. Environment variable JAVA_HOME is set.
            2. +
          2. Environment variable ANT_HOME is set.
            3. +
          3. Environment variable CLASSPATH is set and contains at least one element from +JAVA_HOME and at least one element from ANT_HOME.
            4. +
          + +

          If any of these conditions is violated, script antenv.cmd is called. This script +first invokes configuration scripts if there exist: the system-wide configuration +antconf.cmd from the %ETC% directory and then the user configuration +antrc.cmd from the %HOME% directory. At this moment both +JAVA_HOME and ANT_HOME must be defined because antenv.cmd +now adds classes.zip or tools.jar (depending on version of JVM) and +everything from %ANT_HOME%\lib except ant-*.jar to +CLASSPATH. Finally ant.cmd calls per-directory configuration +antrc.cmd. All settings made by ant.cmd are local and are undone when the +script ends. The settings made by antenv.cmd are persistent during the lifetime of the +shell (of course unless called automatically from ant.cmd). It is thus possible to call +antenv.cmd manually and modify some settings before calling ant.cmd.

          + +

          Scripts envset.cmd and runrc.cmd perform auxiliary tasks. All scripts +have some documentation inside.

          + +

          Running Ant as a background process on + Unix(-like) systems

          + +

          If you start Ant as a background process (like in ant + &) and the build process creates another process, Ant will + immediately try to read from standard input, which in turn will + most likely suspend the process. In order to avoid this, you must + redirect Ant's standard input or explicitly provide input to each + spawned process via the input related attributes of the + corresponding tasks.

          + +

          Tasks that create such new processes + include <exec>, <apply> + or <java> when the fork attribute is + true.

          + +

          Running Ant via Java

          +

          If you have installed Ant in the do-it-yourself way, Ant can be started +from one of two entry points:

          +
          + 
          java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]
          +
          + +
          + 
          java -Dant.home=c:\ant org.apache.tools.ant.launch.Launcher [options] [target]
          +
          + +

          +The first method runs Ant's traditional entry point. The second method uses +the Ant Launcher introduced in Ant 1.6. The former method does not support +the -lib option and all required classes are loaded from the CLASSPATH. You must +ensure that all required jars are available. At a minimum the CLASSPATH should +include: +

          + +
            +
          • ant.jar and ant-launcher.jar
            • +
          • jars/classes for your XML parser
            • +
          • the JDK's required jar/zip files
            • +
          + +

          +The latter method supports the -lib, -nouserlib, -noclasspath options and will + load jars from the specified ANT_HOME. You should start the latter with the most minimal +classpath possible, generally just the ant-launcher.jar. +

          + + + +Ant can be started in Ant via the <java> command. +Here is an example: + +
          +<java
+        classname="org.apache.tools.ant.launch.Launcher"
+        fork="true"
+        failonerror="true"
+        dir="${sub.builddir}"
+        timeout="4000000"
+        taskname="startAnt"
+>
+    <classpath>
+        <pathelement location="${ant.home}/lib/ant-launcher.jar"/>
+    </classpath>
+    <arg value="-buildfile"/>
+    <arg file="${sub.buildfile}"/>
+    <arg value="-Dthis=this"/>
+    <arg value="-Dthat=that"/>
+    <arg value="-Dbasedir=${sub.builddir}"/>
+    <arg value="-Dthe.other=the.other"/>
+    <arg value="${sub.target}"/>
+</java>
+
          +
          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/runninglist.html b/tools/apache-ant-1.8.2/docs/manual/runninglist.html new file mode 100644 index 000000000..e2b8010f9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/runninglist.html @@ -0,0 +1,47 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + +

          Running Apache Ant

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/stylesheets/antmanual.css b/tools/apache-ant-1.8.2/docs/manual/stylesheets/antmanual.css new file mode 100644 index 000000000..049b2eda6 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/stylesheets/antmanual.css @@ -0,0 +1,20 @@ +/* + * 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. + * + */ +body { + background-image:url(/images/beta.png) +} diff --git a/tools/apache-ant-1.8.2/docs/manual/stylesheets/style.css b/tools/apache-ant-1.8.2/docs/manual/stylesheets/style.css new file mode 100644 index 000000000..cf26c60c3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/stylesheets/style.css @@ -0,0 +1,72 @@ +/* + * 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. + * + */ +h2 { + font-size: 200%; + background-color: ffffff; +} + +h3 { + font-size: 130%; + color: #ffffff; + background-color: #525D76; +} + +h4 { + color: #ffffff; + background-color: #828DA6; +} + +td { + background-color: eeeeee; + color: 000000; +} + +/* first row */ +table tr:first-child td { + background-color: cccccc; + color: 000000; +} + +/* or th as first row */ +table th { + background-color: cccccc; + color: 000000; +} + +pre { + background-color: efefef; +} + +/* code snippets in examples and tutorials */ +.code { + background: #EFEFEF; + margin-top: +} + +/* highlight console output */ +.output { + color: #FFFFFF; + background: #837A67; +} + +ul.inlinelist { + list-style-type: none; + margin-left: 0; + padding: 0; +} + diff --git a/tools/apache-ant-1.8.2/docs/manual/sysclasspath.html b/tools/apache-ant-1.8.2/docs/manual/sysclasspath.html new file mode 100644 index 000000000..5efb2086c --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/sysclasspath.html @@ -0,0 +1,79 @@ + + + + + + +build.sysclasspath + + + + +

          build.sysclasspath

          +

          The value of the build.sysclasspath property +controls how the system classpath, i.e. the classpath in effect when +Apache Ant is run, affects the behavior of classpaths in Ant. +The default behavior varies from task to task.

          + +The values and their meanings are: + + + + + + + + + + + + + + + + + + + + + + +
          valuemeaning
          onlyOnly the system classpath is used and classpaths specified in build files, +etc are ignored. This situation could be considered as the person running +the build file knows more about the environment than the person writing the +build file. +
          ignore +The system classpath is ignored. This situation is the reverse of the +above. The person running the build trusts the build file writer to get the +build file right. This mode is recommended for portable scripts. +
          last +The classpath is concatenated to any specified classpaths at the end. This +is a compromise, where the build file writer has priority. +
          first +Any specified classpaths are concatenated to the system classpath. This is +the other form of compromise where the build runner has priority. +
          + +

          Since Ant 1.7 the value of this property also affects the +bootclasspath settings--it combines the bootclasspath that has been +specified for a task with the bootclasspath of the Java VM running +Ant. If the property has not been set, it defaults to "ignore" in +this case.

          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/targets.html b/tools/apache-ant-1.8.2/docs/manual/targets.html new file mode 100644 index 000000000..8453fd724 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/targets.html @@ -0,0 +1,300 @@ + + + + + + + Targets and Extension-Points + + + +

          Targets

          + +

          A target is a container of tasks that cooperate to reach a + desired state during the build process.

          + +

          Targets can depend on other targets and Apache Ant ensures that these + other targets have been executed before the current target. For + example you might have a target for compiling and a + target for creating a distributable. You can only build a + distributable when you have compiled first, so the distribute + target depends on the compile target.

          + +

          Ant tries to execute the targets in the depends + attribute in the order they appear (from left to right). Keep in + mind that it is possible that a target can get executed earlier + when an earlier target depends on it:

          + +
          +
          <target name="A"/>
+<target name="B" depends="A"/>
+<target name="C" depends="B"/>
+<target name="D" depends="C,B,A"/>
          +
          + +

          Suppose we want to execute target D. From its + depends attribute, you might think that first target + C, then B and then A is executed. Wrong! C depends on B, and B + depends on A, so first A is executed, then B, then C, and finally + D.

          + + 
          Call-Graph:  A --> B --> C --> D
          + +

          In a chain of dependencies stretching back from a given target + such as D above, each target gets executed only once, even when + more than one target depends on it. Thus, executing the D target + will first result in C being called, which in turn will first call + B, which in turn will first call A. After A, then B, then C have + executed, execution returns to the dependency list of D, which + will not call B and A, since they were already called in + process of dependency resolution for C and B respectively as + dependencies of D. Had no such dependencies been discovered in + processing C and B, B and A would have been executed after C in + processing D's dependency list.

          + +

          A target also has the ability to perform its execution if (or + unless) a property has been set. This allows, for example, better + control on the building process depending on the state of the + system (java version, OS, command-line property defines, etc.). + To make a target sense this property, you should add + the if (or unless) attribute with the + name of the property that the target should react + to. Note: In the most simple case Ant will only + check whether the property has been set, the value doesn't matter, + but using property expansions you can build more complex + conditions. See + the properties page for + more details. For example:

          + +
          + 
          <target name="build-module-A" if="module-A-present"/>
          + 
          <target name="build-own-fake-module-A" unless="module-A-present"/>
          +
          + +

          In the first example, if the module-A-present + property is set (to any value, e.g. false), the target will + be run. In the second example, if + the module-A-present property is set (again, to any + value), the target will not be run.

          + +

          Only one propertyname can be specified in the if/unless + clause. If you want to check multiple conditions, you can use a + dependend target for computing the result for the check:

          + +
          +<target name="myTarget" depends="myTarget.check" if="myTarget.run">
+    <echo>Files foo.txt and bar.txt are present.</echo>
+</target>
+
+<target name="myTarget.check">
+    <condition property="myTarget.run">
+        <and>
+            <available file="foo.txt"/>
+            <available file="bar.txt"/>
+        </and>
+    </condition>
+</target>
+
          + + 
          Call-Graph:  myTarget.check --> maybe(myTarget)
          + +

          If no if and no unless attribute is + present, the target will always be executed.

          + +

          Important: the if and unless + attributes only enable or disable the target to which they are + attached. They do not control whether or not targets that a + conditional target depends upon get executed. In fact, they do + not even get evaluated until the target is about to be executed, + and all its predecessors have already run. + +

          The optional description attribute can be used to + provide a one-line description of this target, which is printed by + the -projecthelp command-line option. Targets without + such a description are deemed internal and will not be listed, + unless either the -verbose or -debug + option is used.

          + +

          It is a good practice to place + your tstamp tasks in a + so-called initialization target, on which all other targets + depend. Make sure that target is always the first one in the + depends list of the other targets. In this manual, most + initialization targets have the name "init".

          + 
          +    <project>
+        <target name="init">
+            <tstamp/>
+        </target>
+        <target name="otherTarget" depends="init">
+            ...
+        </target>
+    </project>
+
          + +

          Especially if you only have a few tasks you also could place these + tasks directly under the project tag (since Ant 1.6.0):

          + 
          +    <project>
+        <tstamp/>
+    </project>
+
          + +

          If the depends attribute and the if/unless attribute are set, the + depends attribute is executed first.

          + +

          A target has the following attributes:

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          AttributeDescriptionRequired
          namethe name of the target.Yes
          dependsa comma-separated list of names of targets on + which this target depends.No
          ifthe name of the property that must be set in + order for this target to execute, + or something evaluating to + true.No
          unlessthe name of the property that must not be set + in order for this target to execute, + or something evaluating to + false.No
          descriptiona short description of this target's function.No
          extensionOfAdds the current target to the depends list of + the named extension-point. + since Ant 1.8.0.No
          onMissingExtensionPointWhat to do if this target tries to extend a + missing + extension-point. ("fail", + "warn", "ignore"). + since Ant 1.8.2.No. Not allowed unless + extensionOf is present. Defaults to fail. +
          + +

          A target name can be any alphanumeric string valid in the + encoding of the XML file. The empty string "" is in this + set, as is comma "," and space " ". Please + avoid using these, as they will not be supported in future Ant + versions because of all the confusion they cause on command line and IDE. IDE support of + unusual target names, or any target name containing spaces, varies + with the IDE.

          + +

          Targets beginning with a hyphen such + as "-restart" are valid, and can be used to + name targets that should not be called directly from the command + line.
          + For Ants main class every option starting with hyphen is an + option for Ant itself and not a target. For that reason calling these + target from command line is not possible. On the other hand IDEs usually + don't use Ants main class as entry point and calling them from the IDE + is usually possible.

          + +

          Extension-Points

          + +

          since Ant 1.8.0.

          + +

          Extension-Points are similar to targets in that they have a name and + a depends list and can be executed from the command line. Just + like targets they represent a state during the build process.

          + +

          Unlike targets they don't contain any tasks, their main purpose + is to collect targets that contribute to the desired state in + their depends list.

          + +

          Targets can add themselves to an extension-points's depends list via + their extensionOf attribute. The targets that add themselves will be + added after the targets of the explicit depends-attribute of the + extension-point, if multiple targets add themselves, their relative + order is not defined.

          + +

          The main purpose of an extension-point is to act as an extension + point for build files designed to + be imported. In the imported + file an extension-point defines a state that must be reached and + targets from other build files can join the depends list of said + extension-point in order to contribute to that state.

          + +

          For example your imported build file may need to compile code, it + might look like:

          +
          +<target name="create-directory-layout">
+   ...
+</target>
+<extension-point name="ready-to-compile"
+              depends="create-directory-layout"/>
+<target name="compile" depends="ready-to-compile">
+   ...
+</target>
+
          + + 
          Call-Graph:  create-directory-layout --> 'empty slot' --> compile
          + + +

          And you need to generate some source before compilation, then in + your main build file you may use something like

          +
          +<target name="generate-sources"
+        extensionOf="ready-to-compile">
+   ...
+</target>
+
          + + 
          Call-Graph:  create-directory-layout --> generate-sources  --> compile
          + + +

          This will ensure that the generate-sources target is + executed before the compile target.

          + +

          Don't rely on the order of the depends list, + if generate-sources depends + on create-directory-layout then it must explicitly depend + on it via its own depends attribute.

          + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tasklist.html b/tools/apache-ant-1.8.2/docs/manual/tasklist.html new file mode 100644 index 000000000..7d55164da --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tasklist.html @@ -0,0 +1,195 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + + + +

          Tasks

          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tasksoverview.html b/tools/apache-ant-1.8.2/docs/manual/tasksoverview.html new file mode 100644 index 000000000..9dfa02a3d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tasksoverview.html @@ -0,0 +1,1204 @@ + + + + + +Overview of Apache Ant Tasks + + + + + +

          Overview of Apache Ant Tasks

          +

          Given the large number of tasks available with Ant, it may be +difficult to get an overall view of what each task can do. The following +tables provide a short description of each task and a link to the complete +documentation.

          + +Archive Tasks
          +Audit/Coverage Tasks
          +Compile Tasks
          +Deployment Tasks
          +Documentation Tasks
          +EJB Tasks
          +Execution Tasks
          +File Tasks
          +Java2 Extensions Tasks
          +Logging Tasks
          +Mail Tasks
          +Miscellaneous Tasks
          +Pre-process Tasks
          +Property Tasks
          +Remote Tasks
          +SCM Tasks
          +Testing Tasks
          + + +

          + + + + + +
          + +Archive Tasks + +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          BUnzip2

          Expands a file packed using GZip or BZip2.

          BZip2

          Packs a file using the GZip or BZip2 algorithm. This task + does not do any dependency checking; the output file is always + generated

          Cab

          Creates Microsoft CAB archive files. It is invoked + similar to the Jar or + Zip tasks. This task will work on + Windows using the external cabarc tool (provided by Microsoft), + which must be located in your executable path.

          Ear

          An extension of the Jar task with + special treatment for files that should end up in an + Enterprise Application archive.

          GUnzip

          Expands a GZip file.

          GZip

          GZips a set of files.

          Jar

          Jars a set of files.

          Jlink

          Deprecated. Use the zipfileset + and zipgroupfileset attributes of the + Jar or + Zip tasks instead.

          Manifest

          Creates a manifest file.

          Rpm

          Invokes the rpm executable to build a Linux installation + file. This task currently only works on Linux or other Unix platforms + with RPM support.

          SignJar

          Signs a jar or zip file with the javasign + command-line tool.

          Tar

          Creates a tar archive.

          Unjar

          Unzips a jarfile.

          Untar

          Untars a tarfile.

          Unwar

          Unzips a warfile.

          Unzip

          Unzips a zipfile.

          War

          An extension of the Jar task + with special treatment for files that should end up in the + WEB-INF/lib, WEB-INF/classes, or + WEB-INF directories of the Web Application Archive.

          Zip

          Creates a zipfile.

          + +

          + + + + + +
          + +Audit/Coverage Tasks +[Back to top]
          + + + + + + + + + + + +
          Task NameDescription
          JDepend

          Invokes the + JDepend parser. This parser "traverses a set of Java source-file + directories and generates design-quality metrics for each Java + package".

          + +

          + + + + + +
          + +Compile Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Depend

          Determines which classfiles are out-of-date with respect to their + source, removing the classfiles of any other classes that depend on the + out-of-date classes, forcing the re-compile of the removed classfiles. + Typically used in conjunction with the + Javac task.

          Javac

          Compiles the specified source file(s) within the running + (Ant) VM, or in another VM if the fork attribute is + specified.

          Apt

          Runs the annotation processor tool (apt), and then optionally compiles + the original code, and any generated source code.

          JspC

          Runs the JSP compiler. It can be used to precompile JSP pages + for fast initial invocation of JSP pages, deployment on a server without + the full JDK installed, or simply to syntax-check the pages without + deploying them. The Javac task + can be used to compile the generated Java source. + (For Weblogic JSP compiles, + see the Wljspc task.)

          NetRexxC

          Compiles a + NetRexx + source tree within the running (Ant) VM.

          Rmic

          Runs the rmic compiler on the specified file(s).

          Wljspc

          Compiles JSP pages using Weblogic's JSP compiler, + weblogic.jspc. (For non-Weblogic JSP compiles, see the + JspC task.

          + +

          + + + + + +
          + +Deployment Tasks +[Back to top]
          + + + + + + + + + + +
          Task NameDescription
          ServerDeploy

          Task to run a "hot" deployment tool for vendor-specific + J2EE server. +

          + +

          + + + + + +
          + +Documentation Tasks +[Back to top]
          + + + + + + + + + + + +
          Task NameDescription
          Javadoc/Javadoc2

          Generates code documentation using the javadoc tool. + The Javadoc2 task is deprecated; use the Javadoc task instead.

          + +

          + + + + + +
          + +EJB Tasks +[Back to top]
          + + + + + + + + + + +
          Task NameDescription
          EJB Tasks

          (See the documentation describing the EJB tasks.)

          + +

          + + + + + +
          + +Execution Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Ant

          Runs Ant on a supplied buildfile, optionally + passing properties (with possibly new values). + This task can be used to build sub-projects.

          AntCall

          Runs another target within the same buildfile, optionally + passing properties (with possibly new values).

          Apply/ExecOn

          Executes a system command. When the os attribute is + specified, the command is only executed when Ant is run on one + of the specified operating systems.

          Dependset

          This task compares a set of source files with a set of target + files. If any of the source files is newer than any of + the target files, all the target files are removed.

          Exec

          Executes a system command. When the os attribute + is specified, the command is only executed when Ant is run on one of + the specified operating systems.

          Java

          Executes a Java class within the running (Ant) VM, or in + another VM if the fork attribute is specified.

          Parallel

          A container task that can contain other Ant tasks. + Each nested task specified within the <parallel> + tag will be executed in its own thread.

          Sequential

          A container task that can contain other Ant tasks. + The nested tasks are simply executed in sequence. Its primary use is + to support the sequential execution of a subset of tasks within + the <parallel> tag.

          Sleep

          A task for suspending execution for a specified period of time. + Useful when a build or deployment process requires an interval between + tasks.

          Subant

          Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.

          Waitfor

          Blocks execution until a set of specified conditions become true. + This task is intended to be used with the + Parallel task to synchronize + a set of processes.

          + +

          + + + + + +
          + +File Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Attrib

          Changes the permissions and/or attributes of a file or all + files inside the specified directories. Currently, it has effect + only under Windows.

          Checksum

          Generates a checksum for a file or set of files. This task can + also be used to perform checksum verifications.

          Chgrp

          Changes the group ownership of a file or all files inside + the specified directories. Currently, it has effect only under + Unix.

          Chmod

          Changes the permissions of a file or all files inside the + specified directories. Currently, it has effect only under Unix. + The permissions are also UNIX style, like the arguments for the + chmod command.

          Chown

          Changes the owner of a file or all files inside the + specified directories. Currently, it has effect only under + Unix.

          Concat

          Concatenates multiple files into a single one or to Ant's + logging system.

          Copy

          Copies a file or Fileset to a new file or directory.

          Copydir

          Deprecated. Use the + Copy task instead.

          Copyfile

          Deprecated. Use the + Copy task instead.

          Delete

          Deletes either a single file, all files and sub-directories + in a specified directory, or a set of files specified by one or more + FileSets.

          Deltree

          Deprecated. Use the + Delete task instead.

          Filter

          Sets a token filter for this project, or reads multiple token + filters from a specified file and sets these as filters. Token filters + are used by all tasks that perform file-copying operations.

          FixCRLF

          Modifies a file to add or remove tabs, carriage returns, linefeeds, + and EOF characters.

          Get

          Gets a file from a URL.

          Mkdir

          Creates a directory. Non-existent parent directories are created, + when necessary.

          Move

          Moves a file to a new file or directory, or a set(s) of file(s) to + a new directory.

          Patch

          Applies a "diff" file to originals.

          Rename

          Deprecated. Use the Move + task instead.

          + RenameExtensions

          Deprecated. Use the Move + task with a glob mapper + instead.

          Replace

          Replace is a directory-based task for replacing the occurrence + of a given string with another string in selected file.

          + ReplaceRegExp

          Directory-based task for replacing the occurrence of a given + regular expression with a substitution pattern in a file or set of + files.

          Sync

          Synchronize two directory trees.

          Tempfile

          Generates a name for a new temporary file and sets the specified + property to that name.

          Touch

          Changes the modification time of a file and possibly creates it at + the same time.

          + +

          + + + + + +
          + +Java2 Extensions Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          + Jarlib-available

          Check whether an extension is present in a FileSet or an + ExtensionSet. If the extension is present, the specified property is + set.

          +
          + Jarlib-display

          Display the "Optional Package" and + "Package Specification" information contained within the + specified jars.

          +
          + Jarlib-manifest

          Task to generate a manifest that declares all the dependencies + in manifest. The dependencies are determined by looking in the + specified path and searching for Extension/"Optional Package" + specifications in the manifests of the jars.

          +
          + Jarlib-resolve

          Try to locate a jar to satisfy an extension, and place the + location of the jar into the specified property.

          +
          + +

          +

          + + + + + +
          + +Logging Tasks +[Back to top]
          + + + + + + + + + + +
          Task NameDescription
          Record

          Runs a listener that records the logging output of the + build-process events to a file. Several recorders can exist + at the same time. Each recorder is associated with a file.

          + +

          + + + + + +
          + +Mail Tasks +[Back to top]
          + + + + + + + + + + + + + + + + +
          Task NameDescription
          Mail

          A task to send SMTP email.

          MimeMail

          Deprecated. Use the Mail + task instead.

          + +

          + + + + + +
          + +Miscellaneous Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Defaultexcludes

          Modify the list of default exclude patterns from within + your build file.

          Echo

          Echoes text to System.out or to a file.

          Fail

          Exits the current build by throwing a BuildException, + optionally printing additional information.

          GenKey

          Generates a key in keystore.

          HostInfo

          Sets properties related to the provided host, or to + the host the process is run on.

          Input

          Allows user interaction during the build process by displaying a + message and reading a line of input from the console.

          Script

          Executes a script in a + Apache BSF-supported language.

          Sound

          Plays a sound file at the end of the build, according to whether + the build failed or succeeded.

          Splash

          Displays a splash screen.

          Sql

          Executes a series of SQL statements via JDBC to a database. + Statements can either be read in from a text file using the + src attribute, or from between the enclosing SQL + tags.

          Taskdef

          Adds a task definition to the current project, such that this + new task can be used in the current project.

          TStamp

          Sets the DSTAMP, TSTAMP, and + TODAY properties in the current project, based on + the current date and time.

          Typedef

          Adds a data-type definition to the current project, such that this + new type can be used in the current project.

          XmlValidate

          Checks that XML files are valid (or only well-formed). This task + uses the XML parser that is currently used by Ant by default, but any SAX1/2 + parser can be specified, if needed.

          + +

          + + + + + +
          + +Pre-process Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          ANTLR

          Invokes the ANTLR + Translator generator on a grammar file.

          AntStructure

          Generates a DTD for Ant buildfiles that contains information + about all tasks currently known to Ant.

          Import

          Import another build file and potentially override targets + in it with targets of your own.

          Include

          Include another build file.

          JavaCC

          Invokes the + + JavaCC compiler-compiler on a grammar file.

          Javah

          Generates JNI headers from a Java class.

          JJDoc

          Invokes the + JJDoc documentation generator for the JavaCC compiler-compiler. + JJDoc takes a JavaCC parser specification and produces documentation + for the BNF grammar. It can operate in three modes, determined by + command line options. This task only invokes JJDoc if the grammar file + is newer than the generated BNF grammar documentation.

          JJTree

          Invokes the + JJTree preprocessor for the JavaCC compiler-compiler. It inserts + parse-tree building actions at various places in the JavaCC source that + it generates. The output of JJTree is run through JavaCC to create the + parser. This task only invokes JJTree if the grammar file is newer than + the generated JavaCC file.

          Macrodef

          Define a new task as a macro built-up upon other tasks.

          + Native2Ascii

          Converts files from native encodings to ASCII with escaped Unicode. + A common usage is to convert source files maintained in a native + operating system encoding to ASCII, prior to compilation.

          Presetdef

          Define a new task by instrumenting an existing task with + default values for attributes or child elements.

          +
          Translate

          Identifies keys in files, delimited by special tokens, and + translates them with values read from resource bundles.

          XSLT

          Processes a set of documents via XSLT.

          + +

          + + + + + +
          + +Property Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Available

          Sets a property if a specified file, directory, class in the + classpath, or JVM system resource is available at runtime.

          Basename

          Sets a property to the last element of a specified path. +

          BuildNumber

          Task that can be used to track build numbers. +

          Condition

          Sets a property if a certain condition holds true; this is a + generalization of Available and + Uptodate.

          Dirname

          Sets a property to the value of the specified file up to, + but not including, the last path element. +

          + Echoproperties
          + +

          Lists the current properties.

          LoadFile

          Loads a file into a property.

          LoadProperties

          Load a file's contents as Ant properties. This task is + equivalent to using <property file="..."/> + except that it supports nested <filterchain> elements, + and it cannot be specified outside a target.

          MakeURL

          Creates a URL (list) from a file/fileset or path

          PathConvert

          Converts a nested path, path reference, filelist reference, or + fileset reference to the form usable on a specified platform and/or + to a list of items separated by the specified separator and stores + the result in the specified property.

          Property

          Sets a property (by name and value), or set of properties + (from a file or resource) in the project.

          + PropertyFile

          Creates or modifies property files. Useful when wanting to make + unattended modifications to configuration files for application + servers and applications. Typically used for things such as + automatically generating a build number and saving it to a build + properties file, or doing date manipulation.

          Uptodate

          Sets a property if a given target file is newer than a set of + source files.

          Whichresource

          Find a class or resource.

          XmlProperty

          Loads property values from a well-formed XML file.

          + +

          + + + + + +
          + +Remote Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          FTP

          Implements a basic FTP client that can send, receive, + list, and delete files, and create directories.

          Rexec

          Task to automate a remote rexec session.

          Scp

          Copy files to or from a remote server using SSH.

          setproxy

          Sets Java's web proxy properties, so that tasks and code run + in the same JVM can have through-the-firewall access to remote web sites.

          Sshexec

          Execute a command on a remote server using SSH.

          Telnet

          Task to automate a remote telnet session. This task uses + nested <read> and <write> tags + to indicate strings to wait for and specify text to send.

          + +

          + + + + + +
          + +SCM Tasks +[Back to top]
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Task NameDescription
          Cvs

          Handles packages/modules retrieved from a + CVS + repository.

          CvsChangeLog

          Generates an XML report of the changes recorded in a + CVS + repository.

          CVSPass

          Adds entries to a .cvspass file. Adding entries to this file + has the same affect as a cvs login command.

          CvsTagDiff

          Generates an XML-formatted report file of the changes between + two tags or dates recorded in a CVS repository.

          ClearCase

          Tasks to perform the ClearCase cleartool checkin, checkout, + uncheckout, update, lock, unlock, mklbtype, rmtype, mklabel, mkattr, mkdir, mkelem, and mkbl commands.

          Continuus/Synergy

          Tasks to perform the Continuus ccmcheckin, + ccmcheckout, ccmcheckintask, ccmreconfigure, and + ccmcreateTask commands.

          + Microsoft Visual SourceSafe

          Tasks to perform the Visual SourceSafe vssget, + vsslabel, vsshistory, vsscheckin, + vsscheckout, vssadd, vsscp, and vsscreate + commands.

          Perforce

          Tasks to perform the Perforce p4sync, p4change, + p4edit, p4submit, p4have, p4label, + p4counter, p4reopen, p4revert, and p4add + commands.

          Pvcs

          Allows the user extract the latest edition of the source code + from a PVCS repository.

          SourceOffSite

          Tasks to perform the SourceOffSite sosget, soslabel, + soscheckin, and soscheckout commands.

          + +

          + + + + + +
          + +Testing Tasks +[Back to top]
          + + + + + + + + + + + + + + + + +
          Task NameDescription
          Junit

          Runs tests from the Junit + testing framework. This task has been tested with JUnit 3.0 up to + JUnit 3.7; it won't work with versions prior to JUnit 3.0.

          JunitReport

          Merges the individual XML files generated by the + Junit task and applies a + stylesheet on the resulting merged document to provide a browsable + report of the testcases results.

          + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/toc.html b/tools/apache-ant-1.8.2/docs/manual/toc.html new file mode 100644 index 000000000..91d982426 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/toc.html @@ -0,0 +1,51 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorial-HelloWorldWithAnt.html b/tools/apache-ant-1.8.2/docs/manual/tutorial-HelloWorldWithAnt.html new file mode 100644 index 000000000..bcb980afc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tutorial-HelloWorldWithAnt.html @@ -0,0 +1,517 @@ + + + + Tutorial: Hello World with Apache Ant + + + +

          Tutorial: Hello World with Apache Ant

          + +

          This document provides a step by step tutorial for starting java programming with Apache Ant. +It does not contain deeper knowledge about Java or Ant. This tutorial has the goal +to let you see, how to do the easiest steps in Ant.

          + + + +

          Content

          +

          + + + +

          Preparing the project

          +

          We want to separate the source from the generated files, so our java source files will +be in src folder. All generated files should be under build, and there +splitted into several subdirectories for the individual steps: classes for our compiled +files and jar for our own JAR-file.

          +

          We have to create only the src directory. (Because I am working on Windows, here is +the win-syntax - translate to your shell):

          + +
          +md src
+
          + +

          The following simple Java class just prints a fixed message out to STDOUT, +so just write this code into src\oata\HelloWorld.java.

          + +
          +package oata;
+
+public class HelloWorld {
+    public static void main(String[] args) {
+        System.out.println("Hello World");
+    }
+}
+
          + +

          Now just try to compile and run that: +

          +md build\classes
+javac -sourcepath src -d build\classes src\oata\HelloWorld.java
+java -cp build\classes oata.HelloWorld
+
          +which will result in +
          +Hello World
+
          +

          + +

          Creating a jar-file is not very difficult. But creating a startable jar-file needs more steps: create a +manifest-file containing the start class, creating the target directory and archiving the files.

          +
          +echo Main-Class: oata.HelloWorld>myManifest
+md build\jar
+jar cfm build\jar\HelloWorld.jar myManifest -C build\classes .
+java -jar build\jar\HelloWorld.jar
+
          + +

          Note: Do not have blanks around the >-sign in the echo Main-Class instruction because it would +falsify it!

          + + + +

          Four steps to a running application

          +

          After finishing the java-only step we have to think about our build process. We have to compile our code, otherwise we couldn't +start the program. Oh - "start" - yes, we could provide a target for that. We should package our application. +Now it's only one class - but if you want to provide a download, no one would download several hundreds files ... +(think about a complex Swing GUI - so let us create a jar file. A startable jar file would be nice ... And it's a +good practise to have a "clean" target, which deletes all the generated stuff. Many failures could be solved just +by a "clean build".

          + +

          By default Ant uses build.xml as the name for a buildfile, so our .\build.xml would be:

          +
          +<project>
+
+    <target name="clean">
+        <delete dir="build"/>
+    </target>
+
+    <target name="compile">
+        <mkdir dir="build/classes"/>
+        <javac srcdir="src" destdir="build/classes"/>
+    </target>
+
+    <target name="jar">
+        <mkdir dir="build/jar"/>
+        <jar destfile="build/jar/HelloWorld.jar" basedir="build/classes">
+            <manifest>
+                <attribute name="Main-Class" value="oata.HelloWorld"/>
+            </manifest>
+        </jar>
+    </target>
+
+    <target name="run">
+        <java jar="build/jar/HelloWorld.jar" fork="true"/>
+    </target>
+
+</project>
+
          + +

          Now you can compile, package and run the application via

          +
          +ant compile
+ant jar
+ant run
+
          +

          Or shorter with

          +
          +ant compile jar run
+
          + +

          While having a look at the buildfile, we will see some similar steps between Ant and the java-only commands: + + + + + + + + +
          java-onlyAnt
          +md build\classes
+javac
+    -sourcepath src
+    -d build\classes
+    src\oata\HelloWorld.java
+echo Main-Class: oata.HelloWorld>mf
+md build\jar
+jar cfm
+    build\jar\HelloWorld.jar
+    mf
+    -C build\classes
+    .
+
+
+
+java -jar build\jar\HelloWorld.jar
+  
          +<mkdir dir="build/classes"/>
+<javac
+    srcdir="src"
+    destdir="build/classes"/>
+<!-- automatically detected -->
+<!-- obsolete; done via manifest tag -->
+<mkdir dir="build/jar"/>
+<jar
+    destfile="build/jar/HelloWorld.jar"
+
+    basedir="build/classes">
+    <manifest>
+        <attribute name="Main-Class" value="oata.HelloWorld"/>
+    </manifest>
+</jar>
+<java jar="build/jar/HelloWorld.jar" fork="true"/>
+
          +

          + + + + +

          Enhance the build file

          +

          Now we have a working buildfile we could do some enhancements: many time you are referencing the +same directories, main-class and jar-name are hard coded, and while invocation you have to remember +the right order of build steps.

          +

          The first and second point would be addressed with properties, the third with a special property - an attribute +of the <project>-tag and the fourth problem can be solved using dependencies.

          + + +
          +<project name="HelloWorld" basedir="." default="main">
+
+    <property name="src.dir"     value="src"/>
+
+    <property name="build.dir"   value="build"/>
+    <property name="classes.dir" value="${build.dir}/classes"/>
+    <property name="jar.dir"     value="${build.dir}/jar"/>
+
+    <property name="main-class"  value="oata.HelloWorld"/>
+
+
+
+    <target name="clean">
+        <delete dir="${build.dir}"/>
+    </target>
+
+    <target name="compile">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
+    </target>
+
+    <target name="jar" depends="compile">
+        <mkdir dir="${jar.dir}"/>
+        <jar destfile="${jar.dir}/${ant.project.name}.jar" basedir="${classes.dir}">
+            <manifest>
+                <attribute name="Main-Class" value="${main-class}"/>
+            </manifest>
+        </jar>
+    </target>
+
+    <target name="run" depends="jar">
+        <java jar="${jar.dir}/${ant.project.name}.jar" fork="true"/>
+    </target>
+
+    <target name="clean-build" depends="clean,jar"/>
+
+    <target name="main" depends="clean,run"/>
+
+</project>
+
          + + +

          Now it's easier, just do a ant and you will get

          +
          +Buildfile: build.xml
+
+clean:
+
+compile:
+    [mkdir] Created dir: C:\...\build\classes
+    [javac] Compiling 1 source file to C:\...\build\classes
+
+jar:
+    [mkdir] Created dir: C:\...\build\jar
+      [jar] Building jar: C:\...\build\jar\HelloWorld.jar
+
+run:
+     [java] Hello World
+
+main:
+
+BUILD SUCCESSFUL
+
          + + + +

          Using external libraries

          +

          Somehow told us not to use syso-statements. For log-Statements we should use a Logging-API - customizable on a high +degree (including switching off during usual life (= not development) execution). We use Log4J for that, because

            +
          • it is not part of the JDK (1.4+) and we want to show how to use external libs
            • +
          • it can run under JDK 1.2 (as Ant)
            • +
          • it's highly configurable
            • +
          • it's from Apache ;-)
            • +

          +

          We store our external libraries in a new directory lib. Log4J can be +downloaded [1] from Logging's Homepage. +Create the lib directory and extract the log4j-1.2.9.jar into that lib-directory. After that we have to modify +our java source to use that library and our buildfile so that this library could be accessed during compilation and run. +

          +

          Working with Log4J is documented inside its manual. Here we use the MyApp-example from the +Short Manual [2]. First we have to modify the java source to +use the logging framework:

          + +
          +package oata;
+
+import org.apache.log4j.Logger;
+import org.apache.log4j.BasicConfigurator;
+
+public class HelloWorld {
+    static Logger logger = Logger.getLogger(HelloWorld.class);
+
+    public static void main(String[] args) {
+        BasicConfigurator.configure();
+        logger.info("Hello World");          // the old SysO-statement
+    }
+}
+
          + +

          Most of the modifications are "framework overhead" which has to be done once. The blue line is our "old System-out" +statement.

          +

          Don't try to run ant - you will only get lot of compiler errors. Log4J is not inside the classpath so we have +to do a little work here. But do not change the CLASSPATH environment variable! This is only for this project and maybe +you would break other environments (this is one of the most famous mistakes when working with Ant). We introduce Log4J +(or to be more precise: all libraries (jar-files) which are somewhere under .\lib) into our buildfile:

          + +
          +<project name="HelloWorld" basedir="." default="main">
+    ...
+    <property name="lib.dir"     value="lib"/>
+
+    <path id="classpath">
+        <fileset dir="${lib.dir}" includes="**/*.jar"/>
+    </path>
+
+    ...
+
+    <target name="compile">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}" classpathref="classpath"/>
+    </target>
+
+    <target name="run" depends="jar">
+        <java fork="true" classname="${main-class}">
+            <classpath>
+                <path refid="classpath"/>
+                <path location="${jar.dir}/${ant.project.name}.jar"/>
+            </classpath>
+        </java>
+    </target>
+
+    ...
+
+</project>
+
          + +

          In this example we start our application not via its Main-Class manifest-attribute, because we could not provide +a jarname and a classpath. So add our class in the red line to the already defined path and start as usual. Running +ant would give (after the usual compile stuff):

          + +
          +[java] 0 [main] INFO oata.HelloWorld  - Hello World
+
          + +

          What's that?

            +
          • [java] Ant task running at the moment
            • +
          • 0 sorry don't know - some Log4J stuff
            • +
          • [main] the running thread from our application
            • +
          • INFO log level of that statement +
          • oata.HelloWorld source of that statement +
          • - separator
            • +
          • Hello World the message
            • +
          +For another layout ... have a look inside Log4J's documentation about using other PatternLayout's.

          + + + +

          Configuration files

          +

          Why we have used Log4J? "It's highly configurable"? No - all is hard coded! But that is not the debt of Log4J - it's +ours. We had coded BasicConfigurator.configure(); which implies a simple, but hard coded configuration. More +confortable would be using a property file. In the java source delete the BasicConfiguration-line from the main() method +(and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create +a new file src/log4j.properties. That's the default name for Log4J's configuration and using that name would make +life easier - not only the framework knows what is inside, you too!

          + +
          +log4j.rootLogger=DEBUG, stdout
+
+log4j.appender.stdout=org.apache.log4j.ConsoleAppender
+
+log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
+log4j.appender.stdout.layout.ConversionPattern=%m%n
+
          + +

          This configuration creates an output channel ("Appender") to console named as stdout which prints the +message (%m) followed by a line feed (%n) - same as the earlier System.out.println() :-) Oooh kay - but we haven't +finished yet. We should deliver the configuration file, too. So we change the buildfile:

          + +
          +    ...
+    <target name="compile">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}" classpathref="classpath"/>
+        <copy todir="${classes.dir}">
+            <fileset dir="${src.dir}" excludes="**/*.java"/>
+        </copy>
+    </target>
+    ...
+
          + +

          This copies all resources (as long as they haven't the suffix ".java") to the build directory, so we could +start the application from that directory and these files will included into the jar.

          + + +           +

          Testing the class

          +

          In this step we will introduce the usage of the JUnit [3] testframework in combination with Ant. Because Ant +has a built-in JUnit 3.8.2 you could start directly using it. Write a test class in src\HelloWorldTest.java:

          + +
          +public class HelloWorldTest extends junit.framework.TestCase {
+
+    public void testNothing() {
+    }
+    
+    public void testWillAlwaysFail() {
+        fail("An error message");
+    }
+    
+}
          + +

          Because we dont have real business logic to test, this test class is very small: just show how to start. For +further information see the JUnit documentation [3] and the manual of junit task. +Now we add a junit instruction to our buildfile:

          + +
          +    ...
+
+    <target name="run" depends="jar">
+        <java fork="true" classname="${main-class}">
+            <classpath>
+                <path refid="classpath"/>
+                <path id="application" location="${jar.dir}/${ant.project.name}.jar"/>
+            </classpath>
+        </java>
+    </target>
+    
+    <target name="junit" depends="jar">
+        <junit printsummary="yes">
+            <classpath>
+                <path refid="classpath"/>
+                <path refid="application"/>
+            </classpath>
+            
+            <batchtest fork="yes">
+                <fileset dir="${src.dir}" includes="*Test.java"/>
+            </batchtest>
+        </junit>
+    </target>
+
+    ...
+
+
          + +

          We reuse the path to our own jar file as defined in run-target by giving it an ID. +The printsummary=yes lets us see more detailed information than just a "FAILED" or "PASSED" message. +How much tests failed? Some errors? Printsummary lets us know. The classpath is set up to find our classes. +To run tests the batchtest here is used, so you could easily add more test classes in the future just +by naming them *Test.java. This is a common naming scheme.

          + +

          After a ant junit you'll get:

          + +
          +...
+junit:
+    [junit] Running HelloWorldTest
+    [junit] Tests run: 2, Failures: 1, Errors: 0, Time elapsed: 0,01 sec
+    [junit] Test HelloWorldTest FAILED
+
+BUILD SUCCESSFUL
+...
+
          + +

          We can also produce a report. Something that you (and other) could read after closing the shell .... +There are two steps: 1. let <junit> log the information and 2. convert these to something readable (browsable).

          + +

          +    ...
+    <property name="report.dir"  value="${build.dir}/junitreport"/>
+    ...
+    <target name="junit" depends="jar">
+        <mkdir dir="${report.dir}"/>
+        <junit printsummary="yes">
+            <classpath>
+                <path refid="classpath"/>
+                <path refid="application"/>
+            </classpath>
+            
+            <formatter type="xml"/>
+            
+            <batchtest fork="yes" todir="${report.dir}">
+                <fileset dir="${src.dir}" includes="*Test.java"/>
+            </batchtest>
+        </junit>
+    </target>
+    
+    <target name="junitreport">
+        <junitreport todir="${report.dir}">
+            <fileset dir="${report.dir}" includes="TEST-*.xml"/>
+            <report todir="${report.dir}"/>
+        </junitreport>
+    </target>
+
          + +

          Because we would produce a lot of files and these files would be written to the current directory by default, +we define a report directory, create it before running the junit and redirect the logging to it. The log format +is XML so junitreport could parse it. In a second target junitreport should create a browsable +HTML-report for all generated xml-log files in the report directory. Now you can open the ${report.dir}\index.html and +see the result (looks something like JavaDoc).
          +Personally I use two different targets for junit and junitreport. Generating the HTML report needs some time and you dont +need the HTML report just for testing, e.g. if you are fixing an error or a integration server is doing a job. +

          + + + + + +

          Resources

          +
          +    [1] http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip
+    [2] http://logging.apache.org/log4j/docs/manual.html
+    [3] http://www.junit.org/index.htm
+
          + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.html b/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.html new file mode 100644 index 000000000..526408bdb --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.html @@ -0,0 +1,977 @@ + + + + + Tutorial: Tasks using Properties, Filesets & Paths + + +

          Tutorial: Tasks using Properties, Filesets & Paths

          + +

          After reading the tutorial about writing +tasks [1] this tutorial explains how to get and set properties and how to use +nested filesets and paths. Finally it explains how to contribute tasks to Apache Ant.

          + +

          Content

          +

          + + +

          The goal

          +

          The goal is to write a task, which searchs in a path for a file and saves the +location of that file in a property.

          + + +

          Build environment

          +

          We can use the buildfile from the other tutorial and modify it a little bit. +That's the advantage of using properties - we can reuse nearly the whole script. :-)

          +
          +<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="FindTask" basedir="." default="test">
+    ...
+    <target name="use.init" description="Taskdef's the Find-Task" depends="jar">
+        <taskdef name="find" classname="Find" classpath="${ant.project.name}.jar"/>
+    </target>
+
+    <!-- the other use.* targets are deleted -->
+    ...
+</project>
+
          + +

          The buildfile is in the archive +tutorial-tasks-filesets-properties.zip [2] in /build.xml.01-propertyaccess +(future version saved as *.02..., final version as build.xml; same for sources).

          + + +

          Property access

          +

          Our first step is to set a property to a value and print the value of that property. +So our scenario would be +

          +    <find property="test" value="test-value"/>
+    <find print="test"/>
+
          +ok, can be rewritten with the core tasks +
          +    <property name="test" value="test-value"/>
+    <echo message="${test}"/>
+
          +but I have to start on known ground :-)

          +

          So what to do? Handling three attributes (property, value, print) and an execute method. +Because this is only an introduction example I don't do much checking: + +

          +import org.apache.tools.ant.BuildException;
+
+public class Find extends Task {
+
+    private String property;
+    private String value;
+    private String print;
+
+    public void setProperty(String property) {
+        this.property = property;
+    }
+
+    // setter for value and print
+
+    public void execute() {
+        if (print != null) {
+            String propValue = getProject().getProperty(print);
+            log(propValue);
+        } else {
+            if (property == null) throw new BuildException("property not set");
+            if (value    == null) throw new BuildException("value not set");
+            getProject().setNewProperty(property, value);
+        }
+    }
+}
+
          + +As said in the other tutorial, the property access is done via Project instance. +We get this instance via the public getProject() method which we inherit from +Task (more precise from ProjectComponent). Reading a property is done via +getProperty(propertyname) (very simple, isn't it?). This property returns +the value as String or null if not set.
          +Setting a property is ... not really difficult, but there is more than one setter. You can +use the setProperty() method which will do the job like expected. But there is +a golden rule in Ant: properties are immutable. And this method sets the property +to the specified value - whether it has a value before that or not. So we use another +way. setNewProperty() sets the property only if there is no property with that +name. Otherwise a message is logged.

          + +

          (by the way: a short word to ants "namespaces" (don't +be confused with xml namespaces: +an <antcall> creates a new space for property names. All properties from the caller +are passed to the callee, but the callee can set its own properties without notice by the +caller.)

          + +

          There are some other setter, too (but I haven't used them, so I can't say something +to them, sorry :-)

          + +

          After putting our two line example from above into a target names use.simple +we can call that from our testcase: + +

          +import org.apache.tools.ant.BuildFileTest;
+
+public class FindTest extends BuildFileTest {
+
+    public FindTest(String name) {
+        super(name);
+    }
+
+    public void setUp() {
+        configureProject("build.xml");
+    }
+
+    public void testSimple() {
+        expectLog("use.simple", "test-value");
+    }
+}
+
          + +and all works fine.

          + + + +

          Using filesets

          +

          Ant provides a common way of bundling files: the fileset. Because you are reading +this tutorial I think you know them and I don't have to spend more explanations about +their usage in buildfiles. Our goal is to search a file in path. And on this step the +path is simply a fileset (or more precise: a collection of filesets). So our usage +would be +

          +    <find file="ant.jar" location="location.ant-jar">
+        <fileset dir="${ant.home}" includes="**/*.jar"/>
+    </find>
+
          +

          + +

          What do we need? A task with two attributes (file, location) and nested +filesets. Because we had attribute handling already explained in the example above and the +handling of nested elements is described in the other tutorial the code should be very easy: +

          +public class Find extends Task {
+
+    private String file;
+    private String location;
+    private Vector filesets = new Vector();
+
+    public void setFile(String file) {
+        this.file = file;
+    }
+
+    public void setLocation(String location) {
+        this.location = location;
+    }
+
+    public void addFileset(FileSet fileset) {
+        filesets.add(fileset);
+    }
+
+    public void execute() {
+    }
+}
+
          +Ok - that task wouldn't do very much, but we can use it in the described manner without +failure. On next step we have to implement the execute method. And before that we will +implement the appropriate testcases (TDD - test driven development).

          + +

          In the other tutorial we have reused the already written targets of our buildfile. +Now we will configure most of the testcases via java code (sometimes it's much easier +to write a target than doing it via java coding). What can be tested?

            +
          • not valid configured task (missing file, missing location, missing fileset)
            • +
          • don't find a present file
            • +
          • behaviour if file can't be found
            • +
          +Maybe you find some more testcases. But this is enough for now.
          +For each of these points we create a testXX method.

          + +
          +public class FindTest extends BuildFileTest {
+
+    ... // constructor, setUp as above
+
+    public void testMissingFile() {
+        Find find = new Find();
+        try {
+            find.execute();
+            fail("No 'no-file'-exception thrown.");
+        } catch (Exception e) {
+            // exception expected
+            String expected = "file not set";
+            assertEquals("Wrong exception message.", expected, e.getMessage());
+        }
+    }
+
+    public void testMissingLocation() {
+        Find find = new Find();
+        find.setFile("ant.jar");
+        try {
+            find.execute();
+            fail("No 'no-location'-exception thrown.");
+        } catch (Exception e) {
+            ... // similar to testMissingFile()
+        }
+    }
+
+    public void testMissingFileset() {
+        Find find = new Find();
+        find.setFile("ant.jar");
+        find.setLocation("location.ant-jar");
+        try {
+            find.execute();
+            fail("No 'no-fileset'-exception thrown.");
+        } catch (Exception e) {
+            ... // similar to testMissingFile()
+        }
+    }
+
+    public void testFileNotPresent() {
+        executeTarget("testFileNotPresent");
+        String result = getProject().getProperty("location.ant-jar");
+        assertNull("Property set to wrong value.", result);
+    }
+
+    public void testFilePresent() {
+        executeTarget("testFilePresent");
+        String result = getProject().getProperty("location.ant-jar");
+        assertNotNull("Property not set.", result);
+        assertTrue("Wrong file found.", result.endsWith("ant.jar"));
+    }
+}
+
          + +

          If we run this test class all test cases (except testFileNotPresent) fail. Now we +can implement our task, so that these test cases will pass.

          + +
          +    protected void validate() {
+        if (file==null) throw new BuildException("file not set");
+        if (location==null) throw new BuildException("location not set");
+        if (filesets.size()<1) throw new BuildException("fileset not set");
+    }
+
+    public void execute() {
+        validate();                                                             // 1
+        String foundLocation = null;
+        for(Iterator itFSets = filesets.iterator(); itFSets.hasNext(); ) {      // 2
+            FileSet fs = (FileSet)itFSets.next();
+            DirectoryScanner ds = fs.getDirectoryScanner(getProject());         // 3
+            String[] includedFiles = ds.getIncludedFiles();
+            for(int i=0; i<includedFiles.length; i++) {
+                String filename = includedFiles[i].replace('\\','/');           // 4
+                filename = filename.substring(filename.lastIndexOf("/")+1);
+                if (foundLocation==null && file.equals(filename)) {
+                    File base  = ds.getBasedir();                               // 5
+                    File found = new File(base, includedFiles[i]);
+                    foundLocation = found.getAbsolutePath();
+                }
+            }
+        }
+        if (foundLocation!=null)                                                // 6
+            getProject().setNewProperty(location, foundLocation);
+    }
+
          + +

          On //1 we check the prerequisites for our task. Doing that in a validate-method +is a common way, because we separate the prerequisites from the real work. On //2 we iterate +over all nested filesets. If we don't want to handle multiple filesets, the addFileset() +method has to reject the further calls. We can get the result of a fileset via its DirectoryScanner +like done in //3. After that we create a plattform independend String representation of +the file path (//4, can be done in other ways of course). We have to do the replace(), +because we work with a simple string comparison. Ant itself is platform independant and can +therefore run on filesystems with slash (/, e.g. Linux) or backslash (\, e.g. Windows) as +path separator. Therefore we have to unify that. If we found our file we create an absolute +path representation on //5, so that we can use that information without knowing the basedir. +(This is very important on use with multiple filesets, because they can have different basedirs +and the return value of the directory scanner is relative to its basedir.) Finally we store the +location of the file as property, if we had found one (//6).

          + +

          Ok, much more easier in this simple case would be to add the file as additional +include element to all filesets. But I wanted to show how to handle complex situations +whithout being complex :-)

          + +

          The test case uses the ant property ant.home as reference. This property is set by the +Launcher class which starts ant. We can use that property in our buildfiles as a +build-in property [3]. But if we create a new ant +environment we have to set that value for our own. And we use the <junit> task in fork-mode. +Therefore we have do modify our buildfile: +

          +    <target name="junit" description="Runs the unit tests" depends="jar">
+        <delete dir="${junit.out.dir.xml}"/>
+        <mkdir  dir="${junit.out.dir.xml}"/>
+        <junit printsummary="yes" haltonfailure="no">
+            <classpath refid="classpath.test"/>
+            <sysproperty key="ant.home" value="${ant.home}"/>
+            <formatter type="xml"/>
+            <batchtest fork="yes" todir="${junit.out.dir.xml}">
+                <fileset dir="${src.dir}" includes="**/*Test.java"/>
+            </batchtest>
+        </junit>
+    </target>
+
          + + +

          Using nested paths

          +

          A task providing support for filesets is a very comfortable one. But there is another +possibility of bundling files: the <path>. Fileset are easy if the files are all under +a common base directory. But if this is not the case you have a problem. Another disadvantage +is its speed: if you have only a few files in a huge directory structure, why not use a +<filelist> instead? <path>s combines these datatypes in that way that a path contains +other paths, filesets, dirsets and filelists. This is why +Ant-Contribs [4] <foreach> task is modified to support paths instead of filesets. So we want that, +too.

          + +

          Changing from fileset to path support is very easy:

          +
          +Change java code from:
+    private Vector filesets = new Vector();
+    public void addFileset(FileSet fileset) {
+        filesets.add(fileset);
+    }
+to:
+    private Vector paths = new Vector();                      *1
+    public void addPath(Path path) {                          *2
+        paths.add(path);
+    }
+and build file from:
+    <find file="ant.jar" location="location.ant-jar">
+        <fileset dir="${ant.home}" includes="**/*.jar"/>
+    </find>
+to:
+    <find file="ant.jar" location="location.ant-jar">
+        <path>                                                *3
+            <fileset dir="${ant.home}" includes="**/*.jar"/>
+        </path>
+    </find>
+
          +

          On *1 we rename only the vector. It�s just for better reading the source. On *2 +we have to provide the right method: an addName(Type t). Therefore replace the +fileset with path here. Finally we have to modify our buildfile on *3 because our task +doesn�t support nested filesets any longer. So we wrap the fileset inside a path.

          + +

          And now we modify the testcase. Oh, not very much to do :-) Renaming the testMissingFileset() +(not really a must-be but better it�s named like the think it does) and update the +expected-String in that method (now a path not set message is expected). The more complex +test cases base on the buildscript. So the targets testFileNotPresent and testFilePresent have to be +modified in the manner described above.

          + +

          The test are finished. Now we have to adapt the task implementation. The easiest modification is +in the validate() method where we change le last line to if (paths.size()<1) throw new +BuildException("path not set");. In the execute() method we have a little more work. +... mmmh ... in reality it's lesser work, because the Path class does the whole DirectoryScanner-handling +and creating-absolute-paths stuff for us. So the execute method is just:

          + +
          +    public void execute() {
+        validate();
+        String foundLocation = null;
+        for(Iterator itPaths = paths.iterator(); itPaths.hasNext(); ) {
+            Path path = (Path)itPaths.next();                                // 1
+            String[] includedFiles = path.list();                            // 2
+            for(int i=0; i<includedFiles.length; i++) {
+                String filename = includedFiles[i].replace('\\','/');
+                filename = filename.substring(filename.lastIndexOf("/")+1);
+                if (foundLocation==null && file.equals(filename)) {
+                    foundLocation = includedFiles[i];                        // 3
+                }
+            }
+        }
+        if (foundLocation!=null)
+            getProject().setNewProperty(location, foundLocation);
+    }
+
          + +

          Of course we have to do the typecase to Path on //1. On //2 and //3 +we see that the Path class does the work for us: no DirectoryScanner (was at 2) and no +creating of the absolute path (was at 3).

          + + + +

          Returning a list

          +

          So far so good. But could a file be on more than one place in the path? - Of course.
          +And would it be good to get all of them? - It depends on ...

          + +

          In this section we will extend that task to support returning a list of all files. +Lists as property values are not supported by Ant natively. So we have to see how other +tasks use lists. The most famous task using lists is Ant-Contribs <foreach>. All list +elements are concatenated and separated with a customizable separator (default ',').

          + +

          So we do the following:

          + +
          +    <find ... delimiter=""/> ... </find>
+
          + +

          If the delimiter is set we will return all found files as list with that delimiter.

          + +

          Therefore we have to

            +
          • provide a new attribute
            • +
          • collect more than the first file
            • +
          • delete duplicates
            • +
          • create the list if necessary
            • +
          • return that list
            • +

          + +

          So we add as testcase:

          +
          +in the buildfile:
+    <target name="test.init">
+        <mkdir dir="test1/dir11/dir111"/>                             *1
+        <mkdir dir="test1/dir11/dir112"/>
+        ...
+        <touch file="test1/dir11/dir111/test"/>
+        <touch file="test1/dir11/dir111/not"/>
+        ...
+        <touch file="test1/dir13/dir131/not2"/>
+        <touch file="test1/dir13/dir132/test"/>
+        <touch file="test1/dir13/dir132/not"/>
+        <touch file="test1/dir13/dir132/not2"/>
+        <mkdir dir="test2"/>
+        <copy todir="test2">                                          *2
+            <fileset dir="test1"/>
+        </copy>
+    </target>
+
+    <target name="testMultipleFiles" depends="use.init,test.init">    *3
+        <find file="test" location="location.test" delimiter=";">
+            <path>
+                <fileset dir="test1"/>
+                <fileset dir="test2"/>
+            </path>
+        </find>
+        <delete>                                                      *4
+            <fileset dir="test1"/>
+            <fileset dir="test2"/>
+        </delete>
+    </target>
+
+in the test class:
+    public void testMultipleFiles() {
+        executeTarget("testMultipleFiles");
+        String result = getProject().getProperty("location.test");
+        assertNotNull("Property not set.", result);
+        assertTrue("Only one file found.", result.indexOf(";") > -1);
+    }
+
          + +

          Now we need a directory structure where we CAN find files with the same +name in different directories. Because we can't sure to have one we create +one on *1 and *2. And of course we clean up that on *4. The creation +can be done inside our test target or in a separate one, which will be better +for reuse later (*3). + +

          The task implementation is modified as followed:

          + +
          +    private Vector foundFiles = new Vector();
+    ...
+    private String delimiter = null;
+    ...
+    public void setDelimiter(String delim) {
+        delimiter = delim;
+    }
+    ...
+    public void execute() {
+        validate();
+        // find all files
+        for(Iterator itPaths = paths.iterator(); itPaths.hasNext(); ) {
+            Path path = (Path)itPaths.next();
+            String[] includedFiles = path.list();
+            for(int i=0; i<includedFiles.length; i++) {
+                String filename = includedFiles[i].replace('\\','/');
+                filename = filename.substring(filename.lastIndexOf("/")+1);
+                if (file.equals(filename) && !foundFiles.contains(includedFiles[i])) {   // 1
+                    foundFiles.add(includedFiles[i]);
+                }
+            }
+        }
+
+        // create the return value (list/single)
+        String rv = null;
+        if (foundFiles.size() > 0) {                                        // 2
+            if (delimiter==null) {
+                // only the first
+                rv = (String)foundFiles.elementAt(0);
+            } else {
+                // create list
+                StringBuffer list = new StringBuffer();
+                for(Iterator it=foundFiles.iterator(); it.hasNext(); ) {    // 3
+                    list.append(it.next());
+                    if (it.hasNext()) list.append(delimiter);               // 4
+                }
+                rv = list.toString();
+            }
+        }
+
+        // create the property
+        if (rv!=null)
+            getProject().setNewProperty(location, rv);
+    }
+
          + +

          The algorithm does: finding all files, creating the return value depending on the users +wish, returning the value as property. On //1 we eliminates the duplicates. //2 +ensures that we create the return value only if we have found one file. On //3 we +iterate over all found files and //4 ensures that the last entry has no trailing +delimiter.

          + +

          Ok, first searching for all files and then returning only the first one ... You can +tune the performance of your own :-)

          + + +

          Documentation

          +

          A task is useless if the only who is able to code the buildfile is the task developer +(and he only the next few weeks :-). So documentation is also very important. In which +form you do that depends on your favourite. But inside Ant there is a common format and +it has advantages if you use that: all task users know that form, this form is requested if +you decide to contribute your task. So we will doc our task in that form.

          + +

          If you have a look at the manual page of the Java task [5] + you will see that it:

            +
          • is plain html
            • +
          • starts with the name
            • +
          • has sections: description, parameters, nested elements, (maybe return codes) and (most +important :-) examples
            • +
          • parameters are listed in a table with columns for attribute name, its description and whether + it's required (if you add a feature after an Ant release, provide a since Ant xx + statement when it's introduced)
            • +
          • describe the nested elements (since-statement if necessary)
            • +
          • provide one or more useful examples; first code, then description.
            • +
          +As a template we have: + +
          +<html>
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<title>Taskname Task</title>
+</head>
+
+<body>
+
+<h2><a name="taskname">Taskname</a></h2>
+<h3>Description</h3>
+<p> Describe the task.</p>
+
+<h3>Parameters</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+  <tr>
+    <td valign="top"><b>Attribute</b></td>
+    <td valign="top"><b>Description</b></td>
+    <td align="center" valign="top"><b>Required</b></td>
+  </tr>
+
+  do this html row for each attribute (including inherited attributes)
+  <tr>
+    <td valign="top">classname</td>
+    <td valign="top">the Java class to execute.</td>
+    <td align="center" valign="top">Either jar or classname</td>
+  </tr>
+
+</table>
+
+<h3>Parameters specified as nested elements</h3>
+
+Describe each nested element (including inherited)
+<h4>your nested element</h4>
+<p>description</p>
+<p><em>since Ant 1.6</em>.</p>
+
+<h3>Examples</h3>
+<pre>
+    A code sample; don't forget to escape the < of the tags with &lt;
+</pre>
+What should that example do?
+
+</body>
+</html>
+
          + +

          Here is an example documentation page for our task:

          +
          +<html>
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<title>Find Task</title>
+</head>
+
+<body>
+
+<h2><a name="find">Find</a></h2>
+<h3>Description</h3>
+<p>Searchs in a given path for a file and returns the absolute to it as property.
+If delimiter is set this task returns all found locations.</p>
+
+<h3>Parameters</h3>
+<table border="1" cellpadding="2" cellspacing="0">
+  <tr>
+    <td valign="top"><b>Attribute</b></td>
+    <td valign="top"><b>Description</b></td>
+    <td align="center" valign="top"><b>Required</b></td>
+  </tr>
+  <tr>
+    <td valign="top">file</td>
+    <td valign="top">The name of the file to search.</td>
+    <td align="center" valign="top">yes</td>
+  </tr>
+  <tr>
+    <td valign="top">location</td>
+    <td valign="top">The name of the property where to store the location</td>
+    <td align="center" valign="top">yes</td>
+  </tr>
+  <tr>
+    <td valign="top">delimiter</td>
+    <td valign="top">A delimiter to use when returning the list</td>
+    <td align="center" valign="top">only if the list is required</td>
+  </tr>
+</table>
+
+<h3>Parameters specified as nested elements</h3>
+
+<h4>path</h4>
+<p>The path where to search the file.</p>
+
+<h3>Examples</h3>
+<pre>
+    <find file="ant.jar" location="loc">
+        <path>
+            <fileset dir="${ant.home}"/>
+        <path>
+    </find>
+</pre>
+Searches in Ants home directory for a file <i>ant.jar</i> and stores its location in
+property <i>loc</i> (should be ANT_HOME/bin/ant.jar).
+
+<pre>
+    <find file="ant.jar" location="loc" delimiter=";">
+        <path>
+            <fileset dir="C:/"/>
+        <path>
+    </find>
+    <echo>ant.jar found in: ${loc}</echo>
+</pre>
+Searches in Windows C: drive for all <i>ant.jar</i> and stores their locations in
+property <i>loc</i> delimited with <i>';'</i>. (should need a long time :-)
+After that it prints out the result (e.g. C:/ant-1.5.4/bin/ant.jar;C:/ant-1.6/bin/ant.jar).
+
+</body>
+</html>
+
          + + +

          Contribute the new task

          +If we decide to contribute our task, we should do some things:
            +
          • is our task welcome? :-) Simply ask on the user list
            • +
          • is the right package used?
            • +
          • does the code conform to the styleguide?
            • +
          • do all tests pass?
            • +
          • does the code compile on JDK 1.2 (and passes all tests there)?
            • +
          • code under Apache license
            • +
          • create a patch file
            • +
          • publishing that patch file
            • +
          +The Ant Task Guidelines [6] support additional +information on that.

          + +

          Now we will check the "Checklist before submitting a new task" described in that guideline. +

            +
          • Java file begins with Apache license statement. must do that
            • +
          • Task does not depend on GPL or LGPL code. ok
            • +
          • Source code complies with style guidelines have to check (checkstyle)
            • +
          • Code compiles and runs on Java1.2 have to try
            • +
          • Member variables are private, and provide public accessor methods + if access is actually needed. have to check (checkstyle)
            • +
          • Maybe Task has failonerror attribute to control failure behaviour hasn't
            • +
          • New test cases written and succeed passed on JDK 1.4, have to try on JDK 1.2
            • +
          • Documentation page written ok
            • +
          • Example task declarations in the documentation tested. ok (used in tests)
            • +
          • Patch files generated using cvs diff -u to do
            • +
          • patch files include a patch to defaults.properties to register the +tasks to do
            • +
          • patch files include a patch to tasklist.html to link to the new task page to do
            • +
          • Message to dev contains [SUBMIT] and task name in subject to do
            • +
          • Message body contains a rationale for the task to do
            • +
          • Message attachments contain the required files -source, documentation, +test and patches zipped up to escape the HTML filter. to do
            • +
          + + +

          Package / Directories

          +

          This task does not depend on any external library. Therefore we can use this as +a core task. This task contains only one class. So we can use the standard package +for core tasks: org.apache.tools.ant.taskdefs. Implementations are in the +directory src/main, tests in src/testcases and buildfiles for +tests in src/etc/testcases.

          + +

          Now we integrate our work into Ants distribution. So first we do an update of our +cvs tree. If not done yet, you have to checkout the ant module from Apaches cvs server +as described in Access the Source Tree (AnonCVS) +[7] (password is anoncvs):

          +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login                 //1
+cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout ant          //2
+
          +If you have a local copy of Ants sources just do an update +
          +cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
+cd ant                                                                       //3
+cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic update                //4
+

          + +

          We use the -d flag on //1 to specifiy the cvs directory. You can +specify the environment variable CVSROOT with that value and after that you haven�t +to use that flag any more. On //2 we get the whole cvs tree of ant. (Sorry, +but that uses a lot of time ... 10 up to 30 minutes are not unusual ... but this has +to be done only once :-). A cvs update doesn't use a modulename but you have to be +inside the directory. Therefore we go into that on //3 and do the update +on //4.

          + +

          Now we will build our Ant distribution and do a test. So we can see if there +are any tests failing on our machine. (We can ignore these failing tests on later +steps; windows syntax used here- translate to xNIX if needed): +

          +ANTHOME> build                                                    // 1
+ANTHOME> set ANT_HOME=%CD%\dist                                   // 2
+ANTHOME> ant test -Dtest.haltonfailure=false                      // 3
+
          + +First we have to build our Ant distribution (//1). On //2 we set the ANT_HOME +environment variable to the directory where the new created distribution is stored +(%CD% is expanded to the current directory on Windows 2000 and XP, on 9x and NT +write it out). On //3 we let Ant do all the tests (which enforced a compile +of all tests) without stopping on first failure.

          + +

          Next we apply our work onto Ants sources. Because we haven't modified any, this is +a relative simple step. (Because I have a local copy of Ant and usually contribute my +work, I work on the local copy just from the beginning. The advantage: this step isn't +necessary and saves a lot of work if you modify existing source :-). + +

            +
          • move the Find.java to ANTHOME/src/main/org/apache/tools/ant/taskdefs/Find.java
            • +
          • move the FindTest.java to ANTHOME/src/testcases/org/apache/tools/ant/taskdefs/FindTest.java
            • +
          • move the build.xml to ANTHOME/src/etc/testcases/taskdefs/find.xml (!!! renamed !!!)
            • +
          • add a package org.apache.tools.ant.taskdefs; at the beginning of the two java files
            • +
          • delete all stuff from find.xml keeping the targets "testFileNotPresent", "testFilePresent", + "test.init" and "testMultipleFiles"
            • +
          • delete the dependency to "use.init" in the find.xml
            • +
          • in FindTest.java change the line configureProject("build.xml"); to + configureProject("src/etc/testcases/taskdefs/find.xml");
            • +
          • move the find.html to ANTHOME/docs/manual/Tasks/find.html
            • +
          • add a <a href="Tasks/find.html">Find</a><br> + in the ANTHOME/docs/manual/tasklist.html
            • +
          + +Now our modifications are done and we will retest it: +
          +ANTHOME> build
+ANTHOME> ant run-single-test                                      // 1
+             -Dtestcase=org.apache.tools.ant.taskdefs.FindTest    // 2
+             -Dtest.haltonfailure=false
+
          +Because we only want to test our new class, we use the target for single tests, specify +the test to use and configure not to halt on the first failure - we want to see all +failures of our own test (//1 + 2).

          + +

          And ... oh, all tests fail: Ant could not find the task or a class this task relies upon.

          + +

          Ok: in the earlier steps we told Ant to use the Find class for the <find> task (remember the +<taskdef> statement in the "use.init" target). But now we want to introduce that task as +a core task. And nobody wants to taskdef the javac, echo, ... So what to do? The answer is the +src/main/.../taskdefs/default.properties. Here is the mapping between taskname and implementing +class done. So we add a find=org.apache.tools.ant.taskdefs.Find as the last core +task (just before the # optional tasks line). Now a second try: +

          +ANTHOME> build                                                    // 1
+ANTHOME> ant run-single-test
+             -Dtestcase=org.apache.tools.ant.taskdefs.FindTest
+             -Dtest.haltonfailure=false
+
          +We have to rebuild (//1) Ant because the test look in the %ANT_HOME%\lib\ant.jar +(more precise: on the classpath) for the properties file. And we have only modified it in the +source path. So we have to rebuild that jar. But now all tests pass and we check whether our class +breaks some other tests. +
          +ANTHOME> ant test -Dtest.haltonfailure=false
+
          +Because there are a lot of tests this step requires a little bit of time. So use the run-single-test +during development and do the test only at the end (maybe sometimes during development too). +We use the -Dtest.haltonfailure=false here because there could be other tests fail and we have +to look into them.

          + +

          This test run should show us two things: our test will run and the number of failing tests +is the same as directly after the cvs update (without our modifications).

          + + + +

          Apache license statement

          +

          Simply copy the license text from one the other source from the Ant source tree.

          + + +

          Test on JDK 1.2

          +

          Until version 1.5 Ant must be able to run on a JDK 1.1. With version 1.6 this is not a +requisite any more. But JDK 1.2 is a must-to-work-with. So we have to test that. You can download older +JDKs from Oracle [8].

          + +

          Clean the ANT_HOME variable, delete the build, bootstrap and dist directory +and point JAVA_HOME to the JDK 1.2 home directory. Then do the build, set ANT_HOME +and run ant test (like above).

          + +

          Our test should pass.

          + + + +

          Checkstyle

          +

          There are many things we have to ensure. Indentation with 4 spaces, blanks here and there, ... +(all described in the Ant Task Guidelines [6] which +includes the Sun code style +[9]). Because there are so many things we would be happy to have a tool for do the checks. +There is one: checkstyle. Checkstyle is available at +Sourceforge [10] and Ant provides with the check.xml a buildfile which will do the job +for us.

          + +

          Download it and put the checkstyle-*-all.jar into your %USERPROFILE%\.ant\lib directory. +All jar's stored there are available to Ant so you haven't to add it to you %ANT_HOME%\lib +directory (this feature was added with Ant 1.6).

          + +

          So we will run the tests with +

          +ANTHOME> ant -f check.xml checkstyle htmlreport
+
          +I prefer the HTML report because there are lots of messages and we can navigate faster. +Open the ANTHOME/build/reports/checkstyle/html/index.html and navigate to the Find.java. Now we +see that there are some errors: missing whitespaces, unused imports, missing javadocs. So we have +to do that.

          + +

          Hint: start at the buttom of the file so the line numbers in the report will keep +up to date and you will find the next error place much more easier without redoing the checkstyle.

          + +

          After cleaning up the code according to the messages we delete the reports directory and +do a second checkstyle run. Now our task isn't listed. That's fine :-)

          + + + + + + +

          Publish the task

          +

          Finally we publish that archive. As described in the +Ant Task Guidelines [7] we can post it on the developer mailinglist or we create a BugZilla +entry. For both we need some information:

          + + + + + + + + + + + + + + + + + +
          subjectshort descriptionTask for finding files in a path
          bodymore details about the pathThis new task looks inside a nested <path/> for occurrences of a file and stores + all locations as a property. See the included manual for details.
          attachementsall files needed to apply the pathArchive containing a patch with the new and modified resources
          + +

          Sending an email with these information is very easy and I think I haven't to show that. +The other way - BugZilla - is slightly more difficult. But it has the advantage that entries +will not be forgotten (once per week a report is generated). So I will show this way.

          + +

          You must have a BugZilla account for that. So open the +BugZilla Main Page [11] and follow the link +Open a new Bugzilla account [12] +and the steps described there if you haven't one.

          + +
            +
          1. From the BugZilla main page choose Enter + a new bug report [13]
            2. +
          2. Choose "Ant" as product
            3. +
          3. Version is the last "Alpha (nightly)" (at this time 1.7)
            4. +
          4. Component is "Core tasks"
            5. +
          5. Plattform and Severity are ok with "Other" and "Normal"
            6. +
          6. Initial State is ok with "New"
            7. +
          7. Same with the empy "Assigned to"
            8. +
          8. It is not required to add yourself as CC, because you are the reporter and therefore will be + informed on changes
            9. +
          9. URL: no url required
            10. +
          10. Summary: add the subject from the table
            11. +
          11. Description: add the body from the table
            12. +
          12. Then press "Commit"
            13. +
          13. After redirecting to the new created bug entry click "Create a New Attachment"
            14. +
          14. Enter the path to your local path file into "File" or choose it via the "File"'s + button.
            15. +
          15. Enter a short description into "Description", so that you could guess, what the + path file includes. Here we could add "Initial Patch".
            16. +
          16. The "Content Type" is "auto-detect". You could use the "patch" type, if you only + provide a single path file, but we want do upload more that one, included in our + patch.zip.
            17. +
          17. Then press "Commit"
            18. +
          +Now the new task is uploaded into the bug database. + + +

          Resources

          +  [1] tutorial-writing-tasks.html
          +  [2] tutorial-tasks-filesets-properties.zip
          +  [3] properties.html#built-in-props
          +  [4] http://ant-contrib.sourceforge.net/
          +  [5] Tasks/java.html
          +  [6] http://ant.apache.org/ant_task_guidelines.html
          +  [7] http://ant.apache.org/cvs.html
          +  [8] http://www.oracle.com/technetwork/java/archive-139210.html
          +  [9] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
          +  [10] http://checkstyle.sourceforge.net/
          +  [11] http://issues.apache.org/bugzilla/
          +  [12] http://issues.apache.org/bugzilla/createaccount.cgi
          +  [13] http://issues.apache.org/bugzilla/enter_bug.cgi
          + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.zip b/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.zip new file mode 100644 index 000000000..94c8a10f1 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/tutorial-tasks-filesets-properties.zip differ diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks-src.zip b/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks-src.zip new file mode 100644 index 000000000..3567c3bcd Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks-src.zip differ diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks.html b/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks.html new file mode 100644 index 000000000..b7edb7210 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tutorial-writing-tasks.html @@ -0,0 +1,804 @@ + + + + Tutorial: Writing Tasks + + + + +

          Tutorial: Writing Tasks

          + +

          This document provides a step by step tutorial for writing +tasks.

          +

          Content

          + + + +

          Set up the build environment

          +

          Apache Ant builds itself, we are using Ant too (why we would write +a task if not? :-) therefore we should use Ant for our build.

          +

          We choose a directory as root directory. All things will be done +here if I say nothing different. I will reference this directory +as root-directory of our project. In this root-directory we +create a text file names build.xml. What should Ant do for us?

          +
            +
          • compiles my stuff
            • +
          • make the jar, so that I can deploy it
            • +
          • clean up everything
            • +
          +So the buildfile contains three targets. +
          +<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="MyTask" basedir="." default="jar">
+
+    <target name="clean" description="Delete all generated files">
+        <delete dir="classes"/>
+        <delete file="MyTasks.jar"/>
+    </target>
+
+    <target name="compile" description="Compiles the Task">
+        <javac srcdir="src" destdir="classes"/>
+    </target>
+
+    <target name="jar" description="JARs the Task">
+        <jar destfile="MyTask.jar" basedir="classes"/>
+    </target>
+
+</project>
+
          + +This buildfile uses often the same value (src, classes, MyTask.jar), so we should rewrite that +using <property>s. On second there are some handicaps: <javac> requires that the destination +directory exists; a call of "clean" with a non existing classes directory will fail; "jar" requires +the execution of some steps bofore. So the refactored code is: + +
          +<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="MyTask" basedir="." default="jar">
+
+    <property name="src.dir" value="src"/>
+    <property name="classes.dir" value="classes"/>
+
+    <target name="clean" description="Delete all generated files">
+        <delete dir="${classes.dir}" failonerror="false"/>
+        <delete file="${ant.project.name}.jar"/>
+    </target>
+
+    <target name="compile" description="Compiles the Task">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
+    </target>
+
+    <target name="jar" description="JARs the Task" depends="compile">
+        <jar destfile="${ant.project.name}.jar" basedir="${classes.dir}"/>
+    </target>
+
+</project>
+
          +ant.project.name is one of the + +build-in properties [1] of Ant. + + + +

          Write the Task

          + +Now we write the simplest Task - a HelloWorld-Task (what else?). Create a text file +HelloWorld.java in the src-directory with: +
          +public class HelloWorld {
+    public void execute() {
+        System.out.println("Hello World");
+    }
+}
+
          +and we can compile and jar it with ant (default target is "jar" and via +its depends-clause the "compile" is executed before). + + + + +

          Use the Task

          +

          But after creating the jar we want to use our new Task. Therefore we need a +new target "use". Before we can use our new task we have to declare it with + +<taskdef> [2]. And for easier process we change the default clause:

          +
          +<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="MyTask" basedir="." default="use">
+
+    ...
+
+    <target name="use" description="Use the Task" depends="jar">
+        <taskdef name="helloworld" classname="HelloWorld" classpath="${ant.project.name}.jar"/>
+        <helloworld/>
+    </target>
+
+</project>
+
          + +

          Important is the classpath-attribute. Ant searches in its /lib directory for +tasks and our task isn't there. So we have to provide the right location.

          + +

          Now we can type in ant and all should work ...

          +
          +Buildfile: build.xml
+
+compile:
+    [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes
+    [javac] Compiling 1 source file to C:\tmp\anttests\MyFirstTask\classes
+
+jar:
+      [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar
+
+use:
+[helloworld] Hello World
+
+BUILD SUCCESSFUL
+Total time: 3 seconds
+
          + + + + +

          Integration with TaskAdapter

          +

          Our class has nothing to do with Ant. It extends no superclass and implements +no interface. How does Ant know to integrate? Via name convention: our class provides +a method with signature public void execute(). This class is wrapped by Ant's +org.apache.tools.ant.TaskAdapter which is a task and uses reflection for +setting a reference to the project and calling the execute() method.

          + +

          Setting a reference to the project? Could be interesting. The Project class +gives us some nice abilities: access to Ant's logging facilities getting and setting +properties and much more. So we try to use that class:

          +
          +import org.apache.tools.ant.Project;
+
+public class HelloWorld {
+
+    private Project project;
+
+    public void setProject(Project proj) {
+        project = proj;
+    }
+
+    public void execute() {
+        String message = project.getProperty("ant.project.name");
+        project.log("Here is project '" + message + "'.", Project.MSG_INFO);
+    }
+}
+
          +and the execution with ant will show us the expected +
          +use:
+Here is project 'MyTask'.
+
          + + + +

          Deriving from Ant's Task

          +

          Ok, that works ... But usually you will extend org.apache.tools.ant.Task. +That class is integrated in Ant, get's the project-reference, provides documentation +fiels, provides easier access to the logging facility and (very useful) gives you +the exact location where in the buildfile this task instance is used.

          + +

          Oki-doki - let's us use some of these:

          +
          +import org.apache.tools.ant.Task;
+
+public class HelloWorld extends Task {
+    public void execute() {
+        // use of the reference to Project-instance
+        String message = getProject().getProperty("ant.project.name");
+
+        // Task's log method
+        log("Here is project '" + message + "'.");
+
+        // where this task is used?
+        log("I am used in: " +  getLocation() );
+    }
+}
+
          +

          which gives us when running

          +
          +use:
+[helloworld] Here is project 'MyTask'.
+[helloworld] I am used in: C:\tmp\anttests\MyFirstTask\build.xml:23:
+
          + + +

          Accessing the Task's Project

          +

          The parent project of your custom task may be accessed through method getProject(). However, do not call this from the custom task constructor, as the return value will be null. Later, when node attributes or text are set, or method execute() is called, the Project object is available.

          +

          Here are two useful methods from class Project:

          +
            +
          • String getProperty(String propertyName)
            • +
          • + String replaceProperties(String value) +
            • +
          + +

          The method replaceProperties() is discussed further in section Nested Text.

          + + +

          Attributes

          +

          Now we want to specify the text of our message (it seems that we are +rewriting the <echo/> task :-). First we well do that with an attribute. +It is very easy - for each attribute provide a public void set<attributename>(<type> +newValue) method and Ant will do the rest via reflection.

          +
          +import org.apache.tools.ant.Task;
+import org.apache.tools.ant.BuildException;
+
+public class HelloWorld extends Task {
+
+    String message;
+    public void setMessage(String msg) {
+        message = msg;
+    }
+
+    public void execute() {
+        if (message==null) {
+            throw new BuildException("No message set.");
+        }
+        log(message);
+    }
+
+}
+
          +

          Oh, what's that in execute()? Throw a BuildException? Yes, that's the usual +way to show Ant that something important is missed and complete build should fail. The +string provided there is written as build-failes-message. Here it's necessary because +the log() method can't handle a null value as parameter and throws a NullPointerException. +(Of course you can initialize the message with a default string.)

          + +

          After that we have to modify our buildfile:

          +
          +    <target name="use" description="Use the Task" depends="jar">
+        <taskdef name="helloworld"
+                 classname="HelloWorld"
+                 classpath="${ant.project.name}.jar"/>
+        <helloworld message="Hello World"/>
+    </target>
+
          +

          That's all.

          + +

          Some background for working with attributes: Ant supports any of these datatypes as +arguments of the set-method:

            +
          • elementary data type like int, long, ...
            • +
          • its wrapper classes like java.lang.Integer, java.lang.Long, ...
            • +
          • java.lang.String
            • +
          • some more classes (e.g. java.io.File; see + Manual + 'Writing Your Own Task' [3])
            • +
          • Any Java Object parsed from Ant 1.8's Property +Helper
            • +
          +Before calling the set-method all properties are resolved. So a <helloworld message="${msg}"/> +would not set the message string to "${msg}" if there is a property "msg" with a set value. + + + +

          Nested Text

          +

          Maybe you have used the <echo> task in a way like <echo>Hello World</echo>. +For that you have to provide a public void addText(String text) method.

          +
          +...
+public class HelloWorld extends Task {
+    private String message;
+    ...
+    public void addText(String text) {
+        message = text;
+    }
+    ...
+}
+
          +

          But here properties are not resolved! For resolving properties we have to use +Project's replaceProperties(String propname) : String method which takes the +property name as argument and returns its value (or ${propname} if not set).

          +

          Thus, to replace properties in the nested node text, our method addText() can be written as:

          +
          +    public void addText(String text) {
+        message = getProject().replaceProperties(text);
+    }
+
          + + + +

          Nested Elements

          +

          There are several ways for inserting the ability of handling nested elements. See +the Manual [4] for other. +We use the first way of the three described ways. There are several steps for that:

            +
          1. We create a class for collecting all the info the nested element should contain. + This class is created by the same rules for attributes and nested elements + as for the task (set<attributename>() methods).
            2. +
          2. The task holds multiple instances of this class in a list.
            3. +
          3. A factory method instantiates an object, saves the reference in the list + and returns it to Ant Core.
            4. +
          4. The execute() method iterates over the list and evaluates its values.
            5. +
          +
          +import java.util.Vector;
+import java.util.Iterator;
+...
+    public void execute() {
+        if (message!=null) log(message);
+        for (Iterator it=messages.iterator(); it.hasNext(); ) {      // 4
+            Message msg = (Message)it.next();
+            log(msg.getMsg());
+        }
+    }
+
+
+    Vector messages = new Vector();                                  // 2
+
+    public Message createMessage() {                                 // 3
+        Message msg = new Message();
+        messages.add(msg);
+        return msg;
+    }
+
+    public class Message {                                           // 1
+        public Message() {}
+
+        String msg;
+        public void setMsg(String msg) { this.msg = msg; }
+        public String getMsg() { return msg; }
+    }
+...
+
          +

          Then we can use the new nested element. But where is xml-name for that defined? +The mapping XML-name : classname is defined in the factory method: +public classname createXML-name(). Therefore we write in +the buildfile

          +
          +        <helloworld>
+            <message msg="Nested Element 1"/>
+            <message msg="Nested Element 2"/>
+        </helloworld>
+
          +

          Note that if you choose to use methods 2 or 3, the class that represents the nested +element must be declared as static

          + + +

          Our task in a little more complex version

          +

          For recapitulation now a little refactored buildfile:

          +
          +<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="MyTask" basedir="." default="use">
+
+    <property name="src.dir" value="src"/>
+    <property name="classes.dir" value="classes"/>
+
+    <target name="clean" description="Delete all generated files">
+        <delete dir="${classes.dir}" failonerror="false"/>
+        <delete file="${ant.project.name}.jar"/>
+    </target>
+
+    <target name="compile" description="Compiles the Task">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}"/>
+    </target>
+
+    <target name="jar" description="JARs the Task" depends="compile">
+        <jar destfile="${ant.project.name}.jar" basedir="${classes.dir}"/>
+    </target>
+
+
+    <target name="use.init"
+            description="Taskdef the HelloWorld-Task"
+            depends="jar">
+        <taskdef name="helloworld"
+                 classname="HelloWorld"
+                 classpath="${ant.project.name}.jar"/>
+    </target>
+
+
+    <target name="use.without"
+            description="Use without any"
+            depends="use.init">
+        <helloworld/>
+    </target>
+
+    <target name="use.message"
+            description="Use with attribute 'message'"
+            depends="use.init">
+        <helloworld message="attribute-text"/>
+    </target>
+
+    <target name="use.fail"
+            description="Use with attribute 'fail'"
+            depends="use.init">
+        <helloworld fail="true"/>
+    </target>
+
+    <target name="use.nestedText"
+            description="Use with nested text"
+            depends="use.init">
+        <helloworld>nested-text</helloworld>
+    </target>
+
+    <target name="use.nestedElement"
+            description="Use with nested 'message'"
+            depends="use.init">
+        <helloworld>
+            <message msg="Nested Element 1"/>
+            <message msg="Nested Element 2"/>
+        </helloworld>
+    </target>
+
+
+    <target name="use"
+            description="Try all (w/out use.fail)"
+            depends="use.without,use.message,use.nestedText,use.nestedElement"
+    />
+
+</project>
+
          + +And the code of the task: +
          +import org.apache.tools.ant.Task;
+import org.apache.tools.ant.BuildException;
+import java.util.Vector;
+import java.util.Iterator;
+
+/**
+ * The task of the tutorial.
+ * Print a message or let the build fail.
+ * @since 2003-08-19
+ */
+public class HelloWorld extends Task {
+
+
+    /** The message to print. As attribute. */
+    String message;
+    public void setMessage(String msg) {
+        message = msg;
+    }
+
+    /** Should the build fail? Defaults to false. As attribute. */
+    boolean fail = false;
+    public void setFail(boolean b) {
+        fail = b;
+    }
+
+    /** Support for nested text. */
+    public void addText(String text) {
+        message = text;
+    }
+
+
+    /** Do the work. */
+    public void execute() {
+        // handle attribute 'fail'
+        if (fail) throw new BuildException("Fail requested.");
+
+        // handle attribute 'message' and nested text
+        if (message!=null) log(message);
+
+        // handle nested elements
+        for (Iterator it=messages.iterator(); it.hasNext(); ) {
+            Message msg = (Message)it.next();
+            log(msg.getMsg());
+        }
+    }
+
+
+    /** Store nested 'message's. */
+    Vector messages = new Vector();
+
+    /** Factory method for creating nested 'message's. */
+    public Message createMessage() {
+        Message msg = new Message();
+        messages.add(msg);
+        return msg;
+    }
+
+    /** A nested 'message'. */
+    public class Message {
+        // Bean constructor
+        public Message() {}
+
+        /** Message to print. */
+        String msg;
+        public void setMsg(String msg) { this.msg = msg; }
+        public String getMsg() { return msg; }
+    }
+
+}
+
          + +And it works: +
          +C:\tmp\anttests\MyFirstTask>ant
+Buildfile: build.xml
+
+compile:
+    [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes
+    [javac] Compiling 1 source file to C:\tmp\anttests\MyFirstTask\classes
+
+jar:
+      [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar
+
+use.init:
+
+use.without:
+
+use.message:
+[helloworld] attribute-text
+
+use.nestedText:
+[helloworld] nested-text
+
+use.nestedElement:
+[helloworld]
+[helloworld]
+[helloworld]
+[helloworld]
+[helloworld] Nested Element 1
+[helloworld] Nested Element 2
+
+use:
+
+BUILD SUCCESSFUL
+Total time: 3 seconds
+C:\tmp\anttests\MyFirstTask>ant use.fail
+Buildfile: build.xml
+
+compile:
+
+jar:
+
+use.init:
+
+use.fail:
+
+BUILD FAILED
+C:\tmp\anttests\MyFirstTask\build.xml:36: Fail requested.
+
+Total time: 1 second
+C:\tmp\anttests\MyFirstTask>
+
          +Next step: test ... + + + + +

          Test the Task

          +

          We have written a test already: the use.* tasks in the buildfile. But its +difficult to test that automatically. Common (and in Ant) used is JUnit for +that. For testing tasks Ant provides a baseclass org.apache.tools.ant.BuildFileTest. +This class extends junit.framework.TestCase and can therefore be integrated +into the unit tests. But this class provides some for testing tasks useful methods: +initialize Ant, load a buildfile, execute targets, +expecting BuildExceptions with a specified text, expect a special text +in the output log ...

          + +

          In Ant it is usual that the testcase has the same name as the task with a prepending +Test, therefore we will create a file HelloWorldTest.java. Because we +have a very small project we can put this file into src directory (Ant's own +testclasses are in /src/testcases/...). Because we have already written our tests +for "hand-test" we can use that for automatic tests, too. But there is one little +problem we have to solve: all test supporting classes are not part of the binary +distribution of Ant. So you can build the special jar file from source distro with +target "test-jar" or you can download a nightly build from + +http://gump.covalent.net/jars/latest/ant/ant-testutil.jar [5].

          + +

          For executing the test and creating a report we need the optional tasks <junit> +and <junitreport>. So we add to the buildfile:

          +
          +...
+<project name="MyTask" basedir="." default="test">
+...
+    <property name="ant.test.lib" value="ant-testutil.jar"/>
+    <property name="report.dir"   value="report"/>
+    <property name="junit.out.dir.xml"  value="${report.dir}/junit/xml"/>
+    <property name="junit.out.dir.html" value="${report.dir}/junit/html"/>
+
+    <path id="classpath.run">
+        <path path="${java.class.path}"/>
+        <path location="${ant.project.name}.jar"/>
+    </path>
+
+    <path id="classpath.test">
+        <path refid="classpath.run"/>
+        <path location="${ant.test.lib}"/>
+    </path>
+
+    <target name="clean" description="Delete all generated files">
+        <delete failonerror="false" includeEmptyDirs="true">
+            <fileset dir="." includes="${ant.project.name}.jar"/>
+            <fileset dir="${classes.dir}"/>
+            <fileset dir="${report.dir}"/>
+        </delete>
+    </target>
+
+    <target name="compile" description="Compiles the Task">
+        <mkdir dir="${classes.dir}"/>
+        <javac srcdir="${src.dir}" destdir="${classes.dir}" classpath="${ant.test.lib}"/>
+    </target>
+...
+    <target name="junit" description="Runs the unit tests" depends="jar">
+        <delete dir="${junit.out.dir.xml}"/>
+        <mkdir  dir="${junit.out.dir.xml}"/>
+        <junit printsummary="yes" haltonfailure="no">
+            <classpath refid="classpath.test"/>
+            <formatter type="xml"/>
+            <batchtest fork="yes" todir="${junit.out.dir.xml}">
+                <fileset dir="${src.dir}" includes="**/*Test.java"/>
+            </batchtest>
+        </junit>
+    </target>
+
+    <target name="junitreport" description="Create a report for the rest result">
+        <mkdir dir="${junit.out.dir.html}"/>
+        <junitreport todir="${junit.out.dir.html}">
+            <fileset dir="${junit.out.dir.xml}">
+                <include name="*.xml"/>
+            </fileset>
+            <report format="frames" todir="${junit.out.dir.html}"/>
+        </junitreport>
+    </target>
+
+    <target name="test"
+            depends="junit,junitreport"
+            description="Runs unit tests and creates a report"
+    />
+...
+
          + +

          Back to the src/HelloWorldTest.java. We create a class extending +BuildFileTest with String-constructor (JUnit-standard), a setUp() +method initializing Ant and for each testcase (targets use.*) a testXX() +method invoking that target.

          +
          +import org.apache.tools.ant.BuildFileTest;
+
+public class HelloWorldTest extends BuildFileTest {
+
+    public HelloWorldTest(String s) {
+        super(s);
+    }
+
+    public void setUp() {
+        // initialize Ant
+        configureProject("build.xml");
+    }
+
+    public void testWithout() {
+        executeTarget("use.without");
+        assertEquals("Message was logged but should not.", getLog(), "");
+    }
+
+    public void testMessage() {
+        // execute target 'use.nestedText' and expect a message
+        // 'attribute-text' in the log
+        expectLog("use.message", "attribute-text");
+    }
+
+    public void testFail() {
+        // execute target 'use.fail' and expect a BuildException
+        // with text 'Fail requested.'
+        expectBuildException("use.fail", "Fail requested.");
+    }
+
+    public void testNestedText() {
+        expectLog("use.nestedText", "nested-text");
+    }
+
+    public void testNestedElement() {
+        executeTarget("use.nestedElement");
+        assertLogContaining("Nested Element 1");
+        assertLogContaining("Nested Element 2");
+    }
+}
+
          + +

          When starting ant we'll get a short message to STDOUT and +a nice HTML-report.

          +
          +C:\tmp\anttests\MyFirstTask>ant
+Buildfile: build.xml
+
+compile:
+    [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\classes
+    [javac] Compiling 2 source files to C:\tmp\anttests\MyFirstTask\classes
+
+jar:
+      [jar] Building jar: C:\tmp\anttests\MyFirstTask\MyTask.jar
+
+junit:
+    [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\report\junit\xml
+    [junit] Running HelloWorldTest
+    [junit] Tests run: 5, Failures: 0, Errors: 0, Time elapsed: 2,334 sec
+
+
+
+junitreport:
+    [mkdir] Created dir: C:\tmp\anttests\MyFirstTask\report\junit\html
+[junitreport] Using Xalan version: Xalan Java 2.4.1
+[junitreport] Transform time: 661ms
+
+test:
+
+BUILD SUCCESSFUL
+Total time: 7 seconds
+C:\tmp\anttests\MyFirstTask>
+
          + + + +

          Debugging

          + +

          Try running Ant with the flag -verbose. For more information, try flag -debug.

          +

          For deeper issues, you may need to run the custom task code in a Java debugger. First, get the source for Ant and build it with debugging information.

          +

          Since Ant is a large project, it can be a little tricky to set the right breakpoints. Here are two important breakpoints for version 1.8:

          +
            +
          • Initial main() function: com.apache.tools.ant.launch.Launcher.main()
            • +
          • Task entry point: com.apache.tools.ant.UnknownElement.execute()
            • +
          + +

          If you need to debug when a task attribute or the text is set, begin by debugging into method execute() of your custom task. Then set breakpoints in other methods. This will ensure the class byte-code has been loaded by the Java VM.

          + + + + +

          Resources

          +

          This tutorial and its resources are available via +BugZilla [6]. +The ZIP provided there contains

            +
          • this initial version of this tutorial
            • +
          • the buildfile (last version)
            • +
          • the source of the task (last version)
            • +
          • the source of the unit test (last version)
            • +
          • the ant-testutil.jar (nightly build of 2003-08-18)
            • +
          • generated classes
            • +
          • generated jar
            • +
          • generated reports
            • +
          +

          The last sources and the buildfile are also available +here [7] inside the manual. +

          + +

          Used Links:

          +  [1] http://ant.apache.org/manual/properties.html#built-in-props

          +  [2] http://ant.apache.org/manual/Tasks/taskdef.html

          +  [3] http://ant.apache.org/manual/develop.html#set-magic

          +  [4] http://ant.apache.org/manual/develop.html#nested-elements

          +  [5] http://gump.covalent.net/jars/latest/ant/ant-testutil.jar

          +  [6] http://issues.apache.org/bugzilla/show_bug.cgi?id=22570

          +  [7] tutorial-writing-tasks-src.zip

          +

          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/tutorials.html b/tools/apache-ant-1.8.2/docs/manual/tutorials.html new file mode 100644 index 000000000..5720473aa --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/tutorials.html @@ -0,0 +1,45 @@ + + + + + + +Tutorials + + + + + +

          Table of Contents

          + +

          Tutorials

          + +

          Hello World with Apache Ant
          +A step by step tutorial for starting java programming with Ant.

          + +

          Writing Tasks
          +A step by step tutorial for writing tasks.

          + +

          Tasks using Properties, Filesets & Paths
          +How to get and set properties and how to use nested filesets and paths +while writing tasks. Finally it explains how to contribute tasks to Ant.

          + + + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/using.html b/tools/apache-ant-1.8.2/docs/manual/using.html new file mode 100644 index 000000000..69483a6fc --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/using.html @@ -0,0 +1,577 @@ + + + + + + +Writing a Simple Buildfile + + + +

          Using Apache Ant

          +

          Writing a Simple Buildfile

          +

          Apache Ant's buildfiles are written in XML. Each buildfile contains one project +and at least one (default) target. Targets contain task elements. +Each task element of the buildfile can have an id attribute and +can later be referred to by the value supplied to this. The value has +to be unique. (For additional information, see the + Tasks section below.)

          +

          Projects

          +

          A project has three attributes:

          + + + + + + + + + + + + + + + + + + + + + +
          AttributeDescriptionRequired
          namethe name of the project.No
          defaultthe default target to use when no target is supplied.No; however, since Ant 1.6.0, + every project includes an implicit target that contains any and + all top-level tasks and/or types. This target will always be + executed as part of the project's initialization, even when Ant is + run with the -projecthelp option. +
          basedirthe base directory from which all path calculations are + done. This attribute might be overridden by setting + the "basedir" + property beforehand. When this is done, it must be omitted in the + project tag. If neither the attribute nor the property have + been set, the parent directory of the buildfile will be used.No
          +

          Optionally, a description for the project can be provided as a +top-level <description> element (see the description type).

          + +

          Each project defines one or more targets. +A target is a set of tasks you want +to be executed. When starting Ant, you can select which target(s) you +want to have executed. When no target is given, +the project's default is used.

          + +

          Targets

          +

          A target can depend on other targets. You might have a target for compiling, +for example, and a target for creating a distributable. You can only build a +distributable when you have compiled first, so the distribute target +depends on the compile target. Ant resolves these dependencies.

          +

          It should be noted, however, that Ant's depends attribute +only specifies the order in which targets should be executed - it +does not affect whether the target that specifies the dependency(s) gets +executed if the dependent target(s) did not (need to) run. +

          + +

          More information can be found in the + dedicated manual page.

          + +

          Tasks

          +

          A task is a piece of code that can be executed.

          +

          A task can have multiple attributes (or arguments, if you prefer). The value +of an attribute might contain references to a property. These references will be +resolved before the task is executed.

          +

          Tasks have a common structure:

          +
          + 
          <name attribute1="value1" attribute2="value2" ... />
          +
          +

          where name is the name of the task, +attributeN is the attribute name, and +valueN is the value for this attribute.

          +

          There is a set of built-in tasks, but it is also very +easy to write your own.

          +

          All tasks share a task name attribute. The value of +this attribute will be used in the logging messages generated by +Ant.

          +Tasks can be assigned an id attribute: +
          +
          <taskname id="taskID" ... />
          +
          +where taskname is the name of the task, and taskID is +a unique identifier for this task. +You can refer to the +corresponding task object in scripts or other tasks via this name. +For example, in scripts you could do: +
          +
          +<script ... >
+  task1.setFoo("bar");
+</script>
+
          +
          +to set the foo attribute of this particular task instance. +In another task (written in Java), you can access the instance via +project.getReference("task1"). +

          +Note1: If "task1" has not been run yet, then +it has not been configured (ie., no attributes have been set), and if it is +going to be configured later, anything you've done to the instance may +be overwritten. +

          +

          +Note2: Future versions of Ant will most likely not +be backward-compatible with this behaviour, since there will likely be no +task instances at all, only proxies. +

          + +

          Properties

          + +

          Properties are an important way to customize a build process or + to just provide shortcuts for strings that are used repeatedly + inside a build file.

          + +

          In its most simple form properties are defined in the build file + (for example by the property + task) or might be set outside Ant. A property has a name and a + value; the name is case-sensitive. Properties may be used in the + value of task attributes or in the nested text of tasks that support + them. This is done by placing the property name between + "${" and "}" in the + attribute value. For example, if there is a "builddir" + property with the value "build", then this could be used + in an attribute like this: ${builddir}/classes. This + is resolved at run-time as build/classes.

          + +

          With Ant 1.8.0 property expansion has become much more powerful + than simple key value pairs, more details can be + found in the concepts section of this + manual.

          + +

          Example Buildfile

          +
          +<project name="MyProject" default="dist" basedir=".">
+    <description>
+        simple example build file
+    </description>
+  <!-- set global properties for this build -->
+  <property name="src" location="src"/>
+  <property name="build" location="build"/>
+  <property name="dist"  location="dist"/>
+
+  <target name="init">
+    <!-- Create the time stamp -->
+    <tstamp/>
+    <!-- Create the build directory structure used by compile -->
+    <mkdir dir="${build}"/>
+  </target>
+
+  <target name="compile" depends="init"
+        description="compile the source " >
+    <!-- Compile the java code from ${src} into ${build} -->
+    <javac srcdir="${src}" destdir="${build}"/>
+  </target>
+
+  <target name="dist" depends="compile"
+        description="generate the distribution" >
+    <!-- Create the distribution directory -->
+    <mkdir dir="${dist}/lib"/>
+
+    <!-- Put everything in ${build} into the MyProject-${DSTAMP}.jar file -->
+    <jar jarfile="${dist}/lib/MyProject-${DSTAMP}.jar" basedir="${build}"/>
+  </target>
+
+  <target name="clean"
+        description="clean up" >
+    <!-- Delete the ${build} and ${dist} directory trees -->
+    <delete dir="${build}"/>
+    <delete dir="${dist}"/>
+  </target>
+</project>
+
          + +

          Notice that we are declaring properties outside any target. As of +Ant 1.6 all tasks can be declared outside targets (earlier version +only allowed <property>,<typedef> and +<taskdef>). When you do this they are evaluated before +any targets are executed. Some tasks will generate build failures if +they are used outside of targets as they may cause infinite loops +otherwise (<antcall> for example).

          + +

          +We have given some targets descriptions; this causes the projecthelp +invocation option to list them as public targets with the descriptions; the +other target is internal and not listed. +

          +Finally, for this target to work the source in the src subdirectory +should be stored in a directory tree which matches the package names. Check the +<javac> task for details. + +

          Token Filters

          +

          A project can have a set of tokens that might be automatically expanded if +found when a file is copied, when the filtering-copy behavior is selected in the +tasks that support this. These might be set in the buildfile +by the filter task.

          +

          Since this can potentially be a very harmful behavior, +the tokens in the files must +be of the form @token@, where +token is the token name that is set +in the <filter> task. This token syntax matches the syntax of other build systems +that perform such filtering and remains sufficiently orthogonal to most +programming and scripting languages, as well as with documentation systems.

          +

          Note: If a token with the format @token@ +is found in a file, but no +filter is associated with that token, no changes take place; +therefore, no escaping +method is available - but as long as you choose appropriate names for your +tokens, this should not cause problems.

          +

          Warning: If you copy binary files with filtering turned on, you can corrupt the +files. This feature should be used with text files only.

          + +

          Path-like Structures

          +

          You can specify PATH- and CLASSPATH-type +references using both +":" and ";" as separator +characters. Ant will +convert the separator to the correct character of the current operating +system.

          +

          Wherever path-like values need to be specified, a nested element can +be used. This takes the general form of:

          +
          +    <classpath>
+      <pathelement path="${classpath}"/>
+      <pathelement location="lib/helper.jar"/>
+    </classpath>
+
          +

          The location attribute specifies a single file or +directory relative to the project's base directory (or an absolute +filename), while the path attribute accepts colon- +or semicolon-separated lists of locations. The path +attribute is intended to be used with predefined paths - in any other +case, multiple elements with location attributes should be +preferred.

          +

          Since Ant 1.8.2 the location attribute can also contain a + wildcard in its last path component (i.e. it can end in a + "*") in order to support wildcard CLASSPATHs introduced + with Java6. Ant will not expand or evaluate the wildcards and the + resulting path may not work as anything else but a CLASSPATH - or + even as a CLASSPATH for a Java VM prior to Java6.

          +

          As a shortcut, the <classpath> tag +supports path and +location attributes of its own, so:

          +
          +    <classpath>
+      <pathelement path="${classpath}"/>
+    </classpath>
+
          +

          can be abbreviated to:

          +
          +    <classpath path="${classpath}"/>
+
          +

          In addition, one or more +Resource Collections +can be specified as nested elements (these must consist of +file-type resources only). +Additionally, it should be noted that although resource collections are +processed in the order encountered, certain resource collection types +such as fileset, +dirset and +files +are undefined in terms of order.

          +
          +    <classpath>
+      <pathelement path="${classpath}"/>
+      <fileset dir="lib">
+        <include name="**/*.jar"/>
+      </fileset>
+      <pathelement location="classes"/>
+      <dirset dir="${build.dir}">
+        <include name="apps/**/classes"/>
+        <exclude name="apps/**/*Test*"/>
+      </dirset>
+      <filelist refid="third-party_jars"/>
+    </classpath>
+
          +

          This builds a path that holds the value of ${classpath}, +followed by all jar files in the lib directory, +the classes directory, all directories named +classes under the apps subdirectory of +${build.dir}, except those +that have the text Test in their name, and +the files specified in the referenced FileList.

          +

          If you want to use the same path-like structure for several tasks, +you can define them with a <path> element at the +same level as targets, and reference them via their +id attribute--see References for an +example.

          + +

          By default a path like structure will re-evaluate all nested + resource collections whenever it is used, which may lead to + unnecessary re-scanning of the filesystem. Since Ant 1.8.0 path has + an optional cache attribute, if it is set to true, the path + instance will only scan its nested resource collections once and + assume it doesn't change during the build anymore (the default + for cache still is false). Even if you are using the + path only in a single task it may improve overall performance to set + cache to true if you are using complex nested + constructs.

          + +

          A path-like structure can include a reference to another path-like +structure (a path being itself a resource collection) +via nested <path> elements:

          +
          +    <path id="base.path">
+      <pathelement path="${classpath}"/>
+      <fileset dir="lib">
+        <include name="**/*.jar"/>
+      </fileset>
+      <pathelement location="classes"/>
+    </path>
+
+    <path id="tests.path" cache="true">
+      <path refid="base.path"/>
+      <pathelement location="testclasses"/>
+    </path>
+
          + The shortcuts previously mentioned for <classpath> are also valid for <path>.For example: +
          +    <path id="base.path">
+      <pathelement path="${classpath}"/>
+    </path>
+
          +can be written as: +
          +    <path id="base.path" path="${classpath}"/>
+
          + +

          Path Shortcut

          +

          + In Ant 1.6 a shortcut for converting paths to OS specific strings + in properties has been added. One can use the expression + ${toString:pathreference} to convert a path element + reference to a string that can be used for a path argument. + For example: +

          +
          +  <path id="lib.path.ref">
+    <fileset dir="lib" includes="*.jar"/>
+  </path>
+  <javac srcdir="src" destdir="classes">
+    <compilerarg arg="-Xbootclasspath/p:${toString:lib.path.ref}"/>
+  </javac>
+
          + + +

          Command-line Arguments

          +

          Several tasks take arguments that will be passed to another +process on the command line. To make it easier to specify arguments +that contain space characters, nested arg elements can be used.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          AttributeDescriptionRequired
          valuea single command-line argument; can contain space + characters.Exactly one of these.
          fileThe name of a file as a single command-line + argument; will be replaced with the absolute filename of the file.
          pathA string that will be treated as a path-like + string as a single command-line argument; you can use ; + or : as + path separators and Ant will convert it to the platform's local + conventions.
          pathrefReference to a path + defined elsewhere. Ant will convert it to the platform's local + conventions.
          linea space-delimited list of command-line arguments.
          prefixA fixed string to be placed in front of the + argument. In the case of a line broken into parts, it will be + placed in front of every part. Since Ant 1.8.No
          suffixA fixed string to be placed immediately after the + argument. In the case of a line broken into parts, it will be + placed after every part. Since Ant 1.8.No
          + +

          It is highly recommended to avoid the line version +when possible. Ant will try to split the command line in a way +similar to what a (Unix) shell would do, but may create something that +is very different from what you expect under some circumstances.

          + +

          Examples

          +
          +  <arg value="-l -a"/>
+
          +

          is a single command-line argument containing a space character, +not separate commands "-l" and "-a".

          +
          +  <arg line="-l -a"/>
+
          +

          This is a command line with two separate arguments, "-l" and "-a".

          +
          +  <arg path="/dir;/dir2:\dir3"/>
+
          +

          is a single command-line argument with the value +\dir;\dir2;\dir3 on DOS-based systems and +/dir:/dir2:/dir3 on Unix-like systems.

          + +

          References

          + +

          Any project element can be assigned an identifier using its +id attribute. In most cases the element can subsequently +be referenced by specifying the refid attribute on an +element of the same type. This can be useful if you are going to +replicate the same snippet of XML over and over again--using a +<classpath> structure more than once, for example.

          +

          The following example:

          +
          +<project ... >
+  <target ... >
+    <rmic ...>
+      <classpath>
+        <pathelement location="lib/"/>
+        <pathelement path="${java.class.path}/"/>
+        <pathelement path="${additional.path}"/>
+      </classpath>
+    </rmic>
+  </target>
+
+  <target ... >
+    <javac ...>
+      <classpath>
+        <pathelement location="lib/"/>
+        <pathelement path="${java.class.path}/"/>
+        <pathelement path="${additional.path}"/>
+      </classpath>
+    </javac>
+  </target>
+</project>
+
          +

          could be rewritten as:

          +
          +<project ... >
+  <path id="project.class.path">
+    <pathelement location="lib/"/>
+    <pathelement path="${java.class.path}/"/>
+    <pathelement path="${additional.path}"/>
+  </path>
+
+  <target ... >
+    <rmic ...>
+      <classpath refid="project.class.path"/>
+    </rmic>
+  </target>
+
+  <target ... >
+    <javac ...>
+      <classpath refid="project.class.path"/>
+    </javac>
+  </target>
+</project>
+
          +

          All tasks that use nested elements for +PatternSets, +FileSets, +ZipFileSets or +path-like structures accept references to these structures +as shown in the examples. Using refid on a task will ordinarily +have the same effect (referencing a task already declared), but the user +should be aware that the interpretation of this attribute is dependent on the +implementation of the element upon which it is specified. Some tasks (the +property task is a handy example) +deliberately assign a different meaning to refid.

          + + +

          Use of external tasks

          +Ant supports a plugin mechanism for using third party tasks. For using them you +have to do two steps: +
            +
          1. place their implementation somewhere where Ant can find them
            2. +
          2. declare them.
            3. +
          +Don't add anything to the CLASSPATH environment variable - this is often the +reason for very obscure errors. Use Ant's own mechanisms +for adding libraries: +
            +
          • via command line argument -lib
            • +
          • adding to ${user.home}/.ant/lib
            • +
          • adding to ${ant.home}/lib
            • +
          +For the declaration there are several ways: +
            +
          • declare a single task per using instruction using + <taskdef name="taskname" + classname="ImplementationClass"/> +
            + <taskdef name="for" classname="net.sf.antcontrib.logic.For" /> + <for ... /> +
            • +
          • declare a bundle of tasks using a properties-file holding these + taskname-ImplementationClass-pairs and <taskdef> +
            + <taskdef resource="net/sf/antcontrib/antcontrib.properties" /> + <for ... /> +
            • +
          • declare a bundle of tasks using a xml-file holding these + taskname-ImplementationClass-pairs and <taskdef> +
            + <taskdef resource="net/sf/antcontrib/antlib.xml" /> + <for ... /> +
            • +
          • declare a bundle of tasks using a xml-file named antlib.xml, XML-namespace and + antlib: protocoll handler +
            + <project xmlns:ac="antlib:net.sf.antconrib"/> + <ac:for ... /> +
            • +
          + +If you need a special function, you should +
            +
          1. have a look at this manual, because Ant provides lot of tasks
            2. +
          2. have a look at the external task page in the manual + (or better online)
            3. +
          3. have a look at the external task wiki + page
            4. +
          4. ask on the Ant user list
            5. +
          5. implement (and share) your own
            6. +
          + + + diff --git a/tools/apache-ant-1.8.2/docs/manual/usinglist.html b/tools/apache-ant-1.8.2/docs/manual/usinglist.html new file mode 100644 index 000000000..9169d6fd8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manual/usinglist.html @@ -0,0 +1,50 @@ + + + + + + +Apache Ant User Manual + + + + + +

          Table of Contents

          + +

          Using Apache Ant

          + + + + diff --git a/tools/apache-ant-1.8.2/docs/manualdownload.html b/tools/apache-ant-1.8.2/docs/manualdownload.html new file mode 100644 index 000000000..b5af19e50 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/manualdownload.html @@ -0,0 +1,356 @@ + + + + + + + + + Apache Ant - Ant Manual Distributions + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Ant Manual Distributions

          +

          + + Downloading Apache Ant™'s Manual +

          +

          Apache Ant's manual is part of the binary distribution but is also + available as a stand-alone download.

          +

          Use the links below to download a distribution of Ant's manual from +one of our mirrors. It is good practice to +verify the integrity +of the distribution files, especially if you are using one of our +mirror sites. In order to do this you must use the signatures from +our main distribution +directory.

          +

          Ant is distributed as zip, tar.gz and +tar.bz2 archives - the contents are the same. Please +note that the tar.* archives contain file names longer +than 100 characters and have been created using GNU tar extensions. +Thus they must be untarred with a GNU compatible version of +tar.

          +

          If you do not see the file you need in the links below, please see +the master distribution +directory or, preferably, its mirror.

          +

          + + Mirror +

          +

          You are currently using [preferred]. If you encounter a +problem with this mirror, please select another mirror. If all +mirrors are failing, there are backup mirrors (at the end of +the mirrors list) that should be available.

          +
          +Other mirrors: + +
          +

          + + Current Release of Ant +

          +

          Currently, Apache Ant 1.8.2 is the best available version, see the +release notes.

          +
          +
          Note
          +
          Ant 1.8.2 was released on 27-December-2010 and +may not be available on all mirrors for a few days.
          +
          +
          +
          +
          Tar files may require gnu tar to extract
          +
          Tar files in the distribution contain long file names, and may + require gnu tar to do the extraction.
          +
          + +

          + + Old Ant Releases +

          +

          Manuals for older releases of Ant can be +found here.

          +

          + + Verify Releases +

          +

          It is essential that you verify the integrity of the downloaded +files using the PGP signature or the SHA1, SHA512 or MD5 checksums. The +checksums are not as strong indicators as the PGP signature.

          +

          The PGP signatures can be verified using PGP or GPG. First +download the KEYS +as well as the asc signature file for the particular +distribution. Make sure you get these files from the main distribution +directory, rather than from a mirror. Then verify the signatures +using

          +

          +% pgpk -a KEYS
          +% pgpv apache-ant-1.8.2-manual.tar.gz.asc
          +           +or
          + +% pgp -ka KEYS
          +% pgp apache-ant-1.8.2-manual.tar.gz.asc
          +           +or
          + +% gpg --import KEYS
          +% gpg --verify apache-ant-1.8.2-manual.tar.gz.asc +

          +

          A command line version of GnuPG +is also available for Windows users. Follow the +instructions +to verify the package.

          +

          Alternatively, you can verify the checksums on the files. Unix +programs called md5/sha1/sha512 or +md5sum/sha1sum/sha512sum are included in many unix +distributions. *sum is also available as part of GNU +Textutils. Windows users can get binary md5 programs from here, here. fsum supports MD5 and +SHA1.

          +

          We highly recommend to verify the PGP signature, though.

          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/mission.html b/tools/apache-ant-1.8.2/docs/mission.html new file mode 100644 index 000000000..500be78e3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/mission.html @@ -0,0 +1,300 @@ + + + + + + + + + Apache Ant - Apache Ant™ Mission + + + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Apache Ant™ Mission

          +

          + + Board Resolution +

          +

          Apache Ant is a project of the Apache Software Foundation. It + started as a subproject of the Apache Jakarta Project.

          +

          This is the board resolution (from the minutes) + that created the Apache Ant project:

          + 
          +7.D. Resolution [R3] to create the Ant PMC
+
+WHEREAS, the Board of Directors deems it to be in the best
+interests of the Foundation and consistent with the
+Foundation's purpose to establish a Project Management
+Committee charged with the creation and maintenance of
+open-source software related to the Apache Ant build tool, for
+distribution at no charge to the public.
+
+NOW, THEREFORE, BE IT RESOLVED, that a Project Management
+Committee (PMC), to be known as the "Apache Ant PMC", be and
+hereby is established pursuant to Bylaws of the Foundation; and
+be it further
+
+RESOLVED, that the Apache Ant PMC be and hereby is responsible
+for the creation and maintenance of the Ant build system and
+related software components, based on software licensed to the
+Foundation; and be it further
+
+RESOLVED, that the office of "Vice President, Apache Ant" be
+and hereby is created, the person holding such office to serve
+at the direction of the Board of Directors as the chair of the
+Apache Ant PMC, and to have primary responsibility for
+management of the projects within the scope of responsibility
+of the Apache Ant PMC; and be it further
+
+RESOLVED, that the persons listed immediately below be and
+hereby are appointed to serve as the initial members of the
+Apache Ant PMC:
+
+   Bruce Atherton
+   Stephane Bailliez
+   Stefan Bodewig
+   Erik Hatcher
+   Diane Holt
+   Donald Leslie
+   Steve Loughran
+   Conor MacNeill
+   Costin Manolache
+   Sam Ruby
+   Jon Skeet
+   Magesh Umasankar
+   Christoph Wilhelms
+
+NOW, THEREFORE, BE IT FURTHER RESOLVED, that Conor MacNeill be
+and hereby is appointed to the office of Vice President, Apache
+Ant, to serve in accordance with and subject to the direction
+of the Board of Directors and the Bylaws of the Foundation
+until death, resignation, retirement, removal or
+disqualification, or until a successor is appointed; and be it
+further
+
+RESOLVED, that the initial Apache Ant PMC be and hereby is
+tasked with the creation of a set of bylaws intended to
+encourage open development and increased participation in the
+Apache Ant Project.
+
+By Unanimous Vote, Resolution R3 was approved. The Ant PMC is
+hereby created.
+
          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/nightlies.html b/tools/apache-ant-1.8.2/docs/nightlies.html new file mode 100644 index 000000000..9d161ca14 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/nightlies.html @@ -0,0 +1,433 @@ + + + + + + + + + Apache Ant - Nightly+Continuous Builds + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Nightly+Continuous Builds

          +

          + + Nightly Builds +

          +

          We don't provide binary nightly builds at the moment, but if you +want to build Apache Ant from sources, you can use a Subversion snapshot.

          +

          + + Continuous Builds +

          +

          Ant and Ivy are using Continous Integrations systems to improve the development process. +Note that these are no official builds and they are not endorsed or even supported by the Ant team. +But if you have problems with testing the latest (successful) build, you are welcome to post +that on the developer mailinglist. +You can directly access the builds of Ant and Ivy on these CI installations:

          +

          The Apache Software Foundation hosts an +installation of the Hudson CI-system which Ant + Ivy +use.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          TitleDescriptionBuild commandWhenlast buildlast success
          Apache Ant
          Ant Trunk on JDK 1.4current development on the lowest defined JDKbuild.shcontinuouslylast buildlast success
          Ant Trunk Tests on JDK 1.4current development on the lowest defined JDKbuild.sh allclean testcontinuouslylast buildlast success
          Checks Ant POMs by building Ant from the POMs.Checks the POMs by building Ant by Mavenmaven src/etc/poms/pom.xml clean packagecontinuouslylast buildlast success
          Ant NightlyMetric checks of Ant Trunk (Findbugs, RAT, Checkstyle)ant allclean distribution | ant -f check.xml dumphtml findbugs ratcontinuouslylast buildlast success
          Ant JDK-MatrixChecks Ant Trunk against several JDKs (1.4, 1.5, 1.6)ant testcontinuouslylast buildlast success
          Apache Ivy
          Ivy Core Trunkcurrent developmentant clean jarcontinuouslylast buildlast success
          Ivy Core Trunk ChecksMetric checks of Ivy Trunk (Findbugs, RAT, Checkstyle)ant findbugs checkstyle-internal | ant -f build-release.xml ratcontinuouslylast buildlast success
          Apache IvyDE
          IvyDE Trunkcurrent developmentant clean hudson-prepare | ant dist checkstyle ratcontinuouslylast buildlast success
          Eclipse UpdatesiteUpdate your Eclipse installation with the latest Ivy/IvyDEant hudson-prepare | ant hudson-buildcontinuouslylast buildlast success
          +

          JetBrains is offering Ant the service of a Continuous Build on their TeamCity system.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          TitleDescriptionBuild commandWhenlast buildlast success
          Apache Ant
          Core Trunk (Windows)current development (Windows platform)clean testcontinuouslylast buildlast success
          Core Trunk (Linux)current development (Linux platform)clean testcontinuouslylast buildlast success
          Core Trunk (MacOS)current development (MacOS platform)clean testcontinuouslylast buildlast success
          JavaDocJavaDocs for classes and testclassesjavadocs javadocs.testDaily at 08:00 GMT
          (if there are pending changes)          		last buildlast success
          Checkstylecheck the conformance against coding styleguide-f check.xml checkstyle htmlreportcontinuouslylast buildlast success
          Findbugsruns Findbugs against Ant Codebase-f check.xml findbugsDaily at 08:00
          (if there are pending changes)          		last buildlast success
          Distributiona 'distribution' nearly as done while releasingallclean main_distributionDaily at 08:00 GMT
          (if there are pending changes)          		last buildlast success
          Apache Ivy
          Core Trunkcurrent developmentclean-all testcontinuouslylast buildlast success
          Core 2.0.xmaintenance of 2.x releasesclean-all testcontinuouslylast buildlast success
          Core Trunk - Checkstylecheck of code styleguideclean checkstyleDaily at 00:00 GMT + 12:00 GMT
          (if there are pending changes)          		last buildlast success
          Core Trunk - Distributiona 'distribution' nearly as done while releasing.-f build-release.xml snapshot-maven2Daily at 09:00 GMT
          (if there are pending changes)          		last buildlast success
          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/page.css b/tools/apache-ant-1.8.2/docs/page.css new file mode 100644 index 000000000..7ff313b76 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/page.css @@ -0,0 +1,221 @@ +/* + * 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. + * + */ +body { + background-color: #FFFFFF; + color: #000000; + margin: 0px 0px 0px 0px; + font-family: Verdana, Helvetica, sans-serif; + font-size : 90%; +} + +a:link { color: #0F3660; } +a:visited { color: #009999; } +a:active { color: #000066; } +a:hover { color: #000066; } + +.menucontainer { + float: left; + background-color: #4C6C8F; + margin: 0px 5px; + width: 250px; +} + +.menu { + font-size : 90%; + padding: 3px 8px 5px 3px; + border-right: 1px solid #294563; + border-left: 1px solid #294563; +} + +.menu a:link { color: #FFFFFF; text-decoration : none; } +.menu a:visited { color: #FFFFFF; text-decoration : none; } +.menu a:hover { color: #FFCC00; text-decoration : none; } +.menu ul { margin: 0px 0px 0px 20px; padding: 0px; } +.menu li { list-style-image: url('images/label.gif'); font-weight : bold; } +.menu ul ul li .sel { list-style-image: url('images/current.gif'); font-weight : normal; } +.menu ul ul li { list-style-image: url('images/page.gif'); font-weight : normal; } + +.menuheader { + color: #CFDCED; +} + +.sel { + color: #ffcc00; +} + +.tab { font-size : 85%; border: 0; background-color: #294563;} +.tab a:link { text-decoration : none; } +.tab a:visited { text-decoration : none; color: #2A4A6D } +.tab a:hover { color: #000066; } + +table .title { background-color: #FFFFFF; width:100%; border: 0px; } +.dida { font-size: 80%; } + +.pre { white-space: pre;} +.nowrap { white-space: nowrap;} + +.main { + margin-left: 280px; + margin-right: 5px; +} + +.content { + padding: 5px 5px 5px 10px; + font : small Verdana, Helvetica, sans-serif; + font-size : 90%; +} + +.content .ForrestTable { width: 100%; background-color: #7099C5; color: #ffffff; font-size : 90%;} +.content .ForrestTable caption { text-align: left; color: black; font-weight: bold; } +.content .ForrestTable th { text-align: center; } +.content .ForrestTable td { background-color: #f0f0ff; color: black; } + +.content .externals { width: 80%; background-color: #7099C5; color: #ffffff; font-size : 90%;} +.content .externals caption { text-align: left; color: black; font-weight: bold; } +.content .externals th { width: 120px; text-align: right; } +.content .externals td { background-color: #f0f0ff; color: black; } + +.content .ContinuousBuild { width: 90%; background-color: #7099C5; color: #ffffff; font-size : 90%;} +.content .ContinuousBuild caption { text-align: left; color: black; font-weight: bold; } +.content .ContinuousBuild th { width: 120px; } +.content .ContinuousBuild td { background-color: #f0f0ff; color: black; text-align: center; } +.content .ContinuousBuild .title { width: 15%; text-align: left; } +.content .ContinuousBuild .description { width: 30%; font-style: italic; } +.content .ContinuousBuild .command { width: 20%; font-family: "Courier New", Courier, monospace; } +.content .ContinuousBuild .when { width: 25%; } +.content .ContinuousBuild .link { } + + +.frame { margin: 5px 20px 5px 20px; font-size: 90%; } +.frame .content { margin: 0px; } + +.note { border: solid 1px #7099C5; background-color: #f0f0ff; } +.note .label { background-color: #7099C5; color: #ffffff; } + +.warning { border: solid 1px #D00000; background-color: #fff0f0; } +.warning .label { background-color: #D00000; color: #ffffff; } + +.fixme { border: solid 1px #C6C600; background-color: #FAF9C3; } +.fixme .label { background-color: #C6C600; color: #ffffff; } + +.code { border-color: #CFDCED; border-style: solid; border-width: 1px; } +.codefrag { font-family: "Courier New", Courier, monospace; } + +.highlight { background-color: yellow; } + +.minitoc {margin: 5px 5px 5px 40px;} + +.dtdElement { width: 100%; font-size: 90%; background-color : #ffffff; } + +.dtdTag { color: #990000; text-transform : uppercase; font-style : normal; font-size : 120%; font-weight : bold; } + +.section { + font-family: Verdana, Helvetica, sans-serif; + background-color: #294563; + color: #ffffff; + font-weight: bold; + padding: 2px; + margin-top: 20px; + clear: right; +} + +.subsection { + font-family: arial,helvetica,sanserif; + background-color: #4C6C8F; + color: #ffffff; + font-weight: bold; + padding: 2px; + clear: right; +} + +.toc { + font-family: arial,helvetica,sanserif; + background-color: #4C6C8F; + color: #ffffff; + font-weight: bold; + padding: 2px; +} + +.faq { + font-family: arial,helvetica,sanserif; + background-color: #4C6C8F; + color: #ffffff; + font-weight: bold; + padding: 2px; +} + +.navpath { + font-family: arial,helvetica,sanserif; + background-color: #CFDCED; + padding: 2px 6px; + margin: 0px 0px 0px 0px; + font-size: 90%; + border-bottom: 2px solid #4C6C8F; +} + +.title { + font-family: Verdana, Helvetica, sans-serif; +} + +.copyright { + font-family: arial,helvetica,sanserif; + font-size: 90%; + background-color: #CFDCED; + clear: both; + text-align: center; + margin: 0px; + border-top: thin solid #4C6C8F; +} + +.bluebar { + padding: 5px 5px 5px 10px; + background-color: #4C6C8F; + margin: 0px; +} + +.lightbluebar { + padding: 5px 5px 5px 10px; + background-color: #CFDCED; + margin: 0px; + border-top: 1px solid #294563; + border-bottom: 1px solid #294563; +} + +.logobar { + background-color: #294563; + padding-right: 10px; + margin: 0px; +} + +.searchcaption { + color: #FFFFFF; + text-align: left; + font-family: arial,helvetica,sanserif; + font-size: 90%; + background-color: #4C6C8F; + margin: 0px; +} + +@media print { + .menu { + display: none; + } +} + +#adcontainer { +} \ No newline at end of file diff --git a/tools/apache-ant-1.8.2/docs/problems.html b/tools/apache-ant-1.8.2/docs/problems.html new file mode 100644 index 000000000..cc0659611 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/problems.html @@ -0,0 +1,404 @@ + + + + + + + + + Apache Ant - Having Problems? + + + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Having Problems?

          +

          + + Having Problems? +

          +

          + This page details some steps you can take to try and resolve + any problems you may be having with Apache Ant. If you find you can't + resolve the problem, then this page will help you collect some of + the relevant information to provide in a bug report. This information + will help the Ant developers understand and resolve the problem. + Of course, not all the steps here will make sense for every problem + you may encounter - these are just some suggestions to point + you in the right direction. +

          +

          + + Ensure that you are actually running the version of Ant that you think you do +

          +

          Many tools include a version of Ant and some Operating + Systems even install it by default now, so you may have a + version of Ant installed that you haven't been aware of.

          +

          One of the first things to do is to run +

          + ant -version +

          + and +

          + ant -diagnostics +

          + to be sure. Also, we highly recommend that you run Ant with + an empty CLASSPATH. If any other version of Ant can be + loaded from the CLASSPATH, many types of errors may happen + because of incompatible classes being loaded.

          +

          See the FAQ for some examples, but many + other problems are a result of an old version of Ant on your + system as well.

          +

          + + Read the Manual +

          +

          + The first step to take when you have a problem with Ant is to read + the manual entry for the task or + concept that is giving you trouble. In particular, check the + meaning of a task's attributes and nested elements. Perhaps an + attribute is available that would provide the behavior you require. + If you have problems with the manual itself, you can submit a + documentation bug report (see below) to help us improve the Ant + documentation. +

          +

          + + Examine Debug Output +

          +

          + If you're still having a problem, the next step is to try and + gather additional information about what Ant is doing. + Try running Ant with the verbose flag: +

          + ant -verbose +

          + or +

          + ant -v +

          + + This will produce output that starts like the following:

          + + + + +
          + +Ant version 1.4.1 compiled on October 11 2001
          +Buildfile: build.xml
          +Detected Java version: 1.3 in: D:\usr\local\java\jdk13\jre
          +Detected OS: Windows NT
          +parsing buildfile D:\ant\build.xml +with URI = file:D:/ant/build.xml
          +Project base dir set to: D:\ant
          +  [property] Loading Environment env.
          +  [property] Loading D:\ant\conf.properties
          +Build sequence for target 'debug' is [debug]
          +Complete build sequence is [debug, gensrc, compile, jar, test]
          +. . .
          + +
          +

          + You should be able to see from the trace more about what Ant + is doing and why it's taking a particular course of action. + If you need even more information, you can use the + -debug flag rather than + -verbose. + This will generally produce so much + output that you may want to save the output to a file and + analyze it in an editor. You can save the output using the + -logfile <filename> flag, or + using redirection. +

          +

          + Once you have all this debug information, how can you use it + to solve your problem? That will depend on the task in question + and the nature of your problem. Each task logs different aspects + of its operation, but it should give you an idea of what is going + on. For example, the <javac> task logs the + reasons why it + chooses to compile particular class files and not others, along + with which compiler it is using and the arguments it will pass + to that compiler. The following partial trace shows why + <javac> is adding one class file but + skipping another. + This is followed by which compiler it will be using, the + arguments that will get passed to the compiler, + and a list of all the class files to be compiled. +

          + + + + +
          + +[javac] Test.java omitted as D:\classes\Test.class is up to date.
          +[javac] Unset.java added as D:\classes\Unset.class is outdated.
          +[javac] Compiling 1 source file to D:\classes
          +[javac] Using classic compiler
          +[javac] Compilation args: -d D:\classes -classpath D:\classes;
          +D:\jdk118\classes.zip; -sourcepath D:\src\java -g:none
          +[javac] File to be compiled:
          +D:\src\java\Unset.java
          + +
          +

          + In many cases, Ant tasks are wrappers around OS commands or + other Java classes. In debug mode, many of these tasks will + print out the equivalent command line, as the + <javac> task + output does. If you are having a problem, it is often useful to + run the command directly from the command line, in the same way + Ant is running it, and see if the problem occurs from there + as well. The problem may be in the command that is being run, + or it may be in the way the Ant task is running the command. + You can also see the effect of changing attribute values on the + generated command line. This can help you to understand whether + you are using the correct attributes and values. +

          +

          + + Has It Been Fixed? +

          +

          + After examining the debug output, if you still believe that the + problem you are having is caused by Ant, chances are that someone + else may have already encountered this problem, and perhaps it has + been fixed. The next step, therefore, would be to download the + sources of ant, see svn. +

          +

          + Gump + is building ant every night and using the ant built from the + latest source to build a long list of open source projects. However, + the version of ant built by gump is not available for download. Even + if it were, it would not include most of the optional tasks. +

          +

          + We currently do not have nightly builds including the optional tasks. +

          +

          + + bugs +

          +

          If you are convinced that you have identified an unfixed bug, please turn to + our document concerning the bug database.

          + +
          +
          + +

          + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/projects.html b/tools/apache-ant-1.8.2/docs/projects.html new file mode 100644 index 000000000..bd340a350 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/projects.html @@ -0,0 +1,1482 @@ + + + + + + + + + Apache Ant - Related Projects + + + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Related Projects

          +

          + + Related Projects +

          +

          Nothing listed here is directly supported by the Apache Ant + developers, if you encounter any problems with them, please use + the contact information.

          +

          + + AndroMDA +

          +

          AndroMDA is a code generator tool that follows the Model + Driven Architecture (MDA) paradigm. It takes a UML model from + a CASE-tool and generates classes and deployable components + (J2EE or other) specific for your application + architecture.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + 1.4.1 and above +
          + URL: + + http://www.AndroMDA.org/ +
          + Contact: + + project mailing lists +
          + License: + + BSD license +
          +

          + + AntContrib +

          +

          The Ant-Contrib project is a collection of user supplied + task (like an <if> task) and a development + playground for experimental tasks like a C/C++ compilation + task for different compilers.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + 1.4.1 and above +
          + URL: + + http://ant-contrib.sourceforge.net/ +
          + Contact: + + project mailing list +
          + License: + + Apache Software Foundation License +
          +

          + + Antelope +

          +

          A GUI for running Ant and editing build files, can run as + stand-alone or as a plugin to jEdit. In addition to running + targets, Antelope can generate performance statistics and can + trace/display a target's execution path without actually + executing the target.

          +

          Includes several additional tasks: Assert, If/Else, + Try/Catch/Finally, Switch, Variable, Stopwatch, Limit, Math, + Post, SSH, SCP, AntFetch, AntCallBack.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.5 and higher. +
          + URL: + + http://antelope.tigris.org/ +
          + Contact: + + Dale Anson +
          + License: + + Apache Software Foundation License +
          +

          + + AntHill +

          +

          Anthill is a build tool that promotes a controlled build + process by ensuring that every build reflects the source + repository contents and tagging the repository with a unique + build number after every build. Anthill also encourages the + sharing of knowledge within an organization by automatically + updating a project intranet site with artifacts from the + latest build.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + bundles Ant 1.3, is compatible with Ant 1.3 to 1.4.1 +
          + URL: + + http://www.urbancode.com/projects/anthill/ +
          + Contact: + + Maciej Zawadzki +
          + License: + + Mozilla-like license +
          +

          + + Antigen +

          +

          Antigen (Ant Installer Generator) is a tool to take an Ant build script, combine it with a GUI + and wrap it up as an executable jar file. Its main use is for creating graphical, ant-based installers.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + bundles Ant 1.6.2 +
          + URL: + + http://antigen.sourceforge.net/ +
          + Contact: + + Jon Tayler +
          + License: + + Academic Free License +
          +

          + + AntInstaller +

          +

          Builds MSI style installers (with command line option) + using Ant as Back end. UI developed by writing an XML install + descriptor. Runtime launched from scripts or an all inclusive + Jar.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.6.1 others not tested +
          + URL: + + http://antinstaller.sf.net/ +
          + Contact: + + teknopaul@users.sourceforge.net +
          + License: + + LGPL but in the process of of moving to Apache2.0 on request +
          +

          + + Antiplate +

          +

          Antiplate is an ant-script that seeds a project-structure for typical java-projects, + including an ant-buildscript with typical targets like compiling, create distributions, + execute tests etc.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.6 or later +
          + URL: + + Homepage +
          + Contact: + + antiplate@mnementh.de +
          + License: + + Apache License 2.0 +
          +

          + + Antlion +

          +

          The Antlion Project adds value to Ant build scripts by providing + tasks which centralizes the library dependencies, and enables + projects to define dependencies upon other projects.

          +

          External dependencies may be loaded from a custom local + repository or Maven-like remote repositories. Antlion handles + the generation of properties, filesets, and paths.

          +

          Inter-project dependencies allow for building the other + project's files if they aren't already built.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.6 and later +
          + URL: + + http://antlion.sourceforge.net/ +
          + Contact: + + Project mailing list +
          + License: + + Apache License, Version 2.0 +
          +

          + + Ant Script Library +

          +

          The Ant Script Library (ASL) is a collection of re-usable + Ant scripts that can be imported into your own projects. The ASL + provides a number of pre-defined targets that simplify setting up build + scripts for a new project, bringing re-use and consistency to your own + Ant scripts.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.7 or later +
          + URL: + + http://www.exubero.com/asl/ + +
          + Contact: + + Joe Schmetzer +
          + License: + + The Apache Software License 2.0 +
          +

          + + AntShellExt (Ant Shell Extension) +

          +

          The domain is sold and we did not found it any more.

          +

          + + Antworks +

          +

          The antworks project is a set of tools and standardized targets that + greatly simplifies using ant in your project.

          +

          + The driver behind antworks is Importer. Importer is an extension to the + ant import task that will download and + cache an ant build.xml file and it's associated resources called + antlets. Antlets are available for Java compiling + and packaging, JUnit, Forrest, J2EE and + more. +

          +

          + See the Getting Started + guide for more information. +

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + 1.6 and later +
          + URL: + + http://antworks.sourceforge.net/index.html +
          + Contact: + + Antworks Developers mailing lists +
          + License: + + The Apache License 2.0 +
          +

          + + BuildMonkey +

          +

          BuildMonkey is a Web-based automated build dashboard, with upload + capability and google web search. It schedules the running of Ant + build scripts - checking sources out of CM - and makes the results + available centrally.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.5.4 or later +
          + URL: + + http://www.buildmonkey.com/ +
          + Contact: + + jb@buildmonkey.com +
          + License: + + Freeware, commercial/support licences available +
          +

          + + CruiseControl +

          +

          CruiseControl is a tool for setting up a continuous build + process. CruiseControl provides an Ant wrapper and a set of + tasks to automate the checkout/build/test cycle. CruiseControl + also comes bundled with a servlet for viewing the status of + the current build, as well as previous build results.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.2 and higher +
          + URL: + + http://cruisecontrol.sourceforge.net/ +
          + Contact: + + Project Mailing Lists and Administrators +
          + License: + + Release 1.0 has been licensed under the GNU General Public + License. Starting with release 1.1 the license has been + changed to a BSD-like license. +
          +

          + + Flaka +

          +

          The goal of Flaka is to simplify writing build scripts using +

            +
          • Regular control structures (when, for, switch, ..)
            • +
          • Exception handling
            • +
          • An Expression Language which in turn provdes: +
              +
            • access to underlying data objects
              • +
            • untyped variables in addition to Ant properties
              • +
            • powerfull expressions like cond ? then : else
              • +
            +
            • +
          + Checkout the manual's overview chapter about the feature Flaka provides. Have especially a look at the section describing the expression language. +

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.7 and higher +
          + URL: + + http://workbench.haefelinger.it/flaka/ +
          + Contact: + + Contact Project Lead +
          + License: + + Apache License v.20 +
          +

          + + Invicta +

          +

          Invicta is a build management tool. Using simple project definition files, + it generates powerful build scripts (such as ANT) while hiding their + complexity. Invicta is a modular framework that allows developing additional + components and output types.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.5 and higher +
          + URL: + + http://invicta.sf.net/ +
          + Contact: + + Project Mailing Lists and Administrators +
          + License: + + LGPL. +
          +

          + + JAM - JavaGen Ant Modules +

          +

          JAM is a modular Ant toolkit for developing and testing Java/J2EE + applications. JAM supports EJB and Servlet/JSP development using XDoclet, + JUnit, Cactus, Maven, Castor and MDA/UML code generation on various J2EE + servers including JBoss.

          +

          From JAMs website: NOTICE: As of June 2006 JAM is no longer supported. + We recommend Maven 2 Tasks for Ant as a replacement.

          + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.6 +
          + URL: + + http://www.javagen.com/jam/ +
          + License: + + GPL +
          +

          + + Krysalis Centipede +

          +

          The Centipede admin told us, that that project + "is no more" and that "Antworks has taken it place." +

          +

          + + Leafcutter +

          +

          Leafcutter is an API which allows you to execute Ant tasks from Java code.
          + Leafcutter is useful as:

            +
          • A way of integrating Ant tasks into existing Java programs.
            • +
          • A wholesale alternative to standard Ant for process automation.
            • +
          +

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + unknown +
          + URL: + + https://leafcutter.dev.java.net/ +
          + Contact: + + Discussion Forum +
          + License: + + Apache Software Foundation License +
          +

          + + luntbuild +

          +

          Luntbuild is an open source build automation and management + tool based on Apache Ant. Builds are setup through concepts of + projects, views, schedules, modules, etc. All configurations + and monitoring tasks is performed from a clean web + interface. It supports schedules builds, force builds, + rebuilds, clean build, increment build, etc.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.x +
          + URL: + + http://luntbuild.javaforge.com/ +
          + Contact: + + luntbuild project page +
          + License: + + Opensource +
          +

          + + NAnt +

          +

          NAnt is a .NET based build tool. In theory it is kind of + like make without make's wrinkles. In practice it's a lot like + Ant.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + compatible in spirit. +
          + URL: + + http://nant.sourceforge.net/ +
          + Contact: + + project mailing list +
          + License: + + GNU General Public License +
          +

          + + Parabuild +

          +

          Parabuild is an automated multiplatform build management server. + Parabuild helps software teams and organizations of all sizes reduce + risks of project failures and increase productivity by providing provides + automatic continuous integration builds and stable scheduled builds.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.3 and later +
          + URL: + + http://www.viewtier.com/products/parabuild.htm +
          + Contact: + + http://www.viewtier.com/about_us.htm +
          + License: + + Commercial +
          +

          + + Rant +

          +

          Rant stands for Remote Ant. It is a distributed build + system that allows an Ant build file to launch builds on other + systems and receive exceptions should they occur.

          +

          Note: As the Sourceforge project site + shows, the last update was on Feb 09 2002. (jhm)

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.4 +
          + URL: + + http://remoteant.sourceforge.net/ +
          + Contact: + + Chris Nelson +
          + License: + + MIT License +
          +

          + + Savant +

          +

          Savant is a build and dependency management tool written in Java. Savant can be used in + two different ways:

            +
          • As a stand-alone build tool that wraps Apache Ant and provides a number of cool new + features such as plugins that are versioned and downloadable
            • +
          • As a set of tasks which can be used within Apache Ant build files
            • +

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Unknown. There is a distro, which ships Ant 1.7.1 +
          + URL: + + http://code.google.com/p/savant-build/ +
          + Contact: + + Bugtracking system +
          + License: + + ASF 2.0 +
          +

          + + WebTest +

          +

          WebTest is a free open source tool for automated testing of web applications. + It is a set of powerful Ant tasks allowing to call web pages, mimic user actions + (clicking links, filling forms, ...) and verify the results. + The generated reports give comprehensive information on success and failure of the test steps.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.6.5 +
          + URL: + + http://webtest.canoo.com/ +
          + Contact: + + project mailing list +
          + License: + + Apache like license +
          +

          + + XML Publication +

          +

          XML Publication is a set of tools to generate Web pages + from desktop documents or other structured documents using + XSLT and Ant.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.4 +
          + URL: + + http://wwbota.free.fr/XMLPublication/ +
          + Contact: + + Jean-Marc Vanel +
          + License: + + GNU General Public License. +
          +

          + + yEd +

          +

          yEd is a freeware multi-purpose graph and diagram editor + that runs on the Java 2 platform. It provides an import filter + for Ant build scripts that makes it possible to conveniently + display and browse the dependencies between the different targets + of the build file. This is especially useful for debugging and + understanding large build files.

          + + + + + + + + + + + + + + + + + +
          + Compatibility: + + Ant 1.x +
          + URL: + + http://www.yworks.com/products/yed/ +
          + Contact: + + yWorks Support +
          + License: + + Freeware +
          + +
          +
          + +

          + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/projects/index.html b/tools/apache-ant-1.8.2/docs/projects/index.html new file mode 100644 index 000000000..667c91ad8 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/projects/index.html @@ -0,0 +1,205 @@ + + + + + + + + + Apache Ant - Welcome + + + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Welcome

          +

          + + Welcome to the Apache Ant™ Projects Area +

          +

          This is where the Apache Ant sub-projects live!

          +

          Now, that Apache Ant has become an Apache Top-Level Project it is time to make space on this + Web-Page for Ant sub-projects.

          +

          To make sure you do not miss anything: Stay tuned and visit this page from time to time :)! +

          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/projects/ivy.html b/tools/apache-ant-1.8.2/docs/projects/ivy.html new file mode 100644 index 000000000..fed1f1e8d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/projects/ivy.html @@ -0,0 +1,202 @@ + + + + + + + + + Apache Ant - The Apache Ivy Subproject + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          The Apache Ivy Subproject

          +

          + + The Apache Ivy™ Subproject +

          +

          Apache Ivy

          +

          Apache Ivy is a simple yet powerful dependency manager featuring continuous integration, + dependencies of dependencies management, multiple repositories including ibiblio and + high performance (use of a local cache).

          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/projects/ivyde.html b/tools/apache-ant-1.8.2/docs/projects/ivyde.html new file mode 100644 index 000000000..22daa40ba --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/projects/ivyde.html @@ -0,0 +1,205 @@ + + + + + + + + + Apache Ant - The Apache IvyDE Subproject + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          The Apache IvyDE Subproject

          +

          + + The Apache IvyDE™ Subproject +

          +

          Apache IvyDE

          +
            Apache IvyDE is the Eclipse plugin which intergrates Apache Ivy into your java development enviromnent. It includes: +
          • an Ivy xml files editor: creation wizard, html preview and completion for Ivy xml tag, attributes but also attributes' values.
            • +
          • an Ivy settings files editor: completion for xml tag, attributes but also attributes' values.
            • +
          • a classpath container: automatic downloads, access "resolve" task from your IDE, and resolve in Eclipse's workspace
            • +
          • an Ivy console: presents every log from Ivy, really helpful to debug a failing resolve
            • +
          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/resources.html b/tools/apache-ant-1.8.2/docs/resources.html new file mode 100644 index 000000000..c3b8aff74 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/resources.html @@ -0,0 +1,1480 @@ + + + + + + + + + Apache Ant - Resources + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          Resources

          +

          + + FAQs +

          +

          + + At Apache Ant™'s website +

          +

          Starting with the release of Apache Ant 1.4 the Ant's FAQ is + bundled with the distribution, the most recent version can + always be found at the website.

          + + + + + +
          + FAQ: + + http://ant.apache.org/faq.html +
          +

          + + jGuru +

          +

          jGuru hosts an interactive Ant discussion forum and FAQ system

          + + + + + + + + + +
          + Forum: + + http://www.jguru.com/forums/home.jsp?topic=Ant +
          + FAQ: + + http://www.jguru.com/faq/home.jsp?topic=Ant +
          +

          + + FAQ about Borland Application Server tasks +

          +

          Benoit Moussaud, the original author of the Borland + Application Server specific EJB tasks has put + together a FAQ for this specific subtask.

          + + + + + +
          + FAQ: + + http://www.moussaud.org/ejbjar.html +
          +

          + + WIKIs +

          +

          + + Apache +

          +

          The ASF provides a Wiki farm for Apache projects.

          + + + + + + + + + +
          + Main page: + + Apache Wiki Farm +
          + Ant Wiki: + + Ant Wiki +
          +

          + + Books +

          +

          The most recent books come first

          +

          + + Ant in Action +

          +

          Published April/May 2007, and covering Ant 1.7.

          +

          This is a major rewrite of the first edition; still 600 pages long. +

          +

          + This book moves up from Ant1.5 to Java1.5 and 1.7, with a near-complete + rewrite of the applied-ant section, covering new topics such as + antlibs, repository management with Ivy, Xml Schema validation, + EJB3.0/Java EE development and advanced deployment using SmartFrog. + The ant coding section looks at AntUnit, antlib authoring and + scripting languages, while the beginners chapters, the first third + of the book, still shows developers how to build, test, package and + redistribute a Java application. +

          +

          + If you are one of the 20,000+ owners of the first edition, it is now + obsolete. Sorry :) +

          + + + + + + + + + + + + + + + + + + +
          + Author: + + Steve Loughran and Erik Hatcher +
          + Publisher URL: + + + + http://www.manning.com/loughran/ + + +
          + Book URL + + + + http://antbook.org/ + + +
          + Source code repository + + + + http://sourceforge.net/projects/antbook + + +
          ISBN:193239480X
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Ant: The Definitive Guide, 2nd edition +

          +

          Published April 2005, and covers Ant release 1.6.1.

          +

          This is a complete rewrite of the first edition; this book is + now 290 pages and so covers Ant in more depth than its predecessor. +

          +

          It also mixes reference information (tables) with text explanation + on how to use the tasks. Contents includes JUnit, CVS, execution, basic + deployment, Web application development and XDoclet. There is also coverage + of XDoclet, and a chapter on how to extend Ant in Java.

          + + + + + + + + + + +
          + Author: + + Steve Holzner +
          + URL: + + + http://www.oreilly.com/catalog/anttdg2/ + +
          ISBN:0596006098
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Pragmatic Project Automation +

          +

          + + How to Build, Deploy, and Monitor Java Applications. + Published: July 2004 ISBN: 0-9745140-3-9 +

          +

          + This is not a reference guide to Ant, but a book on how to automate the build process. + The core build, continuous integration, reporting and release management + are all covered. Ant is of course central to this. This is a fun read! +

          + + + + + + + + + + +
          + Author: + + Mike Clark +
          + URL: + + + http://www.pragmaticprogrammer.com/sk/auto// + +
          ISBN:0974514039
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Extreme Programming with Ant +

          +

          This book shows how to implement an XP project using Ant 1.5.3, and many other 3rd party tools. Covers:

          +
            +
          • The fundamentals of Ant: concepts, core and optional tasks
            • +
          • How to write custom Ant components, including custom Tasks, Loggers, Listeners, Input Handlers, Selectors, Filters, Mappers and Data Types
            • +
          • Mitigating risks by creating spike tests with Ant buildfiles
            • +
          • Add CVS version control and testing with JUnit
            • +
          • Automate nightly builds and reporting
            • +
          • Deploy applications dynamically using XDoclet
            • +
          • Enforcing Code Standards with Jalopy, PMD, CheckStyle, iContract, JDepend
            • +
          • Using Remote Ant (Rant) and CruiseControl
            • +
          • Generating project documentation
            • +
          • Adapting an XP process for use by other teams or across an enterprise
            • +
          • Custom Task examples to generating UML diagrams, creating reports and metrics on-the-fly
            • +
          • Follows a case-study of a team that implements an XP Project
            • +
          + + + + + + + + + + +
          + Authors: + + Glenn Niemeyer and Jeremy Poteet +
          + URL: + + http://www.sams.com/catalog/product.asp?product_id=%7BFB825A48-BC04-4C55-BD8C-DF93C6BBF920%7D +
          ISBN:0672325624
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Ant. Das Java-Build-Tool in der Praxis +

          +

          A German language book on Ant that covers Ant 1.5. + This is the original description:

          + 
          +        Das Build-Tool Ant ist das Open-Source-Werkzeug, das den Entwicklungsprozess einer Java-
+        oder J2EE-Anwendung wesentlich vereinfacht. Gesteuert durch XML-basierte Skripte f�hrt es
+        nahezu alle Aufgaben aus, die nach dem Kodieren einer Anwendung anfallen.
          +

          Some topics:

          +
            +
          • creating archives (zip, jar)
            • +
          • call the java compiler
            • +
          • edit property files
            • +
          • file operation
            • +
          • source code control systems
            • +
          +

          The book is available in English as "Ant: The Java Build Tool in Practice"

          + + + + + + + + + + +
          + Authors: + + Bernd Matzke +
          + URL: + + http://www.addison-wesley.de/main/main.asp?page=home/bookdetails&ProductID=13459 +
          ISBN:3827320666
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Java Development with Ant +

          +

          Published 2002. This book covers Ant 1.5, including:

          +
            +
          • The new Ant 1.5 features
            • +
          • Ant's datatypes and property handling
            • +
          • JUnit testing and reporting
            • +
          • Continuous integration techniques
            • +
          • XDoclet for attribute-oriented programming
            • +
          • EJB generation, building, and packaging
            • +
          • Writing and testing native code
            • +
          • Building Web Services with Apache Axis
            • +
          • Deploying your system to multiple remote servers
            • +
          • Using and writing +
              +
            • Loggers
              • +
            • Listeners
              • +
            • Selectors
              • +
            • Custom tasks
              • +
            +
            • +
          +

          Also available in Korean and German editions

          + + + + + + + + + + +
          + Authors: + + Erik Hatcher and Steve Loughran +
          + URL: + + http://www.manning.com/antbook/ +
          ISBN:1930110588
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Ant: The Definitive Guide, 1st edition +

          +

          Published 2002, Covers Ant release 1.4.1.

          + + + + + + + + + + +
          + Authors: + + Jesse E. Tilly and Eric M. Burke +
          + URL: + + http://www.oreilly.com/catalog/anttdg/ +
          ISBN:0596001843
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Ant. Kurz und Gut. +

          +

          A German language short reference for Ant that covers Ant + 1.4. This is the original description:

          + 
          +  Ant kurz & gut enthält eine vollständige Referenz der Built-in Tasks
+  und ihrer jeweiligen Attribute sowie kurze Beispiele für ihre Verwendung.
+  Daneben bietet das Buch eine knappe Einführung in die Arbeit mit Ant und
+  eine Erläuterung der Ant-Basiselemente (Projekte, Properties, Targets und Tasks).
+  Behandelt werden außerdem grundlegende Konzepte wie Filesets, Patternsets und
+  Pfadstrukturen, das Schreiben eigener Tasks, die Aufruf-Syntax und Optional Tasks.
          + + + + + + + + + + +
          + Author: + + Stefan Edlich +
          + URL: + + http://www.amazon.de/exec/obidos/ASIN/3897212412/ +
          ISBN:3897212412
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Java Tools for eXtreme Programming +

          +

          This book covers the following XP subjects:

          +
            +
          • Automated unit and functional testing
            • +
          • Continuous integration through build and deployment automation
            • +
          • The value of refactoring and continuous integration
            • +
          • How Ant, JUnit, JUnitPerf, Cactus, HTTPUnit, and JMeter + can be used to achieve the goals of the XP methodology
            • +
          + + + + + + + + + + +
          + Authors: + + Richard Hightower and Nicholas Lesiecki +
          + URL: + + http://www.wiley.com/cda/product/0,,047120708X,00.html +
          ISBN:047120708X
          +

          Available from:
          + Amazon.com + | Barnes & Noble + | Book Sense + | Powells.com +

          +

          + + Articles and Presentations +

          +

          The following sections list articles and presentations + written about Apache Ant. If you've written something that + should be included, please post it to one of the mailing + lists.

          +

          + + Articles +

          +

          + + Ant + DocBook HOWTO +

          +

          Pure Java DocBook Systems, including Ant Integration

          +

          The DocBook team documents how to use "make" for DocBook. + This HOWTO document is an attempt to cover the neglected case of using + DocBook for pure Java projects.

          + + + + + + + + + +
          + Author: + + Blaine Simpson +
          + URL: + + http://pub.admc.com/howtos/ant-docbook-howto/ +
          +

          + + Extending Ant Input Abilities +

          +

          The contents of this document is the following:

            +
          • Section 2 provides a simple example how InputHandlers are created,
            • +
          • Section 3 develops an inputhandler that masks the passwords typed on the command line,
            • +
          • Section 4 gives two handlers, whose input is typed in graphical components,
            • +
          • Section 5 extends Input task so that we can use dierent input handlers on different uses of <input>,
            • +
          • Section 6 describes a problem found while writing this document,
            • +
          • Section 7 summarizes some dark corners the author do not understand.
            • +

          + + + + + + + + + +
          + Author: + + Ivan Ivanov +
          + URL: + + https://sourceforge.net/project/showfiles.php?group_id=103509 (Download ZIP+PDF from Sourceforge) +
          +

          + + Keep the Ant, Hold the XML +

          +

          Key G. Gauthier talks about writing "buildfiles" in Java.

          + + + + + + + + + +
          + Author: + + Key G. Gauthier +
          + URL: + + http://www.ftponline.com/javapro/2004_06/magazine/features/kgauthier/ +
          +

          + + Ant 1.6 for Task Writers +

          +

          This article talks about XML namespace handling, Ant + libraries and the newly introduced type polymorphism.

          + + + + + + + + + +
          + Author: + + Stefan Bodewig +
          + URL: + + http://otn.oracle.com/pub/articles/bodewig_taskwriters.html +
          +

          + + Managing Build Complexity with Apache Ant 1.6 +

          +

          As Apache Ant is applied to increasingly difficult tasks, + its users are creating more complex and less legible build + files. This is due, in part, to the limited tools for + decomposition and code reuse within previous versions of + Ant.

          + + + + + + + + + +
          + Author: + + Geoffrey Wiseman +
          + URL: + + http://www.sys-con.com/story/?storyid=45078&DE=1 +
          +

          + + New Ant 1.6 Features for Big Projects +

          +

          This article describes the <macrodef>, <import> + and <subant> tasks in detail and shows how they help in + building bigger systems.

          + + + + + + + + + +
          + Author: + + Stefan Bodewig +
          + URL: + + http://otn.oracle.com/pub/articles/bodewig_ant1.6.html +
          +

          + + Programmieren für Ant +

          +

          This article describes the main topics of programming your own tasks. + Description is done on five examples.

          +

          This article is written in German and published in + Java-Spektrum + 5/2004.

          + + + + + + + + + +
          + Author: + + Bernd Matzke +
          + URL: + + http://www.sigs-datacom.de/sd/news/document?PID=216 +
          +

          + + Ant in Anger: Using Ant in a Production Development System +

          +

          This document describes strategies and some basic examples of how to + use Ant in larger team development projects.

          + + + + + + + + + +
          + Author: + + Steve Loughran +
          + URL: + + http://ant.apache.org/ant_in_anger.html +
          +

          + + Ant Task Guidelines +

          +

          This document describes how to write custom Ant tasks, and how to submit + them to potentially be included in Ant.

          + + + + + + + + + +
          + Author: + + Steve Loughran +
          + URL: + + http://ant.apache.org/ant_task_guidelines.html +
          +

          + + Build a Better Robot with Ant +

          +

          This article describes the gory details of writing custom + Ant tasks.

          + + + + + + + + + +
          + Author: + + Erik Hatcher +
          + URL: + + http://www.fawcette.com/javapro/2003_02/magazine/features/ehatcher/l +
          +

          + + Automating the build and test process +

          +

          This article demonstrates an approach to the automated build and test process. Working with Ant 1.3 and the JUnit test framework, it shows how to automate a process that captures pertinent information about each test suite run, generates an attractive report, and e-mails the report.

          + + + + + + + + + +
          + Author: + + Erik Hatcher +
          + URL: + + http://www.ibm.com/developerworks/java/library/j-junitmail/ +
          +

          + + Incremental development with Ant and JUnit +

          +

          This article explores the benefits of unit testing with Ant and + JUnit, detailing how to develop automated unit tests and integrate them + into your build process.

          + + + + + + + + + +
          + Author: + + Malcolm Davis +
          + URL: + + http://www-106.ibm.com/developerworks/library/j-ant/?dwzone=java +
          +

          + + Automate your build process using Java and Ant +

          +

          This article provides an introduction to using Ant with some basic + examples and by highlighting some of the important tasks.

          + + + + + + + + + +
          + Author: + + Michael Cymerman +
          + URL: + + http://www.javaworld.com/javaworld/jw-10-2000/jw-1020-ant.html +
          +

          + + Short tutorial in Cactus' (formerly J2EEUnit) documentation +

          +

          There is a short tutorial on how to use Ant in Cactus' + documentation. It has a slant towards build files that will be used + with Cactus.

          + + + + + + + + + +
          + Author: + + Cactus development team +
          + URL: + + http://jakarta.apache.org/cactus/howto_ant_primer.html +
          +

          + + Developing custom Ant tasks with VisualAge for Java +

          +

          This article outlines how to integrate Ant into VisualAge for Java, + and how to write and debug custom tasks using the IDE and the + integrated debugger.

          + + + + + + + + + +
          + Author: + + Glenn McAllister +
          + URL: + + http://www7.software.ibm.com/vad.nsf/data/document2366?OpenDocument&p=1&BCT=1&Footer=1 +
          +

          + + Automated builds with VisualAge for Java and Ant +

          +

          This article shows how you can perform command line builds with a + VisualAge for Java repository.

          + + + + + + + + + +
          + Author: + + Glenn McAllister +
          + URL: + + http://www7.software.ibm.com/vad.nsf/Data/Document4366?OpenDocument&p=1&BCT=3&Footer=1 +
          +

          + + Ant: A Build Tool from the Jakarta Project +

          +

          This article is from the "Best Practices" section of + Sun's Dot-Com Builder Site.

          + + + + + + + + + +
          + Author: + + Laura Geele Wang +
          + URL: + + http://dcb.sun.com/practices/profiles/ant.jsp +
          +

          + + Making a Mountain Out of an Anthill +

          +

          This article is from the June 2001 issue of the Java Developer' + Journal. You need to be a registered JDJ subscriber to view this + article.

          + + + + + + + + + +
          + Author: + + Neal Ford +
          + URL: + + http://www.sys-con.com/java/archivesa.cfm?volume=06&issue=06 +
          +

          + + Using Ant and Weblogic EJBs +

          +

          This article describes how to use Ant to create Weblogic EJBs, and + some workarounds for issues you may encounter.

          + + + + + + + + + +
          + Author: + + Jesse E. Tilly +
          + URL: + + http://www.onjava.com/pub/a/onjava/2001/06/25/antejb.html +
          +

          + + Using JavaScript with Ant +

          +

          A tutorial about using JavaScript and XSLT with Ant.

          + + + + + + + + + +
          + Author: + + Dylan Schiemann +
          + URL: + + http://www.sitepen.com/ant/javascript.html +
          +

          + + Building with Ant +

          +

          Series of articles that describe a framework for web + application development based on Ant and JUnit.

          + + + + + + + + + +
          + Author: + + Alex Chaffee +
          + URL: + + Introduction: http://softwaredev.earthweb.com/sdtech/article/0,,12065_989631,00.html
          + Directory Structure: http://softwaredev.earthweb.com/sdtech/article/0,,12082_994991,00.html
          + Deployment and Distribution: http://softwaredev.earthweb.com/sdtech/article/0,,12077_998241,00.html +
          +

          + + Developing with JAXB and Ant +

          +

          Series of articles that shows how to use Ant together with + the Java API for XML Binding (JAXB).

          + + + + + + + + + +
          + Author: + + Joseph Shelby +
          + URL: + + http://www.onjava.com/pub/a/onjava/2002/03/06/jaxant1.html
          + http://www.onjava.com/pub/a/onjava/2002/03/13/jaxbant2.html +
          +

          + + Presentations +

          +

          + + Ant Build Tool +

          +

          A PowerPoint presentation on Ant 1.2. It provides a basic overview + of Ant's capabilities.

          + + + + + + + + + +
          + Author: + + Patrick Chanezon +
          + URL: + + http://people.netscape.com/chanezon/tech/ant/ant_preso.ppt +
          +

          + + Ant +

          +

          A detailed Ant 1.3 PowerPoint presentation, made at the St. Louis Java Users Group + meeting in March 2001. Includes a detailed build file and basic + descriptions of all the built in and optional tasks. Updated for Ant 1.4 in October 2001. + Available in PDF format now.

          + + + + + + + + + +
          + Author: + + Mark Volkmann +
          + URL: + + http://www.ociweb.com/jnb/files/Ant.pdf +
          + +
          +
          + +

          + Apache Ant, Apache Ivy, Ant, Ivy, Apache, the Apache feather logo, and the Apache Ant project logos are trademarks of The Apache Software Foundation. + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/slides/extending_ant.odp b/tools/apache-ant-1.8.2/docs/slides/extending_ant.odp new file mode 100644 index 000000000..278ba7c72 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/slides/extending_ant.odp differ diff --git a/tools/apache-ant-1.8.2/docs/svn.html b/tools/apache-ant-1.8.2/docs/svn.html new file mode 100644 index 000000000..d66c43cb3 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/svn.html @@ -0,0 +1,267 @@ + + + + + + + + + Apache Ant - SVN Repositories + + + + + + +

          + +

          + +
          + + + + + + +
          Apache Ant siteApache Ant logo +
          + + + + + + + + + + + + + + +
          + + + + +
          + the Apache Ant site +
          +
          +
          +
          + +
          + + + + + +
          + + + + +
          Home
          +           		+ + + + +
          Projects
          +
          +
          + +
          + +
          +
          + +
          +
          + ApacheCon - logo +
          + + +
          +
           
          +
          +
          +

          SVN Repositories

          +

          + + Access the Source Tree (Subversion) +

          +

          Anyone can checkout source code from our public Subversion repository. To do so, + simply use the following command (if you are using a GUI client, configure it + appropriately):

          + 
          +svn co http://svn.apache.org/repos/asf/ant/[project]/trunk/ ant-[project]
          +

          Modules available for access are:

          +
            +
          • ant - The "main" Ant module.
            + http://svn.apache.org/repos/asf/ant/core/trunk/ +
            • +
          • Ivy - The "main" Ivy module.
            + http://svn.apache.org/repos/asf/ant/ivy/core/trunk/ +
            • +
          • IvyDE + - Eclipse Plugin for Ivy.
            + http://svn.apache.org/repos/asf/ant/ivy/ivyde/trunk/ +
            • +
          • antunit Test framework for Ant.
            + http://svn.apache.org/repos/asf/ant/antlibs/antunit/trunk/
            • +
          • Dotnet antlib Contains Nant, Nunit, ...
            + http://svn.apache.org/repos/asf/ant/antlibs/dotnet/trunk/
            • +
          • svn antlib Contains tasks to interact with Subversion repositories.
            + http://svn.apache.org/repos/asf/ant/antlibs/svn/trunk/
            • +
          • sandbox - New developments. Contains currently gendoc.
            + http://svn.apache.org/repos/asf/ant/sandbox/ +
            • +
          +

          If you are not familiar with Subversion, Jakarta's + source repositories page may hold many helpful hints.

          +

          Nightly snapshots of the SVN tree are available at + http://svn.apache.org/snapshots/ant/.

          +

          A nice view of the source history is available through + Cenqua's Fisheye instance.

          + +
          +
          + +

          + +

          + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/.htaccess b/tools/apache-ant-1.8.2/docs/webtest/gettest/.htaccess new file mode 100644 index 000000000..262439ff9 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/.htaccess @@ -0,0 +1,10 @@ +Redirect seeother /webtest/gettest/other.txt /webtest/gettest/testother.txt +Redirect temp /webtest/gettest/temp.txt /webtest/gettest/testtemp.txt +Redirect permanent /webtest/gettest/permanent.txt /webtest/gettest/testperm.txt +Redirect /webtest/gettest/infinite.txt /webtest/gettest/infinite2.txt +Redirect /webtest/gettest/infinite2.txt /webtest/gettest/infinite.txt +Redirect /webtest/gettest/redir5.txt /webtest/gettest/redir5-1.txt +Redirect /webtest/gettest/redir5-1.txt /webtest/gettest/redir5-2.txt +Redirect /webtest/gettest/redir5-2.txt /webtest/gettest/redir5-3.txt +Redirect /webtest/gettest/redir5-3.txt /webtest/gettest/redir5-4.txt +Redirect /webtest/gettest/redir5-4.txt /webtest/gettest/testredir5.txt diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/local.cgi b/tools/apache-ant-1.8.2/docs/webtest/gettest/local.cgi new file mode 100644 index 000000000..2e34db214 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/local.cgi @@ -0,0 +1,19 @@ +#!/bin/sh + +# 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. + +echo "Location: testlocal.txt" +echo diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/testlocal.txt b/tools/apache-ant-1.8.2/docs/webtest/gettest/testlocal.txt new file mode 100644 index 000000000..c8420ac95 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/testlocal.txt @@ -0,0 +1 @@ +local redirect succeeded diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/testother.txt b/tools/apache-ant-1.8.2/docs/webtest/gettest/testother.txt new file mode 100644 index 000000000..0387eb0a4 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/testother.txt @@ -0,0 +1 @@ +seeother redirect succeeded diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/testperm.txt b/tools/apache-ant-1.8.2/docs/webtest/gettest/testperm.txt new file mode 100644 index 000000000..d16174652 --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/testperm.txt @@ -0,0 +1 @@ +permanent redirect succeeded diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/testredir5.txt b/tools/apache-ant-1.8.2/docs/webtest/gettest/testredir5.txt new file mode 100644 index 000000000..507b4390d --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/testredir5.txt @@ -0,0 +1 @@ +5 levels of redirect succeeded diff --git a/tools/apache-ant-1.8.2/docs/webtest/gettest/testtemp.txt b/tools/apache-ant-1.8.2/docs/webtest/gettest/testtemp.txt new file mode 100644 index 000000000..d036b86fe --- /dev/null +++ b/tools/apache-ant-1.8.2/docs/webtest/gettest/testtemp.txt @@ -0,0 +1 @@ +temporary redirect succeeded diff --git a/tools/apache-ant-1.8.2/docs/webtest/testkeystore b/tools/apache-ant-1.8.2/docs/webtest/testkeystore new file mode 100644 index 000000000..2fd22c9f4 Binary files /dev/null and b/tools/apache-ant-1.8.2/docs/webtest/testkeystore differ diff --git a/tools/apache-ant-1.8.2/etc/ant-bootstrap.jar b/tools/apache-ant-1.8.2/etc/ant-bootstrap.jar new file mode 100644 index 000000000..2c6a6b451 Binary files /dev/null and b/tools/apache-ant-1.8.2/etc/ant-bootstrap.jar differ diff --git a/tools/apache-ant-1.8.2/etc/changelog.xsl b/tools/apache-ant-1.8.2/etc/changelog.xsl new file mode 100644 index 000000000..c6aef8fde --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/changelog.xsl @@ -0,0 +1,148 @@ + + + + + + + + + + + + + + + + + + + + + + + <xsl:value-of select="$title"/> + + + +

          + +

          +

          Designed for use with Apache Ant.

          +
          + + + + + + + +
          + + + +           + + + + + + + + + + 
          +
          +
            + +
          + + +           + + + + + + + + + + + + + mailto: + + + + + +
        9. + + + + /?rev=&content-type=text/x-cvsweb-markup + + + /?r1=&r2= + + + () +
          10. + + + + + + + + diff --git a/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-frames.xsl b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-frames.xsl new file mode 100644 index 000000000..c79c0b7b1 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-frames.xsl @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CheckStyle Audit + + + + + + + <h2>Frame Alert</h2> + <p> + This document is designed to be viewed using the frames feature. + If you see this message, you are using a non-frame-capable web client. + </p> + + + + + + + + + + + + +

          CheckStyle Audit

          Designed for use with + CheckStyle and + Ant.
          +
          +           + + + + + + + + + + + + +
          + + + + + +           + + + .bannercell { + border: 0px; + padding: 0px; + } + body { + margin-left: 10; + margin-right: 10; + font:normal 80% arial,helvetica,sanserif; + background-color:#FFFFFF; + color:#000000; + } + .oddrow td { + background: #efefef; + } + .evenrow td { + background: #fff; + } + th, td { + text-align: left; + vertical-align: top; + } + th { + font-weight:bold; + background: #ccc; + color: black; + } + table, th, td { + font-size:100%; + border: none + } + table.log tr td, tr th { + + } + h2 { + font-weight:bold; + font-size:140%; + margin-bottom: 5; + } + h3 { + font-size:100%; + font-weight:bold; + background: #525D76; + color: white; + text-decoration: none; + padding: 5px; + margin-right: 2px; + margin-left: 2px; + margin-bottom: 0; + } + + + + + + + + + +

          Files

          +

          + + + + + +
          +

          + + +           + + +

          Files

          + + + + + + + + +
          NameErrors
          +           + + + + + + + + files/.html + + + + + + + + + + + + + + files/.html + + + + + + + + + + + + + + + + + ../ + + + + + + ../ + + + + + + + + + stylesheet.css + + + + +

          File

          + + + + + + + + + + + + +
          Error DescriptionLine:Column
          :
          + + +           +           + + +

          Summary

          + + + + + + + + + + + + + + + +
          Total FilesFiles With ErrorsErrors
          +           + + + + oddrow + evenrow + + +           \ No newline at end of file diff --git a/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-text.xsl b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-text.xsl new file mode 100644 index 000000000..7359e4160 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-text.xsl @@ -0,0 +1,34 @@ + + + + + + + + + + + : + + : + + + + + + diff --git a/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-xdoc.xsl b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-xdoc.xsl new file mode 100644 index 000000000..5fc6eab38 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/checkstyle/checkstyle-xdoc.xsl @@ -0,0 +1,130 @@ + + + + + + + + + + + + + + + Checkstyle Audit + + + + + + + + + + + + +
          + + + + + + + + +
          NameErrors
          +
          +           + + + + + + + + files.html + + + + + + + + + + + + + Checkstyle Audit + + + +
          + + + + + + + + + + + + +
          Error DescriptionLine
          +
          + +           +           +           + + +
          + + + + + + + + + + + + + + + +
          FilesFiles With ErrorsErrors
          +
          +           + + + + oddrow + evenrow + + +           + diff --git a/tools/apache-ant-1.8.2/etc/coverage-frames.xsl b/tools/apache-ant-1.8.2/etc/coverage-frames.xsl new file mode 100644 index 000000000..a55a52aa8 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/coverage-frames.xsl @@ -0,0 +1,489 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Coverage Results. + + + + + + + + + <h2>Frame Alert</h2> + <p> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </p> + + + + + + + + .bannercell { + border: 0px; + padding: 0px; + } + body { + margin-left: 10; + margin-right: 10; + font:normal 80% arial,helvetica,sanserif; + background-color:#FFFFFF; + color:#000000; + } + .a td { + background: #efefef; + } + .b td { + background: #fff; + } + th, td { + text-align: left; + vertical-align: top; + } + th { + font-weight:bold; + background: #ccc; + color: black; + } + table, th, td { + font-size:100%; + border: none + } + table.log tr td, tr th { + + } + h2 { + font-weight:bold; + font-size:140%; + margin-bottom: 5; + } + h3 { + font-size:100%; + font-weight:bold; + background: #525D76; + color: white; + text-decoration: none; + padding: 5px; + margin-right: 2px; + margin-left: 2px; + margin-bottom: 0; + } + + + + + + + + + +

          Classes

          + + + + + + + / + .html + + + + + +
          + +
          + + +           + + + + + + + + +

          Home

          +

          Packages

          + + + + + + + +
          + + + +
          + + +           + + + + + + + + + +

          Summary

          + + + + + + + + + + + + + +
          Reported ClassesMethods HitLines Hit
          + + + + +
          + To ensure accurate test runs on Java applications, developers need to know how much of + the code has been tested, and where to find any untested code. Coverage helps you + locate untested code, and measure precisely how much code has been exercised. + The result is a higher quality application in a shorter period of time. +

          +

          + +

          Packages

          + + + + + + + + + + + + +
          + + + +           + + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +

          +
          + +

          Classes

          + + + + + + + +
          + +
          + + +           + + + + + + + + + + + + +

          Package

          + + + +
          + + +

          Classes

          + + + + + +
          +           + + + +           + + + + + + + + + + + + +

          Class .

          + + + + + +
          + + +

          Methods

          + + + + + +
          + + + + +           + + + + + + + + + + + + +
          + + http://jakarta.apache.org + +

          Source Code Coverage

          Designed for use with Sitraka JProbe and Ant.
          +
          +           + + + + + + + + + Name + Methods Hit + Lines Hit + + + + + + Name + Lines Hit + + + + + + + + + + + + + + + Name + Methods Hit + Lines Hit + + + + + + + + + + + + + + + + ../ + + + + + + ../ + + + + + + + + stylesheet.css + + + + + + a + b + + + +           + + diff --git a/tools/apache-ant-1.8.2/etc/jdepend-frames.xsl b/tools/apache-ant-1.8.2/etc/jdepend-frames.xsl new file mode 100644 index 000000000..ccc9dcc20 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/jdepend-frames.xsl @@ -0,0 +1,487 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + JDepend Analysis + + + + + + + + + + <h2>Frame Alert</h2> + <p> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </p> + + + + + + + + + + + + + + + + +

          Summary

          + + [summary] + [packages] + [cycles] + [explanations] +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          PackageTotal ClassesAbstract ClassesConcrete ClassesAfferent CouplingsEfferent CouplingsAbstractnessInstabilityDistance
          + + overview-packages.html#PK + + + +
          + +
          + + +           + + + + + + + + +

          Packages

          + + [summary] + [packages] + [cycles] + [explanations] +
          + + + +

          PK +

          + + + + + + + +
          Afferent Couplings: Efferent Couplings: Abstractness: Instability: Distance:
          + + + + + + + + + + + + + + +
          Abstract ClassesConcrete ClassesUsed by PackagesUses Packages
          + + None + + +
          +           +           		+ + None + + +
          +           +           		+ + None + + + + overview-packages.html#PK + +
          +           +           		+ + None + + + + overview-packages.html#PK + +
          +           +
          +           +           + +
          + [summary] + [packages] + [cycles] + [explanations] +
          + + +           + + + + + + + + +

          Cycles

          + + [summary] + [packages] + [cycles] + [explanations] +
          + + + +

          There are no cyclic dependancies.

          +           + +

          #CY

          + +
          +

          +           + +
          + [summary] + [packages] + [cycles] + [explanations] +
          + + +           + + + + + + + + + +

          Explanations

          + + [summary] + [packages] + [cycles] + [explanations] +
          + +

          The following explanations are for quick reference and are lifted directly from the original JDepend documentation.

          + +

          Number of Classes

          +

          The number of concrete and abstract classes (and interfaces) in the package is an indicator of the extensibility of the package.

          +

          Afferent Couplings

          +

          The number of other packages that depend upon classes within the package is an indicator of the package's responsibility.

          +

          Efferent Couplings

          +

          The number of other packages that the classes in the package depend upon is an indicator of the package's independence.

          +

          Abstractness

          +

          The ratio of the number of abstract classes (and interfaces) in the analyzed package to the total number of classes in the analyzed package.

          +

          The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package.

          +

          Instability

          +

          The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change.

          +

          The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package.

          +

          Distance

          +

          The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability.

          +

          A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0).

          +

          The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible.

          + + + +           + + + + + + + + + +
          + [summary] + [packages] + [cycles] + [explanations] +
          +

          Packages

          + + + + + + + +
          + + +           + + + + + + + + + + + + + + + + Not Analyzed: + + + + + + + + + + + +
          + [summary] + [packages] + [cycles] + [explanations] +
          +

          Cycles

          + + + + +
          + + +           + + + + + + + + + + + +

          JDepend Analysis

          + + + + + +
          Designed for use with JDepend and Ant.
          +
          +           + +           diff --git a/tools/apache-ant-1.8.2/etc/jdepend.xsl b/tools/apache-ant-1.8.2/etc/jdepend.xsl new file mode 100644 index 000000000..f8132975f --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/jdepend.xsl @@ -0,0 +1,276 @@ + + + + + + + + + + + JDepend Analysis + + + + + + + + +

          JDepend Analysis

          +

          Designed for use with JDepend and Ant.

          +
          + +
          +

          Summary

           +           		+ [summary] + [packages] + [cycles] + [explanations] +
          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          PackageTotal ClassesAbstract ClassesConcrete ClassesAfferent CouplingsEfferent CouplingsAbstractnessInstabilityDistance
          + + #PK + + + +
          + +
          + +
          +

          Packages

           +           		+ [summary] + [packages] + [cycles] + [explanations] +
          + + + +

          PK +

          + + + + + + + +
          Afferent Couplings: Efferent Couplings: Abstractness: Instability: Distance:
          + + + + + + + + + + + + + + +
          Abstract ClassesConcrete ClassesUsed by PackagesUses Packages
          + + None + + +
          +           +           		+ + None + + +
          +           +           		+ + None + + + + #PK + +
          +           +           		+ + None + + + + #PK + +
          +           +
          +           +           + +
          +

          Cycles

           +           		+ [summary] + [packages] + [cycles] + [explanations] +
          + + +

          There are no cyclic dependancies.

          +           + +

          + +
          +

          +           + +
          +

          Explanations

           +           		+ [summary] + [packages] + [cycles] + [explanations] +
          + +

          The following explanations are for quick reference and are lifted directly from the original JDepend documentation.

          + +

          Number of Classes

          +

          The number of concrete and abstract classes (and interfaces) in the package is an indicator of the extensibility of the package.

          +

          Afferent Couplings

          +

          The number of other packages that depend upon classes within the package is an indicator of the package's responsibility.

          +

          Efferent Couplings

          +

          The number of other packages that the classes in the package depend upon is an indicator of the package's independence.

          +

          Abstractness

          +

          The ratio of the number of abstract classes (and interfaces) in the analyzed package to the total number of classes in the analyzed package.

          +

          The range for this metric is 0 to 1, with A=0 indicating a completely concrete package and A=1 indicating a completely abstract package.

          +

          Instability

          +

          The ratio of efferent coupling (Ce) to total coupling (Ce / (Ce + Ca)). This metric is an indicator of the package's resilience to change.

          +

          The range for this metric is 0 to 1, with I=0 indicating a completely stable package and I=1 indicating a completely instable package.

          +

          Distance

          +

          The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability.

          +

          A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and instable (x=1, y=0).

          +

          The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible.

          + + + +           + +           diff --git a/tools/apache-ant-1.8.2/etc/junit-frames-xalan1.xsl b/tools/apache-ant-1.8.2/etc/junit-frames-xalan1.xsl new file mode 100644 index 000000000..0efb75873 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/junit-frames-xalan1.xsl @@ -0,0 +1,733 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + Standard Output from <xsl:value-of select="@name"/> + + +
          + + +           +           + + + + + Standard Error from <xsl:value-of select="@name"/> + + +
          + + +           +           +           +           + + + + + Unit Test Results. + + + + + + + + + <h2>Frame Alert</h2> + <p> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </p> + + + + + + + +body { + font:normal 68% verdana,arial,helvetica; + color:#000000; +} +table tr td, table tr th { + font-size: 68%; +} +table.details tr th{ + font-weight: bold; + text-align:left; + background:#a6caf0; +} +table.details tr td{ + background:#eeeee0; +} + +p { + line-height:1.5em; + margin-top:0.5em; margin-bottom:1.0em; +} +h1 { + margin: 0px 0px 5px; font: 165% verdana,arial,helvetica +} +h2 { + margin-top: 1em; margin-bottom: 0.5em; font: bold 125% verdana,arial,helvetica +} +h3 { + margin-bottom: 0.5em; font: bold 115% verdana,arial,helvetica +} +h4 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +h5 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +h6 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +.Error { + font-weight:bold; color:red; +} +.Failure { + font-weight:bold; color:purple; +} +.Properties { + text-align:right; +} + + + + + + + . + + + Unit Test Results: <xsl:value-of select="$class.name"/> + + + + + + + + +

          Class

          + + + + + +
          + +

          Tests

          + + + + + + + + + +
          +
          + + javascript:displayProperties('.'); + Properties » + +
          + +
          + + ./-out.html + System.out » + +
          +           + +
          + + ./-err.html + System.err » + +
          +           + + +           + + + + cur = TestCases['.'] = new Array(); + + + cur[''] = ''; + + + + + + + + + + + Unit Test Classes: <xsl:value-of select="$name"/> + + + + + + + + + +
          +

          + + <none> +

          +
          + +

          Classes

          + + + + + + + +
          + +
          + + +           + + + + + + + All Unit Test Classes + + + + + +

          Classes

          + + + + +
          + + +           + + + + + + + + + / + .html + + + + + + + + + + + + + All Unit Test Packages + + + + + +

          Home

          +

          Packages

          + + + + +
          + + +           + + + + + + + <none> + + + + + + + + + + Unit Test Results: Summary + + + + + + open('allclasses-frame.html','classListFrame') + +

          Summary

          + + + + + + + + + + + + + + + + + Error + Failure + Pass + + + + + + + + +
          TestsFailuresErrorsSuccess rateTime
          + + + + + + + +
          + + + + +
          + Note: failures are anticipated and checked for with assertions while errors are unanticipated. +
          + +

          Packages

          + + + + + + + + + + + Error + Failure + Pass + + + + + + + + + + + +
          + + <none> + + + + +
          + + +           + + + + + + + + + + + + open('package-frame.html','classListFrame') + +

          Package

          + + + + + +

          Classes

          +

          + + + + + +
          +

          +           + + +           + + + + + + + ../ + + + + + + ../ + + + + + + + + stylesheet.css + + + + + +

          Unit Test Results

          + + + + + +
          Designed for use with JUnit and Ant.
          +
          +           + + + + + Name + Tests + Errors + Failures + Time(s) + Time Stamp + Host + + + + + + + Name + Status + Type + Time(s) + + + + + + + + + + Error + Failure + Pass + + + + + + + + + + + + + + + + + + + + Error + Failure + TableRowColor + + + + + + Failure + + + + Error + + + + Success + + + + + + + + + + + + + + + + + + + + + + + + + N/A + + + + + +

          + + + + + + + +           + + + + + + + + + + + + +
          + +           + + + + + + + + + + +           diff --git a/tools/apache-ant-1.8.2/etc/junit-frames.xsl b/tools/apache-ant-1.8.2/etc/junit-frames.xsl new file mode 100644 index 000000000..535ba827e --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/junit-frames.xsl @@ -0,0 +1,902 @@ + + + + + + + + +Unit Test Results. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + Standard Output from <xsl:value-of select="@name"/> + + +
          + + +           +           + + + + + Standard Error from <xsl:value-of select="@name"/> + + +
          + + +           +           + + + + + + + + + + + + + + +           +           + + + + + <xsl:value-of select="$TITLE"/> + + + + + + + + + <h2>Frame Alert</h2> + <p> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </p> + + + + + + + +body { + font:normal 68% verdana,arial,helvetica; + color:#000000; +} +table tr td, table tr th { + font-size: 68%; +} +table.details tr th{ + font-weight: bold; + text-align:left; + background:#a6caf0; +} +table.details tr td{ + background:#eeeee0; +} + +p { + line-height:1.5em; + margin-top:0.5em; margin-bottom:1.0em; +} +h1 { + margin: 0px 0px 5px; font: 165% verdana,arial,helvetica +} +h2 { + margin-top: 1em; margin-bottom: 0.5em; font: bold 125% verdana,arial,helvetica +} +h3 { + margin-bottom: 0.5em; font: bold 115% verdana,arial,helvetica +} +h4 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +h5 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +h6 { + margin-bottom: 0.5em; font: bold 100% verdana,arial,helvetica +} +.Error { + font-weight:bold; color:red; +} +.Failure { + font-weight:bold; color:purple; +} +.Properties { + text-align:right; +} + + + + + + + + + + All Failures + + + All Errors + + + All Tests + + + + + Unit Test Results: <xsl:value-of select="$title"/> + + + + + + open('allclasses-frame.html','classListFrame') + +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          + +
          + + +           + + + + + + + . + + + Unit Test Results: <xsl:value-of select="$class.name"/> + + + + + + + + +

          Class

          + + + + + +
          + + + +

          Failures

          +           + +

          Errors

          +           + +

          Tests

          +           +           + + + + + + + + + + + + + + + + + + + +
          +
          + + javascript:displayProperties('.'); + Properties » + +
          + +
          + + ./_-out.html + System.out » + +
          +           + +
          + + ./_-err.html + System.err » + +
          +           + + +           + + + + cur = TestCases['.'] = new Array(); + + + cur[''] = ''; + + + + + + + + + + + Unit Test Classes: <xsl:value-of select="$name"/> + + + + + + + + + +
          +

          + + <none> +

          +
          + +

          Classes

          + + + + + + + +
          + +
          + + +           + + + + + + + All Unit Test Classes + + + + + +

          Classes

          + + + + +
          + + +           + + + + + + + + + / + _.html + + + + + + + + + + + + + All Unit Test Packages + + + + + +

          Home

          +

          Packages

          + + + + +
          + + +           + + + + + + + <none> + + + + + + + + + + Unit Test Results: Summary + + + + + + open('allclasses-frame.html','classListFrame') + +

          Summary

          + + + + + + + + + + + + + + + + + Error + Failure + Pass + + + + + + + + +
          TestsFailuresErrorsSuccess rateTime
          + + + + + + + +
          + + + + +
          + Note: failures are anticipated and checked for with assertions while errors are unanticipated. +
          + +

          Packages

          + + + + + + + + + + + Error + Failure + Pass + + + + + + + + + + + +
          + + <none> + + + + +
          + + +           + + + + + + + + + + + + open('package-frame.html','classListFrame') + +

          Package

          + + + + + +

          Classes

          +

          + + + + + +
          +

          +           + + +           + + + + + + + ../ + + + + + + ../ + + + + + + + + stylesheet.css + + + + + +

          + + + + + +
          Designed for use with JUnit and Ant.
          +
          +           + + + + + Name + Tests + Errors + Failures + Time(s) + Time Stamp + Host + + + + + + + + + Class + + Name + Status + Type + Time(s) + + + + + + + + + + Error + Failure + Pass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Error + Failure + TableRowColor + + + + + + + + + + + + + + + + + + + + + + Failure + + + + Error + + + + Success + + + + + + + + + + + + + + + + + + + + + + + + + N/A + + + + + +

          + + + + + + + +           + + + + + + + + + + + + + + + +
          + + + +           + + + +           +           + + + + + + + + + + +           diff --git a/tools/apache-ant-1.8.2/etc/junit-noframes.xsl b/tools/apache-ant-1.8.2/etc/junit-noframes.xsl new file mode 100644 index 000000000..18177a113 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/junit-noframes.xsl @@ -0,0 +1,478 @@ + + + + + + +Unit Test Results. + + + + + + <xsl:value-of select="$TITLE"/> + + + + + + + + + + +
          + + + +
          + + + +
          + + + + + + +           + + + + + + + + +

          Packages

          + Note: package statistics are not computed recursively, they only sum up all of its testsuites numbers. + + + + + + + + + + + + + + + + + Failure + Error + + + + + + + + + + + +
          + + + +
          +           + + + + + + + + + + + + +

          Package

          + + + + + + +
          + Back to top +

          +

          + + + + + + + + +

          TestCase

          + + + + + + + + + + +
          +
          + + javascript:displayProperties('.'); + Properties » + +
          +

          + + Back to top + + + + +

          Summary

          + + + + + + + + + + + + + + + + + Failure + Error + + + + + + + + + +
          TestsFailuresErrorsSuccess rateTime
          + + + + + + + +
          + + + + +
          + Note: failures are anticipated and checked for with assertions while errors are unanticipated. +
          +           + + + + cur = TestCases['.'] = new Array(); + + + cur[''] = ''; + + + + + +

          + + + + + +
          Designed for use with JUnit and Ant.
          +
          +           + + + + Name + Tests + Errors + Failures + Time(s) + + + + + + + Name + Tests + Errors + Failures + Time(s) + Time Stamp + Host + + + + + + + Name + Status + Type + Time(s) + + + + + + + + + + + Failure + Error + + + + + + + + + + + + + + + + + + + + + + + Error + + + + + + Failure + + + + Error + + + + Success + + + + + + + + + + + + + + + + + + + + + + + + N/A + + + + + + +

          + + + +           + + +           + + + + + + + + + + + + + + + +
          + + + +           + + + +           +           + + + + + + + + + + + +           diff --git a/tools/apache-ant-1.8.2/etc/log.xsl b/tools/apache-ant-1.8.2/etc/log.xsl new file mode 100644 index 000000000..5040993b7 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/log.xsl @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + + +
          + + http://jakarta.apache.org + + + Apache Ant +
          + + + +
          + + + + + +           + + + + + + failed + complete + + + + + + + + + + + + + +
          Build FailedBuild CompleteTotal Time:
          + +
          + See the stacktrace. +           +
          + + + + + +
          ant.file
          ant.version
          java.version
          os.name
          + +

          Build events

          + + + + + + + +
          targettaskmessage
          +

          + + + +

          Error details

          + + +
          +
          +
          + +

          +           + + + + + + + a + b + + + [ ] + + + + + + +           diff --git a/tools/apache-ant-1.8.2/etc/maudit-frames.xsl b/tools/apache-ant-1.8.2/etc/maudit-frames.xsl new file mode 100644 index 000000000..257c0c8ca --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/maudit-frames.xsl @@ -0,0 +1,503 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + + + + Audit Results. + + + + + + + + + <H2>Frame Alert</H2> + <P> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </P> + + + + + + + + .bannercell { + border: 0px; + padding: 0px; + } + body { + margin-left: 10; + margin-right: 10; + font:normal 80% arial,helvetica,sanserif; + background-color:#FFFFFF; + color:#000000; + } + .a td { + background: #efefef; + } + .b td { + background: #fff; + } + th, td { + text-align: left; + vertical-align: top; + } + th { + font-weight:bold; + background: #ccc; + color: black; + } + table, th, td { + font-size:100%; + border: none + } + table.log tr td, tr th { + + } + h2 { + font-weight:bold; + font-size:140%; + margin-bottom: 5; + } + h3 { + font-size:100%; + font-weight:bold; + background: #525D76; + color: white; + text-decoration: none; + padding: 5px; + margin-right: 2px; + margin-left: 2px; + margin-bottom: 0; + } + + + + + + + + + + + + + + +

          Class .

          + + + + +
          + +

          Violations

          + + + + + +
          + + + +           + + + + + + + + + + + + + + + + +
          +

          +
          + +

          Classes

          + + + + +
          + + +           + + + + + +           + + + + + + + + + + + + + + +

          Classes

          + + + + +
          + + +           + + + + + + + + + + / + .html + + + + + + + + + + + + + + + + + +

          Home

          +

          Packages

          + + + + +
          + + +           + + + + + + + + + + + + + + + + + + + + + +

          Summary

          + + + + + + + + + + + +
          Audited classesReported classesViolations
          + + + + +
          + Note: Rules checked have originated from style guidelines suggested by the language designers, + experience from the Java development community and insite experience. Violations are generally + reported with a reference to the Java Language Specifications (JLS x.x.x) + and Metamata Audit rules (x.x). + Please consult these documents for additional information about violations. +

          + Rules checked also enforce adherence to Sun Java coding guidelines in use at Jakarta. +

          + One should note that these violations do not necessary underline errors but should be used + as an indication for possible errors. As always, use your best judgment and review + them carefully, it might save you hours of debugging. +

          + +

          Packages

          + + + + + + + + + + +
          + + + +           + + + + + + + + + + + + open('package-frame.html','classListFrame') + +

          Package

          + + + + +

          Classes

          + + + + + +
          +           + + + +           + + + + + + + ../ + + + + + + ../ + + + + + + + + stylesheet.css + + + + + + + + + + + + + + +
          + + http://jakarta.apache.org + +

          Source Code Audit

          Designed for use with Webgain QA/Metamata Audit and Ant.
          +
          +           + + + + + + + + + + Name + Violations + + + + + + + Line + Message + + + + + + + + + + + + + + + + + + + + + + + + + a + b + + + + + diff --git a/tools/apache-ant-1.8.2/etc/mmetrics-frames.xsl b/tools/apache-ant-1.8.2/etc/mmetrics-frames.xsl new file mode 100644 index 000000000..8b4643ad2 --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/mmetrics-frames.xsl @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + . + + + + + + + + + + + + + + + + + + + + + + + + + . + + + + + + Metrics Results. + + + + + + + + + <H2>Frame Alert</H2> + <P> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </P> + + + + + + + + + + + +

          Metrics Reference

          +V(G) | +LOC | +DIT | +NOA | +NRM | +NLM | +WMC | +RFC | +DAC | +FANOUT | +CBO | +LCOM | +NOC + + +

          Cyclomatic Complexity - V(G)

          +This metric was introduced in the 1970s to measure the amount of control +flow complexity or branching complexity in a module such as a +subroutine. It gives the number of paths that may be taken through the +code, and was initially developed to give some measure of the cost of +producing a test case for the module by executing each path. +

          +Methods with a high cyclomatic complexity tend to be more difficult to +understand and maintain. In general the more complex the methods of an +application, the more difficult it will be to test it, and this will adversely +affect its reliability. +

          +V(G) is a measure of the control flow complexity of a method or +constructor. It counts the number of branches in the body of the method, +defined as: +

            +
          • while statements;
            • +
          • if statements;
            • +
          • for statements.
            • +
          + +The metric can also be configured to count each case of a switch +statement as well. + +           +

          Lines of Code - LOC

          + +This is perhaps the simplest of all the metrics to define and compute. +Counting lines has a long history as a software metric dating from before +the rise of structured programming, and it is still in widespread use today. +The size of a method affects the ease with which it can be understood, its +reusability and its maintainability. There are a variety of ways that the size +can be calculated. These include counting all the lines of code, the number +of statements, the blank lines of code, the lines of commentary, and the +lines consisting only of syntax such as block delimiters. +

          +This metric can also be used for sizing other constructs as well, for +example, the overall size of a Java class or package can be measured by +counting the number of source lines it consists of. +

          +LOC can be used to determine the size of a compilation unit (source file), +class or interface, method, constructor, or field. It can be configured to +ignore: +

            +
          • blank lines;
            • +
          • lines consisting only of comments;
            • +
          • lines consisting only of opening and closing braces.
            • +
          + +           +

          Depth of Inheritance Hierarchy - DIT

          + +This metric calculates how far down the inheritance hierarchy a class is +declared. In Java all classes have java.lang.Object as their ultimate +superclass, which is defined to have a depth of 1. So a class that +immediately extends java.lang.Object has a metric value of 2; any of its +subclasses will have a value of 3, and so on. +

          +A class that is deep within the tree inherits more methods and state +variables, thereby increasing its complexity and making it difficult to +predict its behavior. It can be harder to understand a system with many +inheritance layers. +

          +DIT is defined for classes and interfaces: +

            +
          • all interface types have a depth of 1;
            • +
          • the class java.lang.Object has a depth of 1;
            • +
          • all other classes have a depth of 1 + the depth of their super class.
            • +
          + +           +

          Number of Attributes - NOA

          + +The number of distinct state variables in a class serves as one measure of +its complexity. The more state a class represents the more difficult it is to +maintain invariants for it. It also hinders comprehensibility and reuse. +

          +In Java, state can be exposed to subclasses through protected fields, which +entails that the subclass also be aware of and maintain any invariants. This +interference with the class's data encapsulation can be a source of defects +and hidden dependencies between the state variables. +

          +NOA is defined for classes and interfaces. It counts the number of fields +declared in the class or interface. + + +

          Number of Remote Methods - NRM

          + +NRM is defined for classes. A remote method call is defined as an +invocation of a method that is not declared in any of: +
            +
          • the class itself;
            • +
          • a class or interface that the class extends or implements;
            • +
          • a class or method that extends the class.
            • +
          + +The value is the count of all the remote method calls in all of the methods +and constructors of the class. + +           +

          Number of Local Methods - NLM

          + +NLM is defined for classes and interfaces. A local method is defined as a +method that is declared in the class or interface. NLM can be configured to +include the local methods of all of the class's superclasses. Methods with +public, protected, package and private visibility can be independently +counted by setting configuration parameters. + +           +

          Weighted Methods per Class - WMC

          + +If the number of methods in a class can be determined during the design +and modeling phase of a project, it can be used as a predictor of how +much time and effort is needed to develop, debug and maintain it. This +metric can be further refined by incorporating a weighting for the +complexity of each method. The usual weighting is given by the cyclomatic +complexity of the method. +

          +The subclasses of a class inherit all of its public and protected methods, +and possibly its package methods as well, so the number of methods a +class has directly impacts the complexity of its subclasses. Classes with +large numbers of methods are often specific to a particular application, +reducing the ability to reuse them. +

          +The definition of WMC is based upon NLM, and it provides the same +configuration parameters for counting inherited methods and of varying +visibility. The main difference is that NLM always counts each method as 1, +whereas WMC will weight each method. There are two weighting schemes: +

            +
          • V(G) the cyclomatic complexity of the method is used as its weight. + Methods from class files are given a V(G) of 1.
            • +
          • the arity, or the number of parameters of the method are used to + determine the weight.
            • +
          + +           +

          Response For Class - RFC

          + +The response set of a class is the set of all methods that can be invoked as +a result of a message sent to an object of the class. This includes methods +in the class's inheritance hierarchy and methods that can be invoked on +other objects. The Response For Class metric is defined to be size of the +response set for the class. A class which provides a larger response set is +considered to be more complex than one with a smaller response set. +

          +One reason for this is that if a method call on a class can result in a large +number of different method calls on the target and other classes, then it +can be harder to test the behavior of the class and debug problems. It will +typically require a deeper understanding of the potential interactions that +objects of the class can have with the rest of the system. +

          +RFC is defined as the sum of NLM and NRM for the class. The local methods +include all of the public, protected, package and private methods, but not +methods declared only in a superclass. + + +

          Data Abstraction Coupling - DAC

          + +DAC is defined for classes and interfaces. It counts the number of reference +types that are used in the field declarations of the class or interface. The +component types of arrays are also counted. Any field with a type that is +either a supertype or a subtype of the class is not counted. + + +

          Fan Out - FANOUT

          + +FANOUT is defined for classes and interfaces, constructors and methods. It +counts the number of reference types that are used in: +
            +
          • field declarations;
            • +
          • formal parameters and return types;
            • +
          • throws declarations;
            • +
          • local variables.
            • +
          + +The component types of arrays are also counted. Any type that is either a +supertype or a subtype of the class is not counted. + +           +

          Coupling Between Objects - CBO

          + +When one object or class uses another object or class they are said to be +coupled. One major source of coupling is that between a superclass and a +subclass. A coupling is also introduced when a method or field in another +class is accessed, or when an object of another class is passed into or out +of a method invocation. Coupling Between Objects is a measure of the +non-inheritance coupling between two objects. +

          +A high value of coupling reduces the modularity of the class and makes +reuse more difficult. The more independent a class is the more likely it is +that it will be possible to reuse it in another part of the system. When a +class is coupled to another class it becomes sensitive to changes in that +class, thereby making maintenance for difficult. In addition, a class that is +overly dependent on other classes can be difficult to understand and test in +isolation. +

          +CBO is defined for classes and interfaces, constructors and methods. It +counts the number of reference types that are used in: +

            +
          • field declarations
            • +
          • formal parameters and return types
            • +
          • throws declarations
            • +
          • local variables
            • +
          + +It also counts: +
            +
          • types from which field and method selections are made
            • +
          + +The component types of arrays are also counted. Any type that is either a +supertype or a subtype of the class is not counted. + +           +

          Lack of Cohesion Of Methods - LCOM

          + +The cohesion of a class is the degree to which its methods are related to +each other. It is determined by examining the pattern of state variable +accesses within the set of methods. If all the methods access the same state +variables then they have high cohesion; if they access disjoint sets of +variables then the cohesion is low. An extreme example of low cohesion +would be if none of the methods accessed any of the state variables. + +If a class exhibits low method cohesion it indicates that the design of the +class has probably been partitioned incorrectly, and could benefit by being +split into more classes with individually higher cohesion. On the other +hand, a high value of cohesion (a low lack of cohesion) implies that the +class is well designed. A cohesive class will tend to provide a high degree +of encapsulation, whereas a lack of cohesion decreases encapsulation and +increases complexity. +

          +Another form of cohesion that is useful for Java programs is cohesion +between nested and enclosing classes. A nested class that has very low +cohesion with its enclosing class would probably better designed as a peer +class rather than a nested class. +

          +LCOM is defined for classes. Operationally, LCOM takes each pair of +methods in the class and determines the set of fields they each access. If +they have disjoint sets of field accesses increase the count P by one. If they +share at least one field access then increase Q by one. After considering +each pair of methods, +LCOM = (P > Q) ? (P - Q) : 0 +

          +Indirect access to fields via local methods can be considered by setting a +metric configuration parameter. + + +

          Number Of Classes - NOC

          + +The overall size of the system can be estimated by calculating the number +of classes it contains. A large system with more classes is more complex +than a smaller one because the number of potential interactions between +objects is higher. This reduces the comprehensibility of the system which +in turn makes it harder to test, debug and maintain. +

          +If the number of classes in the system can be projected during the initial +design phase of the project it can serve as a base for estimating the total +effort and cost of developing, debugging and maintaining the system. +

          +The NOC metric can also usefully be applied at the package and class level +as well as the total system. +

          +NOCL is defined for class and interfaces. It counts the number of classes or +interfaces that are declared. This is usually 1, but nested class declarations +will increase this number. + + + + + + + .bannercell { + border: 0px; + padding: 0px; + } + body { + margin-left: 10; + margin-right: 10; + font:normal 80% arial,helvetica,sanserif; + background-color:#FFFFFF; + color:#000000; + } + .a td { + background: #efefef; + } + .b td { + background: #fff; + } + th, td { + text-align: left; + vertical-align: top; + } + th { + font-weight:bold; + background: #ccc; + color: black; + } + table, th, td { + font-size:100%; + border: none + } + table.log tr td, tr th { + + } + h2 { + font-weight:bold; + font-size:140%; + margin-bottom: 5; + } + h3 { + font-size:100%; + font-weight:bold; + background: #525D76; + color: white; + text-decoration: none; + padding: 5px; + margin-right: 2px; + margin-left: 2px; + margin-bottom: 0; + } + .Error { + font-weight:bold; color:red; + } + + + + + + + + + + + + + + + + +

          Class .

          + + + +
          + +

          Methods

          + + + +
          + + + + +           + + + + + + + + + + + + + + + +
          +

          +
          + +

          Classes

          + + + + + + + + +
          + +
          + + +           + + + + + + + + + + + +

          Classes

          + + + + + +
          + + +           + + + + + + +           + + + / + + .html + + + + + + + + + + + + + + + + +

          Home

          +

          Packages

          + + + + +
          + + +           + + + + + + + + + + + + + + + + + + + + + +

          Summary

          + + + + + + + + + + + + + + + + + +
          V(G)LOCDITNOANRMNLMWMCRFCDACFANOUTCBOLCOMNOCL
          + + + + +
          + Note: Metrics evaluate the quality of software by analyzing the program source and quantifying + various kind of complexity. Complexity is a common source of problems and defects in software. + High complexity makes it more difficult to develop, understand, maintain, extend, test and debug + a program. +

          + The primary use of metrics is to focus your attention on those parts of code that potentially are + complexity hot spots. Once the complex areas your program have been uncovered, you can take remedial + actions. + For additional information about metrics and their meaning, please consult + Metamata Metrics manual. +

          + +

          Packages

          + + + + + + +
          + + + + +           + + + + + + + + + + + +

          Package

          + + + + +
          + + + + + +
          + Note: Metrics evaluate the quality of software by analyzing the program source and quantifying + various kind of complexity. Complexity is a common source of problems and defects in software. + High complexity makes it more difficult to develop, understand, maintain, extend, test and debug + a program. +

          + The primary use of metrics is to focus your attention on those parts of code that potentially are + complexity hot spots. Once the complex areas your program have been uncovered, you can take remedial + actions. + For additional information about metrics and their meaning, please consult + Metamata Metrics manual. +

          + + + +

          Classes

          + + + + + + +
          +           + + + + +           + + + + + + + ../ + + + + + + ../ + + + + + + + + stylesheet.css + + + + + + + + + + + + + + + +
          + + http://jakarta.apache.org + +

          Source Code Metrics

          Designed for use with Webgain QA/Metamata Metrics and Ant.
          +
          +           + + + + + + + + + Name + V(G) + LOC + DIT + NOA + NRM + NLM + WMC + RFC + DAC + FANOUT + CBO + LCOM + NOCL + + + + + + + Name + V(G) + LOC + FANOUT + CBO + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a + b + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Error + + + + +           + diff --git a/tools/apache-ant-1.8.2/etc/tagdiff.xsl b/tools/apache-ant-1.8.2/etc/tagdiff.xsl new file mode 100644 index 000000000..5d430a79d --- /dev/null +++ b/tools/apache-ant-1.8.2/etc/tagdiff.xsl @@ -0,0 +1,179 @@ + + + + + + + + + + + + + + + + + + + + + + <xsl:value-of select="$title"/> + + + +

          + +

          + Tagdiff between and + +

          Designed for use with Ant.

          +
          + + + + + +
          + New Files | + Modified Files | + Removed Files +
          + + + New Files + New + + + + + Modified Files + Modified + + + + + + Removed Files + Removed + + +
          + + + +           + + + + + + + + + + - entries + + (back to top) + + + + + + + +
            + +
          + + + + + + + + + + + + + + + + + + + + mailto: + + + + + + +
        10. + + / + + + + + + + + /?rev=&content-type=text/x-cvsweb-markup + + + /?r1=&r2=&diff_format=h + + ( --> ) + + +
          11. +           + + + + + + +           diff --git a/tools/apache-ant-1.8.2/fetch.xml b/tools/apache-ant-1.8.2/fetch.xml new file mode 100644 index 000000000..d0628d283 --- /dev/null +++ b/tools/apache-ant-1.8.2/fetch.xml @@ -0,0 +1,343 @@ + + + + + + + + This build file downloads JAR files that optional Ant tasks use, + and installs them in a location that is accessible the next time Ant runs. + + You can choose three locations, by going -Ddest=LOCATION on the command line + -Ddest=user user lib dir ${user.home}/.ant/lib + -Ddest=system ant lib dir ${ant.home}/lib + -Ddest=optional optional dir $${basedir}/lib/optional (for Ant developers) + + You may also need to set proxy settings. On Java1.5, Ant tries to get + this from the OS, unless you use the -noproxy option. + + Proxies can be configured manually setting the JVM proxy values in the + ANT_OPTS environment variable. + + For example, to set the proxy up in the tcsh shell, the command would be + something like: + + For csh/tcsh: + setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" + For bash: + export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" + For Windows, set the environment variable in the appropriate dialog box + and open a new console. or, by hand + set ANT_OPTS = -Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080 + + + + + + + + + + + + + + + + + + + + + + + + ERROR +Set -Ddest=LOCATION on the command line + -Ddest=user user lib dir ${user.home}/.ant/lib + -Ddest=system ant lib dir ${ant.home}/lib + -Ddest=optional optional dir $${basedir}/lib/optional (for Ant developers) + + + + + + + + + + + + Unknown destination : ${dest} + Downloading to ${dest.dir} + + + + + + + + + + + + + Unknown archive @{archive} -no property @{archive}.version defined in ${lib.dir}/libraries.properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/get-m2.xml b/tools/apache-ant-1.8.2/get-m2.xml new file mode 100644 index 000000000..4111e81ea --- /dev/null +++ b/tools/apache-ant-1.8.2/get-m2.xml @@ -0,0 +1,121 @@ + + + + + + + + This build file downloads the Maven2 Ant tasks, + and installs them in the location specified by the m2.dest.dir property. + + You may need to set proxy settings. On Java1.5, Ant tries to get + this from the OS, unless you use the -noproxy option. + + Proxies can be configured manually setting the JVM proxy values in the + ANT_OPTS environment variable. + + For example, to set the proxy up in the tcsh shell, the command would be + something like: + + For csh/tcsh: + setenv ANT_OPTS "-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" + For bash: + export ANT_OPTS="-Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080" + For Windows, set the environment variable in the appropriate dialog box + and open a new console. or, by hand + set ANT_OPTS = -Dhttp.proxyHost=proxy -Dhttp.proxyPort=8080 + + + + + + + + + + + + $${@{property}} not specified + + + + + + + + + + + + + + + + + + + Downloading to ${m2.dest.dir} + + + + + + + + + + + + + + + + + + Failed to verify the downloaded file ${m2.antlib.url}" against the checksum + coded into libraries.properties. + The local copy has been deleted, for security reasons + + + + + + + + + + diff --git a/tools/apache-ant-1.8.2/lib/README b/tools/apache-ant-1.8.2/lib/README new file mode 100644 index 000000000..67e37ce73 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/README @@ -0,0 +1,3 @@ +Please refer to the Ant manual under Installing Ant / Library +Dependencies for a list of the jar requirements for various optional +tasks and features. diff --git a/tools/apache-ant-1.8.2/lib/ant-antlr.jar b/tools/apache-ant-1.8.2/lib/ant-antlr.jar new file mode 100644 index 000000000..7d32582fb Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-antlr.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-antlr.pom b/tools/apache-ant-1.8.2/lib/ant-antlr.pom new file mode 100644 index 000000000..9f429e9bc --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-antlr.pom @@ -0,0 +1,76 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-antlr + 1.8.2 + Apache Ant + ANTLR + antlr specific task. + The implementation forks a java process, therefore the antlr jar file is only needed at runtime + + + org.apache.ant + ant + 1.8.2 + true + compile + + + + antlr + antlr + 2.7.2 + true + runtime + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/ANTLR* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-bcel.jar b/tools/apache-ant-1.8.2/lib/ant-apache-bcel.jar new file mode 100644 index 000000000..04f82d72e Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-bcel.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-bcel.pom b/tools/apache-ant-1.8.2/lib/ant-apache-bcel.pom new file mode 100644 index 000000000..59458775c --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-bcel.pom @@ -0,0 +1,72 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-bcel + 1.8.2 + Apache Ant + BCEL + + + org.apache.ant + ant + 1.8.2 + compile + + + bcel + bcel + 5.1 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/filters/util/JavaClassHelper* + org/apache/tools/ant/util/depend/bcel/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-bsf.jar b/tools/apache-ant-1.8.2/lib/ant-apache-bsf.jar new file mode 100644 index 000000000..2e7564828 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-bsf.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-bsf.pom b/tools/apache-ant-1.8.2/lib/ant-apache-bsf.pom new file mode 100644 index 000000000..d0cc88f0d --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-bsf.pom @@ -0,0 +1,75 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-bsf + 1.8.2 + Apache Ant + BSF + + + org.apache.ant + ant + 1.8.2 + compile + + + bsf + bsf + 2.4.0 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/Script* + org/apache/tools/ant/taskdefs/optional/script/** + org/apache/tools/ant/types/optional/*Script* + org/apache/tools/ant/util/Script* + org/apache/tools/ant/util/optional/Script* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-log4j.jar b/tools/apache-ant-1.8.2/lib/ant-apache-log4j.jar new file mode 100644 index 000000000..78c2133cf Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-log4j.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-log4j.pom b/tools/apache-ant-1.8.2/lib/ant-apache-log4j.pom new file mode 100644 index 000000000..00f8b63de --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-log4j.pom @@ -0,0 +1,70 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-log4j + 1.8.2 + Apache Ant + Log4J + + + org.apache.ant + ant + 1.8.2 + compile + + + log4j + log4j + 1.2.13 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/listener/Log4jListener* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-oro.jar b/tools/apache-ant-1.8.2/lib/ant-apache-oro.jar new file mode 100644 index 000000000..497814810 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-oro.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-oro.pom b/tools/apache-ant-1.8.2/lib/ant-apache-oro.pom new file mode 100644 index 000000000..40324a6c1 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-oro.pom @@ -0,0 +1,75 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-oro + 1.8.2 + Apache Ant + Apache Oro + + + org.apache.ant + ant + 1.8.2 + compile + + + oro + oro + 2.0.8 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/util/regexp/JakartaOro* + org/apache/tools/ant/taskdefs/optional/perforce/* + + + org/apache/tools/ant/taskdefs/optional/perforce/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-regexp.jar b/tools/apache-ant-1.8.2/lib/ant-apache-regexp.jar new file mode 100644 index 000000000..dfedea307 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-regexp.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-regexp.pom b/tools/apache-ant-1.8.2/lib/ant-apache-regexp.pom new file mode 100644 index 000000000..e8f746921 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-regexp.pom @@ -0,0 +1,71 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-regexp + 1.8.2 + Apache Ant + Apache Regexp + + + org.apache.ant + ant + 1.8.2 + compile + + + regexp + regexp + 1.3 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/util/regexp/JakartaRegexp* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-resolver.jar b/tools/apache-ant-1.8.2/lib/ant-apache-resolver.jar new file mode 100644 index 000000000..ed8004eb2 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-resolver.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-resolver.pom b/tools/apache-ant-1.8.2/lib/ant-apache-resolver.pom new file mode 100644 index 000000000..b999b5040 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-resolver.pom @@ -0,0 +1,70 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-resolver + 1.8.2 + Apache Ant + Apache Resolver + + + org.apache.ant + ant + 1.8.2 + compile + + + xml-resolver + xml-resolver + 1.1 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/types/resolver/** + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.jar b/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.jar new file mode 100644 index 000000000..91376a3e7 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.pom b/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.pom new file mode 100644 index 000000000..cad6f4f47 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-apache-xalan2.pom @@ -0,0 +1,95 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-apache-xalan2 + 1.8.2 + Apache Ant + Xalan 2 + contains Xalan2-specific features + + + org.apache.ant + ant + 1.8.2 + compile + + + xalan + xalan + 2.7.1 + compile + + + + + + maven-antrun-plugin + + + create-timestamp-file + generate-resources + + run + + + + + + + + + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/Xalan2TraceSupport* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-commons-logging.jar b/tools/apache-ant-1.8.2/lib/ant-commons-logging.jar new file mode 100644 index 000000000..b7e1dee62 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-commons-logging.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-commons-logging.pom b/tools/apache-ant-1.8.2/lib/ant-commons-logging.pom new file mode 100644 index 000000000..e57ddf957 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-commons-logging.pom @@ -0,0 +1,71 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-commons-logging + 1.8.2 + Apache Ant + Commons Logging + Ant Listener based on commons-logging + + + org.apache.ant + ant + 1.8.2 + compile + + + commons-logging + commons-logging-api + 1.0.4 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/tlistener/CommonsLoggingListener* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-commons-net.jar b/tools/apache-ant-1.8.2/lib/ant-commons-net.jar new file mode 100644 index 000000000..25b7fe6ef Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-commons-net.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-commons-net.pom b/tools/apache-ant-1.8.2/lib/ant-commons-net.pom new file mode 100644 index 000000000..3da389eab --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-commons-net.pom @@ -0,0 +1,76 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-commons-net + 1.8.2 + Apache Ant + Commons Net + ftp, rexec and telnet tasks + + + org.apache.ant + ant + 1.8.2 + compile + + + commons-net + commons-net + 1.4.0 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/net/FTP* + org/apache/tools/ant/taskdefs/optional/net/RExec* + org/apache/tools/ant/taskdefs/optional/net/TelnetTask* + + + org/apache/tools/ant/taskdefs/optional/net/FTP* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-jai.jar b/tools/apache-ant-1.8.2/lib/ant-jai.jar new file mode 100644 index 000000000..613adaf4b Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-jai.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-jai.pom b/tools/apache-ant-1.8.2/lib/ant-jai.pom new file mode 100644 index 000000000..fc77323cb --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-jai.pom @@ -0,0 +1,85 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-jai + 1.8.2 + Apache Ant + JAI + image task and corresponding types. + + + + org.apache.ant + ant + 1.8.2 + compile + + + javax.media + jai-core + 1.1.3 + + + com.sun.media + jai-codec + 1.1.3 + + + + + jboss + JBoss + http://repository.jboss.org/maven2/ + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/image/* + org/apache/tools/ant/types/optional/image/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-javamail.jar b/tools/apache-ant-1.8.2/lib/ant-javamail.jar new file mode 100644 index 000000000..7ac7755dd Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-javamail.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-javamail.pom b/tools/apache-ant-1.8.2/lib/ant-javamail.pom new file mode 100644 index 000000000..bfb93ef55 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-javamail.pom @@ -0,0 +1,79 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-javamail + 1.8.2 + Apache Ant + JavaMail + implementation of the mail task based on javamail. + Required to send emails to SMTP servers using user/password combinations + or to send mail over SSL + + + org.apache.ant + ant + 1.8.2 + compile + + + javax.mail + mail + 1.4 + compile + + + javax.activation + activation + 1.1 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/email/MimeMailer* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-jdepend.jar b/tools/apache-ant-1.8.2/lib/ant-jdepend.jar new file mode 100644 index 000000000..9ff68d04b Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-jdepend.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-jdepend.pom b/tools/apache-ant-1.8.2/lib/ant-jdepend.pom new file mode 100644 index 000000000..d585e4b74 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-jdepend.pom @@ -0,0 +1,73 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-jdepend + 1.8.2 + Apache Ant + JDepend + task jdepend invoking the jdepend parser. There is also a version 2.9.1 of the + jdepend parser available on the maven repository + + + org.apache.ant + ant + 1.8.2 + compile + + + jdepend + jdepend + 2.7 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/jdepend/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-jmf.jar b/tools/apache-ant-1.8.2/lib/ant-jmf.jar new file mode 100644 index 000000000..01365c2b9 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-jmf.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-jmf.pom b/tools/apache-ant-1.8.2/lib/ant-jmf.pom new file mode 100644 index 000000000..758a2934b --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-jmf.pom @@ -0,0 +1,66 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-jmf + 1.8.2 + Apache Ant + JMF + contains the sound task and a soundplayer listener + download the dependency from http://java.sun.com/products/java-media/jmf/ + + + org.apache.ant + ant + 1.8.2 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/sound/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-jsch.jar b/tools/apache-ant-1.8.2/lib/ant-jsch.jar new file mode 100644 index 000000000..59f5fd1e9 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-jsch.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-jsch.pom b/tools/apache-ant-1.8.2/lib/ant-jsch.pom new file mode 100644 index 000000000..39e0d161e --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-jsch.pom @@ -0,0 +1,75 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-jsch + 1.8.2 + Apache Ant + JSch + contains the sshexec and scp tasks + jsch 0.1.29 might not be available from maven + + + org.apache.ant + ant + 1.8.2 + compile + + + com.jcraft + jsch + 0.1.42 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/ssh/* + + + org/apache/tools/ant/taskdefs/optional/ssh/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-junit.jar b/tools/apache-ant-1.8.2/lib/ant-junit.jar new file mode 100644 index 000000000..d2b1665bd Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-junit.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-junit.pom b/tools/apache-ant-1.8.2/lib/ant-junit.pom new file mode 100644 index 000000000..f90adc1a1 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-junit.pom @@ -0,0 +1,101 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-junit + 1.8.2 + Apache Ant + JUnit + contains the junit and junirreport tasks + + + org.apache.ant + ant + 1.8.2 + compile + + + junit + junit + 3.8.2 + compile + + + + + + maven-antrun-plugin + + + create-timestamp-file + generate-resources + + run + + + + + + + + + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/junit/* + + + org/apache/tools/ant/taskdefs/optional/junit/JUnit4TestMethodAdapter* + + + org/apache/tools/ant/taskdefs/optional/junit/ + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-junit4.jar b/tools/apache-ant-1.8.2/lib/ant-junit4.jar new file mode 100644 index 000000000..8f9843489 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-junit4.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-junit4.pom b/tools/apache-ant-1.8.2/lib/ant-junit4.pom new file mode 100644 index 000000000..4128917ca --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-junit4.pom @@ -0,0 +1,71 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-junit4 + 1.8.2 + Apache Ant + JUnit 4 + contains JUnit 4.x support + + + org.apache.ant + ant + 1.8.2 + compile + + + junit + junit + 4.8.1 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/junit/JUnit4TestMethodAdapter* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-launcher.jar b/tools/apache-ant-1.8.2/lib/ant-launcher.jar new file mode 100644 index 000000000..939abb579 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-launcher.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-launcher.pom b/tools/apache-ant-1.8.2/lib/ant-launcher.pom new file mode 100644 index 000000000..5015839e2 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-launcher.pom @@ -0,0 +1,58 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-launcher + 1.8.2 + Apache Ant Launcher + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/launch/*.java + + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/ant-launcher/classes + ../../../../target/ant-launcher/testcases + ../../../../target/ant-launcher + + diff --git a/tools/apache-ant-1.8.2/lib/ant-netrexx.jar b/tools/apache-ant-1.8.2/lib/ant-netrexx.jar new file mode 100644 index 000000000..6d38a989a Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-netrexx.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-netrexx.pom b/tools/apache-ant-1.8.2/lib/ant-netrexx.pom new file mode 100644 index 000000000..564282f2e --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-netrexx.pom @@ -0,0 +1,99 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-netrexx + 1.8.2 + Apache Ant + NetRexx + NetRexxC task + dependency can be downloaded from http://www.ibm.com/software/awdtools/netrexx/download.html + + + org.apache.ant + ant + 1.8.2 + compile + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/NetRexxC* + + + + ${basedir}/../../../../lib/optional + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.4 + + + validate + + + + + + + + + run + + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + diff --git a/tools/apache-ant-1.8.2/lib/ant-parent.pom b/tools/apache-ant-1.8.2/lib/ant-parent.pom new file mode 100644 index 000000000..af8ceb2c6 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-parent.pom @@ -0,0 +1,120 @@ + + + + + 4.0.0 + org.apache.ant + ant-parent + 1.8.2 + pom + master POM + + + The Apache Software License, Version 2.0 + http://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + Apache Ant + http://ant.apache.org/ + 2000 + + The Apache Software Foundation + http://www.apache.org/ + + + + + dummy + Dummy to avoid accidental deploys + + + + + scm:svn:http://svn.apache.org/repos/asf/ant/core/trunk + scm:svn:https://svn.apache.org/repos/asf/ant/core/trunk + http://svn.apache.org/repos/asf/ant/core/trunk + + + hudson + https://hudson.apache.org/hudson/job/Ant_BuildFromPOMs/ + + + + Ant Developers List + dev-subscribe@ant.apache.org + dev-unsubscribe@ant.apache.org + dev@ant.apache.org + http://mail-archives.apache.org/mod_mbox/ant-dev + + + Ant Users List + user-subscribe@ant.apache.org + user-unsubscribe@ant.apache.org + user@ant.apache.org + http://mail-archives.apache.org/mod_mbox/ant-user + + + + bugzilla + http://issues.apache.org/bugzilla/ + + + ant + ant-antlr + ant-apache-bcel + ant-apache-bsf + ant-apache-log4j + ant-apache-oro + ant-apache-regexp + ant-apache-resolver + ant-apache-xalan2 + ant-commons-logging + ant-commons-net + ant-jai + ant-javamail + ant-jdepend + ant-jmf + ant-jsch + ant-junit + ant-junit4 + ant-launcher + ant-netrexx + ant-swing + ant-testutil + + + + junit + junit + 3.8.2 + test + + + + ../../../src/main + ../../../src/testcases + ../../../target/classes + ../../../target/testcases + + diff --git a/tools/apache-ant-1.8.2/lib/ant-swing.jar b/tools/apache-ant-1.8.2/lib/ant-swing.jar new file mode 100644 index 000000000..0069327bd Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-swing.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-swing.pom b/tools/apache-ant-1.8.2/lib/ant-swing.pom new file mode 100644 index 000000000..a8c77bf61 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-swing.pom @@ -0,0 +1,67 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-swing + 1.8.2 + Apache Ant + Swing + a listener and a splash task based on Swing + + + org.apache.ant + ant + 1.8.2 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/taskdefs/optional/splash/* + + + + + ../../../../src/main + ../../../../src/testcases + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId}/testcases + ../../../../target/${project.artifactId} + + + diff --git a/tools/apache-ant-1.8.2/lib/ant-testutil.jar b/tools/apache-ant-1.8.2/lib/ant-testutil.jar new file mode 100644 index 000000000..cc73c8d31 Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant-testutil.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant-testutil.pom b/tools/apache-ant-1.8.2/lib/ant-testutil.pom new file mode 100644 index 000000000..d7f967df4 --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant-testutil.pom @@ -0,0 +1,75 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant-testutil + 1.8.2 + Apache Ant Test Utilities + test utility classes + + + org.apache.ant + ant + 1.8.2 + compile + + + junit + junit + 3.8.2 + compile + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/BuildFileTest* + org/apache/tools/ant/util/regexp/RegexpMatcherTest* + org/apache/tools/ant/util/regexp/RegexpTest* + org/apache/tools/ant/taskdefs/optional/AbstractXSLTLiaisonTest* + org/apache/tools/ant/types/AbstractFileSetTest* + + + + + ../../../../src/tests/junit + ../../../../target/${project.artifactId}/classes + ../../../../target/${project.artifactId} + + + diff --git a/tools/apache-ant-1.8.2/lib/ant.jar b/tools/apache-ant-1.8.2/lib/ant.jar new file mode 100644 index 000000000..7f5be4a4e Binary files /dev/null and b/tools/apache-ant-1.8.2/lib/ant.jar differ diff --git a/tools/apache-ant-1.8.2/lib/ant.pom b/tools/apache-ant-1.8.2/lib/ant.pom new file mode 100644 index 000000000..8854149dc --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/ant.pom @@ -0,0 +1,222 @@ + + + + + + org.apache.ant + ant-parent + ../pom.xml + 1.8.2 + + 4.0.0 + org.apache.ant + ant + 1.8.2 + Apache Ant Core + + + org.apache.ant + ant-launcher + 1.8.2 + compile + + + + + ../../../../target/ant/.build.timestamp.properties + + + + org.apache.maven.plugins + maven-jar-plugin + + + + maven-antrun-plugin + + + create-timestamp-file + generate-resources + + run + + + + + + + + + + + + delete-timestamp-file + clean + + run + + + + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.4 + 1.4 + + org/apache/tools/ant/filters/util/JavaClassHelper* + org/apache/tools/ant/types/resolver/** + org/apache/tools/ant/listener/Log4jListener* + org/apache/tools/ant/listener/CommonsLoggingListener* + org/apache/tools/ant/util/regexp/JakartaRegexp* + org/apache/tools/ant/util/regexp/JakartaOro* + org/apache/tools/ant/taskdefs/email/MimeMailer* + org/apache/tools/ant/launch/** + org/apache/tools/ant/taskdefs/optional/net/FTP* + org/apache/tools/ant/taskdefs/optional/net/RExec* + org/apache/tools/ant/taskdefs/optional/net/TelnetTask* + org/apache/tools/ant/taskdefs/optional/perforce/* + org/apache/tools/ant/taskdefs/optional/junit/* + org/apache/tools/ant/taskdefs/optional/ssh/* + org/apache/tools/ant/taskdefs/optional/image/* + org/apache/tools/ant/types/optional/image/* + org/apache/tools/ant/taskdefs/optional/Script* + org/apache/tools/ant/taskdefs/optional/script/** + org/apache/tools/ant/types/optional/*Script* + org/apache/tools/ant/util/ScriptRunner.java + org/apache/tools/ant/util/optional/ScriptRunner.java + org/apache/tools/ant/filters/util/JavaClassHelper* + org/apache/tools/ant/util/depend/bcel/* + org/apache/tools/ant/taskdefs/optional/NetRexxC* + org/apache/tools/ant/taskdefs/optional/Xalan2TraceSupport* + org/apache/tools/ant/taskdefs/optional/jdepend/* + + + org/apache/tools/ant/filters/util/JavaClassHelper* + org/apache/tools/ant/types/resolver/** + org/apache/tools/ant/util/Script* + org/apache/tools/ant/listener/Log4jListener* + org/apache/tools/ant/listener/CommonsLoggingListener* + org/apache/tools/ant/util/regexp/JakartaRegexp* + org/apache/tools/ant/util/regexp/JakartaOro* + org/apache/tools/ant/util/regexp/Jdk14Regexp* + org/apache/tools/ant/taskdefs/email/MimeMailer* + org/apache/tools/ant/launch/** + org/apache/tools/ant/taskdefs/StyleTest* + org/apache/tools/ant/taskdefs/optional/junit/ + org/apache/tools/ant/taskdefs/optional/net/FTP* + org/apache/tools/ant/taskdefs/optional/ssh/* + org/apache/tools/ant/taskdefs/optional/perforce/* + + + + + org.apache.maven.plugins + maven-surefire-plugin + + true + + + ant.home + ${env.ANT_HOME} + + + build.tests + ../../../../target/ant/testcases + + + build.tests.value + ../../../../target/ant/testcases + + + offline + true + + + root + ../../../.. + + + + + + org.apache.maven.plugins + maven-surefire-report-plugin + + + + + ../../../../src/main + true + + org/apache/tools/ant/taskdefs/default.properties + org/apache/tools/ant/types/default.properties + org/apache/tools/ant/taskdefs/default.properties + org/apache/tools/ant/types/conditions/antlib.xml + org/apache/tools/ant/defaultManifest.mf + org/apache/tools/ant/version.txt + + + + ../../../../src/resources + true + + **/antlib.xml + + + + ../../../../docs + false + + images/ant_logo_large.gif + + + + + + ../../../../src/etc/testcases + true + + + ../../../../src/main + true + + **/*.java + + + + ../../../../src/main + ../../../../src/tests/junit + ../../../../target/ant/classes + ../../../../target/ant/testcases + ../../../../target/ant + + diff --git a/tools/apache-ant-1.8.2/lib/libraries.properties b/tools/apache-ant-1.8.2/lib/libraries.properties new file mode 100644 index 000000000..3e948f6fc --- /dev/null +++ b/tools/apache-ant-1.8.2/lib/libraries.properties @@ -0,0 +1,65 @@ +# 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. + +#this file declares the libraries for use in +#a given release of the components + +#if you change this, change the checksum to match +m2.version=2.0.4 +m2.url=http://ibiblio.org/maven2/ +m2.artifact-name=maven-artifact-ant +m2.jar.name=${m2.artifact-name}-${m2.version}-dep.jar +#this is the URL of the antlib library, that is pulled down for everything else. +m2.antlib.url=${m2.url}/org/apache/maven/${m2.artifact-name}/${m2.version}/${m2.jar.name} +#this is the sha1 checksum of the artifact +m2.sha1.checksum=4e7ddfdb91600e9b59bb965ff8eef2f06015df50 + +# Repository to use by default for fetching dependencies. +m2.repo=http://repo1.maven.org/maven2/ + +#versions of different libraries. Please keep in alphabetical order, except +#when a specific dependency forces them to be out-of-order +antlr.version=2.7.7 +bcel.version=5.1 +bsf.version=2.4.0 +bsh.version=2.0b4 +bsh-core.version=${bsh.version} +commons-net.version=1.4.1 +commons-logging.version=1.1 +commons-logging-api.version=${commons-logging.version} +jai-core.version=1.1.3 +jai-codec.version=1.1.3 +jasper-compiler.version=4.1.36 +jasper-runtime.version=${jasper-compiler.version} +jdepend.version=2.9.1 +jruby.version=0.9.8 +junit.version=4.8.1 +jsch.version=0.1.42 +jython.version=2.1 +#log4j 1.2.15 requires JMS and a few other Sun jars that are not in the m2 repo +log4j.version=1.2.14 +#js is the javascript implementation of the rhino project +#17R1 is compiled with Java5 so we can't use the jar when building with JDK 1.4 +js.version=1.6R7 +oro.version=2.0.8 +regexp.version=1.3 +servlet-api.version=2.3 +which.version=1.0 +xalan.version=2.7.1 +xml-resolver.version=1.2 +mail.version=1.4 +#paired +jacl.version=1.2.6 +tcljava.version=${jacl.version} diff --git a/tools/jsmin/jsmin.0.2.4.jar b/tools/jsmin/jsmin.0.2.4.jar new file mode 100644 index 000000000..efb66298f Binary files /dev/null and b/tools/jsmin/jsmin.0.2.4.jar differ